Managing Environment Configurations
Parent page: Environment Configuration Management
An organization can centrally control the environment its designers operate in, through the definition and management of Environment Configurations. These are used to constrain each designer's Altium Designer working environment to only use company-ratified design elements, including schematic templates, output job configuration files, BOM templates, layer stacks, project templates, and workspace preferences.
Environment configurations are created and managed from within the Team Configuration Center, through its browser-based interface, allowing an administrator to craft one or more environment configurations, depending on the needs of the organization.
Accessing the Team Configuration Center
The interface to the Team Configuration Center is accessed through the Altium Vault's browser-based interface. Simply sign into the Altium Vault through a Web Browser. Once there, navigate to the ADMIN » CONFIGURATIONS page. Note that this page is only accessible when you are signed in to the Altium Vault with administrative rights (are a member of the Administrators role).
Access of the Team Configuration Center's browser-based user interface - through a preferred external Web Browser.
Creating an Environment Configuration
To create a new environment configuration, simply click the Add Configuration button, located at the top-right of the page. The Configuration details page will display, presenting a shell configuration, ready to be defined.
Adding a new configuration - roll over the image to see the resulting shell configuration, ready to be defined.
Although the environment configuration is created, it is not yet saved. To ensure the configuration is 'saved', click the Save button, at the top-right of the page. The configuration does not have to be defined prior to saving, except for a name, allowing you to create placeholder configurations, then come back later to define them. Configuration data is stored in the Altium Vault's database.
Click on the Configurations entry in the breadcrumbs area to return to the summary page, listing currently saved (not necessarily defined) configurations. Click on the 
icon, or the configuration name, to access the Configuration details page again, to continue defining, or make changes to, the configuration.
Use the breadcrumbs to switch back to the summary page for currently defined configurations. Click a configuration's name, or the associated folder icon, to switch back to the
Configuration details view.
Defining an Environment Configuration
Definition of an environment configuration essentially consists of the following:
- Name - a meaningful name, perhaps reflective of the people whose working environment it is to govern.
- Description - a meaningful description.
- Roles - specification of whom the environment configuration applies to. Roles themselves are simply groupings of users, defined and stored as part of the vault's Identity Service. These are the same roles that are defined and used by the vault to control access permissions.
- Configuration Data - the elemental constraints of the configuration. The revisions of supported data items that can be validly used by a user targeted by the configuration.
Roles
To specify a role for assignment to the configuration, simply click within the Roles field, and start typing its name, to pop-up a list of matching roles. Select the required role from this list. Multiple roles can be chosen for assignment. To remove a role, simply click the delete cross, to the far right of its name.
Specify one or more existing roles for the configuration.
Data Item Access
To be able to use the revision of a data item specified through an environment configuration, the member users within an assigned role need to be able to 'see' that Item Revision. Unless specifically shared, an Item Revision is only visible to the person who created it - its Owner - and any member of the Administrators role. This enables you to control which data Items of an environment configuration are available, when that configuration is used by various different roles. The configuration service will flag any data items that cannot be seen by one or more assigned roles in two ways:
- If a data item is defined already before a role is assigned, the service will check if that Item Revision is visible to (shared with) that role. If it isn't, the entry Invisible for Roles: <RoleName> will appear in the description field for the data item.
- If roles are defined before the configuration data, then the service will perform checking when the configuration is saved, presenting results in a pop-up dialog, and adding the corresponding Invisible for Roles: <RoleName> entry to the description field for the affected data items.
The configuration service will alert you to any data items that are not visible to an assigned role. In this case, users in the Designers role can see the two defined data items,
because those Item Revisions have been shared with that role. The Item Revisions have not been shared with the Managers role.
Configuration Data
Before you can define configuration data for the environment configuration, first ensure that relevant data Items have been created, released/committed/uploaded to, and exist in, the Altium Vault. For more information, click a link below:
The process for specifying which configuration data Items - sourced from the organization's Altium Vault - are to be used by users of the environment configuration, is the same for each of the supported data elements. In each case, you simply specify the required data Item revision through use of the Vault Explorer pop-up. Access this pop-up by clicking the Add button, to the right of the respective section.
Within the Vault Explorer pop-up, use the left-hand region, which reflects the folder tree in the vault, to browse to and select, the folder containing the required Item. Once selected, the top-right region will populate with a listing of Items (and revisions thereof) in that folder. Select the required revision (check its checkbox) and click OK. Multiple revisions can be selected for addition en masse.
Example of browsing for a specific revision of a Schematic Template Item, to be used by the environment configuration.
With certain data item types, additional features are provided when defining a configuration:
- When you have assigned a revision of an Altium Designer Preference Item to the configuration, an additional region is added, that allows you to browse what is included in that revision (what will be controlled, at least initially). Simply click the Show details info control to access this, and click on a folder to expand further.
- For BOM Templates, Layer Stacks, and Project Templates, you have the choice of how, if at all, those data items are controlled. Choose from the following:
- Do Not Control - select this setting to leave the use of this area uncontrolled. The user will be able to use local, file-based templates.
- All Available Revisions - select this setting to instantly add the latest revision of all released Items of the respective type, to the configuration.
- Specific Revisions - select this setting to only use specific revisions of released Items of the respective type, for the configuration.
- For Outputjob documents, you have the option to mark them as required - by enabling the Req'd option associated with a chosen Item Revision. Simply put, if an OutJob defined as part of an environment configuration is marked as required, then release will not be possible until that OutJob is present and enabled for inclusion in the relevant data set being generated as part of project release.
Once the configuration is defined as required, click the Save button.
Example defined environment configuration.
). To remove an Item Revision of any other data item type, simply click the associated Remove control (
).Removing an Environment Configuration
To remove an environment configuration, deleting it from the Team Configuration Center (and from the Altium Vault's database), simply click the Remove control (), at the far right of the entry for that environment configuration, on the summary Configurations page.