Teamcenter 10.1 DataExchangeGuide - Help!help.aviacons.ru/tc10doc/PDF/en_US/tdocExt/pdf/data_exchange.pdf · Teamcenter is a trademark or ... Data Exchange performance tuning

Teamcenter 10.1

Data Exchange Guide

Publication NumberPLM00094 I

Proprietary and restricted rights notice

This software and related documentation are proprietary to Siemens ProductLifecycle Management Software Inc.

© 2013 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.

Siemens and the Siemens logo are registered trademarks of Siemens AG. Teamcenteris a trademark or registered trademark of Siemens Product Lifecycle ManagementSoftware Inc. or its subsidiaries in the United States and in other countries. Allother trademarks, registered trademarks, or service marks belong to their respectiveholders.

2 Data Exchange Guide PLM00094 I

Contents

Proprietary and restricted rights notice . . . . . . . . . . . . . . . . . . . . . . . . . 2

Part I: Introduction

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

Getting started with Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Basic concepts for using Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Progress monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Progress monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Part II: Installation and configuration

Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Planning your installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Planning your installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Installation worksheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Installing Teamcenter Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Installing Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1Teamcenter server installation requirements . . . . . . . . . . . . . . . . . . . . . . . . 5-1Teamcenter configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Install Global Services Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10Global Services Web application deployment . . . . . . . . . . . . . . . . . . . . . . . . . 5-14Global Services configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34Configure PDX export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42Defining a PDX workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44Defining a custom PDX style sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44

Using briefcase files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Using briefcase files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1Migrate a supplier site from a managed to unmanaged site . . . . . . . . . . . . . . 6-10Configure 4th Generation Design data exchange . . . . . . . . . . . . . . . . . . . . . . 6-12

Using the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Introduction to the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1Enabling the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1Start the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3Mapping Designer user interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

PLM00094 I Data Exchange Guide 3

Contents

Filtering rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5Basic tasks using the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6Advanced tasks using the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . 7-15Mapping Designer perspectives and views . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28

Verifying and troubleshooting the transfer configuration . . . . . . . . . . . 8-1

Verifying and troubleshooting the transfer configuration . . . . . . . . . . . . . . . . 8-1

Part III: Data sharing

Using Data Exchange from Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Using Data Exchange from Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1Progress monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12Controlling transfer activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13Working with remote objects using ODS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13Transferring a briefcase package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-16Working with unmanaged site briefcase files . . . . . . . . . . . . . . . . . . . . . . . . . 9-19Working with PDX data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-23Process for bulk loading Teamcenter data . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-24

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

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

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

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

Data Exchange performance tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

Data Exchange performance tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1Tuning aspects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1Pooling Teamcenter connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2Throttling mapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3BPEL performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-4Logging configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-5

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

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

Teamcenter core data dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-1

Teamcenter data model diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-1

Sample assembly structure in a TC XML file . . . . . . . . . . . . . . . . . . . . . G-1

Sample TC XML file with GSID references . . . . . . . . . . . . . . . . . . . . . . . H-1

Sample bulk load repeat file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . I-1

Frequently asked questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . J-1

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . K-1


Contents

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1

Figures

Bulk loader components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15FSC for Teamcenter host 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3FSC for Teamcenter host 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Collapsed standard style sheet view . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45Customized style sheet with subtypes . . . . . . . . . . . . . . . . . . . . . . . . . 5-46Customized style sheet with AdditionalAttributes elements . . . . . . . . . 5-47Mapping Designer perspective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4Creating a map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11Creating a comma-separated value (CSV) file . . . . . . . . . . . . . . . . . . . 7-21Creating an index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22Creating an association . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22Lookup definition files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23Lookup function file added to the factor’s libraries . . . . . . . . . . . . . . . . 7-24Lookup table in a map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-24Island of data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-26TC XML root element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-27TC XML object reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-28Typical TC XML island structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-29Organizational and administrative TC XML elements . . . . . . . . . . . . . 9-29XML elements for replicatable objects . . . . . . . . . . . . . . . . . . . . . . . . . 9-31TC XML Header element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-32GSID-based organization objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-33Object referenced by child GSID elemId attribute . . . . . . . . . . . . . . . . 9-34TC XML file with POM stubs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-34Create, update, and skip sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-38Validation log file in Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-41Teamcenter site configuration in Global Services properties file . . . . . . . C-3Teamcenter connector configuration in Global Services site map file . . . C-4Teamcenter connector throttling configuration for mapper . . . . . . . . . . C-4Activity status configuration settings . . . . . . . . . . . . . . . . . . . . . . . . . C-5Object nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-2LDAP person object mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-5LDAP group and role object mapping . . . . . . . . . . . . . . . . . . . . . . . . . D-9

Tables

Item attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-1Anchor elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-2ItemRevision attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-3Form attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-5ImanRelation attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-7PSBOMView attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-7PSBOMViewRevision attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-9PSOccurrence attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-10PSOccurenceThread attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-11Dataset attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-12

PLM00094 I Data Exchange Guide 5

Contents

RevisionAnchor attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-14ImanFile attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-15User attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-16Group attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-17Tool attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-17ImanType attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-17ImanVolume attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-17DataseType attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-17


Part

I Introduction

This guide describes how to install and configure Teamcenter Data Exchangecomponents and provides supported business process descriptions. Data Exchangecomprises the following core components:

• Teamcenter 10.1

• Data Exchange Web application solution

• Security Services (if using single sign-on)

Also, this guide provides procedures for using Data Exchange to transfer databetween product life cycle management sites.

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

Progress monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

PLM00094 I Data Exchange Guide

Chapter

1 Getting started with DataExchange

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

Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Basic concepts for using Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Key concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Teamcenter Engineering upgrade and other transitions . . . . . . . . . . . . . . 1-5Briefcase file exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Teamcenter offline exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5Siemens PLM Software briefcase file exchange . . . . . . . . . . . . . . . . . . 1-6Supplier site exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7

4th Generation Design data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8PDX export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12Teamcenter variant schema exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12Requirement objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13Vendor management objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13Multiple language support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13Bulk loading data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15Configured BOM export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16Multifield key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16


Chapter

1 Getting started with DataExchange

Getting started with Data ExchangeMake sure you complete prerequisite tasks and understand basic concepts aboutTeamcenter Data Exchange.

Before you beginPrerequisites Unless stated otherwise in the description of a configuration

task, you must be a dba group member or member of anothergroup with dba privileges.

Enable DataExchange

Complete the installation and configuration tasks describedin this guide to enable.

Configure DataExchange

Configuring Data Exchange is described in the following topics:

• Teamcenter configuration

• Global Services configuration

Start DataExchange

Data Exchange is accessible from within the thin client or richclient interface.

Basic concepts for using Data ExchangeTeamcenter 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 certain sites to be retired.

For information about the site consolidation process and tools, contact the GlobalTechnical Access Center (GTAC).

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

• Exchange data between Teamcenter sites with disparate data models.

PLM00094 I Data Exchange Guide 1-1

Chapter 1 Getting started with Data Exchange

• Upgrade multiple Teamcenter Engineering (Engineering Process Management)sites with disparate data models to Teamcenter.

• Transfer data from non-Teamcenter data sources to your Teamcenter site.

• Migrate Teamcenter Systems Engineering to Teamcenter.

• Transition from Teamcenter Enterprise to Teamcenter.

For information about installing and configuring Teamcenter Enterprise andTeamcenter to transition data to Teamcenter, see the Transition Guide.

Note It is important that you carefully consider your specific requirements duringthe planning phase of a transition. The following are possible transitionscenarios.

These descriptions provide very high-level considerations. Contact SiemensPLM Software services for assistance in determining the best approach foryour companies requirements.

Key concepts

The following are key concepts for understanding how you use Data Exchange.

• Site

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

• Export

Export is the Data Exchange function used to send data to a remote site. Whileexporting the data, you can either transfer the data with ownership or transferthe data for reference. If you transfer the data for reference, the ownership isretained 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 siteimports 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. Whenevera master object is modified, you must update the replicas by synchronizing themto the master. A replica is a nonwriteable object and cannot be updated exceptby the owning site. When an object is replicated, you cannot delete the masterobject unless all the replicas are deleted.

A replica is represented by a symbol with two green dots.

• Synchronization

When a master object is replicated at other sites, you must update the replicaswhenever the master object is modified. The process of updating replicas is

1-2 Data Exchange Guide PLM00094 I

Getting started with Data Exchange

referred to as synchronization. The synchronizer is responsible for ensuring thata previously replicated data is synchronized.

Manual synchronization is performed by a user. It is a re-export or re-importof the object with the same transfer formula. Automatic synchronization issupported for push cases and is initiated by Global Services by making a callto transfer updated objects.

Caution When manually synchronizing a replica, both the owning site andreplica 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 controlshow the data structure is transferred by specifying which relationships are ofinterest.

• Transfer mode

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

• Transfer option

Specifies the different options by which you can transfer an object. The differenttransfer options are:

o Include All Versionso Latest Versionso Selected Versiono Include Entire BOMo Transfer Top Assembly

• Transfer option set

A transfer option set (TOS) ( ) is a stored set of transfer options used forremote data export. A transfer option set displays all of the unique options inthe 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 sitethat map to a similar logical concept defined by a different set of objects at theimporting site. You define a factor using a closure rule. Closure rules helpoptimize Data Exchange performance.

• File Management System (FMS) file transfer

File Management System (FMS) is used for transferring files by geographicallyseparated work groups whose sites are connected by wide area networks (WANs).



It also allows access to shared documents in local area network caches, whichhelps avoid round-trips across high-latency WAN networks to reach sites.

FMS uses a file GUID, a business-neutral identifier for file contents, to determinewhen to pull a file from its local cache, rather than retrieving the file across anetwork from the underlying file system of the site. Binary and text files have adifferent GUIDs if they are replicated. However, if you change the file content byone bit or change its language encoding, the system creates a new file GUID todescribe the new contents of the file.

• Single sign-on (SSO)

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

• Export protection

The export protection capability of Data Exchange sends export-protectedobjects as stubs.

• Replica deletion

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

• Stub replication

The stub replication capability ensures that when a master object replica issent to another site, the exporter creates an export record for this new site andtags it as stubbed.

• International Traffic in Arms Regulations (ITAR) license

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

• Audit monitoring

Global Services provides an audit log of transactions during transfers betweenTeamcenter Enterprise and Teamcenter that is maintained in the GlobalServices database. You can query for transactions using the AuditMonitoringbusiness object search form in the Global Services portal. The followingtransactions 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



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

o Fnd0LicenseChangeAudito Fnd0LicenseExportAudito Fnd0OrganizationAudit

Teamcenter Engineering upgrade and other transitions

Data Exchange can aid you when you are upgrading multiple TeamcenterEngineering (Engineering Process Management) sites that have disparate data andoperational 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, workprocesses, and so forth.

Note Site standardization can be joined with site consolidation.

• Upgrading all sites to Teamcenter as interim step.

• Enabling target sites with the harmonized data model.

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

You can also use the Global Services framework components to transition third-partyor custom systems, such as non-Siemens PLM Software PLM or PDM systems, toTeamcenter. High-level considerations for the transition process are:

• Adding a custom Global Services framework connector.

• Providing methods for export, import, and confirm.

• Leveraging connectors developed by Siemens PLM Software partners forthird-party competitive systems, such as, ENOVIA or Inventor.

• Leveraging or reusing Global Services components and tools such as the mapperand BPEL engine.

Briefcase file exchange

Teamcenter offline exchange

There may be times when a Teamcenter site that shares data with other sites isnot online. The Siemens PLM Software briefcase functionality also allows you totransfer the data in the archived file format between the offline sites.



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

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

During the export process, if a revision rule results in an imprecise line, theexporter includes the latest revision. Unconfigured lines and any unchanged objectsconfigured by incremental change that have already been exported are exportedas stubs (BOMLine objects as full objects with PSOccurrence objects as stubs).Additionally, new BOM lines added to a structure that are not tracked by incrementalchange 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 exportedstructure is not included in the exported briefcase file. The importer deletes (inferreddelete) the object at the importing site when the structure exists at the importingsite.

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

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

For information about distributing system administration objects, see the Multi-SiteCollaboration Guide.

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

For more information about exporting and importing incremental change data, seethe Manufacturing Process Planner Guide.

Siemens PLM Software briefcase file exchange

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



For information about Briefcase Browser, see Using briefcase files, Working withunmanaged site briefcase files, and the Briefcase Browser Guide.

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

Feature Briefcase PLM XML

Use case focus Managed suppliers orumanaged suppliers withBriefcase Browser

General data exchange

Package container ZIP file None

File format Teamcenter XML (TCXML)

PLM XML

Checkout support Yes No

Content NX, JT, and documents JT and other files

Transfer mode(determines content)

User selected (TM andTOS)

User selected TM only (nooptions)

Incremental (delta) exportsupport

Yes No

Applicationinteroperability

Teamcenter 2007 MP1 orlater only

Teamcenter and otherPLM XML compatibleapplications

Toolkit/SDK support None planned PLM XML SDK

Supplier site exchange

For security or logistics reasons, you may need to exchange information with asupplier that does not have an online connection to any of your Teamcenter sites.Using the Siemens PLM Software briefcase functionality of Teamcenter DataExchange allows you to provide the shared data in an archive file that can bephysically 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 archivethat has the checked-out object, the associated objects required to properly lockthe object for modification, and the site reservation object that contains a remotesite attribute. If the remote site attribute matches the importing site, Teamcentercreates a reservation object associated to the object at the importing site. This allowsusers at the importing site to locally check out and modify the objects (provided theyhave the proper privileges) even though the objects are replicas and not ownedby the site. An object that is checked out to another site has its Checked Out byproperty set to the remote site. The following objects can be checked out to a site:

• BOMView

• BOMViewRevision

• Dataset

• Form



• Item

• ItemRevision

Tip The view type data is not exported with the PSBOMView data in TC XML.The import process uses the default view type when importing PSBOMViewdata.

Therefore, when transferring PSBOMView data using a briefcase file,tcxml_export and tcxml_import, or any utility that uses TC XMLmetadata, set the PSE_default_view_type preference at the target site tothe view type value of the assembly at the source site. Usually, this is thesame 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 outItem 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 ahub site (tier-1 supplier) can use the Check-Out to site command to check out objectsto one of their suppliers (tier-2 supplier) for modifications. The owning site attributeis set to the exporting site (tier-1 supplier), which allows the importing site to modifythe data and send it back to the hub site.

Note If a tier-2 supplier does not use the Check-In from site command beforesending an object back to the tier-1 supplier, the tier-1 supplier must performthe 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 restorethe reservation object to its precheckout state. Datasets are not restored to theirprecheckout state but the site checkout lock is removed.

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

4th Generation Design data

4th Generation Design (4GD) is the process of developing a collaborative designthat contains all the necessary design information used to manufacture the subjectproduct, for example a car, ship, or aircraft. A collaborative design is the collectorfor product configurations and includes all product design data as design elementsand design features. You develop your collaborative design using the 4G Designerapplication. supports massive product designs with millions of business objects andalso supports enhanced collaborative business processes. You can exchange 4GDdata by exporting and importing briefcase files. The briefcase file uses Teamcenteras the payload to provide the scalability to handle the massive data required for4GD data exchange.



Note The Briefcase Browser application does not support briefcase files containing4GD data.

For information about 4GD concepts, see the 4th Generation Design Guide.

The following 4GD concepts apply to briefcase data exchange.

Data Exchange also supports low-level TC XML transfers for bulk loading data. Thiscapability can be used during site consolidation activities that include 4GD data.You can export and import configured 4GD data and its supporting infrastructure inan unmanaged site briefcase file.

The following 4GD business objects are supported in briefcase transfers:

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

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

When replicating partition data model members:

• Member-owned memberships are exported as full objects.



o If PtnB is the root object:

LinkAB, membershipB1, memebershipB2, and PtnB objects areexported 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 asfull objects.

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

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

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

• POM revisioning

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



• Partitions

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

• Compatibility

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

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

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

For roots objects designated as not exportable, the object is listed asSTUB_INSUFFICIENT_PRIVILEGE in the export log and a stub object is createdat 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 isexported separately from 4GDstructure due to the potential sizeof the data. If you want to exportBOM structure and 4GD structuretogether in single operation, set thisoption to true.

Note BOM structure includesthe full island of data ofan associated item/BVRwith a design element.

DesignElement sourceobjects are exported as fullobjects. For ShapeDE objects,ShapeDesignRevision is thesource object. For ReuseDEand SubordinateDE objects,ItemRevision is the source object.

opt_workset_rlz_de By default, the Workset/Subsetstructure is exported separatelyfrom DesignElement objects. If youwant to export the Workset/Subsetstructure and DesignElementobjects together in a single operation,set this option to true.

Realization map objects(Rlz0ModelRealizationMap)are exported as full objects.The source object can be aDesignFeature, DesignElement,or DesignControlElement object.

opt_exp_cfgbom Sets the export mode for eitherconfigured or unconfigured 4GD data,Set to true to export configured 4GDdata.

Configured and unconfiguredbehavior are explained followingthis table.

Configured export1. Constructs the BOMWindow object for the given root object and configuration

context (revision rule, variant rule, and effectivity).



2. Get the top line from BOMWindow object. For a Workset object, this is theWorksetLine object.

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

4. Serialize 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 canbe viewed by PDX viewer applications or used by other systems that support thePDX data format. You can also create a PDX package using a workflow process byspecifying the workflow handler provided for PDX packages.

Data Exchange exports the Teamcenter data in an XML format (TC XML) thatis converted to PDX format by a style sheet (XSLT). Teamcenter uses features ofTeamcenter Global Services and Teamcenter briefcase to perform the export. GlobalServices schedules the export job and also transforms the TC XML data to PDXdata using XSLT. Teamcenter briefcase packages the contents and uploads the PDXpackage to Teamcenter. The following figure shows how the Teamcenter componentsinteract to export a PDX package.

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

• The Global Services deployment URL.

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

TC_gms_export_transfermode_for_Pune = TIEPDXExportDefault

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

For information about the Teamcenter objects that can be exported to PDX andhow they are mapped to PDX objects by the out-of-the-box (OOTB) mapping file,see Standard PDX mapping.

Teamcenter variant schema exchange

The data mapping functionality of Teamcenter Data Exchange allows you to sharedata among Teamcenter sites that have variations in their object schemas by



mapping the attributes between objects that differ. Standard Teamcenter DataExchange supports transfer of ownership of objects between Teamcenter sites onlywhen the schemas are identical. To transfer ownership between Teamcenter siteswith variant schemas, you must create a custom style sheet (XLST file) that excludesthe objects that are not defined at the importing site.

Requirement objectsData Exchange can transfer requirement objects and their associated data betweenTeamcenter sites, with or without ownership, and can synchronize replicateddata. However, if you require remote check out and check in actions, you must useMulti-Site Collaboration.

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

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

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

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

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

Multiple language supportThe Teamcenter multilingual schema contains elements for localizable attributevalue representations in one or more languages. This allows you to export andimport objects with localizable attributes for display names in more than onelanguage. Teamcenter clients that access the imported data can display the localizedattributes in differing languages depending on their locale. Prior to Teamcenter8.2, Teamcenter sites were monolingual, that is, they could import attributes inonly one language. Teamcenter 8.2 and later versions can be either multilingual ormonolingual.

For information about localizing displayed names, see the Localization Guide.

When you upgrade to Teamcenter 8.2 from a previous release, the TC XMLschema that Data Exchange uses to transfer data between sites must bemodified to provide additional attributes that hold localized values for attributesthat are designated by the localizable proper constant for the attribute. Thebmide_generatetcxmlschema Java utility provides the modification to theschema. The upgrade process runs this utility at the end of the database installationor upgrade. The utility retrieves a list of languages that are supported by thedatabase and provides attributes to hold localized values for the attributes that have



the localizable property constant set to true. It adds localized attributes to theschema for the primary language of the database and for each approved nonprimarylanguage.

Note The URIs that appear in the headers of PLM XML and TC XML files serveas namespace names, which are unique identifiers for an XML vocabulary.Although they are URIs, they are not used to identify and retrieve Webaddresses.

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

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

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

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

o For objects transferred from monolingual to multilingual sites, DataExchange uses the site master language specified in the transfer formulato import the localizable attributes. If the transfer formula does notcontain 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 ofthe multilingual site for the import to succeed.

o For objects transferred from multilingual to monolingual sites, DataExchange ignores the locale information in the TC XML file. Requiredattribute values are stored in the importing site. Therefore, the site masterlanguage at the multilingual site must be supported at the monolingual site,and all localized attributes must have a site master language representationat 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-8characters (such as Shift-JIS) are not supported.

• You can transfer objects with ownership between multilingual sites thathave their required languages common to both sites. The tcxml_import andtcpxml_export utilities support arguments that allow you to specify allowedand required languages.



Caution When attribute values contain commas in the strings ateither of the sites, you must change the default value for theGMS_tcxml_string_separator preference at both sites to preventdata corruption at the importing site.

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

Bulk loading data

Bulk loader is a tool that you can use in a data migration solution to import datafrom a legacy system into Teamcenter. Bulk loader leverages the site consolidationtechnology to achieve desired performance/scalability specifications for datamigration. The legacy data must be extracted and mapped to the TC XML formatby a custom solution. The following figure shows the components involved in adata migration solution. The Validator, Importer, and the API to generate object IDcomponents are provided as part of the bulk loader functionality.

Bulk loader components

For information about the bulk loading process and requirements, see Process forbulk loading Teamcenter data.



Configured BOM export

Data Exchange allows you to export a configured bill of materials (BOM) usingTC XML which provides extensibility and an increase in speed and scalability forthis type of export. The export uses the fast traversal method of the bulk loader toquickly stream Teamcenter data to a TC XML file. This is useful in active workspace(AWS) and supplier exchange activities. This functionality is available from the MyTeamcenter and Structure Manager applications in the rich client interface.

Data Exchange constructs the BOM for the given root object and configuration rules(revision and variant rules). It traverses the BOM as defined by the closure rulesand 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 thetransfer 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, andgeneric design elements (GDE) lines.

For information about how to export a configured BOM, see Exporting a configuredbill of materials (BOM).

Multifield key

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

For more information about multified keys and their use, see the Business ModelerIDE Guide.


Chapter

2 Progress monitor



Chapter

2 Progress monitor

Progress monitoringYou can see the status of each transaction, transfer request, replication request, andsynchronization request in the Global Services Audit - Activity Status table thatGlobal Services displays in the default Web browser. This functionality is availablein Teamcenter and in Teamcenter Enterprise through the Show progress indicatoroption in the Export To Remote Site Via Global Services dialog box.

You can also search for a request using specific search criteria supplied through asearch dialog box. You can abort or resume a halted transaction by searching forthe transaction in the MsgResult or MessageResults business object search dialogbox. Click the Result ID column to access Process - Abort Transaction or Process -Resume Transaction options.

The show progress functionality is accessible from My Teamcenter and theTeamcenter and Teamcenter Enterprise thin clients. To enable real-time monitoring,you must select the Show progress Indicator check box in the import or exportoptions dialog box for the transfer.


Part

II Installation and configuration

Perform prerequisite tasks, plan your installation, and then install Data Exchange.

Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Planning your installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Installing Teamcenter Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Using briefcase files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Using the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Verifying and troubleshooting the transfer configuration . . . . . . . . . . . . . . . . 8-1


Chapter

3 Prerequisites

Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1


Chapter

3 Prerequisites

PrerequisitesYou must have a Teamcenter server installed that contains several optionalcomponents. Depending on the use cases that Data Exchange must support, youmay need other products, such as Teamcenter Integration for NX I-deas and theContent Migration Manager (CMM). These products are documented in their owndocumentation set provided with the product. The following figure shows a sampledeployment scenario with two Teamcenter sites participating in the Data Exchangenetwork.


Chapter

4 Planning your installation

Planning your installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Installation worksheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1


Chapter

4 Planning your installation

Planning your installationSome information provided in this topic is optional depending on the businessprocesses you plan to support. Information about supporting functionality, such assingle sign-on (SSO) and File Management System (FMS) is described with referenceto the general documentation provided for those features. You must follow thedefined 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 andFMS, for each Teamcenter site participating in the network.

For information about installing a Teamcenter server, see the appropriate serverinstallation guide (for Windows or UNIX /Linux).

• Configure each Teamcenter server.

• Install and deploy a Teamcenter Web tier application with the required DataExchange solutions.

For information about installing Web tier applications, see the appropriateserver installation guide (for Windows or UNIX/Linux). For information aboutdeploying a Web tier application, see the Web Application Deployment Guide.

• Install a Global Services Web tier application with the required Data Exchangesolutions.

• Configure Global Services components required for Data Exchange.

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

For information about installing Security Services, see Security ServicesInstallation/Customization.

Installation worksheetsUse these worksheets to record important information about your network. You needto record this information for reference on the worksheet and also get values herewhen they are needed.


Chapter 4 Planning your installation

Worksheet 1 – Data Exchange deployment information

Teamcenter site IDs

Teamcenter Web application URLs

ODS servers (if applicable)

Global Services Web application URL(TC_gms_server preference)

Security Services logon URL

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

Administrator user name/password(default: infodba)

Administrator password

Site ID

TC_gms_server

TC_SSO_login_URL

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

Web tier application staging directory

Web tier application name (context root)

Context parameters

DEPLOYABLE-FILE-NAME


Planning your installation

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

Enterprise Application RegistrationID

LogVolumeName

LogVolumeLocation



Worksheet 3 – FMS information

KeyGen value

FMS_HOME directory

FMS key file name

Site 1 parameters:

siteidfscidfscaddress

Site 2 parameters:


Site 3 parameters:


Additional site parameters


Planning your installation

Worksheet 4 – Security Services information

Global Services user

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 – Global Services Information

ICD file location

WEB_ROOT location

Web application staging location

Global Services Web application URL (For example: http://host:port/tcgs/controller/home)

Map control files

Site ID

Teamcenter site IDs

Teamcenter administrator user nameand password(for connecting to Teamcenteron behalf of Global Services,GlobalServicesAdmin.xml andJDBCMessageBox.xml files).



Worksheet 6 – Global Services Information

Teamcenter user name and password.(for connecting to Teamcenteron behalf of Global Services,GlobalServicesAdmin.xml andJDBCMessageBox.xml files)

fsc.uris


Chapter

5 Installing Teamcenter DataExchange

Installing Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Teamcenter server installation requirements . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Teamcenter configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2File Management System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

Create an FMS key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Configure FMS for Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

Transfer option sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Transfer CATIA alternate shape representations . . . . . . . . . . . . . . . . 5-4Create version 0 transfer option set . . . . . . . . . . . . . . . . . . . . . . . . . 5-5

Define users, groups, and rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Define remote sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6Set a rule to allow transfer of ownership . . . . . . . . . . . . . . . . . . . . . . . . . 5-6Closure rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7Transfer modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7Data mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8

Preventing data loss . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9Configure Supplier Relationship Management . . . . . . . . . . . . . . . . . . . . . 5-9

Install Global Services Data Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10Supporting files locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10Generate Web applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11

Global Services Web application deployment . . . . . . . . . . . . . . . . . . . . . . . . . 5-14Creating the Global Services tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14Configuring application servers for Global Services . . . . . . . . . . . . . . . . . 5-16

Deploy the Global Services application . . . . . . . . . . . . . . . . . . . . . . . 5-17Deploy on Websphere 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18Deploy on WebLogic 12.1.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20Deploy on JBoss 7.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21

Configuring Data Exchange orchestration . . . . . . . . . . . . . . . . . . . . . . . . 5-25Configure the application server for ODE . . . . . . . . . . . . . . . . . . . . . 5-25Configure ODE to use an Oracle database . . . . . . . . . . . . . . . . . . . . . 5-27

Configuring Global Services for HTTPS . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28Configure the application server for SSL . . . . . . . . . . . . . . . . . . . . . . 5-29Configuring File Management System for SSL . . . . . . . . . . . . . . . . . . 5-29

Generate a key store and private key . . . . . . . . . . . . . . . . . . . . . . 5-30Obtain a signed certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31Update the FSC and FMS configuration . . . . . . . . . . . . . . . . . . . 5-31


Configure Global Services application as a trusted client . . . . . . . . . . . 5-32Install the Global Services signer certificate to Teamcenter rich

client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32Install the Global Services signer certificate to Teamcenter thin

client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32Configure the Teamcenter Enterprise Global Services end point

variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33Modify Teamcenter preferences for SSL . . . . . . . . . . . . . . . . . . . . . . . 5-33

Global Services configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34Configure required Global Services components . . . . . . . . . . . . . . . . . . . . 5-34Configuring off-hours transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38Configuring export to secret teams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39Configure map files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40Configure site mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41Custom BPEL processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41

Configure PDX export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42

Defining a PDX workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44

Defining a custom PDX style sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44Subtyped objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45Custom attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-46PDX specification elements not in the standard style sheet . . . . . . . . . . . . 5-47

Data Exchange Guide PLM00094 I

Chapter

5 Installing Teamcenter DataExchange

Installing Data ExchangeThis installation process describes the requirements when installing the Teamcenterserver and the Teamcenter – Server Adapter Web tier solution, which are providedin the Teamcenter server installation guides, installing supporting components andoptional CAD tools, (which are covered in their own documentation), creating theGlobal Services Web application with the components required for Data Exchange,and deploying the Web application.

Teamcenter server installation requirementsFor information about installing the Teamcenter server, see the Teamcenter serverinstallation manual (for UNIX/Linux or Windows).

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

• Global Services features:

o Global Services Preferences

o Global Services Framework

o Global Services Monitoring GUI for Rich Client

Note The Global Services adapter option is not required for Data Exchange.

You must a enter value for Server URL parameter during the TeamcenterEnvironment Manager (TEM) process. This parameter specifies the GlobalServices Web application URL on the application server, for example,http://ciwin3:7001/tcgs

• Four-tier architecture

• FMS

An initial installation of Teamcenter using Teamcenter Environment Managerprovides a single FSC that mounts to a single volume.

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


Chapter 5 Installing Teamcenter Data Exchange

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

For information about ODS, see the Multi-Site Collaboration Guide.

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

For information about installing Security Services, see Security ServicesInstallation/Customization.

Teamcenter configurationConfiguring Teamcenter for Data Exchange involves performing the following tasks:

1. Configure File Management System.

2. Define sites.

3. Set Access Manager (AM) rules to allow transfer of ownership betweenTeamcenter sites.

4. Create transfer option sets.

5. (Optional) Create closure rules.

6. (Optional) Create transfer modes.

7. (Optional) Update preferences.

8. (Optional) Configure PDX export.

File Management SystemData Exchange uses File Management System (FMS) keys to digitally sign andverify FMS tickets during file transfers. FMS keys can use different keys fordifferent ticket types; however, this is not a best practice for Data Exchange.Teamcenter Enterprise does not provide a default key value. Because you use thesame key for all systems that exchange files, you must either use the TeamcenterFMS default key value or generate a key and use the install_encryptionkeysutility to set the key in the Teamcenter database. FMS provides a script (keygen)that runs a Java utility for generating a key. This utility requires that you have theFSC_HOME and JAVA_HOME environment variables set.

Data Exchange creates tickets with the delete flag set to false to allow a pausedtransaction to be resumed. Therefore, you must periodically delete completedtransactions 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.


Installing Teamcenter Data Exchange

# This file (FMS.key) contains a 128–bit key for FMS ticketsf6968bd55d740f44ebacaba09c1313c4

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 theinstall_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 thatyou create and to configure the FSCs from different sites to communicate with eachother. The mulitsiteimport element is used to set the attributes for each site inthe Data Exchange network. The following figures show a possible configuration fora Data Exchange network that has two Teamcenter sites (TcHost1and TcHost2).You can configure FMS in several ways to obtain different performance and failuretolerance characteristics. For more information about the configuring FMS, see theSystem Administration Guide.

<!— 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. Youwill need this later during the Global Services configuration.



<!— 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

Transfer option sets

A transfer option set (TOS) is defined as a local TOS (for export transfers) or aremote 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 thetransfer mode (TM) and closure rules are defined at the remote site. The remote siteTOS 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 atransfer option set. For additional information about managing transfer option sets,see the PLM XML/TC XML Export Import Administration Guide.

Note A remote TOS is normally imported from a remote site to ensure that itmatches the TOS on the remote site. Although you can create a remote siteTOS and manually synchronize it to the remote site, it is recommended thatyou use the import (tcxml_import) and export (tcxml_export) utilitiesinstead to provide your remote TOS. Once a TOS is imported, you must notchange the TOS name or site reference; however, you can add or removeoptions as long as the TOS at the remote site is updated to reflect thechanges you make.

For remote transfer option sets, you define only the TOS name, which must matchthe TOS name defined in the remote system. You must define a local transferoption set for exporting data to another site. A local TOS requires that you definean option row in the options table for each symbol that is defined in the associatedclosure rule clause.

Transfer CATIA alternate shape representations

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

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

These property clause entries export the Shapes_Name and Shapes_Filesattributes 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 thatcontains an IMAN_specification relation to a dataset, Teamcenter exports twodatasets pointing to the same ImanFile object. You can change the export behaviorto 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 optionset and set its value to True.

Caution Do not set this option to TRUE when you are transferring objectsthrough a briefcase file. If this option is not set to FALSE , the briefcaseimport fails.

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

2. Select the name of the transfer option set you want to use when transferringitem 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) andtype 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 Descriptionbox.

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

9. Click Create.

Define users, groups, and rules

The following setup is required to ensure that the Teamcenter Enterprise ownerattribute 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 Enterprisewith the corresponding users created previously members with this as theirdefault group.

This configuration ensures the following standard mapping does not cause anerror on import.



From TeamcenterEnterprise To TeamcenterUser team Owning user and owning user’s default group

WPS team Owning user and owning user’s default group

Vault Owning user and owning user’s default group

From Teamcenter To Teamcenter Enterprise

Owning user Owner (team or vault)

Owning group Not mapped (data not transferred)

Define remote sitesRemote sites are created using the Organization application. For more informationabout defining sites, see the Organization Guide. You must define sites for alllocations 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. Forthe deployment example, Teamcenter site 1 defines two remote sites: TcHost1and 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 siteID in each definition. For Teamcenter sites, this value is definedduring the installation process. For Teamcenter Enterprise sites,this is the Site ID value that is entered when the local site object iscreated in Teamcenter Enterprise.

4. Type the URL for your Global Services Web application in the Tc GS URL box.

5. Select the Uses TCXML Payload check box.

6. Select the 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.

Set a rule to allow transfer of ownershipBy default, the Access Manager (AM) rules do not allow transfer of ownership fromone Teamcenter site to another. You must change the default value to enable thiscapability.

For more information about AM rules, see the Access Manager Guide.



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

2. Click to grant Transfer Out ( ) privileges.

3. Click Modify and click .

Closure rules

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

If $HPGL

Closure rules are a component of a transfer mode and therefore must be createdbefore the transfer mode. Closure rules can use various action directives, suchas the SKP_GRM action that Teamcenter uses to skip the Generic RelationshipManagement (GRM) objects for exports. Alternatively, the SKIP action skips thesecondary objects but includes the primary and GRM objects in the export.

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

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

Data Exchangestandard scoperule object

Prior to Teamcenter 9.1(defaultTransferModes.xml)

Teamcenter 9.1 exportto HL TC XML(defaultTcxmlScopeRules.xml)

Teamcenter 9.1 configuredexport to LL TC XML(defaultTcxmlScopeRules.xml)

Transfer option set TIEOptionSetDefaultTIEUnconfiguredExportDefaultTIEConfiguredExportDefault

TIEConfiguredExportDefault_LL

Transfer mode TIEUnconfiguredExportDefault TIEExportDefaultTM TIEExportDefaultTM_LL

Closure rule TIEUnconfiguredExportDefault TIEExportDefaultCR TIEExportDefaultCR_LL

Property set TIEPropertySet TIEExportDefaultPS TIEExportDefaultPS_LL

Transfer modes

Data Exchange provides standard transfer modes that allow you to move standardTeamcenter and Teamcenter Enterprise data between sites. If these standardtransfer modes do not meet your requirements, you must provide a transfer modefor 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 transfermodes for Data Exchange must navigate clauses in the resulting XML file notthe Teamcenter database. The transfer modes defined for a specific site typically



uses the same closure rule but have different filters, action rule, or revision rulesdepending on the type of data being transferred.

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

Note If you are using the CATIA integration and are transferring assemblies withCAD data, you must add the following property set clause to the transfermode 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 errormessage indicating the export failed at the Global Services data import step,and the log file shows the IsContext attribute of the POM_catia_absoccclass is empty.

For information about property set clauses, see the PLM XML/TC XMLExport Import Administration Guide.

Caution The forceExportReplica option must be set to TRUE only when youare transferring non BOM data. For BOM relevant data, this optionshould not be used or, if set, it must be set to FALSE.

For additional information about managing transfer modes, see the PLM XML/TCXML Export Import Administration Guide.

Data mappingThe Business Modeler IDE (Integrated Development Environment) hosts theMapping Designer data migration tool that you use to map the data model betweensites. This tool is based on the Altova MapForce graphical data modeling tool.

In the Mapping Designer tool, you can create a new project or open an existingone, such as the standard sample projects. All the mapping information betweena source and a target site are stored in the form of a Mapping Designer project. Aproject contains the following information:

• Source and target schema definition files

• Factor definitions (XML) files

Each factor contains source and target objects, their selected properties, instancefiltering rules, and factor dependencies. A factor defines conceptual element ofthe source or target systems. Defining factors and specifying the transformationfor each factor separately simplifies the mapping process and allows a moremanageable 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 thefactors that are defined and their corresponding transformations (XSLT).



These identifiers help Mapping Designer track which generic system the sourceand target schema belong to. A Mapping Designer project retrieves this fromthe schema files and stores it as project properties. The property names aresourceendpoint and targetendpoint. The factors created/stored in the projectindividually store this information, so each factor identifies that it is valid for aspecific sourceendpoint and targetendpoint property. This information is helpfulwhen a factor is being imported.

For information about installing the Mapping Designer and how to use it, seeIntroduction to the Mapping Designer.

Preventing data loss

Mapping data between different systems results in the possibility that data canbe lost under certain circumstances. An example of this possibility is when thefollowing 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 andthe transfer is undone.

This situation could result in the loss of data because when an object is transferredfrom Teamcenter Enterprise to Teamcenter, some attributes are dropped during themapping processing. This is due to data model incompatibility and because someTeamcenter 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 isno way for it be repopulated in Teamcenter Enterprise on the reverse trip.

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

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

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

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

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

Primaryobject classtype

Primaryobject

Relationtype

Related propertyor object

Propertyactiontype

CLASS Item Attribute checked_out DO

CLASS Item Attribute checked_out_user DO



Primaryobject classtype

Primaryobject

Relationtype

Related propertyor object

Propertyactiontype

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

For information about creating and using preferences, see the Rich Client InterfaceGuide.

For information about creating transfer option sets, see the PLM XML/TC XMLExport Import Administration Guide.

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

For information about creating these LOVs, see the Business Modeler IDE Guide.

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

Install Global Services Data ExchangeYou build Global Services Web applications using the Web Application Manager.

Note Paths shown use backslashes (\) as separators. On UNIX systems, replacebackslashes with forward slashes (/).

Supporting files locations

Several Global Services connectors require that you provide the location to files thatare provided by the connector’s back-end system or from some other source. Thelocation must be accessible to the Web Application Manager as you must enter thepath to the file in the Disk Locations for Install Images box. If you plan to includethe connector in your Web application, make sure the files identified for the connectorare available, and note the path to the file for use in Generate Web applications.



Note As an alternative to having the directories containing dependent connectorfiles accessible to the Web Application Manager, you can copy the dependentfiles to an accessible location. However, if you do not keep the files in thepaths indicated in the ICD file, you must edit the ICD file for the connectorto eliminate or correct the path. For example, the Teamcenter Enterpriseconnector ICD has the following dependent file entry:

[COPYFILE]{[FROM]enterprise/mti.jar[TO]lib/enterprise

}

If you copy the mti.jar file to a Web Application Manager accessible location,it must be in the enterprise directory under the location set in the DiskLocation to Add box. Alternatively, you can edit the ICD file to removeenterprise/ from the [FROM] section.

• Teamcenter Enterprise connector

This solution requires the MTI_ROOT\evista\java\classes directory location.This directory contains the mti.jar file and mtiems.jar files required forconnecting to Teamcenter Enterprise. The mtiems.jar file contains the importand export functionality that the connector supports for Teamcenter Enterprise.

The easiest approach is to copy the required JAR files (mti.jar and mtiems.jarto WEB_ROOT\application-directory-staging-directory\ webapp_root\lib\ enterprise directory and add this location to the disk locations for installimages in the Web Application Manager.

Generate Web applicationsNote Some solutions require other solutions, and some solutions are incompatible

with others. When you select a solution, the Web Application Managerautomatically selects prerequisite solutions and disables incompatiblesolutions. For example, Teamcenter – Server Adapter and Teamcenter 10.1Global Services Framework – Enterprise Application are incompatiblesolutions.

1. Launch the Web Application Manager (insweb.bat).

2. Copy Web tier solution ICDs:

a. Click Copy ICDs.

b. In the Copy ICD Files dialog box, click Browse.

c. Browse to the Web_tier directory in the Teamcenter software distributionimage, select the icd directory, and click Open.

d. In the Copy ICD Files dialog box, click OK to load ICD files.

3. Click Add to begin creating Global Services applications.

The Web Application Manager displays the Add Web Application dialog box.



4. Create the required undeployable solutions:

a. In the Name box, type a name for the application, for example, ApplicationDirectory.

b. Accept the default value for Staging Location or enter a different directory.

c. In the Disk Locations for Install Images box, add the path to the Web_tierdirectory on the Teamcenter software distribution image.

d. Click Advanced Web Application Options.

e. In the Advanced Web Application Options dialog box, clear theAutomatically Build Deployable File check box.

f. Click Solutions.

g. In the Select Solutions dialog box, clear all preselected solutions and selectthe Teamcenter 10.1 Global Services Framework – Application Directorysolution.

Note Do not change the default solution type (Thin Client) in the SolutionType box.

5. Click OK to begin installing the solution.

The Web Application Manager displays the installation status in the Progressdialog box. When the installation is complete, click OK to close the Progressdialog box.

6. Click Add to begin creating the Global Services enterprise application.

The Web Application Manager displays the Add Web Application dialog box.

7. Create the Global Services enterprise application:

a. In the Name box, type a name for the application, for example, GlobalServices Data Exchange.

b. Accept the default value for Staging Location or enter a different directory.

c. Click Advanced Web Application Options. Type tcgs in the DeployableFile Name box.

If you require the deployable file to be a distributable file, select theDistributable option.1

d. (Optional) Enter the application’s description in the Description box.

Note Do not change the default solution type (Thin Client) shown in theSolution Type box.

8. Select the solutions to include in the Global Services Web application:

1. A distributable file is required only if you deploy the Web tier application in a cluster configuration.



a. Click Solutions.

b. In the Select Solutions dialog box, clear all preselected solutions and selectthe Teamcenter 10.1 Global Services Framework - Data Exchange solution.

c. If you have an Teamcenter Enterprise site participating in your DataExchange operations, select the Teamcenter 10.1 Global ServicesFramework - Teamcenter Enterprise Connector solution.

9. If you selected a connector that requires supporting files (see Supporting fileslocations), click Modify Disk Locations and add the path to any supporting files.

10. Click OK.

The Web Application Manager displays the Modify Required ContextParameters dialog box.

11. Enter values for required context parameters.

For most context parameters, accept the default values shown. At a minimum,Global Services requires values for the following context parameters:

To set a context parameter, double-click the Value box for the given parameterand enter the new value. To view a description of any context parameter, clickthe parameter name in the Modify Required Context Parameters dialog box.

Note For a description of these parameters, see the Installation on WindowsServers Guide.

ApplicationInstanceSSOAppIDLogFileLocationTcGSBOSJNDI

TcGSJDBCJNDITcGSMessageServerJNDITcGSNotifierReactorJNDITcGSDORJNDI

To set a context parameter, double-click the Value box for the given parameterand enter the new value. To view a description of any context parameter, clickthe parameter name in the Modify Required Context Parameters dialog box.

For more information about Global Services context parameters, see theInstallation on Windows Servers Guide.

12. Click OK to begin building the Web application.

The Web Application Manager displays the installation status in the Progressdialog box. When the installation is complete, click OK to close the Progressdialog box.

13. Repeat this procedure to create a Teamcenter 10.1 Global Services Framework -Ode BPEL enterprise application starting at step 7.

Type tcgs-ode in the Deployable File Name box.

In the Modify Context Parameters dialog box, the TCGS_WS_URLand TCGS_ODE_URL values must match the values of theglobalservices.webservices.url and globalservices.ode.url propertiesrespectively, in the globalservices.properties file.



Property Value

globalservices.webservices.url

Specifies the URL of the Global Services Webservices WAR file within the Global ServicesOde BPEL enterprise application, for example:

globalservices.webservices.url =http://localhost:8080/tcgs-ws

This is used by services that must send HTTPSOAP requests to other web services.

globalservices.ode.url Specifies the URL to the Global Services OdeBPEL enterprise application, for example:

globalservices.ode.url =http://localhost:8080/tcgs-ode

This is used by services that must send HTTPSOAP requests to BPEL processes.

For more information about the configuring the application server for ODE, seethe Web Application Deployment Guide.

14. Click Exit to exit the Web Application Manager.

15. Locate the deployable files (by the names you specified in step 7) generatedduring installation. This file is in the deployment directory under the specifiedstaging location.

For information about deploying the Web application, see Global Services Webapplication deployment.

Global Services Web application deploymentGlobal Services stores product configuration, connection configuration, SSO security,and business object files in the datastore. The database tables that Global Servicesuses for the datastore are created during the Teamcenter server installation process.The datastore must be accessible to Global Services through a JDBC connection usingJNDI. This connection is set up in your application server and the steps required arespecific to the application server. In most cases, the setup requires creating a datasource and a connection pool. For specific information about creating a connectionpool and datastore, see your application server and database documentation.

Creating the Global Services tables

Global Services stores product configuration, connection configuration, SSO security,and business object files in a data store. This data store must be accessible toGlobal Services through a JDBC connection using JNDI. This connection is set upin your application server and the steps required are specific to the applicationserver. In most cases, the setup requires creating a data source and a connectionpool. For specific information about creating a connection pool and data store, seeyour application server and database documentation.



You can use Teamcenter Environment Manager (TEM) to create the Global Servicestables in Teamcenter during the server installation process. If you are not usinga Teamcenter database as your data store, you can create or upgrade the GlobalServices required tables in your database using the scripts supplied in the databasespecific directory of the Teamcenter 10.1 Global Services – Application Directorysolution staging location. These directories are located under:

webapp_root

database

Caution The Global Services tables are referenced by third-party software thatrequires case-insensitive collation types. Therefore, if your databaseserver’s default collation is case insensitive, you must alter your GlobalServices database to case-insensitive (CI) collation after you create it.For information about configuring a database for CI collation, see thecomments in the database sql files.

Caution A datastore created by a Global Services instance deployed on a givenserver must not be accessed by Global Services instances deployedon a server that runs a different operating system. This is especiallyimportant if there are text files in the datastore containing charactersother than US ASCII characters.

Record the database name and type; you must have this information during thedeployment procedure.

Teamcenter provides the following Global Services database scripts:

Note The script files contain comments that provide additional information abouttheir purpose and use.

Create scripts

File name Purpose

oracle_create_tcgs.sqlsqlserver_create_tcgs.sqldb2_create_tcgs.sqlhsqldb_create_tcgs.sql

Creates the Global Services tables in theindicated database that has not previouslycontained Global Services table data.

oracle_drop_tcgs.sqlsqlserver_drop_tcgs.sqlhsqldb_drop_tcgs.sql

Drops the Global Services tables from theindicated database that has previouslycontained Global Services table data so thecreate script can be used to create an emptydata store. This allows the Global Servicesapplication to install the initial content thenext time the application is accessed.

Upgrade scripts

File name Purpose

oracle_upgrade_tcgs_v20070.sqlsqlserver_upgrade_tcgs_v20070.sql

Upgrade from Teamcenter 2007 to thecurrent release



File name Purpose


Upgrade from Teamcenter 2007.1 to thecurrent release

oracle_upgrade_tcgs_v200711.sql Upgrade from Teamcenter 2007.1.1 tothe current release











Upgrade from Teamcenter 8 to thecurrent release





db2_upgrade_tcgs_v80003.sqlsqlserver_upgrade_tcgs_v80003.sqloracle_upgrade_tcgs_v80003.sql


db2_upgrade_tcgs_v8000301.sqlsqlserver_upgrade_tcgs_v8000301.sql

Upgrade from Teamcenter 8.3.0.1 to thecurrent release

Configuring application servers for Global Services

Several tasks must be performed to configure the application server forGlobal Services. Some of these tasks may require using the application serveradministration tool. See your application server documentation for more specificinformation about how to perform these tasks.

Global Services supports the IPv6 protocol. However, if want to install GlobalServices in an environment that the supports IPv6 protocol, the application servermust be installed on a dual-stack server.

For information about supporting IPv6 and dual stack networks on you applicationserver host, see your Windows, UNIX, or Linux server documentation.


http://www.cisco.com/web/strategy/docs/gov/IPV6at_a_glance_c45-625859.pdf

http://technet.microsoft.com/en-us/library/cc737586(v=ws.10)


Perform the setup as described in the following topic for your application server:

• Deploy on Websphere 8

• Deploy on WebLogic 12.1.1.0

• Deploy on JBoss 7.1

Data Exchange requires configuration files that are updated by the Web ApplicationManager. The data store is populated with these files the first time you access theGlobal Services Web tier application using the following URL format:

http://appserver-host:port-number/tcgs/controller/index

Replace appserver-host and port-number with the host name and port number theapplication server uses.

Deploy the Global Services application

The following provides information for deploying the Global Services EAR file. If youare familiar with deploying applications on your application server, this informationmay be sufficient to allow you to perform the installation. For more detailedinstructions, see the appropriate application server topic.

Note Global Services no longer supplies solutions (Gateway for OracleManufacturing and Gateway for SAP) or Oracle Manufacturing or SAPconnectors. These are replaced by third-party integration products. Theseproducts are available from GTAC in the Integrations section of Full ProductReleases file downloads. The documentation for installing, administering,or configuring these integrations is included in the same location. You musthave a valid WebKey user name and password to access the integrationproducts.

1. Start the application server administration tool if your application server hasone.

Note If you are configuring Oracle application server 10g v10.1.2, type–Xmx256 and dedicated connection=true in Java Options in yourOC4J instance’s Server Properties page.

2. Create a connection pool and a data source that uses it. Choose an appropriatedriver for your database. The following table provides suggested driver values.

Note It is recommended that you set the maximum connection pool size to1000 to ensure enough connections are available for processing.

JDBC database Driver class Driver type Default port

DB2 COM.ibm.db2.jdbc.app.DB2Driver IBM Type 2 DB2 Driver 5000

MySQL org.gjt.mm.mysql.Driver MySQL Type 4 Driver 3306

Oracle oracle.jdbc.pool.OracleDriver Oracle Thin Driver 1521

SQL server com.microsoft.sqlserver.jdbc.SQLServerXADataSource

Other 1433

Provide user name and password values to connect to the database for adatabase user with read and write access.



The ApplicationInstance context parameter determines the JNDI name forthe data store. This parameter value is defined when you build the GlobalServices Web tier application and is used at the beginning of the JNDI name.The JNDI name is GlobalServicesInstance1/jdbc/GlobalServicesDB if youaccept the default value for the context parameter.

Provide the URL the JDBC connection uses to connect to the database, forexample:

Oracle database:

jdbc:orcle:thin:@host-name:port-number:Oracle-SID

3. Create the following queues if you have included the Teamcenter 10.1 GlobalServices - JMS Messaging solution in your Web application:

jms.actionDestination=javax/jms/action

jms.responseDestination=javax/jms/response

4. Deploy the enterprise application you generated as described in thedocumentation for your application server.

Caution If you are deploying on a WebSphere application server, do not selectthe Precompile JSP option. This causes the deployment to fail.

Deploy on Websphere 8

Note Do not enable application server security on the application server whereyou deploy the Global Services Web application

1. Before you deploy the Global Services application (EAR) file, complete thefollowing:

a. Download the binary archive file from the Apache Tomcat site at thefollowing link:

http://tomcat.apache.org/download-70.cgi

b. Use an archive management tool, such as 7-Zip file manager, to extract theservlet-api.jar file in the lib directory of the Tomcat archive file into adirectory accessible to the application server. Note the path to the file forlater use.

c. Open the Global Services Web application EAR file in 7-Zip file manager anddelete the EAR/lib/asix2-jaxws-1.4.jar file.

2. Start the WebSphere integrated solutions console and expand Servers→ServerTypes in the navigation tree pane and click WebSphere application servers.

3. In the Application servers section, click the server name (server1 by default).

4. In the Application servers pane, expand Java and Process Management underServer Infrastructure and click Process definition.

5. Click Java Virtual Machine under Additional Properties.


http://tomcat.apache.org/download-70.cgi


6. Type the following parameters in the Generic JVM arguments box:-Dorg.apache.ode.rootDir = full-path-to-Ode-working-directory-Dcom.ibm.websphere.webservices.DisableIBMJAXWSEngine=true

7. Type the full path and filename for each of the following files, delimited bysemicolons, into the Classpath box.

Note The path to the servlet-api.jar file was noted in a previous step. Thismust be the last entry in the Classpath property. The other files arelocated in the WEB_ROOT/staging-directory/earapp_root/lib directory.

commons-io-1.4.jarcommons-fileupload-1.2.jarwoden-api-1.0M8.jarcommons-codec-1.3.jarcommons-httpclient-3.1.jarcommons-logging-1.1.1.jarlog4j-1.2.15.jarservlet-api.jar

8. Click OK, Save , and restart the application server.

9. Deploy the ODE Web applications as described in Configure the applicationserver for ODE.

10. Configure the deployed ODE Web application:

a. Click the deployed ODE Web application and click Manage Modules underthe Modules section in the Enterprise Applications pane.

b. Click Apache-Axis2 in the Module column.

c. Choose Classes loaded with local class loader first (parent last) fromthe Class loader order list.

11. Configure the axis2 properties in Global Services.

a. Set the axis2.max.connections property value in theglobalservices.properties file to a positive numeric valueapproximately three times the expected number of concurrent connections toODE from Global Services.

Tip You can start with a low two-digit number if you do not expecta large number of transfer requests. If you experience time-outexceptions, increase the value.

You can set properties by manually editing in theglobalservices.properties file in the Global Services datastore orusing the Global Services Web Manager interface.

For information about managing the Global Services datastore, see theGlobal Services Configuration Guide.

b. (Optional) Set the ode-axis2.db.pool.max property in theglobalservices.properties file. This property is associated with theaxis2.max.connections property and is set to 20 by default. If you expect



a large number of concurrent connections to ODE or experience time-outexceptions, increase the value.

c. Restart the application server.

Deploy on WebLogic 12.1.1.0

1. Start the WebLogic server administration console.

For online help for the WebLogic server administration console, see the WebLogicserver documentation.

2. In the left pane of the console, click Deployments.

3. In the right pane, click Install.

4. Navigate to the location of the Global Services EAR and click Next.

5. Continue to click Next until you reach the pane that asks if you want toimmediately update the application configuration.

6. Select No and click Finish.

In the Deployments page, WebLogic displays the Global Services enterpriseapplication.

7. In the Domain Structure tree, expand Services and Domain, then select DataSources.

8. In the Summary of Data Sources pane, click New.

9. Enter the following for the data source properties and click Next:

Name Type a name that identifies the data source.This name is used in the configuration file(config.xml) to identify this data source in theadministration console.

JNDI Name Type the JNDI name defined by theApplicationInstance context parameter whenyou built the Web tier application. The JNDIname is GlobalServicesInstance1/jdbc/GlobalServicesDB if you accept the defaultvalue for the context parameter.

Database Type Select the Teamcenter database.

Database Driver Select the driver that corresponds to the typeof database you are using for your data store.See the table in Deploy the Global Servicesapplication for a list of suggested drivers.

10. Ensure Supports Global Transactions is selected, select One-Phase Commit,and click Next.

11. Enter the following for the connection pool properties and click Next:


http://docs.oracle.com/cd/E23943_01/wls.htm

http://docs.oracle.com/cd/E23943_01/wls.htm


Database Name Type the SID of the Teamcenter database definedduring the Teamcenter server installationprocess.

Host Name Type the DNS name or IP address of the serverthat hosts the database.

Port Type the port number on which the databaseserver listens for connection requests.

Database User Name Type the database user account name that youwant to use for each connection in the data source.

Properties If you are using a MySQL database, type theautoReconnect property with the value set totrue, for example:

autoReconnect=true

Password and ConfirmPassword

Type the password for the database user account.

Note It is recommended that you set the maximum connection pool size to1000 to ensure enough connections are available for processing.

12. Review the connection parameters and click Test Configuration. If there areany configuration errors, go back and correct them. If the test is successful,click Next.

13. Select the servers or clusters on which you want to deploy the data source andclick Finish.

Note Not all changes take effect immediately. For information, see the WebLogicdocumentation.

Deploy on JBoss 7.1

1. Add an administrative user in the management realm:

a. Open a command shell and ensure that the JAVA_HOME andJBOSS_HOME environment variables are set.

b. Change to the bin directory of JBOSS_HOME and type the followingcommand:

add-user

The JBoss add-user utility displays prompts for the type of user, realm, username, and password. The utility displays default values for user type andrealm in parentheses. Press Enter to accept the default values for user typeand realm (Management User and ManagementRealm).

What type of user do you wish to add?a) Management User (mgmt-users.properties)b) Application User (application-users.properties)(a):

Note the user name and password values you enter.

2. Open the standalone.xml file in the following location:



JBOSS_HOMEstandalone

configuration

Locate the following entry:<subsystem xmlns="urn:jboss:domain:ee:1.0"/>

Replace this entry with:<subsystem xmlns="urn:jboss:domain:ee:1.0">

<global-modules><module name="org.jboss.as.jmx" slot="main"/>

</global-modules></subsystem>

Locate the following entry:<subsystem xmlns="urn:jboss:domain:naming:1.1"/>

Replace this entry with:<subsystem xmlns="urn:jboss:domain:naming:1.1">

<bindings><lookup name="TcGSBOSBox"

lookup="java:global/tcgs/coreEJBs/BOSBoxBean!com.teamcenter._globalservices.bos.BOSBoxHome"/>

<lookup name="ejb/JETI/Gateway"lookup="java:global/tc/JETIGateway-ejb/Gateway!com.teamcenter.

jeti.ejb.GatewayHome"/><lookup name="TcGSTeamcenterSOABox"

lookup="java:global/tcgs/teamcenterSOAConnectorEJBs/TeamcenterSoaBoxBean!com.teamcenter.globalservices.connection.ConnectionBoxHome"/>

<lookup name="TcGSJDBCBox"lookup="java:global/tcgs/coreEJBs/JDBCBoxBean!com.teamcenter.

globalservices.connection.ConnectionBoxHome"/><lookup name="TcGSDORepositoryBox"

lookup="java:global/tcgs/coreEJBs/DataObjectRepositoryBoxBean!com.teamcenter.globalservices.connection.ConnectionBoxHome"/>

<lookup name="TcGSNotifierReactor"lookup="java:global/tcgs/coreEJBs/NotifierReactorBean!com.

teamcenter._globalservices.reactor.notifier.NotifierReactorHome"/><lookup name="TcGSEntBox"

lookup="java:global/tcgs/tcentEJBs/TcEntBoxBean!com.teamcenter.globalservices.connection.ConnectionBoxHome"/>

</bindings></subsystem>

For development and testing purposes, you can make the JBoss managementconsole accessible to remote hosts by editing the inet-address element:

<interface name="management"><inet-address value="${jboss.bind.address.management:0.0.0.0}"/>

</interface>

Warning Allowing remote access to the JBoss management console is asecurity risk. Use this configuration only during development andtesting.

3. If you are deploying the Teamcenter 10.1 Global Services Framework - OdeBPEL Enterprise Application solution for any reason:

a. Using an archive file management tool, such as 7-Zip File Manager, expandthe ODE archive (tcgs-ode.EAR in the following example) file and removethe Persistence.xml file from the META–INF locations:

tcgs-ode.EARtcgs-ode.WAR



WEB-INFlib

ode-dao-jpa-1.3.5.jarMETA-INF

ode-bpel-store-1.3.5.jarMETA-INF

b. Open the standalone startup batch file or shell script in the followinglocation:

JBOSS_HOMEbin

standalone

Add the following entry prior to the JBoss bootstrap environment section:

set JAVA_OPTS=”-Dorg.apache.ode.rootDir=full path toode-working-dir” %JAVA_OPTS%

echo =============================================================echo.echo JBoss Bootstrap Environment

4. Define the JDBC data source:

a. Create a directory structure that contains a main directory as itsmost subordinate child directory under the modules directory of theJBOSS_HOME location, for example:

JBOSS_HOMEmodules

foomyjdbcdriver

main

You can use any valid directory name for the foo and myjdbcdriverdirectories.

b. Copy the database drive file or files to the main directory.

c. Create a module.xml file in the main directory that contains the following:

<module xmlns="urn:jboss:module:1.0" name="directory-structure"><resources>

<resource-root path="driver-file-name"/></resources><dependencies>

<module name="javax.api"/></dependencies>

</module>

For the name attribute (directory-structure) value, type the directorystructure you created without the main directory. Use periods for the pathseparator, for example:



<module xmlns="urn:jboss:module:1.0" name="foo.myjdbcdriver">

For the path attribute (driver-file-name) value, type the database driver filename. For example, for an Oracle database:

<resource-root path="ojdbc6.jar"/>

d. Open the standalone.xml file that you edited in step 2, locate the driverselement, and add a driver element as child to the element:

<subsystem xmlns="urn:jboss:domain:datasources:1.0"><datasources><drivers>...<driver name="driver-name" module="directory-structure">

<datasource-class>driver-class-name</datasource-class></driver>

</drivers>

Type any unique value for the name (driver-name) attribute value and forthe module (directory-structure) attribute value, type the same value youused for the name attribute in module.xml file. Type the driver class namein the data-source-class element, for example:

oracle.jdbc.driver.OracleDriver

e. Locate the datasource element, and add a datasource element as childto the element:

<subsystem xmlns="urn:jboss:domain:datasources:1.0"><datasources>...

<datasource jndi-name="java:/data-source-JNDI-name"pool-name="GMS_DS" enabled="true"use-java-context="false">

<connection-url>driver-URL</connection-url><driver>driver-name</driver>

<security><user-name>datasource-username</user-name><password>datasource-password</password>

</security></datasource></datasources>

Type the data source JNDI name for the jndi-name (data-source-JNDI-name)attribute value. This value must have a java:/ prefix.

Type the URL of the JDBC connection for the database for theconnection-url (driver-URL) element value. For example, for an Oracledatabase connection:

jdbc:orcle:thin:@host-name:port-number:Oracle-SID

Type the driver class name in the data-source-class element, for example:oracle.jdbc.driver.OracleDriver

Type the user name used to connect to the database in the user-nameelement and the password associated with that user in the passwordelement.

5. Deploy the EAR file:



a. Open the JBoss console in a browser on the host where JBoss is running:

http://localhost:9990/console

b. Log on, click Runtime in the top right corner, and click Manage Deploymentsin the left pane.

Note You may have to click Deployments in the left pane to exposeManage Deployments.

c. Click Add Content in the Deployments pane and click Browse in the Uploaddialog box.

d. Navigate to the location of the Global Services Web application EAR file(tcgs.ear by default) and click Open.

e. After JBoss finishes deploying the application, click the application’s Enablebutton in the Deployments pane.

You must start the JBoss application server instance with the bind option to enableconnections from clients running on a host different from the application serverhost. The simplest way to do this is to start the server with the -b myhost option.Substitute the host name or IP address of the local host for myhost, for example:

standalone -b 0.0.0.0

However, this has some security implications.

For information about JBoss security, see the JBoss documentation:

http://community.jboss.org/wiki/SecureJBoss

Configuring Data Exchange orchestration

Global Services uses the standard Apache Orchestration Director Engine (ODE) forbusiness processing execution language (BPEL) functionality. The ODE is set up bydefault to use the built in Derby database for its event tracking. You must performthe following tasks to set up ODE for Data Exchange and to use the TeamcenterOracle database for BPEL event tracking.

Configure the application server for ODE

When the Teamcenter 10.1 Global Services Framework - Ode BPEL enterpriseapplication solution is required, you must perform the following steps:

Note Create the Teamcenter 10.1 Global Services Framework - Ode BPELenterprise application solution before performing these steps and performthese steps prior to deploying your Web application. When you createthe Web application, you must enter values for the TCGS_WS_URLand TCGS_ODE_URL context parameters. These values mustmatch the values you supply for the globalservices.webservices.urland globalservices.ode.url properties respectively, in theglobalservices.properties file.

It is recommended that you set the maximum connection pool size to 1000 toensure enough connections are available for processing.



1. Create an ODE working directory that is accessible to the application server. Forexample, on a UNIX system, create the /mnt/disk1/ode-working-dir directory.

2. Copy the contents of the ode-working-dir directory located in theWEB_ROOT\staging-directory\earapp_root directory.

3. Deploy the Web application as described in the topic for your application server.

4. Modify the application server Java start options for your application server:

• For WebSphere application servers:

a. Log on to the WebSphere Integrated Solutions Console and expandServers in the left pane.

b. Select Application servers and select the server where you deployed theGlobal Services Web application.

c. Click the Configuration tab, and in the Server Infrastructure section,expand Java and Process Management and select Process Definition.

d. In the Additional Properties section, select Java Virtual Machine.

e. Locate the Generic JVM arguments box and add the following argumentat the end of its contents:

-Dorg.apache.ode.rootDir=complete-path-to-ode-working-dir-Dcom.ibm.websphere.webservices.DisableIBMJAXWSEngine=true

complete-path-to-ode-working-dir represents the path to the directoryyou created in step 1.

Note You may also define this property in your application server’suser-defined properties.

f. Download the globalservices.properties file from the Global Servicesdata store, update the properties as follows, and upload the file to thedata store:

Note The globalservices.context.root property defined in previousreleases of Global Services is no longer supported.

Property Value

globalservices.webservices.url

Specifies the URL of the GlobalServices Web services WAR filewithin the Global Services Ode BPELenterprise application, for example:

globalservices.webservices.url =http://localhost:8080/tcgs-ws

This is used by services that mustsend HTTP SOAP requests to otherweb services.



Property Value

globalservices.ode.url Specifies the URL to the GlobalServices Ode BPEL enterpriseapplication, for example:

globalservices.ode.url =http://localhost:8080/tcgs-ode

This is used by services that mustsend HTTP SOAP requests to BPELprocesses.

For information about managing the Global Services data store, see theGlobal Services Configuration Guide.

• For WebLogic application servers:

a. Use an archive management tool, such as 7-Zip File Manager, to copy thexercesImpl-2.9.0.jar file from the Global Services Web application EARfile (tcgs.ear by default) to the ODE.WAR/WEB-IND/Lib location inthe ODE Web application EAR file (ode.ear by default).

b. Add the following JVM argument to the application server startupcommand.

-Dorg.apache.ode.rootDir=complete-path-to-ode-working-dir

complete-path-to-ode-working-dir represents the path to the directoryyou created in step 1.

c. Redeploy the ODE Web application.

Configure ODE to use an Oracle database

The Apache Orchestration Director Engine (ODE) uses the built-in Apache Derbydatabase by default for its event tracking. When you install the Global ServicesFramework feature on your Teamcenter server, you also get Oracle tables requiredfor ODE event tracking. The following steps are required to change ODE to usethe Oracle tables:

Caution If you use the Apache Derby database, you may encounter concurrencyproblems.

1. Check the default settings in the ode-axis2.properties file. For most setups, nochanges are required. The comments in the file provide information about thesettings. Change settings as required.

## Licensed to the Apache Software Foundation (ASF) under one or more# contributor license agreements. See the NOTICE file distributed with# this work for additional information regarding copyright ownership.# The ASF licenses this file to You under the Apache License, Version 2.0# (the "License"); you may not use this file except in compliance with# the License. You may obtain a copy of the License at## http://www.apache.org/licenses/LICENSE-2.0## Unless required by applicable law or agreed to in writing, software# distributed under the License is distributed on an "AS IS" BASIS,# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.# See the License for the specific language governing permissions and



# limitations under the License.#

## ODE-AXIS2 Configuraiton Properties## http://ode.apache.org/index.html

### ode-axis2.db.mode## Database Mode ("INTERNAL", "EXTERNAL", "EMBEDDED")## What kind of database should ODE use?## * "EXTERNAL" - ODE will use an app-server provided database and pool.## The "ode-axis2.db.ext.dataSource" property will need to## be set.## Ode also supports:## * "EMBEDDED" - ODE will create its own embbeded database (Derby)## and connection pool (Minerva).## * "INTERNAL" - ODE will create its own connection pool for a user-## specified JDBC URL and driver.##### ode-axis2.db.ext.dataSource## External Database [JNDI Name]## JNDI Name of the DataSource for the ODE database. This is only## used if the "ode-axis2.db.mode" property is set to "EXTERNAL"##### ode-axis2.dao.factory## DAO Connection Factory class.## This property is used to enable Hibernate as the JPA implementation.

## Hibernate Configuraiton Properties## See http://www.hibernate.org/docs.html

###hibernate.dialect## The classname of a Hibernate org.hibernate.dialect.Dialect## which allows Hibernate to generate SQL optimized for a particular## relational database. If you leave this setting blank, Hibernate## will actually attempt to choose the correct org.hibernate.dialect.Dialect## implementation based on the JDBC metadata returned by the JDBC driver.## Example settings:## RDBMS Dialect## DB2 org.hibernate.dialect.DB2Dialect## Oracle (any version) org.hibernate.dialect.OracleDialect## Oracle 9i org.hibernate.dialect.Oracle9iDialect## Oracle 10g org.hibernate.dialect.Oracle10gDialect## Microsoft SQL Server org.hibernate.dialect.SQLServerDialect#####hibernate.hbm2ddl.auto## Automatically validates or exports schema DDL to the database when the## SessionFactory is created. With create-drop, the database schema will## be dropped when the SessionFactory is closed explicitly.#####hibernate.current_session_context_class## Supply a custom strategy for the scoping of the "current" Session.## See Section 2.5 of Hibernate manual, “Contextual sessions” for more## information about the built-in strategies.## e.g. jta | thread | managed | custom.Class#####hibernate.transaction.manager_lookup_class## e.g. classname.of.TransactionManagerLookup## The classname of a TransactionManagerLookup. Examples:## org.hibernate.transaction.JBossTransactionManagerLookup JBoss## org.hibernate.transaction.WeblogicTransactionManagerLookup Weblogic## org.hibernate.transaction.WebSphereTransactionManagerLookup WebSphere## org.hibernate.transaction.WebSphereExtendedJTATransactionLookup WebSphere 6

## Default settingsode-axis2.db.mode=EXTERNALode-axis2.db.ext.dataSource=GlobalServicesInstance1/jdbc/GlobalServicesDBode-axis2.dao.factory=org.apache.ode.daohib.bpel.BpelDAOConnectionFactoryImpl

#hibernate.hbm2ddl.auto=updatehibernate.current_session_context_class=jta#hibernate.transaction.manager_lookup_class=#hibernate.dialect=

2. For WebSphere application servers, copy the wsdl4j-1.6.2.jar file fromthe WEB_ROOT/staging-directory/earapp_root/lib directory to theWAS_HOME/AppServer/java/jre/lib/ext directory

WAS_HOME is the WebSphere installation directory.

Configuring Global Services for HTTPS

You can configure one-way secure socket layer (SSL) communication for yourTeamcenter Global Services transfers. The configuration required includes:



• Configuring the application server

• Configuring File Management System (FMS) to use SSL

• Installing the Global Services signer certificate to the Teamcenter rich client

• Installing the Global Services signer certificate to the Teamcenter thin client

• Modifying the Teamcenter Enterprise configuration variables for SSL

• Modifying the Teamcenter preferences for SSL

Configure the application server for SSL

You must configure the application server where you have the Global Services Webapplication deployed for SSL. Any other application server that contains TeamcenterWeb products that are communicating with Global Services must also be configuredfor SSL. In general, you perform the following configuration in the application server:

• Create a key store

The key store is normally Java key store (JKS) type. You must have the pathto, and file name of, the key store file.

• Import/identify the certificate authority file to the application server

The application server must have access to certificate authority (CA) file youwill use for your SSL communications.

• Configure SSL listening port

You must set the SSL port number for your application server default value.

Note For WebSphere application servers, you must enable the States FederalInformation Standard (FIPS) algorithms. The Use the United States FederalInformation Standard (FIPS) algorithms option is located under Security |SSL certificate and key Management section in the WebSphere integratedsolutions console.

Instructions for enabling secure socket layer (SSL) on an application server areprovided in the application server documentation.

See Deploy the Global Services application for additional information aboutapplication server SSL configuration.

Configuring File Management System for SSL

You must configure File Management System (FMS) to use a purchased vendorcertificate authority that is supported by standard distributions of the Java runtimeenvironment. The following variables are used in these procedures:

key store-file Represents the key store file name. This file is conforms tothe Java-based storage standard with public and private keysthat are stored in an encrypted key store. Individual keysand certificates within this cryptographic storage can haveindividual password protection.

key store-password Represents the password required to manage the key store.



FSC-myhost Represents an alias name for the certificate. The certificate isbound to the host so use a name that indicates the FSC host.This is a similar naming convention to the FSC configurationfile name (FSC_host-name_user-name).

FSC-myhost-password

Represents the certificate alias password. This password isrequired to retrieve the certificate.

FSC-myhost .csr Represents the certificate signing request (CSR) file name.This file requires a .csr extension. This file contains thecertificate signing request information that you send to thesigning authority.

FSC-myhost .cer Represents the certificate file name. This is the file returnedby the signing authority and should have a .cer file extension.

Generate a key store and private key

1. From a command prompt, go to the FSC_HOME directory.

2. Type the following command and prompt replies to create a key store:

keytool -genkey -key store key store-file -keyalg RSA -alias FSC-myhostEnter key store password: key store-passwordWhat is your first and last name?[Unknown]: myhost.mydomain.com

What is the name of your organizational unit?[Unknown]: mycompany

What is the name of your organization?[Unknown]: mycompany

What is the name of your City or Locality?[Unknown]: mycity

What is the name of your State or Province?[Unknown]: mystate

What is the two-letter country code for this unit?[Unknown]: my

Is CN=myhost.mydomain.com, OU=mycompany, O=mycompany, L=mycity, ST=mystate,C=my correct?[no]: yes

Enter key password for <FSC-myhost>(RETURN if same as key store password): FSC-myhost-password

3. Verify the key entry by typing the following command and prompt replies:keytool -list -key store key store-fileEnter key store password: key store-password

key store type: jkskey store provider: SUN

The command output should be similar to:

Your key store contains 1 entry

fsc-myhost, Nov 8, 2007, keyEntry,Certificate fingerprint (MD5): 59:B6:2D:38:24:16:45:1B:47:2A:E9:06:55:80:B3:C6

4. Back up the key store file to a secure location. The private key is stored in thisfile and is unrecoverable if the file or passwords are lost.



Obtain a signed certificate

You must create a certificate signing request (CSR) and submit it to a certificateauthority (CA) to receive the signed certificate. The process of submitting the CSRand receiving the signed certificate from the CA varies by signing authority.

1. Generate a CSR from the private key by typing the following command andprompt replies in your FSC_HOME directory:

keytool -certreq -key store key store-file -alias FSC-myhost -fileFSC-myhost.csrEnter key store password: key store-passwordEnter key password for <FSC-myhost> FSC-myhost-password

2. Open the fsc-myhost.csr file and verify the contents are similar to the following:-----BEGIN NEW CERTIFICATE REQUEST-----MIIBtjCCAR8CAQAwdjELMAkGA1UEBhMCbXkxEDAOBgNVBAgTB215c3RhdGUxDzANBgNVBAcTBm15Y2l0eTESMBAGA1UEChMJbXljb21wYW55MRIwEAYDVQQLEwlteWNvbXBhbnkxHDAaBgNVBAmTE215aG9zdC5teWRvbWFpbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAJ0h3iF8KBEN2UKwhw1dw+RlxGwcsptLA3EI+6rAKa32dg/4FY89zBcUG02413X0BxQWcsRznYWFDJHLK4En7I2xeJNsORwJfBeF9yW6d4lzaWA6LATFr5T3DHafF6mSRNPl+739mpGuQr44AXBQWqZoOMhecc+n/ErekMlZdgWTAgMBAAGgADANBgkqhkiG9w0BAQQFAAOBgQCQJTqujL7GIXz0is0fUoAxtCydMiX1BeVHU+l/IqcTh4BX8V3vJmm+kHwwKn3yeih+WJzYmDdNh/uaKxO7txyFdPPDd1bdIosFc4XIZwys0jFKwGqfMUjB9wgaKgHSRQTtCOPBEO/ClLjm8ocFNQBWysYVevAZQAmEMp90BxBt/Q==-----END NEW CERTIFICATE REQUEST-----

3. Submit the CSR file to the certificate signing authority and receive the signedcertificate using the process defined by the signing authority.

4. Import the signed certificate into the FSC server by typing the followingcommand and prompt replies in your FSC_HOME directory:

keytool -import -trustcacerts -key store keystore—file -file FSC-myhost.cer -alias FSC-myhostEnter key store password: key store-passwordEnter key password for <FSC-myhost> FSC-myhost-password

Update the FSC and FMS configuration

1. Configure the FSC key store by specifying the following properties in thefsc.$FSCID.properties file in your FSC_HOME directory:

com.teamcenter.fms.servercache.key store.file=key store-filecom.teamcenter.fms.servercache.key store.password=key store-passwordcom.teamcenter.fms.servercache.keystore.ssl.certificate.password=FSC-myhost-password

2. Configure the FMS master file for SSL through the following as required:

• Update the existing HTTP connection

• Add an additional connection

• Assign clients to particular connections

3. Modify any of the following bootstrap configuration values to use the new scheme(or port) as required:

• Any <fscmaster address=" “/> values in fsc.xml files

• Any <parenfscr address=" “/> values in fcc.xml files

• The Fms_BootStrap_Urls preference



For an example one-way SSL FSC and FMS configuration, see Configuring GlobalServices for HTTPS.

Configure Global Services application as a trusted client

This process depends on the application server you are using for your Global ServicesWeb application. Similar process to the ones provided for WebSphere and WebLogicis required for the other supported application servers.

For WebSphere:1. Log on to the Integrated Solutions Console and navigate to the Key stores and

certificates section (Security→SSL certificate and key management→Keystores and certificates).

2. Select the key stores that you create for the Global Services Web applicationcertificate and for the File Management System (FMS) certificate and clickExchange Signers.

3. Select the FMS key store and add it as a signer for the Global Services Webapplication.

For WebLogic:1. Open a command shell and navigate to the Java Runtime Environment (JRE) for

your WebLogic domain where you Global Services Web application is deployed.

2. Import the FMS certificate to the Java cacerts key store using the Java keytool-import utility.

Install the Global Services signer certificate to Teamcenter rich client

1. Open a command shell and navigate to:

TC_ROOTportaljrelibsecurity

2. Import the certificate using the Java keytool -import utility, for example:keytool -import –alias myprivateroot –keystore ..\lib\security\cacerts–file c:\root.cer

3. Use the keytool utility to verify the security certificate was added to the portalkey store, for example:

keytool –list –keystore ..\lib\security\cacerts

The rich client is configured as a trusted client. Try a transfer between sitesusing the rich client to verify the configuration.

Install the Global Services signer certificate to Teamcenter thin client

You must import the certificate for the Global Services Web application into theinternet browsers that you use to access your Teamcenter thin client. This processvaries by browser and operating system. The following procedures are for the



currently supported Firefox and Internet Explorer versions on Windows but can beused as a guide for other browsers and operating systems.

For Firefox:1. Choose Tools→Options and click Advanced.

2. Click View Certificates and click the Your Certificates tab.

3. Click Import and navigate to the certificate file and click Open. Type thecertificate’s pass phase when prompted and click OK.

For Internet Explorer:1. Choose Tools→Internet Options and click the Content tab.

2. Click Certificates and click the Personal tab.

3. Click Import and follow the wizard instructions to install the certificate. Selectthe High Security option to prevent Internet Explorer from saving your passphrase.

Configure the Teamcenter Enterprise Global Services end point variable

1. In the Teamcenter Enterprise Administration Editor choose GMS Configuration.

2. In the GMS Configuration pane, type the https URL for the Global Servicesapplication as the value for Teamcenter Global Services URL and click Finish.

Alternatively, you can edit the GS_END_POINT value in the config.cfg file.

Note Secure Socket Layer (SSL) communication with Global Services is notsupported in Teamcenter Enterprise 2005SR1 release.

Modify Teamcenter preferences for SSLNote It is recommended that you configure Global Services for HTTP

communications and verify it is functional before switching to SSL.

1. In the Organization application, select the node of the remote site definitionfrom the Organization List tree.

2. Modify the value in the TcGS URL box to the HTTPS URL for the GlobalServices Web application and click Modify.

3. Select the node of the local site definition from the Organization List tree.

4. Modify the value in the TcGS URL box to the HTTPS URL for the GlobalServices Web application and click Modify.

5. Choose Edit→Options and click Search in the Options dialog box.

6. Search for TC_gms and modify the values for the following preferences asindicated:



Preference Value

TC_gms_server HTTPS URL of your Global Services Webapplication.

TC_gms_server_ca_file File name of the trusted CA certificates inPEM format.

Note You can omit setting the value for theTC_gms_server_ca_path preferenceif you include the full path the file inthis preference.

TC_gms_server_ca_path Path to the trusted CA certificates file.

TC_gms_sso_enabled FALSE

Note SSO does not support HTTPScommunications.

7. Locate the Web_protocol preference and change its value to https://.

Global Services configurationIf you want to change or add sites to your Data Exchange configuration, change themapping between sites, or specify security privileges, you must edit files in theGlobal Services datastore to configure them for Data Exchange. You access theGlobal Services datastore using the Global Services Configuration Objects pane.The Configuration Objects pane is accessible by members of the Global Servicesadministrator group (TcGSAdmins) through the Global Services Configure link.Access the portal using the following URL format:

http://host-name:port-number/context-root/controller/index

For information about managing the Global Services datastore, see the GlobalServices Configuration Guide.

Configure required Global Services components

You must configure Global Services for use with Data Exchange after you deploy theTeamcenter 10.1 Global Services – Data Exchange Web application by editingfiles in the Global Services datastore. You access the Global Services datastoreusing the Global Services Configuration Objects pane. The Configuration Objectspane is accessible by Global Services administrator group (TcGSAdmins ) membersthrough the Global Services Configure link. Access the Global Services using thefollowing URL format:

http://host-name:port-number/context-root/controller/index

For information about managing the Global Services datastore and Global Servicesconfiguration files, see the Global Services Configuration Guide.

1. Download the following files from the /config datastore location:



Note XML files get serializes when they are loaded into the GlobalServices datastore. Therefore, the files have ser extension in thedatastore and xml extensions after they are downloaded. Theglobalservices.properties file is not an XML file.

DataMappersitemapTeamcenterSoaConfigTcEntConfig (if exchange data with an Teamcenter Enterprise host)globalsevices.properties

2. Download the GlobalServicesAdmin file from the /security location.

3. (Optional) Download the EmailTemplate file from the /config/template location.

4. (Optional) Open the EmailTemplate.xml file and add or update the elements toinclude e-mail notifications as desired.

For more information about e-mail notification, see the Global ServicesConfiguration Guide.

The following example shows notifications for a PDX export:<?xml version="1.0"?>



<rules xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="rule.xsd"xmlns:util="http://teamcenter.com/globalservices/util/2006-12"xmlns="http://teamcenter.com/globalservices/rule/2006-12">

<rule><condition><util:param name="message-id" value="export-to-briefcase-success"/></condition><action><emailto="[email protected]"from="[email protected]"smpt="smpt.companydomain.com"subject="export-to-pdx-success">The export to PDX package operation succeded.Object %object_handle% was exported to a PDX package from %master% to %target% at%complettion_date%</email></action></rule><rule><condition><util:param name="message-id" value="export-to-briefcase-failure"/></condition><action><emailto="[email protected]"from="[email protected]"smpt="smpt.companydomain.com"subject="export-to-pdx-success">The export to PDX package operation failed.Object %object_handle% could not be exported to a PDX package from%master% to %target% at. Check the syslogs for futher information.</email></action></rule>

</rules>

Save the file as email_notif_rules.xml.



For more information about configuring e-mail notifications, see the GlobalServices Configuration Guide.

5. Open the DataMapper.xml file and update the mapper service for thedataTransfer actions to include the source and target site IDs and theappropriate map control file:

...<action name="dataTransfer">

<map source="source site-id from sitemap.xml"target="target site-id from sitemap.xml">

<mapper service="CtrlFileMapService">/MapControlFiles/xfermapctrl.file

</mapper>

</map></action>...

You can use the wildcard character (*) in source and target values. However, youmust take care to avoid conflicting definitions when you use wildcard characters.You can also set throttling to control the number of allows mapping processes forperformance reasons using the maximum-concurrency element and turn onlist of values processing by setting the listOfValuesHandler element to true.

For more information about configuring the data mapper, see the Global ServicesConfiguration Guide.

You must have one dataTransfer action defined for each combination of sourceand target site. For example:

...<action name="dataTransfer">

<map source="457655709" target="457141260"><mapper service="CtrlFileMapService">

/MapControlFiles/TeamCenter_to_TC_Enterprise_control.txt</mapper>

</map></action>

<action name="dataTransfer"><map source="457141260" target="457655709">

<mapper service="CtrlFileMapService">/MapControlFiles/TC_Enterprise_to_Teamcenter_control.txt</mapper>

</map></action>

<action name="dataTransfer"><!— Tc to Tc PDX –>

<map source="457655709" target="109598626"><mapper service="XSLTMapService">/MapControlFiles/Tc2PDX.xsl</mapper>

</map></action>

...

By default, the data mapper limits the number of concurrent data mappingservices in an instance of the MapperService class to four. This throttlingmechanism reduces the resource demands of the data mapper. To change thisvalue, add a maximum-concurrency element to the datamapper.xml filethat contains the desired limit. To turn off throttling, enter zero (0) or a negativenumber, for example:

<maximum-concurrency>0</maximum-concurrency>

6. Open the globalservices.properties file and provide values for the fsc.urisand globalservices.default.tc.siteid properties. The fsc.uris property must



contain at least one URL of an FSC address as configured in the fmsmaster.xmlfile (see Configure FMS for Data Exchange). The globalservices.default.tc.siteidproperty contains the site ID for the Teamcenter site that provides FMS writetickets for Data Exchange transactions, for example:

...fsc.uris=http://cvg101:4001...globalservices.default.tc.siteid=457655709...

Provide the participating Teamcenter site ID (site.id property), the Teamcentertransient volume ID (vol.id property) used for file transfers, and the FMSkey (fsc.key property) used to generate tickets. Normally, site.id andglobalservices.default.tc.siteid values are the same. The site ID and transientvolume ID are identified during the Teamcenter server installation and the FMSkey is defined during Create an FMS key, for example:

...site.id=457655709vol.id="b1e720e68d2167d33c5f96e1961ace4f"fsc.key=f6968bd55d740f44ebacaba09c1313c4...

Note The vol.id value must match the transient volume ID of yourTeamcenter site. You can get this information from the id attribute ofthe transientvolume element in your FMS master file.

For more information about using FMS, see the System Administration Guide.

7. Open the sitemap.xml file and update or add smap:site elements, as required,to match your sites. The site-id attribute must match the site ID for the site asdefined in the Teamcenter Organization application. The JNDI-name attributemust match the JNDI-name context parameter defined for the site’s connectorwhen you generated the Global Services Web application. The config-nameattribute must match the name of the configuration file for the Global Servicesconnector to the site.

...<smap:site site-id="457655709">

<conn:data-source-spec JNDI-name="TcGSTeamcenterSOABox"config-name="TeamcenterSoaConfigTcHost1"/>

</smap:site>

<smap:site site-id="457141260"><conn:data-source-spec JNDI-name="TcGSEntBox"

config-name="TcEntConfig"/></smap:site>...

8. For each Teamcenter site participating in the Data Exchange network, copy theTeamcenterSoaConfig.xml file and rename it to a unique name that indicatesthe site, for example, TeamcenterSoaConfigTcHost1.xml.

Open the file and update the SOA_URL value to match your Teamcenter sitesWeb application URL. For example:

...<util:param name="SOA_URL" value="http://TcHost1:7001/tc"/>



...

If you are using Security Services (SSO), locate the SSO_enabled value andchange it to true. Also, locate the SSOApplicationID value and update itto match the ID supplied for this Teamcenter installation when configuringSecurity Services.

...<util:param name="SSO_enabled" value="true"/>

...<util:param name="SSOApplicationID" value="Teamcenter1"/>

...

9. Open the GlobalServicesAdmin.xml file and update the user and passwordattributes for the JDBCMessageBox attribute with the user and password forthe Teamcenter database administrator. Also, add a box-security-info elementfor each site with the user and password used to access that site, for example:

...<box-security-info

user="TC-DB-user-name"password="TC-DB-user-password"name="JDBCMessageBox"/>

<box-security-infouser="infodba"password="infodba"name="TeamcenterSoaConfigTcHost1"/>

<box-security-infouser="super user"password=""name="TcEntConfig"/>

...

10. Upload each updated file back into its datastore location.

Configuring off-hours transactions

The standard transfer request window starts one minute after receiving the requestuntil 9 minutes after the start time. To change this setting, you must change theBPEL transfer process configuration (data-transfer.bpel ) file that is stored in thedata-transfer.jar file. This file is located in the /bpel Global Services datastorelocation. The standard off-hours configuration is defined as follows:

...

<assign name="Assign__off-hours-start_and_off-hours-end">

<copy><from expression="op:add-dayTimeDuration-to-time(fn:current-time(),

’PT1M’)"/><to variable="off-hours-start"/>

</copy><copy>

<from expression="op:subtract-dayTimeDuration-from-time(fn:current-time(),’PT10M’)"/>

<to variable="off-hours-end"/></copy>

</assign>...

If the transfer remain unprocessed after the transfer window ends, requests areresubmitted to the next off-hours window, which is a 9-minute window 1 day and 1minute after the message was submitted.

The comment section shows a simple configuration that changes the setting to aspecific time period for off-hours processing (local Global Services server time from10:00 p.m. to 6:00 a.m.):

<assign name="Assign__off-hours-start_and_off-hours-end"><copy>

<from expression="’22:00:00’"/><to variable="off-hours-start"/>

</copy><copy>

<from expression="’06:00:00’"/><to variable="off-hours-end"/>

</copy></assign>

Configuring export to secret teams

When exporting secret team objects from Teamcenter, the exporting user musthave the required Secret, super-secret, or top-secret intellectual property(IP) clearance and a DBA role must exist in the Secret group that contains theDBA user. The DBA user must also have the required Secret, super-secret, ortop-secret IP clearance. If the export user is not set up properly, the export fails.

For information about clearance levels and assigning users to roles, see the SecurityAdministration Guide and the Organization Guide.

Also, you must configure authorized data access (ADA) and an access control list(ACL) for the exporting users and the IP Admin role user. The following arerequirements for exporting secret items:

• All exporting users that export secret items and the IP Admin role user must bein the same ACL.

• The IP Admin role user must be granted IP Admin privileges in the ACL.

• Licenses can be attached or detached to items or any valid objects only when theowning user has IP Admin privileges.

• A license must exist at each site with the same name and the objects must be IPclassified (secret, super-secret, or top-secret) for the license to be effectiveon objects at the various sites.



• A user must have IP Admin privileges to set the IP classification on an object.

For information about ADA, ACL, and IP, see the Security Administration Guide andthe Classification Administration Guide.

Configure map files

You can add a new map control file or change the existing map control files thatGlobal Services uses by updating the DataMapper.xml file in the Global Servicesdatastore.

Note Teamcenter 10.1 uses 128-byte ID names. If you have earlier version sitesthat use 32-byte ID names in your Data Exchange environment, you cantransfer only from the 32-byte sites to the 128-byte sites. Standard DataExchange does not support transfers the other direction. If you attemptto transfer from a longer ID site to a 32-byte site, the transfer may fail,however no data corruption occurs.

1. To add new map files or change map files, download the DataMapper.xml filefrom the /config datastore location:

2. Open the file update the desire mapper element:

<action name="dataTransfer"><map source="source site-id from sitemap.xml"

target="target site-id from sitemap.xml">

<mapper service="CtrlFileMapService">/MapControlFiles/xfermapctrl.file 

</mapper></map>

</action>



<action name="QueryAuditAction"><map source="1" target="1">

<mapper service="JavaMapService">com.teamcenter._globalservices.service.QueryAuditService

</mapper></map>

</action>

For example:


<mapper service="CtrlFileMapService">/MapControlFiles/TeamCenter_to_TeamCenter_control.txt

</mapper></map>

</action><action name="dataTransfer">

<map source="457655709" target="457706589"><mapper service="CtrlFileMapService">/MapControlFiles/TeamCenter_to_TeamCenter_control.txt</mapper>

</map></action>

3. Upload the updated file back into its datastore location.



Configure site mapping

You can add a new site or change the sites that participate in Data Exchangetransfers by updating the sitemap.xml and if you are adding a site, adding theassociated connector configuration file to the Global Services datastore.

For information about Global Services connector configuration files, see the GlobalServices Configuration Guide.

1. Download the sitemap.xml file from the /security datastore location.

2. Open the sitemap.xml file and add a new site by adding a smap:site elementwith the appropriate site-id, JNDI-name, and config-name values, or changean existing site by updating the site-id value to match your new site. Forexample:

<smap:site site-id="45830535"><conn:data-source-spec JNDI-name="TcGSTeamcenterSOABox"

config-name="TeamcenterSoaConfigTcHost1"/></smap:site>

<smap:site site-id="458309700"><conn:data-source-spec JNDI-name="TcGSTeamcenterSOABox"

config-name="TeamcenterSoaConfigTcHost2"/></smap:site><smap:site site-id="457141260">

<conn:data-source-spec JNDI-name="TcGSEntBox"config-name="TcEntConfig"/>

</smap:site>

The site-id must match the value assigned to the site in Teamcenter. TheJNDI-name must match the connector EJB name that Global Services usesto connect to the site. The config-name value must match the connectorconfiguration file name.

3. If you are adding a site, create the connector configuration file.

4. Upload the updated sitemap.xml file into the /security datastore location andany new connector configuration files into the /config datastore location.

Custom BPEL processes

The Global Services BPEL engine controls the transfer process and uses theApache Orchestration Director Engine (ODE). The standard BPEL process providesdata transfer between Teamcenter and Teamcenter Enterprise sites and betweendifferent Teamcenter sites. You can create your own BPEL process to support acustom transfer process.

For information about using a custom BPEL process, see the Global ServicesCustomization Guide.



Configure PDX exportCaution You must select the Vendor Management feature during Teamcenter

installation to create the TIEPDXPropertySet property set that PDXexport requires.

Teamcenter Environment Manager (TEM) imports thedefaultTransfermodes.xml file that contains the definitions ofall standard transfer modes. The importer validates the clausesof a property set. Because the TIEPDXPropertySet property setcontains vendor management-related clauses, if you do not select theVendor Management feature, the validation fails when the vendormanagement-related clauses are encountered. This prevents the PDXexport feature from being fully functional.

1. Map your Teamcenter objects and their attributes to PDX objects and theirattributes. Teamcenter provides a default mapping of standard Teamcenterobjects to PDX objects (see Standard PDX mapping) and a default style sheetfor 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 appropriatefor 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 thetransfer mode file be based on the business process.

B. Update the transfer mode to reference the information that must beexported in a PDX package.

For details on how to change the closure rule, filter rule, propertyset, and revision rule, see the PLM XML/TC XML Export ImportAdministration Guide.

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

Note You must have generated the Global Services Web application anddeployed it on your application server before you can access theGlobal Services datastore.

For information about generating and deploying the Web application,see Install Global Services Data Exchange and Global Services Webapplication deployment.

For non-Global Services based exports, you can extract the requireddatastore file from the Global Services JAR file.

A. Download the standard PDX style sheet (Tc2PDX.xsl file) located in theMapControlFiles location of the Global Services datastore.

For information about downloading files from the Global Servicesdatastore, see the Global Services Configuration Guide.

For non-Global Services based export, use an archive tool,such as 7-Zip, to extract the Tc2PDX.xsl file from the



ugs_globalservices_application_directory.jar file. This file islocated in the Web_tier directory of the Teamcenter install image and islocated in the JAR file at:

datastore/initial_datastore_full.zip/MapControlFiles

Siemens PLM Software recommends naming the style sheet based onyour business process.

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

For information about custom transformations, see Defining a customPDX style sheet.

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

2. 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 Namebox, 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 samesite 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 TCXMLPayload check box.

e. For Global Services based export, type the URL used to contact the GlobalServices Web application in the TcGS URL box, for example:

http://hostname:7001/tcgs

f. Select the Is Offline check box.

g. Click Create.

3. For non-Global Services based export, attach the customized Tc2PDX.xsl stylesheet to the default PDX TIEPDXExportDefault transfer mode:

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

plmxml_tm_edit_xsl -u=infodba -p=infodba-transfermode=TIEPDXExportDefault -xsl_file=C:\temp\Tc2PDX.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>

4. Set your Teamcenter preferences.

For information about creating and using preferences, see the Rich ClientInterface Guide.

• Set the PDX_pkg_file_name preference at the site location.

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

TC_gms_export_transfermode_for_PDX1=TIEPDXExportDefault

5. Set the PROCESS_WARM and PROCESS_TARGET parameter in the serverpool properties file (serverPoolconfiguration-ID.properties) to ensure thereis a sufficient number of tcservers available. The following are recommendedminimum values for PDX export functionality:

PROCESS_WARM=5PROCESS_TARGET=0700 10, 1700 10

For information about server manager pool-specific configuration, see the SystemAdministration Guide.

6. Test the customized solution.

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

Defining a PDX workflowThe BC-perform-offline-export workflow handler contains the required and optionalarguments that, as an administrator, you can combine to define process templatesthat can be used to export to a PDX package through a workflow.

For information about defining workflows, see the Workflow Designer Guide.

Defining a custom PDX style sheetYou must create a custom XSLT file to handle transformations for the followingscenarios:

• You have Teamcenter objects that are subtyped at your site.

• You have custom attributes at your site.

• You must map elements in the PDX specification that the standard style sheetdoes not map.



Subtyped objects

The following table and figures show how the standard style sheet maps elements ofTC 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 BOMLineelements, Attachment elements, and so forth). Your customizations must preservetheir functionality.

TC XML element PDX element

Item, Part, CommericalPart Item

EngChange Change

ManufacturerPart ManufacturerPart

Vendor Contact

<xsl:if test=”count(//tc:Item)>0or count(//tc:Part))>0or 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:if test=”count(//tc:ManufacturerPart)>0”><xsl:element name=”ManufacturerPart”><xsl:for-each select=”tc:TcXML/tc:ManufacturerPart”>⋮


<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”>⋮


Collapsed standard style sheet view



<xsl:if test=”count(//tc:Item)>0or count(//tc:Part))>0or count(//tc:MyCustomPart))>0or 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:if test=”count(//tc:EngChange)>0”><xsl:element name=”Changes”><xsl:for-each select=”tc:TcXML/tc:EngChange”>⋮


<xsl:if test=”count(//tc:ManufacturerPart)>0”><xsl:element name=”ManufacturerPart”><xsl:for-each select=”tc:TcXML/tc:ManufacturerPart”>⋮


<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”>⋮


Customized style sheet with subtypes

Custom attributes

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

<xsl:attribute name="fileSize⋮><xsl:value—ofselect=⋮//tc:ImanFile/tc:GSIdentity(@elemId=$dsId)/../@byte_size"/>

</xsl:attribute><xsl:attribute name="versionIdentifier⋮><xsl:value—ofselect=⋮//tc:GSIdentity(@elemId=$imsoId)/../@version_number"/>

</xsl:attribute><xsl:attribute name="attachmentModificationDate⋮><xsl:value—ofselect=⋮//tc:ImanFile/tc:GSIdentity(@elemId=$dsId)/../@last_mod_date"/>

</xsl:attribute><xsl:attribute name="extraAttribute⋮><xsl:value—of select=⋮Yes"/></xsl:attribute>



<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—ofselect=⋮//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 youwant in addition to these (for example, SupplierPart). Use the standard style sheetas a reference for adding the additional elements.


Chapter

6 Using briefcase files

Using briefcase files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1Configure briefcase for site checkin and checkout . . . . . . . . . . . . . . . . . . . 6-1Configure Teamcenter for Briefcase Browser . . . . . . . . . . . . . . . . . . . . . . 6-2Briefcase Browser site configuration files . . . . . . . . . . . . . . . . . . . . . . . . 6-4

Migrate a supplier site from a managed to unmanaged site . . . . . . . . . . . . . . 6-10

Configure 4th Generation Design data exchange . . . . . . . . . . . . . . . . . . . . . . 6-12


Chapter

6 Using briefcase files

Using briefcase filesYou can use briefcase files to exchange data with other Teamcenter sites that do notparticipate 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 theirdata with Teamcenter (unmanaged site) such as a supplier site. Unamanged sitesmust have Briefcase Browser installed and configured to work with briefcase files.

For information about installing and configuring Briefcase Browser, see the BriefcaseBrowser Guide.

If your site is a managed Teamcenter site, you must preform the migration procedureas described in Migrate a supplier site from a managed to unmanaged site beforeusing Briefcase Browser as an unmanaged site.

Configure briefcase for site checkin and checkout

To use briefcase with the Tools→Check In/Out→Check Out To Site commandin a non-SSO configuration, the following access privileges must be given to theTeamcenter user specified in the Global Services configuration.

Symbol Privilege

Read

Write

Export

Import

Transfer out

Transfer in

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

For information about using access control lists (ACLs) to control access privileges,see the Access Manager Guide.


Chapter 6 Using briefcase files

You must create and set the GMS_tcxml_string_separator preference at theexporting site location to allow a Teamcenter 2007 version prior to MP4 to importa 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 typeGMS_tcxml_string_separator in the Name box.

4. Select GMS Offline.Import from the Category list and Site from the ProtectionScope 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 importThe GMS_site_checkin_after_import preference controls whether or not abriefcase file that contains objects checked out to a site are automatically checked inwhen it is imported. If set to true, the objects are checked in on import.

Configure Teamcenter for Briefcase Browser

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

By default, Teamcenter uses Global Services to export a briefcase file. If you do nothave Global Services installed, you can export the briefcase file without user theGlobal Services functionality by setting the GMS_offline_use_TcGS preferencevalue to false.

For information about setting preferences, see the Preferences and EnvironmentVariables Reference.

The unmanaged site must be defined for each unmanaged site in the Organizationapplication. The site must be defined with the Is Unmanaged, Is Offline, and UsesTCXML Payload options selected.

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

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

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


Using briefcase files

For information about defining sites, see the Organization Guide.

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

TC_gms_export_default_transfermode=TIEExportDefaultTM

TC_gms_import_default_transfermode= TIEImportDefault

TC_show_checkedout_icon = TRUE

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

BRIEFCASE_export_CAD_incomplete = FALSE

You can set this to TRUE if you want to allow incomplete CAD exports.Siemens 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 to the dataset attached to item(item_id) 000123 revision (rev_id) B as the validation rule dataset.

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

item_id/rev_id

Briefcase Browser site configuration files

Briefcase Browser reads the XML configuration files in thebbworkspace\configuration directory. Each configuration has aseparate directory that contains the site-id.properties file as a minimum.

site-id.propertiesDefines the unmanaged site ID. This value can be any numeric sequence and isnot 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 ormodify this file manually or use the Preference dialog box in Briefcase Browser.

It should also contain the following additional configuration files:

TCXML.xsdDefines the schema that Briefcase Browser uses to load, display, and createbriefcase files. It must have this name. This file is normally supplied by themanaged (OEM) site to the supplier (unmanaged) site. It is available in theTC_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 headersof PLM XML and TC XML files serve as namespace names, which areunique identifiers for an XML vocabulary. Although they are URIs, theyare not used to identify and retrieve Web addresses.

CustomMappings.xmlDefines information about the Teamcenter (OEM) site that you exchangebriefcase 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 exchangingupdated 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.

• Define the release status values the managed (OEM) site allows you toassign to parts or assemblies you create in the release_status_nameelements. Briefcase Browser displays the values that you supply inrelease_status_name elements in the Release Status Name list in thePreferences dialog box. The value you select in the Preference dialog boxis assigned as the release status of any new CAD parts or assemblies youcreate. The value must match one of the valid values for Teamcenter releasestatus 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="10.1.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><attribute>item_id</attribute>

</multi_field_key><helper_object_map custom_type="CAD--Revision"

ootb_type="ItemRevision"/><helper_object_map custom_type="CAD--Master"

ootb_type="Item--Master"/><helper_object_map custom_type="CAD--Revision--Master"




<item_type_mapping custom_type="B4Item"><multi_field_key><attribute>item_id</attribute>

</multi_field_key><helper_object_map custom_type="B4ItemRevision"

ootb_type="ItemRevision"/><helper_object_map custom_type="B4ItemMaster"

ootb_type="Item--Master"/><helper_object_map custom_type="B4ItemRevisionMaster"


<item_type_mapping custom_type="CommercialPart"><multi_field_key><attribute>item_id</attribute>

</multi_field_key><helper_object_map custom_type="CommercialPart--Revision"

ootb_type="ItemRevision"/><helper_object_map custom_type="CommercialPart--Master"

ootb_type="Item--Master"/><helper_object_map custom_type="CommercialPart--Revision--Master"


<item_type_mapping custom_type="Design"><multi_field_key><attribute>item_id</attribute>

</multi_field_key><helper_object_map custom_type="Design--Revision"

ootb_type="ItemRevision"/><helper_object_map custom_type="Design--Master"

ootb_type="Item--Master"/><helper_object_map custom_type="Design--Revision--Master"


<item_type_mapping custom_type="Part"><multi_field_key><attribute>item_id</attribute>

</multi_field_key><helper_object_map custom_type="Part--Revision"

ootb_type="ItemRevision"/><helper_object_map custom_type="Part--Master"

ootb_type="Item--Master"/><helper_object_map custom_type="Part--Revision--Master"


</custom_mappings>

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

For more information about the auto_baseline (baseline) feature, see theBriefcase Browser Guide.

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 impreciseassembly structures are allowed.

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

You map custom CAD parts types to OEM types by assigning a custom Itemtype to the items in the TC XML data created for your CAD part. You define thesubtype 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 ownedparts to be created as Item objects at the OEM site.



Note The custom item type must be defined in the schema (TCXML.xsd) fileused by Briefcase Browser.

You can have multiple custom types defined in this file. Briefcase Browserlocates the matching custom in the file and maps the file to the defined OEMobject. If a custom type part is not found in the CustomMappings.xml file, thefirst custom type defined in used. If there are no custom types defined, BriefcaseBrowser maps the part to the standard Teamcenter.

cad_to_tc_attribute_map.xmlDefines the mapping of user-defined NX attributes to qualified Teamcenter objectattributes. The user-defined attributes must be part of the configured TC XMLschema (TCXML.xsd file). This allows you to define attributes for qualifiedobjects in addition to the required attributes, for example:

<?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"

tc_type="CAD--Revision--Master"/><attribute_mapping cad_part_attr="CALC_WEIGHT" tc_attr="nisCalculationWeight"

tc_type="CAD--Revision--Master"/><attribute_mapping cad_part_attr="CALCULATIVE_COEFFICIENT"

tc_attr="nisCalculativeCoefficient"tc_type="CAD--Revision--Master"/>

<attribute_mapping cad_part_attr="Z_CENTROID" tc_attr="nisGravityZ"tc_type="ItemRevision--Master"/>

<attribute_mapping cad_part_attr="Y_CENTROID" tc_attr="nisGravityY"tc_type="CAD--Revision--Master"/>

<attribute_mapping cad_part_attr="X_CENTROID" tc_attr="nisGravityX"tc_type="CAD--Revision--Master"/>

</CAD2TC_attribute_mappings>

visible-attributes.xmlDefines the attributes that are displayed in Briefcase Browser properties views.By default, Briefcase Browser displays all qualified attributes. If this file ispresent, Briefcase Browser limits the attributes in the properties views to theattributes 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.xmlDefines the localized values for the language indicated by the name of thedirectory containing the file. The directory name consists of a two-characterlocale and two-character country code such as en_US. The language directoriesmust be in the lang directory in the site’s configuration directory.



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

configurationsdefaultdashboard_supplier

langen_USja_JP

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

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

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

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

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



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



Migrate a supplier site from a managed to unmanaged siteYou can change a supplier site that has previously been defined as a managed site inTeamcenter to an unmanaged site without causing any data errors for previouslytransferred data. This procedure designates the site migrating to an unmanaged siteas 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.

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 theITEM_smart_baseline preference to 0.

For information about creating and using preferences, see the Rich ClientInterface Guide.

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

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

4. If the supplier site is a hub site, in the Organization application, clear the Is aHub 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 optionsbutton .

c. In the TIEConfiguredExportDefault dialog box, select the Replica Bypasscheck 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 siteID as the managed site for the unmanaged site.

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

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

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

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

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



12. Transfer briefcase files to the OEM and import them into Teamcenter usingTools®Import®From Briefcase.

Configure 4th Generation Design data exchange4th Generation Design (4GD) data can be exported and imported from DataExchange only through TC XML briefcase files. Therefore, you must set theGMS_offline_use_TcGS preference to FALSE.

For more information about GMS_offline_use_TcGS preference, see the Preferencesand Environment Variables Reference.

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

2. In the Options dialog box, click Filters and type GMS_offline_use_TcGS inthe 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 ruleused 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 byselecting the desired rule name from the Revision Rule list.

For information about additional options you can use to control how 4GD data isexported, see 4th Generation Design data.


Chapter

7 Using the Mapping Designer

Introduction to the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Enabling the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1Install the Mapping Designer to the Business Modeler IDE . . . . . . . . . . . 7-1Install Altova MapForce . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2

Start the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

Mapping Designer user interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

Filtering rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5

Basic tasks using the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6Mapping Designer process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6Create a Mapping Designer project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6Add a factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8Create a map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10Create filtering rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11Build a control file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14Deploy a control file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14

Advanced tasks using the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . 7-15Add a child factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15Clone a factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15Import a factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15Search for factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16Delete a factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17Add a factor dependency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17Modify factor source elements and properties . . . . . . . . . . . . . . . . . . . . . 7-18Modify factor target elements and properties . . . . . . . . . . . . . . . . . . . . . . 7-19Find Teamcenter property characteristics . . . . . . . . . . . . . . . . . . . . . . . . 7-20Create a lookup table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20Import the sample Mapping Designer projects . . . . . . . . . . . . . . . . . . . . . 7-24Add your mappings to a sample project . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26Change Mapping Designer project properties . . . . . . . . . . . . . . . . . . . . . . 7-28

Mapping Designer perspectives and views . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28Introduction to Mapping Designer perspectives and views . . . . . . . . . . . . 7-28Mapping Designer perspective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-29Mapping Designer views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-29

Factors view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-29Factor Details view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-30Factors Search view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31


Eclipse views used by the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . 7-31Console view in the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . 7-31Editors in the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-32Project Explorer view in the Mapping Designer . . . . . . . . . . . . . . . . . 7-32


Chapter

7 Using the Mapping Designer

Introduction to the Mapping DesignerThe Mapping Designer is an application that administrators can use to map datamodel from one product lifecycle management (PLM) system to another (for example,Teamcenter Enterprise to Teamcenter, or Teamcenter to Teamcenter Enterprise). Itcan also map data model from one Teamcenter installation to another Teamcenterinstallation, or from one Teamcenter Enterprise installation to another TeamcenterEnterprise installation. Mapping is only one part of a larger process to move databetween Teamcenter PLM systems.

The Mapping Designer is installed to the Business Modeler IDE, but it is onlyenabled after you install Altova MapForce. After you’ve installed Altova MapForce,you can access the Mapping Designer perspective in the Business Modeler IDE bychoosing Window®Open Perspective®Other®Mapping Designer.For more information, see Enabling the Mapping Designer.

Enabling the Mapping Designer

Install the Mapping Designer to the Business Modeler IDE

1. Start Teamcenter Environment Manager (TEM).

For example, from the Teamcenter software distribution image run TEM.bat(Windows) or TEM.sh (Linux).

Note Before running TEM, you must install the proper version of the JREand set the JRE_HOME environment variable or the JRE64_HOMEenvironment variable.

For more information, see the Installation on Windows Clients Guide.

2. Proceed to the Solutions dialog box. In the Solutions dialog box, select BusinessModeler IDE, and then click Next.

3. Perform the following steps in the Features dialog box:

a. Under Base Install, select Business Modeler IDE Standalone.

b. Under Extensions®Platform Extensibility®Global Services, selectMapping Designer.This installs the Mapping Designer data model mapping tool into theBusiness Modeler IDE.


Chapter 7 Using the Mapping Designer

c. In the Installation Directory box, enter the location where you want to installthe Business Modeler IDE.

The Business Modeler IDE files are installed to a bmide subdirectory.

d. Click Next.

4. Complete the remaining dialog boxes to finish the installation. When theinstallation is complete, exit Teamcenter Environment Manager.

Install Altova MapForceAfter you install the Mapping Designer, you must install Altova MapForce, amapping tool that the Mapping Designer uses to create maps.

For more information about MapForce, go to the following URL:

http://www.altova.com/products/mapforce/data_mapping.html

1. Install the Altova MapForce 2011 Professional Edition.

a. Go to the following URL:

http://www.altova.com/download_archive.html

b. Click the arrow in the Software Archive for box, select 2011sp1, and chooseMapForce® 2011 Professional Edition.

Note Choose the 64-bit package if you have a 64-bit machine and youwant to run in 64-bit mode. If you want to run in 64-bit mode, youmust have already installed the 64-bit versions of the JRE and theBusiness Modeler IDE.

2. Run Altova MapForce.

The first time you run MapForce, you must select a license option. Choose thepermanent license option.

Note If you have difficulty obtaining a license, contact your Siemens PLMSoftware representative to obtain a MapForce license.

3. MapForce uses an integration to Eclipse. Install the MapForce 2011 IntegrationPackage and choose the Eclipse plug-in.

a. Go to the following URL:

http://www.altova.com/download_archive.html

b. Click the arrow in the Software Archive for box, select 2011sp1, and chooseMapForce® 2011 Integration Package.

c. Run the installer and select the Install the Eclipse plug-in check box. Thenselect the Manually, using the Eclipse configuration manager option toinstall the Eclipse plug-in using the manual configuration. By default,when running in 32-bit mode, the integration plug-ins are installed to thefollowing locations (on Windows):

c:\Program Files (x86)\Altova\Common2011\eclipsec:\Program Files (x86)\Altova\MapForce2011\eclipse


Using the Mapping Designer

4. Install the MapForce Eclipse plug-in files.

a. Copy the MapForce Eclipse plug-ins from the locations where they wereinstalled, for example:

c:\Program Files (x86)\Altova\Common2011\eclipse\pluginsc:\Program Files (x86)\Altova\MapForce2011\eclipse\plugins

b. Paste the MapForce Eclipse plug-ins in the Business Modeler IDE pluginsdirectory, for example:

install-location\bmide\client\plugins

c. Launch the Business Modeler IDE.

5. To verify the installation of MapForce to the Business ModelerIDE, open the MapForce perspective by choosing Window®OpenPerspective®Other®Mapforce.

6. To verify that the Mapping Designer perspective is enabled, chooseWindow®Open Perspective®Other®Mapping Designer.

Start the Mapping Designer1. To start working with the Mapping Designer, you must run the Business

Modeler IDE:

• Windows systems:

Click the Start button and choose the Programs®Teamcenter 10®BusinessModeler IDE menu commands. This runs the bmide.bat file.

• Linux systems:

Run the bmide.sh file in the install-location/bmide/client directory.

2. When you start the Business Modeler IDE for first time, the Welcome dialog boxappears. Click the Workbench button on the right side of the Welcome window.

3. To access the Mapping Designer perspective, choose Window®OpenPerspective®Other®Mapping Designer.

Mapping Designer user interfaceThe Mapping Designer perspective is the UI where you perform all mapping work.

For more information about the user interface, see Introduction to Mapping Designerperspectives and views.

The following figure shows the perspective after a project, factor, and map are created.To access this perspective, choose Window®Open Perspective®Other®MappingDesigner.



Mapping Designer perspective

The Mapping Designer perspective is composed of the following views and editors:

1 Factors View The Factors view displays the available factors.A factor is a list of data model elements thatyou want to map between the source systemand the target system.

For more information, see Factors view.

2 Project Explorer view The Project Explorer view displays the files inthe project workspace. The files include factorXML files, MapForce map files (.mfd), schemafiles (.xsd), and transformation files (.xslt).

For more information, see Project Explorer viewin the Mapping Designer.

3 MapForce editor The MapForce editor displays factors, and isused to create mappings. To open a factor inthis editor, right-click a factor in the Factorsview and choose Open Factor.

4 Factor Details View The Factor Details view displays additionalfactor information, including filtering rules.Filtering rules define the object instances to beprocessed by the Mapper Engine.

For more information, see Factor Details view.



5 Factors Search View The Factors Search view displays results ofqueries for factors.

For more information, see Factors Search view.

In addition to these Mapping Designer views, there are additional views providedby MapForce. For documentation about MapForce views, see the MapForcedocumentation, available at the following URL:

http://www.altova.com/documentation.html

Filtering rulesFiltering rules select the source system instances to be processed, and applies thetransformation only to those objects. The rules specify the relationships between theelements in the factors. The following tables show sample filtering rules.

Rule Element PrimaryPrimaryproperty Secondary

Secondaryproperty

1 Cmponent Cmponent2 CmpnMstr Cmponent ItemMstrOBID CmpnMstr elemId

Based on the rules in the table, processing proceeds as follows:

1. Based on rule 1, the Mapper Engine processes the source instance XML file toget a list of objects that are of the Cmponent type.

2. Based on rule 2, for each Cmponent object found by rule 1, the Mapper Enginefinds all objects of the CmpnMstr type that satisfy the following:

Cmponent::ItemMstrOBID=CmpnMstr::elemID

3. The Mapper Engine applies the transformation to the objects selected fromrules 1 and 2.

Rule Element PrimaryPrimaryproperty Secondary

Secondaryproperty

1 Document Document2 Document Document elemId Attach Left3 WordDoc Attach Right WordDoc elemId

Based on the rules in the table, processing proceeds as follows:

1. Based on rule 1, the Mapper Engine processes the source instance XML file toget a list of objects that are of the Document type.

2. Based on rule 2, for each Document object found by rule 1, the Mapper Enginefinds all objects of the Attach type that satisfy the following:

Document::elemID=Attach::Left



3. Based on rule 3, for each object of the Attach type found, the Mapper Enginefinds WordDoc objects that satisfy the following:

Attach::Right=WordDoc::elemId

4. The Mapper Engine applies the transformation to the objects selected fromrules 1, 2, and 3.

Basic tasks using the Mapping Designer

Mapping Designer processFollow this process to create a mapping from one PLM system to another:

1. Create a project.

For more information, see Create a Mapping Designer project.

2. Create a list (factor) of the data model elements that you want to map betweenthe source system and the target system.

For more information, see Add a factor.

3. Using the data model elements in the factors, map the source elements to thetarget elements.

For more information, see Create a map.

4. Create filtering rules on the factors to define which instances of the data modelelements to process.

For more information, see Create filtering rules.

5. Build a control file that contains all the mapping information in the project.

For more information, see Build a control file.

6. Deploy the control file to the Data Exchange server.

For more information, see Deploy a control file.

Create a Mapping Designer projectBefore you can create a mapping, you must create a project. A project provides anenvironment which manages your data model mappings in files and folders.

1. Open the Mapping Designer perspective if it is not already active. ChooseWindow®Open Perspective®Other®Mapping Designer.

2. Choose File®New®Project, and in the New Project dialog box, choose MappingDesigner®Mapping Designer Project. Click Next.The New Project wizard runs.

3. In the Project dialog box, perform the following steps:

a. Type a name for your project in the Project Name box.



b. Select the Use default location check box if you want to createthe project under your default workspace. To find the workspacelocation, choose File®Switch Workspace. For example, on Windowssystems, the default workspace for the Business Modeler IDE is atinstall-location\bmide\workspace.

If you want to create the project in another location, clear the Use defaultlocation check box and click Browse to choose another location. For example,if you are using a source control management (SCM) system to manage yourXML source files, you may want to create the project in a location where theSCM can recognize it.

c. Select the Add project to working sets check box if you want to add theproject to a working set that you have already created in Eclipse. (You canuse this option only if you have installed the Business Modeler IDE to anEclipse environment.)

d. Click Next.

4. In the Source and Target Schema dialog box, perform the following steps:

a. In the Project Description box, type a description of the work you willperform in the project.

b. Click the Browse button to the right of the Source Schema File box to locatethe schema data model file for the system you are mapping from.

c. Click the Browse button to the right of the Target Schema File box to locatethe schema data model file for the system you are mapping to.

Note Before you create a project, you must have already generated schemafor your source and target installations. To generate a Teamcenterschema file, use the Export option in the Business Modeler IDE. Youcan also use schemas from the sample projects.

For more information, see the Business Modeler IDE Guide.

To generate an Teamcenter Enterprise schema file, in theAdministration Editor use the System Utilities®Generate XMLSchema menu option. After generating the file, the followingmessage is displayed:

Generation of new XML Schema is successfully completed.Please find the xsd file at XSD_DIR of config.cfg

Verify that the structure of the resulting XSD file is correct. Forexample, if some input items are missing, they are replaced withchange_me. Look for instances of change_me in the schema fileand change them as appropriate. If you do not, you may encountererrors when you use this file and attempt to create a project or afactor using the Mapping Designer.

For the generated Teamcenter Enterprise schema file tobe read by the Mapping Designer, you need to copy theMTI_ROOT/xml/ems/TcEntBaseSchema.xsd file into the samedirectory as the generated schema file. The generated schema filerefers to this TcEntBaseSchema.xsd file, and if both files are not



in the same directory before creating the Mapping Designer project,errors can occur when creating factors.

d. Choose Finish.

The wizard creates the project and displays it in the Factors view. To seethe files in the project, click the Project Explorer tab to access the ProjectExplorer view.

To see the project’s properties, right-click the project in the Project Explorerview and choose Project Explorer. In the left pane of the Properties dialogbox, choose Teamcenter®Mapping Designer.For more information, see Change Mapping Designer project properties.

Add a factor

In the Mapping Designer, a factor is a list of data model elements that you want tomap between the source system and the target system.

More generally, a factor is a conceptual piece of information, and factoring is a wayof defining those pieces (factors), specifying transformations for those factors, andthen applying the transformations to the factors. Defining factors and specifyingthe transformation for each factor simplifies the mapping process and makes itmore manageable.


2. In the Factors view, right-click the project in which you want to add the factorand choose Add New Factor, or right-click a factor and choose Add New ChildFactor.The New Factor wizard runs.

3. In the Factor: Create a new Factor dialog box, perform the following steps:

a. The Project box shows the project to which this new factor is added.

b. In the Name box, type the name you want to assign to the new factor.

You may want to name the factor for the data model category you aremapping, for example, Cmponent or Assembly.

c. In the Description box, type a description of the work you will perform inthe factor.

d. In the Version box, type the iteration for this factor (for example, A, B, C,or 1.0, 1.1, and so on).

e. If a factor already exists in a project, you can click the arrow in the ExtendFrom box to copy data model elements from another factor.

f. Click Next.

4. In the Factor: Add source elements dialog box, perform the following steps tochoose the data model elements to map from the source system.



a. Select Sort Alphabetically if you want to place the elements in alphabeticalorder.

b. Click the Add Element button.

c. In the Element Selection Page dialog box, choose a data model element fromthe source system that you want to map.

For example, if the project is set up for mapping from Teamcenter Enterpriseto Teamcenter, the list displays Teamcenter Enterprise data elements. Selectan element in the source system you want to map.

If you want to map an element from a parent factor, the parent is shown inbrackets after the name of the element, for example, [parent-factor].

Click Next.

d. In the Property Selection Page dialog box, select the properties (attributes)on this element that you want to map.

Click Finish.

The source element and its properties appear in the Factor: Add sourceelements dialog box.

e. Continue to add source elements and properties using the buttons on theright side of the Factor: Add source elements dialog box:

• Add ElementAdd a data model element.

• Add PropertyAdd properties to the selected element.

• RemoveRemove the selected element or property.

• ReplaceReplace the selected element or property with another.

f. When done, click Next.

5. In the Factor: Add target elements dialog box, perform the same steps that youdid when adding source elements. These are the data model elements to map toin the target system.

For example, if the project is set up for mapping from Teamcenter Enterprise toTeamcenter, the target list displays Teamcenter data elements.

When done, click Next.

6. In the Factor: Add source instance filtering rules dialog box, click the Addbutton.

Each factor must have a set of rules to filter out objects in the source systemthat need to be processed. The Mapper Engine only applies the transformationto the objects specified in the rules.



For directions about how to create rules using this dialog box, see Create filteringrules. For an explanation of filtering rules, see Filtering rules.

Note If you choose not to create filtering now, you can click Finish and proceedto step 8. You can create filter rules later.

7. Click Finish.

The new factor appears under the project.

8. To save the factor, choose File®Save All.

9. To see the factor files, right-click in the Project Explorer view and chooseRefresh. To see the elements and properties in the factor, double-click thefactor’s .xml file.

Caution The Mapping Designer does not automatically refresh the factorfolder. This must be done manually. If a factor folder is checked intoa source control system before the refresh is done, the factor fileversions may become unsynchronized.

10. If you need to make additional changes to the factor, right-click the factor in theFactors view and choose Modify Source Element/Properties or Modify TargetElement/Properties.

For more information, see Modify factor source elements and properties andModify factor target elements and properties.

After you create the factor, create a map between the source and target elements.


Create a mapUsing the data model elements in the factors, map the source elements to the targetelements.

The steps in the following procedure document only the basics about how to createa map using the Mapping Designer. The mapping functionality is provided byMapForce, and is a rich set of features that allow you to do complex mapping.

For more detailed documentation about creating maps, including using libraryfunctions, see the MapForce documentation, available at the following URL:

http://www.altova.com/documentation.html


2. In the Factors view, right-click the factor that you want to map and chooseOpen Factor.The factor appears in an editor as a SourceSchema box and a TargetSchemabox. (This editor is provided by the MapForce plug-in.)

3. Click the plus symbol (+) by the TcFactor node in the source box and in thetarget box. This expands to show all the elements you have created in thesource and target.



For example, if you are mapping from Teamcenter Enterprise to Teamcenter,click the plus symbol (+) by the tce:TcFactor node in the source box and theplm:TcFactor node in the target box.

4. Click the arrows on the TcFactor node in the source box and drag the mousepointer to the plm:TcFactor node in the target box. This maps the source factorto the target factor.

5. Expand the elements you want to map by clicking the plus symbol (+) by theelements. Click and drag from the source element properties to the targetelement properties. This maps the properties in the source element to the targetelement.

Creating a map

For examples of mappings, view the sample projects.

For more information, see Import the sample Mapping Designer projects.

6. When you are done mapping, click the Save button on the toolbar.

To see the mapping file, right-click in the Project Explorer view, choose Refresh,and open the factor. The mapping file is saved with an .mfd (MapForce)extension.

After you create the map, create filtering rules.


Create filtering rulesCreate filtering rules on the factors to define which instances of the source datamodel elements to process. The Mapping Engine only applies the transformation tothe objects specified in the rules.

For a detailed explanation, see Filtering rules.



You can create the filtering rules when you create the factor, or after the factor iscreated. The following procedure describes how to create the rules after factorsare already created.


2. In the Factors view, select the factor for which you want to create filtering rules.

3. In the Factor Details view at the bottom of the window, select the Filtering Rulestab.

4. Click the Add button on the Filtering Rules tab.

5. Perform the following steps in the Factor: Create new filtering rule dialog box:

a. In the To Be Included pane, click the Browse button to the right of theElement box to choose the main element to filter.

b. Click the Define Condition button if you want to create a condition thatthe element must meet. Only objects having the element that meets thiscondition will be processed from the source system.

Click the Add button in the Condition dialog box and perform the followingsteps in the Condition: Add condition statement dialog box:

A. The Primary box displays the main element to filter for the condition.

B. For Condition Type, select one of the following:

• AttributeSpecifies that the condition applies to a property.

• ConstantSpecifies a constant is used with the condition.

• Raw XPathSpecifies that the condition applies to an XPath (XML PathLanguage) address for the node in an XML document.

C. If you selected Attribute, click the Browse button to the right of thePrimary Property box to select the primary property to filter.

D. If you selected Attribute, click the arrow in the Criteria box to select theoperator for the condition.

Operator Description= Equals.

!= Does not equal.< Less than.<= Less than or equals.> Greater than.



Operator Description>= Greater than or equals.

E. If you selected Attribute or Constant, click the Browse button to theright of the Secondary box to select the second-level element to filterfor the condition.

F. If you selected Attribute or Constant, click the Browse button to theright of the Secondary Property box to select the second-level propertyto filter for the condition.

G. If you selected Constant, in the Constant Value box, type a constantvalue to apply to the condition.

H. If you selected Raw XPath, in the Raw XPath box, type the path to theXML node that the condition applies to.

I. Click Finish.

J. After you finish building conditions, click Finish in the Condition: Buildcondition dialog box.

c. Click Finish in the Factor: Create new filtering rule dialog box.

The first level of the filter appears in the table on the Filtering Rules tab.

6. Now you are ready to add the next level of filtering. Select the first level offiltering and click the Add button on the Filtering Rules tab.

7. Perform the following steps in the Factor: Create new filtering rule dialog box:

a. In the Existing pane, click the Browse button to the right of the Propertybox to select the property on the primary element to filter.

b. In the To Be Included pane, click the Browse button to the right of theElement box to select the element to include in the filtering.

c. In the To Be Included pane, click the Browse button to the right of theProperty box to select the property to filter on this element.

d. Repeat the same steps as needed for the Define Condition button and theHas Multiple and Is Required check boxes.

e. Click Finish.

8. Select the rule in the table under which you want to create additional filteringand click Add. Continue to add rules, adding layers of filtering.

For examples, see Filtering rules.

9. When you are done creating filters, click the Save button on the toolbar orchoose File®Save.

After you create the filtering rules, build a control file.




Build a control file

Build a control file that contains all the mapping information in the project. Beforebuilding the control file, you must create factors, a mapping, and filtering rules.


2. In the Factors view, right-click the project and choose Build Control File.

The Build Control File dialog box displays a confirmation message.

3. In the Build Control File dialog box, click OK.

4. To see the control file, right-click in the Project Explorer view and chooseRefresh. The control file mapping file is saved as project-name_control.xml. Tosee its contents, right-click the file and choose Open or Open With.

After you build the control file, you must deploy it to the Data Exchange server.


Deploy a control file

The control file must be deployed to the Data Exchange server so that it can be runwith the Mapper Engine in the data exchange process. The Mapper Engine runs theinstance file from the source system against the mapping control file. The resultingoutput file contains the data items to be imported into the target system.


2. In the Factors view, right-click the project whose control file you want to deployand choose Deploy Control File.

The Deploy wizard runs.

3. In the Deploy dialog box, perform the following steps:

a. Click the arrow in the Project box to choose the project whose control file youwant to deploy.

b. In the Server URL box, type the URL of the data exchange server.

c. In the Target directory box, type the directory of the datastore locationwhere the deployed files are to be placed.

d. In the User ID box, type the ID of the authorized user on the server.

e. In the Password box, type the password for the authorized user on the server.

f. Click Finish.



Advanced tasks using the Mapping Designer

Add a child factor

You can add a factor as a child of another factor. This process is similar to addinga new factor.


1. Right-click an existing factor and choose Add New Child Factor.

2. When you add source and target elements, note that the parent factor’s elementsare shown. You can add or remove elements as needed.

Clone a factor

You can clone a factor and make changes to it to reuse it in a project. To clone afactor, right-click the factor and choose Clone Factor.


2. In the Factors view, right-click the factor you want to clone and choose CloneFactor.

The Clone a Factor wizard runs.

3. In the New Name box of the Clone dialog box, type a name for the cloned factor.

4. Click Finish.

The cloned factor appears in the project.

5. If the original factor has dependencies on other factors, make the samedependencies for the clone factor.

To view the dependencies on a factor, click the Dependency tab in the FactorDetails view. To add dependencies, click the Add button on the Dependency tab.

For directions about how to create dependencies, see Add a factor dependency.

6. To save the cloned factor, choose File®Save All.

Import a factor

If a factor is created outside of your project, you can import it into your project.Right-click the project and choose Import Factor.

You can also import a factor from within the same project and give it a new name.This works the same as using the Clone Factor command.

Caution The source and target schemas used by the imported factor must bethe same as those as used by your project. If there are elements inthe imported factor that are not present in your project’s schema, theimported factor will not load properly.




2. In the Factors view, right-click the project into which you want to import thefactor and choose Import Factor.The Import Factor wizard runs.

3. In the Import Factor dialog box, click the Browse button to the right of theFactor Location box.

4. Locate the folder containing the factor and click OK.

5. In the New Factor Name box, type a new name to change the name of theimported factor.

6. Click Finish.

The factor is placed into the project.

If you want to add elements to the factor, right-click the factor and choose ModifySource Element/Properties or Modify Target Element/Properties. To map elementsin the factor, right-click the factor and choose Open Factor.For more information, see Modify factor source elements and properties and Modifyfactor target elements and properties.

Search for factorsIf you are working with projects that have a number of factors, you can use theFactors Search view to find factors.

For more information about the view, see Factors Search view.


2. In the lower right of the perspective, click the Factors Search View tab to accessthe Factors Search view.

3. Click the Search button on the view toolbar.

The Advanced Factor Search wizard runs.

4. Perform the following steps in the Advanced Factor Search dialog box:

a. Click the arrow in the Project box to select the project in which to search.An asterisk * searches all projects.

b. In the Factor Name box, type the name of the factor you want to find.

c. In the Factor Desc box, type the description of the factor.

d. Click the Browse button to the right of the Source Element box to choosethe source system data model element to search for.

e. Click the Browse button to the right of the Target Element box to choose thetarget system data model element to search for.



f. Click the Browse button to the right of the Depends On box to choose thefactor it depends on.

g. Click the Browse button to the right of the Used By box to choose the factorit is used by.

h. Click OK.

The matching factors appear in the view.

Delete a factor

You can delete a factor by right-clicking it and choosing Delete Factor.1. Open the Mapping Designer perspective if it is not already active. Choose

Window®Open Perspective®Other®Mapping Designer.

2. In the Factors view, right-click the factor you want to delete and choose DeleteFactor.The Confirm Delete Factor Action dialog box is displayed.

3. Click OK.

The factor is removed from the project.

Note However, if other factors are dependent on this factor, the factor is notdeleted. A message states the names of the factors that are dependenton the factor to be deleted. To remove the dependencies:

a. Open each of the other factors.

b. In the Factor Details view, click the Dependency tab.

c. Select the factor in the Depends On pane and click the Removebutton.

After the dependency is removed from all the other factors, you can again right-clickthe factor and choose Delete Factor.

Add a factor dependency

Factors can depend on one another for mappings. To see the dependencies for afactor, look at the Dependency tab in the Factor Details view.


2. In the Factors view, select the factor for which you want to create dependencies.

3. In the Factor Details view at the bottom of the window, select the Dependencytab.

4. Click the Add button to the right of the Depends On pane.

(The Used By pane shows the factors that are dependent on this factor.)



5. In the Factor Selection dialog box, select the factor you want to add and click OK.

The dependent factor is displayed in the Depends On pane.

Modify factor source elements and propertiesWhen you create a factor, you select the attributes from the source system that youwant mapped. You can go back later and add more attributes by right-clicking thefactor and choosing Modify Source Element/Properties.

For directions about how to create a factor, see Add a factor.


2. In the Factors view, right-click the factor you want to modify and Modify SourceElement/Properties.

The Modify Source Elements wizard runs.

3. In the Factor: Modify source elements dialog box, perform the following stepsto choose the data model elements to map from the source system.



c. In the Element Selection Page dialog box, choose a data model element fromthe source system that you want to map.

For example, if the project is set up for mapping from Teamcenter Enterpriseto Teamcenter, the list displays Teamcenter Enterprise data elements. Selectan element in the source system you want to map.

Click Next.

d. In the Property Selection Page dialog box, select the properties (attributes)on this element that you want to map.

Click Finish.

The source element and its properties appear in the Factor: Modify sourceelements dialog box.

e. Continue to add source elements and properties. When done, click Finish.

4. After you change the elements and properties on a factor, you must adjustfiltering rules to accommodate the changes. Select the factor, and in the FactorDetails view, click the Filtering Rules tab.

For directions about how to create filtering rules, see Create filtering rules.

5. After changing elements and properties in the factor, you must adjust themapping between the source and target elements to account for the changes.Open the factor and draw connections between the source and target factor nodes.

For directions about how to create a mapping, see Create a map.

6. To save the changes to the factor and the mapping, choose File®Save All.



Modify factor target elements and properties

When you create a factor, you select the attributes from the target system that youwant mapped. You can go back later and add more attributes by right-clicking thefactor and choosing Modify Target Element/Properties.

For directions about how to create a factor, see Add a factor.


2. In the Factors view, right-click the factor you want to modify and choose ModifyTarget Element/Properties.

The Modify Target Elements wizard runs.

3. In the Factor: Modify target elements dialog box, perform the following steps tochoose the data model elements to map to in the target system:



c. In the Element Selection Page dialog box, choose a data model element inthe target system that you want to map to.

For example, if the project is set up for mapping from Teamcenter Enterpriseto Teamcenter, the list displays Teamcenter data elements. Select anelement in the target system you want to map to.

Click Next.

d. In the Property Selection Page dialog box, select the properties (attributes)on this element that you want to map to.

Click Finish.

The target element and its properties appear in the Factor: Modify targetelements dialog box.

e. Continue to add target elements and properties. When done, click Finish.

4. After you change the elements and properties on a factor, you must adjustfiltering rules to accommodate the changes. Select the factor, and in the FactorDetails view, click the Filtering Rules tab.

For directions about how to create filtering rules, see Create filtering rules.

5. After changing elements and properties in the factor, you must adjust themapping between the source and target elements to account for the changes.Open the factor and draw connections between the source and target factor nodes.

For directions about how to create a mapping, see Create a map.

6. To save the changes to the factor and the mapping, choose File®Save All.



Find Teamcenter property characteristics

Occasionally, you may need to look up the characteristics of properties (attributes)in Teamcenter that you want to map. You can use the Business Modeler IDE tolook up this information.

In the Standard perspective of the Business Modeler IDE, go to the BusinessObjects folder, open the business object with the properties you want to examine,and click the Properties tab. The properties display in a properties table. The tablelists information such as the storage type, whether the property is inherited, andthe business object where it originates.

Sometimes you need a little more information, like the values for properties. Youstill can use the Business Modeler IDE. The following is an example.

A person needs to map one kind of dataset to another, and when he creates the map,he discovers he needs to find out values for the reference names (ref_names) andreference types (ref_types) properties on the dataset. He knows that the referencename value is the name for the kind of dataset, such as word for an MSWorddocument, and so on. He also knows that the reference type value defines whetherthe dataset file is text, which has a value of 1, or binary, which has a value of 2.But for a particular dataset, how does he find the values for the ref_names andref_types properties? He uses the References tab on the dataset in the BusinessModeler IDE.

1. In the BMIDE view, click the Find button and look up the dataset.

2. Right-click the dataset and choose Open.

3. Click the References tab.

4. Locate the values on the References table.

The ref_names property can equal any value in the Reference column that hasa value of BINARY or TEXT.

The ref_types property equals 1 if the format is TEXT or 2 if the format isBINARY.

The Business Modeler IDE contains a wealth of information about business objectsand their properties. If you ever have questions about how the Teamcenter schemais organized, look first to the Business Modeler IDE.

Create a lookup table

The lookup feature in Mapping Designer allows you to transform an input value toan output value using a lookup table. Lookup tables can be used on factors andinherited by child factors, avoiding having to create separate lookups for use oneach child factor.

Suppose you want to look up the user names associated with employee personalidentification (PID) numbers, because in one system personnel are identified bytheir ID numbers, and in another system they are known by a user name. Youcan place a lookup table between the two systems to map the user value in onesystem to the other. Following is an example using this scenario. This is known anassociation-based lookup.



1. In the Project Explorer view, create a comma-separated (CSV) file with a .csvextension that contains the values to be used in the lookup, for example,personnel.csv.

Each row in the comma-separated value (CSV) file represents one key/valueentry. The first row contains metadata defining the name of the columns.

Creating a comma-separated value (CSV) file

2. Create the lookup table index declarations.

In this step, you create an in-factor lookup that will be used later in theassociation-based lookup. An in-factor lookup is not applied to the full outputdocument, but is applied to the output of this factor only. It is also more powerfulthan an association lookup because it can be conditioned using MapForce logicand can handle multiple inputs and outputs.

a. In the Factors view, right-click the project and choose Table Definition Editor.

b. Click the Add an Index button and in the Index Name box typea name for the index.

An index matches a logical name with the physical CSV lookup file and alsodeclares which of the columns in the CSV lookup file are treated as keys andwhich are treated as values.

c. In the CSV File Name box, type the name of the comma-separated valuefile that holds the keys and values.

d. In the Keys box, type the names of the keys from the CSV file. Any columncan be used as a key or a value. The purpose of this index is to declarewhich of the columns in the lookup file are treated as keys and which aretreated as values.

e. In the Values box, type the names of the values from the CSV file in theValue Name column.

In the Default Value column, type the value to use if no value is found duringa lookup.



Creating an index

f. Click the Add an Association button to associate a property namewith the index.

An association references the index for a simple lookup (single key/valuepair) that is applied for all instances of a given property on a given class.In the following example, the simple index is specified to supply the valuelookup for the ref_names property on the MISC class.

Creating an association

3. Choose File®Save All.



The lookup table appears in the Project Explorer view as the tabledef.tdf file.

4. In the Factors view, right-click the project and choose Build Control File.

The lookup functions file is generated as project-name-lookupfunctions.xslt inthe Project Explorer view. The following figure shows the .csv file, the tabledefinition file, and the lookup functions file.

Lookup definition files

5. In the Factors view, open a factor to which you want to add the lookup table. Thefactor map appears in the view to the right.

6. Click the Libraries tab to see the libraries for that map. Click the Add/RemoveLibraries button at the bottom of the Libraries view, and in the Librariesdialog box, select the project-name-lookupfunctions.xslt file and thecommonFunctions.mfd file from the workspace.

The lookup functions file is added to the list of libraries. Under it are shownthe lookup definitions.



Lookup function file added to the factor’s libraries

7. Drag a lookup definition from the Libraries view to the map in the view to theright. Then hook up the properties from the source map to the target map usingthe lookup table.

Lookup table in a map

Import the sample Mapping Designer projects

Your Teamcenter installation source includes sample projects that map fromTeamcenter Enterprise to Teamcenter, and Teamcenter to Teamcenter Enterprise.You can import these projects to your workspace to serve as the basis for your ownmappings.

These sample projects contain the mappings for COTS data model in TeamcenterEnterprise and Teamcenter. COTS means commercial-off-the-shelf and is anotherway of saying out-of-the-box. You can add mappings for your custom data model tothese COTS mappings.



Note Rather than using an entire sample project, you could import factors from asample project.

For more information, see Import a factor.

This procedure describes how to import the sample Teamcenter Enterprise andTeamcenter mapping projects.

1. Browse to the TC_ROOT\TC_DATA\mapping_designer_projects directoryon a Teamcenter server installation. Locate the following directories (see theReadme.txt files under each directory for more information):

• ADA

Contains ADA License mapping projects.

• Catia

Maps Teamcenter Enterprise and Teamcenter to CATIA integrations.

• Foundation

Maps Teamcenter Enterprise to Teamcenter.

• Ideas_NX

Maps Teamcenter Enterprise and Teamcenter to the I-deas NX Integration.

• interspec_to_teamcenter

Maps the Interspec specification authoring tool to Teamcenter.

• MRO_Teamcenter_to_TC_Enterprise

Maps Teamcenter maintenance, repair, and overhaul to TeamcenterEnterprise.

• ProE

Maps Teamcenter Enterprise and Teamcenter to Pro/ENGINEERintegrations.

• tc2tc2

Maps Teamcenter to Teamcenter, but filters out I-deas data to prevent itfrom being placed on the receiving site.

• TC_Enterprise_to_Teamcenter_absocc

Maps Teamcenter Enterprise to Teamcenter including absolute occurrences.

• TeamcenterToTeamcenter

Maps Teamcenter to Teamcenter.

You can also extract the projects from the Teamcenter installation source.Navigate to the tc directory, open the data.zip file, and extract the files in thedata\mapping_designer_projects path.



Note You can perform mapping of Teamcenter Systems Engineering toTeamcenter using the example in the TC_DATA\tcse_migrationdirectory.


3. Choose File®Import on the menu bar.

4. In the Import dialog box, choose Mapping Designer®Import Mapping DesignerProject. Click Next.The Import Mapping Designer Project dialog box appears.

5. Leave the Copy project to workspace check box unselected if you want to usethe project directly from its original location, or select the check box if you wantto copy the project files into your workspace directory.

6. Click the Browse button to the right of the Project contents box and browse tothe directory where the projects are located.

For example, choose the TC_Enterprise_to_Teamcenter directory if you wantto map from Teamcenter Enterprise to Teamcenter.

7. Click OK.

8. Choose Finish.

The project is imported and appears in the Factors view.

9. Make the imported project files writable:

a. Locate the imported project.

For example, if you copied the project files into your workspace, chooseFile®Switch Workspace to find the workspace location. On Windowssystems, the default workspace for the Business Modeler IDE is atinstall-location\bmide\workspace.

b. Change the file attributes so that the files are writable.

For example, if you are using a Windows system, in Windows Explorer,right-click the project folder, choose Properties, and in the Attributes paneon the General tab, clear the Read-only check box.

Caution To use the imported project without errors, you must make the filesin the imported project writable.

Add your mappings to a sample projectYou can add mappings for your custom data model to the COTS mappings in thesample projects.

1. Rename the sample project by right-clicking the project in the Project Explorerview and choosing Rename.

2. Apply your schema to the project:



a. Right-click the project in the Project Explorer view and choose Properties.

b. In the left pane of the Properties dialog box, choose Mapping Designer.

c. To change the source schema to your own system’s schema, click the Browsebutton to the right of the Select Source Schema box.

Warning The new source schema must be from the same software versionas the old one. For example, if the source schema being replacedis from Teamcenter Enterprise 2007, the new source schemamust be based on Teamcenter Enterprise 2007.

d. To change the target schema to your own system’s schema, click the Browsebutton to the right of the Select Target Schema box.

Warning The new target schema must be from the same software versionas the old one. For example, if the target schema being replacedis from Teamcenter 10.1, the new target schema must be basedon Teamcenter 10.1.

e. Click OK.

For more information about changing project properties, see ChangeMapping Designer project properties.

3. Change existing mappings and add your own:

a. Alter the mappings in the existing factors to fit your company’s policies:

• To change mappings, right-click a factor in the Factors view, chooseOpen Factor, and drag from the points on the source schema box to thetarget schema box. You can also delete a map line by right-clicking it.

• To change the elements in the factor, right-click the factor in the Factorsview and choose Modify Source Element/Properties or Modify TargetElement/Properties.

For more information, see Modify factor source elements and propertiesand Modify factor target elements and properties.

• To delete a factor, right-click it in the Project Explorer view and chooseDelete.

For more information, see Delete a factor.

b. Create your own factors.


c. Create your own mappings for your new factors.


d. Create filter rules for your own factors.


e. Create a control file for the project.




Change Mapping Designer project propertiesYou can change properties on mapping designer projects, including the source andtarget schema for the project.

1. Right-click the project in the Project Explorer view and choose Properties.

2. In the left pane of the Properties dialog box, choose Teamcenter®MappingDesigner.

3. To change the source schema, click the Browse button to the right of the SelectSource Schema box.

Warning The new source schema must be from the same software version asthe old one. For example, if the source schema being replaced is fromTeamcenter Enterprise 2007, the new source schema must be basedon Teamcenter Enterprise 2007.

4. To change the target schema, click the Browse button to the right of the SelectTarget Schema box.

Warning The new target schema must be from the same software versionas the old one. For example, if the target schema being replacedis from Teamcenter 10.1, the new target schema must be based onTeamcenter 10.1.

5. To change the explanation of the project’s purpose, type in the ProjectDescription box.

6. To allow transfer of all the data model, not only the mapped data model, selectthe Copy Unmapped Objects check box.

If you select this option, the copyUnmapped flag is set to true in the controlfile, and the Mapper Engine takes all the input elements that didn’t get mappedand copies them over to the output file. This is very useful for Teamcenter toTeamcenter mappings where data is being pushed from one Teamcenter siteto another where the schemas have minor differences, so there are minimalmappings and the rest of the data needs to be copied as-is.

Mapping Designer perspectives and views

Introduction to Mapping Designer perspectives and viewsThe Mapping Designer utilizes the Eclipse user interface, which is composed ofperspectives, views, and editors. A view is a tabbed window within the user interfacethat provides a view of data. A perspective is an arrangement of views. An editor isa window that allows you to edit source files.

Each perspective is divided into windows, and each window may contain multipleviews and editors. If a window contains more than one view, the views are stackedwith tabs. The Window menu allows you to open new views and perspectives and tomove between ones already open.



The Mapping Designer provides its own perspective, several views, and also usessome Eclipse views. Only the perspectives and views provided by the MappingDesigner are documented here. The Eclipse user interface is fully documented in theWorkbench User Guide, accessible by choosing Help®Help Contents.

Mapping Designer perspectiveThe Mapping Designer perspective allows you to map data model from onePLM system to another (for example, Teamcenter Enterprise to Teamcenter, orTeamcenter to Teamcenter Enterprise).

To access the Mapping Designer perspective, choose Window®OpenPerspective®Other®Mapping Designer.

Mapping Designer views

Factors view

The Factors view displays the available factors. A factor is a list of data modelelements that you want to map between the source system and the target system.

Yellow underlining of a factor indicates it is a work-in-progress (WIP), while greenindicates that a child of a WIP factor is not in-progress. To set WIP for a factor, usethe Factor WIP and Parent Factor WIP check boxes in the Factor Details view.

The following is a list of actions you can perform from the shortcut menu when youright-click in the Factors view.

Menu command DescriptionAdd New Factor or Add NewChild Factor

Adds a new list of source and target data modelelements to the selected project.


Open Factor Opens the selected factor, and displays the sourceand target data model elements in a MapForceeditor so you can create a map.


Delete Factor Removes the selected factor.


Modify SourceElement/Properties

Changes source system data model elements on theselected factor.

For more information, see Modify factor sourceelements and properties.

Modify TargetElement/Properties

Changes target system data model elements on theselected factor.

For more information, see Modify factor targetelements and properties.

Import Factor Loads a factor to the selected project.

For more information, see Import a factor.



Menu command Description

Build Control File Creates a mapping control file for the selectedproject.


Deploy Control File Deploys the control file to a data exchange server.


Clone Factor Copies the factor for reuse in the project.

For more information, see Clone a factor.

Properties Changes the properties of the Mapping Designerproject.

For more information, see Change MappingDesigner project properties.

Factor Details view

The Factor Details view displays additional factor information, including filteringrules. Filtering rules filter out the instances that must be processed and appliesthe transformation only to those objects.

The Factor Details view has the following tabs:

• GeneralDisplays the properties of the factor.

o NameDisplays the name of the factor.

o DescriptionShows the description of the factor.

o Source End PointShows the source schema of the factor.

o Target End PointShows the target schema of the factor.

o Parent FactorIdentifies the name of the parent factor, if any.

o Factor WIPSpecifies that the factor is a work-in-progress. Use this check box to showthat the factor is unfinished.

o Parent Factor WIPSpecifies that the parent of the factor is a work-in-progress.



• Filtering Rules

Displays the rules for processing the mapping in the factor.


• Dependency

Displays the factor’s dependencies.

For more information, see Add a factor dependency.

Factors Search view

The Factors Search view enables you to find factors in projects. Click the Searchbutton on the view toolbar to launch the Advanced Factor Search wizard.

For more information, see Search for factors.

The following is a list of actions you can perform from the shortcut menu when youright-click in the Factors Search view:

Menu command Description

Open Factor Opens the selected factor, and displays the sourceand target data model elements in a MapForceeditor so you can create a map.


Delete Factor Removes the selected factor.


Modify SourceElement/Properties

Changes source system data model elements on theselected factor.

For more information, see Modify factor sourceelements and properties.

Modify TargetElement/Properties

Changes target system data model elements on theselected factor.

For more information, see Modify factor targetelements and properties.

Properties Changes the properties of the Mapping Designerproject.

For more information, see Change MappingDesigner project properties.

Eclipse views used by the Mapping Designer

Console view in the Mapping Designer

The Mapping Designer is built on an Eclipse framework. Some default Eclipseviews that are used for Mapping Designer functions. Views are the tabbed panesthat appear in the user interface.



The Console view is a default Eclipse view used to display output from loading andbuilding your projects. Watch this window for any problems or errors.

For more documentation on Eclipse views, see the Workbench User Guide accessibleby choosing Help®Help Contents.

Editors in the Mapping Designer

Editors are used to display model elements. Each editor that is opened is stackedwith tabs on top of the existing editor.

The MapForce editor displays factors, and is used to create mappings. To open afactor in this editor, right-click a factor in the Factors view and choose Open.

Warning Do not edit data model source files manually. All data model changesshould be made using the wizards provided by the Mapping Designer.

Project Explorer view in the Mapping Designer

The Project Explorer view is a default Eclipse view used for browsing file systemobjects. The Project Explorer view displays the files in the project workspace.

The Project Explorer view always shows the projects at the top level and any foldersand files under them. For example, if you have a project, expand the project in theProject Explorer view and note the files it contains. You can open files in an editorby double-clicking them, or right-click and choose Open.

The files include MapForce map files (.mfd), schema files (.xsd), and transformationfiles ( .xslt).


Chapter

8 Verifying and troubleshootingthe transfer configuration

Verifying and troubleshooting the transfer configuration . . . . . . . . . . . . . . . . 8-1Verify FMS configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1Verify transfer from Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1Verify transfer from Teamcenter Enterprise . . . . . . . . . . . . . . . . . . . . . . 8-2Troubleshooting transfer errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2

Transfer process diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4Determine transfer activity status . . . . . . . . . . . . . . . . . . . . . . . . 8-7Using the log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8


Chapter

8 Verifying and troubleshootingthe transfer configuration

Verifying and troubleshooting the transfer configurationAfter you complete the installation and configuration steps, you should verify thesetup by performing a transfer from each site to each other site participating in youData Exchange environment.

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 ./statusFSC id: FSC_TcEntHost, site:TcEntHostrunning for 3 days, 17 hours, 3 min, 46 secCurrent number of file connections: 0Current number of admin connections: 1fscadmin -s http://cvg101:4001 -k=FMS.key ./statusFSC id: FSC_TcHost1, site:CVG101running for 0 days, 7 hours, 5 min, 16 secCurrent number of file connections: 0Current number of admin connections: 1fscadmin -s http://cvg102:4001 -k=FMS.key ./statusFSC id: FSC_TcHost2, site:CVG102running for 0 days, 5 hours, 7 min, 51 secCurrent number of file connections: 0Current number of admin connections: 1

2. If an FSC for a site is not running, check the FMS configuration using thefscadmin 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 GS→To Remote SiteVia Global Services.

4. In the Remote Export to GS Site dialog box, if the default site is not the desired

destination, click the select target site button . In the Select Target Sitedialog box, select the site listed in the Selected GS Sites list and click move


Chapter 8 Verifying and troubleshooting the transfer configuration

left , select the destination site from the Available GS Sites list, click moveright , and click OK.

5. In the Remote Export to GS Site dialog box, select the Immediate check boxand click OK.

Verify transfer from Teamcenter Enterprise

To verify the configuration of an Teamcenter Enterprise Data Exchange site, use thethin client to transfer a replica to a Teamcenter Data Exchange site.

1. Log on to your Teamcenter Enterprise thin client as a user with Data Exchangeexport privileges.

2. Search for or create an item to transfer.

3. Select the item and choose More Actions→Remote Export.

4. In the Remote Export Options pane, select the check box for each item that youwant to transfer and click OK.

5. Select the destination site from the Site list and the desired transfer optionset from the Transfer Option Set list.

6. Select the Immediate and Continue On Error check boxes and click Finish.

The thin client displays a message indicating the export was successful.

Troubleshooting transfer errors

The following figure shows the transfer flow from Teamcenter Enterprise toTeamcenter for a remote import action. You can use this diagram and the supportinginformation to determine where the process has failed and what steps you shouldtake to attempt to resolve the error. Following the diagram are descriptions for eachstep in the process which contain information you can use to determine whether theprocess has completed that step successfully or not.

A diagram showing the transfer of data from Teamcenter to Teamcenter Enterprisewould closely mirror the sequence of events in this diagram. Alternatively, thetransfer can be initiated by an export (push) rather than an import (pull) as shownin the figure. The import process requires finding the remote object to pull. This canbe done through search of published objects on the ODS server. From TeamcenterEnterprise, this is typically performed from the thin client. The main differenceis the client that calls Global Services. The Global Services engine is neutral; itexecutes a business process execution language (BPEL) process for data transferthat contains a set of steps or activities.


Verifying and troubleshooting the transfer configuration

The transfer process flow provides a description, with a list of diagnostic stepsincluding Global Services BPEL activity, for each step in the process shown in thefigure. You can view Global Services activity status in the Global Services Audit -Activity status table or in the Global Services log file. A Global Services activity canhave the following statuses with corresponding details column data:

Null Activity is not yet started or inactive.

In Progress Activity has started. Details indicates Active.

Waiting An error occurred during the activity. The process is waitingfor a manual retry. After resolving the error condition, theuser must use the Resume button on the Detailed TransferStatus dialog box to start the retry. For more information, seeProgress monitoring.

Complete Activity has finished. Details indicates Succeeded or Failed.

Aborted The transfer was aborted by a user prior to or during theactivity.

Common activity IDs are:

• Scheduling• Data Export• Data Import• Data Mapping• Notification

Note If you are using the CATIA integration and encounter a failure whentransferring assemblies with CAD data, ensure that you have the followingproperty set clause in the transfer mode you use to transfer the assemblies:

CLASS.POM_catia_absocc:ATTRIBUTE.IsContext:DO

For information about property set clauses, see the PLM XML/TC XMLExport Import Administration Guide.



Transfer process diagnostics

1. A user initiates a transfer from the remote import function of the rich client by:

a. Selecting the item to export.

b. Setting the transfer options.

c. Selecting the destination site.

d. Clicking OK.

No Global Services activity is displayed at this point.

2. Teamcenter sends a request for objects.

a. Teamcenter sends a SOAP message to Global Services requesting the objectsfrom Teamcenter Enterprise.

No Global Services activity displayed at this point.

Diagnostic action

• Check the Teamcenter server syslog file to see if the SOAP messagewas created.

Location: By default, C:\temp.

Name: tcserver<nnnnnnnn>.syslog

Information: Search for a sig 11 or sig 22 error which indicatesthe SOAP message was not created.

• Check the Global Services transaction table to confirm the SOAPmessage was received.

• Check the Global Services log for errors.

• Check the rich client for error messages.

Location: By default, %Temp%

Name: <user>_session<nnnnnnnn>.log

b. The Global Services BPEL process creates a request object.

Global Servicesactivity:

Scheduling.

The Status column indicates the activity is InProgress if it is scheduled for off hours; otherwise thestatus is Complete.

Diagnostic action

• Start progress monitoring by selecting the Show progress indicatorcheck box in the import or export dialog box. Global Services displaysthe Audit - Activity Status table in the default Web browser when theprocess starts.

If you suspect a Global Services failure, you can check the GlobalServices application log file for error information. To access this log file:



A. Log on to Global Services as an administrator(GlobalServicesAdmin by default)

B. Click the Tools link at the bottom of the portal.

C. Click View default log file on the Logging pane.

c. Global Services passes the request to the remote Teamcenter site through aSOAP message.


Data Export.

The Status column indicates In Progress

Diagnostic action

• Check the Global Services transaction table to ensure the message wassent.

• Ensure the SOAP message contains the transfer formula and transferoption set.

• Check the remote Teamcenter syslog to ensure the request message wasreceived and the export started.


3. The remote Teamcenter scoper generates the TC XML file.


Data Export.

The Status column indicates the activity is In Progress.

Diagnostic action

• Check the remote Teamcenter syslog for errors.

4. The data exporter outputs the file to the remote Teamcenter FMS transferlocation.


Data Export.


Diagnostic action

• Check for the TC XML file in the FMS transfer location.

• Check the remote Teamcenter site syslog for errors.

• Check the FMS log for errors.

5. FMS 2 generates an FMS read ticket and the remote Teamcenter site passes it toGlobal Services with notification of the completed export.


Data Export.

The Status indicates the activity is Complete.



Diagnostic action

• Check the Global Services transaction table to ensure the ticket arrived.


6. The XML data file is transferred to Global Services for access by the data mapper.


Data Mapping.

The Status indicates the activity is In Progress.

Diagnostic action

• Check for a temporary file in the Global Services transfer directory.

7. Data mapper maps data using the map control file (MCF) to TC XML formatfor the importing site.


Data Mapping.


Diagnostic action

• Check data mapper log for errors.


8. Global Services transfers the TC XML data to the FMS transient volume.


Data Mapping.

The Status column indicates the activity is Complete.

Diagnostic action

• Check for FMS transfer.

9. Global Services notifies Teamcenter that mapping is complete, and FMS 1provides a ticket to transfer the data.


Data Import.


Diagnostic action


10. FMS 1 transfers the TC XML file to Teamcenter


Data Import.


11. The Teamcenter data importer parses the TC XML file and creates the metadatain the database.


Data Import.




Diagnostic action

• Check the Teamcenter syslog file for errors.

12. FMS 2 (Teamcenter Enterprise) transfers the bulk data files to the Teamcentervolume.


Data Import.


Diagnostic action

• Check the FMS log for errors.

13. Data is imported (not shown in the figure).


Confirm Export.


Diagnostic action

• Check Teamcenter and verify the parts are imported successfully.

• Check the remote Teamcenter site and verify export records are created forthe objects.

Determine transfer activity status

You can use the Global Services log files to get information about a transfer, and youcan use the Global Services activity status table information to help you locateinformation about a transfer. You use the standard activity status business objectdefinition (BOD) in Global Services to help you track the transfer process. You canuse the BOD to search for and display activity status information in the GlobalServices user interface.

This procedure is based on using an activity status business object definition.

1. Log on to your Global Services application as the Global Services administrator(GlobalServicesAdmin by default) and ensure the activity status BOD is inthe BOS location in the datastore.

For information about uploading BOD files into the datastore, see the GlobalServices Configuration Guide.

2. In the Global Services Data View pane, click Activity Status.

3. In the Search Activity Status pane, type the percent character (%) in the ResultID box and select 1 in the associated Priority list.

4. Type Sched% in the Activity ID box, select Descending in the Sort Order list,and click Continue.

Global Services displays a table containing a row for each transfer activity.

5. Locate the failed Result ID and record the last six digits (includes a dashbetween the digits). For example, in the following result ID, the last six digitsare 229–884.



11877229677229–884

These digits provide enough information to uniquely identify the transferactivity.

6. Select and copy the content in the Additional Info column for the record.

This information indicates the action and options for this activity, which helpsyou understand the process.

7. Click the browser back button to return the Search Activity Status pane.

8. Enter the six digits, including the dash, you recorded in the Result ID box, clearany text from the Activity ID box, and click Continue.

Global Services displays a table containing a row for each step in the failedtransfer process.

9. Determine the step that has failed and record its time stamp. This time stampcan be used to locate information about the failure in the Global Services log files.

Using the log files

Teamcenter logs transaction messages to log files stored within the applicationserver directory structure. A comprehensive log file (WebTier.log) is written to thelogs\WebTier\process directory under the application server home directory.This file contains information for all Teamcenter activity that occurs within anapplications server domain, including Global Services activity. Also, Global Servicesstores default log files in the teamcenter\logs\GlobalServicesInstance\processdirectory. The default log files content is limited to Global Services message activityand is determined by the Global Services exception message log configuration file.For more information about the log file, see the Global Services Configuration Guide.

To troubleshoot a failure, open the WebTier.log file. The log file location dependson the application server you are using. For example:

• JBossjboss-4.0.5GAbin\logs\WebTier\process\WebTier.log

• WebLogicbea\user_projects\domains\teamcenter\logs\WebTier\process\WebTier.log

• WebSphereIBM\WebSphere\AppServer\profiles\AppSrv01\logs\WebTier\process\WebTier.log

• Oracle application serveroracle\10.1.3\OracleAS\j2ee\home\logs\WebTier\process\WebTier.log

Search for the time stamp for the failed step in the transfer process. Investigate theerror messages in this vicinity.

Download the Global Services default log file

You can use the Global Services portal to download a default log file copy that youcan view and search with any text editor. By default, rolling appenders are used to



name these log files. These log files contain less information than the WebTier.logfile as it contains only the Global Services specific messages.

1. In the Global Services interface, click Tools.

2. In the Message Server pane, click View default log file and save the file.


Part

III Data sharing

Using Data Exchange from Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

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

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

Data Exchange performance tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

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

Teamcenter core data dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-1

Teamcenter data model diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-1

Sample assembly structure in a TC XML file . . . . . . . . . . . . . . . . . . . . . . . . . G-1

Sample TC XML file with GSID references . . . . . . . . . . . . . . . . . . . . . . . . . . H-1

Sample bulk load repeat file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . I-1

Frequently asked questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . J-1

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . K-1


Chapter

9 Using Data Exchange fromTeamcenter

Using Data Exchange from Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1Export from Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1Exporting a configured bill of materials (BOM) . . . . . . . . . . . . . . . . . . . . 9-4

Exporting a BOM without variant rules . . . . . . . . . . . . . . . . . . . . . . 9-6Delta export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6Synchronize changes for a specific BOM configuration . . . . . . . . . . . . 9-7Export a configured bill of materials to a briefcase file (with Global

Services) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8Export a bill of materials to a briefcase file (without Global Services) . . 9-8

Using site checkout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-9Check out to a site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10

Cancel checkout to a site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10Import to Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11Check in from a site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11Check replica synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12Export to SRM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12


Controlling transfer activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13Abort a transfer activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13Resume a transfer activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13

Working with remote objects using ODS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13Publish to default ODS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13Publish to the publication list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-14Unpublish ODS objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-14Search (ODS) for remote items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-15

Transferring a briefcase package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-16Package the data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-16Transfer the package file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-18Import the package file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-18

Working with unmanaged site briefcase files . . . . . . . . . . . . . . . . . . . . . . . . . 9-19Export a configured briefcase file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-19Import validation results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-22Import a configured briefcase file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-22

Working with PDX data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-23


Export a PDX package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-23Access a PDX package from a workflow . . . . . . . . . . . . . . . . . . . . . . . . . . 9-24Query for a PDX package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-24Delete a PDX package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-24Download a PDX package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-24

Process for bulk loading Teamcenter data . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-24Island of data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-26Enable bulk loader utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-27TC XML format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-27TC XML file with GSID references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-32TC XML file with POM_stub elements . . . . . . . . . . . . . . . . . . . . . . . . . . 9-34Bulk loader utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-35

Create, update, and infer-delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-37Pre-import validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-38

Required schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-39Required helper objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-39Validate your TC XML test files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-40Pre-import validation logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-40

Mapping configured BOM export files . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-41


Chapter

9 Using Data Exchange fromTeamcenter

Using Data Exchange from TeamcenterTeamcenter Data Exchange uses some menu commands that Multi-SiteCollaboration uses. The configuration and destination determine whether DataExchange or Multi-Site Collaboration performs the action.

For information about using Data Exchange from Teamcenter Enterprise, see theTransition Guide.

Note When exporting a Pro/ENGINEER/PTC Creo assembly or part that containsa family table instance, you must export all associated family table instancesprior to exporting the assembly. Otherwise, the remote Teamcenter site doesnot include any nested family table instances for the part.

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

Export from Teamcenter

To export local data to a remote site using Global Services, theGMS_offline_use_TcGS preference must be set to TRUE. This is the defaultsetting.

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

2. Choose Tools→Export→To Remote Site Via Global Services.

3. In the Remote Export to Global Services dialog box, select a destination sitefrom the Site Selection list.

(Optional) Type a description in the Reason box. The reason text is stored forfuture reference.

Select the desired check boxes:


Chapter 9 Using Data Exchange from Teamcenter

Check box Description

Start immediatetransfer

Causes the transfer request to process immediately.By default, Data Exchange schedules transfer requestprocessing based on system load conditions. Youradministrator can disable this option.

Show progressindicator

Displays the progress monitor dialog box automaticallywhen the process starts.

Send E-mailnotification

Requests that Data Exchange send an e-mail when atransfer is complete to the address associated with therequesting 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 theselected option set.

If you are exporting a Requirements object, you must select the IncludeAll Files check box.

Item options DescriptionInclude AllRevisions

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

Latest RevisionOnly

Exports the latest revision regardless of whether it is aworking or released revision.

Latest WorkingRevision Only

Exports only the latest working (such as nonreleased)revision.

LatestWorking/AnyRelease Status

Exports the latest working revision, if any; if no workingrevision, the latest released revision with any releasestatus is exported.

Latest AnyRelease Status

Exports the latest released revision with any release status.

SelectedRevision(s) Only

Exports only the revisions selected in the workspace.

Caution If you use this option to export an assembly itmust contain precise parts only. If you attemptto export an assembly that contains impreciseparts, the export fails.

This option cannot be used to export anassembly that has global alternates orsubstitute components.

Specific ReleaseStatus Only

Exports only the latest revision with the specified releasestatus selected from the list.


Using Data Exchange from Teamcenter

Productstructureoptions DescriptionInclude EntireBOM

Includes all components if the item selected is an assembly.The revision selectors allow you choose which revision toexport with the selected item and its component items, ifapplicable. You can choose only one revision selector.

The TC_bom_level_export preference controls whetherthis option is available.

TransferTop-Level ItemOnly

Transfers the selected assembly item and export allcomponents with no site ownership transfer.

Dataset options DescriptionInclude AllVersions

Includes all dataset versions with each dataset selectedfor import or export. When this option is not set, includesonly the latest version of each dataset selected for importor export.

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

Save options Description

Save All OptionAs Default

Saves the options you select on the dialog box as the defaultoption settings.

Restore OptionSet Defaults

Replaces all options settings with the defaults settings.

Session options Description

TransferOwnership

Transfers site ownership to the target site. When the thisoption is not selected, your site retains ownership. If youtransfer an item revision with a sequence, its sequencemanager is also transferred. The TC_ownership_exportpreference controls the default value of this option. It isrecommended that you leave the default setting for thisoption to cleared.




Continue OnError

Allows the remote import or export objects operationto continue if errors are encountered whileimporting/exporting optional objects. All objects areconsidered optional except the following:

• Requirements

• Specifications

• Item Master

• Item Revision Master

This option is disabled if the Transfer Ownership optionis set.

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

Exporting a configured bill of materials (BOM)

The required input options are described in the following tables.

Transfer option DescriptionDefaultvalue

opt_exp_cfgbom Starts the configured BOM export andcontrols the traversal flow to preventthe export of persistent objects relatedto lines that are configured out.

False

opt_rt_only Controls whether the exported datacontains only runtime objects or bothruntime and related persistent objects.

False

opt_exp_cnf Exports the variant configuration datawhen the structure is configured byonly a revision rule (no variant rule isapplied). A structure configured thisway contains more lines than are foundin a realizable product (150 percentBOM).

For more information, see Exporting aBOM without variant rules.

False

opt_exp_persistentobj_only Blocks serialization of runtime objectsin the TC XML file. Configured exportand import using high level TC XML issupported only for versions 8.3.3 and9.1 and later. Serialization of runtimeobjects must be turned off for priorversions of Teamcenter.

False



Session option Description

revRule Indicates the name of the revision rule to use. If a configuredBOM export is started without this session option defined,the revision rule is read from the TC_config_rule_namepreference.

varRule Indicates the name of the saved variant rule or stored optionset. Supports classic, modular, and hybrid variants. Thevalues that Teamcenter displays for the variant rules aresaved in the database.

For information about saving a variant rule in the database,see the Structure Manager Guide.

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

Session option DescriptionDefaultvalue

processUnconfiguredByOccEff Controls export of the BOMLineobject configured out by occurrenceeffectivity.

False

processSuppressedOcc Controls export of suppressedBOMLines objects.

False

processUnconfiguredVariants Controls export of unconfiguredvariants.

False

processUnconfiguredChanges Controls export of BOMLineobjects configured out byincremental change.

False

Note For Teamcenter 9.1 and later, exporting incremental changes that areapplied in context of a sublevel is not supported. Changes must be done byselecting the topline context explicitly.



Note When synchronizing nonworkspace objects using high-level configured TCXML, Teamcenter exports full objects even when you select the modifiedobjects only option. You can use low-level TC XML configured export as analternative.

If you select the modified objects only option during an unconfigured export,Teamcenter determines the objects requiring synchronization based on thecorrect parents IXR, resulting in export of only the modified objects.

However, when there are no physical structure changes (for example, onlyeffectivity or revision rule changes,) both high-level and low-level TC XMLexport functions cannot identify the synchronization candidates, causingfull objects to be exported.

You can export a configured BOM from My Teamcenter as described in Export aconfigured bill of materials to a briefcase file (with Global Services) and Export abill of materials to a briefcase file (without Global Services). You can also export aconfigured BOM from a command line using the tcxml_export utility. You must bea user with administrator privileges to use the utility.

For information about this utility, see the Utilities Reference.

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 percentBOM. The exported TC XML file must contain enough information for the target siteto solve the variant conditions. To accomplish this, the TC XML file contains theconfiguration data stored in the following variant data model classes:

• VariantExpression

• VariantExpressionBlock

• ConfigurationCNF

• ConfigurationExprLiteral

• ConfigurationFamily

Legacy and classic variants are supported; modular and hybrid variants are notsupported. You must select the opt_exp_cnf transfer option (set to True) for thistype 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 regularbasis to provide the proper representation of a BOM in the data caches. Toaccomplish these updates efficiently, Data Exchange provides the ability to:

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

• Express a BOMLine object as a function of certain persistent Teamcenterobjects (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 thescratch 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 deltaexport contains all changes to all exported configured structures. No specific rootobject is used. To specify a root object, you must use the -inputfile or -inputduidfilearguments with the -sync argument.

The process for a delta export of a specific configuration is described in Synchronizechanges 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 yourcommand environment to a valid license value obtained from GTAC.

For information about the low-level fast export feature of this utility, see the UtilitiesReference.

Delta export for a specific BOM configuration requires a root object used toreconfigure 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

VRule1BOMWindow

• 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 sameconfiguration 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 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 anoffline site. A briefcase transfer can be performed with or without Global Servicesas 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, chooseTools→Export→To Briefcase.

2. In the Export To Briefcase Via Global Services dialog box, click the Selecttarget 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.

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

Teamcenter displays the TIEConfiguredExportDefault dialog box.

Select the desired export options.

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

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

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

• Select Send E-mail notification to have Teamcenter send an E-mail to youwhen the transfer is completed.

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

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

You can export a configured bill of materials (BOM) an offline site as a briefcase filewithout having Global Services installed. To transfer without Global Services, theGMS_offline_use_TcGS preference must be set to FALSE.




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

2. In the Export To Briefcase Via Global Services, click the Select target remotesite(s) button ( ) and select the site desired remote sites.

3. Select the TIEConfiguredExportDefault from the Options Set list.



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 thedesired file name in the Export File Name box.

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

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

Site checkout functionality is meant for collaboration between OEM and suppliers infollowing 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 revisionsis not supported.

You can perform site checkout on the following list of objects and their subclassesonly:

• Item• ItemRevision• PSBOMView• PSBOMViewRevision• Form

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

• New objects created at a supplier site that are part of an existing island fromthe 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 alsoowned by the OEM.

• New objects created at a supplier site that are part of a new island at suppliersite 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. Forexample, the following objects are part of an island.

• Item (primary object of an island)• ItemRevision• Dataset• Form• Relation• PSOccurrence

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

Check out to a site

1. In My Teamcenter, select one or more objects that you want to check out to a site.

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

3. In the Site CheckOut dialog box, type an identifier in the Change ID box andselect the desired remote site from the Target site list.

4. (Optional) Type information in the Comments box.

5. (Optional) Click to display the Explore dialog box. Use the navigation tree toadd any related objects that you want checked out to the site.

Note If you select an object that has related objects that must be locked formodification, the related objects are automatically checked out.

For more information, see Supplier site exchange.

6. Click Yes.

Cancel checkout to a site

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

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

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



• The export record is removed.

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

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

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

For information about searching for remote objects, see Search (ODS) for remoteitems.

2. Choose Tools→Import→Remote.

3. (Optional) In the Import From Global Services dialog box, type a description inthe Reason box. The reason text is stored for future reference.

4. Select the desired check boxes:

Check box DescriptionImmediate Causes the transfer request to process immediately. By

default, Data Exchange schedules transfer requests basedon system load conditions. Your administrator can disablethis option.

ProgressIndicator

When the process starts, opens the default Web browserand displays the Audit - Activity Status table. The tableshows the activity steps as they are processed.

E-mailNotification

Requests that Data Exchange send an e-mail when atransfer is complete to the address associated with therequesting user.

5. Click Yes.

Check in from a siteAfter you import the briefcase package (see Import the package file) that has objectschecked out to a site (see Using site checkout), you can check in the objects to yoursite. 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 itsprecheckout state.

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

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

Check replica synchronizationThe replica sync state of an object identifies whether it is up to date with the masterobject.

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

Export to SRMYou can export Supplier Requirement Management (SRM) objects to a remote site.

Note For information about SRM export setup and configuration, see ConfigureSupplier Relationship Management.

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 e-mail address is your Teamcenter user e-mail 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 e-mail to the Sponsor Email with the exported data, alongwith whatever other information is specified by the transfer option set.

Progress monitoringYou can monitor the progress of a transfer in My Teamcenter or from the thin clientby selecting the Show progress indicator check box in the Export To Remote SiteVia Global Services dialog box. This causes the default Web browser to open to theAudit - Activity Status table from Global Services and display the activity stepsas they are processed.



Controlling transfer activityYou must be a member of the Global Services administrative group to control DataExchange transfer activity. You can abort or resume a Data Exchange transferor and export to briefcase transaction from the Global Services Message ResultsSummary pane or Message Reactor Results pane.

Abort a transfer activityAfter you start an import or export through Data Exchange, you can abort theactivity as follows:

1. Log on to Global Services as an administrative group user.

2. In the Dataview pane, click the MsgResult or MessageResults business object.

3. Query for the transaction.

4. In the Message Reactor Results or Message Summary Results pane, click theResult ID value for the transaction that you want to abort and select Process -Abort Transaction from the list.

Resume a transfer activityYou can resume a paused after correcting any issues that cause the activity topause as follows:

1. Log on to Global Services as an administrative group user.

2. In the Dataview pane, click the MsgResult or MessageResults business object.

3. Query for the transaction.

4. In the Message Reactor Results or Message Summary Results pane, click theResult ID column for the transaction that you want to resume and select Process- Resume Transaction from the list.

Working with remote objects using ODSYou use the Object Directory Service (ODS) server to make objects available toremote systems and to find objects on remote systems. You can also remove(unpublish) an object previously published to the ODS. Your system administratordefines a default ODS for your entire site. The system administrator may havedefined a list of ODS publication sites that you can use to publish to multiple ODSsites at the same time. For additional information about ODS, see the Multi-SiteCollaboration Guide. You use the rich client interface to work with ODS.

Publish to default ODS1. 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 availableare 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 listYou can publish to a list of ODS servers that has been configured by your siteadministrator.

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 ofthese 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 areavailable are listed under Available Sites.

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

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

c. Click Yes.

Unpublish ODS objectsAfter you publish an object to an ODS server, you can remove the object so thatremote 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 thedefault ODSserver

Choose Tools→Multi-SiteCollaboration→Unpublish→FromDefault ODS

Unpublishes theobject with no furtherinteraction required.

From all ODSservers

Choose Tools→Multi-SiteCollaboration→Unpublish→From AllPublished - To ODS Site(s)

Unpublishes theobject with notfurther interactionrequired.

From specificODS servers

Choose Tools→Multi-SiteCollaboration→Unpublish→FromSpecific ODS Site(s)

Displays theUnpublish FromODS Site dialog boxwhere you can selectthe desired ODSsites.

From thedefault ODSserver or adifferent serverif the default isnot the expectedODS server

Choose Tools→Multi-SiteCollaboration→Unpublish→FromDefault ODS…

Displays theUnpublish FromDefault ODS Sitedialog box whereyou can confirm thedefault ODS serveror select the desiredODS site.

Search (ODS) for remote items

You search for remote objects using a saved search, specifically the system-definedRemote 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



Transferring a briefcase packageThe process of transferring data for reference using a briefcase package requires twoprocedures with an intervening manual step. The first procedure packages thedata, and the packaged data is transferred to the destination site through a manualprocess (such as FTP); and the second procedure imports the packaged data at theremote site. Normally, the manufacturer (OEM) initiates the transfer by creatingthe briefcase package and the supplier then imports the package. The return trip issimilar 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 briefcasefiles. If you are exporting to a Teamcenter site prior to Teamcenter 2007MP4, 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 desireddestination 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 AvailableSites 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 siteand click .

d. Click OK.

4. Select the desired transfer option set from the Transfer Option Set list.




Causes the transfer request to process immediately. Bydefault, Data Exchange schedules transfer requests basedon system load conditions. Your administrator may disablethis option.


When the process starts, opens the default Web browserand displays the Audit - Activity Status table. The tableshows the activity steps as they are processed.


Requests that Data Exchange send an e-mail to when thetransfer is complete to the address associated with therequesting user.

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 ownershipand 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 thevariables in the selected transfer option set.

Item options DescriptionInclude AllRevisions

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

Latest RevisionOnly

Exports the latest revision regardless of whether it is aworking or released revision.

Latest AnyRevisions Only

Exports only the latest revision with the specified releasestatus selected from the list.

Productstructureoptions DescriptionInclude EntireBOM

Includes all components if the item selected is an assembly.The revision selectors allow you choose which revision toexport with the selected item and its component items, ifapplicable. You can choose only one revision selector.

The TC_bom_level_export preference controls whetherthis option is available.


Transfers the selected assembly item and exports allcomponents with no site ownership transfer.

Dataset options DescriptionInclude AllVersions

Includes all dataset versions with each dataset selectedfor import or export. When this option is not set, includesonly the latest version of each dataset selected for importor export.

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

Save options Description

Save All OptionAs Default

Saves the options you select on the dialog box as the defaultoption settings.

Restore OptionSet Defaults

Replaces all options settings with the defaults settings.




TransferOwnership

Transfers site ownership to the target site. When thisoption is not selected, your site retains ownership. If youtransfer an item revision with a sequence, its sequencemanager is also transferred. The TC_ownership_exportpreference controls the default value of this option. It isrecommended that you leave the default setting for thisoption cleared.

Continue OnError

Allows the remote import or export objects operationto continue if errors are encountered whileimporting/exporting optional objects. All objects areconsidered optional except the following:

RequirementsSpecificationsItem MasterItem Revision Master

This option is disabled if the Transfer Ownership optionis 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 fileCaution If you are exporting to a Teamcenter site prior to Teamcenter 2007 MP4,

the importing site recognizes only the ugs extension as a briefcasefile. Teamcenter 10.1 generates briefcase files with a bcz extension.Therefore, you must change the extension of the package file to ugsbefore transferring it. Teamcenter 10.1 recognizes both bcz and ugsextensions 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 e-mail, FTP, or some other manual method to transfer the package file tothe importing site.

Import the package file1. In My Teamcenter, choose Tools→Import→From Briefcase.



2. In the Import from Offline Package dialog box, type the path to the briefcasepackage file or click the browse button and select the file.




Causes the transfer request to process immediately. Bydefault, Data Exchange schedules transfer requests basedon system load conditions. Your administrator may disablethis option.


Displays the progress monitor dialog box automaticallywhen the process starts.


Request that Data Exchange send an e-mail when thetransfer is complete to the address associated with therequesting user.

Site Check-Inafter import

Automatically checks in any objects in the briefcase filethat were checked out to a site.

4. Click OK.

Teamcenter imports the briefcase package file.

Working with unmanaged site briefcase filesYou can import and export configured briefcase files to and from unmanaged sitesin the My Teamcenter and Structure Manager rich client applications. You musthave set up Teamcenter as described in Configure Teamcenter for Briefcase Browser.Unmanaged sites use Briefcase Browser to create and modify briefcase files.

For information about using Briefcase Browser, see the Briefcase Browser Guide.

Export a configured briefcase file

1. Log on to Teamcenter and open the My Teamcenter or Structure Managerapplication. Locate and expand the top level of the assembly structure thatyou want to export.

2. For each object that the unmanage site must update, select the object and chooseTools®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 theComments box.

5. Select the select the item revision associated with the top level of the assemblystructure 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 isthe location where you can access the generated briefcase file for transfer to theunmanaged site.

10. Select the desired revision from the Revision Rule list.



Select the Replica Bypass option and any other desired export options.

Caution You must select the Replica Bypass option to prevent import failuresat the unmanaged site on subsequent imports.

Note Unmanaged sites do not have the ability to manage versions, whichmeans the latest version, and only the latest version, is required.Therefore, the Dataset version 0 only option is selected by default andis 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 resultsUse 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 attributevalue set to mqc_upodate_all_features and the Dataset Types attribute valueset to UGMASTER.

3. Save the file.

4. In Teamcenter, create a validation rule set dataset and import the rule file youcreated into the new validation rule set.

5. Open options and locate the BRIEFCASE_import_validation_rule_itempreference. Set its value to the item ID/revision ID of the item you want tovalidate.

6. Import the briefcase file as described in Import a configured briefcase file andverify the validation forms for the imported item revision are present.

Import a configured briefcase file1. 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 dialogbox.

2. Navigate to or type the path and file name of the briefcase file in the BriefcaseFile 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, allobjects that are checked out to the unmanaged site are checked in during theimport process. Otherwise, you must check them in individually after they areimported.

5. Click Yes to begin the import.

Working with PDX dataThe 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 accessedwithin a workflow the same as any dataset.

For information about the Teamcenter objects that can be exported to PDX andhow they are mapped to PDX objects by the out-of-the-box (OOTB) mapping file,see Standard PDX mapping.

Export a PDX package1. Select the object to export.

2. Choose Tools→Export→To PDX.

3. In the Export to Remote Site via Global Services 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 theexport 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 ofduring the scheduled off-hours period.

Progress Indicator Displays the progress pane automatically when theprocess starts.

E-mail Notification Requires Data Exchange to send an e-mail when thetransfer is complete to the address associated with therequesting user.

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

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

4. Click Yes.

After the export completes, open your Mailbox to locate the PDX package. Youcan copy the package to another location in Teamcenter or download the packageto the file system.



Access a PDX package from a workflowA PDX package is a dataset that is accessible from a workflow process like anydataset. You can attach or refer a PDX package to another object in a workflowprocess. You can copy a document to be sent as a reference document in the processdialog box.

Query for a PDX package1. 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, selectDataset search from the list, and click Change Search.

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

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

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

Download a PDX package1. Select the PDX package, right-click, and choose Named References.

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

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

Process for bulk loading Teamcenter dataFrom the perspective of the Teamcenter components, you use the following processto 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 togenerate Teamcenter UIDs for composing the TC XML file containing legacydata.

int TIE_get_preconstructed_uids(



int numRequestedUids, (I) Number of UIDs to constructint* numConstructedUids, (O) Number of UIDs constructedchar*** constructedUids (OF) Number of numConstructedUids

constructed);

int TIE_get_hashed_uid(int ownSiteId, (I) Site Id of Legacy systemconst char* hashKey, (I) Hash Keychar** hashedUID (OF) Valid Teamcenter UID for given hash key

);

2. Use the tcxml_validate utility to validate the TC XML file generated by thecustom mapping solution. The validator log reports potential errors within TCXML file. Fix the root cause of any errors within the custom mapping logic. Thisvalidation focuses on data samples [~2500 element XML Files] extracted fromlegacy systems to be executed in a test lab environment.

3. Use the tcxml_import utility to import the TC XML files generated by thecustom mapping solution. After all aspects of the translation/mapping arecorrect, the full TC XML file can imported at the highest speed possible, withoutany additional validation.

Caution When attribute values contain commas in the strings ateither of the sites, you must change the default value for theGMS_tcxml_string_separator preference at both sites to preventdata 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 PSBOMViewdata.

Therefore, when transferring PSBOMView data using a briefcase file,tcxml_export and tcxml_import, or any utility that uses TC XMLmetadata, set the PSE_default_view_type preference at the target site tothe view type value of the assembly at the source site. Usually, this is thesame 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 followingtopics:

• Teamcenter core data dictionary

• Teamcenter data model diagram

• Sample assembly structure in a TC XML file

• Sample TC XML file with GSID references

• Sample bulk load repeat file

• Frequently asked questions



Island of data

An Island of data concept is used to bulk load data into Teamcenter. Loading datain islands maintains the integrity of data relationships and allows recover fromimport failures during the bulk load. The following definitions help you understandthis concept:

Island The fundamental unit of data. It consists of a principal objectand the additional objects on which it depends for its correctfunctional definition and usage within Teamcenter.

Principal object The initial object used to start the traversal to determine anisland of data.

Dependent object An object that must be included in the set of objects implied bythe principal object and the closure rules to correctly form theisland of data. Dependent objects may not exist in a particularisland.

The following diagram shows how an island can be defined:

Island of data



Enable bulk loader utilitiesThe site consolidation tools and detailed documentation are protected by license toensure that a proper qualification is done through the Siemens PLM Software GlobalSales and Services organization in cooperation with the Siemens PLM SoftwareResearch and Development organization. A license is required to run the bulkloader utilities. You must obtain a license key from GTAC and set the value of theSITCONS_AUTH_KEY environment variable to that license key.

Fast import of objects using the tcxml_import utility uses data files that conform tothe low level (LL) TC XML format. The bulk loading process also uses the LL TCXML format. The use of stub objects and inferred delete are handled differentlyin this format.

For LL TC XML imports, an entire island of data must be full elements regardless ofwhether an object is locally owned or a replica. Stub objects are used to solve islandinterdependencies and are represented by POM_stub objects in the Teamcenterdatabase. They are not used to represent objects that have already been sent tothe target site as it does in HL TC XML imports. Consequently, if you transfer anew revision to Teamcenter using LL TC XML, all predecessor revisions must betransferred as full objects. These may have further related objects and so on. If theyare not full objects, an inferred delete of the stub objects occurs.

For more information see islands of data and bulk loading data.

Note The tcxml_xfer_ownership utility does not require a license key for theflip-the-switch ownership feature.

For information about this feature, see the Utilities Reference.

TC XML formatThe TC XML format is defined by the TC XML schema. The TC XML schema isautogenerated at installation and upgrade, and the resulting TCXML.xsd file isplaced in the TC_DATA directory on the Teamcenter server. You can also use theBusiness Modeler IDE to generate a current copy of the schema.

For information about exporting a TC XML schema file, see the Business ModelerIDE Guide.

In a TC XML file, the root element is TCXML and the namespace (xmlns) attributeis http://www.tcxml.org/Schemas/TCXMLSchema, as shown in the followingfigure.


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

TC XML root element

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 (#) tothe elemId value.

TC XML object reference

TC XML data is grouped into islands; an island ties logically related objectstogether. The data migration solution can form simple islands, like [Item, ItemRev,MasterForm] or [Dataset, RevAnchor, ImanFile], and the fast import processesthe islands one‐at‐a‐time. The following figure shows an example of how to structureTC XML data islands for best results:



Typical TC XML island structure

XML elements for organizational (User, Group, Site, and so forth) andadministrative (Types, Rules) objects are assigned an island_id attribute value of0 and contain the candidate key attribute.

The organizational and administrative objects are not replicated; they are looked upat 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 inthe following table. The attribute descriptor is POM_attr_is_candidate_key.Additionally, the following list of classes and corresponding candidate keys isprocessed by the fast import function. Some special cases, indicated by a hash(#), involve composite keys for which the XML element has a dummy attributecontaining the composite key values.



Class Name Candidate Key

ClosureRule name

RevisionRule object_name

ImanVolume volume_name

Tool object_name

TC_Project project_id

TransferMode object_name

TransferOptionSet object_name

CFM_date_info id

AM_ACL ACL_Name

ImanActionHandler handler_id

ImanEventType eventtype_id

ImanAliasList alName

Condition condition_name

ImanQuery query_name

TaskType tasktype_name

Participant Subclasses* assignee

GroupMember# member

[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 definedin 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 thosethat 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 thedependent 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 arescattered or mixed up in the file the import fails.



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. Thesite-id value in the originatingSite attribute of the Header element is consideredto be the owner of the object.

For array attributes, the values must be separated by the delimiter defined by theGMS_tcxml_string_separator preference. The default delimiter is a comma (,).The Header element contains details of the originating site, option set or transfermode used, transfer option name-value pairs, and session option name-value pairs.The originatingSite attribute contains the site-id value representing the legacysystem and must be unique (cannot be the same as the Teamcenter site). This sitemust be defined in the Organization application of the importing Teamcenter site.



TC XML Header element

TC XML file with GSID references

Bulk loader supports importing low-level (LL) TC XML files containing GlobalServices ID (GSID) references (GSIdentity elements). GSIDs are used for objectlook-up and the bulk load import handles creation of Teamcenter UIDs for the legacyobjects. This relieves the custom mapping solution from invoking a Teamcenter APIfor UID creation and identity management.

Caution You must set the GMS_USE_FNV_HASH preference to true to enablethe use of the FNV hashing API to create Teamcenter UIDs for thelegacy objects.

Note If you use the bulk load function to load objects that will be referenced byData Exchange, the GSIdenity element must match the element used bythe 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) andadministrative (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 childGSIdentity element’s elemId attribute of the corresponding organization object.For example, the owning_group attribute of the Item element in the followingfigure, points to the child GSIdentity element’s elemId attribute of the Groupobject.

GSID-based organization objects

Each object may contain an associated child GSIdentity element and the objectlook‐up is based on the GSIdentity element. The puid attribute may or may not bepresent and, in any case, the GSIdentity element takes precedence for identifyingthe object. For new objects, the GSIdentity attributes (label, subLabel, andspilt_token) are used to generate the puid attribute. The GSIdentity elements forthe new objects are persisted when the island is saved. They serve as import recordsfor these objects. Bulk load import also allows mixed TC XML files where someobjects have UID-based identity and some have GSID-based identity.

Reference attributes refer to other objects by the elemId attribute of the childGSIdentity 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. Thisvalue 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 thedatabase. These objects are always locally owned and are the database objects thatrepresent a stubbed object.

The POM_stub element requires three attributes:

• definitive

Points to the source site POM_imc element in the TC XML file.

• object_class

Indicates the class of the object represented by the stub.

• object_uid

Points to the GSIdentity element of the object represented by the stub. If theactual object is not present in the TC XML file, the object_uid refers to its ownGSIdentity element which uniquely identifies the object as being representedby the stub. In this case, the attributes of the GSIdentity element of thePOM_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 Teamcenterdatabase for the stub, it skips creation of the stub.

Bulk loader utilityThe tcxml_import utility in bulk loader mode imports legacy data in a TC XML fileinto Teamcenter. The utility can be run only by a system administrator (Teamcenteruser in the dba group) and requires a license from GTAC. The objects are importedas local objects by providing the -bulk_load argument. In case of any failuresduring import, a file with failed islands is created in the same location as that ofthe 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 theUtilities Reference contain arguments not listed here. Those arguments arefor regular imports of TC XML data, not bulk loading of legacy data, and areignored when the –bulk_load argument is used.

Syntaxtcxml_import [-u=user-id {-p=password | -pf=password-file} -g=group]-file=xml-file-name -site=site-name-bulk_load -bypassSiteCheck

[-h]

Arguments-uSpecifies the user ID.

This is generally infodba or another user with administration privileges. If thisargument 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 ratherthan being authenticated against the Teamcenter database. If you donot supply these arguments, the utility attempts to join an existing SSOsession. If no session is found, you are prompted to enter a user IDand password.

-pSpecifies the password.

If used without a value, the system assumes a null value. This argument ismutually exclusive with the -pf argument.

If this argument is not used, the system assumes the user-id value to be thepassword.

-pfSpecifies the password file. This file can be created manually, or usingTeamcenter Environment Manager.

• If created manually, the file must be a single-line ASCII file containing thepassword in clear text.



• If created through Teamcenter Environment Manager, the wizard promptsyou 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 notused, the system assumes the user-id value to be the password.

This argument is mutually exclusive with the -p argument.

-gSpecifies the group associated with the user.

If used without a value, the user’s default group is assumed.

-fileSpecifies the input TC XML file containing the objects to be imported intoTeamcenter.

-siteSpecifies the master exporting site from which input TC XML data is generated.

-bulk_loadPerforms a fast import using POM level APIs of a file containing legacy dataobjects. The file must conform to the TC XML low-level data format. Youmust specify the -file and -site arguments. If you specify any other optionalarguments they are ignored. See restrictions.

-bypassSiteCheckAllows import of TC XML data into the site from where it was exported. Use thisargument along with the -bulk_load argument for bulk update of attributes oflocal objects and import of archived audit records.

Caution Use this argument only with the -bulk_load argument for bulkupdate of attributes of local objects and import of archived auditrecords.

-hDisplays help for this utility.

Restrictions1. To use this argument you must set a license key value for the

SITCONS_AUTH_KEY environment variable. You must obtain the key fromGTAC.

2. Using POM level APIs ensures the overall integrity of the data (referentialintegrity, type safety, and so forth). However, the tcxml_import utility does notverify adherence to business rules. You must identify these types of errors andfix them during the pre-import process.

For information about the pre-import process, see Pre-import validation.

3. When importing a PSOccurrence object, the import file must contain thefollowing attributes:

• xform• notes_ref• child_bv



• variant_condition• alternate_etc_ref

4. When importing a workspace object, the following properties must be presentin the import file:

• uom_tag• configuration_object_tag

Examples

To import legacy objects from the Item32.xml file into the Teamcenter site whereyou 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).

• 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 andheaders. Additionally it has a comment tag to display the failure message.

Create, update, and infer-delete

The import functionality of the bulk load process is different from low-level fastimports in that some objects are imported as replicas followed by a separate stepfor 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 Teamcentersite and are updated in all subsequent imports. The bulk_load session option allowsfor this variation in behavior. This option is set when the -bulk_load argumentis used with the tcxml_import utility.

For creation, the owning_site attribute of the object must point to a POM_imcelement that contains the site-id attribute of the importing Teamcenter site asdescribed in TC XML format.

For updates, the lsd attribute of the object in the TC XML file must be later than thelsd attribute of the object in the Teamcenter database.

The fast import traverses the target database to collect the helpers of each principalobject in the TC XML file. The objects that exist in the target database but not inthe 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 importprocess:

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 existsat Teamcenter site -2132200621 and the lsd attribute value is the same in the TC XML fileand the database.

Bulk load process updates the item with an item_id value of 000032 because it alreadyexists at Teamcenter site -2132200621 and the lsd attribute value in the TC XML fileis later than the value in the database.

Create, update, and skip sequence

Pre-import validation

The TC XML file generated by the custom mapping solution needs to be validatedto ensure that it is constructed properly for consumption by fast import. Thetcxml_validate utility serves this purpose by performing the following validations:

1. Checks for well-formed XML.

2. Validates XML against XML schema.

3. Checks for well-formed and valid UIDs.

4. Validates typed and untyped references.

5. Checks for missing attributes,

6. Checks for required helper objects configured by closure rules.

7. Checks for conformance to GRM rules.



Required schema

The tcxml_validate utility uses the LLTCMXML.xsd schema to validate the inputfiles. This file must be in the TC_DATA directory. To generate this file and enableschema validation:


1. Use the bmide_generatetcplmxmlschema utility to generate the file for yourTeamcenter 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 inthe 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] forlog information

Siemens and the Siemens logo are registered trademarks of Siemens AG. UGS,Teamcenter and UGS Teamcenter are trademarks or registered trademarksof UGS Corp. or its subsidiaries in the U.S. and other countries. Thissoftware 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 NOTLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FORA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHTOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOTLIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANYTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USEOF 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 properlyinstalled and rerun the utility.

3. Set the Teamcenter TIE_validate_xml_against_schema preference to true.

Required helper objects

You use closure rules define the objects that are mandatory to form a valid datamodel 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 datamodel objects must be marked with the required predicate by suffixing the clausewith :R. For example, the following explains the standard closure rule clauses forItemRevision and Variant class objects

Every ItemRevision object must have an Item object represented by the followingclause 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 custommapping solution. When you first run the utility, use input files that have small datasamples to verify the correctness of the custom mapping solution.

The input-file-name_validator.log contains a report of any errors found in theinput TC XML file. Your mapping solution must be fixed to clear these errors.After correcting the custom mapping, rerun the tcxml_validate utility to validatethe 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 ofthe mapping are correct, the TC XML files can be generated in bulk by the mappingsolution.

Note You cannot use the tcxml_validate utility on very large TC XML files. It islimited to files containing approximately 2500 elements.

Tip The tcxml_validate utility is intended as a tool used to perfect your custommapping solution. It is not intended to be used on all TC XML files beforethey are imported.

For a complete description of the tcxml_validate utility, including syntax andexamples, see the Utilities Reference.

Pre-import validation logs

The tcxml_validate utility creates a log file containing the results of validationat the location of the input TC XML file. The file naming convention isinput-xml-file_validator.log.

The log file contains the errors found for an XML element along with the details suchas Object UID, Class, Island-id, and parent object. The values for an element areseparated 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 betterreadability. The following figure shows a sample log after it is imported into Excel:



Validation log file in Excel

Caution On Windows systems, when schema validation is used and the TCXML elements have some mandatory attributes missing, an exact errormessage is not included in the log file. However, the log file containsthe line number and column number of the missing attributes in thefile, for example:

TIEFastImportSAXHandler Error: [] encountered in xml at line[17] and column [898]. May have encountered some invalidcharacters or missing some required attributes - but anywayattempting to continue processing...

To determine the missing mandatory attributes, check the element listedin the indicated line and see the appropriate object table in Teamcentercore data dictionary.

Mapping configured BOM export files

The TC XML file generated by the configured BOM export function contains parentunique identifiers (PUIDs) instead of Global Services identifiers (GSIDs). To use theGlobal Services mapping engine, the file must have GSIDs. Teamcenter providesthe PUID2GSIDTCXMLconverter Java utility that you use to convert low-levelPUID-based TC XML files to low-level GSID-based TC XML files.

This utility inserts a GSID child element for every element and replaces UIDreferences 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 utilityfrom the command line using the following syntax:

PUID2GSIDTCXMLconverter input-xml-filepath-filename

The utility generates the output file in the same directory as the input file with thesame filename appended with Gsid. For example, the following outputs a file namedjcb_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 dependingon the size of the input file.


Appendix

A Standard mapping

Standard mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1Standard PDX mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2


Appendix

A Standard mapping

Standard mappingThe DataMapper.xml file defines mappings for the mapper framework. The<maximum-concurrency > element controls the number of simultaneousmappings that may run in an application. The mapper service provides convenientaccess to mapping functionality. The service uses this DataMapper.xml file todetermine the type of mapping requested. Mapping is keyed on action type andsource and destination systems, for example:


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 amapper service. Between these sibling mapper elements, the output of a previousservice is the input of the next service in the chain.

Control file mapping is a service that wraps the mapping functionality provided bythe 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 GlobalServices 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 thedataTransfer 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 fileprovides 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. Anyimplementing class must implement to the ImapService interface. TheDataMapper.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 I Data Exchange Guide A-1

Appendix A Standard mapping

Tip Wild card quick configuration guidelines:

The DataMapper.xml configuration file accepts wild card (*) entries forMAP node’s SOURCE and TARGET attributes. Entries with wild cardsare used as a fall back in cases when an entry bearing specific site sourceand target site IDs does not exist. It is important to note that multiple mapentries with the same combination of SOURCE and TARGET attributevalues must not conflict with each other. Specifically, the following examplepair of entries is NOT allowed, and results in an error:

<map source="X" target="*"> ... </map><map source="*" target="Y"> ... </map>

Such entries prevent Global Services from determining which entry is tobe used.

For more information about the standard mapping control files and about mappingbetween Teamcenter sites, see the mapping designer topics in the Business ModelerIDE Guide.

Standard PDX mappingPDXelement name

PDXattribute

Teamcenterobject

Teamcenterattribute

ApprovedManufacturerListItem manufacturerPartIdentifier ManufacturerPart object_name

ApprovedManufacturerListItem manufacturerPartUniqueIdentifier ManufacturerPart item_id

ApprovedManufacturerListItem manufacturerContactUniqueIdentifier Vendor item_id

ApprovedManufacturerListItem globalManufacturerPartStatusCodeManufacturerPartRevision®ReleaseStatus

name

ApprovedManufacturerListItem globalManufacturerPartStatusCodeOtherManufacturerPartRevision®ReleaseStatus

name

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

AffectedItem obsoleteDateItemRevision®ReleaseStatus

date_released

AffectedItem effectiveDateItemRevision®ReleaseStatus

date_released

AffectedItem globalLifeCyclePhaseCodeItemRevision®ReleaseStatus

name

AffectedItem globalLifeCyclePhaseCodeOtherItemRevision®ReleaseStatus

name

AffectedItem description ItemRevision object_desc

Attachment universalResourceIdentifier Imanfile original_file_name

Attachment fileIdentifier Imanfile file_name

A-2 Data Exchange Guide PLM00094 I

Standard mapping

PDXelement name

PDXattribute

Teamcenterobject

Teamcenterattribute

Attachment fileSize Imanfile byte_size

Attachment description Dataset description

BillOfMaterialItem revisionIdentifierPSOccurrence→Item→Item Revision

item_revision_id

BillOfMaterialItem globalBillOfMaterialTypeCode Item object_type

BillOfMaterialItem globalBillOfMaterialTypeCodeOther Item object_type

BillOfMaterialItem notes PSOccurrence®PSOccurrenceNotes

note_texts

BillOfMaterialItem BillOfMaterialItemIdentifierPSOccurrence®Item

object_name

BillOfMaterialItem billOfMaterialItemUniqueIdentifierPSOccurrence®Item

item_id

BillOfMaterialItem itemQuantity PSOccurrence qty_value

BillOfMaterialItem descriptionPSOccurrence®Item®Item Revision

object_desc

BillOfMaterialItem proprietarySequenceIdentifier PSOccurrence seq_no

Change changeNumber EngChange item_id

Change revisionIdentifier EngChange Revision item_revision_id

Change globalEngineeringChangeStatusCodeEngChange Revision®ReleaseStatus

name

Change globalEngineeringChangeStatusCodeOtherEngChange Revision®ReleaseStatus

name

Change changeStatusDateEngChange Revision®ReleaseStatus

date_released

Change changeType EngChange object_type

Change changeSubTypeEngChange RevisionMaster

ec_type

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 globalLlifeCyclePhaseCodeItem Revision®Release Status

name

PLM00094 I Data Exchange Guide A-3

Appendix A Standard mapping

PDXelement name

PDXattribute

Teamcenterobject

Teamcenterattribute

Item globalLlifeCyclePhaseCodeOtherItem Revision®Release Status

name

Item globalProductTypeCode Item object_type

Item revisionIdentifier Item Revision item_revision_id

Item globalProductUnitOfMeasureCodeItem®UnitOfMeasure unit

Item revisionReleasedDate Item Revision release_date

Item description Item object_desc

ManufacturerPart manufacturerPartIdentifier ManufacturerPart object_name

ManufacturerPart manufacturerPartUniqueIdentifier ManufacturerPart item_id

ManufacturerPart manufacturerName Vendor object_name

ManufacturerPart manufacturerContactUniqueIdentifier Vendor item_id

ManufacturerPart globalManufacturerPartStatusCodeManufacturer PartRevision®ReleaseStatus

name

ManufacturerPart globalManufacturerPartStatusCodeOtherManufacturer PartRevision® ReleaseStatus

name

ManufacturerPart manufacturerPartType ManufacturerPart object_type

ManufacturerPart description ManufacturerPart object_desc

ProductDataeXchangePackage originatedByContactName Header author

ProductDataeXchangePackage originatedByContactUniqueIdentifier Header author

ReferenceDesignator referenceDesignatorName PSOccurrence ref_designator

A-4 Data Exchange Guide PLM00094 I

Appendix

B Teamcenter Data Exchangeconcepts and components

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

Exporter and importer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1Supported objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1Supported transfer options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-6

Scoper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-7Data mapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-7Data synchronizer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-8Identity manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-10Ownership manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-11Siemens PLM Software briefcase . . . . . . . . . . . . . . . . . . . . . . . . . . B-12

File Management System file transfer . . . . . . . . . . . . . . . . . . . . . . . . . . B-13Security Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-14


Appendix

B Teamcenter Data Exchangeconcepts and components

Teamcenter Data Exchange concepts and componentsTeamcenter and Global Services provide components that support the Data Exchangefunctionality. Understanding the Teamcenter and Data Exchange componentsand architecture helps you understand the installation and configuration processof Teamcenter Data Exchange.

Data Exchange componentsData 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 Global Services Framework to transfer objectsbetween sites.

Exporter and importer

The exporter and importer components provide serialization and deserializationof transferred data. In the serialization process, the exporter follows TeamcenterXML (TC XML) schema to generate XML fragments and creates export records forobjects exported to a target site.

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

PLM00094 I Data Exchange Guide B-1

Appendix B Teamcenter Data Exchange concepts and components

• Identifier• ImanFile• ImanRelation• Item• ItemRevision• ReleaseStatus• POMObject• Table• TableCellBCD• TableCellDate• TableCellDouble• TableCellHex• TableCellInt• TableCellLogical• TableCellSED• 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

B-2 Data Exchange Guide PLM00094 I

Teamcenter Data Exchange concepts and components

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

• 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• 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 fromsupported Teamcenter objects are exported through properties. These objects mustbe 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 TeamcenterEnterprise:

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

Parts (assemblies/components) that have documents without any attachments areimported into Teamcenter as empty datasets without any named references.

The following CAD data is not supported for transfer by the importer or exporter:



• Absolute occurrences

• Options and variants

• Effectivities

• Precise CATIA assembly structure

• Imprecise Pro/ENGINEER assembly structure

Supported transfer options

The following table contains the transfer options that are supported by DataExchange.

Option group Supported option Symbol name Value

Item Options Include AllRevisions opt_all_revs true | false

Latest RevisionOnly opt_revs Latest

Latest WorkingRevision Only opt_revs Latest

Working

LatestWorking/AnyRelease Status

opt_revs

LatestWorkingandReleased

Latest AnyRelease Status opt_revs Latest

Released

SelectedRevision(s) Only opt_revs Selected

Specific ReleaseStatus Only opt_revs Released

status

Dataset Options Include AllVersions opt_all_ds_vers true | false

Include All Files opt_all_ds_files true | false

ProductStructure Options

Include EntireBOM opt_entire_bom true | false


opt_do_struct true | false

ExcludeTransfer-ProtectedComponents

opt_trans_prot_comp true | false

ExcludeExport-ProtectedComponents

opt_exp_prot_comp true | false



Option group Supported option Symbol name Value

General OptionsExcludeExport-ProtectedObjects

opt_exp_prot_obj true | false

Exclude FolderContents opt_folder_contents true | false

Relations Relations to beincluded opt_grm

Supportedthroughclosure rule

Include JTdatasets opt_jt_ds true | false

Include NXdatasets opt_nx_ds true | false

Scoper

When the exporter or importer receives a request to transfer data, it determines thetransfer mode from the option set object. It then creates the traversal object basedon the transfer mode scope (import, export) and the schema format. PLM XMLor 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 handand calls the traverse method. The traverse method navigates to the next objectand then calls the process method. This operation iterates until no more objectsare available to process.

The scoper evaluates the transfer mode closure rules and the options provided by theexporter and returns only the objects that are identified for process in a closure ruleclause. 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 relationshipto other objects must be converted or mapped to the representation in the othersystem. For moving data from one Teamcenter system to another, you only need tomap customizations as the standard Teamcenter object attribute and relationshipsare the same in both systems.

Teamcenter provides a standard mapping process for moving data betweenTeamcenter Enterprise and Teamcenter systems. This standard mapping does notmap all object attributes. Attributes that are not used in the destination system arenot mapped. Attributes that are used only to provide system functionality that canbe achieved through another method and are not displayed to the user, are also notmapped. Due to customizations to support a unique business process, you may needto map some of these standard attributes.

Reference elements can be mapped to multiple objects and will accept any numberof mappings. A reference element must map to a string that matches the string ofcharacters prepended by plm: for the object that it is mapped to.

For a GSIdentity object, the class attribute is information only and not the classname in the receiving system.



Data synchronizer

The data synchronizer uses recipes defined by initial replication to determine ifreplicated data is up-to-date or needs to be updated. You can use the synchronizationfunctionality to see if data that is replicated on your site is outdated and update it asdesired. You can also push data that has changed to sites where replicas exist. Thesynchronization 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 lastmodification date to the replica’s last export date. Through a customization, you canalso identify candidates automatically providing an event trigger that calls an APIthat flags replicated objects as out-of-date.

A recipe is a combination of import export options that is encoded as transfer formulastrings. This transfer formula is stored as part of the ImanExportRecord objectas a string identifying the name of the transfer formula and an integer field for theassociated transfer formula variables presented in the form of a map. The mapcontains a key string and a value string. This allows generalized behavior of theseoptions. 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 importedin multiple assemblies, only the last recipe is stored, as shown in the followinguse cases:

Component in two assemblies with differing relationships

1. User A, at site 2, replicates assembly X (which includes component Z) from site 1with the include_relation value set to Manifestation.



2. User B, at site 2, imports assembly Y (which also includes component Z) fromsite 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 LatestReleased.

2. User B, at site 2, imports the same item X with revision selector set to LatestWorking.

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

2. User B, at site 2, imports the same item X with revision selector set to LatestWorking.

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 itemsthat are moved between systems that have their own identity mechanism. Due todifferences in data models and the intended item’s use, the GSIdentity object maybe unique from the system ID for the item, such an OBID or UID. Some objectsmay have several equivalent objects in the destination systems. Therefore, theGSIdentity object for the exported object may equate to multiple objects in thedestination system that must reflect the original GSIdentity attributes.

The GSIdentity class is a subclass of the POM class and contains the followingattributes:

• system

Provides a token indicating the data origination, for example, TeamcenterEnterprise or Teamcenter.

• label

Contains a textual representation for the data’s UID or OBID in its nativesystem.

• 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 componentsfor one-to-many mappings.

• context

Tracks the attribute name when an attribute in one system becomes the fullobject in another system. It may also identify (usually as an index) a runtimeobject that becomes a persistent object in the receiving system. This occurs whenthe runtime object has uniqueness only in the context of a persistent object. Inmany instances, neither of these two cases apply and this attribute is empty.

• factor_id

Contains a unique string that identifies a group of Teamcenter Enterpriseobjects that belong together.

• atomic

Provides a token that indicates whether the label is simply the UID or OBID ofan object or something more complex.

The GSIdentity object is persisted and associated with the transferred objectcreated in the new system. Objects have only one identity. The composition ofGSIdentity 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. Thecollect_garbage utility can be used to remove GSIdentity objects from thedatabase for objects that have been deleted.

Ownership manager

The ownership manager controls ownership of objects that are transferred amongsystems and participates in import and export operations. When a part is processedfor transfer of ownership, ownership of all part revisions is transferred to thereceiving site. A transfer of ownership can be for the top-level parts only or for anassembly and all its child parts. If ownership of a replicated object is transferred to anew site, the export records for the object are transferred to the receiving site so thatthe owning site is always aware of existing replicas and all replicas are updated withthe new site ownership data.

When ownership of an object that is published to an ODS is transferred to anothersite, the ODS publication record is updated with the new owning site.

During the ownership transfer process, objects at the exporting site are locked toprevent modifications and are flagged as in the Ownership Transfer Pendingstate. This flag is cleared after the exporting site receives a message from theimporter that the transfer is complete and the exporting site marks the objects ithas as replicas. If the ownership transfer process terminates unexpectedly, theownership may be in an inconsistent state. The ensure_site_consistency utilityallows you to report objects that are in the Ownership Transfer Pending stateand to correct inconsistent ownership.

The following is an example process for exporting an object with transfer ofownership:

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 objectswith 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 ownershipconsistency, 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 exportrecords.

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 which transfer of ownership is successful.



11. Site 2 generates a TC XML file with success/failure state for ownership transferfor 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 ownershipmanager to unlock them.

13. The ownership manager unlocks all objects from this list and also changes theowning_site attribute for objects whose ownership was successfully transferred.

14. The ownership manager sends a message to Object Directory Service (ODS)regarding ownership changes.

15. Global Services sends messages to sites where replicas and stubs are locatedregarding 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 withsuppliers or other sites that do not share a live connection with your enterprise. Itallows data to be replicated and also provides the capability to check out data to asite for modification (the owning site remains the original site, but the remote sitecan 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 TCXML file are packaged into a briefcase file. This file can then be imported at thereceiving site to create the replica objects and files.

A site can be defined as a hub (when configuring sites). A hub site can replicatereplica 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 itemto 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 changethe 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 ofFMS file tickets.

3. Create the briefcase file using the TC XML data and the data files, and includethe 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 itas named references, and attach the briefcase dataset object to a Teamcentermail that is sent to the exporting user.

Briefcase also can be used to schedule an export through Global Services, allowingthe export to proceed in the background so that you can immediately gain rich clientsession control for other purposes. The following is the process for a scheduled export:

1. Teamcenter calls an SOA service to initiate the offline export.

2. Global Services schedules the offline export.

3. Global Services locates a server at the exporting site and calls and SOA service toexport the objects. The TC XML files and log files are generated after the export.

4. If mapping is required, Global Services calls the mapper to translate the TCXML files.

5. Global Services locates a server at the exporting site and calls the packagebriefcase contents SOA service to create the briefcase file.

6. If the exporting user chooses to receive e-mail notification after export, GlobalServices sends an e-mail notification to the user. This e-mail contains informationabout the briefcase dataset object created and its URL after the export .

7. Teamcenter calls the export API to export the objects. The TC XML files and logfiles are generated after the export.

8. Teamcenter calls the package briefcase API to create the briefcase file.

The briefcase feature does not support transfer of ownership but does support checkout to site to allow modification of objects by suppliers

File Management System file transferData Exchange uses File Management System (FMS) to transfer data files betweenTeamcenter PLM systems. FMS transfers files on demand and uses the FMS servercache (FSC) to improve file transfer performance. FMS keys are stored in the PLMsystem databases for use by the server processes to generate tickets for a specificsystem. FSC servers use keys read from key files referenced in their configurationfiles.

For Teamcenter, default keys are set in the Teamcenter database and can be modifiedusing the install_encryptionkeys utility. FMS in Teamcenter uses these defaultkeys unless you configure it to use key files referenced in the FMSmaster.xmlconfiguration file.

For information about using FMS with Teamcenter, see the System AdministrationGuide.

FMS in Teamcenter Enterprise does not provide default keys; they are explicitly setduring the install process. You must also configure the FMS key files.



For information about using FMS with Teamcenter Enterprise, see the TeamcenterEnterprise Network and Database Configuration Guide.

Security Services

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


Appendix

C Data Exchange performancetuning

Data Exchange performance tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

Tuning aspects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

Pooling Teamcenter connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2

Throttling mapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3

BPEL performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-4

Logging configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-5Activity status configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-5Global Services logging configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . C-5


Appendix

C Data Exchange performancetuning

Data Exchange performance tuningThe following figure depicts the Global Services components involved in movingobjects to and from Teamcenter to other enterprise information systems, includingother Teamcenter sites.

Global Services implements a controller pattern to facilitate transfers of databetween two end points. In addition to export and import steps, this includes acustomizable mapping step to translate data between the end point schemas.

Tuning aspectsThe application server where your Teamcenter Global Services application isinstalled (TcGS server) is multi-threaded so it handles multiple concurrent sessionswithin the same Global Services process. To support multi-threading properly, youmust size the TcGS server or servers to meet the expected load. This sizing mustaccount for the hardware aspects, such as the amount of memory and number andspeed of CPUs installed.

TcGS server memory use grows on a per-session basis. However, memoryconsumption in the TcGS server for Data Exchange is mainly due to the mappingprocess. The following is one approach to sizing your TcGS server:

1. Determine the desired system throughput.

2. Determine the number of concurrent mapper steps required to support this load.

PLM00094 I Data Exchange Guide C-1

Appendix C Data Exchange performance tuning

3. Determine the number of TcGS servers required to spread the mapper loadacross the Global Services processes.

To properly determine the number of TcGS servers to use, you must account for thelimitations of the specific application server used. For example, if the applicationserver uses a 32–bit Java virtual machine (JVM), the application server is limited toroughly 1.5GB of heap space (memory). If the application server uses a 64–bit JVM,memory available is limited to the amount installed in the computer.

For more specific details on sizing, see Pooling Teamcenter connections, PoolingTeamcenter Enterprise connections, Throttling mapper, and Throttling BPEL.

In addition to memory, you must consider the TcGS server for CPU consumption.The mapper (and application server in general) consumes a lot of CPU time so youmust size the TcGS server load and, possibly the number of application serverinstances on each machine that runs a TcGS server.

Note Sizing of CPU and memory involves many factors that are outside the scopeof this high-level discussion. You may be aware of other factors, such as L2cache size and certain network properties that affect the calculations thatare not addressed. The goal of this discussion is to identify general issues,not to provide a worksheet for picking the required hardware.

Pooling Teamcenter connectionsThere are two pools for Teamcenter: a server pool maintained by the TeamcenterWeb tier and a client pool maintained by the Teamcenter Global Services (TcGS)server as part of its Teamcenter SOA connector. The TcGS server pool is sometimesreferred to as the client-side connection pool. The following is a sample configurationfile for the Teamcenter SOA connector that provides connection throttling:



<util:param name="CONNECTION_POOL_SIZE" value="4"/><util:param name="CONNECTION_POOL_REJUVENATION_RATE" value="15"/>

The Teamcenter server pool controls the supply of business logic server (TcServer)processes. It has settings to specify the number of active but unallocated serverprocesses, maximum number of server processes to run at a location, idle timeoutsettings, and other similar settings. The TcGS server SOA client-side connection poolcontrols TcGS server consumption provided by Teamcenter. The TcGS server can, inits SOA pool, control the amount of TcServer processes reused by the TcGS severbefore being retired, and the maximum number of concurrent TcServer processesthat the TcGS server consumes. It is important to make sure that the supply ofTcServer processes is sufficient to meet the peak demand specified by pooling, andthat the TcGS server has sufficient servers to quickly process data.

The following are important concepts when determining relative pool size:

C-2 Data Exchange Guide PLM00094 I

Data Exchange performance tuning

• The difference in pool sizes specified in TcGS server and Teamcenter Web-tierpools must be sufficient to maintain adequate levels of service for non-TcGSserver four-tier Teamcenter clients.

• The rate that the TcGS server retires TcServer instances (rejuvenation rate) ismeasured in TcGS server SOA connector calls. The longer the rejuvenation rate,the fewer warm servers are consumed as new dedicated servers. If warm serversare consumed too quickly, server unavailable errors can occur.

• Both standard (out-of-the-box) and custom TcServer code has a potentialto leak memory. If problematic server growth is observed, scale back therejuvenation rate and try to determine the cause. Any leak determined to be dueto out-of-the-box code requires filing a problem report (PR) through SiemensPLM Software.

Throttling mapperAs a large consumer of memory and CPU, it is important to throttle use of the GlobalServices mapper component. There are two throttling settings within the mapper.The first regulates the number of concurrent active mapping actions and has thewait in an inactive state.

Note Mapper throttling occurs within the BPEL mapping step. Therefore, thethrottling limit may be lower than the number of concurrent mapper actionsshown by the Data Exchange activity status table. This is because someactions are inactive. Mapping actions in inactive states result in increasedmapping times for transfers.

In addition to throttling active mapper processes, mapper depends on a Teamcenterconnection to receive FMS tickets. It is likely that Teamcenter connections in GlobalServices have been pooled and throttled (which is a default behavior in 8.1 andabove). Therefore, mapper processing may slow down due to Teamcenter servercontention with export and import processes in Data Exchange. To avoid thisissue, Siemens PLM Software recommends that the Teamcenter SOA connectionconfiguration in Global Services used by the mapper be separate from thatconfiguration used by other actions. The Teamcenter SOA connector configurationused for mapping is defined in the /config/globalservices.properties file in theGlobal Services data store.

…# -- This property sets the site ID of the default Teamcenter instance that is# defined for this particular Global Services instance. The proper value is# usually a 10-digit number,and will have a corresponding entry in# /config/SiteMap.xml.globalservices.default.tc.siteid=ChangeMe…

Teamcenter site configuration in Global Services properties file



…<smap:site site-id="-2142045694"><conn:data-source-spec JNDI-name="TcGSTeamcenterSOABox"config-name=" TcForMapperConfig" />

</smap:site>…

Teamcenter connector configuration in Global Services site map file

Because mappers use of Teamcenter is light-weight, a pool size of one TcServerprocess for mapping is normally sufficient.

…

<util:param name="CONNECTION_POOL_SIZE" value="1"/><util:param name="CONNECTION_POOL_REJUVENATION_RATE" value="15"/>…

Teamcenter connector throttling configuration for mapper

To use a separate connection configuration for mapper-initiated calls toTeamcenter, a dummy site ID is required. This site must have an entryin the Global Services data store in the /config/sitemap.xml file. Italso must have a globalservices.default.tc.siteid property entry in the/config/globalservices.properties file, Because this value is used only in GlobalServices, any unique integer value is valid.

BPEL performanceIn Teamcenter 8.3 or later, throttling the BPEL engine is managed through theunderlying Apache ODE 1.3 throttling mechanism. This mechanism provides value,but is not ideal. This is because it limits the number of BPEL processes that are runin parallel, but does not queue up additional requests for later processing. Thisexisting mechanism results in having additional requests, those beyond the numberof concurrent maximum BPEL processes, rejected.

When transfer activities include a very large number of objects, memory restrictionsmay cause the BPEL engine to miss scheduling export requests. To avoid this issue:

• In the ode-axis2.properties file, increase the value of theode-axis2.db.pool.max property, for example:

ode-axis2.db.pool.max=20

For more information about the ode-axis2.properties file, see the ApacheODE documentation.

• Change the ODE to not run in memory by updating theode-working-dir/processes/data-transfer/deploy.xml file asfollows:


http://ode.apache.org/controlling-odes-memory-footprint.html

http://ode.apache.org/controlling-odes-memory-footprint.html

Data Exchange performance tuning

1. Remove or comment out the <in-memory>true</in-memory> element.

2. Add a <process-events generate=”none”/> element after the<active>true</active> element.

Delete all .deployed files from the directory (delete *.deployed) and restartthe application server.

Logging configurationDue to the scope of logging in Teamcenter, the Data Exchange logging informationis limited to settings related to database sizing for the Global Services data store.In addition to the configuration settings maintained in the Global Services datastore, the database1 maintains information specific to individual transfers. BPELinformation is maintained as individual transfer data in the Global Services datastore. This information is generated by the BPEL process and is not subjected tosite-specific configuration. Activity status related information is also maintained asindividual transfer data in the data store.

Activity status configuration

The activity status information contains logging data generated from the exportingand importing systems. This information can be quite large. There are configurationsettings which allow this information to be truncated. The specific settings of interest(shown in the following figure) are in the /config/globalservices.properties file.

# This property sets the maximum length of a stack trace as it appears in# Activity Status records. If property not present, the default value is 750.

exception.serializer.trace.max.len=1000

# The globalservices.max.audit.string.length property sets the maximum length# of a string that would be put in the LOB fields of the Audit records. If# the property is commented out, content is inserted untruncated.

globalservices.max.audit.string.length=5000000

Activity status configuration settings

Setting the globalservices.max.audit.string.length property as non-truncatedmust not be done in a production system. Individual sites, based on their use ofactivity status information, have different balancing points for information andspace. These settings reflect those balance points.

Global Services logging configuration

The Global Services logging configuration can impact performance. Theout-of-the-box settings for Global Services logging (log4j.xml file) are set to optimizeperformance and provide sufficient error information. If logger settings are modified

1. The data store is contained in the database instance. However, these are not identical. In addition to containing the data store, theGlobal Services database contains BPEL tables which are outside of datastore control.



for test or debug purposes, the best practice is to set them back to default levels afterspecific needs are addressed.


Appendix

D Synchronizing a Teamcenterdatabase to an LDAP repository

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

ldapsync utility database update rules . . . . . . . . . . . . . . . . . . . . . . . D-1Object nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-2Direct and indirect memberships . . . . . . . . . . . . . . . . . . . . . . . . . . . D-2Internal and external objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-3Group membership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-3

Configuring the ldapsync utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-3Configure the connection to an LDAP server . . . . . . . . . . . . . . . . . . . D-3Configure the ldapsync utility for SSL . . . . . . . . . . . . . . . . . . . . . . . . D-4User and person mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-5

User and person mapping preferences . . . . . . . . . . . . . . . . . . . . . D-5Group and role mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-9

Group mapping preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . D-10Role mapping preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-11

Data synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-12Data synchronization preferences . . . . . . . . . . . . . . . . . . . . . . . D-12

Configuring the LDAP server database . . . . . . . . . . . . . . . . . . . . . . D-13Differentiate groups and roles . . . . . . . . . . . . . . . . . . . . . . . . . . D-14Link to separate LDAP directories . . . . . . . . . . . . . . . . . . . . . . D-14

Synchronize Teamcenter to an LDAP repository . . . . . . . . . . . . . . . . . . . D-15Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-15

Reset an external user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-15Search limitations for ldapsync . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-16

Search the base DN only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-16Search the base DN and one level under it . . . . . . . . . . . . . . . . . D-16

LDAP configuration examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-16Sun ONE Directory Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-16Microsoft Active Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-19


Appendix

D Synchronizing a Teamcenterdatabase to an LDAP repository

Synchronizing a Teamcenter database to an LDAP repositoryTeamcenter provides a batch utility that maps data constructs from an LDAPrepository to objects in the Teamcenter database. You can create, update, anddeactivate Teamcenter objects by making changes to the appropriate LDAPentries and then running the ldapsync utility. This tool is not required by DataExchange, however it can simplify your security configuration by synchronizing yourTeamcenter security objects to your LDAP configuration.

Even if you are not using Data Exchange, you can use this utility to synchronize yourLDAP configuration and Teamcenter security objects.

LDAP synchronization concepts

The objects synchronized by the ldapsync utility are users and their associatedpersons, groups, roles, and group memberships. Teamcenter uses preferences set atthe user location to control the synchronization process, providing flexibility in howthe ldapsync utility modifies the Teamcenter database.

The ldapsync utility does not change the LDAP repository, only the Teamcenterdatabase when differences exist between the two. The utility can generate anextensive log file that tracks objects that are modified and any error conditionsencountered during execution.

Users that you synchronize with the ldapsync utility must be authenticated throughTeamcenter Security Services; therefore, you must have Security Services installed.

ldapsync utility database update rules

You can control the following default behavior using Teamcenter preferences set atthe 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; itis deactivated in the database.

• If an object exists in both locations, the ldapsync utility compares the lastmodified timestamp in the LDAP repository to the last synchronized timestampin the Teamcenter database and updates the object in the database when theLDAP timestamp is more recent.

PLM00094 I Data Exchange Guide D-1

Appendix D Synchronizing a Teamcenter database to an LDAP repository

Object nodes

The ldapsync utility recognizes the following four types of entries or nodes in anLDAP repository:

• user• group• role• undefined

Group = Engineers

ou=ABC, dc=com

Shoreview Pune Ames

Group - synched

Users - synched

Roles - synchedRole = Coder

Role = Design

Company - ignored by ldapsync

Locations - ignored

User-C

User-B

User-A

User-F

User-E

User-D

Object nodes

The first three map directly to their equivalent objects in Teamcenter, with usernodes mapping to both Teamcenter person and Teamcenter user objects. Theldapsync utility also constructs group memberships from the combination of auser, role, and group node. Undefined nodes are useful within LDAP for providingclarity to the overall structure. For example, nodes of object class ou (organizationalunit) can be used to segregate users by geographical location without affecting theldapsync utility output.

Direct and indirect memberships

Direct or indirect membership describes how parent modes trace a path to theirchildren. In a direct membership, each child has exactly one parent and thatparent-child relationship conforms to parent-child connections in the LDAPrepository. In an indirect membership, a specific child node may have multipleparents, 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 LDAPserver. This type of membership is represented in the ldapsync utility by theLDAP_member_type_attr and LDAP_member_list_attr preferences at the sitelocation. If the LDAP_member_type_attr preference value is set to true, theldapsync utility uses the values in the LDAP_member_list_attr preference asa list of child distinguished names (DNs). Therefore, a specific child node can be

D-2 Data Exchange Guide PLM00094 I

Synchronizing a Teamcenter database to an LDAP repository

included multiple times, for example, if a person (represented by a user node) belongsto several project teams (represented by group nodes) each group node can point tothe same user node, rather than requiring a duplicate user node for each group’s use.

There is no way to easily determine how many indirect parents a node may have;however, this information has no known value at this time.

Internal and external objects

The ldapsync utility manages objects as internal or as external objects. Teamcentercreates all internally managed objects and only Teamcenter can modified them. Theldapsync utility can create and modify externally manage objects. An internallymanaged 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 LDAPrepository. The minimum requirement for a group membership is a groupnode and a user node. If a default role for a group is specified, a role node isoptional. The parent®®®child®®®grandchild relationship in LDAP is representedas group®®®optional-role-node®®®user. Intervening undefined nodes, such asorganizational units (ou) are ignored in the path, an example of this in the LDAPrepository is:

group®®®ou1®®®ou2®®®role®®®ou3®®®user

Configuring the ldapsync utilityYou configure the ldapsync utility primarily through Teamcenter preferences at thesite location. These preferences are divided into the following categories:

• Connection

• User and person mapping

• Group mapping

• Role mapping

• Synchronization

For information about the ldapsync utility preferences in these categories, see thePreferences and Environment Variables Reference.

The LDAP database server may require configuration depending on the objectsbeing synchronized.

Configure the connection to an LDAP server

In the rich client interface, choose Edit→Options and set the following preferencesunder the Configuration.LDAP.Connection category:

• LDAP_admin_dn



Defines the LDAP administrator’s name. Set this value to the DN of an LDAPuser who has search and read permissions in the LDAP directory service.

• LDAP_admin_pw

Specifies the password for the LDAP administrator identified by theLDAP_admin_dn preference. If you do not set this preference, you mustinclude a password using the –l argument for the ldapsync utility. Because thispassword is stored in the database in plain text, it is recommended that theassociated account have read-only access to the LDAP.

• LDAP_cert_db_path

Specifies the path to the directory containing the cert8.db (certificationdatabase) file. the ldapsync utility uses this value only when the LDAP_use_sslpreference 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 definean LDAP directory server connection.

• LDAP_service_hosts

Lists the host or hosts that provide LDAP directory services for this installation.Valid inputs are host names or IP addresses. This value is used with the valueset in the LDAP_port_number preference to define LDAP directory serverconnections.

• 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 thispreference 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–SSLmode before you configure it for secure socket layer (SSL) use. After you have theutility 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 theymay 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 MozillaWeb site.



1. Download the certutil executable from the Mozilla Web site. The executable ispackaged 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 LDAPperson object. When the ldapsync utility identifies an LDAP person object forsynchronization, it creates both a user object and a person object in Teamcenter. TheinetOrgPerson class is the standard LDAP person object class for a Sun ONEDirectory 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 Mappingpreferences category.

• LDAP_attribute_mapping

Defines the mapping of LDAP objects to Teamcenter user attributes using setsof three strings, for example:

LDAP_attribute_mapping=LDAPPersonNamecn%REPLACE_ME%LDAPEngUserIduid



%REPLACE_ME%LDAPLastUpdatemodifyTimestamp%REPLACE_ME%LDAPOsUseruid%REPLACE_ME%LDAPUserGroup%REPLACE_ME%EngineeringLDAPUserRole%REPLACE_ME%%REPLACE_ME%

Each attribute map can contain string values for the following:

o Teamcenter attribute nameo Mapped LDAP attributeo Default value used if there is no mapped LDAP attribute or if the mapped

LDAP attribute value is null

Attribute name LDAP attributeDefaultvalue Description

LDAPEngUserId uid Does notapply

User ID

LDAPLastUpdate modifyTimestamp Does notapply

Last updatetimestamp

LDAPOsUser uid None Operatingsystem username.

LDAPPersonName cn Does notapply

Person name

LDAPUserGroup Undefined Engineering Defaultgroup

LDAPUserRole Undefined None Default role

The LDAPLastUpdate attribute is used for synchronization checks but is notset in the Teamcenter role object.

Caution The LDAPUserGroup and LDAPUserRole attributes are requiredin Teamcenter. Therefore, you must specify either a mapped LDAPattribute or a default value for these attributes.

• LDAP_person_attr_mapping

Defines the mapping of LDAP objects to Teamcenter person attributes using setsof three strings, for example:

Note This example uses generic person attribute values (PA1–PA10)

LDAP_person_attr_mapping=LDAPPersonNamecn%REPLACE_ME%



LDAPLastUpdatemodifyTimestamp%REPLACE_ME%PA1postaladdress%REPLACE_ME%PA2localityName%REPLACE_ME%PA3st%REPLACE_ME%PA4postalCode%REPLACE_ME%PA5co%REPLACE_ME%PA6o%REPLACE_ME%PA7employeeNumber%REPLACE_ME%PA8physicalDeliveryOfficeName%REPLACE_ME%PA9mail%REPLACE_ME%PA10telephoneNumber%REPLACE_ME%



LDAP attribute value is null.


LDAPPersonName cn Does notapply

Personname

LDAPLastUpdate modifyTimestamp None Last updatetimestamp

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 Employeenumber

PA8 physicalDeliveryOfficeName None Internalmail code

PA9 mail None E-mailaddress

PA10 telephoneNumber None Telephonenumber


• LDAP_base_dn

Defines the distinguished name (DN) of one or more nodes in the external LDAPdirectory where the user and person synchronization process starts. Use this tolimit the extent of the ldapsync utility user and person search for performancereasons or to partition users in a single LDAP directory server instance foruse with multiple Teamcenter installation. If the LDAP directory server doesnot have this type of organization, set this value to the lowest level DNs thatencompass all Teamcenter users.

The following are examples of a high level DN and a more specific DN,respectively:

dc=siemens,dc=com

ou=Engineering Groups,ou=specials users,db=siemens,dc=com

• LDAP_ignore_users

Defines Teamcenter user IDs that the ldapsync utility does not process. Thedefault value is infodba.

Note The ldapsync utility never processes the infodba user even if it is notincluded in this list.

This allows you to include a list of user IDs that exist in Teamcenter foradministrative purposes that do not have corresponding entries in the LDAPrepository.

• LDAP_user_object_class

Defines the LDAP object class you use to indicate which Teamcenter users tosynchronize. If you use multiple classes to represent Teamcenter users, specifythe 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 Teamcenteruser object for synchronization. Use LDAP query filter syntax for this preferencevalue. The default value is uid=*.



Group and role mapping

You can map the Teamcenter group and role objects from the LDAP group object anda mapped default role attribute. You can also specify roles in their own LDAP groupobject. 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 canconfigure a different class for each object type.

The standard LDAP role object is not supported for mapping to Teamcenter becauseLDAP roles are global and attached to the person object. Teamcenter requires roleconstructs that are configured specifically within the context of a group. If yourequire non-default roles, you may have to alter the LDAP schema.

For more information, see Differentiate groups and roles.

LDAP group and role object mapping

Three new LDAP object attributes are required to support group and role objectmapping. Add these to the standard LDAP group object schema. Although allthree attributes are optional, the following are required to support LDAP objectmembership models:

object_type Specifies a string attribute that allows Teamcenter todistinguish which groupOfUniqueNames class instancesrepresent Teamcenter groups or roles. Valid values of thisattribute are group and role. The default value is group.An alternative to using this attribute is to create separategroupOfUniqueNames subclasses for Teamcenter groupsand roles to differentiate them.

member_type Specifies a logical attribute that allows Teamcenter todistinguish the membership model to use to determine thechildren of this group or role. Valid values are True (indicatesindirect) or False (indicates direct). The default value is True.

memberDNs Specifies a list of string attributes that allow Teamcenter to findthe children member DNs for the group or role for an indirectmembership type. This is not valid for direct membership type.



Group mapping preferences

These preferences are in the Configuration.LDAP.Group Mapping preferencescategory.

• LDAP_group_attr_mapping

Defines the mapping of LDAP objects to Teamcenter group attributes using setsof three strings, for example:

LDAP_group_attr_mapping=LDAPGroupNamecn%REPLACE_ME%LDAPGroupDescdescription%REPLACE_ME%LDAPLastUpdatemodifyTimestamp%REPLACE_ME%LDAPGroupDBA%REPLACE_ME%0LDAPGroupRole%REPLACE_ME%%REPLACE_ME%





LDAPGroupDBA Undefined None Group DBAprivilege

LDAPGroupDesc description None Groupdescription

LDAPGroupName cn Does notapply

Group name

LDAPGroupRole Undefined None Default role

LDAPLastUpdate modifyTimestamp Does notapply

Last updatetimestamp


• LDAP_group_base_dn

Defines the distinguished name (DN) of one or more nodes in the externalLDAP directory where the group synchronization process starts. Use this tolimit the extent of the ldapsync utility group search for performance reasonsor to partition groups in a single LDAP directory server instance for use withmultiple Teamcenter installation. If the LDAP directory server does not have



this type of organization, set this value to the lowest level DNs that encompassesall 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 which Teamcenter groups tosynchronize. If you use multiple classes to represent Teamcenter groups, specifythe common base class. The default value is groupOfUniqueNames.

This allows you to define specific subclasses in LDAP to differentiate groupsand roles. If your groups and roles have the same object class, use theLDAP_object_type_attr preference instead.

• LDAP_group_query_filter

Defines the set of conditions an LDAP object must satisfy to match a Teamcentergroup object for synchronization. Use LDAP query filter syntax for thispreference value. The default value is cn=*.

Role mapping preferences

These preferences are in the Configuration.LDAP.Role Mapping preferencescategory.

• LDAP_role_attr_mapping

Defines the mapping of LDAP objects to Teamcenter role attributes using setsof three strings, for example:

LDAP_role_attr_mapping=LDAPRoleNamecn%REPLACE_ME%LDAPRoleDescdescription%REPLACE_ME%LDAPLastUpdatemodifyTimestamp%REPLACE_ME%





LDAPLastUpdate modifyTimestamp None Last updatetimestamp

LDAPRoleDesc description None Roledescription




LDAPRoleName cn None Role name

The LDAPLastUpdate attribute is used for synchronization checks but is notset in the Teamcenter group object.

• LDAP_role_object_class

Defines the LDAP object class you use to indicate which Teamcenter roles tosynchronize. If you use multiple classes to represent Teamcenter roles, specifythe common base class. The default value is groupOfUniqueNames.

This allows you to define specific subclasses in LDAP to differentiate groupsand roles. If your groups and roles have the same object class, use theLDAP_object_type_attr preference instead.

• LDAP_group_query_filter

Defines the set of conditions an LDAP object must satisfy to match a Teamcenterrole object for synchronization. Use LDAP query filter syntax for this preferencevalue. The default value is cn=*.

Data synchronization

LDAP data synchronization uses three preference types:

• Indirect membership preferences (LDAP_member_list_attr andLDAP_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.

Data synchronization preferences

These preferences are in the Configuration.LDAP.Synchronization preferencescategory.

• LDAP_member_list_attr

Defines the LDAP attribute containing a list of member DNs for this object. Theldapsync utility uses this value only when the LDAP_member_type_attr isset. 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 valueof this preference which contains a logical value indicating whether the objecthas 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 setto true for indirect children or false for direct children.

This preference applies to objects representing either groups or roles definedin LDAP.

If you set this preference, you must also set the LDAP_member_list_attrpreference.

• LDAP_object_type_attr

Defines an LDAP attribute that contains the object type for this object. Thisapplies to group or role objects defined in LDAP. The object name must referencea string attribute defined in the LDAP group object that is set to either group orrole. For example, if you set the preference value to objectType, your LDAPmust 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 followingtable. The deactivate flag is not valid for this preference. The default valueis scue.

• LDAP_sync_member_flags

Defines the synchronization for members using the flags described in thefollowing table. The deactivate flag is not valid for this preference. The defaultvalue is scue.

• LDAP_sync_role_flags

Defines the synchronization for roles using the flags described in the followingtable. The deactivate flag is not valid for this preference. The default valueis scue.

• LDAP_sync_user_flags

Defines the synchronization for users using the flags described in the followingtable. The default value is scdue.

Flag Action Descriptionc Create Allows creation of externally managed objects in Teamcenter.

d Deactivate Allows deactivation of externally managed objects inTeamcenter.

e Externalize Allows conversion of internally managed Teamcenter objectsthat have corresponding objects in LDAP to externallymanaged objects.

s Synchronize Enables synchronization.u Update Allows updates to externally managed objects in Teamcenter.

Configuring the LDAP server database

You may need to configure the LDAP server database to allow the ldapsync utilityto differentiate between groups and roles or to search a separate directory structure.



Differentiate groups and roles

There are two ways to indicate to the ldapsync utility that an object isa group or role. You can assign a unique object class for each or use theLDAP_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 theunique groupOfUniqueGroupNames class for groups and thegroupOfUniqueRoleNames class for roles.

2. Add the unique object class to the group or role that you want to define.

3. Set ldapsync preferences. For this example, set the following preferences:LDAP_group_object_class: groupOfUniqueGroupNamesLDAP_role_object_class: groupOfUniqueRoleNames

For information about these preferences, see the Preferences and EnvironmentVariables Reference.

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. Forexample, add the objectType attribute to the groupOfUniqueNames objectclass.

For information about the objectType attribute, see Group and role mapping.

3. Set the LDAP_group_object_class, LDAP_role_object_class, andLDAP_object_type_attr preferences. For this example, set the preferences asfollows:

LDAP_group_object_class: groupOfUniqueNamesLDAP_role_object_class: groupOfUniqueNamesLDAP_object_type_attr: objectType


Link to separate LDAP directories

The ldapsync utility reads a directory structure starting at the specified baseDNdirectory and continues until it has read all of the child nodes. If separate directorystructures must be searched that are not under the baseDN directory, configureLDAP member attributes as follows:

1. Add a unique attribute to the LDAP server, such as the LDAP_child attribute.

2. Add the attribute to a group or role with the attribute value set to the otherDN directory. You can configure multiple LDAP_child attributes under eachgroup or role.

Caution To avoid an infinite loop, ensure the DN you provide in theLDAP_child attribute does not point back to the original DN.



3. Set the LDAP_member_type_attr attribute as for direct or indirect searchingand the LDAP_member_list_attr attribute to the unique attribute. Forexample, if you add the LDAP_child attribute and are using indirect searching:

LDAP_member_type: trueLDAP_member_list_attr: LDAP_child


Synchronize Teamcenter to an LDAP repositoryNote 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 Teamcenterenvironment settings by clicking the Start button and choosing the followingmenu commands:

Programs→UGS Teamcenter 10.1→Teamcenter10.1→ service-name_configuration-ID Command Prompt

Replace service-name and configuration-ID with the Teamcenter service nameand configuration ID you entered during installation.

2. Enter the following command to synchronize Teamcenter to your LDAPrepository:

ldapsync –u=userid -p=password —g=group —l=ldap-password

Replace userid and password with a Teamcenter administrative user ID andpassword. Replace ldap-password with the password for the DN of an LDAPuser who has search and read permissions in the LDAP directory service.

Note The –l=ldap-password argument is not required if you set theLDAP_admin_pw preference.

For more information about the ldapsync utility and its syntax, see the UtilitiesReference.

Troubleshooting

You can determine or fix the following ldapsync utility issues:

• An object is set incorrectly as internally or externally managed.

• The ldapsync utility cannot analyze children nodes due to search limitations.

Reset an external user

Use the make_user utility to fix an object incorrectly set to internally or externallymanaged. The –datasource=0 argument resets the object to internally managed orthe –datasource=1 sets it to externally managed. You can set the data source forusers, groups, roles, persons, and group members. To set the data source for a groupmember, 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

For information about the make_user utility, see the Utilities Reference.

Search limitations for ldapsync

The ldapsync utility uses two kinds of LDAP searches; a base-level search (onlysearch the current node), and a one-level search (search the current node and allnodes one level under the current node). If any of the nodes have an LDAP accesscontrol list (ACL) that prevents searches on that node, the ldapsync utility cannotanalyze it and the utility cannot continue searching on any of its children. To checkfor an ACL that prevents searches, use an LDAP directory search tool, such asldapsearch.

Search the base DN only

To search the base DN only on a Sun ONE Directory Server, type: ldapsearch -bo={baseDN} -h "{host-name}" -p 389 -s base "(cn=*)"

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

LDAP configuration examples

The examples show how you can configure two commonly used LDAP servers, SunONE Directory Server and Microsoft Active Directory.

Sun ONE Directory Server

The following table provides an example of configuring Teamcenter preferences tosynchronize a Sun ONE Directory Server to the Teamcenter database.

Preference list Sun ONE Directory Server values

LDAP_admin_dn cn=Directory-Manager

LDAP_admin_pw password




LDAP_attribute_mapping LDAPPersonNamecn%REPLACE_ME%LDAPEngUserIduid%REPLACE_ME%LDAPLastUpdatemodifyTimestamp%REPLACE_ME%LDAPOsUseruid%REPLACE_ME%LDAPUserGroup%REPLACE_ME%EngineeringLDAPUserRole%REPLACE_ME%Designer

LDAP_base_dn dc=company-name, dc=com

LDAP_cert_db_path

LDAP_group_attr_mapping LDAPGroupNamecn%REPLACE_ME%LDAPGroupDescdescription%REPLACE_ME%LDAPLastUpdatemodifyTimestamp%REPLACE_ME%LDAPGroupDBA%REPLACE_ME%0LDAPGroupRole%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 LDAPPersonNamecn%REPLACE_ME%LDAPLastUpdatemodifyTimestamp%REPLACE_ME%PA1postalAddress%REPLACE_ME%PA2localityName%REPLACE_ME%PA3st%REPLACE_ME%PA4postalCode%REPLACE_ME%PA5co%REPLACE_ME%PA6o%REPLACE_ME%PA7employeeNumber%REPLACE_ME%PA8physicalDeliveryOfficeName%REPLACE_ME%PA9mail%REPLACE_ME%PA10telephoneNumber%REPLACE_ME%

LDAP_port_number port-number

LDAP_role_attr_mapping LDAPRoleNamecn%REPLACE_ME%LDAPRoleDescdescription%REPLACE_ME%LDAPLastUpdatemodifyTimestamp%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 tosynchronize a Microsoft Active Directory LDAP server to the Teamcenter database.

Preference list Active Directory values

LDAP_admin_dn [email protected]

LDAP_admin_pw password

LDAP_attribute_mapping LDAPPersonNamecn%REPLACE_ME%LDAPEngUserIdsAMAccountName%REPLACE_ME%LDAPLastUpdatewhenChanged%REPLACE_ME%LDAPOsUsersAMAccountName%REPLACE_ME%LDAPUserGroup%REPLACE_ME%EngineeringLDAPUserRole%REPLACE_ME%Designer

LDAP_base_dn dc=company-name, dc=com

LDAP_cert_db_path



Preference list Active Directory values

LDAP_group_attr_mapping LDAPGroupNamecn%REPLACE_ME%LDAPGroupDescdescription%REPLACE_ME%LDAPLastUpdatewhenChanged%REPLACE_ME%LDAPGroupDBA%REPLACE_ME%0LDAPGroupRole%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 LDAPPersonNamecn%REPLACE_ME%LDAPLastUpdatemodifyTimestamp%REPLACE_ME%PA1postaladdress%REPLACE_ME%PA2localityName%REPLACE_ME%PA3st%REPLACE_ME%PA4postalCode%REPLACE_ME%PA5co%REPLACE_ME%PA6



Preference list Active Directory valueso%REPLACE_ME%PA7employeeNumber%REPLACE_ME%PA8physicalDeliveryOfficeName%REPLACE_ME%PA9mail%REPLACE_ME%PA10telephoneNumber%REPLACE_ME%

LDAP_port_number port-number

LDAP_role_attr_mapping LDAPRoleNamecn%REPLACE_ME%LDAPRoleDescdescription%REPLACE_ME%LDAPLastUpdatewhenChanged%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 Teamcenter core data dictionary


Appendix

E 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 TCXML file).

Note When using the bulk load utility (txcml_import), the utility sets appropriatevalues for attributes that are not mandatory. This type of activity must bedone 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

ead_paragraph No

elemId Yes

global_alt_list No

gov_classification No

has_variant_module No

ip_classification No

is_configuration_item No

is_vi No

island_id Yes

item_id Yes

last_mod_date No

last_mod_user YesPoints to the Userelement in the TC XMLfile.

PLM00094 I Data Exchange Guide E-1

Appendix E Teamcenter core data dictionary

Item attributes


license_list No

lsd No

object_application Yes Typically set toTeamcenter.

object_desc No

object_name Yes

object_properties No

object_type Yes

owning_group YesPoints to the Groupelement in the TC XMLfile.

owning_organization No

owning_project No

owning_site YesPoints to the POM_imcelement in the TC XMLfile.

owning_user YesPoints to the Userelement in the TC XMLfile.

parent_uid Yes

pid No Class-id. Fast importignores this attribute.

preferred_global_alt No

process_stage_list No

project_list No

puid Yes

release_status_list No

revision_limit Yes Typically set to 1.

revision_number Yes Typically set to 0.

timestamp No

uom_tag No

wso_thread No

Anchor elements


acl_bits No

E-2 Data Exchange Guide PLM00094 I

Teamcenter core data dictionary

Anchor elements


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 YesPoints to the Userelement in the TCXML file.

lsd No

managed_objects No



owning_user YesPoints to the Userelement in the TCXML file.

owning_site YesPoints to thePOM_imc elementin the TC XML file.

parent_uid Yes

puid Yes

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

items_tag YesHolds the PUID valueof the correspondingItem.

last_mod_date No


license_list No

lsd No

object_application No

object_desc No

object_name Yes


object_type Yes



owning_project No



parent_uid Yes





pid YesThe class-id. Fastimport ignores theattribute.


project_list No

puid Yes




sequence_anchor YesHolds the PUID valueof the correspondingAnchor 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



Form attributes


last_mod_date No

last_mod_userPoints to the Userelement in the TCXML file.

license_list No

lsd No


object_desc No

object_name Yes


object_type Yes



owning_project No



parent_uid Yes

pid YesThe class-id. Fastimport ignores theattribute.


project_list No

puid Yes




timestamp No

wso_thread No



ImanRelation attributes


elemId Yes

island_id Yes

lsd No



parent_uid Yes

pid YesThe class-id attribute.Fast Import ignoresthe attribute.

primary_object Yes

Holds the PUID valueof the primary objectof the ImanRelationobject.

puid Yes

relation_type Yes

Points to thecorrespondingImanType elementin the TC XML file.

secondary_object Yes

Holds the PUID valueof the secondary objectof the ImanRelationobject.

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


license_list No

lsd No


object_desc No

object_name Yes



object_type Yes



parent_item Yes

parent_uid Yes

pid NoThe class-id attribute.Fast Import ignoresthe attribute.


project_list No

puid Yes








timestamp No

view_type YesPoints to thePSViewType elementin the TC XML file.

wso_thread No

PSBOMViewRevision attributes


acl_bits No

active_seq No

archive_date No

archive_info No

backup_date No

bom_view Yes

Points the PUID valueof the correspondingPSBOMViewelement.

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


license_list No

lsd No


object_desc No

object_name Yes



PSBOMViewRevision attributes



object_type Yes



owning_project No

owning_site Yes

Required for LL TCXML. Points to thePOM_imc element inthe TC XML file.


parent_uid Yes

pid Yes


project_list No

puid Yes




struct_last_mod_date Yes

timestamp No

wso_thread No

PSOccurrence attributes


alternate_etc_ref No

child_item YesPoints the PUID valueof the correspondingitem.

child_bv No

effectivities No

elemId Yes

island_id Yes

lsd No



PSOccurrence attributes


notes_ref No


occ_thread Yes

Points the PUID valueof the correspondingPSOccurrenceThreadelement in the TCXML file.

occ_flags No

occ_type No

occurrence_type No

order_no No Typically set to 10.


parent_bvr Yes

Points the PUID valueof the correspondingPSBOMViewRevisionelement in the TCXML file.

parent_uid Yes Required for low-levelTC 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



PSOccurenceThread attributes


lsd No



parent_uid Yes

pid YesThe class-id attribute.Fast import ignoresthis attribute.

puid Yes

timestamp No

Dataset attributes


acl_bits No

active_seq No

archive_date No

archive_info No

backup_date No

creation_date No

dataset_type YesPoints to theDatasetType elementin the TC XML file.

date_released No

ead_paragraph No

elemId Yes

format_used No



island_id Yes

last_mod_date No


license_list No

local_path No



Dataset attributes


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




parent_uid Yes

pid No


project_list No

puid Yes

ref_names No

ref_list Yes

Holds the PUID valueof the correspondingImanFile element inthe TC XML file.

ref_types No




Dataset attributes


rev_chain_anchor Yes

Holds the PUID valueof the correspondingRevisionAnchorelement in the TCXML file.



system_managed No

tool_used YesPoints to the Toolelement in the TCXML 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

last_mod_user YesPoints to the Userelement in the TC XMLfile.

lsd No





RevisionAnchor attributes


owning_user YesPoints to the Userelement in the TC XMLfile.

owning_site YesPoints to the POM_imcelement in the TC XMLfile.

parent_uid Yes

pid Yes

puid Yesrev No

revisions YesHolds the values of thecorresponding Datasetrevisions.

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


lsd No

machine_type No


original_file_name No



ImanFile attributes





parent_uid Yes

pid YesThe class-id attribute.Fast import ignoresthis attribute.

puid Yes

relative_directory_path No

released_version No

sd_path_name Yes

Contains the relativepath of the legacy filefrom the logical volumeroot.

status_flag No

store_and_forward_flag No

text_flag No

time_last_modified No

timestamp No

translate No

volume_tag YesPoints to theImanVolume elementin the TC XML file.

vm_info No

User attributes


elemId Yes

island_id Yes

user_id Yes Candidate key



Group attributes


elemId Yes

island_id Yesname Yes Candidate key

Tool attributes


elemId Yes

island_id Yes

object_name Yes

Candidate key

ImanType attributes


elemId Yes

island_id Yes

type_class Yes Candidate key

type_name Yes Candidate key

ImanVolume attributes


elemId Yes

island_id Yes

volume_name Yes

Candidate key

DataseType attributes


elemId Yes



DataseType attributes


datasettype_name Yes

Candidate key

island_id Yes


Appendix

F Teamcenter data model diagram


Appendix

F Teamcenter data model diagram

PLM00094 I Data Exchange Guide F-1

Appendix F Teamcenter data model diagram

F-2 Data Exchange Guide PLM00094 I

Appendix

G Sample assembly structurein a TC XML file


Appendix

G Sample assembly structurein 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 datasetobject attached to the Child_1 object:

The following figure shows the relationships between the objects.

PLM00094 I Data Exchange Guide G-1

Appendix G Sample assembly structure in a TC XML file

G-2 Data Exchange Guide PLM00094 I

Appendix

H Sample TC XML file withGSID references


Appendix

H Sample TC XML file withGSID 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"><GSIdentity elemId="id76" label="LegacyIDid76one" /></ImanType>

- <User elemId="id3" island_id="0" user_id="infodba"><GSIdentity elemId="id77" label="LegacyIDid77one" /></User>

- <PSViewType elemId="id4" island_id="0" name="view"><GSIdentity elemId="id78" label="LegacyIDid78one" /></PSViewType>

+ <POM_imc elemId="id5" island_id="0" site_id="-1589622576">+ <ItemRevision acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""

creation_date="2010-09-29T10:23:07Z" date_released="" declared_options="" ead_paragraph="" elemId="id6"gde_bvr_list="" gov_classification="" has_variant_module="" ip_classification="" island_id="5"item_revision_id="A" items_tag="#id81" last_mod_date="2010-09-29T10:23:07Z" last_mod_user="#id77"license_list="" lsd="2010-09-29T10:23:07Z" object_application="Teamcenter" object_desc=""object_name="onec" object_properties="0" object_type="ItemRevision" owning_group="#id75"owning_organization="" owning_project="" owning_user="#id77" parent_uid="#id81" pid="758"process_stage_list="" project_list="" release_status_list="" revision_limit="1" revision_number="0"sequence_anchor="#id82" sequence_id="1" sequence_limit="3" timestamp="QpHx6UvxI45M1A" used_options=""variant_expression_block="" wso_thread="">

- <Item acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date="" configuration_object_tag=""creation_date="2010-09-29T10:23:06Z" date_released="" ead_paragraph="" elemId="id7" global_alt_list=""gov_classification="" has_variant_module="" ip_classification="" is_configuration_item="" is_vi=""island_id="5" item_id="onec" last_mod_date="2010-09-29T10:23:07Z" last_mod_user="#id77" license_list=""lsd="2010-09-29T10:23:07Z" object_application="Teamcenter" object_desc="" object_name="onec"object_properties="0" object_type="Item" owning_group="#id75" owning_organization="" owning_project=""owning_user="#id77" parent_uid="" pid="564" preferred_global_alt="" process_stage_list="" project_list=""release_status_list="" revision_limit="1" revision_number="0" timestamp="QpIx6UvxI45M1A" uom_tag=""wso_thread=""><GSIdentity elemId="id81" label="LegacyIDid81one" /></Item>

- <Anchor acl_bits="0" archive_date="" archive_info="" backup_date="" creation_date="2010-09-29T10:23:07Z"elemId="id8" immune_objects="" island_id="5" keep_limit="3" last_mod_date="2010-09-29T10:23:07Z"last_mod_user="#id77" lsd="2010-09-29T10:23:07Z" managed_objects="" object_properties="0"owning_group="#id75" owning_user="#id77" parent_uid="#id80" pid="520" timestamp="QlMx6UvxI45M1A"><GSIdentity elemId="id82" label="LegacyIDid82one" /></Anchor>

- <ImanRelation elemId="id9" island_id="5" lsd="2010-09-29T10:23:06Z" object_properties="0" parent_uid="#id81"pid="443" primary_object="#id81" relation_type="#id76" secondary_object="#id85" timestamp="QhGx6UvxI45M1A"user_data=""><GSIdentity elemId="id83" label="LegacyIDid83one" /></ImanRelation>

- <ImanRelation elemId="id10" island_id="5" lsd="2010-09-29T10:23:07Z" object_properties="0" parent_uid="#id80"pid="443" primary_object="#id80" relation_type="#id76" secondary_object="#id86" timestamp="QpEx6UvxI45M1A"user_data=""><GSIdentity elemId="id84" label="LegacyIDid84one" /></ImanRelation>

- <Form acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""creation_date="2010-09-29T10:23:06Z" data_file="" date_released="" ead_paragraph="" elemId="id11"form_file="n/a" gov_classification="" ip_classification="" island_id="5"last_mod_date="2010-09-29T10:23:06Z" last_mod_user="#id77" license_list="" lsd="2010-09-29T10:23:06Z"object_application="Teamcenter" object_desc="" object_name="onec" object_properties="0"object_type="Item Master" owning_group="#id75" owning_organization="" owning_project="" owning_user="#id77"parent_uid="#id83" pid="555" process_stage_list="" project_list="" release_status_list=""revision_limit="1" revision_number="0" timestamp="QdEx6UvxI45M1A" wso_thread=""><GSIdentity elemId="id85" label="LegacyIDid85one" /></Form>

- <Form acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""creation_date="2010-09-29T10:23:07Z" data_file="" date_released="" ead_paragraph="" elemId="id12"form_file="n/a" gov_classification="" ip_classification="" island_id="5"last_mod_date="2010-09-29T10:23:07Z" last_mod_user="#id77" license_list="" lsd="2010-09-29T10:23:07Z"object_application="Teamcenter" object_desc="" object_name="onec/A" object_properties="0"object_type="ItemRevision Master" owning_group="#id75" owning_organization="" owning_project=""owning_user="#id77" parent_uid="#id84" pid="555" process_stage_list="" project_list=""

PLM00094 I Data Exchange Guide H-1

Appendix H Sample TC XML file with GSID references

release_status_list="" revision_limit="1" revision_number="0" timestamp="QpBx6UvxI45M1A" wso_thread=""><GSIdentity elemId="id86" label="LegacyIDid86one" /></Form>

- <ItemRevision acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""creation_date="2010-09-29T10:23:35Z" date_released="" declared_options="" ead_paragraph="" elemId="id13"gde_bvr_list="" gov_classification="" has_variant_module="" ip_classification="" island_id="3"item_revision_id="A" items_tag="#id88" last_mod_date="2010-09-29T10:24:26Z" last_mod_user="#id77"license_list="" lsd="2010-09-29T10:24:26Z" object_application="Teamcenter" object_desc=""object_name="one" object_properties="0" object_type="ItemRevision" owning_group="#id75"owning_organization="" owning_project="" owning_user="#id77" parent_uid="#id88" pid="758"process_stage_list="" project_list="" release_status_list="" revision_limit="1" revision_number="0"sequence_anchor="#id93" sequence_id="1" sequence_limit="3" structure_revisions="#id92"timestamp="gBLx6UvxI45M1A" used_options="" variant_expression_block="" wso_thread=""><GSIdentity elemId="id87" label="LegacyIDid87one" /></ItemRevision>

- <Item acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date="" bom_view_tags="#id90"configuration_object_tag="" creation_date="2010-09-29T10:23:35Z" date_released="" ead_paragraph=""elemId="id14" global_alt_list="" gov_classification="" has_variant_module="" ip_classification=""is_configuration_item="" is_vi="" island_id="3" item_id="one" last_mod_date="2010-09-29T10:24:26Z"last_mod_user="#id77" license_list="" lsd="2010-09-29T10:24:26Z" object_application="Teamcenter"object_desc="" object_name="one" object_properties="0" object_type="Item" owning_group="#id75"owning_organization="" owning_project="" owning_user="#id77" parent_uid="" pid="564"preferred_global_alt="" process_stage_list="" project_list="" release_status_list="" revision_limit="1"revision_number="0" timestamp="gBMx6UvxI45M1A" uom_tag="" wso_thread=""><GSIdentity elemId="id88" label="LegacyIDid88one" /></Item>

- <PSOccurrence alternate_etc_ref="" child_bv="" child_item="#id81" effectivities="" elemId="id15"island_id="3" lsd="2010-09-29T10:24:26Z" notes_ref="" object_properties="0" occ_flags="0"occ_thread="#id91" occ_type="" occurrence_type="0" order_no="10" parent_bvr="#id92" parent_uid="#id92"pid="783" pred_list="" qty_value="-1" seq_no="10" timestamp="gBEx6UvxI45M1A" uom_tag="" used_options=""variant_condition="" xform=""><GSIdentity elemId="id89" label="LegacyIDid89one" /></PSOccurrence>

- <PSBOMView acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""creation_date="2010-09-29T10:24:16Z" date_released="" ead_paragraph="" elemId="id16"gov_classification="" ip_classification="" island_id="3" last_mod_date="2010-09-29T10:24:16Z"last_mod_user="#id77" license_list="" lsd="2010-09-29T10:24:16Z" object_application="Teamcenter"object_desc="" object_name="one-View" object_properties="0" object_type="BOMView" owning_group="#id75"owning_organization="" owning_project="" owning_user="#id77" parent_item="#id88" parent_uid="#id88"pid="594" process_stage_list="" project_list="" release_status_list="" revision_limit="1"revision_number="0" timestamp="Q5Nx6UvxI45M1A" view_type="#id78" wso_thread=""><GSIdentity elemId="id90" label="LegacyIDid90one" /></PSBOMView>

- <PSOccurrenceThread clone_stable_occ_uid="AAAAAAAAAAAAAA" elemId="id17" island_id="3"lsd="2010-09-29T10:24:26Z" object_properties="0" parent_uid="#id89" pid="256" timestamp="gBDx6UvxI45M1A"><GSIdentity elemId="id91" label="LegacyIDid91one" /></PSOccurrenceThread>

- <PSBOMViewRevision acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""bom_view="#id90" creation_date="2010-09-29T10:24:17Z" date_released="" ead_paragraph="" elemId="id18"gov_classification="" ip_classification="" is_precise="0" island_id="3"last_mod_date="2010-09-29T10:24:26Z" last_mod_user="#id77" license_list="" lsd="2010-09-29T10:24:26Z"object_application="Teamcenter" object_desc="" object_name="one/A-View" object_properties="0"object_type="BOMView Revision" owning_group="#id75" owning_organization="" owning_project=""owning_user="#id77" parent_uid="#id87" pid="595" process_stage_list="" project_list=""release_status_list="" revision_limit="1" revision_number="0" struct_last_mod_date="2010-09-29T10:24:26Z"timestamp="gBCx6UvxI45M1A" wso_thread=""><GSIdentity elemId="id92" label="LegacyIDid92one" /></PSBOMViewRevision>

- <Anchor acl_bits="0" archive_date="" archive_info="" backup_date="" creation_date="2010-09-29T10:23:35Z"elemId="id19" immune_objects="" island_id="3" keep_limit="3" last_mod_date="2010-09-29T10:23:35Z"last_mod_user="#id77" lsd="2010-09-29T10:23:35Z" managed_objects="" object_properties="0"owning_group="#id75" owning_user="#id77" parent_uid="#id87" pid="520" timestamp="QtIx6UvxI45M1A"><GSIdentity elemId="id93" label="LegacyIDid93one" /></Anchor>

- <ImanRelation elemId="id20" island_id="3" lsd="2010-09-29T10:23:35Z" object_properties="0" parent_uid="#id88"pid="443" primary_object="#id88" relation_type="#id76" secondary_object="#id96" timestamp="QtCx6UvxI45M1A"user_data=""><GSIdentity elemId="id94" label="LegacyIDid94one" /></ImanRelation>

- <ImanRelation elemId="id21" island_id="3" lsd="2010-09-29T10:23:35Z" object_properties="0" parent_uid="#id87"pid="443" primary_object="#id87" relation_type="#id76" secondary_object="#id97" timestamp="QtPx6UvxI45M1A"user_data=""><GSIdentity elemId="id95" label="LegacyIDid95one" /></ImanRelation>

- <Form acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""creation_date="2010-09-29T10:23:35Z" data_file="" date_released="" ead_paragraph="" elemId="id22"form_file="n/a" gov_classification="" ip_classification="" island_id="3"last_mod_date="2010-09-29T10:23:35Z" last_mod_user="#id77" license_list="" lsd="2010-09-29T10:23:35Z"object_application="Teamcenter" object_desc="" object_name="one" object_properties="0"object_type="Item Master" owning_group="#id75" owning_organization="" owning_project="" owning_user="#id77"parent_uid="#id94" pid="555" process_stage_list="" project_list="" release_status_list=""revision_limit="1" revision_number="0" timestamp="QpPx6UvxI45M1A" wso_thread=""><GSIdentity elemId="id96" label="LegacyIDid96one" /></Form>

- <Form acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""creation_date="2010-09-29T10:23:35Z" data_file="" date_released="" ead_paragraph="" elemId="id23"form_file="n/a" gov_classification="" ip_classification="" island_id="3"last_mod_date="2010-09-29T10:23:35Z" last_mod_user="#id77" license_list="" lsd="2010-09-29T10:23:35Z"object_application="Teamcenter" object_desc="" object_name="one/A" object_properties="0"object_type="ItemRevision Master" owning_group="#id75" owning_organization="" owning_project=""owning_user="#id77" parent_uid="#id95" pid="555" process_stage_list="" project_list=""

H-2 Data Exchange Guide PLM00094 I

Sample TC XML file with GSID references

release_status_list="" revision_limit="1" revision_number="0" timestamp="QtMx6UvxI45M1A" wso_thread=""><GSIdentity elemId="id97" label="LegacyIDid97one" /></Form>

- <Header author="infodba" date="2010-09-29" elemId="id24" originatingSite="-2132200621" targetSite=""time="15:58:52">

- <TransferFormula elemId="id25">- <OptionSet elemId="id26" name="SiteConsolidationDefault"><Option elemId="id27" name="internalClosureRule" value="True" /><Option elemId="id28" name="opt_entire_bom" value="True" /><Option elemId="id29" name="opt_entire_mse" value="False" /><Option elemId="id30" name="opt_ixr_islanchor" value="False" /><Option elemId="id31" name="opt_mechatro" value="False" /><Option elemId="id32" name="opt_res_audit" value="True" /><Option elemId="id33" name="opt_res_checkout" value="False" /><Option elemId="id34" name="opt_varexp_islanchor" value="True" /></OptionSet>

- <SessionOptions elemId="id35"><Option elemId="id36" name="fastStream" value="yes" /></SessionOptions><TransferMode elemId="id37" object_name="SiteConsolidationDefaultTM" /><Reason elemId="id38" /></TransferFormula></Header></TCXML>

PLM00094 I Data Exchange Guide H-3

Appendix

I Sample bulk load repeat file


Appendix

I 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"><GSIdentity elemId="id75" label="LegacyIDid75one" /></Group>

- <ImanType elemId="id2" island_id="0" type_class="ImanRelation" type_name="IMAN_master_form"><GSIdentity elemId="id76" label="LegacyIDid76one" /></ImanType>

- <User elemId="id3" island_id="0" user_id="infodba"><GSIdentity elemId="id77" label="LegacyIDid77one" /></User>

- <PSViewType elemId="id4" island_id="0" name="view"><GSIdentity elemId="id78" label="LegacyIDid78one" /></PSViewType>

- <POM_imc elemId="id5" island_id="0" site_id="-1589622576"><GSIdentity elemId="id79" label="LegacyIDid79one" /></POM_imc>

- <ItemRevision acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""creation_date="2010-09-29T10:23:35Z" date_released="" declared_options="" ead_paragraph="" elemId="id13"gde_bvr_list="" gov_classification="" has_variant_module="" ip_classification="" island_id="3"item_revision_id="A" items_tag="#id88" last_mod_date="2010-09-29T10:24:26Z" last_mod_user="#id77"license_list="" lsd="2010-09-29T10:24:26Z" object_application="Teamcenter" object_desc="" object_name="one"object_properties="0" object_type="ItemRevision" owning_group="#id75" owning_organization=""owning_project="" owning_user="#id77" parent_uid="#id88" pid="758" process_stage_list="" project_list=""release_status_list="" revision_limit="1" revision_number="0" sequence_anchor="#id93" sequence_id="1"sequence_limit="3" structure_revisions="#id92" timestamp="gBLx6UvxI45M1A" used_options=""variant_expression_block="" wso_thread=""><GSIdentity elemId="id87" label="LegacyIDid87one" /></ItemRevision>

- <Item acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date="" bom_view_tags="#id90"configuration_object_tag="" creation_date="2010-09-29T10:23:35Z" date_released="" ead_paragraph=""elemId="id14" global_alt_list="" gov_classification="" has_variant_module="" ip_classification=""is_configuration_item="" is_vi="" island_id="3" item_id="one" last_mod_date="2010-09-29T10:24:26Z"last_mod_user="#id77" license_list="" lsd="2010-09-29T10:24:26Z" object_application="Teamcenter"object_desc="" object_name="one" object_properties="0" object_type="Item" owning_group="#id75"owning_organization="" owning_project="" owning_user="#id77" parent_uid="" pid="564" preferred_global_alt=""process_stage_list="" project_list="" release_status_list="" revision_limit="1" revision_number="0"timestamp="gBMx6UvxI45M1A" uom_tag="" wso_thread=""><GSIdentity elemId="id88" label="LegacyIDid88one" /></Item>

- <PSOccurrence alternate_etc_ref="" child_bv="" child_item="gUJx6YHEaQAhNA" effectivities="" elemId="id15"island_id="3" lsd="2010-09-29T10:24:26Z" notes_ref="" object_properties="0" occ_flags="0" occ_thread="#id91"occ_type="" occurrence_type="0" order_no="10" parent_bvr="#id92" parent_uid="#id92" pid="783" pred_list=""qty_value="-1" seq_no="10" timestamp="gBEx6UvxI45M1A" uom_tag="" used_options="" variant_condition=""xform=""><GSIdentity elemId="id89" label="LegacyIDid89one" /></PSOccurrence>

- <PSBOMView acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""creation_date="2010-09-29T10:24:16Z" date_released="" ead_paragraph="" elemId="id16" gov_classification=""ip_classification="" island_id="3" last_mod_date="2010-09-29T10:24:16Z" last_mod_user="#id77"license_list="" lsd="2010-09-29T10:24:16Z" object_application="Teamcenter" object_desc=""object_name="one-View" object_properties="0" object_type="BOMView" owning_group="#id75"owning_organization="" owning_project="" owning_user="#id77" parent_item="#id88" parent_uid="#id88"pid="594" process_stage_list="" project_list="" release_status_list="" revision_limit="1"revision_number="0" timestamp="Q5Nx6UvxI45M1A" view_type="#id78" wso_thread=""><GSIdentity elemId="id90" label="LegacyIDid90one" /></PSBOMView>

- <PSOccurrenceThread clone_stable_occ_uid="AAAAAAAAAAAAAA" elemId="id17" island_id="3"lsd="2010-09-29T10:24:26Z" object_properties="0" parent_uid="#id89" pid="256" timestamp="gBDx6UvxI45M1A"><GSIdentity elemId="id91" label="LegacyIDid91one" /></PSOccurrenceThread>

- <PSBOMViewRevision acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""bom_view="#id90" creation_date="2010-09-29T10:24:17Z" date_released="" ead_paragraph="" elemId="id18"gov_classification="" ip_classification="" is_precise="0" island_id="3" last_mod_date="2010-09-29T10:24:26Z"last_mod_user="#id77" license_list="" lsd="2010-09-29T10:24:26Z" object_application="Teamcenter"object_desc="" object_name="one/A-View" object_properties="0" object_type="BOMView Revision"owning_group="#id75" owning_organization="" owning_project="" owning_user="#id77" parent_uid="#id87"pid="595" process_stage_list="" project_list="" release_status_list="" revision_limit="1"revision_number="0" struct_last_mod_date="2010-09-29T10:24:26Z" timestamp="gBCx6UvxI45M1A" wso_thread="">

PLM00094 I Data Exchange Guide I-1

Appendix I Sample bulk load repeat file

<GSIdentity elemId="id92" label="LegacyIDid92one" /></PSBOMViewRevision>

- <Anchor acl_bits="0" archive_date="" archive_info="" backup_date="" creation_date="2010-09-29T10:23:35Z"elemId="id19" immune_objects="" island_id="3" keep_limit="3" last_mod_date="2010-09-29T10:23:35Z"last_mod_user="#id77" lsd="2010-09-29T10:23:35Z" managed_objects="" object_properties="0"owning_group="#id75" owning_user="#id77" parent_uid="#id87" pid="520" timestamp="QtIx6UvxI45M1A"><GSIdentity elemId="id93" label="LegacyIDid93one" /></Anchor>

- <ImanRelation elemId="id20" island_id="3" lsd="2010-09-29T10:23:35Z" object_properties="0"parent_uid="#id88" pid="443" primary_object="#id88" relation_type="#id76" secondary_object="#id96"timestamp="QtCx6UvxI45M1A" user_data=""><GSIdentity elemId="id94" label="LegacyIDid94one" /></ImanRelation>

- <ImanRelation elemId="id21" island_id="3" lsd="2010-09-29T10:23:35Z" object_properties="0"parent_uid="#id87" pid="443" primary_object="#id87" relation_type="#id76" secondary_object="#id97"timestamp="QtPx6UvxI45M1A" user_data=""><GSIdentity elemId="id95" label="LegacyIDid95one" /></ImanRelation>

- <Form acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""creation_date="2010-09-29T10:23:35Z" data_file="" date_released="" ead_paragraph="" elemId="id22"form_file="n/a" gov_classification="" ip_classification="" island_id="3"last_mod_date="2010-09-29T10:23:35Z" last_mod_user="#id77" license_list="" lsd="2010-09-29T10:23:35Z"object_application="Teamcenter" object_desc="" object_name="one" object_properties="0"object_type="Item Master" owning_group="#id75" owning_organization="" owning_project=""owning_user="#id77" parent_uid="#id94" pid="555" process_stage_list="" project_list=""release_status_list="" revision_limit="1" revision_number="0" timestamp="QpPx6UvxI45M1A" wso_thread=""><GSIdentity elemId="id96" label="LegacyIDid96one" /></Form>

- <Form acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""creation_date="2010-09-29T10:23:35Z" data_file="" date_released="" ead_paragraph="" elemId="id23"form_file="n/a" gov_classification="" ip_classification="" island_id="3"last_mod_date="2010-09-29T10:23:35Z" last_mod_user="#id77" license_list="" lsd="2010-09-29T10:23:35Z"object_application="Teamcenter" object_desc="" object_name="one/A" object_properties="0"object_type="ItemRevision Master" owning_group="#id75" owning_organization="" owning_project=""owning_user="#id77" parent_uid="#id95" pid="555" process_stage_list="" project_list=""release_status_list="" revision_limit="1" revision_number="0" timestamp="QtMx6UvxI45M1A" wso_thread=""><GSIdentity elemId="id97" label="LegacyIDid97one" /></Form>

- <Header author="infodba" date="2010-09-29" elemId="id24" originatingSite="-2132200621" targetSite=""time="15:58:52">

- <TransferFormula elemId="id25">- <OptionSet elemId="id26" name="SiteConsolidationDefault"><Option elemId="id27" name="internalClosureRule" value="True" /><Option elemId="id28" name="opt_entire_bom" value="True" /><Option elemId="id29" name="opt_entire_mse" value="False" /><Option elemId="id30" name="opt_ixr_islanchor" value="False" /><Option elemId="id31" name="opt_mechatro" value="False" /><Option elemId="id32" name="opt_res_audit" value="True" /><Option elemId="id33" name="opt_res_checkout" value="False" /><Option elemId="id34" name="opt_varexp_islanchor" value="True" /></OptionSet>

- <SessionOptions elemId="id35"><Option elemId="id36" name="fastStream" value="yes" /></SessionOptions><TransferMode elemId="id37" object_name="SiteConsolidationDefaultTM" /><Reason elemId="id38" /></TransferFormula></Header></TCXML>

I-2 Data Exchange Guide PLM00094 I

Appendix

J Frequently asked questions


Appendix

J 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 referencingitems_tag, the uid of the parent id is used. Also the parent_uid attributeis mentioned twice as items_tag and parent_uid. To be able to separate theusers/objects/relations in the loads it would be best to reference everything by theTeamcenter UID.<ItemRevision acl_bits="0" active_seq="1" archive_date="" archive_info="" backup_date=""creation_date="2010-06-29T15:43:21Z" date_released="" declared_options="" ead_paragraph=""elemId="id17" gde_bvr_list="" gov_classification="" has_variant_module=""ip_classification="" island_id="4" item_revision_id="A" items_tag="AVDxiag7I45M1A"last_mod_date="2010-06-29T15:46:31Z" last_mod_user="#id5" license_list=""lsd="2010-06-29T15:46:31Z" object_application="Teamcenter" object_desc="" object_name="child1"object_properties="0" object_type="ItemRevision" owning_group="#id1" owning_organization=""owning_project="" owning_user="#id5" parent_uid="AVDxiag7I45M1A" pid="758"process_stage_list="" project_list="" puid="AVMxiag7I45M1A" release_status_list=""revision_limit="1" revision_number="0" sequence_anchor="AVOxiag7I45M1A" sequence_id="1"sequence_limit="3" structure_revisions="QFJxiag7I45M1A" timestamp="QNMxiag7I45M1A"used_options="" variant_expression_block="" wso_thread=""/>

Answer — Organization and administrative objects, such as User and Group,cannot be referenced by a UID. They have to be looked up based on their candidatekey. So there is an XML element for the organization object with just the candidatekey 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-idattribute and saves them at once.

Would it be easier to handle if the header information could be written to aseparate configuration file?

Answer — The import process relies on originating site information and the sessionoptions in the Header element. This information is read in the first pass of the XMLparsing and used in the second pass when the actual import happens.

How can we find out which attributes in the TC XML are mandatory andif empty attributes can be left out?

Answer — The fast import sets null values for missing attributes that do not havean initial value. However, there is no straightforward way to arrive at a set ofattributes that are required to be populated for a given class. The tcxml_validateutility reports if the required typed and untyped references are missing from theTC XML. In addition, the list of mandatory attributes for core Teamcenter classesdocumented in Teamcenter core data dictionary. For other classes of interest, similarexercise must be done as part of the customization work.

PLM00094 I Data Exchange Guide J-1

Appendix J Frequently asked questions

How is the timestamp generated?

Answer — The timestamp indicates when the object was last modified. Thetimestamp attribute takes the form of a UID – not a date or time as might beexpected. Because a UID encodes a representation of time, it is sufficient to store aUID for this purpose. This attribute can be omitted from the TC XML. Fast importinternally generates and sets the timestamp for an object.

For generating the UID with TIE_get_hashed_uid an external ID comingfrom the legacy system is needed, as well as a siteID identifying the legacysystem. Are there any requirements to the format of that external ID (fieldtype, 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 theenhancement 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 allowfor many-to-many mappings. If the external ID is composed such that it is uniqueacross 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 haveto be unique over all data loaded?

Answer — The elemId and island_id attributes are unique per file.

What causes errors during job scheduling and execution?

Answer — Process execution problems may occur due to available memory ormaximum 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.1application server and the ODE uses an Oracle database.

To run an ODE process in memory, uncomment or addthe <in-memory>true</in-memory> element to theode-working-dir/processes/data-transfer/deploy.xml file. For more informationabout 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-memmoryttl to longer than 10 minutes using the ode-axis2.mex.inmem.ttlproperty. This properties value is set in milliseconds in theode-working-dir/conf/ode-axis2.properties file. For example, thefollowing set the ttl to 30 minutes:

ode-axis2.mex.inmem.ttl=1800000

J-2 Data Exchange Guide PLM00094 I

Appendix

K Glossary


Appendix

K Glossary

B

BOMBill of materials.

• 100% BOM

The as sold product configuration, for example, the configuration of a car to bebuilt and shipped to the dealer.

• 120% BOM

Partial overlay of selected variant conditions. You cannot build the productfrom a 120% BOM.

• 150% BOM

Overlays of all possible variant configurations. You cannot build the productfrom a 150% BOM.

See also design bill of materials and manufacturing bill of materials.

business logic reactorSee reactor.

business objectLogical grouping of data attributes and properties that are manipulated at theenterprise level.

A Global Services business object allows users to query for and update informationin multiple data sources.

business object definition fileFile that contains the XML-based definition of a Global Services business object.

business object server connectorGlobal Services component that defines one standard method for retrieving data fromall data source systems, resulting in the ability to change or replace a data sourcesystem without affecting other data sources in the Global Services environment.

The business object server connector is an Enterprise JavaBean.

C

Closure RuleRule that controls the scope of the translation of data imported to and exported fromTeamcenter. Closure rules specify how the data structure is traversed by specifying

PLM00094 I Data Exchange Guide K-1

Appendix K Glossary

the relationships of interest and the actions to occur when these relationships areencountered.

connector (Global Services)Global Services component that accesses information from a data source. Eachconnector accesses information from a particular type of data source. For example,Global Services provides a connector for communicating with JDBC-compliantdatabases. Global Services offers optional connectors.

One implementation of a connector can communicate with multiple data sources byusing different connector configuration files.

Global Services connectors are Enterprise JavaBeans. Enterprise customizers cancreate connectors to data sources using the Global Services connector APIs.

connector configuration fileXML-based file that specifies the data source a connector communicates with toobtain information.

For each instance of a connector, Global Services administrators create connectorconfiguration files that describe the data sources the connector communicates with.

credentials fileXML file that defines a Global Services user name and maps the Global Services username to the user’s sign-on credentials for each data source connector in the GlobalServices 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 froman LDAP database.

credentials serviceGlobal Services component that finds and provides a Global Services user’s sign-oncredentials for a data source in the Global Services environment. Global Servicesprovides two credentials services, XML and lightweight directory access protocol(LDAP), and APIs for creating a custom credentials service.

credentials service configuration fileXML file that configures credentials services for each data source connector in theGlobal Services environment.

D

data sourceSystem that manages enterprise data and can be accessed by Teamcenter.Examples are product knowledge management (PKM) systems, product lifecyclemanagement systems, relational databases, enterprise resource planning (ERP)systems, component and supplier management (CSM) systems, mechanical designautomation (MDA) systems, purchasing systems, systems engineering GroupWare,and maintenance, repair, and overhaul (MRO) systems.

datastoreJava Database Connectivity (JDBC) database instance used to store the GlobalServices configuration and business object definition (BOD) information. Themajority of the objects in the datastore are stored as serialized objects for improvedperformance. The configuration and BOD files are serialized during the process ofuploading them to the datastore. Global Services users with administrator privileges

K-2 Data Exchange Guide PLM00094 I

Glossary

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.

design bill of materialsList of components and subassemblies used to define an assembly structure, andthe representation of the assembly structure. Compare with manufacturing billof materials.

G

Global Services connectorGlobal Services component that accesses information from a data source. Eachconnector accesses information from a particular type of data source. For example,Global Services provides a connector for communicating with JDBC-compliantdatabases. Global Services offers optional connectors.

One implementation of a connector can communicate with multiple data sources byusing different connector configuration files.

Global Services connectors are Enterprise JavaBeans. Enterprise customizers cancreate connectors to data sources using the Global Services connector APIs.

Global Services FoundationWeb application that enables your enterprise to access information stored invirtually any type of electronic data source that manages your enterprise data.

Running on a standard commercial Web application server, the server componentsof Global Services Foundation enable communication among the data sources andbetween users and the data sources. All components of Global Services Foundationuse standard Web technology: Extensible Markup Language (XML), ExtensibleStylesheet Language (XSL), and the Java programming language. Users accessGlobal Services Foundation from a commercial Web browser using the standardtechnologies of Web browsers, primarily support for HyperText Markup Language(HTML) forms and small Java applets.

I

I-deasSiemens PLM Software’s integrated CAD/CAM/CAE solution that is used to design,analyze, test, and manufacture products.

initiatorData source component that sends data source messages to the Global Servicesmessage server through an HTTP or HTTPS request.

An initiator is required only when the data source must provide information to otherdata sources in a Global Services environment.

The initiator is not an integral part of the data source system; it is created by GlobalServices customizers.

J

JDBC connectorEnterprise JavaBean that connects Global Services to data sources using the JavaDatabase Connectivity (JDBC) API.


Appendix K Glossary

The JDBC connector is provided as part of Global Services.

M

manufacturing bill of materialsDefines how the product is manufactured, rather than how it is designed. Comparewith design bill of materials.

My TeamcenterIn the Teamcenter rich client and thin client, application that is the main accesspoint for managing product information. My Teamcenter provides the functionalityfor creating objects in the Teamcenter database, querying the database for objects,checking in and checking out objects, and managing tasks. Users can also openobjects, automatically launching the related application.

Each user has a personal My Teamcenter window that displays product informationas graphical objects. Although users share product information across the enterprise,they organize this information individually in personal workspaces.

N

notifierGlobal Services component that allows a Global Services administrator to configureautomatic e-mail 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 commandwhen an event occurs.

A notifier is a specialized Global Services reactor.

O

Object Directory Service (ODS)Teamcenter Object Directory Services database. The ODS is either a Teamcentersite or part of a Teamcenter site that stores publication records for objects publishedto a Teamcenter multisite deployment.

ownership managerResponsible for facilitating ownership transfer for objects and files that movebetween the systems.

P

Product Communication Layer (PCL) serverSoftware that performs the first phase of data migration processing to convert I-deasdata for use in Teamcenter Integration for NX. The PCL server exposes the I-deasproject metadata to the TDS server for interpretation.

publishingMakes an object available to other sites. When you publish an object, a publicationrecord is created in the ODS that can be read and searched by other sites. Untilyou publish an object, it can only be seen by the local owning site; other sites arenot aware that it exists.


Glossary

R

reactorGlobal Services component that implements business logic and receives messagesfrom the Global Services message server.

Customizers create a reactor for each data source system in the Teamcenterenvironment using Teamcenter toolkit Java APIs.

Reactors are Enterprise JavaBeans.

remote actionAction that is performed from independent sites without actually logging on to thesite. Remote actions are performed within the Teamcenter managed host/server sites.

remote searchSearch for published objects in the ODS. The remote search returns the publicationrecord for the object searched.

replicaReplication is the act of creating an exact copy of an object, known as a replica, at aspecific site. Replicas are objects that are not owned by Teamcenter.

S

single-source business objectGlobal Services business object that exists in one data source with all data containedin one addressable element. A single-source business object is defined with onedata segment.

stubProxy object that is used to represent an object that is excluded while exporting alarger object such as an item or an assembly.

synchronizationProcess of updating replicas. When a master object is replicated at other sites, youmust update the replicas whenever the master object is modified. See also replica.

T

Team BrowserClient application that provides a graphical interface to I-deas Enterprise, theproduct that integrates Teamcenter and I-deas Enterprise. The Team Browserenables users to view and manage the data in their personal workspaces and teamsand to interact with vaults. See also Teamcenter Integration for NX I-deas.

Teamcenter Integration for NX I-deasProduct that integrates Teamcenter and I-deas to provide a single data managementenvironment for users. Teamcenter Integration for NX I-deas users author theirdata in I-deas and manage the data in Teamcenter. Teamcenter Integration for NXI-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 folderLogical storage area for team data.


Appendix K Glossary

transaction logTracks solution transactions from Teamcenter to . The transaction log providesinformation on each transaction including messages from . The information in thislog is used to monitor the success of solution transactions and to gain insight intoreasons for transaction failure.

transfer modeObjects composed of rules that configure PLM XML import and export operations.Transfer mode allows users to import and export data with little knowledge otherthan the name of the transfer mode object.

transfer option setStored set of transfer options for remote export or import of data.

U

unpublishingMakes an object invisible to other sites. The object is accessible only by the localowning site.


Index

A

Abort activity . . . . . . . . . . . . . . . . . . . 9-13Abort transfer . . . . . . . . . . . . . . . . . . . . 2-1Access privileges for Check Out To Site . . 6-1ACL for Check Out to Site . . . . . . . . . . . 6-1Active Directory configurationexample . . . . . . . . . . . . . . . . . . . . . D-19

Activity status table . . . . . . . . . . . 5-14, 8-7Adding

Factors . . . . . . . . . . . . . . . . . . . . . . . 7-8Mapping Designer projects . . . . . . . . . 7-6

Adding custom attributes to the stylesheet . . . . . . . . . . . . . . . . . . . . . . . . 5-46

Altova MapForce, installing . . . . . . . . . . 7-2Application objects . . . . . . . . . . . . . . . B-3ApplicationInstance . . . . . . . . . . . . . . 5-13ApplicationInstance contextparameter . . . . . . . . . . . . . . . . . 5-18, 5-20

Attributesconfig-name . . . . . . . . . . . . . . . . . . . 5-37IsContext . . . . . . . . . . . . . . . . . . . . . 5-8JNDI-name . . . . . . . . . . . . . . . . . . . 5-37Shapes_Files . . . . . . . . . . . . . . . . . . . 5-4Shapes_Name . . . . . . . . . . . . . . . . . . 5-4site-id . . . . . . . . . . . . . . . . . . . . . . . 5-37

Audit monitoring . . . . . . . . . . . . . . . . . 1-4autoReconnect connection poolproperty . . . . . . . . . . . . . . . . . . . . . . 5-21

axis2.max.connections property . . . . . . 5-19

B

baseDN directory . . . . . . . . . . . . . . . D-14BC-perform-offline-export workflowhandler . . . . . . . . . . . . . . . . . . . . . . . 5-44

Bill of materials export . . . . . . . . . . . . 1-16JBoss . . . . . . . . . . . . . . . . . . . . . . . . . 5-25bmide_generatetcxmlschema Javautility . . . . . . . . . . . . . . . . . . . . . . . . 1-13

box-security-info element . . . . . . . . . . . 5-38BPEL configuration for off-hoursprocessing . . . . . . . . . . . . . . . . . . . . . 5-38

BPEL failure . . . . . . . . . . . . . . . . . . . . 8-4Briefcase

Send E-mail notification . . . . . . . . . . 9-19Show progress indicator . . . . . . . . . . 9-19Site Check-In after import . . . . . . . . 9-19Start immediate transfer . . . . . . . . . 9-19

Briefcase Check Out To Site . . . . . . . . . . 6-1Briefcase export to Teamcenter 2007 . . . . 6-1Briefcase file export versus Teamcenterexport . . . . . . . . . . . . . . . . . . . . . . . . . 1-7

Briefcase import fails . . . . . . . . . . . . . . 5-5Briefcase supplier exchange . . . . . . . . . . 1-7Building control files . . . . . . . . . . . . . . 7-14Bulk data file transfer failure . . . . . . . . . 8-7Bulk load

Island of data . . . . . . . . . . . . . . . . . 9-26Bulk loader

Before you begin . . . . . . . . . . . . . . . 9-27Format of TC XML data . . . . . . . . . . 9-27Getting started . . . . . . . . . . . . . . . . 1-15

Ccad_to_tc_attribute_map.xml file . . . . . . 6-7Cancel Check-Out to site . . . . . . . . . . . . 1-8CATIA

Alternate shape . . . . . . . . . . . . . . . . . 5-4Required attributes for shapes . . . . . . 5-4

CATIA integrationTransferring CAD data . . . . . . . . . . . . 5-8

CATIA property set clause . . . . . . . . . . . 5-8Check Out To Site . . . . . . . . . . . . . . . . . 6-1Check-Out to site . . . . . . . . . . . . . . . . . 1-7Classes

POM_catia_absocc . . . . . . . . . . . . . . . 5-8Cloning factors . . . . . . . . . . . . . . . . . . 7-15Closure rule clause . . . . . . . . . . . . . . . . 1-3Closure rule clauses . . . . . . . . . . . . . . . 5-7collect_garbage utility . . . . . . . . . . . . . B-11Commit . . . . . . . . . . . . . . . . . . . . . . . 5-20Component visibility options for configuredexport . . . . . . . . . . . . . . . . . . . . . . . . . 9-5

config-name attribute . . . . . . . . . . . . . 5-37Configuration data . . . . . . . . . . . . . . . 5-14configurations directory . . . . . . . . . . . . . 6-4Configure export

Component visibility options . . . . . . . . 9-5

PLM00094 I Data Exchange Guide Index-1

Index

Required session options . . . . . . . . . . . 9-5Required transfer options . . . . . . . . . . 9-4

Configuring a JNDI data storeconnection . . . . . . . . . . . . . . . . . . . . 5-17

Configuring Data Exchange . . . . . . . . . . 1-1Configuring Global Services for DataExchange . . . . . . . . . . . . . . . . . . . . . 5-34

Configuring off-hours processing . . . . . . 5-38Configuring secret teams . . . . . . . . . . . 5-39conn:data-source-spec element . . . . . . . 5-37Connection pool database name . . . . . . 5-21Connection pool driver . . . . . . . . . . . . . 5-17Connector support files . . . . . . . . . . . . 5-10Console view . . . . . . . . . . . . . . . . . . . . 7-31Context parameter

ApplicationInstance . . . . . . . . . 5-18, 5-20Context parameters

ApplicationInstance . . . . . . . . . . . . . 5-13LogFileLocation . . . . . . . . . . . . . . . . 5-13SSOAppID . . . . . . . . . . . . . . . . . . . 5-13TcGSBOSJNDI . . . . . . . . . . . . . . . . 5-13TcGSDORJNDI . . . . . . . . . . . . . . . . 5-13TcGSJDBCJNDI . . . . . . . . . . . . . . . 5-13TcGSMessageServerJNDI . . . . . . . . . 5-13TcGSNotifierReactorJNDI . . . . . . . . 5-13

Control filesBuilding . . . . . . . . . . . . . . . . . . . . . 7-14Deploying . . . . . . . . . . . . . . . . . . . . 7-14

Controlling the number of mappingservices . . . . . . . . . . . . . . . . . . . . . . 5-36

CreatingControl files . . . . . . . . . . . . . . . . . . . 7-14Filtering rules . . . . . . . . . . . . . . . . . 7-11Mapping Designer projects . . . . . . . . . 7-6Maps . . . . . . . . . . . . . . . . . . . 7-10, 7-26Remote sites . . . . . . . . . . . . . . . . . . . 5-6

CustomMappings.xml file . . . . . . . . . . . 6-5

DData Exchange

Transaction off-hours processing . . . . 5-38Data Exchange concepts

Closure rule clause . . . . . . . . . . . . . . . 1-3Export . . . . . . . . . . . . . . . . . . . . . . . 1-2Export protection . . . . . . . . . . . . . . . . 1-4Factors . . . . . . . . . . . . . . . . . . . . . . . 1-3File Management System . . . . . . . . . . 1-3Import . . . . . . . . . . . . . . . . . . . . . . . 1-2Replica . . . . . . . . . . . . . . . . . . . . . . . 1-2Replica deletion . . . . . . . . . . . . . . . . . 1-4Site . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2SSO . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Stub replication . . . . . . . . . . . . . . . . . 1-4

Synchronizer . . . . . . . . . . . . . . . . . . . 1-2Transfer mode . . . . . . . . . . . . . . . . . . 1-3Transfer option set . . . . . . . . . . . . . . . 1-3

Data Exchange export support for secretteams . . . . . . . . . . . . . . . . . . . . . . . . 5-39

Data mapper failure . . . . . . . . . . . . . . . 8-6Data mapper throttling . . . . . . . . . . . . 5-36Data migration tool . . . . . . . . . . . . . . . . 5-8Data model incompatibility . . . . . . . . . . 5-9Data not synchronized . . . . . . . . . . . . . B-8Data source . . . . . . . . . . . . 5-18, 5-20–5-21data store

Creating . . . . . . . . . . . . . . . . . . . . . 5-14Table . . . . . . . . . . . . . . . . . . . . . . . 5-15

data store table . . . . . . . . . . . . . . . . . . 5-15Data synchronization . . . . . . . . . . . . . . 1-2Database tables

Activity status . . . . . . . . . . . . . . . . . 5-14data store . . . . . . . . . . . . . . . . . . . . 5-14Datastore . . . . . . . . . . . . . . . . . . . . 5-14Message log . . . . . . . . . . . . . . . . . . . 5-14Reactor result . . . . . . . . . . . . . . . . . 5-14

DataMapper.xml file . . . . . . . . . . 5-36, 5-40Datastore

Creating . . . . . . . . . . . . . . . . . . . . . 5-14dataTransfer action . . . . . . . . . . . . . . . 5-36Deleting

Factors . . . . . . . . . . . . . . . . . . . . . . 7-17Dependency tab . . . . . . . . . . . . . 7-17, 7-31Dependent factors . . . . . . . . . . . . . . . . 7-17Deploying

Control file . . . . . . . . . . . . . . . . . . . 7-14Deployment status . . . . . . . . . . . . . . . 5-20Detailed transfer status . . . . . . . . . . . . . 2-1Directories

Web_tier . . . . . . . . . . . . . . . . . . . . . 5-11

EEclipse

Views . . . . . . . . . . . . . . . . . . . . . . . 7-31Editing source files . . . . . . . . . . . . . . . 7-32Editors

View . . . . . . . . . . . . . . . . . . . . . . . . 7-32Elements

box-security-info . . . . . . . . . . . . . . . 5-38conn:data-source-spec . . . . . . . . . . . . 5-37listOfValuesHandler . . . . . . . . . . . . . 5-36maximum-concurrency . . . . . . . . . . . 5-36smap:site . . . . . . . . . . . . . . . . . . . . 5-37

EmailTemplate.xml files . . . . . . . . . . . 5-35Enabling Data Exchange . . . . . . . . . . . . 1-1ensure_site_consistency utility . . . . . . . B-11Environment variables . . . . . . . . . . . . . 5-2

Index-2 Data Exchange Guide PLM00094 I

Index

Error encountered Retrying importoperation . . . . . . . . . . . . . . . . . . . . . . 5-5

ExampleAdding custom attributes to the style

sheet . . . . . . . . . . . . . . . . . . . . . 5-46Standard style sheet . . . . . . . . . . . . 5-45style sheet with subtypes . . . . . . . . . 5-45

example directory . . . . . . . . . . . . . . . . . 6-9Export privilege . . . . . . . . . . . . . . . . . . 6-1Export protection . . . . . . . . . . . . . . . . . 1-4Exporting

PDX package . . . . . . . . . . . . . . . . . . 9-23To SRM . . . . . . . . . . . . . . . . . . . . . . 9-12

Exporting a PDX package . . . . . . . . . . 1-12Exporting a Pro Engineer assembly . . . . 9-1

FFactor definition files . . . . . . . . . . . . . . . 5-8Factor transformation file . . . . . . . . . . . 5-8Factors . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Adding . . . . . . . . . . . . . . . . . . . . . . . 7-8Cloning . . . . . . . . . . . . . . . . . . . . . . 7-15Deleting . . . . . . . . . . . . . . . . . . . . . 7-17Dependency . . . . . . . . . . . . . . . . . . . 7-17Details view . . . . . . . . . . . . . . . . . . 7-30Importing . . . . . . . . . . . . . . . . . . . . 7-15Modify Source Element/Properties . . . 7-18Modify Target Element/Properties . . . 7-19Search view . . . . . . . . . . . . . . . . . . . 7-31Searching . . . . . . . . . . . . . . . . . . . . 7-16View . . . . . . . . . . . . . . . . . . . . . . . . 7-29

File Management System . . . . . . . . . . . 1-3Files

cad_to_tc_attribute_map.xml . . . . . . . 6-7CustomMappings.xml . . . . . . . . . . . . . 6-5DataMapper.xml . . . . . . . . . . . 5-36, 5-40EmailTemplate.xml . . . . . . . . . . . . . 5-35Factor definition . . . . . . . . . . . . . . . . 5-8Factor transformation . . . . . . . . . . . . 5-8FMS_master.xml . . . . . . . . . . . . . . . . 5-3Global Services properties . . . . . . . . 5-19globalservices.properties . . . . . . 5-19, 5-36GlobalServicesAdim.xml . . . . . . . . . . 5-38localization . . . . . . . . . . . . . . . . . . . . 6-7Map control . . . . . . . . . . . . . . . . . . . . 5-8MapForce . . . . . . . . . . . . . . . . . . . . . 5-8mti.jar . . . . . . . . . . . . . . . . . . . . . . 5-11mtiems.jar . . . . . . . . . . . . . . . . . . . . 5-11site-id.properties . . . . . . . . . . . . . . . . 6-4sitemap.xml . . . . . . . . . . . . . . . 5-37, 5-41TCXML.xsd . . . . . . . . . . . . . . . . . 6-4, 6-7Teamcenter FMS master . . . . . . . . . . 5-3TeamcenterSoaConfig.xml . . . . . . . . . 5-37

visible-attributes.xml . . . . . . . . . . . . . 6-7WebTier.log . . . . . . . . . . . . . . . . . . . . 8-8

Filtering rulesCreating . . . . . . . . . . . . . . . . . . . . . 7-11In general . . . . . . . . . . . . . . . . . . . . . 7-5

FMS key utility . . . . . . . . . . . . . . . . . . B-13FMS master example (Teamcenter) . . . . . 5-3FMS site IDs . . . . . . . . . . . . . . . . . . . . 5-3FMS ticket . . . . . . . . . . . . . . . . . . . . . . 8-5FMS tickets . . . . . . . . . . . . . . . . . . . . . 5-2FMS_master.xml file . . . . . . . . . . . . . . . 5-3FSC_HOME . . . . . . . . . . . . . . . . . . . . . 5-2FSC_HOME variable . . . . . . . . . . . . . . . 5-2fsc.uris property . . . . . . . . . . . . . . . . . 5-36fscadmin utility . . . . . . . . . . . . . . . . . . . 8-1Full objects exported with modified object onlyoption . . . . . . . . . . . . . . . . . . . . . . . . . 9-6

GGarbage collection, GSIdentityobjects . . . . . . . . . . . . . . . . . . . . . . . B-10

Gateway for Oracle EBS integration(T40) . . . . . . . . . . . . . . . . . . . . . . . . 5-17

Global Services configuration for DataExchange . . . . . . . . . . . . . . . . . . . . . 5-34

Global Services datastoreconfiguration . . . . . . . . . . . . . . . . . . . 5-34

Global Services installation . . . . . . . . . 5-11Global Services JDBCMessageBoxparameter . . . . . . . . . . . . . . . . . . . . . 5-38

Global Services properties . . . . . . . . . . 5-19Global Services request failure . . . . . . . . 8-5Global Services TEM values . . . . . . . . . . 5-1Global Services third partyintegrations . . . . . . . . . . . . . . . . . . . 5-17

globalservices.default.tc.siteidproperty . . . . . . . . . . . . . . . . . . . . . . 5-36

globalservices.properties file . . . . . 5-19, 5-36GlobalServicesAdmin.xml file . . . . . . . . 5-38GlobalServicesDB . . . . . . . . . . . . 5-18, 5-20GMS_site_checkin_after_importpreference . . . . . . . . . . . . . . . . . . . . . . 6-2

GSIdentity attributes . . . . . . . . . . . . . B-10GSIdentity object . . . . . . . . . . . . B-7, B-10

HHTTP time-out errors in logs with missingexport requests . . . . . . . . . . . . . . . . . C-4

IICD files, copying


Index

Global Services . . . . . . . . . . . . . . . . 5-11IMAN_specification relation . . . . . . . . . . 5-5ImanExportRecord object . . . . . . . . . . . B-8ImanFile object . . . . . . . . . . . . . . . . . . . 5-5Import fails with ds0_only option . . . . . . 5-5Import privilege . . . . . . . . . . . . . . . . . . 6-1Import/export rule . . . . . . . . . . . . . . . . . 5-7Importing

Factors . . . . . . . . . . . . . . . . . . . . . . 7-15Sample Mapping Designer projects . . 7-24

Install and configuration tasks . . . . . . . . 4-1Install images for connectors . . . . . . . . 5-10install_encryptionkeys utility . . . . 5-2, B-13Installations

JBoss server . . . . . . . . . . . . . . . . . . 5-21WebLogic server . . . . . . . . . . . . . . . . 5-20

InstallingAltova MapForce . . . . . . . . . . . . . . . . 7-2Mapping Designer . . . . . . . . . . . . 7-1–7-2

IP Admin role . . . . . . . . . . . . . . . . . . . 5-39IP classification . . . . . . . . . . . . . . . . . . 5-39Is HTTP enabled . . . . . . . . . . . . . . . . . . 5-6IsContext attribute . . . . . . . . . . . . . . . . 5-8

JJAVA_HOME . . . . . . . . . . . . . . . . . . . . 5-2JAVA_HOME variable . . . . . . . . . . . . . . 5-2JBoss

Security . . . . . . . . . . . . . . . . . . . . . 5-25JNDI data store . . . . . . . . . . . . . . . . . 5-17JNDI-name attribute . . . . . . . . . . . . . . 5-37Job progress . . . . . . . . . . . . . . . . . . . . . 2-1

Kkeygen required environmentvariables . . . . . . . . . . . . . . . . . . . . . . . 5-2

keygen utility . . . . . . . . . . . . . . . . . . . . 5-2

LLaunching

Mapping Designer . . . . . . . . . . . . . . . 7-3LDAP groups and roles . . . . . . . . . . . D-13LDAP mapping

Group and role . . . . . . . . . . . . . . . . . D-8User and person . . . . . . . . . . . . . . . . D-5

LDAP object incorrectly set as externally orinternally managed . . . . . . . . . . . . . D-15

LDAP objectsExternally managed . . . . . . . . . . . . D-15Internally managed . . . . . . . . . . . . D-15

LDAP preference list . . . . . . . . . D-16, D-19

LDAP server database . . . . . . . . . . . . D-13LDAP troubleshooting . . . . . . . . . . . . D-15LDAP_admin_dn preference . . . . D-16, D-19LDAP_admin_pw preference . . . D-16, D-19LDAP_attribute_mappingpreference . . . . . . . . . . . . . . . . . . . . D-17

LDAP_attribute_mappingpreference . . . . . . . . . . . . . . . . . . . . D-19

LDAP_base_dn preference . . . . . D-17, D-19LDAP_cert_db_path preference . . . . . D-17,D-19

LDAP_group_attr_mappingpreference . . . . . . . . . . . . . . . . . . . . D-17

LDAP_group_attr_mappingpreference . . . . . . . . . . . . . . . . . . . . D-20

LDAP_group_base_dn preference . . . . D-17LDAP_group_base_dn preference . . . . D-20LDAP_group_object_classpreference . . . . . . . . . . . . . . . . . . . . D-17

LDAP_group_object_classpreference . . . . . . . . . . . . . . . . . . . . D-20

LDAP_group_query_filter preference . . D-17LDAP_group_query_filter preference . . D-20LDAP_ignore_users preference . . . . . . D-17,D-20

LDAP_member_list_attr preference . . D-17LDAP_member_list_attr preference . . D-20LDAP_member_type_attr preference . . D-20LDAP_member_type_attr preference . . D-17LDAP_object_type_attr preference . . . D-17LDAP_object_type_attr preference . . . D-20LDAP_person_attr_mappingpreference . . . . . . . . . . . . . . . . . . . . D-18

LDAP_person_attr_mappingpreference . . . . . . . . . . . . . . . . . . . . D-21

LDAP_port_number preference . . . . . D-18,D-21

LDAP_role_attr_mappingpreference . . . . . . . . . . . . . . . . . . . . D-18

LDAP_role_attr_mappingpreference . . . . . . . . . . . . . . . . . . . . D-21

LDAP_role_object_class preference . . . D-21LDAP_role_object_class preference . . . D-18LDAP_role_query_filter preference . . . D-19LDAP_role_query_filter preference . . . D-21LDAP_service_hosts preference . . . . . D-19,D-21

LDAP_sync_group_flags preference . . D-19LDAP_sync_group_flags preference . . D-21LDAP_sync_member_flagspreference . . . . . . . . . . . . . . . . . . . . D-21

LDAP_sync_member_flagspreference . . . . . . . . . . . . . . . . . . . . D-19

LDAP_sync_role_flags preference . . . . D-19


Index

LDAP_sync_role_flags preference . . . . D-21LDAP_sync_user_flags preference . . . D-21LDAP_sync_user_flags preference . . . D-19LDAP_use_ssl preference . . . . . . D-19, D-21LDAP_user_object_class preference . . D-21LDAP_user_object_class preference . . D-19LDAP_user_query_filter preference . . D-21LDAP_user_query_filter preference . . D-19ldapsync does not find user, group, or rolenodes under the base DN . . . . . . . . . D-16

ldapsync utility . . . . . . . . . . . . . . . . . . D-1ldapsync utility basic concepts . . . . . . . D-1ldapsync with secure socket layer . . . . . D-4License detached from imported object . . 9-1Licenses and IP classification . . . . . . . . 5-39listOfValuesHandler element . . . . . . . . 5-36Localization file . . . . . . . . . . . . . . . . . . 6-7Log file directory . . . . . . . . . . . . . . . . . . 8-8Log files . . . . . . . . . . . . . . . . . . . . . . . . 2-1LogFileLocation . . . . . . . . . . . . . . . . . 5-13Lookup table . . . . . . . . . . . . . . . . . . . . 7-20

Mmake_user utility . . . . . . . . . . . . . . . D-15Map control file . . . . . . . . . . . . . . . . . . . 5-8map element . . . . . . . . . . . . . . . . . . . . 5-40MapForce

Project . . . . . . . . . . . . . . . . . . . . . . . 5-8properties . . . . . . . . . . . . . . . . . . . . . 5-9

MapForce, installing . . . . . . . . . . . . . . . 7-2Mapping Designer

Installing . . . . . . . . . . . . . . . . . . 7-1–7-2Lookup table . . . . . . . . . . . . . . . . . . 7-20Perspective . . . . . . . . . . . . . . . . . . . 7-29Perspectives and views . . . . . . . . . . . 7-28Projects . . . . . . . . . . . . . . . . . . . . . . . 7-6Sample projects . . . . . . . . . . . . . . . . 7-24Start . . . . . . . . . . . . . . . . . . . . . . . . . 7-3Tasks . . . . . . . . . . . . . . . . . . . . . . . . 7-6User interface . . . . . . . . . . . . . . . . . . 7-3Using . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Maps, creating . . . . . . . . . . . . . . 7-10, 7-26maximum-concurrency element . . . . . . 5-36Message log table . . . . . . . . . . . . . . . . 5-14MFC, see Map control fileMissing export requests in Global Servicesactivity status. . . . . . . . . . . . . . . . . . C-4

Modified objects only export of nonworkspaceobjects . . . . . . . . . . . . . . . . . . . . . . . . 9-6

Modify Source Element/Propertiesoption . . . . . . . . . . . . . . . . . . . . . . . . 7-18

Modify Target Element/Propertiesoption . . . . . . . . . . . . . . . . . . . . . . . . 7-19

Modify transfer out AM rule . . . . . . . . . . 5-6Monolingual sites . . . . . . . . . . . . . . . . 1-13mti.jar file . . . . . . . . . . . . . . . . . . . . . 5-11mtiems.jar file . . . . . . . . . . . . . . . . . . 5-11mulitsiteimport element . . . . . . . . . . . . 5-3Multilingual sites . . . . . . . . . . . . . . . . 1-13Multiple recipes on import . . . . . . . . . . B-8

OObjects

GSIdentity . . . . . . . . . . . . . . . B-7, B-10GSIdentity garbage collection . . . . . . B-10ImanExportRecord . . . . . . . . . . . . . . B-8Traversal . . . . . . . . . . . . . . . . . . . . B-7

Objects automatically checked out to asite . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8

Objects references through properties . . B-4Objects that can be checked out to asite . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7

Attributes . . . . . . . . . . . . . . . . . . . . D-14Offline data sharing methods . . . . . . . . . 1-7One-phase commit . . . . . . . . . . . . . . . 5-20opt_from_tc_ds0_only option . . . . . . . . . 5-5Oracle Manufacturing integration . . . . 5-17Organization application . . . . . . . . . . . . 6-2Ownership manager example . . . . . . . . B-11Ownership of published object . . . . . . . B-11Ownership transfer pending . . . . . . . . . B-11

PParameters

ApplicationInstance . . . . . . . . . 5-18, 5-20Server URL . . . . . . . . . . . . . . . . . . . . 5-1SOA_URL . . . . . . . . . . . . . . . . . . . . 5-37SSO_enabled . . . . . . . . . . . . . . . . . . 5-38SSOApplicationID . . . . . . . . . . . . . . 5-38

PDX export functionality . . . . . . . . . . . 1-12Perspectives

Mapping Designer . . . . . . . . . . . . . . 7-29POM subclass . . . . . . . . . . . . . . . . . . . B-10POM_catia_absocc class . . . . . . . . . . . . . 5-8Preference

User mapping . . . . . . . . . . . . . . . . . D-5Preferences

Data synchronization . . . . . . . . . . . D-12GMS_site_checkin_after_import . . . . . 6-2Group mapping . . . . . . . . . . . . . . . D-10LDAP_admin_dn . . . . . . . . . . D-16, D-19LDAP_admin_pw . . . . . . . . . . D-16, D-19LDAP_attribute_mapping . . . . D-17, D-19LDAP_base_dn . . . . . . . . . . . D-17, D-19LDAP_cert_db_path . . . . . . . . D-17, D-19


Index

LDAP_group_attr_mapping . . D-17, D-20LDAP_group_base_dn . . . . . . D-17, D-20LDAP_group_object_class . . . . D-17, D-20LDAP_group_query_filter . . . . D-17, D-20LDAP_ignore_users . . . . . . . . D-17, D-20LDAP_member_list_attr . . . . . D-17, D-20LDAP_member_type_attr . . . . D-17, D-20LDAP_object_type_attr . . . . . . D-17, D-20LDAP_person_attr_mapping . . . . . . D-18,

D-21LDAP_port_number . . . . . . . . D-18, D-21LDAP_role_attr_mapping . . . . D-18, D-21LDAP_role_object_class . . . . . D-18, D-21LDAP_role_query_filter . . . . . D-19, D-21LDAP_service_hosts . . . . . . . . D-19, D-21LDAP_sync_group_flags . . . . . D-19, D-21LDAP_sync_member_flags . . . D-19, D-21LDAP_sync_role_flags . . . . . . D-19, D-21LDAP_sync_user_flags . . . . . . D-19, D-21LDAP_use_ssl . . . . . . . . . . . . D-19, D-21LDAP_user_object_class . . . . . D-19, D-21LDAP_user_query_filter . . . . . D-19, D-21Person mapping . . . . . . . . . . . . . . . . D-5Role mapping . . . . . . . . . . . . . . . . D-11

Prerequisites of Data Exchange . . . . . . . 1-1Privileges

Export . . . . . . . . . . . . . . . . . . . . . . . 6-1Import . . . . . . . . . . . . . . . . . . . . . . . 6-1Read . . . . . . . . . . . . . . . . . . . . . . . . . 6-1Transfer in . . . . . . . . . . . . . . . . . . . . 6-1Transfer out . . . . . . . . . . . . . . . . . . . 6-1Write . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Pro/ENGINEER part family table . . . . . . 9-1Process method . . . . . . . . . . . . . . . . . . B-7Progress indicator check box . . . . . . . . . 2-1Progress pane . . . . . . . . . . . . . . . . . . . . 8-4Progress query . . . . . . . . . . . . . . . . . . . 8-4Project Explorer view . . . . . . . . . . . . . 7-32Projects

Mapping Designer . . . . . . . . . . . 7-6, 7-24Mapping Designer properties . . . . . . 7-28

Propertiesfsc.uris . . . . . . . . . . . . . . . . . . . . . . 5-36globalservices.default.tc.siteid . . . . . . 5-36Mapping Designer projects . . . . . . . . 7-28

Propertyaxis2.max.connections . . . . . . . . . . . 5-19

PUID2GSIDTCXMLConverterutility . . . . . . . . . . . . . . . . . . . . . . . . 9-41

Q

Query for detailed transfer status . . . . . . 8-4

R

Reactor result table . . . . . . . . . . . . . . . 5-14Read privilege . . . . . . . . . . . . . . . . . . . . 6-1Real-time monitoring . . . . . . . . . . . . . . 2-1Recipes . . . . . . . . . . . . . . . . . . . . . . . B-8ref_names property . . . . . . . . . . . . . . . 7-20ref_types property . . . . . . . . . . . . . . . . 7-20Reference element mapping . . . . . . . . . B-7References tab . . . . . . . . . . . . . . . . . . 7-20Remote sites . . . . . . . . . . . . . . . . . . . . . 5-6Remote Teamcenter exporter failure . . . . 8-5Replica . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Replica deletion . . . . . . . . . . . . . . . . . . 1-4Required session options for configuredexport . . . . . . . . . . . . . . . . . . . . . . . . . 9-5

Required transfer options for configuredexport . . . . . . . . . . . . . . . . . . . . . . . . . 9-4

Resume activity . . . . . . . . . . . . . . . . . 9-13Resume transfer . . . . . . . . . . . . . . . . . . 2-1Rules

Filtering . . . . . . . . . . . . . . . . . . 7-5, 7-11

S

Sample configuration files . . . . . . . . . . . 6-9Sample ldapsync configuration . . . . . . D-16Sample Mapping Designer projects

Importing . . . . . . . . . . . . . . . . . . . . 7-24In general . . . . . . . . . . . . . . . . . . . . 7-24

SAP (T4S) integration . . . . . . . . . . . . . 5-17SAP integration . . . . . . . . . . . . . . . . . 5-17Schedule export . . . . . . . . . . . . . . . . . B-13Schema files . . . . . . . . . . . . . . . . . . . . . 5-8Scoper objects . . . . . . . . . . . . . . . . . . . B-2Searching child nodes in LDAP . . . . . D-16Searching for

Factors . . . . . . . . . . . . . . . . . . . . . . 7-16Secret teams . . . . . . . . . . . . . . . . . . . . 5-39Security in JBoss . . . . . . . . . . . . . . . . 5-25Send E-mail notification . . . . . . . . . . . 9-19Serialization of data . . . . . . . . . . . . . . B-1Server URL parameter . . . . . . . . . . . . . 5-1Setting FMS keys . . . . . . . . . . . . . . . . B-13Shapes_Files attribute . . . . . . . . . . . . . . 5-4Shapes_Name attribute . . . . . . . . . . . . . 5-4Show progress indicator . . . . . . . . . . . . 9-19Single sign-on . . . . . . . . . . . . . . . . . . . . 1-4Site . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Site Check-In after import . . . . . . . . . . 9-19Site checkout modification privileges . . . B-12Site ID . . . . . . . . . . . . . . . . . . . . . 5-6, 5-43Site node . . . . . . . . . . . . . . . . . . . . . . . 5-6


Index

site-id attribute . . . . . . . . . . . . . . . . . . 5-37site-id.properties file . . . . . . . . . . . . . . . 6-4sitemap.xml file . . . . . . . . . . . . . 5-37, 5-41smap:site element . . . . . . . . . . . . . . . . 5-37SOA connector SOA_URL parameter . . 5-37Source

File editing . . . . . . . . . . . . . . . . . . . 7-32sourceendpoint property . . . . . . . . . . . . 5-9SSL

Application server . . . . . . . . . . . . . . 5-29SSO . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4SSO_enabled parameter . . . . . . . . . . . 5-38SSOAppID . . . . . . . . . . . . . . . . . . . . . 5-13SSOApplicationID parameter . . . . . . . . 5-38Standard mapping . . . . . . . . . . . . . . . B-7Standard style sheet . . . . . . . . . . . . . . 5-45Standard style sheet elements . . . . . . . 5-47Standard transfer process . . . . . . . . . . 5-41Start immediate transfer . . . . . . . . . . . 9-19Starting

Mapping Designer . . . . . . . . . . . . . . . 7-3Starting JBoss . . . . . . . . . . . . . . . . . . 5-25Stub replication . . . . . . . . . . . . . . . . . . 1-4style sheet with subtypes . . . . . . . . . . . 5-45Sun ONE configuration example . . . . . D-16Supplier Relationship Management . . . . 5-9Supplier site

Cancel checkout . . . . . . . . . . . . . . . . 9-10Reservation object . . . . . . . . . . . . . . . 9-9Reservation object on checkin . . . . . . 9-11

Support filesmtiems.jar . . . . . . . . . . . . . . . . . . . . 5-11Teamcenter Enterprise connector . . . 5-11

Supported requirements actions . . . . . . 1-13Supports global transactions . . . . . . . . 5-20Synchronization . . . . . . . . . . . . . . . . . . 1-2Synchronizer . . . . . . . . . . . . . . . . . . . . 1-2Synchronizing

Component with differentrelationships . . . . . . . . . . . . . . . . B-8

Released and deleted working itemrevision . . . . . . . . . . . . . . . . . . . B-9

Released and working item revision . . B-9

TTabs

References . . . . . . . . . . . . . . . . . . . . 7-20targetendpoint property . . . . . . . . . . . . . 5-9TC XML configured BOM export . . . . . 1-16TC XML transfer failure . . . . . . . . . . . . 8-6TcGs URL . . . . . . . . . . . . . . . . . . . . . 5-43TcGSAdmins group . . . . . . . . . . . . . . . 5-34TcGSBOSJNDI . . . . . . . . . . . . . . . . . . 5-13

TcGSDORJNDI . . . . . . . . . . . . . . . . . 5-13TcGSJDBCJNDI . . . . . . . . . . . . . . . . . 5-13TcGSMessageServerJNDI . . . . . . . . . . 5-13TcGSNotifierReactorJNDI . . . . . . . . . . 5-13tcxml_export utility . . . . . . . . . . . . . . . . 5-4tcxml_import utility . . . . . . . . . . . 5-4, 9-35TCXML.xsd file . . . . . . . . . . . . . . . . 6-4, 6-7Teamcenter data importer failure . . . . . . 8-6Teamcenter Engineering transition . . . . . 1-5Teamcenter Enterprise connector, requiredfiles . . . . . . . . . . . . . . . . . . . . . . . . . 5-11

Teamcenter Environment Manager (TEM)Install Mapping Designer . . . . . . . . . . 7-1

Teamcenter scoper failure . . . . . . . . . . . 8-5Teamcenter SOA connectorconfiguration . . . . . . . . . . . . . . . . . . . 5-37

Teamcenter transfer request failure . . . . 8-4TeamcenterSoaConfig.xml file . . . . . . . 5-37TESIS integrations . . . . . . . . . . . . . . . 5-17Third-party product transitions . . . . . . . 1-5TIEConfiguredExportDefault optionset . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

TIEPropertySet transfer options . . . . . . . 5-4Tier-1 supplier . . . . . . . . . . . . . . . . . . . 1-8Tier-2 supplier . . . . . . . . . . . . . . . . . . . 1-8Transfer customization . . . . . . . . . . . . 5-41Transfer formula options . . . . . . . . . . . B-8Transfer in privilege . . . . . . . . . . . . . . . 6-1Transfer mode . . . . . . . . . . . . . . . . . . . 1-3Transfer mode objects

Option set . . . . . . . . . . . . . . . . . . . . . 5-4Transfer of ownership publicationrecord . . . . . . . . . . . . . . . . . . . . . . . . B-11

Transfer option set . . . . . . . . . . . . . . . . 1-3Transfer out privilege . . . . . . . . . . . . . . 6-1Transfer ownership AM rule . . . . . . . . . 5-6Transferring CATIA CAD data . . . . . . . . 5-8Transfers between multilingual andmonolingual sites . . . . . . . . . . . . . . . 1-13

Transition Guide . . . . . . . . . . . . . . . . . . 1-4Audit monitoring . . . . . . . . . . . . . . . . 1-4

Traversal object . . . . . . . . . . . . . . . . . B-7Traverse method . . . . . . . . . . . . . . . . . B-7Troubleshooting

Two datasets point to the same ImanFileobject . . . . . . . . . . . . . . . . . . . . . . 5-5

UUnmanaged site definition . . . . . . . . . . . 6-2Upgrade to a multilingual site . . . . . . . 1-13User group standard mapping . . . . . . . . 5-5User interface

Mapping Designer . . . . . . . . . . . . . . . 7-3


Index

Using a generated FMS key . . . . . . . . . . 5-2Using separate LDAP directories . . . . D-14Utilities

collect_garbage . . . . . . . . . . . . . . . . B-11ensure_site_consistency . . . . . . . . . . B-11fscadmin . . . . . . . . . . . . . . . . . . . . . . 8-1import and export . . . . . . . . . . . . . . . 5-4install_encryptionkeys . . . . . . . 5-2, B-13keygen . . . . . . . . . . . . . . . . . . . . . . . 5-2ldapsync . . . . . . . . . . . . . . . . . . . . . D-1PUID2GSIDTCXMLConverter . . . . . 9-41tcxml_export . . . . . . . . . . . . . . . . . . . 5-4tcxml_import . . . . . . . . . . . . . . . 5-4, 9-35

VView default Global Services log file . . . . 8-4Views

Console . . . . . . . . . . . . . . . . . . . . . . 7-31Eclipse . . . . . . . . . . . . . . . . . . . . . . 7-31

Editor . . . . . . . . . . . . . . . . . . . . . . . 7-32Factor Details . . . . . . . . . . . . . . . . . 7-30Factors . . . . . . . . . . . . . . . . . . . . . . 7-29Factors Search . . . . . . . . . . . . . . . . . 7-31Project Explorer . . . . . . . . . . . . . . . . 7-32

visible-attributes.xml file . . . . . . . . . . . . 6-7

WWeb tier

Application . . . . . . . . . . . . . . . . . . . . 5-1Generating application . . . . . . . . . . . 5-11

Web_tier directory . . . . . . . . . . . . . . . . 5-11WebLogic deployments . . . . . . . . . . . . 5-20WebTier.log file . . . . . . . . . . . . . . . . . . . 8-8Workflow handlers . . . . . . . . . . . . . . . 5-44Workspace

Switching . . . . . . . . . . . . . . . . . . . . . 7-7Write privilege . . . . . . . . . . . . . . . . . . . 6-1

Documents

Teamcenter 10.1 DataExchangeGuide - Help!help.aviacons.ru/tc10doc/PDF/en_US/tdocExt/pdf/data_exchange.pdf · Teamcenter is a trademark or ... Data Exchange performance tuning