Optional Configuration Settings for Teamcenter Connectors

DefaultArchitectureType Setting

The DefaultArchitectureType setting defines the default architecture type used by the Teamcenter API to determine how the Bill of Materials (BOM) structure is generated.

Purpose

The DefaultArchitectureType setting acts as a fallback configuration when the architecture type is not defined in the pdmconnconfig.xml file. The DefaultArchitectureType setting directly influences how BOM data is structured and interpreted during integration with Teamcenter.

Valid Values

  • 2: two-tier BOM structure
  • 4: four-tier BOM structure (typically more detailed)

Example Configuration

<DefaultArchitectureType>4</DefaultArchitectureType>
In this case, a four-tier BOM structure is applied by default.

Parsers Configuration

The <Parsers> section maps specific PLMXML tags to internal parser components used by Altair products.

These mappings instruct the system on how to interpret various element types during import and translation.

Guidelines

  • It is very important that you do not rename or alter Parser names because they are tightly coupled to internal logic.
  • To add support for new PLMXML elements, contact Altair development.
  • Each Parser is defined by:
    • A name attribute (the Parser module identifier)
    • One or more <Value> tags representing the PLMXML tags handled by that Parser

Example Configuration

<Parsers>
  <!-- Maps multiple PLMXML types to the PartParser -->
  <Parser name="PartParser">
    <Value>DesignRevision</Value>
    <Value>ValidationCheckRevision</Value>
    <Value>ProductRevision</Value>
    <Value>OperationRevision</Value>
    <Value>ConnectionRevision</Value>
    <Value>ValidationCheckRevision</Value>
    <Value>GDE</Value>
    <Value>ConnectionRevision</Value>
  </Parser>
  <!-- Maps instance-based tags to the ProductInstanceParser -->
  <Parser name="ProductInstanceParser">
    <Value>ProductInstance</Value>
    <Value>ConnectionInstance</Value>
    <Value>Instance</Value>
    <Value>CompositionInstance</Value>
    <Value>ConnectionInstance</Value>
    <Value>GDEInstance</Value>
  </Parser>
</Parsers>
Note: More parser configurations are included in the full pdmsyscfg.xml file. These configurations cover additional PLMXML elements like: User, Role, Form, Dataset, and more.

TransferContexts Configuration

The <TransferContexts> section defines how product structure and related data are extracted and mapped for various integration workflows.

Each <TransferContext> section specifies the object types, relationship logic, and search priorities relevant to that particular context.

Purpose

The purpose of the <TransferContexts> section is to:
  • Control the behavior of BOM translation and data import.
  • Tailor behavior for different CAD/CAE workflows or schema formats.
  • Identify which elements serve as prototypes, occurrences, and structural roots.

Core Elements of Each TransferContext

name
A unique label identifying the context (like, CUSTOM_CAE_ExternalProcess or Smaragd).
<PrototypePart>
Defines which object type(s) act as the main item or revision.
This element is optional.
<OccurrencePart>
Specifies which object type(s) represent instances or children within the BOM.
<RootIdSearchOrder>
Determines the priority order used to identify the root node of the structure.
<GeneralRelationTypes>
Lists relationship tags that should be parsed when constructing connections.
This element is optional.

Example: CAE External Process Context

This context is designed for CAE workflows involving prototype and occurrence part parsing. It supports Teamcenter specific (TC_*) and generic (CAE_*) relation types.
<TransferContext name="CUSTOM_CAE_ExternalProcess">
  <PrototypePart>
    <Value>ProductRevision</Value>
  </PrototypePart>
  <OccurrencePart>
    <Value>Occurrence</Value>
    <Value>ProductInstance</Value>
  </OccurrencePart>
  <RootIdSearchOrder>
    <Value>ProductView</Value>
    <Value>Header</Value>
  </RootIdSearchOrder>
  <GeneralRelationTypes>
    <Value>TC_CAE_Source</Value>
    <Value>TC_CAE_Target</Value>
    <Value>TC_CAE_Include</Value>
    <Value>CAE_Source</Value>
    <Value>CAE_Target</Value>
    <Value>CAE_Include</Value>
  </GeneralRelationTypes>
</TransferContext>

Example: PLMXML Visualization Schema Context

This example is a minimal context focusing on visual schemas. No prototype part is needed; it relies on InstanceGraph for root determination.

<TransferContext name="PLMXMLTcVisSchema">
  <OccurrencePart>
    <Value>ProductInstance</Value>
  </OccurrencePart>
  <RootIdSearchOrder>
    <Value>InstanceGraph</Value>
  </RootIdSearchOrder>
</TransferContext>
Note: More TransferContext configurations are included in the full pdmsyscfg.xml file.

Dataset Configuration

The <Dataset> section defines how Teamcenter Item Revisions are associated with datasets during the Teamcenter to UDM translation process.

The <Dataset> section governs which dataset relationships are considered, how nested datasets are handled, and whether to override default filtering rules.

Key Elements

<Role>
Specifies the exact Teamcenter relation names used to associate datasets with Item Revisions.
  • Purpose: filters which datasets will be included in the UDM translation.
  • Requirement: these relations must exist in your Teamcenter BMIDE configuration.
  • Behavior: only datasets connected via these relations are processed unless OverrideRoles is enabled.
Role examples:
  • IMAN_Rendering: typically used for visualization or rendering files.
  • IMAN_specification: general specification linkage.
  • IMAN_reference: generic reference data linkage.
    <Role>
  <Value>IMAN_Rendering</Value>
  <Value>IMAN_specification</Value>
  <Value>IMAN_reference</Value>
</Role>
<Nested>
Determines how nested datasets (datasets within datasets) are represented in the UDM structure.
Valid values:
  • UDMRepresentation: creates a separate UDM representation part and links it to the prototype part.
  • UDMDataSourceFile: attaches the nested dataset directly as a file under the parent representation part.
Selection guidance:
  • Use UDMRepresentation for clearer separation and traceability.
  • Use UDMDataSourceFile for a flatter, more compact structure.
Example:
<Nested>UDMRepresentation</Nested>
<OverrideRoles>
If enabled (true), the system ignores the <Role> list and instead processes all dataset relations defined in the Teamcenter BMIDE model.
  • Use case: when your organization uses custom relation types not explicitly listed in <Role>.
  • Warning: may significantly increase processing time and memory usage for large configurations.
Example:
<OverrideRoles>false</OverrideRoles>

Form Configuration

The <Form> section defines how Teamcenter Form objects linked to Item Revisions are interpreted and included in the UDM structure.

The <Form> section provides control over both the structural relationship (how forms are connected) and attribute level data transfer (if enabled).

Purpose

The purpose of the <Form> section is to:
  • Interpret and map Form objects in Teamcenter to UDM equivalents.
  • Define how Form attributes are transferred between revisions.
  • Select which relation types are considered for inclusion.
  • Optional: configure attribute propagation using <ManageFormAttributes> (currently commented out by default).

Attribute Mapping Between Revisions (ManageFormAttributes)

The optional ManageFormAttributes block enables attribute transfer between a source Item Revision and a target Item Revision.

Note: This block is currently commented out in the XML and must be uncommented and configured to activate.
Configuration details:
<Source>
itemRevisionType: defines the source IR type (like, ItemRevision).
productIdAttributeName: optionally maps PLMXML productId to a custom UDM attribute name.
<Value>: lists specific Form subtypes to include for attribute mapping.
<Target>
itemRevisionType: target IR type (like, CAEModelRevision).
attributeOverwrite: must be "true" to allow updates to existing attributes.
productIdAttributeName: optional, mirrors mapping logic from source.
Example (commented by default):
<!--
<ManageFormAttributes>
  <Source itemRevisionType="ItemRevision" productIdAttributeName="itemid">
    <Value>ItemRevision Master</Value>
    <Value>catia_model_attributes</Value>
  </Source>
  <Target itemRevisionType="CAEModelRevision" attributeOverwrite="true" productIdAttributeName="itemid"/>
</ManageFormAttributes

Form Association via Relation Types

The <Role> element specifies which Teamcenter relation types are used to associate Forms with Item Revisions.
  • Only Forms linked via the listed relation types will be included unless OverrideRoles is enabled.
  • These roles must exist in your BMIDE configuration.
Supported relation values:
  • TC_Attaches
  • IMAN_master_form_rev
  • IMAN_specification
  • IMAN_manifestation
  • IMAN_reference
Example:
<Role>
  <Value>TC_Attaches</Value>
  <Value>IMAN_master_form_rev</Value>
  <Value>IMAN_specification</Value>
  <Value>IMAN_manifestation</Value>
  <Value>IMAN_reference</Value>
</Role>

OverrideRoles

The OverrideRoles element determines whether to strictly follow the <Role> list or to include all Form types defined in BMIDE.
  • false (default): Uses only the listed relation types in <Role>.
  • true: Ignores <Role> and includes all Form objects regardless of relation.

Not currently supported in HyperWorks products or Inspire UI. Enabling may significantly increase processing time.

Example: 
<OverrideRoles>false</OverrideRoles>

Display and Import Configuration

Learn how attributes are displayed in the GUI (specifically, the More Properties panel), how BOMs are presented, and how PLMXML files are imported into Teamcenter.

DisplayAttributesFailingOrder (Optional, Commented)

The DisplayAttributesFailingOrder element determines the fallback order for retrieving attribute data in the Get More Properties panel.

Valid sources:
  • PartMetadata: retrieves metadata directly from parts.
  • Relations: uses relationship based attribute data.
Important: Use caution if including both sources. Duplicate attributes from multiple sources may cause data conflicts.
It is recommended you define a single preferred source to ensure consistency.
Example (currently commented):
<!--
<DisplayAttributesFailingOrder>
  <Value>PartMetadata</Value>
  <Value>Relations</Value>
</DisplayAttributesFailingOrder>
-->

DisplayAllProperties

The DisplayAllProperties element controls whether empty attributes are shown in the More Properties panel.
  • true: displays all attributes, including those without values.
  • false (default): only displays attributes with values.
Current setting:
<DisplayAllProperties>false</DisplayAllProperties>
It is recommended to use false in most production environments to minimize clutter and improve readability.

BVRRevisionRule

The BVRRevisionRule element defines the revision rule used for generating the BOM displayed in the Explore dialog.
  • The BVRRevisionRule element must match a configured rule in Teamcenter, such as:
    • Any Status; Working
    • Released Only
  • Leave the BVRRevisionRule element blank to use the system default.
Example:
<BVRRevisionRule></BVRRevisionRule>

PLMXMLImport

The PLMXMLImport element defines how the system handles direct PLMXML imports into the Teamcenter server.

The TransferMode element specifies the data import method. The default is: ConfiguredDataImportDefault – optimized for most scenarios.

Example:
<PLMXMLImport>
  <TransferMode>
    	<Value>ConfiguredDataImportDefault</Value>
  </TransferMode>
</PLMXMLImport>

Contact your Teamcenter administrator or Altair development to configure alternative transfer modes as needed.

DownloadFileTypes Configuration

The <DownloadFileTypes> element determines how file types are selected and downloaded from Teamcenter based on the BOM structure or predefined file extensions. This impacts both performance and user experience during data retrieval.

Behavior Control via Attributes

You can control download logic using either the deepSearchLevel or extensionList element, but not both. The deepSearchLevel element is recommended.

If both the deepSearchLevel and extensionList elements are defined, both will be ignored, and the system will default to deepSearchLevel=0.

If neither is defined, the system will also default to deepSearchLevel=0.

  • deepSearchLevel:
    • The deepSearchLevel element defines how many levels of the BOM hierarchy should be traversed to find associated file types.
    • Values:
      • 0: current part only.
      • Higher numbers: deeper scan; may impact performance.
  • extensionList:
    • The extensionList element is a space-separated list of file extensions to filter which file types are shown in the UI.
    • Example: extensionList="asm prt catpart"

FileType Mapping

The FileType element defines parent-child file extension relationships for supported CAD file types. This enables automatic pairing of assembly files with their associated part files.

Structure:
  • parentType: the file extension for the assembly or container file (must be unique).
  • <ChildTypeList>: one or more file extensions representing individual part files associated with the parent.
Example configuration:
<DownloadFileTypes deepSearchLevel="2">
  <FileType parentType="CATProduct">
    <ChildTypeList>
      <Value>CATPart</Value>
    </ChildTypeList>
  </FileType>
  <FileType parentType="CATPart">
    <ChildTypeList>
      <Value>CATPart</Value>
    </ChildTypeList>
  </FileType>
  <FileType parentType="asm">
    <ChildTypeList>
      <Value>prt</Value>
    </ChildTypeList>
  </FileType>
</DownloadFileTypes>

Recommendation

Use the deepSearchLevel element for most configurations where the product structure depth is known and manageable. Use the extensionList element only for tightly controlled datasets where you want to hard-code the eligible file types.

More file types configurations are included in the full pdmsyscfg.xml file.

NX Assembly Download via UG Clone (InvokeUGClone)

The <InvokeUGClone> element allows the system to download NX based assembly data from Teamcenter using the ug_clone utility.

<InvokeUGClone> Element Purpose

  • The <InvokeUGClone> element is used when dealing with complex NX assemblies that require specialized file retrieval logic.
  • The <InvokeUGClone> element helps ensure NX part dependencies are resolved as per Teamcenter configuration.

Attributes

  • locale (optional):
    • The locale attribute specifies the language/locale used during the ug_clone invocation.
    • If the locale attribute is omitted, the system default is used.
    • Supported values of the locale attribute are: en_US, cs_CZ, de_DE, es_ES, fr_FR, it_IT, ja_JP, ko_KR, pl_PL, pt_BR, ru_RU, zh_CN, and zh_TW.
  • revisionRule: reserved for future use. Currently, the revisionRule attribute has no functional impact.
Note: Performance warning

Enabling this option may significantly increase processing time. Use only when required by your integration.

Example

<InvokeUGClone locale="en_US">true</InvokeUGClone>

CAE to CAD Linking (CAECAD)

The <CAECAD> block enables linking between CAE and CAD Item Revisions using relation types defined in Teamcenter.

<CAECAD> Block Purpose

  • The <CAECAD> block allows CAE Item Revisions to reference their CAD counterparts via GeneralRelation links.
  • The <CAECAD> block is used to build traceable links in the UDM structure and support multi-domain data analysis.

GeneralRelation Element

  • enabled="true": activates this linking behavior.
  • <Value> entries: list relation types in fallback order.

    If the first relation type exists, it is used. Otherwise, the system checks the next one in sequence.

Common Teamcenter Relation Types

  • TC_CAE_Source
  • TC_CAE_Target

Example Configuration

<CAECAD>
  <GeneralRelation enabled="true">
    <Value>TC_CAE_Source</Value>
    <Value>TC_CAE_Target</Value>
  </GeneralRelation>
</CAECAD>

Teamcenter SSO Version Check

The TeamcenterSSOVersionCheck setting controls whether to enforce strict Teamcenter server version validation during single sign-on (SSO) authentication. It helps ensure compatibility between the client and server service-oriented architecture (SOA) APIs.

  • Set enabled="true" to enforce strict version validation.
  • Set enabled="false" to skip version validation.

Example Configuration

<TeamcenterSSOVersionCheck enabled="false"/>