PLM Integration SDK

The PLM Integration SDK lets you build a custom connector between an Altium 365 Workspace and any PLM system – including systems not supported out of the box – while fitting into the same PLM Integration workflow that Altium 365 users already know.

The SDK is a C# framework that implements the Generic PLM Connector interface: a gRPC service that Altium 365 calls to communicate with a PLM instance. You implement the connector logic; Altium 365 handles the Workspace side of the integration.

SDK repository and full documentation: AltiumDeveloper/plm-integration-sdk-cs

When to Use It

Use the PLM Integration SDK when any of the following apply:

  • Your PLM is not natively supported – Altium 365 supports several PLM systems directly. For everything else, the Generic Connector model lets you build a first-class integration that behaves the same way from the Workspace perspective.

  • You need custom integration logic – mapping rules, lifecycle behaviors, or synchronization nuances that go beyond what the standard configuration UI or XML-based setup can express.

  • Enterprise deployment constraints – on-premises gateways, controlled packaging, or deployment patterns that require owning the connector as a deployable service.

How it Works

Altium 365 communicates with the connector over gRPC. Your connector runs as a service that receives calls from the platform and translates them into operations on your PLM system.

Before every operation, Altium 365 calls an Auth endpoint to verify that the credentials the user configured will allow access to the PLM. An IContext containing those credentials is then made available throughout the call chain via dependency injection – you don't need to pass credentials manually between operations.

Operations

The PLM Integration SDK implements the following operations:

Operation

Description

Sync to PLM

Reads components from Altium 365 and creates or updates corresponding items in the PLM

Sync to Altium

Queries the PLM for items and stores the data back in Altium 365

Publish BOM

Runs during project publication; creates relationship definitions between the project and its PLM items

Publish Project

Creates or updates all project components, uploads file attachments, and establishes relationships; may advance workflow state if configured

For a detailed walkthrough of each flow, see the Operations Flow article.

Getting Started

  1. Clone or fork AltiumDeveloper/plm-integration-sdk-cs. The repository includes a working example implementation backed by file system storage – a useful reference for understanding how operations map to PLM calls.

  2. Familiarise yourself with how PLM Integration works in Altium 365 – particularly the Generic Connector model, connection setup, and sync direction configuration.

  3. Implement the connector interfaces for your PLM system and deploy the service where Altium 365 can reach it.

  4. Register the connector in your Workspace under Admin → PLM Integration.

Requirements

Enterprise license – PLM Integration (including the Generic Connector driver) is an Enterprise Toolkit feature. The Generic Connector option will not appear in the PLM connection configuration without the appropriate license assigned to your Workspace.

Further Reading

如您发现任何问题,请选中相关文本/图片,并按 Ctrl + Enter 键向我们提交反馈。
Content