TeamcenterKnowledge

Reference

Local Teamcenter 2506 documentation sources

Everything here is on this machine. No Support Center login, no network.

Inventory

Source Path Size Authority on
Help Server app http://localhost:51000 - Product help browsing
WSDL + XSD schemas D:\Siemens\Help Server\soa_client_wntx64\soa_client_wntx64\wsdls\ 1,962 files The wire contract: required vs optional members
Services Reference D:\Siemens\Help Server\docs-teamcenter-2506-services_reference\services_reference\ ~1.1M files Per-operation prose, deprecation notices with named successors
Java API javadoc D:\Siemens\Help Server\docs-teamcenter-2506-javadoc\javadoc\ ~4,400 files Java types and classes
SOA Client SDK D:\Siemens\Help Server\soa_client_wntx64\soa_client_wntx64\{java,cpp,net}\ 180 Java sample files End-to-end client flow patterns
SOA toolbox D:\Siemens\Help Server\soa_client_wntx64\soa_client_wntx64\toolbox\ - TcSoaTools.jar, TcSoaWeb.jar, Ant, schemas

The wsdls\ directory is the ground truth

Naming: <Package><YYMM><ServiceName>.wsdl and .xsd, for example Cad1906StructureManagement.xsd for the cad._2019_06 interface.

The .wsdl declares <wsdl:operation name="..."> and maps its input message to an element. The .xsd defines that element's structure. The .xsd is where minOccurs lives, and minOccurs is the single most load-bearing fact in the whole schema. An <xsd:element> with no minOccurs attribute defaults to required.

The true service identity is the .xsd's targetNamespace, not the filename:

http://teamcenter.com/Schemas/Cad/2019-06/StructureManagement
   -> route  Cad-2019-06-StructureManagement

http://teamcenter.com/Schemas/Internal/Administration/2007-06/Authorization
   -> route  Internal-Administration-2007-06-Authorization

The additive-version trap

Teamcenter's SOA schema is additive per version. An operation appears only in the file for the version it was introduced at, not in every later release's file. Grep the version file matching the java package name (_2019_06 becomes 1906), not the deployment's own release number. Looking for a 2019 operation in Cad2506StructureManagement.xsd finds nothing and reads like "not supported on 2506."

What the kit does NOT contain

The SDK ships the public services only. Active Workspace's internal operations are real, in daily use, and absent:

  • Internal-ActiveWorkspaceBom-2025-06-OccurrenceManagement/addObject5
  • Internal-IcsAw-2019-12-Classification/findClassificationInfo3
  • AttrTargetMgmtAW/importParameterExcel, AttrTargetMgmt/createParameters
  • Internal-AWS2-*

"Not in the WSDLs" is not evidence the operation does not exist. Capture those from the AWC: see ../skills/tc-capture-awc-calls/SKILL.md.

The Services Reference

services_reference/
  java_loose/    <- read this one
  java_strong/
  net/
  soa/           <- Doxygen C++ client doc, NOT the wire protocol

Page path pattern:

java_loose/<Template>/com/teamcenter/services/loose/<domain>/_<YYYY_MM>/<Service>.html

<Template> is the deployment template that ships the service and is not predictable from the domain name: cad lives under Foundation. There are 102 templates including Foundation, AttrTargetMgmt, AttrTargetMgmtAW, Cla0classification, SystemsEngineering, Hrn, IppeCore, TargetManagement, ValidationContract, MDConnectivity, TestManagement. Find the right one with a path search rather than guessing:

find "D:/Siemens/Help Server/docs-teamcenter-2506-services_reference/services_reference/java_loose" \
     -path "*loose/cad/_2019_06*" -name "*.html"

Read the method-detail section, not just the summary table. Deprecation notices and the exact required/optional prose per parameter are there.

The SDK samples: useful for flow, not for correctness

java/samples/, cpp/samples/, net/samples/ contain domain-named projects: HelloTeamcenter, HelloTcLoose, HelloTcSoap, HelloTcWeb, HelloTcOauth, HelloTcOauthWeb, FileManagement, Classification, ContentManagement, cpdsearch, WireHarness.

All three languages' WireHarness sample still calls createBOMWindows, which has been a deprecated silent no-op since Teamcenter 12.2. The samples show you the shape of a client session; they do not show you which operation is current.

The generated indexes in this repo

Built from the sources above so nobody has to grep 1,962 files mid-task:

File Contents Built by
../data/soa_wsdl_index.json 1,464 operations, 214 service classes, each with its JSON REST route, .wsdl, .xsd and request struct name ../scripts/build_soa_index.py
../data/soa_deprecations.json 174 deprecated operation names, 188 occurrences, 92 with an explicitly named successor ../scripts/build_deprecations.py

Query them:

python scripts/soa_lookup.py createOrReConfigureBOMWindows
python scripts/soa_lookup.py --grep dataset
python scripts/soa_lookup.py --struct CreateWindowsInfo3 --xsd Cad1906StructureManagement.xsd

Two crackings these sources made possible

  1. createBOMWindows had been deprecated since TC 12.2. Two earlier passes concluded the web-tier SOA gateway could not read occurrence or BOM structure at all, and proposed writing a compiled server-side ITK translator. The Services Reference said @Deprecated with a named successor, and the successor's XSD said every inapplicable ModelObject slot must be NULLTAG. Once the request matched the actual schema, it returned a real BOMWindow and BOMLine, and expandPSAllLevels returned 26 named connector objects. No admin fix, no ITK, no deployment change. The data was always reachable; the calls were wrong.

  2. getTypeDescriptions2 is on Core-2015-10-Session, not DataManagement. Called on the wrong service it returns a generic InternalServerException for every type name including real ones, which looks exactly like a broken feature. Grepping the operation name across every .xsd found the real owner in under a minute.

Non-SOA administrative utilities (TC host, DBA group)

Not reachable over SOA; they need shell access on the Teamcenter server.

Utility Purpose
plmxml_import Bulk-load classification hierarchy and ICO placements
clsutility -import -hierarchy Classification hierarchy only
ics_connect -file= Classification placements only
smlutility -create_indexing_views Rebuild the classification search index
ums_import_unit_definitions Load units from unit_definitions.csv; has -dryRun, strongly recommended
ums_mapping -analyze -report_file= Read-only legacy-UoM to UMS mapping report
tcxml_export / tcxml_import Object export/import; -bulk_load and -low_level can be licence-blocked

%TC_ROOT%\bin has no generic object-create utility. The -u=infodba -pf=...\security\config1_infodba.pwf -g=dba CLI pattern that works for ums_import_unit_definitions does not extend to creating business objects.


Generated from references/doc-sources.md in the tc-automation-skills library, which is the canonical copy and also serves as the agent skill set for Teamcenter work.