Contact our corporate or local offices directly.
Altium NEXUS, in conjunction with an Altium managed content server, offers the ability to update components in an existing board design to use managed components that reside in an Altium managed content server. The local ‘unmanaged’ components can be individually updated to server-hosted managed component Items, or batch updated using automated Parameter matching through the Altium NEXUS Item Manager.
Using a highly configurable Rule system to target suitable Component Item Revisions in the server, the Altium NEXUS Item Manager provides a fast and effective way to convert the current PCB project to one that uses fully Managed Components from a centralized Altium managed content server.
The Item Manager provides two key abilities in relation to components and sheets of re-usable schematic circuitry in a board design project:
By way of background, note that an individual component in a design can be updated to a server-managed component directly from the Properties panel in the Schematic Editor.
To do so, select the component in the workspace and then use the panel's Source drop down menu to choose a managed content server as the component data source – you need to be signed in to the server for access. The following Component source dialog provides the option to select a target component from the server or simply link the component to the server, while retaining or replacing the component identifier (Design Item ID).
If the server component has been selected, the accessed component data will replace the existing component and models, and update the component Parameters. The panel will also indicate the component's current Revision State and synchronization status, as shown below.
While this would be a laborious approach to updating all of a design's components to managed content server components, in even a small scale board design, the Item Manager provides a simple and automated conversion method that uses advanced Parameter matching (Automatching) and a bulk update approach. A typical application of the Item Manager would be to update an existing board design to use Managed Components and Sheets that have been migrated to an Altium Server from company Libraries.
The Item Manager dialog is accessed from the main Tools menu from an active schematic document (Tools » Item Manager) and presents all components and sheet symbols found in the active board design project.
Select the dialog's lower Unmanaged or Components tab to populate the list of components in the current design. In essence, the left section of the dialog shows component settings of the active project (Current Settings), while the right section lists how they will change (New Settings) when suitable Managed Components from the server have been assigned. To view and access Managed Schematic Sheets, select the Sheet Symbols tab.
The way in which component data is presented in the Item Manager dialog is highly configurable, based on the data columns that are enabled and/or grouped. This allows the list of design Items and their associated system/user Parameters to be shown in a way that matches specific approaches to component identification – all Item Parameters, such as proprietary company part numbers for example, can be displayed as needed.
To configure the which columns are presented in the Item Manager, right click in the dialog's column heading area and select Columns » Select Columns from the context menu. The Select Columns dialog will offer all available parameters from both the local design
[Current Settings] and the managed Items in the Altium server
[New Settings]. Add an Available parameter column to the currently Selected columns (), or remove a Selected column as required ().
Hover over a column heading to expose its filter icon, which when selected, allows the listing in the Item Manager to be constrained to specific entry types or to a custom created filter.
To group the listed Items data by a particular Parameter column, such as Component type category or Schematic document etc, drag the desired column heading entry to the dialog's upper title row (as indicated by the hint text). The Item list will reconfigure to group its entries by the assigned parameter column.
Assuming that the connected Altium managed content server is populated with collections of Managed Components and schematic sheets, the current board design project can be converted to using those managed Items where a suitable match is available. The local-to-server matching can be performed manually, or as an automated process through the Item Manager based on configurable Parameter matching. When complete, the local unmanaged component definitions will be updated to their managed counterparts from the Altium managed content server.
To manually replace a local component (or schematic) with a managed version from the server, select its entry in the Item Manager list and then Choose manually from its right click context options. In the following Choose Managed Component dialog, browse and select a suitably matched Managed Item (or specific revision of that Item) in the content server.
When the dialog is closed (OK), the selected managed component information will populate the entry's New Settings region in the list. Note that since the entry is now a pending Managed entity, the updated entry is transferred from the listing under the Unmanaged tab to the list under the Managed tab.
To automate the process of choosing matching content server Items, the Item Manager provides a configurable auto-matching capability that attempts to match each unmanaged design component with a Managed Component Item in the connected server. When a match is found, that managed Component Item will be proposed for the update.
The key to the Item Manager's automatic Parameter matching capabilities is the update Rules and Options available in the Item Manager Options dialog, accessed from the Item Manager dialog's button. The configurable Rules determine which component Parameters in the active (local) design are matched to the Parameters of all Managed Components in the selected Source server.
How effective these Rules are in achieving a local-to-server component match will depend upon the available component Parameters, which will be specific to company systems or individual preferences. In the simplest, but perhaps unlikely, scenario the Comment or Component Name parameter entries may match between the local and equivalent server-based components. In the ideal case however, both the local and server components will share a company reference or manufacturer part number parameter.
To create such a part number Rule for example, select and modify an existing Rule (which can also be renamed) or use the button create a new Rule – a Rule must be selected (checked) to be edited. Note that the Local and Server Parameter selection drop-down lists are independent, which allows differently named parameters to be nominated – in the below example, the local
LibRef parameter and the Server
PartRef parameter represent a company part reference number.
Running a part/reference number matching Rule such as above is likely to create a near complete match between the local and server components. With the Rule established, the matching process is initiated by the button in the Item Manager dialog.
The subsequent Automatching Items dialog will indicate positive matches in green text and include a reference to the name of the successful Rule.
When a match cannot be found, the entry will be in red text and a reference included indicating the reason for the error or matching failure – a different or additional Rule will need to be created to achieve a successful match for those components. Also note that a Rule may detect more than one server Item (component) as a match, which is considered as a successful result but requires manual intervention to resolve. This conflict is regarded as an 'ambiguous' result, and can be resolved in the Item Manager dialog – see below.
When the automatch process is complete, close the Automatching Items dialog (OK) to populate the Items Manager dialog with the proposed new component settings. The pending Managed Items that will be applied to matched entries are listed in the New Settings region under the dialog's Managed tab, or under Components tab along with items that have not been matched.
To resolve any ambiguous Items, generally caused by multiple matches, select the Ambiguous Items (or Ambiguous Footprints) tab and make a suitable choice from the Not selected drop down menu in the dialog’s New Settings section – note that multiple matches, and therefore the available choices, can in fact be referencing different Revisions of the same Component Item. When the issue is resolved (no longer classed as ambiguous) the component Item entry will move to the Managed/Components tab lists.
As outlined above, Item Manager Rules establish Parameter matches between the local project Components and Managed Components in the server. Any number of Rules can be created, and these work on descending priority basis. If the first (top) Rule fails, then the next Rule is applied – effectively a sequential Boolean OR relationship. A rule is active only when its associated checkbox is enabled.
When the Automatching process is run, the State Notes column in the Automatching Options dialog indicates which Rules have failed in finding a match. In this case a different or new Rule is required to satisfactorily mat ch the available Parameters.
Use the Item Manager Options dialog’s button to create a new Rule, and the associated button to apply multiple Parameter matching conditions. As each Parameter condition is added the Rule becomes increasingly specific, and all conditions need to be satisfied before the Rule match succeeds – effectively a Boolean AND condition.
Taking the example shown here, where (say) the components cannot be matched by part/reference number Parameters, a new Rule can be created to match suitable specifications for the listed unmatched capacitors shown above.
The Item Manager Options dialog provides a range of Item updating options that can be used to further refine the how automatched Managed Components are applied to the current board design.
The options are applied to the current design via the ECO process, and behave as follows:
The Library Update Settings dialog includes a list of all available Parameters, for all components, in the current board project (right-click to access mass on/off functions). Those Parameters checked in the list will be updated when a local component is updated to a Managed Component – the behavior of that update is determined by the options outlined below.
The Parameter replacement (or addition) behavior is determined by the lower two options in the dialog:
The proposed changes that have been set up in the Item Manager are applied to the current board design by generating and executing an Engineering Change Order (ECO). Select the range of listed components you wish to update, and then the desired ECO option from the button menu – the options are:
The executed ECO process will update the project components accordingly, which will then be listed in the Item Manager dialog as currently up-to-date Managed Components. Note that the previous icon for each entry () has changed to indicate the reference to a Managed Component ().
In the Schematic Editor, the updated components are linked to their matched Managed Components in the server – the active link information will detect a change in the Managed Component's Revision state when/if it is subsequently updated. Select a component in the workspace and note its Source and associated information in the Properties panel.
During the course of product development it is very likely that changes will occur in the design's source components. For example, component models may be updated to a new drawing standard, or component definitions may have been updated to add new parameters. Any such changes made to the server-based managed components used in a design need to be detected and made to flow through to any affected schematic sheets.
For an individual, selected component the Properties panel will provide an immediate indication that a component is out of date relative to its managed source data. Use the associated button to update the data for that component from its source server.
As well as being used to detect and manage components that are currently unmanaged (indicated as [Not Managed] and not sourced from an managed content server), the Item Manager is also used to detect and manage all Items that are out of date.
When the Item Manager is opened it automatically compiles the schematic project, detects and lists all components (indicating if they are managed or not), and then compares the Item-Revision of each managed component on the schematics against the available Revisions of that Item in the managed content server. If there are Items that have a newer revision available in the server, these are flagged as Out of date in the Item Manager's Revision Status column.
To bring out of date items up to date they must selected, and then the Update to latest revision command applied from the right-click context menu. The New Settings region of the dialog will then show the detail of each new Item-Revision. Select the Apply ECO option from the ECO button menu to generate the Change Order and apply the new revision(s) to the components in the design.
Before committing to a component update or change process in the Item Manager it may be prudent to generate a snapshot of the current listing information using the dialog's Export function. To do this, right-click anywhere in the Item Manager and select Export from the context menu, and then navigate to a suitable location and name the report as required.
The report is generated as an HTML file, and presented with the same layout as the current Item Manager display.
Contact our corporate or local offices directly.