Skip to main content
Technical Preview

Overview

Siemens Teamcenter is the PLM system that owns parts, revisions, BOMs, drawings and change processes for many plants. This connector lets shop-floor logic on MQTT read the released revision and BOM of a part, find its released drawing for a work instruction screen, and raise a problem report from a quality event, without custom code. SiemensTeamcenterApi (SiemensTeamcenterRestApi.lot) is one client connector on https://YOUR_TC_SERVER with 18 events: 1 login, 14 reads and 3 writes. No event deletes, revises or checks out anything.
Teamcenter exposes every SOA service operation as JSON over HTTP: POST /tc/JsonRestServices/<Library>-<YYYY>-<MM>-<Service>/<operation> with a body of {"header": {"state": {}, "policy": {}}, "body": {...}}. Siemens does not publish an OpenAPI file for Teamcenter. Your installation can generate its own API description (Active Workspace npm run genSoaApi). The events here follow public samples: the Teamcenter REST API Postman collection, TCSwiftBridge and the Mendix Teamcenter connector docs. To add another operation, copy an event and change the operation path.

Server host

Teamcenter is installed per customer, or runs as Teamcenter X (SaaS). Replace YOUR_TC_SERVER with your web tier host, with no trailing slash. Add the port when the web tier does not use 443 (for example :7001 or :8080). Behind the Active Workspace gateway, the same operations are also served under /tc/RestServices/ and need an X-XSRF-TOKEN header. This template uses /tc/JsonRestServices/ on the web tier.

Authentication

Teamcenter sessions act as their user. Keep the user and password in Hub secrets, map them in with GET SECRET, and never publish the session cookie on a topic other clients can read.
  1. Publish the credentials on mes/siemens-teamcenter/session/login. The web tier answers with a JSESSIONID cookie (Set-Cookie).
  2. Send "cookie": "JSESSIONID=<id>" in every other payload. One session holds one Teamcenter server process, so reuse it instead of logging in per call.
JSESSIONID only comes back in the Set-Cookie header, not in the response body. It is not yet verified whether the broker’s REST client keeps cookies per connector or passes Set-Cookie on. Until that is confirmed, get the session outside the broker and keep the cookie on internal/siemens-teamcenter/cookie (the example actions read it there). Sites that use Teamcenter SSO or Teamcenter X log in through Siemens SSO. They need a session from that login flow, which this template does not cover.

Payload convention

  • request: the full SOA envelope, sent as the body unchanged. header.policy picks which properties come back (types[].properties[].name).
  • cookie: the session cookie, JSESSIONID=<id>.
  • Objects are referenced as {"uid": "...", "type": "ItemRevision"}. Some operations take plain UID strings.

Events

Replies arrive on <topic>/response.

Flows

Item revision and BOM

  1. GetItemFromId with the item ID returns the item and revision UIDs.
  2. CreateBomWindow with the item UID returns a BOM window and its top BOM line.
  3. ExpandBomOneLevel or ExpandBomAllLevels with the top BOM line returns the children. The property policy in header.policy sets which item revision fields come back.
  4. CloseBomWindow frees the window on the server.

Released drawing for work instruction display

  1. GetItemFromId returns the revision UID.
  2. GetProperties on the revision with release_status_list, date_released, IMAN_specification and IMAN_Rendering tells you whether the revision is released and which datasets hold its drawing. You can also use ExpandGrmRelationsForPrimary with relationTypeName IMAN_specification.
  3. Show the dataset in Active Workspace, or download the file through FMS. File download (getFileReadTickets and FMS) is not part of this template.

Problem report from a quality event

  1. CreateProblemReport creates an item of your problem report type (ProblemReport in the example) in a folder.
  2. CreateRelations links the affected revision to the problem report revision.
  3. StartWorkflow starts your change process template on it.
The type name, relation type and workflow template depend on your Change Management setup. Confirm them with your Teamcenter administrator.

Example actions

docs-helper-actions.lot holds example actions. They log in every 25 minutes with Hub secrets, look up an item or a revision’s drawing datasets when a station asks, and create a problem report from a quality event.

Not included

  • Delete, revise and checkout operations (left out on purpose).
  • File download and upload through FMS (binary content).
  • BOM edits (addOrUpdateChildrenToParentLine, saveBOMWindows).
  • Teamcenter SSO / Teamcenter X login services and the AWC gateway /tc/RestServices/ variant.

Status

Blocked (beta). Every event works against a local mock Teamcenter web tier, and the connector passes lot_lint. No call has run against a real Teamcenter server. To clear the live test, the factory needs:
  • the web tier URL,
  • a Teamcenter service user and password (or SSO client details and a way to get JSESSIONID),
  • a test item with a released revision, a BOM and a drawing.

Connector file

Last modified on October 21, 2026