Release to PLM - Create Simple Template

1. Invoke the Dashboard GUI by executing the batch file in the installation folder <connectorInstallationFolder>\AltiumToPlm\launch_dashboard.bat

2. Invoke the Template Editor shortcut from the Dashboard GUI.

3. Connect to PLM if prompted. Template Editor requires a connection to PLM, see article on specifying your PLM Credentials

4. Create New Template by placing your cursor in the Templates panel and invoking the Right Mouse Button menu and executing Add Template.


5. Specify Template Name and Description

6. Specify Attribute Mappings

With your right mouse button click the Attribute Mappings node.

The Attribute ID and Name fields are auto-populated based on your PLM Configuration. You need to enter a value in the Mapped name column for any of those PLM BOM attributes you would like to update with the Connector. Minimum mapping would be Part Number (Number), quantity (Qty), refDes (Ref Des). Below are typical mappings. 

Arena PLM

The Arena attributes "quantity" and "refDes" should be mapped as indicated below. The Arena attribute "Part Number" should be mapped to the Altium component attribute that holds your corporate part number which exists in PLM. This may be a symbol level attribute, a database library attribute, or a Vault component parameter.

Altium Designer

Altium Vault


Agile PLM

Altium Designer

Altium Vault

7. Specify PLM Attributes for BOM Preview

With your right mouse button click the BOM Settings node.

In the Available Attributes list you will see all the Part related attributes from your PLM System. Add a check to the box on the left of the Attribute Name and that attribute value will be displayed in the BOM preview page of the release wizard.

Arena PLM

Agile PLM

8. Define Bom Structure

With your right mouse button click and expand the Design Structure node and click on the New Element node. This will be the top level of the ECAD BOM Structure created in PLM.

Specify a Name for the item. This will only be used to identify structure item in the wizard.

Specify a PLM Type for the item. This is used by the connector when creating the object in PLM. Click the Browse button to display a list of your PLM classes/categories. 

Select the correct type and click OK


                    Arena PLM Example                                      Agile PLM Example


Check the box to the left of Use Native BOM? if you want the Altium Designer or Vault BOM uploaded to the PLM object. This is normally the case with an Assembly object.

Check the box to the left of Use Native Files? when creating a template for a Vault flow and if you want Vault based files uploaded to the PLM object. 

Check the box to the left of Use Variant BOM? when creating a template for a Altium Designer based flow and if you want to create a separate PLM object for each item of this type. The number of object created is based on the number of variant defined in the schematic. 

Use the Numbering Format to configure the auto creation of PLM objects within Design Structure. Click the Configure link to view configuration details for this class/category. 

Arena PLM

Within the Configure Numbering Format dialog click the Part category on the left and then specify the Code on the right, then click OK

Agile PLM

Within the Configure Numbering Format dialog highlight the Auto Number name then click OK


If there are Required Attributes defined in PLM for this class/category they will be presented and you can specify attribute value that will be set when then objects are created in PLM.

Use the PLM Actions Edit link to list PLM tasks that can be executed for this item.

Choose one or more actions from the Select action dialog and click OK. Generally the Assembly item would include a Publish BOM action and the PCB and/or Schematic items would include a Checkin Files action. Publish Attributes is used if there are attributes, other than description, that must be specified by the user.  

9. Setup File Sources

Setup a File Source to indicate the files that should be upload to PLM from your local workspace (with Altium Designer flow) or from Altium Vault. 

Move your cursor over the File Sources not and invoke the Right Mouse Button menu and execute New File Source

Enable the Directory File Source (most used option) and click OK

Within the Directory Source form specify details regarding the File Source definition. 

Specify a Name for the source, this will be listed in the Files preview page of the Release wizard. 

Optionally specify a Description of the source, this is only an administrative note. 

Check the Enabled box if you would like this file source activated in the Release Wizard. 

Enter a Zip File name if you would like all of the files added to a single compressed file before uploading to PLM.

Use the Directory field to specify the location the files to be uploaded to PLM. You can use the Browse button to specified a hardcoded path to the files. You can place your cursor in the input cell and ctrl-<space bar> to bring up a list of application and environment variables (e.g. PROJECTDIR) to provide more flexibility. PROJECTDIR is used most often to specify a location relative to your design workspace for Altium Designer flows. 

Altium Designer example

Altium Vault example


Check the Recurse box to allow the connector to look into subfolders for the files.

Use the File Filters to identify the files to be extracted from the Directory you have specified. Move your cursor to the File Filters table and invoke the Right Mouse Button menu and execute the Add Filter option to add a row to the table. In the Expression column specify a wildcarded or regular expression to identify the files to be uploaded. 

You may add multiple filters and multiple file sources. 


10. Add Additional Structure Elements

You can create a hierarchical structure of part/document elements for the ECAD BOM structure to be created in PLM.

Place your cursor over the parent item (e.g. PCBA), invoke the Right Mouse Button menu and execute Add Structure Element. 


This will create a child node under your parent. You can now follow the steps in 8. and 9. to define the configuration for this structure element. 

11. Save the Template

Use the top level File > Save menu option to store this template in your AltiumToPlm\Templates folder. 

12. Close the Dashboard GUI

Click the Dashboard tab. Click the Exit shortcut within the main Dashboard panel. 


Back to Release to PLM - Quickstart

Have more questions? Submit a request


Please sign in to leave a comment.
Powered by Zendesk