PLM Integration with Altium NEXUS Server

The Altium NEXUS Server can be hooked up to one or more PLM instances, with direct support for Windchill®, Arena® PLM and Oracle® Agile™ PLM. Interface configuration is performed through the NEXUS Server's browser interface, with most configuration defined within an XML-based configuration file (uploaded to the Server). With the interface set up and working, features and functionality are provided when working in the following distinct areas:

• Library (components) – catering for the uni- or bi-directional synchronization of your components, component parameters, and part choices, between your NEXUS Server and your PLM instance. Configuration allows you to specify which parameters are mastered in which system. In addition, Item parameters enable you to update properties in the NEXUS Server (configurable per field), without having to formally release a new revision of that Component Item. A dedicated Part Request workflow is also available that supports the automatic creation of a Component in your PLM instance, and also the propagation generated PLM part numbers back to components in NEXUS.
• Design (projects) – a dedicated Project Creations workflow is available that supports the automatic creation of part numbers in your PLM instance, and then propagation of these as Server Parameters of the NEXUS Managed Project. Such parameters can be used in special strings (e.g. for sheet border annotations). You have the ability to publish your design to your PLM instance, as part of running the Project Releaser in Altium NEXUS. The publishing operation uses a publishing template – defined as part of the PLM instance integration configuration – to control how data should be propagated to the PLM. And if you're publishing for the first time and part numbers (on the PLM side) are not yet associated with the managed project, those part numbers will be created in the PLM and associated to the project as part of that initial publication. You also have the ability to define component entries for NEXUS managed components in the PLM instance, as part of the publishing operation (optional, based on configuration). And you'll always be able to see exactly what has been created, such as part numbers in the PLM instance, as part of the process workflow's history (History tab).

PLM Support

The Altium NEXUS Server provides direct support for the following PLM systems:

• Windchill PLM (11.0 M030)
• Arena PLM
• Oracle Agile PLM
• Generic PLM – the NEXUS Server also offers a Configuration Generator that creates a generic PLM configuration by analyzing the data model of the current NEXUS Server installation.

In situations where it is not possible to connect between the NEXUS Server and a company enterprise system, component data exported from that system may be imported into the NEXUS Server using its supplied CSV Import command line tool.

Connecting to Your PLM Instance

Connection to your PLM instance is performed from the Admin – PLM Integration page of the NEXUS Server's browser interface. This involves uploading the applicable XML-based configuration file and publishing template, and enabling/configuring synchronization of your PLM components with those in the NEXUS Server.

To create a new PLM interface instance, click the  button. As many instances can be defined as required, to interface your Altium NEXUS Server to various different PLM instances. For example, your components might reside in one PLM instance, with the generated output from released design projects in another, or perhaps different divisions are using different instances (of the same or differing PLM system). Each instance must be uniquely named, have a configuration file and one or more defined publishing templates. To test the connection for a defined instance, click the  button.

Sample configuration files and publishing templates are provided as part of the installation – click on the sections below for more information:

When adding a new PLM entry from the button, use the button to browse to and then apply a suitably saved/modified PLM configuration.

Similarly, a compatible publishing template is added through the button under the Publish Template tab. In the following Publish Template dialog use the button to browse to and select the correct template file.

Add and configure the interface to your company's PLM system. With a valid connection, you can then publish project release data to the PLM system (using defined process definitions)
in accordance with an active publishing template for the instance, and also schedule synchronization of components between that PLM and your NEXUS Server.

Rather than using the supplied configuration files to create a new enterprise system instance, the NEXUS Server's internal configuration generator may be used to create a custom configuration for access to, potentially, any enterprise system – click on the following expanding section for more information:

Connection Validation

The NEXUS Server offers a comprehensive PLM Instance connection validation check, which is available from the button in the Add/Edit Instance page. This will perform a range of configuration compatibility checks and immediately report the results.

When the connection validation report is run, the server analyses the current configuration and publishing template settings for compatibility with both the NEXUS Server and target PLM data. Configuration issues such as path errors, unmatched component type definitions and parameters, invalid Lifecycle or Revision settings are detected and reported in the following Configuration Validation Report dialog.

The reported errors and warnings may be then corrected in the applied configuration/publishing files, and/or by making changes in the settings of the server or PLM instance.

Component Synchronization

Synchronization of components between the NEXUS Server and the connected PLM instance – or to be more specific, their parametric data – is based on the LibSync process workflow. The LibSync process is predefined in the NEXUS Server and not accessible (or editable) from the server's Admin - Processes page. However as a workflow based process, the results of its synchronization action may be viewed and any errors handled.

Using the synchronization process involves the following:

• Configuring the synchronization setup for each component type, which in practice is:
  • Determining the direction of synchronization (to the server, or to the PLM).
  • Determining which components types are involved, and where new components are to be created.
  • Configuring the mapping or parameter attributes.
• Performing the synchronization.

The first item is handled in the configuration file used for the connected PLM instance. The synchronization itself can be performed on-demand, from the PLM Integration page of the NEXUS Server's browser interface, and/or can be scheduled – automated synchronization at periodic intervals, defined when configuring the connection to the PLM instance.

Configuring Synchronization

Within the configuration file, you define a section for synchronization mapping for each dedicated part type. On the NEXUS Server side, this is the component of type altiumType – its value is one of the type parameters options can be seen in the Component Type dialog in the NEXUS design client space. On the PLM side, a part is created of type plmType, as determined by its value in the PLM space.

The section is declared as an Entity in the file, an example of which might be, for capacitors:

<Entity altiumType="Capacitor" plmType="Capacitor">
--
</Entity>

Within the Entity, two sections are used to control and configure synchronization from the NEXUS Server to the PLM instance, and the PLM instance to the NEXUS Server – allowing for uni- or bi-directional synchronization. Use the following sections, in conjunction with the comments available in the sample configuration files, to learn more. Ultimately, what gets defined in the configuration file will vary, depending on your specific needs.

<Attributes>

<!-- Name/Comment from NEXUS will be passed to PLM field Name 'as is' -->
<common:Attribute>
	<common:Key>Name</common:Key>
	<common:Value>${parameter.Name}</common:Value>
</common:Attribute>

<!-- Number generated on PLM side will be propagated to NEXUS -->
<!-- as PlmPartNumber parameter (note: any parameter name can be used)-->
<common:Attribute attributeType="revision" primaryKeyOrdinal="1">
	<common:Key>Number</common:Key>
	<common:Value>${parameter.PlmPartNumber}</common:Value>
</common:Attribute>

<!-- NEXUS component description will go to PLM field Description. Value will be prefixed with 'Extended' -->
<!-- Description on NEXUS side is a revision level parameter -->
<common:Attribute attributeType="revision">
	<common:Key>Description</common:Key>
	<common:Value>Extended ${parameter.Description}</common:Value>
</common:Attribute>

<!-- This attribute will not be pushed to PLM component as part of library synchronization -->
<!-- It is being used to pass values during project publish with BOM -->
<common:Attribute>
    <common:Key>Reference Designator</common:Key>
    <common:Value>${parameter.LogicalDesignator}</common:Value>
</common:Attribute>

<!-- RoHS field in PLM will be set to 'YES' -->
<common:Attribute>
	<common:Key>RoHS</common:Key>
	<common:Value>YES</common:Value>
</common:Attribute>

</Attributes>

<Attributes>

<!-- Name field from PLM will be passed to name/comment field in NEXUS -->
<common:Attribute attributeType="revision">
	<common:Key>name</common:Key>
	<common:Value>${attribute.Name}</common:Value>
</common:Attribute>

<!-- Description field from PLM will be passed to Description field in NEXUS on revision level -->
<!-- Revision level attributes will cause new revision to be created in case parameter value is changed -->
<common:Attribute attributeType="revision">
	<common:Key>Description</common:Key>
	<common:Value>${attribute.Description}</common:Value>
</common:Attribute>

<!-- Number field from PLM will be passed to PlmPartNumber field in NEXUS on revision level  -->
<!-- Note: any attribute name can be used -->
<common:Attribute attributeType="revision" primaryKeyOrdinal="1">
	<common:Key>PlmPartNumber</common:Key>
	<common:Value>${attribute.Number}</common:Value>
</common:Attribute>

<common:Attribute attributeType="item">
	<common:Key>DynamicCONTS</common:Key>
	<common:Value>Will not cause revision update if changed ${attribute.LastModified}</common:Value>
</common:Attribute>

</Attributes>

Performing Component Synchronization

Component (library) synchronization may be performed as a manual or timed process, from the Sync action button of a PLM instance entry on the PLM Integration page or as an automated cycle specified in the instance setup, respectively. Click the  control associated with the PLM instance that you wish to synchronize. The synchronization process will proceed through the LibSync workflow, in accordance with the settings defined in the associated configuration file.

The control changes to . If you want to stop the synchronization process, click this control. A confirmation window will appear, click  to stop the synchronization – all components already synchronized will remain so, but no further synchronization beyond that point will occur.

Component synchronization in progress between the NEXUS Server and the indicated PLM instance.

When component synchronization is run, the LibSync process moves through its predefined Workflow until it completes or encounters an error. Refresh the browser (F5) to show the current state of the sync process. To monitor or review the LibSync process, select the Synchronization status tab and choose the Closed listing option – if a process is still running it will show in the Active listing.

The view’s sub-tabs provide the following information:

• Diagram – a graphic representing the process workflow, with its current step position highlighted (Competed or the error/failure state).
• Data – an information summary of the process action, including the success or failure of its steps and a link to the logged process report – see below..
• History – a time log of the main Workflow events listed in sequence.

The LibSync process results are also available in the Process Management page (Admin » Processes) under the Browser tab.

The details of the selected LibSync event shown under the Data sub-tab include a link to the system log file (PLM [date-number].log) for the event.

Scheduled Synchronization

You also have the ability to schedule automated synchronization. To do so, edit the PLM instance (from the main PLM Integration page, click on its name, or the associated  control), select the Component Synchronisation tab and enable the Synchronize PLM Components with server on schedule option. Use the Synchronize every controls to set up the automated sync schedule as required. The system is very flexible and allows you to:

• Set up scheduled synchronization every 15/30/45/60/75/90 minutes.
• Set up scheduled synchronization every x hours.
• Set up scheduled daily synchronization, to be performed at a nominated time.

The schedule you define will be reflected back on the main PLM Integration page, in the Sync scheduled column.

Setting up a synchronization schedule.

To set up scheduled synchronization requires you to provide valid user credentials (for your PLM system). The credentials should have already be registered when setting up the PLM instance, but if not, click the  button and enter your User name and Password into the subsequent PLM Credentials window. Without valid credentials, scheduled synchronization will remain in the OFF state. On-demand synchronization will also not be possible.

You can also run the synchronization process on-demand. Click the  button and choose which mode of sync you need:

• Incremental – in this mode, only those components that have been modified since the last synchronization was run (i.e. their timestamp is later than the last synchronization date), and that pass the synchronization criteria in the configuration file, will be included in the sync, with changes propagated accordingly. This is the default mode, and is the same mode that is run by clicking the  control for a PLM instance on the main PLM Integration page.
• Full – this mode forces a full synchronization. All components that pass the synchronization criteria in the configuration file will be be included in the sync, with changes propagated accordingly.

Process Workflows

The following process definitions (and underlying workflows) are available, in support of PLM integration:

• Part Requests process theme:
  • Part Request with PLM Part Create – supporting the automatic creation of a Component in your PLM instance, and then propagation of the generated part number back to the component in NEXUS. The workflow diagram is shown below.

One important thing to note is that when you modify this sample definition to create your own, you must specify the PLM instance into which parts are to be created. Select the Create Part in PLM entity in the workflow diagram and choose the PLM instance from the drop-down menu associated with the PLM Instance field. This menu lists all currently defined PLM instances (as defined on the PLM Integration page of the interface).

► See Creating and Managing Processes for more information on working with process workflows.

• Project Activities process theme:

• Publish to PLM (User selects) – publish of released managed project outputs to the integrated PLM instance, where the user is able to select exactly which outputs get published. The workflow diagram is shown below.

• Project Releaser with Publish – publish to the integrated PLM instance as an additional stage of the Project Releaser. The workflow diagram is shown below.

• Project Creations process theme:
  • Project with initialise in PLM – supporting the automatic creation of part numbers in your PLM instance, and then propagation of these as Server Parameters of the NEXUS Managed Project. The workflow diagram is shown below.

Accessing PLM-related Processes

The following sections highlight where to access activated PLM-related processes. And since the samples cannot be used out-of-the-box, the following were created from them, for the purpose of illustration:

• PR with PLM Part Create – created from the sample process definition: Part Request with PLM Part Create.
• Publish to Company PLM – created from the sample process definition: Publish to PLM. X
• Publish to Company PLM – Choose Data – created from the sample process definition: Publish to PLM (User selects).
• Project Releaser with Publish to Company PLM – created from the sample process definition: Project Releaser with Publish.
• Create Project with PLM Initialise – created from the sample process definition: Project with Initialise in PLM.

Remember that Administrators for the Altium NEXUS Server can start a new instance of any activated process definition – directly from the corresponding process theme tab within the Processes area of the NEXUS Server's browser interface – by clicking the  control.

Part Requests

Access from within Altium NEXUS from the Explorer panel, after having conducted a search, from within the Details pane of the Manufacturer Part Search panel, or from the link at the bottom of the component listing in the Components panel.

From the Altium NEXUS Server's browser interface, the activated process definition can be accessed from the Part Requests page, by clicking the  button at the top-right of the page.

Project Activities

Standard Publishing Processes

Standard publish to PLM processes (with or without user selection) can be accessed from within Altium NEXUS from the Project » Project Activities sub-menu for the active project.

From the Altium NEXUS Server's browser interface, the activated process definition can be accessed from the detailed view for a managed project, by clicking the  button.

Publishing with the Project Releaser

The process for publishing to a PLM instance as part of the Project Releaser can be accessed from within Altium NEXUS from the Project » Project Releaser sub-menu for the active project.

The Project Releaser will appear, with an additional stage – Stage 7 Publish to PLM. In addition, a command is available from the menu associated to the  button – Prepare & Release & Publish to PLM – should you wish to run the Project Releaser without stopping to review the generated data, and execution report.

If you run the Project Releaser with the standard Prepare command, after reviewing and releasing the data, the  button will be presented at the Execution Report stage. Click this to continue the underlying workflow for the process, to publish to the PLM. The Login Credentials dialog will appear. Enter the Username and Password for your PLM instance, and select the PLM Template you want to use (which appears in the form <PLMInstance>:<PublishingTemplate>).

If you chose to use the Prepare & Release & Publish to PLM command, you will ultimately be presented with the Login Credentials dialog directly. The Project Releaser will not pause at the Execution Report stage, and no  button will be presented.

Click on the Diagram tab to see the underlying workflow for the process.

Click the  button to proceed with the publishing process, in accordance with that workflow.

Check the status of the publish to PLM process through the NEXUS Server's browser interface, from the Activities tab within that project's detailed view.

Project Creations

Access from within Altium NEXUS from the main File » New » Managed Project sub-menu.

From the Altium NEXUS Server's browser interface, the activated process definition can be accessed from the main Projects page of the interface, by clicking the  button.

And also from the detailed view for a managed project, by clicking the  menu button.

The process workflow will proceed, with a dialog to enable you to define the project, in terms of its name, description, type, and any Project Template Item that should be used in its creation. After clicking Start, the Login Credentials dialog will appear. Enter the Username and Password for your PLM instance, and select the PLM Template you want to use (which appears in the form <PLMInstance>:<PublishingTemplate>). Then click Submit to proceed with the workflow.