Data Exchange PDF

SIEMENS
Teamcenter 11.2
Data Exchange
PLM00094 • 11.2
Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Getting started with Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Teamcenter Data Exchange interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Basic concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Data Exchange use cases and roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Teamcenter upgrade and other transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Data Exchange concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Briefcase file exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
4th Generation Design data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
PDX export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13
Teamcenter variant schema exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
Special characters in TC XML files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
Requirement objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Vendor management objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Multiple language support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Bulk loading data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17
Configured BOM export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17
Multifield key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
Installing Teamcenter Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
Planning your installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
Installation worksheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-22
Teamcenter server installation requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-23
Teamcenter configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24
Teamcenter configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24
Create Teamcenter Integration Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24
Teamcenter Integration Framework configuration process . . . . . . . . . . . . . . . . . . . . . . . 1-26
Define remote sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-27
Define Teamcenter preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28
File Management System (FMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28
Configuring Teamcenter Integration Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-30
Transfer modes in Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-34
Transfer option sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-35
Set a rule to allow transfer of ownership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-36
Define users, groups, and rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-36
Closure rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
Verifying the transfer configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
Verify FMS configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
Verify transfer from Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-38
PLM00094 11.2 Data Exchange 3

Contents
Contents
Transferring objects using business access rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

TC XML configured export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Exporting a configured bill of materials (BOM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Exporting a BOM without variant rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Delta export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Synchronize changes for a specific BOM configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Export a bill of materials to a briefcase file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Export a configured bill of materials to a briefcase file (with Global Services) . . . . . . . . . . . 2-5
Mapping configured BOM export files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Export from Teamcenter (using Global Services) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Import to Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
Using site checkout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Check out to a remote site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Check in from a site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
Cancel checkout to a site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
Check replica synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
Exporting Supplier Relationship Management data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
Configure Supplier Relationship Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
Export to SRM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
Accessing remote objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
Object Directory Service (ODS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
Publish to default ODS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
Publish to the publication list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
Unpublish ODS objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
Search for remote items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
Using PDX export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
Configure PDX export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
Defining a PDX workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
Creating a custom PDX style sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
Exporting PDX data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20
Exchanging data with suppliers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Using briefcase files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Using briefcase files with unmanaged sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Configure briefcase for site checkin and checkout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Configure Teamcenter for Briefcase Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Briefcase Browser site configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Configure Teamcenter for briefcase mail notification . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
Configure 4th Generation Design data exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
Migrate a supplier site from a managed to unmanaged site . . . . . . . . . . . . . . . . . . . . . . 3-11
CAD design exchange business process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
Configure 4th Generation Design data exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
Unmanaged site briefcase transfers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Configuration required for unmanaged site transfers . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Export a configured briefcase file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Import validation results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16
Import a configured briefcase file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17
Transferring a briefcase package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17
Briefcase transfer process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17
4 Data Exchange PLM00094 11.2

Contents
Package the data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18

Transfer the package file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20
Import the package file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20
Fast streaming data transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Low-level TC XML use cases and concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Custom data mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Data mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Preventing data loss . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Loading bulk data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Bulk load business process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Extract bulk data from legacy system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Using the CSV to TC XML converter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Island of data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
TC XML format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16
Prepare Teamcenter for bulk load import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
Enable bulk loader utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
Process for bulk loading Teamcenter data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22
TC XML file with GSID references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
TC XML file with POM_stub elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24
Create, update, and infer-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-25
Teamcenter core data dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
Teamcenter data model diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42
Sample assembly structure in a TC XML file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43
Sample TC XML file with GSID references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44
Transfer bulk physical files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-46
Pre-import validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48
Pre-import validation utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48
Required schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49
Required helper objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50
Validate your TC XML test files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50
Pre-import validation logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50
Bulk load data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-51
Bulk loader utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-51
Sample bulk load repeat file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-54
Frequently asked questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-55
Copying product data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
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

Contents
Contents
Managing administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Types of administration data you can export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Managing administrative data process descriptions and roles . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Partial administration data import for work groups business process . . . . . . . . . . . . . . . . . 7-1
Managing administration data between two Teamcenter sites . . . . . . . . . . . . . . . . . . . . . 7-2
Reconciling difference in administration data between Teamcenter sites . . . . . . . . . . . . . . 7-2
Working with administration data reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Administration data reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Generate an administration data report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Generate an administration data comparison report . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Exporting administrative data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Export partial administration data from Teamcenter Environment Manager . . . . . . . . . . . . 7-5
Export full administration data from Teamcenter Environment Manager . . . . . . . . . . . . . . . 7-7
Importing administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Administration data import behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Perform a dry run of administration data import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11
Working with TC XML administration data files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Import administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
View a sites administration data import history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Standard mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Standard PDX mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Teamcenter Data Exchange concepts and components . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
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-7
Data synchronizer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-8
Identity manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-9
Ownership manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-10
Siemens PLM Software briefcase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-12
File Management System file transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-13
Security Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-13
Synchronizing a Teamcenter database to an LDAP repository . . . . . . . . . . . . . . . . . . . . . D-1
ldapsync utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1

LDAP syncrhonization concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1
Objects synchronized by the ldapsync utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1
Object nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1
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

Contents
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-8
Group mapping preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D-9
Role mapping preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-11
Data synchronization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-12
Differentiate groups and roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-13
Link to separate LDAP directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-13
Synchronize Teamcenter to an LDAP repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-14
ldapsync utility troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-14
Reset an external user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-14
ldapsync cannot find nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-15
Sun ONE Directory Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-15
Microsoft Active Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-18
Data exchange preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-1

Data Exchange preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-34
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-1
Figures
Bulk loader components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17

FSC for Teamcenter host 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-29
FSC for Teamcenter host 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-30
Collapsed standard style sheet view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18
Customized style sheet with subtypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19
Customized style sheet with AdditionalAttributes elements . . . . . . . . . . . . . . . . . . . . 2-20
Island of data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16
TC XML root element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16
TC XML object reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17
Typical TC XML island structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
Organizational and administrative TC XML elements . . . . . . . . . . . . . . . . . . . . . . . . 5-18
XML elements for replicatable objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
TC XML Header element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
GSID-based organization objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24
Object referenced by child GSID elemId attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24
TC XML file with POM stubs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-25
Create, update, and skip sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
Validation log file in Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-51
Object nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-2
LDAP person object mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-5
LDAP group and role object mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-9

Contents
Contents
Tables
Item attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26

Anchor elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
ItemRevision attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29
Form attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
ImanRelation attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31
PSBOMView attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32
PSBOMViewRevision attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33
PSOccurrence attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
PSOccurenceThread attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36
Dataset attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36
RevisionAnchor attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
ImanFile attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
User attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40
Group attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40
Tool attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41
ImanType attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41
ImanVolume attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41
DataseType attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41
ItemSummary dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
ItemRevSummary and DocumantRevSummary datasets . . . . . . . . . . . . . . . . . . . . . 7-11

Chapter 1: Introduction
Getting started with Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Teamcenter Data Exchange interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Basic concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

Data Exchange use cases and roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Teamcenter upgrade and other transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Data Exchange concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Briefcase file exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Teamcenter offline exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Siemens PLM Software briefcase file exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Supplier site exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
4th Generation Design data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
PDX export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13
Teamcenter variant schema exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
Special characters in TC XML files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
Requirement objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Vendor management objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Multiple language support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Bulk loading data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17
Configured BOM export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17
Multifield key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
Installing Teamcenter Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18

Planning your installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
Installation worksheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-22
Teamcenter server installation requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-23
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24
Teamcenter configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24

Teamcenter configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24
Create Teamcenter Integration Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24
Teamcenter Integration Framework configuration process . . . . . . . . . . . . . . . . . . . . . . . 1-26
Define remote sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-27
Define Teamcenter preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28
File Management System (FMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28
FMS Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28
Create an FMS key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28
Configure FMS for Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-29
PLM00094 11.2 Data Exchange

Configuring Teamcenter Integration Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-30
Configure sites and mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-30
Configure data mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-31
Configure data mapping for ITAR license data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-32
Configure Teamcenter Integration Framework for FMS . . . . . . . . . . . . . . . . . . . . . . 1-33
Transfer modes in Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-34
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-34
Transfer option sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-35
Local versus remote transfer option sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-35
Transfer CATIA alternate shape representations . . . . . . . . . . . . . . . . . . . . . . . . . . 1-35
Create version 0 transfer option set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-35
Set a rule to allow transfer of ownership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-36
Define users, groups, and rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-36
Closure rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
Verifying the transfer configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37

Verify FMS configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37
Verify transfer from Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-38
Data Exchange PLM00094 11.2

Chapter 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 thin client or rich client interface.
Teamcenter Data Exchange interface

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.
PLM00094 11.2 Data Exchange 1-1

Chapter
Chapter 1: 1: Introduction
Introduction
Basic concepts
Data Exchange use cases and roles

Teamcenter Data Exchange provides a solution for various data sharing scenarios. 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.
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.
1-2 Data Exchange PLM00094 11.2

Introduction
You can also use the integration framework components to transition third-party or custom systems,
such as non-Siemens PLM 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 PLM 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 PLM 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 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

Chapter
Introduction
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.
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.
• 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 by you can transfer an object. The different transfer options are:
o Include All Versions

o Latest Versions
o Selected Version
o Include Entire BOM
o 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.
• 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.

Introduction
• File Management System (FMS) file transfer

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:
o Get objects for ownership transfer.
o Transfer ownership to site.
o Update ownership transfer to source site.
• Organizational/license object audit logs

Chapter
Introduction
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:
o Fnd0LicenseChangeAudit
o Fnd0LicenseExportAudit
o 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:
o ADA_License
o ClosureRule
o Condition
o CondValAgent
o CondValAgentRevision
o CondValData
o CondValDataRevision
o Filter
o Fnd0AlgebraicFormula
o FunctionalityRule
o Group
o GroupMember
o IdContext
o ImanType
o NoteType
o PIEActionRule
o POM_imc
o PropertySet
o PSOccurrenceType
o PSViewType
o ResourcePool
o RevisionRule
o Role
o TransferMode
o TransferOptionSet
o TC_Project
o UnitOfMeasure
o User
o VerificationRule

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 PLM 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.
Siemens PLM 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 is an
Eclipse-based application that 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.

Chapter
Introduction
Feature Briefcase PLM XML

Use case focus Managed suppliers or General data exchange
umanaged 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
only XML compatible applications
Toolkit/SDK support None planned PLM XML SDK
Related topics
• Using briefcase files with unmanaged sites
• Configuration required for unmanaged site transfers
• Briefcase Browser capabilities
• How autobaseline (auto_baseline) works for NX data
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 PLM 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

Introduction
• 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:
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. supports massive product designs with millions of business objects and
also supports enhanced collaborative business processes. You can exchange 4GD data by exporting

Chapter
Introduction
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.
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.

Introduction
o If PtnB is the root object:

LinkAB, membershipB1, memebershipB2, and PtnB objects are exported as full objects.
The memberB1 and memberB2 objects are exported as full objects.
o 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.
o If Ptn1 is the root object, only the Ptn1 object is exported.
o If Ptn2 is the root object, the Link1 and Ptn2 objects are exported as full objects.
o 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

Chapter
Introduction
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.
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 ShapeDesignRevision
together in single operation, set this option object is always exported with the ShapeDE
to true. 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 object.
island of data of an associated
item/BVR with a design element.
opt_workset_rlz_de By default, the Workset/Subset Realization map objects

structure is exported separately from (Rlz0ModelRealizationMap) are
DesignElement objects. If you want to exported as full objects. The source object
export the Workset/Subset structure and can be a DesignFeature, DesignElement,
DesignElement objects together in a single or DesignControlElement object.
operation, set this option to true.
opt_exp_cfgbom Sets the export mode for either configured or Configured and unconfigured behavior are
unconfigured 4GD data, Set to true to export explained following this table.
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:

Introduction
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
element are 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 realization maps that are not in the TC XML file.
• Partition
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 PDX package to Teamcenter. The following figure shows how the Teamcenter
components interact to export a PDX package.

Chapter
Introduction
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 TC XML files

For Teamcenter 10.1.4 and later versions, when you export a variable length array (VLA) of string
type, 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

Introduction
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.
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.

Chapter
Introduction
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:
o 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.
o 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.
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.

Introduction
• 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
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.

Chapter
Introduction
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.
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.
Related topics
• Teamcenter components required for transition
• Overview of the site consolidation process
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.

Introduction
• (Optional) Install Security Services if you want single sign-on (SSO) functionality.
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

Chapter
Introduction
Worksheet 2 – Teamcenter web tier information (use a separate sheet for each site)
DEPLOYABLE-FILE-NAME
Enterprise Application Registration ID
LogVolumeName
LogVolumeLocation

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

Chapter
Introduction
Worksheet 4 – Security Services information
Teamcenter site 1 transfer user
Teamcenter site 1 site ID
Teamcenter site 1 pseudo site ID

(SSOAppID)
Teamcenter site 2 pseudo site ID
(SSOAppID)
Teamcenter site3 pseudo site ID
(SSOAppID)
Worksheet 6 – integration framework information
Map control files
Site ID
Teamcenter site IDs
Teamcenter administrator user name

and password
Teamcenter user name and password.
fsc.uris
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.

Introduction
Teamcenter server installation requirements

Data Exchange requires that the following Teamcenter server features be installed during the server
installation process:
• Teamcenter Integration Framework
o (Optional) PMM Integration
o (Optional) SRM Integration
o (Optional) Substance Compliance Integration
o (Optional) Enterprise Integration
• Four-tier architecture
• FMS

Chapter
Introduction
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.
Related topics
• Remote procedure call security
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.
Create Teamcenter Integration Framework

You can create a stand-aloneTeamcenter Integration Framework or create a Teamcenter Integration
Framework in an existing Teamcenter environment. A stand-alone Teamcenter Integration Framework
has the advantage that it can be run on a separate host from the Teamcenter server. Both are
configured using the Teamcenter Integration Framework configuration wizard.
1. If you are installing a stand-alone Teamcenter Integration Framework:
a. Start Teamcenter Environment Manager (TEM) from the Teamcenter software distribution
image. Do not start TEM from the install directory of an existing Teamcenter environment.
Alternatively, you can start TEM from the command line of the Teamcenter software
distribution image with the Java runtime environment (JRE) that you want to use, for example:
C:\apps\tc111_win\tem -jre “D:\Program Files\Java\jdk1.7.0_17\jre

Introduction
b. Select the language in the Installer Language dialog box.
c. In TEM, choose Teamcenter in the Welcome to Teamcenter panel.
d. Click Install in the Install / Upgrade Options panel.
e. Type a new identification and description in the Configuration panel if you do not want
to use the defaults.
f. In the Solutions panel, select Teamcenter.

Note
Ensure that all other check boxes on this panel are cleared.
2. If you are installing in an existing Teamcenter environment:

a. Start TEM from the install directory in the TC_ROOT directory of your Teamcenter installation.
b. Choose Configuration Manager in the Maintenance panel.
c. Select the Teamcenter configuration where you want to install Teamcenter Integration
Framework in the Old Configuration panel.
d. Choose Add/Remove Features in the Feature Maintenance panel.
3. In the Features panel, expand Extensions→Platform Extensibility.

If you are connecting to Teamcenter Enterprise, select Enterprise Integration.
If you are connecting to Product Master Manager, select PMM Integration.
If you are connecting to Supplier Relationship Management, select SRM Integration.
If you are connecting to Substance Compliance, select Substance Compliance Integration..
Note
To use the Enterprise Integration, TEM must be able to access the Teamcenter Enterprise
connector files (mti.jar and mtiems,jar) for the site. You must supply its location in a
later step.
If you are installing in an existing Teamcenter environment, you cannot change the installation
directory. Teamcenter Integration Framework is installed in the tcif directory under your existing
TC_ROOT directory. Otherwise, you can enter the path to the desired directory and Teamcenter
Integration Framework is installed in the tcif directory under the path you enter.
4. If you are installing a stand-alone Teamcenter Integration Framework, enter the path to the Java
Development Kit (JDK) in the Path box of the Java Development Kit panel.
5. If prompted for the TcIntegrationFramework.zip file, browse to the tc directory of the install
image to locate the file.
6. You can accept the default port numbers or click Advanced to choose different ports. The
default values are:

Chapter
Introduction
Web Server Port: 8080

LDAP Server Port: 14389
Security Port: 9001
Web UI Port: 8040
Active MQ Port: 61616
If you change the default values, make note of them. You need the Web Server Port number
when defining your sites in Teamcenter, and you need the Web UI Port number to access the
Teamcenter Integration Framework configuration interface when you enter the address directly in
a web browser.
7. If you are connecting to Teamcenter Enterprise, enter the path to the Teamcenter Enterprise
connector files (mti.jar and mtiems.jar) in the Enterprise Integration Setting panel.
TEM displays the Confirmation panel. Click Start to confirm the settings and start the
Teamcenter Integration Framework installation. It may take several minutes to complete the
installation. TEM displays a success message when the installation completes.
On Windows systems, a shortcut icon for Teamcenter Integration Framework in placed on your
desktop. This can be used to start Teamcenter Integration Framework. Alternatively, you can
start Teamcenter Integration Framework in a command prompt window by running the trun script
in the tcif\container\bin directory.
Teamcenter Integration Framework configuration process

You use the Teamcenter Integration Framework configuration wizard to perform this process. The
actual wizard procedure is described later after you have obtained all of the required information.
1. Launch the Teamcenter Integration Framework configuration interface. Type the following
address in your web browser:
https://host-name:TcIF-web-ui-port/tcif/controller/webclient
2. Choose Configure→Wizard to and choose the Configure a site wizard
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.

Introduction
b. Set the Teamcenter FMS ID and URL.
c. Set the Teamcenter thin client 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.
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.

Chapter
Introduction
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.
Preference name Value

GMS_offline_use_TcGS FALSE
TCIF_user_name IFAdmin
TCIF_user_password admin
http://host-name:port-number/tcif
Use the name of the host for the Teamcenter
TCIF_url Integration Framework server as the host-name
and the Teamcenter Integration Framework web
server port as the port-number (8081 by default).
Related topics
• What are preferences?
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 FMS.key. This key value
must be the first non-UNIX style comment line in the file.
# This file (FMS.key) contains a 128–bit key for FMS tickets
f6968bd55d740f44ebacaba09c1313c4

Introduction
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 FMS.key file.
6. Verify FMS access for your Teamcenter site using the fscadmin utility:
fscadmin -s URL-for-FSC -k common-key-file ./status
For example:
fscadmin -s http://cvg101:4001 -k FMS.key ./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 canconfigure 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="FMS.key"/>
<ticket version="M050" keyfile="FMS.key"/>
<ticket version="F100" keyfile="FMS.key"/>
<fccdefaults>
………………
……………….
</FMSenterprise>
</FMSworld>
FSC for Teamcenter host 1

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

Chapter
Introduction
<!— 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="FMS.key"/>
<ticket version="M050" keyfile="FMS.key"/>
<ticket version="F100" keyfile="FMS.key"/>
<fccdefaults>
.
.
.
.
.
.
</FMSenterprise>
</FMSworld>
FSC for Teamcenter host 2
Configuring Teamcenter Integration Framework
Configure sites and mapping
There are several files in Teamcenter Integration Framework (TeamcenterSoaConfig.xml,

sitemap.xml, datamapper.xml) 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. Type the URL for the Teamcenter thin client web application in the Thin Client URL box, for
example:
http://app-server-host:9080/tc
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
mti.jar and mtiems.jar files, Teamcenter site ID, MUX host name, MUX port number, and the
Teamcenter Enterprise thin client web application URL.

Introduction
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 datamapper.xml file. This files defines a source and target site and the control file used
for that direction of transfer.
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 datamapper.xml 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.

Chapter
Introduction
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.
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:
TcStubtoTcObj.xsl
Teamcenter_to_TC_Enterprise_control.txt
TcEntObjtoTcEntStub.xsl
RemoveFlaggedObj.xsl
RemoveFlaggedRel.xsl
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.
TcStubtoTcObj.xsl
Teamcenter_to_TC_Enterprise_control.txt
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.
TceStubtoTceObj.xsl
TC_Enterprise_to_Teamcenter_control.txt
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.

Introduction
Note
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 create the GMS_expired_or_locked_ada_licenses_bypass preference and set its
value to TRUE.
1. 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
→TC_Enterprise_to_Teamcenter_Foundation
→Factor
2. Start the Mapping Designer and open the TC_Enterprise_to_Teamcenter_Foundation project.
3. Open the Factors Search view and search for the WrkImAda_add_license_list_ADA to
confirm that it is in the project.
4. 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 globalservices.properties 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 globalservices.properties file in the datastore.
1. Log on to Teamcenter Integration Framework and choose Configure→Sites and Monitoring.

Chapter
Introduction
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: http://MILLABV2:4544
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.
Caution
Before performing any TC XML exports, you must remove any references to obsolete attributes
and classes from custom closure rules or property sets. Additionally, you should remove any
deprecated attributes and classes from custom closure rules or property sets.
To identify deprecated and obsolete classes and attributes, see the Teamcenter 10.1.4
README file.
Note
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:ATTRIBUTE.IsContext:DO
If you do not add this clause, the transfer fails during import with an error message indicating
the export failed at the data import step, and the log file shows the IsContext attribute of the
POM_catia_absocc class is empty.
Caution
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.
Related topics
• Property sets
• Transfer mode objects

Introduction
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.
For additional information about managing transfer option sets, see the PLM XML/TC XML Export
Import Administration.
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, 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.
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.

Chapter
Introduction
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.
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

Introduction
From Teamcenter Enterprise To Teamcenter

WPS team Owning user and owning user’s default group
Vault Owning user and owning user’s default group
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 Teamcenter 9.1 Teamcenter 9.1 configured
standard scope Prior to Teamcenter 9.1 export to HL TC XML export to LL TC XML
rule object (defaultTransferModes.xml) (defaultTcxmlScopeRules.xml) (defaultTcxmlScopeRules.xml)
TIEUnconfiguredExportDefault
Transfer option set TIEOptionSetDefault TIEConfiguredExportDefault_LL
TIEConfiguredExportDefault
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:
fscadmin -s http://TcEntHost:4444 -k=FMS_ent.key ./status
FSC id: FSC_TcEntHost, site:TcEntHost

Chapter
Introduction
running for 3 days, 17 hours, 3 min, 46 sec

Current number of file connections: 0
Current number of admin connections: 1
fscadmin -s http://cvg101:4001 -k=FMS.key ./status
FSC id: FSC_TcHost1, site:CVG101
fscadmin -s http://cvg102:4001 -k=FMS.key ./status
FSC id: FSC_TcHost2, site:CVG102
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 http://cvg101:4001 -k=FMS.key ./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.

Chapter 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-2
Delta export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Synchronize changes for a specific BOM configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Export a bill of materials to a briefcase file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Export a configured bill of materials to a briefcase file (with Global Services) . . . . . . . . . . . 2-5
Mapping configured BOM export files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Export from Teamcenter (using Global Services) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Import to Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
Using site checkout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9

Check out to a remote site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Check in from a site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
Cancel checkout to a site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
Check replica synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
Exporting Supplier Relationship Management data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11

Configure Supplier Relationship Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
Export to SRM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
Accessing remote objects . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12

Object Directory Service (ODS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
Publish to default ODS . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
Publish to the publication list . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
Unpublish ODS objects . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
Search for remote items . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
Using PDX export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15

Configure PDX export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
Defining a PDX workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
Creating a custom PDX style sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
Subtyped objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
Custom attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19
PDX specification elements not in the standard style sheet . . . . . . . . . . . . . . . . . . . 2-20
Exporting PDX data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20
Export a PDX package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20
Access a PDX package from a workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21
Query for a PDX package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21
Delete a PDX package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22
Download a PDX package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22

Chapter 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 False
only 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.

Chapter
Chapter 2: 2: Transferring
Transferring objects
objects usingusing business
business access
access rulesrules
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
For Teamcenter 9.1 and later, 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.
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

Transferring objects using business access rules
• 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.
• 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.
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.

Chapter
business access
access rulesrules
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\inp.txt–svrule=VRule1 –processSuppressedOcc
–optionset=TIEConfiguredExportDefault_LL —file=d:\temp\out.xml
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\inp.txt
–svrule=VRule1 –processSuppressedOcc –optionset=TIEConfiguredExportDefault_LL
–file=d:\temp\out_sync.xml
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.

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

Chapter
business access
access rulesrules
The utility generates the output file in the same directory as the input file with the same filename
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.
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
indicator process starts.
Send email Requests that Data Exchange send an email when a transfer is
notification complete 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.
Item options Description

Include All Exports all revisions. When transferring site ownership, this is the only
Revisions option available.
Latest Revision Exports the latest revision regardless of whether it is a working or
Only 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 Exports only the revisions selected in the workspace.

Revision(s) 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
Status Only selected from the list.
Product structure
options Description
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
Item Only no 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

Chapter
business access
access rulesrules
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.
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:

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.
• 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.

Chapter
business access
access rulesrules
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.
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.
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:
Property
Primary object Related property or action
class type Primary object Relation type object 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.

Chapter
business access
access rulesrules
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.
Export to SRM
Before you can export objects to Supplier Requirement 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.
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 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.
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.

Chapter
business access
access rulesrules
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 with no further interaction
Default ODS required.
From all ODS Choose Tools→Multi-Site Unpublishes the object
servers Collaboration→Unpublish→From All with not further interaction
Published - To ODS Site(s) required.
From specific ODS Choose Tools→Multi-Site Displays the Unpublish
servers Collaboration→Unpublish→From From ODS Site dialog
Specific ODS Site(s) box 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 From Default ODS Site
different server if Default ODS… dialog box where you
the default is not can confirm the default
the expected ODS ODS server or select the
server desired ODS site.
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 defaultTransfermodes.xml 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.
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 (Tc2PDX.xsl file) located in the data directory of your
TC_DATA directory of your Teamcenter installation.
Siemens PLM Software recommends renaming the style sheet, for example,
WidgetCorpTc2PDX.xsl.
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.

Chapter
business access
access rulesrules
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.

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:
http://hostname:8080/tcif
f. Select the Is Offline check box.
g. Click Create.
4. For non-Global Services based export, attach the customized Tc2PDX.xsl 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\WidgetCorpTc2PDX.xsl
-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 <Tc2PDX.xsl>
5. Set your Teamcenter preferences.

• Set the PDX_pkg_file_name preference at the site location.
• If you are providing PDX options sets based on the destination site, you must 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

6. Set the PROCESS_WARM and PROCESS_TARGET parameter in the server pool properties
file (serverPoolconfiguration-ID.properties) 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
ManufacturerPart ManufacturerPart
Vendor Contact

Chapter
business access
access rulesrules
<xsl:if test=”count(//tc:Item)>0
or count(//tc:Part))>0
or count(//tc:CommercialPart))>0”>
<xsl:element name=”Items”>
<xsl:for-each select=”tc:TcXML/tc:Item”>
⋮
<xsl:for-each select=”tc:TcXML/tc:Part”>
⋮
<xsl:for-each select=”tc:TcXML/tc:CommercialPart”>
⋮
</xsl:element>
</xsl:if>
<xsl:if test=”count(//tc:EngChange)>0”>
<xsl:element name=”Changes”>
<xsl:for-each select=”tc:TcXML/tc:EngChange”>
⋮
</xsl:element>
</xsl:if>
<xsl:if test=”count(//tc:ManufacturerPart)>0”>
<xsl:element name=”ManufacturerPart”>
<xsl:for-each select=”tc:TcXML/tc:ManufacturerPart”>
⋮
</xsl:element>
</xsl:if>
<xsl:element name=”History”>
⋮
</xsl:element>
<xsl:if test=”count(//tc:Vendor)>0”>
<xsl:element name=”Contacts”>
<xsl:for-each select=”tc:TcXML/tc:Vendor”>
⋮
</xsl:element>
</xsl:if>
Collapsed standard style sheet view

<xsl:if test=”count(//tc:Item)>0
or count(//tc:Part))>0
or count(//tc:MyCustomPart))>0
or count(//tc:CommercialPart))>0”>
<xsl:element name=”Items”>
<xsl:for-each select=”tc:TcXML/tc:Item”>
⋮
<xsl:for-each select=”tc:TcXML/tc:Part”>
⋮
<xsl:for-each select=”tc:TcXML/tc:MyCustomPart”>
⋮
<xsl:for-each select=”tc:TcXML/tc:CommercialPart”>
⋮
</xsl:element>
</xsl:if>
<xsl:if test=”count(//tc:EngChange)>0”>
<xsl:element name=”Changes”>
<xsl:for-each select=”tc:TcXML/tc:EngChange”>
⋮
</xsl:element>
</xsl:if>
<xsl:if test=”count(//tc:ManufacturerPart)>0”>
<xsl:element name=”ManufacturerPart”>
<xsl:for-each select=”tc:TcXML/tc:ManufacturerPart”>
⋮
</xsl:element>
</xsl:if>
<xsl:element name=”History”>
⋮
</xsl:element>
<xsl:if test=”count(//tc:Vendor)>0”>
<xsl:element name=”Contacts”>
<xsl:for-each select=”tc:TcXML/tc:Vendor”>
⋮
</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⋮>
<xsl:value—of
select=⋮//tc:ImanFile/tc:GSIdentity(@elemId=$dsId)/../@byte_size"/>
</xsl:attribute>
<xsl:attribute name="versionIdentifier⋮>
<xsl:value—of
select=⋮//tc:GSIdentity(@elemId=$imsoId)/../@version_number"/>
</xsl:attribute>
<xsl:attribute name="attachmentModificationDate⋮>
<xsl:value—of
select=⋮//tc:ImanFile/tc:GSIdentity(@elemId=$dsId)/../@last_mod_date"/>
</xsl:attribute>
<xsl:attribute name="extraAttribute⋮>
<xsl:value—of select=⋮Yes"/>
</xsl:attribute>

Chapter
business access
access rulesrules
<xsl:element name="AdditionalAttributes⋮>
<xsl:element name="AdditionalAttribute⋮>
<xsl:attribute name="name⋮>
<xsl:text>CustomAttribute1</xsl:text>
</xsl:attribute>
<xsl:attribute name="value⋮>
<xsl:value—of
select=⋮//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
• 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.

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 Indicator Displays the progress pane automatically when the process starts.
email Notification Requires Data Exchange to send an email when the transfer is
complete to the address associated with the requesting user.
e. (Optional) Click export options to select the transfer options for the PDX package.
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.

Chapter
business access
access rulesrules
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.
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.

Chapter 3: Exchanging data with suppliers
Using briefcase files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Using briefcase files with unmanaged sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Configure briefcase for site checkin and checkout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Configure Teamcenter for Briefcase Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Briefcase Browser site configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Configure Teamcenter for briefcase mail notification . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
Configure 4th Generation Design data exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
Migrate a supplier site from a managed to unmanaged site . . . . . . . . . . . . . . . . . . . . . . 3-11
CAD design exchange business process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
Configure 4th Generation Design data exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
Unmanaged site briefcase transfers . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 3-14

Configuration required for unmanaged site transfers . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Export a configured briefcase file . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Import validation results . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 3-16
Import a configured briefcase file . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . 3-17
Transferring a briefcase package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17

Briefcase transfer process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17
Package the data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
Transfer the package file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20
Import the package file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20

Chapter 3: Exchanging data with suppliers
Using briefcase files

Using 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. Unamanged 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.
• May require data push (manual file transfer, such as email attachment) unless you have Supplier
Collaboration Foundation installed.
Caution
To use delta export functionality, you must ensure that the system time (GMT) of the
Teamcenter server and the database server are the same. If they are not synchronized,
you can have unexpected behavior.
Also, if there is an access change to any objects, any subsequent delta export does not export
the object that has the change. Therefore, if you change object access, do not use delta
export. Perform a full export to get properly synchronized objects.
If your site is a managed Teamcenter site, you must perform the migration procedure before using
Briefcase Browser at your site.
Related topics
• Install Briefcase Browser
• Startup configuration
• Briefcase Browser capabilities
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.

Chapter
Chapter 3: 3: Exchanging
Exchanging
data data with suppliers
with suppliers
Note
To export an assembly that is either:

• 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 defiintion button ( ) and type GMS_tcxml_string_separator
in the Name box.
4. Select GMS Offline.Import 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.
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.

Exchanging data with suppliers
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%\defaultTcxmlScopeRules.xml
-scope_rules -scope_rules_mode=overwrite
tcxml_import -u=infodba -p=xxx
-file=%TC_DATA%\siteConsolidationInternalClosureRules.xml
-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.
4. Ensure the following preference values are set at the site location:
TC_gms_export_default_transfermode=TIEExportDefaultTM
TC_gms_import_default_transfermode= TIEImportDefault

Chapter
Exchanging
with suppliers
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 PLM
Software recommends the following settings:
• Protection Scope
User
• 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 PLM Software recommends the following settings:
• Protection Scope
User
• Category
General
• Environment
Disabled
• Multiple
Single
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 site-id.properties file as a minimum.

The create_briefcase_browser_config_package utility creates a package compressed 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=infodba -p=infodba -g=dba
-bbDir=C:\apps\bb
The package name is the OEM site name. It contains the CustomMappings.xml file with the OEM
site ID set as the target site ID. It also contains the TCXML.xsd schema file, generated from the
OEM and the OEM configuration file
site-id.properties
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:
TCXML.xsd
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 TCXML.xsd file does not exist in the configuration directory for your site, Briefcase Browser
uses the standard Teamcenter schema.
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.
CustomMappings.xml
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.
• The separator character the site requires between the item ID and revision.
• Custom type mapping to OEM objects.

Chapter
Exchanging
with suppliers
• Define the 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.
The following is sample content for this file:

<?xml version="1.0" encoding="UTF-8"?>
<custom_mappings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="../bce-core/CustomMappings.xsd">
<oem name="your_oem_name" site_id="87654321" tc_version="11.2.0"
auto_baseline="true" generate_validation_xml="true"
is_precise="true" separator="/">
<release_status_name>Snapshot</release_status_name>
<release_status_name>TCM Released</release_status_name>
<release_status_name>R2InWork</release_status_name>
</oem>
<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>
</multi_field_key>
<helper_object_map custom_type="CAD--Revision"
<helper_object_map custom_type="CAD--Master"
<helper_object_map custom_type="CAD--Revision--Master"
<item_type_mapping custom_type="B4Item">
<multi_field_key>
</multi_field_key>
<helper_object_map custom_type="B4ItemRevision"
<helper_object_map custom_type="B4ItemMaster"
<helper_object_map custom_type="B4ItemRevisionMaster"
<item_type_mapping custom_type="CommercialPart">
<multi_field_key>
</multi_field_key>
<helper_object_map custom_type="CommercialPart--Revision"
<helper_object_map custom_type="CommercialPart--Master"
<helper_object_map custom_type="CommercialPart--Revision--Master"
<item_type_mapping custom_type="Design">
<multi_field_key>
</multi_field_key>
<helper_object_map custom_type="Design--Revision"
<helper_object_map custom_type="Design--Master"
<helper_object_map custom_type="Design--Revision--Master"
<item_type_mapping custom_type="Part">
<multi_field_key>
</multi_field_key>
<helper_object_map custom_type="Part--Revision"

<helper_object_map custom_type="Part--Master"
<helper_object_map custom_type="Part--Revision--Master"
</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.
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 (TCXML.xsd) 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 CustomMappings.xml file, the first custom type defined in used. If there are no custom
types defined, Briefcase Browser maps the part to the standard Teamcenter.
CustomDatasetMappings.xml
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.
<?xml version="1.0" encoding="utf-8"?>

<custom_data_set_mapping xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<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"

Chapter
Exchanging
with suppliers
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 CAD attributes to qualified Teamcenter object attributes.
The user-defined attributes must be part of the configured TC XML schema (TCXML.xsd 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"?>


<CAD2TC_attribute_mappings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="cad_to_tc_attribute_map.xsd">

<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"
<attribute_mapping cad_part_attr="CALC_WEIGHT" tc_attr="nisCalculationWeight"
<attribute_mapping cad_part_attr="CALCULATIVE_COEFFICIENT"
tc_attr="nisCalculativeCoefficient"
<attribute_mapping cad_part_attr="Z_CENTROID" tc_attr="nisGravityZ"
tc_type="ItemRevision--Master"/>
<attribute_mapping cad_part_attr="Y_CENTROID" tc_attr="nisGravityY"
<attribute_mapping cad_part_attr="X_CENTROID" tc_attr="nisGravityX"
</CAD2TC_attribute_mappings>
visible-attributes.xml
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:
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:

Chapter
Exchanging
with suppliers
Sample files are provided for each of these configuration files in the
example\bbworkspace\exmple\configurations\example directory.

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 defiintion button ( ) and type Briefcase_tcmail_notification
in the Name box.
4. Select GMS Offline.Import 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 of delete the preference.
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.

Chapter
Exchanging
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.
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.

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.
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.
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.

Chapter
Exchanging
with suppliers
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 configured briefcase file

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 unmanage site must update, select the object and choose Tools→Site
Check-In/Out Check-out To Site.
Teamcenter displays the Check-out To Site dialog box.
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 Without Global Services dialog box.

6. (Optional) Type a reason statement in the Reason box.
7. Click the site button and select the target site.
8. Select TIEConfiguredExportDefault from the Option Set list.
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.


Chapter
Exchanging
with suppliers
Select the Replica Bypass option and any other desired export options.
Caution
You must select the Replica Bypass option to prevent import failures at the unmanaged
site on subsequent imports.
Note
Unmanaged sites do not have the ability to manage versions, 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.
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 ruleseteditor.bat 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_upodate_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.
6. Import the briefcase file and verify the validation forms for the imported item revision are present.
Import a configured briefcase file

1. Log on to Teamcenter and open the My Teamcenter or Structure Manager application and choose
Tools→Import→From Briefcase.
Teamcenter displays the Import from Briefcase Without Global Services 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

Chapter
Exchanging
with suppliers
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.
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. In the Export to Remote Site Via Global Services dialog box, 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.

Start immediate Causes the transfer request to process immediately. By default,
transfer Data 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
indicator the 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
6. (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.
7. 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.

Include All Exports all revisions. When transferring site ownership, this is the only
Revisions option available.
Latest Revision Exports the latest revision regardless of whether it is a working or
Only released revision.
Latest Any Exports only the latest revision with the specified release status
Revisions Only selected from the list.
Product structure
options Description
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
Item Only no 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

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.

Chapter
Exchanging
with suppliers

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.
8. Click OK.
Teamcenter sends a briefcase package file to your (export user) mailbox.
9. 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 11.2 generates briefcase
files with a bcz extension. Therefore, you must change the extension of the package file
to ugs before transferring it. Teamcenter 11.2 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.
Import the package file

1. In My Teamcenter, choose Tools→Import→From Briefcase.
2. In the Import from Offline Package dialog box, type the path to the briefcase package file
or click the browse button and select the file.


Start immediate Causes the transfer request to process immediately. By default,
transfer Data 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
indicator process starts.
Send email Request that Data Exchange send an email when the transfer is
Site Check-In after Automatically checks in any objects in the briefcase file that were
import checked out to a site.
4. Click OK.
Teamcenter imports the briefcase package file.

Chapter 4: Fast streaming data transfer
Low-level TC XML use cases and concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Custom data mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Data mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Preventing data loss . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3

Chapter 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 XMLfeatures:
• Export and import operations at the POM layer that bypass the business logic.
• Metadata transfer and ownership transfer that are two distinct processes.
• Synchronization:
o For the modified objects, the complete island of data is exported.
o 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 synchronization 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.
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.

Chapter
Chapter 4: 4: Fast Fast streaming
streaming data data transfer
transfer
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.
Related topics
• Introduction to the Mapping Designer
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.
• 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.

Fast streaming data transfer
Related topics
• Using the Mapping Designer

Chapter 5: Loading bulk data
Bulk load business process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Extract bulk data from legacy system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

Using the CSV to TC XML converter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Capabilities of the CSV to TC XML converter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Enable the CSV to TC XML converter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
Sample CSV files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7
Default CSV file requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8
Special characters in CSV files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
csv2tcxml.perl utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10
Using CSV conversion HTML reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
Using Dataset and ReleaseStatus objects in CSV files . . . . . . . . . . . . . . . . . . . . . . 5-13
Extending the data model for CSV file conversion . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
Island of data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
TC XML format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16
Prepare Teamcenter for bulk load import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21

Enable bulk loader utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
Process for bulk loading Teamcenter data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22
TC XML file with GSID references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
TC XML file with POM_stub elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24
Create, update, and infer-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-25
Teamcenter core data dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
Teamcenter data model diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42
Sample assembly structure in a TC XML file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43
Sample TC XML file with GSID references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44
Transfer bulk physical files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-46
Pre-import validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48

Pre-import validation utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48
Required schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49
Required helper objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50
Validate your TC XML test files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50
Pre-import validation logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50
Bulk load data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-51

Bulk loader utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-51
Sample bulk load repeat file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-54
Frequently asked questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-55

Chapter 5: Loading bulk data
Bulk load business process

Loading data into Teamcenter using bulk load utilities is performed using TC XML files in low-level
format that by pass the business logic rules providing performance enhancement when loading
legacy data.
Business process Description Roles

Extract legacy data for Determine the legacy data to extract Data administrator
import. into a low-level TC XML files containing
island of data that the bulk load utility Implementation engineer
can use as import files. Technical architect
Extract the legacy data to the common, Note
comma-separated values (CSV), format
that can easily be transformed to the Siemens PLM
required format. Software services
personnel can assist
Use the CSV to TC XML converter to in the conversion
create the required TC XML import files. process using special
tools they have
developed for this
process.
Prepare Teamcenter, Obtain and create bulk import utility System administrator
legacy data, and the key and configure 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:

Chapter
Chapter 5: 5: Loading
Loading
bulk bulk
data data
Extract bulk data from legacy system

Using the CSV to TC XML converter
Capabilities of the CSV to TC XML converter

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.

Loading bulk data
• 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.
o Validates that business object names and attributes used in column headers are valid in the
schema.
o Validates that Item, Dataset, ImanRelation, and PSBOMView type names are valid in the
schema.
o Validates that ReleaseStatus, PSViewType, and NoteType values are valid in schema.
o Validates that LOV values on attributes and length of string attributes are valid.
o 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.
• Limitation of the ultiity

Note
The CVS2TCXML utility does not support infer-delete of objects.
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

Chapter
Loading
bulk bulk
data data
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 and common column names for objects
Required column names Teamcenter objects in TC XML file

Item:item_id, ItemRevision:item_revision_id, Item, ItemRevision, Form, ImanRelation,
Item:object_type Anchor
Dataset:dataset_type, Dataset, ImanFile, ImanRelation,
Dataset:object_name, ImanFile:file_name, RevisionAnchor
ImanRelation:relation_type, Item:item_id,
ItemRevision:item_revision_id
parent_item, parent_rev, child_item, child_rev PSBOMView, PSBOMViewRevision,
PSOccurrence, PSOccurrenceThread
parent_item, parent_rev, child_item, ImanRelation (ItemRev→ItemRev or
child_rev, ImanRelation:relation_type Item→Item 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
Enable the CSV to TC XML converter
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.
You must have the following software installed to use the csv2tcxml.perl converter:
• If you have Teamcenter installed, you can use the tcperl version that comes with Teamcenter.
However, if you require a 64-bit version, you must install Strawberry Perl. If your CSV files
contain more than 100k lines, you need the 64-bit version.
If you cannot use tcperl, you need Strawberry Perl 64-bit with XML:Parser and XML::DOM
modules installed. You can download the latest version from:
http://strawberryperl.com/
• Java Runtime Environment 1.5 or later for formats using Teamcenter primary key identifiers
(PUIDs).
1. Install the Strawberry Perl environment by executing the following commands from a command
shell:
cpan
install XML:Parser
install XML::DOM
exit

Loading bulk data
2. Start a Teamcenter command shell as a Teamcenter administrator and change to the

TC_DATA\csv2tcxml_perl directory.
3. Type the following command to generate four files: csv2tcxml_all_attrs.txt,

csv2tcxml_required_attrs.txt, csv2tcxml_datamodel.txt, and csv2tcxml_column_names.txt.
tcperl csv2tcxml.perl install Teamcenter-administrator-password
4. Open the cvs2tcmxl_config.txt file and add appropriate values to the following variables:
• source_site
Target site ID in Teamcenter; this site must exist prior to attempting an import.
• volume
Name of the Teamcenter volume that contains the dataset files that are uploaded from
legacy system.
• sdpath
Operating system directory name for the volume; provide the name only, do not include
the path.
5. Modify and add additional configuration variables that you need in the cvs2tcmxl_config.txt
file. The file contains descriptions of the most commonly used variables and their default value if
they have one. You can add additional configuration variables.
Additional configuration variables
The following variables 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:
o 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.

Chapter
Loading
bulk bulk
data data
o 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:
o 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.
o 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:
o The attribute is defined at an abstract parent class.
o The attribute is used by multiple persistent child classes.
o 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.

Loading bulk data
puid_lookup_file
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 formattted 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
(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 ouput 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 items.csv 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|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 csv2tcxml.perl items.csv
The following listing shows a sample dataset.csv 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

Chapter
Loading
bulk bulk
data data
perl csv2tcxml.perl dataset.csv
The following listing shows a sample bom.csv 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

perl csv2tcxml.perl bom.csv item=exist
The following listing shows a sample grm.csv 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

perl csv2tcxml.perl grm.csv item=exist
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:

o For item files, an item revision and its related objects and attributes.
o For BOM files, a PSOccurence object and its related objects and attributes.
o For GRM files, a generic relation management rule and its related objects and attributes.
o 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:

Loading bulk data
• 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
o The separator character may be multiple characters. For example, you can specify
the variable value as column_sep|##.
o The pipe character must be used in the first (header) line, regardless of the value
specified in the column_sep variable.
o The column_sep varialble 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

. 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

< <
> >
& &
" "
' '
You must also set the skip_special_chars configuration variable to 1 in the cvs2tcmxl_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.

Chapter
Loading
bulk bulk
data data
Example for standard key values:
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
csv2tcxml.perl utility
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.
Syntax
perl csv2tcxml.perl [split] {file-name | reports input-directory}

[split-file-integer] [item=exist] [source_site=site-ID]
[volume=volume-name] [sdpath=volume-directory-name]
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
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.

Loading bulk data
Item=exist
Does not include the item and revision information in the TC XML output file for bill of materials
(BOM), generic relationship management (GRM), and datasets.
source_site=site-id
Defines the site ID of the exporting site. This site must be defined in Teamcenter prior to
importing the migrated objects. This argument is optional if you define the source_site value
in the cvs2tcmxl_config.txt file. It you supply this value, it overrides the value defined in the
cvs2tcmxl_config.txt file.
volume=volume-name
Defines the name of the volume where Teamcenter stores the files related to imported datasets.
This argument is optional if you define the source_site value in the cvs2tcmxl_config.txt file. If
you supply this value, it overrides the value defined in the cvs2tcmxl_config.txt file.
sdpath=
Defines the path to and name of the directory containing the volume where Teamcenter stores
the files related to imported datasets. This argument is optional if you define the source_site
value in the cvs2tcmxl_config.txt file. If you supply this value, it overrides the value defined in
the cvs2tcmxl_config.txt file.
Examples
• To read the input CSV file and generate a puid-based TC XML file for items:
perl csv2tcxml.perl items.csv
• 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 csv2tcxml.perl dataset.csv 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 csv2tcxml.perl bom.csv item=exist
• The following is an example of the converter's progress indicator output:

D:\tcxml> perl D:\scripts\csv2tcxml.perl D:\scripts\samples\items.csv source_site=10000
-> 0 of 5 : Processing
[D:\scripts\samples\items.csv] 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
[D:\scripts\samples\items.csv.log] ***
-> Total time = 0 seconds
Erorrs and warnings

The converter generates the following error messages:
• Required input (source_site) missing in config file and command line.

Chapter
Loading
bulk bulk
data data
• 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.
• 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.

Loading bulk data
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.
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

Chapter
Loading
bulk bulk
data data
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.
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 PSOccurrence.effectivities attribute points to the Effectivity object.

Loading bulk data
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:
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 it depends for its correct functional definition and usage within
Teamcenter.
Principal object The initial object used to start the traversal to determine an island of data.
Dependent object An object that must be included in the set of objects implied by the principal
object and 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:

Chapter
Loading
bulk bulk
data data
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 TCXML.xsd 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://www.tcxml.org/Schemas/TCXMLSchema, as shown in the following figure.
Note
TC XML root element

The TC XML root element has a format attribute that you can set to low_level or high_levelFor bulk
loading, you must set the attribute to low_level.

Loading bulk data
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:

Chapter
Loading
bulk bulk
data data
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
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.

Loading bulk data
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
[Group.name,User.user_id, Role.role_name]
ResourcePool# pool
[Group.name, 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 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 mixed
up in the file the import fails.

Chapter
Loading
bulk bulk
data data
XML elements for replicatable 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.

Loading bulk data
TC XML Header element
Prepare Teamcenter for bulk load import
Enable bulk loader utilities

A license is required to run the bulk loader utilities. Bulk load actions are protected by license
to ensure that users meet the proper qualification through the Siemens PLM Software Global
Sales and Services organization in cooperation with the Siemens PLM Software Research and
Development organization. You must obtain a license key from GTAC and set the value of the
SITCONS_AUTH_KEY environment variable to that license key.
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.
Note
The tcxml_xfer_ownership utility does not require a license key for the flip-the-switch
ownership feature.

Chapter
Loading
bulk bulk
data data
Process for bulk loading Teamcenter data

From the perspective of the Teamcenter components, you use the following process to load bulk
data into Teamcenter:
Note
For a high-level view of the bulk loader components and their relationship, see Bulk loading
data.
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.
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
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:
• Teamcenter core data dictionary

Loading bulk data
• 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:

o An elemId attribute that uniquely identifies the element (required).
o 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:
• 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.

Chapter
Loading
bulk bulk
data data
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.
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

Loading bulk data
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
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:

Chapter
Loading
bulk bulk
data 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.
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

Loading bulk data
Item attributes
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
Points to the User element
last_mod_user Yes
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
Points to the Group element
owning_group Yes
in the TC XML file.
owning_organization No
owning_project No
Points to the POM_imc
owning_site Yes
element in the TC XML file.
owning_user Yes
in the TC XML file.
parent_uid Yes
Class-id. Fast import
pid No
ignores this attribute.
preferred_global_alt No
process_stage_list No
project_list No
puid Yes
release_status_list No

Chapter
Loading
bulk bulk
data data
Item attributes
revision_limit Yes Typically set to 1.
revision_number Yes Typically set to 0.
timestamp No
uom_tag No
wso_thread No
Anchor elements
acl_bits No
archive_date No
archive_info No
backup_date No
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
in the TC XML file.
lsd No
managed_objects No
owning_group Yes
in the TC XML file.
owning_user Yes
in the TC XML file.
owning_site Yes
parent_uid Yes
puid Yes

Loading bulk data
ItemRevision attributes
acl_bits No
active_seq No
archive_date No
archive_info No
backup_date No
creation_date No
date_released No
declared_options No
ead_paragraph No
elemId Yes
gde_bvr_list No
has_variant_module No
island_id Yes
item_revision_id Yes
Holds the PUID value of the
items_tag Yes
corresponding Item.
last_mod_date No
last_mod_user Yes
in the TC XML file.
license_list No
lsd No
object_application No
object_desc No
object_name Yes
object_type Yes
owning_group Yes
in the TC XML file.
owning_project No
owning_site Yes
owning_user Yes
in the TC XML file.

Chapter
Loading
bulk bulk
data data
ItemRevision attributes
parent_uid Yes
The class-id. Fast import
pid Yes
ignores the attribute.
project_list No
puid Yes
Holds the PUID value of
sequence_anchor Yes 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
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
elemId Yes
form_file Yes Typically set to n/a.
island_id Yes

Loading bulk data
Form attributes
last_mod_date No
last_mod_user
in the TC XML file.
license_list No
lsd No
object_desc No
object_name Yes
object_type Yes
owning_group Yes
in the TC XML file.
owning_project No
owning_user Yes
in the TC XML file.
owning_site Yes
parent_uid Yes
The class-id. Fast import
pid Yes
ignores the attribute.
project_list No
puid Yes
timestamp No
wso_thread No
ImanRelation attributes
elemId Yes
island_id Yes
lsd No

Chapter
Loading
bulk bulk
data data
ImanRelation attributes
owning_site Yes
parent_uid Yes
The class-id attribute. Fast
pid Yes
Import ignores the attribute.
primary_object Yes the primary object of the
ImanRelation object.
puid Yes
Points to the corresponding
relation_type Yes ImanType element in the
TC XML file.

secondary_object Yes the secondary object of the
ImanRelation object.
timestamp No
user_data No
PSBOMView attributes
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
island_id Yes
last_mod_date No

Loading bulk data
PSBOMView attributes
last_mod_user Yes
in the TC XML file.
license_list No
lsd No
object_desc No
object_name Yes
owning_site Yes
object_type Yes
owning_group Yes
in the TC XML file.
owning_user Yes
in the TC XML file.
parent_item Yes
parent_uid Yes
pid No
Import ignores the attribute.
project_list No
puid Yes
timestamp No
Points to the PSViewType

view_type Yes
wso_thread No
PSBOMViewRevision attributes
acl_bits No

Chapter
Loading
bulk bulk
data data
active_seq No
archive_date No
archive_info No
backup_date No
Points the PUID value
bom_view Yes of the corresponding
PSBOMView element.
creation_date No
date_released No
ead_paragraph No
elemId Yes
island_id Yes
is_precise Yes Typically set to 0.
last_mod_date No
last_mod_user Yes
in the TC XML file.
license_list No
lsd No
object_desc No
object_name Yes
object_type Yes
owning_group Yes
in the TC XML file.
owning_project No
Required for LL TC XML.
owning_site Yes Points to the POM_imc
owning_user Yes
in the TC XML file.
parent_uid Yes
pid Yes

Loading bulk data
project_list No
puid Yes
struct_last_mod_date Yes
timestamp No
wso_thread No
PSOccurrence attributes
alternate_etc_ref No
Points the PUID value of the
child_item Yes
corresponding item.
child_bv No
effectivities No
elemId Yes
island_id Yes
lsd No
notes_ref No
of the corresponding
occ_thread Yes
PSOccurrenceThread
occ_flags No
occ_type No
occurrence_type No
order_no No Typically set to 10.
owning_site Yes
parent_bvr Yes
PSBOMViewRevision

Chapter
Loading
bulk bulk
data data
PSOccurrence attributes
Required for low-level TC
parent_uid Yes
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
clone_stable_occ_uid No
elemId Yes
island_id Yes
lsd No
owning_site Yes
parent_uid Yes
pid Yes
import ignores this attribute.
puid Yes
timestamp No
Dataset attributes
acl_bits No
active_seq No
archive_date No
archive_info No
backup_date No

Loading bulk data
Dataset attributes
creation_date No
Points to the DatasetType
dataset_type Yes
date_released No
ead_paragraph No
elemId Yes
format_used No
island_id Yes
last_mod_date No
last_mod_user Yes
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_desc No
object_name Yes
object_type Yes
owning_project No
owning_group Yes
in the TC XML file.
owning_site Yes
owning_user Yes
in the TC XML file.
parent_uid Yes

Chapter
Loading
bulk bulk
data data
Dataset attributes
pid No
project_list No
puid Yes
ref_names No
ref_list Yes the corresponding ImanFile
ref_types No
Holds the PUID value
rev_chain_anchor Yes
RevisionAnchor element
in the TC XML file.
system_managed No
Points to the Tool element
tool_used Yes
in the TC XML file.
timestamp No
user_class No
wso_thread No
RevisionAnchor attributes
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

Loading bulk data
RevisionAnchor attributes
last_mod_user Yes
in the TC XML file.
lsd No
owning_group Yes
in the TC XML file.
owning_user Yes
in the TC XML file.
owning_site Yes
parent_uid Yes
pid Yes
puid Yes
rev No
Holds the values of the
revisions Yes corresponding Dataset
revisions.
timestamp No
ImanFile attributes
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
in the TC XML file.
lsd No
machine_type No

Chapter
Loading
bulk bulk
data data
ImanFile attributes
original_file_name No
owning_group Yes
in the TC XML file.
owning_user Yes
in the TC XML file.
owning_site Yes
parent_uid Yes
pid Yes
import ignores this attribute.
puid Yes
relative_directory_path No
released_version No
Contains the relative path
sd_path_name Yes 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
Points to the ImanVolume
volume_tag Yes
vm_info No
User attributes
elemId Yes
island_id Yes
user_id Yes Candidate key
Group attributes
elemId Yes

Loading bulk data
Group attributes
island_id Yes
name Yes Candidate key
Tool attributes
elemId Yes
island_id Yes
Candidate key
object_name Yes
ImanType attributes
elemId Yes
island_id Yes
type_class Yes Candidate key
type_name Yes Candidate key
ImanVolume attributes
elemId Yes
island_id Yes
Candidate key
volume_name Yes
DataseType attributes
elemId Yes

Chapter
Loading
bulk bulk
data data
DataseType attributes
Candidate key
datasettype_name Yes
island_id Yes
Teamcenter data model diagram

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.
The expanded view of the Top_item object and its children includes the dataset object attached
to the Child_1 object:

Chapter
Loading
bulk bulk
data data
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="http://www.tcxml.org/Schemas/TCXMLSchema">
- <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">
</ImanType>
- <User elemId="id3" island_id="0" user_id="infodba">
</User>
- <PSViewType elemId="id4" island_id="0" name="view">
</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"

Loading bulk data
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="">
</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">
</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="">
</ImanRelation>
pid="443" primary_object="#id80" relation_type="#id76" secondary_object="#id86" timestamp="QpEx6UvxI45M1A"
user_data="">
</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="">
</Form>
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="">
</Form>
- <ItemRevision acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
object_name="one" object_properties="0" object_type="ItemRevision" owning_group="#id75"
owning_organization="" owning_project="" owning_user="#id77" parent_uid="#id88" pid="758"
sequence_anchor="#id93" sequence_id="1" sequence_limit="3" structure_revisions="#id92"
timestamp="gBLx6UvxI45M1A" used_options="" variant_expression_block="" wso_thread="">
</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="">
</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="">
</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"
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"

Chapter
Loading
bulk bulk
data data
pid="594" process_stage_list="" project_list="" release_status_list="" revision_limit="1"

revision_number="0" timestamp="Q5Nx6UvxI45M1A" view_type="#id78" wso_thread="">
</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">
</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"
object_application="Teamcenter" object_desc="" object_name="one/A-View" object_properties="0"
object_type="BOMView Revision" owning_group="#id75" owning_organization="" owning_project=""
release_status_list="" revision_limit="1" revision_number="0" struct_last_mod_date="2010-09-29T10:24:26Z"
timestamp="gBCx6UvxI45M1A" wso_thread="">
</PSBOMViewRevision>
owning_group="#id75" owning_user="#id77" parent_uid="#id87" pid="520" timestamp="QtIx6UvxI45M1A">
</Anchor>
pid="443" primary_object="#id88" relation_type="#id76" secondary_object="#id96" timestamp="QtCx6UvxI45M1A"
user_data="">
</ImanRelation>
pid="443" primary_object="#id87" relation_type="#id76" secondary_object="#id97" timestamp="QtPx6UvxI45M1A"
user_data="">
</ImanRelation>
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="">
</Form>
object_application="Teamcenter" object_desc="" object_name="one/A" object_properties="0"
release_status_list="" revision_limit="1" revision_number="0" timestamp="QtMx6UvxI45M1A" wso_thread="">
</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>
Transfer bulk physical files

To transfer legacy system physical file data you must map a volume in Teamcenter to the directory
structure containing the physical files.

Loading bulk data
1. In the Organization application, create a logical volume, pointing to the location of the top
directory in the structure. For example, if you want to import the 2.txt physical file in the following
directory structure, type D:\voltest in the Windows Path Name box and type a name, such as
vol_test in the Volume Name box.
voltest
fol1
fol2
fol3
2.txt
2. In My Teamcenter, choose Edit→Options and locate the TIE_Volume_Map preference and

enter the map values. For example, if volume1 is the name used in the TC XML file to map to the
vol_test volume you create in Teamcenter, add or update the default value to volume1,vol_test
in the Values list.
3. Create a TC XML file for input to the low-level TC XML import operation to import the legacy
D:\voltest\fol1\fol2\2.txt file. The TC XML file requires the following ImanFile element:
• The file_name and original_file_name attribute values contain the name of the legacy file to
be imported, in this example, the 2.txt file.

Chapter
Loading
bulk bulk
data data
• The sd_path_name attribute contains the relative path of the legacy file from the logical
volume root, in this example, D:\voltest. In this example, fol1\fol2.
• The volume_tag attribute contains the elemId value of the ImanVolume element. This is the
volume map in the TIE_Volume_Map preference. In this example, volume1.
The file requires the following Dataset element:
The dataset refers to the ImanFile object through the ref_list attribute. This allows the legacy file
metadata to be transformed to the corresponding Teamcenter data model, for example:
ItemRevision→GRM→Dataset→Named Reference→ImanFile
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,

Loading bulk data
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 LLTCMXML.xsd schema to validate the input files. This file must
be in the TC_DATA directory. To generate this file and enable schema validation:
Note
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:
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-25-45.log] 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 LLTCXML.xsd 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.

Chapter
Loading
bulk bulk
data data
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 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:
CLASS.ItemRevision:CLASS.Item:ATTRIBUTE.items_tag:PROCESS+TRAVERSE: :I+R
Every Variant object must have a parent_Item object represented by:

CLASS.Item:CLASS.Variant: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:

Loading bulk data
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.
Syntax
tcxml_import [-u=user-id {-p=password | -pf=password-file} -g=group]

-file=xml-file-name -site=site-name
-bulk_load -bypassSiteCheck
[-h]

Chapter
Loading
bulk bulk
data data
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.
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.

Loading bulk data
-bypassSiteCheck
Allows import of TC XML data into the site from where it was exported. Use this argument
along with the -bulk_load argument for bulk update of attributes of local objects and import
of archived audit records.
Caution
Use this argument only with the -bulk_load argument for bulk update of attributes of local
objects and import of archived audit records.
-h
Displays help for this utility.
Restrictions
1. To use this argument you must set a license key value for the SITCONS_AUTH_KEY
environment variable. You must obtain the key from GTAC.
2. 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.
3. When importing a PSOccurrence object, the import file must contain the following attributes:
• xform
• notes_ref
• child_bv
• variant_condition
• alternate_etc_ref
4. 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 Item32.xml file into the Teamcenter site where you run the utility:
tcxml_import —u=infodba –p=infodba –file=D:\Temp\Item32.xml
–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.
• 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).

Chapter
Loading
bulk bulk
data data
• 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.
Sample bulk load repeat file

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
- <TCXML xmlns="http://www.tcxml.org/Schemas/TCXMLSchema">
- 
- <Group elemId="id1" island_id="0" name="dba">
</Group>
- <ImanType elemId="id2" island_id="0" type_class="ImanRelation" type_name="IMAN_master_form">
</ImanType>
- <User elemId="id3" island_id="0" user_id="infodba">
</User>
- <PSViewType elemId="id4" island_id="0" name="view">
</PSViewType>
- <POM_imc elemId="id5" island_id="0" site_id="-1589622576">
</POM_imc>
- <ItemRevision acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""
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="">
</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"
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=""
timestamp="gBMx6UvxI45M1A" uom_tag="" wso_thread="">
</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="">
</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"
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"
revision_number="0" timestamp="Q5Nx6UvxI45M1A" view_type="#id78" wso_thread="">
</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">
</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"
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"
revision_number="0" struct_last_mod_date="2010-09-29T10:24:26Z" timestamp="gBCx6UvxI45M1A" wso_thread="">

Loading bulk data

</PSBOMViewRevision>
owning_group="#id75" owning_user="#id77" parent_uid="#id87" pid="520" timestamp="QtIx6UvxI45M1A">
</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="">
</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="">
</ImanRelation>
object_application="Teamcenter" object_desc="" object_name="one" object_properties="0"
object_type="Item Master" owning_group="#id75" owning_organization="" owning_project=""
release_status_list="" revision_limit="1" revision_number="0" timestamp="QpPx6UvxI45M1A" wso_thread="">
</Form>
object_application="Teamcenter" object_desc="" object_name="one/A" object_properties="0"
release_status_list="" revision_limit="1" revision_number="0" timestamp="QtMx6UvxI45M1A" wso_thread="">
</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=""/>

Chapter
Loading
bulk bulk
data data
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 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.
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.

Loading bulk data
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/deploy.xml file. For more information about ODE
processes, see the following URL:
http://ode.apache.org/creating-a-process.html
If your processes may exist for longer than 10 minutes, configure the in-memmory ttl to longer than
10 minutes using the ode-axis2.mex.inmem.ttl property. This properties value is set in milliseconds
in the ode-working-dir/conf/ode-axis2.properties file. For example, the following set the ttl to 30
minutes:
ode-axis2.mex.inmem.ttl=1800000

Chapter 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

Chapter 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.

Chapter
Chapter 6: 6: Copying
Copying product
product data data

Copying product data
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 production environment to test environment. This can be used when a site was

Chapter
Copying product
product data data
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 making a copy of a Teamcenter environment that has the features you require
in your production site. You then use the bulk load feature to extract a copy of the desired product
data from the production site to 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
• -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 ( ).
Teamcenter displays the UnconfiguredBulkExtractDefault dialog box.

Chapter
Copying product
product data 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.

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.

Chapter
Copying product
product data data

• 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.

Chapter
Copying product
product data 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.
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.

Chapter 7: Managing administration data
Types of administration data you can export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Managing administrative data process descriptions and roles . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Partial administration data import for work groups business process . . . . . . . . . . . . . . . . . 7-1
Managing administration data between two Teamcenter sites . . . . . . . . . . . . . . . . . . . . . 7-2
Reconciling difference in administration data between Teamcenter sites . . . . . . . . . . . . . . 7-2
Working with administration data reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

Administration data reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Generate an administration data report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Generate an administration data comparison report . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Exporting administrative data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5

Export partial administration data from Teamcenter Environment Manager . . . . . . . . . . . . 7-5
Export full administration data from Teamcenter Environment Manager . . . . . . . . . . . . . . . 7-7
Importing administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9

Administration data import behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Administrative data import options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Style sheet import behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Perform a dry run of administration data import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11
Working with TC XML administration data files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Import administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
View a sites administration data import history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17

Chapter 7: Managing administration data
Types of administration data you can export

New administration management tools are available for exporting, importing, reconciling, viewing,
and comparing administration between sites. Both sites exchanging data using these tools should
be the same Teamcenter version to ensure proper operation. However, if they have the same data
model for the data being exchanged, they can be different versions and still operate properly. The
following types of administration data are supported:
Note
Mixed use of the new administration management tools and legacy tools, for example, the
dsa_util utility, can lead to inconsistent or corrupt data.
• Access Manager rules
• Organization data (users, groups, roles, and volumes)
• Preferences
• Saved queries
• Style sheets
• Subscriptions
Note
Only class-based subscriptions are considered administration data.
• Revision rules
• Workflows and their associated workflow access control lists (ACLs).

Note
Do not use the tcxml_export and txcml_import utilities to transfer administration data. Use
only the admin_data_export and admin data_import utilities with administration data.
Managing administrative data process descriptions and roles

Partial administration data import for work groups business process
The partial administration data import process allows you to assign individual people to work
individual administration components, for example, workflow templates. Each user can work on
an individual component. Users work in their own database (development environment) and then

Chapter
Chapter 7: 7: Managing
Managing administration
administration data data
export their administration component to a partial administration data file containing the category
of the component they are developing. The individual files (partial files) can then be loaded into
the production environment.
Managing administration data between two Teamcenter sites

You can use Teamcenter Environment Manager (TEM) to manage your administration data at
multiple sites. Additionally, you can use the administration data utilities to manage your data and
provide HTML- formatted reports of the administration data at a single site or compare the data
between two sites.
You can export and import data between sites, provided the schemas for the administration data,
and any related objects involved in the transfer, are the same at both sites. For example, if you
have custom business objects at the exporting site, and a revision rule refers to an instance of the
custom business object, the custom type must also exist in the schema at the importing site. In this
scenario, the import succeeds, but errors occur during activities involving the revision rule due to the
nonexistent custom business object.
Reconciling difference in administration data between Teamcenter sites

You may need to determine the why two sites are behaving differently or may want to ensure
the administration data is the same at both sites to allow consolidation of data. The process for
reconciling administration data between two sites consists of:
1. Export the administration data from both sites, using either the admin_data_export utility or
Teamcenter Environment Manager.

Managing administration data
2. Use the generate_admin_data_compare_report utility to compare the differences between

the sites.
3. View the comparison report. The report shows the areas that differ between the sites for each
type of administration data..
4. After you determine the administration data that requires modification, import the data that
requires updating from the other site using the admin_data_import utility or Teamcenter
Environment Manager. Set the appropriate override options during the import to ensure you get
the only the desired data modification at both sites.
Working with administration data reports
Administration data reports

To help you manage your Teamcenter site there are multiple administrative data reports that you can
generate. These reports are provided in an HTML format so you can use any browser to view them.
You use the generate_admin_data_report utility to create an administration data report for a site.
This type of report provides the following capabilities:
• Allows you to generate a report containing:
o All or any of the following categories
■ Revision rules
■ Saved queries
■ Style sheets
■ Subscriptions
■ Preferences
■ Workflows
o A select set of elements for any of the listed categories
• Provides a way for you to study configurations offline
• Allows you to analyze configurations much easier than using the rich client administrative
applications
• Provides where used information embedded on each page
• Generates an Access Manager (AM) report that includes analysis condition usage, accessor
type usage, and named ACL usage
• Allows easy analysis of preference overrides for site, group, role, and user
• Allows easy viewing of style sheet XML file with style sheet dataset
• Allows easy analysis of style sheet configurations
• Allows easy identification of misconfigured preferences

Chapter
• Allows easy analysis of preferences that have impact to administration categories, such as
organization, revision rules, saved queries, or style sheets
• Allows easy identification of ownership of configurations (owning user that can be affected by
AM rules)
The following additional reports are available for an individual site:

• Dry run import
Shows changes that will occur due to importing an administrative data file from another site prior
to doing the actual import. Use this to determine the affects of importing the administration data
without changing the existing data.
• Import history
Shows the administration data that was successfully imported at a particular point in time. The
report file contains the site name and a timestamp. You can use this to determine exactly when
changes occurred that may be affecting the behavior of the site.
You use the generate_admin_data_compoare_report utility to show the differences in

administration data report between two sites. You can compare any of the supported administration
data types. You must generate an administration data export file for each site and then use those files
as the source or target site input files.
Generate an administration data report

You use the generate_admin_data_report utility to generate an HTML report for the local site or
from an exported file from a remote site.
This is a Java utility that, by default, has the maximum Java heap size set to 1024M. For reports
that contain a large number of objects you may need to increase maximum Java heap size to avoid
out-of-memory errors or poor performance. If possible, set the maximum heap to at least to 4096M
for large reports. You can set this value using the BMIDE_SCRIPT_ARGS environment variable,
for example:
set BMIDE_SCRIPTS_ARGS=-Xmx4096M
Note
Java standards require that no more than 25 percent of total RAM be allocated to virtual
memory (VM). If the amount allocated to the Java VM exceeds this percentage, degradation
of performance can occur.
Generate an administration data comparison report

You use the generate_admin_data_compare report utility to generate an HTML report comparing
the source site export package to the local site environment or an exported file from a target site.
This is a Java utility that, by default, has the maximum Java heap size set to 1024M. For reports
that contain a large number of objects you may need to increase maximum Java heap size to avoid
out-of-memory errors or poor performance. If possible, set the maximum heap to at least to 4096M
for large reports. You can set this value using the BMIDE_SCRIPT_ARGS environment variable,
for example:

set BMIDE_SCRIPTS_ARGS=-Xmx4096M
Note
Java standards require that no more than 25 percent of total RAM be allocated to virtual
memory (VM). If the amount allocated to the Java VM exceeds this percentage, degradation
of performance can occur.
Exporting administrative data
Export partial administration data from Teamcenter Environment Manager

The partial administration data export allows individual administration components, for example,
workflow templates to be exported from the database. You can select the specific instances of
administration data by category, class, and specific attribute/value criteria by choosing the Partial
export option.
1. Start Teamcenter Environment Manager (TEM).
a. In the Maintenance panel, select Configuration Manager.
b. In the Configuration Maintenance panel, select Perform maintenance on and existing

configuration
2. Select the configuration for the site where you want to import the administration data file.
3. In the Feature Maintenance panel, select the Manage Administration Data option under
Teamcenter Foundation.

Chapter
4. In the Manage Administration Data panel, select the Partial export option.
5. Use the Partial Administration Data Export panel to specify the administration data to export.
a. Type, or browse to, the location where you want to place the administration data package.
b. Select the administration data category to export.
c. Select the administration data class to export.
d. Refine the administration data that is exported by using rows in the table.
A. Type the Attribute and Value pair.
B. Click the Add button to the right of the table to add rows for additional attribute/value
pairs. Select a row from the table and click the Remove button to delete a attribute/value
pair.
C. Select the Boolean Operator.
6. In the Teamcenter Administrative User panel, enter the logon information for the Teamcenter
administrative user account.

7. In the Confirmation panel, review the choices and select Start.
On successful export, TEM packages the exported administration data to the specified packaging
directory. The export package contains the administration data in TC XML files used later for
importing into another Teamcenter environment..
Export full administration data from Teamcenter Environment Manager

You can select the categories of data to export, for example, preferences, by selecting the Full
export option.

configuration
4. In the Manage Administration Data panel, select the Full export option.

Chapter
5. In the Full Administration Data Export panel, specify the administration data package and the
categories to export.
a. Type, or browse to, the location where you want to place the administration data package.
b. Select the administration data categories to export.
7. In the Confirmation panel, review the choices and click Start.
On successful export, TEM packages the exported administration data to the specified packaging
directory. The export package contains the administration data in TC XML files that are used later for
importing into another Teamcenter environment.

Importing administration data
Administration data import behavior
Administrative data import options
Import behavior is based on the import option selected and the type of administration data. Override
with source data is always used for Access Manager rules. For the other administration data types,
you can select from the following options:
• Override with source
Overrides all administration data at the importing site with the import package administration data.
• Keep target
Keeps the importing site’s administration data.
• Choose latest change

Replaces the conflicting administration data with the latest administration data based on
timestamp.
• Choose source for un-resolvable conflicts and latest for resolvable conflicts
Ignores the import administration data for nontrivial or unresolved merge conflicts. For all other
merge conflicts, uses the latest administration data based on timestamp.
Style sheet import behavior
By default, each style sheet has two preferences set. For example, the summary styles sheet has the
following:
type-name.SUMMARYRENDERING=dataset-name
dataset-name.SUMMARY_REGISTEREDTO=type-name
There may be no preferences or only one preference defined on a style sheet. This means the
style sheet is not in use. During import, missing one or both preferences is processed as if both
preferences are defined.
ItemSummary dataset
Target preferences after Target action with
Source preferences Target preferences Action import source option1
Item. First time import, dataset Added at source Item. Add at target
SUMMARYRENDERING does not exist. site. SUMMARYRENDERING site using import
package data.
ItemSummary. ItemSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO
1. When you select either the Choose Source option or Choose Source for Unresolved Conflicts option.

Chapter
ItemSummary dataset
Dataset does not exist Item. Added at target No change. None.
SUMMARYRENDERING site.
ItemSummary.
SUMMARY_REGISTEREDTO
Item. Item. First time created Item. Update using
SUMMARYRENDERING SUMMARYRENDERING at source. SUMMARYRENDERING source package.
ItemSummary. ItemSummary. First time created ItemSummary.

SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO at target not by SUMMARY_REGISTEREDTO
importing.
Item. Item. Change XML file Item. Update.
SUMMARYRENDERING SUMMARYRENDERING content at source. SUMMARYRENDERING
ItemSummary. ItemSummary. ItemSummary.

SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO
Item. Item. Change XML file Item. Update using
SUMMARYRENDERING SUMMARYRENDERING content at source. SUMMARYRENDERING source package.
ItemSummary. ItemSummary. Change XML file ItemSummary.

SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO content at target. SUMMARY_REGISTEREDTO
Item. Item. Change XML file Item. Add using source
SUMMARYRENDERING SUMMARYRENDERING content at source. SUMMARYRENDERING package.
ItemSummary. ItemSummary. Delete at target. ItemSummary.

Item. Delete at source. None.
SUMMARYRENDERING
ItemSummary.
Item. Delete at target. None.
SUMMARYRENDERING
ItemSummary.
Item. Item. Delete at source. Item. None.
SUMMARYRENDERING SUMMARYRENDERING SUMMARYRENDERING
Delete at target.
Item. Item. Delete at source. Depends on SyncDelete SyncDelete
SUMMARYRENDERING SUMMARYRENDERING option.
Change at target. ON: Delete
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO OFF: Keep target.
Item. Item. Delete at source. Depends on SyncDelete SyncDelete

SUMMARYRENDERING SUMMARYRENDERING option.
ON: Delete
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO OFF: Keep target.
Item. Item. Added at source Item. Add using source 2.

SUMMARYRENDERING SUMMARYRENDERING from source 2. SUMMARYRENDERING
ItemSummary. ItemSummary. Imported at target ItemSummary.

SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO from source 1. SUMMARY_REGISTEREDTO

ItemSummary dataset
Item. Item. Change at target. -override_ with_
SUMMARYRENDERING SUMMARYRENDERING source option,
update using
ItemSummary. ItemSummary. source package.
-choose_ source_
for_ unresolved_
conflicts option,
keep target.
Item. Item. Delete at target. Item. Add using source
SUMMARYRENDERING SUMMARYRENDERING SUMMARYRENDERING package.

ItemRevSummary and DocumantRevSummary datasets

XML filewsaSource Target preferences after Target action with
preferences Target preferences Action import a source option2
ItemRevision. ItemRevision. Add at source. ItemRevision. Add at target
SUMMARYRENDERING SUMMARYRENDERING SUMMARYRENDERING site using import
Add at target. package data.
ItemRevisionSummary. ItemRevisionSummary. ItemRevisionSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO DocumentRevision
has it own
DocumentRevision. (DocumentRevision inherits DocumentRevision. stylesheet.
SUMMARYRENDERING ItemRevision’s summary SUMMARYRENDERING
stypesheet.)
DocumentRevisionSummary. DocumsntRevisionSummary.
Perform a dry run of administration data import


configuration
2. Choose Source option or Choose Source for Unresolved Conflicts option.

Chapter
4. In the Manage Administration Data panel, select the Dry run import option.
5. In the Dry Run Import Adminstration Data panel, browse to the location and select the
administration data package.
6. In the Import Merge Options panel, select the merge option for each category.

Selection Description
Override With Select this option to override all administration data in the target
Source environment with the source administration data.
Keep Target Select this option to keep target administration data when resolving
conflicts.
Choose Latest Select this option to choose the latest administration data (based on
timestamp) when resolving merge conflicts.
Choose Source Select this option to choose the source administration data for
for Unresolvable nontrivial, or unresolved, merge conflicts and the latest for all other
Conflicts merge conflicts.
Choose Target Select this option to choose the target administration data for nontrivial,
for Unresolvable or unresolved, merge conflicts and the latest for all other merge
Conflicts conflicts.
8. In the Confirmation panel, review the choices and click Start.
9. In the Install panel, monitor the Overall Progress or select Show Details to watch the install
status.
Working with TC XML administration data files

Normally, you do not need to alter the content of the administration data TC XML file. You may want
to check the impact of importing the file prior to actually importing it into a remote site.
After you export an administration data file, you can carefully modify the TC XML content of the file, if
required, to provide changes for specific sites or groups of site. To import a modified file, you must
select the Ignore package validation check box in Teamcenter Environment Manager (TEM).

Chapter
This enables bulk load functionality that bypasses certain validation checks. If there are mistakes in
the TC XML file, the import can cause corruption and possibly data loss. Therefore, this functionality
requires an authorization key. You can obtain the key from the Global Technical Access Center
(GTAC) after passing the Manage Administration Data self-paced course available from Learning
Advantage. This course provides the information necessary to avoid potential problems when you
edit the TC XML content of an administration data file.
In your Teamcenter environment, you must set the BULK_LOADER_AUTH_KEY environment
variable to the value of the authorization key. This enables the bulk load capabilities that are used to
import the modified package. If you do not set this variable to a valid value, TEM returns an error
message when you attempt to import the modified package.
Rules for editing an administration data TC XML file
• Ensure the uniqueness of elemId attributes across the TC XML file.
• Ensure the value of Boolean type attributes are Y (true) or N (false).
• Ensure the value of reference type attributes are formatted as:

#<elemId-of-the-GSIdentity-of-the-referenced-object>
• Ensure the value of date type attributes are in GMT format:

year-month-dayThour:minute:SecondZ
For example, for 09 September 2014 at 4:21:04 AM (GMT), 2014-09-23T04:21:04Z.

• Ensure the timestamp value is present.
• Ensure L10N attributes are list of values formatted as:

locale:M/S:M/A/P/R/I:sequence:[aA-zZ]^32:translation
A locale in the format of en_US: M/S, is a master or secondary language.

M/A/P/R/I is the translation status.
The sequence number is 4 digits for multiple value attributes.
There are 32 characters reserved.
The rest is the translation, for example:
de_DE:S:A:0000::Proxy-Link,
en_US:S:A:0000::Proxy
es_ES:S:A:0000::Enlace
Link,
proxy,
fr_FR:S:A:0000::Lien
it_IT:S:A:0000::Collegamento
pt_BR:S:A:0000::Link
proxy,
proxy,
de
proxy
• When editing the attributes that are part of the candidate key, the GSIdentity label of the object,
and the label of the objects that reference the object, must be updated accordingly.
• Ensure all required attributes for the administration object have values.
• For out-of-the-box administration objects, a users home, mailbox_folder, and newstuff_folder

attributes must not be added. Also, a dataset rev_chain_anchor attribute must not be added.
This is true even though these are required attributes.
• After editing the file, validate the complete file content against LLTCXML.xsd file (low-level TC
XML schema) located in the TC_DATA directory to ensure the XML is valid.
Import administration data


configuration

Chapter
4. In the Manage Administration Data panel, select the Import option.
5. In the Import Adminstration Data panel, browse to the location and select the administration
data package.
6. In the Import Merge Options panel, select the merge option for each category.

Selection Description
Override With Select this option to override all administration data in the target
Source environment with the source administration data.
Keep Target Select this option to keep target administration data when resolving
conflicts.
Choose Latest Select this option to choose the latest administration data (based on
timestamp) when resolving merge conflicts.
Choose Source Select this option to choose the source administration data for
for Unresolvable nontrivial, or unresolved, merge conflicts and the latest for all other
Conflicts merge conflicts.
Choose Target Select this option to choose the target administration data for nontrivial,
for Unresolvable or unresolved, merge conflicts and the latest for all other merge
Conflicts conflicts.
8. In the Confirmation panel, review the choices and select Start.
9. In the Install panel, monitor the Overall Progress or select Show Details to watch the install
status.
View a sites administration data import history

For reviewing all the previous imports of administrative data, a HTML-based import history report
is available, after each successful import done using the command line utility or TEM installer, a
new folder is created in the directory the TC_ROOT\logs\import_history with a name that is a
combination of the time stamp and the exporting environment name. For accessing the import
report, open the index.html file in a web browser.

Appendix A: Standard mapping

Appendix A: Standard mapping
The DataMapper.xml 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 DataMapper.xml
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/ctrl.file (points to datastore location)
</mapper>
XSLT mapping provides a configured way to map XSLT. The mapper config file provides the XSLT for
the mapping, for example:
<mapper service="XSLTMapService">
/bin/map.xslt (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 DataMapper.xml file defines the implementing
class to be called for Java mapping, for example:
<mapper service="JavaMapService">
com.teamcenter._globalservices.service.QueryAuditService
(defines the class to invoke)
</mapper>
PLM00094 11.2 Data Exchange A-1

Appendix
Appendix A: A: Standard
Standard mapping
mapping
Tip
Wild card quick configuration guidelines:

The DataMapper.xml 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 Data Exchange PLM00094 11.2

Appendix B: Standard PDX mapping

Appendix 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
ManufacturerPart
ApprovedManufacturerListItem globalManufacturerPartStatusCode Revision name
→ReleaseStatus
ManufacturerPart
ApprovedManufacturerListItem globalManufacturerPartStatusCodeOther Revision name
→ReleaseStatus
ApprovedManufacturerListItem globalPreferredStatusCode VendorIdentifier preferred_status
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
ItemRevision
AffectedItem obsoleteDate date_released
→ReleaseStatus
ItemRevision
AffectedItem effectiveDate date_released
→ReleaseStatus
ItemRevision
AffectedItem globalLifeCyclePhaseCode name
→ReleaseStatus
ItemRevision
AffectedItem globalLifeCyclePhaseCodeOther name
→ReleaseStatus
AffectedItem description ItemRevision object_desc
Attachment universalResourceIdentifier Imanfile original_file_name
Attachment fileIdentifier Imanfile file_name
Attachment fileSize Imanfile byte_size
Attachment description Dataset description
PSOccurrence
BillOfMaterialItem revisionIdentifier Item item_revision_id
Item Revision
BillOfMaterialItem globalBillOfMaterialTypeCode Item object_type
BillOfMaterialItem globalBillOfMaterialTypeCodeOther Item object_type
PSOccurrence
BillOfMaterialItem notes note_texts
→PSOccurrenceNotes
PSOccurrence
BillOfMaterialItem BillOfMaterialItemIdentifier object_name
→Item
PSOccurrence
BillOfMaterialItem billOfMaterialItemUniqueIdentifier item_id
→Item
PLM00094 11.2 Data Exchange B-1

Appendix
Appendix B: B: Standard
Standard PDX PDX mapping
mapping

BillOfMaterialItem itemQuantity PSOccurrence qty_value
PSOccurrence
BillOfMaterialItem description →Item object_desc
→Item Revision
BillOfMaterialItem proprietarySequenceIdentifier PSOccurrence seq_no
Change changeNumber EngChange item_id
Change revisionIdentifier EngChange Revision item_revision_id
EngChange Revision
Change globalEngineeringChangeStatusCode name
→ReleaseStatus
EngChange Revision
Change globalEngineeringChangeStatusCodeOther name
→ReleaseStatus
EngChange Revision
Change changeStatusDate date_released
→ReleaseStatus
Change changeType EngChange object_type
EngChange Revision
Change changeSubType 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
Contact telephoneNumber Vendor supplier_phone
Contact emailAddress Vendor email_addr
HistoryItem userName Header author
HistoryItem modificationDate Header date
Item itemIdentifier Item object_name
Item itemUniqueIdentifier Item Item_id
Item Revision
Item globalLlifeCyclePhaseCode name
→Release Status
Item Revision
Item globalLlifeCyclePhaseCodeOther name
→Release Status
Item globalProductTypeCode Item object_type
Item revisionIdentifier Item Revision item_revision_id
Item
Item globalProductUnitOfMeasureCode 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
B-2 Data Exchange PLM00094 11.2

Standard PDX mapping

Manufacturer Part
ManufacturerPart globalManufacturerPartStatusCode Revision name
→ReleaseStatus
Manufacturer Part
ManufacturerPart globalManufacturerPartStatusCodeOther Revision name
→ ReleaseStatus
ManufacturerPart manufacturerPartType ManufacturerPart object_type
ManufacturerPart description ManufacturerPart object_desc
ProductDataeXchangePackage originatedByContactName Header author
ProductDataeXchangePackage originatedByContactUniqueIdentifier Header author
ReferenceDesignator referenceDesignatorName PSOccurrence ref_designator
PLM00094 11.2 Data Exchange B-3

Appendix 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-7
Data synchronizer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-8
Identity manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-9
Ownership manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-10
Siemens PLM Software briefcase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-12
File Management System file transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-13
Security Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-13

Appendix 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
PLM00094 11.2 Data Exchange C-1

Appendix
Appendix C: C: Teamcenter
Teamcenter Data Data Exchange
Exchange concepts
concepts and components
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
Objects owned by Structure Manager:

• BoundingBox
• BoundingMultiBox
Objects owned by Vendor Management:
C-2 Data Exchange PLM00094 11.2

Teamcenter Data Exchange concepts and components
• 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):

• BitDef
• BitValue
• CalParmRevision
• ParmDefBCD
• ParmDefBCDRevision
• ParmDefBitDef
• ParmDefBitDefRevision
• ParmDefBool
• ParmDefBoolRevision
• ParmDefDate

Appendix
Exchange concepts
and components
• 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
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)
• 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

Appendix
Exchange concepts
and components
• 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
Latest Working Latest
opt_revs
Revision Only Working
Latest
Latest Working/Any
opt_revs Working and
Release Status
Released
Latest Any Release Latest
opt_revs
Status Released
Selected Revision(s)
opt_revs Selected
Only
Specific Release Released
opt_revs
Status 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
opt_do_struct true | false
Item Only
Exclude
Transfer-Protected opt_trans_prot_comp true | false
Components
Exclude
Export-Protected opt_exp_prot_comp true | false
Components
Exclude
General Options Export-Protected opt_exp_prot_obj true | false
Objects

Option group Supported option Symbol name Value

Exclude Folder
opt_folder_contents true | false
Contents
Supported
Relations to be
Relations opt_grm through
included
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 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.

Appendix
Exchange concepts
and components
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.
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.
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.

Appendix
Exchange concepts
and components
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
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
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.
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.

Appendix
Exchange concepts
and components
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 PLM 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
• 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 FMSmaster.xml 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).

Appendix D: Synchronizing a Teamcenter database
to an LDAP repository
ldapsync utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1
LDAP syncrhonization concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1

Objects synchronized by the ldapsync utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1
Object nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1
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-8
Group mapping preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D-9
Role mapping preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-11
Data synchronization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-12
Differentiate groups and roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-13
Link to separate LDAP directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-13
Synchronize Teamcenter to an LDAP repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-14
ldapsync utility troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-14

Reset an external user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-14
ldapsync cannot find nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-15
Search limitations for ldapsync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-15
Search the base DN and one level under it . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-15
Search the base DN only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-15
Sun ONE Directory Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-15
Microsoft Active Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-18

Appendix 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 syncrhonization 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.
Object nodes
The ldapsync utility recognizes the following four types of entries or nodes in an LDAP repository:
PLM00094 11.2 Data Exchange D-1

Appendix
Appendix D: D: Synchronizing
Synchronizing a Teamcenter
a Teamcenter database
database to anto an LDAP
LDAP repository
repository
• user
• group
• role
• undefined
Company - ignored by
ou=ABC, dc=com ldapsync
Group =
Group - synched
Engineers
Locations - ignored Shoreview Pune Ames
Role = Role =
Roles - synched
Design Coder
Users - synched
User-C User-F
User-B User-E
User-A User-D
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
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.
D-2 Data Exchange PLM00094 11.2

Synchronizing a Teamcenter database to an LDAP repository
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
Configuration.LDAP.Connection 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.
• LDAP_cert_db_path
Specifies the path to the directory containing the cert8.db (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.

Appendix
LDAP repository
repository
• 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.
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
inetOrgPerson
Teamcenter User Teamcenter Person
LDAP person object mapping
User and person mapping preferences

These preferences are in the Configuration.LDAP.User 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
%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:
o Teamcenter attribute name
o Mapped LDAP attribute
o 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

Appendix
LDAP repository
repository

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.
• 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%
value is null.
Default
Attribute name LDAP attribute value Description
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
• 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.

Appendix
LDAP repository
repository
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
• 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.

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_type Specifies a logical attribute that allows Teamcenter to distinguish the
membership 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 Configuration.LDAP.Group 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%
LDAPGroupDesc
description
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%

Appendix
LDAP repository
repository
LDAPGroupDBA
%REPLACE_ME%
0
LDAPGroupRole
%REPLACE_ME%
%REPLACE_ME%
value is null
Default
Attribute name LDAP attribute value Description
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
• 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
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 Configuration.LDAP.Role 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%
value is null

LDAPLastUpdate modifyTimestamp None Last update
timestamp
LDAPRoleDesc description None Role
description
LDAPRoleName cn None Role name
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=*.

Appendix
LDAP repository
repository
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 Configuration.LDAP.Synchronization 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 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
• LDAP_sync_role_flags
Defines the synchronization for roles using the flags described in the following table. The

• 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:
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.

Appendix
LDAP repository
repository
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.
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 11.2→Teamcenter
11.2→ 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 -user=user2 -datasource=0
To set a group member to externally managed, type:

make_user -user=user2 –role=role2 –group=group2 -datasource=1
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 table 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

Appendix
LDAP repository
repository

LDAP_attribute_mapping LDAPPersonName
cn
%REPLACE_ME%
LDAPEngUserId
uid
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%
LDAPOsUser
uid
%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
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
%REPLACE_ME%
PA4
postalCode
%REPLACE_ME%
PA5
co
%REPLACE_ME%
PA6
o
%REPLACE_ME%
PA7
employeeNumber
%REPLACE_ME%
PA8
%REPLACE_ME%
PA9
mail
%REPLACE_ME%
PA10
telephoneNumber
%REPLACE_ME%
LDAP_port_number port-number

Appendix
LDAP repository
repository

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
LDAP_user_object_class inetOrgPerson
LDAP_user_query_filter (uid=*)
Microsoft Active Directory

The following table provides an example of configuring Teamcenter preferences to synchronize a
Microsoft Active Directory LDAP server to the Teamcenter database.
Preference list Active Directory values

LDAP_admin_dn test-admin@domain.com
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%
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

Appendix
LDAP repository
repository

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
%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
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=*)

Appendix E: Data exchange preferences
Alt_id_default_idContext_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-2
Alt_id_default_identifier_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-3
BRIEFCASE_export_CAD_incomplete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4
BRIEFCASE_import_validation_rule_item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-5
Briefcase_pkg_file_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-6
GMS_expired_or_locked_ada_licenses_bypass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-7
GMS_offline_use_TcGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-8
GMS_tcxml_string_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-9
GMS_UID_mapping_dbname_index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-10
GMS_UID_mapping_remote_site_index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-11
GS_USER_NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-12
GS_USER_PASSWORD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-13
PDX_pkg_file_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-14
SRM_hostname_portnumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-16
TC_default_gms_site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-17
TC_default_gms_transfer_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-18
TC_gms_import_default_transfermode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-19
TC_gms_enable_immediate_option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-20
TC_gms_export_default_transfermode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-21
TC_gms_export_transfermode_for_<site_name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-22
TC_gms_gs_bos_service_url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-23
TC_gms_gs_server_url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-24
TC_gms_gs_uri . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-25
TC_gms_monitoring_gui_total_number_of_steps_for_transfer . . . . . . . . . . . . . . . . . . . . . . E-26
TC_gms_sso_enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-27
TIE_allow_import_with_different_SML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-28
TIE_Attachment_Window_Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-29
TIE_exp_pending_object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-30
TIE_fast_traversal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-31
TIE_itemrev_infer_delete_skip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-32
TIE_reference_objects_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-33
TIE_validate_against_xsd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-34
Data Exchange preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-34

Alt_id_default_idContext_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-35
Alt_id_default_identifier_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-36
BRIEFCASE_export_CAD_incomplete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-37
BRIEFCASE_import_validation_rule_item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-38
Briefcase_pkg_file_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-39
GMS_expired_or_locked_ada_licenses_bypass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-40
GMS_offline_use_TcGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-41
GMS_tcxml_string_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-42
GMS_UID_mapping_dbname_index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-43

GMS_UID_mapping_remote_site_index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-44
GS_USER_NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-45
GS_USER_PASSWORD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-46
PDX_pkg_file_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-47
SRM_hostname_portnumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-49
TC_default_gms_site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-50
TC_default_gms_transfer_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-51
TC_gms_import_default_transfermode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-52
TC_gms_enable_immediate_option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-53
TC_gms_export_default_transfermode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-54
TC_gms_export_transfermode_for_<site_name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-55
TC_gms_gs_bos_service_url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-56
TC_gms_gs_server_url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-57
TC_gms_gs_uri . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-58
TC_gms_monitoring_gui_total_number_of_steps_for_transfer . . . . . . . . . . . . . . . . . . . . E-59
TC_gms_sso_enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-60
TIE_allow_import_with_different_SML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-61
TIE_Attachment_Window_Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-62
TIE_exp_pending_object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-63
TIE_fast_traversal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-64
TIE_itemrev_infer_delete_skip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-65
TIE_reference_objects_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-66
TIE_validate_against_xsd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-67
Data Exchange PLM00094 11.2

Appendix E: Data exchange preferences
PLM00094 11.2 Data Exchange E-1

Appendix
Appendix E: E:
Data Data exchange
exchange preferences
preferences
Alt_id_default_idContext_type
DESCRIPTION
Specifies a default IdContext type. This is required for import operations when the
type is not specified by user.
VALID
VALUES
Accepts multiple strings as values. Must be a valid IdContext type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
E-2 Data Exchange PLM00094 11.2

Data exchange preferences
Alt_id_default_identifier_type
DESCRIPTION
Specifies a default Identifier type. This is required for import operations when the
type is not specified by a user.
VALID
VALUES
Accepts multiple strings as values. Must be a valid Identifier type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
BRIEFCASE_export_CAD_incomplete
DESCRIPTION
Specifies whether a CAD incomplete assembly is allowed when exporting a briefcase
file to an unmanaged system.
This type of briefcase file may be limited to only JT data if the ug_clone utility cannot
export all of the required NX files. Teamcenter provides warning messages when an
exported briefcase file does not contain all of the required CAD data.
For information about CAD complete briefcase files, see Briefcase Browser.
Note
This preference is not created by the Teamcenter installation process. If you

require this functionality, you must create the preference.
For information about creating and using preferences, see Teamcenter Basics.
Tip
Siemens PLM Software recommends that you use the following values when
creating this preference:
• Protection Scope: Site
• Category: General
• Environment: Disabled
You must select Logical from the Type box and Single from the Multiple box.
VALID
VALUES
One of any logical pair (true or false, on or off, 0 or 1).
TRUE CAD incomplete assemblies are allowed in briefcase export
files. The success of the operation depends on the completion
of the ug_clone utility process.
FALSE CAD incomplete assemblies are blocked from briefcase export
files and Teamcenter generates an error message indicating the
export failed because the CAD is not complete.
DEFAULT
VALUE
None.
DEFAULT
PREFERENCE
SCOPE
Siemens PLM Software recommends this preference be restricted by site.

BRIEFCASE_import_validation_rule_item
DESCRIPTION
Specifies how Teamcenter determines the validation input when importing a briefcase
file.
Because briefcase files from unmanaged sites can contain new CAD parts or
assemblies, Teamcenter uses the NX ug_clone utility during the import process. The
utility requires validation rules as an input. This preference specifies the item and its
revision related to the dataset contain the validation rules.
Note

Tip
You must select String from the Type box and Single from the Multiple box.
VALID
VALUES
Two strings separated by a slash (/) character that identify a ValidationRule dataset
under the item revision. The strings are:
ItemID Identifies the item related to the dataset containing the validation rules,
for example:
000167
RevID Identifies the revision of the item related to the dataset containing the
validation rules, for example:
B
For this example, the value is:

000167/B
DEFAULT
VALUE
None.
DEFAULT
PREFERENCE
SCOPE

Appendix
Appendix E: E:
Data Data exchange
preferences
Briefcase_pkg_file_name
DESCRIPTION
Defines the file name format for briefcase packages (named references attached to
dataset objects). The format is based on the keywords representing attributes of the
object being exported. The format is any combination of one or more of the attributes
specified in the following valid values and any text string representing a constant in
the file name.
VALID
VALUES
Any text string The text forms a part of the package file name. Add SPLM as a
prefix for the following format:
SPLM_00001_A_Site1_31-Sep-2011_19-48-30.bcz
ItemID The item ID attribute forms a part of the package file name.
Add ItemId as the attribute following the prefix for the following
format:
BCZ_00001_A_assembly1_31-Sep-2011_19-48-30.bcz
RevID The revision ID attribute forms part of the package file name.
Add RevID as the second attribute for the following format:
BCZ_00001_A_Site1_31-Sep-2011_19-48-30.bcz
ItemName The object’s item name forms part of the package file name.
Add ItemName as the third attribute for the following format:
TargetSite The remote site name forms part of the package file name. Add
TargetSite as the third attribute for the following format:
BCZ_00001_A_Site1_31-Sep-2011_19-48-30.bcz
TimeStamp The time stamp forms part of the package file name. Add
TimeStamp as the last attribute for the following format:
DEFAULT
VALUE
BCZ:ItemId:RevId:TargetSite:TimeStamp
DEFAULT
PROTECTION
SCOPE
Site preference.

GMS_expired_or_locked_ada_licenses_bypass
DESCRIPTION
Controls the check for expired or locked license status by the TC XML importer when
importing an object with an ADA License. License objects must already exist at the
importing site to be attached to an object during import. The importing process does
not allow an expired or locked license to be attached to an object. You can use this
preference to allow the importer to bypass the license status check.
Note

Tip
• Category: TC XML Import Export.Import
You must select Logical from the Type list and Single from the Multiple box.
VALID
VALUES
TRUE The import process bypasses the license status check and
attaches the ADA License to the imported object.
FALSE The import process checks the status of the related ADA
License and attaches the license only when it is not expired
or locked.
DEFAULT
VALUES
None.
This preference does not exist until you create it. The default behavior is the same
as for the FALSE value setting.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
GMS_offline_use_TcGS
DESCRIPTION
Specifies whether or not briefcase export and import actions use Global Services
components to perform transfers.
VALID
VALUES
TRUE Global Services participates in the transfer process. Global
Services must be installed to use this value.
FALSE Briefcase transfers are performed without the use of Global
Services components and features.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

DESCRIPTION
Specifies the character used as the value delimiter for strings in the TC XML file. You
use this preference to define a character other than a comma as a value delimiter when
attribute values contain commas. For example, an import file from a German (de_DE)
local site contains commas as the decimal separator in numeric strings. Importing a
file from that site into an English (en_US) site requires the value delimiter for the
strings to be a character other than a comma to maintain the integrity of the data.
VALID
VALUES
, (comma) The comma character separates string values.
; (semicolon) The semicolon character separates string values.
| (pipe) The pipe (vertical bar) character separates string values.
DEFAULT
VALUES
, (comma)
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
GMS_UID_mapping_dbname_index
DESCRIPTION
Lists the databases for remote Teamcenter Enterprise sites involved in data exchange.
The indices of the databases specified are used for generating unique object UIDs
in PLM XML.
VALID
VALUES
Enter values as instance-name:dbname1, dbname2, for example, svli60:sum501a.
To determine these values, search the Teamcenter Enterprise fmsmaster.xml file for
the accesson id value, for example, accesson id = “rhgtpqksvli60sum501a-aaG”.
Split this value as follows:
1. Drop the last three characters (aaG).
2. In the remaining string, record the last eight characters (ignore any hyphens) as
the dbname value, for this example, sum501a.
3. Record the next six characters as the instance name, for this example, svli60.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

GMS_UID_mapping_remote_site_index
DESCRIPTION
Lists the index mapping for remote Teamcenter Enterprise sites involved in data
exchange. The indexes are used for generating unique object UIDs in PLM XML.
VALID
VALUES
Enter values as instance-name:index1, for example, svli60:1. To determine the
instance name, see GMS_UID_mapping_dbname_index.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
GS_USER_NAME
DESCRIPTION
Identifies the user permitted logon access to Global Services.
VALID
VALUES
Accepts a single string as a value. Must be a valid user name.
DEFAULT
VALUES
GlobalServicesAdmin
DEFAULT
PROTECTION
SCOPE
Site preference.

GS_USER_PASSWORD
DESCRIPTION
Identifies the user password required to log onto Global Services.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
GlobalServicesAdmin
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
PDX_pkg_file_name
DESCRIPTION
Specifies the format for the name of the PDX package file when exported from
Teamcenter. The format of the preference value is (all values are optional):
PDX-string:ItemId:RevId:ItemName:TargetSite:TimeStamp
Note
You can use the following keywords in this preference.
• ItemId
• ItemName
• RevId
• TargetSite
• TimeStamp
VALID
VALUES
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.
Any combination of values is valid. The following are a few examples:
PDX:ItemId:RevId:ItemName:TargetSite
PDX:ItemId:ItemName:TargetSite
ItemId:RevId:ItemName
PDX:ItemId:RevId:ItemName:TargetSite:TimeStamp
Note
Based on the last example, the package file name for the 000303/A Mem_Assy
object package, exported to the Zurich site is:
PDX_00001_A_Mem_Assy_Zurick_4-Feb-2008_18-14-00.pdx

DEFAULT
VALUES
If no value is set, the package file name is based on the ItemName attribute.
For example, for the 000303/A Mem_Assy object package the file name is
Mem_Assy.pdx.
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
The keywords are case sensitive and the only keywords supported. Any other values
are treated as constants.

Appendix
Appendix E: E:
Data Data exchange
preferences
SRM_hostname_portnumber
DESCRIPTION
Specifies the host and port on which SRMConnect is running.
SRMConnect is part of supplier relationship management data sharing.
VALID
VALUES
Hostname:portnumber
DEFAULT
VALUES
localhost:3000
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_default_gms_site
DESCRIPTION
Determines the name of the Data Exchange site to be used as the default target site
when performing a remote export. If this preference is not defined, the system uses
the first Data Exchange site found in the database. If no such sites are defined, the
request returns an error.
VALID
VALUES
Accepts a single string as a value. Must be the name of a valid Data Exchange site.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TC_default_gms_transfer_mode
DESCRIPTION
Defines the default PLM XML transfer mode used for Data Exchange operations.
VALID
VALUES
Accepts a single string as a value. Must be a valid PLM XML transfer mode.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_gms_import_default_transfermode
DESCRIPTION
Specifies the transfer mode used when performing a PLM XML import.
VALID
VALUES
Accepts a single string as a value. Must be a valid PLM XML import transfer mode.
DEFAULT
VALUES
TIEImportDefault
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TC_gms_enable_immediate_option
DESCRIPTION
Determines whether users can schedule a Data Exchange request for immediate
execution. (By default, the system schedules requests based on load conditions.) This
is a role-based preference; you can use it to enable the option for users based on role.
VALID
VALUES
TRUE The Immediate check box appears in the various Data
Exchange import and export dialog boxes.
FALSE The Immediate check box does not appear.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Role preference.

TC_gms_export_default_transfermode
DESCRIPTION
Specifies the PLM XML transfer mode used when exporting from Briefcase.
VALID
VALUES
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TC_gms_export_transfermode_for_<site_name>
DESCRIPTION
Specifies the export transfer mode for a specific site. If this preference is not set, the
transfer mode specified by the TC_gms_export_default_transfermode preference
is used.
VALID
VALUES
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_gms_gs_bos_service_url
DESCRIPTION
Specifies the URL for the Global Services business object server.
VALID
VALUES
Accepts a single string as a value. Must be a valid URL.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TC_gms_gs_server_url
DESCRIPTION
Specifies the URL of the Global Services Web server location.
VALID
VALUES
Accepts a single string as a value. Must be a valid Web server location.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_gms_gs_uri
DESCRIPTION
Specifies the URI Global Services uses for SOA envelopes.
VALID
VALUES
Accepts a single string as a value. Must be a valid URI.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TC_gms_monitoring_gui_total_number_of_steps_for_transfer
DESCRIPTION
Specifies the number of steps in the Data Exchange data transfer process. The
progress monitor uses this value to determine the percentage of progress to display.
The standard process has five steps. If the transfer options include notification,
Teamcenter increments the value by 1 to account for the extra step. If you add custom
steps to the process, you must update this value to allow the progress monitor to
display the correct progress percentage.
VALID
VALUES
Any integer.
DEFAULT
VALUES
5
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_gms_sso_enabled
DESCRIPTION
Determines whether Global Services uses Security Services to provide single sign-on
(SSO) capability. If this preference is not set to true, the following preferences must
be set to provide user credentials for Global Services:
• GS_USER_NAME
• GS_USER_PASSWORD
VALID
VALUES
true SSO is enabled for Global Services.
false SSO is not enabled for Global Services. User ID and password
preferences must be defined so that users can log onto Global
Services.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TIE_allow_import_with_different_SML
DESCRIPTION
Specifies whether Teamcenter allows importing a TC XML file that contains a different
site master language from the site master language at importing site.
VALID
VALUES
true or ON Allows import.
false or OFF Does not allow import.
DEFAULT
VALUE
false
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
When this preference is set to true, after import, non-localized attributes in the
importing system can be in languages other than the importing system site master
language.

TIE_Attachment_Window_Filter
DESCRIPTION
Lists the Generic Relationship Management (GRM) rules to consider when fetching
BOM line attachments. This improves performance by limiting the exported BOM line
attachments to only those that are determined to be required instead of all BOMLine
attachments. This is a multiple value preference.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid Teamcenter GRM
name.
DEFAULT
VALUES
IMAN_master_form
IMAN_specification
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
When this preference is not defined, all BOM line attachments are included causing
slower export performance. The configured BOM export performance greatly improves
when the only attachments requested are those related to the BOM lines through the
listed GRMs.

Appendix
Appendix E: E:
Data Data exchange
preferences
TIE_exp_pending_object
DESCRIPTION
Determines whether to export a pending object as a full replica or as a stub. When
Data Exchange is performing an export, it sets an export lock for the affected objects
at the beginning of the transfer. If a second export is initiated while a previous export
that contains the same object is pending, the object lock is still set by the pending
transfer. If this preference is set to export pending objects as a stub, it causes Data
Exchange to export the object as a POM_stub object containing only the object's
identifying information.
Caution
If this preference is set to false (or not set), a pending object that is exported as
a stub can cause a transfer to be incomplete or to fail. To avoid this problem,
set the preference to true.
VALID
VALUES
true Exports the object as a full replica.
false Exports the object as stub.
DEFAULT
VALUE
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TIE_fast_traversal
DESCRIPTION
Determines whether Teamcenter uses TC XML or PLM XML schema for reports. TC
XML-based reports provide a fast traversal of objects that improves performance.
However, if you have custom reports that are based on the PLM XML schema, you can
use this preference to allow their use without modification. As an alternative to using
this preference, you can add the opt_fast_traversal option, with its value set to false,
to your transfer option set to allow the use of PLM XML-based reports.
VALID
VALUES
true Reports are based on the TC XML schema.
false Reports are based on the PLM XML schema.
DEFAULT
VALUE
true
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TIE_itemrev_infer_delete_skip
DESCRIPTION
Determines whether an update (synchronize or re-export) causes item revisions
created for secondary objects during the original export are deleted in Teamcenter
when they do not exist in the update. You use this preference to prevent the infer
delete functionality of Teamcenter from deleting an item revision of an object during
subsequent imports to Teamcenter.
For example, if this preference is not defined or is set to false and:
• The first export to the target site contains three revisions.

• The transfer completes successfully.
• The re-export contains only one revision.
Then the import process infers that the additional revisions found at the importing site
no longer exist and deletes them (infer delete function).
Note

Tip
You must select Logical from the Type list and Single from the Multiple list.
VALID
VALUES
true The import process does not delete objects at the Teamcenter site that
are not in the imported TC XML file.
false The import process deletes objects at the Teamcenter site (infer delete) that
DEFAULT
VALUE
false
If this preference is not defined at the importing site, the import process uses the
false behavior.
DEFAULT
PROTECTION
SCOPE
Site preference.

TIE_reference_objects_list
DESCRIPTION
Specifies list of object names and attributes to be processed as reference objects. TC
XML import does not import organizational objects such as User, Group, Role and
Project objects that used for reference purposes only. These objects are searched by
the Data Exchange importer and their values are set in objects created by importer.
For example, the owning_user attribute in the WorkspaceObject object refers to a
User object with a particular ID or name.
VALID
VALUES
Strings delimited by a commas in the following format:
TIE_reference_objects_list=bo_name,bo_attr_name,ref_attr_name
bo_name Name of a Teamcenter business object.

bo_attr_name Name of the attribute on the business object that the importer
must lookup.
ref_attr_name Name of the attribute that references the business object.
For example, to get owning_user and owning_group attribute references:
TIE_reference_objects_list=
User,user_id,owning_user
Group,name,owning_group
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TIE_validate_against_xsd
DESCRIPTION
Determines whether the system validates the XML output file against the Teamcenter
PLM XML schema.
VALID
VALUES
true The system validates the XML output file against the Teamcenter
PLM XML schema.
false The system does not validate the XML output file against the
Teamcenter PLM XML schema.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.
Data Exchange preferences

Alt_id_default_idContext_type
DESCRIPTION
Specifies a default IdContext type. This is required for import operations when the
type is not specified by user.
VALID
VALUES
Accepts multiple strings as values. Must be a valid IdContext type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
Alt_id_default_identifier_type
DESCRIPTION
Specifies a default Identifier type. This is required for import operations when the
type is not specified by a user.
VALID
VALUES
Accepts multiple strings as values. Must be a valid Identifier type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

BRIEFCASE_export_CAD_incomplete
DESCRIPTION
Specifies whether a CAD incomplete assembly is allowed when exporting a briefcase
file to an unmanaged system.
This type of briefcase file may be limited to only JT data if the ug_clone utility cannot
export all of the required NX files. Teamcenter provides warning messages when an
exported briefcase file does not contain all of the required CAD data.
For information about CAD complete briefcase files, see Briefcase Browser.
Note

Tip
You must select Logical from the Type box and Single from the Multiple box.
VALID
VALUES
TRUE CAD incomplete assemblies are allowed in briefcase export
files. The success of the operation depends on the completion
of the ug_clone utility process.
FALSE CAD incomplete assemblies are blocked from briefcase export
files and Teamcenter generates an error message indicating the
export failed because the CAD is not complete.
DEFAULT
VALUE
None.
DEFAULT
PREFERENCE
SCOPE

Appendix
Appendix E: E:
Data Data exchange
preferences
BRIEFCASE_import_validation_rule_item
DESCRIPTION
Specifies how Teamcenter determines the validation input when importing a briefcase
file.
Because briefcase files from unmanaged sites can contain new CAD parts or
assemblies, Teamcenter uses the NX ug_clone utility during the import process. The
utility requires validation rules as an input. This preference specifies the item and its
revision related to the dataset contain the validation rules.
Note

Tip
You must select String from the Type box and Single from the Multiple box.
VALID
VALUES
Two strings separated by a slash (/) character that identify a ValidationRule dataset
under the item revision. The strings are:
ItemID Identifies the item related to the dataset containing the validation rules,
for example:
000167
RevID Identifies the revision of the item related to the dataset containing the
validation rules, for example:
B
For this example, the value is:

000167/B
DEFAULT
VALUE
None.
DEFAULT
PREFERENCE
SCOPE

Briefcase_pkg_file_name
DESCRIPTION
Defines the file name format for briefcase packages (named references attached to
dataset objects). The format is based on the keywords representing attributes of the
object being exported. The format is any combination of one or more of the attributes
specified in the following valid values and any text string representing a constant in
the file name.
VALID
VALUES
Any text string The text forms a part of the package file name. Add SPLM as a
prefix for the following format:
SPLM_00001_A_Site1_31-Sep-2011_19-48-30.bcz
ItemID The item ID attribute forms a part of the package file name.
Add ItemId as the attribute following the prefix for the following
format:
RevID The revision ID attribute forms part of the package file name.
Add RevID as the second attribute for the following format:
BCZ_00001_A_Site1_31-Sep-2011_19-48-30.bcz
ItemName The object’s item name forms part of the package file name.
Add ItemName as the third attribute for the following format:
TargetSite The remote site name forms part of the package file name. Add
TargetSite as the third attribute for the following format:
BCZ_00001_A_Site1_31-Sep-2011_19-48-30.bcz
TimeStamp The time stamp forms part of the package file name. Add
TimeStamp as the last attribute for the following format:
DEFAULT
VALUE
BCZ:ItemId:RevId:TargetSite:TimeStamp
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
GMS_expired_or_locked_ada_licenses_bypass
DESCRIPTION
Controls the check for expired or locked license status by the TC XML importer when
importing an object with an ADA License. License objects must already exist at the
importing site to be attached to an object during import. The importing process does
not allow an expired or locked license to be attached to an object. You can use this
preference to allow the importer to bypass the license status check.
Note

Tip
You must select Logical from the Type list and Single from the Multiple box.
VALID
VALUES
TRUE The import process bypasses the license status check and
attaches the ADA License to the imported object.
FALSE The import process checks the status of the related ADA
License and attaches the license only when it is not expired
or locked.
DEFAULT
VALUES
None.
This preference does not exist until you create it. The default behavior is the same
as for the FALSE value setting.
DEFAULT
PROTECTION
SCOPE
Site preference.

GMS_offline_use_TcGS
DESCRIPTION
Specifies whether or not briefcase export and import actions use Global Services
components to perform transfers.
VALID
VALUES
TRUE Global Services participates in the transfer process. Global
Services must be installed to use this value.
FALSE Briefcase transfers are performed without the use of Global
Services components and features.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
DESCRIPTION
Specifies the character used as the value delimiter for strings in the TC XML file. You
use this preference to define a character other than a comma as a value delimiter when
attribute values contain commas. For example, an import file from a German (de_DE)
local site contains commas as the decimal separator in numeric strings. Importing a
file from that site into an English (en_US) site requires the value delimiter for the
strings to be a character other than a comma to maintain the integrity of the data.
VALID
VALUES
, (comma) The comma character separates string values.
; (semicolon) The semicolon character separates string values.
| (pipe) The pipe (vertical bar) character separates string values.
DEFAULT
VALUES
, (comma)
DEFAULT
PROTECTION
SCOPE
Site preference.

GMS_UID_mapping_dbname_index
DESCRIPTION
Lists the databases for remote Teamcenter Enterprise sites involved in data exchange.
The indices of the databases specified are used for generating unique object UIDs
in PLM XML.
VALID
VALUES
Enter values as instance-name:dbname1, dbname2, for example, svli60:sum501a.
To determine these values, search the Teamcenter Enterprise fmsmaster.xml file for
the accesson id value, for example, accesson id = “rhgtpqksvli60sum501a-aaG”.
Split this value as follows:
1. Drop the last three characters (aaG).
2. In the remaining string, record the last eight characters (ignore any hyphens) as
the dbname value, for this example, sum501a.
3. Record the next six characters as the instance name, for this example, svli60.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
GMS_UID_mapping_remote_site_index
DESCRIPTION
Lists the index mapping for remote Teamcenter Enterprise sites involved in data
exchange. The indexes are used for generating unique object UIDs in PLM XML.
VALID
VALUES
Enter values as instance-name:index1, for example, svli60:1. To determine the
instance name, see GMS_UID_mapping_dbname_index.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

GS_USER_NAME
DESCRIPTION
Identifies the user permitted logon access to Global Services.
VALID
VALUES
Accepts a single string as a value. Must be a valid user name.
DEFAULT
VALUES
GlobalServicesAdmin
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
GS_USER_PASSWORD
DESCRIPTION
Identifies the user password required to log onto Global Services.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
GlobalServicesAdmin
DEFAULT
PROTECTION
SCOPE
Site preference.

PDX_pkg_file_name
DESCRIPTION
Specifies the format for the name of the PDX package file when exported from
Teamcenter. The format of the preference value is (all values are optional):
PDX-string:ItemId:RevId:ItemName:TargetSite:TimeStamp
Note
You can use the following keywords in this preference.
• ItemId
• ItemName
• RevId
• TargetSite
• TimeStamp
VALID
VALUES
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.
Any combination of values is valid. The following are a few examples:
PDX:ItemId:RevId:ItemName:TargetSite
PDX:ItemId:ItemName:TargetSite
ItemId:RevId:ItemName
PDX:ItemId:RevId:ItemName:TargetSite:TimeStamp
Note
Based on the last example, the package file name for the 000303/A Mem_Assy
object package, exported to the Zurich site is:
PDX_00001_A_Mem_Assy_Zurick_4-Feb-2008_18-14-00.pdx

Appendix
Appendix E: E:
Data Data exchange
preferences
DEFAULT
VALUES
If no value is set, the package file name is based on the ItemName attribute.
For example, for the 000303/A Mem_Assy object package the file name is
Mem_Assy.pdx.
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
The keywords are case sensitive and the only keywords supported. Any other values
are treated as constants.

SRM_hostname_portnumber
DESCRIPTION
Specifies the host and port on which SRMConnect is running.
SRMConnect is part of supplier relationship management data sharing.
VALID
VALUES
Hostname:portnumber
DEFAULT
VALUES
localhost:3000
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TC_default_gms_site
DESCRIPTION
Determines the name of the Data Exchange site to be used as the default target site
when performing a remote export. If this preference is not defined, the system uses
the first Data Exchange site found in the database. If no such sites are defined, the
request returns an error.
VALID
VALUES
Accepts a single string as a value. Must be the name of a valid Data Exchange site.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_default_gms_transfer_mode
DESCRIPTION
Defines the default PLM XML transfer mode used for Data Exchange operations.
VALID
VALUES
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TC_gms_import_default_transfermode
DESCRIPTION
Specifies the transfer mode used when performing a PLM XML import.
VALID
VALUES
DEFAULT
VALUES
TIEImportDefault
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_gms_enable_immediate_option
DESCRIPTION
Determines whether users can schedule a Data Exchange request for immediate
execution. (By default, the system schedules requests based on load conditions.) This
is a role-based preference; you can use it to enable the option for users based on role.
VALID
VALUES
TRUE The Immediate check box appears in the various Data
Exchange import and export dialog boxes.
FALSE The Immediate check box does not appear.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Role preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TC_gms_export_default_transfermode
DESCRIPTION
Specifies the PLM XML transfer mode used when exporting from Briefcase.
VALID
VALUES
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_gms_export_transfermode_for_<site_name>
DESCRIPTION
Specifies the export transfer mode for a specific site. If this preference is not set, the
transfer mode specified by the TC_gms_export_default_transfermode preference
is used.
VALID
VALUES
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TC_gms_gs_bos_service_url
DESCRIPTION
Specifies the URL for the Global Services business object server.
VALID
VALUES
Accepts a single string as a value. Must be a valid URL.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_gms_gs_server_url
DESCRIPTION
Specifies the URL of the Global Services Web server location.
VALID
VALUES
Accepts a single string as a value. Must be a valid Web server location.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TC_gms_gs_uri
DESCRIPTION
Specifies the URI Global Services uses for SOA envelopes.
VALID
VALUES
Accepts a single string as a value. Must be a valid URI.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_gms_monitoring_gui_total_number_of_steps_for_transfer
DESCRIPTION
Specifies the number of steps in the Data Exchange data transfer process. The
progress monitor uses this value to determine the percentage of progress to display.
The standard process has five steps. If the transfer options include notification,
Teamcenter increments the value by 1 to account for the extra step. If you add custom
steps to the process, you must update this value to allow the progress monitor to
display the correct progress percentage.
VALID
VALUES
Any integer.
DEFAULT
VALUES
5
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TC_gms_sso_enabled
DESCRIPTION
Determines whether Global Services uses Security Services to provide single sign-on
(SSO) capability. If this preference is not set to true, the following preferences must
be set to provide user credentials for Global Services:
• GS_USER_NAME
• GS_USER_PASSWORD
VALID
VALUES
true SSO is enabled for Global Services.
false SSO is not enabled for Global Services. User ID and password
preferences must be defined so that users can log onto Global
Services.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

TIE_allow_import_with_different_SML
DESCRIPTION
Specifies whether Teamcenter allows importing a TC XML file that contains a different
site master language from the site master language at importing site.
VALID
VALUES
true or ON Allows import.
false or OFF Does not allow import.
DEFAULT
VALUE
false
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
When this preference is set to true, after import, non-localized attributes in the
importing system can be in languages other than the importing system site master
language.

Appendix
Appendix E: E:
Data Data exchange
preferences
TIE_Attachment_Window_Filter
DESCRIPTION
Lists the Generic Relationship Management (GRM) rules to consider when fetching
BOM line attachments. This improves performance by limiting the exported BOM line
attachments to only those that are determined to be required instead of all BOMLine
attachments. This is a multiple value preference.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid Teamcenter GRM
name.
DEFAULT
VALUES
IMAN_master_form
IMAN_specification
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
When this preference is not defined, all BOM line attachments are included causing
slower export performance. The configured BOM export performance greatly improves
when the only attachments requested are those related to the BOM lines through the
listed GRMs.

TIE_exp_pending_object
DESCRIPTION
Determines whether to export a pending object as a full replica or as a stub. When
Data Exchange is performing an export, it sets an export lock for the affected objects
at the beginning of the transfer. If a second export is initiated while a previous export
that contains the same object is pending, the object lock is still set by the pending
transfer. If this preference is set to export pending objects as a stub, it causes Data
Exchange to export the object as a POM_stub object containing only the object's
identifying information.
Caution
If this preference is set to false (or not set), a pending object that is exported as
a stub can cause a transfer to be incomplete or to fail. To avoid this problem,
set the preference to true.
VALID
VALUES
true Exports the object as a full replica.
false Exports the object as stub.
DEFAULT
VALUE
false
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TIE_fast_traversal
DESCRIPTION
Determines whether Teamcenter uses TC XML or PLM XML schema for reports. TC
XML-based reports provide a fast traversal of objects that improves performance.
However, if you have custom reports that are based on the PLM XML schema, you can
use this preference to allow their use without modification. As an alternative to using
this preference, you can add the opt_fast_traversal option, with its value set to false,
to your transfer option set to allow the use of PLM XML-based reports.
VALID
VALUES
true Reports are based on the TC XML schema.
false Reports are based on the PLM XML schema.
DEFAULT
VALUE
true
DEFAULT
PROTECTION
SCOPE
Site preference.

TIE_itemrev_infer_delete_skip
DESCRIPTION
Determines whether an update (synchronize or re-export) causes item revisions
created for secondary objects during the original export are deleted in Teamcenter
when they do not exist in the update. You use this preference to prevent the infer
delete functionality of Teamcenter from deleting an item revision of an object during
subsequent imports to Teamcenter.
For example, if this preference is not defined or is set to false and:
• The first export to the target site contains three revisions.

• The transfer completes successfully.
• The re-export contains only one revision.
Then the import process infers that the additional revisions found at the importing site
no longer exist and deletes them (infer delete function).
Note

Tip
You must select Logical from the Type list and Single from the Multiple list.
VALID
VALUES
true The import process does not delete objects at the Teamcenter site that
false The import process deletes objects at the Teamcenter site (infer delete) that
DEFAULT
VALUE
false
If this preference is not defined at the importing site, the import process uses the
false behavior.
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix
Appendix E: E:
Data Data exchange
preferences
TIE_reference_objects_list
DESCRIPTION
Specifies list of object names and attributes to be processed as reference objects. TC
XML import does not import organizational objects such as User, Group, Role and
Project objects that used for reference purposes only. These objects are searched by
the Data Exchange importer and their values are set in objects created by importer.
For example, the owning_user attribute in the WorkspaceObject object refers to a
User object with a particular ID or name.
VALID
VALUES
Strings delimited by a commas in the following format:
TIE_reference_objects_list=bo_name,bo_attr_name,ref_attr_name
bo_name Name of a Teamcenter business object.

bo_attr_name Name of the attribute on the business object that the importer
must lookup.
ref_attr_name Name of the attribute that references the business object.
For example, to get owning_user and owning_group attribute references:
TIE_reference_objects_list=
User,user_id,owning_user
Group,name,owning_group
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TIE_validate_against_xsd
DESCRIPTION
Determines whether the system validates the XML output file against the Teamcenter
PLM XML schema.
VALID
VALUES
true The system validates the XML output file against the Teamcenter
PLM XML schema.
false The system does not validate the XML output file against the
Teamcenter PLM XML schema.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

Appendix F: Glossary

Appendix F: Glossary
BOM
Bill of materials.
• 100% BOM
The as sold product configuration, for example, the configuration of a car to be built and shipped
to the dealer.
• 120% BOM
Partial overlay of selected variant conditions. You cannot build the product from a 120% BOM.
• 150% BOM
Overlays of all possible variant configurations. You cannot build the product from a 150% BOM.
See also design bill of materials and manufacturing bill of materials.
business logic reactor

See reactor.
business object
Logical grouping of data attributes and properties that are manipulated at the enterprise level.
A Global Services business object allows users to query for and update information in multiple
data sources.
business object definition file

File that contains the XML-based definition of a Global Services business object.
business object server connector

Global Services component that defines one standard method for retrieving data from all data source
systems, resulting in the ability to change or replace a data source system without affecting other
data sources in the Global Services environment.
The business object server connector is an Enterprise JavaBean.
Closure Rule
Rule that controls the scope of the translation of data imported to and exported from Teamcenter.
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.
PLM00094 11.2 Data Exchange F-1

Appendix
Appendix F: F: Glossary
Glossary
connector (Global Services)

Global Services component that accesses information from a data source. Each connector accesses
information from a particular type of data source. For example, Global Services provides a connector
for communicating with JDBC-compliant databases. Global Services offers optional connectors.
One implementation of a connector can communicate with multiple data sources by using different
connector configuration files.
Global Services connectors are Enterprise JavaBeans. Enterprise customizers can create connectors
to data sources using the Global Services connector APIs.
connector configuration file

XML-based file that specifies the data source a connector communicates with to obtain information.
For each instance of a connector, Global Services administrators create connector configuration files
that describe the data sources the connector communicates with.
credentials file
XML file that defines a Global Services user name and maps the Global Services user name to the
user's sign-on credentials for each data source connector in the Global Services environment. There
is one credentials file for each Global Services user.
The credentials file functions only with the Global Services XML credentials service. The Global
Services LDAP credentials service accesses sign-on credentials from an LDAP database.
credentials service
Global Services component that finds and provides a Global Services user's sign-on credentials for a
data source in the Global Services environment. Global Services provides two credentials services,
XML and lightweight directory access protocol (LDAP), and APIs for creating a custom credentials
service.
credentials service configuration file

XML file that configures credentials services for each data source connector in the Global Services
environment.
data source
System that manages enterprise data and can be accessed by Teamcenter. Examples are product
knowledge management (PKM) systems, product lifecycle management systems, relational
databases, enterprise resource planning (ERP) systems, component and supplier management
(CSM) systems, mechanical design automation (MDA) systems, purchasing systems, systems
engineering GroupWare, and maintenance, repair, and overhaul (MRO) systems.
datastore
Java Database Connectivity (JDBC) database instance used to store the Global Services
configuration and business object definition (BOD) information. The majority of the objects in the
datastore are stored as serialized objects for improved performance. The configuration and BOD
files are serialized during the process of uploading them to the datastore. Global Services users with
administrator privileges can access the Configuration Object form in Global Services that allows them
to add, remove, and update objects in the datastore. See also business object definition file.
F-2 Data Exchange PLM00094 11.2

Glossary
design bill of materials

List of components and subassemblies used to define an assembly structure, and the representation
of the assembly structure. Compare with manufacturing bill of materials.
Global Services connector

Global Services component that accesses information from a data source. Each connector accesses
information from a particular type of data source. For example, Global Services provides a connector
for communicating with JDBC-compliant databases. Global Services offers optional connectors.
One implementation of a connector can communicate with multiple data sources by using different
connector configuration files.
Global Services connectors are Enterprise JavaBeans. Enterprise customizers can create connectors
to data sources using the Global Services connector APIs.
Global Services Foundation

web application that enables your enterprise to access information stored in virtually any type of
electronic data source that manages your enterprise data.
Running on a standard commercial web application server, the server components of Global Services
Foundation enable communication among the data sources and between users and the data sources.
All components of Global Services Foundation use standard web technology: Extensible Markup
Language (XML), Extensible Stylesheet Language (XSL), and the Java programming language.
Users access Global Services Foundation from a commercial web browser using the standard
technologies of web browsers, primarily support for HyperText Markup Language (HTML) forms
and small Java applets.
I-deas
Siemens PLM Software’s integrated CAD/CAM/CAE solution that is used to design, analyze, test,
and manufacture products.
initiator
Data source component that sends data source messages to the Global Services message server
through an HTTP or HTTPS request.
An initiator is required only when the data source must provide information to other data sources in a
Global Services environment.
The initiator is not an integral part of the data source system; it is created by Global Services
customizers.
JDBC connector
Enterprise JavaBean that connects Global Services to data sources using the Java Database
Connectivity (JDBC) API.
The JDBC connector is provided as part of Global Services.

Appendix
Glossary
manufacturing bill of materials

Defines how the product is manufactured, rather than how it is designed. Compare with design
bill of materials.
My Teamcenter
In the Teamcenter rich client and thin client, application that is the main access point for managing
product information. My Teamcenter provides the functionality for creating objects in the Teamcenter
database, querying the database for objects, checking in and checking out objects, and managing
tasks. Users can also open objects, automatically launching the related application.
Each user has a personal My Teamcenter window that displays product information as graphical
objects. Although users share product information across the enterprise, they organize this
information individually in personal workspaces.
notifier
Global Services component that allows a Global Services administrator to configure automatic email
notification of Global Services messages to a list of subscribers.
The notifier can also log text to a file and contain Java code that executes a command when an
event occurs.
A notifier is a specialized Global Services reactor.
Object Directory Service (ODS)

Teamcenter Object Directory Services database. The ODS is either a Teamcenter site or part of
a Teamcenter site that stores publication records for objects published to a Teamcenter multisite
deployment.
ownership manager
Responsible for facilitating ownership transfer for objects and files that move between the systems.
Product Communication Layer (PCL) server

Software that performs the first phase of data migration processing to convert I-deas data for use
in Teamcenter Integration for NX. The PCL server exposes the I-deas project metadata to the TDS
server for interpretation.
publishing
Makes an object available to other sites. When you publish an object, a publication record is created
in the ODS that can be read and searched by other sites. Until you publish an object, it can only be
seen by the local owning site; other sites are not aware that it exists.

Glossary
reactor
Global Services component that implements business logic and receives messages from the Global
Services message server.
Customizers create a reactor for each data source system in the Teamcenter environment using
Teamcenter toolkit Java APIs.
Reactors are Enterprise JavaBeans.
remote action
Action that is performed from independent sites without actually logging on to the site. Remote
actions are performed within the Teamcenter managed host/server sites.
remote search
Search for published objects in the ODS. The remote search returns the publication record for the
object searched.
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 not owned by Teamcenter.
single-source business object

Global Services business object that exists in one data source with all data contained in one
addressable element. A single-source business object is defined with one data segment.
stub
Proxy object that is used to represent an object that is excluded while exporting a larger object such
as an item or an assembly.
synchronization
Process of updating replicas. When a master object is replicated at other sites, you must update the
replicas whenever the master object is modified. See also replica.
Team Browser
Client application that provides a graphical interface to I-deas Enterprise, the product that integrates
Teamcenter and I-deas Enterprise. The Team Browser enables users to view and manage the
data in their personal workspaces and teams and to interact with vaults. See also Teamcenter
Integration for NX I-deas.
Teamcenter Integration for NX I-deas

Product that integrates Teamcenter and I-deas to provide a single data management environment for
users. Teamcenter Integration for NX I-deas users author their data in I-deas and manage the data in
Teamcenter. Teamcenter Integration for NX I-deas includes the My Teamcenter user interface and the
I-deas Data Services (IDS) and Team Data Sharing (TDS) modules. See also I-deas.
team folder
Logical storage area for team data.

Appendix
Glossary
transfer mode
Objects composed of rules that configure PLM XML import and export operations. Transfer mode
allows users to import and export data with little knowledge other than the name of the transfer
mode object.
transfer option set

Stored set of transfer options for remote export or import of data.
unpublishing
Makes an object invisible to other sites. The object is accessible only by the local owning site.

Siemens Industry 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 PLM Software
© 2015 Siemens Product Lifecycle Management

Siemens PLM Software, a business unit of the Siemens
Software Inc. Siemens and the Siemens logo are
Industry Automation Division, is a leading global provider
registered trademarks of Siemens AG. D-Cubed,
of product lifecycle management (PLM) software and
Femap, Geolus, GO PLM, I-deas, Insight, JT, NX,
services with 7 million licensed seats and 71,000 customers
Parasolid, Solid Edge, Teamcenter, Tecnomatix and
worldwide. Headquartered in Plano, Texas, Siemens
Velocity Series are trademarks or registered trademarks
PLM Software works collaboratively with companies
of Siemens Product Lifecycle Management Software
to deliver open solutions that help them turn more
Inc. or its subsidiaries in the United States and in other
ideas into successful products. For more information
countries. All other trademarks, registered trademarks
on Siemens PLM Software products and services, visit
or service marks belong to their respective holders.
www.siemens.com/plm.

Data Exchange PDF

Încărcat de

Informații document

Titlu original

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Data Exchange PDF

Încărcat de

Drepturi de autor:

Formate disponibile

SIEMENS

PLM00094 11.2 Data Exchange 3

Transferring objects using business access rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Exchanging data with suppliers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

4 Data Exchange PLM00094 11.2

Package the data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18

Fast streaming data transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Low-level TC XML use cases and concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Loading bulk data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Bulk load business process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Copying product data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Bulk extract and load of product data use cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

PLM00094 11.2 Data Exchange 5

Managing administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Types of administration data you can export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Standard mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Standard PDX mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

Teamcenter Data Exchange concepts and components . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

Data Exchange components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

Synchronizing a Teamcenter database to an LDAP repository . . . . . . . . . . . . . . . . . . . . . D-1

ldapsync utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1

6 Data Exchange PLM00094 11.2

Configure the ldapsync utility for SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D-4

Data exchange preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-1

Bulk loader components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17

PLM00094 11.2 Data Exchange 7

Item attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26

8 Data Exchange PLM00094 11.2

Getting started with Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Basic concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

Installing Teamcenter Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18

Teamcenter configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24

PLM00094 11.2 Data Exchange

Verifying the transfer configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37

Data Exchange PLM00094 11.2

Getting started with Data Exchange

Before you begin

Teamcenter Data Exchange interface

PLM00094 11.2 Data Exchange 1-1

Data Exchange use cases and roles

• Exchange data between Teamcenter sites with disparate data models.

• Migrate Teamcenter Systems Engineering to Teamcenter.

• Transition from Teamcenter Enterprise to Teamcenter.

Teamcenter upgrade and other transitions

• Standardizing (harmonize) shared customizations.

• Packaging and distributing customizations to all sites.

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.

1-2 Data Exchange PLM00094 11.2

• Adding a custom integration framework connector.

• Providing methods for export, import, and confirm.

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

Data Exchange concepts

A site ( ) is a Teamcenter installation or manufacturer or supplier that uses some other

PLM00094 11.2 Data Exchange 1-3

Data Exchange does not support automatic pull synchronization.

• Closure rule clause

o Include All Versions

• Transfer option set

1-4 Data Exchange PLM00094 11.2

• File Management System (FMS) file transfer

• Single sign-on (SSO)