Teamcenter 12.

Data Exchange
PLM00094 - 12.3
 Contents

Introduction
Getting started with Data Exchange ───────────────────────── 1-1
Before you begin ───────────────────────────────────────── 1-1
Teamcenter Data Exchange interfaces ──────────────────────────── 1-1
Basic concepts ─────────────────────────────────────── 1-2
Data Exchange use cases and roles ────────────────────────────── 1-2
Teamcenter upgrade and other transitions ───────────────────────── 1-3
Data Exchange concepts ──────────────────────────────────── 1-4
Briefcase file exchange ───────────────────────────────────── 1-8
4th Generation Design data ───────────────────────────────── 1-11
PDX export ─────────────────────────────────────────── 1-15
Teamcenter variant schema exchange ─────────────────────────── 1-16
Special characters in Teamcenter import files ────────────────────── 1-16
Requirement objects ───────────────────────────────────── 1-18
Vendor management objects ──────────────────────────────── 1-18
Multiple language support ────────────────────────────────── 1-18
Bulk loading data ──────────────────────────────────────── 1-20
Configured BOM export ──────────────────────────────────── 1-21
TC XML Data Exchange compatibility for Product Configurator ──────────── 1-21
Multifield key ────────────────────────────────────────── 1-22
Installing Teamcenter Data Exchange ──────────────────────── 1-22
Planning your installation ────────────────────────────────── 1-22
Installation worksheets ──────────────────────────────────── 1-23
Prerequisites ────────────────────────────────────────── 1-25
Teamcenter server installation requirements ─────────────────────── 1-26
Teamcenter configuration ─────────────────────────────── 1-27
Teamcenter configuration ────────────────────────────────── 1-27
Install Teamcenter Integration Framework ──────────────────────── 1-27
Teamcenter Integration Framework configuration process ─────────────── 1-27
Define remote sites ────────────────────────────────────── 1-29
Define Teamcenter preferences ─────────────────────────────── 1-29
Configure attribute mapping for 4GD major revisioning ──────────────── 1-30
File Management System (FMS) ─────────────────────────────── 1-31
Configuring Teamcenter Integration Framework ───────────────────── 1-33
Transfer modes in Teamcenter ─────────────────────────────── 1-37
Transfer option sets ────────────────────────────────────── 1-38
Set a rule to allow transfer of ownership ───────────────────────── 1-40
Define users, groups, and rules ─────────────────────────────── 1-40
Closure rules ────────────────────────────────────────── 1-41
Verifying the transfer configuration ───────────────────────── 1-41
Verify FMS configuration ─────────────────────────────────── 1-41
Verify transfer from Teamcenter ────────────────────────────── 1-42

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2

© 2020 Siemens
 Contents

Transferring objects using business access rules

TC XML configured export ──────────────────────────────── 2-1
Exporting a configured bill of materials (BOM) ───────────────────────
2-1
Exporting a BOM without variant rules ─────────────────────────── 2-3
Delta export ─────────────────────────────────────────── 2-3
Synchronize changes for a specific BOM configuration ──────────────────
2-4
Repeat a previous export ──────────────────────────────────── 2-5
Export a bill of materials to a briefcase file ─────────────────────────
2-6
Export a configured bill of materials to a briefcase file (with Global Services) ────
2-6
Mapping configured BOM export files ──────────────────────────── 2-7
Exporting configured 4GD data to PLM XML ──────────────────── 2-8
4GD root objects for export to PLM XML ─────────────────────────── 2-8
Mapping 4GD object types to PLM XML ─────────────────────────── 2-9
4GD PLM XML export feature support ─────────────────────────── 2-10
Importing PLM XML as 4GD data ─────────────────────────── 2-11
4GD PLM XML import feature support ─────────────────────────── 2-11
Mapping 4GD PLM XML to 4GD object types ─────────────────────── 2-12
Export from Teamcenter (using Global Services) ───────────────── 2-15
Import to Teamcenter ────────────────────────────────── 2-18
Using site checkout ─────────────────────────────────── 2-18
Check out to a remote site ────────────────────────────────── 2-18
Check in from a site ────────────────────────────────────── 2-19
Cancel checkout to a site ─────────────────────────────────── 2-20
Check replica synchronization ───────────────────────────── 2-20
Exporting Supplier Relationship Management data ─────────────── 2-21
Configure Supplier Relationship Management ────────────────────── 2-21
Export to SRM ───────────────────────────────────────── 2-22
Improving export performance ──────────────────────────── 2-22
Accessing remote objects ─────────────────────────────── 2-22
Object Directory Service (ODS) ─────────────────────────────── 2-22
Publish to default ODS ──────────────────────────────────── 2-23
Publish to the publication list ──────────────────────────────── 2-23
Unpublish ODS objects ──────────────────────────────────── 2-24
Search for remote items ─────────────────────────────────── 2-25
Using PDX export ───────────────────────────────────── 2-25
Configure PDX export ───────────────────────────────────── 2-25
Defining a PDX workflow ─────────────────────────────────── 2-28
Creating a custom PDX style sheet ───────────────────────────── 2-28
Exporting PDX data ────────────────────────────────────── 2-32

Exchanging data with suppliers

Using briefcase files ──────────────────────────────────── 3-1
Exchanging briefcase files with unmanaged sites ───────────────────── 3-1
Configure briefcase for site checkin and checkout ───────────────────── 3-2
Configure Teamcenter for Briefcase Browser ──────────────────────── 3-4
Configure Teamcenter for briefcase mail notification ─────────────────── 3-6
Briefcase Browser site configuration files ────────────────────────── 3-7

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3

© 2020 Siemens
 Compare and preview large briefcase files ──────────────────────── 3-16
Configure Briefcase Viewer ────────────────────────────────── 3-16
Customize Briefcase Viewer icons ────────────────────────────── 3-17
Configure 4th Generation Design data exchange ──────────────────── 3-19
Migrate a supplier site from a managed to unmanaged site ────────────── 3-19
Marking objects for ownership transfer ────────────────────────── 3-22
Recover briefcase ownership ───────────────────────────────── 3-24
Preview Briefcase Browser packages in the rich client ────────────────── 3-24
Compare Briefcase Browser packages in the rich client ───────────────── 3-25
CAD design exchange business process ────────────────────── 3-26
Configure 4th Generation Design data exchange ──────────────── 3-26
Unmanaged site briefcase transfers ───────────────────────── 3-27
Configuration required for unmanaged site transfers ────────────────── 3-27
Export a briefcase file to an unmanaged site ─────────────────────── 3-27
Import validation results ─────────────────────────────────── 3-30
Import a briefcase file from an unmanaged site ───────────────────── 3-31
Transferring a briefcase package ─────────────────────────── 3-31
Briefcase transfer process ────────────────────────────────── 3-31
Package the data ──────────────────────────────────────── 3-32
Transfer the package file ─────────────────────────────────── 3-35
Import the package file ──────────────────────────────────── 3-36

Fast streaming data transfer

Low-level TC XML use cases and concepts ────────────────────── 4-1
Improve Briefcase performance between managed Teamcenter sites ──── 4-1
Custom data mapping ────────────────────────────────── 4-3
Data mapping ────────────────────────────────────────── 4-3
Preventing data loss ─────────────────────────────────────── 4-3

Loading bulk data

Bulk load business process ─────────────────────────────── 5-1
Migrating bulk data from Teamcenter Enterprise or a third-party system ── 5-2
Using the CSV to TC XML converter ────────────────────────────── 5-2
Island of data ────────────────────────────────────────── 5-20
TC XML format ───────────────────────────────────────── 5-21
Prepare Teamcenter for bulk load import ───────────────────── 5-26
Enable bulk loader utilities ────────────────────────────────── 5-26
Bulk load Teamcenter data ────────────────────────────────── 5-26
TC XML file with GSID references ────────────────────────────── 5-28
TC XML file with POM_stub elements ─────────────────────────── 5-30
Create, update, and infer-delete ────────────────────────────── 5-31
Teamcenter core data dictionary ────────────────────────────── 5-32
Teamcenter data model diagram ────────────────────────────── 5-51
Sample assembly structure in a TC XML file ──────────────────────── 5-52
Sample TC XML file with GSID references ───────────────────────── 5-53
Pre-import validation ────────────────────────────────── 5-58
Pre-import validation utility ───────────────────────────────── 5-58

4 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Contents

Required schema ──────────────────────────────────────── 5-58

Required helper objects ──────────────────────────────────── 5-59
Validate your TC XML test files ────────────────────────────────
5-60
Pre-import validation logs ────────────────────────────────── 5-60
Bulk load data ─────────────────────────────────────── 5-61
Bulk loader utility ─────────────────────────────────────── 5-61
Sample bulk load repeat file ───────────────────────────────── 5-64
Frequently asked questions ────────────────────────────── 5-67

Copying product data

Bulk extract and load of product data use cases ────────────────── 6-1
Product data bulk extract and bulk load functions ──────────────── 6-3
Creating a test or training environment ─────────────────────── 6-4
Make a copy of your Teamcenter environment ─────────────────── 6-4
Extract product data from your production environment ──────────── 6-4
Bulk load import options ───────────────────────────────── 6-7
Load product data into your test environment ────────────────── 6-10

Standard mapping A-1

Standard PDX mapping B-1

Teamcenter Data Exchange concepts and components

Data Exchange components ─────────────────────────────── C-1
Supported objects ───────────────────────────────────── C-1
Exporter and importer ────────────────────────────────── C-6
Supported transfer options ─────────────────────────────── C-6
Scoper ──────────────────────────────────────────── C-7
Data mapper ──────────────────────────────────────── C-8
Data synchronizer ───────────────────────────────────── C-8
Identity manager ───────────────────────────────────── C-10
Ownership manager ─────────────────────────────────── C-11
Siemens Digital Industries Software briefcase ────────────────── C-13
File Management System file transfer ─────────────────────── C-14
Security Services ───────────────────────────────────── C-14

Synchronizing a Teamcenter database to an LDAP repository

ldapsync utility ─────────────────────────────────────── D-1
LDAP synchronization concepts ──────────────────────────── D-1
Objects synchronized by the ldapsync utility ──────────────────────── D-1
Object nodes ─────────────────────────────────────────── D-2
Direct and indirect memberships ─────────────────────────────── D-2
Internal and external objects ───────────────────────────────── D-3
Group membership ─────────────────────────────────────── D-3
Configuring the ldapsync utility ──────────────────────────── D-3

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5

© 2020 Siemens
 Configure the connection to an LDAP server ────────────────────────
D-3
Configure the ldapsync utility for SSL ────────────────────────────
D-4
User and person mapping ─────────────────────────────────── D-5
User and person mapping preferences ───────────────────────────D-5
Group and role mapping ──────────────────────────────────── D-9
Group mapping preferences ───────────────────────────────── D-10
Role mapping preferences ────────────────────────────────── D-12
Data synchronization preferences ─────────────────────────────D-13
Differentiate groups and roles ────────────────────────────────
D-14
Link to separate LDAP directories ──────────────────────────────
D-15
Synchronize Teamcenter to an LDAP repository ───────────────── D-15
ldapsync utility troubleshooting ─────────────────────────── D-16
Reset an external user ──────────────────────────────────── D-16
ldapsync cannot find nodes ───────────────────────────────── D-17
Sun ONE Directory Server ─────────────────────────────── D-17
Microsoft Active Directory ─────────────────────────────── D-20

Tables

5-1. Item attributes ─────────────────────────────────── 5-33

5-2. Anchor elements ────────────────────────────────── 5-34
5-3. ItemRevision attributes ───────────────────────────── 5-35
5-4. Form attributes ─────────────────────────────────── 5-37
5-5. ImanRelation attributes ───────────────────────────── 5-39
5-6. PSBOMView attributes ────────────────────────────── 5-40
5-7. PSBOMViewRevision attributes ──────────────────────── 5-41
5-8. PSOccurrence attributes ───────────────────────────── 5-43
5-9. PSOccurenceThread attributes ───────────────────────── 5-44
5-10. Dataset attributes ──────────────────────────────── 5-45
5-11. RevisionAnchor attributes ─────────────────────────── 5-47
5-12. ImanFile attributes ─────────────────────────────── 5-48
5-13. User attributes ────────────────────────────────── 5-49
5-14. Group attributes ───────────────────────────────── 5-50
5-15. Tool attributes ────────────────────────────────── 5-50
5-16. ImanType attributes ─────────────────────────────── 5-50
5-17. ImanVolume attributes ───────────────────────────── 5-50
5-18. DataseType attributes ────────────────────────────── 5-51

6 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 1. Introduction
Getting started with Data Exchange ───────────────────────── 1-1
Before you begin ───────────────────────────────────────── 1-1
Teamcenter Data Exchange interfaces ──────────────────────────── 1-1
Basic concepts ─────────────────────────────────────── 1-2
Data Exchange use cases and roles ────────────────────────────── 1-2
Teamcenter upgrade and other transitions ───────────────────────── 1-3
Data Exchange concepts ──────────────────────────────────── 1-4
Briefcase file exchange ───────────────────────────────────── 1-8
4th Generation Design data ───────────────────────────────── 1-11
PDX export ─────────────────────────────────────────── 1-15
Teamcenter variant schema exchange ─────────────────────────── 1-16
Special characters in Teamcenter import files ────────────────────── 1-16
Requirement objects ───────────────────────────────────── 1-18
Vendor management objects ──────────────────────────────── 1-18
Multiple language support ────────────────────────────────── 1-18
Bulk loading data ──────────────────────────────────────── 1-20
Configured BOM export ──────────────────────────────────── 1-21
TC XML Data Exchange compatibility for Product Configurator ──────────── 1-21
Multifield key ────────────────────────────────────────── 1-22
Installing Teamcenter Data Exchange ──────────────────────── 1-22
Planning your installation ────────────────────────────────── 1-22
Installation worksheets ──────────────────────────────────── 1-23
Prerequisites ────────────────────────────────────────── 1-25
Teamcenter server installation requirements ─────────────────────── 1-26
Teamcenter configuration ─────────────────────────────── 1-27
Teamcenter configuration ────────────────────────────────── 1-27
Install Teamcenter Integration Framework ──────────────────────── 1-27
Teamcenter Integration Framework configuration process ─────────────── 1-27
Define remote sites ────────────────────────────────────── 1-29
Define Teamcenter preferences ─────────────────────────────── 1-29
Configure attribute mapping for 4GD major revisioning ──────────────── 1-30
File Management System (FMS) ─────────────────────────────── 1-31
Configuring Teamcenter Integration Framework ───────────────────── 1-33
Transfer modes in Teamcenter ─────────────────────────────── 1-37
Transfer option sets ────────────────────────────────────── 1-38
Set a rule to allow transfer of ownership ───────────────────────── 1-40
Define users, groups, and rules ─────────────────────────────── 1-40
Closure rules ────────────────────────────────────────── 1-41
Verifying the transfer configuration ───────────────────────── 1-41
Verify FMS configuration ─────────────────────────────────── 1-41
Verify transfer from Teamcenter ────────────────────────────── 1-42

Data Exchange, Teamcenter 12.3 PLM00094 12.3

© 2020 Siemens
Data Exchange, Teamcenter 12.3 PLM00094 12.3
© 2020 Siemens
 1. Introduction
Getting started with Data Exchange

Before you begin

Prerequisites Unless stated otherwise in the description of a configuration task, you must be
a dba group member or member of another group with dba privileges.

Enable Data Complete the installation tasks described in Installing Teamcenter Data
Exchange Exchange.

Configure Data Configuring Data Exchange is described in Teamcenter configuration.

Exchange

Start Data Exchange Data Exchange is accessible from within the rich client interface.

Teamcenter Data Exchange interfaces

Teamcenter Data Exchange uses some menu commands that Multi-Site Collaboration uses. The
configuration and destination determine whether Data Exchange or Multi-Site Collaboration performs
the action.

If you are using Data Exchange to exchange data between Teamcenter Enterprise and Teamcenter, see
Transition from Teamcenter Enterprise to Teamcenter.

Note:
When exporting a Pro/ENGINEER/PTC Creo assembly or part that contains a family table instance,
you must export all associated family table instances prior to exporting the assembly. Otherwise,
the remote Teamcenter site does not include any nested family table instances for the part.
When you transfer objects with attached licenses, the license must exist in the importing system
for the license to be attached to the imported object. Synchronizing license associations between
systems is not supported. Therefore, if a licenses is detached from an object at the owning site,
the license does not get detached from the replica object.

Note:
Object Directory Service (ODS) operations are not supported between Teamcenter and
Teamcenter Enterprise sites. All Data Exchange operations related to ODS are supported only for
Teamcenter-to-Teamcenter operations. This includes publishing objects to the ODS, remote search
operations, and remote import operations based on remote search results.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-1

© 2020 Siemens
 1. Introduction

Command line utilities

Teamcenter provides command line utilities to exchange data with other sites or third-party products. In
a standard installation, these utilities are available without any changes required by the system
administrator. However, if you plan to run any of the following utilities to export or import ImanFile
objects, the site must either have the Teamcenter distribution image locally or the system path must
include the path to the FSC library. For Windows systems, add %TC_ROOT%\fsc\lib. For Linux and UNIX
systems, add $TC_ROOT/fsc/lib.

• plmxml_export
• plmxml_import
• tcxml_export
• tcxml_import
• pdx_export

Basic concepts

Data Exchange use cases and roles

There are two main methods of exchanging data from a Teamcenter site. For Teamcenter-to-
Teamcenter data exchange that have compatible data models, you can use Multi-Site Collaboration. For
other scenarios, Data Exchange can be used. The standard Data Exchange product can provide solutions
to the following:

• Consolidate Teamcenter sites to allow sites to be retired.

• Exchange data between your site and Teamcenter supplier sites that are online (connected) or offline
(unconnected).

• Exchange data between Teamcenter sites that are not connected (offline) using briefcase files.

• Exchange data with suppliers that are not using Teamcenter (unmanaged sites) using briefcase files.

• Exchange data between Teamcenter sites with disparate data models.

• Upgrade multiple Teamcenter sites with disparate data models to the current version of Teamcenter.

• Transfer data from non-Teamcenter data sources to your Teamcenter site. This can be done using the
bulk load feature or with a custom connector integration.

• Migrate Teamcenter Systems Engineering to Teamcenter.

• Transition from Teamcenter Enterprise to Teamcenter.

1-2 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Teamcenter upgrade and other transitions

Teamcenter upgrade and other transitions

Data Exchange can aid you when you are upgrading multiple Teamcenter sites that have disparate data
and operational models. High-level considerations for the upgrade process are:

• Isolating customizations at each site.

• Standardizing (harmonize) shared customizations.

• Packaging and distributing customizations to all sites.

• Standardizing organizations, access rules, naming and deep copy rules, work processes, and so forth.

Note:
Site standardization can be joined with site consolidation.

• Upgrading sites to an upgrade supported Teamcenter version as interim step.

• Enabling target sites with the harmonized data model.

• Populating new sites using Data Exchange, transforming or mapping data as needed.

You can also use the integration framework components to transition third-party or custom systems,
such as non-Siemens Digital Industries Software PLM or PDM systems, to Teamcenter. High-level
considerations for the transition process are:

Note:
It is important that you carefully consider your specific requirements during the planning phase of
a transition.
These descriptions provide very high-level considerations. Contact Siemens Digital Industries
Software services for assistance in determining the best approach for your companies
requirements.

• Adding a custom integration framework connector.

• Providing methods for export, import, and confirm.

• Leveraging connectors developed by Siemens Digital Industries Software partners for third-party
competitive systems, such as, ENOVIA or Inventor.

• Leveraging or reusing integration components and tools such as the mapper.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-3

© 2020 Siemens
 1. Introduction

Data Exchange concepts

Data Exchange uses the TC XML framework for data operations. The following are the basic concepts for
understanding how you use Data Exchange.

• Site

A site ( ) is a Teamcenter installation or manufacturer or supplier that uses some other method to
manage their product data.

• Export
Export is the Data Exchange function used to send data to a remote site. While exporting the data,
you can either transfer the data with ownership or transfer the data for reference. If you transfer the
data for reference, the ownership is retained by the exporting site and a replica is exported to the
remote site.

• Import
When a user exports data from a remote site to a Teamcenter site, the site imports the data
automatically.

• Replica
Replication is the act of creating an exact copy of an object, known as a replica, at a specific site.
Replicas are objects that are owned by a remote site. Whenever a master object is modified, you must
update the replicas by synchronizing them to the master. A replica is a nonwriteable object and
cannot be updated except by the owning site. When an object is replicated, you cannot delete the
master object unless all the replicas are deleted.
A replica is represented by a symbol with two green dots.

• Synchronization
When a master object is replicated at other sites, you must update the replicas whenever the master
object is modified. The process of updating replicas is referred to as synchronization. The synchronizer
is responsible for ensuring that a previously replicated data is synchronized.
Manual synchronization is performed by a user. It is a re-export or re-import of the object with the
same transfer formula. Automatic synchronization is supported for push cases and is initiated by
integration framework making a call to transfer updated objects.

Caution:
When manually synchronizing a replica, both the owning site and replica site must be online to
receive replica deletion notification.

1-4 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Data Exchange concepts

Note:
Data Exchange does not support automatic pull synchronization.

• Closure rule clause

A closure rule clause ( ) controls the scope of the data transfer. It defines the rules for gathering
objects during the export action. Closure rules specify how the data structure is traversed by
specifying the relationships of interest and the actions to occur when these relationships are
encountered.
Teamcenter also has many internal closure rules that handle out-of-the-box data model traversal.
These are normally imported during installation or upgrade. They must not be changed. For instance,
the inclusion of the BOM and Absolute Occurrence network is handled by internal closure rules.

• Transfer mode

A transfer mode ( ) is a logical grouping of closure rule clauses. You select a transfer mode when
creating closure rule clauses. Transfer modes allow users to export and import data by knowing only
the transfer mode name that they must use, for example, ToSiteA or FromSiteB.

• Transfer option
Specifies the different options you can choose to use when Teamcenter transfers an object. The
different transfer options are:

• Include All Versions

• Latest Versions
• Selected Version
• Include Entire BOM
• Transfer Top Assembly

• Transfer option set

A transfer option set (TOS) ( ) is a stored set of transfer options used for remote data export. A
transfer option set displays all of the unique options in the closure rule conditional clauses for the
selected transfer mode. The Description column of the TransferOptionSet pane in the PLM XML/TC
XML Export Import Administration application describes the purpose of the options included in the
standard Teamcenter transfer option sets.

• Factor
A factor is a logical concept defined by a set of objects at the exporting site that map to a similar
logical concept defined by a different set of objects at the importing site. You define a factor using a
closure rule. Closure rules help optimize Data Exchange performance.

• File Management System (FMS) file transfer

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-5

© 2020 Siemens
 1. Introduction

File Management System (FMS) is used for transferring files by geographically separated work groups
whose sites are connected by wide area networks (WANs). It also allows access to shared documents
in local area network caches, helps avoid round-trips across high-latency WAN networks to reach sites.
FMS uses a file GUID, a business-neutral identifier for file contents, to determine when to pull a file
from its local cache, rather than retrieving the file across a network from the underlying file system of
the site. Binary and text files have a different GUIDs if they are replicated. However, if you change the
file content by one bit or change its language encoding, the system creates a new file GUID to
describe the new contents of the file.

• Single sign-on (SSO)

Security Services allows a user to sign on one time for access to multiple Teamcenter products. Data
Exchange supports this functionality when its components are properly configured to use single sign-
on (SSO).

• Export protection
The export protection capability of Data Exchange sends export-protected objects as stubs.

• Replica deletion
The replica deletion capability deletes the export record of an object on the master site when a replica
is deleted on the remote site.

• Stub replication
The stub replication capability ensures that when a master object replica is sent to another site, the
exporter creates an export record for this new site and tags it as stubbed.

• International Traffic in Arms Regulations (ITAR) license

Teamcenter provides support for enforcing policies of ITAR (International Traffic in Arms Regulations)
to control dissemination of certain types of information through ITAR licenses that you can attach to
workspace objects. If an ITAR license exists at the destination site, the license_id attribute associated
with the workspace object can be imported.

• Audit monitoring
The integration framework provides an audit log of transactions during transfers between Teamcenter
Enterprise and Teamcenter that is maintained in the integration framework database. The following
transactions are logged:

• Get objects for ownership transfer.

• Transfer ownership to site.

• Update ownership transfer to source site.

• Organizational/license object audit logs

1-6 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Data Exchange concepts

Data Exchange transfers use the TC XML import and export (TIE) functionality to transfer objects
between sites. TIE does not support replicating audit record business objects. Do not attempt to
replicate the following objects between sites:

• Fnd0LicenseChangeAudit
• Fnd0LicenseExportAudit
• Fnd0OrganizationAudit

• Administrative objects
The TC XML framework processes Teamcenter administrative objects differently from other objects.
For example, during the import process, if an administrative object identified in the TC XML file is not
found at the importing site, the import fails whether or not the exporting user selected the Continue
On Error option. Objects of the following classes are considered administrative objects by the
framework:

• ADA_License
• ClosureRule
• Condition
• CondValAgent
• CondValAgentRevision
• CondValData
• CondValDataRevision
• Filter
• Fnd0AlgebraicFormula
• FunctionalityRule
• Group
• GroupMember
• IdContext
• ImanType
• NoteType
• PIEActionRule
• POM_imc
• PropertySet
• PSOccurrenceType
• PSViewType
• ResourcePool
• RevisionRule
• Role
• TransferMode
• TransferOptionSet
• TC_Project
• UnitOfMeasure
• User
• VerificationRule

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-7

© 2020 Siemens
 1. Introduction

Briefcase file exchange

Teamcenter offline exchange

There may be times when a Teamcenter site that shares data with other sites is not online. The Siemens
Digital Industries Software briefcase functionality also allows you to transfer the data in the archived file
format between the offline sites.

You can export incremental change information in a briefcase file. The incremental change data export
is based on object timestamps. The importing site determines objects are successfully imported reports
the status to the exporting site that uses the information to update the import/export record (IXR) of the
objects at the exporting site. Therefore, exporting an incremental change briefcase file is a two-step
process.

For the import to succeed, the system administration objects, such as effectivity and revision rules, used
to configure the exported structure must exist at the importing site. The import process searches for the
system objects at the local site by name, the contents of the objects is not verified. If a local system
object is not found the import process logs an error in the import log file.

During the export process, if a revision rule results in an imprecise line, the exporter includes the latest
revision. Unconfigured lines and any unchanged objects configured by incremental change that have
already been exported are exported as stubs (BOMLine objects as full objects with PSOccurrence
objects as stubs). Additionally, new BOM lines added to a structure that are not tracked by incremental
change are exported as stubs and all substructure to the BOM lines are ignored.

Any BOM line not tracked by incremental change that is deleted from an exported structure is not
included in the exported briefcase file. The importer deletes (inferred delete) the object at the importing
site when the structure exists at the importing site.

You can export a briefcase file with multiple root objects that are configured by a single revision rule or
with each having a different revision rule (collaboration context). A structure context is a configurable
structure that consists of one or more root objects sharing the same configuration. A collaboration
context is a container object containing one or more structure contexts, each of can have a different
configuration. The configuration of the structure context is defined by a configuration context, and may
include revision rules, variant rules and closure rules.

Closure rules are also system administration objects. The closure rules for a collaboration context must
exist at the importing site or be imported separately prior to importing a briefcase file containing the
collaboration context objects.

Collaboration and structure objects are workspace objects. They cannot be revised, but they can be
managed with incremental changes. The change object affects the structures contained in the
collaboration context object. However, you cannot export incremental change data affecting objects
specific to the manufacturing data model in a briefcase file.

1-8 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Siemens Digital Industries Software briefcase file exchange

Siemens Digital Industries Software briefcase file exchange

The briefcase file feature provides an alternative method of sharing data with supplier sites. Briefcase
files can be exchanged with supplier sites that use Teamcenter (managed sites) or with supplier sites
that do not use Teamcenter (unmanaged sites) through Briefcase Browser. Briefcase Browser does not
require a Teamcenter installation.

The following table contains information comparing the various offline data sharing capabilities
available in Teamcenter and their implementation differences.

Feature Briefcase PLM XML

Use case focus Managed suppliers or General data exchange

unmanaged suppliers with
Briefcase Browser

Package container ZIP file None

File format Teamcenter XML (TC XML) PLM XML

Checkout support Yes No

Content NX, JT, and documents JT and other files

Transfer mode (determines User selected (TM and TOS) User selected TM only (no
content) options)

Incremental (delta) export Yes No

support

Application interoperability Teamcenter 2007 MP1 or later Teamcenter and other PLM XML
only compatible applications

Toolkit/SDK support None planned PLM XML SDK

Briefcase Browser supports both NX and CATIA CAD data. You can have only one plug-in installed at a
time. However, there are some differences in the functionality between the plug-ins for the CAD
formats.

• For CATIA CAD data, drawing files in Briefcase Browser are confined to the data model where the
drawing is related to an item revision of the same item.

• The CATIA schema is validated strictly by the rules of the supplied schema.

• When you open a partial briefcase file in Briefcase Browser, there may be differences in the structure
view from what is displayed in Teamcenter, for example, Briefcase Browser shows unselected NX
siblings as stubs, however the CATIA plug-in ignores them.

• For CATIA data you can export a partial BOM export and assemblies with variant rules.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-9

© 2020 Siemens
 1. Introduction

Supplier site exchange

For security or logistics reasons, you may need to exchange information with a supplier that does not
have an online connection to any of your Teamcenter sites. Using the Siemens Digital Industries
Software briefcase functionality of Teamcenter Data Exchange allows you to provide the shared data in
an archive file that can be physically moved or electronically transferred (FTP) to or from the supplier
site.

You can also check out objects to a site. This functionality creates a briefcase archive that has the
checked-out object, the associated objects required to properly lock the object for modification, and the
site reservation object that contains a remote site attribute. If the remote site attribute matches the
importing site, Teamcenter creates a reservation object associated to the object at the importing site.
This allows users at the importing site to locally check out and modify the objects (provided they have
the proper privileges) even though the objects are replicas and not owned by the site. An object that is
checked out to another site has its Checked Out by property set to the remote site. The following
objects can be checked out to a site:

• BOMView

• BOMViewRevision

• Dataset

• Form

• Item

• ItemRevision

Tip:
The view type data is not exported with the PSBOMView data in TC XML. The import process uses
the default view type when importing PSBOMView data.
Therefore, when transferring PSBOMView data using a briefcase file, tcxml_export and
tcxml_import, or any utility that uses TC XML metadata, set the PSE_default_view_type
preference at the target site to the view type value of the assembly at the source site. Usually, this
is the same as the source sites default view type.
This import behavior is designed to be consistent with Structure Manager.

The following table identifies the related objects that are checked out to a site:

1-10 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 4th Generation Design data

Object selected for checkout Associated objects checked out

Item Item master form

ItemRevision Item revision master form

Dataset Named references that are work space objects

The checkout to site functionality also supports tiered suppliers. A supplier that is a hub site (tier-1
supplier) can use the Check-Out to site command to check out objects to one of their suppliers (tier-2
supplier) for modifications. The owning site attribute is set to the exporting site (tier-1 supplier), allows
the importing site to modify the data and send it back to the hub site.

Note:
If a tier-2 supplier does not use the Check-In from site command before sending an object back to
the tier-1 supplier, the tier-1 supplier must perform the Check-In from site command twice on the
object to release the lock.

A site that has checked out an object to a site can cancel the site checkout to restore the reservation
object to its precheckout state. Datasets are not restored to their precheckout state but the site checkout
lock is removed.

Remote checkout and the Check-Out to site command are mutually exclusive and Teamcenter disables
the commands to prevent the other action.

4th Generation Design data

4th Generation Design (4GD) is the process of developing a collaborative design that contains all the
necessary design information used to manufacture the subject product, for example a car, ship, or
aircraft. A collaborative design is the collector for product configurations and includes all product design
data as design elements and design features. You develop your collaborative design using the 4G
Designer application. 4G Designer supports massive product designs with millions of business objects
along with enhanced collaborative business processes. You can exchange 4GD data by exporting and
importing briefcase files. The briefcase file uses Teamcenter as the payload to provide the scalability to
handle the massive data required for 4GD data exchange.

Note:
The Briefcase Browser application does not support briefcase files containing 4GD data.

The following 4GD concepts apply to briefcase data exchange.

Data Exchange also supports low-level TC XML transfers for bulk loading data. You can export and
import configured 4GD data and its supporting infrastructure in an unmanaged site briefcase file. A
configured export to and unmanaged site can include JT datasets but cannot include NX related
datasets.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-11

© 2020 Siemens
 1. Introduction

All 4GD business objects are supported in briefcase replica transfers. The following 4GD objects can be
selected as root objects:

• Collaborative design (Cpd0CollaborativeDesign class)

• Design control element (Cpd0DesignControlElement class)

• Design feature (Cpd0DesignFeature class)

• Workset (Cpd0Workset class)

• Promissory, reuse, and shape design elements (Cpd0DesignElement class)

• Partition (Ptn0Partition class)

• Subset definition (Mdl0SubsetDefinition class)

• Partition template model (Ptn0PartitionTemplateModel class)

When replicating partition data model memberships:

• Partition-owned memberships are exported along with the partition that owns them.

• Member-owned memberships are exported along with the member that owns them.

When replicating partition data model members:

• Member-owned memberships are exported as full objects.

• If PtnB is the root object:

LinkAB, membershipB1, memebershipB2, and PtnB objects are exported as full objects.

1-12 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 4th Generation Design data

The memberB1 and memberB2 objects are exported as full objects.

• If PtnC is the root object, the PtnC and linkBC objects are exported as full objects.

• Member-owned memberships are exported along with the member that owns them.

• If Ptn1 is the root object, only the Ptn1 object is exported.

• If Ptn2 is the root object, the Link1 and Ptn2 objects are exported as full objects.

• If member1 is the root object, the member1 object and its contents, and the membership1 object
are all exported as full objects.

• POM revisioning
The revisable setting for business objects at both the source and destination systems must be
consistent. Therefore, a class that has revisioning enabled at an exporting site has to have revisioning
enabled at the importing site; otherwise, the import fails. Only the latest version of a revisable object
is transferred for both managed and unmanaged use cases.

• Partitions
You can add a design element under a replicated partition. The master partition does not have the
knowledge of all design elements under the replicated partition. This behavior is acceptable as long as
either a well-defined best practice approach is exercised so your users can assume the master
partition is always up to date within a given time interval, or a central authority, implemented in the
future, can be consulted to determine what data is up to date. For a parent-child link owned by child
partitions, users must make sure the partition hierarchy is constructed at one site and then replicated
to all other sites.

• Compatibility
Forward and backward compatibility between Teamcenter versions requires the Teamcenter schemas
to be compatible at both the exporting and importing sites. Therefore, you cannot export 4GD data
from earlier Teamcenter versions that do not support the 4GD data model.

Exported objects are listed as the master object in the export log. The imported objects are listed as new
objects in the import log.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-13

© 2020 Siemens
 1. Introduction

When importing the same object after the initial import, the imported object is listed as updated in the
import log.

For roots objects designated as not exportable, the object is listed as STUB_INSUFFICIENT_PRIVILEGE in
the export log and a stub object is created at the importing site.

The following TC XML options apply to 4GD object replication.

TC XML option name Description Export behavior

opt_de_rlz_item By default, BOM structure is exported DesignElement source objects are

separately from 4GD structure due to the exported as full objects. For ShapeDE
potential size of the data. If you want to objects, ShapeDesignRevision is the
export BOM structure and 4GD structure source object. The
together in single operation, set this ShapeDesignRevision object is always
option to true. exported with the ShapeDE object
even if the opt_de_rlz_item option is
set to FALSE.
Note:
For ReuseDE and SubordinateDE
BOM structure includes the full
objects, ItemRevision is the source
island of data of an associated
object.
item/BVR with a design element.

opt_workset_rlz_de By default, the Workset/Subset structure Realization map objects

is exported separately from (Rlz0ModelRealizationMap) are
DesignElement objects. If you want to exported as full objects. The source
export the Workset/Subset structure and object can be a DesignFeature,
DesignElement objects together in a DesignElement, or
single operation, set this option to true. DesignControlElement object.

opt_exp_cfgbom Sets the export mode for either Configured and unconfigured behavior
configured or unconfigured 4GD data, are explained following this table.
Set to true to export configured 4GD
data.

Infer delete of 4GD objects

• Mdl0SubsetDefinition
Deletes the search criteria if it is different from that in the imported TC XML file.

• Cpd0DesignElementImpl
Causes a category change for these objects:

1-14 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 PDX export

Original object New object Result

Shape design Reuse design element Change the source object of the design element
element from an item revision to a shape revision.

Reuse design Shape design element Change the source object of the design element
element from a shape revision to an item revision.

Reuse design Reuse design element Deletes the subordinate design elements that are
element not in the imported TC XML file.

• Workset
Deletes the Subsets that are not in the imported TC XML file.
For the subassembly, infer delete is controlled by the BVR and PSOccurrence objects.

• SubsetInstance in a Workset
Deletes the search criteria if it is different from that in the imported TC XML file.
Deletes the realization maps that are not in the TC XML file.

• Partition
Deletes the search criteria if it is different from that in the imported TC XML file.
Deletes the child-parent links that not in the imported TC XML file.
Deletes the memberships that are not in the imported TC XML file.

Configured export

1. Constructs the BOMWindow object for the given root object and configuration context (revision
rule, variant rule, and effectivity).

2. Gets the top line from BOMWindow object. For a Workset object, this is the WorksetLine object.

3. Traverses from the top line as defined by the closure rules.

4. Serializes the traversed data with properties defined by the property set.

PDX export

Data Exchange exports data in PDX format as a PDX package. This package can be viewed by PDX viewer
applications or used by other systems that support the PDX data format. You can also create a PDX
package using a workflow process by specifying the workflow handler provided for PDX packages.

Data Exchange exports the Teamcenter data in an XML format (TC XML) that is converted to PDX format
by a style sheet (XSLT). Teamcenter uses features of the Teamcenter integration framework and
Teamcenter briefcase to perform the export. Teamcenter schedules the export job and also transforms
the TC XML data to PDX data using XSLT. Teamcenter briefcase packages the contents and uploads the

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-15

© 2020 Siemens
 1. Introduction

PDX package to Teamcenter. The following figure shows how the Teamcenter components interact to
export a PDX package.

The site definition distinguishes a PDX export from a standard briefcase export. When you define a site
as a target for PDX export, you must identify:

• The integration framework deployment URL.

• The transfer option set used for exporting the TC XML data using the
TC_gms_export_transfermode_for_<site-name> site-level preference, for example:

TC_gms_export_transfermode_for_Pune = TIEPDXExportDefault

• The style sheet that is applied to this TC XML file in the data mapping step in integration framework.

Teamcenter objects that can be exported to PDX and how they are mapped to PDX objects by the out-of-
the-box (OOTB) mapping file are described in Standard PDX mapping.

Teamcenter variant schema exchange

The data mapping functionality of Teamcenter Data Exchange allows you to share data among
Teamcenter sites that have variations in their object schemas by mapping the attributes between objects
that differ. Standard Teamcenter Data Exchange supports transfer of ownership of objects between
Teamcenter sites only when the schemas are identical. To transfer ownership between Teamcenter sites
with variant schemas, you must create a custom style sheet (XLST file) that excludes the objects that are
not defined at the importing site.

Special characters in Teamcenter import files

Teamcenter generally excepts all characters that are legal for the underlying database's character set
when the tcserver process is configured for a compatible character set.

1-16 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Special characters in Teamcenter import files

Teamcenter does not attempt to filter characters (with a few exceptions) when importing files. The user
interface blocks nonprintable characters for the operating systems character set. However, the
nonprintable characters can be imported from a file.

The underlying database rejects characters that do not belong to the database's declared character set.
For example, if you set the database to the 8-bit US ASCII (ISO 8859-1) character set, it rejects characters
that are not defined for that code page. However, if you set the database for a 7-bit ASCII character set,
it allows noncode page 8-bit characters because it does not validate the high bit.

Teamcenter does filter specific strings in places that are a security concern due to potential command
injection attacks. For example, Teamcenter rejects a semicolon (;) or the string rsh if they are in a file
name.

Additionally, Siemens Industry Software Inc. recommends that you do not use the following characters
in item IDs to avoid potential database issue:

• Single quotation mark (')

• Double quotation mark (“)
• Slash (/)
• Backslash (\)
• Colon ( :)
• Less than (<)
• Greater than (>)
• Vertical bar (|)
• Tilde (~)
• Back tic (`)

For Teamcenter 10.1.4 and later versions, when you export a variable length array (VLA) of string type
in a TC XML file, the export process inserts a slash (\) character before the predefined separator
character and any slash characters in property values. The predefined separator character is defined in
the GMS_tcxml_string_separator preference and is a comma (,) by default.

For example, when exporting the following VLA string property values:

prop[0] “ab,c”
prop[1] “d\ef”

The output file contains:

prop="ab\,c,d\\ef

A slash character is prefixed to the slash and comma (default separator) in the strings. During the import
process, the tcxml_import utility parses the property correctly and the values are the same at both the
exporting and importing site. In prior versions of Teamcenter, the output file contained three values
("ab", "c", and "d\ef") and the import process could not properly parse them into values that matched the
exporting site values.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-17

© 2020 Siemens
 1. Introduction

Requirement objects

Data Exchange can transfer requirement objects and their associated data between Teamcenter sites,
with or without ownership, and can synchronize replicated data. However, if you require remote check
out and check in actions, you must use Multi-Site Collaboration.

You can transfer to other sites (export/import) custom notes along with their Trace link using Data
Exchange and the associated TC XML utilities. You can also export notes on Trace links to other sites
using PLM XML.

Note:
PLM XML import of notes on trace links is not supported. Notes on trace links is not supported for
briefcase file transfers.

Transferring notes on trace links requires you to use the REQ_export_notesonlinks transfer mode.

Vendor management objects

Data Exchange can transfer vendor management objects between Teamcenter sites, including their
roles, such as:

• Supplier
• Manufacturer
• Distributor
• Commercial part
• Manufacturer part

Multiple language support

The Teamcenter multilingual schema contains elements for localizable attribute value representations in
one or more languages. This allows you to export and import objects with localizable attributes for
display names in more than one language. Teamcenter clients that access the imported data can display
the localized attributes in differing languages depending on their locale. Prior to Teamcenter 8.2,
Teamcenter sites were monolingual, that is, they could import attributes in only one language.
Teamcenter 8.2 and later versions can be either multilingual or monolingual.

When you upgrade to Teamcenter 8.2 from a previous release, the TC XML schema that Data Exchange
uses to transfer data between sites must be modified to provide additional attributes that hold localized
values for attributes that are designated by the localizable proper constant for the attribute. The
bmide_generatetcxmlschema Java utility provides the modification to the schema. The upgrade
process runs this utility at the end of the database installation or upgrade. The utility retrieves a list of
languages that are supported by the database and provides attributes to hold localized values for the
attributes that have the localizable property constant set to true. It adds localized attributes to the
schema for the primary language of the database and for each approved nonprimary language.

1-18 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Multiple language support

Note:
The URIs that appear in the headers of PLM XML and TC XML files serve as namespace names, are
unique identifiers for an XML vocabulary. Although they are URIs, they are not used to identify and
retrieve web addresses.

The TC XML file used to transfer objects from and to a multilingual site, contains elements that identify
the site master language, all required languages, and any allowed languages for the site. For exports,
unapproved locale attribute values are not included in the TC XML file, and a message is written to the
exporter log file indicated the attribute value was not exported. For imports, the locale information in
the TC XML file and locale information that Data Exchange obtains from the importing system is used to
determine if localized values in the TC XML file are supported in the importing system. Values for
unsupported locales are ignored, and a message is written to the importer log file indicating the
attribute value was not imported.

Consider the following when transferring objects with localized attributes and when monolingual and
multilingual sites participate in your Data Exchange environment:

• When transferring objects between multilingual sites that have different site master languages, the
import succeeds only if the importing site supports the site master language contained in the TC XML
file, and the TIE_allow_import_with_different_SML preference at the importing site is set to true or
ON.

• Data Exchange transfers are supported between multilingual sites and monolingual sites with the
following restrictions:

• For objects transferred from monolingual to multilingual sites, Data Exchange uses the site master
language specified in the transfer formula to import the localizable attributes. If the transfer
formula does not contain the site master language, the site master language of the importing
(multilingual) site is used to import the localizable attributes. In this case, the locale of the
monolingual site must match the site master language of the multilingual site for the import to
succeed.

• For objects transferred from multilingual to monolingual sites, Data Exchange ignores the locale
information in the TC XML file. Required attribute values are stored in the importing site. Therefore,
the site master language at the multilingual site must be supported at the monolingual site, and all
localized attributes must have a site master language representation at the multilingual site.

• The Teamcenter databases must be character set compatible. For example, transfers between sites
using the UTF-8 character set and sites using non-UTF-8 characters (such as Shift-JIS) are not
supported.

• You can transfer objects with ownership between multilingual sites that have their required
languages common to both sites. The tcxml_import and tcpxml_export utilities support arguments
that allow you to specify allowed and required languages.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-19

© 2020 Siemens
 1. Introduction

Caution:
When attribute values contain commas in the strings at either of the sites, you must change the
default value for the GMS_tcxml_string_separator preference at both sites to prevent data
corruption at the importing site.

• You can synchronize objects between multilingual sites and between monolingual and multilingual
sites.

Bulk loading data

Bulk loader is a tool that you can use in a data migration solution to import data from a legacy system
into Teamcenter. The bulk load business process leverages the site consolidation technology to achieve
desired performance/scalability specifications for data migration. The legacy data must be extracted and
mapped to the TC XML format by a custom solution. The following figure shows the components
involved in a data migration solution. The Validator, Importer, and the API to generate object ID
components are provided as part of the bulk loader functionality.

Bulk loader components

1-20 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Configured BOM export

Configured BOM export

Data Exchange allows you to export a configured bill of materials (BOM) using TC XML provides
extensibility and an increase in speed and scalability for this type of export. The export uses the fast
traversal method of the bulk loader to quickly stream Teamcenter data to a TC XML file. This is useful in
Active Workspace and supplier exchange activities. This functionality is available from the My
Teamcenter and Structure Manager applications in the rich client interface.

Data Exchange constructs the BOM for the given root object and configuration rules (revision and
variant rules). It traverses the BOM as defined by the closure rules and serializes the traversed BOM data
with properties defined by the property set. The inputs required to construct the BOM are passed as a
transfer formula in the transfer session options. The transfer formula includes:

• The transfer option set (TOS)

• The transfer mode

• A list of user selected options that override the TOS options

• Session options

You can export both precise and imprecise assemblies with related notes, attachments, absolute
occurrences and overrides, alternates and substitutes, and generic design elements (GDE) lines.

TC XML Data Exchange compatibility for Product Configurator

Teamcenter Product Configurator TC XML data cannot be exchanged across all Teamcenter versions.
This is general limitation of TC XML data exchange whenever there are major data model changes across
Teamcenter versions. Because, Teamcenter Product Configurator TC XML has major data model changes
in version 10.1.5, any TC XML data exported from versions prior to 10.1.5 cannot be imported to
Teamcenter 10.1.5 or later versions.

The configurator supports data exchange across Teamcenter versions provided there is data model
compatibility. For example, the Teamcenter Product Configurator data can be exchanged between
Teamcenter 10.1.5 and Teamcenter 11.2.1. Also, the data can be exchanged between Teamcenter
10.1.6 and Teamcenter 11.2.2.

Teamcenter Configurator Version

Source Target Compatibility Comment

10.1.3 10.1.3 Yes

10.1.3 10.1.4 Yes

10.1.3 10.1.5 and later No Teamcenter 10.1.5 has major data model
changes. You must upgrade the source site to

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-21

© 2020 Siemens
 1. Introduction

Teamcenter Configurator Version

Source Target Compatibility Comment

Teamcenter 10.1.5 before performing data

exchange.

10.1.4 10.1.4 Yes

10.1.4 10.1.5 and later No Teamcenter 10.1.5 has major data model
changes. You must upgrade the source site to
Teamcenter 10.1.5 before performing data
exchange.

10.1.5 and later 10.1.6 and later Yes

Multifield key

Multifield keys are identifiers assigned to each object to ensure their uniqueness in the database. Data
Exchange supports multifield keys definitions for objects that it transfers. Teamcenter administrators
can add multiple properties to define a key. The multifield key is composed of a domain name (the name
of the business object type) and a combination of the object’s properties. This ensures a unique
identifier across all the objects in the domain. You configure multifield keys for objects using the
Business Modeler IDE.

Installing Teamcenter Data Exchange

Planning your installation

Some information provided in this topic is optional depending on the business processes you plan to
support. Information about supporting functionality, such as single sign-on (SSO) and File Management
System (FMS) is described with reference to the general documentation provided for those features. You
must follow the defined installation and configuration process due to the product interdependence.

The installation process includes the following tasks:

• Install a Teamcenter server, with the required Data Exchange components and FMS, for each
Teamcenter site participating in the network.

• Install Teamcenter Integration Framework.

• Configure each Teamcenter server.

• Install and deploy a Teamcenter web tier application with the required Data Exchange solutions.

• (Optional) Install Security Services if you want single sign-on (SSO) functionality.

1-22 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Installation worksheets

Installation worksheets

Use these worksheets to record important information about your network. You need to record this
information for reference on the worksheet and also get values here when they are needed.

Worksheet 1 – Data Exchange deployment information

Teamcenter site IDs

Teamcenter web application URLs

ODS servers (if applicable)

Security Services logon URL

Worksheet 2 – Teamcenter server information (use a separate sheet for each site)

Administrator user name/password (default: infodba)

Administrator password

Site ID

TC_gms_server

TC_SSO_login_URL

Worksheet 2 – Teamcenter web tier information (use a separate sheet for each site)

Web tier application staging directory

Web tier application name (context root)

Context parameters

DEPLOYABLE-FILE-NAME

Enterprise Application Registration ID

LogVolumeName

LogVolumeLocation

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-23

© 2020 Siemens
 1. Introduction

Worksheet 3 – FMS information

KeyGen value

FMS_HOME directory

FMS key file name

Site 1 parameters:

siteid
fscid
fscaddress

Site 2 parameters:

siteid
fscid
fscaddress

Site 3 parameters:

siteid
fscid
fscaddress

Additional site parameters

1-24 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Prerequisites

Worksheet 4 – Security Services information

Teamcenter site 1 transfer user

Teamcenter site 2 transfer user

Teamcenter site 32 transfer user

Teamcenter site 1 site ID

Teamcenter site 2 site ID

Teamcenter site 3 site ID

Teamcenter site 1 pseudo site ID

(SSOAppID)

Teamcenter site 2 pseudo site ID

(SSOAppID)

Teamcenter site3 pseudo site ID

(SSOAppID)

Worksheet 5 – integration framework information

Map control files

Site ID

Teamcenter site IDs

Teamcenter administrator user name and

password

Teamcenter user name and password.

[Link]

Prerequisites

You must have a Teamcenter server installed that contains several optional components. Depending on
the use cases that Data Exchange must support, you may need other products, such as Teamcenter
Integration for NX I-deas and the Content Migration Manager (CMM). These products are documented in
their own documentation set provided with the product. The following figure shows a sample
deployment scenario with two Teamcenter sites participating in the Data Exchange network.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-25

© 2020 Siemens
 1. Introduction

Teamcenter server installation requirements

Data Exchange requires that the following Teamcenter server features be installed during the server
installation process:

• Teamcenter Integration Framework

• (Optional) PMM Integration

• (Optional) SRM Integration

• (Optional) Substance Compliance Integration

• (Optional) Enterprise Integration

• Four-tier architecture

1-26 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Teamcenter configuration

• FMS
An initial installation of Teamcenter using Teamcenter Environment Manager provides a single FSC
that mounts to a single volume.

• (Optional) Vendor management (required for PDX export functionality)

• (Optional) ODS (If you want to be able to locate remote objects.)

It is recommended that you also install Security Services. This provides single sign-on functionality for
Teamcenter products.

Teamcenter configuration

Teamcenter configuration

Configuring Teamcenter for Data Exchange involves performing the following tasks:

1. Define sites.

2. Configure File Management System.

3. Create transfer option sets.

4. Set Access Manager (AM) rules to allow transfer of ownership between Teamcenter sites.

5. Update preferences.

6. (Optional) Create closure rules.

7. (Optional) Create transfer modes.

8. (Optional) Configure PDX export.

Install Teamcenter Integration Framework

Install Teamcenter Integration Framework. See the Teamcenter Integration Framework help collection
on the Siemens Digital Industries Software Doc Center.

Teamcenter Integration Framework configuration process

You use the Teamcenter Integration Framework configuration interface to perform this process. See the
Teamcenter Integration Framework help collection on the Siemens Digital Industries Software Doc
Center for details on configuring Teamcenter Integration Framework.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-27

© 2020 Siemens
 1. Introduction

1. Launch the Teamcenter Integration Framework configuration interface. Type the following address
in your web browser:

[Link]

2. Choose Configure→Sites.

3. Create a Teamcenter Enterprise site.

a. Set the Teamcenter Enterprise site ID.

b. Set the Teamcenter Enterprise FMS ID and URL.

c. Set the Teamcenter Enterprise MUX host and port.

d. Set the Teamcenter Enterprise site logon credentials (user name and password) for the
Teamcenter Integration Framework user.

e. Choose the Teamcenter Enterprise connector.

f. Save the Teamcenter Enterprise configuration.

4. Create a Teamcenter site.

a. Set the Teamcenter site ID.

b. Set the Teamcenter FMS ID and URL.

c. Set the Teamcenter 4-tier URL.

d. Set the Teamcenter server manager URL

e. Set the Teamcenter site logon credentials (user name and password) for the Teamcenter
Integration Framework user.

f. Choose the Teamcenter connector.

g. Save the Teamcenter configuration.

5. Configure the mapping relation between the two sites.

a. Create a new site mapping.

b. Configure the Teamcenter Enterprise site as the source site.

c. Select the map control files that define the mapping between the two sites.

1-28 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Define remote sites

d. Save the site mapping.

e. Create another new site mapping.

f. Configure the Teamcenter site as the source site.

g. Select the map control files that define the mapping between the two sites.

h. Save the site mapping.

Define remote sites

Remote sites are created using the Organization application. You must define sites for all locations that
exchange data.

1. Select the top-level sites node from the Organization List tree.

2. In the Sites pane, type a descriptive name for the site in the Site Name box. For the deployment
example, Teamcenter site 1 defines two remote sites: TcHost1 and the TcHost2.

3. Type a unique identifier in the Site ID box. For the deployment example, 457655709 and
457141260.

Caution:
Each site must be defined at other sites using exactly the same site ID in each definition. For
Teamcenter sites, this value is defined during the installation process.

4. Type the URL for your Teamcenter Integration Framework web server in the TcGS URL box.

5. Select the Uses TCXML Payload check box.

6. Select the Is HTTP Enabled check box.

7. Select the Allow deletion of replicated master objects to this site check box.

8. Click Create.

The site is created and appears in the Organization List tree.

Define Teamcenter preferences

You must set the Teamcenter preference values as shown in the following table to enable Teamcenter
Integration Framework.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-29

© 2020 Siemens
 1. Introduction

Preference name Value

GMS_offline_use_TcGS FALSE

TCIF_user_name IFAdmin

TCIF_user_password admin

TCIF_url [Link]
Use the name of the host for the Teamcenter Integration Framework server
as the host-name and the Teamcenter Integration Framework web server
port as the port-number (8081 by default).

Configure attribute mapping for 4GD major revisioning

Teamcenter supports interoperability between versions for at least one major release. To support major
revisioning of 4GD objects between versions of Teamcenter, you must configure attribute mapping to
support the two methods currently supported for revisioning. You must be a Teamcenter administrator
user to configure attribute mapping at both of the sites.

To support Multi-Site and high-level (HL) and low-level (LL) TC XML Data Exchange (TIE):

1. Attach the mdl0element_thread_to_wso_thread_mapping.xsl XSLT file available in the TC_DATA

directory to both the exporting and importing transfer mode being used for HL TIE using the
plmxml_tm_edit_xsl command line utility, for example:

plmxml_tm_edit_xsl –u=admin-user-name –p=admin-password -g=dba

-transfermode=TIEImportDefault -xsl_file=%TC_DATA%
\mdl0element_thread_to_wso_thread_mapping.xsl
–action=attach

Note:
This example uses the TIE default (TIEImportDefault) transfer mode. For mapping attributes
for Multi-Site transfers, use the MultiSiteDefaultTM transfer mode.

2. Ensure the wso_thread property of the Mdl0ConditionalElement object is set in the property set
of transfer mode you use for the data transfer. Include the following clause in the property set:

CLASS Mdl0ConditionalElement ATTRIBUTE wso_thread DO

After you perform these commands, you can also use the tcxml_import utility to transfer data using LL
TIE by specifying the XSLT file to use or the option set to use. For example, to specify the XSLT tile:

tcxml_import -u=admin-user -p=admin-password -g=dba -xsl=xslt-file-name

-file=tcxml-import-file-name -low_level

To specify the option set tile:

1-30 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 FMS keys

tcxml_import -u=admin-user -p=admin-password

-g=dba -optionset=option-set-name
-file=tcxml-import-file-name -low_level

The transfer mode associated with the transfer option has the XSLT file attached in the first step of this
procedure.

File Management System (FMS)

FMS keys

Data Exchange uses File Management System (FMS) keys to digitally sign and verify FMS tickets during
file transfers. FMS keys can use different keys for different ticket types; however, this is not a best
practice for Data Exchange.

FMS provides a script (keygen) that runs a Java utility for generating a key. This utility requires that you
have the FSC_HOME and JAVA_HOME environment variables set.

Data Exchange creates tickets with the delete flag set to false to allow a paused transaction to be
resumed. Therefore, you must periodically delete completed transactions from the transient volumes.

Create an FMS key

1. Use the keygen script to generate a key. For example, to generate a 128–bit key:

keygen 128

2. Copy this key value into a text file. For this example, the file name is [Link]. This key value must
be the first non-UNIX style comment line in the file.

# This file ([Link]) contains a 128–bit key for FMS tickets

f6968bd55d740f44ebacaba09c1313c4

3. Copy this text file to the FSC_HOME directory of each host running an FSC.

4. Install the generated key in the Teamcenter database using the install_encryptionkeys utility:

install_encryptionkeys -u=infodba -p=infodba—password -g=dba -f=modify

5. Verify the generated key is installed using the following command:

install_encryptionkeys -u=infodba -p=infodba—password -g=dba -f=list

The commands output must match the key value in the [Link] file.

6. Verify FMS access for your Teamcenter site using the fscadmin utility:

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-31

© 2020 Siemens
 1. Introduction

fscadmin -s URL-for-FSC -k common-key-file ./status

For example:

fscadmin -s [Link] -k [Link] ./status

Configure FMS for Data Exchange

You must edit the FMS_master.xml file for each site to reference the key files that you create and to
configure the FSCs from different sites to communicate with each other. The mulitsiteimport element is
used to set the attributes for each site in the Data Exchange network. The following figures show a
possible configuration for a Data Exchange network that has two Teamcenter sites (TcHost1 and
TcHost2). You can configure FMS in several ways to obtain different performance and failure tolerance
characteristics.

<!— fmamaster_FSC_TcHost1_ntpriv_gmsua.xml file in TC_ROOT\fsc directory —>

<FMSworld>
<multisiteimport siteid="576557004">
<defaultfscimport fscid="FSC_TcHost2_ntpriv_gmsua"
fscaddress="http:TcHost2:8544" priority="0" />
</multisiteimport>
<FMSenterprise id="457655709">
<ticket version="v100" keyfile="[Link]"/>
<ticket version="M050" keyfile="[Link]"/>
<ticket version="F100" keyfile="[Link]"/>
<fccdefaults>
………………
……………….
</FMSenterprise>

</FMSworld>

FSC for Teamcenter host 1

Note:
Locate the transientvolume element in this file and note the id value.

<!— fmsmaster_FSC_TcHos2t_master.xml file in TC_ROOT\fsc directory directory —>

<FMSworld>
<multisiteimport siteid="457655709">
<defaultfscimport fscid="FSC_TcHost1_ntpriv_gmsua"
fscaddress="http:TcHost1:4544" priority="0" />
</multisiteimport>
<FMSenterprise id="576557004">
<ticket version="v100" keyfile="[Link]"/>
<ticket version="M050" keyfile="[Link]"/>
<ticket version="F100" keyfile="[Link]"/>
<fccdefaults>
:
:

1-32 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Configure sites and mapping

</FMSenterprise>

</FMSworld>
FSC for Teamcenter host 2

Configuring Teamcenter Integration Framework

Configure sites and mapping

There are several files in Teamcenter Integration Framework ([Link],

[Link], [Link]) that configure the sites and define mappings between them in your
Data Exchange environment. Although these can be manually modified in the datastore, you can use
the Teamcenter Integration Framework configuration wizard to perform the configuration for all of
these files.

1. Log on to Teamcenter Integration Framework and choose Configure→Sites and Monitoring.

2. In the configuration interface, choose Configure→Wizard, select Configure a site, and click the
Next.

3. Select Teamcenter from the Create new site configuration list and click Next.

4. Type the Teamcenter site ID, for example, 457706589, in the Site ID box and click Next.

5. Enter the Teamcenter 4-tier URL, for example:

[Link]

6. For the user that Teamcenter Integration Framework uses to log on to the Teamcenter site, type
the user name in the Site User Name column and the associated password in the Site User
Password column for the IFAdmin principal.

7. Click Next, confirm your configuration and click Save.

Perform this same process for the enterprise site entering the location for your Teamcenter Enterprise
[Link] and [Link] files, Teamcenter site ID, MUX host name, MUX port number, and the
Teamcenter Enterprise thin client web application URL.

Configure data mapping

The Business Modeler IDE hosts the Mapping Designer data migration tool that you use to map the data
model between sites. The Mapping Designer provides the map control files used by the mapping engine.

You must define the control file to use for mapping from one site to another (one for each direction) in
the [Link] file. This files defines a source and target site and the control file used for that
direction of transfer.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-33

© 2020 Siemens
 1. Introduction

The map control files you use depend on the Teamcenter Enterprise solutions (data model) you intend
to support for data transfers. The standard map control files
(TC_Enterprise_to_Teamcenter_control.txt and Teamcenter_to_TC_Enterprise_control.txt) are
provided in specific locations within the datastore. There are also standard map control files for
transferring stub objects between systems in the MapControlFiles folder.

You can configure data mapping using the Teamcenter Integration Framework configuration interface
that is available from the Configure→Sites and Monitoring menu option in the Teamcenter Integration
Framework interface. The Teamcenter Integration Framework configuration interface has embedded
help available to assist you. Using the Teamcenter Integration Framework configuration interface
prevents typing errors for the elements and attribute names and is the recommended method for
configuring data mapping.

You can also manually edit the [Link] file.

Data model Data store location Teamcenter Enterprise solutions

Foundation Teamcenter Data Exchange (EMS)

MapControlFiles
Authorized Data Access License(ADA)
CAD_Neutral

IDS Teamcenter Data Exchange (EMS)

MapControlFiles
I-deas Enterprise using IDS (IDS)

CATIA Teamcenter Data Exchange (EMS)

MapControlFiles
CATIA Teamcenter Integration (CMI, GMI)
CATIA
Multi-Site Support for CATIA Integration
(CMX)

Pro/ENGINEER Teamcenter Data Exchange (EMS)

MapControlFiles
Pro/Engineer Classic Integration (PRO)
ProE
Multi-Site Support for Pro/Engineer
Integration (PMX)

1. Log on to Teamcenter Integration Framework and choose Configure →Sites and Monitoring.

2. In the configuration interface, choose Configure→Wizard, select Configure mapping relation

between two sites, and click the Next.

3. Select Create new site mapping and click Next.

4. Select the Teamcenter site under Select source site and click Next.

5. Select the Teamcenter Enterprise site under Select target site and click Next.

1-34 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Configure data mapping

6. Select the following files from the Available Transforms list (use ctrl+click to select multiple files)
and click the right arrow button to move them to the Selected Transforms list:

[Link]
Teamcenter_to_TC_Enterprise_control.txt
[Link]
[Link]
[Link]

7. Click Next, confirm your source and target site IDs and click Save.

8. Select Create new site mapping and click Next.

9. Select the Teamcenter Enterprise site under Select source site and click Next.

10. Select the Teamcenter site under Select target site and click Next.

11. Select the following files from the Available Transforms list (use ctrl+click to select multiple files)
and click the right arrow button to move them to the Selected Transforms list:

[Link]
Teamcenter_to_TC_Enterprise_control.txt
[Link]
[Link]
[Link]

12. Click Next, confirm your source and target site IDs and click Save.

13. Select the Teamcenter site under Select source site and click Next.

14. Select the Teamcenter Enterprise site under Select target site and click Next.

15. Select the following files from the Available Transforms list (use ctrl+click to select multiple files)
and click the right arrow button to move them to the Selected Transforms list:

[Link]
TC_Enterprise_to_Teamcenter_control.txt
[Link]
[Link]
[Link]

16. Click Next, confirm your source and target site IDs and click Save.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-35

© 2020 Siemens
 1. Introduction

Configure data mapping for ITAR license data

If you are transferring ITAR license information between Teamcenter and Teamcenter Enterprise sites,
you must create a map control file that contains the WrkImAda_add_license_list_ada factor. Be aware
of the following items when transferring objects with attached licenses.

• When you transfer objects with attached licenses, the license must exist in the importing system for
the license to be attached to the imported object. Synchronizing license associations between
systems is not supported. Therefore, if a licenses is detached from an object at the owning site, the
license does not get detached from the replica object.

• When you transfer objects with attached licenses from Teamcenter Enterprise to Teamcenter, the
importer checks the license status in Teamcenter and prevents attachment of a license with an
expired or locked status. To allow attachment of an expired or locked license, you must set the
GMS_expired_or_locked_ada_licenses_bypass preference value to TRUE.

Use the following process to create a map control file containing the WrkImAda_add_license_list_ada
factor.

1. If you will be attaching an expired or locked license, create the

GMS_expired_or_locked_ada_licenses_bypass preference and set its value to TRUE. (This
preference is not created by the Teamcenter installation process, so you must create the
preference.)

Siemens Digital Industries Software recommends that you use the following values when creating
this preference:

• Protection Scope: Site

• Environment: Disabled
• Category: TC XML Import [Link]

Select Logical from the Type list and Single from the Multiple box.

2. Copy the WrkImAda_add_license_list_ada directory and its contents from the following location:

TC_DATA
mapping_designer_projects
ADA
TC_Enterprise_to_Teamcenter_ADA_SA
Factor

To the following location:

TC_DATA
mapping_designer_projects
Foundation

1-36 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Configure Teamcenter Integration Framework for FMS

TC_Enterprise_to_Teamcenter_Foundation
Factor

3. Start the Mapping Designer and open the TC_Enterprise_to_Teamcenter_Foundation project.

4. Open the Factors Search view and search for the WrkImAda_add_license_list_ADA to confirm
that it is in the project.

5. Open the Factors view, right-click theTC_Enterprise_to_Teamcenter_Foundation project, and

choose Build Control File.

Configure Teamcenter Integration Framework for FMS

You can FMS using the Teamcenter Integration Framework configuration interface that is available from
the Configure→Sites and Monitoring menu option in the Teamcenter Integration Framework
interface. The Teamcenter Integration Framework configuration interface has embedded help available
to assist you. Using the Teamcenter Integration Framework configuration interface prevents typing
errors for the elements and attribute names and is the recommended method for configuring FMS.

You can also manually edit the [Link] file.

You can add new FSC servers or change the existing FSC servers used by the mapper service in
Teamcenter Integration Framework by updating the [Link] file in the datastore.

1. Log on to Teamcenter Integration Framework and choose Configure→Sites and Monitoring.

2. In the configuration interface, choose Configure→FMS, type the site running FMS in the Site ID
box and the URL for the host name and port number for the FMS server cache in the FSC URIs box,
for example:

Site ID: 457706589

FSC URIs: [Link]

Click Save.

Transfer modes in Teamcenter

Data Exchange provides standard transfer modes that allow you to move standard Teamcenter and
Teamcenter Enterprise data between sites. If these standard transfer modes do not meet your
requirements, you must provide a transfer mode for each destination site and for each data type you
support for transfer to the site. This is true for any type of PLM site, including other Teamcenter sites.
Therefore, it is likely that you will have multiple transfer modes for each site. The transfer modes for
Data Exchange must navigate clauses in the resulting XML file not the Teamcenter database. The
transfer modes defined for a specific site typically uses the same closure rule but have different filters,
action rule, or revision rules depending on the type of data being transferred.

Use the PLM XML/TC XML Export Import Administration application to create transfer modes.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-37

© 2020 Siemens
 1. Introduction

Be aware of the following items when working with transfer modes:

• Before performing any TC XML exports, you must remove any references to obsolete attributes and
classes from custom closure rules or property sets. Also remove any deprecated attributes and classes
from custom closure rules or property sets.
To identify deprecated and obsolete classes and attributes, see the Teamcenter README file for the
current version.

• If you are using the CATIA integration and are transferring assemblies with CAD data, you must add
the following property set clause to the transfer mode you use to transfer the assemblies:

CLASS.POM_catia_absocc:[Link]:DO

If you do not add this clause, the transfer fails during import with an error message stating the export
failed at the data import step, and the log file stating the IsContext attribute of the
POM_catia_absocc class is empty.

• The forceExportReplica option must be set to TRUE only when you are transferring non BOM data.
For BOM relevant data, this option should not be used or, if set, it must be set to FALSE.

Transfer option sets

Local versus remote transfer option sets

A transfer option set (TOS) is defined as a local TOS (for export transfers) or a remote TOS (for import
transfers). Data Exchange uses this TOS to pull (import) data from the remote system. The TOS has no
associated transfer mode, because the transfer mode (TM) and closure rules are defined at the remote
site. The remote site TOS is used to populate the export Teamcenter XML (TC XML) file.

Closure rules are filtered based on the options in the remote TOS.

Use the PLM XML/TC XML Export Import Administration application to create a transfer option set.

Note:
A remote TOS is normally imported from a remote site to ensure that it matches the TOS on the
remote site. Although you can create a remote site TOS and manually synchronize it to the remote
site, it is recommended that you use the import (tcxml_import) and export (tcxml_export)
utilities instead to provide your remote TOS. Once a TOS is imported, you must not change the TOS
name or site reference; however, you can add or remove options as long as the TOS at the remote
site is updated to reflect the changes you make.

For remote transfer option sets, you define only the TOS name. The name must match the TOS name
defined in the remote system. You must define a local transfer option set for exporting data to another
site. A local TOS requires that you define an option row in the options table for each symbol that is
defined in the associated closure rule clause.

1-38 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Transfer CATIA alternate shape representations

You can determine the options included in a TOS and get a description of their purpose in the PLM
XML/TC XML Export Import Administration application.

You can also modify the option settings, remove or add new options, and create new options in this
application. The best practice is to create a new TOS and not to modify the Siemens Digital Industries
Software supplied transfer option sets. The standard transfer option sets are overwritten when you do a
Teamcenter upgrade; any modifications you made are lost.

If you add custom options, you must customize Teamcenter to handle them.

Transfer CATIA alternate shape representations

If you intend to transfer CATIA alternate shape representation objects between Teamcenter sites, you
must add the following property set clauses to the TIEPropertySet property set at the exporting site:

CLASS.POM_alternateSR_userdata:ATTRIBUTE.Shapes_Files:DO
CLASS.POM_alternateSR_userdata:ATTRIBUTE.Shapes_Names:DO

These property clause entries export the Shapes_Name and Shapes_Files attributes for the
POM_alternateSR_userdata object.

Create version 0 transfer option set

Teamcenter stores two versions of a dataset by default (version 0 and version latest; version 0 is a copy
of latest version). When exporting an item or item revision that contains an IMAN_specification
relation to a dataset, Teamcenter exports two datasets pointing to the same ImanFile object. You can
change the export behavior to export only version 0 of the dataset with the latest version exported as a
stub. To do this, you must add the opt_from_tc_ds0_only option to your transfer option set and set its
value to True.

Caution:
Do not set this option to TRUE when you are transferring objects through a briefcase file. If this
option is not set to FALSE, the briefcase import fails.

1. In the Teamcenter rich client, open the PLM XML/TC XML Export Import Administration application
and select TransferOptionSet in the option pane beneath the tree pane.

2. Select the name of the transfer option set you want to use when transferring item or item revisions
with related datasets.

3. Click to add a new option.

4. Select the first column (Option) of the new row (at the bottom of the list) and type
opt_from_tc_ds0_only in the Option box.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-39

© 2020 Siemens
 1. Introduction

5. Press the Tab key and type Zero version export in the Display Name box.

6. Press the Tab key and select True from the Default Value list.

7. Press the Tab key and type Export zero version dataset only in the Description box.

8. Press tab and type Dataset Options in the Group Name box.

9. Click Create.

Set a rule to allow transfer of ownership

By default, the Access Manager (AM) rules do not allow transfer of ownership from one Teamcenter site
to another. You must change the default value to enable this capability.

1. In Access Manager, select Has Class (POM_application_object)→Import/Export in the rule tree.

2. Click to grant Transfer Out ( ) privileges.

3. Click Modify and click .

Define users, groups, and rules

The following setup is required to ensure that the Teamcenter Enterprise owner attribute is mapped to
Teamcenter owning user and owning group.

1. In Teamcenter Enterprise, create user teams, shared teams, and vaults.

2. In Teamcenter, create a user for every team and vault in Teamcenter Enterprise. General users can
also be created for testing mapping between the sites.

3. In Teamcenter, create a group for every team and vault in Teamcenter Enterprise with the
corresponding users created previously members with this as their default group.
This configuration ensures the following standard mapping does not cause an error on import.

From Teamcenter Enterprise To Teamcenter

User team Owning user and owning user’s default group

WPS team Owning user and owning user’s default group

Vault Owning user and owning user’s default group

1-40 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Closure rules

From Teamcenter To Teamcenter Enterprise

Owning user Owner (team or vault)

Owning group Not mapped (data not transferred)

Closure rules

Data Exchange provides standard closure rules that are used by the standard transfer modes provided.
To create additional closure rules, use the PLM XML/TC XML Export Import Administration application. A
closure rule must contain clauses for each type of data a site exports to another site. You can provide
conditional clauses in a closure rule. The closure rule qualifies only if the conditional clause evaluates to
TRUE. You can include symbols in a conditional clause. The symbols can be referenced from the transfer
option set and can be presented to your users as options they can turn on and off. You enter a symbol in
the conditional clause as a string that begins with a $ character, for example:

If $HPGL

Closure rules are a component of a transfer mode and therefore must be created before the transfer
mode. Closure rules can use various action directives, such as the SKIP_GRM action that Teamcenter
uses to skip the Generic Relationship Management (GRM) objects for exports. Alternatively, the SKIP
action skips the secondary objects but includes the primary and GRM objects in the export.

For additional information about managing closure rules, see the PLM XML/TC XML Export Import
Administration.

The default closure rules used by Data Exchange to determine objects in scope changed at Teamcenter
9.1. The following table shows the differences.

Data Exchange Prior to Teamcenter 9.1 Teamcenter 9.1 export to HL Teamcenter 9.1 configured
standard scope ([Link]) TC XML export to LL TC XML
rule object ([Link]) ([Link])

Transfer option set TIEOptionSetDefault TIEUnconfiguredExportDefault TIEConfiguredExportDefault_L

TIEConfiguredExportDefault L

Transfer mode TIEUnconfiguredExportDefault TIEExportDefaultTM TIEExportDefaultTM_LL

Closure rule TIEUnconfiguredExportDefault TIEExportDefaultCR TIEExportDefaultCR_LL

Property set TIEPropertySet TIEExportDefaultPS TIEExportDefaultPS_LL

Verifying the transfer configuration

Verify FMS configuration

1. Use the fscadmin utility to check the FMS access of your sites. For example:

Data Exchange, Teamcenter 12.3 PLM00094 12.3 1-41

© 2020 Siemens
 1. Introduction

fscadmin -s [Link] -k=FMS_ent.key ./status

FSC id: FSC_TcEntHost, site:TcEntHost
running for 3 days, 17 hours, 3 min, 46 sec
Current number of file connections: 0
Current number of admin connections: 1
fscadmin -s [Link] -k=[Link] ./status
FSC id: FSC_TcHost1, site:CVG101
running for 0 days, 7 hours, 5 min, 16 sec
Current number of file connections: 0
Current number of admin connections: 1
fscadmin -s [Link] -k=[Link] ./status
FSC id: FSC_TcHost2, site:CVG102
running for 0 days, 5 hours, 7 min, 51 sec
Current number of file connections: 0
Current number of admin connections: 1

2. If an FSC for a site is not running, check the FMS configuration using the fscadmin utility against
the configuration requirements. For example:

fscadmin -s [Link] -k=[Link] ./config

Verify transfer from Teamcenter

1. Log on to My Teamcenter as a user with Data Exchange export privileges.

2. Search for or create an item to transfer.

3. Select the item check box and choose Tools→Export→To Remote using Global Multi-SIte.

4. In the Export to Remote Site using Global Multi-Site dialog box, if the default site is not the
desired destination, click the select target site button . In the Select Target Site dialog box,
select the site listed in the Selected Sites list and click move left , select the destination site from
the Available Sites list, click move right , and click OK.

5. In the Export to Remote Site using Global Multi-Site dialog box, select the Immediate check box
and click OK.

1-42 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 2. Transferring objects using business
access rules
TC XML configured export ──────────────────────────────── 2-1
Exporting a configured bill of materials (BOM) ───────────────────────
2-1
Exporting a BOM without variant rules ─────────────────────────── 2-3
Delta export ─────────────────────────────────────────── 2-3
Synchronize changes for a specific BOM configuration ──────────────────
2-4
Repeat a previous export ──────────────────────────────────── 2-5
Export a bill of materials to a briefcase file ─────────────────────────
2-6
Export a configured bill of materials to a briefcase file (with Global Services) ────
2-6
Mapping configured BOM export files ──────────────────────────── 2-7
Exporting configured 4GD data to PLM XML ──────────────────── 2-8
4GD root objects for export to PLM XML ─────────────────────────── 2-8
Mapping 4GD object types to PLM XML ─────────────────────────── 2-9
4GD PLM XML export feature support ─────────────────────────── 2-10
Importing PLM XML as 4GD data ─────────────────────────── 2-11
4GD PLM XML import feature support ─────────────────────────── 2-11
Mapping 4GD PLM XML to 4GD object types ─────────────────────── 2-12
Export from Teamcenter (using Global Services) ───────────────── 2-15
Import to Teamcenter ────────────────────────────────── 2-18
Using site checkout ─────────────────────────────────── 2-18
Check out to a remote site ────────────────────────────────── 2-18
Check in from a site ────────────────────────────────────── 2-19
Cancel checkout to a site ─────────────────────────────────── 2-20
Check replica synchronization ───────────────────────────── 2-20
Exporting Supplier Relationship Management data ─────────────── 2-21
Configure Supplier Relationship Management ────────────────────── 2-21
Export to SRM ───────────────────────────────────────── 2-22
Improving export performance ──────────────────────────── 2-22
Accessing remote objects ─────────────────────────────── 2-22
Object Directory Service (ODS) ─────────────────────────────── 2-22
Publish to default ODS ──────────────────────────────────── 2-23
Publish to the publication list ──────────────────────────────── 2-23
Unpublish ODS objects ──────────────────────────────────── 2-24
Search for remote items ─────────────────────────────────── 2-25
Using PDX export ───────────────────────────────────── 2-25
Configure PDX export ───────────────────────────────────── 2-25
Defining a PDX workflow ─────────────────────────────────── 2-28
Creating a custom PDX style sheet ───────────────────────────── 2-28
Exporting PDX data ────────────────────────────────────── 2-32

Data Exchange, Teamcenter 12.3 PLM00094 12.3

© 2020 Siemens
Data Exchange, Teamcenter 12.3 PLM00094 12.3
© 2020 Siemens
 2. Transferring objects using business
access rules
TC XML configured export

Exporting a configured bill of materials (BOM)

The required input options are described in the following tables.

Default
Transfer option Description value

opt_exp_cfgbom Starts the configured BOM export and controls False

the traversal flow to prevent the export of
persistent objects related to lines that are
configured out.

opt_rt_only Controls whether the exported data contains only False

runtime objects or both runtime and related
persistent objects.

opt_exp_cnf Exports the variant configuration data when the False

structure is configured by only a revision rule (no
variant rule is applied). A structure configured this
way contains more lines than are found in a
realizable product (150 percent BOM).

opt_exp_persistentobj_only Blocks serialization of runtime objects in the TC False

XML file. Configured export and import using
high level TC XML is supported only for versions
8.3.3 and 9.1 and later. Serialization of runtime
objects must be turned off for prior versions of
Teamcenter.

Session option Description

revRule Indicates the name of the revision rule to use. If a configured BOM export is
started without this session option defined, the revision rule is read from the
TC_config_rule_name preference.

varRule Indicates the name of the saved variant rule or stored option set. Supports
classic, modular, and hybrid variants. The values that Teamcenter displays for
the variant rules are saved in the database.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-1

© 2020 Siemens
 2. Transferring objects using business access rules

Session option Description

Be aware that if the revision on which the variant options are populated is not
part of the BOM being exported, the following closure rules must be added
for the revision to be exported:
[Link]:[Link]:ATTRIBUTE.parent_item:PROCESS+TRAVERSE
[Link]:[Link]:ATTRIBUTE.bom_view_tags:PROCESS
[Link]:[Link]:ATTRIBUTE.structure_-
revisions:PROCESS

The export of a configured BOM using incremental change (IC) is covered as part of the revision rule
configuration. Additionally, you can control the visibility of components in the constructed BOM with
the options in the following table.

Default
Session option Description value

processUnconfiguredByOccEff Controls export of the BOMLine object False

configured out by occurrence effectivity.

processSuppressedOcc Controls export of suppressed BOMLines False

objects.

processUnconfiguredVariants Controls export of unconfigured variants. False

processUnconfiguredChanges Controls export of BOMLine objects False

configured out by incremental change.

Note:
Exporting incremental changes that are applied in context of a sublevel is not supported. Changes
must be done by selecting the topline context explicitly.

Note:
When synchronizing nonworkspace objects using high-level configured TC XML, Teamcenter
exports full objects even when you select the modified objects only option. You can use low-level
TC XML configured export as an alternative.
If you select the modified objects only option during an unconfigured export, Teamcenter
determines the objects requiring synchronization based on the correct parents IXR, resulting in
export of only the modified objects.
However, when there are no physical structure changes (for example, only effectivity or revision
rule changes,) both high-level and low-level TC XML export functions cannot identify the
synchronization candidates, causing full objects to be exported.

2-2 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Exporting a BOM without variant rules

You can export a configured BOM using Global Services from My Teamcenter or without using Global
Services. You can also export a configured BOM from a command line using the tcxml_export utility.
You must be a user with administrator privileges to use the utility.

Exporting a BOM without variant rules

A structure that is configured by only a revision rule (no variant rule is applied) contains more lines than
are found in a realizable product resulting in a 150 percent BOM. The exported TC XML file must contain
enough information for the target site to solve the variant conditions. To accomplish this, the TC XML
file contains the configuration data stored in the following variant data model classes:

• VariantExpression

• VariantExpressionBlock

• ConfigurationCNF

• ConfigurationExprLiteral

• ConfigurationFamily

Legacy and classic variants are supported; modular and hybrid variants are not supported. You must
select the opt_exp_cnf transfer option (set to True) for this type of export.

Delta export

BOMLine objects can be updated by many workflows and actions such as:

• BOMLine updates in Structure Manager

• Computer aided design (CAD) application updates to occurrences and end items

• Revise, baseline, release, check out and check in operations

• Multi-Site import and export operations such as replica updates

Because BOMLine objects are runtime objects, updates must be sent on a regular basis to provide the
proper representation of a BOM in the data caches. To accomplish these updates efficiently, Data
Exchange provides the ability to:

• Assign a stable identity to runtime objects that have been exported. The identity is stored in the
accountability table.

• Express a BOMLine object as a function of certain persistent Teamcenter objects (a recipe) that are
stored in the recipe table.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-3

© 2020 Siemens
 2. Transferring objects using business access rules

• Identify changed (dirty) BOMLine objects by combining the date in the recipe, accountability, and
scratch tables. Edits to Teamcenter data are stored in the scratch table.

• Reconfigure changed BOMLine objects by using their occurrence thread chain. These changes are
stored in the scratch table.

Unless you specify a root object as an input for the tcxml_export utility, a delta export contains all
changes to all exported configured structures. No specific root object is used. To specify a root object,
you must use the -inputfile or -inputduidfile arguments with the -sync argument.

The process for a delta export of a specific configuration is described in Synchronize changes for a
specific BOM configuration.

All applications that use TC XML and perform data synchronization have their application IDs registered
in the Teamcenter database's subscription table (SUBSCRIPTION_TABLE). If an application ID is inactive
longer than the time specified by the install utility's TC_TIMESTAMP_THRESHOLD parameter, it is
deleted from the subscription table. When this happens, the related data is no longer synchronized. The
default value of TC_TIMESTAMP_THRESHOLD is 96 hours. See Maintain data synchronization through
site consolidationfor more information.

Synchronize changes for a specific BOM configuration

This process requires the -low_level argument of the tcxml_export utility. Therefore, you must set the
SITCONS_AUTH_KEY environment variable in your command environment to a valid license value
obtained from GTAC.

Delta export for a specific BOM configuration requires a root object used to reconfigure and export the
modified component lines for the BOM configuration.

1. Export an assembly with specific configuration rules:

• Revision rule
Latest Working Only

• Variant rule
VRule1
BOMWindow

• Export options
Export suppressed bomlines

tcxml_export –u=tcadm –p=admpw> –g=dba –low_level

–inputfile=d:\temp\[Link]–svrule=VRule1 –processSuppressedOcc
–optionset=TIEConfiguredExportDefault_LL —file=d:\temp\[Link]

2-4 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Repeat a previous export

2. In Teamcenter, make changes to the product structure such as adding, deleting, or modifying child
components.

3. Delta export the configured assembly by specifying the top item ID and the same configuration
rules as the initial export.

tcxml_export –u=tcadm –p=admpw> –g=dba –low_level -sync

-inputfile=d:\temp\[Link] –svrule=VRule1 –processSuppressedOcc
–optionset=TIEConfiguredExportDefault_LL –file=d:\temp\out_sync.xml

Repeat a previous export

You can repeat the most recent export of a particular export configuration. Doing so helps address
situations such as:

• Importing a delta export failed and you need to regenerate the same delta export package.

• You need to correct an issue with the data and then recreate the previous delta export, including the
updated data and unchanged data from the previous delta export.

• Other situations where repeating the previous delta export is more efficient than manually updating
exported data.

You can re-export configured exports of high level and low level TC XML to managed or unmanaged
sites. Full and partial BOM exports are supported.

1. In the Teamcenter rich client, choose the same root object as used in the previous export you wish
to recreate.

2. Choose Tools > Export > To Briefcase. The Export to Briefcase dialog box is displayed.

3. Choose the same target site, revision rule, and variant rule as used in the previous export.

You do not need to mark objects for ownership transfer. The same ownership transfer
specifications will be used as in the previous export. Objects with their ownership transferred in
the previous export will also be included in this export.

4. Check Force Re-Export and click OK. The most recent export meeting this configuration is
repeated.

If the previous export meeting this criteria was a full export, the full export is repeated, including
changes since the previous full export. If there is no previous export, a full export is created.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-5

© 2020 Siemens
 2. Transferring objects using business access rules

Export a bill of materials to a briefcase file

You can export a configured bill of materials (BOM) an offline site as a briefcase file without having
middle ware (Teamcenter Integration Framework or Global Services) installed. To transfer without
middle ware, the GMS_offline_use_TcGS preference must be set to FALSE.

1. To export a BOM from My Teamcenter, choose Tools→Export→To Briefcase.

2. In the Export To Briefcase dialog box, click the Select target remote site(s) button ( ) and select
the site desired remote sites.

3. Select the TIEConfiguredExportDefault from the Options Set list.

4. Click the Display/Set export options button ( ).

Teamcenter displays the TIEConfiguredExportDefault dialog box.

Select the desired export options.

5. Select the desired revision rule form the Revision Rule list.

6. Select the desired variant rule form the Variant Rule list.

7. Select or type the desired directory in the Export Directory box and type the desired file name in
the Export File Name box.

8. (Optional) Type a description of the export in the Reason box.

Export a configured bill of materials to a briefcase file (with Global Services)

You can export a configured bill of materials (BOM) as a briefcase file for use by an offline site. A
briefcase transfer can be performed with or without Global Services as determined by the
GMS_offline_use_TcGS preference. To use Global Services, this preference must be set to TRUE.

1. To export a BOM through Global Services, in My Teamcenter, choose Tools→Export→To Briefcase.

2. In the Export To Briefcase dialog box, click the Select target remote site(s) button ( ) and select
the site desired remote sites.

3. Select the TIEConfiguredExportDefault from the Options Set list.

4. Select the desired revision rule from the Revision Rule list.

5. Select the desired variant rule from the Variant Rule list.

2-6 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Mapping configured BOM export files

6. Click the Display/Set export options button ( ).

Teamcenter displays the TIEConfiguredExportDefault dialog box.

Select the desired export options.

7. (Optional) Select any other export options check boxes:

• Select Start immediate transfer to start the transfer when you click OK. If you do not select this
option, the transfer is scheduled for off hours.

• Select Show progress indicator to open the progress pane that shows the steps of the transfer
as they are performed.

• Select Send email notification to have Teamcenter send an email to you when the transfer is
completed.

8. (Optional) Type a description of the export in the Reason box.

Mapping configured BOM export files

The TC XML file generated by the configured BOM export function contains parent unique identifiers
(PUIDs) instead of global stable identifiers (GSIDs). To use the Teamcenter Integration Framework
mapping engine, the file must have GSIDs. Teamcenter provides the PUID2GSIDTCXMLconverter Java
utility that you use to convert low-level PUID-based TC XML files to low-level GSID-based TC XML files.

This utility inserts a GSID child element for every element and replaces UID references with element-id
references to the corresponding objects’ GSID element. This allows the mapping engine to use the TC
XML files. You run this Java utility from the command line using the following syntax:

PUID2GSIDTCXMLconverter input-xml-filepath-filename

The utility generates the output file in the same directory as the input file with the same file name
appended with Gsid. For example, the following outputs a file named jcb_llaGsid.xml in the D:\Temp
directory:

D:\workdir>java -Xms30m -Xmx500m PUID2GSIDTCXMLConverter D:\Temp

\jcb_lla.xml

Note:
You may need to increase the Java virtual memory (JVM) size depending on the size of the input
file.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-7

© 2020 Siemens
 2. Transferring objects using business access rules

Exporting configured 4GD data to PLM XML

4GD root objects for export to PLM XML

Teamcenter supports PLM XML export for the following 4th Generation Design (4GD) root objects:

Note:
The 4GDPIEDataExportDefault transfer mode is the default transfer mode for transferring 4GD
data to PLM XML.

• Cpd0DesignElement
• Cpd0DesignFeature
• Cpd0Workset
• Mdl0SubsetDefinition
• Ptn0Partition
• Partition

4GD export to PLM XML has the following limitations:

Caution:
Exporting 4GD data in PLM XML format requires the out-of-the-box (OOTB) closure rules and
property sets defined in the 4GDPIEDataExportDefault transfer mode. If you need a custom
transfer mode, Siemens Digital Industries Software recommends that you copy the OOTB transfer
mode and add any required closure rules or property sets to the transfer mode. Do not delete any
of the OOTB clauses, this can cause incorrect data in the exported PLM XML

• The configuration (revision rule, variant rule, effectivity, and so forth) on a subset element is used
when you export a workset.

• The configuration on the 4GD application view is ignored for the export.

• If some objects are not accessible, the corresponding elements/attributes may be missing in the PLM
XML file. This may cause the schema validation to fail.

• If you set the TIE_debug value to 2, no error occurs if some objects in the export are not accessible.
The inaccessible objects are identified as configured out in the log file.

• The 4GDPIEDataExportDefault transfer mode is supported only for 4GD exports. Do not use it for
BOM exports, this causes undefined behavior.

• 4GD subset items cannot be directly exported to 4GD PLM XML using the 4GDPIEDataExportDefault
transfer mode. To export subset items, either use the PLM XML ConfiguredDataExportDefault
transfer mode instead of 4GDPIEDataExportDefault or open the item in Structure Manager and
export it as a BOM structure.

2-8 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Mapping 4GD object types to PLM XML

• The search option for a 4GD configuration is not supported.

Mapping 4GD object types to PLM XML

Note:
By default, design features and attribute groups are not exported with a workset structure because
the opt_4gd_exp_weld and opt_4gd_exp_ag options are set to FALSE in the
TIEPLMXMLExportInternal option set. If you want these exported with the workset structure,
change the options to TRUE.

4GD object type PLM XML element

ApprSearchCriteriaGroup SetFilter

ApprSearchCriteriaBoxZone ZoneFilter
ApprSearchCriteriaNamedZone
ApprSearchCriteriaPlaneZone
ApprSearchCriteriaProximity

ApprSearchCriteriaSavedQry SavedQuery

Cpd0CollaborativeDesign CollaborativeDesign

Cpd0Workset Workset

Cpd0WorksetRevision WorksetRevision

Cpd0WorksetMaster Form
Cpd0WorksetRevisionMaster
and other master forms

Cpd0DesignElement DesignElement

Cpd0ContinuousJoin ContinuousJoinDesignFeature

Cpd0ArcWeld ArcWeldDesignFeature

Cpd0Datum DatumDesignFeature

Cpd0DiscreteJoin DiscreteJoinDesignFeature

Cpd0ResistanceWeld ResistanceWeldDesignFeature

Cpd0SurfaceAdd SurfaceAddDesignFeature

Cpd0AdhesiveFill AdhesiveFillDesignFeature

Cpd0SurfaceWeld SurfaceWeldDesignFeature

Mdl0ApprSrchCrtClosure ClosureRule

Mdl0ApprSrchCrtOptionSet OptionSet

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-9

© 2020 Siemens
 2. Transferring objects using business access rules

4GD object type PLM XML element

Mdl0ApprSrchCrtType TypeSearchCriteria

Mdl0ApprSrchGeomConstraint GeometricConstraint

Mdl0ApprSrchSlctContent GroupFilter

Mdl0AttributeGroup AttributeGroup

Mdl0AttachAttributeGroup GeneralRelation

Mdl0DefaultGeometry SubElements of DesignElement:

plm:Transform, plm:Bound,
plm:Representation

Mdl0ElementThread InstanceThread

Cpd0ArcWeld ArcWeldDesignFeature

Ptn0ApprSrchPartition PartitionSearchCriteria

Ptn0Partition and its subtypes: Partition

Ptn0Design,
Ptn0Functional,
Ptn0Mfg,
Ptn0System, Ptn0Zone

Ptn0PartitionItem and its subtypes: PartitionItem

Ptn0DesignItem,
Ptn0FunctionalItem,
Ptn0MfgItem,
Ptn0SystemItem,
Ptn0ZoneItem

Ptn0PartitionItemRevision and its subtypes: PartitionItemRevision

Ptn0DesignItemRevision, Ptn0FunctionalItemRevision,
Ptn0MfgItemRevision, Ptn0SystemItemRevision,
Ptn0ZoneItemRevision

Ptn0PartitionScheme PartitionScheme

4GD PLM XML export feature support

Supported Unsupported

Property set customization Filter rule customization

Closure rule customization Action rule customization
Runtime property traversal in closure rule
Localization attribute export
Dataset/form absolute override
Dataset/Form override
AccesIndent/ownerRefs

2-10 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 4GD PLM XML import feature support

Supported Unsupported

Table property export LOV localization

Delta export

Importing PLM XML as 4GD data

4GD PLM XML import feature support

You can update your 4GD data by importing 4GD PLM XML created or modified by third-party
applications.

Imported objects are merged with your existing 4GD data. By default, if an imported object already
exists, the existing 4GD object is updated to match the imported object. Importing 4GD PLM XML
requires the 4GDPIEDataImportDefault transfer mode delivered with Teamcenter.

Imported 4GD PLM XML must adhere to the PLM XML standard and its restrictions. A 4GD PLM XML file
is identified to Teamcenter and differentiated from a standard PLM XML file by its Header element's
child Application element having its name attribute set to 4G. For example:

<Header id="id1" traverseRootRefs="#id2"

transferContext="4GDPIEDataExportDefault">
<Application id="id19" name="4G" version="0"/>
</Header>

If you are exchanging 4GD data between Teamcenter sites, export and import data using TC XML. If you
are importing BOM data that does not include 4GD data, import using standard PLM XML.

Limitations

Be aware of the following limitations when importing 4GD PLM XML:

• Importing the Representation 4GD PLM XML element (a child element of Occurrence) is not
supported.

• Importing 4GD PLM XML as PSOccurrenceNotes and BoundingMultiBox objects is not supported.

• Add and Modify elements (used in delta PLM XML) are not imported in 4GD PLM XML.

• The PLM XML schema allows an element in one file to reference another PLM XML file. Such
references are not supported when importing 4GD PLM XML files. In these cases, import the XML files
separately.

• Importing closure rules is not supported. All the data in a 4GD PLM XML file is imported and is not
filtered by import closure rules.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-11

© 2020 Siemens
 2. Transferring objects using business access rules

• Only major revisions are imported. Change space and minor revisions are not supported for import.

• Effectivity and variant configuration information is not imported.

• Run-time properties are not imported. Persistent attributes in UserData are imported.

• Business Modeler IDE extensions for operations on business objects (such as creating and saving) are
not honored or executed when importing.

• Revising objects during importing (that is, importing a new revision of an existing object and copying
or linking the related data from the old revision to the new revision) is not supported.

• 4GD override data and constraints data are not supported.

• 4GD connection groups and links are not supported.

• Changing a design element category during importing is not supported.

• Importing BOM incremental change data is not supported.

Mapping 4GD PLM XML to 4GD object types

You can update your 4GD data by importing 4GD PLM XML created or modified by third-party
applications.

4GD PLM XML-to-object import mapping

The 4GDPIEDataImportDefault transfer mode is the default transfer mode for importing 4GD PLM XML.
The following 4GD PLM XML elements are mapped to the listed 4GD object types on import.

4GD PLM XML element 4GD object type

AdhesiveFillDesignFeature Cpd0AdhesiveFill

ArcWeldDesignFeature Cpd0ArcWeld

ArcWeldDesignFeature Cpd0ArcWeld

AttributeGroup Mdl0AttributeGroup

ClosureRule Mdl0ApprSrchCrtClosure

CollaborativeDesign Cpd0CollaborativeDesign

ContinuousJoinDesignFeature Cpd0ContinuousJoin

DatumDesignFeature Cpd0Datum and its source object

Cpd0ShapeDesign

2-12 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Mapping 4GD PLM XML to 4GD object types

4GD PLM XML element 4GD object type

DesignElement Cpd0DesignElement
Cpd0DesignItemInstance
Rlz0ItemRealizationMap

DesignElement subelements Transform. Bound, Mdl0DefaultGeometry

Representation

DesignFeatureBase and its subelements Transform, Cpd0DesignFeature

Bound, Representation
Mdl0DefaultGeometry

DiscreteJoinDesignFeature Cpd0DiscreteJoin

Form Cpd0WorksetMaster,
Cpd0WorksetRevisionMaster, and other
master forms

GeneralRelation Mdl0AttachAttributeGroup

GeometricConstraint Mdl0ApprSrchGeomConstraint

GroupFilter Mdl0ApprSrchSlctContent

InstanceThread Mdl0ElementThread

Member Ptn0Membership

OccurrenceFilter ApprSearchCriteria

OptionSet Mdl0ApprSrchCrtOptionSet

Partition Ptn0Partition and its subtypes

Ptn0Design, Ptn0Functional, Ptn0Mfg,
Ptn0System, Ptn0Zone,
Ptn0ChildParentLink

PartitionItem Ptn0PartitionItem and its subtypes

Ptn0DesignItem, Ptn0FunctionalItem,
Ptn0MfgItem, Ptn0SystemItem,
Ptn0ZoneItem

PartitionItemRevision Ptn0PartitionItemRevision and its

subtypes Ptn0DesignItemRevision,
Ptn0FunctionalItemRevision,
Ptn0MfgItemRevision,
Ptn0SystemItemRevision,
Ptn0ZoneItemRevision

PartitionScheme Ptn0PartitionScheme

PartitionSearchCriteria Ptn0ApprSrchPartition

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-13

© 2020 Siemens
 2. Transferring objects using business access rules

4GD PLM XML element 4GD object type

Product Cpd0ShapeDesign

Product Item

ProductRevision Cpd0ShapeDesignRevision

ResistanceWeldDesignFeature Cpd0ResistanceWeld

SavedQuery ApprSearchCriteriaSavedQry

SetFilter ApprSearchCriteriaGroup

Subset Cpd0DesignSubsetElement/
Mdl0SubsetDefinition

SubsetInstance Cpd0DesignSubsetInstance

SurfaceAddDesignFeature Cpd0SurfaceAdd

SurfaceWeldDesignFeature Cpd0SurfaceWeld

TypeSearchCriteria Mdl0ApprSrchCrtType

Workset Cpd0Workset

WorksetRevision Cpd0WorksetRevision
Cpd0WorksetModel

ZoneFilter ApprSearchCriteriaBoxZone
ApprSearchCriteriaNamedZone
ApprSearchCriteriaPlaneZone
ApprSearchCriteriaProximity

The following PLM XML elements are mapped to the listed Teamcenter object types.

4GD PLM XML element 4GD object type

ApplicationRef PLMAppUID

AssociatedAttachment GRM

AssociatedDataSet ImanRelation

AssociatedForm ImanRelation

DataSet Dataset

Form Form

Occurrence BOMLine

2-14 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Export from Teamcenter (using Global Services)

4GD PLM XML element 4GD object type

Product Item

ProductInstance PSOccurrence

ProductRevision ItemRevision

Export from Teamcenter (using Global Services)

To export local data to a remote site using Global Services, the GMS_offline_use_TcGS preference must
be set to TRUE.

1. In the rich client, select the object that you want to export.

2. Choose Tools→Export→ Remote using Multi-Site.

3. In the Export to Remote Site using Global Multi-Site dialog box, select a destination site from the
Site Selection list.
(Optional) Type a description in the Reason box. The reason text is stored for future reference.
Select the desired check boxes:

Check box Description

Start immediate Causes the transfer request to process immediately. By default, Data
transfer Exchange schedules transfer request processing based on system load
conditions. Your administrator can disable this option.

Show progress Displays the progress monitor dialog box automatically when the process
indicator starts.

Send email Requests that Data Exchange send an email when a transfer is complete
notification to the address associated with the requesting user.

4. In the Remote Export Options dialog box, select the desired check boxes:

Note:
The options available in this dialog box depend on the variables in the selected option set.
If you are exporting a Requirements object, you must select the Include All Files check box.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-15

© 2020 Siemens
 2. Transferring objects using business access rules

Item options Description

Include All Revisions Exports all revisions. When transferring site ownership, this is the only
option available.

Latest Revision Only Exports the latest revision regardless of whether it is a working or
released revision.

Latest Working Exports only the latest working (such as nonreleased) revision.
Revision Only

Latest Working/Any Exports the latest working revision, if any; if no working revision, the
Release Status latest released revision with any release status is exported.

Latest Any Release Exports the latest released revision with any release status.
Status

Selected Revision(s) Exports only the revisions selected in the workspace.

Only
Caution:
If you use this option to export an assembly it must contain precise
parts only. If you attempt to export an assembly that contains
imprecise parts, the export fails.
This option cannot be used to export an assembly that has global
alternates or substitute components.

Specific Release Exports only the latest revision with the specified release status selected
Status Only from the list.

Product structure Description

options

Include Entire BOM Includes all components if the item selected is an assembly. The revision
selectors allow you choose revision to export with the selected item and
its component items, if applicable. You can choose only one revision
selector.
The TC_bom_level_export preference controls whether this option is
available.

Transfer Top-Level Transfers the selected assembly item and export all components with no
Item Only site ownership transfer.

2-16 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Export from Teamcenter (using Global Services)

Dataset options Description

Include All Versions Includes all dataset versions with each dataset selected for import or
export. When this option is not set, includes only the latest version of
each dataset selected for import or export.

Include All Files Includes all underlying operating system files (such as named
references) with each dataset selected for import or export. If you do not
set this option, only the dataset metadata is imported or exported.

Save options Description

Save All Option As Saves the options you select on the dialog box as the default option
Default settings.

Restore Option Set Replaces all options settings with the defaults settings.
Defaults

Session options Description

Transfer Ownership Transfers site ownership to the target site. When the this option is not
selected, your site retains ownership. If you transfer an item revision
with a sequence, its sequence manager is also transferred. The
TC_ownership_export preference controls the default value of this
option. It is recommended that you leave the default setting for this
option to cleared.

Continue On Error Allows the remote import or export objects operation to continue if
errors are encountered while importing/exporting optional objects. All
objects are considered optional except for administrative objects and the
following:

• Requirements
• Specifications
• Item Master
• Item Revision Master

Caution:
Data Exchange ignores the Continue On Error option for
administrative objects and checks for the objects in the importing
database before the actual import process begins. If they are not
found, the import fails even when you select this option.

This option is disabled if the Transfer Ownership option is set.

5. Click OK to close the dialog box and click Yes.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-17

© 2020 Siemens
 2. Transferring objects using business access rules

Import to Teamcenter
Teamcenter imports data during synchronization actions (pull) or when you select from an ODS server
that you want to pull from a remote site. The following procedure shows how you import objects in the
rich client:

1. In My Teamcenter, search for the remote objects and select the objects you want to import.

2. Choose Tools→Import→Remote.

3. (Optional) In the Remote Import using Global Multi-Site dialog box, type a description in the
Reason box. The reason text is stored for future reference.

4. Select the desired check boxes:

Check box Description

Immediate Causes the transfer request to process immediately. By default, Data

Exchange schedules transfer requests based on system load conditions.
Your administrator can disable this option.

Progress Indicator When the process starts, opens the default web browser and displays the
Audit - Activity Status table. The table shows the activity steps as they
are processed.

email Notification Requests that Data Exchange send an email when a transfer is complete
to the address associated with the requesting user.

5. Click Yes.

Using site checkout

Check out to a remote site

You can check out an object to a site (such as a supplier site) so that it can be modified by the site. This
creates a briefcase package file that you can transfer to the site where it can be imported. It also creates
a reservation object and associates it with the checked-out object. You cannot check out an object to a
site if it is already checked out either locally or to another site. If you log on to a hub site, you can also
check out a replica object to site.

Site checkout functionality is meant for collaboration between OEM and suppliers in following use cases
only:

• Adding or modifying datasets at a supplier site.

• Adding or modifying components (ps occurrences) at a supplier site.

2-18 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Check in from a site

• Modifying metadata (attribute values) of workspace objects at a supplier site. Modification of non-
workspace objects and revising item and item revisions is not supported.

To check out an object to a remote site:

1. In My Teamcenter, select the object you want to check out.

You can perform site checkout on the following objects and their subclasses only:

• Item
• ItemRevision
• PSBOMView
• PSBOMViewRevision
• Form

2. Choose Tools→Site Check-In/Out→Check-out To site.

3. In the Check-out To Site dialog box, choose the desired remote site for the Target Site list.
Optionally, type a change ID and comments in the respective boxes.

4. Click the Explore Selected Component(s) button , select related objects to check out, and click
OK. To select all related objects, click the Select All Components button .

5. Click Yes.

Data Exchange does not support site checkout of Schedule, ScheduleRevision, ScheduleTask,
ScheduleTaskRevision objects, and their related objects.

Check in from a site

After you import the briefcase package (see Import the package file) that has objects checked out to a
site (see Check out to a remote site), you can check in the objects to your site. You can also check in a
replica object. When an object is checked in to a site:

• If it was checked out to another site, the reservation object is restored to its precheckout state.

• If the object was not checked out to another site, the reservation object is removed.

• The export record is updated.

1. In My Teamcenter, select the objects that you want to check in to your site.

2. Choose Tools→Site Check-In/Out→Check-in From site.

3. Click Yes.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-19

© 2020 Siemens
 2. Transferring objects using business access rules

Ownership of new objects added at supplier site is determined based on the following criteria:

• New objects created at a supplier site that are part of an existing island from the OEM are owned by
the OEM. For example, a dataset/version added to an Item/ItemRevision object at a supplier site that
is owned by the OEM is also owned by the OEM.

• New objects created at a supplier site that are part of a new island at supplier site are owned by
supplier, for example, adding a new Item object (component) at a supplier site to an assembly owned
by the OEM.

Note:
Islands are logical groups of objects where the primary object is an item. For example, the
following objects are part of an island.

• Item (primary object of an island)

• ItemRevision
• Dataset
• Form
• Relation
• PSOccurrence

Cancel checkout to a site

If you checked out an object out to a site (see Check out to a remote site), you can cancel the checkout
by choosing Tools→Site Check-In/Out→Cancel Check-Out to site. You can also cancel checkout of a
replica object. Only an administrator can cancel a site checkout when another user performed the
checkout. When a site checkout is canceled:

• If it was checked out to another site, the reservation object is restored to its precheckout state.

• If the object was not checked out to another site, the reservation object is removed.

• The export record is removed.

• Datasets are not restored to their precheckout state. The only action is the site checkout lock is
removed.

Check replica synchronization

The replica sync state of an object identifies whether it is up to date with the master object.

1. Select the replica objects that you want to check.

2. Choose Tools→Multi-Site Collaboration→Check Replica Sync State.

Teamcenter displays the Replica Sync State dialog box showing replicated object status.

2-20 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Configure Supplier Relationship Management

Exporting Supplier Relationship Management data

Configure Supplier Relationship Management

To enable Data Exchange to export to Supplier Relationship Management (SRM), you must set the host
and port where SRM Connect is running in the SRM_hostname_portnumber preference.

SRM Connect can be integrated to Teamcenter using a socket service connection.

For information about SRM Connect, see the SRM Connect Reference Guide.

By default, SRM export uses the TIEUnconfiguredExportDefault transfer option set (TOS). You can
create a custom transfer option set for your SRM export using the PLM XML/TC XML Export Import
Administration application. For the TIEUnconfiguredExportDefault:

• Add the following properties to the TIEExportDefaultPS property set for the
TIEUnconfiguredExportDefault TOS:

Primary object Primary object Relation type Related property or Property

class type object action
type

CLASS Item Attribute checked_out DO

CLASS Item Attribute checked_out_user DO

CLASS Item Attribute object_type DO

CLASS ItemRevision Attribute checked_out DO

CLASS ItemRevision Attribute checked_out_user DO

CLASS ItemRevision Attribute object_type DO

CLASS Dataset Attribute object_type DO

You can provide a list of values (LOV) for the Partition and Template for a bid package that allows users
to select what is appropriate for their package. These Partition and Template LOVs must be present in
Teamcenter before they can be used during SRM export from Data Exchange.

Also, when you export an SRM object that has custom item or subitem types, the item type is exported
as an attribute on a standard Teamcenter item object parent for the item. This maintains the information
during transfers between systems. To support this feature, you must update the RFx maintained
properties and XML file to store the types and subtypes supported by Teamcenter.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-21

© 2020 Siemens
 2. Transferring objects using business access rules

Export to SRM

Before you can export objects to Supplier Relationship Management (SRM), you must configured Data
Exchange to enable SRM export.

1. In the rich client, select the part or assembly object that you want to export.

2. Choose Tools→Export→To SRM.

The system displays the Export To SRM dialog box.

3. In the Export To SRM dialog box, provide a Sponsor Email value.

The default email address is your Teamcenter user email address.

4. Select a partition from the SRM Partition list.

5. Select a template from the SRM Template list.

6. (Optional) Type a description in the Reason box.

The reason text is stored for future reference.

7. (Optional) Select a transfer option set from the Option Set list.

8. Click OK to start the export and close the dialog box.

The system sends an email to the Sponsor Email with the exported data, along with whatever
other information is specified by the transfer option set.

Improving export performance

You can improve performance of certain exports by setting transfer options.

• If delta exports are not required, set the createIxr option to False.

• If your exports do not require site checkout, set the opt_skip_sco_checks option to True.

• If your exports do not require ACL checks, set the skipPrivilegeCheck option to True.

• If your exports do not require the infer delete feature, set the inskipAddExcludedGRMs option to
True.

Accessing remote objects

Object Directory Service (ODS)

You use the Object Directory Service (ODS) server to make objects available to remote systems and to
find objects on remote systems. You can also remove (unpublish) an object previously published to the

2-22 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Publish to default ODS

ODS. Your system administrator defines a default ODS for your entire site. The system administrator may
have defined a list of ODS publication sites that you can use to publish to multiple ODS sites at the same
time. For additional information about ODS, see the Multi-Site Collaboration. You use the rich client
interface to work with ODS.

Note:
ODS operations are not supported between Teamcenter and Teamcenter Enterprise sites. All Data
Exchange operations related to ODS are supported only for Teamcenter-to-Teamcenter operations.
This includes publishing objects to the ODS, remote search operations, and remote import
operations based on remote search results.

Publish to default ODS

1. Select the objects you want to publish.

2. Choose Tools→Multi-Site Collaboration→Publish and a default ODS command:

• To Default ODS
Teamcenter publishes the object without requiring additional input.
This completes the process.

• To Default ODS…
Teamcenter displays the Publish to Default ODS dialog box. At this time, you can publish to the
default ODS (step 3) or select a site (step 4).

3. Click Yes to publish to the default ODS.

This completes the process.

4. Click to select the site names that you want to publish to.
Teamcenter displays the Site Selection dialog box. The sites that are available are listed under
Available Sites.

5. Select the sites that you want to add to the Selected Sites list and click .

6. Click OK to apply your changes and close the Site Selection dialog box.

7. Click Yes.

Publish to the publication list

You can publish to a list of ODS servers that has been configured by your site administrator.

1. Select the objects you want to publish.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-23

© 2020 Siemens
 2. Transferring objects using business access rules

2. Choose Tools→Multi-Site Collaboration→Publish→To ODS Publication List.

3. In the Publish to Publication List dialog box, publish to a list of sites in one of these ways:

• Click Yes to publish to the sites that are in the list.

• Click to select the site names that you want to publish to.
Teamcenter displays the Site Selection dialog box. The sites that are available are listed under
Available Sites.

a. Select the sites that you want to remove from the Selected Sites list and click .

b. Click OK to apply your changes and close the Site Selection dialog box.

c. Click Yes.

Unpublish ODS objects

After you publish an object to an ODS server, you can remove the object so that remote sites cannot
access it by using the unpublish commands.

1. Select the objects you want to unpublish.

2. Unpublish the object in one of these ways:

To unpublish Do this Result

From the default Choose Tools→Multi-Site Unpublishes the object

ODS server Collaboration→Unpublish→From Default with no further
ODS interaction required.

From all ODS Choose Tools→Multi-Site Unpublishes the object

servers Collaboration→Unpublish→From All with not further
Published - To ODS Site(s) interaction required.

From specific ODS Choose Tools→Multi-Site Displays the Unpublish

servers Collaboration→Unpublish→From Specific From ODS Site dialog box
ODS Site(s) where you can select the
desired ODS sites.

From the default Choose Tools→Multi-Site Displays the Unpublish

ODS server or a Collaboration→Unpublish→From Default From Default ODS Site
different server if ODS… dialog box where you can
the default is not confirm the default ODS
the expected ODS server or select the
server desired ODS site.

2-24 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Search for remote items

Search for remote items

You search for remote objects using a saved search, specifically the system-defined Remote search.

1. Click Search on the rich client toolbar.

2. In the Search pane, click Change.

3. In the Change Search dialog box, click the System Defined Searches tab.

4. Select Remote and click Change Search.

5. Type or select the following search criteria for the object.

• Name
• ID
• Rev ID
• Description
• Type
• Class
• Owning User
• Owning Group
• Owning Site
• Release Status

Using PDX export

Configure PDX export

Caution:
You must select the Vendor Management feature during Teamcenter installation to create the
TIEPDXPropertySet property set that PDX export requires.
Teamcenter Environment Manager (TEM) imports the [Link] file that
contains the definitions of all standard transfer modes. The importer validates the clauses of a
property set. Because the TIEPDXPropertySet property set contains vendor management-related
clauses, if you do not select the Vendor Management feature, the validation fails when the
vendor management-related clauses are encountered. This prevents the PDX export feature from
being fully functional.

1. Map your Teamcenter objects and their attributes to PDX objects and their attributes. Teamcenter
provides a default mapping of standard Teamcenter objects to PDX objects (see Standard PDX
mapping) and a default style sheet for transforming standard objects to PDX objects.

a. Map any custom subtypes or data model changes.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-25

© 2020 Siemens
 2. Transferring objects using business access rules

b. If the default PDX transfer option set and transfer mode are not appropriate for mapping your
PDX package due to new subtypes or data model changes, define an appropriate transfer
option set and transfer mode.

A. Copy the default transfer mode file. It is recommended that naming the transfer mode
file be based on the business process.

B. Update the transfer mode to reference the information that must be exported in a PDX
package.
For details on how to change the closure rule, filter rule, property set, and revision rule,
see the PLM XML/TC XML Export Import Administration.

c. Create a custom style sheet to transform the custom subtypes or data model differences.

A. Copy the standard PDX style sheet ([Link] file) located in the data directory of your
TC_DATA directory of your Teamcenter installation.
Siemens Digital Industries Software recommends renaming the style sheet, for example,
[Link].

B. Change the style sheet to transform the information required in your exported PDX
package.

C. Ensure this style sheet is called during export of a PDX package.

2. Define the transfer option sets that Teamcenter displays in the PDX export dialog box. These are
controlled by the TC_gms_export_transfermode_for_target-site-name and
TC_gms_export_default_transfermode preferences. If both are defined, the
TC_gms_export_transfermode_for_target-site-name preference takes precedence. The transfer
mode value of the preference defines the options that the dialog box displays.

3. Define the PDX remote site:

a. Select the top-level sites node from the Organization List tree.

b. In the Sites pane, type a descriptive name for the site in the Site Name box, for example, PDX
site 1: PDX1.

c. Type a unique identifier in the Site ID box, for example, 1009598626.

Caution:
Each site must be defined at other sites using exactly the same site ID in each definition.

d. Select the Uses TCXML Payload check box.

2-26 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Configure PDX export

Note:
The TcGS URL box is read only until you select the Uses TCXML Payload check box.

e. For Teamcenter Integration Framework based export, type the URL used to contact the
Teamcenter Integration Framework web server port in the TcGS URL box, for example:

[Link]

f. Select the Is Offline check box.

g. Click Create.

4. For non-Global Services based export, attach the customized [Link] style sheet to the default
PDX TIEPDXExportDefault transfer mode:

a. In a Teamcenter command shell, use the plmxml_tm_edit_xsl utility to attach the style sheet
to the transfer mode, for example:

plmxml_tm_edit_xsl -u=infodba -p=infodba

-transfermode=TIEPDXExportDefault
-xsl_file=C:\TC\tcdata\data\[Link]
-action=attach

b. Use the utility to verify the style sheet is attached correctly, for example:

plmxml_tm_edit_xsl -u=infodba -p=infodba

-transfermode=TIEPDXExportDefault -action=list

The utility’s output should be similar to:

Original File Name is <[Link]>

5. Set your Teamcenter preferences.

• If you are providing PDX options sets based on the destination site, create a
TC_gms_export_transfermode_for_<site_name> preference for each destination site that
contains the transfer mode designated for the particular site, for example:

TC_gms_export_transfermode_for_PDX1=TIEPDXExportDefault

• Set the PDX_pkg_file_name preference at the site location. The following keywords are the only
keywords supported by PDX_pkg_file_name. The keywords are case sensitive and other values
are treated as constants.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-27

© 2020 Siemens
 2. Transferring objects using business access rules

PDX-string PDX-string is a string constant prefixed to the package file name of each
exported package. You can use this to identify the package as desired, such as
by the originating site.
ItemId Includes the item ID of the exported object as part of the package file name.
ItemName Includes the item name of the exported object as part of the package file name.
RevId Includes the revision ID of the exported object as part of the package file name.
TargetSite Includes the site name the object exported to as part of the package file name.
TimeStamp Includes the time stamp information at the time the object is exported as part
of the package file name.

6. Set the PROCESS_WARM and PROCESS_TARGET parameter in the server pool properties file
([Link]) to ensure there is a sufficient number of tcservers
available. The following are recommended minimum values for PDX export functionality:

PROCESS_WARM=5
PROCESS_TARGET=0700 10, 1700 10

7. Test the customized solution.

8. Provide your users with the transfer option set name they must select when they are exporting a
PDX package.

Defining a PDX workflow

The BC-perform-offline-export workflow handler contains the required and optional arguments that, as
an administrator, you can use to create workflow process templates for exporting a PDX package
through a workflow.

Creating a custom PDX style sheet

Subtyped objects

The following table and figures show how the standard style sheet maps elements of TC XML data to
elements of PDX data. If these Teamcenter objects are subtyped, their corresponding sections have to be
duplicated as shown in the second figure. The standard style sheet makes extensive use of templates (to
generate BOMLine elements, Attachment elements, and so forth). Your customizations must preserve
their functionality.

TC XML element PDX element

Item, Part, CommericalPart Item

EngChange Change

2-28 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Subtyped objects

TC XML element PDX element

ManufacturerPart ManufacturerPart

Vendor Contact

<xsl:if test=&#8221;count(//tc:Item)&gt;0
or count(//tc:Part))&gt;0
or count(//tc:CommercialPart))&gt;0&#8221;>
<xsl:element name=&#8221;Items&#8221;>
<xsl:for-each select=&#8221;tc:TcXML/tc:Item&#8221;>
&#8942;
<xsl:for-each select=&#8221;tc:TcXML/tc:Part&#8221;>
&#8942;
<xsl:for-each select=&#8221;tc:TcXML/tc:CommercialPart&#8221;>
&#8942;
</xsl:element>
</xsl:if>

<xsl:if test=&#8221;count(//tc:EngChange)&gt;0&#8221;>
<xsl:element name=&#8221;Changes&#8221;>
<xsl:for-each select=&#8221;tc:TcXML/tc:EngChange&#8221;>
&#8942;
</xsl:element>
</xsl:if>

<xsl:if test=&#8221;count(//tc:ManufacturerPart)&gt;0&#8221;>
<xsl:element name=&#8221;ManufacturerPart&#8221;>
<xsl:for-each select=&#8221;tc:TcXML/tc:ManufacturerPart&#8221;>
&#8942;
</xsl:element>
</xsl:if>

<xsl:element name=&#8221;History&#8221;>
&#8942;
</xsl:element>

<xsl:if test=&#8221;count(//tc:Vendor)&gt;0&#8221;>
<xsl:element name=&#8221;Contacts&#8221;>
<xsl:for-each select=&#8221;tc:TcXML/tc:Vendor&#8221;>
&#8942;
</xsl:element>
</xsl:if>

Collapsed standard style sheet view

<xsl:if test=&#8221;count(//tc:Item)&gt;0
or count(//tc:Part))&gt;0
or count(//tc:MyCustomPart))&gt;0

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-29

© 2020 Siemens
 2. Transferring objects using business access rules

or count(//tc:CommercialPart))&gt;0&#8221;>
<xsl:element name=&#8221;Items&#8221;>
<xsl:for-each select=&#8221;tc:TcXML/tc:Item&#8221;>
&#8942;
<xsl:for-each select=&#8221;tc:TcXML/tc:Part&#8221;>
&#8942;
<xsl:for-each select=&#8221;tc:TcXML/tc:MyCustomPart&#8221;>
&#8942;
<xsl:for-each select=&#8221;tc:TcXML/tc:CommercialPart&#8221;>
&#8942;
</xsl:element>
</xsl:if>

<xsl:if test=&#8221;count(//tc:EngChange)&gt;0&#8221;>
<xsl:element name=&#8221;Changes&#8221;>
<xsl:for-each select=&#8221;tc:TcXML/tc:EngChange&#8221;>
&#8942;
</xsl:element>
</xsl:if>

<xsl:if test=&#8221;count(//tc:ManufacturerPart)&gt;0&#8221;>
<xsl:element name=&#8221;ManufacturerPart&#8221;>
<xsl:for-each select=&#8221;tc:TcXML/tc:ManufacturerPart&#8221;>
&#8942;
</xsl:element>
</xsl:if>

<xsl:element name=&#8221;History&#8221;>
&#8942;
</xsl:element>

<xsl:if test=&#8221;count(//tc:Vendor)&gt;0&#8221;>
<xsl:element name=&#8221;Contacts&#8221;>
<xsl:for-each select=&#8221;tc:TcXML/tc:Vendor&#8221;>
&#8942;
</xsl:element>
</xsl:if>
Customized style sheet with subtypes

Custom attributes

The custom attributes of Teamcenter objects must be mapped either to attributes of PDX elements or to
AdditionalAttributes PDX elements. This involves adding these tags as shown in the following figure for
the attachment element.

<xsl:attribute name="fileSize&#8942;>
<xsl:value&#8212;of
select=&#8942;//tc:ImanFile/tc:GSIdentity(@elemId=$dsId)/../
@byte_size"/>

2-30 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 PDX specification elements not in the standard style sheet

</xsl:attribute>
<xsl:attribute name="versionIdentifier&#8942;>
<xsl:value&#8212;of
select=&#8942;//tc:GSIdentity(@elemId=$imsoId)/../
@version_number"/>
</xsl:attribute>
<xsl:attribute name="attachmentModificationDate&#8942;>
<xsl:value&#8212;of
select=&#8942;//tc:ImanFile/tc:GSIdentity(@elemId=$dsId)/../
@last_mod_date"/>
</xsl:attribute>
<xsl:attribute name="extraAttribute&#8942;>
<xsl:value&#8212;of select=&#8942;Yes"/>
</xsl:attribute>
<xsl:element name="AdditionalAttributes&#8942;>
<xsl:element name="AdditionalAttribute&#8942;>
<xsl:attribute name="name&#8942;>
<xsl:text>CustomAttribute1</xsl:text>
</xsl:attribute>
<xsl:attribute name="value&#8942;>
<xsl:value&#8212;of
select=&#8942;//tc:ImanFile/tc:GSIdentity(@elemId=
$dsId)/../@myCustomAttri
bute"/>
</xsl:attribute>
</xsl:element>
</xsl:element>
Customized style sheet with AdditionalAttributes elements

PDX specification elements not in the standard style sheet

The standard style sheet transforms the following PDX elements:

• ApprovedManufacturerListItem
• AdditionalAttribute
• AdditionalAttributes
• AffectedItem
• ApprovedManufacturerListMarkup
• Attachment
• BillOfMaterialItem
• BillOfMaterialMarkup
• Change
• ChangeHistoryItem
• Contact
• HistoryItem
• Item
• ManufacturerPart
• ProductDataeXchangePackage

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-31

© 2020 Siemens
 2. Transferring objects using business access rules

• ReferenceDesignator

The style sheet must be extended for any other PDX specification elements that you want in addition to
these (for example, SupplierPart). Use the standard style sheet as a reference for adding the additional
elements.

Exporting PDX data

Export a PDX package

The PDX export feature is available within the rich client from the Tools menu. PDX export can be used
within a workflow and a PDX package can be accessed within a workflow the same as any dataset.

The Teamcenter objects that can be exported to PDX and how they are mapped to PDX objects by the
out-of-the-box (OOTB) mapping file, are described in Standard PDX mapping.

1. Select the object to export.

2. Choose Tools→Export→To PDX.

Note:
Unmanaged sites are not listed as available export sites for PDX.

3. In the Export to PDX dialog box:

a. (Optional) Type the reason you are exporting the package in the Reason box.

b. Click Select target remote site to the right of Target Sites to select the export destinations
for the objects.

c. Select the PDX option set from the Option Set list.

d. (Optional) Select the check box for a desired option:

Immediate Starts the export process immediately instead of during the scheduled off-
hours period.
Progress Displays the progress pane automatically when the process starts.
Indicator
email Requires Data Exchange to send an email when the transfer is complete to
Notification the address associated with the requesting user.

e. (Optional) Click export options to select the transfer options for the PDX package.

2-32 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Access a PDX package from a workflow

Note:
The options available in this dialog box depend on the variables in the selected option
set.

4. Click Yes.
After the export completes, open your Mailbox to locate the PDX package. You can copy the
package to another location in Teamcenter or download the package to the file system.

Access a PDX package from a workflow

A PDX package is a dataset that is accessible from a workflow process like any dataset. You can attach or
refer a PDX package to another object in a workflow process. You can copy a document to be sent as a
reference document in the process dialog box.

Query for a PDX package

1. Click Search on the toolbar or select Advanced from the search menu at the top of the navigation
pane.

Note:
The software ships with Item selected as the default search.

2. In the Search pane, click Change.

3. In the Change Search dialog box, click the System-defined Searches tab, select Dataset search
from the list, and click Change Search.

4. In the Search pane, select PDX from the Dataset Type list and click execute.

Note:
The Abort button in the upper left corner is active while a query is running, but it cannot
stop the database query process once it starts.

Delete a PDX package

If you have the proper privileges, you can delete a PDX package by selecting the package and pressing
the delete key.

Download a PDX package

1. Select the PDX package, right-click, and choose Named References.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 2-33

© 2020 Siemens
 2. Transferring objects using business access rules

2. In the Named References dialog box, select the PDX package file in the Name column and click
Export.

3. Type, or browse to, the location where you want to place the PDX package and click Export.

2-34 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 3. Exchanging data with suppliers
Using briefcase files ──────────────────────────────────── 3-1
Exchanging briefcase files with unmanaged sites ───────────────────── 3-1
Configure briefcase for site checkin and checkout ───────────────────── 3-2
Configure Teamcenter for Briefcase Browser ──────────────────────── 3-4
Configure Teamcenter for briefcase mail notification ─────────────────── 3-6
Briefcase Browser site configuration files ────────────────────────── 3-7
Compare and preview large briefcase files ──────────────────────── 3-16
Configure Briefcase Viewer ────────────────────────────────── 3-16
Customize Briefcase Viewer icons ────────────────────────────── 3-17
Configure 4th Generation Design data exchange ──────────────────── 3-19
Migrate a supplier site from a managed to unmanaged site ────────────── 3-19
Marking objects for ownership transfer ────────────────────────── 3-22
Recover briefcase ownership ───────────────────────────────── 3-24
Preview Briefcase Browser packages in the rich client ────────────────── 3-24
Compare Briefcase Browser packages in the rich client ───────────────── 3-25
CAD design exchange business process ────────────────────── 3-26
Configure 4th Generation Design data exchange ──────────────── 3-26
Unmanaged site briefcase transfers ───────────────────────── 3-27
Configuration required for unmanaged site transfers ────────────────── 3-27
Export a briefcase file to an unmanaged site ─────────────────────── 3-27
Import validation results ─────────────────────────────────── 3-30
Import a briefcase file from an unmanaged site ───────────────────── 3-31
Transferring a briefcase package ─────────────────────────── 3-31
Briefcase transfer process ────────────────────────────────── 3-31
Package the data ──────────────────────────────────────── 3-32
Transfer the package file ─────────────────────────────────── 3-35
Import the package file ──────────────────────────────────── 3-36

Data Exchange, Teamcenter 12.3 PLM00094 12.3

© 2020 Siemens
Data Exchange, Teamcenter 12.3 PLM00094 12.3
© 2020 Siemens
 3. Exchanging data with suppliers
Using briefcase files

Exchanging briefcase files with unmanaged sites

You can use briefcase files to exchange data with other Teamcenter sites that do not participate in a
data exchange environment or for sites that are temporarily offline. You can also use briefcase files to
exchange data with sites that do not manage their data with Teamcenter (unmanaged site) such as a
supplier site. Unmanaged sites must have Briefcase Browser installed and configured to work with
briefcase files.

Subsystem designers and manufacturers, component suppliers, and build to specification suppliers are
examples of suppliers that can be unmanaged sites. Briefcase data exchange:

• Allows variability of data models.

• Supports metadata, JT, NX, and CATIA data.

• Requires data push (manual file transfer, such as email attachment) unless you are using the Supplier
Collaboration solution.

• Supports partial BOM export.

• Supports delta export from a full assembly and from subassemblies.

• Supports round-trip exchange of CAD data (stubs for remote objects not checked out to site in the
briefcase file).

• Supports configured export by revision rule and variant rule.

• Provides briefcase package preview and compare in Teamcenter rich client.

• Supports export of CAD incomplete assemblies.

For briefcase packages containing NX data, when a supplier owns the object locally or the object is
checked out to the supplier site, infer delete is allowed for occurrences in any type of export. This
includes exports with incomplete, variant, or partial CAD data. For briefcase packages with CATIA data,
infer delete of occurrences is not allowed for exports with incomplete, variant, or partial CAD data.

Exports to unmanaged sites do not create an export record (IXR) in the database. For performance
reasons, the briefcase accountability table is used instead for unmanaged exports. Therefore, the object
is displayed in Teamcenter with no value in the Exported To column in the rich client.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-1

© 2020 Siemens
 3. Exchanging data with suppliers

You must set the include_all_objects option in the [Link] file to true if you are adding
objects to a CAD part in the CAD application. Otherwise, the new objects are not shown when you
import the briefcase file into Teamcenter.

Unmanaged sites exchanging NX data must supply English characters for the item ID, revision, and
name attribute values. Other locales are not supported in this use case.

If your site is a managed Teamcenter site, you must perform the migration procedure before using
Briefcase Browser at your site.

Caution:
Briefcase Browser does not support the Item:sci0IsIMDSObject property added by the
International Materials Data System (IMDS) template. Therefore, if you are exchanging data with
an unmanaged site, you cannot have this template installed in Teamcenter or you must manually
remove the property occurrences from the briefcase file.

Note:
Briefcase Browser cannot operate on NX alternate representations (UGALTREP objects). Therefore,
for performance reasons this clause is not included in the unmanaged transfer option set. If you
want this data to display in Briefcase Browser, add the follow clause to the
TIEUnmanagedExportforNX transfer option set:

[Link]:[Link]:RELATIONP2S.IMAN_UG_altrep:Process+traverse:
$opt_nx_altrep=="true"

Note:
By default, when you import a briefcase file created from an NX assembly or part, Teamcenter
does not parse the clone output log file (ug_clone_import_console_output.log for the ug_clone
utility or tcin_import_import_console_output.clone for the tcin_import utility). If you require
parsing of the clone output log file for debugging, you must set the BC_NX_DEBUG environment
variable value to TRUE at the importing site. However, do this only if absolutely necessary as this
may cause an error to occur during the import.

Configure briefcase for site checkin and checkout

To use briefcase with the Tools→Check In/Out→Check Out To Site command in a non-SSO
configuration, the following access privileges must be given to the Teamcenter user specified in the
Teamcenter Integration Framework configuration.

Note:
To export an assembly that is either:

3-2 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Configure briefcase for site checkin and checkout

• Cloned from a replica or an assembly that is checked out to a remote site

• Created using the Save As command on a replica or an assembly that is checked out to a
remote site

You must set the opt_based_on option to FALSE in the transfer option set or clear the Include
IMAN_based_on checkbox in the Export to Briefcase dialog box.

Symbol Privilege

Read

Write

Export

Import

Transfer out

Transfer in

If these access privileges are not set, the transfer back to Teamcenter fails because the Teamcenter user
does not have the required object access privilege.

You must create and set the GMS_tcxml_string_separator preference at the exporting site location to
allow a Teamcenter 2007 version prior to MP4 to import a briefcase package file from the site.

1. Log on to Teamcenter as a user with administrator privileges.

2. Choose Edit→Options and click Filter.

3. Click the Create a new preference definition button ( ) and type GMS_tcxml_string_separator
in the Name box.

4. Select GMS [Link] from the Category list and Site from the Protection Scope list.

5. (Optional) Type MP2 Briefcase string separator in the Description box.

6. Type a comma (,) and a space in the Values box.

7. Click Save.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-3

© 2020 Siemens
 3. Exchanging data with suppliers

Site checkin after import

The GMS_site_checkin_after_import preference controls whether or not a briefcase file that contains
objects checked out to a site are automatically checked in when it is imported. If set to true, the objects
are checked in on import.

Object-based site checkout

To enable object-based site checkout of objects in export briefcase files, you create the
Object_based_site_check_out logical preference and set its value to true.

When object-based site checkout is enabled, if you select an item revision as the root object, the
selected revision, its helper objects, and the related item and its helper objects are candidates for site
checkout. If an item is selected for site checkout, based on the revision rule selected, the corresponding
item revision and its helper objects are candidates for site checkout.

By default, Teamcenter uses the TIEUnconfiguredExportDefault option set for traversal. You can use a
different option set by creating the option_set_for_site_check_out preference and setting its value to
the desired option set.

This also applies to Cancel check out and Site check in.

Configure Teamcenter for Briefcase Browser

A briefcase file that is exported to an unmanaged site is a configured export that uses the
TIEConfiguredExportDefault transfer option set.

By default, Teamcenter uses Global Services to export a briefcase file. If you do not have Global Services
installed, you can export the briefcase file without using Global Services functionality by setting the
GMS_offline_use_TcGS preference value to false.

The unmanaged site must be defined for each unmanaged site in the Organization application. The site
must be defined with the Is Unmanaged, Is Offline, and Uses TCXML Payload options selected.

1. In your Teamcenter command shell, import the required transfer modes as follows:

tcxml_import -u=infodba -p=xxx -file=%TC_DATA%\[Link]

-scope_rules -scope_rules_mode=overwrite

tcxml_import -u=infodba -p=xxx

-file=%TC_DATA%\[Link]
-scope_rules -scope_rules_mode=overwrite

2. Log on to Teamcenter as a user with dba privileges and open the Organization application.

3. Define a site for the unmanaged site. Select the Uses TCXML Payload, Is Offline, and Is
Unmanaged options.

3-4 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Configure Teamcenter for Briefcase Browser

4. Ensure the following preference values are set at the site location:

TC_gms_export_default_transfermode=TIEExportDefaultTM

TC_gms_import_default_transfermode= TIEImportDefault

TC_show_checkedout_icon = TRUE

The following preferences are optional. Set these values as required.

BRIEFCASE_export_CAD_incomplete = FALSE
You can set this to TRUE if you want to allow incomplete CAD exports. Siemens Digital
Industries Software recommends the following settings:

• Protection Scope
User

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-5

© 2020 Siemens
 3. Exchanging data with suppliers

• Category
General

• Environment
Disabled

• Multiple
Single

• Value
FALSE

BRIEFCASE_import_validation_rule_item = item_id/rev_id
item_id/rev_id indicates the item that contains the dataset validation rules. For example, set
the value to 000123/B for the dataset attached to item (item_id) 000123 revision (rev_id) B
as the validation rule dataset.
Siemens Digital Industries Software recommends the following settings:

• Protection Scope
User

• Category
General

• Environment
Disabled

• Multiple
Single

Configure Teamcenter for briefcase mail notification

You can configure Teamcenter to create an envelope object containing your briefcase package in the
mailbox folder automatically when you create a briefcase package.

1. Log on to Teamcenter as a user with administrator privileges.

2. Choose Edit→Options and click Filter.

3. Click the Create a new preference definition button ( ) and type Briefcase_tcmail_notification
in the Name box.

3-6 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Briefcase Browser site configuration files

4. Select GMS [Link] from the Category list and Site from the Protection Scope list.

5. Type Controls creation of automatic envelope for briefcase package the mailbox folder in the
Description box.

6. Type TRUE in the Values box.

7. Click Save.

To turn this feature off, set the preference value to FALSE or delete the preference.

Briefcase Browser site configuration files

Briefcase Browser reads the XML configuration files in the bbworkspace\configuration directory. Each
configuration has a separate directory that contains the [Link] file as a minimum.

The create_briefcase_browser_config_package utility creates a compressed package file of the

configuration files that you can provide to your suppliers. The utility takes the path to the Briefcase
Browser installation ZIP file (-bbDir argument) and generates a managed (OEM) site ZIP file containing
the OEM configuration package.

create_briefcase_browser_config_package -u=username -p=passwd -g=dba

-bbDir=C:\apps\bb

The package name is the OEM site name. It contains the [Link] file with the OEM site ID
set as the target site ID. It also contains the [Link] schema file, generated from the OEM and the
OEM configuration file.

[Link]
Defines the unmanaged site ID. This value can be any numeric sequence not starting with a zero
and is not required to meet Teamcenter site ID requirements. If this file is not present, Briefcase
Browser does not allow you to create a briefcase file. You can create or modify this file manually or
use the Preference dialog box in Briefcase Browser.

It should also contain the following additional configuration files:

[Link]
Defines the schema that Briefcase Browser uses to load, display, and create briefcase files. It must
have this name. This file is normally supplied by the managed (OEM) site to the supplier
(unmanaged) site. It is available in the TC_DATA directory of the Teamcenter installation.

If a [Link] file does not exist in the configuration directory for your site, Briefcase Browser uses
the standard Teamcenter schema. [Link] is required in this directory for comparing and
previewing briefcase files.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-7

© 2020 Siemens
 3. Exchanging data with suppliers

Note:
The uniform resources identifiers (URIs) that appear in the headers of PLM XML and TC XML
files serve as namespace names, are unique identifiers for an XML vocabulary. Although they
are URIs, they are not used to identify and retrieve web addresses.

[Link]

Defines information about the Teamcenter (OEM) site that you exchange briefcase files with. This
information includes:

• The site name.

• The site ID.

• The Teamcenter version.

• If your site must use the auto_baseline (baseline) feature when exchanging updated briefcase
data.

• If the site allows precise or imprecise structures.

• If your site must create all replica objects as stubs (include_all_objects=false). When writing
reference objects as stubs, Briefcase Browser does not package any corresponding CAD data in
the briefcase package. If this value is set to true, Briefcase Browser writes all objects as full objects
in the briefcase file reference replica parts.

• If your site must include full objects for all checked-out parts and locally owned parts
(include_modified_objects_only=false). If this value is set to true, Briefcase Browser writes local
parts as full objects and parts checked out to your site as full objects if they are modified since the
file was last saved, including their parent and grandparent objects. If objects checked out to your
site have not been modified, they are written as stub objects and the corresponding part files are
not included in the briefcase package.

• The separator character the site requires between the item ID and revision.

• Custom type mapping to OEM objects.

• Release status values the managed (OEM) site allows you to assign to parts or assemblies you
create in the release_status_name elements. Briefcase Browser displays the values that you
supply in release_status_name elements in the Release Status Name list in the Preferences
dialog box. The value you select in the Preference dialog box is assigned as the release status of
any new CAD parts or assemblies you create. The value must match one of the valid values for
Teamcenter release status at the OEM site.

3-8 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Briefcase Browser site configuration files

• Custom forms related to item revisions to process when exchanging data, such as business object
forms with mass-related properties. When ir_to_form is set to true, the listed forms are
processed. If ir_to_form is set to false, the forms are ignored. See the ir_to_form section in the
following sample for examples.

Following is sample content for this file:

<?xml version="1.0" encoding="UTF-8"?>

<custom_mappings xmlns:xsi="[Link]
xsi:noNamespaceSchemaLocation="../bce-core/[Link]">
<oem name="your_oem_name" site_id="87654321" tc_version="Target-TC-Version"
auto_baseline="false" generate_validation_xml="false" is_precise="true"
separator="/" object_name_separator="/" bomview_type_name="view"
include_modified_objects_only="false" include_all_objects="false"
extract_to_sub_directory="false" process_reference_briefcases="true">
<release_status_name>Snapshot</release_status_name>
<release_status_name>TCM Released</release_status_name>
<release_status_name>R2InWork</release_status_name>
</oem>

<ir_to_form enabled="false">
<form_type>custom_form_type</form_type>
<relation>custom_relation</relation>
</ir_to_form>

<item_type_mapping custom_type="Item">
<multi_field_key>
<attribute>item_id</attribute>
</multi_field_key>
<helper_object_map custom_type="ItemRevision"
ootb_type="ItemRevision"/>
<helper_object_map custom_type="Item--Master"
ootb_type="Item--Master"/>
<helper_object_map custom_type="ItemRevision--Master"
ootb_type="ItemRevision--Master"/>
</item_type_mapping>

<item_type_mapping custom_type="CAD">
<multi_field_key>
<attribute>item_id</attribute>
</multi_field_key>
<helper_object_map custom_type="CAD--Revision"
ootb_type="ItemRevision"/>
<helper_object_map custom_type="CAD--Master"
ootb_type="Item--Master"/>
<helper_object_map custom_type="CAD--Revision--Master"
ootb_type="ItemRevision--Master"/>
</item_type_mapping>

<item_type_mapping custom_type="B4Item">
<multi_field_key>
<attribute>item_id</attribute>
</multi_field_key>
<helper_object_map custom_type="B4ItemRevision"
ootb_type="ItemRevision"/>
<helper_object_map custom_type="B4ItemMaster"
ootb_type="Item--Master"/>
<helper_object_map custom_type="B4ItemRevisionMaster"

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-9

© 2020 Siemens
 3. Exchanging data with suppliers

ootb_type="ItemRevision--Master"/>
/item_type_mapping>

<item_type_mapping custom_type="CommercialPart">
<multi_field_key>
<attribute>item_id</attribute>
</multi_field_key>
<helper_object_map custom_type="CommercialPart--Revision"
ootb_type="ItemRevision"/>
<helper_object_map custom_type="CommercialPart--Master"
ootb_type="Item--Master"/>
<helper_object_map custom_type="CommercialPart--Revision--Master"
ootb_type="ItemRevision--Master"/>
</item_type_mapping>

<item_type_mapping custom_type="Design">
<multi_field_key>
<attribute>item_id</attribute>
</multi_field_key>
<helper_object_map custom_type="Design--Revision"
ootb_type="ItemRevision"/>
<helper_object_map custom_type="Design--Master"
ootb_type="Item--Master"/>
<helper_object_map custom_type="Design--Revision--Master"
ootb_type="ItemRevision--Master"/>
</item_type_mapping>

<item_type_mapping custom_type="Part">
<multi_field_key>
<attribute>item_id</attribute>
</multi_field_key>
<helper_object_map custom_type="Part--Revision"
ootb_type="ItemRevision"/>
<helper_object_map custom_type="Part--Master"
ootb_type="Item--Master"/>
<helper_object_map custom_type="Part--Revision--Master"
ootb_type="ItemRevision--Master"/>
</item_type_mapping>
</custom_mappings>

The auto_baseline attribute indicates the whether or not your Briefcase Browser provides
autobaseline functionality. If this is set to true, the baseline feature is enabled. The template file has
this value set to true. If it is set to false, Briefcase Browser does not automatically revision objects. If
the attribute is not defined in this file, Briefcase Browser performs automatic revisions as if the
attribute was set to true.

If the briefcase file you are exchanging must contain precise assembly structures, you set the
is_precise attribute to true. Set this value to false when imprecise assembly structures are allowed.

If you intend to add objects to CAD parts in the CAD application, you must set the
include_all_objects attribute to true to include them when you save the briefcase file for exporting
back to Teamcenter.

3-10 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Briefcase Browser site configuration files

You can have any number of release status elements. These become the selection list for Release
Status in your Briefcase Browser preferences dialog box.

You map custom CAD parts types to OEM types by assigning a custom Item type to the items in the
TC XML data created for your CAD part. You define the subtype of the Item type as a helper object,
for example:

<helper_object_map custom_type="CADPart" ootb_type="Item"/>

This causes the TC XML data generated for custom CADPart supplier owned parts to be created as
Item objects at the OEM site.

Note:
The custom item type must be defined in the schema ([Link]) file used by Briefcase
Browser.

You can have multiple custom types defined in this file. Briefcase Browser locates the matching
custom in the file and maps the file to the defined OEM object. If a custom type part is not found in
the [Link] file, the first custom type defined in used. If there are no custom types
defined, Briefcase Browser maps the part to the standard Teamcenter.
[Link]
This XML file contains valid dataset extensions and relation types supported for Non-CAD files. Each
dataset extension specifies whether it is a master, dataset name, ref_names, and relation to be
used while generating TC XML. Each relation type specifies the display relation for the Add Dataset
dialog box and the actual relation to be used for generating TC XML. If this file is not found, an OOTB
file is used. You can add additional non-CAD types to this file.

Caution:
If your system has CAD dataset types other than the master dataset, and the dataset type
follows the model file naming convention, you must add an entry representing the dataset.
Add the entry with the is_master attribute set to False, for example:

<cad_data_set_mapping is_master="False" dataset_type="UGPART"

ref_names="UGPART" relation=""/>

This prevents an error from occurring when you open or synchronize an updated CAD
assembly in Briefcase Browser.

<?xml version="1.0" encoding="utf-8"?>

<!-- XML file containing valid dataset extensions and relation types supported for
Non-CAD files.
Each dataset extension specifies if it is a master, dataset name, ref_names and
relation to be
used while generating TCXML. Each relation type specifies the display relation for
the Add Dataset
dialog and the actual relation to be used for generating

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-11

© 2020 Siemens
 3. Exchanging data with suppliers

TCXML. -->
<custom_data_set_mapping xmlns:xs="[Link]
xmlns:xsi="[Link]

<data_set_mapping extension="prt">
<cad_data_set_mapping is_master="True" dataset_type="UGMASTER" ref_names="UGPART"
relation=""/>
<cad_data_set_mapping dataset_type="UGPART" ref_names="UGPART" relation=""/>

</data_set_mapping>
<data_set_mapping extension="doc">
<cad_data_set_mapping dataset_type="MSWord" ref_names="word"
relation="IMAN_reference"/>
</data_set_mapping>
<data_set_mapping extension="docx">
<cad_data_set_mapping dataset_type="MSWord" ref_names="word"
relation=""/>
</data_set_mapping>
<data_set_mapping extension="xls">
<cad_data_set_mapping dataset_type="MSExcel" ref_names="excel"
relation=""/>
</data_set_mapping>
<data_set_mapping extension="jpg">
<cad_data_set_mapping dataset_type="JPEG" ref_names="JPEG_Reference"
relation=""/>
</data_set_mapping>
<data_set_mapping extension="jt">
<cad_data_set_mapping dataset_type="DirectModel" ref_names="JTPART"
relation="IMAN_Rendering"/>
</data_set_mapping>
<relation_type actual_relation="IMAN_specification"
display_relation="specification"/>
<relation_type actual_relation="IMAN_Rendering"
display_relation="rendering"/>
<relation_type actual_relation="IMAN_manifestation"
display_relation="manifestation"/>
<relation_type actual_relation="IMAN_reference"
display_relation="reference"/>
</custom_data_set_mapping>

cad_to_tc_attribute_map.xml
Defines the mapping of user-defined NX attributes to qualified Teamcenter object attributes. The
user-defined attributes must be part of the configured TC XML schema ([Link] file). This allows
you to define attributes for qualified objects in addition to the required attributes, for example:

Caution:
You can map only one CAD part attribute to one Teamcenter attribute (1-to-1 map). Mapping
a CAD part attribute to multiple Teamcenter attributes or a single attribute to multiple item
types can cause corrupt or lost data.

<?xml version="1.0" encoding="UTF-8"?>

<!-- Only one CAD2TC_attribute_mappings that can contain more than one
attribute map. These mappings will hold a list of CAD attributes
that map to teamcenter attribute -->

3-12 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Briefcase Browser site configuration files

<CAD2TC_attribute_mappings xmlns:xsi="[Link]
xsi:noNamespaceSchemaLocation="cad_to_tc_attribute_map.xsd">

<!-- cad_part_attr should be unique for each attribute_mapping -->

<attribute_mapping cad_part_attr="PART_MATERIAL" tc_attr="nisPartMaterial"
tc_type="CAD--Revision--Master"/>
<attribute_mapping cad_part_attr="PART_THICKNESS" tc_attr="nisPartThickness"
tc_type="CAD--Revision--Master"/>
<attribute_mapping cad_part_attr="CALC_WEIGHT" tc_attr="nisCalculationWeight"
tc_type="CAD--Revision--Master"/>
<attribute_mapping cad_part_attr="CALCULATIVE_COEFFICIENT"
tc_attr="nisCalculativeCoefficient"
tc_type="CAD--Revision--Master"/>
<attribute_mapping cad_part_attr="Z_CENTROID" tc_attr="nisGravityZ"
tc_type="ItemRevision--Master"/>
<attribute_mapping cad_part_attr="Y_CENTROID" tc_attr="nisGravityY"
tc_type="CAD--Revision--Master"/>
<attribute_mapping cad_part_attr="X_CENTROID" tc_attr="nisGravityX"
tc_type="CAD--Revision--Master"/>
</CAD2TC_attribute_mappings>

[Link]
Defines the attributes that are displayed in Briefcase Browser properties views. By default, Briefcase
Browser displays all qualified attributes. If this file is present, Briefcase Browser limits the attributes
in the properties views to the attributes defined in this file. The following is sample content for this
file:

<visible_attributes>

<group name="Item">
<attribute ootb_type="Item" name="item_id"/>
<attribute ootb_type="ItemRevision" name="object_name"/>
<attribute ootb_type="ItemRevision"
name="object_description"/>
</group>

<group name="Admin">
<attribute ootb_type="POM_imc" name="POM_imc"/>
<attribute ootb_type="Group" name="Group"/>
<attribute ootb_type="User" name="User"/>
</group>

</visible_attributes>
attributes_text_locale.xml
Defines the localized values for the language indicated by the name of the directory containing the
file. The directory name consists of a two-character locale and two-character country code such as
en_US. The language directories must be in the lang directory in the site’s configuration directory.

For example, the following shows the US English (en_US) and the Japanese localization (ja_JP)
directories:

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-13

© 2020 Siemens
 3. Exchanging data with suppliers

configurations
default
dashboard_supplier
lang
en_US
ja_JP

Briefcase Browser reads the TC XML file content and displays the object property names as defined
in the file. The properties are database field names that may not be readable by your users. You can
use this file to map the database field names to usable localized names.

Note:
Your attributes_text_locale.xml files must be UTF-8 encoded. They must also contain the
following element as the root XML element in the file:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

If the property names do not display in your locale language, use a different text editor for
UTF-8 encoding.

The following is sample content for this file in the Japanese locale:

3-14 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Briefcase Browser site configuration files

Sample files are provided for each of these configuration files in the example\bbworkspace
\configurations\example directory.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-15

© 2020 Siemens
 3. Exchanging data with suppliers

Compare and preview large briefcase files

When using the Rich Client to preview or compare large briefcase files (containing 100,000 or more
objects), you may need to increase the amount of memory allocated for the Rich Client as follows:

1. Close any running instances of the Rich Client.

2. In an ASCII editor, open the file TC_ROOT\portal\[Link].

3. Change the following line from

set VM_XMX=1024m

to

set VM_XMX=2048m

4. Restart the Rich Client.

When previewing or comparing briefcase files containing significantly more than 100,000 objects, you
may need to increase the value of VM_XMX higher than 2048m.

Configure Briefcase Viewer

Perform the following steps before using the Briefcase Viewer for the first time or when you need to
change the configuration for the package content.

1. Choose Window→Preferences to display the Preferences dialog box. Ensure Briefcase Viewer is
selected. (When later updating the Briefcase Viewer configuration, you can also click Comparison
Preferences in the Briefcase Preview pane to open the Preferences dialog box.)

3-16 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Customize Briefcase Viewer icons

2. Click Explorer in the Preferences dialog box. Note the location of the default configuration folder.
This is the location that contains the configuration files required by the Briefcase Viewer.

3. Browse to the site configuration files directory (TC XML schema file, [Link] file,
and so forth).

4. Copy the configuration files to the default directory location.

Customize Briefcase Viewer icons

You can customize the icons used to represent different object types in the Briefcase Preview pane.
Custom icons are mapped to objects with various ownership types in the [Link] file.
Using customized icons has the following requirements:

• Icons must be 16x16 pixel bitmap images or SVG images. Most bitmap formats are supported,
including .gif, .png, and .jpg.

• Icon images must be stored in an \icons directory in your Briefcase Viewer configuration folder.

• Create a [Link] ASCII file defining custom icon mappings and store the file in your
Briefcase Viewer configuration directory.

Mapping custom icons

Custom icons appear in place of the default icons. Create an ASCII [Link] file to specify
which custom icons override which specific default icons. Save this file in your Briefcase Viewer
configuration folder.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-17

© 2020 Siemens
 3. Exchanging data with suppliers

Each line in the file defines how a particular image file overrides one or more default icons. If custom-
[Link] contains more than one line, icon mappings are applied most-specific context to least-
specific context.

Each line in [Link] has the following form:

ownership,object_type,file_name

Valid values are as follows:

ownership
The ownership of the related object type. The custom icon will be used as follows:

all All owners.

local The object is owned locally.
stub Stub objects.
replica Objects that are replicas.
checked out Objects that are checked out.
ownership Objects that are marked as ownership transfer to another site.
transfer

object_type
The Teamcenter object type. Specific values are defined in your data model using BMIDE. A value of
all specifies the custom icon will be used for all object types.
file_name
The name of the image to use as the icon. The image must be stored in an \icons directory in your
Briefcase Viewer configuration folder.

Lines starting with a # symbol are considered comments and ignored.

Save the updated [Link] file and reload a briefcase file in the Briefcase Preview pane to
display the custom icons.

Examples

Examples of overriding default icons with custom icons:

• Assign the icon stub_generic.png to all stub objects.

stub, all, stub_generic.png

3-18 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Configure 4th Generation Design data exchange

• Assign the icons stub_docrev.png to document revision stubs, stub_itemrev.png to item revision
stubs, and stub_generic.png to all other stub objects.

stub,all,stub_generic.png
stub,documentrevision,stub_docrev.png
stub,itemrevision,stub_itemrev.png

• Assign the icons stub_docrev.png to document revision stubs, replica_docrev.png to document

revision replicas and [Link] to all other document revision object types.

stub,documentrevision,stub_docrev.png
replica,documentrevision,replica_docrev.png
all,documentationrevision,[Link]

Configure 4th Generation Design data exchange

4th Generation Design (4GD) data can be exported and imported from Data Exchange only through TC
XML briefcase files. Therefore, you must set the GMS_offline_use_TcGS preference to FALSE.

1. In the rich client, choose Edit→Options.

2. In the Options dialog box, click Filters and type GMS_offline_use_TcGS in the Filters box.

3. Click Edit, type false in the Value box, and click Save.

4. If you want to change the default value (Latest Working) for the revision rule used to configure a
partition:

a. Type TC_config_rule_name in the Filter box.

b. Click Edit, type the revision rule name in the Value box, and click Save.

Note:
The exporting user can override the default revision rule value by selecting the desired
rule name from the Revision Rule list.

Migrate a supplier site from a managed to unmanaged site

You can change a supplier site that has previously been defined as a managed site in Teamcenter to an
unmanaged site without causing any data errors for previously transferred data. This procedure
designates the site migrating to an unmanaged site as the supplier site and the OEM site as a managed
site.

1. At the supplier site, identify all assemblies that were sent to the OEM site.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-19

© 2020 Siemens
 3. Exchanging data with suppliers

2. Ensure that any shared data is not checked out to a remote site.

3. Create new revisions for all shared items:

a. Turn off the smart baseline feature by changing the value of the ITEM_smart_baseline
preference to 0.

b. At the supplier site, create a baseline of the supplier data that has been sent to the OEM site.

All new revisions occur in the migrated unmanaged site. Shared objects have multiple revisions,
and OEM replica parts are not baselined.

4. If the supplier site is a hub site, in the Organization application, clear the Is a Hub check box for the
supplier site.

5. At the supplier site, export all supplier owned objects to a briefcase file.

a. Choose Tools→Export→To Briefcase.

b. Select the unmanaged site and click the Display/Set remote export options button .

c. In the TIEConfiguredExportDefault dialog box, select the Replica Bypass check box.

3-20 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Migrate a supplier site from a managed to unmanaged site

Note:
You may have to scroll down to access the check box.

6. Export all baseline assemblies for migration. This includes:

• New baseline assemblies that were previously sent.

• Supplier-owned data.

• OEM replica data that must be preserved.

7. Install Briefcase Browser at the supplier site being migrated using the same site ID as the managed
site for the unmanaged site.

8. In Briefcase Browser, extract all briefcase files in the migration working directory.

9. Confirm the briefcase files extracted meet the OEM requirements.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-21

© 2020 Siemens
 3. Exchanging data with suppliers

Notify the Teamcenter administrator at the OEM site that the briefcase file output is as expected.

10. In the Organization application at the OEM site, modify the previously managed supplier site by
selecting the Unmanaged option for the site.

11. At the unmanaged supplier site, use Briefcase Browser to add parts to new assemblies. You can
copy the required .prt files to a new working directory and create briefcase files based on them.

12. Transfer briefcase files to the OEM and import them into Teamcenter using Tools→Import→From
Briefcase.

Marking objects for ownership transfer

Before using Briefcase to export objects, you can specify (mark) which particular objects are to be
exported with their ownership transferred to the target site. Marking objects for ownership transfer
before the export improves data exports by letting you:

• Precisely identify which objects will have their ownership transferred

• Verify that the ownership of the objects can be transferred

• Lock those items against ownership transfer from a different session or by a different user in this
same session

When you mark an object for ownership transfer, ownership of its entire island of objects is transferred
upon export. That is, the principal object and the additional objects on which it depends for its correct
functional definition and usage within Teamcenter, including item revisions, are owned by the target
site upon export. If you mark an item revision for ownership transfer, the full item is marked for
ownership transfer.

Ownership is transferred after the successful export of all revisions of the object, including revisions not
explicitly included in the export. You can mark objects of the following types for ownership transfer.

Foundation
• Item

• Item Revision

• BOMLine
4GD
• Design element

• Workset

3-22 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Marking objects for ownership transfer

To mark objects for ownership transfer, you must be granted the Transfer out privilege. See Access
privileges.

When marking objects for ownership transfer, be aware of the following limitations:

• Objects of the type Mfg0BvrDynamicIPA and Bom0PBELine cannot be marked for ownership
transfer.

• Objects with any of the following statues cannot be marked for ownership transfer:

• Remote Object

• Checked Out

• Objects in workflow

• Avoid marking objects for ownership transfer when performing partial delta exports unless you are
sure the full object will be exported. Objects will not have their ownership transferred if there is no
change to an object.

Mark objects for ownership transfer

1. Locate the object to mark for ownership transfer. You can mark only local objects not already
marked for ownership transfer.

2. Choose Window > Choose View > Other > Teamcenter > Briefcase Ownership Transfer and click
Open to display the Briefcase Ownership Transfer view. Drag the object (or objects) to this view.

Alternatively, select one or more objects, right-click, and choose Briefcase > Mark for Ownership
Transfer.

The Ownership transfer to site dialog box is displayed.

3. On the Ownership transfer to site dialog box, select the target site to which you want to transfer
object ownership. Only offline sites are available when marking objects for ownership transfer.

The object is added to the Briefcase Ownership Transfer view, which lists all the objects marked
for ownership transfer by you, the current user.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-23

© 2020 Siemens
 3. Exchanging data with suppliers

4. Once you have marked the objects for ownership transfer, export the objects. Object ownership is
transferred when briefcase export completes successfully. Exported objects are removed from the
Briefcase Ownership Transfer view.

Objects that were not part of the export, but were marked for ownership transfer remain listed in
the Briefcase Ownership Transfer view.

When an object is marked for ownership transfer, users cannot check out the object or mark it for
ownership transfer. The object remains locked (including across sessions) until the object is exported or
is removed from the Briefcase Ownership Transfer view by clicking Remove selected object from
view .

Recover briefcase ownership

You can recover ownership of briefcase objects from other sites when that ownership has inadvertently
been transferred or is no longer valid. Recover transferred ownership by running the
briefcase_ownership_recovery utility. Ownership can be recovered only in cases where ownership was
previously transferred using a release of Teamcenter that includes the briefcase_ownership_recovery
utility.

The briefcase_ownership_recovery utility reverts the ownership of the objects associated with a
briefcase to the original (exporting) site. The objects are reverted to replicas on the remote (importing)
site.

Caution:
To ensure data integrity, run this utility at both the exporting site and the importing site.

You can review the objects for which ownership can be changed with the utility's -report option before
actually implementing the ownership changes.

Preview Briefcase Browser packages in the rich client

View the contents of a briefcase file using the Briefcase Preview pane. You can view briefcase packages
containing JT files and related documentation and CAD files and related documentation depending on
the configuration you have selected for the Briefcase Preview pane.

Previewing a briefcase in the rich client is supported only on Windows and Linux. Ensure that the
Briefcase Viewer has been properly configured and the related configuration files have been copied to
the site configuration files directory as described in Configure Briefcase Viewer.

Open and preview a briefcase package

In My Teamcenter, right-click a briefcase package (bcz file) and choose Briefcase→Open. The briefcase
file opens in the Briefcase Preview pane. The contents of this package are listed as the Existing objects.

3-24 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Compare Briefcase Browser packages in the rich client

Expand and collapse the briefcase hierarchy to review the objects in the package.

Change the columns displayed by right-clicking on a column heading, choosing Configure Columns,
and choosing which columns to display and their order.

Compare Briefcase Browser packages in the rich client

You can compare briefcase packages to review differences. Understanding the differences can influence
your decision on whether to import the changes. You can compare a briefcase package to the objects
currently in Teamcenter or to the objects in another briefcase package.

Ensure that the Briefcase Viewer has been properly configured and the related configuration files have
been copied to the site configuration files directory as described in Configure Briefcase Viewer.

Compare briefcase packages

1. Open a briefcase package in the Briefcase Preview pane. The contents are listed as Existing
objects.

2. Choose a briefcase package to compare with the existing briefcase package:

• To compare the existing briefcase package with a second package, click Compare. Navigate to
and open the second package.
Alternately, in My Teamcenter, select both packages, right-click, and choose
Briefcase→Compare.

• To compare the existing briefcase package with the objects currently in Teamcenter, click
Compare with Latest.
Alternately, in My Teamcenter, right-click the first briefcase package and choose
Briefcase→Compare with Latest.

These objects are listed as Proposed objects.

3. Click Comparison to view the object differences, identified with color coding. By default:

• Red identifies objects not in the newer briefcase.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-25

© 2020 Siemens
 3. Exchanging data with suppliers

• Green identifies objects not included in the older briefcase or stored in Teamcenter.

• Blue identifies objects that are changed.

If no differences exist, the top level of the briefcase displays no child items.

4. Optionally filter the displayed comparison results when comparing long lists of objects. Click in
the Briefcase Preview pane and select one of the following filter options:

No Filter
All objects in the briefcase structures are displayed. This is the default and initial setting for every
comparison.
Show Changed Objects
Only those objects that are changed (and any parents) are displayed.
Show Added Objects
Only objects that are added (and any parents) are displayed.
Show Deleted Objects
Only objects that have been deleted (and any parents) are displayed.
Show Changed, Added and Deleted Objects
Only objects that are changed, added, and deleted (and any parents) are displayed.

Click Cancel to end the comparison.

CAD design exchange business process

Exchanging data with suppliers that do not use Teamcenter as their data management system can be
effectively handled using the Briefcase Browser application and an unmanaged site configuration in
Teamcenter.

Configure 4th Generation Design data exchange

4th Generation Design (4GD) data can be exported and imported from Data Exchange only through TC
XML briefcase files. Therefore, you must set the GMS_offline_use_TcGS preference to FALSE.

1. In the rich client, choose Edit→Options.

2. In the Options dialog box, click Filters and type GMS_offline_use_TcGS in the Filters box.

3. Click Edit, type false in the Value box, and click Save.

3-26 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Configuration required for unmanaged site transfers

4. If you want to change the default value (Latest Working) for the revision rule used to configure a
partition:

a. Type TC_config_rule_name in the Filter box.

b. Click Edit, type the revision rule name in the Value box, and click Save.

Note:
The exporting user can override the default revision rule value by selecting the desired
rule name from the Revision Rule list.

Unmanaged site briefcase transfers

Configuration required for unmanaged site transfers

You can import and export configured briefcase files to and from unmanaged sites in the My
Teamcenter and Structure Manager rich client applications. You must have set up Teamcenter with
Unmanaged sites and use Briefcase Browser at those sites to create and modify briefcase files.

Export a briefcase file to an unmanaged site

1. Log on to Teamcenter and open the My Teamcenter or Structure Manager application. Locate and
expand the top level of the assembly structure that you want to export.

2. For each object that the unmanaged site must update that they do not locally own, select the
object and choose Tools→Site Check-In/Out Check-out To Site.

Tip:
Because the types of non-CAD datasets you may want to export are various, for performance
reasons, unmanaged site exports do not have support for any specific non-CAD datasets out-
of-the-box. If you need to include non-CAD datasets in the export, you must add a clause to
the transfer options set you are supporting to allow the export of datasets required.
For example, to add support for Microsoft Word (MSWORD) datasets to your export, include
the following clause in the closure rules for the transfer option set:

ItemRevision:MSWORD:Iman_reference.*

Teamcenter displays the Check-out To Site dialog box.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-27

© 2020 Siemens
 3. Exchanging data with suppliers

3. Select the unmanaged site from the Target Site list.

4. (Optional) Type an identifier in the Change ID box and a comment in the Comments box.

5. Select the select the item revision associated with the top level of the assembly structure that you
want to export and choose Tools→Export→To Briefcase.

Teamcenter displays the Export to Briefcase dialog box.

6. (Optional) Type a reason statement in the Reason box.

3-28 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Export a briefcase file to an unmanaged site

7. Click the site button and select the target site.

8. Select the option set you want to use for this transfer from the Option Set list. Select the standard
option (TIEConfiguredExportDefault) for configured exports or one of the other available option
sets. For transfers containing NX data, select TIEUnmanageExportForNX.

9. Type or navigate to the desired directory in the Export Directory box. This is the location where
you can access the generated briefcase file for transfer to the unmanaged site.

10. Select the desired revision from the Revision Rule list.

11. Click the Display/Set export options button .

Teamcenter displays the option-set-name dialog box.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-29

© 2020 Siemens
 3. Exchanging data with suppliers

Note:
Unmanaged sites do not have the ability to manage dataset versions, this means the latest
version, and only the latest version, is required. Therefore, the Dataset version 0 only
option is selected by default and is read-only.
If you select the Include modified objects only session option, unchanged objects are
exported as stubs, unless a new or changed dependent object appears under the selected
root object. The export process recognizes a change to the lsd attribute of the item causing a
full export of all revisions.

Note:
If you are transferring an assembly with at least one part marked for ownership transfer to
the importing site (not the entire assembly), you should transfer the parts that have
ownership transferred in a separate briefcase file. Otherwise, you must create closure rules
to prevent transfer of ownership of other parts in the assembly to the importing site.

12. Click OK and click Yes to begin the export.

Teamcenter displays the Export Completed dialog box if the export is successful.

Import validation results

Use the validation rule editor to create a rule set used to create a validation results (VRX) file.

1. From your Teamcenter command shell, run the [Link] file:

%UGII_BASE_DIR%\DESIGN_TOOLS\checkmate\tools\ruleset_editor

2. In the Validation Rule Editor, create a new rule set with the checker attribute value set to
mqc_update_all_features and the Dataset Types attribute value set to UGMASTER.

3. Save the file.

4. In Teamcenter, create a validation rule set dataset and import the rule file you created into the new
validation rule set.

5. Open options and locate the BRIEFCASE_import_validation_rule_item preference. Set its value to
the item ID/revision ID of the item you want to validate.

3-30 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Import a briefcase file from an unmanaged site

6. Import the briefcase file and verify the validation forms for the imported item revision are present.

Import a briefcase file from an unmanaged site

1. Log on to Teamcenter and open the My Teamcenter or Structure Manager application and choose
Tools→Import→From Briefcase.

Teamcenter displays the Import Briefcase dialog box.

2. Navigate to or type the path and file name of the briefcase file in the Briefcase File box. Select
TIEImportOptionSetDefault from the Option Set list.

3. Click the Display/Set export options button and select the desired options.

4. (Optional) Select the Site Check-In after import box. If you select this box, all objects that are
checked out to the unmanaged site are checked in during the import process. Otherwise, you must
check them in individually after they are imported.

5. Click Yes to begin the import.

Transferring a briefcase package

Briefcase transfer process

The process of transferring data for reference using a briefcase package requires two procedures with an
intervening manual step. The first procedure packages the data, and the packaged data is transferred to
the destination site through a manual process (such as FTP); and the second procedure imports the
packaged data at the remote site. Normally, the manufacturer (OEM) initiates the transfer by creating
the briefcase package and the supplier then imports the package. The return trip is similar in that the
supplier repackages the data and the originating site imports it.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-31

© 2020 Siemens
 3. Exchanging data with suppliers

Note:
Teamcenter 8 and later recognizes both bcz and ugs extensions as briefcase files. If you are
exporting to a Teamcenter site prior to Teamcenter 2007 MP4, the importing site recognizes only
the ugs extension as a briefcase file.

Package the data

1. In My Teamcenter, select the part to be placed in the briefcase.

2. Choose Tools→Export→To Briefcase.

3. If the desired destination site is not in the Target Sites box:

a. Click the sites button .

b. In the Remote Sites dialog box, select the desired site from the Available Sites list, or select
Any Site to create a standard package file, and click .

c. Select the sites in the Selected Sites list that you are not the desired site and click .

d. Click OK.

4. Select the desired transfer option set from the Transfer Option Set list.

5. Select the desired check boxes:

Check box Description

Start immediate Causes the transfer request to process immediately. By default, Data
transfer Exchange schedules transfer requests based on system load conditions.
Your administrator may disable this option.

Show progress When the process starts, opens the default web browser and displays the
indicator Audit - Activity Status table. The table shows the activity steps as they
are processed.

Send email Requests that Data Exchange send an email to when the transfer is
notification complete to the address associated with the requesting user.

6. If you have chosen a transfer option set configured to use low-level TC XML, you can analyze
the briefcase TC XML for issues before actually exporting the briefcase data. Doing so can minimize
export and subsequent import errors, reducing the likelihood of needing to re-export data.
For more information about validating briefcase TC XML files, see tcxml_export and
briefcase_validator.
Select one of the following additional options:

3-32 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Package the data

Dry Run
Specifies that a simulated low-level TC XML export be run and the exported TC XML be
validated. A report listing warnings and errors in the TC XML is generated and saved to the file
specified by File Name.

If Validate before mapping is checked in the Export Options dialog box, the internal TC XML
is validated instead of the exported TC XML.

In neither case is a briefcase file created.

Validate
Specifies that the exported TC XML be validated. If no warnings or errors are detected in the TC
XML, the briefcase file is created. If warnings or errors are detected in the TC XML, a report is
generated listing them and saved to the file specified by File Name. In that case, no briefcase
file is created.

If Validate before mapping is checked in the Export Options dialog box, the internal TC XML
is validated instead of the exported TC XML.
None
Specifies a briefcase file is created with no validation of the TC XML.

7. (Optional) Click to access the advanced options.

Note:
The Transfer Ownership check box is on this secondary dialog box. Therefore, this step is
not optional if you want to transfer ownership and it is not selected by default.

8. In the Export Options dialog box, select the desired check boxes:

Note:
The options available in this dialog box are dynamic and depend on the variables in the
selected transfer option set.

Item options Description

Include All Revisions Exports all revisions. When transferring site ownership, this is the only
option available.

Latest Revision Only Exports the latest revision regardless of whether it is a working or
released revision.

Latest Any Revisions Exports only the latest revision with the specified release status selected
Only from the list.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-33

© 2020 Siemens
 3. Exchanging data with suppliers

Product structure Description

options

Include Entire BOM Includes all components if the item selected is an assembly. The revision
selectors allow you choose revision to export with the selected item and
its component items, if applicable. You can choose only one revision
selector.
The TC_bom_level_export preference controls whether this option is
available.

Transfer Top-Level Transfers the selected assembly item and exports all components with no
Item Only site ownership transfer.

Dataset options Description

Include All Versions Includes all dataset versions with each dataset selected for import or
export. When this option is not set, includes only the latest version of
each dataset selected for import or export.

Include All Files Includes all underlying operating system files (such as named
references) with each dataset selected for import or export. If you do not
set this option, only the dataset metadata is imported or exported.

Save options Description

Save All Option As Saves the options you select on the dialog box as the default option
Default settings.

Restore Option Set Replaces all options settings with the defaults settings.
Defaults

Session options Description

Transfer Ownership Transfers site ownership to the target site. When this option is not
selected, your site retains ownership. If you transfer an item revision
with a sequence, its sequence manager is also transferred. The
TC_ownership_export preference controls the default value of this
option. It is recommended that you leave the default setting for this
option cleared.

Include Modified Exports unmodified objects as stubs. Only modified objects are
Objects Only transferred as full objects.

Note:
If a change is made to any dependent revision in an assembly, the
last modified date of the assembly is updated. Therefore, the

3-34 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Transfer the package file

Session options Description

assembly and all its dependent revisions are exported as full

objects.

Validate before Validates the internal TC XML instead of the exported TC XML when Dry
mapping Run or Validate are chosen. This option is only available when Option
Set specifies a transfer option set configured to use low-level TC XML.

Continue On Error Allows the remote import or export objects operation to continue if
errors are encountered while importing/exporting optional objects. All
objects are considered optional except the following:

Requirements
Specifications
Item Master
Item Revision Master

This option is disabled if the Transfer Ownership option is set.

9. Click OK.
Teamcenter sends a briefcase package file to your (export user) mailbox.

10. Select the briefcase package file and export the package to the file system.

Transfer the package file

Caution:
If you are exporting to a Teamcenter site prior to Teamcenter 2007 MP4, the importing site
recognizes only the ugs extension as a briefcase file. Teamcenter 12 generates briefcase files with
a bcz extension. Therefore, you must change the extension of the package file to ugs before
transferring it. Teamcenter 12 recognizes both bcz and ugs extensions as briefcase files.

1. In My Teamcenter, select the package file from the exporter's mailbox.

2. Choose View→Named References.

3. Select the package file and click Download.

4. Click OK to export the file to the specified directory.

Teamcenter exports a package file copy to the selected directory.

5. Click Close to exit the dialog box.

6. Use email, FTP, or some other manual method to transfer the package file to the importing site.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-35

© 2020 Siemens
 3. Exchanging data with suppliers

Import the package file

1. In My Teamcenter, choose Tools→Import→From Briefcase to display the Import Briefcase dialog

box.

2. Set Briefcase File to the briefcase package file to be imported.

3. Set Option Set to the transfer option set containing the configuration options to use during
import.

4. Optionally check any desired import options:

Option Description

Start immediate Causes the transfer request to process immediately. By default, Data
transfer Exchange schedules transfer requests based on system load conditions.
Your administrator may disable this option.

Show progress Displays the progress monitor dialog box automatically when the process
indicator starts.

Send email Request that Data Exchange send an email when the transfer is complete
notification to the address associated with the requesting user.

Site Check-In after Automatically checks in any objects in the briefcase file that were
import checked out to a site.

5. If you have chosen a transfer option set configured to use low-level TC XML, you can analyze
the briefcase TC XML for issues before actually importing the briefcase data. Doing so can minimize
import errors, reducing the likelihood of needing to re-import data.
For more information about validating briefcase TC XML files, see tcxml_import and
briefcase_validator.
Select one of the following additional options:
Dry Run
Specifies that a simulated low-level TC XML import be run and the imported TC XML be
validated. A report listing any warnings and errors in the TC XML is generated and displayed.
The report is also saved in the same directory as the briefcase file, named the same as the
briefcase file, but with a .html extension.

Optionally click and check Validate before mapping to validate the exported TC XML
before it is transformed.

In neither case is the briefcase file imported.

Validate
Specifies that the imported TC XML be validated. Two levels of validation occur:

3-36 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Import the package file

• In the first validation level, configuration aspects of the briefcase file such as the user,
transformation rules, data types, and the target site are validated.

• In the second pass, the objects in the briefcase file are validated.

If errors are found in the first pass, the briefcase file is not imported. If errors are found only in
the second pass, the briefcase file is imported. Whenever warnings or errors are found, a
report is generated and displayed. The report is also saved in the same directory as the
briefcase file, named the same as the briefcase file, but with a .html extension.

Optionally click and check Validate before mapping to validate the original TC XML
instead of the transformed TC XML.
None
Specifies the briefcase file is to be imported with no validation of the briefcase file.

6. Click OK and confirm your import settings. The briefcase package file is imported.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 3-37

© 2020 Siemens
 3. Exchanging data with suppliers

3-38 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 4. Fast streaming data transfer
Low-level TC XML use cases and concepts ────────────────────── 4-1
Improve Briefcase performance between managed Teamcenter sites ──── 4-1
Custom data mapping ────────────────────────────────── 4-3
Data mapping ────────────────────────────────────────── 4-3
Preventing data loss ─────────────────────────────────────── 4-3

Data Exchange, Teamcenter 12.3 PLM00094 12.3

© 2020 Siemens
Data Exchange, Teamcenter 12.3 PLM00094 12.3
© 2020 Siemens
 4. Fast streaming data transfer
Low-level TC XML use cases and concepts
Low-level (LL) TC XML allows fast streaming of data for scenarios that move large amounts of data, for
example, site consolidation and legacy data migration. It processes the data much faster than other
transfer methods.

The LL TC XML format uses the island of data concept to transfer data in chunks while maintaining
data integrity. LL TC XML features:

• Export and import operations at the POM layer that bypass the business logic.

• Metadata transfer and ownership transfer that are two distinct processes.

• Synchronization:

• For the modified objects, the complete island of data is exported.

• For unconfigured data, the synchronization applies to the complete data in the accountability table.
The synchronization cannot limited to a particular root object.

• For configured BOM objects, you can synchronize either a specified assembly configuration or all the
configurations. However, BOM synchronization does not support product structure unit or date
effectivity changes.

Caution:
To avoid a possible 515106 error (A relation cannot be saved because it violates
a unique index), you must translate the TC XML import file when you are exporting from an
earlier version of Teamcenter to the current version. If you use the site consolidation default
import transfer mode (SiteConsolidationDefaultTMImport), Teamcenter translates the import
file for you automatically during the import process.
If you use custom transfer modes to import data, you must attach the
Mapping_of_copy_stable_id.xsl style sheet to the custom transfer mode to translate the import
file during the import process. This file is located in the TC_DATA directory. Use the
plmxml_tm_edit_xsl utility to attach the style sheet to the transfer mode.

Improve Briefcase performance between managed Teamcenter

sites
Improve the speed of Briefcase operations when importing and exporting data between managed sites
by using transfer option sets configured to use low-level TC XML. For information on working with

Data Exchange, Teamcenter 12.3 PLM00094 12.3 4-1

© 2020 Siemens
 4. Fast streaming data transfer

transfer option sets, see What are transfer option sets? in the PLMXML Export Import Administration
Guide.

Use the following transfer option sets to leverage low-level TC XML with Briefcase:

• TIEUnconfiguredLLBCZExportDefault for unconfigured Briefcase export using TC XML.

• TIEConfiguredLLBCZExportDefault for configured Briefcase export using TC XML.

• TIELLBCZImportOptionSetDefault for Briefcase import using TC XML.

When using these transfer option sets, be aware of the following items:

• Anchors are exported and imported.

• PSOccurrence threads are exported and imported.

• All Dataset revisions are exported and imported.

• Inactive ItemRevisions are not exported or imported.

Updating objects previously exported using high-level TC XML

If the target site contains objects that were previously exported using high-level TC XML, some objects
may not be updated upon import by default. To import these objects, add the option
forceUpdate=True to the TIELLBCZImportOptionSetDefault transfer option set. Doing so forces the
updating of all objects in the TC XML file.

Exporting and importing replica objects

When exporting and importing replica objects (objects for which the owning site is not the local site):

• By default, if an object is a replica, the object will be exported as a stub instead of a full object in the
TC XML file. To export the object instead of a stub, set the option forceExportReplica=True in
the transfer option set.

• When importing objects that already exist at the target site, but the target site is not the owning site,
the last save dates (lsd) of the objects are compared. If the lsd of the object in the TC XML is more
recent than that of the existing object at the target site, the object is updated. If the lsd values are the
same, or if the lsd of the object in the TC XML is older, the object is not updated at the target site.

Using low-level TC XML with custom transfer option sets

To leverage low-level TC XML with custom transfer option sets, add the following option to the option
sets:

4-2 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Data mapping

opt_ll_bcz=True

Custom data mapping

Data mapping

The Business Modeler IDE (Integrated Development Environment) hosts the Mapping Designer data
migration tool that you use to map the data model between sites. This tool is based on the Altova
MapForce graphical data modeling tool.

In the Mapping Designer tool, you can create a new project or open an existing one, such as the
standard sample projects. All the mapping information between a source and a target site are stored in
the form of a Mapping Designer project. A project contains the following information:

• Source and target schema definition files

• Factor definitions (XML) files

Each factor contains source and target objects, their selected properties, instance filtering rules, and
factor dependencies. A factor defines conceptual element of the source or target systems. Defining
factors and specifying the transformation for each factor separately simplifies the mapping process
and allows a more manageable definition.

• A transformation (XSLT) file for each factor

• A MapForce project file for each factor

Each project file contains saved graphical mappings.

• A map control file

This is the master transform file used by the mapping engine. It references the factors that are
defined and their corresponding transformations (XSLT).

These identifiers help Mapping Designer track generic system the source and target schema belong to. A
Mapping Designer project retrieves this from the schema files and stores it as project properties. The
property names are sourceendpoint and targetendpoint. The factors created/stored in the project
individually store this information, so each factor identifies that it is valid for a specific sourceendpoint
and targetendpoint property. This information is helpful when a factor is being imported.

Preventing data loss

Mapping data between different systems results in the possibility that data can be lost under certain
circumstances. An example of this possibility is when the following conditions exist:

• An object is transferred from Teamcenter Enterprise to Teamcenter.

• The object ownership is transferred to Teamcenter.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 4-3

© 2020 Siemens
 4. Fast streaming data transfer

• The object is subsequently determined to have been transferred in error and the transfer is undone.

This situation could result in the loss of data because when an object is transferred from Teamcenter
Enterprise to Teamcenter, some attributes are dropped during the mapping processing. This is due to
data model incompatibility and because some Teamcenter Enterprise attributes are not needed in
Teamcenter (or vice versa). When ownership is transferred back to Teamcenter Enterprise from
Teamcenter, data loss could occur because when an attribute is not sent to Teamcenter, there is no way
for it be repopulated in Teamcenter Enterprise on the reverse trip.

4-4 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 5. Loading bulk data
Bulk load business process ─────────────────────────────── 5-1
Migrating bulk data from Teamcenter Enterprise or a third-party system ── 5-2
Using the CSV to TC XML converter ────────────────────────────── 5-2
Island of data ────────────────────────────────────────── 5-20
TC XML format ───────────────────────────────────────── 5-21
Prepare Teamcenter for bulk load import ───────────────────── 5-26
Enable bulk loader utilities ────────────────────────────────── 5-26
Bulk load Teamcenter data ────────────────────────────────── 5-26
TC XML file with GSID references ────────────────────────────── 5-28
TC XML file with POM_stub elements ─────────────────────────── 5-30
Create, update, and infer-delete ────────────────────────────── 5-31
Teamcenter core data dictionary ────────────────────────────── 5-32
Teamcenter data model diagram ────────────────────────────── 5-51
Sample assembly structure in a TC XML file ──────────────────────── 5-52
Sample TC XML file with GSID references ───────────────────────── 5-53
Pre-import validation ────────────────────────────────── 5-58
Pre-import validation utility ───────────────────────────────── 5-58
Required schema ──────────────────────────────────────── 5-58
Required helper objects ──────────────────────────────────── 5-59
Validate your TC XML test files ──────────────────────────────── 5-60
Pre-import validation logs ────────────────────────────────── 5-60
Bulk load data ─────────────────────────────────────── 5-61
Bulk loader utility ─────────────────────────────────────── 5-61
Sample bulk load repeat file ───────────────────────────────── 5-64
Frequently asked questions ────────────────────────────── 5-67

Data Exchange, Teamcenter 12.3 PLM00094 12.3

© 2020 Siemens
Data Exchange, Teamcenter 12.3 PLM00094 12.3
© 2020 Siemens
 5. Loading bulk data
Bulk load business process
Loading data into Teamcenter using bulk load utilities is performed using TC XML files that bypass the
business logic rules. Doing so provides performance enhancements when loading legacy data.

Business process Description Roles

Extract legacy data for Determine the legacy data to extract into Data administrator
import low-level TC XML files containing
Implementation engineer
islands of data that the bulk load utility
can use as import files. Technical architect
Extract the legacy data to the common,
comma-separated values (CSV), format Note:
that can easily be transformed to the Siemens Digital
required format. Industries Software
Use the CSV to TC XML converter to services personnel can
create the required TC XML import files. assist in the conversion
process using special
tools they have
developed for this
process.

Prepare Teamcenter, Obtain and create a bulk import utility System administrator
legacy data, and the key and configure a logical volume for
associated physical files physical files in Teamcenter.
for import into
Teamcenter

Validate the import file Validate your TC XML import file meets System administrator
Teamcenter requirements. Correct any
validation errors.

Bulk load objects Load data and correct any issues that System administrator
occur using bulk load repeat files.

The following figure shows the bulk load business process and roles:

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-1

© 2020 Siemens
 5. Loading bulk data

Migrating bulk data from Teamcenter Enterprise or a third-party

system

Using the CSV to TC XML converter

Choosing a CSV to TC XML converter version

The CSV to TC XML converter relies on the [Link] utility to migrate data. Beginning in
Teamcenter 11.6, a replacement [Link] utility is available for conversions, and the previous
version of the [Link] utility is deprecated. This new [Link] utility is recommended for
new data migrations. The previous version continues to be supported in this release, but support will
stop in a future Teamcenter release.

Be aware of the following items when choosing which [Link] utility to use.

5-2 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Capabilities of the CSV to TC XML converter

Deprecated [Link] utility New [Link] utility

Recommended for existing integrations with third- Recommended for new data migrations.
party tools and environments with automation
scripts relying on the deprecated utility.
Supports bulk migrations you may already have Input CSV data may need to be respecified.
configured.
Utility is located inTC_DATA\csv2tcxml_perl Utility is located inTC_DATA\csv2tcxml directory.
directory.
Configuration and use is covered in this document. Configuration and use is documented in the
CSV2TCXML Converter Guide in the TC_DATA
\csv2tcxml directory.
Existing feature set that is supported for a limited New capabilities:
number of future releases.
• Supports standard .csv files.

• Supports many encodings beyond ASCII and

UTF8. (Refer to Appendix A of the CSV2TCXML
Converter Guide.

• The utility is highly configurable using the

[Link] file and supporting .ini files.

• Can create multiple objects of the same class in

one row using the object name.

• No longer requires the csv2tcxml_mapping.txt

file for linking. Linking rules in the header are
used.

• Many more templates can now be supported

with the extendable framework.

• Additional features such as attribute propagation

and class aggregation.

Capabilities of the CSV to TC XML converter

Note:
The TC_DATA\csv2tcxml_perl\[Link] utility described here is deprecated and support will
be removed in a future release.
The replacement utility is TC_DATA\csv2tcxml\[Link] (named the same, but stored in a
different directory). This replacement utility is recommended for new data migrations. Refer to the
CSV2TCXML Converter Guide in the TC_DATA\csv2tcxml directory for instructions on its use.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-3

© 2020 Siemens
 5. Loading bulk data

See Choosing a CSV to TC XML converter version for more information.

The converter:

• Reads one or more text files, formatted similar to comma-separated values (CSV) files that contain
metadata, and generates a TC XML file based on mapping defined in CSV file column header.

• Supports the following business objects and their subclasses and subtypes:

Item, ItemRevision, and the related master forms

ImanRelation
Dataset and ImanFile
PSBOMView, PSBOMViewRevision, PSOccurrence, and PSOccurrenceNotes
ReleaseStatus

• Allows you to create additional business objects using simple definitions in csv2tcxml_mapping.txt
file. New objects can be linked to another object using a relation or attribute.

• Supports multifield key values on items.

• Supports generation of PUID-based TC XML.

• Allows mapping a CSV column value into any standard or custom business object and its attributes. A
single column value can be mapped to single or multiple objects and their attributes.

• Provides a column lookup feature. You can use this feature to replace the column value with a new
value from an external file. For example, if the owning_user attribute values on the source system
are different from the values in Teamcenter, the source system values and their replacement values
can be provided in an input file and the converter replaces them during conversion.

• Groups objects into islands according to Teamcenter islands of data export/import process. Multiple
islands can be combined together based on a preference for better import performance.

• Supports data conversion in a modular method using CSV files. Item and item revision related
information are processed separately and similarly BOM, relation, and dataset related information can
be processed individually.

• Provides various validations, and violations are captured in a log file as errors or warnings.

• Validates that business object names and attributes used in column headers are valid in the
schema.

• Validates that Item, Dataset, ImanRelation, and PSBOMView type names are valid in the schema.

• Validates that ReleaseStatus, PSViewType, and NoteType values are valid in schema.

5-4 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 CSV file column names

• Validates that LOV values on attributes and length of string attributes are valid.

• Checks for different revisions of the same item having different item types.

• Allows you to set chunking of large XML files based on a size defined in a preference.

• Provides a progress indicator during conversion and an HTML report for data, performance, and
errors.

• Supports CSV files of any size configured by a preference to unload objects from memory after certain
number of lines in the file is reached. This provides scalability.

• Supports UTF-8 encoding.

• Supports data extraction from Business Modeler IDE template XML files for standard and custom data
models.

Limitations of the utility

Caution:
If you open a .csv file in Excel to view its contents, do not save the file as a .csv file from Excel.
Excel may add extra characters when the file is saved that prevent the CSV2TCXML utility from
converting it successfully.

The CSV2TCXML utility does not support infer-delete of objects.

CSV file column names

Open the csv2tcxml_column_names.txt file. Examine this file to understand all possible CSV column
names for item, dataset, imanrelation, and psoccurrence types including the standard and custom
attributes. This file also lists the attribute type (integer, double, string, and so forth) for each column
name, and allowed values if that attribute is a list of values (LOV).

Required column names Teamcenter objects in TC XML file

Item:item_id, ItemRevision:item_revision_id, Item, ItemRevision, Form, ImanRelation, Anchor
Item:object_type
Dataset:dataset_type, Dataset:object_name, Dataset, ImanFile, ImanRelation,
ImanFile:file_name, RevisionAnchor
ImanRelation:relation_type, Item:item_id,
ItemRevision:item_revision_id

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-5

© 2020 Siemens
 5. Loading bulk data

Required column names Teamcenter objects in TC XML file

parent_item, parent_rev, child_item, child_rev PSBOMView, PSBOMViewRevision,
PSOccurrence, PSOccurrenceThread
parent_item, parent_rev, child_item, child_rev, ImanRelation (ItemRev→ItemRev or Item→Item
ImanRelation:relation_type or ItemRev→Item or Item→ItemRev supported)

Common optional column names Teamcenter objects in TC XML file

owning_user, owning_group, creation_date, All WorkspaceObjects having these attributes
last_mod_date, release_status_list, project_list

Design Intent:
The owning_user column is not a required column in the input CSV file. If you omit this column,
the converter uses infodba as the default value. However, if you include this column, the values
must match an existing User object's user_id attribute value (not user_name) in the importing
site's database.
Also, the owning_group is not a required column. If you omit this column, the converter uses dba
as the default value. However, if you include this column, the values must match an existing
Group object's name attribute value in the importing site's database.

For the following columns, the column name represents a reference attribute. However, the value you
use in the column is a string, not a reference. For example, the value to use in a CSV file for the
owning_user column must match the value of an existing User.user_id attribute in the Teamcenter
database where you want to import the XML file.

CSV file column name Expected value

owning_user User ID in Teamcenter (User.user_id attribute)

owning_group Group name in Teamcenter ([Link] attribute)

project_list Project ID in Teamcenter (TC_Project.project_id attribute)

uom_tag Unit of measure symbol in Teamcenter

([Link] attribute)

volume Volume name in Teamcenter (ImanVolume.volume_name

attribute)

PSOccurrenceNotes:note_types Note type name in Teamcenter ([Link] attribute)

5-6 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Enable the CSV to TC XML converter

Enable the CSV to TC XML converter

Note:
The TC_DATA\csv2tcxml_perl\[Link] utility described here is deprecated and support will
be removed in a future release.
The replacement utility is TC_DATA\csv2tcxml\[Link] (named the same, but stored in a
different directory). This replacement utility is recommended for new data migrations. Refer to the
CSV2TCXML Converter Guide in the TC_DATA\csv2tcxml directory for instructions on its use.
See Choosing a CSV to TC XML converter version for more information.

You can migrate bulk data from legacy/enterprise systems to Teamcenter by extracting the data in a
format similar to a comma-separated values (CSV) file (using SQL or other tools in that system) and
converting it into TC XML using the converter. By default, the separator is a pipe character (|) instead of
a comma. The output TC XML file can be imported into Teamcenter using the bulk load function of the
tcxml_import utility.

1. Start a Teamcenter command shell as a Teamcenter administrator and change to the TC_DATA
\csv2tcxml_perl directory.

2. Type the following command to generate four files: csv2tcxml_all_attrs.txt,

csv2tcxml_required_attrs.txt, csv2tcxml_datamodel.txt, and csv2tcxml_column_names.txt.

perl [Link] install Teamcenter-administrator-password

3. Open the csv2tcmxl_config.txt file and add appropriate values to the following variables:

source_site= Defines the site ID of the exporting site. This site must be defined in Teamcenter
site-id prior to importing the migrated objects.
volume=volu Defines the name of the volume where Teamcenter stores the files related to
me-name imported datasets.
sdpath= Defines the operating system directory containing the volume where Teamcenter
stores the files related to imported datasets. Provide the name only, do not
include the path.

4. Modify and add additional configuration variables that you need in the csv2tcmxl_config.txt file.
The file contains descriptions of the most commonly used variables and their default value if they
have one. Some of the less commonly used variables are commented out by default. To add these
variables, uncomment them and provide a default value.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-7

© 2020 Siemens
 5. Loading bulk data

Note:
You can override any of the variable values in this file temporarily by adding them into the
command line arguments when you type the command. Use the format argument-
name=argument-value.

Additional configuration variables

The following parameter descriptions provide additional information to help you determine when and
how to use the more complex variables:

GMS_tcxml_string_separator
Specifies the separator character used in note_texts values for parsing multiple values. This variable
is similar to the Teamcenter preference of the same name. The default character is a comma (,). You
can set the value to another character if the comma character does not work with your values. For
example, to use the semicolon character:

GMS_tcxml_string_separator|;
mfk_columns
Allows part data that has multiple objects with the same item_id value. This is normally not allowed
but can be processed as multifield key data in one of the following ways:

• If the input data contains two or more objects with the same item_id value, but the data are of
different classes, set the mfk_columns configuration variable. For example, if there are two parts
with the same item_id value but one is an Item object and the other is a CustomPart object, set
the variable as follows.

mfk_columns|Item:object_type,parent_type,child_type

Ensure the following columns are present in the CSV file:

• For Item object files, add an Item:object_type column in the first (header) row and populate
the column in all other rows with the name of the Teamcenter Item subclass.

• For BOM or GRM object files, add parent_type and child_type columns in the header row and
populate the column in all other rows with the object type for the parent (assembly) and child
(component) objects.

• If the input data contains two or more objects with the same item_id value and they are of the
same class, determine another attribute that is unique and set the mfk_columns variable as
follows:

mfk_columns|name-of-unique-attribute,parent_type,child_type,parent_mfk,child_mfk

Ensure that the following columns are present in the CSV file:

5-8 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Enable the CSV to TC XML converter

• For Item object files, add Item:object_type and a column for the unique attribute in the first
(header) row. Populate the column in all other rows with the name of the Teamcenter Item
subclass and the unique attribute.

• For BOM or GRM object files, add parent_mfk and child_mfk columns in the header row and
populate the columns in all other rows with the multifield key value for the parent and child
items.

• If you use an attribute other than object_type in the mfk_column variable and:

• The attribute is defined at an abstract parent class.

• The attribute is used by multiple persistent child classes.

• You want to use only one configuration file for all migrations (alternative to redefining the
mfk_column variable for each class).

Define the multifield key attribute using $CLASS:attribute-name as follows:

mfk_columns|
$CLASS:attribute-name,parent_type,child_type,parent_mfk,child_mfk

For example, the data you are migrating uses several Item subclasses, each with a common
parent class that defines the TDM_ID attribute. This attribute is used as part of the multifield key
for all the child classes. To specify the TDM_ID attribute as part of the multifield key for all the
child classes, set the variable as:

mfk_columns|$CLASS:TDM_ID,parent_type,child_type,parent_mfk,child_mfk

When the converter encounters $CLASS in the mfk_columns variable, it checks for an attribute
by that name for the class and replaces $CLASS with the object_type value.
lookup_columns
Specifies the name of a separate lookup file or files for the specified attribute or attributes. For
example, to specify lookup files for the object_type and owning_user attributes, set the variable as
follows:

lookup_columns|Item:object_type,owning_user

The converter looks for files named Item_object_type.txt and owning_user.txt. Any colon (:)
characters in the attribute name are converted to underscore (_) characters. The converter uses the
contents of the files to replace the values in the output TC XML file.

The lookup text files must contain separate lines formatted as old-value|new-value.
puid_lookup_file

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-9

© 2020 Siemens
 5. Loading bulk data

Specifies a lookup file containing separate lines of puid/item_id value pairs for standard key values
or puid/item_id/object_type value sets for multifield key values. For example, for standard key
values, the lines are formatted as:

puid-value,item_id-value!
puid-value,item_id-value!A

For multifield key values the lines are formatted as:

puid-value,item_id-value!object_type
puid-value,item_id-value!object_type!A

Instead of generating PUID values during the conversion process, the converter uses the file to
obtain existing PUID values. Use this when the importing site has existing data, either created locally
or previously migrated without using the converter, and you must migrate additional data that must
be related to the existing data.

You can generate the lookup file by running a simple SQL script to extract puid and item_id values
from the Teamcenter database.
skip_special_chars
Specifies whether the converter processes XML special characters, such as &#10; (the XML numeric
representation of \n) in the CSV file. By default, the converter processes them. To skip the
processing of these special characters and pass them through unchanged in the output TC XML file,
set the variable as:

skip_special_chars|1
disable_attr_truncation
Specifies whether the converter truncates string attribute values to the maximum length as
specified in the ATTR_LENGTH value in the csv2tcxml_datamodel.txt file. The converter also
generates a warning when an attribute string is truncated. To disable the truncation, set the variable
as:

disable_attr_truncation|1

Sample CSV files

Sample Microsoft Excel format files are in the TC_DATA/csv2tcxml_samples directory. These files use the
default pipe (|) character as the separator.

The following listing shows a sample [Link] file containing item and item revision information:

!Item:item_id|ItemRevision:item_revision_id|ItemRevision:object_name|
ItemRevision:object_desc|
Item:object_type|owning_user|owning_group|creation_date|last_mod_date
18-0003|A|Assembly|MyAssembly|Item|migration|dba|2000/02/04-19:24:23|2000/02/04-20:12:23
18-0004|A|Component1|MyComponent1|Part|joek|dba|2000/02/04-19:24:23|2000/02/04-20:12:23
18-0005|B|Component2|MyComponent2|Requirement|mikeh|dba|2000/02/04-19:24:23|

5-10 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Sample CSV files

2000/02/04-20:12:23
18-0006|G|Component3|MyComponent3|EngChange|migration|dba|2000/02/04-19:24:23|
2000/02/04-20:12:23

Use the following command to convert this file:

perl [Link] [Link]

The following listing shows a sample [Link] file containing dataset information:

!Item:item_id|ItemRevision:item_revision_id|Dataset:dataset_type|Dataset:object_name|
ImanRelation:relation_type|owning_user|owning_group|creation_date|last_mod_date
18-0003|A|Text|AssmText|IMAN_reference|migration|dba|2000/02/04-19:24:23|
2000/02/04-20:12:23
18-0004|A|DirectModel|CompJT|IMAN_Rendering|swaminat|dba|2000/02/04-19:24:23|
2000/02/04-20:12:23
18-0005|B|UGPART|CompPart|IMAN_UG_altrep|mholt|dba|2000/02/04-19:24:23|
2000/02/04-20:12:23
18-0006|G|MSWordX|CompDoc|IMAN_requirement|migration|dba|2000/02/04-19:24:23|
2000/02/04-20:12:23

Use the following command to convert this file:

perl [Link] [Link] item=exist

The following listing shows a sample [Link] file containing BOM information:

parent_item|parent_rev|child_item|child_rev|PSOccurrence:seq_no|PSOccurrence:qty_value
18-0003|A|18-0004|A|10|1
18-0003|A|18-0005|B|20|5
18-0003|A|18-0006|G|30|3

Use the following command to convert this file:

perl [Link] [Link] item=exist

The following listing shows a sample [Link] file containing relation information:

!parent_item|parent_rev|child_item|child_rev|ImanRelation:relation_type
18-0003|A|18-0004|A|IMAN_reference
18-0003|A|18-0005||IMAN_requirement
18-0003||18-0006|G|TC_Attaches
18-0003||18-0006||IMAN_based_on

Use the following command to convert this file:

perl [Link] [Link] item=exist

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-11

© 2020 Siemens
 5. Loading bulk data

Default CSV file requirements

The utility requires the following format in the CSV file by default:

• The pipe character (|) is the column separator.

• The exclamation character (!) is the first character in the line that defines header/column names.

• The comma character (,) is the variable length array (VLA) attribute value separator.

• Date values are formatted as YYYY/MM/DD-hh:mm:ss. The utility converts the dates to Teamcenter
format, YYYY-MM-DDThh:mm:ssZ. The time may be omitted, in which case the utility appends
T00:00:00Z to the date information.
For example, if the date supplied is 2000/02/04-19:24:23, the utility converts it to
2002-02-04T19:24:23Z. If the date supplied is 2000/02/04, the utility converts it to
2002-02-04T00:00:00Z

• Each line in the file represents:

• For item files, an item revision and its related objects and attributes.

• For BOM files, a PSOccurence object and its related objects and attributes.

• For GRM files, a generic relation management rule and its related objects and attributes.

• For dataset files, a dataset object and its related objects and attributes.

• There cannot be duplicate dataset types with the same dataset name under any item revision.

Note:
Empty characters at the end of an item_id attribute are skipped during the creation and lookup to
prevent duplication failures.

If the default column separator (|) is not suitable because it appears in some attribute values, there are
two options:

• If there is another character that is guaranteed not to be in any attribute value, specify the
column_sep configuration variable in the configuration file for the utility. For example, if the hash (#)
character can be used, set the variable as column_sep|#.

Note:
• The separator character may be multiple characters. For example, you can specify the variable
value as column_sep|##.

5-12 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Special characters in CSV files

• The pipe character must be used in the first (header) line, regardless of the value specified in
the column_sep variable.

• The column_sep variable is not related to the GMS_tcxml_string_separator preference.

That preference specifies the separator used for the note_texts attribute values.

• If there is not a single character available that is guaranteed to be unused, use the default pipe (|)
character as the separator and use the XML numeric character references for any special characters.
For example, to embed a linefeed character in an attribute value, use code &#10;. The csv2tcxml
converter copies the attribute value without converting the &#xx; value. The tcxml_import utility
converts it to the proper character during the import process.

Special characters in CSV files

The csv2tcxml converter and tcxml_import utility require the following special characters be replaced
by their XML equivalents in attribute values in the input file:

Character Replace with

< &lt;

> &gt;

& &amp;

" &quot;

' &apos;

You must also set the skip_special_chars configuration variable to 1 in the csv2tcmxl_config.txt file.

If you are migrating Item class objects to a custom Item subclass, and the subclass defines an attribute
that points to another Item or ItemRevision object, you must prefix the attribute with the dollar
character ($) in the first line of the CSV file. This is also true if the attribute points to a Item subclass or
ItemRevision subclass.

For example, the VendorPart custom Item subclass contains the vendor_ref attribute. This attribute
points to the Vendor custom Item subclass. You must:

• Define the column in the first line of the input file as |$VendorPart:vm0vendor_ref|.
This causes the csv2tcxml converter to use the column value in the following lines of the file as a
PUID value.

• Add valid PUIDs (item_id) values of the required Vendor objects to the column.

Example for standard key values:

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-13

© 2020 Siemens
 5. Loading bulk data

Object class Format Example

Item item_id 59-513-1541

ItemRevision item_id!item_revision_id 59-513-1541!A

Example for multifield key values:

Object class Format Example

Item item_id 59-513-1541!VendorPart

ItemRevision item_id!item_revision_id 59-513-1541!VendorPart!A

[Link] utility

Note:
The TC_DATA\csv2tcxml_perl\[Link] utility described here is deprecated and support will
be removed in a future release.
The replacement utility is TC_DATA\csv2tcxml\[Link] (named the same, but stored in a
different directory). This replacement utility is recommended for new data migrations. Refer to the
CSV2TCXML Converter Guide in the TC_DATA\csv2tcxml directory for instructions on its use.
See Choosing a CSV to TC XML converter version for more information.

Converts a file formatted similar to a CSV file into a TC XML file that can be imported into a Teamcenter
site. You use this utility to migrate data from a legacy system into Teamcenter using the bulk load
function of the tcxml_import utility.

Note:
The csv2tcxml_config.txt file contains default values for many of the arguments. You can override
any of the variable values in this file temporarily by adding them into the command line
arguments when you type the command. Use the format argument-name=argument-value.

Syntax

perl [Link] [split] {file-name | reports input-directory}

[split-file-integer]

Arguments

split
Indicates that the input file is processed as a set of subfiles. The converter processes the number of
lines indicated by the split-file-integer argument as a subfile. The next set of lines are then

5-14 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 [Link] utility

processed until it has processed all lines in the indicated file. This allows more efficient use of
memory for very large files and can prevent memory limit errors.
file-name
Defines the name of the TC XML output file that you use to import the legacy data into the target
Teamcenter site. This argument is required unless you are generating reports.
reports
Generates the HTML report from the log files in the indicated directory. This report shows summary
information, breakup of the objects created, performance of the conversion with time taken for
each step, and the number of errors and warnings the converter generated. It also includes a link to
the log file.
input-directory
Indicates the directory containing the log files used to generate the HTML report.
split-file-integer
Indicates the number of lines to process as a subfile when you specify the split argument. If you do
not specify a split value, the converter uses 100,000 as the default value.

Examples

• To read the input CSV file and generate a puid-based TC XML file for items:

perl [Link] [Link]

• To read the input CSV file and generate a puid-based TC XML file for datasets that does not contain
item or revision information in the file:

perl [Link] [Link] item=exist

• To read the input CSV file and generate a puid-based TC XML file for datasets that does not contain
BOM or GRM information in the file:

perl [Link] [Link] item=exist

• The following is an example of the converter's progress indicator output:

D:\tcxml> perl D:\scripts\[Link] D:\scripts\samples\[Link] source_site=10000

-> 0 of 5 : Processing
[D:\scripts\samples\[Link]] in [puid] with item-exists=[0] ...
-> 1 of 5 : Generating GSids
!
-> 2 of 5 : Converting GSids to Puids
-> 3 of 5 : Converting CSV to TCXML
!
-> 4 of 5 : Creating tcxml file
-> 5 of 5 : Printing & Validating tcxml stats
NOTE: *** 3 errors 0 warnings 0 duplicates logged in

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-15

© 2020 Siemens
 5. Loading bulk data

[D:\scripts\samples\[Link]] ***
-> Total time = 0 seconds

• To import a custom form that is attached to an item revision, in csv2tcxml_mapping.txt add the
following line file to the #CREATE_OBJECT_COLUMNS section and replace CostDataForm with the
custom form type name.

CustomFormName|CostDataForm:object_name<-IMAN_reference<-ItemRevision

In the .csv file, add the following column name and provide a value in each row to create the custom
form.

!Item:item_id|ItemRevision:item_revision_id|CustomFormName
100223|A|cost-frm-1
100778|A|cost-frm-2

• To process multiple imports for an assembly, include the occurrence ID (occ_id) property. A unique
occ-id column must be provided if the BOM data is updated multiple times as shown in the following
example:

!parent_item|parent_rev|child_item|child_rev|occ_id
car|A|wheel|A|front-left
car|A|wheel|A|front-right
car|A|wheel|A|rear-left
car|A|wheel|A|rear-right

Errors and warnings

The converter generates the following error messages:

• Required input (source_site) missing in config file and command line.

• Column count in Header is different than columns in a row.
• Item id value length is less than 1.
• Custom Item type used in csv file is missing in csv2tcxml_datamodel.txt
file.
• Island 0 (admin) objects are not on top of xml file.
• Class/type in item, itemrevision, form, psbomview objects is not valid.
• Dataset type, tool/format and volume/sdpath definition is missing.
• Puid value of BO is invalid in itemrevision, form, dataset, bvr, psocc,
relation and generic BO.
• Unsupported secondary object during generic BO creation with GRM.
• Primary object missing during generic BO creation thru attribute
reference.
• Duplicate Puid generated.
• Business object/attribute name(s) used in column name is missing in
Teamcenter schema.
• Item helper classes/types defined in csv2tcxml_datamodel.txt is missing in
Teamcenter schema.

5-16 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Using CSV conversion HTML reports

• Dataset/ImanRelation types used in csv file is missing in Teamcenter

schema.
• Category defined in mapping is unknown or unsupported.

The converter generates the following warning messages:

• Unsupported command line parameters.

• Certain column in csv file is not mapped in mapping file.
• Required attribute is empty.

Using CSV conversion HTML reports

The converter generates an HTML report for each CSV file conversion. The report contains summary
information showing the output TC XML file size and total number of elements processed. It also
displays a pie chart with breakup of the objects created in the output TC XML file, a performance chart
with the time taken for each step of the conversion, and a column chart with the number of errors and
warnings generated during conversion and a link to the log file.

1 Summary information Output TC XML file size.

2 Summary information Total number of elements processed.

3 Objects created pie chart Breakdown of objects created by type.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-17

© 2020 Siemens
 5. Loading bulk data

4 Performance chart Time taken to complete each step in the conversion

process.

5 Log file column chart Number of errors and warnings generated with link to
the log file.

Using Dataset and ReleaseStatus objects in CSV files

The converter defines one ImanFile object for each Dataset object. To define additional Form objects to
associate with a particular dataset subclass, define an extra configuration variable as follows:

Dataset-class_FORMS|form-storageclass1:form1;storageclass2:form2;…

For example, the UGPART dataset subclass has two Form objects associated with it. Define the extra
configuration variable as:

UGPART_FORMS|UGPartAttr:UGPART-ATTR;UGPartAttributesForm:UGPARTATTRIBUTES

You can also define multiple ImanFile objects associated with the same Dataset object. To do this, list
the file names as comma-separated values in the ImanFile:file_name column. The converter creates
one ImanFIle object for each file name specified.

You can associate ReleaseStatus values with migrated Item and ItemRevision objects by adding a
release_status_list column to the first line (header) of the CSV file. Populate the following lines in the
column with one or more values that correspond to existing ReleaseStatus objects at the importing
Teamcenter site. You can optionally specify a timestamp (date and time) value for the ReleaseStatus
object. To do this, define a ReleaseStatus:date:released column and populate it with one or more
timestamp values. The value is used with the corresponding release_status_list value. The converter
processes multiple values in the release_status_list and date_released columns as follows:

• If there is one value in the release_status_list column and one value in the date_released column,
the date_released value is used for the ReleaseStatus.date_released attribute value.

• If there are one or more values in the release_status_list column and no value in the date_released
column, or no date_released column defined in the CSV file, the ReleaseStatus objects are created
without a date_released attribute. This is valid because a date_released attribute is not required for
ReleaseStatus objects.

• If there are two values in the release_status_list column and one value in the date_released
column, the date_released value is used for both ReleaseStatus objects.

• If there are two values in the release_status_list column and two values in the date_released
column, the first date is used for the first ReleaseStatus object and the second date is used for the
second ReleaseStatus object.

5-18 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Extending the data model for CSV file conversion

Extending the data model for CSV file conversion

Names for column headers are defined in the csv2tcxml_column_names.txt file. To use classes and
attributes other than the standard Item, ItemRevision, BOM, and relation (GRM) classes, you must:

• Identify the classes and attributes you must convert.

• Identify how elements of the new class are related to other objects.

For example, the Effectivity class stores information about part effectivities, either by part revision or by
structure. For revision effectivity, the Effectivity object is related to a ReleaseStatus object. For
structure effectivity it is related to a PSOccurrence object. These relationships are defined in the
csv2tcxml_mapping.txt file as follows:

reveff_units|Effectivity:effectivity_units<-ReleaseStatus:effectivities
reveff_dates|Effectivity:effectivity_dates<-ReleaseStatus:effectivities
assmeff_units|Effectivity:effectivity_units<-PSOccurrence:effectivities
assmeff_dates|Effectivity:effectivity_dates<-PSOccurrence:effectivities

The first column, from the start of the line up to the pipe (|) character, specifies the column name to use
in the CSV file. The next column, from the | to <- specifies the attribute name that holds the value
specified in the CSV file for that column. The final column specifies how the Effectivity object is related
to other objects. For revision effectivities, the ReleaseStatus effectivities attribute points to the
Effectivity object. For structure effectivities, the PSOccurrence effectivities object points to the
Effectivity object.

The following sample CSV file listing defines an Effectivity object when used with the previous mapping
shown for the csv2tcxml_mapping.txt file:

!parent_item|parent_rev|child_item|child_rev|assmeff_units|
Effectivity:effectivity_protection
061714-0005|A|061714-0006|A|1 10 20 30|false

Because the CSV file specifies the parent_item, parent_rev, child_item, and child_rev attributes, the
converter creates the PSBOMView, PSBOMViewRevision, and PSOccurrence BOM objects. The
csv2tcxml_mapping.txt file specifies the assmeff_units column as the Effectivity object, therefore the
converter creates an Effectivity object. Because the mapping file also specifies how the Effectivity
object is related, the [Link] attribute points to the Effectivity object.

Note:
The last column, Effectivity:effectivity_protection, is required in the CSV file for Effectivity
objects. To see all required attributes for a class, see the csv2tcxml_required_attrs.txt file.

For effectivities, the effectivities attribute of the ReleaseStatus or PSOccurrence object points directly
to the Effectivity object. However, if a relation (GRM) class points to the new object, you must use the
following format:

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-19

© 2020 Siemens
 5. Loading bulk data

column-name|object-to-create:attribute-name <- GRM-name <-related-object

For example, to specify that CompanyObject objects are related to an Item object by the
ContactInCompany relation, add the following to the csv2tcxml_mapping.txt file and add the
comp_contact column to the CSV file:

comp_contact|CompanyContact:first_name<-ContactInCompany<-Item

Island of data

An Island of data concept is used to bulk load data into Teamcenter. Loading data in islands maintains
the integrity of data relationships and allows recover from import failures during the bulk load. The
following definitions help you understand this concept:

Island The fundamental unit of data. It consists of a principal object and the additional objects
on which it depends for its correct functional definition and usage within Teamcenter.
Principal The initial object used to start the traversal to determine an island of data.
object
Dependent An object that must be included in the set of objects implied by the principal object and
object the closure rules to correctly form the island of data. Dependent objects may not exist
in a particular island.

The following diagram shows how an island can be defined:

5-20 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 TC XML format

Island of data

TC XML format

The TC XML format is defined by the TC XML schema. The TC XML schema is autogenerated at
installation and upgrade, and the resulting [Link] file is placed in the TC_DATA directory on the
Teamcenter server. You can also use the Business Modeler IDE to export a TC XML schema file of your
current Teamcenter schema.

In a TC XML file, the root element is TCXML and the namespace (xmlns) attribute is http://
[Link]/Schemas/TCXMLSchema, as shown in the following figure.

TC XML root element

The TC XML root element has a format attribute that you can set to low_level or high_level. For bulk
loading, you must set the attribute to low_level.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-21

© 2020 Siemens
 5. Loading bulk data

Note:
The URIs that appear in the headers of PLM XML and TC XML files serve as namespace names, are
unique identifiers for an XML vocabulary. Although they are URIs, they are not used to identify and
retrieve web addresses.

A TC XML file has a flat structure (no hierarchy). Elements in the TC XML file have:

• The leaf-class name as its element name.

• An elemId attribute to uniquely identify the element (required).

• An island_id attribute (required).

Note:
The elemId attribute value must have id followed by a number, for example, elemId = ”id90”.

Object references in a TCXML file are formed by prefixing the hash character (#) to the elemId value.

TC XML object reference

TC XML data is grouped into islands; an island ties logically related objects together. The data migration
solution can form simple islands, like [Item, ItemRev, MasterForm] or [Dataset, RevAnchor,
ImanFile], and the fast import processes the islands one-at-a-time. The following figure shows an
example of how to structure TC XML data islands for best results:

5-22 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 TC XML format

Typical TC XML island structure

XML elements for organizational (User, Group, Site, and so forth) and administrative (Types, Rules)
objects are assigned an island_id attribute value of 0 and contain the candidate key attribute.

The organizational and administrative objects are not replicated; they are looked up at the target site
based on their candidate key.

Organizational and administrative TC XML elements

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-23

© 2020 Siemens
 5. Loading bulk data

The candidate keys for certain classes are defined by the schema as shown in the following table. The
attribute descriptor is POM_attr_is_candidate_key. Additionally, the following list of classes and
corresponding candidate keys is processed by the fast import function. Some special cases, indicated by
a hash (#), involve composite keys for the XML element has a dummy attribute containing the
composite key values.

Class name Candidate key

ClosureRule name

RevisionRule object_name

ImanVolume volume_name

Tool object_name

TC_Project project_id

TransferMode object_name

TransferOptionSet object_name

CFM_date_info id

AM_ACL ACL_Name

ImanActionHandler handler_id

ImanEventType eventtype_id

ImanAliasList alName

Condition condition_name

ImanQuery query_name

TaskType tasktype_name

Participant Subclasses* assignee

GroupMember# member

[[Link],User.user_id, Role.role_name]

ResourcePool# pool

[[Link], Role.role_name, ResourcePool.allow_sub_groups,

ResourcePool.all_members]

VerificationRule# vrule

[functionality, type, context_filter, condition_reference, subGroup]

The XML elements for objects that can be replicate have a list of attributes defined in the schema with
the parent_uid attribute that indicates the principal object. The list of attributes includes the ones

5-24 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 TC XML format

defined directly on the leaf class plus those that are defined on each parent class up to and including the
POM_object class. In an island, the principal object has an empty parent_uid attribute and all the
dependent objects have the parent_uid value set to the puid of the principal object (parent_uid=puid).

The objects of one island must appear together in the TC XML file. If they are scattered or otherwise in
error, the import of that island fails. (Other islands will be imported.) After the import of an island fails,
correct the issues and reimport the failed island.

XML elements for replicable objects

Valid values for logical attributes are Y or N.

If the owning_site attribute is missing, the object is created as a replica. The site-id value in the
originatingSite attribute of the Header element is considered to be the owner of the object.

For array attributes, the values must be separated by the delimiter defined by the
GMS_tcxml_string_separator preference. The default delimiter is a comma (,). The Header element
contains details of the originating site, option set or transfer mode used, transfer option name-value
pairs, and session option name-value pairs. The originatingSite attribute contains the site-id value
representing the legacy system and must be unique (cannot be the same as the Teamcenter site). This
site must be defined in the Organization application of the importing Teamcenter site.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-25

© 2020 Siemens
 5. Loading bulk data

TC XML Header element

Prepare Teamcenter for bulk load import

Enable bulk loader utilities

Fast import of objects using the tcxml_import utility uses data files that conform to the low-level (LL) TC
XML format. The bulk load process also uses the LL TC XML format. The use of stub objects and inferred
delete are handled differently in this format.

For LL TC XML imports, an entire island of data must be full elements regardless of whether an object is
locally owned or a replica. Stub objects are used to solve island interdependencies and are represented
by POM_stub objects in the Teamcenter database. They are not used to represent objects that have
already been sent to the target site as it does in HL TC XML imports. Consequently, if you transfer a new
revision to Teamcenter using LL TC XML, all predecessor revisions must be transferred as full objects.
These may have further related objects and so on. If they are not full objects, an inferred delete of the
stub objects occurs.

Bulk load Teamcenter data

From the perspective of the Teamcenter components, you use the following process to load bulk data
into Teamcenter:

1. Use the APIs TIE_get_preconstructed_uids and TIE_get_hashed_uid to generate Teamcenter

UIDs for composing the TC XML file containing legacy data.

5-26 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Bulk load Teamcenter data

int TIE_get_preconstructed_uids
(
int numRequestedUids, (I) Number of UIDs to construct
int* numConstructedUids, (O) Number of UIDs constructed
char*** constructedUids (OF) Number of numConstructedUids
constructed
);

int TIE_get_hashed_uid
(
int ownSiteId, (I) Site Id of Legacy system
const char* hashKey, (I) Hash Key
char** hashedUID (OF) Valid Teamcenter UID for given hash key
);

2. Use the tcxml_validate utility to validate the TC XML file generated by the custom mapping
solution. The validator log reports potential errors within TC XML file. Fix the root cause of any
errors within the custom mapping logic. This validation focuses on data samples (~2500 element
XML files) extracted from legacy systems to be executed in a test lab environment.

3. Use the tcxml_import utility to import the TC XML files generated by the custom mapping
solution. After all aspects of the translation/mapping are correct, the full TC XML file can imported
at the highest speed possible, without any additional validation.

Caution:
The importing user must have write access to the location where the utility logs the
information about the import. You can ensure that this requirement is met by including the -
log argument with a path to a location that is write accessible to the importing user. You may
optionally include a file name for the log file in the path.
When attribute values contain commas in the strings at either of the sites, you must change
the default value for the GMS_tcxml_string_separator preference at both sites to prevent
data corruption at the importing site.

Tip:
The view type data is not exported with the PSBOMView data in TC XML. The import process uses
the default view type when importing PSBOMView data.
Therefore, when transferring PSBOMView data using a briefcase file, tcxml_export and
tcxml_import, or any utility that uses TC XML metadata, set the PSE_default_view_type
preference at the target site to the view type value of the assembly at the source site. Usually, this
is the same as the source sites default view type.
This import behavior is designed to be consistent with Structure Manager.

For reference information useful for bulk loader customizations, see the following topics:

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-27

© 2020 Siemens
 5. Loading bulk data

• Teamcenter core data dictionary

• Teamcenter data model diagram

• Sample assembly structure in a TC XML file

• Sample TC XML file with GSID references

• Sample bulk load repeat file

• Frequently asked questions

TC XML file with GSID references

Bulk loader supports importing low-level (LL) TC XML files containing global stable ID (GSID) references
(GSIdentity elements). GSIDs are used for object look-up and the bulk load import handles creation of
Teamcenter UIDs for the legacy objects. This relieves the custom mapping solution from invoking a
Teamcenter API for UID creation and identity management.

Caution:
You must set the GMS_USE_FNV_HASH preference to true to enable the use of the FNV hashing
API to create Teamcenter UIDs for the legacy objects.

Note:
If you use the bulk load function to load objects that will be referenced by Data Exchange, the
GSIdenity element must match the element used by the Data Exchange process.

Every element in a TC XML file containing GSID references:

• Uses the leaf-class name as the element name.

• Is uniquely identified by its elemId attribute (required).

• Has an island_id attribute (required).

• Has a GSIdentity element as child element (required) with:

• An elemId attribute that uniquely identifies the element (required).

• A label attribute with a unique value for each element (required).

The XML elements for organizational (User, Group, Site, and so forth) and administrative (Types,
Rules) objects:

5-28 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 TC XML file with GSID references

• Are assigned 0 for the island_id attribute

• Contain the candidate key attribute

In a GSID-based TC XML file, the organizational objects are referred by the child GSIdentity element’s
elemId attribute of the corresponding organization object. For example, the owning_group attribute of
the Item element in the following figure, points to the child GSIdentity element’s elemId attribute of
the Group object.

GSID-based organization objects

Each object may contain an associated child GSIdentity element and the object look-up is based on the
GSIdentity element. The puid attribute may or may not be present and, in any case, the GSIdentity
element takes precedence for identifying the object. For new objects, the GSIdentity attributes (label,
subLabel, and spilt_token) are used to generate the puid attribute. The GSIdentity elements for the
new objects are persisted when the island is saved. They serve as import records for these objects. Bulk
load import also allows mixed TC XML files where some objects have UID-based identity and some have
GSID-based identity.

Reference attributes refer to other objects by the elemId attribute of the child GSIdentity element. The
following figure shows this type of reference. In the figure, the items_tag attribute of the ItemRevision
element has a value of #id93. This value matches the elemId attribute of the Item object’s child
GSIdentity element.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-29

© 2020 Siemens
 5. Loading bulk data

Object referenced by child GSID elemId attribute

TC XML file with POM_stub elements

In Teamcenter, POM_stub objects represent objects that do not exist in the database. These objects are
always locally owned and are the database objects that represent a stubbed object.

The POM_stub element requires three attributes:

• definitive
Points to the source site POM_imc element in the TC XML file.

• object_class
Indicates the class of the object represented by the stub.

• object_uid
Points to the GSIdentity element of the object represented by the stub. If the actual object is not
present in the TC XML file, the object_uid refers to its own GSIdentity element uniquely identifies
the object as being represented by the stub. In this case, the attributes of the GSIdentity element of
the POM_stub element are used to compose the object_uid attribute.

The owning_site

5-30 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Create, update, and infer-delete

TC XML file with POM stubs

Note:
If the import process sees that the actual object exists in the Teamcenter database for the stub, it
skips creation of the stub.

Create, update, and infer-delete

The import functionality of the bulk load process is different from low-level fast imports in that some
objects are imported as replicas followed by a separate step for ownership transfer. Also the objects
owned by the target site are not updated. During bulk load, the objects are imported as local objects at
the target Teamcenter site and are updated in all subsequent imports. The bulk_load session option
allows for this variation in behavior. This option is set when the -bulk_load argument is used with the
tcxml_import utility.

For creation, the owning_site attribute of the object must point to a POM_imc element that contains
the site-id attribute of the importing Teamcenter site in the TC XML file.

For updates, the lsd attribute of the object in the TC XML file must be later than the lsd attribute of the
object in the Teamcenter database.

The fast import traverses the target database to collect the helpers of each principal object in the TC
XML file. The objects that exist in the target database but not in the TC XML file are deleted if they are
not locally owned. This is the infer-delete mechanism. Because the bulk load process imports objects as
local to Teamcenter, the infer-delete logic does not apply.

The following figure shows the create, update, and skip sequence of the import process:

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-31

© 2020 Siemens
 5. Loading bulk data

Bulk load process creates an item with an item_id value of 000032 in Teamcenter site
-2132200621 as a local object.

Bulk load process skips the item with an item_id value of 000032 because it already
exists
at Teamcenter site -2132200621 and the lsd attribute value is the same in the TC XML file
and the database.

Bulk load process updates the item with an item_id value of 000032 because it already
exists at Teamcenter site -2132200621 and the lsd attribute value in the TC XML file
is later than the value in the database.
Create, update, and skip sequence

Teamcenter core data dictionary

The following tables show the mandatory attributes for the core Teamcenter classes (that is, those
attributes that are to be present for each class instance in the TC XML file).

Note:
When using the bulk load utility (txcml_import), the utility sets appropriate values for attributes
that are not mandatory. This type of activity must be done for other classes of interest as part of
the customization work.

5-32 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Teamcenter core data dictionary

Item attributes

Attribute Mandatory Comments

acl_bits No

active_seq No

archive_date No

archive_info No

backup_date No

configuration_object_tag No

creation_date No

date_released No

ead_paragraph No

elemId Yes

global_alt_list No

gov_classification No

has_variant_module No

ip_classification No

is_configuration_item No

is_vi No

island_id Yes

item_id Yes

last_mod_date No

last_mod_user Yes Points to the User element in

the TC XML file.

license_list No

lsd No

object_application Yes Typically set to Teamcenter.

object_desc No

object_name Yes

object_properties No

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-33

© 2020 Siemens
 5. Loading bulk data

Attribute Mandatory Comments

object_type Yes

owning_group Yes Points to the Group element

in the TC XML file.

owning_organization No

owning_project No

owning_site Yes Points to the POM_imc

element in the TC XML file.

owning_user Yes Points to the User element in

the TC XML file.

parent_uid Yes

pid No Class-id. Fast import ignores

this attribute.

preferred_global_alt No

process_stage_list No

project_list No

puid Yes

release_status_list No

revision_limit Yes Typically set to 1.

revision_number Yes Typically set to 0.

timestamp No

uom_tag No

wso_thread No

Anchor elements

Attribute Mandatory Comments

acl_bits No

archive_date No

archive_info No

backup_date No

5-34 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Teamcenter core data dictionary

Attribute Mandatory Comments

creation_date No

elemId Yes

immune_objects No

island_id Yes

keep_limit Yes Typically set to 3.

last_mod_date No

last_mod_user Yes Points to the User element

in the TC XML file.

lsd No

managed_objects No

object_properties No

owning_group Yes Points to the Group element

in the TC XML file.

owning_user Yes Points to the User element

in the TC XML file.

owning_site Yes Points to the POM_imc

element in the TC XML file.

parent_uid Yes

puid Yes

ItemRevision attributes

Attribute Mandatory Comments

acl_bits No

active_seq No

archive_date No

archive_info No

backup_date No

creation_date No

date_released No

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-35

© 2020 Siemens
 5. Loading bulk data

Attribute Mandatory Comments

declared_options No

ead_paragraph No

elemId Yes

gde_bvr_list No

gov_classification No

has_variant_module No

ip_classification No

island_id Yes

item_revision_id Yes

items_tag Yes Holds the PUID value of the

corresponding Item.

last_mod_date No

last_mod_user Yes Points to the User element

in the TC XML file.

license_list No

lsd No

object_application No

object_desc No

object_name Yes

object_properties No

object_type Yes

owning_group Yes Points to the Group element

in the TC XML file.

owning_organization No

owning_project No

owning_site Yes Points to the POM_imc

element in the TC XML file.

owning_user Yes Points to the User element

in the TC XML file.

parent_uid Yes

5-36 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Teamcenter core data dictionary

Attribute Mandatory Comments

pid Yes The class-id. Fast import

ignores the attribute.

process_stage_list No

project_list No

puid Yes

release_status_list No

revision_limit Yes Typically set to 1.

revision_number Yes Typically set to 0.

sequence_anchor Yes Holds the PUID value of the

corresponding Anchor
element.

sequence_id Yes Typically set to 1.

sequence_limit Yes Typically set to 3.

timestamp No

used_options No

variant_expression_block No

wso_thread No

Form attributes

Attribute Mandatory Comments

acl_bits No

active_seq No

archive_date No

archive_info No

backup_date No

creation_date No

data_file No

date_released No

ead_paragraph No

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-37

© 2020 Siemens
 5. Loading bulk data

Attribute Mandatory Comments

elemId Yes

form_file Yes Typically set to n/a.

gov_classification No

ip_classification No

island_id Yes

last_mod_date No

last_mod_user Points to the User element

in the TC XML file.

license_list No

lsd No

object_application Yes Typically set to Teamcenter.

object_desc No

object_name Yes

object_properties No

object_type Yes

owning_group Yes Points to the Group element

in the TC XML file.

owning_organization No

owning_project No

owning_user Yes Points to the User element

in the TC XML file.

owning_site Yes Points to the POM_imc

element in the TC XML file.

parent_uid Yes

pid Yes The class-id. Fast import

ignores the attribute.

process_stage_list No

project_list No

puid Yes

release_status_list No

5-38 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Teamcenter core data dictionary

Attribute Mandatory Comments

revision_limit Yes Typically set to 1.

revision_number Yes Typically set to 0.

timestamp No

wso_thread No

ImanRelation attributes

Attribute Mandatory Comments

elemId Yes

island_id Yes

lsd No

object_properties No

owning_site Yes Points to the POM_imc

element in the TC XML file.

parent_uid Yes

pid Yes The class-id attribute. Fast

Import ignores the attribute.

primary_object Yes Holds the PUID value of the

primary object of the
ImanRelation object.

puid Yes

relation_type Yes Points to the corresponding

ImanType element in the TC
XML file.

secondary_object Yes Holds the PUID value of the

secondary object of the
ImanRelation object.

timestamp No

user_data No

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-39

© 2020 Siemens
 5. Loading bulk data

PSBOMView attributes

Attribute Mandatory Comments

acl_bits No

active_seq No

archive_date No

archive_info No

backup_date No

creation_date No

date_released No

ead_paragraph No

elemId Yes

gov_classification No

ip_classification No

island_id Yes

last_mod_date No

last_mod_user Yes Points to the User element

in the TC XML file.

license_list No

lsd No

object_application Yes Typically set to Teamcenter.

object_desc No

object_name Yes

object_properties No

owning_site Yes Points to the POM_imc

element in the TC XML file.

object_type Yes

owning_group Yes Points to the Group element

in the TC XML file.

owning_user Yes Points to the User element

in the TC XML file.

5-40 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Teamcenter core data dictionary

Attribute Mandatory Comments

parent_item Yes

parent_uid Yes

pid No The class-id attribute. Fast

Import ignores the attribute.

process_stage_list No

project_list No

puid Yes

release_status_list No

revision_limit Yes Typically set to 1.

revision_number Yes Typically set to 0.

timestamp No

view_type Yes Points to the PSViewType

element in the TC XML file.

wso_thread No

PSBOMViewRevision attributes

Attribute Mandatory Comments

acl_bits No

active_seq No

archive_date No

archive_info No

backup_date No

bom_view Yes Points the PUID value of the

corresponding PSBOMView
element.

creation_date No

date_released No

ead_paragraph No

elemId Yes

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-41

© 2020 Siemens
 5. Loading bulk data

Attribute Mandatory Comments

gov_classification No

island_id Yes

is_precise Yes Typically set to 0.

ip_classification No

last_mod_date No

last_mod_user Yes Points to the User element

in the TC XML file.

license_list No

lsd No

object_application Yes Typically set to Teamcenter.

object_desc No

object_name Yes

object_properties No

object_type Yes

owning_group Yes Points to the Group element

in the TC XML file.

owning_organization No

owning_project No

owning_site Yes Required for LL TC XML.

Points to the POM_imc
element in the TC XML file.

owning_user Yes Points to the User element

in the TC XML file.

parent_uid Yes

pid Yes

process_stage_list No

project_list No

puid Yes

release_status_list No

revision_limit Yes Typically set to 1.

5-42 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Teamcenter core data dictionary

Attribute Mandatory Comments

revision_number Yes Typically set to 0.

struct_last_mod_date Yes

timestamp No

wso_thread No

PSOccurrence attributes

Attribute Mandatory Comments

alternate_etc_ref No

child_item Yes Points the PUID value of the

corresponding item.

child_bv No

effectivities No

elemId Yes

island_id Yes

lsd No

notes_ref No

object_properties No

occ_thread Yes Points the PUID value of the

corresponding
PSOccurrenceThread
element in the TC XML file.

occ_flags No

occ_type No

occurrence_type No

order_no No Typically set to 10.

owning_site Yes Points to the POM_imc

element in the TC XML file.

parent_bvr Yes Points the PUID value of the

corresponding
PSBOMViewRevision
element in the TC XML file.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-43

© 2020 Siemens
 5. Loading bulk data

Attribute Mandatory Comments

parent_uid Yes Required for low-level TC

XML schema.

pid No

pred_list No

puid Yes

qty_value No Typically set to -1.

seq_no Yes Typically set to 10.

timestamp No

uom_tag No

used_options No

variant_condition No

xform No

PSOccurenceThread attributes

Attribute Mandatory Comments

clone_stable_occ_uid No

elemId Yes

island_id Yes

lsd No

object_properties No

owning_site Yes Points to the POM_imc

element in the TC XML file.

parent_uid Yes

pid Yes The class-id attribute. Fast

import ignores this attribute.

puid Yes

timestamp No

5-44 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Teamcenter core data dictionary

Dataset attributes

Attribute Mandatory Comments

acl_bits No

active_seq No

archive_date No

archive_info No

backup_date No

creation_date No

dataset_type Yes Points to the DatasetType

element in the TC XML file.

date_released No

ead_paragraph No

elemId Yes

format_used No

gov_classification No

ip_classification No

island_id Yes

last_mod_date No

last_mod_user Yes Points to the User element

in the TC XML file.

license_list No

local_path No

lsd No

markup_acl No

markup_create_tool No

markup_official No

markup_status No

object_application Yes Typically set to Teamcenter.

object_desc No

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-45

© 2020 Siemens
 5. Loading bulk data

Attribute Mandatory Comments

object_name Yes

object_properties No

object_type Yes

owning_organization No

owning_project No

owning_group Yes Points to the Group element

in the TC XML file.

owning_site Yes Points to the POM_imc

element in the TC XML file.

owning_user Yes Points to the User element

in the TC XML file.

parent_uid Yes

pid No

process_stage_list No

project_list No

puid Yes

ref_names No

ref_list Yes Holds the PUID value of the

corresponding ImanFile
element in the TC XML file.

ref_types No

release_status_list No

rev_chain_anchor Yes Holds the PUID value of the

corresponding
RevisionAnchor element in
the TC XML file.

revision_limit Yes Typically set to 1.

revision_number Yes Typically set to 0.

system_managed No

tool_used Yes Points to the Tool element in

the TC XML file.

timestamp No

5-46 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Teamcenter core data dictionary

Attribute Mandatory Comments

user_class No

wso_thread No

RevisionAnchor attributes

Attribute Mandatory Comments

acl_bits No

archive_date No

archive_info No

backup_date No

creation_date No

elemId Yes

highest_rev Yes Typically set to 1.

id No

island_id Yes

keep_limit Yes Typically set to 3.

last_mod_date No

last_mod_user Yes Points to the User element in

the TC XML file.

lsd No

object_properties No

owning_group Yes Points to the Group element

in the TC XML file.

owning_user Yes Points to the User element in

the TC XML file.

owning_site Yes Points to the POM_imc

element in the TC XML file.

parent_uid Yes

pid Yes

puid Yes

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-47

© 2020 Siemens
 5. Loading bulk data

Attribute Mandatory Comments

rev No

revisions Yes Holds the values of the

corresponding Dataset
revisions.

timestamp No

ImanFile attributes

Attribute Mandatory Comments

acl_bits No

archive_date No

archive_info No

backup_date No

creation_date No

destination_volume_tag No

elemId Yes

file_name Yes

hsm_info No

island_id Yes

last_mod_date No

last_mod_user Yes Points to the User element

in the TC XML file.

lsd No

machine_type No

object_properties No

original_file_name No

owning_group Yes Points to the Group element

in the TC XML file.

owning_user Yes Points to the User element

in the TC XML file.

5-48 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Teamcenter core data dictionary

Attribute Mandatory Comments

owning_site Yes Points to the POM_imc

element in the TC XML file.

parent_uid Yes

pid Yes The class-id attribute. Fast

import ignores this attribute.

puid Yes

relative_directory_path No

released_version No

sd_path_name Yes Contains the relative path of

the legacy file from the
logical volume root.

status_flag No

store_and_forward_flag No

text_flag No

time_last_modified No

timestamp No

translate No

volume_tag Yes Points to the ImanVolume

element in the TC XML file.

vm_info No

User attributes

Attribute Mandatory Comments

elemId Yes

island_id Yes

user_id Yes Candidate key

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-49

© 2020 Siemens
 5. Loading bulk data

Group attributes

Attribute Mandatory Comments

elemId Yes

island_id Yes

name Yes Candidate key

Tool attributes

Attribute Mandatory Comments

elemId Yes

island_id Yes

object_name Yes Candidate key

ImanType attributes

Attribute Mandatory Comments

elemId Yes

island_id Yes

type_class Yes Candidate key

type_name Yes Candidate key

ImanVolume attributes

Attribute Mandatory Comments

elemId Yes

island_id Yes

volume_name Yes Candidate key

5-50 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Teamcenter data model diagram

DataseType attributes

Attribute Mandatory Comments

elemId Yes

datasettype_name Yes Candidate key

island_id Yes

Teamcenter data model diagram

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-51

© 2020 Siemens
 5. Loading bulk data

Sample assembly structure in a TC XML file

The structure in the following figure is a simple one-level bill of material (BOM) structure where:

• The Top_item object is the parent item.

• The Child_1 and Child_2 objects are the children of the Top_item object.
• A dataset is attached to the Child_1 object.

Top_item/A;1(view)
Child_1/A;1
Child_2/A;1

The expanded view of the Top_item object and its children includes the dataset object attached to the
Child_1 object:

5-52 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Sample TC XML file with GSID references

The following figure shows the relationships between the objects.

Sample TC XML file with GSID references

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
- <TCXML xmlns="[Link]
- <Group elemId="id1" island_id="0" name="dba">
<GSIdentity elemId="id75" label="LegacyIDid75one" />
</Group>
- <ImanType elemId="id2" island_id="0" type_class="ImanRelation"
type_name="IMAN_master_form">
<GSIdentity elemId="id76" label="LegacyIDid76one" />
</ImanType>

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-53

© 2020 Siemens
 5. Loading bulk data

- <User elemId="id3" island_id="0" user_id="infodba">

<GSIdentity elemId="id77" label="LegacyIDid77one" />
</User>
- <PSViewType elemId="id4" island_id="0" name="view">
<GSIdentity elemId="id78" label="LegacyIDid78one" />
</PSViewType>
+ <POM_imc elemId="id5" island_id="0" site_id="-1589622576">
+ <ItemRevision acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:23:07Z" date_released="" declared_options=""
ead_paragraph="" elemId="id6"
gde_bvr_list="" gov_classification="" has_variant_module="" ip_classification=""
island_id="5"
item_revision_id="A" items_tag="#id81" last_mod_date="2010-09-29T10:23:07Z"
last_mod_user="#id77"
license_list="" lsd="2010-09-29T10:23:07Z" object_application="Teamcenter" object_desc=""
object_name="onec" object_properties="0" object_type="ItemRevision" owning_group="#id75"
owning_organization="" owning_project="" owning_user="#id77" parent_uid="#id81" pid="758"
process_stage_list="" project_list="" release_status_list="" revision_limit="1"
revision_number="0"
sequence_anchor="#id82" sequence_id="1" sequence_limit="3" timestamp="QpHx6UvxI45M1A"
used_options=""
variant_expression_block="" wso_thread="">
- <Item acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
configuration_object_tag=""
creation_date="2010-09-29T10:23:06Z" date_released="" ead_paragraph="" elemId="id7"
global_alt_list=""
gov_classification="" has_variant_module="" ip_classification="" is_configuration_item=""
is_vi=""
island_id="5" item_id="onec" last_mod_date="2010-09-29T10:23:07Z" last_mod_user="#id77"
license_list=""
lsd="2010-09-29T10:23:07Z" object_application="Teamcenter" object_desc=""
object_name="onec"
object_properties="0" object_type="Item" owning_group="#id75" owning_organization=""
owning_project=""
owning_user="#id77" parent_uid="" pid="564" preferred_global_alt="" process_stage_list=""
project_list=""
release_status_list="" revision_limit="1" revision_number="0" timestamp="QpIx6UvxI45M1A"
uom_tag=""
wso_thread="">
<GSIdentity elemId="id81" label="LegacyIDid81one" />
</Item>
- <Anchor acl_bits="0" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:23:07Z"
elemId="id8" immune_objects="" island_id="5" keep_limit="3"
last_mod_date="2010-09-29T10:23:07Z"
last_mod_user="#id77" lsd="2010-09-29T10:23:07Z" managed_objects="" object_properties="0"
owning_group="#id75" owning_user="#id77" parent_uid="#id80" pid="520"
timestamp="QlMx6UvxI45M1A">
<GSIdentity elemId="id82" label="LegacyIDid82one" />
</Anchor>
- <ImanRelation elemId="id9" island_id="5" lsd="2010-09-29T10:23:06Z" object_properties="0"
parent_uid="#id81"
pid="443" primary_object="#id81" relation_type="#id76" secondary_object="#id85"
timestamp="QhGx6UvxI45M1A"
user_data="">
<GSIdentity elemId="id83" label="LegacyIDid83one" />
</ImanRelation>
- <ImanRelation elemId="id10" island_id="5" lsd="2010-09-29T10:23:07Z" object_properties="0"
parent_uid="#id80"
pid="443" primary_object="#id80" relation_type="#id76" secondary_object="#id86"

5-54 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Sample TC XML file with GSID references

timestamp="QpEx6UvxI45M1A"
user_data="">
<GSIdentity elemId="id84" label="LegacyIDid84one" />
</ImanRelation>
- <Form acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:23:06Z" data_file="" date_released="" ead_paragraph=""
elemId="id11"
form_file="n/a" gov_classification="" ip_classification="" island_id="5"
last_mod_date="2010-09-29T10:23:06Z" last_mod_user="#id77" license_list=""
lsd="2010-09-29T10:23:06Z"
object_application="Teamcenter" object_desc="" object_name="onec" object_properties="0"
object_type="Item Master" owning_group="#id75" owning_organization="" owning_project=""
owning_user="#id77"
parent_uid="#id83" pid="555" process_stage_list="" project_list="" release_status_list=""
revision_limit="1" revision_number="0" timestamp="QdEx6UvxI45M1A" wso_thread="">
<GSIdentity elemId="id85" label="LegacyIDid85one" />
</Form>
- <Form acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:23:07Z" data_file="" date_released="" ead_paragraph=""
elemId="id12"
form_file="n/a" gov_classification="" ip_classification="" island_id="5"
last_mod_date="2010-09-29T10:23:07Z" last_mod_user="#id77" license_list=""
lsd="2010-09-29T10:23:07Z"
object_application="Teamcenter" object_desc="" object_name="onec/A" object_properties="0"
object_type="ItemRevision Master" owning_group="#id75" owning_organization=""
owning_project=""
owning_user="#id77" parent_uid="#id84" pid="555" process_stage_list="" project_list=""
release_status_list="" revision_limit="1" revision_number="0" timestamp="QpBx6UvxI45M1A"
wso_thread="">
<GSIdentity elemId="id86" label="LegacyIDid86one" />
</Form>
- <ItemRevision acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:23:35Z" date_released="" declared_options=""
ead_paragraph="" elemId="id13"
gde_bvr_list="" gov_classification="" has_variant_module="" ip_classification=""
island_id="3"
item_revision_id="A" items_tag="#id88" last_mod_date="2010-09-29T10:24:26Z"
last_mod_user="#id77"
license_list="" lsd="2010-09-29T10:24:26Z" object_application="Teamcenter" object_desc=""
object_name="one" object_properties="0" object_type="ItemRevision" owning_group="#id75"
owning_organization="" owning_project="" owning_user="#id77" parent_uid="#id88" pid="758"
process_stage_list="" project_list="" release_status_list="" revision_limit="1"
revision_number="0"
sequence_anchor="#id93" sequence_id="1" sequence_limit="3" structure_revisions="#id92"
timestamp="gBLx6UvxI45M1A" used_options="" variant_expression_block="" wso_thread="">
<GSIdentity elemId="id87" label="LegacyIDid87one" />
</ItemRevision>
- <Item acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
bom_view_tags="#id90"
configuration_object_tag="" creation_date="2010-09-29T10:23:35Z" date_released=""
ead_paragraph=""
elemId="id14" global_alt_list="" gov_classification="" has_variant_module=""
ip_classification=""
is_configuration_item="" is_vi="" island_id="3" item_id="one"
last_mod_date="2010-09-29T10:24:26Z"
last_mod_user="#id77" license_list="" lsd="2010-09-29T10:24:26Z"
object_application="Teamcenter"
object_desc="" object_name="one" object_properties="0" object_type="Item"
owning_group="#id75"
owning_organization="" owning_project="" owning_user="#id77" parent_uid="" pid="564"

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-55

© 2020 Siemens
 5. Loading bulk data

preferred_global_alt="" process_stage_list="" project_list="" release_status_list=""

revision_limit="1"
revision_number="0" timestamp="gBMx6UvxI45M1A" uom_tag="" wso_thread="">
<GSIdentity elemId="id88" label="LegacyIDid88one" />
</Item>
- <PSOccurrence alternate_etc_ref="" child_bv="" child_item="#id81" effectivities=""
elemId="id15"
island_id="3" lsd="2010-09-29T10:24:26Z" notes_ref="" object_properties="0" occ_flags="0"
occ_thread="#id91" occ_type="" occurrence_type="0" order_no="10" parent_bvr="#id92"
parent_uid="#id92"
pid="783" pred_list="" qty_value="-1" seq_no="10" timestamp="gBEx6UvxI45M1A" uom_tag=""
used_options=""
variant_condition="" xform="">
<GSIdentity elemId="id89" label="LegacyIDid89one" />
</PSOccurrence>
- <PSBOMView acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:24:16Z" date_released="" ead_paragraph="" elemId="id16"
gov_classification="" ip_classification="" island_id="3"
last_mod_date="2010-09-29T10:24:16Z"
last_mod_user="#id77" license_list="" lsd="2010-09-29T10:24:16Z"
object_application="Teamcenter"
object_desc="" object_name="one-View" object_properties="0" object_type="BOMView"
owning_group="#id75"
owning_organization="" owning_project="" owning_user="#id77" parent_item="#id88"
parent_uid="#id88"
pid="594" process_stage_list="" project_list="" release_status_list="" revision_limit="1"
revision_number="0" timestamp="Q5Nx6UvxI45M1A" view_type="#id78" wso_thread="">
<GSIdentity elemId="id90" label="LegacyIDid90one" />
</PSBOMView>
- <PSOccurrenceThread clone_stable_occ_uid="AAAAAAAAAAAAAA" elemId="id17" island_id="3"
lsd="2010-09-29T10:24:26Z" object_properties="0" parent_uid="#id89" pid="256"
timestamp="gBDx6UvxI45M1A">
<GSIdentity elemId="id91" label="LegacyIDid91one" />
</PSOccurrenceThread>
- <PSBOMViewRevision acl_bits="0" active_seq="1" archive_date="" archive_info=""
backup_date=""
bom_view="#id90" creation_date="2010-09-29T10:24:17Z" date_released="" ead_paragraph=""
elemId="id18"
gov_classification="" ip_classification="" is_precise="0" island_id="3"
last_mod_date="2010-09-29T10:24:26Z" last_mod_user="#id77" license_list=""
lsd="2010-09-29T10:24:26Z"
object_application="Teamcenter" object_desc="" object_name="one/A-View"
object_properties="0"
object_type="BOMView Revision" owning_group="#id75" owning_organization=""
owning_project=""
owning_user="#id77" parent_uid="#id87" pid="595" process_stage_list="" project_list=""
release_status_list="" revision_limit="1" revision_number="0"
struct_last_mod_date="2010-09-29T10:24:26Z"
timestamp="gBCx6UvxI45M1A" wso_thread="">
<GSIdentity elemId="id92" label="LegacyIDid92one" />
</PSBOMViewRevision>
- <Anchor acl_bits="0" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:23:35Z"
elemId="id19" immune_objects="" island_id="3" keep_limit="3"
last_mod_date="2010-09-29T10:23:35Z"
last_mod_user="#id77" lsd="2010-09-29T10:23:35Z" managed_objects="" object_properties="0"
owning_group="#id75" owning_user="#id77" parent_uid="#id87" pid="520"
timestamp="QtIx6UvxI45M1A">
<GSIdentity elemId="id93" label="LegacyIDid93one" />
</Anchor>

5-56 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Sample TC XML file with GSID references

- <ImanRelation elemId="id20" island_id="3" lsd="2010-09-29T10:23:35Z" object_properties="0"

parent_uid="#id88"
pid="443" primary_object="#id88" relation_type="#id76" secondary_object="#id96"
timestamp="QtCx6UvxI45M1A"
user_data="">
<GSIdentity elemId="id94" label="LegacyIDid94one" />
</ImanRelation>
- <ImanRelation elemId="id21" island_id="3" lsd="2010-09-29T10:23:35Z" object_properties="0"
parent_uid="#id87"
pid="443" primary_object="#id87" relation_type="#id76" secondary_object="#id97"
timestamp="QtPx6UvxI45M1A"
user_data="">
<GSIdentity elemId="id95" label="LegacyIDid95one" />
</ImanRelation>
- <Form acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:23:35Z" data_file="" date_released="" ead_paragraph=""
elemId="id22"
form_file="n/a" gov_classification="" ip_classification="" island_id="3"
last_mod_date="2010-09-29T10:23:35Z" last_mod_user="#id77" license_list=""
lsd="2010-09-29T10:23:35Z"
object_application="Teamcenter" object_desc="" object_name="one" object_properties="0"
object_type="Item Master" owning_group="#id75" owning_organization="" owning_project=""
owning_user="#id77"
parent_uid="#id94" pid="555" process_stage_list="" project_list="" release_status_list=""
revision_limit="1" revision_number="0" timestamp="QpPx6UvxI45M1A" wso_thread="">
<GSIdentity elemId="id96" label="LegacyIDid96one" />
</Form>
- <Form acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:23:35Z" data_file="" date_released="" ead_paragraph=""
elemId="id23"
form_file="n/a" gov_classification="" ip_classification="" island_id="3"
last_mod_date="2010-09-29T10:23:35Z" last_mod_user="#id77" license_list=""
lsd="2010-09-29T10:23:35Z"
object_application="Teamcenter" object_desc="" object_name="one/A" object_properties="0"
object_type="ItemRevision Master" owning_group="#id75" owning_organization=""
owning_project=""
owning_user="#id77" parent_uid="#id95" pid="555" process_stage_list="" project_list=""
release_status_list="" revision_limit="1" revision_number="0" timestamp="QtMx6UvxI45M1A"
wso_thread="">
<GSIdentity elemId="id97" label="LegacyIDid97one" />
</Form>
- <Header author="infodba" date="2010-09-29" elemId="id24" originatingSite="-2132200621"
targetSite=""
time="15:58:52">
- <TransferFormula elemId="id25">
- <OptionSet elemId="id26" name="SiteConsolidationDefault">
<Option elemId="id27" name="internalClosureRule" value="True" />
<Option elemId="id28" name="opt_entire_bom" value="True" />
<Option elemId="id29" name="opt_entire_mse" value="False" />
<Option elemId="id30" name="opt_ixr_islanchor" value="False" />
<Option elemId="id31" name="opt_mechatro" value="False" />
<Option elemId="id32" name="opt_res_audit" value="True" />
<Option elemId="id33" name="opt_res_checkout" value="False" />
<Option elemId="id34" name="opt_varexp_islanchor" value="True" />
</OptionSet>
- <SessionOptions elemId="id35">
<Option elemId="id36" name="fastStream" value="yes" />
</SessionOptions>
<TransferMode elemId="id37" object_name="SiteConsolidationDefaultTM" />
<Reason elemId="id38" />

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-57

© 2020 Siemens
 5. Loading bulk data

</TransferFormula>
</Header>
</TCXML>

Pre-import validation

Pre-import validation utility

The TC XML file generated by the custom mapping solution needs to be validated to ensure that it is
constructed properly for consumption by fast import. The tcxml_validate utility serves this purpose by
performing the following validations:

1. Checks for well-formed XML.

2. Validates XML against XML schema.

3. Checks for well-formed and valid UIDs.

4. Validates typed and untyped references.

5. Checks for missing attributes,

6. Checks for required helper objects configured by closure rules.

7. Checks for conformance to GRM rules.

Required schema

The tcxml_validate utility uses the [Link] schema to validate the input files. This file must be
in the TC_DATA directory. To generate this file and enable schema validation:

Note:
The URIs that appear in the headers of PLM XML and TC XML files serve as namespace names, are
unique identifiers for an XML vocabulary. Although they are URIs, they are not used to identify and
retrieve web addresses.

1. Use the bmide_generatetcplmxmlschema utility to generate the file for your Teamcenter site, for
example:

bmide_generatetcplmxmlschema -u=infodba -p=infodba -g=dba

-schema_type=llschema

The utility may take a few minutes to finish and displays some information in the command shell,
for example:

5-58 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Required helper objects

C:\apps\tc\tc900\TR\bin>bmide_generatetcplmxmlschema -u=infodba -p=infodba -g=dba

-schema_type=llschema

Extracting....

Extraction Completed.

Extracting Localizations....

Localization Extraction Completed.

Please refer [C:\Temp\2\business_model_extractor_2011_05_11_13-[Link]] for

log information

Siemens and the Siemens logo are registered trademarks of Siemens AG. UGS,
Teamcenter and UGS Teamcenter are trademarks or registered trademarks
of UGS Corp. or its subsidiaries in the U.S. and other countries. This
software and related documentation are proprietary to UGS Corp.
Copyright ⌐ 2007 UGS Corp. All rights reserved.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*************************************************
* WARNING - TCTYPE_add_runtime_property is deprecated in
* Teamcenter version Tc8.3
* and no longer supported in Tc10
* Replace this call to TCTYPE_add_runtime_property with Define Runtime
* Properties from BMIDE
*************************************************

C:\apps\tc\tc900\TR\bin>

2. Verify the [Link] file is in the TC_DATA directory.

If it is not, verify you have the Business Modeler IDE application properly installed and rerun the
utility.

3. Set the Teamcenter TIE_validate_xml_against_schema preference to true.

Required helper objects

You use closure rules define the objects that are mandatory to form a valid data model at your
Teamcenter site. The standard (OOTB) closure rules are marked by the required (R) predicate. Any new
closure rule clauses you add for custom data model objects must be marked with the required predicate

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-59

© 2020 Siemens
 5. Loading bulk data

by suffixing the clause with :R. For example, the following explains the standard closure rule clauses for
ItemRevision and Variant class objects

Every ItemRevision object must have an Item object represented by the following clause with the :R
predicate:

[Link]:[Link]:ATTRIBUTE.items_tag:PROCESS+TRAVERSE: :I+R

Every Variant object must have a parent_Item object represented by:

[Link]:[Link]:REFBY.parent_item:PROCESS+TRAVERSE: :R

Validate your TC XML test files

Use tcxml_validate utility to validate the TC XML file generated by the custom mapping solution. When
you first run the utility, use input files that have small data samples to verify the correctness of the
custom mapping solution.

The input-file-name_validator.log contains a report of any errors found in the input TC XML file. Your
mapping solution must be fixed to clear these errors. After correcting the custom mapping, rerun the
tcxml_validate utility to validate the fixes. Use this process recursively on a small, but representative,
set of data. Continue the process until the mapping solution is perfected. Once all aspects of the
mapping are correct, the TC XML files can be generated in bulk by the mapping solution.

Note:
You cannot use the tcxml_validate utility on very large TC XML files. It is limited to files
containing approximately 2500 elements.

Tip:
The tcxml_validate utility is intended as a tool used to perfect your custom mapping solution. It is
not intended to be used on all TC XML files before they are imported.

For a complete description of the tcxml_validate utility, including syntax and examples, see the Utilities
Reference.

Pre-import validation logs

The tcxml_validate utility creates a log file containing the results of validation at the location of the
input TC XML file. The file naming convention is input-xml-file_validator.log.

The log file contains the errors found for an XML element along with the details such as Object UID,
Class, Island-id, and parent object. The values for an element are separated by pipe symbol (|). The log
file can be imported into an Excel worksheet. Set the delimiter to a bar (|) or pipe character when
importing it into Excel for better readability. The following figure shows a sample log after it is imported
into Excel:

5-60 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Bulk loader utility

Validation log file in Excel

Caution:
On Windows systems, when schema validation is used and the TC XML elements have some
mandatory attributes missing, an exact error message is not included in the log file. However, the
log file contains the line number and column number of the missing attributes in the file, for
example:

TIEFastImportSAXHandler Error: [] encountered in xml at line

[17] and column [898]. May have encountered some invalid
characters or missing some required attributes - but anyway
attempting to continue processing...

To determine the missing mandatory attributes, check the element listed in the indicated line and
see the appropriate object table in Teamcenter core data dictionary.

Bulk load data

Bulk loader utility

The tcxml_import utility in bulk loader mode imports legacy data in a TC XML file into Teamcenter. The
utility can be run only by a system administrator (Teamcenter user in the dba group) and requires a
license from GTAC. The objects are imported as local objects by providing the -bulk_load argument. In
case of any failures during import, a file with failed islands is created in the same location as that of the
TC XML input file.

For bulk loading using the tcxml_import utility:

Note:
The -h (help) argument output and the syntax defined for this utility in the Utilities Reference
contain arguments not listed here. Those arguments are for regular imports of TC XML data, not
bulk loading of legacy data, and are ignored when the –bulk_load argument is used.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-61

© 2020 Siemens
 5. Loading bulk data

Syntax

tcxml_import [-u=user-id {-p=password | -pf=password-file} -g=group]

-file=xml-file-name -site=site-name
-bulk_load
[-h]

Arguments

-u
Specifies the user ID.

This is generally infodba or another user with administration privileges. If this argument is used
without a value, the operating system user name is used.

Note:
If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments
are authenticated externally through SSO rather than being authenticated against the
Teamcenter database. If you do not supply these arguments, the utility attempts to join an
existing SSO session. If no session is found, you are prompted to enter a user ID and password.

-p
Specifies the password.

If used without a value, the system assumes a null value. This argument is mutually exclusive with
the -pf argument.

If this argument is not used, the system assumes the user-id value to be the password.
-pf
Specifies the password file. This file can be created manually, or using Teamcenter Environment
Manager.

• If created manually, the file must be a single-line ASCII file containing the password in clear text.

• If created through Teamcenter Environment Manager, the wizard prompts you for a password and
creates the password file during installation.

If used without a value, the system assumes a null value. If this argument is not used, the system
assumes the user-id value to be the password.

This argument is mutually exclusive with the -p argument.

-g
Specifies the group associated with the user.

5-62 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Bulk loader utility

If used without a value, the user's default group is assumed.

-file
Specifies the input TC XML file containing the objects to be imported into Teamcenter.
-site
Specifies the master exporting site from input TC XML data is generated.
-bulk_load
Performs a fast import using POM level APIs of a file containing legacy data objects. The file must
conform to the TC XML low-level data format. You must specify the -file and -site arguments. If you
specify any other optional arguments they are ignored. See restrictions.
-h
Displays help for this utility.

Restrictions

1. Using POM level APIs ensures the overall integrity of the data (referential integrity, type safety, and
so forth). However, the tcxml_import utility does not verify adherence to business rules. You must
identify these types of errors and fix them during the pre-import process.

2. When importing a PSOccurrence object, the import file must contain the following attributes:

• xform
• notes_ref
• child_bv
• variant_condition
• alternate_etc_ref

3. When importing a workspace object, the following properties must be present in the import file:

• uom_tag
• configuration_object_tag

Examples

• To import legacy objects from the [Link] file into the Teamcenter site where you run the utility:

tcxml_import —u=infodba –p=infodba –file=D:\Temp\[Link]

–bulk_load –site=-2140766078

The following files are created at the same location as the input XML file:

• Item32_importer.log
Contains the import process details.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-63

© 2020 Siemens
 5. Loading bulk data

• Item32_pretraverse.log
Contains the results of pre-traversal performed at the importing site.

• Item32_import_results.txt
Contains the import status (success or failure of island).

• Item32_repeat.xml

Note:
This file is created only when failures occur during the import process.

Contains data for the failed islands, along with all organizational elements and headers.
Additionally it has a comment tag to display the failure message.

• To upload dataset files from a local directory into the importing site when the [Link] file
contains ImanFile elements:

tcxml_import —u=infodba –p=infodba –file=D:\Temp\[Link] –bulk_load

Sample bulk load repeat file

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
- <TCXML xmlns="[Link]
- <!--
Summary of island failure errors: Failed with Error The instance cannot be saved because
it contains at least
one attribute that violates a unique attribute rule.(515106) for Island: 3(Principal
Object:gYAx6YHEaQAhNA)
-->
- <Group elemId="id1" island_id="0" name="dba">
<GSIdentity elemId="id75" label="LegacyIDid75one" />
</Group>
- <ImanType elemId="id2" island_id="0" type_class="ImanRelation"
type_name="IMAN_master_form">
<GSIdentity elemId="id76" label="LegacyIDid76one" />
</ImanType>
- <User elemId="id3" island_id="0" user_id="infodba">
<GSIdentity elemId="id77" label="LegacyIDid77one" />
</User>
- <PSViewType elemId="id4" island_id="0" name="view">
<GSIdentity elemId="id78" label="LegacyIDid78one" />
</PSViewType>
- <POM_imc elemId="id5" island_id="0" site_id="-1589622576">
<GSIdentity elemId="id79" label="LegacyIDid79one" />
</POM_imc>
- <ItemRevision acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:23:35Z" date_released="" declared_options=""
ead_paragraph="" elemId="id13"
gde_bvr_list="" gov_classification="" has_variant_module="" ip_classification=""
island_id="3"
item_revision_id="A" items_tag="#id88" last_mod_date="2010-09-29T10:24:26Z"

5-64 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Sample bulk load repeat file

last_mod_user="#id77"
license_list="" lsd="2010-09-29T10:24:26Z" object_application="Teamcenter" object_desc=""
object_name="one"
object_properties="0" object_type="ItemRevision" owning_group="#id75"
owning_organization=""
owning_project="" owning_user="#id77" parent_uid="#id88" pid="758" process_stage_list=""
project_list=""
release_status_list="" revision_limit="1" revision_number="0" sequence_anchor="#id93"
sequence_id="1"
sequence_limit="3" structure_revisions="#id92" timestamp="gBLx6UvxI45M1A" used_options=""
variant_expression_block="" wso_thread="">
<GSIdentity elemId="id87" label="LegacyIDid87one" />
</ItemRevision>
- <Item acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
bom_view_tags="#id90"
configuration_object_tag="" creation_date="2010-09-29T10:23:35Z" date_released=""
ead_paragraph=""
elemId="id14" global_alt_list="" gov_classification="" has_variant_module=""
ip_classification=""
is_configuration_item="" is_vi="" island_id="3" item_id="one"
last_mod_date="2010-09-29T10:24:26Z"
last_mod_user="#id77" license_list="" lsd="2010-09-29T10:24:26Z"
object_application="Teamcenter"
object_desc="" object_name="one" object_properties="0" object_type="Item"
owning_group="#id75"
owning_organization="" owning_project="" owning_user="#id77" parent_uid="" pid="564"
preferred_global_alt=""
process_stage_list="" project_list="" release_status_list="" revision_limit="1"
revision_number="0"
timestamp="gBMx6UvxI45M1A" uom_tag="" wso_thread="">
<GSIdentity elemId="id88" label="LegacyIDid88one" />
</Item>
- <PSOccurrence alternate_etc_ref="" child_bv="" child_item="gUJx6YHEaQAhNA"
effectivities="" elemId="id15"
island_id="3" lsd="2010-09-29T10:24:26Z" notes_ref="" object_properties="0" occ_flags="0"
occ_thread="#id91"
occ_type="" occurrence_type="0" order_no="10" parent_bvr="#id92" parent_uid="#id92"
pid="783" pred_list=""
qty_value="-1" seq_no="10" timestamp="gBEx6UvxI45M1A" uom_tag="" used_options=""
variant_condition=""
xform="">
<GSIdentity elemId="id89" label="LegacyIDid89one" />
</PSOccurrence>
- <PSBOMView acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:24:16Z" date_released="" ead_paragraph="" elemId="id16"
gov_classification=""
ip_classification="" island_id="3" last_mod_date="2010-09-29T10:24:16Z"
last_mod_user="#id77"
license_list="" lsd="2010-09-29T10:24:16Z" object_application="Teamcenter" object_desc=""
object_name="one-View" object_properties="0" object_type="BOMView" owning_group="#id75"
owning_organization="" owning_project="" owning_user="#id77" parent_item="#id88"
parent_uid="#id88"
pid="594" process_stage_list="" project_list="" release_status_list="" revision_limit="1"
revision_number="0" timestamp="Q5Nx6UvxI45M1A" view_type="#id78" wso_thread="">
<GSIdentity elemId="id90" label="LegacyIDid90one" />
</PSBOMView>
- <PSOccurrenceThread clone_stable_occ_uid="AAAAAAAAAAAAAA" elemId="id17" island_id="3"
lsd="2010-09-29T10:24:26Z" object_properties="0" parent_uid="#id89" pid="256"
timestamp="gBDx6UvxI45M1A">
<GSIdentity elemId="id91" label="LegacyIDid91one" />

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-65

© 2020 Siemens
 5. Loading bulk data

</PSOccurrenceThread>
- <PSBOMViewRevision acl_bits="0" active_seq="1" archive_date="" archive_info=""
backup_date=""
bom_view="#id90" creation_date="2010-09-29T10:24:17Z" date_released="" ead_paragraph=""
elemId="id18"
gov_classification="" ip_classification="" is_precise="0" island_id="3"
last_mod_date="2010-09-29T10:24:26Z"
last_mod_user="#id77" license_list="" lsd="2010-09-29T10:24:26Z"
object_application="Teamcenter"
object_desc="" object_name="one/A-View" object_properties="0" object_type="BOMView
Revision"
owning_group="#id75" owning_organization="" owning_project="" owning_user="#id77"
parent_uid="#id87"
pid="595" process_stage_list="" project_list="" release_status_list="" revision_limit="1"
revision_number="0" struct_last_mod_date="2010-09-29T10:24:26Z"
timestamp="gBCx6UvxI45M1A" wso_thread="">
<GSIdentity elemId="id92" label="LegacyIDid92one" />
</PSBOMViewRevision>
- <Anchor acl_bits="0" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:23:35Z"
elemId="id19" immune_objects="" island_id="3" keep_limit="3"
last_mod_date="2010-09-29T10:23:35Z"
last_mod_user="#id77" lsd="2010-09-29T10:23:35Z" managed_objects="" object_properties="0"
owning_group="#id75" owning_user="#id77" parent_uid="#id87" pid="520"
timestamp="QtIx6UvxI45M1A">
<GSIdentity elemId="id93" label="LegacyIDid93one" />
</Anchor>
- <ImanRelation elemId="id20" island_id="3" lsd="2010-09-29T10:23:35Z" object_properties="0"
parent_uid="#id88" pid="443" primary_object="#id88" relation_type="#id76"
secondary_object="#id96"
timestamp="QtCx6UvxI45M1A" user_data="">
<GSIdentity elemId="id94" label="LegacyIDid94one" />
</ImanRelation>
- <ImanRelation elemId="id21" island_id="3" lsd="2010-09-29T10:23:35Z" object_properties="0"
parent_uid="#id87" pid="443" primary_object="#id87" relation_type="#id76"
secondary_object="#id97"
timestamp="QtPx6UvxI45M1A" user_data="">
<GSIdentity elemId="id95" label="LegacyIDid95one" />
</ImanRelation>
- <Form acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:23:35Z" data_file="" date_released="" ead_paragraph=""
elemId="id22"
form_file="n/a" gov_classification="" ip_classification="" island_id="3"
last_mod_date="2010-09-29T10:23:35Z" last_mod_user="#id77" license_list=""
lsd="2010-09-29T10:23:35Z"
object_application="Teamcenter" object_desc="" object_name="one" object_properties="0"
object_type="Item Master" owning_group="#id75" owning_organization="" owning_project=""
owning_user="#id77" parent_uid="#id94" pid="555" process_stage_list="" project_list=""
release_status_list="" revision_limit="1" revision_number="0" timestamp="QpPx6UvxI45M1A"
wso_thread="">
<GSIdentity elemId="id96" label="LegacyIDid96one" />
</Form>
- <Form acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
creation_date="2010-09-29T10:23:35Z" data_file="" date_released="" ead_paragraph=""
elemId="id23"
form_file="n/a" gov_classification="" ip_classification="" island_id="3"
last_mod_date="2010-09-29T10:23:35Z" last_mod_user="#id77" license_list=""
lsd="2010-09-29T10:23:35Z"
object_application="Teamcenter" object_desc="" object_name="one/A" object_properties="0"
object_type="ItemRevision Master" owning_group="#id75" owning_organization=""

5-66 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Frequently asked questions

owning_project=""
owning_user="#id77" parent_uid="#id95" pid="555" process_stage_list="" project_list=""
release_status_list="" revision_limit="1" revision_number="0" timestamp="QtMx6UvxI45M1A"
wso_thread="">
<GSIdentity elemId="id97" label="LegacyIDid97one" />
</Form>
- <Header author="infodba" date="2010-09-29" elemId="id24" originatingSite="-2132200621"
targetSite=""
time="15:58:52">
- <TransferFormula elemId="id25">
- <OptionSet elemId="id26" name="SiteConsolidationDefault">
<Option elemId="id27" name="internalClosureRule" value="True" />
<Option elemId="id28" name="opt_entire_bom" value="True" />
<Option elemId="id29" name="opt_entire_mse" value="False" />
<Option elemId="id30" name="opt_ixr_islanchor" value="False" />
<Option elemId="id31" name="opt_mechatro" value="False" />
<Option elemId="id32" name="opt_res_audit" value="True" />
<Option elemId="id33" name="opt_res_checkout" value="False" />
<Option elemId="id34" name="opt_varexp_islanchor" value="True" />
</OptionSet>
- <SessionOptions elemId="id35">
<Option elemId="id36" name="fastStream" value="yes" />
</SessionOptions>
<TransferMode elemId="id37" object_name="SiteConsolidationDefaultTM" />
<Reason elemId="id38" />
</TransferFormula>
</Header>
</TCXML>

Frequently asked questions

Why is there a different referencing scheme used within the TC XML format?

For example, for the owning_user the element id is used, for the referencing items_tag, the uid of the
parent id is used. Also the parent_uid attribute is mentioned twice as items_tag and parent_uid. To be
able to separate the users/objects/relations in the loads it would be best to reference everything by the
Teamcenter UID.

<ItemRevision acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""

creation_date="2010-06-29T15:43:21Z" date_released="" declared_options=""
ead_paragraph=""
elemId="id17" gde_bvr_list="" gov_classification="" has_variant_module=""
ip_classification="" island_id="4" item_revision_id="A" items_tag="AVDxiag7I45M1A"
last_mod_date="2010-06-29T15:46:31Z" last_mod_user="#id5" license_list=""
lsd="2010-06-29T15:46:31Z" object_application="Teamcenter" object_desc=""
object_name="child1"
object_properties="0" object_type="ItemRevision" owning_group="#id1"
owning_organization=""
owning_project="" owning_user="#id5" parent_uid="AVDxiag7I45M1A" pid="758"
process_stage_list="" project_list="" puid="AVMxiag7I45M1A" release_status_list=""
revision_limit="1" revision_number="0" sequence_anchor="AVOxiag7I45M1A" sequence_id="1"
sequence_limit="3" structure_revisions="QFJxiag7I45M1A" timestamp="QNMxiag7I45M1A"
used_options="" variant_expression_block="" wso_thread=""/>

Answer — Organization and administrative objects, such as User and Group, cannot be referenced by a
UID. They have to be looked up based on their candidate key. So there is an XML element for the

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-67

© 2020 Siemens
 5. Loading bulk data

organization object with just the candidate key and element ID and all the references use the elemId
attribute to point to it.

How are the island_ids handled?

Answer — The import process collects all the objects that have the same island-id attribute and saves
them at once.

Would it be easier to handle if the header information could be written to a separate

configuration file?

Answer — The import process relies on originating site information and the session options in the
Header element. This information is read in the first pass of the XML parsing and used in the second
pass when the actual import happens.

How can we find out attributes in the TC XML are mandatory and if empty attributes can
be left out?

Answer — The fast import sets null values for missing attributes that do not have an initial value.
However, there is no straightforward way to arrive at a set of attributes that are required to be populated
for a given class. The tcxml_validate utility reports if the required typed and untyped references are
missing from the TC XML. In addition, the list of mandatory attributes for core Teamcenter classes
documented in Teamcenter core data dictionary. For other classes of interest, similar exercise must be
done as part of the customization work.

How is the timestamp generated?

Answer — The timestamp indicates when the object was last modified. The timestamp attribute takes
the form of a UID – not a date or time as might be expected. Because a UID encodes a representation of
time, it is sufficient to store a UID for this purpose. This attribute can be omitted from the TC XML. Fast
import internally generates and sets the timestamp for an object.

For generating the UID with TIE_get_hashed_uid an external ID coming from the legacy
system is needed, as well as a siteID identifying the legacy system. Are there any
requirements to the format of that external ID (field type, characters, field length, and so
forth)?

Answer — There are no restrictions on the character set or string length.

Is the hashed UID the same external ID that is also used for the enhancement of creating
the UID internally inside the bulk loader process? Or what is the format of the GSID
needed?

Answer — The GSID contains label, sublabel, and split_token attributes to allow for many-to-many
mappings. If the external ID is composed such that it is unique across the legacy data model it can be
used to populate the label attribute.

5-68 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Frequently asked questions

Must the elemId and island_id attributes be unique in a file or do they have to be unique
over all data loaded?

Answer — The elemId and island_id attributes are unique per file.

What causes errors during job scheduling and execution?

Answer — Process execution problems may occur due to available memory or maximum time-to-live
(ttl) expiration when running in the Apache ODE in memory. This issue is usually encountered when you
are running the ODE on a JBoss 5.1 application server and the ODE uses an Oracle database.

To run an ODE process in memory, uncomment or add the <in-memory>true</in-memory> element to

the ode-working-dir/processes/data-transfer/[Link] file. For more information about ODE
processes, see [Link]

If your processes may exist for longer than 10 minutes, configure the in-memory ttl to longer than 10
minutes using the [Link] property. This properties value is set in milliseconds in the
ode-working-dir/conf/[Link] file. For example, the following set the ttl to 30 minutes:

[Link]=1800000

Data Exchange, Teamcenter 12.3 PLM00094 12.3 5-69

© 2020 Siemens
 5. Loading bulk data

5-70 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 6. Copying product data
Bulk extract and load of product data use cases ────────────────── 6-1
Product data bulk extract and bulk load functions ──────────────── 6-3
Creating a test or training environment ─────────────────────── 6-4
Make a copy of your Teamcenter environment ─────────────────── 6-4
Extract product data from your production environment ──────────── 6-4
Bulk load import options ───────────────────────────────── 6-7
Load product data into your test environment ────────────────── 6-10

Data Exchange, Teamcenter 12.3 PLM00094 12.3

© 2020 Siemens
Data Exchange, Teamcenter 12.3 PLM00094 12.3
© 2020 Siemens
 6. Copying product data
Bulk extract and load of product data use cases
The primary uses cases for the bulk loading product data are:

• Seeding a developer environment for testing of customization with actual production data.

• Testing of block point releases or training users on such releases.

• Practicing upgrade of a production environment using actual production data prior to rolling out the
upgrade to the production sites.

• Troubleshooting an issue in a production environment using the actual product data in an isolated
environment.

The following graphics show the allowed and prohibited site imports using low-level bulk load.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 6-1

© 2020 Siemens
 6. Copying product data

6-2 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Product data bulk extract and bulk load functions

Product data bulk extract and bulk load functions

You can move selected product data from a production environment to test or training environment
using the bulk load features of Teamcenter. The bulk load feature is accessible using the tcxml_export
and tcxml_import utilities and uses the low-level TC XML format to quickly extract and load the selected
data. Additionally, you can access this feature using the Bulk Extract and Bulk Load commands on the
Tools menu in the rich client. Either method creates a copy of the desired data in a briefcase file that
you import into the target test site.

To bulk load product data into a site, it must be designated as a test site. You can designate a site as a
test site during the install process in Teamcenter Environment Manager (TEM). Teamcenter also provides
the -mark_as_test_env argument for the install utility that allows you to change a site created as a

Data Exchange, Teamcenter 12.3 PLM00094 12.3 6-3

© 2020 Siemens
 6. Copying product data

production environment to test environment. This can be used when a site was created using the
default (production environment) and it is subsequently determined that it must be a test environment.

Creating a test or training environment

You can create a site containing a copy of your production data for upgrade testing, acceptance testing
of customizations, or training purposes. Teamcenter Environment Manager is the recommended tool for
creating a test environment that has the features you require in your production site. Use the bulk load
feature to then extract a copy of the desired product data from the production site for the test site.

Make a copy of your Teamcenter environment

An alternative method to this procedure is to convert a production environment that matches your
Teamcenter site to a test environment using the install utility with the -mark_as_test_env argument to
convert it to a test environment.

1. Launch Teamcenter Environment Manager (TEM) from the Teamcenter installation image, not from
install directory of your existing TC_ROOT.

2. Install a Teamcenter environment that matches the solutions and features in your current
Teamcenter environment.

Follow the steps for installing a Teamcenter corporate server in the appropriate server installation
guide.

3. In the Foundation panel, accept the default Create and populate database option.

Follow the instruction for the Foundation Database and Volume Information in the appropriate
server installation guide.

4. In the Foundation Settings panel, select the Test Environment option.

Complete the installation following the instructions in the appropriate server installation guide.

Extract product data from your production environment

An alternative method to this procedure is to use the tcxml_export utility with the -bulk_extract
argument and one or more arguments that identify the root object for the extract:

• -input_criteria

• -class

• -folder

6-4 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Extract product data from your production environment

• -item

• -item_key

• -inputfile

• -inputuidfile

• -uid

To use this feature:

1. Launch the rich client for your production environment, select the objects you want to extract, and
choose Tools→Export→Bulk Extract.

2. In the Bulk Extract to Briefcase dialog box:

a. Type or navigate to the location where you want to save the briefcase file in the Directory
box.

b. Select UnconfiguredBulkExtractDefault in the Option Set list.

Teamcenter provides a default name for the briefcase file in the File Name box that you can
modify if desired. Do not change file extension.

c. If you want to change the editable UnconfiguredBulkExtractDefault export options, click the
Display/Set export options button ( ).

Tip:
If there are no changes to the Organization objects associated with the data you are
extracting, you can prevent unnecessary export of the Organization objects by clearing
the Export All Properties of Organization Object option.

Teamcenter displays the UnconfiguredBulkExtractDefault dialog box.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 6-5

© 2020 Siemens
 6. Copying product data

The Bulk Extract data to Briefcase option is selected by default and is read-only. Only the
Teamcenter site administrator can edit the read-only check boxes.

Teamcenter exports briefcase files in a compressed format to decrease the file size.
Compressing the file can be time consuming. If you want to decrease the time it takes to
create the briefcase file and are not concerned with the size of the file you are extracting,
select the Export Uncompressed Briefcase check box. This option can be set as the default
option in the option set you use to bulk extract data by setting the (opt_uncompressed_bcz
option value to TRUE.

d. Click OK to close the dialog boxes.

6-6 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Bulk load import options

Teamcenter displays the Options Settings dialog box. If the settings are correct, click Yes to
continue.

Teamcenter creates a briefcase (.bcz) file in the directory location and displays the Export
Completed dialog box indicating if the export is successful.

3. Ensure the briefcase file is in a location accessible to the test environment.

Bulk load import options

Teamcenter provides the following options for bulk loading briefcase files into a test environment:

• Import all objects as local (opt_ll_force_import_local=true)

Selecting this check box causes the test environment to be set as the owning site for all objects in the
imported briefcase file. This option is selected by default unless you administrator changes its default
value.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 6-7

© 2020 Siemens
 6. Copying product data

6-8 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Bulk load import options

• Force update all local objects (opt_ll_force_update_local=true)

Selecting this check box causes the all objects in the briefcase to be updated in the test environment.
If this is selected, objects in the import file that also exist in the test environment are replaced with
the import file objects, regardless of which one was changed last (lsd attribute). This can cause loss of
changes to previously imported objects in the test environment that have not changed in the
production environment.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 6-9

© 2020 Siemens
 6. Copying product data

If you clear both options, all replica objects are imported as replicas in the test environment. You must
be careful when you import objects from different production environments that participate in a Multi-
Site environment. This may cause site ownership conflicts.

Load product data into your test environment

An alternative method to this procedure is to use the tcxml_import utility with:

• The -bulk_load argument

• The -optionset= argument value set to a transfer option set that has the opt_bulk_load_bcz options
set to TRUE

To use this feature:

1. Launch the rich client for your test environment and choose Tools→Import→Bulk Load.

2. In the Bulk Load from Briefcase dialog box:

a. Type or navigate to the location of the briefcase file in the Briefcase File box.

b. Select BulkLoadDefault in the Option Set list.

c. If you want to change the editable BulkLoadDefault import options, click the Display/Set
import options button .

Teamcenter displays the BulkLoadDefault dialog box.

6-10 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Load product data into your test environment

The Bulk Load from Briefcase option is selected by default and is read-only. Only the
Teamcenter site administrator can edit the read-only check boxes.

3. Click OK to close the dialog boxes.

Teamcenter displays the Remote Export Options Settings dialog box. If the settings are correct,
click Yes to continue.

Teamcenter imports the product data from the briefcase file into your test environment.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 6-11

© 2020 Siemens
 6. Copying product data

6-12 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 A. Standard mapping

Data Exchange, Teamcenter 12.3 PLM00094 12.3

© 2020 Siemens
Data Exchange, Teamcenter 12.3 PLM00094 12.3
© 2020 Siemens
 A. Standard mapping
The [Link] file defines mappings for the mapper framework. The <maximum-concurrency >
element controls the number of simultaneous mappings that may run in an application. The mapper
service provides convenient access to mapping functionality. The service uses this [Link] file
to determine the type of mapping requested. Mapping is keyed on action type and source and
destination systems, for example:

<action name="dataTransfer">
<map source="1" target="1">

The mapping service provides support for no-op mappings and chained mappings. A no-op mapping is
declared as an empty <map> element, that is, without any <mapper> child elements. Chained
mappings are defined by creating a <map> element with multiple <mapper> child elements. Each child
element represents a mapper service. Between these sibling mapper elements, the output of a previous
service is the input of the next service in the chain.

Control file mapping is a service that wraps the mapping functionality provided by the mapper engine.
The input for this mapping is a File Management System (FMS) ticket from the input system. The control
file for the mapping is stored in the Global Services datastore. The output of the mapping is streamed
into the target system. FMS ticket(s) of the output and log information are returned. This action is the
dataTransfer action for standard mappings, for example:

<mapper service="CtrlFileMapService">
/bin/[Link] (points to datastore location)
</mapper>

XSLT mapping provides a configured way to map XSLT. The mapper configuration file provides the XSLT
for the mapping, for example:

<mapper service="XSLTMapService">
/bin/[Link] (points to datastore location)
</mapper>

Java mapping provides a convenient way to hook in custom mapping. Any implementing class must
implement to the ImapService interface. The [Link] file defines the implementing class to
be called for Java mapping, for example:

<mapper service="JavaMapService">
[Link]._globalservices.[Link]
(defines the class to invoke)
</mapper>

Tip:
Wild card quick configuration guidelines:

Data Exchange, Teamcenter 12.3 PLM00094 12.3 A-1

© 2020 Siemens
 A. Standard mapping

The [Link] configuration file accepts wild card (*) entries for MAP node's SOURCE and
TARGET attributes. Entries with wild cards are used as a fall back in cases when an entry bearing
specific site source and target site IDs does not exist. It is important to note that multiple map
entries with the same combination of SOURCE and TARGET attribute values must not conflict with
each other. Specifically, the following example pair of entries is NOT allowed, and results in an
error:

<map source="X" target="*"> ... </map>

<map source="*" target="Y"> ... </map>

Such entries do identify which entry is used.

A-2 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 B. Standard PDX mapping

Data Exchange, Teamcenter 12.3 PLM00094 12.3

© 2020 Siemens
Data Exchange, Teamcenter 12.3 PLM00094 12.3
© 2020 Siemens
 B. Standard PDX mapping
PDX PDX Teamcenter Teamcenter
element name attribute object attribute

ApprovedManufacturerListItem manufacturerPartIdentifier ManufacturerPart object_name

ApprovedManufacturerListItem manufacturerPartUniqueIdentifier ManufacturerPart item_id

ApprovedManufacturerListItem manufacturerContactUniqueIdentifier Vendor item_id

ApprovedManufacturerListItem globalManufacturerPartStatusCode ManufacturerPart name

Revision
→ReleaseStatus

ApprovedManufacturerListItem globalManufacturerPartStatusCodeOther ManufacturerPart name

Revision
→ReleaseStatus

ApprovedManufacturerListItem globalPreferredStatusCode VendorIdentifier preferred_stat

us

ApprovedManufacturerListItem description ManufacturerPart object_desc

ApprovedManufacturerListItem manufacturedBy VendorIdentifier object_name

AffectedItem itemIdentifier Item object_name

AffectedItem itemUniqueIdentifier Item item_id

AffectedItem oldRevision ItemRevision item_revision_

id

AffectedItem newRevision ItemRevision item_revision_

id

AffectedItem obsoleteDate ItemRevision date_released

→ReleaseStatus

AffectedItem effectiveDate ItemRevision date_released

→ReleaseStatus

AffectedItem globalLifeCyclePhaseCode ItemRevision name

→ReleaseStatus

AffectedItem globalLifeCyclePhaseCodeOther ItemRevision name

→ReleaseStatus

AffectedItem description ItemRevision object_desc

Attachment universalResourceIdentifier Imanfile original_file_n

ame

Attachment fileIdentifier Imanfile file_name

Attachment fileSize Imanfile byte_size

Attachment description Dataset description

Data Exchange, Teamcenter 12.3 PLM00094 12.3 B-1

© 2020 Siemens
 B. Standard PDX mapping

PDX PDX Teamcenter Teamcenter

element name attribute object attribute

BillOfMaterialItem revisionIdentifier PSOccurrence item_revision_

Item id
Item Revision

BillOfMaterialItem globalBillOfMaterialTypeCode Item object_type

BillOfMaterialItem globalBillOfMaterialTypeCodeOther Item object_type

BillOfMaterialItem notes PSOccurrence note_texts

→PSOccurrenceNotes

BillOfMaterialItem BillOfMaterialItemIdentifier PSOccurrence object_name

→Item

BillOfMaterialItem billOfMaterialItemUniqueIdentifier PSOccurrence item_id

→Item

BillOfMaterialItem itemQuantity PSOccurrence qty_value

BillOfMaterialItem description PSOccurrence object_desc

→Item
→Item Revision

BillOfMaterialItem proprietarySequenceIdentifier PSOccurrence seq_no

Change changeNumber EngChange item_id

Change revisionIdentifier EngChange Revision item_revision_

id

Change globalEngineeringChangeStatusCode EngChange Revision name

→ReleaseStatus

Change globalEngineeringChangeStatusCodeOther EngChange Revision name

→ReleaseStatus

Change changeStatusDate EngChange Revision date_released

→ReleaseStatus

Change changeType EngChange object_type

Change changeSubType EngChange Revision ec_type

Master

Change changeOriginationDate EngChange Revision creation_date

Change changeRequestDescription CMII CR/CN Form object_desc

Change changeOwnerName EngChange owning_user

Change description EngChange Revision object_desc

Contact contactIdentifier Vendor object_name

Contact contactUniqueIdentifier Vendor item_id

Contact contactName Vendor contact_name

Contact addressLine1 Vendor supplier_addr

B-2 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 PDX PDX Teamcenter Teamcenter
element name attribute object attribute

Contact telephoneNumber Vendor supplier_phon

e

Contact emailAddress Vendor email_addr

HistoryItem userName Header author

HistoryItem modificationDate Header date

Item itemIdentifier Item object_name

Item itemUniqueIdentifier Item Item_id

Item globalLlifeCyclePhaseCode Item Revision name

→Release Status

Item globalLlifeCyclePhaseCodeOther Item Revision name

→Release Status

Item globalProductTypeCode Item object_type

Item revisionIdentifier Item Revision item_revision_

id

Item globalProductUnitOfMeasureCode Item unit

→UnitOfMeasure

Item revisionReleasedDate Item Revision release_date

Item description Item object_desc

ManufacturerPart manufacturerPartIdentifier ManufacturerPart object_name

ManufacturerPart manufacturerPartUniqueIdentifier ManufacturerPart item_id

ManufacturerPart manufacturerName Vendor object_name

ManufacturerPart manufacturerContactUniqueIdentifier Vendor item_id

ManufacturerPart globalManufacturerPartStatusCode Manufacturer Part name

Revision
→ReleaseStatus

ManufacturerPart globalManufacturerPartStatusCodeOther Manufacturer Part name

Revision
→ ReleaseStatus

ManufacturerPart manufacturerPartType ManufacturerPart object_type

ManufacturerPart description ManufacturerPart object_desc

ProductDataeXchangePackage originatedByContactName Header author

ProductDataeXchangePackage originatedByContactUniqueIdentifier Header author

ReferenceDesignator referenceDesignatorName PSOccurrence ref_designator

Data Exchange, Teamcenter 12.3 PLM00094 12.3 B-3

© 2020 Siemens
 B. Standard PDX mapping

B-4 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 C. Teamcenter Data Exchange concepts and
components
Data Exchange components ─────────────────────────────── C-1
Supported objects ───────────────────────────────────── C-1
Exporter and importer ────────────────────────────────── C-6
Supported transfer options ─────────────────────────────── C-6
Scoper ──────────────────────────────────────────── C-7
Data mapper ──────────────────────────────────────── C-8
Data synchronizer ───────────────────────────────────── C-8
Identity manager ───────────────────────────────────── C-10
Ownership manager ─────────────────────────────────── C-11
Siemens Digital Industries Software briefcase ────────────────── C-13
File Management System file transfer ─────────────────────── C-14
Security Services ───────────────────────────────────── C-14

Data Exchange, Teamcenter 12.3 PLM00094 12.3

© 2020 Siemens
Data Exchange, Teamcenter 12.3 PLM00094 12.3
© 2020 Siemens
 C. Teamcenter Data Exchange concepts and
components
Data Exchange components
Data Exchange functionality is provided mainly by the following components:

• Exporter
• Importer
• Scoper
• Data mapper
• Data synchronizer
• Identity manager
• Ownership manager
• Briefcase

These components interact with the integration framework to transfer objects between sites.

Supported objects
The importer and exporter use the TC XML schema to import and export objects. The following objects
are supported by the TC XML framework:

Teamcenter base objects:

• Alias
• Dataset
• Form
• Folder
• IdContext
• Identifier
• ImanFile
• ImanRelation
• Item
• ItemRevision
• ReleaseStatus
• POMObject
• Table
• TableCellBCD
• TableCellDate
• TableCellDouble
• TableCellHex
• TableCellInt
• TableCellLogical
• TableCellSED

Data Exchange, Teamcenter 12.3 PLM00094 12.3 C-1

© 2020 Siemens
 C. Teamcenter Data Exchange concepts and components

• TableCellString
• TableDefinition
• TableLabel
• ValidationData
• ValidationResult

Teamcenter PSM objects:

• AbsOccData
• AbsOccDataQualifier
• AbsoluteOccurrence
• AssemblyArrangement
• AssemblyArrangementAnchor
• MEApprPathRoot
• MEApprPathNode
• PSBOMView
• PSBOMViewRevision
• PSOccurrence
• PSOccurrenceNotes
• SnapShot
• Variant
• VariantCondition
• VariantExpression
• VariantOption
• VariantRule

Teamcenter site objects:

• ImanExportRecord
• ImanReservation
• POM_stub
• PublicationAuditRecord

Teamcenter scoper objects:

• ClosureRule
• Filter
• PIEActionRule
• PropertySet
• TransferMode
• TransferOptionSet

The following objects are supported by applications:

Objects owned by Excel import:

• FullText

C-2 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Supported objects

Objects owned by Structure Manager:

• BoundingBox
• BoundingMultiBox

Objects owned by Vendor Management:

• BidPackage
• BidPackageContent
• BidPackageLineItem
• BidPackageRevision
• Vendor
• VendorIdentifier
• VendorRevision
• VendorRole
• VMRepresents

Objects owned by InterSpec:

• CPBOMRevision
• CPComponentRevision
• CPKeyword
• CPManufacturer
• CPPlant
• CPProcLineRevision
• CPProcStageRevision
• CPPropertyListColumn
• CPPropertyListFormat
• CPPropertyListRevision
• CPPropertyRevision
• CPRefSpecRevision
• CPSpecification
• CPSpecificationRevision
• CPSpecSection
• CPSpecType
• UOwithConversion

Objects owned by Organization:

• ADA_license
• Participant

Objects owned by ECAD:

• GDE
• ICSApplicationObject

Objects owned by Calibration and Configuration Data Management (CCDM):

Data Exchange, Teamcenter 12.3 PLM00094 12.3 C-3

© 2020 Siemens
 C. Teamcenter Data Exchange concepts and components

• BitDef
• BitValue
• CalParmRevision
• ParmDefBCD
• ParmDefBCDRevision
• ParmDefBitDef
• ParmDefBitDefRevision
• ParmDefBool
• ParmDefBoolRevision
• ParmDefDate
• ParmDefDateRevision
• ParmDefDbl
• ParmDefDblRevision
• ParmDefHex
• ParmDefHexRevision
• ParmDefInt
• ParmDefIntRevision
• ParmDefSED
• ParmDefSEDRevision
• ParmDefStr
• ParmDefStrRevision
• ParmGrpDef
• ParmGrpDefRevision
• ParmGrpVal
• ParmGrpValRevision
• ParmValBCD
• ParmValBitDef
• ParmValBool
• ParmValDate
• ParmValDbl
• ParmValHex
• ParmValInt
• ParmValSED
• ParmValStr
• ProductVariant
• ProductVariantIntent

Objects owned by Aerospace and Defense:

• ADSDesign
• ADSDrawing
• ADSPart
• ADSTechDocument

Objects owned by Change Management:

• ChangeItem

C-4 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Supported objects

The following objects are not supported, but the references to these objects from supported Teamcenter
objects are exported through properties. These objects must be defined at the importing site using the
Business Modeler IDE.

Teamcenter base objects:

• Project
• Tool
• UnitOfMeasure

Teamcenter Organization objects:

• Group
• GroupMember
• Person
• POM_imc
• Role
• User

Teamcenter PSM objects:

• PSOccurrenceType
• PSViewType

The importer supports transfer of the following CATIA objects from Teamcenter Enterprise:

• Basic document-centric classes

• V5 CGR files

• V4 and V5 drawing files

• Hybrid models, coexistence V4 and V5 models

• Design Tables

• Imprecise assembly structures

• Alternate shape representations

The importer supports transfer of the following Pro/ENGINEER objects from Teamcenter Enterprise:

• Basic document-centric classes

• Dependent objects (CAD dependency relations)

Data Exchange, Teamcenter 12.3 PLM00094 12.3 C-5

© 2020 Siemens
 C. Teamcenter Data Exchange concepts and components

• Auxiliary file types

• Family tables

• CGM files

• Suppressed parts

• Precise assembly structures

• Release history document with transfer of ownership

The exporter supports transfer of CAD neutral files and metadata to Teamcenter Enterprise.

Parts (assemblies/components) that have documents without any attachments are imported into
Teamcenter as empty datasets without any named references.

The following CAD data is not supported for transfer by the importer or exporter:

• Absolute occurrences

• Options and variants

• Effectivities

• Precise CATIA assembly structure

• Imprecise Pro/ENGINEER assembly structure

Exporter and importer

The exporter and importer components provide serialization and deserialization of transferred data. In
the serialization process, the exporter follows Teamcenter XML (TC XML) schema to generate XML
fragments and creates export records for objects exported to a target site.

Supported transfer options

The following table contains the transfer options that are supported by Data Exchange.

Option group Supported option Symbol name Value

Item Options Include All Revisions opt_all_revs true | false

Latest Revision Only opt_revs Latest

C-6 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Scoper

Option group Supported option Symbol name Value

Latest Working Revision opt_revs Latest

Only Working

Latest Working/Any opt_revs Latest

Release Status Working and
Released

Latest Any Release opt_revs Latest

Status Released

Selected Revision(s) opt_revs Selected

Only

Specific Release Status opt_revs Released

Only status

Dataset Options Include All Versions opt_all_ds_vers true | false

Include All Files opt_all_ds_files true | false

Product Structure Include Entire BOM opt_entire_bom true | false

Options

Transfer Top-Level Item opt_do_struct true | false

Only

Exclude Transfer- opt_trans_prot_comp true | false

Protected Components

Exclude Export- opt_exp_prot_comp true | false

Protected Components

General Options Exclude Export- opt_exp_prot_obj true | false

Protected Objects

Exclude Folder opt_folder_contents true | false

Contents

Relations Relations to be included opt_grm Supported

through
closure rule

Include JT datasets opt_jt_ds true | false

Include NX datasets opt_nx_ds true | false

Scoper
When the exporter or importer receives a request to transfer data, it determines the transfer mode from
the option set object. It then creates the traversal object based on the transfer mode scope (import,
export) and the schema format. PLM XML or TC XML). The basic behavior of a traversal object is to

Data Exchange, Teamcenter 12.3 PLM00094 12.3 C-7

© 2020 Siemens
 C. Teamcenter Data Exchange concepts and components

provide two methods, process and traverse. The process method processes the present object in hand
and calls the traverse method. The traverse method navigates to the next object and then calls the
process method. This operation iterates until no more objects are available to process.

The scoper evaluates the transfer mode closure rules and the options provided by the exporter and
returns only the objects that are identified for process in a closure rule clause. This list is sent to the
exporter or importer for serialization or deserializaton.

Data mapper
Product life cycle management systems track product object data and relationships. To move data from
one system to another, an object's attributes and its relationship to other objects must be converted or
mapped to the representation in the other system. For moving data from one Teamcenter system to
another, you only need to map customizations as the standard Teamcenter object attribute and
relationships are the same in both systems.

Teamcenter provides a standard mapping process for moving data between Teamcenter Enterprise and
Teamcenter systems. This standard mapping does not map all object attributes. Attributes that are not
used in the destination system are not mapped. Attributes that are used only to provide system
functionality that can be achieved through another method and are not displayed to the user, are also
not mapped. Due to customizations to support a unique business process, you may need to map some
of these standard attributes.

Reference elements can be mapped to multiple objects and will accept any number of mappings. A
reference element must map to a string that matches the string of characters prepended by plm: for the
object that it is mapped to.

For a GSIdentity object, the class attribute is information only and not the class name in the receiving
system.

Data synchronizer
The data synchronizer uses recipes defined by initial replication to determine if replicated data is up-to-
date or needs to be updated. You can use the synchronization functionality to see if data that is
replicated on your site is outdated and update it as desired. You can also push data that has changed to
sites where replicas exist. The synchronization function cannot be used to update the following:

• Meta model data such as types

• Administrative data such as users, groups, roles, and business rules

• Security information such as Access Manager (AM) rules

Candidates for synchronization are determined by comparing the master's last modification date to the
replica's last export date. Through a customization, you can also identify candidates automatically
providing an event trigger that calls an API that flags replicated objects as out-of-date.

C-8 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Data synchronizer

A recipe is a combination of import export options that is encoded as transfer formula strings. This
transfer formula is stored as part of the ImanExportRecord object as a string identifying the name of
the transfer formula and an integer field for the associated transfer formula variables presented in the
form of a map. The map contains a key string and a value string. This allows generalized behavior of
these options. The following options that can be used to form the transfer formula:

• All Item Revisions

• Revision Rule

• Release Status

• Export File

• Selected Revision Only

• All Datasets Version

• Included Generic Relationship Manager (GRM)

• Excluded GRM

Recipes for individual components are stored, but when components are imported in multiple
assemblies, only the last recipe is stored, as shown in the following use cases:

Component in two assemblies with differing relationships

1. User A, at site 2, replicates assembly X ( includes component Z) from site 1 with the
include_relation value set to Manifestation.

2. User B, at site 2, imports assembly Y ( also includes component Z) from site 1 with the
include_relation value set to Rendering.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 C-9

© 2020 Siemens
 C. Teamcenter Data Exchange concepts and components

The recipe is overwritten and item revision Z/A has the Rendering relationship.

3. User A deletes replica assembly Y or Z.

Item revision Z/A has the Rendering relationship.

Synchronization with a released and a working item revision

1. User A, at site 2, imports item X from site A with revision selector set to Latest Released.

2. User B, at site 2, imports the same item X with revision selector set to Latest Working.

3. Item revision X/B is released and then revised to X/C.

4. Item revision X/C is released and then revised to X/D.

5. User B, at site 2, synchronizes item X with site 1.

The Latest Working revision (X/D) is replicated to site 2, because the last exported recipe is Latest
Working.

Synchronization with a released and a deleted working item revision

1. User A, at site 2, imports item X from site A with revision selector set to Latest Released.

2. User B, at site 2, imports the same item X with revision selector set to Latest Working.

3. Item revision X/B is released and then revised to X/C.

4. Item revision X/C is released and then revised to X/D.

5. User A deletes replica revision X/B at site 2.

6. User B, at site 2, synchronizes item X with site 1.

The Latest Working revision (X/D) is replicated to site 2.

Identity manager
Data Exchange uses the GSIdentity object to provide a unique identity for items that are moved
between systems that have their own identity mechanism. Due to differences in data models and the
intended item's use, the GSIdentity object may be unique from the system ID for the item, such an OBID
or UID. Some objects may have several equivalent objects in the destination systems. Therefore, the
GSIdentity object for the exported object may equate to multiple objects in the destination system that
must reflect the original GSIdentity attributes.

The GSIdentity class is a subclass of the POM class and contains the following attributes:

• system

C-10 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Ownership manager

Provides a token indicating the data origination, for example, Teamcenter Enterprise or Teamcenter.

• label
Contains a textual representation for the data's UID or OBID in its native system.

• sub-label
Contains the UID or OBID of helper objects in many-to-one mappings.

• class
Contains the calling class name.

• split_token
Contains information the translator uses to identify the individual components for one-to-many
mappings.

• context
Tracks the attribute name when an attribute in one system becomes the full object in another system.
It may also identify (usually as an index) a runtime object that becomes a persistent object in the
receiving system. This occurs when the runtime object has uniqueness only in the context of a
persistent object. In many instances, neither of these two cases apply and this attribute is empty.

• factor_id
Contains a unique string that identifies a group of Teamcenter Enterprise objects that belong
together.

• atomic
Provides a token that indicates whether the label is simply the UID or OBID of an object or something
more complex.

The GSIdentity object is persisted and associated with the transferred object created in the new system.
Objects have only one identity. The composition of GSIdentity data provides a key that remains
consistent and unique for the data's life or may be changed systematically if the mapping algorithm is
altered. The collect_garbage utility can be used to remove GSIdentity objects from the database for
objects that have been deleted.

Ownership manager
The ownership manager controls ownership of objects that are transferred among systems and
participates in import and export operations. When a part is processed for transfer of ownership,
ownership of all part revisions is transferred to the receiving site. A transfer of ownership can be for the
top-level parts only or for an assembly and all its child parts. If ownership of a replicated object is
transferred to a new site, the export records for the object are transferred to the receiving site so that

Data Exchange, Teamcenter 12.3 PLM00094 12.3 C-11

© 2020 Siemens
 C. Teamcenter Data Exchange concepts and components

the owning site is always aware of existing replicas and all replicas are updated with the new site
ownership data.

When ownership of an object that is published to an ODS is transferred to another site, the ODS
publication record is updated with the new owning site.

During the ownership transfer process, objects at the exporting site are locked to prevent modifications
and are flagged as in the Ownership Transfer Pending state. This flag is cleared after the exporting site
receives a message from the importer that the transfer is complete and the exporting site marks the
objects it has as replicas. If the ownership transfer process terminates unexpectedly, the ownership may
be in an inconsistent state. The ensure_site_consistency utility allows you to report objects that are in
the Ownership Transfer Pending state and to correct inconsistent ownership.

The following is an example process for exporting an object with transfer of ownership:

1. The user selects objects to be exported from site 1 to site 2.

2. The user selects the option to transfer ownership.

3. The exporter processes the objects to be exported, for example, remove objects with no export
privilege, add helper objects, process closure rules, and so forth.

4. The ownership manager processes this list and removes objects in workflow, removes shared
objects, adds additional objects to maintain ownership consistency, for example, all item revisions
for an item.

5. The exporter adds export records for the objects to the list of objects.

6. The ownership manager locks the objects from further modification.

7. The exporter processes the object list and generates a TC XML file.

8. The importer at site 2 imports the objects from the TC XML file including export records.

9. The ownership manager sets the site ownership for imported objects as site 2. Objects imported as
replicas are left out.

10. The importer keeps track of objects for transfer of ownership is successful.

11. Site 2 generates a TC XML file with success/failure state for ownership transfer for each object and
sends it back to site 1.

12. Site 1 reads the objects in the TC XML file and sends a request to the ownership manager to unlock
them.

C-12 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Siemens Digital Industries Software briefcase

13. The ownership manager unlocks all objects from this list and also changes the owning_site
attribute for objects whose ownership was successfully transferred.

14. The ownership manager sends a message to Object Directory Service (ODS) regarding ownership
changes.

15. Teamcenter integration framework sends messages to sites where replicas and stubs are located
regarding ownership changes.

16. The ownership manager deletes the export records for these objects.

Siemens Digital Industries Software briefcase

Briefcase functionality primarily provides a method of exchanging information with suppliers or other
sites that do not share a live connection with your enterprise. It allows data to be replicated and also
provides the capability to check out data to a site for modification (the owning site remains the original
site, but the remote site can change objects, for example, add components to the structure, change
geometry, and so forth). Briefcase data is packaged in an archive file. The Teamcenter XML (TC XML) file
generated by the exporter and all the data files referenced in the TC XML file are packaged into a
briefcase file. This file can then be imported at the receiving site to create the replica objects and files.

A site can be defined as a hub (when configuring sites). A hub site can replicate replica objects to other
sites, typically when delegating work to sub-contractors. If an item is checked out to a hub site, the hub
site can also check out that item to another remote site for modification.

Objects checked out to a site are subject to the following modification privileges:

• All users at the site can change the object subject to Access Manager (AM) rules, provided no user at
the site has performed a local object checkout.

• If a user performs a local object checkout, only that user can change the object.

• If an object is checked out to remote site, users at the local site cannot change the object.

The following is the process Teamcenter uses for packaging a briefcase file:

1. Export the data files referenced in the TC XML files to the transient volume.

2. Update the TC XML files to contain the relative path to the data files instead of FMS file tickets.

3. Create the briefcase file using the TC XML data and the data files, and include the following
information in the briefcase file as attributes:

• Exporting site

• Target site

Data Exchange, Teamcenter 12.3 PLM00094 12.3 C-13

© 2020 Siemens
 C. Teamcenter Data Exchange concepts and components

• List of TC XML files

• Teamcenter version

4. Create a briefcase dataset object with the briefcase file and log file attached to it as named
references, and attach the briefcase dataset object to a Teamcenter mail that is sent to the
exporting user.

Briefcase also can be used to schedule an export through Teamcenter Integration Framework or Global
Services, allowing the export to proceed in the background so that you can immediately gain rich client
session control for other purposes.

The briefcase feature does not support transfer of ownership but does support check out to site to allow
modification of objects by suppliers

File Management System file transfer

Data Exchange uses File Management System (FMS) to transfer data files between Teamcenter PLM
systems. FMS transfers files on demand and uses the FMS server cache (FSC) to improve file transfer
performance. FMS keys are stored in the PLM system databases for use by the server processes to
generate tickets for a specific system. FSC servers use keys read from key files referenced in their
configuration files.

For Teamcenter, default keys are set in the Teamcenter database and can be modified using the
install_encryptionkeys utility. FMS in Teamcenter uses these default keys unless you configure it to use
key files referenced in the [Link] configuration file.

Security Services
Security Services allows a user to sign on one time for access to multiple Teamcenter products.
Teamcenter Data Exchange support this functionality when its components are properly configured to
use single sign-on (SSO).

C-14 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 D. Synchronizing a Teamcenter database to
an LDAP repository
ldapsync utility ─────────────────────────────────────── D-1
LDAP synchronization concepts ──────────────────────────── D-1
Objects synchronized by the ldapsync utility ──────────────────────── D-1
Object nodes ─────────────────────────────────────────── D-2
Direct and indirect memberships ─────────────────────────────── D-2
Internal and external objects ───────────────────────────────── D-3
Group membership ─────────────────────────────────────── D-3
Configuring the ldapsync utility ──────────────────────────── D-3
Configure the connection to an LDAP server ──────────────────────── D-3
Configure the ldapsync utility for SSL ──────────────────────────── D-4
User and person mapping ─────────────────────────────────── D-5
User and person mapping preferences ─────────────────────────── D-5
Group and role mapping ──────────────────────────────────── D-9
Group mapping preferences ───────────────────────────────── D-10
Role mapping preferences ────────────────────────────────── D-12
Data synchronization preferences ───────────────────────────── D-13
Differentiate groups and roles ──────────────────────────────── D-14
Link to separate LDAP directories ────────────────────────────── D-15
Synchronize Teamcenter to an LDAP repository ───────────────── D-15
ldapsync utility troubleshooting ─────────────────────────── D-16
Reset an external user ──────────────────────────────────── D-16
ldapsync cannot find nodes ───────────────────────────────── D-17
Sun ONE Directory Server ─────────────────────────────── D-17
Microsoft Active Directory ─────────────────────────────── D-20

Data Exchange, Teamcenter 12.3 PLM00094 12.3

© 2020 Siemens
Data Exchange, Teamcenter 12.3 PLM00094 12.3
© 2020 Siemens
 D. Synchronizing a Teamcenter database to
an LDAP repository
ldapsync utility
Teamcenter provides a batch utility that maps data constructs from an LDAP repository to objects in the
Teamcenter database. You can create, update, and deactivate Teamcenter objects by making changes to
the appropriate LDAP entries and then running the ldapsync utility. This tool is not required by Data
Exchange, however it can simplify your security configuration by synchronizing your Teamcenter
security objects to your LDAP configuration.

Even if you are not using Data Exchange, you can use this utility to synchronize your LDAP configuration
and Teamcenter security objects.

You can control the following default behavior of the utility using Teamcenter preferences set at the
user location:

• If an object exists in the LDAP repository but not in the Teamcenter database; it is created in the
database.

• If an object exists in the Teamcenter database but not in the LDAP repository; it is deactivated in the
database.

• If an object exists in both locations, the ldapsync utility compares the last modified timestamp in the
LDAP repository to the last synchronized timestamp in the Teamcenter database and updates the
object in the database when the LDAP timestamp is more recent.

LDAP synchronization concepts

Objects synchronized by the ldapsync utility

The objects synchronized by the ldapsync utility are users and their associated persons, groups, roles,
and group memberships. Teamcenter uses preferences set at the user location to control the
synchronization process, providing flexibility in how the ldapsync utility modifies the Teamcenter
database.

The ldapsync utility does not change the LDAP repository, only the Teamcenter database when
differences exist between the two. The utility can generate an extensive log file that tracks objects that
are modified and any error conditions encountered during execution.

Users that you synchronize with the ldapsync utility must be authenticated through Teamcenter
Security Services; therefore, you must have Security Services installed.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 D-1

© 2020 Siemens
 D. Synchronizing a Teamcenter database to an LDAP repository

Object nodes

The ldapsync utility recognizes the following four types of entries or nodes in an LDAP repository:

• user
• group
• role
• undefined

Object nodes

The first three map directly to their equivalent objects in Teamcenter, with user nodes mapping to both
Teamcenter person and Teamcenter user objects. The ldapsync utility also constructs group
memberships from the combination of a user, role, and group node. Undefined nodes are useful within
LDAP for providing clarity to the overall structure. For example, nodes of object class ou (organizational
unit) can be used to segregate users by geographical location without affecting the ldapsync utility
output.

Direct and indirect memberships

Direct or indirect membership describes how parent modes trace a path to their children. In a direct
membership, each child has exactly one parent and that parent-child relationship conforms to parent-
child connections in the LDAP repository. In an indirect membership, a specific child node may have
multiple parents, that is, more than one parent node can point the same child node.

Indirect membership is recognized by the ldapsync utility but not by the LDAP server. This type of
membership is represented in the ldapsync utility by the LDAP_member_type_attr and

D-2 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Internal and external objects

LDAP_member_list_attr preferences at the site location. If the LDAP_member_type_attr preference

value is set to true, the ldapsync utility uses the values in the LDAP_member_list_attr preference as a
list of child distinguished names (DNs). Therefore, a specific child node can be included multiple times,
for example, if a person (represented by a user node) belongs to several project teams (represented by
group nodes) each group node can point to the same user node, rather than requiring a duplicate user
node for each group’s use.

There is no way to easily determine how many indirect parents a node may have; however, this
information has no known value at this time.

Internal and external objects

The ldapsync utility manages objects as internal or as external objects. Teamcenter creates all internally
managed objects and only Teamcenter can modified them. The ldapsync utility can create and modify
externally manage objects. An internally managed object can become externally managed. Teamcenter
users, groups, roles, and group memberships are flagged as either internal or external objects.

Group membership

The ldapsync utility determines group memberships by mapping user, group, and role nodes, on a one-
to-one basis, to their appropriate Teamcenter objects. Group memberships result from the relationship
of these nodes in the LDAP repository. The minimum requirement for a group membership is a group
node and a user node. If a default role for a group is specified, a role node is optional. The
parent→child→grandchild relationship in LDAP is represented as group→optional-role-node→user.
Intervening undefined nodes, such as organizational units (ou) are ignored in the path, an example of
this in the LDAP repository is:

group→ou1→ou2→role→ou3→user

Configuring the ldapsync utility

Configure the connection to an LDAP server

In the rich client interface, choose Edit→Options and set the following preferences under the
[Link] category:

• LDAP_admin_dn
Defines the LDAP administrator's name. Set this value to the DN of an LDAP user who has search and
read permissions in the LDAP directory service.

• LDAP_admin_pw
Specifies the password for the LDAP administrator identified by the LDAP_admin_dn preference. If
you do not set this preference, you must include a password using the –l argument for the ldapsync
utility. Because this password is stored in the database in plain text, it is recommended that the
associated account have read-only access to the LDAP.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 D-3

© 2020 Siemens
 D. Synchronizing a Teamcenter database to an LDAP repository

• LDAP_cert_db_path
Specifies the path to the directory containing the [Link] (certification database) file. the ldapsync
utility uses this value only when the LDAP_use_ssl preference is set to true.

• LDAP_port_number
Defines the port number used when connecting to the LDAP directory server. It is used with the value
set in the LDAP_service_hosts preference to define an LDAP directory server connection.

• LDAP_service_hosts
Lists the host or hosts that provide LDAP directory services for this installation. Valid inputs are host
names or IP addresses. This value is used with the value set in the LDAP_port_number preference to
define LDAP directory server connections.

• LDAP_use_ssl
Specifies whether a connection to the LDAP directory uses SSL encryption. This preference contains a
logical value set to false by default. If you set this preference to true, you must also set the
LDAP_cert_db_path preference.

Configure the ldapsync utility for SSL

It is recommended that you have the ldapsync utility fully functional in non–SSL mode before you
configure it for secure socket layer (SSL) use. After you have the utility functioning properly, configure it
to work with SSL, as follows:

1. Obtain a certificate.

2. Start the SSL port on the directory server.

3. Verify the SSL port can be accessed using an LDAP browser utility.

4. Register the directory server as a trusted server.

5. Configure the ldapsync utility to use the trusted store.

Your network security administrator must perform the first three steps and they may assist you with step
four. To register the directory server as trusted (step 4):

Note:
For information about how to perform any of these steps, see the Mozilla web site.

1. Download the certutil executable from the Mozilla web site. The executable is packaged in the NSS
and NSF download packages.

2. Install the certutil executable.

D-4 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 User and person mapping

3. Create a trusted store.

4. Add the server certificate to the trusted store.

To configure the ldapsync utility to use the trusted store:

1. Set the LDAP_port_number preference at the site location, for example:

LDAP_port_number: 10636

2. Set the LDAP_use_ssl preference at the site location, for example:

LDAP_use_ssl: TRUE

3. Set the LDAP_cert_db_path preferences, for example:

LDAP_cert_db_path: trusted-store-path

User and person mapping

The Teamcenter user and person objects are both mapped from the LDAP person object. When the
ldapsync utility identifies an LDAP person object for synchronization, it creates both a user object and a
person object in Teamcenter. The inetOrgPerson class is the standard LDAP person object class for a Sun
ONE Directory Server, but you can configure this to a different class.

LDAP person object mapping

User and person mapping preferences

These preferences are in the [Link] and Person Mapping preferences category.

• LDAP_attribute_mapping
Defines the mapping of LDAP objects to Teamcenter user attributes using sets of three strings, for
example:

LDAP_attribute_mapping=
LDAPPersonName
cn

Data Exchange, Teamcenter 12.3 PLM00094 12.3 D-5

© 2020 Siemens
 D. Synchronizing a Teamcenter database to an LDAP repository

%REPLACE_ME%
LDAPEngUserId
uid
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%
LDAPOsUser
uid
%REPLACE_ME%
LDAPUserGroup
%REPLACE_ME%
Engineering
LDAPUserRole
%REPLACE_ME%
%REPLACE_ME%

Each attribute map can contain string values for the following:

• Teamcenter attribute name

• Mapped LDAP attribute
• Default value used if there is no mapped LDAP attribute or if the mapped LDAP attribute value is
null

Attribute name LDAP attribute Default value Description

LDAPEngUserId uid Does not apply User ID

LDAPLastUpdate modifyTimestamp Does not apply Last update

timestamp

LDAPOsUser uid None Operating

system user
name.

LDAPPersonName cn Does not apply Person name

LDAPUserGroup Undefined Engineering Default group

LDAPUserRole Undefined None Default role

The LDAPLastUpdate attribute is used for synchronization checks but is not set in the Teamcenter
role object.

Caution:
The LDAPUserGroup and LDAPUserRole attributes are required in Teamcenter. Therefore, you
must specify either a mapped LDAP attribute or a default value for these attributes.

D-6 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 User and person mapping preferences

• LDAP_person_attr_mapping
Defines the mapping of LDAP objects to Teamcenter person attributes using sets of three strings, for
example:

Note:
This example uses generic person attribute values (PA1–PA10)

LDAP_person_attr_mapping=
LDAPPersonName
cn
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%
PA1
postaladdress
%REPLACE_ME%
PA2
localityName
%REPLACE_ME%
PA3
st
%REPLACE_ME%
PA4
postalCode
%REPLACE_ME%
PA5
co
%REPLACE_ME%
PA6
o
%REPLACE_ME%
PA7
employeeNumber
%REPLACE_ME%
PA8
physicalDeliveryOfficeName
%REPLACE_ME%
PA9
mail
%REPLACE_ME%
PA10
telephoneNumber
%REPLACE_ME%

Each attribute map can contain string values for the following:

Data Exchange, Teamcenter 12.3 PLM00094 12.3 D-7

© 2020 Siemens
 D. Synchronizing a Teamcenter database to an LDAP repository

• Teamcenter attribute name

• Mapped LDAP attribute
• Default value used if there is no mapped LDAP attribute or if the mapped LDAP attribute value is
null.

Attribute name LDAP attribute Default Description

value

LDAPPersonName cn Does not Person name

apply

LDAPLastUpdate modifyTimestamp None Last update

timestamp

PA1 postaladdress None Address

PA2 localityName None City

PA3 st None State

PA4 postalcode None Zip code

PA5 co None Country

PA6 o None Organization

PA7 employeeNumber None Employee

number

PA8 physicalDeliveryOfficeName None Internal mail

code

PA9 mail None email address

PA10 telephoneNumber None Telephone

number

The LDAPLastUpdate attribute is used for synchronization checks but is not set in the Teamcenter
role object.

• LDAP_base_dn
Defines the distinguished name (DN) of one or more nodes in the external LDAP directory where the
user and person synchronization process starts. Use this to limit the extent of the ldapsync utility user
and person search for performance reasons or to partition users in a single LDAP directory server
instance for use with multiple Teamcenter installation. If the LDAP directory server does not have this
type of organization, set this value to the lowest level DNs that encompass all Teamcenter users.
The following are examples of a high level DN and a more specific DN, respectively:

dc=siemens,dc=com

ou=Engineering Groups,ou=specials users,db=siemens,dc=com

D-8 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Group and role mapping

• LDAP_ignore_users
Defines Teamcenter user IDs that the ldapsync utility does not process. The default value is infodba.

Note:
The ldapsync utility never processes the infodba user even if it is not included in this list.

This allows you to include a list of user IDs that exist in Teamcenter for administrative purposes that
do not have corresponding entries in the LDAP repository.

• LDAP_user_object_class
Defines the LDAP object class you use to indicate Teamcenter users to synchronize. If you use multiple
classes to represent Teamcenter users, specify the common base class. The default value is
inetOrgPerson.

• LDAP_user_query_filter
Defines the set of conditions an LDAP object must satisfy to match a Teamcenter user object for
synchronization. Use LDAP query filter syntax for this preference value. The default value is uid=*.

Group and role mapping

You can map the Teamcenter group and role objects from the LDAP group object and a mapped default
role attribute. You can also specify roles in their own LDAP group object. A user is typically assigned a
role within a group. Groups can also be nested. The standard LDAP group object class is
groupOfUniqueNames, but you can configure a different class for each object type.

The standard LDAP role object is not supported for mapping to Teamcenter because LDAP roles are
global and attached to the person object. Teamcenter requires role constructs that are configured
specifically within the context of a group. If you require non-default roles, you may have to alter the
LDAP schema.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 D-9

© 2020 Siemens
 D. Synchronizing a Teamcenter database to an LDAP repository

LDAP group and role object mapping

Three new LDAP object attributes are required to support group and role object mapping. Add these to
the standard LDAP group object schema. Although all three attributes are optional, the following are
required to support LDAP object membership models:

object_type Specifies a string attribute that allows Teamcenter to distinguish

groupOfUniqueNames class instances represent Teamcenter groups or roles. Valid
values of this attribute are group and role. The default value is group. An alternative
to using this attribute is to create separate groupOfUniqueNames subclasses for
Teamcenter groups and roles to differentiate them.
member_typ Specifies a logical attribute that allows Teamcenter to distinguish the membership
e model to use to determine the children of this group or role. Valid values are True
(indicates indirect) or False (indicates direct). The default value is True.
memberDNs Specifies a list of string attributes that allow Teamcenter to find the children member
DNs for the group or role for an indirect membership type. This is not valid for direct
membership type.

Group mapping preferences

These preferences are in the [Link] Mapping preferences category.

• LDAP_group_attr_mapping
Defines the mapping of LDAP objects to Teamcenter group attributes using sets of three strings, for
example:

LDAP_group_attr_mapping=
LDAPGroupName
cn
%REPLACE_ME%

D-10 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Group mapping preferences

LDAPGroupDesc
description
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%
LDAPGroupDBA
%REPLACE_ME%
0
LDAPGroupRole
%REPLACE_ME%
%REPLACE_ME%

Each attribute map can contain string values for the following:

• Teamcenter attribute name

• Mapped LDAP attribute
• Default value used if there is no mapped LDAP attribute or if the mapped LDAP attribute value is
null

Attribute name LDAP attribute Default Description

value

LDAPGroupDBA Undefined None Group DBA

privilege

LDAPGroupDesc description None Group description

LDAPGroupName cn Does not Group name

apply

LDAPGroupRole Undefined None Default role

LDAPLastUpdate modifyTimestamp Does not Last update

apply timestamp

The LDAPLastUpdate attribute is used for synchronization checks but is not set in the Teamcenter
role object.

• LDAP_group_base_dn
Defines the distinguished name (DN) of one or more nodes in the external LDAP directory where the
group synchronization process starts. Use this to limit the extent of the ldapsync utility group search
for performance reasons or to partition groups in a single LDAP directory server instance for use with
multiple Teamcenter installation. If the LDAP directory server does not have this type of organization,
set this value to the lowest level DNs that encompasses all Teamcenter groups.
The following are examples of a high level DN and a more specific DN, respectively:

dc=siemens,dc=com

Data Exchange, Teamcenter 12.3 PLM00094 12.3 D-11

© 2020 Siemens
 D. Synchronizing a Teamcenter database to an LDAP repository

ou=Engineering Groups,ou=groups,db=siemens,dc=com

• LDAP_group_object_class
Defines the LDAP object class you use to indicate Teamcenter groups to synchronize. If you use
multiple classes to represent Teamcenter groups, specify the common base class. The default value is
groupOfUniqueNames.
This allows you to define specific subclasses in LDAP to differentiate groups and roles. If your groups
and roles have the same object class, use the LDAP_object_type_attr preference instead.

• LDAP_group_query_filter
Defines the set of conditions an LDAP object must satisfy to match a Teamcenter group object for
synchronization. Use LDAP query filter syntax for this preference value. The default value is cn=*.

Role mapping preferences

These preferences are in the [Link] Mapping preferences category.

• LDAP_role_attr_mapping
Defines the mapping of LDAP objects to Teamcenter role attributes using sets of three strings, for
example:

LDAP_role_attr_mapping=
LDAPRoleName
cn
%REPLACE_ME%
LDAPRoleDesc
description
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%

Each attribute map can contain string values for the following:

• Teamcenter attribute name

• Mapped LDAP attribute
• Default value used if there is no mapped LDAP attribute or if the mapped LDAP attribute value is
null

Attribute name LDAP attribute Default value Description

LDAPLastUpdate modifyTimestamp None Last update

timestamp

LDAPRoleDesc description None Role description

LDAPRoleName cn None Role name

D-12 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Data synchronization preferences

The LDAPLastUpdate attribute is used for synchronization checks but is not set in the Teamcenter
group object.

• LDAP_role_object_class
Defines the LDAP object class you use to indicate the Teamcenter roles to synchronize. If you use
multiple classes to represent Teamcenter roles, specify the common base class. The default value is
groupOfUniqueNames.
This allows you to define specific subclasses in LDAP to differentiate groups and roles. If your groups
and roles have the same object class, use the LDAP_object_type_attr preference instead.

• LDAP_group_query_filter
Defines the set of conditions an LDAP object must satisfy to match a Teamcenter role object for
synchronization. Use LDAP query filter syntax for this preference value. The default value is cn=*.

Data synchronization preferences

LDAP data synchronization uses three preference types:

• Indirect membership preferences (LDAP_member_list_attr and LDAP_member_type_attr)

These provide a link to another LDAP tree structure.

• Object type preference (LDAP_object_type_attr)

This distinguish a group or role object

• Synchronization flags preferences (LDAP_sync_flag-name_flags)

These provide system-wide decisions about synchronization.

These preferences are in the [Link] preferences category.

• LDAP_member_list_attr
Defines the LDAP attribute containing a list of member DNs for this object. The ldapsync utility uses
this value only when the LDAP_member_type_attr is set. This preference is set to uniqueMember by
default.

• LDAP_member_type_attr
Defines the LDAP attribute that contains membership type (indirect or direct) for this object. The LDAP
object must have an attribute that matches the value of this preference that contains a logical value
indicating whether the object has indirect (false) or indirect (true) children. For example, if you set
this to memberType, the LDAP object must have an attribute by that name that is set to true for
indirect children or false for direct children.
This preference applies to objects representing either groups or roles defined in LDAP.
If you set this preference, you must also set the LDAP_member_list_attr preference.

• LDAP_object_type_attr
Defines an LDAP attribute that contains the object type for this object. This applies to group or role
objects defined in LDAP. The object name must reference a string attribute defined in the LDAP group

Data Exchange, Teamcenter 12.3 PLM00094 12.3 D-13

© 2020 Siemens
 D. Synchronizing a Teamcenter database to an LDAP repository

object that is set to either group or role. For example, if you set the preference value to objectType,
your LDAP must have an attribute by that name that is set to either group or role.

• LDAP_sync_group_flags
Defines the synchronization for groups using the flags described in the following table. The deactivate
flag is not valid for this preference. The default value is scue.

• LDAP_sync_member_flags
Defines the synchronization for members using the flags described in the following table. The
deactivate flag is not valid for this preference. The default value is scue.

• LDAP_sync_role_flags
Defines the synchronization for roles using the flags described in the following table. The deactivate
flag is not valid for this preference. The default value is scue.

• LDAP_sync_user_flags
Defines the synchronization for users using the flags described in the following table. The default
value is scdue.

Flag Action Description

c Create Allows creation of externally managed objects in Teamcenter.

d Deactivate Allows deactivation of externally managed objects in Teamcenter.

e Externalize Allows conversion of internally managed Teamcenter objects that have

corresponding objects in LDAP to externally managed objects.

s Synchronize Enables synchronization.

u Update Allows updates to externally managed objects in Teamcenter.

Differentiate groups and roles

There are two ways to indicate to the ldapsync utility that an object is a group or role. You can assign a
unique object class for each or use the LDAP_object_type_attr preference.

To assign a unique object class:

1. Add a new object class in the LDAP server. For example, extent the groupOfUniqueNames class by
adding the unique groupOfUniqueGroupNames class for groups and the
groupOfUniqueRoleNames class for roles.

2. Add the unique object class to the group or role that you want to define.

3. Set the ldapsync preferences. For this example, set the following preferences:

D-14 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Link to separate LDAP directories

LDAP_group_object_class: groupOfUniqueGroupNames
LDAP_role_object_class: groupOfUniqueRoleNames

To use the LDAP_object_type_attr preference:

1. Use the same object class when defining both groups and roles.

2. Define a unique attribute within the object class in the LDAP server. For example, add the
objectType attribute to the groupOfUniqueNames object class.

3. Set the LDAP_group_object_class, LDAP_role_object_class, and LDAP_object_type_attr

preferences. For this example, set the preferences as follows:

LDAP_group_object_class: groupOfUniqueNames
LDAP_role_object_class: groupOfUniqueNames
LDAP_object_type_attr: objectType

Link to separate LDAP directories

The ldapsync utility reads a directory structure starting at the specified baseDN directory and continues
until it has read all of the child nodes. If separate directory structures must be searched that are not
under the baseDN directory, configure LDAP member attributes as follows:

1. Add a unique attribute to the LDAP server, such as the LDAP_child attribute.

2. Add the attribute to a group or role with the attribute value set to the other DN directory. You can
configure multiple LDAP_child attributes under each group or role.

Caution:
To avoid an infinite loop, ensure the DN you provide in the LDAP_child attribute does not
point back to the original DN.

3. Set the LDAP_member_type_attr attribute as for direct or indirect searching and the
LDAP_member_list_attr attribute to the unique attribute. For example, if you add the LDAP_child
attribute and are using indirect searching:

LDAP_member_type: true
LDAP_member_list_attr: LDAP_child

Synchronize Teamcenter to an LDAP repository

Note:
The utility must be run from a command prompt with the proper environment settings.

Data Exchange, Teamcenter 12.3 PLM00094 12.3 D-15

© 2020 Siemens
 D. Synchronizing a Teamcenter database to an LDAP repository

1. Open a command prompt.

On Windows systems, open a command prompt with the proper Teamcenter environment settings
by clicking the Start button and choosing the following menu commands:

Programs→UGS Teamcenter 12→Teamcenter 12→ service-name_configuration-ID

Command Prompt

Replace service-name and configuration-ID with the Teamcenter service name and configuration
ID you entered during installation.

2. Enter the following command to synchronize Teamcenter to your LDAP repository:

ldapsync –u=userid -p=password —g=group —l=ldap-password

Replace userid and password with a Teamcenter administrative user ID and password. Replace
ldap-password with the password for the DN of an LDAP user who has search and read permissions
in the LDAP directory service.

Note:
The –l=ldap-password argument is not required for the ldapsync utility if you set the
LDAP_admin_pw preference.

ldapsync utility troubleshooting

Reset an external user

Use the make_user utility to fix an object incorrectly set to internally or externally managed. The –
datasource=0 argument resets the object to internally managed or the –datasource=1 sets it to
externally managed. You can set the data source for users, groups, roles, persons, and group members.
To set the data source for a group member, you use the –user, –role, and –group arguments together.

For example, to set a user to internally managed, type:

make_user -update -user=user2 –role=role2 –group=group2 -datasource=0

To set a group member to externally managed, type:

make_user -update -user=user2 –role=role2 –group=group2 -datasource=1

D-16 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Search limitations for ldapsync

ldapsync cannot find nodes

Search limitations for ldapsync

The ldapsync utility uses two kinds of LDAP searches; a base-level search (only search the current node),
and a one-level search (search the current node and all nodes one level under the current node). If any
of the nodes have an LDAP access control list (ACL) that prevents searches on that node, the ldapsync
utility cannot analyze it and the utility cannot continue searching on any of its children. To check for an
ACL that prevents searches, use an LDAP directory search tool, such as ldapsearch.

Search the base DN and one level under it

To search the base DN and one level under it, type:

ldapsearch -b o={baseDN} -h "{host-name}" -p 389 -s one "(cn=*)"

Search the base DN only

To search the base DN only on a Sun ONE Directory Server, type: ldapsearch -b o={baseDN} -h
"{host-name}" -p 389 -s base "(cn=*)"

Sun ONE Directory Server

The following preference value list provides an example of configuring Teamcenter preferences to
synchronize a Sun ONE Directory Server to the Teamcenter database.

Preference list Sun ONE Directory Server values

LDAP_admin_dn cn=Directory-Manager
LDAP_admin_pw password
LDAP_attribute_mapping LDAPPersonName
cn
%REPLACE_ME%
LDAPEngUserId
uid
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%
LDAPOsUser
uid
%REPLACE_ME%
LDAPUserGroup
%REPLACE_ME%
Engineering

Data Exchange, Teamcenter 12.3 PLM00094 12.3 D-17

© 2020 Siemens
 D. Synchronizing a Teamcenter database to an LDAP repository

Preference list Sun ONE Directory Server values

LDAPUserRole
%REPLACE_ME%
Designer
LDAP_base_dn dc=company-name, dc=com
LDAP_cert_db_path
LDAP_group_attr_mapping LDAPGroupName
cn
%REPLACE_ME%
LDAPGroupDesc
description
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%
LDAPGroupDBA
%REPLACE_ME%
0
LDAPGroupRole
%REPLACE_ME%
Designer
LDAP_group_base_dn dc=company-name, dc=com
LDAP_group_object_class groupOfUniqueNames
LDAP_group_query_filter (cn=*)
LDAP_ignore_users infodba
LDAP_member_list_attr uniqueMember
LDAP_member_type_attr
LDAP_object_type_attr Object-type
LDAP_person_attr_mapping LDAPPersonName
cn
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%
PA1
postalAddress
%REPLACE_ME%
PA2
localityName
%REPLACE_ME%
PA3
st

D-18 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Sun ONE Directory Server

Preference list Sun ONE Directory Server values

%REPLACE_ME%
PA4
postalCode
%REPLACE_ME%
PA5
co
%REPLACE_ME%
PA6
o
%REPLACE_ME%
PA7
employeeNumber
%REPLACE_ME%
PA8
physicalDeliveryOfficeName
%REPLACE_ME%
PA9
mail
%REPLACE_ME%
PA10
telephoneNumber
%REPLACE_ME%
LDAP_port_number port-number
LDAP_role_attr_mapping LDAPRoleName
cn
%REPLACE_ME%
LDAPRoleDesc
description
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%
LDAP_role_object_class groupOfUniqueNames
LDAP_role_query_filter (cn=*)
LDAP_service_hosts LDAP-hostname
LDAP_sync_group_flags scue
LDAP_sync_member_flags scde
LDAP_sync_role_flags scue
LDAP_sync_user_flags scdue
LDAP_use_ssl FALSE

Data Exchange, Teamcenter 12.3 PLM00094 12.3 D-19

© 2020 Siemens
 D. Synchronizing a Teamcenter database to an LDAP repository

Preference list Sun ONE Directory Server values

LDAP_user_object_class inetOrgPerson
LDAP_user_query_filter (uid=*)

Microsoft Active Directory

The following preference value list provides an example of configuring Teamcenter preferences to
synchronize a Microsoft Active Directory LDAP server to the Teamcenter database.

Preferences Active Directory values

LDAP_admin_dn test-admin@[Link]
LDAP_admin_pw password
LDAP_attribute_mapping LDAPPersonName
cn
%REPLACE_ME%
LDAPEngUserId
sAMAccountName
%REPLACE_ME%
LDAPLastUpdate
whenChanged
%REPLACE_ME%
LDAPOsUser
sAMAccountName
%REPLACE_ME%
LDAPUserGroup
%REPLACE_ME%
Engineering
LDAPUserRole
%REPLACE_ME%
Designer
LDAP_base_dn dc=company-name, dc=com
LDAP_cert_db_path
LDAP_group_attr_mapping LDAPGroupName
cn
%REPLACE_ME%
LDAPGroupDesc
description
%REPLACE_ME%
LDAPLastUpdate
whenChanged
%REPLACE_ME%
LDAPGroupDBA
%REPLACE_ME%

D-20 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
 Microsoft Active Directory

Preferences Active Directory values

0
LDAPGroupRole
%REPLACE_ME%
Designer
LDAP_group_base_dn dc=company-name, dc=com
LDAP_group_object_class groupOfUniqueNames
LDAP_group_query_filter (cn=*)
LDAP_ignore_users infodba
LDAP_member_list_attr uniqueMember
LDAP_member_type_attr
LDAP_object_type_attr Object-type
LDAP_person_attr_mapping LDAPPersonName
cn
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%
PA1
postaladdress
%REPLACE_ME%
PA2
localityName
%REPLACE_ME%
PA3
st
%REPLACE_ME%
PA4
postalCode
%REPLACE_ME%
PA5
co
%REPLACE_ME%
PA6
o
%REPLACE_ME%
PA7
employeeNumber
%REPLACE_ME%
PA8
physicalDeliveryOfficeName
%REPLACE_ME%
PA9
mail

Data Exchange, Teamcenter 12.3 PLM00094 12.3 D-21

© 2020 Siemens
 D. Synchronizing a Teamcenter database to an LDAP repository

Preferences Active Directory values

%REPLACE_ME%
PA10
telephoneNumber
%REPLACE_ME%
LDAP_port_number port-number
LDAP_role_attr_mapping LDAPRoleName
cn
%REPLACE_ME%
LDAPRoleDesc
description
%REPLACE_ME%
LDAPLastUpdate
whenChanged
%REPLACE_ME%
LDAP_role_object_class groupOfUniqueNames
LDAP_role_query_filter (cn=*)
LDAP_service_hosts LDAP-hostname
LDAP_sync_group_flags scue
LDAP_sync_member_flags scde
LDAP_sync_role_flags scue
LDAP_sync_user_flags scdue
LDAP_use_ssl FALSE
LDAP_user_object_class user
LDAP_user_query_filter (sAMAccountName=*)

D-22 PLM00094 12.3 Data Exchange, Teamcenter 12.3

© 2020 Siemens
Siemens Digital Industries Software
Headquarters Europe
Granite Park One Stephenson House
5800 Granite Parkway Sir William Siemens Square
Suite 600 Frimley, Camberley
Plano, TX 75024 Surrey, GU16 8QD
USA +44 (0) 1276 413200
+1 972 987 3000

Asia-Pacific
Americas Suites 4301-4302, 43/F
Granite Park One AIA Kowloon Tower, Landmark East
5800 Granite Parkway 100 How Ming Street
Suite 600 Kwun Tong, Kowloon
Plano, TX 75024 Hong Kong
USA +852 2230 3308
+1 314 264 8499

About Siemens Digital Industries Software

Siemens Digital Industries Software is a leading global provider of product life cycle management
(PLM) software and services with 7 million licensed seats and 71,000 customers worldwide.
Headquartered in Plano, Texas, Siemens Digital Industries Software works collaboratively with
companies to deliver open solutions that help them turn more ideas into successful products. For
more information on Siemens Digital Industries Software products and services, visit
[Link]/plm.
This software and related documentation are proprietary and confidential to Siemens.
© 2020 Siemens. A list of relevant Siemens trademarks is available. Other trademarks belong to
their respective owners.