TIA Portal Teamcenter Gateway
Scope
Teamcenter Gateway workflows exposed by Siemens.Engineering.TeamcenterGateway.
The V21 API is provider-based: connection, lock, search/download, and workflow
operations are separate services.
Reference files
Load ONLY the reference file(s) relevant to the task.
| Reference file |
Load when the task involves |
references/workflows-and-safety.md |
Provider acquisition, credentials, connection ownership, search/download, checkout/check-in, save workflows, cache overwrite, and remote-write safety. |
references/v21-api-surface.md |
Complete installed V21 Siemens.Engineering.TeamcenterGateway type and member surface. |
Installed V21 entry points
Portal-scoped providers:
TeamcenterConnectionProvider connections =
tiaPortal.GetService<TeamcenterConnectionProvider>();
TcGatewayLockProvider locks =
tiaPortal.GetService<TcGatewayLockProvider>();
TcGatewaySearchAndDownloadProvider searchAndDownload =
tiaPortal.GetService<TcGatewaySearchAndDownloadProvider>();
The save provider belongs to the opened project or global library:
TcGatewayWorkflowProvider workflow =
project.GetService<TcGatewayWorkflowProvider>();
Do not introduce an intermediate service or storage composition that is absent
from these installed entry points.
Enforcement
- Require the exact endpoint, Teamcenter instance, user/group/role or SSO application identity, and expected item/revision/dataset identity.
- Keep passwords in
SecureString; treat TcGatewayConnectionInfo.SessionToken as a secret and never log or serialize it.
- Require explicit remote-write authorization for checkout, check-in, checkout cancellation, overwrite download, and every save/new-item/new-revision operation.
- Treat
LocalCacheOption.Overwrite as destructive. Use it only for an exact, pre-inventoried cache target.
- Resolve search results to exactly one expected item and revision. Never use
.First() or [0] as selection logic.
- Disconnect in
finally only when the current operation established the connection; do not terminate a caller-owned Teamcenter session.
- Checkout cancellation is not rollback and does not discard local project/library changes. Do not use it as unconditional cleanup.
- Do not claim a save, check-in, download, or disconnect succeeded without checking the returned result and/or re-reading authoritative Teamcenter state.
Evidence boundary
Installed V21 assemblies and XML documentation prove provider names, signatures,
types, and enum members. Endpoint reachability, license, credentials, permissions,
dataset locks, cache behavior, and remote persistence require an authorized live
Teamcenter Gateway test.
1---2name: tia-teamcenter3description: TIA Portal V21 Teamcenter Gateway operations. Use for connecting to Teamcenter, searching/downloading managed projects or libraries, dataset locking, and saving projects or global libraries through the installed provider APIs.4license: MIT5---67# TIA Portal Teamcenter Gateway89## Scope1011Teamcenter Gateway workflows exposed by `Siemens.Engineering.TeamcenterGateway`.12The V21 API is provider-based: connection, lock, search/download, and workflow13operations are separate services.1415## Reference files1617Load ONLY the reference file(s) relevant to the task.1819| Reference file | Load when the task involves |20|---|---|21| `references/workflows-and-safety.md` | Provider acquisition, credentials, connection ownership, search/download, checkout/check-in, save workflows, cache overwrite, and remote-write safety. |22| `references/v21-api-surface.md` | Complete installed V21 `Siemens.Engineering.TeamcenterGateway` type and member surface. |2324## Installed V21 entry points2526Portal-scoped providers:2728```csharp29TeamcenterConnectionProvider connections =30 tiaPortal.GetService<TeamcenterConnectionProvider>();31TcGatewayLockProvider locks =32 tiaPortal.GetService<TcGatewayLockProvider>();33TcGatewaySearchAndDownloadProvider searchAndDownload =34 tiaPortal.GetService<TcGatewaySearchAndDownloadProvider>();35```3637The save provider belongs to the opened project or global library:3839```csharp40TcGatewayWorkflowProvider workflow =41 project.GetService<TcGatewayWorkflowProvider>();42```4344Do not introduce an intermediate service or storage composition that is absent45from these installed entry points.4647## Enforcement48491. Require the exact endpoint, Teamcenter instance, user/group/role or SSO application identity, and expected item/revision/dataset identity.502. Keep passwords in `SecureString`; treat `TcGatewayConnectionInfo.SessionToken` as a secret and never log or serialize it.513. Require explicit remote-write authorization for checkout, check-in, checkout cancellation, overwrite download, and every save/new-item/new-revision operation.524. Treat `LocalCacheOption.Overwrite` as destructive. Use it only for an exact, pre-inventoried cache target.535. Resolve search results to exactly one expected item and revision. Never use `.First()` or `[0]` as selection logic.546. Disconnect in `finally` only when the current operation established the connection; do not terminate a caller-owned Teamcenter session.557. Checkout cancellation is not rollback and does not discard local project/library changes. Do not use it as unconditional cleanup.568. Do not claim a save, check-in, download, or disconnect succeeded without checking the returned result and/or re-reading authoritative Teamcenter state.5758## Evidence boundary5960Installed V21 assemblies and XML documentation prove provider names, signatures,61types, and enum members. Endpoint reachability, license, credentials, permissions,62dataset locks, cache behavior, and remote persistence require an authorized live63Teamcenter Gateway test.
czarnak