Altium NEXUS Documentation

Managed BOM Templates

Modified by Jason Howie on Jun 20, 2018
All Contents

Parent page: Server Items

Altium NEXUS, in conjunction with your managed content server, caters for the ability to create and manage Excel-based BOM Template Items in that Server. Such Items are created directly within the Server, with the relevant Excel template file (*xls, *.xlsx, *.xlt, *.xltx) uploaded to a revision of a target item. Once a BOM Template Item has been created (and data released into a revision of it), and its lifecycle state set to a level that the organization views as ready for use at the design level, it can be reused in future board-level design projects.

In addition, and when using an Altium NEXUS Server as your managed content server, a managed BOM Template Item can be used as a configuration data item in one or more defined Environment Configurations. An environment configuration is used to constrain a designer's Altium NEXUS working environment to only use company-ratified design elements. Environment configurations are defined and stored within the Team Configuration Center - a service provided through the Altium NEXUS Server installation, and the facilitator of this concept of Environment Configuration Management.

For more information on working with, and creating a Bill of Materials in Altium NEXUS, see BOM Management with ActiveBOM.

Folder Type

When creating the folder in which to store a BOM Template Item, you can specify the folder's type. This has no bearing on the content of the folder - uploading will always result in a BOM Template Item. It simply provides a visual 'clue' as to wh at is stored in a folder and can be beneficial when browsing a Server for particular content. To nominate a folder's use as a container for BOM Template Items, set its Folder Type as BOM Templates, when defining the folder properties in the Edit Folder dialog.


Specifying the folder type - its intended use - gives a visual indication of the content of that folder when browsing the Server!

Another important aspect of the parent folder is the Item Naming Scheme employed for it. This defines the format of the unique ID for each Item created in that particular folder. Several default example schemes are available, utilizing the short-form code for either the folder type (XLT - Excel Templates) or the content type (XLT - Excel Template):

  • $CONTENT_TYPE_CODE-001-{0000} - for example, XLT-001-0001.
  • $CONTENT_TYPE_CODE-001-{A00} - for example, XLT-001-A01.
  • $FOLDER_TYPE_CODE-001-{0000} - for example, XLT-001-0001.
  • $FOLDER_TYPE_CODE-001-{A000} - for example, XLT-001-A001.

Using a default naming scheme, the software will automatically assign the next available unique ID, based on that scheme, having scanned the entire Server and identifiers of existing Items. This can be a great time-saver when manually creating BOM Template Items.

A custom scheme can also be defined for a folder, simply by typing it within the field, ensuring that the variable portion is enclosed in curly braces (e.g. XLBOM-001-{0000}).


The Item Naming Scheme of the parent folder is applied to the Unique ID for each Item
created within that folder.

The Item Naming Scheme employed for the parent folder can be changed at any time. The modified scheme will then be applied to any subsequent newly-created Items within that folder.

Item Type

When creating the target BOM Template Item in which to store your Excel template file, ensure that its Content Type is set to BOM Template in the Create New Item dialog. If you are creating the Item in a BOM Templates type folder, this Item type will be available from the right-click context menu when creating the Item.


Creating a BOM Template Item within a BOM Templates folder - the correct Content Type is available on the context menu.

When defining the BOM Template Item, to which the source Excel template file is uploaded, be sure to specify the type of lifecycle management to be used for the Item, and the naming scheme employed for its revisions, respectively.

Control over which Item types can use a particular lifecycle definition or revision naming scheme, can be defined and enabled at a global level from within the Content Types dialog, when defining each schema. The default schemes assigned for use by a BOM Template Item are: Basic Lifecycle and 1-Level Revision Scheme, respectively.

Once a file has been uploaded into the initial revision of a BOM Template Item, these schemes cannot be changed for that particular Item.

Specify the required schemes in the Create New Item dialog, using the Lifecycle Definition and Revision Naming Scheme fields respectively.

If the option to control use of lifecycle definitions and revision naming schemes per content type is enabled for any definitions/schemes, and the BOM Template Item type is not set to use a particular definition/scheme, then that definition/scheme will not be available in the applicable drop-down list.


Selecting the Lifecycle Definition and Revision Naming schemes for a manually created Item.

Observing standard revision naming schemes and lifecycle definitions, across the various types of design item in a managed content server ensures smooth, consistent management of those items.
It is a good idea to add a Name and Description as part of the Item's definition. This information is used when searching the Server and enables quick identification of what a BOM Template Item offers.

Uploading a BOM Template File

So far, we've discussed the support for a BOM Template Item in the Server, in terms of related folder and item types. Uploading an Excel template file into the revision of such an item can be performed in a couple of ways.

Upload Menu

An Excel template file can be uploaded by right-clicking on the required BOM Template Item in the Explorer panel, and choosing the Upload command from the context menu. The Create New Revision dialog will appear, in which you can change Name, Description, and add release notes as required. Use the Sources region of the dialog to load the required template file. This can be performed by dragging and dropping the file from Windows Explorer, onto the region. Alternatively, click the  button - the Add Files dialog (a standard Windows open-type dialog) will appear. Use this to browse to, and open, the required template file (supported formats/extensions are: *.xls, *.xlsx, *.xlt, and *.xltx).

If the Item has no planned revision, upload will be to the next planned revision, created on-the-fly as part of the upload process.


Manually specifying the Excel template file to be uploaded to the target BOM Template Item.

Once the desired file is dropped in, or selected and the Open button clicked, an entry for it will appear back in the Sources region. Proceed with the upload by clicking the OK button. The uploaded file will be available in the Details aspect view for the Item Revision, in the Explorer panel.


The uploaded file is listed in the Details aspect view for the revision of the BOM Template Item.

Drag and Drop from Windows Explorer

An Excel template file can also be uploaded by dragging the selected file from a source folder in your Windows Explorer, and dropping onto the required target BOM Template Item in the Explorer panel. The Create New Revision dialog will appear, with the dragged file listed in the Sources region. Modify Name and Description, and add any Release Notes as required, and then click the OK button.

If the existing BOM Template Item has no planned revision, upload will be to the next planned revision, created on-the-fly as part of the upload process. If you drop the dragged file away from an existing Item, a new BOM Template Item will be created. The Create New Item dialog will appear. The Name of the item will be the file name, including extension. The Description will be in the format Uploaded from <FileNameandPath>, Size <FileSize>, Created on <FileCreationDate>. Change these as required. The Item ID will be in accordance with the Item Naming scheme defined at the folder level. If the folder has no naming scheme defined, naming will follow the $CONTENT_TYPE_CODE-001-{0000} scheme.

Uploading an Excel template file using the drag and drop method.

Reusing a Managed BOM Template Item

Once an Excel BOM template file has been uploaded to a managed content server, and its lifecycle state set to a level that the organization views as ready for use at the design level, that BOM template can be reused in future board-level design projects.

When you are signed in to your managed content server, use of available BOM Template Items is automatic. If there are released revisions of BOM Template Items, then only those available templates - shared with you - will be presented in the Bill of Materials dialog, through the dialog's Template menu (in the Excel Options region):

If BOM Template Items exist, then when signed into the Server they will be presented, instead of the local (file-based) templates, when configuring a Bill of Materials Report.

If there are no released revisions of BOM Template Items in the Server, or if you sign out of your Server, then you will be able to use local, file-based templates (stored in *.xls, *.xlsx, *.xlt, or *.xltx files).

If you do not sign in to your managed content server you can still work with Altium NEXUS (under your valid Altium NEXUS License), but you will not be able to access your organization's managed content server, or any other services it provides. You will therefore not be able to reuse any managed BOM Template Items. You will only be able to use file-based templates defined locally, and available from the templates folder specified on the Data Management - Templates page of the Preferences dialog.
When using an Altium NEXUS Server as your managed content server, a released BOM Template can also be used as a configuration data item in one or more defined Environment Configurations. An environment configuration is used to constrain a designer's Altium NEXUS working environment to only use company-ratified design elements. Environment configurations are defined and stored within the Team Configuration Center - a service provided through the Altium NEXUS Server installation. Once you have signed in to the Altium NEXUS Server, and chosen (if applicable) from the selection of environment configurations available to you, Altium NEXUS will be configured, with respect to use of BOM Templates. If the chosen environment configuration has one or more defined BOM Template Items, then only those defined templates can be used. If the chosen environment configuration applicable to you does not have any BOM Template Items specified/added, or is set to Do Not Control, then these will remain manually definable. In other words, you are free to use local, file-based templates. For more information, see Environment Configuration Management.

Updating a BOM Template Item

If you need to change the Excel template stored in a BOM Template Item, upload the required new template file to that Item - the new template will be stored in the next revision of that Item.

Downloading a BOM Template File

Download the Excel BOM Template file (*.xls, *.xlsx, *.xlt, *.xltx) stored in a revision of a BOM Template Item, by right-clicking on that revision and choosing the Operations » Download command from the context menu. The file will be downloaded into a sub-folder under the chosen directory, named using the Item Revision ID. The file can be found in the Released folder therein.

Access the Download command from the top-level entry for a BOM Template Item itself, to download the Excel BOM Template file stored in the latest revision of that Item.
Click the Explore button in the Download from Vault dialog, to quickly explore to the download folder.

 

Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

You are reporting an issue with the following selected text
and/or image within the active document:
ALTIUM DESIGNER FREE TRIAL
Altium Designer Free Trial
Let’s get started. First off, are you or your organization already using Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

In that case, why do you need an evaluation license?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You actually don’t need an evaluation license for that.

Click the button below to download the latest Altium Designer installer.

Download Altium Designer Installer

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Please fill out the form below to get a quote for a new seat of Altium Designer.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

If you are on Altium Subscription, you don’t need an evaluation license.

If you are not an active Altium Subscription member, please fill out the form below to get your free trial.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Why are you looking to evaluate Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

You came to the right place! Please fill out the form below to get your free trial started.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Great News!

Valid students can get their very own 6-month Altium Designer Student License for FREE! Just fill out the form below to request your Student License today.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

That’s great! Making things is awesome. We have the perfect program for you.

Upverter is a free community-driven platform designed specifically to meet the needs of makers like you.

Click here to give it a try!

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.