Designing with a Connected Workspace

Now reading version 19.0. For the latest, read: Designing with a Connected Workspace for version 22
Applies to Altium Designer versions: 19.0, 19.1 and 20.0

Altium Designer can work with the following types of managed content server:

A managed content server works in harmony with Altium Designer to provide an elegant answer to the question of handling design data with secured integrity. The server not only provides rock-solid, secure storage of data, but also enables re-release of data as distinctly separate revisions - essentially tracking design changes over time, without overwriting any previously released data. It also caters for the lifecycle of the data to be managed, allowing people that need to use the data to see, at-a-glance, what stage the data has reached in its 'life' and therefore what it can be safely used for.

The server is used to manage all managed data, including components, domain models, schematic sheets of circuitry and design templates. Indeed, you can even create and manage your entire design projects directly within the server.

By furnishing a set of resuable design 'building blocks' within the server, you can embark on fresh projects safe in the knowledge that each model, component, and higher-order design element has been ratified and approved for use, with no having to reinvent the wheel as it were. The server becomes both the source and destination of design elements, with each new design utilizing elements realeased to, and managed through, the server. And by designing only with elements from the server, the integrity of those designs is inherently assured.

While you can continue to use your existing Altium NEXUS Server with Altium Designer, bear in mind that the Altium NEXUS Server, as a standalone product, is no longer developed. Altium NEXUS Server 1.1 was the last release, beyond which only maintenance updates would be made. To ensure you have access to the latest features and functionality, you are encouraged to switch to using Altium Concord Pro. Alternatively, should you require an agile solution for managed flows and enterprise integrations, switch to Altium NEXUS. Altium NEXUS is a turnkey solution for structured, workflow-driven PCB design by teams. It includes the capability for design, component data management, design data management, workflow authoring, process management, and more. As a complete or turnkey solution, It is comprised of configurable off-the-shelf modules and deployed with assistance from Altium professionals.

Server Items

Within a managed content server, each design entity that can be stored, managed, and reused, is represented as a specific type of Item. An Item is uniquely identified within the server and can contain any number of Revisions, where a revision contains the data for that Item. Each time a change is made to the data contained within a revision - which for most Item types can be edited directly within an associated temporary editor - it is committed (or re-released) into a new revision of that Item, ensuring that no existing revision can ever be overwritten, and thereby ensuring the highest integrity.

An Item can have any number of revisions, which are essentially an evolution of that Item over time. A change is made and the new data content is committed/uploaded/released into a new revision. The data stored in each revision of an item is therefore typically different. To identify between these different revisions of an Item, a revision identifier (ID) is used, which in combination with the Item ID creates a unique identifier for each release of an Item. This gives us the Item-Revision.

Another important aspect of an Item Revision is its Lifecycle State. This is another identifier that can be used to quickly assess what stage that revision has currently reached in its life, and what designers are therefore authorized to do with it. Where the Revision reflects design changes made to the Item, the Lifecycle State reflects the state of the item from a business perspective, such as Planned, New From Design, For Production, Obsolete, and so on.

Read about Server Items.

The Explorer Panel

From within Altium Designer, component management is streamlined through use of the Components panel and Manufacturer Part Search panel. However, another interface to your managed content server is Altium Designer's Explorer panel. From this panel you can perform many activities, including:

  • Creating and managing the organizational structure used in the server.
  • Creating any number of Items, each representative of a design object.
  • Direct editing and placement of Item Revisions.
  • Reviewing and managing the lifecycle of Item revisions.
  • Interrogating the usage of a particular Item revision (Where-Used).
  • Browsing and managing Part Choice information for Component Items.
  • Downloading stored data, including data generated through the managed release of board design projects.

The Explorer panel becomes your trusty right-hand, presenting a collection of features that can really enhance your productivity when working with the managed content server through Altium Designer.

While the majority of your day-to-day working with your managed content server will be through the Components panel or Explorer panel, there will also be occasion when you need to interact with the server through its browser interface - especially for administrative purposes. For more information, see the page Exploring the Browser-based Interface.

Direct Editing

A managed content server provides a flexible and secure method of centralizing the storage and management of all types of design data used in Altium Designer. From the schematic model to the component, from managed sheets through to completed PCB designs, the server delivers an ideal method of storing and managing your electronic design data.

Many design entities can be edited and released into the initial revision of a corresponding, and newly-created server Item, courtesy of the server's support for direct editing. Direct editing frees you from the shackles of separate version-controlled source data. You can simply edit a supported Item type using a temporary editor loaded with the latest source direct from the server itself. And once editing is complete, the entity is released (or re-released) 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 managed content server handles it all, with the same great integrity you've come to expect, and in a manner that greatly expedites changes to your data.

And at any stage, you can come back to any revision of a supported Item in the server, 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 entity contained in the revision opened for editing. Make changes as required, then commit the release of the document into the next revision of the item.


Controlled Access

A managed content server provides secure handling of data with high integrity, while providing both Design Team and Supply Chain access to that data as needed. This latter aspect, of whom can access a server, and more importantly what data they are allowed to access, is facilitated by the server's user access control and sharing capabilities. These can be broken down into the following key areas:

  • User Management
  • Folder-level Sharing
  • Item-level Sharing
  • Item Revision-level Sharing

Folders, Items, and Item Revisions in a managed content server can be shared on a number of different levels, in effect defining both the level of visibility of the entity, and the level of security for access to it. This can range from being strictly private access by specified individuals or roles, through to levels for allowing anyone in the same organization to view or change that entity respectively.


Managed Components

Altium Designer, with its unified design approach, has traditionally used a component model that extends across all aspects of the electronics design process. However, to seamlessly fit the process of electronics design into the encapsulating product development process as a whole, this model needs to evolve - extending to cover other aspects including other design processes (in particular MCAD and Industrial Design), as well as business processes (such as procurement and manufacturing) that intersect with the product development process.

This evolved object model is known as the Unified Component Model.

Under this modeling paradigm, the design component, as seen by the designer, is separated from the Manufacturer and/or Vendor parts. This information is not defined as part of the component. Instead, Part Choices are used to map the design component to one or more Manufacturer Parts, listed in a Part Catalog, which in turn can be mapped to one or more Vendor parts, allowing the designer to state up-front, what real parts can be used for any given design component used in a design.

These components, along with their part choices, are stored in the managed content server. A component is stored as a series of revisions of a uniquely-identifiable Component Item. Each revision is lifecycle-managed, providing collections of certified components, authorized to be re-instantiated into new design projects, manufactured into prototypes, or used for production runs. In short, a catalog of components implemented through server-based 'libraries'.

Altium Designer's Components panel provides a powerful interface with which to interact with all your components - both managed (server-based) and library (file-based). And for your managed components, the panel provides a filter-based parametric (faceted) search capability, for specifying target component parameters. In addition, the panel also offers options to edit a managed component through the Component Editor (in its Single Component Editing mode), view the component in its source server via the Explorer panel, and perform component management functions such as component creation and cloning, or editing the selected component's Part Choices and Type.
By using Altium Designer's Manufacturer Part Search panel, you can search for real-world manufactured parts, then acquire those parts into your managed content server. Acquisition involves creating a new managed component - using the Component Editor in its Single Component Editing mode - and releasing to your target managed content server.

 

Altium NEXUS includes a server for all your managed content - a 'managed content server' if you will, and an integral part of the overall deployed solution.

The server works in harmony with the design software element of your Altium NEXUS solution to provide an elegant answer to the question of handling design data with secured integrity. The server not only provides rock-solid, secure storage of data, but also enables re-release of data as distinctly separate revisions - essentially tracking design changes over time, without overwriting any previously released data. It also caters for the lifecycle of the data to be managed, allowing people that need to use the data to see, at-a-glance, what stage the data has reached in its 'life' and therefore what it can be safely used for.

The server is used to manage all managed data, including components, domain models, schematic sheets of circuitry and design templates. Indeed, you can even create and manage your entire design projects directly within the server.

By furnishing a set of resuable design 'building blocks' within the server, you can embark on fresh projects safe in the knowledge that each model, component, and higher-order design element has been ratified and approved for use, with no having to reinvent the wheel as it were. The server becomes both the source and destination of design elements, with each new design utilizing elements realeased to, and managed through, the server. And by designing only with elements from the server, the integrity of those designs is inherently assured.

While you can continue to use your existing Altium Vault with Altium NEXUS, in what is sometimes referred to as 'compatibility mode', bear in mind that the Altium Vault, as a product, is no longer developed. Altium Vault 3.0 was the last release, beyond which only maintenance updates would be made. To ensure you have access to the latest features and functionality, you are encouraged to use the server that is integral to the deployed Altium NEXUS solution.

Server Items

Within a server, each design entity that can be stored, managed, and reused, is represented as a specific type of Item. An Item is uniquely identified within the server and can contain any number of Revisions, where a revision contains the data for that Item. Each time a change is made to the data contained within a revision - which for most Item types can be edited directly within an associated temporary editor - it is committed (or re-released) into a new revision of that Item, ensuring that no existing revision can ever be overwritten, and thereby ensuring the highest integrity.

An Item can have any number of revisions, which are essentially an evolution of that Item over time. A change is made and the new data content is committed/uploaded/released into a new revision. The data stored in each revision of an item is therefore typically different. To identify between these different revisions of an Item, a revision identifier (ID) is used, which in combination with the Item ID creates a unique identifier for each release of an Item. This gives us the Item-Revision.

Another important aspect of an Item Revision is its Lifecycle State. This is another identifier that can be used to quickly assess what stage that revision has currently reached in its life, and what designers are therefore authorized to do with it. Where the Revision reflects design changes made to the Item, the Lifecycle State reflects the state of the item from a business perspective, such as Planned, New From Design, For Production, Obsolete, and so on.

Read about Server Items.

The Explorer Panel

From within Altium NEXUS, component management is streamlined through use of the Components panel and Manufacturer Part Search panel. However, another interface to your server is Altium NEXUS's Explorer panel. From this panel you can perform many activities, including:

  • Creating and managing the organizational structure used in the server.
  • Creating any number of Items, each representative of a design object.
  • Direct editing and placement of Item Revisions.
  • Reviewing and managing the lifecycle of Item revisions.
  • Interrogating the usage of a particular Item revision (Where-Used).
  • Browsing and managing Part Choice information for Component Items.
  • Downloading stored data, including data generated through the managed release of board design projects.

The Explorer panel becomes your trusty right-hand, presenting a collection of features that can really enhance your productivity when working with the server through Altium NEXUS.

While the majority of your day-to-day working with your server will be through the Components panel or Explorer panel,, there will also be occasion when you need to interact with the server through its browser interface - especially for administrative purposes. For more information, see Browser-based Access & Management.

Direct Editing

A server provides a flexible and secure method of centralizing the storage and management of all types of design data used in Altium NEXUS. From the schematic model to the component, from managed sheets through to completed PCB designs, the server delivers an ideal method of storing and managing your electronic design data.

Many design entities can be edited and released into the initial revision of a corresponding, and newly-created server Item, courtesy of the server's support for direct editing. Direct editing frees you from the shackles of separate version-controlled source data. You can simply edit a supported Item type using a temporary editor loaded with the latest source direct from the server itself. And once editing is complete, the entity is released (or re-released) 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 managed content server handles it all, with the same great integrity you've come to expect, and in a manner that greatly expedites changes to your data.

And at any stage, you can come back to any revision of a supported Item in the server, and edit it directly. Simply right-click on the revision and choose the Edit command from the context menu. Once again, the temporary editor will open, with the entity contained in the revision opened for editing. Make changes as required, then commit the release of the document into the next revision of the item.


Controlled Access

A server provides secure handling of data with high integrity, while providing both Design Team and Supply Chain access to that data as needed. This latter aspect, of whom can access a server, and more importantly what data they are allowed to access, is facilitated by the server's user access control and sharing capabilities. These can be broken down into the following key areas:

  • User Management
  • Folder-level Sharing
  • Item-level Sharing
  • Item Revision-level Sharing

Folders, Items, and Item Revisions in a managed content server can be shared on a number of different levels, in effect defining both the level of visibility of the entity, and the level of security for access to it. This can range from being strictly private access by specified individuals or roles, through to levels for allowing anyone in the same organization to view or change that entity respectively.


Managed Components

Altium NEXUS, with its unified design approach, has traditionally used a component model that extends across all aspects of the electronics design process. However, to seamlessly fit the process of electronics design into the encapsulating product development process as a whole, this model needs to evolve - extending to cover other aspects including other design processes (in particular MCAD and Industrial Design), as well as business processes (such as procurement and manufacturing) that intersect with the product development process.

This evolved object model is known as the Unified Component Model.

Under this modeling paradigm, the design component, as seen by the designer, is separated from the Manufacturer and/or Vendor parts. This information is not defined as part of the component. Instead, Part Choices are used to map the design component to one or more Manufacturer Parts, listed in a Part Catalog, which in turn can be mapped to one or more Vendor parts, allowing the designer to state up-front, what real parts can be used for any given design component used in a design.

These components, along with their part choices, are stored in the managed content server. A component is stored as a series of revisions of a uniquely-identifiable Component Item. Each revision is lifecycle-managed, providing collections of certified components, authorized to be re-instantiated into new design projects, manufactured into prototypes, or used for production runs. In short, a catalog of components implemented through server-based 'libraries'.

Altium NEXUS's Components panel provides a powerful interface with which to interact with all your components - both managed (server-based) and library (file-based). And for your managed components, the panel provides a filter-based parametric (faceted) search capability, for specifying target component parameters. In addition, the panel also offers options to edit a managed component through the Component Editor (in its Single Component Editing mode), view the component in its source server via the Explorer panel, and perform component management functions such as component creation and cloning, or editing the selected component's Part Choices and Type.
By using Altium NEXUS's Manufacturer Part Search panel, you can search for real-world manufactured parts, then acquire those parts into your managed content server. Acquisition involves creating a new managed component - using the Component Editor in its Single Component Editing mode - and releasing to your integral server.

 

Note

The features available depend on your level of Altium Designer Software Subscription.