Teamcenter Integration for CATIA V5 (11.0.6) Installation Guide

Teamcenter Integration for CATIA V5 (11.0.6) Installation Guide

What's New What's New in Previous Releases

Getting Started Installation Prerequisites The Installation Process

Configuration Customization

Integration Entry Points The Preferences .xls file

Configuring the Interface Directories and Filepaths

Environment Variables Parameter Definitions Table

Troubleshooting Uninstallation

July, 2018 © 2018 EBSolutions

Legal Notice

Siemens and the Siemens logo are registered trademarks of SiemensAG. Teamcenter is a registered trademark of Siemens Product Lifecycle Management Software, Inc. or its subsidiaries in the United States and in other countries.

CATIA is a registered trademark of Dassault Systèmes or its subsidiaries in the United States and/or other countries. Eclipse is a registered trademark of the Eclipse Foundation, Inc.

All other copyrights, trademarks, service marks, and logos are the respective property of their holders.

This documentation and its contents are proprietary and comprise legally protected subject matter belonging to EB Solutions. All use, its reproduction, and disclosure are strictly controlled and prohibited without the prior written consent of EB Solutions.

© 2018 EB Solutions. All Rights Reserved.

Table of Contents i

Teamcenter Integration for CATIA V5 (11.0.6) © 2018 EB Solutions

What's New ....................................................................................................................... 1-1 Chapter 1:

Teamcenter Integration for CATIA V5 (11.0.6) ...................................................................................... 1-2

New Features and Improvements ....................................................................................................... 1-2 Multi Model Link (MML) Browser .................................................................................................. 1-2

System Support ............................................................................................................................. 1-2

Teamcenter Loader ....................................................................................................................... 1-2

Known Issues ...................................................................................................................................... 1-3 Documentation .............................................................................................................................. 1-3

Error: System cannot find specific path (Perl Path in TcIC Compilation Batch Files) ................. 1-3

Closed Problem Reports ..................................................................................................................... 1-4

Auxiliary Files ................................................................................................................................ 1-4 Customization ............................................................................................................................... 1-5

Detailed States .............................................................................................................................. 1-5

Documentation .............................................................................................................................. 1-5

Export ............................................................................................................................................ 1-5

IMM ............................................................................................................................................... 1-5

Import ............................................................................................................................................ 1-5 JT .................................................................................................................................................. 1-6

Load .............................................................................................................................................. 1-6

Load as cgr ................................................................................................................................... 1-7

Load Merge ................................................................................................................................... 1-7

Load, Update, Save ...................................................................................................................... 1-7 Loader ........................................................................................................................................... 1-7

MML Browser ................................................................................................................................ 1-7

Project Assignment ....................................................................................................................... 1-8

Refresh .......................................................................................................................................... 1-8

Save .............................................................................................................................................. 1-8

Save Manager ............................................................................................................................... 1-9 User Settings ................................................................................................................................. 1-9

What's New in Previous Releases .................................................................................. 2-1 Chapter 2:

Teamcenter Integration for CATIA V5 (11.0.5.2) ................................................................................... 2-2

New Features and Improvements ................................................................................................. 2-2

Table of Contents ii


Known Issues ................................................................................................................................ 2-3 Closed Problem Reports ............................................................................................................... 2-3

Teamcenter Integration for CATIA V5 (11.0.5.1) ................................................................................... 2-5 New Features and Improvements ................................................................................................. 2-5

Known Issues ................................................................................................................................ 2-6

Closed Problem Reports ............................................................................................................... 2-6

Teamcenter Integration for CATIA V5 (11.0.5) ...................................................................................... 2-7 New Features and Improvements ................................................................................................. 2-7

Known Issues ................................................................................................................................ 2-7

Closed Problem Reports ............................................................................................................... 2-8

Teamcenter Integration for CATIA V5 (11.0.4.2) ................................................................................. 2-15 New Features and Improvements ............................................................................................... 2-15

Known Issues .............................................................................................................................. 2-15 Closed Problem Reports ............................................................................................................. 2-15


Known Issues .............................................................................................................................. 2-16

Closed Problem Reports ............................................................................................................. 2-16

Teamcenter Integration for CATIA V5 (11.0.4) .................................................................................... 2-17 New Features and Improvements ............................................................................................... 2-17

Known Issues .............................................................................................................................. 2-19


Teamcenter Integration for CATIA V5 (11.0.3.1) ................................................................................. 2-26

New Features and Improvements ............................................................................................... 2-26 Known Issues .............................................................................................................................. 2-26



Known Issues .............................................................................................................................. 2-29



Known Issues .............................................................................................................................. 2-36


Table of Contents iii



Known Issues .............................................................................................................................. 2-42



Known Issues .............................................................................................................................. 2-54



Known Issues .............................................................................................................................. 2-74 Closed Problem Reports ............................................................................................................. 2-75

Teamcenter Integration for CATIA V5 (10.0.1) .................................................................................... 2-95 New Features and Improvements .............................................................................................. 2-95

Known Issues .............................................................................................................................. 2-96


Teamcenter Integration for CATIA V5 (10.0.0) .................................................................................. 2-106 New Features and Improvements ............................................................................................. 2-106

Known Issues ............................................................................................................................ 2-118

Closed Problem Reports ........................................................................................................... 2-119

Teamcenter Integration for CATIA V5 (9.0.1) .................................................................................... 2-135 New Features and Improvements ............................................................................................. 2-135 Known Issues ............................................................................................................................ 2-137


Teamcenter Integration for CATIA V5 (9.0.0) .................................................................................... 2-147 New Features and Improvements ............................................................................................. 2-147

Known Issues ............................................................................................................................ 2-160


Teamcenter Integration for CATIA V5 (8.3.4.1) ................................................................................. 2-170 New Features and Improvements ............................................................................................. 2-170

Known Issues ............................................................................................................................ 2-170


Teamcenter Integration for CATIA V5 (8.3.4) .................................................................................... 2-171

New Features and Improvements ............................................................................................. 2-171 Known Issues ............................................................................................................................ 2-173

Table of Contents iv







Known Issues ............................................................................................................................ 2-186



Known Issues ............................................................................................................................ 2-189






Known Issues ............................................................................................................................ 2-197



Known Issues ............................................................................................................................ 2-205 Closed Problem Reports ........................................................................................................... 2-205


Known Issues ............................................................................................................................ 2-206



Known Issues ............................................................................................................................ 2-207



Table of Contents v





Known Issues ............................................................................................................................ 2-214



Known Issues ............................................................................................................................ 2-230






Known Issues ............................................................................................................................ 2-261





Known Issues ............................................................................................................................ 2-287



Known Issues ............................................................................................................................ 2-288




Table of Contents vi


Getting Started ................................................................................................................. 3-1 Chapter 3:

Teamcenter and CATIA V5 ........................................................................................................... 3-1

Active Workspace and CATIA V5 ................................................................................................. 3-2

Prerequisites for System and Application Administrators ...................................................................... 3-2

Compatibility Between Teamcenter Integration for CATIA V4 and Teamcenter Integration for CATIA V5 .................................................................................................... 3-3

Upgrading Teamcenter Integration for CATIA V5 from the 7.x Series ................................................... 3-3

Installation Prerequisites ................................................................................................ 4-1 Chapter 4:

Supported Operating Systems ............................................................................................................... 4-1

System Requirements ............................................................................................................................ 4-2

Teamcenter and CATIA Requirements ............................................................................................... 4-2

CATIA/CAA Compatibilities ................................................................................................................ 4-2

HP-UX 11.11 Prerequisite .................................................................................................................. 4-3

CAA Compilation Prerequisites .............................................................................................................. 4-4

Shared Library Clean-up ........................................................................................................................ 4-5

Localization / Internationalization ........................................................................................................... 4-5

The Installation Process .................................................................................................. 5-1 Chapter 5:

Installation Summary .............................................................................................................................. 5-1

InstallAnywhere Features ....................................................................................................................... 5-2

Java Virtual Machine (JVM) ................................................................................................................ 5-3

Localization ......................................................................................................................................... 5-3

Installer Modes .................................................................................................................................... 5-4

Installing Translation Services ................................................................................................................ 5-5

Deployment Strategies........................................................................................................................ 5-6

Installation Prerequisites ..................................................................................................................... 5-7

To convert CATIA files into JT files (SIEMENS.catiav5tojtdirect and SIEMENS.catiav4tojtdirect) ........................................................................................................... 5-8

To create .bmp Thumbnails from CATIA Files (SIEMENS.catiav5preview) ................................. 5-8

Using InstallAnywhere ........................................................................................................................ 5-8

Table of Contents vii


Post-Installation Steps ...................................................................................................................... 5-10 Set the Teamcenter Service Host Address and Dedicated User (Dispatcher Server) ............... 5-10

Modify the .catiav5tojtdirect Script (Dispatcher Server) .............................................................. 5-12

Modify the .catiav4tojtdirect Script (Dispatcher Server) .............................................................. 5-12

Verifications ................................................................................................................................. 5-13

Installing Teamcenter Integration for CATIA V5 on UNIX .................................................................... 5-17

InstallAnywhere ................................................................................................................................. 5-17 Using InstallAnywhere: Server Installation.................................................................................. 5-18

Using InstallAnywhere: cdrom Extraction .................................................................................. 5-19

Customizing Teamcenter Files ......................................................................................................... 5-19

Installing Teamcenter Integration for CATIA V5 on Windows .............................................................. 5-20

Using InstallAnywhere ...................................................................................................................... 5-20 Using InstallAnywhere : Client Installation .................................................................................. 5-21

Using InstallAnywhere : Server Installation................................................................................. 5-24

Using InstallAnywhere : Build CATIA Libraries ........................................................................... 5-27

Using InstallAnywhere : cdrom Extraction .................................................................................. 5-28

Customizing Teamcenter Files ......................................................................................................... 5-30

Creating Cache Directories ............................................................................................................... 5-31

The About integration Menu within Teamcenter and CATIA V5 .......................................................... 5-31

Configuration Details......................................................................................................................... 5-31

Version Number ................................................................................................................................ 5-33

Configuration .................................................................................................................. 6-35 Chapter 6:

Define Different CATIA Versions to Launch within the Integration ...................................................... 6-35

Configure Active Workspace .................................................................................................................. 6-3

Define Types of Clients ....................................................................................................................... 6-3

For Embedded Active Workspaces ............................................................................................... 6-4 For Standalone Active Workspaces .............................................................................................. 6-5

Embedded Active Workspace Settings and Location ......................................................................... 6-6

Default Setting Values................................................................................................................... 6-8

Settings and Location.................................................................................................................... 6-8 Visualization in Active Workspace ................................................................................................ 6-9

Table of Contents viii


Standalone Active Workspace Settings and Location ........................................................................ 6-9 Settings and Location.................................................................................................................... 6-9

Load Manager ................................................................................................................................... 6-11

Load Manager Panel ................................................................................................................... 6-11

Teamcenter Loader Contextual Menu ........................................................................................ 6-12 Display structure Contextual Menu ............................................................................................. 6-13

Open in CATIA .................................................................................................................................. 6-14

Configure CATIA V5 ............................................................................................................................. 6-14

Configure Teamcenter .......................................................................................................................... 6-14

Active Workspace ............................................................................................................................. 6-15

Custom Configurations ..................................................................................................................... 6-15

Multi-site Configurations ................................................................................................................... 6-16

New Instance Synchronization ......................................................................................................... 6-17

Templates ......................................................................................................................................... 6-17

Template Prerequisites ............................................................................................................... 6-20 Accessing the Templates ............................................................................................................ 6-20

Display Specific Relations ........................................................................................................... 6-21

The CATIA V5 Menu in Teamcenter ................................................................................................. 6-22

Create Dataset Items Using the PSE Menu................................................................................ 6-22

Configure Teamcenter Loader ............................................................................................................. 6-23

Teamcenter Preferences .................................................................................................................. 6-23

Configure Teamcenter Integration for CATIA V5 ................................................................................. 6-24

Attribute Mappings ............................................................................................................................ 6-24

Behavior and Modifying CATIA Properties ................................................................................. 6-25 Configuring Attribute Mappings ................................................................................................... 6-27

Configuring Attribute Mappings for CATDrawings, CATParts and CATProducts............................. 6-30

Configuring Attribute Mappings for DesignTables ...................................................................... 6-35

Configuring Attribute Mappings for Foreign Files ....................................................................... 6-36 Configuring Attribute Mappings for the Integration Schema ....................................................... 6-37

Configuring Attribute Mappings for the Save Manager ............................................................... 6-38

Table of Contents ix


Preferences Related to Attribute Mappings ................................................................................ 6-40

CGR Management ............................................................................................................................ 6-45

Overview ..................................................................................................................................... 6-45

Configure CATIA ......................................................................................................................... 6-46

Configure Teamcenter ................................................................................................................ 6-46

Configuring Ignore Nodes ................................................................................................................. 6-49

Import Queries .................................................................................................................................. 6-50 Build an Import Query ................................................................................................................. 6-51

Create New Import Preferences ................................................................................................. 6-54

Item Revision Browser Queries .................................................................................................. 6-57

Supplier Import Queries .............................................................................................................. 6-57

Developing the Integration Schema .................................................................................................. 6-59 The Integration Schema .............................................................................................................. 6-59

How Teamcenter Integration for CATIA Manages CATIA Components ..................................... 6-61

Create the CatiaExport Tool ....................................................................................................... 6-62

Seed Documents ......................................................................................................................... 6-62

Integration Toolbar ............................................................................................................................ 6-64 Save ............................................................................................................................................ 6-64

Import .......................................................................................................................................... 6-64

Load ............................................................................................................................................ 6-64

Add CATShape ........................................................................................................................... 6-65 Utility............................................................................................................................................ 6-65

Replace Load as cgr ................................................................................................................... 6-65

Configure Environment Messages .............................................................................................. 6-65

Configure Icons ........................................................................................................................... 6-65

Configuring Multiple CATIA Environments ....................................................................................... 6-66 Customize CATIA Running Scripts ............................................................................................. 6-66

Launch Different CATIA Versions ............................................................................................... 6-71

View the Log File ......................................................................................................................... 6-72

Preferences Related to Multiple CATIA Environments ............................................................... 6-72

Multi-Model Link (MML) Browsing Using My Teamcenter ................................................................ 6-76

Teamcenter Preferences for Multi-Model Link (MML) Browsing Using My Teamcenter ............ 6-76

Configuring the Theorem/Teamcenter Translator ............................................................................ 6-78

Table of Contents x


The catia2jt script for the Theorem Translator ............................................................................ 6-78 Call catiav5tojtdirect Service in Workflow ................................................................................... 6-78

Preferences Related to Dispatcher Services .............................................................................. 6-79

Customizing Teamcenter Integration for CATIA V5 ..................................................... 7-1 Chapter 7:

BOMView Type ....................................................................................................................................... 7-2

Create and Customize a Contextual Menu or Toolbar ........................................................................... 7-2

Create a Contextual Menu .................................................................................................................. 7-2 Create the Contextual Menu Description Class ............................................................................ 7-3

Create the Contextual Menu ......................................................................................................... 7-5

Customize a Teamcenter Contextual Menu ....................................................................................... 7-6

Create a New Toolbar ....................................................................................................................... 7-12

Create a Toolbar ......................................................................................................................... 7-12

Create a Toolbar using CAA ....................................................................................................... 7-13

Dataset Browser ................................................................................................................................... 7-15

Add/Remove Columns ...................................................................................................................... 7-15 Column Width and Titles ............................................................................................................. 7-16

Modify Column Titles ................................................................................................................... 7-16

Reorder Columns .............................................................................................................................. 7-16

Define the Environment ........................................................................................................................ 7-17

Customizing the CATIA_env File ...................................................................................................... 7-18

Display Messages in the System Language ........................................................................................ 7-20

Import Spreadsheet Editor ................................................................................................................... 7-20

Preferences Related to the Spreadsheet Editor Panel ..................................................................... 7-21

Teamcenter Integration for CATIA V5 Toolbar ..................................................................................... 7-22

Hide All or Parts of the Toolbar ......................................................................................................... 7-22

Icon Descriptions and File Names .................................................................................................... 7-23

Save ............................................................................................................................................ 7-23

Import .......................................................................................................................................... 7-23 Load ............................................................................................................................................ 7-23

Add CATShape ........................................................................................................................... 7-23

Table of Contents xi


Utility............................................................................................................................................ 7-24 Replace Load as cgr ................................................................................................................... 7-24

Descriptions and File Names ...................................................................................................... 7-24

Item Revision Browser.......................................................................................................................... 7-29

Add/Remove Columns ..................................................................................................................... 7-30

Adjust Column Widths....................................................................................................................... 7-30

Modify Column Titles ........................................................................................................................ 7-31

Reorder Columns .............................................................................................................................. 7-31

JT: The catia2jt Script .......................................................................................................................... 7-32

Teamcenter catia2jt Script Example ................................................................................................. 7-32

Customize the MML Browser Display .................................................................................................. 7-34

Options .............................................................................................................................................. 7-34

Frame .......................................................................................................................................... 7-35 Configuration ............................................................................................................................... 7-36

Tree ............................................................................................................................................. 7-36

Table ........................................................................................................................................... 7-37

Managing Properties ......................................................................................................................... 7-37

Reset the Browser Display ............................................................................................................... 7-38

Customize the MML Browser Display: Common Errors ................................................................... 7-38

Modify the Look & Feel ......................................................................................................................... 7-39

Save Manager ...................................................................................................................................... 7-41

The Save Manager Editor Panel ....................................................................................................... 7-41

The Save Manager Table ................................................................................................................. 7-41

Add/Remove/Hide Columns ........................................................................................................ 7-42 Change Table Icons .................................................................................................................... 7-45

Column Width and Titles ............................................................................................................. 7-45

Reorder Columns ........................................................................................................................ 7-46

Set the Table/Editor Divider Position .......................................................................................... 7-47

The Save Manager Toolbar .............................................................................................................. 7-48 Customize the Right Vertical Toolbar ......................................................................................... 7-48

Table of Contents xii


Customize the Top Horizontal Toolbar ....................................................................................... 7-50

Save Manager Title Area .................................................................................................................. 7-52

Preferences Related to the Save Manager ...................................................................................... 7-52 Always Display the Save Manager During Save ........................................................................ 7-52

Save a Drawing, Process or Analysis File .................................................................................. 7-53

Use Existing Item Revision ......................................................................................................... 7-53

Display Additional Information within the title of the Save Manager Panel ................................. 7-53

Special Characters ............................................................................................................................... 7-54

Preferences Related to Special Characters...................................................................................... 7-55

Status Window Customization .............................................................................................................. 7-55

Status Window Table Customization ................................................................................................ 7-55 Status Window Table Customization: Add/Remove Columns .................................................... 7-56

Status Window Table Customization: Change Table Icons ........................................................ 7-61

Status Window Table Customization: Column Widths and Titles ............................................... 7-62

Status Window Table Customization: Reorder Columns ............................................................ 7-63

Status Window Title Area ................................................................................................................. 7-65

Status Window Toolbar Customization ............................................................................................. 7-65 Customize Status Window Toolbar Buttons................................................................................ 7-65

Modify Toolbar Order .................................................................................................................. 7-67

Preferences Related to the Status Window ...................................................................................... 7-67

Check-in/Check-out Panel .......................................................................................................... 7-67 Display Additional Information Within the Title of the Status Window Panel .............................. 7-68

Teamcenter Loader .............................................................................................................................. 7-68

Hide Commands ............................................................................................................................... 7-69

Impact Analysis ................................................................................................................................. 7-71

Loader Size ....................................................................................................................................... 7-72

Show in Teamcenter Menu ............................................................................................................... 7-72

Viewer Size ....................................................................................................................................... 7-74

Saved Searches ................................................................................................................................ 7-74

Table of Contents xiii


Integration Entry Points .................................................................................................. 8-1 Chapter 8:

ITK Functions ......................................................................................................................................... 8-1

Overview ............................................................................................................................................. 8-1 Common Header ........................................................................................................................... 8-1

Current Process Identifier ............................................................................................................. 8-2

libcatia_tc_custom ......................................................................................................................... 8-3

Working Environment .................................................................................................................... 8-3

ItemID/Item Revision ........................................................................................................................... 8-5

List of ITK Functions ........................................................................................................................... 8-5 Assembly Configuration ................................................................................................................ 8-5

Auxiliary Files ................................................................................................................................ 8-7

BOM Line Validation/CATPart, CATProduct Datasets ................................................................. 8-7

Check In/Check Out ...................................................................................................................... 8-8

Dataset .......................................................................................................................................... 8-9

Export as reference and Load as reference................................................................................ 8-14 External Files .............................................................................................................................. 8-16

Foreign Files ............................................................................................................................... 8-17

Import Spreadsheet ..................................................................................................................... 8-18

Item Revision .............................................................................................................................. 8-19

Item and Item Revision ............................................................................................................... 8-19

Item Revision Rule ...................................................................................................................... 8-20 JT ................................................................................................................................................ 8-20

Load ............................................................................................................................................ 8-22

Occurrences ................................................................................................................................ 8-23

Replace by revision ..................................................................................................................... 8-25

Save ............................................................................................................................................ 8-25 Save New Revision ..................................................................................................................... 8-26

Secondary Dataset ...................................................................................................................... 8-27

Title Block .................................................................................................................................... 8-29

TC_Custom Libraries ........................................................................................................................ 8-30 UNIX ............................................................................................................................................ 8-30

Windows ...................................................................................................................................... 8-31

Scripts ......................................................................................................................................... 8-31

RACLess Entry Points ...................................................................................................................... 8-32

Table of Contents xiv


RACLess Mode Through Server Support ................................................................................... 8-32

Definition of the client_env File ......................................................................................................... 8-32

List of Functions Available in RACLess Mode .................................................................................. 8-36

StartRACLessServer.bat file and Project Management ................................................................... 8-40

Launch the StartRACLessServer.bat file .................................................................................... 8-41

Stop the RACLess connection .................................................................................................... 8-41

JAVA Code Customizations .............................................................................................................. 8-44 Introduction and Implementations ............................................................................................... 8-44

Customized Implementations ...................................................................................................... 8-47

Process Lock ............................................................................................................................... 8-69

Selection Management ............................................................................................................... 8-71 Silent Processes with JAVA Code Customization ...................................................................... 8-73

The tcic_selection.xml File .......................................................................................................... 8-74

User Interface Implementations: Main Classes .......................................................................... 8-76

Examples of RACLess Customizations .................................................................................... 8-100

Check in/Check Out Customization ................................................................................................ 8-103 RACLessProcessAbstract Implementation ............................................................................... 8-103

Use a Java Project to Compile and Install the Sample ............................................................. 8-107

Save Manager and State Details Customization ............................................................................ 8-115

Silent Import .................................................................................................................................... 8-122

Method 1: Launch two CATScript processes ........................................................................... 8-123

Method 2: Create a RACLess process that inherits from the RACLessProcessAbstract class .... 8-124 UserImportCommand API ......................................................................................................... 8-124

Silent Export .................................................................................................................................... 8-128

UserExportCommand API ......................................................................................................... 8-130 SampleSilentExport Sample ..................................................................................................... 8-130

Silent Load, Update, Save .............................................................................................................. 8-134

UserLUSCommand API ............................................................................................................ 8-135

SampleSilentLUS Sample ......................................................................................................... 8-135

RACLess API JAVA Documentation ............................................................................................... 8-138

Table of Contents xv


RACLess Command Line Entry Points ........................................................................................... 8-138

Save Manager .................................................................................................................................... 8-145

Save Manager Configuration File ................................................................................................... 8-145 Save Manager Configuration File: Graphical Objects Description ........................................... 8-147

Save Manager Configuration File: XML Tags ........................................................................... 8-147

Save Manager Entry Point ........................................................................................................ 8-150

Save Manager Lifecycle.................................................................................................................. 8-152 CATIAdatas ............................................................................................................................... 8-152

Concrete Classes Implementation ............................................................................................ 8-155

Data and Objects Accessors ..................................................................................................... 8-157

Interface Construction ............................................................................................................... 8-162 Managing XML Information ....................................................................................................... 8-165

Save Module Elements ............................................................................................................. 8-172

Factories Mechanism ................................................................................................................ 8-173

The Listeners ............................................................................................................................ 8-174

Save Manager Workbench ....................................................................................................... 8-178

The Cat2uimanager.jar File ...................................................................................................... 8-179 Setting up an Environment ........................................................................................................ 8-183

Save Manager Tutorial.................................................................................................................... 8-190

Import a Project into Eclipse ..................................................................................................... 8-191

Create a New Display Element ................................................................................................. 8-193 Create a New Action ................................................................................................................. 8-195

Create a New Application.......................................................................................................... 8-198

Create a New Button ................................................................................................................. 8-200

Create a New Module ............................................................................................................... 8-203

Create a New Toolbar Style ...................................................................................................... 8-206 Manage CATIAdata Before and After the Save Manager Displays .......................................... 8-208

Change the Table Display ......................................................................................................... 8-210

Save Manager API Java Documentation ........................................................................................ 8-214

User Exit Class ................................................................................................................................... 8-215

Entry Point Before Local Save ........................................................................................................ 8-215 Overview ................................................................................................................................... 8-215

Customize Using CAA APIs ...................................................................................................... 8-215

Customize Using CATScript ..................................................................................................... 8-217

Table of Contents xvi


Modify CATIA Documents ......................................................................................................... 8-217

CATIA Settings Access ................................................................................................................... 8-218

Example .................................................................................................................................... 8-220

Load Entry Point ............................................................................................................................. 8-221 The userExitAfterAllExportedFiles Function ............................................................................. 8-222

The userExitAtEndOfLoadProcesses Function ........................................................................ 8-222

CATIA Side ............................................................................................................................... 8-223

Save Entry Point ............................................................................................................................. 8-224 CATIA Side ............................................................................................................................... 8-224

Teamcenter Side/After Save Entry Point .................................................................................. 8-225

The Preferences .xls File and Configuring the Interface ............................................. 9-1 Chapter 9:

Configuring the Interface ........................................................................................................................ 9-2

The Configuration Directory, Folder and Files ....................................................................................... 9-6 File Names and Descriptions ........................................................................................................ 9-6

Location and Naming Convention ................................................................................................. 9-8

Directories and Filepaths, Environment Variables and Parameter Definitions TableChapter 10: 10-1

Directories and Filepaths ...................................................................................................................... 10-1

Parameter Definitions Table ................................................................................................................. 10-4

System and User Environment Variables ............................................................................................. 10-8

Installation Troubleshooting ......................................................................................... 11-1 Chapter 11:

Error Logs and Preferences ................................................................................................................. 11-1

Activate the Client Log File ............................................................................................................... 11-2

Activate the Server Log File .............................................................................................................. 11-3

Display a Warning Message During the Save Processs .................................................................. 11-3

Enable Tracing Events ...................................................................................................................... 11-4

Journal Name .............................................................................................................................. 11-4

Teamcenter Logs .............................................................................................................................. 11-5

Translation Services ............................................................................................................................. 11-5

Translation Request Did Not Complete ............................................................................................ 11-5

Table of Contents xvii


Troubleshooting .catiav5preview ...................................................................................................... 11-5

Uninstall Teamcenter Integration for CATIA V5 .......................................................... 12-1 Chapter 12:

Uninstall Teamcenter Integration for CATIA V5 (Client) ...................................................................... 12-1

Uninstall Teamcenter Integration for CATIA V5 (Server) ..................................................................... 12-2

Uninstall Teamcenter Integration for CATIA V5 (Silent Mode)............................................................. 12-2

What's New

1-1


What's New Chapter 1:What's New in this release? What's New in previous releases?

What's New Teamcenter Integration for CATIA V5 (11.0.6)

1-2


Teamcenter Integration for CATIA V5 (11.0.6)

New Features and Improvements Known Issues Closed Problem Reports

New Features and Improvements

Multi Model Link (MML) Browser System Support Teamcenter Loader Visualization in Active Workspace

Multi Model Link (MML) Browser

The Show in Teamcenter command is now available under the Multi Model Link Browser to allow users to open the element selected in Teamcenter.

System Support

In addition to other prerequisites, Teamcenter 12.0.0 (and higher) is now supported on Linux Server and Windows platforms.

Teamcenter Loader

Displayed objects in Teamcenter Loader can now be sorted by name.

My Worklist

My Worklist can now be viewed from the navigation pane. Select a task to perform in the My Worklist component view, use the Viewer view with Task View selected and display a list of users assigned to perform a signoff task from My Worklist tree.

The My Worklist tree includes your user inbox, remote inboxes, and resource pool inboxes to which you are subscribed.

Each inbox contains two folders, Tasks to Perform and Tasks to Track.


1-3


Quick Search

Use the new Quick Search tool to manage the Most Recently Used queries and Favorites. Search can be based on Item ID, Item Name, and Dataset Name. Search results and Favorites display as sliding panels.

Modify the value of the new preferences CATIA_loader_search_loading_page_size and CATIA_loader_search_load_all_limit to set a limit on the number of objects to be loaded in the quick search page.

Search BOM Lines

Frequently used search queries can be saved and reused in the Search BOM Lines field of the Display Structure.

Visualization in Active Workspace

Visualization is supported with Active Workspace 4.0 by activating the IS_VIEWER_SUPPORTED option in the %TCICV5_DIR%\env\aw_config.properties file.

Set this option to false to disable visualization in Active Workspace.

awhosted.option.IS_VIEWER_SUPPORTED = true

Known Issues

Documentation Error: System cannot find specific path (Perl Path in TcIC Compilation Batch Files)

Documentation

Display issues occur and the print button is disabled when viewing the online documentation in Chrome. Chrome automatically blocks the print script from running when viewing the documentation locally as a security precaution. All other browsers are supported.

Error: System cannot find specific path (Perl Path in TcIC Compilation Batch Files)

The error message, System cannot find specific Path, displays when compiling Teamcenter 11.3 and higher. This error is caused by the Perl path (%TC_ROOT%\bin\perl in %TCICV5_DIR%\custom_server) for the following TcIC compilation batch files:

• compile.bat


1-4


• link_custom_exits.bat

• link_tc_custom_exits.bat

Solution

Replace the %TC_ROOT%\bin\perl path for the batch files with %TC_ROOT%\perl\bin\perl.

Closed Problem Reports

Auxiliary Files Customization Detailed States Documentation Export IMM Import JT Load Load as cgr Load Merge Load, Update, Save Loader MML Browser Project Assignment Refresh Save Save Manager User Settings

Auxiliary Files

Reference PR 9034037

Summary TcIC: DXF generation results in FMSException error.


1-5


Customization


Summary TcIC 11.0.3.4 customization - plugin issue


Summary TcIC 11.0.4 Load using user exit cat_USER_is_default cannot change dataset

Detailed States


Summary 'Detailed States' - Dialog switches into background

Documentation


Summary Needs to know where the TcIC BMIDE files are for v11.0.5

Export


Summary TcIC occasionally hangs when running in silent mode

IMM


Summary Material on multi-bodies in CATIA are not exposed properly in Tc using IMM.

Import


Summary A drawing update is done while creating the import


1-6



Summary TcICV5: Import Spreadsheet Editor Multiple Changes incorrect selection/blank UI.


Summary TcICV5 Import spreadsheet creation failed - Document can not be read


Summary TcIC Spreadsheet Import Fail


Summary Spreadsheet import of CATDrawing fails when file name conflicts with naming rule

JT


Summary JT creation fails for baseline if JT dataset exists

Load


Summary TcIC-"Load as cgr" and "Replace Load As Cgr" not OK with loc. and rel. cache


Summary [TcIC] CATPart of different revision is loaded.


Summary [TcIC]Loading using Load as Cgr=ON is slower.


Summary TcIC cannot load STL file if a release status is set.


1-7


Load as cgr


Summary TcIC 11.0.5.2: Load as cgr not working as expected.

Load Merge


Summary Load merge error with TcIC 11

Load, Update, Save


Summary TcIC LUS command behavior in the context Load options

Loader

Reference ER 7904440

Summary TcIC 11.0.1 Teamcenter Loader have no sorting.


Summary Sorting issue in TcIC loader


Summary TcIC - RMB not working in Loader when expanding the structure.

MML Browser


Summary MML Browser don't show info on CATPart with Drawing Links.


1-8


Project Assignment


Summary TcIC 11 Project Assign should be possible to set to always be on Item Level

Refresh


Summary Check in on Save does not refresh the display of CO status in Teamcenter.


Summary TcIC: Refresh is required for an ItemRevision created by TcIC

Save


Summary CATDrawing sheet numbers not getting displayed in proper sequence in Teamcenter


Summary Several characters of Formula value are lost during attribute mapping


Summary Workflow process does not show up error/Warning Dialogue in TcIC11.


Summary Teamcenter Integration saving without respond


Summary Save to Tc fails with "Action Canceled: end of the command" if we add large desc



1-9


Summary TcIC does not work on Windows 10.


Summary TcIC changes Values during save process


Summary Save process replace existing dataset for new drawing.

Save Manager


Summary Projects are not sorted correctly in TcIC 11.


Summary Save Manager Multi-Select Use Existing Dataset gets Null Error


Summary TcIC - save manager shows "/Attribut" in ItemID field.


Summary Array of tag property is unsupported in TcIC.

User Settings


Summary TcIC User Settings window in CATIA is not shown correctly for some users.

What's New in Previous Releases

2-1


What's New in Previous Releases Chapter 2:Version 11.0.5.2 Version 11.0.5.1 Version 11.0.5 Version 11.0.4.2 Version 11.0.4.1 Version 11.0.4 Version 11.0.3.1 Version 11.0.3 Version 11.0.2.1 Version 11.0.2 Version 11.0.1 Version 11.0.0 Version 10.0.1 Version 10.0.0 Version 9.0.1 Version 9.0.0 Version 8.3.1.2 Version 8.3.1.1 Version 8.2.4 Version 8.2.0 Version 8.1.0 Version 8.0.6 Version 8.0.1 Version 8.0.0

Disclaimer: Information in this documentation kit is applicable only to the latest version of the Integration. This section, What's New in Previous Releases, is for reference purposes only. Links and/or other content contained in this section may sometimes refer to functionality that has recently become obsolete or inaccurate in the latest Integration version.

What's New in Previous Releases Teamcenter Integration for CATIA V5 (11.0.5.2)

2-2


Teamcenter Integration for CATIA V5 (11.0.5.2)



Load, Update, Save

Under some circumstances, assemblies are not up-to-date after a Load, Update, Save process.

Use the new preference, CATIA_LoadUpdateSave_modified_file_option, to indicate whether to force both modified and unmodified files to be saved during the Load, Update, Save process (ALL) or to save only modified files and their parents (PARENTS).

By default, the value of this preference is NONE indicating only modified files are saved.

The value of this preference can also be locally overloaded to define a specific behavior for the current session without changing the value set in Teamcenter.

The force Save is also available interactively through the Load, Update, Save options in the following configurations. They are available under all context or panels in which the Load, Update, Save process is already supported like Navigator, Structure Manager, TcIC Loader, etc.

Material and Mass Properties Geometric Information

With out of the box (OOTB) Teamcenter Integration for CATIA V5, Mass Properties and Materials can be computed for the document only or for the main body only of each document when the Compute Mass Properties for the Main Body button is toggled on.

Using Teamcenter Integrated Material Management software, materials are managed in Teamcenter throughout the lifecycle, from material design to production, as well as throughout the lifecycle of products that include these materials.

Mass property management can be enhanced using TcIC with Teamcenter Integrated Material Management. Through this, material management can be exposed to Teamcenter for each individual body of the part.

This enhancement requires Integrated Material Management and support from Siemens to integrate TcIC and IMM.


2-3


Use the new preference, CATIA_IMM_managed, to store CATIA Material and Mass data according to Integrated Material Management schema (true) or to store CATIA Material and Mass data in CATIA_model_form form in Teamcenter (false).

Customize the userExitAfterAllImportedFiles entry point to have access to geometric data during the Save process.

Known Issues



Load Load, Update, Save Material Management Save

Load


Summary [TcIC] CATPart of different revision is loaded.


Summary TcIC Assembly lost flexibility after Item Id Change.


2-4


Load, Update, Save


Summary TcIC LUS command behavior in the context Load options.

Material Management


Summary Material on multi-bodies in CATIA are not exposed properly in Tc using IMM.

Save


Summary Several characters of Formula value are lost during attribute mapping


Summary TcIC: Refresh is required for an ItemRevision created by TcIC


Summary TcIC Error when store CATProcess dataset to existing ICF_Cust_Prt-item.


2-5



Summary Save to Tc fails with "Action Canceled: end of the command" if we add large desc


Summary TcIC - Save Manager shows "/Attribut" in ItemID field.




Assign to Project

Projects in Teamcenter organize data and are the basis for granting data access to project team members.

During the Save As or Create New processes, an item or item revision can be assigned to or removed from a Project.

Configure whether a project can be assigned to either an item or an item revision by default, during the Save and Import processes by setting the new preferences, CATIA_apply_project_by_default for the Save process and CATIA_apply_project_by_default_for_import for the Import process. The default value of these preferences is ItemRevision, indicating the Item Revision button is toggled on.

Assign to Project is available during the Save Existing, Use Existing Dataset, Use Existing Item, Import Existing and Import New Revision processes.


2-6


CATIA Support

This version adds support for CATIA V5-6R2018, SP1 on Windows 7 64 bit, Windows 8 and Windows 10.

Known Issues



Load


Summary TcIC 11.0.4: Load using user exit cat_USER_is_default cannot change dataset.

Save Manager


Summary TcIC 11: Project Assign should be possible to set to always be on Item Level.

What's New in Previous Releases Teamcenter Integration for CATIA V5 (11.0.5)

2-7





Exclude Dataset Types from Load Save Manager and Spreadsheet Editor Panels

Exclude Dataset Types from Load

Exclude certain dataset types from being loaded by listing them in the CATIA_exclude_dataset_types_on_load preference. These dataset types will be ignored from the top line during the Load/Export processes.

This preference can also be used to improve load performance.

The datasets to exclude must be defined in CATIA_component_dataset_types preference.

Save Manager and Spreadsheet Editor Panels

Naming rules and associated naming patterns now display in the Save Manager and Spreadsheet Editor panels.

The naming rule can be selected and applied during the Item ID and Item Revision ID assignation processes.

An object can be associated to several naming rules. Items can be assigned with a specific rule such as minor or major modifications, in addition to the default naming rule. Only naming rules valid for the current object display in the Naming Rule panel.

Multi-selection is permitted.

Known Issues


2-8




Documentation Export Import Install Load Load As Load for compare Load, Update, Save Loader Preview Purge Replace Save Save As Save Manager State Details UTF-8

Documentation


Summary Significance of socketV5.exe parameter.


2-9


Export


Summary Export drawing with view from 3D option gives error though export is successful.

Import


Summary TcIC Spreadsheet Import for Drawing with MFK counter fails for second MFK value.

Install


Summary TcIC 11.0.4 and 11.0.4.1 not work.

Load


Summary Stop delivering QLJTs while loading Structure without CATProduct.



2-10


Summary When load assembly, structure is not sync


Summary Can not open CGR file


Summary TcIC - Load to CATIA revision conflict last column not visible.


Summary TcIC load leaves BOM Window open.

Load As


Summary TcIC Load as reference core dump when unreadable in structure.

Load for compare


Summary Load for consulting and compare shows TcIC save manager when


2-11


trying to save..

Load, Update, Save


Summary LUS fails if CATDrawing and CATProduct datasets are in CATDrawing ItemRev.

Loader


Summary Effectivity option does not apply structures in Display structure.

Preview


Summary Preview not working correctly for revision having CATPart and JT dataset attached.

Purge



2-12


Summary Purge deletes new files in CATIA session when DLNames is used.

Replace


Summary Replace loading as CGR leads to CATIA hang.

Save


Summary Save As with Scene management increases save time considerably.


Summary Arrangements with multiple subassembly occurrences show incorrect position.


Summary TcIC does not handle multi-variable DL_Names.



2-13


Summary Parameter mapping not working for EHF drawing with views created from 3D FT&A.

Save As


Summary TcIC does not update custom attributes when create new component from existing.


Summary CATIA TcIC: Scene (arrangement) do not display correctly in Viewer.


Summary TcIC 11 does not allow some LOV cases.

Save Manager


Summary LOV type property is not available in Save Manager.



2-14


Summary Duplicate IDs generated in CATIA SaveManager.


Summary Save As does not allow to change the part name in TcIC 11.0.4 Save Manager.

State Details


Summary TcIC is use a lot of memory.

UTF-8


Summary Cannot connect Tc with CATIA in UTF8 DB Environment.


2-15





This version fixes Problem Reports.

Known Issues



State Details


Summary TcIC is use a lot of memory.


2-16





Attribute Mapping

The filename value is now supported in the CATIA_savemanager_map_ir_attr and CATIA_savemanager_map_ds_attr preferences. The CATIA filename property can be mapped to an item revision attribute or a dataset attribute in the Save Manager panel

Known Issues



Save/Import


Summary CATIA filename should be defined as the automotive OEM requires.


2-17





Create Descriptor

Customize Load Process

Default Dataset Entry Point

Messages

Rename Drawing Datasets during Save As/Revise within Teamcenter

Create Descriptor

The Save and Import processes now support Teamcenter's Create Descriptor during dataset creation. when the CATIA_use_dataset_descriptor preference is set to true, to assign values to Teamcenter properties.

At a minimum, Teamcenter 11.3 version is required to support dataset descriptor.

The Import Spreadsheet must be modified to be compatible with TcIC 11.0.4 and higher. The legacy spreadsheet must also be modified to align with the expected format. Refer to the Import Spreadsheet Default Format section for information on modifying and updating the format.

Customize Load Process

CATPart

A new value, 2, is available for the CATIA_customize_load_process preference to permit loading a CATPart under specific conditions listed below.

• A CATPart/V4/Foreign File dataset exists and a CATProduct dataset and BOMView Revision do not exist.

• A CATPart/V4/Foreign File dataset and BOMView Revision containing no occurrences exists and a CATProduct dataset does not.

• A dataset and BOMView Revision do not exist.


2-18


The cat_USER_hasChildren entry point has been updated to reflect this improvement.

Prevent CATIA from Starting from Teamcenter

The TcIC Load process fails and prevents CATIA from Starting from Teamcenter when

LaunchCATIA.bat has been configured and a DR1 license is used.

Set the new variable, TcIC_dr1_license, to true to support TcIC functionalities. This preference is false, by default.

Default Dataset Entry Point

The cat_USER_is_default_dataset entry point function is used to indicate the default dataset, i.e., which dataset to load.

This entry point has been modified to be called for each type of dataset and not for each dataset. The libcatia_custom library and code modifications must be recompiled.

Messages

Use the new preference, CATIA_display_export_end_of_command , to display an end of process message during the non-silent mode of the Export , Export as reference and Create Export SpreadSheet processes. This preference is false , by default, indicating an end of process message does not display.

Rename Drawing Datasets during Save As/Revise within Teamcenter

Use the new preference, CATIA_rename_drawing_dataset_in_post_action , to manage drawing dataset naming during Teamcenter's post-action.

When set to true (default), drawing datasets are renamed during the Save As/Revise processes within Teamcenter. When set to false , drawing datasets are not renamed.

This preference is not used during Save As/Revise processes managed within Save Manager Panel or the Import Spreadsheet and does not apply to auxiliary drawing datasets.


2-19


Known Issues



Auxiliary Files Documentation Export Import Installation Load Load, Update, Save Mappings Multi-process Project Management Save Save Manager Session Agent Translation

Auxiliary Files


Summary It is broken that PDF dataset name created by using TcIC

Documentation


Summary Installation guide Teamcenter system requirements is confusing

Export


2-20



Summary Need a Message dialog in TcIC 10x after export spreadsheet is complete

Import


Summary EBS_ItemRevName during import is not mapping into Teamcenter.

Installation


Summary TcIC Translation Solutions installation can not proceed

Load


Summary TcIC Loads Product Node Rather Than Leaf Node for V4 Parts with Empty BOM View



2-21


Summary TcIC automatically updates parts once the Top assembly is loaded into CATIA


Summary TcIC Load to CATIA revision conflict after deleting .dat files.


Summary TcIC Load as reference fails with some structures


Summary Specific Chinese characters data not loading in CATIA

Load, Update, Save


Summary LUS done on multiple parts in My Tc works for only the first part

Mappings


Summary Attributes from CATIA-Drawings are not mapped to Tc (Function IMPORT)


2-22



Summary Error with mapping Tc Double Property to CATIA


Summary CATIA Partnumber will be replaced by file name definition after 2nd save.


Summary CATIA_savemanager_map_ds_description maps FileName instead of PartNumber

Multi-process


Summary Mult-process has to be supported in TcIC 10.

Project Management


Summary 4-Tier Project Assign Issue on Create in TcIC Save Manager

Save


2-23



Summary Operation about CATPart that does not have access right


Summary In New Folder Dialog of TcIC, we can not display custom folders.


Summary TcIC Importing 2 CATDrawings with MML-Link, Only one will be imported.


Summary Save As Existing Issue with JT Rendering dataset.

Save Manager


Summary How to display a custom Form in Descriptor panel of Save Manager.


Summary TcIC - Cascading LOV Usability.


2-24



Summary TcIC : support Custom Forms.


Summary Descriptor Panel shows wrong naming tab under the ItemType RevisionTab


Summary CATIA Save management fails if multi valued LOV is selected.

Session Agent


Summary Latest TcIC Release (11.0.3.2) doesn't work with Teamcenter's Session Agent


2-25


Translation


Summary Dispatcher Load Testing for catiav5tojtdirect Translator.


2-26





This version fixes closed Problem Reports.

Known Issues



Import


Summary Supplier import func, Single DWG ViewLinks to multiple CATParts not made

Load


Summary TcIC 10.0.6.2 load of multiple Legacy Design Table load fails


Summary Strong load performance degradation after DLNames configuration in CATIA


Summary I-DEAS Hybrid assy under CAT.Product go out of position when round tripped


2-27


Save


Summary Save as is failing with unable to create the item error message

Save Manager


Summary Saveas in Save Manager requires child harness bundle to be uprevised


2-28





Teamcenter Loader Load Merge Selected Level CATIA V5-6R2017 Support

Teamcenter Loader

2D/3D Viewer

2D/3D Viewer is now available in the Structure panel of Teamcenter Loader using the Display visualization command. Use Display visualization to view the JT of the selected BOMLines and 2D or 3D files of the selected item or item revision.

Open a JT file directly from the Home directory of the Loader to display the. 2D/3D Viewer in standalone view.

Use the new preferences, CATIA_loader_2Dviewer_datasettypes and CATIA_loader_3Dviewer_datasettypes, to define the list of datasets available to the 2D viewer or the 3D viewer.

Columns

Specify the columns to display in the Structure table by modifying the CATIA_loader_bl_attr_list_of_struct_table preference. Columns are defined by BOMLine attributes. Click and drag on the columns in the Structure table to rearrange the order of the columns. This new order is saved for future views.

Column widths are controlled by the CATIA_loader_bl_attr_width_list_of_struct_table preference.

Display properties

Two views are now available for the Properties tab of the Loader and can be used to filter and display properties according to preference definitions (General) or to display all properties (All).

Use preferences to control how properties display in the General view of the Display properties function.


2-29


Impact Analysis

Use the new Impact Analysis command in the Teamcenter Loader to display parent documents, pointed documents, and pointing document information of the selected document.

Save Assembly Configuration Command

Use the TcIC_assyconfig_menu preference within the tcic_var_env.xml configuration file to display the Save assembly configuration command in the CATIA menu of Teamcenter, in the contextual menu of a selected BOM Line, in the Teamcenter Loader, and in the Load Manager.

Load Merge Selected Level

A Load Merge Selected Level can now be performed on an assembly loaded or exported as reference to separate working, reference and context data and help manage large reference structures when working in context. Product and assembly components are valid selections for this command in the context of referenced assemblies.

CATIA V5-6R2017 Support

CATIA V5-6R2017 SP1 is supported on Windows 7 64-bit platform.

Known Issues



2-30



Create ExportSpreadsheet Export General Import ImportAllAssemblies Installation and Configuration Load Load Merge Load Merge Selected Level Load, Update, Save Save Save As Save Manager State Details

Create ExportSpreadsheet


Summary CATIA: Unable to execute "Create export spreadsheet" command.

Export


Summary TcIC Export gets hanged at 50% progress stage and is not getting completed.


Summary TcIC causes tcserver crash when export in parallel.


Summary TcIC export fails error log UID not existing.


2-31


General


Summary TcIC establish parallel RACLess session on one server for export data fails.

Import


Summary Unable to import CATProduct BOMViews into Tc.


Summary QChecker Attributes from CATIA are not mapped in Tc-Attributes.


Summary This document is not referenced in the spreadsheet

ImportAllAssemblies


Summary "[ ]" used in a file name turn into "_" after importing CAD files.

Installation and Configuration


Summary Most TcIC functions cannot be started.


Summary TcIC long path definition TcIC RACLess dir leads to blocking of RACLess server.



2-32


Summary Silent client installation for TcIC 11.0.2.


Summary TcIC 11.0.2.1 Load problems with 2T SSO

Load


Summary TcIC load to CATIA wait for user interaction (dialog restricted items).


Summary TcIC Loading of wire harness takes longer time than expected.


Summary Cannot Load structure in CATIA.


Summary TcIC: Losing flexibility in CATIA upon load from Teamcenter.


Summary TcIC some structures load to CATIA hanging at managing flexibility step.


Summary Security Services & SSO - Load in CATIA from Structure Manager fails.


Summary TcIC CATIA message after Load to CATIA unable to get the document error handling.


Summary TcIC 11: Instance not created when BOMLine configured out by rev rule.



2-33


Summary TcIC fast load warning message for objects without cgr childs.


Summary TcIC load to CATIA with cgr visualized opposed CATIA configuration.

Load Merge


Summary To enable 'Load Merge' from Teamcenter to CATIA.



Summary TcIC function to Load Merge Selected Level for component structures in CATIA

Load, Update, Save


Summary TcIC LUS command with 'Load to First level of selection' truncate the assembly

Save


Summary Custom Prop values shows up as blank after saving to Tc from CATIA with 0 value


Summary TcIC warning message during save goes behind CATIA screen.


2-34


Save As


Summary MML targets requires to be revised upon revision of top node.


Summary TcIC performance issue saving CATPart with synchrofit data.


Summary TcIC - Attribute Mapping & boolean attribute in Item Revision Master Form.

Save Manager


Summary Drawing parameters mapping with TcIC save manager not happening


Summary TcIC - Attribute Mapping & Dynamic LOV Issue.


Summary TcIC - issue with Cascading LOV's selection.


Summary Revising item in CATIA Save Manager ( TcIC 9.0.5 )


Summary TcIC SaveManager issue with object name - Exhaustive LOV.


Summary TcIC Save Manager crash with assemblies.



2-35


Summary TcIC Issue with Interdependent LOV's (Complex).


Summary TcIC issue with Dynamic LOV defined as Tag type.


Summary TcIC - Cascading LOV Usability: session frozen due to a huge/deep Cascading LOV.


Summary Save Manager doesn't consider the default values set for Attributes.

State Details


Summary SaveManager is blocked until the Detail States is closed


Summary TcIC release status in detailed state displayed with =@= instead of ,


2-36





Automatic Load Merge Warning Messages During Load

Automatic Load Merge

Use the new preference, CATIA_automatic_load_merge, to control whether the Load Merge process runs automatically, without having to start merge from the CATIA toolbar. Possible values are Yes (default), No and Question.

By default, (Yes), the Load Merge process runs automatically when the top level is already opened. An error message displays when the Load Merge cannot be performed.

Warning Messages During Load

Use CATIA_display_warnings_at_end_of_process to control when warning messages relating to load processes display; either during (empty, default) or at the end of the load process to avoid user interaction (SECRET).

Known Issues



2-37



Contextual Menu Installation Load Load Merge Mappings Refresh State Details

Contextual Menu


Summary Problem with CATIA contextual menu (RMB) on drawings menu.

Installation


Summary TcIC long path definition TcIC racless dir leads to blocking of Racless Server.

Load


Summary TcIC Load to CATIA wait for user interaction (dialog restricted items).


Summary Cannot Load structure in CATIA.


Summary TcIC some structures load to CATIA hanging at managing flexibility step.

Load Merge


2-38



Summary ER to enable 'Load Merge' from Teamcenter to CATIA.

Mappings


Summary Attribute Mapping & boolean attribute in Item Revision Master Form.

Refresh


Summary Tc BOM updates not Refreshed to TcIC CATIA V5.

State Details


Summary TcIC release status in detailed state displayed with =@= instead of ,


2-39





BOM Window Refresh Preference Check-in/Check-out Panel Embedded Active Workspace Integration Toolbar JT Translations Load as reference: Assembly Configuration Dataset Managing Non-CAD Occurrences Teamcenter Loader Updating Reference Properties

BOM Window Refresh Preference

Use the new CATIA_refresh_bom_window_on_save preference to determine when the BOM window should be refreshed at the end of a Save process and improve performance. The default value of this preference is OF_TOP_LEVEL; the BOM window corresponding to the save assembly is refreshed.

Check-in/Check-out Panel

Use the new CATIA_cico_ask_confirmation_action_from_ui preference to display the Check-in / Check-out panel containing the OK button and require user interaction to start the action (true). Set it to false to prevent the display of Check-in / Check-out panel and start the action without user interaction. The Check-in/Check-out panel always displays even when this preference is set to false if errors occur.

This option is available for the Save Manager Toolbar, Browse Multi-Model Links and the Status Window.


2-40


Embedded Active Workspace

The Refresh command is now available in the Active Workspace toolbar. Use Refresh to refresh the current page loaded in Teamcenter Embedded Active Workspace if it is not displayed.

The Show in Teamcenter command is now available in the Active Workspace toolbar. Use Show in Teamcenter to load an item revision of the item selected in Teamcenter Embedded Active Workspace into Teamcenter Loader or in the RAC. This command is visible in the toolbar when Teamcenter Loader client and RAC client have been defined in the client_env file.

Integration Toolbar

The Open TcIC Loader command is now available in the utility toolbar when the Loader client has been installed.

JT Translations

Translation Services can now be launched from a workflow process or using Translation >> Translate menu in Teamcenter.

First, select a dataset with defined preferences then pick Translation >>Translate. The translator(s) defined for the dataset display. Select a cell containing a translator service to display translator values.

A list displays when more than one translator has been defined.

The Integration submits the item revisions that are supported by the designated services.

Input parameters, such as item revision, are now supported in TcIC Translation services, in addition to dataset source.

Load as reference: Assembly Configuration Dataset

Assembly Configuration files record the full structure in a description file at the root assembly level so that large structures can be computed overnight and loaded for reference during the day. This capability is designed for Fast DMU only.

When the configuration file is stored in an Assembly Configuration dataset, the Load as reference process uses this file and creates data directly in CATIA instead of analyzing the selection and exporting data from the database. This improves performance.

The new Save assembly configuration command and panel saves the assembly configuration file in the assembly configuration dataset. This command is available in the CATIA menu in Teamcenter, in the contextual menu of a selected BOM Line in Teamcenter Loader and in the Load Manager.


2-41


Use Entry Points to configure the Save assembly configuration process to run silently or non-silently, configure the names of the dataset ID, dataset revision and assembly configuration dataset and configure the assembly configuration .xml filename.

Use preferences to define the assembly configuration dataset, the type of link to be used to manage the assembly configuration file and to display the Assembly Configuration Data panel.

The new Activate Terminal Nodes command is available from the CATIA toolbar and the contextual menu. It enables cache files in CATIA, on an assembly loaded as reference with an assembly configuration, to be exported. The Replace Load as cgr command can then be used load the geometry in CATIA.

The Teamcenter Integration 11.0.2 Template must be deployed to manage this new capability.

Managing Non-CAD Occurrences

A non-CAD occurrence is a product occurrence (BOM line) not delivered to the CAD system based on pre-defined criteria.

Two new preferences, CATIA_manage_noncad_occurrence and CATIA_manage_noncad_xxx_occattr have been created to define a non-CAD occurrence. By default, these preferences are empty indicating non-CAD occurrences are not managed. Change the value of these preferences to manage non-CAD occurrences.

CATIA_manage_noncad_occurrence contains the list of real name BOM line attributes to define a non-CAD occurrence.

CATIA_manage_noncad_xxx_occattr contains the list of display values of the attribute name defined in CATIA_manage_noncad_occurrence. (xxx corresponds to the attribute name defined in CATIA_manage_noncad_occurrence).

Occurrences are still managed by the cat_USER_isOccurrenceNonCAD entry point.

Teamcenter Loader

Use the Remove all and Remove selection buttons in the Teamcenter Loader search results to remove one or all items from the search results list.

The Start Teamcenter command is available from the Loader toolbar to launch RAC Client or Embedded Active Workspace.

Thumbnails can be displayed in Teamcenter Loader.

Improved search capability has been added to the Display Structure to search BOM lines according to attribute criteria.


2-42


The Open TcIC Loader command is now available in the utility toolbar when the Loader client has been installed.

Updating Reference Properties

Updating reference properties improves load performance by preventing properties of released or non-modifiable documents from being updated.

Previously, each time an attribute mapping changed either on already released documents or non-modifiable documents, the document's status during load was changed to modified. Use the new CATIA_deactivate_update_reference_properties preference to prevent this. This preference can also be used to ensure migrated data is not modified during the load process and improve performance during load processes and, indirectly, during save processes.

Possible values are NONE, READ ONLY, STATUS and STATUSxxx. The default value is empty, indicating reference properties are updated for all documents and shape representations.

Known Issues



2-43



Assign ID Browse MML Check In/Check Out Customization Documentation General Highlight Icons in Rich Client Import Installation JT translation Load Login Progress Monitor Purge Read Linked Documents Revision Conflict Save Save Manager Scenes UI

Assign ID


Summary Assign item ID does not work as expected in TcIC Save panel.

Browse MML


Summary Allow MML Browsing of selected part in assembly context.


2-44


Check In/Check Out


Summary TcIC close the checkout dialog if not error during check out appears


Summary TcIC Check In/Check Out from Tc is pushing the completion window behind Tc window

Customization


Summary TcIC configuration possibility custom plug-in directory


Summary Custom code is no longer giving the expected result after import.


Summary EBS TcIC prevents application from closing.

Documentation


Summary OTW install is not working for users other than install.


Summary CATIA_queries_for_item_rev_browser doesn't work (they are not shown)


Summary Inquiry : About preference "CATIA_V4_as_foreign_file"


2-45


General


Summary TcIC if reading of plug-ins fails no error message displayed.

Highlight


Summary TcIC highlighting between CATIA and Teamcenter is not working with TcIC (11.0.1).


Summary TcIC Highlight in CATIA V5 TcIC Command fails


Summary TcIC Highlight from Teamcenter to CATIA don't find loaded objects.

Icons in Rich Client


Summary Different icons (and tooltip) issue reported in 10.0.4

Import


Summary Only 1 Item with 2 Revisions are getting created for Spreadsheet with 2 rows.


2-46


Installation


Summary WORK_DIR creation is missing in TCIC 10x


Summary TcIC 9.0.6 - 32bit - R24 is not available.

JT Translation


Summary Save Manager should create separate ETS request for each part in the CATProduct


Summary catiav5tojtdirect fails when translator installed PATH has space in it.

Load


Summary TcIC reduce client server communication for the refresh of the CATIA load option


Summary Avoid mapping during Load.


Summary TcIC function use server calculated structures for a fast load to CATIA.


Summary TcIC load new initiated from CATIA in two CATIA sessions


2-47



Summary TcIC should show an user readable error message if a file was not found (FMS).


Summary Loading drawing gets attached warning message on read linked documents


Summary When does TcIC check a Drawing is out of date, before or after the icon overlay?


Summary TcIC "des" file sensitivity causes dataset load issue


Summary TcIC loading to CATIA as cgr broke some contraints


Summary Warning by loading a CATdrawing CATIA_MAP_Property_Nomenclature is missed.


Summary TcIC load same CATPart twice from Teamcenter to CATIA modifications not shown.

Login


Summary TcIC login with SSO fails while passing SsoCredentials


2-48


Progress Monitor


Summary Design Table save pop up gets hidden behind progress bar while doing Tc IC save.

Purge


Summary Increase speed of Purge function in CATIA TcIC menu.

Read Linked Documents


Summary Read Linked Documents issue from CATDrawing

Revision Conflict


Summary TcIC dialog for revision conflict missing Cancel option and OK instead continue.

Save


Summary SaveAs New Attribute Mapping.


Summary Smart refresh of Structure Manager in Teamcenter after TcIC Save


2-49



Summary New install: cannot Save from Tc to CATIA


Summary Warning when saving an assembly from CATIA to Tc9.1


Summary TcIC Saving new part from CATIA to Tc collapses the structure in SM - PR 1976301


Summary Error saving a file with CATIA/Tc integration.


Summary Save as of write protected data into existing item fails.


Summary Save of some drawings creates multiple attribute mapping parameters.


Summary In TCIC Save Manager, revision property is mandatory (would like optional)


Summary TcIC changes item type during Revise action in Save Manager assign RevID fails

Save Manager


Summary Save Manager of TcIC does not open.


2-50


Scenes


Summary Bug with Assembly Scenes when saving linked drawing include linked docs

UI


Summary Not able to show full list with MMA data.


2-51





Active Workspace Support BOM Window Refresh Preference CATIA V5-6R2016 Create CATPart/CATProduct Datasets InstallAnywhere Last Modification Date Comparison Manage Latest Revisions Over the Web (OTW) Installation Show in Teamcenter Teamcenter Loader Web Server Port

Active Workspace Support

Siemens PLM Software's Active Workspace is now integrated with Dassault Systemes' CATIA V5 software. Embedded Active Workspace and Standalone Active Workspace, briefly described below, are now available within Teamcenter Integration for CATIA V5 and can be configured.

Access to Teamcenter from inside CATIA can be accomplished by using a tightly Embedded Active Workspace client (available inside CATIA), providing a broad range of PLM capabilities seamlessly inside the CAD session. Users interact with the PLM environment while remaining inside CATIA. The Embedded Active Workspace menu is now available within the Teamcenter Contextual Menu in CATIA V5.

Access to Teamcenter from outside CATIA can also be accomplished by using a Standalone Active Workspace client installation to display the Active Workspace client application in the default web browser application. This provides a lower level of PLM capabilities than using Embedded Active Workspace client.

When CATIA is the main tool, it is recommended to use Embedded Active workspace (or Hosted mode) to enable Load processes directly within the CAD software.


2-52


Use the new preferences to control the Embedded Active Workspace menu, Load Manager display, Load Options, and the availability of the Open in CATIA command within the Active Workspace.

BOM Window Refresh Preference

The CATIA_refresh_bom_window_on_load preference is depreciated in 11.0.1 and replaced with CATIA_refresh_bom_window_on_load_2. The default value of the new preference is No; the BOM window is not automatically refreshed.

CATIA V5-6R2016

Teamcenter Integration for CATIA V5 (11.0.1) supports CATIA V5-6R2016, SP1, on Windows 7 64-bit platforms and SP2 on Windows 10.

CATPart/CATProduct Datasets

The Create CATPart dataset for selection and Create CATProduct dataset for selection commands can now be run within Teamcenter Integration for CATIA V5 directly under a command line and executed without a RAC connection.

InstallAnywhere

Different types of clients can now be installed using Teamcenter Integration for CATIA V5 InstallAnywhere installation:

• RAC client installation (default)

• Teamcenter Embedded Active Workspace installation

• Teamcenter Integration for CATIA Loader installation

• Teamcenter Standalone Active Workspace installation

FMS HOME must be defined during the installation when a TCCS_SA Installation exists and when installing Teamcenter Integration for CATIA Loader, Embedded Active Workspace or Standalone Active Workspace installations.

Last Modification Date

Use CATIA_cache_validate_dataset_for_load to ensure that cache files having a last modification date older than the part file are exported and to improve TcIC Load performance. This preference is read by the cat_USER_validateCacheDatasetForLoad entry point.


2-53


Set this preference to true to compare the last modified date of named reference of the CATPart with the last modified date of the named reference of the CGR. This preference is false, by default, indicating dates are not compared.

Manage Latest Revisions

Use the new preferences, CATIA_ifs_qry_revision_rule_for_item and CATIA_latest_revision_set_type, to filter elements returned by Import Query during spreadsheet creation and to determine the latest revision type to return.

The default value of CATIA_ifs_qry_revision_rule_for_item is NONE, indicating no Filter is applied and all revisions are returned by the import query in the spreadsheet file.

The default value of CATIA_latest_revision_set_type is creation_date, indicating that the creation date is the latest type to apply on the revision rule.

The new entry point, cat_USER_getLatestRevision specifies the latest revision type to return.

The cat_USER_getLatestRevision entry point and CATIA_latest_revision_set_type preference are also taken into account in Replace by revision and Save processes.

Over the Web (OTW) Installation

Different types of clients can now be installed using Teamcenter Integration for CATIA V5 Over the Web (OTW) installation:





Show in Teamcenter

The Show in Teamcenter command opens the selected item revision in the RAC or in Active Workspace depending on the value of CATIA_show_in_teamcenter_option preference.

Show in Teamcenter is now available from the Integration toolbar or the Contextual Menu to load CATIA component(s) into an Embedded Active Workspace or a Standalone Active Workspace window.


2-54


Teamcenter Loader

The type of client to install (RAC Client or TcIC Loader) can now be selected during the Teamcenter Integration for CATIA Installer process. Use Teamcenter Loader to run TcIC in full RACLess mode, i.e., without a RAC connection.

Web Server Port

Use the TcIC_web_server_port variable within the tcic_var_env.xml file to change the port used for the web server of Active Workspace, if necessary.

Known Issues

Display Issues With Online Documentation Installer on Linux Red Hat Teamcenter Login Window Does Not Display

Display Issues With Online Documentation


Installer on Linux Red Hat

Related to PR 7510315: Installer is not launching on Linux Red Hat

The following error displays when launching the Integration installer on Linux Red Hat 6.4.

$ ./Teamcenter_Integration_for_CATIAV5_9.0.7_Tc10.1_LINUX_1.bin Preparing to install... Extracting the JRE from the installer archive... Unpacking the JRE... Extracting the installation resources from the installer archive... Configuring the installer for this system's environment... Launching installer... Graphical installers are not supported by the VM. The console mode will be used instead... Invocation of this Java Application has caused an InvocationTargetException. This application will now exit. (LAX)


2-55


Solution: Use the following command to workaround this issue:

$./Teamcenter_Integration_for_CATIAV5_9.0.4_Tc9.1_LINUX.bin LAX_VM /usr/bin/java

Teamcenter Login Window Does Not Display

PR 7514781 - Teamcenter login window is not displaying when we launch Teamcenter from CATIA.

Steps to Reproduce

1. Launch a CATIA session using Teamcenter Integration for CATIA V5.

2. In CATIA, select the Start Teamcenter button from the TcIC toolbar, then log in to Teamcenter.

3. Log out from Teamcenter and close the TAO window immediately after logging out.

4. In CATIA, select the Start Teamcenter button from the TcIC toolbar.

Result: The TAO window is open but the Teamcenter login window does not display.

Workaround

Edit %TCICV5_DIR%\bin\WIN32\send2portal.bat by removing the parameter -attach -perspective com.teamcenter.rac.ui.perspectives.navigatorPerspective from the %TC_PORTAL_DIR%\portal.bat command line.

The Teamcenter RAC will open, by default, with the latest perspective used in the previous session.


2-56



Customization Documentation Export Highlight in Teamcenter Import Installation JT Conversion Load Load, Update, Save Messages Performances Progress monitor Purge Read Linked Documents Revise Save Save Manager Secondary Parts Spreadsheet TcIC Loader VPN

Customization


Summary TcIC (11.0.0) Custom SaveModule getting NULL Pointer Exception.

Documentation


Summary Integration toolbar CAA Framework build fails with TcIC (10.0.3).



2-57


Summary Teamcenter login window is not displaying when we launch Teamcenter from CATIA.

Export


Summary TcIC duplicated objects in the wrong position in CATIA after Export as reference.


Summary TcIC export with drawings takes too long compared with export without drawings.

Highlight in Teamcenter


Summary TcIC configuration of perspective and view for select and highlight function.


Summary TcIC configuration of highlighting process from CATIA to Teamcenter.

Import


Summary The import mode with TcIC cannot be changed during runtime.


Summary Spreadsheet Import - subsequent import results in error: Invalid trailer....


Summary TcIC import hangs during import of multiple drawings.


2-58



Summary TcIC: Can not import, message: You do not have write access to this directory.


Summary TcIC user request during import of drawings even though silent mode is set.


Summary Create Spreadsheet causes Tc to crash - even though spreadsheet seems ok.

Installation


Summary TcIC configuration possibility custom plug-in directory independent from RAC installation.


Summary Unable to install TcIC V5 (10.0.0) Translations Solutions on SUSE Linux.


Summary TcIC installation with new combined 2-tier/4-tier client is not working.

JT Conversion


Summary JT Named Reference missing even if catia5tojtdirect translation was successful.

Load


2-59



Summary Cancel option in TcIC (10.0.2) is not functioning properly.


Summary Structure Manager is not responding while loading the DC assembly into CATIA..


Summary TcIC Load fails with Invalid Selection Error message.


Summary TcIC remove not required call of function BOM_window_hide_unconfigured.


Summary TcIC wrong behavior dialog for loading a modified structure from Teamcenter to CATIA.


Summary Problem while loading assemblies.


Summary Teamcenter server crash with special use case.


Summary TcIC initializing of communication environment is failing and leads to RAC crash.


Summary TcIC (9.0.8.1) will crash sometimes trying to load replicas.

Load, Update, Save



2-60


Summary Load, Update, Save wrongly updates when duplicate is removed..

Messages


Summary Need TcIC to return complete extended error messages from Teamcenter.

Performance


Summary Performance linked to the CATIA environment initialization.

Progress monitor


Summary TcIC cancel the load process from Teamcenter to CATIA takes long time.

Purge


Summary Purge command in CATIA moves wrong files in backup folder.


Summary Purge deletes new files in CATIA session.




2-61


Summary After [Send to] in CATIA, cannot find the location of the Import folder.

Revise


Summary After Tc revision up always CGR dataset version is 2 when CopyAsObject.

Save


Summary Unable to save within TcIC.


Summary Elec. harness data from CATIA to Tc takes hours for Save Manager to appear.


Summary The multi-row attribute issue in the CATIA V5 Tc9 Integration.


Summary TcIC hide Save Manager creates crash for next save with displayed Save Manager.


Summary Proof of concept, OK to Terminate, on drawing save.


Summary Error saving as a CATDrawing.


Summary TcIC creates fcc crash during save CATIA >> Tc with data from backup directory.


2-62



Summary TcIC - cannot save part owned by different group even if have write privileges.


Summary TcIC during save high memory allocation with server crash as result.


Summary Second save fails on modified .CATPart.


Summary TcIC 11 Save Manager does not create BVR for existing Item/CATProduct.


Summary Long CATIA file names are saved, but limited to 81 char from the system.


Summary TcIC 9 and 125% font.


Summary Use Existing Dataset: Using TcIC (9.0.6) not automatically grabbing latest always.

Save Manager


Summary TcIC conflict between display rules in BMIDE and TcIC preferences for _item_type.

Secondary Parts



2-63


Summary TcIC incorrectly renaming CATSecondaryPart Named Reference.

Spreadsheet


Summary TcIC create all spreadsheets hangs with specific set of data.


Summary TcIC spreadsheet editor crashing and crashing the Teamcenter session during import.

TcIC Loader


Summary TcIC as standalone application - variants in a structure.


Summary TcIC as standalone application - search functionality

VPN


Summary Unable to save from CATIA to Teamcenter when connected to VPN.


2-64





About integration Array Type Attributes Attribute Mappings CATIA V5 Menu within CBA Check-in Status of a CATDrawing during Import Creating and Customizing a Contextual Menu or Toolbar Depreciation of RAC Silent Processes Dispatcher Services Documentation Filters on the Save Manager Panel Installation Load as reference Manage BOM Window Configurations During Load Manage BOM Lines During Load Manage File Name Conflicts During Load Manage Publications During Save MMLAssy Links MML Browser RACLess Command Line Entry Points RACLess Mode Through Server Support Save As Save Entry Point Save Manager and Import Default Folders Save Manager Panel Socket Port Spreadsheet Editor Title Area StartRACLessServer.bat Changes Start Teamcenter Status Window Title Area


2-65


Supported Operating Systems and Requirements TC_ROOT Variable tcic_selection.xml File Teamcenter Menu in CATIA/TcIC Utility Toolbar Workflow and Projects

About integration

The About integration menu within CATIA V5 and Teamcenter has been improved.

From Teamcenter:

RACLess information related to version number of the SOA client and checksum are available within the About integration panel in Teamcenter (CATIA V5 >> Help >> About integration).

From CATIA:

Detailed information related to the specific Integration version is available within the About integration panel in CATIA. (Teamcenter >> About integration).

Array Type Attributes

Array Type attributes now display and can be edited in the Save Manager, Descriptor panel (for the Create Descriptor and the Save As Descriptor), the Spreadsheet Editor and the Item Revision Browser (search panel).

Supported array types:

• The array attributes not attached to an LOV, whatever the attribute type (string, date, etc.).

• The array attributes attached to a simple or filter LOV, whatever the attribute type (string, date, etc.).

Attribute Mappings

Save Manager

In addition to resolving Save Manager Attribute Mappings on newly created components in CATIA, they can now also be resolved during Save As or Create New components under some conditions when the Clear/Erase button is applied or when the item type is changed in the Save Manager panel.

Import Spreadsheet

Use the new preference, CATIA_apply_savemanager_map_in_import_spreadsheet, to apply or not apply attribute mappings in the Import Spreadsheet. By default, attribute mappings are not


2-66


applied. Set this preference to true to apply attribute mappings in the Import Spreadsheet when the import query does not find a corresponding item in the database.

CATIA V5 Menu within CBA

The CATIA V5 menu is now available within CBA (CAD BOM Alignment).

Check-in Status of a CATDrawing during Import

Set the new preference, CATIA_import_files_in_ci_dataset to true to permit Named References of CATDrawings to be imported under a checked-in CATDrawing dataset.

CATIA_import_files_in_ci_dataset = true

The default value is false; Named References of CATDrawings are not imported under a checked-in CATDrawing dataset.

Creating and Customizing a Contextual Menu or Toolbar

This version supports creating and customizing a new contextual menu or toolbar.

Depreciation of RAC Silent Processes

All RAC Silent processes are depreciated in Teamcenter Integration for CATIA V5 (11.0.0).

Dispatcher Services

Set the DISPATCHER_rqst_on_specific_dataset_revision preference to use a specific revision (true) or the latest revision (false, default) of a dataset during Dispatcher Services.

DISPATCHER_rqst_on_specific_dataset_revision = false

The default value is false, the latest revision is always used.

Documentation

Use the Teamcenter menu in CATIA to launch the online documentation in a browser window. The Documentation button on the Integration's utility toolbar has been removed.


2-67


Filters on the Save Manager Panel

A new filter, Hide existing documents without dataset, can be automatically applied to the Save Manager using the CATIA_savemanager_apply_existing_documents_without_dataset_filter preference. This filter is helpful to hide existing documents from view when a dataset is not associated to the item revision of the document in the Save Manager panel.

By default, this filter does not display and is not available. Change the preference to true to activate this filter.

This feature is also dependent on the value of CATIA_save_existing_item_without_dataset.

When this preference is true and CATIA_save_existing_item_without_dataset is false, the Hide existing documents without dataset filter is automatically applied to the Save Manager when there is no dataset associated to the item revision of the document. View this filter by selecting the Error or Warning button on the Save Manager panel.

This filter does not display when the CATIA_savemanager_apply_existing_documents_without_dataset_filter is false and CATIA_save_existing_item_without_dataset is true or when a dataset cannot be created under an existing item in the current environment.

Installation

InstallAnywhere

Import Queries are now imported directly during template installation rather than manually imported using InstallAnywhere.

OTW

Teamcenter Integration for CATIA V5 Over the Web (OTW) installation has been extended to support dependency with a 4-Tier Portal installation or only a Teamcenter communication system.

Select either the RAC client installation or Teamcenter Integration for CATIA Loader installation option from the installer. When Teamcenter Integration for CATIA Loader installation is selected, FMS of the Teamcenter Client Communication System is used.

Load as reference

Use the Load as reference command to load structures in an interactive CATIA session. All products, except the top level and contextual products of flexibility, convert into components and parts can be exported only as a part or as .cgr files. Use the Load as reference command to load a reference assembly to be used as a context in a working assembly. This separates working data, reference data and context data and helps to manage large reference structures when working in context.


2-68


Pick Load as reference within the CATIA V5 menu from My Teamcenter, the PSE, Design Context or Classification to launch the Load as reference command. Load as reference is also available using a command line .

Use CATIA_reference_prefix to define the prefix used for file names for reference documents.

Use CATIA_reference_prefix_partnumber preference to define the prefix for part numbers for reference documents.

Use CATIA_compare_uid_reference_top_level_on_merge to define when the Load Merge operation should be performed on the selected document or under the reference product.

Use the cat_USER_buildReferencePrefixSuffix user entry point function to create additional prefix and a suffix values for file names and the cat_USER_buildReferencePrefixSuffixPartNumber user entry point function to create additional prefix and a suffix values for the part numbers.

Manage BOM Window Configurations During Load

During the Load Merge Target, Load Merge Selected Level, Refresh and Read Linked Documents processes, CATIA_manage_configurations_on_load_from_CATIA determines whether to use the configuration used to load the assembly or the configuration of the Opened BOM window.

Manage BOM Lines During Load

The Load Selected Level option within the CATIA V5 menu is now obsolete and has been replaced with three different options to manage the level loaded for a selected BOM line:

• Load through selection

• Load to first level of the selection

• Load to selection.

Use the new preference, CATIA_load_bom_traversal_option, to set the load level when loading a selected BOM line. By default, the value is THROUGH, indicating the complete selected sub-assembly, including the selected product and all children are loaded. All children components of all sub-assemblies are loaded recursively. Change this preference to FIRST_LEVEL or TO to load other levels.


2-69


Availability

Function Availability

Load, inside the Structure Manager

Available for Load, Load for compare, Export, Load Update Save, Load for Consulting, Load as reference, Export as reference.

Load, launched from CATIA

Not available. Includes Load Merge Target, Load Merge Selected Level, Refresh or Read Linked Documents commands.

Silent Export processes Available

Manage File Name Conflicts During Load

Use the new preference, CATIA_stop_load_if_filename_conflict, to manage file name conflicts during the Load process. By default, the load process stops when a file name conflict occurs. Change this preference to false to permit the load process to continue as a partial load when a file name conflict occurs. In this case, documents with file name conflicts will be excluded from the load process.

Managing Publications During Save

Use the new preference, CATIA_manage_publications_on_save, to manage publications during the Save process (Save or Import).

By default, publications are read in CATIA and created or updated in Teamcenter (true). Set this preference to false so that publications are not created or updated and publication links are not managed in Teamcenter. Setting this preference to false also improves save performance.

MMLAssy Links

Links between two parts of the same assembly, as a result of a Copy/Paste Special with AsResultWithLink format, are saved by default during the Save process during the Save process, with the new preference, CATIA_search_mmlassy_links_on_save.

The default value of this preference is true, indicating MMLAssy Links are managed. Set this preference to false to not manage MMLAssy links in Teamcenter and in this case, links will not be exposed in Teamcenter. A false value improves save performance.


2-70


MML Browser

The Multi-Model Links Browser application is now available through a command line within DoBMMLAction.

RACLess Command Line Entry Points

This version of the Integration provides the ability to run some of the RACLess processes (such as Highlight in CATIA, Check In, Load from Teamcenter, Login to the RACLess Application …) used within the Teamcenter Integration for CATIA V5 directly under a command line.

RACLess Mode Through Server Support

Teamcenter Integration for CATIA V5 commands can be run without launching a connection through Teamcenter Rich Application Client (RAC). Running these commands without a RAC connection is called a RACLess mode.

The purpose of the RACLess mode is to be fully independent from the RAC application so that external applications can connect to TcIC commands using their own client application, such as Teamcenter Active Workspace or a customized client application, instead of using the Teamcenter Portal as the default client application.

Refer to the list of supported functions.

Client applications which can be connected to the Integration are defined in the client_env file. By default, fields are set during the Integration installation.

This version of the Integration supports a single host stand-alone TCCS installation defined in the client_env file (TCCS_SA option). Both TCCS and FCC file transfer systems are supported. There is no Client installed.

An external client can also connect to the RACLess mode through a command line.

TcIC can be run using a Teamcenter RAC client or in RACLess mode.

Save As

Using the BMIDE, data model objects can be created to represent objects in Teamcenter properties, configured for the SaveAsInput operation on the Operation Descriptor.

The Save As Copy process, accessible when a Save As is performed on an existing item in the Save Manager, has been improved to support Teamcenter Save As Descriptor.


2-71


The CopyFromOriginal flag, indicating if value is to be copied from the original object for a SaveAs (when set to true), is now supported.

Use the new preference, CATIA_savemanager_display_item_attr_on_saveas, to hide/display the Item.object_name and Item.object_desc properties in the Save Manager and to manage duplicate fields, i.e., object name and object revision name.

Revising an item in the Save Manager has been improved to support the Teamcenter Revise Descriptor.

Save Entry Point

A new Save entry point, cat_USER_validateForSaveNewRevision, can be used to validate the Save New Revision process. This entry point function is called during the Save New Revision and Import New Revision processes.

Save Manager and Import Default Folders

In Teamcenter Integration for CATIA V5 (11.0.0) the value of the CATIA_savemanager_default_folder and CATIA_default_folder_for_import preferences can now be a folder UID. This is in addition to the previous values of a directory name or NONE. The default value is newstuff.

In defining the preference or selecting a folder in the Save Manager or Spreadsheet editor, the default folder can also be changed from newstuff to the selected folder.

Save Manager Panel

A Browse panel displays when Browse is selected from the destination folder pull-down list on the Save Manager Panel. Use Browse to create a new folder in Teamcenter to save the items to.

A Check-In and Check-Out panel displays during Check-In and Check-Out processes listing the affected elements.

The project name can now be displayed in the title area of the Save Manager panel by modifying the CATIA_ui_title_format preference.

Socket Port

Use the TcIC_socket_port variable within the tcic_var_env.xml file to change the port used for the progress indicator, if necessary. This variable is also used used for interface communication. The default value is 11400 (unchanged).

The previous variable used for the progress indicator, TcIC_progress_socket_port, is no longer available.

The default value of TcIC_rac_socket_port has been changed from 11402 to 11401. This variable is used for communication between RAC and RACLess.


2-72


Spreadsheet Editor Title Area

The project name can now be displayed in the title area of the Spreadsheet Editor panel by modifying the CATIA_ui_title_format preference.

StartRACLessServer.bat Changes

The Teamcenter projects, defined to provide a mechanism for organizing data and implementing access control based on project membership, can also be set during the RACLess connection and used to configure log in.

The client name defined in the client_env file is also set during the RACLess connection and used to configure log in. A cache file is created after the connection is made and stores the log in information and contains User/Group/Role/Host/TCCS parameters.

The StartRACLessServer.bat file parameters are defined within the %TCICV5_DIR%\racless directory have been changed to introduce support Teamcenter Projects ( -proj) and Teamcenter Client name (-client).

Start Teamcenter

Use the Teamcenter menu in CATIA to Start Teamcenter from CATIA. The Start Teamcenter button on the Integration's utility toolbar has been removed.

Status Window Title Area

The project name can now be displayed in the title area of the Status Window panel by modifying the CATIA_ui_title_format preference.

Supported Operating Systems and Requirements

Teamcenter Integration for CATIA V5 (11.0.0) supports Teamcenter 10.1.5 and 11.2.1 (minimum) and CATIA V5-6R2015, SP1, on Windows 7 64-bit platforms.

TC_ROOT Variable

The Teamcenter server directory, TC_ROOT, environment variable is now obsolete.

tcic_selection.xml File

The tcic_selection.xml file has been improved to support configuration on selected BOM Windows.


2-73


Teamcenter Menu in CATIA/TcIC Utility Toolbar

The User Settings, Start Teamcenter and Documentation commands are now available within the Teamcenter pull-down menu, in CATIA V5, for all CATIA workbenches. These commands are no longer available within the TcIC utility toolbar, and can be customized.

User Settings

User Settings connects to the RACLess Application when the connection has not been previously established. Use this command to change the Group, Role and Project of the current RACLess Application. This command is RACLess only and is not available when the Teamcenter RAC Client is running.

The User Settings command is also available through a command line within DoUserSettingsAction .

Workflow and Projects

Projects, in Teamcenter, organize data and are the basis for granting data access to project team members. A workflow is the automation of business procedures in which documents, information, or tasks are passed from one participant to another in a way that is governed by rules or procedures.

Teamcenter Workflows manage product data processes. Any type of workflow can be created to accommodate specific business procedures.

During the Save to Teamcenter process, an item or item revision can be assigned to or removed from a Project, and a Workflow can be applied to an item, item revision, dataset or a BOM View Revision.

Use the CATIA_savemanager_actions_list , CATIA_savemanager_multisel_actions_list and CATIA_savemanager_itemtab_actions_list preferences to display project and workflow in Save Manager panel. These preferences have been updated to include new default values (main_body_geo, project, workflow).

The list of workflows to display can be customized using the CATIA_savemanager_process_template_filter and CATIA_savemanager_process_template_under_construction preferences.


2-74


Known Issues

Preference Definitions/Actions Section of the Save Manager Display Issues With Online Documentation

Preference Definitions/Actions Section of the Save Manager

Incomplete values in the default template set of the CATIA_savemanager_multisel_sections and CATIA_savemanager_itemtab_sections preferences prevent access to the Actions section in the right panel of the Save Manager. This causes the Assign to Project and Assign to Workflow actions to be unavailable during multi-selections in the Save Manager.

To enable these actions, add the actions value (as shown in red) to the preference values:

CATIA_savemanager_multisel_sections = itemrev dataset relation actions

CATIA_savemanager_itemtab_sections = itemrev relation actions

Display Issues With Online Documentation



2-75



About integration CATIA start up Customization Dataset Browser Documentation Entry Point Export Export as reference Final Save Panel Import Installation JT Translation License Management Load Load as cgr Load as reference Load, Update, Save Localization Login LOV Mapping Mass Properties Material MML Browser Project Assignment Revise Descriptor Save Save As Save Manager State Details Update Title Block Workflow


2-76


About integration


Summary No possibility to know the installed version.

CATIA Start up


Summary TcIC 9: Need way to block auto CATIA start.

Customization


Summary NTool can't be used to create parts after having saved one time to Tc.


Summary Sample customization only works first time..


Summary Entry point for filename is not called on export spreadsheet creation.

Dataset Browser


Summary Dataset Browser is no longer displayed.

Documentation



2-77


Summary Checkout of CATIA data not happening prior to load process while performing LUS.


Summary How to set to overwrite the TIF file to prevent an increase in TIF?


Summary TcIC 9.0.7 - Configure properties in the Save Manager.


Summary CATIA_apply_post_action_during_catia_revise description is wrong in User Guide.


Summary Wrong mapping example in Modifying CATIA Properties.


Summary Documentation error add column savemanager.xml.


Summary Documentation error add column statedetails.xml.

Entry Point


Summary Provide an entry point allowing to customize when it creates NewRev from CATIA.

Export


Summary Can not export a CATDrawing by Export drawing when saved in a separate item ID.


2-78



Summary CGR file not exported after Replace in TcIC 8.3.7.10

Export as reference


Summary Export as reference not applying the prefix correctly.


Summary Export as reference can be used in the standard TcIC as Load as Reference.


Summary Change Export as Reference to Load as Reference

Final Save Panel


Summary Updated Files list dialog pops up in front of Teamcenter

Import


Summary CATIA spreadsheet component missing from Excel.


Summary Line Feed character in Description causes server crash TcIC Import


Summary TcIC Spreadsheet not working with new format


2-79



Summary TcIC second supplier import containing re-used components indicates modification


Summary Blocking error during multiple import of linked elements (CCP + VIEW link)


Summary TcIC supplier import Customer specific empty spreadsheet


Summary TcIC supplier import creating zero byte spreadsheet for Europe


Summary Error while importing CATIA product using TcIC Import Spreadsheet.


Summary TcIC import error using import spreadsheet.


Summary Data is not being updated correctly during import to Tc 9.1.2.10.


Summary Silent Import creates new revision instead of using an existing.


Summary Import Spreadsheet causes BOM Lines to be removed.


Summary TcIC Create Spreadsheet error


Summary Unexpected TcIC Import error


2-80


Installation


Summary Defining socket ports in the tcic_var_env.xml does not work


Summary Incorrect path for CAA binaries in setcatenv.bat generated via OTW

JT Translation


Summary DISPATCH_rqst_on_specific_dataset_revision' for request type TRANSLATION


Summary Not able to view error when CATIA JT failed to generate


Summary catiav5tojtdirect reports completed successfully but no jt is created

License Management


Summary CATIA Manager License Errors

Load


Summary LOAD FOR EXPORT



2-81


Summary TcIC: Service call for loading data


Summary Partial load will open old rev in case the old rev is still present in catuii


Summary Files can not be found messages have to be closed


Summary Revision conflict by loading a structure with multiple revisions to CATIA.


Summary Ability to control the order of the CATDrawing select while open new CATDrawing


Summary Load filtered structure fails to deactivate some components


Summary Load from EPS Structure to CATIA is breaking without error after 11%


Summary Warning Message during Unreadable Objects


Summary Update to an assembly done in the structure manager are not reflected to CATIA.


Summary Differences in a loaded product from Tc Structure Manager and TcICV5.


Summary When loading CATPart, Teamcenter getting crashed.



2-82


Summary After partial load, CATPart duplicated.


Summary Top down revise of Design Table item and re-linking in CATIA fails


Summary TcIC - Mouse move over items in CATIA, then loading info disappears


Summary TcIC 9 does not load V4 geometry in CATIA session.


Summary Visualization Mode Issues with TcIC version 9


Summary TcIC 9062 - Error during Load process at 62%.


Summary TcIC: CATIA files date mismatch.


Summary TcIC / Design Table doesn't work as expected in TcIC 9.0.6.


Summary Open in CATIA didn't report remote objs.


Summary TcIC Open report the wrong date.


Summary Bad Loading/Saving performance of TcIC while using a large set of library parts



2-83


Summary TcIC loading CGR's to #20 instead of #14 folder from Struc Mgr.


Summary TcICv5 fails to load parts with secret dataset (regression from previous version).


Summary Difference between CATIA and Tc structure.


Summary No warning during TcIC open when Item is not configured in Structure Manager.


Summary Internal Splice lose offset value TcIC 9.0.4.

Load as cgr


Summary Load as CGR is too slow with Export as reference

Load as reference


Summary Load as reference: Load Merge from same structure brings error message


Summary Load as ref structure creation is failing for objects without NR (in CATIA).


2-84


Load, Update, Save


Summary TcIC LUS command stop saving modified files after encountering an error

Localization


Summary Messy code in Tc after saving part with Chinese from TcIC.


Summary Japanese characters is garbled on Integration for CATIA 10.0.


Summary Information in Load Merge Selected Level message dialog is displayed wrong

Login


Summary Issue with TcIC, if the user password contains a "&" character.

LOV


Summary Need support of wildcard * character in TcIC Save Manager for LOV search


Summary Interdependent LOVs do not work properly with TcIC 9.0.4.2.


2-85


Mapping


Summary Attribute Mapping for a CATPart and a property on custom item rev.

Mass Properties


Summary TcIC, Update Mass Properties is hanging

Material


Summary To set the material name of main body for the Teamcenter property of CATIA material

MML Browser


Summary MML Browser shows wrongly display of outdated Parts.

Project Assignment


Summary Need ability to do Project Assign in TcIC Save Manager.


2-86


Revise Descriptor


Summary Need Revise Descriptor to enable access to properties on Revise

Save


Summary TcIC Save Manager: Display/change current user Teamcenter role and group.


Summary Need Option to not Read or Save CATIA V5 Publications with TcIC.


Summary TcIC Save error message is not informative


Summary Saving a CATIA Product when having ref data being hidden.


Summary TcIC catia_env problem in customer environment


Summary Saving CATIA V4 models to TC corrupts CATIA session


Summary CATProduct with long part number and description can not be saved


Summary Saving a new part from CATIA to TC collapses the structure in SM



2-87


Summary A specific production structure leads to import and save failure.


Summary Folder configured in the save manager is not taken into account by second save


Summary Performance problem during Save As from TcIC 9.0.4.3


Summary Save cgr files to Teamcenter CATCache Dataset fails TcIC.


Summary Save of 2D and 3D together in TcIC changes the Active Document from 2D to 3D.


Summary TcIC ignore Groupchange for CATPart.


Summary In the specific case can't save CATIA data


Summary Query search can't hit Japanese Localization value using attribute mappings


Summary When design revision is revised, CATDrawing was changed to wrong CATDrawing


Summary CATDrawing dataset name automatically reset after TcIC Revise/SaveAs operations.


Summary Cannot save CATPart and CATDrawing at the same time.


2-88



Summary Structure does not match in CATIA and Tc


Summary Property doesn't get updated during 1st Save to Teamcenter.


Summary When Save,The reference name XXXX has 2 different file names, appeared.


Summary CATProduct is getting saved under CATPart in TcE.


Summary TcIC CATIA Design table update crashes Tc with Save As option


Summary CATIA dataset Design Table link breaks during TcIC check-in


Summary TcIC Save Issue with certain electrical data crashes tcserver


Summary CATIAV5MGR R22 : 2491 - CATIA Manager MMA COPY issue.


Summary Teamcenter crash while using % in part name.


Summary TcServer crash when there is Property type mismatch between CATIA and Tc.


Summary END SAVE - Internal error when saving an assembly from CATIA to Tc


2-89



Summary New TcIC crash on Save from CATIA to Tc - EndSAVE error


Summary CATIA/Teamcenter crashes when trying to save an assembly.


Summary CATIA R22 is hanging on to an old CCP link.


Summary Drawing save if multiple items In Save Manager window


Summary TcIC 9.0.5/CATIA- cannot save from the Integration


Summary Takes a long time to save a new simple part into Teamcenter via TcIC 9.0.4.2


Summary TcIC not updating BOM view with latest revision.


Summary TcIC 9.0.6: Save/Save as aborts with action cancelled.


Summary catia_doc_attributes -> catuii_FileDate attribute not updated after TcIC save.


Summary Cannot create item with additional mandatory field for product.


Summary Incorrect BOM after saving in CATIA with a new Revision.


2-90



Summary Using TcIC save manager save drawing and part problems.


Summary TcIC Save Manager dialog not displayed for assembly update.


Summary CATIA crashes when you cancel save process.


Summary Impossible to revise an Item from TcIC creating a BVR.


Summary TcIC does not update custom attributes when create new component from existing.


Summary Unfeasible error messages for problems with CATIA TcIC 10.0.1.


Summary CATIA crashes when saving an assembly and part together with MML links


Summary Can't use an existing part from Tc in CATIA - mismatch from UUID in TcIC


Summary After upgrade, user must put in credentials in SSO to access Teamcenter from CATIA


Summary Save error when revision is write protected - different behavior than Tc.


Summary COMM_FAILURE when number of named references exceeds 200 for


2-91


CATPart dataset


Summary CATDrawing can not be saved on TcIC

Save As


Summary Save As - More link is not available

Save Manager


Summary Save (Mode: Revise) causes undefined assembly condition


Summary TcIC cannot map the partNumber value to ItemID


Summary TcIC Save Manager does not support array type property


Summary TcIC Save Manager inconsistent column mapping behavior.


Summary TcIC Save Manager does not display custom attributes


Summary Can not revise a big structure in one step


Summary Save Manager panel is not displayed when dataset type is not available


2-92



Summary Part Number is automatically added in the Description.


Summary Java error during save.


Summary TcIC 9.0.4.1 Redefine size of display area for existing Item search result


Summary LOV does not work in TcIC


Summary Re-order of attribute names in TcIC save as dialog.


Summary Save Manager dialog not appearing when deployed SaveManagerCustom_2.0.0.jar.


Summary TcIC Save Manager displays incomplete error message string in Japanse locale.


Summary Add column 'Release_status_list' to ItemRevBrowser dialog, table format broken.


Summary TcIC 9: Save Manager doesn't work with Array Properties on Part Revision.


Summary Custom item type does not display correct required properties in TcIC save panel


2-93



Summary TcIC 9 and 125% font.


Summary TcIC gives no warning when exceeding Item Name character limit


Summary Dataset Description comes out blank on the Save Manager


Summary Preference CATIA_savemanager_map_ir_object_type not working as expected.


Summary Save Manager Save problem with property catpart_item_type.


Summary Item ID and Revision Name mappings.


Summary Name is not populating in "Use Existing Item" functionality in TcIC.

State Details


Summary Get OK to terminate when detailed states called in TCiC 8.3.7.5B


2-94


Update TitleBlock


Summary Error during Titleblock update

Workflow


Summary TcIC as standalone application - start a workflow on an object


2-95





Check-in Status of a CATDrawing during Import Compatibility

MMLAssy Links Save Entry Point Save Manager and Import Default Folders Depreciation of RAC Silent Processes

Check-in Status of a CATDrawing during Import

Set the new preference, CATIA_import_files_in_ci_dataset to true to permit Named References of CATDrawings to be imported under a checked-in CATDrawing dataset that does not already have a Named Reference. When the CATDrawing already contains an existing Named Reference, the new Named Reference is not imported.

CATIA_import_files_in_ci_dataset = true

The default value is false. Named References of CATDrawings will not be imported under a checked-in CATDrawing dataset.

Compatibility

Teamcenter Integration for CATIA V5 (10.0.1) is compatible with Teamcenter Integration for CATIA V4 (9.0.0).

MMLAssy Links

Links between two parts of the same assembly, as a result of a Copy/Paste Special with AsResultWithLink format, are saved by default during the Save process during the Save process, with the new preference, CATIA_search_mmlassy_links_on_save.

The default value of this preference is true, indicating MMLAssy Links are managed. Set this preference to false to not manage MMLAssy links in Teamcenter and in this

case, links will not be exposed in Teamcenter. A false value improves save performance.


2-96


Save Entry Point

A new Save entry point, cat_USER_validateForSaveNewRevision, can be used to validate the Save New Revision process. This entry point function is called during the Save New Revision and Import New Revision processes.

Save Manager and Import Default Folders

The value of the CATIA_savemanager_default_folder and CATIA_default_folder_for_import preferences can now be a folder UID. This is in addition to the previous values of a directory name or NONE. The default value is newstuff.

By defining the preference or selecting a folder in the Save Manager or Spreadsheet editor, the default folder can also be changed from newstuff to the selected folder.

Depreciation of RAC Silent Processes

All RAC silent processes will be depreciated in Teamcenter Integration for CATIA V5 (11.0.0).

Known Issues

The online documentation cannot be printed using the Print button on the toolbar while using Google Chrome. Chrome automatically blocks the print script from running when viewing the documentation locally as a security precaution.


2-97



Attribute Mapping Configuration Design Table Double Byte Support Import Item Revision Browser JT Translation License Management Load MML Browser MML Management Revise Save Save Manager Seed Panel Shape Management State Details User Interface

Attribute Mapping


Summary Attribute mapping fails for custom CATIA properties containing specific strings

Configuration


Summary TcIC catia_env problem in customer environment


Summary Defining socket ports in the tcic_var_env.xml does not work


2-98


Design Table


Summary Top down revise of Design table item and re-linking in CATIA fails


Summary TcIC CATIA Design table update crashes TC with Save As option


Summary CATIA dataset Design Table link breaks during TcIC check-in

Double Byte Support


Summary Messy code in Teamcenter after saving part with Chinese from TcIC.


Summary Japanese characters are garbled on Teamcenter Integration for CATIA V5 (10.0.0)

Import


Summary A specific production structure leads to import and save failure.


Summary TcIC second supplier import containing re-used components indicates modification.


Summary TcIC supplier import "Customer specific" empty spreadsheet.


2-99



Summary Locking error occurs during a multiple import of linked elements (CCP + VIEW link).


Summary CATIA R22 retains an old CCP link.


Summary TcIC supplier import creating zero byte spreadsheet for Europe.


Summary Unexpected TCIC Import error.

Item Revision Browser


Summary Add column 'Release_status_list' to ItemRevBrowser dialog, table format broken.

JT Translation


Summary Not able to view error when CATIA JT failed to generate

License Management


Summary TcIC license errors.

Load


2-100



Summary Load filtered structure fails to deactivate some components.


Summary Load from EPS Structure to CATIA fails without error after 11%.


Summary Teamcenter crashes when loading a CATPart.


Summary After partial load, CATPart is duplicated.


Summary Visualization Mode Issues with TcIC version 9.


Summary TcIC 9: Need way to block auto CATIA start.


Summary Server crash when load to CATIA is first action.


Summary Dataset load fails for no linked document.


Summary Internal Splice loses offset value TcIC 9.0.4.


Summary TcIC 9 does not load V4 geometry in CATIA session.


Summary Files can not be found, messages have to be closed.


2-101


MML Browser


Summary MML Browser shows wrong display of outdated parts.

MML Management


Summary Switch for MML behavior for CATIA Save to Teamcenter in TcIC needed.

Revise


Summary Can not revise a big structure in one step.

Save


Summary TcIC Save error message is not informative.


Summary Saving CATIA V4 models to Teamcenter corrupts the CATIA session.


Summary CATProduct with long part number and description can not be saved.


Summary Saving a new part from CATIA to Teamcenter collapses the structure in the Save Manager



2-102


Summary NTool cannot be used to create parts after having saved one time to Teamcenter.


Summary Java error during save.


Summary Part Number is automatically added in the Description.


Summary Performance problem during Save As from TcIC 9.0.4.3


Summary Update to an assembly performed in the Structure Manager is not reflected in CATIA.


Summary TcIC ignores Groupchange for CATPart.


Summary When design revision is revised, CATDrawing was changed to wrong CATDrawing.


Summary Cannot save a CATPart and a CATDrawing at the same time


Summary Property does not get updated during first Save to Teamcenter.


Summary TcIC Save issue with certain electrical data crashes tcserver


Summary CATIA/Teamcenter crashes when trying to save an assembly.


2-103



Summary Drawing save if multiple items in Save Manager window.


Summary Secondary part not loaded when AUXD instances removed and added


Summary TcIC 9.0.5/CATIA- cannot save from TcIC


Summary Takes a long time to save a new simple part into Teamcenter via TcIC 9.0.4.2


Summary TcIC does not update BOM view with latest revision


Summary TcIC 9.0.6: Save/Save As aborts with action cancelled


Summary Save (Mode: Revise) causes undefined assembly condition


Summary Provide an 'entry point' allowing to customize when it creates NewRev from CATIA.


2-104


Save Manager


Summary TcIC Save Manager has inconsistent column mapping behavior


Summary Save Manager panel does not display when dataset type is not available


Summary Folder configured in the Save Manager is not taken into account during a second


Summary LOV does not work in TcIC


Summary Re-order of attribute names in TcIC Save As dialog


Summary To set the material name of main body for the Teamcenter property of CATIA material


Summary SaveManager dialog does not appear when deploying the SaveManagerCustom_2.0.0.jar


Summary TcIC Save window not acting properly after performing an update a few times


Summary Interdependent LOVs do not work properly with TcIC 9.0.4.2



2-105


Summary Custom Item Type does not display correct required properties in TcIC Save panel

Seed Panel


Summary Ability to control the order of the CATDrawing selected while opening a new CATDrawing

Shape Management


Summary CATIA Representations are not saved to Teamcenter

State Details


Summary Get OK to terminate message when Detailed States called in TcIC 8.3.7.5B

User Interface


Summary Mouse moves over items in CATIA, then loading information disappears


Summary CATIAV5MGR R22 : 2491 - MMA copy issue.


2-106





Assemblies BOM Window CATDrawings During Export CATIA V5 Menu CATIA Internal Identifier (UUID) Conflict Messages Customizing FileNames and PartNumbers Design Tables Display Current Teamcenter Connection and CATIA Environment Within the Title of UI Panels Export as reference External Files Hide/Show Attributes and Scenes and Arrangements Management Highlight in Teamcenter / CATIA Item Revision Browser Queries Load as cgr Load for Compare: Part Number Conflicts Load Merge/Load for Compare Multi-Field Key Functionality OEM Properties Operating System Support/System Requirements Partial Load Display Post-actions on JT, Auxiliary and External Files Changes to the query.txt Files RACLess Server Support Refresh Replace by revision Save Performance Improvements Saving Multisheet Documents State Details Panel TcIC V4/V5 Compatibility


2-107


Assemblies

The Load Merge Target, Load Merge Selected Level, Refresh and Read Linked Document processes are now permitted on assemblies which have been inserted or replaced from Teamcenter.

BOM Window

BOM Window Refresh

Use the new CATIA_refresh_bom_window_on_load preference to display a dialog message prompting to refresh the BOM window during Load processes. A message does not display and the BOM window refreshes automatically, by default.

BOM Window Management

Use the new CATIA_stop_load_if_modified_bom preference to display an error or warning message to continue or stop the Load process when the BOM window has been modified but not saved.

CATDrawings During Export

Use the CATIA_export_assy_with_linked_drawings preference to disable/enable exporting of CATDrawing documents linked to the assembly during the export process when only an assembly or CATPart is selected.

This preference is YES, by default, indicating that CATDrawing documents linked to the document to export are always listed in the Export SpreadSheet and always exported. Set this preference to NO to prevent this behavior.

CATIA V5 Menu

New Menu Options

CATPart/CATProduct Datasets

Create a CATPart or CATProduct dataset for a selected BOM line by using one of the two new options in the CATIA V5 menu; Create a CATPart Dataset for selection and Create a CATProduct Dataset for selection. These options are only available from the PSE on a selected BOM line.

Use the new CATIA_create_dataset_on_foreignfile_ir preference to control the CATPart or CATProduct dataset creation for an item revision of foreign file, and the cat_USER_verifyDatasetCreation entry point to validate the selected BOM line.

This function is also impacted by the value of CATIA_customize_load_process.


2-108


Check-in/Check-out

Check-in and Check-out commands are now available from the CATIA V5 Menu in Teamcenter from the Structure Manager, My Teamcenter and Design Context workbenches.

• For example, use the CATIA V5 menu to launch the Check-in or Check-out process on BOM Lines selected using Spatial Search in Teamcenter.

• The Check-in/ Check-out commands in Teamcenter are RACLess commands and can be customized.

CATIA Internal Identifier (UUID) Conflict Messages

In addition to being controlled during the Load process, CATIA Internal Identifier (UUID) conflicts are now controlled during Save, Import and Import Spreadsheet processes.

Teamcenter Integration for CATIA V5 (10.0.0) compares the UUID stored in Teamcenter with the UUID of the CATIA data on the local disk so that OEMs can ensure data received from suppliers is based on initial data. The UUID is stored in the catia_doc_attributes form within the system_data_string field.

Use CATIA_check_catia_uuid to specify whether an error message, a warning message or no messages display when a UUID conflict occurs during the Save, Import and SpreadSheet processes.

By default, no messages display when a UUID conflict occurs and the load, save and import processes complete as normally.

Customizing FileNames and PartNumbers

Two new entry point functions, cat_USER_buildFileName and cat_USER_buildPartNumber, can be used to customize PartNumbers and FileNames for primary objects. These entry points are called during the Save and Load processes.


2-109


Design Tables

Design Tables can now be managed during the Load process and not the Save process and can be included/excluded from the Save process by setting the new values available for the CATIA_manage_designtables preference. Previous values of true (default) and false are still available.

New Value of CATIA_manage_designtables Behavior

LOAD_NOSAVE Design Tables can be loaded but not saved.

LOAD_SAVEDISPLAY Design Tables can be loaded and saved when Yes is selected from the displayed message.

.xlsx Support

The .xlsx file extension (MS Excel 2007 and later versions) is supported as a Design Table format for the Check In/Out, MML Browser, Load, Save and Import/Export processes.

Review the new .xlsx dataset type preference, CATIA_designtable_excelx_dataset_type, the xlsx file extension preference, CATIA_dt_xlsx_extension and the .xlsx item type preference, CATIA_designtable_excelx_item_type, as needed.

Display the Current Teamcenter Connection and CATIA Environment Within the Title of the Panels

The title area within the Save Manager panel, Spreadsheet Editor panel and the State Details panel can display additional information related to the current Teamcenter connection (User, Group, Role) and CATIA Environment. The display format of this information is defined in the CATIA_ui_title_format preference. By default, the value is ({0} – {1} / {2} [{3}]) which displays as user-group / role name of current CATIA environment.

When this preference is empty, information related to the current Teamcenter connection (User, Group, Role) and CATIA Environment does not display.


2-110


Export as reference

Use the new command, Export as reference, within the CATIA V5 menu, to export lightweight structures to a reference directory. All products, except the top level, convert to components and parts can be exported only as a part or as .cgr files. The reference directory file path is configured during installation and can be found in the pre-install steps.

It is recommended to activate the Load as cgr option using the CATIA_load_as_cgr preference when using Export as reference.

Use the Export as reference command to export a reference assembly to be used as a context in a working assembly. This separates working data, reference data and context data and helps to manage large reference structures when working in context.

Pick Export as reference within the CATIA V5 menu from My Teamcenter, the PSE or Design Context to launch the command.

Reference documents and Ignore Nodes should not contain the same prefix value.

Use CATIA_reference_prefix (User Guide) to define the prefix used for part numbers and file names for reference documents. The default value is _REF_.

Use the cat_USER_buildReferencePrefixSuffix user entry point function to create additional prefix and a suffix values for the part numbers and file names.

External Files

External files are all files recorded on the local disk before the save process and are attached to a primary dataset to be imported into the database.

Unlike Auxiliary files, external files are manually created by the user and not created by the Integration during the save process.

External files are now managed during save processes and can be imported into the database attached to the primary dataset. For example, this permits external files such as the numerical command (NC) electrical code of CATProcess documents to be saved, even though they are not managed by the native CATIA Save As command. External Files are not managed during Load processes.

An error message displays when external files for a dataset can not be saved into the database because the corresponding preference has not been defined or is not valid.


2-111


Use the cat_USER_externalFilesInfo and cat_USER_secondary_dataset_info entry points to customize the external document filename and dataset name.

Hide/Show Attributes and Scenes and Arrangements Management

Teamcenter Integration for CATIA V5 (10.0.0) now manages Hide/Show attribute in CATIA and Scenes and Arrangements in CATIA so that visualization of the assembly in CATIA and in the JT Viewer in Teamcenter are aligned.

Use the Hide/Show button on the Save Manager toolbar and the Spreadsheet Editor panel to hide or show attributes.

Set the CATIA_manage_scenes_on_save preference to true to manage Scenes during the Save As and Import processes (it is false, by default). Scenes can not be managed during the Save, Save Selected and Load, Update, Save processes.

Set the CATIA_savemanager_hideshow_option and CATIA_savemanager_hideshow_option_on_import to true to automatically toggle the Hide/Show options on in the Save Manager panel and Import Spreadsheet (they are false, by default).

The default arrangement name can be set by using the CATIA_default_arrangement_name preference to create arrangements in Teamcenter corresponding to Scenes in CATIA.

Highlight in Teamcenter / CATIA

Select in CATIA - Highlight in Teamcenter

Occurrences of documents which are selected in the CATIA specification tree become highlighted in the Structure Manager window of Teamcenter when using Highlight in Teamcenter, depending on

availability. This command is available from the Integration toolbar , the CATIA V5 menu in Teamcenter, or the contextual menu.

Select in Teamcenter - Highlight in CATIA

Occurrences of documents which are selected in the Structure Manager window of Teamcenter become highlighted in the CATIA specification tree when using Highlight in CATIA V5, depending on availability. This command is available from the CATIA V5 menus within Product Structure and Design Table.

Item Revision Browser Queries

The search criteria panel contains a list of queries to request in the database. The available list of queries can now be defined by the new preference, CATIA_queries_for_item_rev_browser. The default query is defined by CATIA_query_for_item_rev_browser.

When a default value has been defined in the CATIA_query_for_item_rev_browser preference but not set in the values of the CATIA_queries_for_item_rev_browser preference, then first query


2-112


defined in the queries list displays. If a different query is selected, then the CATIA_query_for_item_rev_browser is updated.

Load as cgr

Deliver lightweight files, improve the load performance, and reduce the volume of files transferred to a client machine by creating a dummy part.

A dummy part is a cgr exported to the client machine in place of the CATPart document; its file size is 0 KB.

On user demand, the geometry (i.e., the real CATPart) can be delivered to the client machine to enable the designer to modify the part design. Replace the dummy part by the real CATPart using Replace Load as cgr or perform a check out prior to the save process in order to display the part in the Save Manager.

The TcIC_load_as_cgr_menu property in the tcic_var_env.xml file is no longer available beginning with TcIC V5 10.0. The Load as cgr option in the CATIA V5 menu and the Replace Load as cgr command are always visible.

Use the CATIA_manage_load_as_cgr_with_components preference to enable the Load as cgr and Replace Load as cgr processes for dummy parts (false) or cache component (true). By default, Load as cgr is enabled for dummy parts.

Refer to the table comparing the advantages of cache components and dummy parts, the comparison between Load/Load as cgr and to the list of processes which support dummy parts.

Load/Load as cgr/Activate Latest Active Shapes

Use CATIA_load_as_cgr to automatically toggle the Load as cgr Load option on/off from the RAC. Set the value to true to automatically toggle this option; set it to false (default) so that this option is not automatically toggled.

When the Load as cgr option is selected from the CATIA V5 menu, the Activate Latest Active Shapes option is not available.

Load for Compare: Part Number Conflicts

Avoid part number conflicts during the Load for Compare process when an assembly loaded for compare and an assembly loaded using the regular load process are merged into a single window by setting CATIA_rename_partnumber_during_lfc to true so that part numbers will be renamed according to the value of CATIA_load_for_compare_prefix.

The default value is false; conflicting part numbers are not renamed.


2-113


Load Merge/Load for Compare

The Load For Compare process can be performed on a document which has also been loaded as merged in CATIA.

Use the combination of these functions to compare the current working assembly with another revision of the assembly, or another assembly, in the same CATIA window. The Save process is still available when this sequence of processes are used.

Multi-Field Key Functionality

In previous versions of Teamcenter, the Item ID was considered to be a key field which must be unique. Beginning with Teamcenter 10.1, key fields can be configured in Teamcenter so that multiple fields may be unique. For example, when the multi-field keys are configured for Item ID and Item Type, then the part item, drawing item, and design item may all contain the same Item ID. Typically, attributes which must be unique are item_id and object_type.

Refer to Notes on Import, Save General Rules and Behavior (User Guide) and Preferences Related to Attribute Mapping for further information. An example of file name customizations can also be found here.

Operating System Support/Support Prerequisites

In addition to the table of supported operating systems in the Prerequisites section , Teamcenter Integration for CATIA V5 (10.0.0) also supports Teamcenter 9.1.2.9 and 10.1.2, CATIA V5-6R2013 and CATIA V5-6R2014.

OEM Properties

When OEM user properties are created and changed to read_only access, they are overwritten by the properties calculated from the reference properties in the imported document and will have read and write access.

Partial Load Display

Deactivated instances are no longer switched to default to access Shape Representation Activation states. To improve performance, deactivated instances in CATIA display as shown below.


2-114


Right-click on a part to view its properties and to differentiate between an UUID mismatch icon and a deactivated instance. The display changes to deactivated when the part is deactivated as a result of a partial load.

Post-actions on JT, Auxiliary and External Files

By default, JTs and External Files are now converted during the post-action process as a result of two new preferences, CATIA_apply_post_action_on_jt_datasets and CATIA_apply_post_action_on_ext_datasets. Set the preference(s) to false to disable this functionality.

The cat_USER_auxiliaryFilesInfo entry point is now also called during SaveAs/Revise process to permit Auxiliary dataset names to be renamed during post-action.

The user data POM link between an auxiliary dataset and a primary dataset is defined by the new preference, CATIA_pom_class_auxiliary_link_userdata, and is preserved during the SaveAs/Revise process.

Changes to the query.txt File

The query.txt file has been replaced with the query.xml file to define the list of documents to manage during the Export RAC, Partial Export RAC and Load,Update, Save RAC processes in silent mode.

The query.xml file is also used during the Export RACLess, Partial Export RACLess and Load, Update, Save RACLess processes.

RACLess Server Support

The Java Runtime Environment (JRE) version used for the RACLess Application is the same as the version used by Teamcenter.

A RACLess application has been introduced to support processes such as silent processes (Import, Export, Load, Update Save) and AddCATShape Shape Representation, Update Title Block, Check in/Check out, Synchronize Active Shapes and Update Status.


2-115


During the Silent processes, connection through the RACLess server is supported three different ways:

1. Information is set within the command line to established RACLess connection.

2. Information is not set within the command line

3. For Single Sign On (SSO) connections:

a. the specific environment for RACLess Applications is selected when the SSO connection has already been launched.

b. a login panel displays when the SSO connection has not been launched.

During non-Silent processes, connection through the RACLess server through the RAC connection is supported two different ways:

1. The RAC connection information is used to set the RACLess connection when the SSO connection has already been launched.

2. A login panel displays when the SSO connection has not been launched.

Use the TcIC_rac_socket_port preference to set the TCP port number to be used for the interface communication between RAC and RACLess.

Replace by revision

Use the new Replace by revision command from the toolbar or the Teamcenter contextual menu to select a revision to use during the Replace process when several revisions exist.

The behavior of this command is controlled by the CATIA_replace_by_revision_with_latest preference and the cat_USER_getItemRevisionForReplaceByRevision new entry point.

Only revision properties related to Teamcenter can be displayed in the Replace by Revision panel.

This panel can be customized.

Refresh

Refresh functionality is now available for:


2-116


• Top-level CATProduct or CATPart documents

• Foreign Files

• Component caches

• Broken icons

• Instances activated in the CATIA session

In addition, the Refresh performance has been improved; only elements that need to be refreshed are exported from Teamcenter and updated in CATIA.

Save Performance Improvements

A new preference, CATIA_check_PX1_available, has been created to improve performance during save processes for assemblies containing Multi-model Links (MML) by checking the availability of a PX1 license using PX1 APIs.

PX1 libraries should be compiled with Teamcenter Integration for CATIA V5 CAA libraries through InstallAnywhere prior to using them. The TCIC_PX1_COMPILATION environment variable should be set to YES before compiling the CAA libraries in UNIX and Windows Installations.

Saving Multisheet Documents

The CATIA Save As option, Save multisheet document in a single vectorial file, is considered when saving CATDrawing auxiliary files during the Save As process. Use this option to control the number of auxiliary file documents saved per sheet.

By default, this option is not selected and one auxiliary file document is saved per sheet for the document types defined in the CATIA_dwg_auxiliary_types preference.


2-117


Use the cat_USER_auxiliaryFilesInfo and cat_USER_secondary_dataset_info entry points to customize the auxiliary document filename and dataset name. Use the CATIA_pom_class_auxiliary_link_userdata (User Guide) to define the POM class used to create the user data on links between a drawing dataset and an auxiliary dataset.

State Details Panel

The State Details panel now contains new commands:

• Highlight Selected Documents

• Highlight Selected Parent Documents

• Refresh in CATIA

• Replace by revision in CATIA

• Update

An entry point has been created to implement functions called from the Integration.

The Detailed States command is also available within the context menu in CATIA.

TcIC V4/V5 Compatibility



2-118


Known Issues

CATDrawings and Chinese Characters Remote Desktop Sessions Viewing the Online Documentation using Chrome

CATDrawings and Chinese Characters

Problem:

PR 2200224: An error occurs when saving a PDF because the title of a CATDrawing contains certain Chinese characters.

Solution:

This is a Dassault Systèmes/CATIA issue and can be resolved by using one of the following CATIA versions:

• CATIA V5 R20 beginning with SP6 only

• CATIA V5 R21 and later versions

Remote Desktop Sessions

A display issue caused by a known Java issue occurs when applying a custom header in the Save Manager, Save dialogs and Browse Multi-model Links windows.

Resolution/Workaround

The Save Manager, Save dialogs and Browse Multi-model Links windows can be redrawn on an active client session by changing the following default values in the uiconfig.properties file within the .\.TcIC directory:

• Change TCIC_UI_REDRAW to true (the default value is false)

• Change TCIC_UI_CUSTOM_HEADER to false (the default value is true)

Viewing the Online Documentation using Chrome

The print button on the documentation toolbar becomes disabled because Chrome automatically blocks the print script when viewing the documentation locally.

A javascript alert error sometimes occurs when switching between Content Categories (User Guide, Installation Guide, Appendix) or when changing the window size. Selecting OK on this message clears the error and the documentation displays correctly.

http://bugs.java.com/view_bug.do?bug_id=6429812


2-119



Add CATProduct Attributes Mappings Baseline Browse Multi-Model Links Check In/Out Dispatcher Documentation Entry Point Export Export as reference Forbidden Characters Configuration Import Insert Installer Item Revision Browser Load Load for Compare Load Merge Load, Update, Save Mass Properties Multi-site Progress Bar Read Linked Documents Replace Revise Save Save Manager State Details Synchronize Active Shapes Update Title Block


2-120


Add CATProduct


Summary Add CATProduct dataset from Save Manager: Teamcenter status bar does not show working

Attributes Mapping


Summary Attribute mapping OEM_description does not work bidirectional


Summary Teamcenter Integration for CATIA V5 (9.0.0) Attribute Mapping IMAN master fails in CATIA user interface


Summary Problem still exists for type float


Summary Attribute Mapping does not work with %


Summary Teamcenter Integration for CATIA V5 Mapping Parameter From MassProp_form error

Baseline


Summary TcIC 'CATIA_journal_server=SYSLOG' crashes Teamcenter on Baseline and Save As if AUXDS


2-121


Browse Multi-Model Links


Summary Teamcenter Integration for CATIA V5 displaying more than one MMLAssy

Check In/Out


Summary Need ability to check out parts/drawings while loading


Summary BVR is not checked-out from Teamcenter Integration for CATIA V5 (9.0.3) Save Manager dialog


Summary Check out dialog does not display when selecting objects beyond 146 in the Save Manager


Summary Check out message gives wrong message when "Load for Compare in CATIA V5" is used

Dispatcher


Summary Dispatcher server hangs because tcservers are not deleted


Summary Alt Reps - Dispatcher failing to create JT s automatically or correctly


Summary JT trigger does not happen on separate TcIC check-in


2-122



Summary Configuration for catiav5tojtdirect

Documentation


Summary Teamcenter Integration for CATIA V5 (9.0.0) documentation preference: CATIAV4_as_foreign_file

Entry Point


Summary Use the custom entry point for building the filename and write into that a custo

Export


Summary Non-selected CATDrawings are exported

Export as reference


Summary Export as reference command is not made suppression

Forbidden Characters Configuration



2-123


Summary Teamcenter Integration for CATIA V5 (8.3.7) : character forbidden %

Import


Summary Import does not respect chosen Item Type


Summary Import Process - Create Spreadsheet and Import Assemblies macros contradict


Summary Import of CATDrawing fails on Solaris


Summary CATDrawing import not possible due to OEM-properties


Summary Teamcenter Integration for CATIA V5 stops working on importing data


Summary Can not import some assemblies into Teamcenter Engineering when using Chinese characters in the ItemRevison description


Summary CATDrawing is imported under Item ID defined in the Import Spreadsheet


Summary Teamcenter Integration for CATIA V5 Spreadsheet not working with new format


Summary An alert displays when importing in silent mode and causes hanging



2-124


Summary Spreadsheet import fails in a multi-CATIA environment


Summary Teamcenter Integration for CATIA V5 Import spreadsheet of linked CATParts, CATDrawing creating additional item

Insert


Summary Teamcenter Integration for CATIA V5 Insert; changing to Teamcenter session is very slow.

Installer


Summary Teamcenter Integration for CATIA V5 Query install, unable to install Queries ( *p/word not infodba)



Summary The ItemRev Browser is not displaying the fields from the queries correct

Load


Summary Teamcenter Integration for CATIA V5 will not show the ItemRevision ID if no dataset is attached to the ItemRev


Summary CATSCRIPT ERROR - insufficient stack space


2-125



Summary Teamcenter Integration for CATIA V5 part number mapping incorrect


Summary CATIA2D will not open when opening from the CATIA V5 menu


Summary Load to CATIA causes revision conflict (same part number in different variants)


Summary Partial Load loads displayed structure instead of user selection


Summary Unable to load products which include question marks revision


Summary When loading Teamcenter Integration for CATIA V5 (8.3.7) getting error


Summary Revision Conflict error occurred while loading an assembly from the PSE to CATIA


Summary Teamcenter crashes during a partial load of a hybrid assembly to CATIA


Summary TCServer crashes while working in Teamcenter Integration for CATIA V5


Summary Teamcenter server crashes during Teamcenter Integration for CATIA V5 Load and Save operation


Summary Partial Load to CATIA performance issue.


2-126



Summary Teamcenter Integration for CATIA V5 data fails to load on second load on AIX


Summary Loading from Teamcenter to CATIA V5 in VisMode has an issue when a seed model is used


Summary When loading assembly getting revision conflict error message

Load for Compare


Summary Data loaded to CATIA V5 with Load for compare cannot be inserted into previously loaded assembly

Load Merge


Summary After using the Load/Merge function, we cannot use Load for Compare


Summary A server disconnect occurs when using Load Merge


Summary Unable to perform a "Load Merge" operation in Teamcenter Integration for CATIA V5 (8.3.7.1)


2-127


Load, Update, Save


Summary Load, Update, Save functionality is not working


Summary Load, Update, Save not responsive upon an interruption

Mass Properties


Summary CATIA Modified Weight attribute is not always stored in same units


Summary Wrong mass attributes after CATIA data import

Multi-site


Summary Multi-site instance in use error when CATIA_create_OEMForms_option is set to true

Progress Bar


Summary Do not set Ready Status with invalid Naming Rule




2-128


Summary Error when performing Read Link Documents in CATIA V5 R20


Summary ERROR: Read Linked Documents process is breaking off


Summary Read linked documents brings up an unusable panel for a large number of parts

Replace


Summary Replace on invalid selection does not give error message

Revise


Summary Teamcenter Integration for CATIA V5 (9.0.2) Revise drawing and assembly error

Save


Summary Part/Product/Drawing file name format for different item types


Summary Already saved linked parts are shown as new during Save


Summary Preference 'CATIA_Map_Property_PartNumber' does not work with any date input.


2-129



Summary MML links of publications are broken if CATPart is saved out of original context


Summary Problem saving a CATDrawing with a sheetname containing more than 32 characters


Summary Long description text in CATPart leads to crash in Teamcenter


Summary Save Existing dataset - file name and part number contain different DsDesc values


Summary Alt representations not shown in the Structure Manager - re-save of part required


Summary Save CATProducts removes JTs on the last added component


Summary Error creating an item in Teamcenter Integration for CATIA V5 when UOM was entered


Summary Invalid item revision name during the final save in TcIC save window


Summary TcIC revision conflict window is too large to see part numbers


Summary Revising Design Tables from Teamcenter clears the named reference content


2-130



Summary Use Existing Item in Teamcenter Save Manager leads to error


Summary Save As New Revision uploads the old revision file if already in cache


Summary The customer cannot save CGR loaded documents when using TcIC


Summary The information about the occurrence UID is not written during save through TcIC


Summary Save Manager check out fails on an ItemRev without CATProduct dataset and more than one BOMView


Summary Teamcenter crashes when performing a Save As of an assembly containing parts/sub


Summary Save problems at Magna Steyr Fahrzeugtechnik


Summary Use Existing Dataset does not work


Summary Using the preference TCAllowedChildTypes breaks the save process.


Summary When saving working data into TcE a second time, information in dialogue is wrong



2-131


Summary TcIC failed to handle some cases where Teamcenter Occurrence ID is not found.


Summary Teamcenter Integration for CATIA V5 (8.3.6) makes collapsed structure after revise using TcIC


Summary Terminate CATIA, before show Save Manager


Summary Query regarding auto save in TCIC Save Manager


Summary Stopping at 95% process when saving using TcIC


Summary When overwriting the CATAnalysis file, the CATAnalysisResults data is lost


Summary CGRs are not updated when checked out by another user


Summary CATIA_MAP_Property_PartNumber preference value is not correct when saving a CATDrawing from TCIC


Summary Lost 112,000 CATDrawing Links


Summary Delete occurrence panel opens blank with no info displayed


Summary Saving large assemblies or parts takes too long


2-132



Summary Delete occurrence scenario throws Java lang Null pointer exception


Summary Unexpected delete occurrence panel leads to Duplication of BOMLines


Summary Unable to save CATpart to Teamcenter after reconnect to Hot tcserver


Summary CATIA crashed during Save process.


Summary Cannot create occurrence, error occurs when saving Catproduct that was not checked-Out


Summary Save As in Teamcenter, load to CATIA V5 and re-save does not rename secondaries


Summary Teamcenter Integration for CATIA V5 (9.0.0) Mandatory attributes on the IRMF are not available on Save Manager dialog


Summary Teamcenter occurrence thread ID's are not correct on load From Teamcenter in CATIA V5


Summary Saving from CATIA does not assign Project ID/Owning Project to items


Summary The Auto IDs checkbox switches back on after it has been unmarked



2-133


Summary Multiple ActiveShapes forms created and attached to the BOM Lines


Summary Fails when saving CATIA files from CATIA application


Summary Teamcenter Integration for CATIA V5 (9.0.2) Import CATIA Drawing fails to overwrite an existing empty dataset


Summary TcIC does not create items when inherited attributes are in Create Descriptor


Summary Substitute parts are not copied when revising an assembly from TcIC

Save Manager


Summary Assign button disabled in the CATIA Save Manager


Summary Unable to go back to null value for LOV type attributes

State Details


Summary Detailed State report shows incorrect revision for some components

Synchronize Active Shapes



2-134


Summary Syncronize Active Shapes from TcIC toolbar causes Teamcenter server crash

Update Title Block


Summary Title Block mapping with Teamcenter Integration for CATIA V5 (9.0.3) and real name is not possible


2-135





Messages Displayed During Check Out Replace and Staging Directory Conflicts Configure the BOM Window Displayed During Load Processes libcatia_custom: Descriptions of the Working Environment and Current Process Identifier Post-Actions During the CATIA Save Processes Changing the Item Type in the Save Manager Data Panel System Prerequisites Compatibility Save Manager Customization Tutorial Silent Load, Update, Save and Silent Export Documentation Index

Messages Displayed During Check Out

Change the value of the CATIA_display_asynchronized_datasets_on_co preference to INFORMATION to display an informational message during the check out process when a more recent version of a dataset exists in the Teamcenter database. This preference applies only when check-out is launched from the CATIA toolbar, the Save Manager and State Details. It does not apply to the check-out function of Browse Multi-Model Links.

The preference displays a warning message, by default, similar to pre-9.0.1 versions of the Integration.

Replace and Staging Directory Conflicts

Staging Directory conflicts occur when a CATIA product, component or part is replaced with another from Teamcenter having the same file name. Avoid these types of Staging Directory conflicts by changing the value of CATIA_manage_staging_conflict_on_replace to false. The default value is true.

Staging directory conflicts will occur for children components, when necessary, regardless of preference value when the selection is an assembly.


2-136


Configure the BOM Window Displayed During Load Processes

Configure how the BOM window (corresponding to an assembly) displays when opened in the PSE during the Load Merge Target, Load Merge Selected Level, Refresh and Read Linked Documents processes by modifying the value of CATIA_manage_configurations_on_load_from_CATIA. Variant and Effectivity are also managed during these Load processes, depending on the value of this preference.

libcatia_custom: Descriptions of the Working Environment and Current Process Identifier

Descriptions of the Working Environment and the Current Process Identifier, accessible in the libcatia_custom customizable library, are now available .

Post-Actions During CATIA Save Processes

Set the new preferences, CATIA_apply_post_action_during_catia_saveas and CATIA_apply_post_action_during_catia_revise, to true (both are false, by default) to apply deep copy rules and call a post-action during CATIA's Save As and Save New Revision processes, and during Teamcenter's Save As process by using the CATIA_apply_post_action_on_catia_saveas preference.

Changing the Item Type in the Save Manager Data Panel

Changing the item type in Item Revision Properties subsection of the Save Manager Panel refreshes the data panel. All attributes will display their default values, except for visible properties previously applied using the Apply button and the mapped fields of attributes already visible when the Save Manager was opened.

System Prerequisites

SP1 is now the minimum version required when using CATIA V5 R21, R22 (V5-6R2012)and CAA .

Compatibility


Save Manager Customization Tutorial

Beginning with Teamcenter 9.1, the provided SaveManagerCustom_2.0.0.jar is only compatible with 64 bits; it is not compatible with 32 bits. The source code provided within the projectSamples.zip file


2-137


must be manually compiled in order to be compatible with the 32 bits versions of Teamcenter 9.1 and later.

Silent Load, Update, Save and Silent Export

The query.txt file, used to perform a silent Load, Update, Save or a silent Export has changed. The file must now contain the dataset type on which the operation will be performed.

Permitted values for the Load, Update, Save dataset types are Item, ItemRevision, BVR, CATPart and CATDrawing. Permitted values for the silent Export dataset types are BVR and CATDrawing.

Silent Processes API Java documentation has been included in the Installation Guide and contains sample classes which can be used to develop commands.

Documentation Index

An Index containing an alphabetical list of keywords has been added to the online documentation and can be accessed by selecting the new Index button on the documentation toolbar.

An index has been created for the User Guide, Installation Guide and Preferences Only documentation. Select a documentation guide first, then use the Index button to search for a specific keyword within the selected documentation.

Keywords matching the term will display as the index search field is populated. Select a keyword to view its reference in the documentation. Then, select the Table of Contents button to display the corresponding topic in the Table of Contents tree.

Known Issues

There are no known issues associated with this version.


2-138



Attribute Mappings CATIA V5 Menu Check In/Check Out Convert to JT Customization Documentation Entry Point Export Import JT Load Localization Mapping Messages Read Linked Documents Replace Save Save As/Revise Thumbnails

Attribute Mappings


Summary Integration Attribute Mapping does not work with CATDWG second or third level in the Specification Tree.

CATIA V5 Menu


Summary Double entries occur in the CATIA V5 menu when adding Structure Manager to My Teamcenter.



2-139


Summary The CATIAV5 menu is unavailable when integrated with TcXV5.3.

Check In/Check Out


Summary Automatic confirmation of Check In does not work with the Integration Save Manager.


Summary Assembly is switched to Design mode and Check Out takes a very long time.

Convert to JT


Summary DispatcherRequest target object list is different for catiav5tojt and catia2cgr.

Customization


Summary Cannot create a custom Save Manager toolbar.

Documentation


Summary Incomplete documentation for Design Table.


2-140


Entry Point


Summary Command context not available for Teamcenter Integration for CATIA V5 entry point.

Export


Summary Implicit scripting engine error during export.


Summary Export of CATPart and CATProduct return wrong filename.

Import


Summary Create Spreadsheet and Import Assemblies.


Summary Partial Import failure.


Summary tcserver process hangs when a query result is very large.


Summary Teamcenter Integration for CATIA v5 is not properly managing CPP links when importing to Teamcenter.

JT


2-141



Summary Duplicate JT datasets created under a Design Revision on Revise from Teamcenter Integration for CATIA V5.

Load


Summary No BOM creation.


Summary A CATProduct displays a CATDrawing.


Summary Modifying a warning message.


Summary Error opening CATIA dataset when relations are displayed as pseudo-folders.


Summary .cgr files created but not used.


Summary Bad foreign files management.


Summary Performing a LSL on an item with only a jt dataset fails to load geometry.


Summary Teamcenter Integration for CATIA V5 (8.3.3) for Teamcenter 9: problem with CATIA UID preference.


Summary Integration performance issue when loading big assemblies.


2-142



Summary Teamcenter Integration for CATIA V5 (8.3.5) : New CATDrawing loaded without name.


Summary Teamcenter does not send the right sequences to CATIA V5 visualization.


Summary Wrong message loading a non-CAD item.


Summary CATIA fails to start.


Summary Teamcenter crashes when loading an assembly in the Integration.


Summary No In Session error message.


Summary The Integration delivers .cgrs to the wrong .cgr folder.


Summary Assembly does not load all the parts in the Save Manager when modified.


Summary Site preference, CATIA_Check_ENV = Null causes Teamcenter/CATIA to disconnect.

Localization



2-143


Summary Message prompt is unreadable.

Mapping


Summary Integration part number mapping is incorrect.

Mass Properties


Summary Unable to calculate assembly mass properties when a sub assembly has status.

Messages


Summary Modify a warning message.



Summary CATIA drawing wrongly appears as needing update.


Summary Teamcenter Integration for CATIA V5 (8.3.3) for Teamcenter 9 closes CATProcess when Read Linked Document is performed.

Replace



2-144


Summary Replace revision in CATIA V5 by using same filename.

Save


Summary CATIA drawing wrongly appears as needing update.


Summary TCIC java.net.SocketException: Connection reset error.


Summary Teamcenter Integration for CATIA V5 (8.3.0) Action canceled : end of the command (using Display rule).


Summary CATDrawing links are not updated in Teamcenter.


Summary Design Table dataset becomes deleted in Teamcenter when the Integration's Save fails.


Summary Change in dataset type from CATProduct to CATPart leads to wrong PS in CATIA.


Summary Datasets are duplicated when using a .cgr file.


Summary Some CATDrawing attributes are missing.


Summary Unable to save a CATProduct to Teamcenter: Unable to read desc file.


2-145



Summary A save performed on CATProduct cut off JT dataset from Item Revision under multiple CAD system.


Summary Unable to update the MMLAssy link in Teamcenter after revise of the source part.


Summary Cannot Save tubing assembly with different runs and same product specific name.


Summary CATIA crash during initial save (data specific).


Summary Teamcenter Revise troubles Teamcenter Integration for CATIA V5 spreadsheet creation for Import.


Summary Teamcenter Save Manager window does not display when the Save button is selected in CATIA.


Summary Saving electrical structure CATProduct crashes Teamcenter server process.


Summary CATIA BVR display is not correct.


Summary Save Manager window does not prevent an invalid revision.


Summary CATIA file name is incorrect for certain occurrences.


2-146



Summary Saving custom design type from CATIA locks up CATIA Save Manager.

Save As/Revise


Summary Teamcenter Revise troubles Teamcenter Integration for CATIA V5 spreadsheet creation for Import.


Summary Revise item revision behavior different in Teamcenter and the Integration.

Thumbnails


Summary Thumbnail generation fails due to spaces in custom variable.


2-147





Attribute Mapping CATIA V5 Requirements and Support Check In/Check Out Client User Exit Class: Java Entry Points Compatibility Compute Geometric Attributes Dataset Browser Document the Extension Point Dispatcher Services Export Staging Directory Import Item Revision Browser ITK Functions .jar File Names Journaling JT libcatia _tc_custom Compile Scripts Localization/Internationalization Progress Bar Save density in cgr Save Manager Save Manager Entry Points Save Manager Java Packages and Classes Seed Documents/Seed Dataset Panel TcIC Directory Location Update Title Block User and Installation Guide Documentation


2-148


Attribute Mapping

CATIA_MAP_Property_PartNumber and CATIA_MAP_Property_Nomenclature use real name Teamcenter properties. Preference format values have changed and now support localization differences between client and server.

Text within a drawing can now be updated using attribute mapping.

CATIA V5 Requirements and Support

In addition to the current prerequisites, review the new requirements/support when using specific versions of CATIA V5. There is no change to CATIA V5 R19 requirements.

If using CATIA V5R20:

Teamcenter Integration for CATIA V5 (9.0.0) requires CATIA V5R20 SP1, minimum.

If using CATIA V5R21 and R22:

Teamcenter Integration for CATIA V5 (9.0.0) supports CATIA V5R21 and R22 (SP3).

CATIA V5R21 is only supported on Windows 32 and 64-bit platforms, and is not supported even if an AIX SERVER installer has been provided.

Check In/Check Out

By default, the Integration performs a Check In after the Import process.

Client User Exit Class: Java Entry Points

Java Entry Points are now managed by using plug-in Extensions / Extensions Points concepts instead of using the external class TClassCatiaUserExit.

Customizing TClassCatiaUserExit class is no longer supported.

Compatibility

Teamcenter Integration for CATIA V5 is compatible with Teamcenter Integration for CATIA V4.


2-149


Compute Geometric Attributes

Import

Geometric attributes can be computed during the Import process.

Save

The Compute Geometric Attributes on the Main Body Only operation can now be performed during the Save process.

The Compute Geometry for Main Body button is active/selected by default when the CATIA_compute_geometry_for_main_body preference is set to true and mass properties for the main body are always computed. When false, the button is inactive/unselected and requires manual selection to compute mass properties for the main body. The default value is false.

Dataset Browser

Use the Dataset Browser to select a dataset to use when saving a document. The Dataset Browser displays:

• when a single document and Use Existing Dataset are selected from the Save Manager panel.

• when the revision selected from the Item Revision Browser has several existing datasets whose type matches the current document in CATIA.

• The selected Item Revision of a CATDrawing document contains several CATDrawing datasets in the database.

• The selected Item Revision is a seed CATPart or a seed CATProduct document containing several multiple CATPart datasets or CATProduct dataset.

Refer to the Installation Guide to customize the Dataset Browser.


2-150


Document the Extension Point

The EntryPoints documentation window automatically displays when creating an entry point schema in Eclipse.

Create the edited extension point schema's reference documentation by selecting the following tabs to complete the fields.

Description Since Examples API Information Supplied Implementation Copyright

Valid HTML mark-up may be used in any of the section's fields.

Dispatcher Services

Teamcenter Integration for CATIA V5 now supports Dispatcher Services.

When Dispatcher components and services are installed and Teamcenter Preferences are set correctly, CATIA files are sent to the Dispatcher when picking the Create JT option on the Save Manager form, or by picking the Convert to JT option within the CATIA V5 Teamcenter menu.

It is now possible to send files to any translator which has been properly configured.

CATIA_ETS_translation_services Teamcenter Preference contains the list of Dispatcher Services name preferences that can be called in the Convert Items to JT process.

Converting JT via Dispatcher Services

Use the ETS_trans_rqst_referenced_dataset_types preference to specify which CAD dataset type names can be referenced by translation requests as primary or secondary objects. A pre-delete action is registered for each of the defined dataset types to support CAD data deletion while a translation is in process.

Add the dataset types to be managed via Dispatcher to the preference's value, including the dataset type for converting foreign files.

Export Staging Directory

The Export process now runs in an independent temporary directory named export_tmp during the load phase of the export process. This directory is not customizable. Documents loaded under this independent directory are copied under the export directory.


2-151


As a result, the usual staging directory is not empty, data in the CATIA session is not lost and file naming conflicts can be managed.

Specific CATIA options must be listed in the correct order to avoid errors.

Import

The import process has been improved to support new Teamcenter functionalities such as mandatory attributes, localization and the Teamcenter Create Descriptor.

Spreadsheet Format

A new import Spreadsheet format, now the default format, has been created to manage mandatory attributes. The format of the spreadsheet is controlled by the CATIA_manage_mandatory_attrs_on_import preference.

When CATIA_manage_mandatory_attrs_on_import is true (default value), mandatory attributes are available and managed on the import spreadsheet. When the value of this preference is false, the spreadsheet displays in the alternate format and mandatory attributes are not managed. The alternate format is the format available in pre-9.0.0 versions of the Integration.

The spreadsheet will be created in the new format, by default.

Spreadsheet Editor

A Spreadsheet Editor, available from the Integration toolbar, has been created to edit and modify the new import spreadsheet using a graphical interface similar to the Save Manager Panel. When opened, the Spreadsheet Editor checks the validity of the information entered and updates the spreadsheet documents.

Use the Spreadsheet Editor button from the Integration Toolbar to launch the editor.

Tasks such as Convert to JT, Compute Geometric Properties and selecting the default import folder can be specified. The editor panel can also be customized.


2-152


JTs

The Convert to JT operation can now be performed during the Import process.

The Convert to JT button is always active/selected when CATIA_createJT_option_for_import preference is set to true so that JTs are always created during the Import process. When false, the button is inactive/unselected and requires manual selection to create JTs during the import process. The default value is false.

Compute Geometric Attributes

The Compute Geometric Attributes and Compute Geometric Attributes on the Main Body Only operations can be performed during the Import process.

The Compute Mass Properties button is active/selected by default when CATIA_computeGeometry_option_for_import is set to true and mass properties are always computed. When false, the button is inactive/unselected and requires manual selection to compute mass properties. The default value is false.

The Compute Geometry for Main Body button is active/selected by default when the CATIA_compute_geometry_for_main_body_for_import preference is set to true and mass properties


2-153


for the main body are always computed. When false, the button is inactive/unselected and requires manual selection to compute mass properties for the main body. The default value is false.

Default Folder

Use the new preference, CATIA_default_folder_for_import, to change the default import folder from Newstuff to a user-defined folder. This preference is only available beginning Teamcenter 9.1.

Check In after Import

By default, the Integration performs a Check In after the Import process. Set the new preference, CATIA_checkIn_option_for_import, to false to prevent the Integration from performing a check in after the import process.


The new Item Revision Browser displays when the Search button is selected from the Save Manager panel or when a selected element is not found in the database during automatic Save as New Revision, Use Existing Item, Use Existing Dataset operations.

Use the Item Revision Browser from the Save Manager panel to search for and select an item revision from the database to be used during the New Revision, Use Existing Item and Use Existing Dataset processes. Search results display in the query results table and the Save Manager uses the selected item.

Item Revision Browser Query

The Item Revision Browser query must be imported ,otherwise the Item Revision Browser will not display.

Customization

Refer to the Customization section of the Installation Guide to customize the search query table.


2-154


ITK Functions

cat_USER_has_children

The cat_USER_has_chidren ITK function has been renamed to cat_USER_hasChildren. In addition, the CustomLoadValue variable within cat_USER_hasChildren is now VarCATIA_CUSTOM_Load and the Answer variable is now op_answer.

Review this ITK function to ensure all prototype changes have been considered when customizing it.

cat_USER_isOccurrenceNonCAD

The cat_USER_isOccurrenceNonCad function attributes have changed. The root item revision, occurrence, parent BOMView revision, item revision and parent item revision tags have been deleted. A new bom line tag is now the only parameter on which the non-CAD search is performed.

.jar File Names

The name of the Cat2catimancommon.jar file has been changed to Cat2tciccommon.jar and the name of the Cat2savemanager.jar file has been changed to Cat2uimanager.jar.

Journaling

Traces

CATScript and CAA traces are now located in the same journal file. The journal file is enabled by the CATIA_journal_catia preference.

Journal files are located in the named repository for the environment variables; %TEMP% for Windows and $TMP for UNIX. By default, journal files are located in \\temp\\ for Windows and /tmp/ for UNIX, when the environment variables are not created.

Client Traces

Use the CATIA_journal_client Teamcenter Preference to enable the client journaling option. The default value is NO indicating low-level tracing such as hardware configuration and library version is enabled.

JT

Import

JTs can be created during the Import process.


2-155


libcatia _tc_custom Compile Scripts

Sample compile files for libcatia_tc_custom.c/.h have been added to the %TCICV5_DIR%\sample directory.

Localization / Internationalization

Teamcenter Integration for CATIA V5 can be deployed with Client and Servers running in different locales.

For example, Teamcenter Integration for CATIA V5 Client can be installed on a French operating system while Teamcenter Integration for CATIA V5 Server is located in an English environment.

Update Title Block

Existing text within a CATIA drawing can be updated on a 4-Tier Integration installation with Client running in a different locale than the server, according to attribute values. However, the drawing text can only be updated when the client locale is in the same locale as the drawing.

Progress Bar

A new progress bar displays indicating when certain processes, such as Save, Load, Import and Export are in progress; assuring the system is operating correctly and did not crash. It also provides an estimate of completion. Pick Cancel to end the process.

Use TcIC_progress_socket_port within the tcic_var_env.xml file to change the port used for progress indicator communication, if necessary. The default value is 11401. Ensure the port used for the TcIC communication and the progress indicator are different.


2-156


Save density in cgr

An error message now displays and the current process stops when options related to the Save density in cgr CATIA setting have not been set correctly.

Save Manager

The Save Manager has been improved based on Teamcenter display and functionalities. As a result, legacy preferences must be renamed.

New features include:

• mandatory attributes and localization support

• implementation of localized attributes in dialogs

• Teamcenter Create Descriptor used to drive attribute definitions

• extensions to prompt CAD specific attributes

• extended mappings from CATIA properties to the Save Manager

• attribute mapping using the master attribute definitions.

Item, Dataset and Link Type Display Names

The Item Type, Dataset Type and Link Type fields in the Save Manager panel now display names based on Teamcenter localization.

Boolean Properties

Boolean properties (true or false) display for a selected item.

Table Editor

Black arrows display on cells indicating multiple values are present for that property. By default, only the last of these values display in the column. Select the black arrow to view all values associated with this property. It is not possible to select or modify the displayed list of multiple values.

Properties containing lists of values (LOV)

Properties containing lists of values (LOV) display as simple drop-down lists, ranges of selectable values, date ranges, interdependent values and cascading lists. The property's list of values display when selecting the button next to the corresponding field and the type of list depends on permitted value types. For example, when the required value is a date, only the calendar displays when the button is selected.

Preferences


2-157


New preferences have been added to manage the new features of the Save Manager and old preferences have been renamed. Use the new preferences to, for example, control the default behavior of the Auto IDs toggle, the list of properties displayed within the Editor area and the default folder shown in the combo box. Refer to the following sections of the User and Installation Guide for more information.

• Preferences Related to the Save Manager Toolbar (User Guide)

• Preferences Related to the Save Manager Editor (User Guide)

• Configuring Attribute Mappings for the Save Manager (Installation Guide)

• Preferences Related to the Save Manager (Installation Guide)

Old Preference New Preference

SAVEMANAGER_map_item_id CATIA_savemanager_map_ir_item_id

SAVEMANAGER_map_item_rev_id CATIA_savemanager_map_ir_item_revision_id

SAVEMANAGER_map_item_name CATIA_savemanager_map_ir_object_name

SAVEMANAGER_map_item_type_name CATIA_savemanager_map_ir_object_type

SAVEMANAGER_map_item_description CATIA_savemanager_map_ir_object_desc

SAVEMANAGER_map_dataset_id CATIA_savemanager_map_ds_pubr_object_id

SAVEMANAGER_map_dataset_revision CATIA_savemanager_map_ds_rev

SAVEMANAGER_map_dataset_name CATIA_savemanager_map_ds_object_name

SAVEMANAGER_map_dataset_type_name CATIA_savemanager_map_ds_object_type


2-158


Old Preference New Preference

SAVEMANAGER_map_dataset_description CATIA_savemanager_map_ds_object_desc

Save Manager Entry Points

The Save Manager application can be extended by using other plug-ins via the com.ebsolutions.savemanager.extension extension point.

Use this extension point to define pre- and post-actions on buttons in the Save Manager.

Save Manager Java Packages and Classes

The Save Manager Java package has been updated and several Java class have been renamed for Teamcenter Integration for CATIA V5 (9.0.0). Pre-9.0.0 versions of the .xml configuration file are now obsolete.

Review the Save Manager Tutorial to update your code and to the API sections for the java-package-functions-upgradeTcIC900.xlsx file which contains a complete list of the renamed functions and packages

Seed Documents/Seed Dataset Panel

The behavior below applies to seed documents during the following processes:

Load Refresh Insert Read Linked Documents Replace

The seed dataset panel does not display each time a process (above) is performed unless an assembly containing seed documents is already in Teamcenter and the catuii cache directory does not contain an assembly.

If necessary, review and/or purge the catuii contents to ensure it does not contain an assembly containing seed documents so that the seed dataset panel always displays during the processes listed above on an assembly from Teamcenter.

This behavior does not apply to the Load, Update, Save process.


2-159


.TcIC Directory Location

The location of the .TcIC directory, which contains the configuration file, can be changed by modifying the value of TcIC_config_dir in the tcic_var_env.xml file.

The default values are %USERPROFILE on Windows and $HOME on UNIX.

Update Title Block

Attribute mapping can now be used to update text within a drawing. Attribute maps can be defined between a Teamcenter property and a parameter within a CATDrawing, linked to a text.

When the Integration Client is running on a different locale than the Server, drawing text may only be updated when the client locale is in the same locale as the drawing.

User and Installation Guide Documentation

Launch the Documentation

Launch the Teamcenter Integration for CATIA V5 Installation Guide and User Guide by using the CATIA V5 menu or the Documentation button from the Integration toolbar.

Documentation Structure

Review the Locating Information topic of the Using this Document section for specific details on the new structure of the documentation.


2-160


Known Issues

Viewing this Document catuii Size and Impact to Performance DLNames .model ShapeRepresentations and Visualization/Design Mode

Viewing this Document

This document can not be viewed using Google Chrome when the saved locally. All other major browsers are supported.

catuii Size and Impact to Performance

Analyzing the catuii folder make take more time than usual and performance is impacted when catuii reaches a certain size. This limit depends on a combination of many different factors and cannot be documented.

Keeping files in the catuii cache directory helps improve performance when re-loading data from Teamcenter to CATIA; consider the benefits and size of catuii, in terms of performance, before using the Purge function.

DLNames

CATIA Configuration: The Integration fails to execute with CATIA V5 R18 SPx

A change in CATIA behavior introduced in CATIA V5 R18 SPx causes programmatic operations performed on non-DLNames defined as Folder to fail when the Folder option is set to Not Allowed. To resolve this issue, some temporary Integration folders must be configured.

Interactive operations have never been permitted with such configuration.


2-161



Ensure the following temporary Integration folders have been configured as DLNames to use the DLName - Current with Folder - Not Allowed options.

%work_dir%\catuii %work_dir%\tmp %work_dir%\import %work_dir%\export

Working with DLNames when EBS_* Properties have been removed

EBS_* properties inside CATIA files have been removed. In cases when files (and .dat files) have been saved to a different location using Save As and DLNames are used, allow specific folders to match the DLNames for the Integration staging areas.

.model ShapeRepresentations and Visualization/Design Mode

.model ShapeRepresentations are not switched back to Design Mode when an assembly has been manually switched from Visualization mode in CATIA (CATIA Cache is activated) to Design Mode, and then saved in Teamcenter for the first time.


2-162



Attributes Mapping CAA Compilation CAD Environment Management Check In/Check Out Customization Default Mode Documentation Export Import Installer Load Load Merge Selected Level Load, Update, Save LOV Management Mandatory Attributes Multi-model Links Progress Monitor Purge Release Status Save Save As/Revise Save Manager State Details User Interface Update Title Block Visualization

Attributes Mapping


Summary Integration Attribute Mapping doesn't work with CATDrawing 2nd or 3rd level in spec trees.

CAA Compilation


2-163



Summary Error compiling CAA CATIA libraries using special characters in a Spanish windows environment.

CAD Environment Management


Summary Client freezes when the CATIA environment check fails.

Check In/Check Out


Summary Save As, wrong drawing check out.


Summary Cannot check in after saving a CATDrawing.

Customization


Summary Cannot create custom Save Manager toolbar.

Default Mode


Summary Model Files goes to Vis mode from Design Mode.

Documentation


2-164



Summary Documentation not clear about COMMONcatiatojt_ets_ds_types values.


Summary No online help for Teamcenter Integration.


Summary Question about document of Teamcenter Integration for CATIA V5 (8.2.0).

Export


Summary Create Export Spreadsheet hangs.


Summary Wrong values in catimport form.


Summary Cannot export an assembly from Teamcenter when Item Rev name's case is changed.

Import


Summary Import All Spreadsheets is terminated unless data is checked out.


Summary Import Process failure (Spreadsheet).

Installer


2-165



Summary TcUA: Installation Kit: Teamcenter Integration for CATIA V5 (8.2.1)/Teamcenter Integration for CATIA V5 (8.2.1.1) for Tc8.3 are incomplete.

Load


Summary Unable to update a Product with CGRs.


Summary Choice in Save As Existing Item.


Summary Load Products only option.


Summary All lower structures are not loaded.


Summary Change level Indicator attribute is not updated in CATIA properties.


Summary Use standard BOM type for CATIA data.



Summary Load Merge Selected Level on rigid foreign sub-assembly results wrong positions under flexible sub-assembly.

Load, Update, Save


2-166



Summary A round-robined assembly displays as modified when loaded into CATIA.

Localization


Summary Part number map itemrev revision does not work when TC_LOCALIZATION_DIR to CN.

LOV Management


Summary LOV for the Integration Save dialog.

Mandatory Attributes


Summary Mandatory attributes can be bypassed using the Integration.


Summary Expose attribute under the CATpart tab property listing?


Summary TC Eng mandatory attributes vs Integration


Summary Revision Name LOV does not appear in the Integration Save Manager


Summary Add an attribute Item unit in the Save Manager.


2-167



Summary The Integration does not enforce the user to enter those attributes.


Summary The Integration needs to populate required form fields.


Summary Required Field not indicated as required on input screen.

Multi-model Links


Summary The Integration does not support KWE_REFERENCE link.

Progress Monitor


Summary Cancel-/STOP-Functions-Button in the Integration.


Summary In HP, the Integration Save panel's "Save/Cancel" button does not have the correct shape.

Purge


Summary Purge doesn't remove part files when they are replaced.

Release Status


2-168



Summary Not able to Save released CATProduct with dba bypass rights.


Summary Not able to Save released CATProduct with dba bypass rights.

Save


Summary CATIA and Tc8: Saving V5 Parts without a description.

Save As/Revise


Summary Creation of object under CATProduct is not working with Save As/Revise.

Save Manager


Summary Teamcenter Integration for CATIA V5 (8.0.3) Save Manager check out.


Summary Flow for Revising should be more automated.


Summary Save Manager - browse to the destination folder.


Summary Auto assign Revision ID when using the Integration.


2-169



Summary Teamcenter Integration for CATIA V5 (8.0.3) Save Manager check out.

State Details


Summary The Integration should display all release states.

User Interface


Summary Teamcenter Save Manager dialog in the Integration does not stay on top of CATIA.

Update Title Block


Summary Update_Title_Block does not work.

Visualization


Summary Increase in assembly JT version number on the Integration Save.


Summary Flex assembly loses its position in JTViewer.


2-170





CATIA V4/V5 Compatibility

Teamcenter Integration for CATIA V5 (8.3.4.1) is compatible with Teamcenter Integration for CATIA V4 (8.3.4).

Known Issues

There are no known issues in this version of the Integration.


Load


Summary Teamcenter Integration for CATIA V5 (8.3.3) for Teamcenter 9: wrong desc.xml file with respect to Teamcenter Engineering 2005.


2-171





CATIA V4/V5 Compatibility CATIA V5-6R2012 Support CATIA V5 Menu in Design Context Mass Properties Form Red Hat Enterprise Support Save As/Revise: Import Form Linked by a GRM Relation Teamcenter Support



CATIA V5-6R2012 Support

CATIA V5-6R2012 is supported on Windows 32 and 64-bit platforms only. AIX CATIA V5 R22 is not supported even if an AIX SERVER installer has been provided.

CATIA V5 Menu in Design Context

The CATIA V5 menu is now available in Design Context.


2-172


Mass Properties Form

The Mass Properties form has been improved:

• Precision: Previously, the Precision field indicated the number of significant digits to display. It now indicates the number of digits to display after the decimal separator.

• Form Values: The Inertia moment, Gravity center, Inertia product, Min. point and Max. point values on the Mass Properties form now display their corresponding axis labels.


2-173


Red Hat Enterprise Support

This version supports Red Hat Enterprise Linux 5.4. Refer to Known Issues to resolve an issue with Red Hat and the Save process.

Save As/Revise: Import Form Linked by a GRM Relation

Set the new preference, CATIA_apply_post_action_on_import_form, to true, to perform a post-action on the import form linked by GRM relation when performing a Save As or Revise operation. By default, this preference is false, indicating import forms are not managed.

The CATIA_apply_post_action_on_import_form and CATIA_create_OEMForms_option preferences should be set to the same value so that the Save As/Revise behavior from CATIA and Teamcenter is consistent.

Teamcenter Support

This version supports Teamcenter 8.3 and 9.1 (Server and Client)

Known Issues

2-174


Linux Red Hat Support

Using a Red Hat Save process may lead to an action cancelled message. Modify the FSC property file to avoid this issue.

1. Uncomment 

2. Modify the value of FSC_MaximumIdleFileHandleAgeMs to a value lower than 100.


Attributes Mappings Character Encoding Check In/Out Documentation Export Import Load Load, Update, Save Locallization Mass Properties MML Link Refresh Save State Details Uninstallation

Attributes Mappings


Summary DB_UNITS mapping incorrectly with the Integration's load to CATIA V5.

Character Encoding


2-175


Summary Integration error when handling special characters in names.

Check In/Check Out


Summary Automatic confirmation of check in is not working with the Integration (Save Manager).

Documentation


Summary Integration installation documentation - WORK_DIR is case-sensitive.

Export


Summary Implicit scripting engine error during export.

Import


Summary Teamcenter revise troubles, Integration spreadsheet creation for import.


Summary MSKCatalog.CATfct Errror when importing CATIA to ENOVIA.

Load



2-176


Summary Load merge (target + selected level) works on default RevRule.


Summary Change in dataset type from CATProduct to CATPart leads to wrong PS in CATIA.


Summary Teamcenter Integration for CATIA V5 data fails to load on second load on AIX.


Summary Subassembly's positioning incorrect after upgrade to Teamcenter8/Teamcenter Integration for CATIA V5.

Load, Update, Save


Summary Silent LUS does not work, but works from UI.

Localization


Summary Some dialog messages shown in English in Japanese environment.

Mass Properties


Summary The Integration's Teamcenter display name changes on the Mass Properties form.


Summary Precision is shown incorrectly; CATIA mass properties.


2-177


MML Link


Summary CCP Link appears to be broken for public user.

Refresh


Summary The Integration's Refresh using default Revision Rule.

Save


Summary Design Table dataset gets deleted in Teamcenter when the Integration Save fails.


Summary Cannot Save tubing assembly with different runs and same product specific name.


Summary Crash of Teamcenter when saving CATIA data.


Summary CATDrawing links are not updated in Teamcenter.


Summary Server invocation failed error when using save as with the Integration.


Summary The Integration was not able to update the MMLAssy link in Teamcenter after revise of the source part.


2-178



Summary Teamcenter Integration for CATIA V5: no BOM creation.


Summary Teamcenter (tcserver) crash when trying to save an assembly.


Summary Datasets are duplicated when using .cgr files.


Summary Cannot save CATproducts in Teamcenter.


Summary The Integration is crashing during the Save process when Save Mass Properties is on.


Summary Save the part with item name REINF_IP_PARTS_BRACKET_¢ñ will cause system crash.


Summary Flexible definition is gone after save process.


Summary The Integration saves to the user file rather than the staging directory.


Summary Unable to save CATIA V5 drawing to Teamcenter.


Summary The Integration saves Ignode Node catiaParentPartName to instances ordered after in tree.

State Details


2-179



Summary Warning message shown before Detail Status dialog starts.

Uninstallation


Summary Silent uninstall for Integration.


Summary Teamcenter Integration for CATIA V5 (8.3.3) for Teamcenter 9.1 uninstall problems on windows platforms.


2-180





CATIA V4/V5 Compatibility Load JT datasets from NX System Prerequisites/Support Windows Installation


Teamcenter Integration for CATIA V5 (8.3.3) is compatible with Teamcenter Integration for CATIA V4 (8.3.2.1) - (8.3.3).

Load JT datasets from NX

By default, JT file names are created with the Named Reference; JT datasets created with NX have the same Named Reference leading to revision conflicts during Load processes.

Customize default behavior to load JT datasets created with NX by setting the DirectModel dataset type in CATIA_component_dataset_types and the CATIA_rename_jt_from_nx preference to true. In this case, the cat_USER_buildJTFromNXFilename ITK entry point function is called to build a unique filename for each JT dataset.

The customized filename is built based on the value of CATIA_foreignfile_file_name_format unless the entry point has been customized.

System Prerequisites/Support

Teamcenter Integration for CATIA V5 (8.3.3) supports Teamcenter 8.3 and 9.1.

Windows Installation


2-181


Teamcenter Integration for CATIA V5 WIN32 contains Integration libraries compiled for Teamcenter 32-bit. Teamcenter Integration for CATIA V5 WIN64 contains Integration libraries compiled for Teamcenter 64-bit.

Known Issues

License User Management

It is recommended to use License User Management (LUM) version 4.6.8.13 (at minimum) to improve the time to start a batch CATIA session while directly impacting the Integration's Save performances when Mass Properties are computed.


Analysis Attribute Mapping Check In/Out Detail States Documentation Installation JT Translation Load Mass Properties MML Browser Save Update TitleBlock

Analysis


Summary Problem with Teamcenter Integration for CATIA V5 on saving CATIA Analysis files with Computations and Results.

Attribute Mapping



2-182


Summary Unable to map custom attributes in Teamcenter Integration for CATIA V5.


Summary Integration attribute mapping does not work with CATDrawing 2nd or 3rd level in spec tree.

Check In/Out


Summary CATCache dataset is incorrectly checked out in from CATIA toolbar of the Teamcenter Integration for CATIA V5 (8.3.2.1).

Detail States


Summary Message for saving Linked Document shown during Update Status.

Documentation


Summary Information about CATAnalysis file name is wrong in the Integration's documentation.

Installation


Summary Unable to create Teamcenter Integration for CATIA V5 (8.3.2) CATIA Distribution Server Instance on AIX Server.

JT Translation


2-183



Summary Misleading window submitting JT translation from the Integration.

Load


Summary Load of filtered product results in wrong occurrences in CATIA V5.


Summary Integration released parts show as Modified and it is impacting DesignTable creation.


Summary Can not load assembly if multiple parts contain same Design Table.


Summary Wrong message displayed at revision conflict Action canceled: end of command.


Summary Integration's Modify flag is on after open CATDrawing.


Summary Load to CATIA, conflict replacing before and after object.


Summary Integration Revision Conflict error message goes to background.


Summary Loading CATIA assembly causes Teamcenter to hang.

Mass Properties


2-184



Summary CATIA-Display of MCI data in the CAD Calculated form is incorrect.


Summary Inertia Cross Products (Ixy,Iyz,Izx) are incorrectly calculated.

MML Browser


Summary Integration MML Browser shows wrong results when using CAT part alignment.

Save


Summary The Integration hangs when we try to create drawing auxiliary files for a multi-sheet drawing.


Summary After Revise, the old MML'S are not getting removed from MML folder.


Summary Issue with saving drawings in Teamcenter (V5 to V5 migrated).


Summary CATIA crashes when saving/loading a drawing with a large mapped property.


Summary Crash of CATIA after the Integration final Save Panel.



2-185


Summary Saving catalog parts via the Integration to Teamcenter.


Summary CATIA CRASH with error during command java.net.SocketException:Connection reset.


Summary Teamcenter status in the Integration Save Manager does not appear in Japanese locale.


Summary geo_desc file is not created while Import from the Integration.


Summary New Integration version causes server crashes.

Update Title Block


Summary Update Titleblock is not taking custom attributes from type float, int and bool.


2-186






Teamcenter Integration for CATIA V5 (8.3.2.3) is compatible with Teamcenter Integration for CATIA V4 (8.3.2.1).

Known Issues

There are no known issues associated with this version of the Integration.


Attribute Mapping Browse MML JT Translation Load Mass Properties Read Linked Documents Revise Save

Attribute Mapping


Summary Integration attribute mapping :tcserver crash with empty date.

Browse MML


2-187



Summary Different up to date status in Multi-model Links Browser.

JT Translation


Summary Misleading window submitting JT translation from the Integration.

Load


Summary Load Merge Selected Level does not activate default ShapeRep.


Summary Users spend too much time to load huge CATProduct to CATIA using the Integration.


Summary Partial SM load selection to CATIA causing item modification.

Mass Properties


Summary Inertia values are different with CATIA measure inertia values.


Summary Cannot delete the item after Update assembly mass properties.



2-188



Summary Can not see CATIA data which is already open.

Revise


Summary After Revise, also the older Revision of the subassembly is linked.

Save


Summary The modification of a part number parameter has failed error message in CATIA.


Summary Cannot Save CATProduct under CATDrawing item type.


Summary Saving New CATIA V5 assembly with SecondaryPart in main and Ignore Node crashes.


2-189






Teamcenter Integration for CATIA V5 (8.3.2.2) is compatible with Teamcenter Integration for CATIA V4 (8.3.2.1)

Known Issues

There are known issues associated with this version of the Integration.


Export Load Save

Export


Summary A huge assembly cannot be exported using the Integration.

Load


Summary Significant unjournaled time impacting server performance during Load.


2-190


Save


Summary Integration Save performance issue.


2-191





Compatibility Converting Thumbnails via DispatcherServices Teamcenter Contextual Menu

Compatibility

This release is compatible with Teamcenter Integration for CATIA V4 (8.3.2.1).

Converting Thumbnails via DispatcherServices

Define the volume used to store thumbnail visualization data files.

Set the new preference, CATIA_thumbnails_store_file_in_source_vol, to store thumbnail visualization data files for a source dataset in the same volume as the associated source dataset data files.

This preference is true, by default, indicating thumbnail visualization data files for a source dataset are stored in the same volume as the associated source dataset data files.

Teamcenter Contextual Menu

The Teamcenter contextual menu for external references has been temporarily disabled due to PR 2178627: Replace function does not exist in the Integration environment.


2-192


Known Issues

Dynamic Seeds Teamcenter Contextual Menu

Dynamic Seeds

PR 6583950: All Sub-products Display as Modified after a Load, Update, Save is Performed Using Dynamic Seeds

This issue can only be reproduced using dynamic seeds; it does not apply to regular seed documents.

Prerequisite: No seed documents exist in the database

Steps to reproduce:

1. Create the following structure in Teamcenter.

2. Attach CATProduct datasets and BOM view for A1,A2,A3,A4 and CATPart datasets for P1,P2,P3,P4.

3. Save the structure in Teamcenter then perform a Load, Update, Save.

4. After the Load, Update, Save process finishes, Load A1 into CATIA from Teamcenter.

Result

All CATProducts display as Modified in CATIA, except the top level.

Teamcenter Contextual Menu

The Teamcenter contextual menu for external references has been temporarily disabled due to PR 2178627: Replace function does not exist in the Integration environment.

Description


2-193


The Replace function displays in the default CATIA pop-up menu, but not in the Integration environment when selecting external references and sub-surfaces when CATIA is opened from the Integration.

Steps to reproduce

1. Load the Integration.

2. Pick Tools > Options > Part Infrastructure > General tab.

3. Toggle Keep link with selected object on.

4. Add a new Part at Product1.

5. Design the box at Part1.CATPart.

6. Select the surface of Part1 then pick Tools > Publication.

7. Pick Yes, then pick OK.

8. Add a new Part2 CATPart.

9. Select Part2, then pick Insert > Surface-Based Feature > Thick Surface?.

10. Select the face of Part1, then pick OK.

Result:

The Replace function does not display in the pop-up menu of the external reference or sub-surface.


2-194



Create Spreadsheet Double-byte Support Export JT Translation Load Save

Create Spreadsheet


Summary CreateSpreadsheet in Teamcenter Integration for CATIA V5 takes too long.

Double-byte Support


Summary On Chinese OS, Teamcenter Server crashes when loading item to CATIA using Teamcenter Integration for CATIA V5 (8.2.3).

Export


Summary Performance of exporting assembly in Teamcenter Integration for CATIA V5 (8.3.2.a) is very low.

JT Translation


Summary Incorrect Dispatcher Requests.


2-195



Summary Integration translators store data in incorrect volume.

Load


Summary Unable to Load CatiaV4.model in Teamcenter Integration for CATIA V5 (8.3.0).


Summary CATIA V4 drawings will not open when opening from CATIA V5 menu; Invalid selection

Save


Summary CATIA crashes using customer specific CATIA settings.


Summary Regarding save performance.


2-196





Best Practice and Troubleshooting Sections CATIA V4/V5 Compatibilty CGMs and CATDrawings Design Tables JT Conversion Messages Secondary Parts Teamcenter Support

Best Practice and Troubleshooting Sections

The Teamcenter Integration for CATIA V5 User Guide now contains two new sections, Best Practices and Troubleshooting.

The Teamcenter Integration for CATIA V5 Installation Guide now contains a Troubleshooting section.



CGMs and CATDrawings

CGMs are not configured for CATDrawings, by default.

Configure auxiliary files to save a CGM for a CATDrawing. It's recommended to use DrawingSheet datasets to store CGMs in Teamcenter, so that CGMs are visible in the Teamcenter

Design Tables


2-197


Use the new preference, CATIA_manage_designtables, to customize Design Table management.

This preference is true, by default, indicating Design Tables can be saved and loaded. Set this preference to false to prevent some processes from being applied to Design Tables.

JT Conversion Messages

The JT Conversion process dialog box has been enhanced to provide additional statuses when conversion occurs using Dispatcher Services and scripts.

Secondary Parts

The cat_USER_secondary_parts_info ITK function has been improved.

CATIA original FileNames and PartNumbers can now be retained, rather than using the default Teamcenter Integration for CATIA V5 naming convention.

Teamcenter Support

Teamcenter Integration for CATIA V5 (8.3.2) supports Teamcenter 8.3 and Teamcenter 9.

Known Issues

Catuii Size and Impact to Performance CATIA V5 R20 SP5 and Load Performance DLNames Dynamic Seeds Saving Secondary Parts

Catuii Size and Impact to Performance

Analyzing the catuii folder make take more time than usual and performance is impacted when catuii reaches a certain size. This limit depends on a combination of many different factors and cannot be documented.

Keeping files in the catuii cache directory helps improve performance when re-loading data from Teamcenter to CATIA; consider the benefits and size of catuii, in terms of performance, before using the Purge function.


2-198


CATIA V5 R20 SP5 and Load Performance

CATIA V5 R20 SP5 causes major performance issues during the Integration's Load process. This problem has been resolved with CATIA V5 R20 SP6 (minimum).

It's recommended to use the SP6 version (minimum) for R20 to prevent Load performance issues linked to CATIA V5.

DLNames

CATIA Configuration: The Integration fails to execute with CATIA V5 R18 SPx





• %work_dir%\catuii

• %work_dir%\tmp

• %work_dir%\import

• %work_dir%\export

Working with DLNames when EBS_* Properties have been removed

EBS_* properties inside CATIA files have been removed. In cases when files (and .dat files) have been saved to a different location using Save As and DLNames are used, allow specific folders to match the DLNames for the Integration staging areas.

Dynamic Seeds

PR 6583950: All Sub-products Display as Modified after a Load, Update, Save is Performed Using Dynamic Seeds

This issue can only be reproduced using dynamic seeds; it does not apply to regular seed documents.

Prerequisite: No seed documents exist in the database


2-199


Steps to reproduce:

1. Create the following structure in Teamcenter.

2. Attach CATProduct datasets and BOM view for A1,A2,A3,A4 and CATPart datasets for P1,P2,P3,P4.

3. Save the structure in Teamcenter then perform a Load, Update, Save.

4. After the Load, Update, Save process finishes, Load A1 into CATIA from Teamcenter.

Result

All CATProducts display as Modified in CATIA, except the top level.

Saving Secondary Parts

PR 6582074: Save As in Teamcenter Does Not Update Secondary Part Named Reference

Steps to reproduce:

1. Create a new product with a few parts.

2. Edit one or two part descriptions to create secondary parts.

3. Save the product to Teamcenter.

4. Close All and Purge.

5. Select the product from Teamcenter and save it as a new item.

6. Load the new product into CATIA from Teamcenter.

7. Save the assembly.


2-200


Result

The top level is updated to Latest. The secondary part has also been saved, but the original name remains unchanged and causes a revision conflict message to display when attempting to load the original and perform a Save As assembly into the session.


CreateSpreadsheet Design Table Drawing Sheet ETS Export Import Insert License Management Load Purge Refresh Replace Load as cgr Save Secondary Part

CreateSpreadsheet


Summary CreateSpreadsheet in Teamcenter Integration for CATIA V5 takes too long.


Summary Creation of spreadsheet from CATDrawing failed.


Summary Teamcenter server process hangs when a query result is very large.


2-201


DesignTable


Summary Option Not to Save Design Tables.

DrawingSheet


Summary Can not open CATcgm file from Teamcenter Rich Client.

ETS


Summary JT Conversion Process window shows, but should not.

Export


Summary Error Teamcenter Server is not available - another Server is assigned.

Import


Summary Can't specify new Name when revising with spreadsheet import.


Summary Silent import, login information.



2-202


Summary CATIA V5 assembly Import failed with a specific pair of assemblies.


Summary CATIA assembly Import failure with a long instance name.

Insert


Summary Insert does not load CGR but CATPart.

License Management


Summary catia_manager license Tc8.3.0.3. Save As process consumes license.

Load


Summary Not able to load assembly from structure Manager in My Teamcenter.


Summary It lacks BOM structure of imported CATIA data.


Summary Different behavior between Teamcenter Integration for CATIA V5 (7.1.0) and Teamcenter Integration for CATIA V5 (8.3.0) with the same data and operation.


Summary Inconsistent behavior on load to CATIA.


2-203



Summary Previously loaded data in V5 deactivated with Load Merge, Insert, Refresh.

Purge


Summary Documentation of scenarios on when to use the Purge function are missing.


Summary Steps required after recovering and restoring files from Backup dir after purged.

Refresh


Summary Refresh is causing the name of CATIA V4 data loaded in CATIA V5 to be modified.

Replace Load as CGR


Summary Integration Variant Rule is ignored on Replace Load as cgr.

Save


Summary Error messages are not displayed in the Integration.



2-204


Summary Save the part with item name REINF_IP_PARTS_BRACKET_¢ñ will cause system crash.


Summary Issues with the Integration.


Summary Teamcenter Integration for CATIA V5 breaks out of the box IMAN_Rendering Deep Copy Rule.


Summary Save with option Check-in after Save is not working properly.


Summary Integration's Save error message is not informative.


Summary Saving of CATIA data failed with java.net.SocketException.

Secondary Part


Summary API support to retain original file and partnumber for Secondary parts/products.


2-205





CATIA V4/V5 Compatibility Operating Systems



Operating Systems

Teamcenter Integration for CATIA V5 (8.3.1.4) is for the Windows platform only.

Known Issues



Load


Summary Integration Attribute Mapping :tcserver crash with empty date.


2-206







Known Issues



CGR Management on Load


Summary Teamcenter Integration for CATIA V5 (8.3.1.2) does not download CGR files from Teamcenter. .


2-207





CATIA V4/V5 Compatibility Replace Load as cgr



Replace Load as cgr

The Replace Load as cgr command is phase 2 of the Load as cgr command, introduced in Teamcenter Integration for CATIA V5 (8.3.1.1).

Use the new command, Replace Load as cgr from the Integration toolbar, to replace a CGR component loaded with the Load as cgr option, with the corresponding CATPart from Teamcenter.

Known Issues



2-208



Export Spreadsheet Refresh Save

Export Spreadsheet


Summary Creation of spreadsheet from CATDrawing failed.

Refresh


Summary Refresh is causing the name of CATIA V4 data loaded in V5 to be modified.

Save


Summary Save with the Check-in after Save option is not working properly.


Summary Source parts modified after making minor change to a Drawing.


2-209





CATIA V4/V5 Compatibility Dynamic Seeds Load as cgr



Dynamic Seeds

Dynamic Seeds are seed documents that are created on-the-fly by CATIA, during the Integration's Load process, when a seed document Named Reference does not exist for the item defined for seed processing.

Dynamic Seed documents can be CATProducts, CATParts, CATDrawings, CATProcesses and CATAnalysis files. They are managed during the Save processes (except the Import process), Check In/Check Out, State Details and Update Status processes.

Using Dynamic Seeds during the construction of large assembly structures requiring a lot of seed documents (items without a dataset or items with a dataset and without a Named Reference) provides better performance than using seed documents exported by Teamcenter.

Loading items without a Named Reference in its dataset is permitted when the Manual input Part Number option is not selected on the Options dialog, even when a Named Reference does not exist for the seed document in the Teamcenter database. In this case, Dynamic Seeds are used.


2-210


Due to a CATIA limitation, it is not possible to have Dynamic Seeds for a CATDrawing and activate Auxiliary Files, in combination.

Load as cgr

A third option, Load as cgr, has been added to the CATIA V5 menu to improve performance during the Load process.

Use this option to load CGR components without their geometry files (CATPart, model, etc.) when loading from Teamcenter into CATIA.

This option must be activated and can be automatically toggled on and off using the Load as cgr preference. Use an entry point to customize the criteria used to determine when a cache dataset is valid for a Load as cgr process.

Known Issues



2-211



Convert to JT Installation and Configuration Load

Convert to JT


Summary Updating the CATIA part, the JT file is not getting updated.



Summary Teamcenter Integration for CATIA V5 (8.3.1) CAA compilation ends with errors.

Load


Summary CATIA file name mismatch before and after the Integration Save process.


Summary Partial Load takes too long to open in CATIA V5.


2-212





CAA Entry Point CATIA V4/V5 Compatibility Compile CAA/ABC License Support Dispatcher Services Ignore Nodes Packed Lines Uppercase Setting

CAA Entry Point

A new CAA entry point, CV5ICAAEntryPoints::entryPointBeforeLocalSave function has been created and can be used to customize Save processes before saving the CATIA document in the staging directory.


Teamcenter Integration for CATIA V5 (8.3.1) is compatible with Teamcenter Integration for CATIA V4 (8.3.1)

Compile CAA/ABC License Support

ABC License can now be used to compile CAA with Teamcenter Integration for CATIA V5 (8.3.1).

Dispatcher Services

Teamcenter Integration for CATIA V5 now supports Dispatcher Services.

When Dispatcher components and services are installed and Teamcenter Preferences are set correctly, CATIA files are sent to the Dispatcher when picking the Create JT option on the Save Manager, or by picking the Convert to JT option within the CATIA V5 Teamcenter menu.


2-213


It is now possible to send files to any translator which has been properly configured.

The CATIA_ETS_translation_services Teamcenter Preference contains the list of Dispatcher Services name preferences that can be called in the Convert Items to JT process.

Use the ETS_trans_rqst_referenced_dataset_types preference to specify which CAD dataset type names can be referenced by translation requests as primary or secondary objects. A pre-delete action is registered for each of the defined dataset types to support CAD data deletion while a translation is in process. Add the dataset types to be managed via Dispatcher to the preference's value, including the dataset type for converting foreign files.

Ignore Nodes

Set the new preference, CATIA_ignorenode_instance_description, to define ignore nodes.

In Teamcenter Integration for CATIA V5 (8.3.0), an occurrence which is not a broken icon is an ignore node when the part number, file name or instance name begins with a keyword defined in the IgnoreNodesIdentifiers.txt file.

A broken icon is an ignore node when the instance name begins with a keyword defined in IgnoreNodesIdentifiers.txt or when the instance description begines with the keyword, IgnoreNode. These rules continue to be preserved in 8.3.1 when CATIA_ignorenode_instance_description is not defined or set to false (default). Review the table below to change this behavior.

Value of CATIA_ignorenode_instance_description

An occurrence, which is not a broken icon, is defined as an ignore node....

false (default) when the part number, file name or instance name begins with a keyword defined in the IgnoreNodesIdentifiers.txt file

true

when the part number, file name or instance name begins with a keyword defined in the IgnoreNodesIdentifiers.txt file OR when the instance description begins with the IgnoreNode keyword.

For example, an assembly, Prod(part), is created in CATIA with IgnoreNode as the part's instance description. When saved to Teamcenter, only Prod displays in the Save Manager and is saved to Teamcenter when the CATIA_ignore_node_instance_description is set to true.


2-214


Packed Lines

Use CATIA_check_packed_lines to define how packed lines or lines with parent packed lines are managed when loading from the PSE. Available values are WARNING (default), NONE, and ERROR.

Change the value of this preference to display a warning message, an error message or no message at all when loading packed lines (or lines with parent packed lines) from the PSE.

Uppercase Setting

Teamcenter Integration for CATIA V5 (9.0.0) supports uppercase file names during the Save and Load from CATIA processes.

Known Issues

Configuration Issue Error Message/Launching CATIA Session

Configuration Issue

CATIA_component_dataset types

When several datasets use the same Named Reference type, unexpected results may occur due to a limitation in Teamcenter Integration for CATIA V5 (8.3.1).

For example, CATCache and CATShape share the same Named Reference, catshape. In this case, CATCache must not be defined in the CATIA_component_dataset types preference when CATshape has already been defined in this preference.

Error Message/Launching CATIA Session

The error message, error detected while trying to get a running CATIA session.ActiveX component, can't create object, displays when attempting to launch a CATIA session. This error message is the result of a configuration issue in CATIA.


Reinstall CATIA or perform the following steps:

1. Login as administrator (even if you are in an administrators group).

2. Open a cmd prompt, then go to (cd) the install directory, BXX\intel_a\code\bin.


2-215


3. Run catstart -run "cnext /regserver".


Convert to JT Customization Documentation Export Installation and Configuration Load Purge Staging Directory Save

Convert to JT


Summary Not creating correct Dispatcher request from Save Manager Dialog.

Customization


Summary The Integration user exit is not working, userExitAfterAllImportedFiles.


Summary Entry point for custom processing in CATIA prior to saving files in Teamcenter.

Documentation


Summary Teamcenter Integration for CATIA V5 (8.3.0) documentation regarding userExit.


2-216



Summary 64bit install of rich client puts wrong version of CATIA CAA.

Export


Summary Export error in Teamcenter Integration for CATIA V5 (8.3.0).



Summary Installation kits for Teamcenter Integration for CATIA V5 (8.2.1) / (8.2.1.1) for Teamcenter 8.3 are incomplete.

Load


Summary Error while loading a CATProduct with inserted component.


Summary Missing components when loading an assembly from Teamcenter to CATIA.


Summary CATIA hangs when loading during specific scenario.


Summary Position is not preserved during partial load.



2-217


Summary Packed parent should not make the Load to CATIA process fail.


Summary Load to CATIA fails with secret occurrence and non-CAD parts.


Summary Moderately sized CATIA assemblies take two hours to Load.


Summary The Integration is not handling .cgrs correctly on machines in a diffent time zone.


Summary Load Merge changes CATIA/DMU tree naming conventions.


Summary Teamcenter Integration for CATIA V5 (8.3.0) does not refresh .cgr datasets before Load.

Purge Staging Directory


Summary Purge does not remove part files when they are replaced.

Save


Summary The Integration hangs when aux .pdf files is set on with specific CATIA settings.


Summary TCIC_830 Action canceled : end of the command [using Display Rule].



2-218


Summary Teamcenter Integration for CATIA V5 (8.3.0) JT dataset is also checked out when CATpart is checked out from the toolbar.


Summary Thumbnails are not working with the Integration's Save.


Summary Increase in Assembly JT version number during Save to Teamcenter.


Summary CATIA UNDO is not reset after Save to Teamcenter.


Summary When saving PLL3G01090100X3753 Named Reference is not being created on Rev change.


Summary Save from CATIA after Save_As in Teamcenter has wrong result.


Summary Integration Ignore Node capability; add component description field.


Summary Save_As from CATIA does not save secondary files.


2-219





CATIA V4 Datasets During Save As/Revise Process CATIA V4/V5 Compatibility Compute Geometry for the Main Body Convert CATProducts to JT Display Specific Relations Forbidden Characters/JT Translation Foreign Files Import Form Icons in the CATIA Specification Tree Integration Toolbar Changes Legacy Factor: Units of Measurement Non-CAD Management Extensions MML Browser Refresh Preferences Preference Category: Integration.CATIA Save Manager Developer Guide Silent Mode: Export/Load, Update, Save System Prerequisites/Support The Teamcenter Context Menu Translation Services The Update Status Command

CATIA V4 Datasets During the Save As/Revise Process

CATIA V4 datasets are managed during the Save As/Revise process when its type is listed in the CATIAMANAGERV4_dataset_types_list Teamcenter Preference list and has a catia Named Reference type.



2-220



Compute Geometry for the Main Body

Compute Mass Properties and Material for the main body only when the new preference CATIA_compute_geometry_for_main_body is set to true. Set it to false to compute Mass Properties and Material for all bodies of the part.

Convert CATProducts to JT

CATProducts and V4 files can be converted to JT files via ETS or the catia2jt script. When converting a CATProduct, define what's used in the CATProduct conversion by setting the value of the new CATIA_convert_to_jt_with_product preference to ASR, SP, CSR. This preference is empty, by default.

Value of CATIA_convert_to_jt_with_product Result

ASR Convert the product with its default Alternate ShapeRepresentation

CSR Convert the product with its default component ShapeRepresentation

SP Convert the product with its secondary parts and secondary products

The catiav5tojtdirect service must be installed to convert a CATProduct via ETS. When converting a V4 file via the script, verify if the translator used can convert V4 files. For example, there is no Siemens Translator to convert V4 models into JTs on Windows. If CATParts are already configured to convert toJTs, remove CATProduct from the COMMONcatiatojt_ets_ds_types preference to prevent CATProducts from being converted to JTs.


2-221


Display Specific Relations

Beginning with Teamcenter 8, a combination of Teamcenter preferences and BMIDE configuration (using a template) is required in order to enable the display and navigation of objects using specific relation types in MyTeamcenter.

Beginning with Teamcenter Integration for CATIA V5 (8.2.0), the Integration performs the necessary BMIDE configuration; it is only necessary to define Teamcenter preferences to enable the display of specific relations.

Template collisions will occur between a custom BMIDE configuration template and the Teamcenter Integration for CATIA V5 template, versions 8.2.0 and later.

Forbidden Characters/JT Translation

Forbidden characters are replaced by _ during the JT translation process when the specific character is defined in a forbidden characters list.

For example, during the JT translation process, HagelinPinWheel-1-2-3.CATPart becomes HagelinPinWheel_1_2_3.JT, when the forbidden characters list contains the - character.

The Integration contains a list of default forbidden characters. Customize this list as necessary to ensure successful JT translations.

Translation Method List Location Key

.catia2jt Cat2catimancommon.jar located in %TC_POTAL_ROOT%\plugins. Edit the resulting com/ebsolutions/catiman/catiman.properties

jt.BadChars .catiav5tojtdirect Cat2DSTransJT.jar located on the Teamcenter Dispatcher Server machine. Edit the resulting com/ebsolutions/cat2dstransjt/cat2dstransjt.properties

.catiav4tojtdirect Cat2DSTransJT.jar located on the Teamcenter Dispatcher Server machine. Edit the resulting com/ebsolutions/cat2dstransjt/cat2dstransjt.properties


2-222


The JT translation process fails when the translator encounters a character that has not been defined in the forbidden characters list.

Foreign Files

A component leaf with only one ShapeRepresentation is saved or imported as a foreign file. This foreign file becomes an independent item in Teamcenter.

A new preference, CATIA_manage_foreignfiles_on_save, has been created to improve management of foreign files during the Save, Import/Export, State Details, Check in/Check out and Save As/Revise processes.

Set this preference to true to manage foreign files during a Save or Import process as an independent item.

A specific query must be defined for importing foreign files when this preference is set to true.

Prerequisites when CATIA_manage_foreignfiles_on_save is set to true.

• Modify mapping.

• catia_doc_attributes must be added to the dataset.

Other new preferences related to foreign files have been created. Review the Preferences section of this document for details.

Import Form

Import forms were managed as a Named Reference to the dataset in previous versions of Teamcenter Integration for CATIA V5. Beginning with Teamcenter Integration for CATIA V5 (8.3.0), import forms are now managed using a customizable GRM Link, CATIA_importform_link_type, and as a result:

• Import queries for CATProduct, CATPart, CATDrawing and CATDesignTables must be changed when installing the 8.3.0 version of the Integration.

• Named Reference (catimportform) must be replaced by GRM (catia_import_form_link) for attribute mapping.

An example of an import query can be found in TcIC_DIR\sample\ImportExport, and an example of the new attribute mapping field can be found in TcIC_DIR\sample\ImportExport.


2-223


Modify new import form preference, CATIA_importform_link_type, to permit users to modify the import forms even when the dataset is released or read-only.

Icons in the CATIA Specification Tree

Two new icons, and display in the CATIA specification tree. These icons automatically display when the CATIA_manage_status_in_catia_tree preference is true. They can also display when the new command, Update Status, is selected from the Integration toolbar.

These icons indicate:

• : if the document can be saved in Teamcenter by the current user

• : if an occurrence is:

• a non-configured BOM line

• not loaded due to a Teamcenter configuration.

Rules and Behavior

The status icons can be applied only on CATProducts, CATParts (primary and secondary) and foreign files.

Integration Toolbar Changes

Five Different Toolbars

The Integration toolbar now comprises five different toolbars.


2-224


Insert

The Insert icon on the Integration's Load toolbar has been replaced with a new icon.

Select Checked-out Elements

The Select Checked-out Elements icon, shown below, has been removed from the toolbar.

Update Status

A new command, Update Status , has been added to the Integration's Utility toolbar.

Legacy Factor: Units of Measurement

The legacy measurement unit used by the CATIAV4_legacy_factor preference has been changed to meters to correspond with the unit used in Teamcenter Integration for CATIA V4. Previously, the unit was millimeters. The new default value is .001.

Non-CAD Management Extensions

Previously, non-CAD was based on characteristics of the configured item revision for parts and/or assemblies, when enabled. All occurrences of a given item revision were either CAD or non-CAD. A non-CAD item or instance was not loaded after the load process and was not deleted in Teamcenter during the save process.

A new entry point, cat_USER_isOccurrenceNonCAD, has been created for the Load and Save process to provide the ability to treat product structure occurrences in Teamcenter as non-CAD, even when CAD exists. Use this entry point to define when one or more specific occurrences will be loaded, and others will not.


2-225


MML Browser Refresh

The session values (family, state, depth and zoom) of the MML Browser window toolbars are now retained when refreshing the MML Browser window (View >> Refresh Window).

Preferences

CATAnalysis Dataset Types

Change the dataset type used by the Integration to manage AnalysisCompute and AnalysisResult files by setting the following Teamcenter Preferences:

• CATIA_analysisCompute_dataset_type

• CATIA_analysisResult_dataset_type

The default values are CATAnalysisComputations and CATAnalysisResults.

CATIA Files Extension Case/Design Tables

Use the CATIA_dt_xls_extension and CATIA_dt_txt_extension preferences to manage Design Table file extensions case.

The default values are .xls and .txt.

CATIA Internal Identifier (UUID)

Set two preferences related to the CATIA Internal Identifier (UUID):

• CATIA_uuid_note : defines the name of the occurrence note containing the catia UUID value.


2-226


• CATIA_check_catia_uuid : specify the message displayed when an UUID conflict occurs during the load process.

The UUID is also stored in the catia_doc_attributes form in the system_data_string field.

Compute Geometry for the Main Body

Compute Mass Properties and Material for the main body only when the new preference CATIA_compute_geometry_for_main_body is set to true. Set it to false to compute Mass Properties and Material for all bodies of the part.

Converting JT via ETS

Use the ETS_trans_rqst_referenced_dataset_types preference to specify which CAD dataset type names can be referenced by translation requests as primary or secondary objects. A pre-delete action is registered for each of the defined dataset types to support CAD data deletion while a translation is in process.

Add the dataset types to be managed via ETS to the preference's value, including the dataset type for converting foreign files.

Foreign Files

Refer to the following new preferences related to foreign files.

Preference Purpose

.CATIA_manage_foreignfiles_on_save Manage foreign files during the Save, Import/Export, State Details, Check in/Check out, and Save As/Revise processes

.CATIA_foreignfile_item_type Defines a list of item types used when saving a foreign file.

.CATIA_ifs_foreignfile_query Defines the foreign file query name.

.CATIA_ifs_foreignfile_query_attr Defines the foreign file attributes list.

.CATIA_rename_foreignfile_filename Permit renaming of foreign files


2-227


Preference Purpose

.CATIA_foreignfile_file_name_format Define the format of the foreign file name.

Icons in the CATIA Specification Tree

Set the CATIA_manage_status_in_catia_tree preference to true to automatically display icons in the CATIA specification tree. Set this preference to false, to prevent them from automatically displaying.

Use the new command, Update Status, from the Integration toolbar to manually display or update the icons in the CATIA specification tree.

Import

• Import Form

• Manage import forms using a new customizable GRM Link, CATIA_importform_link_type.

• Modify Item Revision During Import

• Set the CATIA_change_ItemRevName_on_import to true to permit the item revision name to be modified during the import process. The default value is false.

Teamcenter Login Message

Teamcenter automatically starts when the Integration command is launched from the toolbar in CATIA. However, selecting the Cancel button during this process sometimes results in a delayed response/feedback when the Integration has not received login confirmation from Teamcenter. Set TCIC_LOGIN_WAIT to control the number of seconds the Integration will wait before displaying this login warning message. The default value is 180 (seconds).

Disable/Enable the Teamcenter Context Menu

Disable/enable the Teamcenter context menu by setting the TCIC_DISPLAY_CONTEXTUAL_MENU environment variable. If this variable is not defined, the Teamcenter context menu is enabled.


2-228


Userdata POM Classes

Customize the CATIA_POM_catia_absocc POM class which indicates if the CATProduct has been saved with flexibility management. The default value is POM_catia_absocc.

Removed Preferences

The following preferences have been removed from this version and are no longer available:

• CATIAMANAGER_temp_directory

• CATIA_POM_class_shapeProperties_form

• CATIA_cache_management

• CATIA_saveLinks_option

• CATIA_preserve_brokenicons

Preference Category: Integration.CATIA

A new category, Integration.CATIA, has been created and contains the descriptions and default values of all preferences defined by the Integration.

Save Manager Developer Guide

A Teamcenter plug-in, such as Eclipse, must be used to customize the Save Manager in Teamcenter 8.

Silent Mode: Export/Load, Update, Save

Scripts related to Silent Export, Silent Partial Export and Silent Load Update Save can be found a renamed directory.

%IPR% is now %TC_PORTAL_ROOT%. %IR% is now %TC_ROOT%.

For example:

• Scripts related to Silent Export were previously located in %TC_PORTAL_ROOT%\plugins\ can now can be found in the %IPR%\plugins\ directory.

In addition, TC_SERIAL_RELEASE is no longer available.


2-229



Teamcenter Integration for CATIA V5 (8.3.0) supports Teamcenter 8.3 for UNIX and Windows platforms (minimum) and Windows 7. Refer to the Prerequisites section of the Installation Guide for more information.

The Teamcenter Context Menu

A new Teamcenter context menu, available within the CATIA context menu, displays when right-clicking on a CATProduct and external references.

The Teamcenter context menu provides quick shortcuts to common actions which can be performed on the selection such as Insert, Load Merge Selected Level and Check-in/Check-out. When the selection is an external reference, only the Read Linked Documents action is available from this menu.

This menu can be disabled by setting the new TCIC_DISPLAY_CONTEXTUAL_MENU environment variable to false.


2-230


The Update Status Command

Use the new command, Update Status, available from the Integration toolbar to display or update the icons displayed in the CATIA specification tree.

The Update Status command only applies to assemblies.

Translation Solutions

A third translation service, SIEMENS.catiav4tojtdirect, is now available to convert CATIAV4 files (.model) into JTs.

Known Issues

Display Specific Relations The Integration fails to execute with CATIA V5 R18 SPx


Beginning with Teamcenter 8, a combination of Teamcenter preferences and BMIDE configuration (using a template) is required in order to enable the display and navigation of objects using specific relation types in MyTeamcenter.

Beginning with Teamcenter Integration for CATIA V5 (8.2.0), the Integration performs the necessary BMIDE configuration; it is only necessary to define Teamcenter preferences to enable the display of specific relations.

Template collisions will occur between a custom BMIDE configuration template and the Teamcenter Integration for CATIA V5 template, versions 8.2.0 and later.

Refer to Templates in the Configuring the Teamcenter Database section for specific information including the action necessary to resolve template collisions.


2-231


The Integration fails to execute with CATIA V5 R18 SPx





• %work_dir%\catuii

• %work_dir%\tmp

• %work_dir%\import

• %work_dir%\export


2-232



About Integration Check In/Check Out Convert to JT Customization DetailStates Documentation Export General Usage Installation and Configuration Load MML Browser Read Link Documents Refresh Save Silent Export Start Teamcenter Update TitleBlock Volume Search

About Integration


Summary The Integration Attribute Mapping for partNumber causes Teamcenter to crash.


Summary Default Display Names not generated for CATIA objects in 8.3 GA.

Check In/Check Out


Summary No check out warning.


2-233



Summary CATSecondaryPart datasets are not checked in automatically.

Convert to JT


Summary Error message with JT translator on empty CATPart or CATProduct.


Summary The catiav5tojtdirect Translation Service hangs when converting multiple CATParts.

Customization


Summary CATIA V5 environment naming rule.


Summary The CATPart/CATProduct are not imported to the dataset.

DetailStates


Summary Check In/Check Out an item without dataset in the DetailStates window returns a wrong result.

Documentation


Summary Teamcenter Integration for CATIA V5 (7.2.2.2) documentation is missing


2-234


information.


Summary The Integration fails to execute with CATIA SP8 Hotfix 32.


Summary Unable to uninstall due to lack of Java Virtual Machine.


Summary Question about document of Teamcenter Integration for CATIA V5 (8.2.0).


Summary Integration Customization File Requires C++ Definition.

Export


Summary ExportProcess.log file is not re-created at each export.

General Usage


Summary Error message displayed incorrectly when attempting to save.



Summary Problem saving CATIA V5 data in Teamcenter Engineering with UTF8 coding.



2-235


Summary Teamcenter Integration for CATIA V5 (8.2.0) Build CATIA Libraries error.


Summary Install Teamcenter Integration for CATIA V5 (8.2.0) Server, becomes 7.5.0 Server.


Summary Toolbar does not display in the Integration.


Summary Integration installation failure, but no errors in log file.


Summary Integration requires infodba as the password for installation.


Summary Teamcenter Integration for CATIA V5 (7.2.2) with Teamcenter Engineering 2007 MP8 for 64bit.

Load


Summary The Integration does not give meaningful error when no part is selected to open.


Summary Attribute mapping with DOUBLE and French CATIA version.


Summary Teamcenter Integration for CATIA V5 (7.2.0) displays wrong error message (non-CAD support).


Summary Teamcenter Integration for CATIA V5 (7.2.0), CATIA V5 should not be invoked when loading a non-CAD item.


2-236



Summary File menu bar of the Integration grays out.


Summary Unexpected results occur when using Revision Rules.


Summary Cannot load internal components correctly into CATIA V5 R19 SP5.


Summary Using the Save/Open Integration function causes a serious error and tcserver process exits.


Summary Problem with file names of CATIA V4 models loaded into V5.


Summary No indication of Load in progress.


Summary Issues with Teamcenter Integration for CATIA V5 (8.2.0).


Summary The Integration has problems with a "." in the environment name.


Summary Teamcenter crashes with a Catia V5 assembly.


Summary CATIA V4 Load issue in Teamcenter Integration for CATIA V5 (8.2.0).

MML Browser


2-237



Summary MML Browser is not displying all levels of graph for ALL.



Summary Not all the parts of the assembly are loaded.

Refresh


Summary Refresh fails using foreign assemblies in Teamcenter Integration for CATIA V5 (8.0.2).

Save


Summary Flexibility is not saved in Teamcenter.


Summary CATIA assembly save problems to Teamcenter.


Summary CATIA crashes during Save to Teamcenter with Teamcenter Integrtion for CATIA V5 (7.5.3 beta).


Summary Unexpected errors in logs when saving Design Table.


Summary Save failure; marshalling error.


2-238



Summary After Save with Preserve all occurences, Load process is wrong.


Summary No save marshalling error.


Summary BOMView Revision issue with Teamcenter Integration for CATIA V5 (7.5.4.2 beta).


Summary Changes made to an assembly in Teamcenter is giving wrong information to Teamcenter.


Summary CATIA geometry and part links lost during save.


Summary Teamcenter Integration for CATIA V5 (7.2.3) - NonCAD Management - adding an instance in CATIA.


Summary Teamcenter Integration for CATIA V5 (7.2.3) - removing of an occurrence from CATIA.


Summary Error while saving a CATProduct to Teamcenter.


Summary Cannot save .pdf if CATDrawing sheet name is in Korean.


Summary Teamcenter save causes drawing to be out of date.



2-239


Summary CATIA to Temcenter Engineering: process hangs the session for hybrid CATIA assembly.


Summary CATPart and CATProduct incorrectly saved as Specification.


Summary Excessive memory and CATIA crash during Save to Teamcenter


Summary Excessive memory and poor performance saving assembly to Teamcenter.


Summary Corrupted structure in Teamcenter following Save to Teamcenter.


Summary Saving a CATDrawing does not get saved to the corresponding Item ID.


Summary Save As issue.


Summary Teamcenter Integration for CATIA V5 (7.5.4.1) Save As problems.


Summary Teamcenter Integratio for CATIA V5 (7.2.2.3), renaming of Revision does not work during Save As.


Summary Save As issue with Teamcenter Integration for CATIA V5 (7.5.4.2).


Summary When a drawing checked out, the BVR also is checked out.

Silent Export


2-240



Summary Teamcenter Integration for CATIA V5 silenced import log file is not maintained consistently.


Summary Silent Export is not working when checking Environment is enabled.


Summary Silent Export functionality for assemblies having nonCAD occurrence.

Start Teamcenter


Summary Cannot start Teamcenter from the Integration. Nothing happens.

Update TitleBlock


Summary Teamcenter Integration for CATIA V5 (8.0.1) - Update Titleblock issue.

Volume Search


Summary Volume Search not working.


Summary Volume Search with CATIA menu works incorrectly.


2-241







Known Issues

There are known issues associated with this version of the Integration.


Import Load Save

Import


Summary CATIA V5 assembly import failed with a specific pair of assemblies.


Summary Unable to import with edited Characters List using Vis mode.

Load


What's New in Previous Releases

2-242


Summary On Chinese OS, Teamcenter server crashes when loading item to CATIA using Teamcenter Integration for CATIA V5 (8.2.3).


Summary CATIA assembly loads have performance problems.

Save


Summary The Integration is not respecting revision values given into the Save Manager.


2-243





catiav5properties.properties Changes CATIA Document Extensions CATIMAN_CODE CATIA V4/V5 Compatibility CGR Management Data Schema Design Tables Documentation/Scripts and Samples Entry Points InstallAnywhere Installation Methods Integration Preferences Integration Toolbar ITK Functions .jar File Names Journaling JT: CATPart/Alternate Shape Representation Load Process: CATIA Flashes Named References System Prerequisites/Support POM Class Attributes Silent Mode: Export/Load, Update, Save Shape Representations System Prerequisites/Support Teamcenter Preferences Templates Thumbnails (Create .bmp Files) Translator Services


2-244


catiav5properties.properties Changes

The catiav5properties.properties file is now obsolete. It has been replaced with tcic_var_env.xml file. As a result, many variables have been renamed and/or replaced with Teamcenter Preferences.

Previous Name New Name

catia.BadStatus CATIA_stop_import_if_bad_status

catia.CheckForUpdatePart CATIA_check_for_update_part

catia.DataPath TcIC_import_data_path

catia.displayWarningMessages CATIA_display_warning_messages

catia.javahome TcIC_java_home

catia.OEMPrefix CATIA_oem_prefix

catia.pathExport TcIC_export_dir

catia.pathImport TcIC_import_dir

catia.readPublicationTimestamps CATIA_read_publication_timestamps

catia.saveMassProperties CATIA_save_mass_properties

catia.saveMaterial CATIA_save_material


2-245



catia.SaveSupplierInfo CATIA_save_supplier_info

catia.searchRefRefLinks CATIA_search_external_ref_links_on_save

catia.SupplierPrefix CATIA_supplier_prefix

catia.switchInVisualizationMode CATIA_switch_in_visu_mode

catia.UpdateDrawing CATIA_update_drawing_before_saving

catiaReferenceProduct.NAME CATIA_reference_product_partnumber

catiman.exportDLNameRequired CATIA_DLName_required_on_export

com.ebsolutions.catia.saveDetailSheet CATIA_dwg_save_aux_for_details_sheets

com.ebsolutions.catiman.silencedImport CATIA_silenced_import

createPropForMapping CATIA_create_catia_properties_for_mapping

filesDir.NAME TcIC_files_dir

ifsSprdsheetExppath TcIC_export_spreadsheet_path

itemType.NAME CATIA_item_type


2-246



partBoundingBoxCalculation CATIA_part_bounding_box_calculation

pathSpreadSheet TcIC_import_spreadsheet_path

referenceNameSeparator CATIA_partnumber_separator

seedAnalysisID.NAME CATIA_seed_analysis_id

seedDrawingID.NAME CATIA_seed_drawing_id

seedPartID.NAME CATIA_seed_part_id

seedProcessID.NAME CATIA_seed_process_id

seedProductID.NAME CATIA_seed_product_id

socketPort TcIC_socket_port

tmpDir.NAME TcIC_tmp_dir

Refer to the Customizing Teamcenter Files in the UNIX and Windows sections of the Installation Guide for new directory paths.


2-247


CATIA Document Extensions

Teamcenter Integration for CATIA V5 (8.2.0) is not case sensitive with regard to CATIA document extensions. All cases, such as .catpart, .CATPart and .CATPART are supported.

CATIMAN_CODE

The CATIMAN_CODE environment variable has been replaced by TCICV5_DIR.



CGR Management

Use the CATIA_CACHE_PATH_ENV environment setting to define the directory to export CGRs during a Load process.

Data Schema

The Is_Default attribute has been added to the POM_alternateSR_userdata Alternate Shape Representation and the POM_componentSR_userdata Component Shape Representation variables.

Design Tables

The data model for DesignTables has been updated to include MSExcelX.


2-248


Documentation/Scripts and Samples

All scripts and samples attached to the documentation have been removed and are no longer accessible through the User Guide. These files are now delivered with the Teamcenter Integration for CATIA V5 8.2.0 kit and can be extracted during the installation process using InstallAnywhere.

Scripts/Sample Files Related To... New Location

Installation Guide: Configuring Attribute Mappings TcIC_DIR\sample

Installation Guide: DESC Entry Point TcIC_DIR\custom_java\EntryPoints

Various TcIC_DIR\env

Installation Guide: Custom Libraries TcIC_DIR\sample

Installation Guide: Save Manager Tutorial TcIC_DIR\custom_java\SaveManager

Installation Guide: Configuring Attribute Mappings for the Integration Schema

TcIC_DIR\sample\AttributesMappings

User Guide: Teamcenter Import/Export Processes

TcIC_DIR\sample\ImportExport TcIC_DIR\custom_java\SilentImport TcIC_DIR\custom_java\PartialExport TcIC_DIR\custom_java\PartialExport TcIC_DIR\custom_java\silent_export

User Guide: Load, Update, Save Into Teamcenter

TcIC_DIR\custom_java\Silent_lus


2-249


Entry Points

Procedures to configure the CatiaLink entry point in order to customize the Load process have been added to the documentation. This procedure uses Eclipse to reference the Teamcenter plug-in and use the Teamcenter sample.

Familiarity with customizing a Teamcenter Eclipse project is recommended.

InstallAnywhere

InstallAnywhere: New Message

A new message displays during Client Installation of the InstallAnywhere process asking if the environment files require backup.

The following environment files are concerned:

• catiav5properties.properties

• env repository

• custom_CATScript

InstallAnywhere: Translation Solutions

Translation Solutions has been added to the Choose Install Set InstallAnywhere screen.

Installation Methods

Installing Teamcenter Integration for CATIA V5 (8.2.0) via CD-ROM is not available. The following installation methods are available:

System

Installation Method

InstallAnywhere Over the Web (OTW)

UNIX x x


2-250


System

Installation Method

InstallAnywhere Over the Web (OTW)

Windows x x

HP-UX, HPI-Itanium, Linux x --

Integration Preferences

Table of Preferences Created or Updated During Installation

The table below contains preferences that are created or updated during the installation.

Name Value

TC_truncate_file_name FALSE

TC_register_internal_service_modules Catia CatiaV4

TC_truncate_file_name FALSE

TC_customization_libraries libcatia_tc_custom

PSEOccNotesNoCopy

catiaOccurrenceName catiaParentPartName catiaFileName catiaOccurrenceOEM catiaOccurrenceDesc


2-251


Name Value

AbsOccGrmCopyRules class.AbsOccData:class.Form:Relation.catia_shapeProperties_link:Clone

Upgrading From Previous Integration Versions

When upgrading to Teamcenter Integration for CATIA V5 (8.2.0) from pre-7.5.0 versions of Teamcenter Integration for CATIA V5, it is necessary to manually rename the preferences in the table below after template deployment.

It is not necessary to manually rename these preferences when upgrading to Teamcenter Integration for CATIA V5 (8.2.0) from the 7.5.0 to 8.1.0 versions because preferences have already been renamed. For example:

• The preferences in the table below must be manually renamed after template deployment, when upgrading from Teamcenter Integration for CATIA V5 (7.1.0) to (8.2.0).

• The preferences in the table below have already been renamed when upgrading from Teamcenter Integration for CATIA V5 (7.5.x), (8.0.x) or (8.1.0) and later. No further action is required.


IMAN_publication_form or TC_publication_form CATIA_publication_form

IMAN_POM_Class_MML_userdata or TC_POM_Class_MML_userdata CATIA_pom_class_mml_link_userdata

IMAN_POM_Class_DWGLink_userdata or TC_POM_Class_DWGLink_userdata CATIA_pom_class_drawing_link_userdata

IMAN_POM_Class_MMLAssy_userdata or TC_POM_Class_MMLAssy_userdata CATIA_pom_class_mmlassy_link_userdata


2-252



IMAN_POM_Class_MFGLink_userdata or TC_POM_Class_MFGLink_userdata CATIA_pom_class_mfg_link_userdata

IMAN_POM_Class_AnalysisLink_userdata or TC_POM_Class_AnalysisLink_userdata CATIA_pom_class_analysis_link_userdata

IMAN_CATIAV5_MML or TC_CATIAV5_MML CATIA_mml_link_type

IMAN_CATIAV5_DWGLINK or TC_CATIAV5_DWGLINK CATIA_drawing_link_type

IMAN_CATIAV5_MMLASSY or TC_CATIAV5_MMLASSY CATIA_mmlassy_link_type

IMAN_prompt_to_delete_occurrences or TC_prompt_to_delete_occurrences CATIA_prompt_to_delete_occurrences

IMAN_create_object_from_CATIA or TC_create_object_from_CATIA CATIA_create_object_from_catia

IMAN_node_use_to_compute_ass_geom_attr or TC_node_use_to_compute_ass_geom_attr CATIA_node_use_to_compute_ass_geom_attr

IMAN_replace_special_character or TC_replace_special_character CATIA_replace_special_character

IMAN_catiaOccurrence_note or TC_catiaOccurrence_note CATIA_occurrence_note


2-253



IMAN_catiaParentComponent_note or TC_catiaParentComponent_note CATIA_parent_component_note

IMAN_catiaFile_note or TC_catiaFile_note CATIA_filename_note

IMAN_catiaOccurrence_desc or TC_catiaOccurrence_desc CATIA_occurence_desc_note

IMAN_catiaOccurrenceOEM_note or TC_catiaOccurrenceOEM_note CATIA_occurrence_oem_note

IMAN_assembly_form or TC_assembly_form CATIA_assembly_form

IMAN_model_form or TC_model_form CATIA_model_form

IMAN_assembly_form_link or TC_assembly_form_link CATIA_assembly_form_link

IMAN_model_form_link or TC_model_form_link CATIA_model_form_link

IMAN_catpart_form or TC_catpart_form CATIA_catpart_form

IMAN_catImport_form or TC_catImport_form CATIA_catImport_form


2-254



IMAN_IFS_CATPart_query or TC_IFS_CATPart_query CATIA_ifs_catpart_query

IMAN_IFS_CATProduct_query or TC_IFS_CATProduct_query CATIA_ifs_catproduct_query

IMAN_IFS_CATDrawing_query or TC_IFS_CATDrawing_query CATIA_ifs_catdrawing_query

IMAN_IFS_CATPart_query_attr or TC_IFS_CATPart_query_attr CATIA_ifs_catpart_query_attr

IMAN_IFS_CATProduct_query_attr or TC_IFS_CATProduct_query_attr CATIA_ifs_catproduct_query_attr

IMAN_IFS_CATDrawing_query_attr or TC_IFS_CATDrawing_query_attr CATIA_ifs_catdrawing_query_attr

IMAN_use_truncate_catiaV4model_name or TC_use_truncate_catiaV4model_name CATIA_use_truncate_catia_v4_model_name

IMAN_saved_modifiedFile_option or TC_saved_modifiedFile_option CATIA_saved_modified_file_option

IMAN_DesignTable_text_dataset_type or TC_DesignTable_text_dataset_type CATIA_designtable_text_dataset_type

IMAN_DesignTable_excel_dataset_type or TC_DesignTable_excel_dataset_type CATIA_designtable_text_dataset_type


2-255



CATIA_rename_Part_FileName CATIA_rename_part_filename

CATIA_rename_Product_FileName CATIA_rename_product_filename

CATIA_rename_Process_FileName CATIA_rename_process_filename

CATIA_rename_Analysis_FileName CATIA_rename_analysis_filename

Integration Toolbar

Two new commands, related to Shape Representations, have been added to the Integration Toolbar.

Add CATShape Representation : exports a CATShape Shape Representation from Teamcenter to a selected element and activates it.

Synchronize Active Shapes: synchronizes Active Shape Representations for the active CATProduct/CATPart document in CATIA according to the Active Shape Representations saved in Teamcenter.

ITK Functions

Entry point to generate the dataset name

Previously, the default dataset name was Item/ItemRev. Beginning with version 8.2.0, the entry point to generate the dataset name calls the USER_new_dataset_name ITK function. If this ITK function is not correct, the ItemID/ItemRevID rule is used for the dataset name.

Entry point to generate the form name


2-256


Previously, the same entry point and dataset name was used to build the form name. Beginning with version 8.2.0, the dataset name is used to build the form name, if the dataset exists. If it does not exist, then the USER_new_form_name ITK function is used.

.jar File Names

The following .jar files have been renamed.

Old .jar File Name New .jar File Name

bmml.jar Cat2bmml.jar

catimancommon.jar Cat2catimancommon.jar

ebscomservice.jar Cat2ebscomservice.jar

savemanager.jar Cat2savemanager.jar

Journaling

Log and trace settings, such as TMCJournal, CATIAMANAGER_XX and WriteTraceFile have been replaced with the CATIA_journal_catia preference.

For example, similar to the previous TMCJournal, the CATIA_journal_catia preference can be used to enable tracing events such as functions calls and errors. Journal files are written to a .syslog and/or an .xml file, depending on value of this preference. By default, this preference enables only low-level tracing, such as hardware configuration and library versions.

JT: CATPart/Alternate Shape Representation

CATPart and Alternate Shape Representation datasets can now be converted to JT files on the client machine using the catia2jt.bat/catia2jt.sh script or via ETS by using the new translation service, catiav5tojtdirect.

The newly created DirectModel dataset is linked to the converted dataset by the type defined in the CATIA_pv_relation_type preference.


2-257


Load Process: CATIA Flashes

CATIA no longer flashes during Load processes.

Named References

Support for Named References with a *.BMP type has been added to CATPart, CATProduct and CATDrawing datasets.


CATIA

Teamcenter Integration for CATIA V5 (8.2.0) supports CATIA V5 R20.

HP and AIX** are not supported with CATIA V5 R20. **AIX 6.1 is required with CATIA V5 R20, however, it is not supported by Teamcenter 8 client.

Teamcenter

Teamcenter 8.1 or Teamcenter 8.1.L is required for this version of the Integration.

Teamcenter 8.1 supports AIX 6.1. AIX is supported with CATIA V5 R20.

POM Class Attributes

The Is_Default attribute name has been added to the list of available POM class attributes for Alternate and Component Shape Representations.

Silent Mode: Export/Load, Update, Save

The compile.sh and compile.bat files used during the Silent Load, Update, Save process and the Silent Export and Partial Silent Export processes must use the correct .jar files.

The correct Teamcenter version must be defined by setting the TC_SERIAL_RELEASE value to 1, 2 or 3. (1 : Tc2008.1, 2 : Tc2008.2, 3 : Tc2008.3). TC_SERIAL_RELEASE is no longer available beginning with version 8.3.0.


2-258


Shape Representations

Active Shape Representations can be saved for a given root context, permitting different Active Shape Representations for an instance of a part or a product, depending on context. An assembly saved with the Save Active Shapes option can have different status’ depending on the root product context.

CATShape files may be modified in a CATIA session. The CATIA status, Modified_by_synch, is used for non-modified CATProducts/CATParts which contain a modified CATShape Shape Representation.

Two New Commands

Two new commands have been added to the Integration toolbar:

• Synchronize Active Shapes: synchronizes Active Shape Representations for the active CATProduct/CATPart document in CATIA according to the Active Shape Representations saved in Teamcenter

• Add CATShape Shape Representations: exports a CATShape Shape Representation from Teamcenter to a selected element and activates it.

CATIA V5 Menu Option

A new option within the CATIA V5 menu, Export Only Active Shapes, can be used to export only active and default Shape Representations. This option is linked to the CATIA_export_only_active_shapes Teamcenter Preference.

The Export only active shapes files option is disabled when the Activate latest active shapes option is also disabled.

During Load Processes

The shape that becomes activated in CATIA is the active shape stored in the higher context in Teamcenter (information is stored in the higher BOM line).

During Save Processes

Active Shape Representations of an instance of a part/product are saved in the context of the top level when the same information does not exist in a sub-context.

The Modified_by_synch status displays for non-modified CATProducts/Parts which contain a modified CATShape Shape Representation. CATShape files can be modified and saved during a CATIA session.

Modified Shape Representations of an element released in Teamcenter can be saved when CATIA_save_shapes_under_released_cad_element preference is set to true.


2-259


JTs

The JT dataset and link types can be customized using the CATIA_pv_dataset_type and CATIA_pv_relation_type preferences.

Review the following sections of the User Guide for additional information:

• Saving Shape Representations from CATIA V5

• Saving an Assembly

• Refresh Process

• Detailed Status Process | CATIA Status


CATIA

Teamcenter Integration for CATIA V5 (8.2.0) supports CATIA V5 R20.

HP and AIX** are not supported with CATIA V5 R20. **AIX 6.1 is required with CATIA V5 R20, however, it is not supported by Teamcenter 2008 client.

Teamcenter

Teamcenter 8.1 or Teamcenter 8.1.L is required for this version of the Integration.

Teamcenter 8.1 supports AIX 6.1. AIX is supported with CATIA V5 R20.

Teamcenter Preferences

BOM View

The CATIA_create_object_from_CATIA variable, used to customize the BOM View setting when creating a BOM View in Teamcenter from the Save process, has been removed.

2-260


JT

Ensure the COMMONcatiatojt_ets_ds_types and COMMONcatiatojt_<dataset_type>_ets_nr_types Teamcenter Preferences are set to ensure proper conversion of CATIA documents into JT files.

Preference Description

COMMONcatiatojt_ets_ds_types

Lists the types of CATIA V5 datasets that can be translated into JT documents. If dataset types are not specified, dataset type validation is not performed.

COMMONcatiatojt_<dataset_type>_ets_nr_types

Must be created for each dataset_type defined in the COMMONcatiatojt_ets_ds_types preference values list.

Default values are created during deployment of the catiav5tojt translation service. If the catiav5tojt translation service is not deployed and a local translator is used instead, these preferences must contain the proper list of dataset type values.

Templates

The Integration template has been modified to enable relations under a pseudofolder to display in Teamcenter. This change in the data model may cause conflicts with customizations which have been previously applied to the Integration.

Run the Teamcenter TypeAnalysisTool before applying a new Teamcenter Integration for CATIA V5 template to ensure type collisions will not occur.

Refer to Siemens' Teamcenter documentation for information on Template collision check and contact GTAC for support with these errors.

Thumbnails (Create .bmp Files)

A .bmp preview of an item, item revision and/or dataset can be displayed as a thumbnail. Thumbnails of a selected item, item revision and/or dataset display in the Summary tab within Teamcenter


2-261


Navigator after a Save/Import process has been performed. Thumbnails become a new Named Reference added to the target dataset.

Three new preferences related to thumbnails have been created and the Integration must be configured to generate .bmp thumbnails. Thumbnails can be created on the client machine or via ETS using the new catiav5preview translation service. Thumbnails are managed only on Windows.

Refer to the Installing Translation Services section of the the Installation Guide to install and configure the catiav5preview translation service.

Translator Services

There are two new translation scripts:

1. SIEMENS.catiav5tojtdirect; used to convert CATIA files into JTs

2. SIEMENS.catiav5preview; used to create thumbnails (.bmp files) from CATIA files (Windows platform only)

These services are installed and configured during the installation process, and are used when generating JT files and .bmp thumbnail files.

Two Dispatcher components must be modified to host and run the translators; Dispatcher Client and Module (part of the Dispatcher Server). These components may be installed on different machines. Refer to Teamcenter documentation for information on using Dispatcher.

Translators used by the SIEMENS.catiav5tojtdirect and SIEMENS.catiav5preview scripts are Java based client applications using Teamcenter Service-Oriented Architecture (SOA). Refer to Teamcenter Services' documentation, if necessary.

Known Issues

Save As/Revise for Read Linked Documents Vendor Issue: Visual Studio

Save As/Revise for Read Linked Documents

After performing a Save As, a part is loaded as a Read Linked Document, and the drawing incorrectly displays a broken icon. For example:


2-262


1. An item revision, P1, containing a part and a drawing is selected.

2. A Save As New Item is performed on the selected item revision (P2). The new part and drawing still display old file names.

3. P2 is opened from Teamcenter to CATIA, but the drawing is not opened.

4. The part is saved back to Teamcenter. The part now has a new name, which is different to the one the drawing expects.

5. Close All and Purge operations are performed.

6. The P2 drawing and part is opened using Read Linked Document. The drawing still displays a broken icon.

To resolve this issue: Best Practice: Save As/Revise for Read Linked Documents

• From CATIA, load the related documents and save them together. The same practice should be used after an operation from CATIA or Teamcenter. OR

• Replace the linked documents in CATIA.

Vendor Issue: Visual Studio

The Teamcenter toolbar does not display in CATIA

A Windows update KB971090 patch applied to Visual Studio 8 SP1 (or 2005) automatically installs a newer version of Visual C++. All CAA/RADE code compiled on this updated machine will not work on another workstation unless the equivalent version of the Visual C++ runtime environment exists on the other workstation. If the equivalent version of the Visual C++ runtime environment does not exist on the other workstation, the Teamcenter toolbar does display in CATIA.

Also note that an error message does not display during the Integration installation process when installing the previously compiled CAA/RADE code on another workstation using the remote directory and the Copy Compiled CAA Code option.


Perform one of the following steps to resolve this issue:

• If the Windows update KB971090 patch has been installed on a machine which compiles CAA/RADE code, ensure KB971090 has also been applied to all workstations where CAA Objects are used.

• Uninstall KB971090 from the machine used to compile CAA/RADE, then:

• Recompile the Teamcenter CATIA CAA/RADE libraries.

• Reinstall Teamcenter Integration for CATIA V5 Client on 64-bit workstation using the newly compiled CAA objects.


2-263



Auxiliary Files CATIA Shapes Activation Check In/Check Out Convert to JT CreateSpreadsheet Customizations Design Table Documentation Error and Warning Messages Export Import Insert Installation and Configuration Load MML Browser Return to CATIA Revise Save Save Manager

Auxiliary Files


Summary Unable to save a PDF file containing a specific character (*) in the second sheet.

CATIA Shapes Activation


Summary The Load process fails when instances of the same revision are packed.

Check In/Check Out


2-264



Summary Inconsistent warning messages display in the Save Manager when performing a Check Out.


Summary Check In/Check Out status does not automatically refresh.

Convert to JT


Summary JT Translation fails to create JT datasets when rendering pseudofolder is ON.


Summary Unable to generate JTs from the CATIA menu when multiple item revisions are selected.

CreateSpreadsheet


Summary Unable to CreateSpreadsheet with environment variable in DLNames.

Customizations


Summary catia_custom_lib warnings display during version 7.5.2 build.


Summary Integration commands do not work when they are added as shortcuts in the Teamcenter Rich Client left-panel.


2-265


Design Table


Summary Items containing Design Tables fail during multi-site operations.

Documentation


Summary Out of date Installation screenshot.


Summary Teamcenter toolbar does not display when using compiled CAA code on other workstations.


Summary Integration command name is incorrect.


Summary ReadMe file is incorrect.

Error and Warning Messages


Summary The Integration error message displayed when users exceed the number of licenses should be improved.

Export


Summary Multi-CATIA environment is not working with Export.


2-266


Import


Summary The Import Spreadsheet takes 30 minutes to create a part.


Summary Unable to import the Spreadsheet.


Summary The Integration Import.CATScript exits when analyzing CATDrawing ViewLinks created from Annotation Sets in version 7.0.7.4.


Summary Regression: No DWGLink after import.


Summary The Import Sub-Mechanism CATIA command prompt command causes Teamcenter to be launched instead of CATIA.

Insert


Summary OMBUNDOERR error occurs when inserting a part into an assembly.



Summary The Teamcenter toolbar in CATIA does not display after 8.0.0 silent installation.


Summary The Command Suppression application does not list the Integration menu.


2-267


Load


Summary An assembly cannot open due to missing catia_doc_attributes.


Summary An assembly cannot open due to missing catia_doc_attributes.


Summary The Load from Teamcenter process fails on a part which has been previously inserted and deleted.


Summary Data contained in component is partly duplicated; specific to a CATIA version.


Summary A subsequent load of a subassembly, after loading a large one, fails with Signal 11 Tcserver crash.

MML Browser


Summary Browse MML Link displays parts to be updated when they are linked to a Design Table.

Return to CATIA


Summary The CATIA window is resized after the Return to CATIA command is used.

Revise


2-268



Summary Revise does not Deep Copy V4 datasets.

Save


Summary Unable to suppress CGM files generation for group/role/user.


Summary Sequence numbers are not assigned during the Save to Teamcenter process; they are assigned using native PSE default behavior.


Summary Issues occur during the Save from CATIA to Teamcenter process; CATdrawings are renamed.


Summary Unable to save a Design Table.


Summary A serious internal error occurs during the Save process.


Summary Drawing files incorrectly display Modified status after a Save using Integration version 7.2.1.


Summary CATProcess file name customization.


Summary Unable to save a CATIA assembly in Teamcenter using Integration version 7.1.3.2.



2-269


Summary Errors occur when saving a CATIA assembly to Teamcenter.


Summary Crash occurs during the Save process.


Summary The Integration Save fails; marshalling error.


Summary Saving a CATIA dataset fails if it that was created by another user.


Summary When Revise is performed on a CATPart, the object_name is not updated correctly.


Summary Unable to perform a Save As into Teamcenter Engineering on CATIA data using CATIA V5 R19 SP5.


Summary The list of non-updated parts is too long which causes the yes/no buttons to become unselectable.


Summary Saving a new product containing a hybrid assembly under References, results in corruption.


Summary Performance issue occurs when the embedded viewer is running.

Save Manager


Summary Released parts incorrectly display as Modified in CATIA.


2-270



Summary The Integration Save Manager GUI becomes corrupted during the Save to Teamcenter process.


Summary The Save Manager Status window incorrectly displays behind a CATIA window.


Summary Contents in the Save Manager blanks out.


Summary The Save Panel display becomes corrupted when clicking in grey areas.


Summary Saving the CATPART name with more than 128 characters fails causes Teamcenter and the Integration to hang.


2-271





Behavior of CATIA Properties CATIA Metaphase Interface (CMI) Compatibility CATIA V4/V5 Compatibility catiaSecondary Dataset and Link Types Entry Points/User Exit ImportAllSpreadsheet Journaling libcatia_tc_custom Managing Skip/Ignore Nodes Multi-site Configuration New Datasets/CATIA Relations Save As/Revise: Preferences Management Save Manager Secondary Parts Shape Representation Management System Prerequisites/Support

Behavior of CATIA Properties

The Definition and Revision CATIA properties are no longer mapped to Item_ID and ItemRev_ID. In addition, the EBS_DatasetUID, EBS_DatasetLastVersion, and EBS_ItemRevName properties are no longer created.

This behavior applies to Product and Part properties and Drawing parameters. Information in the .dat file is used to create a correspondence between CATIA documents and Teamcenter datasets. Information in CATIA properties is not used.

This behavior may be modified by creating maps between the Definition CATIA property and Item_ID and the Revision CATIA property and ItemRev_ID. Teamcenter maps may also be created on the EBS_ItemRevName reference.


2-272




CATIA Metaphase Interface (CMI) Compatibility

Teamcenter Integration for CATIA V5 is compatible with CMI and loads a Teamcenter assembly coming from Teamcenter Enterprise to CATIA without removing and creating all instances.

In CATIA, a Load Merge Target or a Load Merge Selected Level process can be performed on a broken icon of an assembly previously migrated with CMI, if the broken icon is a CATPart and the CATIA cache is activated.

There is no change to the behavior of the Load and Save processes.

A new section, CATIA Metaphase Interface (CMI) Compatibility, has been added to the documentation.

catiaSecondary Dataset and Link Types

catiaSecondary datasets are now managed during the Load process using the CATIA_secondary_model_dataset_type and CATIA_secondary_link_type Teamcenter preferences. A new entry point, cat_USER_isOccurrenceToBeLoaded has been created to define specific Load rules for catiaSecondary datasets.

Parameters representing the tag of top Node (assembly context) and occ_uid path of the current occurrence are also available on the cat_USER_isOccurrenceToBeLoaded new entry point.

Entry Points/User Exit

Save Entry/User Exit Points are now available and can be used to retrieve a list of saved files in order to apply a post action in CATIA.

These points are managed after the Save process on the Teamcenter Client side and after the Save process on the CATIA side. In addition, an Entry Point/User Exit point can also be managed before the Save process is started in CATIA.

ImportAllSpreadsheet

The Dataset_ID and Dataset_Revision fields have been added to the ImportAllSpreadsheet. The Part_Number column has been removed.


2-273


Content of the ImportAllSpreadsheet

The content of the ImportAllSpreadsheet depends on the value of the CATIA_ifs_qry_last_item_rev_for_dataset Teamcenter Preference. When this preference is set to true, only the last revisions of an item in the spreadsheet that contain datasets available for Import are listed. When set to false (default), all item revisions in the spreadsheet that contain datasets available for Import are listed.

Journaling

Use CATIA_journal_client to generate the tcic_client_*.syslog Client Log File. The possible values of this preference are yes or no.

Use CATIA_journal_server to activate Low Level (default) or High Level Traces written to the tcic_server_*.syslog and/or the tcic_server_*.xml files. The possible values are of this preference are yes, no or syslog.

The journal.syslog and journal.xml files have been replaced with .syslog and .xml files.

libcatia_tc_custom

The libcatia_tc_custom is delivered in sample dir of the installation. The libcatia_tc_custom.c and libcatia_tc_custom.h files are in this folder.

Managing Skip/Ignore Nodes

Add a user-defined prefix to the Part Number, File Name and Instance Name properties to exclude specific CATIA nodes from being saved to Teamcenter. These excluded nodes are called Ignore Nodes.

Ignore Nodes are managed during the following processes:

• Save

• Load

• Import/Export

• Replace

Ignore Nodes are not managed during the Insert and Check In/Check Out processes, and children of Ignore Nodes are not managed during the Insert and Replace processes.


2-274


Before using Ignore Nodes, a text file named IgnoreNodesIdentifiers.txt must be manually created and contain a list of permitted ignore prefixes.

Multi-site Configuration

The catia_secondary_link CATIA Relation can be added to the value of the TC_always_export_user_data_for_relation_type Teamcenter preference.

New Datasets/CATIA Relations

Three datasets and one CATIA Relation are added when applying the Teamcenter Integration for CATIA V5 (8.1.0) template.

• CATSecondaryPart

• CATSecondaryProduct

• catiaSecondary

• catia_secondary_part_link

Save As/Revise: Preferences Management

Set the CATIA_apply_post_action_on_revise and CATIA_apply_post_action_on_aux_datasets preferences to control post-actions during the Save As/Revise processes. In addition:

• Links between objects and secondary parts (catiasecondary) remain in the new item revision when performing a Teamcenter Revise/Save As.

• Manage dataset identifiers using the AE_dataset_id_usage Teamcenter Preference.

These preferences are set to true, by default, indicating post-actions are applied during the Save As/Revise processes. Baselines are not supported when CATIA_apply_post_action_on_revise is set to false; associations between objects are lost.

Save Manager

Columns

Two new column elements have been added, dataset_id (Dataset ID of the component's Dataset) and dataset_revision (Dataset Revision of the component's Dataset).


2-275


Create New

Use the Create New button from the Save Manager toolbar to create a new item. The Auto Assign IDs button can also be applied on this operation.

Dataset Identifiers

The The Dataset ID and Dataset Revision fields display in the Save Manager when the AE_dataset_id_usage Teamcenter Preference is set to ON. The fields do not display when this preference is set to OFF.

The Dataset ID and Dataset Revision IDs are managed in the following dataset types/processes when this preference is set to ON:

• Auxiliary Files

• CGRs

• Saving CATIA V4 files from CATIA V5

• CATAnalysis and CATProcess

• DesignTables

• Saving Foreign Files from CATIA V5

• Shape Representations.

Dataset ID and Dataset Revision IDs are not managed during the convert to JT process when saving an assembly.

A validation is performed on these fields to ensure they are correct. Errors display in the Status column of the Save Manager, if necessary.

Default Item Types

The default value of the item type is determined by a combination of any of the following factors:

• the CATPART_item_type, CATPRODUCT_item_type, etc. preferences

• the item types available in Teamcenter

• the item type defined by the itemType.Name property in the catiav5properties.properties file.

When Create New is applied from the Save Manager, the displayed item type is the existing item type. If this type is not available, then default values are used.


2-276


Secondary Parts

A secondary part is a dataset with a CATPart or a CATProduct in a Named Reference. The secondary part dataset is always attached to a CATProduct dataset by a specific GRM link. The CATProduct dataset is not empty, and must have a Named Reference CATProduct.

There are two types of secondary part datasets depending on if the Named Reference is a CATProduct or CATPart.

Refer to the sections of the User Guide listed below for specific information on how secondary parts are managed or not managed during the following processes:

• Browse Multi-Model Links (MML)

• Check In

• Check Out

• Export Spreadsheet

• ImportAllSpreadsheet

• Insert from Teamcenter

• Load Process

• Replace with Teamcenter

• Save Process

Refer to the following customization sections related to secondary parts:

• Dataset Types for Secondary Parts

• ITK Functions Customization Guide (cat_USER_secondary_parts_info)

Shape Representation Management

The default value of the POM classes used to define the userdata of the link in Component and Alternate Shape Representations have been changed.

POM Class New Default Value*

CATIA_POM_class_alternateSR_userdata POM_alternateSR_userdata


2-277


POM Class New Default Value*

CATIA_POM_class_componentSR_userdata POM_componentSR_userdata

*Previous default values were POM_class_alternateSR_userdata and POM_class_componentSR_userdata

The POM_componentSR_userdata length of attribute type has been increased from 128 to 256.


Teamcenter 2008.1 is required for this version of the Integration.

Known Issues



BOMView Revision CATScripts CGR Check In/Out Classification Documentation Export Import Insert Installation Load Mass Properties Memory Menus Merge Messages OEM Forms Save Save Manager


2-278


Start CATIA User Interface

BOM View Revision


Summary BOMView Revision becomes changed with separator.

CATScripts


Summary Some CATScripts for the Integration are not working.

CGR


Summary Unnecessary CATCache is generated for each CATPart when using Cache mode.

Check In/Out


Summary Performing a Check Out on a CATDrawing fails.


Summary A warning message incorrectly displays when performing a Check Out.


Summary Checking out a V4 subassembly also checks out the dataset and BVR, but fails to check them in after a Save.


2-279


Classification


Summary The Model Attribute form is not generated when the revision is c with version 7.1.3 of the Integration.

Documentation


Summary Information on the behavior of partially exported structures from the Integration needs clarification.


Summary The Update Title Block section of the documentation is not up to date.


Summary The Preferences required for the MML Browser are misleading in the documentation.

Export


Summary Exporting CGRs on UNIX platforms fails.

Import


Summary Import of a Drawing linked to n CATParts stores the drawing dataset under the n-1 CATPart item revision.


Summary CATIA/Teamcenter hangs during an Import of a CATDrawing with multiple


2-280


linked CATProducts.


Summary Unable to import a standalone CATDrawing to an existing item revision.


Summary Mass Property computation cannot be disabled during the Import process.


Summary CATIA status is incorrect when using Import Link in CATIA.


Summary The catia_model_attr form is created during the Import process, even when the CATIA_computeGeometry_option is set to false.


Summary The Import Spreadsheet operation always uses the manifestation relations type.

Insert


Summary Incorrect instance name is set when inserting a new item into a CATProduct.

Installation


Summary Unclear error messages appear in the Teamcenter syslog when using the Integration.


Summary German installation interface is missing options to select the CATIA


2-281


version .

Load


Summary Two newly created and empty CATDrawing datasets cannot be loaded sequentially in CATIA.


Summary Errors occur when opening subassemblies of an already opened assembly.


Summary Read Linked Document fails when an assembly contains items with empty datasets.


Summary An item without a CATProduct dataset fails load resulting in bogus multi-rev conflict in LoadProcess.log.


Summary Load Update Save: The Load Update Save log file displays incorrect and misleading warnings.


Summary The error message about inserting duplicated components in a CATIA session causes Part Number corruption, is misleading.


Summary CATIA geometry is missing after loading multiple assemblies.

Mass Properties



2-282


Summary 3D Mass Properties are not updated when saving 3D via 2D.


Summary Assembly Mass Properties calcuation fails without error if the user does not have write access.

Memory


Summary The imanserver does not release memory until after a CatProduct is fully loaded.

Menus


Summary Popup menu from the BOMLine is not correct.

Merge


Summary Merging without selection leaves the CATIA session unusable.

Messages


Summary An incorrect message displays while saving an assembly from CATIA to Teamcenter.

OEM Forms


2-283



Summary An error is thrown in the syslog when attempting to write the OEM form.

Save


Summary Teamcenter Portal fails during startup when the %WORK_DIR% sub-directories (tmp, import, export, catuii) are missing .


Summary Product drawings need an update after saving a changed product.


Summary Problems with saving a PDF with more than one CATIA layer.


Summary Unable to save a New Revision under an existing item.


Summary Error occurs when saving Drawing with a linked document.


Summary Save using an existing item fails on specific CATIA data.


Summary Save from CATIA to Teamcenter fails with a misleading error message when the item has already been checked out by another user.


Summary A CATIA assembly structure with components changes after a SaveAs from CATIA is performed.


Summary CATIA files incorrectly display as Modified after a Save to Teamcenter is


2-284


performed.


Summary Unable to save Mass Properties when the drawing is saved without opening its related 3D model.


Summary The status of a CATDrawing in CATIA having multiple sheets is Modified after a Save to Teamcenter is performed.


Summary Teamcenter deletes CATIA data.


Summary Some data cannot be saved back to Teamcenter.


Summary The Integration can not delete PIPOM_M_LOCK after saving a CATDrawing.


Summary The original CATIA file is updated, without warning, even if Cancel was selected during the Save.


Summary Blank spaces in a CATDrawing's sheet name causes exception during the Save to Teamcenter process.


Summary The revision name changed after performing another Save on a CATDrawing.


Summary Saving CATDrawing with an assembly results in an Update status for the CATDrawing.


2-285



Summary An uncomplete Save in Teamcenter message displays even if the Save completes.


Summary A multi-branch V5 harness causes an Integration marshalling error.

Save Manager


Summary Empty TDR's cause the Save Manager to hang.


Summary Errors occur when 200 characters have been entered in the ItemId field on Save Manager when performing a Save.


Summary Unsupported Naming Rules for Item ID in the Save Manager.


Summary Misleading information in Save Manager suggests errors.


Summary The Integration does not recognize Naming Rule.

Start CATIA


Summary LaunchCatia does not respect -direnv path.

User Interface


2-286



Summary A java.net.SocketException error occurs when switching from CATIA to Teamcenter.


Summary The Integration is very slow when a complex folder is in My Teamcenter.


2-287





Teamcenter Integration for CATIAV5 (8.0.6) is compatible with Teamcenter Integration for CATIAV4 (8.0.4).

Known Issues



Load


Summary CATIA assembly loads have performance problems.


2-288





CATIA V4/V5 Compatibility Teamcenter Preferences




Use the CATIA_auto_attach_to_3d_item Teamcenter Preference to save a drawing, process or an analysis under a new item.

The default value, true, permits the drawing, process and/or analysis to be saved under the same item revision of the first linked document. The Save Mode in the Save Manager is Use Existing Item.

A false value permits the drawing, process and/or analysis to be saved under a new item revision. The Save mode in the Save Manager is New.

Known Issues

Save Density in CGR

Ensure the following steps are completed to correctly save density in the CGR when performing a Save operation to Teamcenter via the Integration.

1. Activate the Save density in cgr CATIA setting.

2. Purge the CATIA cache.


2-289



Check Out Create Item ETS Import Installation ItemCreation Load Mappings Save Seed Document State Details

Check Out


Summary Unable to check out in Teamcenter's Save Manager; it is not successful the first time.


Summary When a single part is checked out using the Integration's Save function, other objects having MML associations also are checked out automatically.

ETS


Summary Two ETS requests are submitted when saving a CATPart from the Integration.

Import



2-290


Summary Incorrect information after supplier Import.

Installation


Summary The CATIA Environment file fails to install with the Integration 7.5.0.

ItemCreation


Summary Integration errors occur when creating BOM Views.

Load


Summary Loading a CATDrawing in CATIA V5 fails when the dataset is selected in Teamcenter.


Summary Unable to open a dataset using Load to CATIA on an ADSPart.


Summary A Revision Conflict is detected differently on a part and an assembly.

Mappings


Summary The CATDrawing parameter is not mapped to Save Manager.

Save


2-291



Summary Preselection of 3D ItemID when performing a Save on a CATDrawing.


Summary Save Manager does not work.


Summary Unable save CGM files.


Summary FMS problem occur when Save is performed on an assembly loaded with seedparts.


Summary Uppercase setting support in Teamcenter Integration for CATIA V5 (7.5.0).


Summary Unable to save Item Rev 02 of a CATPart when a Design Table is associated to it.


Summary Mass Properties cannot be saved in a catia_model_attribute form in Teamcenter when CATIA is in Design Mode (no cache).


Summary A Click OK to Terminate message displays during the Save process.


Summary A Click OK to Terminate message displays causing CATIA to crash when saving a CATDrawing to Teamcenter.


Summary Integration Save errors occur when a dataset is automatically created.



2-292


Summary Problems saving CATIA Drawing Sheets with names containing a mix of lower and uppercase.

Seed Document


Summary Configuration of the Seedpart selection window.

State Details


Summary Windows become hidden in the background while attempting to Check Out Frozen/Non-readable elements.


2-293





Broken Icon Management CATIA V4/V5 Compatibility catiman.properties File Changes Design Tables Detail Sheet Documentation InstallAnywhere Multi-site Configuration Search DLName Behavior Import Item ID Length Entry Points Journaling Load (kernel_user.properties) Load for Consulting Load, Update, Save Mass Properties Form Multiple Seed Documents New Instance Synchronization New Settings Non-CAD Support Purge Dialog Box Save Save Manager Status Window Customization Supplier Import Queries System Prerequisites/Support Teamcenter Preferences Toolbar Update Title Block: Silent


2-294


Broken Icon Management

Broken icons are not removed from the structure during the Save New process in Teamcenter.


Teamcenter Integration for CATIA V5 (8.0.0) is compatible with Teamcenter Integration for CATIA V4 (8.0.0). CATIA compatibilities.

catiman.properties File Changes

The catia.saveFilesInBatch option is no longer available due to the new Load, Update, Save process behavior.

The com.ebsolutions.catia.saveDetailSheet option has been added. Refer to the Detail Sheet section of this document for additional information.

Design Tables

Design Tables are now managed as independent items. Review this section for specific information on changes to the management of Design Tables.

Check In/Out Processes

Design Tables can be checked in/out as a complete stand-alone element.

If Design Tables are linked to a part, drawing, process or an analysis file that is being checked in/out, the linked Design Tables may also be checked in/out. Products containing Design Tables are automatically checked in/out when the product is checked in/out.

Load and Export Processes

Design Tables related to a current item are exported during the Load processes:

• Design Tables saved in a previous version of the Integration and attached as a Named Reference

• Design Tables linked to CATIA datasets.


2-295


Load Customization

The kernel_user.properties file has been replaced with the plugin.xml file. Modify the plugin.xml file to customize loading Design Tables in CATIA V5. Refer to the Load (kernel_user.properties) topic of this document for further information.

MML Browser

The MML Browser now displays links related to Design Tables from CATIA or Teamcenter because they are now managed as separate items. The MML Browser can also be customized to display a specific color to indicate a Design Table link.

Save and Import Processes

The behavior of the Design Table during the Save and Import processes has been changed. Design Tables are now are managed as a separate item and display in the Spreadsheet. As a result, the catia.designTableMsgBox.DISPLAY property has been removed from the catiav5properties.properties file.

Viewing Design Tables

Design Tables can now be viewed in the Detailed States panel.

Detail Sheet

Set the com.ebsolutions.catia.saveDetailSheet option within the catiman.properties file to false to prevent Auxiliary Files for CATDrawing Detail Sheets from being saved.

By default, all Auxiliary Files for CATDrawing Detail Sheets are saved.

Documentation

User Guide/Installation Documents

Documentation regarding installation of the Integration can be found within the Installation Guide documentation. It is no longer available within the User Guide documentation.

Define Different CATIA Versions

The Define Different CATIA Versions section has been added to the Installation Guide and lists the steps required to permit different CATIA versions to be launched within the Integration. This manual process requires copying and editing configuration files and shortcuts.

ImportAllAssemblies

The Teamcenter Import/Export Processes section of the documentation has been updated to include information on creating a spreadsheet for several assemblies using the ImportAllAssemblies operation.


2-296


Link Relations

Link Relations have been expanded to include customizing the Manufacturing, Analysis, Design Tables, CATAnalysisComputation and CATAnalysisResults links.

Load, Update, Save

The Load, Update, Save Into Teamcenter section of the documentation has been updated to include Multi-model Links.

InstallAnywhere

The InstallShield procedure has been replaced with InstallAnywhere to improve the installation process on UNIX, HP-UX, HPI-Itanium and Linux and Windows installations. InstallAnywhere can customized to display in one of ten different languages, as a GUI containing panels and dialog boxes, or in Silent mode requiring no user interaction.

The InstallAnywhere process can be used across all platforms.

Multi-site Configuration

Ensure the TC_always_export_user_data_for_relation_type Teamcenter preference includes the correct integration relations to avoid data inconsistencies.

For example:

catiaV5_DWGLink catiaV5_MML catiaV5_MMLAssy catia_alternateShapeRep catia_componentShapeRep catia_MFGLink catia_analysisLink catia_analysisFilesLink catia_cache_link

Search

Search functionality has been added to the User's Guide and can be accessed within the Home page. The Search function behaves like most browser-based search engines.

JavaScript must be enabled to use Search.

Review the Search Tips section for tips on improving search results, using wildcards and interpreting the Search Results page.


2-297


DLName Behavior

Ensure the Linked Document Localization list within the Document tab of the General directory in CATIA Options displays in a specific order for correct DLName behavior.

Import

Import/ImportAllAssemblies

The CreateSpreadSheet and CreateAllSpreadsheet processes have been combined together into the CreateAllSpreadSheet function.

The Import and ImportAllAssemblies processes have been combined together into the ImportAllAssemblies function.

Use the ImportAllAssemblies icon within the CATIA toolbar to launch the Import or the ImportAllAssemblies process. The correct type of process automatically launches depending whether the data.txt file exists within the Import directory or if the document is open in CATIA.

Programmatic Import

Enable programmatic import for spreadsheet creation and the import process to take advantage of Silent Import.

Create a .bat file for Windows containing commands to enable programmatic import. The import process should be launched from a command line using the root document parameter, depending on your CATIA environment.

Silent Import

Change the value of the com.ebsolutions.catiman.silencedImport setting within the catiman.properties file to true to activate silent import and hide message boxes normally displayed during the Import process. This functionality is useful when performing Imports in batch mode.

When the setting is set to true, messages normally displayed during the Import process are saved to the new SilencedImport.Log file. The new log file replaces the CreateSpreadsheetImport.Log, Import.Log, CreateAllSpreadsheetImport.Log and ImportAllAssemblies.Log files.

Item ID Length

The Integration supports the TC_Allow_Longer_ID_Name Teamcenter Preference.

When this preference is set to false, the Integration supports up to 32 characters for the item ID attribute and up to 72 characters for the dataset description attribute.

When set to true, the Integration supports up to 128 characters for the item ID attribute and up to 72 characters for the dataset description attribute.


2-298


The default value of this preference is false.

Entry Points

A new entry point in Java has been created, and overrides the userExitAfterAllExportedFiles(Vector files_list).

The new prototype, called after during the Load process, is

userExitAfterAllExportedFiles (tc_session i_tc_session, Vector i_file_name_list, Vector i_item_id_list, Vector i_item_rev_list, Vector i_dataset_uid_list).

Journaling

Use the TMCJournal environment variable to activate Low Level (default) or High Level Traces which are written to the journal.syslog and/or the journal.xml files.

Load (kernel_user.properties)

The kernel_user.properties file has been replaced with the plugin.xml file.

Customize the Load Process when loading a single component or drawing from My Teamcenter or Design Tables in CATIA V5 by modifying the plugin.xml file within the ebscomservice plugin, instead of the kernel_user.properties file.

Load for Consulting

Saving an assembly while a Load for Consulting operation is being performed on the assembly is now prevented to avoid data corruption. The ability to perform different, but simultaneous load processes is no longer possible.

Load, Update, Save

The lus Directory

The Load, Update and Save Processes now run in an independent directory named lus. This directory is not customizable.

As a result of the new lus directory, the usual staging directory is not empty and data in the CATIA session is no longer lost. In addition, specific CATIA options must be listed in the correct order.

Messages


2-299


New dialog boxes display during the Load, Update, and Save process, preventing multiple Teamcenter commands from being executed during this process.

A new dialog box also displays in CATIA when attempting to execute a command during the Load, Update and Save process.

Silent Mode

The Silent Mode functionality is useful to write messages normally displayed during the Load, Update, Save (LUS) processes into a log file.

Mass Properties Form

A Units toolbar displays at the top of the Mass Properties form, permitting the Length Units, Mass Units and Precision values to be modified and recalculated based on the new selections. Values are modified across all open Mass Properties forms automatically when viewing multiple forms from My Teamcenter or the PSE.

Three Teamcenter Preferences are used by the Units toolbar to define the length and mass unit, and the precision (number of significant digits).

Default values are:

• Length Units = mm (millimeters)

• Mass Units = g (grams)

• Precision = 6

Available values for the Length and Mass Units (found in the units.txt file) can be user-defined, as needed. Specific error messages also display during the Mass Properties calculations related to the Units toolbar .

Multiple Seed Documents


2-300


Multiple seed documents can be created for a CATPart, CATProduct and CATDrawing.

New Instance Synchronization

Teamcenter product structures are preserved through the partial Load and Save Existing processes based on values of the PSEOccNotesNoCopy setting.

New Settings

A new Teamcenter Preference setting, CATIA_product_alternate_shape_rep, is available and defines how non-CATIA datasets (under a product) are loaded into CATIA when used in conjunction with CATIA_component_dataset_types and CATIA_load_all_product_shapeRep.

Non-CAD Support

A non-CAD item (non-CAD product and part) is an item without a CAD dataset (CATProduct, CATPart, CATDrawing, CATProcess or CATAnalysis) and without a dataset defined in the CATIA_component_dataset_types (dataset foreign file).

Set the CATIA_manage_noncad_part and CATIA_manage_noncad_product preferences to true or false to manage non-CAD items and prevent/permit them to remain in a Teamcenter CAD assembly:

• during a Load process, without loading them into CATIA (with a seed document)

• without deleting them during a Save process

• without transforming them into a CAD item.

These preferences are independent of each other and can be set to different values.

Purge Dialog Box

Use the PURGE_MSG variable to control the display and contents of the Purge dialog box. The Purge dialog box can be hidden or display specific messages based on the settings of this variable.

Save

Flexible Assemblies

Flexible Assemblies are now managed during the Save Selected process when a product (node) is selected and all children are saved.

Example 1:


2-301


A flexible assembly is created in CATIA and saved to Teamcenter. The part position is modified, and a Save Selected Level is performed. The modification is not stored in Teamcenter. In other words, the absolute matrix is not updated in PSE. If that same assembly is then reloaded into CATIA, the part position displays its previous location.

Example 2:

A rigid assembly (non-flexible assembly) is created in CATIA and saved to Teamcenter. Flexibility is then added in CATIA, and a Save Selected Level is performed. The modification is not stored in Teamcenter. In other words, the absolute matrix is not updated in PSE. If the assembly is then reloaded into CATIA, the flexibility is not removed.


Items added in the PSE during the Save Existing process are no longer automatically deleted. Teamcenter product structure is now preserved during the partial Load and Save Existing processes.

For example, consider an assembly, created in Teamcenter, containing three children. When partially loading one of the children, previous behavior would result in a single instance in CATIA, and two children may be removed from Teamcenter during a Save Existing operation. The New Instance Synchronization process dictates that the new behavior on the given assembly is as follows:

• All immediate children are instantiated in CATIA.

• Unselected children are deactivated in CATIA.

• Children are not removed in Teamcenter when the assembly is saved.

Save Target/Save Selected Level

The Save Target and Save Selected Level processes have been combined into a single Save Selected function, representing 100% CAA Code.

Use the Save Selected icon within the CATIA toolbar to launch either the Save Selected process (previously Save Selected Level) or the Save Selected All Levels process (previously Save Target), depending on the component selected.

Pre-8.0.0 Version 8.0.0 Version

Save and Save Selected Components Save As

Save Target and Save Selected Level Save Selected

n/a Save

2-302


Saving Unmodified Files/Force Save

If the IMAN_saved_modifiedFile_option is set to False or the Force Save for unmodified option is activated within the Save Manager, a message displays within the status bar indicating unmodified files are also saved. This message disappears upon the next event within the Save Manager. The status column of unmodified files is updated according to specific rules.

Save Manager

Save Manager Behavior

Set the value of the new Teamcenter preference, SAVEMANAGER_use_existing_item_revision, to latest to automatically populate the revision field using the last item revision of the corresponding item, for the Use Existing Item or Use Existing Dataset options.

Save Manager Customization

Customize the appearance of columns within the Save Manager by modifying the column definition section of the savemanager.xml file to now include Teamcenter and CATIA properties.

For example, columns such as the Created Dataset Date property (<column name="TC Dst Date Created"/>) and CATIA Description property (<column name="CATIA description"/>) can be added to the Integration dialogs.

New Revision

During a Save New Revision operation, an existing item revision is copied and deep copy rules are applied similar to the Revise operation. The item type cannot be changed in the Save Manager when performing a New Revision.

Save As

The item type now remains with the item during a Save As operation.

If Then

Item type has not changed

The existing item is copied and deep copy rules are applied during the Save As operation. The item type is copied to the new item.

Item type has changed A new item is created.

2-303


Status Window Customization

Customize the appearance of columns within the Status Window by modifying the column definition section of the statedetail.xml file to now include Teamcenter and CATIA properties.

For example, columns such as the Created Dataset Date property (<column name="TC Dst Date Created"/>) and CATIA Description property (<column name="CATIA description"/>) can be added to the Integration dialogs.

Supplier Import Queries

The Supplier Import Query .xml files have been modified for improved Integration/Teamcenter support.


Refer to the Installation Prerequisites section of the Installation Guide for the latest system prerequisites and support.


SAVEMANAGER_always_displayed_on_save

Use the SAVEMANAGER_always_displayed_on_save setting to display or hide the Save Manager during the Save Existing process on modified files.

Load Unconfigured Displayed BOM Lines

Use the CATIA_load_unconfigured_displayed_bomlines setting in conjunction with the Show Unconfigured by Occurrence Effectivity and Show Unconfigured Variants PSE View options, to load parts/products containing Variant and Effectivity Conditions.

This setting is false, by default, indicating that parts/products containing Variant or Effectivity Conditions will not be loaded, and only those parts/products displayed in the PSE are loaded.

Teamcenter Preferences Management

The Teamcenter Preferences listed below are only read during the first action performed in Teamcenter.

Teamcenter must be restarted to apply changes made to these preferences.

• CATIA_CATPart_dataset_type

• CATIA_CATProduct_dataset_type

• CATIA_CATDrawing_dataset_type


2-304


• CATIA_CATAnalysis_dataset_type

• CATIA_CATProcess_dataset_type

• CATIA_catia_dataset_type

• CATIA_LoadUpdateSave_DrawingUpdate

• CATIA_cache_managed_on_save

• CATIA_cache_managed_on_load

• CATIA_reposition_rigidAssy

• CATIA_refresh_teamcenter_on_load

• SAVEMANAGER_always_displayed_on_save

• CATIAMANAGER_client_trace

• ETS_available

• CATIA_ETS_available

• CATIA_manage_flexibleAssy

• CATIA_check_env

• CATIA_CE_EnvList

Renamed Preferences

The following Teamcenter Preferences are renamed during the database update of Teamcenter Integration for CATIA V5 (8.0.0), only when they are defined on site.


IMAN_publication_form CATIA_publication_form

IMAN_POM_Class_MML_userdata CATIA_pom_class_mml_link_userdata

IMAN_POM_Class_DWGLink_userdata CATIA_pom_class_drawing_link_userdata


2-305



IMAN_POM_Class_MMLAssy_userdata CATIA_pom_class_mmlassy_link_userdata

IMAN_POM_Class_MFGLink_userdata CATIA_pom_class_mfg_link_userdata

IMAN_POM_Class_AnalysisLink_userdata CATIA_pom_class_analysis_link_userdata

IMAN_CATIAV5_MML CATIA_mml_link_type

IMAN_CATIAV5_DWGLINK CATIA_drawing_link_type

IMAN_CATIAV5_MMLASSY CATIA_mmlassy_link_type

IMAN_prompt_to_delete_occurrences CATIA_prompt_to_delete_occurrences

IMAN_create_object_from_CATIA CATIA_create_object_from_catia

IMAN_node_use_to_compute_ass_geom_attr CATIA_node_use_to_compute_ass_geom_attr

IMAN_replace_special_character CATIA_replace_special_character

IMAN_catiaOccurrence_note CATIA_occurrence_note

IMAN_catiaParentComponent_note CATIA_parent_component_note

IMAN_catiaFile_note CATIA_filename_note


2-306



IMAN_catiaOccurrence_desc CATIA_occurence_desc_note

IMAN_catiaOccurrenceOEM_note CATIA_occurrence_oem_note

IMAN_assembly_form CATIA_assembly_form

IMAN_model_form CATIA_model_form

IMAN_assembly_form_link CATIA_assembly_form_link

IMAN_model_form_link CATIA_model_form_link

IMAN_catpart_form CATIA_catpart_form

IMAN_catImport_form CATIA_catImport_form

IMAN_IFS_CATPart_query CATIA_ifs_catpart_query

IMAN_IFS_CATProduct_query CATIA_ifs_catproduct_query

IMAN_IFS_CATDrawing_query CATIA_ifs_catdrawing_query

IMAN_IFS_CATPart_query_attr CATIA_ifs_catpart_query_attr


2-307



IMAN_IFS_CATProduct_query_attr CATIA_ifs_catproduct_query_attr

IMAN_IFS_CATDrawing_query_attr CATIA_ifs_catdrawing_query_attr

CATIA_IFS_designtable_query CATIA_ifs_designtable_query

CATIA_IFS_designtable_query_attr CATIA_ifs_designtable_query_attr

IMAN_use_truncate_catiaV4model_name CATIA_use_truncate_catiaV4model_name

IMAN_saved_modifiedFile_option CATIA_saved_modified_file_option

CATIA_rename_Part_FileName CATIA_rename_part_filename

CATIA_rename_Product_FileName CATIA_rename_product_filename

CATIA_rename_Process_FileName CATIA_rename_process_filename

CATIA_rename_Analysis_FileName CATIA_rename_analysis_filename

Also refer to the New Instance Synchronization section of Configuring Teamcenter Database on Itanium, Linux, UNIX and Windows section of the Installation Guide for more information.

Unit and Precision Preferences

Set the following preferences to define the Length Units, Mass Units and Precision values of the Mass Properties form.


2-308


Preference Definition

CATIA_display_unit_of_length defines the length unit

CATIA_display_unit_of_mass defines the mass unit

CATIA_display_unit_precision defines the number of significant digits

Toolbar

The Integration toolbar contains new icons for the Save, Save As and Save Selected processes.

Update Title Block: Silent

The Update Title Block (Update TTB) process is launched in silent mode when CATIA is launched in batch mode. Error messages do not display but are written to the UpdateTTB.log file.

The Update TTB process is not launched in silent mode if CATIA is launched in interactive mode.


2-309


Known Issues

Import Item Revision Sequences Load for Compare Purge Status

Import

Problem:

Item ID is not populated in the spreadsheet during second Import.

Workaround:

Ensure the import path used during the first import is used during the second import. This will retrieve the correct Item ID in the spreadsheet and avoid creating a new item.

Item Revision Sequences

Background:

Teamcenter 2007.1 introduced item revision sequences. When an item revision is first created in Teamcenter, a single item revision object is created and given the sequence number 1. When the item revision is Checked Out and Modified, the original item revision object is copied, creating a backup for sequence 1. The original is then marked as sequence 2. Canceling the Check Out or deleting the latest item revision sequence causes the immediately preceding backup copy to become the active item revision.

Problem:

Having multiple copies of an item revision is not compatible with the Integration and causes failure when present.

Solution:

It is strongly recommended to turn off sequence functionality in Teamcenter if using the Integration. Perform the following steps to disable sequencing.

1. Log in to Teamcenter as Administrator.

2. Pick Edit >> Options.

3. Locate the TcCheckoutReserveOnly preference.


2-310


4. Add ItemRevision to the list of values for this preference.

Note that future versions of Teamcenter and Integration for CATIA V5 will resolve this incompatibility.

Load for Compare/Revision Conflict

Problem:

Revision Conflict occurs when performing a Load for Compare on foreign files, when Revise is performed with Copy as Reference. Revision Conflict does not occur when performing a Load for Compare on foreign files, when Revise is performed with Copy as Object. This is expected behavior.

Workaround:

None. This is expected behavior.

Purge

Problem:

Purge does not remove foreign items even if the window is closed.

Workaround:

Install CATIAV5 R18 SP4 HF30 to resolve this issue. This issue is fixed in Teamcenter Integration for CATIA V5 (7.0.6.1) and later.

Status

Problem:

Viewing properties of a part or product in CATIA by right-clicking causes a Modified status to display in error, when using CATIA R18 SP1 and SP2. This is misleading because the item was not modified even though CATIA displays a Modified status. This is a CATIA native issue.

Workaround:

This issue is fixed in SP3. It is recommended to use this Service Pack version of R18.


2-311



Convert to JT CreateAllSpreadsheets DesignTable Documentation Import Insert/Replace Installation/Configuration Load Read Linked Documents Return to CATIA Revise Save Unix Volume Search

Convert to JT


Summary An error message does not display when Create JT during the Save to Teamcenter process fails.

CreateAllSpreadsheets


Summary Importing CATDrawings that reference multiple CATParts fails.

Design Table


Summary Support for custom Design Table file names.



2-312


Summary Improve management of Design Tables.

Documentation


Summary Add Search function to the documentation.


Summary Modify documentation relating to Load in the User Guide.


Summary Installation documentation lists incorrect XML template filenames.


Summary List of Integration macros in the documentation is not correct (Installation Guide).


Summary Version 7.0.6.1 Documentation includes incorrect references to Teamcenter Engineering.


Summary Correct the CAA Compilation requirements section (Installation Guide).


Summary Improve documentation for multiple CATIA version on the same client.

Import


Summary Linked part is not Imported in Teamcenter using the Integration in CATScript mode.


2-313



Summary Importing a CATDrawing linked to geometrical sets in a CATPart fails.


Summary Importing in a multiple CATIA Environment fails.


Summary The import.CATScript process does not honor the CATIA_computeGeometry_option preference setting.

Insert/Replace

Reference PR 2103617 / PR 3038954 / PR 3039045 / PR 5996516

Summary Insert or Replace returns unexpected results when a selection has not been made in CATIA.


Summary A revision conflict occurs during the Replace process when no conflict is expected.

Installation/Configuration


Summary Installation combined combined with DB config fails.


Summary Installing the Integration Portal Client exposes full Teamcenter pulldown menus instead of the reduced Teamcenter Express menu.


Summary ETS translations triggered from the Integration (SaveManager) cannot be extended to support additional services to handle CATDrawings.


2-314


Load


Summary A BOM structure, with a part as a node, becomes corrupted in the PSE after Load/Save in CATIA.


Summary Warning message is incomplete when performing a Load Merge Selected Level on a partially loaded structure (it is not permitted).


Summary Different Revision Rules creates different LoadMergeTarget results.


Summary Status does not display when performing a Load Update Save.



Summary A request to update the Drawing is made, even when it is not required.


Summary Read Link Document fails to load V4 models.


Summary Read Link Doc Issue:Instance change unactive mode.


Summary Performing a Read Linked Documents on a drawing then subsequently clicking on Cancel closes the Drawing.

Return to CATIA


2-315



Summary Return to CATIA V5 incorrectly returns to the last active window.

Revise


Summary The CATIA V5 Drawing cgm dataset name is incorrect after a Revise process.

Save


Summary A CATPart with more than 500 publications cannot be saved to Teamcenter .


Summary Save operation fails if the MML Browser window is open.


Summary Deep Copy Rules are not working properly during a Save As from CATIA.


Summary View Link, referencing a CATIA V5 capture, is not saved to Teamcenter.


Summary Can not save Catia MML-Assemblies in one operation.


Summary Saving a CATIA Electrical assembly takes a very long time and fails with corruption.


Summary Save Manager: Unable to save a CATDrawing when the user does not


2-316


have write access to the linked CATProduct. (Drawing for Frozen CATProduct)


Summary Duplicate catimportforms are created for a V4 dataset when the create_OEM_form pref is set.

Reference PR 1710700, PR 1715040, PR 2109634

Summary The ItemName is not properly updated in Teamcenter during Save from the Integration.


Summary Problems with character_list in 4 Tier and 2 Tier.


Summary MML Management: Links are not saved into Teamcenter (using the Integration version 7.0.6.1).


Summary CGR Management: Empty CGR dataset are being created in error.


Summary SaveAs from CATIA(V5) incorrectly copies catcache datasets.


Summary CGR Management: A cgr file containing CATPart in its filename cannot be stored in Teamcenter.


Summary Save Selected Component: A Save Selected As process fails with CATScript error when a CATPart is selected.


Summary When JT is created, a dead lock is created on the CATPart dataset.



2-317


Summary Wire Harness assembly takes excessive time to save.

Unix


Summary The send2portal script on UNIX looks for the deprecated Teamcenter Teamcenter startup script, start_daemon.

Volume Search


Summary Volume Search fails when a component does not contain geometrical data.

Getting Started

3-1


Getting Started Chapter 3:Prerequisites for System and Application Administrators Compatibility Between Integration Versions Upgrading Teamcenter Integration for CATIA V5 from the 7.x Series

Teamcenter Integration for CATIA V5 integrates Siemens PLM Software's Teamcenter and Active Workspace with Dassaults Systemes' CATIA V5 software.

Teamcenter and CATIA V5

The Integration combines the capabilities of Teamcenter and CATIA V5 products to enable users to place CATIA components (products and parts) and drawings under Teamcenter control. Use the Integration to:

• Create and edit CATIA V5 models,drawings and assembly relationships

• Perform partial load and load merge for efficient assembly management

• Create new product revisions or version updates for work in progress

• Generate drawing title blocks

• Manage mechanical properties of CATIA models and assemblies

• Store, load and migrate CATIA V4 data to CATIA V5.

Teamcenter powers innovation and improves productivity by connecting people with the product and process knowledge they need to effectively function in a globally oriented product lifecycle. Teamcenter’s proven digital lifecycle management solutions are built on an open PLM foundation. Teamcenter is the world’s most widely used PLM system. It is backed by Siemens PLM Software’s leadership in delivering Global Innovation Networks that enable companies to make unified, information-driven decisions at every stage in the product lifecycle.

Teamcenter manages engineering data and processes in a secure, distributed environment. All engineering data, such as models, part structures and technical specifications are stored in a relational database. The user interface is menu driven and provides comprehensive management capabilities.

http://www.plm.automation.siemens.com/en_us/products/teamcenter/

http://www.plm.automation.siemens.com/en_us/products/teamcenter/active-workspace/

http://www.plm.automation.siemens.com/en_us/products/teamcenter/active-workspace/

Getting Started Prerequisites for System and Application Administrators

3-2


Active Workspace and CATIA V5

The Integration combines the capabilities of Active Workspace and CATIA V5 products to enable users to place CATIA components (products and parts) under Embedded Active Workspace control. Use the Integration to:

• Load an assembly selected in the Active Workspace in CATIA V5

• Load a document selected in CATIA into Active Workspace

• Highlight an instance selected in CATIA in Active Workspace

• Copy an instance in Active Workspace and paste it into an assembly in CATIA

• Copy an instance in CATIA and paste it into an assembly in Active Workspace

• Check In/Check out an item revision

• Create CATPart/CATProduct datasets

• Cross Refresh.

Under Standalone Active Workspace, use the Integration to:

• Load an assembly selected in the Active Workspace in CATIA V5

• Load a document selected in CATIA into Active Workspace

Prerequisites for System and Application Administrators

The System Administrator must ensure the minimum system requirements have been met.

The Application Administrator must perform the following steps before using Teamcenter Integration for CATIA V5.

1. Set up the Database Schema.

2. Establish Teamcenter user accounts.

3. Customize the Title Block.

Getting Started Compatibility Between Teamcenter Integration for CATIA V4 and Teamcenter

Integration for CATIA V5

3-3


Compatibility Between Teamcenter Integration for CATIA V4 and Teamcenter Integration for CATIA V5

This version is compatible with Teamcenter Integration for CATIA V4 (9.0.1).

Upgrading Teamcenter Integration for CATIA V5 from the 7.x Series

Like Teamcenter, it is necessary to perform multiple upgrades of the Integration when the current production version of the Integration is 7.x.

The documentation related to each version is accessible on GTAC. Please pay special attention to review the What's New, Closed Problem Reports (Release Notes) and Known Issues sections for important information related to each version.

From Teamcenter Engineering, review the Teamcenter Integration for CATIA V5 7.2.3, 7.5.7 and the latest 8.3.x documentation versions.

From Unified, review the Teamcenter Integration for CATIA V5 7.0.10, 7.5.7 and the latest 8.3.x documentation versions.

Installation Prerequisites

4-1


Installation Prerequisites Chapter 4:Ensure the following requirements have been met before using Teamcenter Integration for CATIA V5.

Supported Operating Systems System Requirements CAA Compilation Prerequisites Shared Library Clean-up Localization / Internationalization

Templates must also be configured before using Teamcenter Integration for CATIA V5. The MCAD Integration template is required when using Embedded Active Workspace.

Supported Operating Systems

Refer to the Siemens PLM Hardware and Software Certifications page for OS server side support.

SIEMENS MS

Active Workspace 3.1

Windows 7 Windows 8 Vista Windows 10

Teamcenter 10.1.5 (Client) Windows 7 Windows 8 Vista

http://www.plm.automation.siemens.com/en_us/support/gtac/certifications.shtml

Installation Prerequisites System Requirements

4-2


SIEMENS MS

Teamcenter 10.1.6 (Client) Windows 7 Windows 8 Windows 10

Teamcenter 11.2.1 (Client)

Windows 7 Windows 8 Vista



System Requirements

Teamcenter and CATIA Requirements

• Teamcenter 10.1.5 or 11.2.1 and higher in the same series for UNIX and Windows platforms. Teamcenter 12.0.0 and higher for Linux and Windows platforms. Active Workspace 3.1 and higher in the same series. Refer to Supported Operating Systems for specific details.

• CATIA V5R18 to V5-6R2018 and corresponding CAA.

• Set up licenses for all the products.

CATIA/CAA Compatibilities

The following table lists compatibilities between the CATIA/CAA and the minimum level supported to the Integration.

Installation Prerequisites System Requirements

4-3


Refer to Dassault Systèmes documentation for specific OS support.

CATIA V5 / CAA V5 Service Pack

R18 SP4

R19 SP3 minimum

R20 SP1

R21 SP1

V5-6R2012 SP1

V5-6R2013, V5-6R2014, V5-6R2015 SP1

V5-6R2016, V5-6R2017 SP1, SP2

V5-6R2018 SP1 minimum

HP-UX 11.11 Prerequisite

To run the Teamcenter Integration for CATIA V5 on HP-UX 11.11, the Kernel parameters must be set to:

• MSGSEG=32767

• NFLOKS= 4096

• SHMINI= 512

Installation Prerequisites CAA Compilation Prerequisites

4-4


CAA Compilation Prerequisites

Ensure the following prerequisites have been met on the client machine (Windows, AIX or SUN) for successful CAA compilation.

• Teamcenter Client (2-Tier or 4-Tier)

• CATIA V5 Release xx

• CAA API CATIA V5 Release xx

• CAA RADE (Visual Studio or other) for CATIA V5 Release xx

• CAA RADE License: ABC, CDV or CDC

• C/C++ Compiler

• Visual Studio

Refer to System Requirements for the minimum version of CAA which is supported by the Integration. Refer to the CATIA documentation for CAA (compiler version, Visual Studio version …) prerequisites.

Compilation of CATIA 32-bit can be performed only on Windows 32-bit. Compilation of CATIA 64-bit can be performed only on Windows 64-bit. CATIA 32-bit on Windows 64-bit only works in the following environment set-up:

• Build the application on a 32-bit Windows platform.

• Copy the workspace to the 64-bit Windows platform.

• Set the _MkmkOS_BitMode variable to 32 (set_MkmkOS_BitMode=32).

• Launch CATIA 32-bit.

Installation Prerequisites Shared Library Clean-up

4-5


Shared Library Clean-up

When Teamcenter stops using a module/library on AIX, the module/library is not automatically removed from the shared library region. In some cases, this prevents Teamcenter Integration for CATIA V5 from overwriting libraries.

Libraries, by default, remain in memory unless the system is rebooted or the slibclean command is performed.

It is recommended to run the slibclean command prior to installing the Integration. It is not recommended to run this command using InstallAnywhere.

The slibclean command must be performed by the superuser.

Localization / Internationalization

4-Tier Teamcenter Integration for CATIA V5 installation can be deployed with a Client and Server running in different locales.

For example, Teamcenter Integration for CATIA V5 Client can be installed on a French operating system while Teamcenter Integration for CATIA V5 Server is located in an English environment.

The Installation Process

5-1


The Installation Process Chapter 5:Installation Summary InstallAnywhere Features Installing Translation Services Installing on UNIX Installing on Windows About Integration

Installation Summary

Important Notes

The Teamcenter Integration for CATIA V5 environment is case-sensitive. Refer to the Integration's Database Schema documentation, if necessary.

Perform the following steps before proceeding with the installation to help ensure a successful installation process. 1. Uninstall previous versions of Teamcenter Integration for CATIA V5. 2. Purge Teamcenter's RAC.

To ensure successful installation of Teamcenter Integration for CATIA V5, review the recommended installation and configuration steps below.

Process Reference

Prerequisites Supported Operating Systems System Requirements CAA Compilation Prerequisites

The Installation Process InstallAnywhere Features

5-2


Process Reference

Client Installation

Client Installation (RAC Client Installation) Embedded Active Workspace Installation Settings and Location Configure Teamcenter Loader Standalone Active Workspace Instalaltion Settings and Location

Server Installation Server Installation and Active Workspace Deployment

Template Deployment

Template Prerequisites Accessing the Templates Display Specific Relations Configure Teamcenter (Template Extraction)

Translation Installation Installing Translation Services The catia2jt script for Theorem Translator Call catiav5tojtdirect Service in Workflow

Configure Teamcenter Integration for CATIA V5

Attribute Mappings CGR Management Import Queries

InstallAnywhere Features

Use InstallAnywhere to guide the Integration installation process.

Java Virtual Machine (JVM) Localization (language preference) Installer Modes (GUI or Silent) Response (Properties) Files (text files providing installer settings)


5-3


Java Virtual Machine (JVM)

Java Virtual Machine (JVM) is installed on the client by InstallAnywhere and is required for successful Integration installation. The JVM is also required during the uninstallation process.

Removing the JVM, installed by default, causes the client uninstallation process to fail.

Localization

InstallAnywhere is localized permitting dialogs and panels to display in one of ten languages; English, French, Italian, Spanish, German, Russian, Korean, Simplified and Traditional Chinese, Japanese.

The available languages include the default system language detected on the target machine and English.

Refer to the following table for available language choices.

System Language InstallAnywhere Installation Translations

English, French, Italian, Spanish, German English, French, Italian, Spanish, German

Russian Russian, English

Korean Korean, English

Japanese Japanese, English

Simplified Chinese Simplified Chinese, English

Traditional Chinese Traditional Chinese, English

5-4


Installer Modes

There are two methods of installation:

1. Graphical User Interface (GUI). This method uses Wizard panels and dialog boxes and requires user interaction.

2. Silent. This method requires no user interaction. All settings are provided in a Response (Properties) File containing the values required by InstallAnywhere to control the installation. The silent mode is fully supported on all platforms.

Response files are text files containing settings for an installer (installer properties file) and are generated by capturing user responses when executing an installer. A response file must be created prior to using the silent mode installation method.

The response file must not contain variables, such as $ HOME, % temp.

Perform the following steps to initiate the silent installer enabling InstallAnywhere to run without user interaction, i.e, in Silent Mode.

1. Create a response file by entering the following in a command line: <Installer name> -r <full path to the response file destination> The response file is created at the end of the installation at the given location.

The Installation Process Installing Translation Services

5-5


For example, myinstaller.exe -r c:\temp\myresponse.properties writes the response file, myresponse.properties, to the temp directory on c:\.

2. Launch InstallAnywhere in silent mode by entering the following in a command line: <Installer name> -i silent -f <full path of the response file location>

A direct or relative path can be used for the response file, for example, myinstaller.exe -i silent -f myresponse.properties

Installing Translation Services

Deployment Strategies Installation Prerequisites Installation Using InstallAnywhere Post-Installation Steps Verifications

It is strongly recommended that installation of Translation Solutions be performed using a dba user. Failure to do so prevents preferences from being imported into Teamcenter.

There are three translation scripts based on Teamcenter's Dispatcher translation management capabilities.

1. SIEMENS.catiav5tojtdirect; used to convert CATIAV5 files into JTs.

2. SIEMENS.catiav4tojtdirect; used to convert CATIAV4 files (.model) into JTs.

3. SIEMENS.catiav5preview; used to create thumbnails (.bmp files) from CATIA files (Windows platform only).

Two Dispatcher components, DispatcherClient and Module (part of the Dispatcher Server), must be modified to host and run the translators. These components may be installed on different machines. Refer to Teamcenter documentation for information on using Dispatcher.


5-6


Translators used by the SIEMENS.catiav5tojtdirect, SIEMENS.catiav4tojtdirect and SIEMENS.catiav5preview scripts are Java based client applications using Teamcenter Service-Oriented Architecture (SOA). Refer to Teamcenter Services' documentation, if necessary.

Use InstallAnywhere to deploy the required translator files, import related preferences and edit customization files and scripts.

Deployment Strategies

Installation of SIEMENS.catiav5tojtdirect, SIEMENS.catiav4tojtdirect and SIEMENS.catiav5preview deploys files on the DispatcherClient and the Module machine of the Dispatcher Server.

SIEMENS.catiav5preview is only available for Windows platforms, therefore, it may be necessary to redefine the way Dispatcher components are distributed.

A Dispatcher Server distributed on separate hosts may result in the deployments illustrated below.

In both cases, the DispatcherClient and Module(s) are updated during the Translation Solutions installation process.


5-7


Installation Prerequisites

To convert CATIA files into JT files To create .bmp thumbnails from CATIA Files

It is strongly recommended that installation of Translation Solutions be performed using a dba user. Failure to do so prevents preferences from being imported into Teamcenter.

Ensure the following prerequisites have been met prior to installing Translation Services.

1. Familiarity with Teamcenter Service-Orientated Architecture (SOA) and Teamcenter Dispatcher.

2. FMS, with FMS client access, available on the Module machine.

3. Stop all Dispatcher services prior to installing Translation Solutions.

4. Define a user dedicated to translations. This user must have sufficient privileges to be able to export CAD data files under Teamcenter datasets and import the translated files into Teamcenter.

5. Meet the specific installation prerequisites required to convert CATIA files into JT files and/or create thumbnails (.bmp files) from CATIA files.


5-8


To convert CATIA files into JT files (SIEMENS.catiav5tojtdirect and SIEMENS.catiav4tojtdirect)

In addition to installation prerequisites above, ensure a JT translator utility is installed on the Module machine.

To create .bmp Thumbnails from CATIA Files (SIEMENS.catiav5preview)

SIEMENS.catiav5preview is only available on 32 and 34 bit Windows.

The SIEMENS.catiav5preview translator uses a utility, getmini.exe, to create thumbnails out of CATIA files. This utility is deployed during the installation process on the Module.

In addition to the installation prerequisites above:

1. CATIA V5 must be installed on the machine hosting the getmini.exe file (Module machine).

2. The same version of CATIA V5 used on the client machine of the Integration must be the same version used on the machine hosting the getmini.exe.

3. On the Integration client machines, ensure the Do not activate default shapes on open option located in Options\Infrastructure\Product Structure\Product Visualization is not toggled on. Toggle this option to prevent thumbnails from being created during the translation process resulting in a blank .bmp.

Using InstallAnywhere

Perform the following steps to install Translation Solutions using InstallAnywhere.

Review the InstallAnywhere Features section before proceeding. Pick Cancel at any time during the process to cancel the installation or pick Previous to return to the previous screen.

1. Double-click on the InstallAnywhere icon or use a command line to launch InstallAnywhere, for example on Windows : C\InstallerName.exe.

2. Choose the Installation language, then pick OK.

3. Review the installation procedure message in the InstallAnywhere Introduction window to ensure you are ready to proceed with the installation, then pick Next to continue.

4. Pick Translation Solutions, then pick Next. Refer to the InstallAnywhere documentation for UNIX or Windows for information on installing other features.

5. Pick a translator(s) to enable, then pick Next.

6. Choose the Dispatcher component(s) to update on the current machine, then pick Next.


5-9


The Dispatcher Server can not be updated to enable the thumbnails translation service on UNIX machines.

7. Enter the Dispatcher Root directory path, then pick Next. The path must contain the following directory:

• DispatcherClient to update the DispatcherClient

• Module to update the Dispatcher Server.

• DispatcherClient and Module to update both DispatcherClient and Server.

Two separate installations are required to update two Dispatcher components when the DispatcherClient and Module exist in different locations on the same machine.

8. Preferences related to Translation Services are imported during the installation process using Teamcenter's preferences_manager utility. The import occurs during the MERGE mode; the scope is set to SITE. Enter the user ID and password of the user with administrative privileges (usually infodba) then pick Next to continue.

9. Teamcenter Service-Oriented Architecture (SOA) Java applications deployed on the Module component of the Dispatcher Server must have access to an existing FMS installation location. Refer to Teamcenter Services documentation, if necessary.

FMS .jar libraries are shipped with FMS installations and are imported into the Integration's code.

10. Enter the path to the FMS installation located on your machine, then pick Next to continue. This field will be automatically populated with the value in the FMS_HOME environment variable, if available. The value entered must contain the .jar subdirectory which contains the following files:

a. fccjavaclientproxy.jar

b. fmsclientcache.jar

c. fmsutil.jar

d. fscjavaclientproxy.jar

11. The CATIA Architecture panel displays when the system architecture is 64 bit (Windows 64 bit). Pick the CATIA architecture required, then pick Next to continue.

12. Review the Pre-Installation Summary, Installing and Install Complete screens to ensure the information detailed in these screens matches your current installation.


5-10


Post-Installation Steps

Set the Teamcenter Service Host Address and Dedicated User (Dispatcher Server) Modify the .catiaV5tojtdirect Script (Dispatcher Server) Modify the .catiaV4tojtdirect Script (Dispatcher Server)

Set the Teamcenter Service Host Address and Dedicated User (Dispatcher Server)

Configure client applications to use Teamcenter Services by indicating how to connect to a running instance of Teamcenter server. Perform the following steps as Administrator:

1. Locate the following config.properties files on the Module component of the Dispatcher Server:

a. Module\Translators\catiav5tojtdirect\config.properties

b. Module\Translators\catiav4tojtdirect\config.properties

c. Module\Translators\catiav5preview\config.properties

2. Enter the following information in the config.properties file for each translator (catiav5tojtdirect, catiav4tojtdirect and catiav5preview) installed:

a. DB_Host; specify the Teamcenter server address

b. user.username; the user dedicated to translations

c. user.password; the password for the user dedicated to translations

d. user.group; optional attribute related to the user dedicated to translations. Default values are used if unedited.

e. user.role; optional attribute related to the user dedicated to translations. Default values are used if unedited.

About DB_Host

SOA client applications support both 2-Tier (IIOP) and 4-Tier (HTTP) deployments.

In the example below, the JT translator application (catiav5tojtdirect) connects to a 2-Tier Teamcenter server and the thumbnail translator application (catiav5preview) connects to a 4-Tier server.


5-11


The connection type (HTTP or IIOP) is set by the DB_Host entry in the config.properties file:

• 4-Tier Teamcenter server connections: DB_Host=http://server:port/app-name

• 2-Tier Teamcenter server connection: DB_Host=iiop:server:port/server-id

For IIOP: a common DB_Host string is iiop:localhost:1572/TcServer1. In this case, use TEM to set the iiop configuration for 2-Tier Client to PER_CLIENT.

Refer to the following definitions and examples as described in the Teamcenter Service Guide Documentation

Term Definition

server

Network name of the server machine. For 4-Tier deployments, this is the host machine the Teamcenter Web tier is executing on. For 2-Tier deployments, this is the host machine the Teamcenter server is executing on.

port

Port number on the Teamcenter machine that is configured for communications. For HTTP communications, this is the port number on the Web application server. For example, if you are using WebLogic, the default value is 7001, or if you are using Apache Tomcat, the default value is 8080. For IIOP communications, this is the port defined by the CORBA ORB Endpoint.


5-12


Term Definition

server-id CORBA ID of the Teamcenter server

app-name

Application name that the Teamcenter Web tier processes are deployed under. The default value is tc but may have been changed during the installation and configuration of the Teamcenter server software.

service-port

Name of the Teamcenter Services operation being called. The optional URL query string wsdl returns the service WSDL, while the URL without the query string executes the service request

Examples

• iiop:192.168.2.54:1154/TcServer1

• iiop:localhost/TCS2

• http://192.168.25.19:8080/tc

Modify the .catiav5tojtdirect Script (Dispatcher Server)

As Administrator, modify the convert_catiav5tojt script located in Module\translators\catiav5tojtdirect based on your specific requirements relating to the JT utility.

The convert_catiav5tojtdirect script shipped with the Translator is an example which runs the default JT Translator utility, Theorem.

Modify the .catiav4tojtdirect Script (Dispatcher Server)

As Administrator, modify the convert_catiav4tojt script located in Module\translators\catiav4tojtdirect based on your specific requirements relating to the JT utility.

The convert_catiav4tojtdirect script shipped with the Translator is an example which runs the default JT Translator utility, Theorem.


5-13


Verifications

.catiav5preview SIEMENS.catiav4tojtdirect SIEMENS.catiav5tojtdirect Preferences

Error and warning messages display during the installation process if problems occur. Review the log files in the final panel of the installer for additional information.

Verifications: .catiav5preview


DispatcherClient

Ensure the following has been deployed on the DispatcherClient machine:

1. The Cat2DCPreview.jar file has been copied to the DispatcherClient\lib directory.

2. Cat2Preview has been added to the import line of DispatcherClient\conf\Service.properties

3. The cat2preview_env.xml file has been copied to DispatcherClient\install and the preferences listed in this file have been successfully imported in Teamcenter by the Teamcenter preferences_manager utility. Refer to the Preferences section.

Module

Ensure the following has been deployed on the Module machine (Windows only):

1. Ensure Module\Translators\catiav5preview has been created and it contains:

a. Cat2DSPreview.jar

b. catiav5preview.bat

c. getmini.exe (the thumbnail generator utility)

d. config.properties


5-14


2. Ensure Module\conf\translator.xml has been edited and .catiav5preview has been added.

3. Ensure Module\Translators\cat2common\soa_lib has been created and it contains Teamcenter SOA client libraries.

Refer to the Troubleshooting section for additional help.

Verifications: SIEMENS.catiav4tojtdirect


DispatcherClient


1. The Cat2DCTransJTV4.jar has been copied to the DispatcherClient\lib directory.

2. Cat2DCTransJTV4 has been added to the import line of DispatcherClient\conf\Service.properties

3. The cat2transjtv4_env.xml has been copied to DispatcherClient\install and the preferences listed in this file have been successfully imported in Teamcenter by the Teamcenter preferences_manager utility. Refer to the Preferences section.

Module

Ensure the following has been deployed on the Module machine:

1. Ensure Module\Translators\catiav4tojtdirect has been created and it contains:

a. Cat2DSTransJTV4.jar

b. catiav4tojtdirect.bat (or .sh)

c. convert_catiav4tojt.bat (or .sh)



5-15


2. Ensure Module\conf\translator.xml has been edited and .catiav4tojtdirect has been added.

3. Ensure Module\Translators\cat2common\soa_lib has been created and contains Teamcenter SOA client libraries.

Verifications: SIEMENS.catiav5tojtdirect


DispatcherClient


1. The Cat2DCTransJT.jar has been copied to the DispatcherClient\lib directory.

2. Cat2DCTransJT has been added to the import line of DispatcherClient\conf\Service.properties

3. The cat2transjt_env.xml has been copied to DispatcherClient\install and the preferences listed in this file have been successfully imported in Teamcenter by the Teamcenter preferences_manager utility. Refer to the Preferences section.

The following ACL must be defined to permit the dcproxy user to process the dataset (DispatcherClient level).

Define another ACL so that Named References can be read from the volume sub-folder for non-DBA users.


5-16


Module

Ensure the following has been deployed on the Module machine:

1. Ensure Module\Translators\catiav5tojtdirect has been created and it contains:

a. Cat2DSTransJT.jar

b. catiav5tojtdirect.bat (or .sh)

c. convert_catiav5tojt.bat (or .sh)


2. Ensure Module\conf\translator.xml has been edited and .catiav5tojtdirect has been added.

3. Ensure Module\Translators\cat2common\soa_lib has been created and contains Teamcenter SOA client libraries.

The Installation Process Installing Teamcenter Integration for CATIA V5 on UNIX

5-17


Verifications: Preferences


Preferences related to Translation Services are imported during the installation process using Teamcenter's preferences_manager utility. The import occurs during the MERGE mode; the scope is set to SITE. As a result, existing single value preferences are not updated. For example, if the value of the CATIA_translation_service_name preference is SIEMENS.catiatojt, it will not be updated to SIEMENS.catiav5tojtdirect, which is the value required in order to enable the translation solution.

Ensure the preferences have the correct values to meet your specific requirements.

Installing Teamcenter Integration for CATIA V5 on UNIX

InstallAnywhere Customizing Teamcenter Files

Ensure the Installation Summary has been reviewed before installing the Integration.

InstallAnywhere

Ensure the ksh script shell is installed on UNIX to avoid error messages during the installation process.

Review the InstallAnywhere Features documentation before proceeding. Pick Cancel at any time during the process to cancel the installation or pick Previous to return to the previous screen.

Perform the following steps to install Teamcenter Integration for CATIA V5 files using InstallAnywhere.


5-18


1. Double-click on the InstallAnywhere icon or use a command line to launch InstallAnywhere, for example on Windows, C:\InstallerName.exe.

2. Pick the Installation language, then pick OK.


4. Pick the feature to be installed.

One or more features may not be available because of your operating system. Refer to Supported Operating Systems for feature availability.

• Pick Server to install Teamcenter Integration for CATIA V5 server, then pick here to continue.

• Pick cdrom Extraction to extract the files to a user-defined folder, then click here to continue.

• Pick Translation Solutions to install translation capabilities, then click here to review specific installation prerequisites, steps and post-installation instructions.

Using InstallAnywhere: Server Installation


Server Installation

Refer to the following steps after Server Installation is selected from the InstallAnywhere Choose Install Set screen.

1. Indicate the directory where the Teamcenter Server is installed then pick Next to continue.

2. Review the Pre-Installation Summary before continuing, then pick Install to initiate the installation process.

3. Please wait a moment for the installation process to complete.

4. Review the installation successful message, then pick Done to exit InstallAnywhere. Installation is now complete.


5-19


The libraries are copied into $TC_ROOT/lib. The windows definitions in $TC_ROOT/lang/motif.client contain the java classes for Teamcenter.

Using InstallAnywhere: cdrom Extraction


cdrom Extraction

Refer to the following steps after cdrom Extraction is selected from the InstallAnywhere Choose Install Set screen.

1. Indicate the directory to extract to, then pick Next to continue.




Customizing Teamcenter Files

Teamcenter Integration for CATIA V5 copies the library in the $TCICV5_DIR/lib directory automatically. It is only necessary to manually copy this library in cases where the installation script has failed or when installing a patch.

The Installation Process Installing Teamcenter Integration for CATIA V5 on Windows

5-20


Installing Teamcenter Integration for CATIA V5 on Windows

InstallAnywhere Customizing Teamcenter Files Creating Cache Directories

Teamcenter Integration for CATIA V5 WIN32 contains Integration libraries compiled for Teamcenter 32bits. Teamcenter Integration for CATIA V5 WIN64 contains Integration libraries compiled for Teamcenter 64bits.

Ensure the Installation Summary has been reviewed before installing the Integration.

Using InstallAnywhere


Perform the following steps to install Teamcenter Integration for CATIA V5 files using InstallAnywhere.

1. Double-click on the InstallAnywhere icon or use a command line to launch InstallAnywhere, for example on Windows, C:\InstallerName.exe.

2. Pick the Installation language, then pick OK.


4. Pick the feature to be installed.

One or more features may not be available because of your operating system. Refer to Supported Operating Systems for feature availability.

• Pick Client to install Teamcenter Integration for CATIA V5 client, then pick here to continue.

• Pick Server to install Teamcenter Integration for CATIA V5 server, then pick here to continue.


5-21


• Pick Build CATIA Libraries to generate CATIA Libraries (CAA), then pick here to continue.

• Pick cdrom Extraction to extract the files to a user-defined folder, then click here to continue.

• Pick Translation Solutions to install translation capabilities, then click here to review specific installation prerequisites, steps and post-installation instructions.

Using InstallAnywhere : Client Installation


Different types of clients can be installed using Teamcenter Integration for CATIA V5 InstallAnywhere:





When selecting Teamcenter Integration for CATIA Loader, Embedded Active Workspace or Standalone Active Workspace installations, FMS HOME must be defined during the installation when a TCCS_SA installation exists.

The Active Workspace MCAD Integration template must be deployed prior to using TcIC with Active Workspace.

Client Installation

Refer to the following steps after Client Installation is selected from the InstallAnywhere Choose Install Set screen.

1. Enter the directory to copy Integration Client files, the reference directory used when exporting documents as reference, and the directory used for Integration temporary files. Reference directory default values are %WORK_DIR%\reference for Windows and $WORK_DIR/reference for UNIX. Pick Next to continue.

2. Define the type of Client installation in the Client Selection panel.


5-22


a. Pick Teamcenter Rich Client to install a RAC client, then click here to continue.

b. Pick Embedded Active Workspace to install an Active Workspace client in hosted mode, then click here to continue.

c. Pick Teamcenter Integration for CATIA V5 Loader to install a Loader Client, then click here to continue.

d. Pick Standalone Active Workspace to install an Active Workspace client in non-hosted mode, then click here to continue.

3. Define the default client in the list of clients. When multiple clients are defined, the selected client is used by default when a client is not currently running and the command selected in CATIA requires a client. For example, when Rich Client (default) and CATIA V5 Loader installations are installed, the Rich Client is used in priority within the TcIC processes. Change the order of the clients in the client_env file to define the CATIA V5 Loader as the default client.

4. Pick an option to install the documentation, then pick Next to continue. To skip this step, pick Next.

a. Install new documentation by entering the .zip file path when the Install Documentation option was selected from the previous screen.

b. Enter the directory where the current documentation is installed when the Use Existing Documentation option was selected from the previous screen.

5. If Teamcenter Rich Client is selected:

a. Enter the directory where Teamcenter Rich Client is installed, then pick Next to continue.

b. If TC_PORTAL_ROOT is not defined, enter the FMS installation path located on this machine (FMS_HOME) for a TCCS Standalone installation.

c. Enter the JRE installation path located on this machine (JRE_HOME)

d. For Windows installations: The CATIA Architecture panel displays when the system architecture is 64 bit (Windows 64 bit). Pick the CATIA architecture required, then pick Next to continue.

6. If Embedded Active Workspace is selected:

a. Enter the Client URL corresponding to the Active Workspace location (optional).

b. If TC_PORTAL_ROOT is not defined, enter the FMS installation path located on this machine (FMS_HOME) for a TCCS Standalone installation or enter the location of the Teamcenter Rich Client Portal folder (TC_PORTAL_ROOT).

The ActiveWorkspaceHosting.TcIC.URL Teamcenter preference has priority over this parameter (when


5-23


defined), so this field may be left empty. The Teamcenter Standalone Active Workspace Client URL field will be read when the TcIC_StandaloneAW_Option parameter is set to true. Enter the TC_PORTAL_ROOT path, not the FMS_HOME path, when using FMS from a 4-tiers or 2-tiers Rich Client.

c. Enter the JRE installation path located on this machine (JRE_HOME).

d. Pick Next to continue.

7. If Teamcenter Integration for CATIA V5 Loader is selected and TC_PORTAL_ROOT or FMS_HOME has not already been defined:

a. Enter the FMS installation path located on this machine (FMS_HOME) for a TCCS Standalone installation, or enter the location of the Teamcenter Rich Client Portal folder (TC_PORTAL_ROOT).

Enter the TC_PORTAL_ROOT path, not the FMS_HOME path, when using FMS from a 4-tiers or 2-tiers Rich Client.

b. Enter the path to the SingleEmbeddedView.jar file of Teamcenter Vis or PLM Vis to enable JT visualization in the Viewer Configuration panel. The path is added to RACLESS_JAVA_CLASSPATH variable. When the path is empty, the JT viewer is not used in TcIC Loader.



8. If Standalone Active Workspace is selected:

The AWC_TCIC_OpenSupportedTypes and AWC_TCIC_ShowObjectDatasetTypes preferences must be defined to display the Open in CATIA command in the Standalone Active Workspace

a. Enter the Client URL corresponding to the Active Workspace location (optional).

b. If TC_PORTAL_ROOT is not defined, enter the FMS installation path located on this machine (FMS_HOME) for a TCCS Standalone installation or enter the location of the Teamcenter Rich Client Portal folder (TC_PORTAL_ROOT).

When Active Workspace (Embedded or Standalone) installation is selected, the windows registry is updated with the %TCICV5_DIR%\aw\aw_keys.reg file.


5-24


The ActiveWorkspaceHosting.TcIC.URL Teamcenter preference has priority over this parameter (when defined), so this field may be left empty. The Teamcenter Standalone Active Workspace Client URL field will be read when the TcIC_StandaloneAW_Option parameter is set to true. Enter the TC_PORTAL_ROOT path, not the FMS_HOME path, when using FMS from a 4-tiers or 2-tiers Rich Client.



9. Pick the CATIA version, enter the path of the CATIA installation, then pick Next to continue.

10. Enter the location of your CATIA Libraries (CAA). If the CATIA libraries (CAA) do not exist, return to the Choose Install Sets panel and pick Build CATIA Libraries to build them.

11. Review the Pre-Installation Summary before continuing, then pick Install to initiate the installation process. Please wait a moment for the installation process to complete.


Using InstallAnywhere : Server Installation

Server Installation Cat2HostedTcIC.war Deployment


Server Installation

Refer to the following steps after Server Installation is selected from the InstallAnywhere Choose Install Set screen.

1. Indicate the type of installation to deploy, then pick Next to continue.

a. Toggle Teamcenter Integration for CATIA server libraries on to deploy server libraries.


5-25


b. Toggle Embedded ActiveWorkspace web application to deploy the .war file under web Server Application for an Embedded Active Workspace installation.

2. Enter the directory where the Teamcenter Server is installed (TC_ROOT) when Teamcenter Integration for CATIA server libraries was selected or enter the folder where the web application file must be deployed when Embedded ActiveWorkspace web application was selected. Pick Next to continue.




The libraries are copied into $TC_ROOT/lib. The windows definitions in $TC_ROOT/lang/motif.client contain the java classes for Teamcenter.

Cat2HostedTcIC.war Deployment

Prerequisite: Installation of the application server.

Jboss

1. Copy the Cat2HostedTcIC.war file from %TCICV5_DIR%\Aw or the local machine where it has been extracted. Paste the file into the jboss-as-7.1.0.Final\standalone\deployments directory.

2. Restart JBoss and the pool_manager services.

WebLogic

1. Start the WebLogic server administration console.

2. Select Deployment from the left pane then pick Install from the right pane.

3. In the Install Application Assistant, pick the Browse button next to the Deployment Archive box, navigate to the location of the Cat2HostedTcIC.war file then pick Next.

4. Accept the default Install this deployment as an application option and pick Next.

5. Pick Finish to accept all the default settings, then pick Save.

6. Pick Deployments then toggle the Cat2HostedTcIC application on.


5-26


7. Ensure the application state indicates Active and the Health indicates OK.

8. Restart Weblogic and pool_manager services.

Tomcat Application Server

1. Run Install-location\apache-tomcat-version\bin\startup.bat to start Tomcat.

2. Pick the Manager App button and log on to the Tomcat Web Application Manager page.

3. Pick Browse, then select the Cat2HostedTcIC.war file from the File Selection Dialog box.

4. Pick Deploy.

WebSphere

1. Start the WebSphere integrated solutions.

2. In the navigation tree, expand Applications and pick Install New Application.

3. In the Preparing for the Application Installation pane, enter the path or browse to locate the Cat2HostedTcIC.war file.

4. Pick Open, then pick Next

5. Accept the Fast Path default to install the application, then pick Next.

6. Accept the selected installed enterprise application and modules options then pick Next.

7. On a single server, non-clustered deployment of the application mapping to the application server already exists, so pick Next to continue.

8. The application may need to be mapped to a virtual host depending on how the WAS server is configured. Contact your WAS Administrator, if necessary. In this example, the server uses the default. Pick Next to continue.

9. Similar to other WAR file applications, enter a context root name for the application, then pick Next.

10. Toggle metadata-complete attribute, then pick Next.

11. Confirm Application Deployment selections, then pick Finish.

12. After the application has deployed, pick Save to complete the deployment process.

13. Restart WebSpheree and pool_manager services.

IIS


5-27


1. Rename Cat2HostedTcIC.war to Cat2HostedTcIC.zip.

2. Create a folder named Cat2HostedTcIC inside an existing website published by IIS for AW.

3. Extract the contents of the Cat2HostedTcIC.zip file into the Cat2HostedTcIC folder just created.

4. Restart IIS and pool_manager services.

Using InstallAnywhere : Build CATIA Libraries


Build CATIA Libraries

For xPDM (PX1) libraries compilation, set the TCIC_PX1_COMPILATION environment variable to YES before launching InstallAnywhere. The PX1 - CATIA PPR PDM Gateway Product 1 module must be installed on the client machine where PX1 libraries compilation is launched and on the client machine where the Integration is installed.

Is the PX1-CATIA PPR PDF Gateway Product 1

module installed? Value of

TCIC_PX1_Compilation Result

no YES The TCIC_PX1_COMPILATION = YES (failed) error message displays.

yes YES The TCIC_PX1_COMPILATION = YES message displays.

Refer to the following steps after Build CATIA Libraries is selected from the InstallAnywhere Choose Install Set screen.

1. For Windows installations: The CATIA Architecture panel displays when the system architecture is 64 bit (Windows 64 bit). Pick the CATIA architecture required, then pick Next to continue.


5-28


2. Pick the CATIA release used for the Integration. Enter the directory of your CATIA installation, the CATIA RADE directory, then pick Next to continue.

3. Indicate the destination folder for built CATIA libraries (CAA).



6. Review the CATIA libraries build log file then pick Next to continue.


Using InstallAnywhere : cdrom Extraction

cdrom Extraction Merge a Custom Toolbar


cdrom Extraction

Refer to the following steps after cdrom Extraction is selected from the InstallAnywhere Choose Install Set screen.

1. Indicate the directory to extract to, then pick Next to continue.





5-29


Merging a Custom Toolbar

The cdrom Extraction process does not extract the full set of binaries so CAA compilation must be performed twice in order to apply a custom toolbar. Merge a custom toolbar by performing the following steps.

1. Compile CAA using InstallAnywhere to get the OOTB compiled CAA.

2. Extract the uncompiled CAA binaries through the cdrom Extraction process.

3. Apply the custom code and compile the toolbar using %TCICV5_DIR%\install\CAACompilation.vbs.

4. Merge CAA.

The steps below use Teamcenter Integration for CATIA V5 (10.0.3). Substitute with your specific information where needed.

Compile CAA using InstallAnywhere

5. Run Teamcenter_Integration_for_CATIAV5_10.0.3_Tc9.1_WIN64.exe.

6. Select Build CATIA libraries from the Choose Install Set screen, then pick Next.

7. Select the CATIA Architecture then pick Next.

8. Enter the directory of the CATIA installation (for example, E:\Program Files\Dassault Systemes\B22) and CATIA RADE paths (for example, E:\Program Files (x86)\Dassault Systemes\T22), then pick Next.

9. Enter the Destination folder for CAA. For example, E:\CAA_10.0.3. Pick Next, then pick Install on the Pre-Installation Summary screen.

10. Review the Install Complete screen, then pick Done to complete the CAA complication.

Extract the cdrom using Install Anywhere

11. Run Teamcenter_Integration_for_CATIAV5_10.0.3_Tc9.1_WIN64.exe.

12. Review the Introduction screen then pick Next to continue.

13. Select cdrom Extraction from the Choose Install Set screen, then pick Next.

14. Enter the destination folder used to extract Teamcenter Integration for CATIA V5, then pick Next to continue.

15. Review the Pre-Installation Summary screen, then pick Install to continue.


5-30


16. After extraction has finished, comment out the TLBTcLoadAddin.cpp file from E:\CDROM_10.0.3\Teamcenter_Integration_for_CATIAV5\CAAObjects\V5R21\CV5CAAToolbar\CV5CAAToolbarTcLoadAddin.m\src

17. Run compile with CAACompilation.vbs. Enter the release number of CATIA on the CAA Complication box, then pick OK.

18. Enter the CATIA installation path, then pick OK.

19. Enter the CATIA RADE path then pick OK to finish the compilation.

Merge CAA

20. Copy the CV5CAAToolbar folder from the E:\CDROM_10.0.3\Teamcenter_Integration_for_CATIAV5\CAAObjects\V5R22 created earlier then paste it in the compiled CAA.

21. Copy/replace all the contents of:

a. E:\CDROM_10.0.3\Teamcenter_Integration_for_CATIAV5\CAAObjects\V5R22\win_b64\code\bin into E:\CAA_10.0.3\CAA\V5R22\win_b64\code\bin.

b. E:\CDROM_10.0.3\Teamcenter_Integration_for_CATIAV5\CAAObjects\V5R22\win_b64\control into E:\CAA_10.0.3\CAA\V5R22\win_b64\control.

c. E:\CDROM_10.0.3\Teamcenter_Integration_for_CATIAV5\CAAObjects\V5R22\win_b64\code\dictionary into E:\CAA_10.0.3\CAA\V5R22\win_b64\code\dictionary.

d. E:\CDROM_10.0.3\Teamcenter_Integration_for_CATIAV5\CAAObjects\V5R22\win_b64\code\lib into E:\CAA_10.0.3\CAA\V5R22\win_b64\code\lib.

e. E:\CDROM_10.0.3\Teamcenter_Integration_for_CATIAV5\CAAObjects\V5R22\win_b64\code\productIC into E:\CAA_10.0.3\CAA\V5R22\win_b64\code\productIC.

22. The merged CAA can now be used for InstallAnywhere installation using the Use Existing CAA option to apply the custom toolbar.

Customizing Teamcenter Files

The following actions are optional because the Teamcenter Integration for CATIA V5 environment performs them automatically.

This action should be performed only if the installation script failed or when installing a patch.

Replace some existing Teamcenter files by executing the following instructions.

1. Copy all lib files of %TCICV5_DIR%\Teamcenter\lib in %TC_ROOT%\lib.

The Installation Process The About integration Menu within Teamcenter and CATIA V5

5-31


2. Copy all dll files of %TCICV5_DIR%\Teamcenter\lib in %TC_ROOT%\bin.

The %TCICV5_DIR%\env\tcic_var_env.xml file contains the default value of different variables and can be customized.

Creating Cache Directories

Because some Teamcenter Integration for CATIA V5 functionalities remove all files in a given directory, it is strongly recommended to dedicate the directories listed below to the exclusive use of Teamcenter Integration for CATIA V5. Ensure there are no spaces within the catuii directory pathname.

1. Create the directories defined in the %TCICV5_DIR%\install\CATIMAN.vbs file (IM_FILES_DIR and IM_TMP_DIR).

2. Create the %WORK_DIR%\tmp and %WORK_DIR%\catuii directories if default settings are used.

The %TCICV5_DIR%\install\CATIMAN.vbs script creates these directories automatically during the install.

The About integration Menu within Teamcenter and CATIA V5

In Teamcenter, pick CATIA V5 >> Help >> About integration, or in CATIA pick, Teamcenter >> About integration to determine the Integration version and other key information related to your installation.

Configuration Details

The Configuration Details button on the About Integration panel displays detailed information related to the specific Integration version installed.

In CATIA:


5-32


In Teamcenter:

This detailed information may be copied to assist in troubleshooting. The information displayed includes:

• Version Number

• SOA Client version

• Plug-in Client version

• Server version

• CATScript version

• CAA version

• Checksums

• SOA Client files

• Plug-in Client files

• Server files

• CATScript files


5-33


• CATScript batch files

View the checksum information to determine the file modified by a software patch.

The message, File doesn't exist, replaces the checksum information when the file does not exist or for Plug-in Client information when Teamcenter RAC client does not launch when the command is launched from CATIA.

Version Number

There are five different version numbers, based on code, related to your installation. Only the latest installation of the five versions of code displays in About integration.

• SOA Client version

• Plug-in Client version

• Server version

• CATScript version

• CAA version

It is possible to have a different version numbers when a software patch has been installed. For example, when a patch related to the Client version is installed, this version number displays in the


5-34


About integration panel because it is the most recent version, or latest version (of the five) that has been installed.

In Teamcenter:

In CATIA:

The About integration panel shown above indicates the version number is 11.0.0_build2015082711. Pick the Configuration Details button to determine which version/patch was the last to be installed and view other version and configuration details.

Configuration Define Different CATIA Versions to Launch within the Integration

6-35


Configuration Chapter 6:Define Different CATIA Versions Configure Active Workspace Configure CATIA V5 Configure Teamcenter Configure Teamcenter Loader Configure the Integration

Define Different CATIA Versions to Launch within the Integration

Defining different CATIA versions to use with the Integration requires copying and editing configuration files and shortcuts.

Perform the following steps to permit different versions of CATIA to be launched within the Integration.

The data in the steps assume R18 has been successfully configured using the Installation and R19 is to be added. Substitute with your specific information where needed.

1. Copy and Paste the existing Teamcenter_Integration_for_CATIAV5 icon onto the user’s desktop.

2. Rename it to a new version, such as Teamcenter_Integration_for_CATIAV5_R19.

3. Press MB3 on the renamed icon, then pick Properties.

4. View the Target (launch command) field within the Shortcut tab of the Properties window.

"C:\Program Files\Dassault Systemes \B18\intel_a\code\bin\CATSTART.exe -run "CNEXT.exe" -env Teamcenter_Integration_for_CATIAV5 -direnv "C:\Documents and Settings\All Users\Application Data\DassaultSystemes\CATEnv" –nowindow"

5. Modify the CATSTART.exe location to the new version.

The location may need to only be changed from R18 to R19, depending on your installation path(s).

Configuration Define Different CATIA Versions to Launch within the Integration

6-2


6. Copy the Teamcenter_Integration_for_CATIAV5.txt environment file located in the directory following -direnv to the Teamcenter_Integration_for_CATIAV5_R19.txt file.

7. Edit the Target string to reflect the new name.

Assuming the new version of CATIA is installed in the same base path, (only a different Rxx number), open the copied file and replace R18 with R19 and B18 with B19.

8. Save then close the Teamcenter_Integration_for_CATIAV5_R19.txt file.

9. Confirm the new Target field displays the new path. If the new version of CATIA is located in an entirely different location, edit the original file accordingly to update the native CATIA path locations. The Integration for CATIA paths will only differ by the Rxx or Bxx.

"C:\Program Files\Dassault Systemes \B19\intel_a\code\bin\CATSTART.exe -run "CNEXT.exe" -env Teamcenter_Integration_for_CATIAV5_R19 -direnv "C:\Documents and Settings\All Users\Application Data\DassaultSystemes\CATEnv" -nowindow"

10. Pick OK to close the Properties window.

11. Launch CATIA using the new shortcut.

Launching CATIA from Teamcenter defaults to the last version of CATIA installed using the Integration.

Configuration Configure Active Workspace

6-3


Configure Active Workspace

Define Types of Clients Embedded Active Workspace Settings and Behavior Standalone Active Workspace Settings and Behaviors Load Manager Open in CATIA

A 4-tiers installation, for Embedded or Standalone Active Workspace, is recommended to better manage structures during Load processes.


Define Types of Clients

For Embedded Active Workspaces For Standalone Active Workspaces

The %TCICV5_DIR%/env/client_env file defines different clients that can be used. Change the order of clients in this file to display the client to be used in priority.

Embedded Active Workspace is defined as Client_0 , whereas Standalone Active Workspace is defined as Client_1. The ActiveWorkspaceHosting.TcIC.URL Teamcenter preference, when defined, has priority over the URL defined in the client_env file.

<client> Teamcenter Embedded Active Workspace Client http://vm-tcserver33:7031/awc Client_0 C:\Tc10.1.5_20151030_4T_t1415e_vm-tcserver33\rac </client>

6-4


<client> Teamcenter C:\Tc10.1.5_20151030_4T_t1415e_vm-tcserver33\rac\otwportal.bat Client_0 C:\Tc10.1.5_20151030_4T_t1415e_vm-tcserver33\rac </client> <client> Teamcenter Standalone Active Workspace Client http://vm-tcserver33:7031/awc Client_1 C:\Tc10.1.5_20151030_4T_t1415e_vm-tcserver33\rac </client> <client> Teamcenter Integration for CATIA V5 Loader C:\TCICV5\racless\TcICLoader.bat Client_0 C:\Tc10.1.5_20151030_4T_t1415e_vm-tcserver33\rac </client>

For Embedded Active Workspaces


Embedded Active Workspace should always be defined as Client_0.

If the Embedded Active Workspace client has been manually added to the client_env file, ensure the following:

• Set the TcIC_awhosted_menu variable to true in the %TCICV5_DIR%/env/tcic_var_env.xml file. The default value is false, so Active Workspace menu is not available in the CATIA contextual Menu.

• The Windows registry has to be updated with the %TCICV5_DIR%\aw\ aw_keys.reg file.

The Active Workspace home page displays in the CAD web browser inside CATIA. When a RACLess connection has already been established, login information is shared with Active Workspace.

6-5


For Standalone Active Workspaces

<client> Teamcenter Standalone Active Workspace Client http://vm-tcserver33:7031/awc Client_1 C:\Tc10.1.5_20151030_4T_t1415e_vm-tcserver33\rac </client>

Standalone Active Workspace should always be defined as Client_1.

If the Standalone Active Workspace client has been manually added in the client_env file, ensure that the Windows registry has been updated with the %TCICV5_DIR%\aw\ aw_keys.reg file.

The Active Workspace home page displays in the default web browser outside CATIA.

When the connection is not established, the Active Workspace Login Panel displays to enter User/Group/Role information..


6-6


Embedded Active Workspace Settings and Location

Default Setting Values Settings and Locations Visualization in Active Workspace

Use %TCICV5_DIR%\env\aw_config.properties file to configure Active Workspace settings and Embedded Web Browser behaviors.

Host-side native configuration settings in the aw_config.properties file are used to configure Active Workspace.

Name Description

allowGoHome Adds the jump to home feature on the User Interface (e.g., gateway). The default value is true.

allowThemeChange Permits the User Interface theme to be changed. The default value is true.

allowUserSessionChange Permits the user session information to be changed, i.e., users can login/logout as a different users. The default value is true.

hasFullScreenSupport Displays the client in full screen mode. The default value is true (full screen mode).

showSiemensLogo Displays the Siemens logo. The default value is true.

theme The fully qualified theme name requested for use by the host. The default value is "".

HostSupportsMultipleSelection Permits multi-selection in a structure. The default value is true.


6-7


Name Description

PinUnpin Defines if the web browser is inside or outside CATIA.

Highlight Displays the Highlight button. The default value is true.

CheckOut Displays the CheckOut button. The default value is true.

CheckIn Displays the CheckIn button. The default value is true.

CreateCATPart Displays the CreateCATPart button. The default value is true.

CreateCATProduct Displays the CreateCATProduct button. The default value is true.

LoadOptions Displays the LoadOptions button. The default value is true.

LoadCommand Displays the LoadCommand button. The default value is true.

Update Displays the Update button. The default value is true.

ShowInTc

Displays the ShowInTc button. The default value is true.


6-8


Default Setting Values

Settings=embeddedLocationView=false Location=com.siemens.splm.clientfx.tcui.xrt.showObject;page=Overview awhosted.option.AllowGoHome=true awhosted.option.AllowThemeChange=true awhosted.option.AllowUserSessionChange=false awhosted.option.HasFullScreenSupport=false awhosted.option.ShowSiemensLogo=true awhosted.option.Theme=com.siemens.splm.clientfx.ui.lightTheme awhosted.option.HostSupportsMultipleSelection=true awhosted.PinUnpin.Default=pin awhosted.PinUnpin.Display=true awhosted.Highlight.Display=true awhosted.CheckOut.Display=true awhosted.CheckIn.Display=true awhosted.CreateCATPart.Display=true awhosted.CreateCATProduct.Display=true awhosted.LoadOptions.Display=true awhosted.LoadCommand.Display=true awhosted.Update.Display=true awhosted.ShowInTc.Display=true

Settings and Location

The URL uses Settings and Location values to define the way the item should be opened in Active Workspace.

For example, when:

• Settings=embeddedLocationView=false

• Location=com.siemens.splm.clientfx.tcui.xrt.showObject;page=Overview

then the url = http://vm-tcserver28:7030/awc?embeddedLocationView=true#com.siemens.splm.clientfx.tcui.xrt.showObject;uid=gZYV3DH1qG1YeC

Settings

Settings define when the client should display in the embedded location view. When embeddedLocationView is set to false, the client displays as:


6-9


When embeddedLocationView is set to true, the client displays as:

Location

Location defines which tab elements display.

Visualization in Active Workspace

Visualization is supported with Active Workspace 4.0 by activating the IS_VIEWER_SUPPORTED option in the %TCICV5_DIR%\env\aw_config.properties file.

Set this option to false to disable visualization in Active Workspace.

awhosted.option.IS_VIEWER_SUPPORTED = true

Standalone Active Workspace Settings and Location

Use %TCICV5_DIR%\env\aw_config.properties file to configure Standalone Active Workspace settings.

Settings and Location

The URL uses Settings and Location values to define the way the item should be opened in Active Workspace.

For example, when:

• Settings=embeddedLocationView=false

• Location=com.siemens.splm.clientfx.tcui.xrt.showObject;page=Overview


6-10


then the url = http://vm-tcserver28:7030/awc?embeddedLocationView=true#com.siemens.splm.clientfx.tcui.xrt.showObject;uid=gZYV3DH1qG1YeC

Settings

Settings define when the client should display in the embedded location view. When embeddedLocationView is set to false, the client displays as:

When embeddedLocationView is set to true, the client displays as:

Location

Location defines which tab elements display.


6-11


Load Manager

Load Manager Panel Teamcenter Loader Contextual Menu Display structure Contextual Menu

Load Manager Panel

Use the %TCIC_DIR/env/loadmanager.xml file provided with the installation to configure the Load Manager panel.

The loadmanager.xml can also be found n the online documentation.

6-12


By default, the file contains the following commands

 <Command name="load_selection"/> <Command name="activate_shape"/> <Command name="export_active_shapes"/> <Command name="load_as_cgr"/> <Command name="load"/> <Command name="load_compare"/> <Command name="load_consulting"/> <Command name="lus"/> <Command name="create_exp_spreadsheet"/> <Command name="export"/> <Command name="load_as_ref"/> <Command name="export_as_ref"/>

Teamcenter Loader Contextual Menu

Use the %TCICV5_DIR%\env\tcicloader.xml file to hide commands from the Teamcenter Loader contextual menu.

The tcicloader.xml file can also be found in the online documentation.

<Command name="paste" image="/com/ebsolutions/uimanager/modules/images/loader/paste_16.png"/> <Command name="create_folder"/> <Command name="remove_folder"/> <Command name="load" image="/com/ebsolutions/uimanager/modules/images/loader/export_32.png"/> <Command name="open_dataset" image="/com/ebsolutions/uimanager/modules/images/loader/open_16.png"/> <Command name="load_compare" image="/com/ebsolutions/uimanager/modules/images/loader/export_comp_16.png"/> <Command name="load_consulting" image="/com/ebsolutions/uimanager/modules/images/loader/export_consult_16.png"/> <Command name="lus" image="/com/ebsolutions/uimanager/modules/images/loader/lus_16.png"/> <Command name="create_exp_spreadsheet" image="/com/ebsolutions/uimanager/modules/images/loader/create_spreadsheet_16.png"/> <Command name="export" image="/com/ebsolutions/uimanager/modules/images/loader/file_export_16.png"/> <Command name="load_as_ref"

6-13


image="/com/ebsolutions/uimanager/modules/images/loader/export_ref_16.png"/> <Command name="export_as_ref" image="/com/ebsolutions/uimanager/modules/images/loader/file_export_ref_16.png"/> <Command name="display_properties" image="/com/ebsolutions/uimanager/modules/images/loader/properties_32.png"/> <Command name="display_structure" image="/com/ebsolutions/uimanager/modules/images/loader/bomview_32.png"/> <Command name="load_selection"/> <Command name="highlight" image="/com/ebsolutions/uimanager/modules/images/loader/highlight_selected_16.png"/> <Command name="show_in_teamcenter" image="/com/ebsolutions/uimanager/modules/images/loader/sendto_16.png"/> <Command name="bmml" image="/com/ebsolutions/uimanager/modules/images/loader/bmml_16.png"/>

Display structure Contextual Menu

Use the %TCICV5_DIR%\env\tcicloader.xml file to hide some commands in the Display structure contextual menu.

The tcicloader.xml file can also be found in the online documentation.

<Command name="open_dataset" image="/com/ebsolutions/uimanager/modules/images/loader/open_16.png"/> <Command name="load_compare" image="/com/ebsolutions/uimanager/modules/images/loader/export_comp_16.png"/> <Command name="load_consulting" image="/com/ebsolutions/uimanager/modules/images/loader/export_consult_16.png"/> <Command name="lus" image="/com/ebsolutions/uimanager/modules/images/loader/lus_16.png"/> <Command name="create_exp_spreadsheet" image="/com/ebsolutions/uimanager/modules/images/loader/create_spreadsheet_16.png"/> <Command name="export" image="/com/ebsolutions/uimanager/modules/images/loader/file_export_16.png"/> <Command name="load_as_ref" image="/com/ebsolutions/uimanager/modules/images/loader/export_ref_16.png"/>

Configuration Configure CATIA V5

6-14


<Command name="export_as_ref" image="/com/ebsolutions/uimanager/modules/images/loader/file_export_ref_16.png"/> <Command name="display_properties" image="/com/ebsolutions/uimanager/modules/images/loader/properties_32.png"/> <Command name="display_structure" image="/com/ebsolutions/uimanager/modules/images/loader/bomview_32.png"/> <Command name="load_selection"/> <Command name="highlight" image="/com/ebsolutions/uimanager/modules/images/loader/highlight_selected_16.png"/> <Command name="show_in_teamcenter" image="/com/ebsolutions/uimanager/modules/images/loader/sendto_16.png"/> <Command name="bmml" image="/com/ebsolutions/uimanager/modules/images/loader/bmml_16.png"/>

Open in CATIA

Customize %TCICV5_DIR%\aw\TcICLauncher.bat file to define the behavior during the Open in CATIA command.

Configure CATIA V5

It's highly recommended to configure CATIA to store computation and result files in the same location as CATAnalysis files, by default.

Configure Teamcenter

Important Information: Database Configuration Active Workspace Custom Configurations Multi-site Configurations New Instance Synchronization Templates The CATIA V5 Menu in Teamcenter

Configuration Configure Teamcenter

6-15


Important Information: Database Configuration

Pick Templates Extraction from the InstallAnywhere panel to retrieve the template required for database configuration.

Start the Teamcenter Environment Manager, based on your system below, to access templates and configure the database schema.

Operating System File

Linux TC_ROOT/install/TEM.sh

UNIX TC_ROOT/install/TEM.sh

Windows TC_ROOT\install\TEM.bat

You must be logged in as a Database Administrator to complete the configuration process using the TEM files.

Active Workspace


Custom Configurations

It is recommended to adopt the standard Teamcenter Integration for CATIA configuration, however, alternate behavior may be required.

Teamcenter Integration for CATIA behavior may be modified using preferences defined in Teamcenter. For example, it is possible to define file naming conventions, BOM view type or default mapping used by the Save Manager. Preferences that are undefined adopt their default documented value.


6-16


Individual preferences may be defined using the Teamcenter Options dialog. It is also possible to import a collection of preferences to apply specific configuration requirements.

Before attempting to import preferences, it is strongly recommended to review all preference values to ensure accuracy and save the preferences as your site integration preferences file.

Perform the following steps to import a preferences .xml file.

1. Pick Edit >> Options.

2. Pick Index.

3. Pick Import from the right panel.

4. Pick the .xml preferences file.

5. Pick Site for the scope and General for the category. Site preferences apply to all users.

6. Merge the values of a given preference, if they already exist.

Multi-site Configurations

The Integration uses user-data attached to Integration relations. Set TC_always_export_user_data_for_relation_type to include Integration relations and avoid data inconsistencies caused when Integration relations are not transversed in multi-site configurations (resulting in stubs at the transfer site).

Use TC_always_export_user_data_for_relation_type to ensure the user data is always exported with GRM relations, even if the secondary object is excluded. The user data object will always have the same site ownership as the GRM relation itself.

TC_always_export_user_data_for_relation_type= catiaV5_DWGLink catiaV5_MML catiaV5_MMLAssy catia_alternateShapeRep catia_componentShapeRep catia_MFGLink catia_analysisLink catia_analysisFilesLink catia_cache_link catia_secondary_link


6-17



The PSEOccNotesNoCopy setting contains the following values after successful installation.

• catiaOccurrenceName

• catiaParentPartName

• catiaFileName

• catiaOccurrenceOEM

• catiaOccurrenceDesc

These values are checked when the New Instance Synchronization process begins during a Save Existing process. The process stops and an error message displays when one or more of these values are missing in the database. The error message specifies which value(s) is missing.

Templates

Prerequisites Access the Templates Display Specific Relations

The installation process performs the steps below when applying the template.

1. The CatiaExport tool is created.

2. Datasets are created:

• CATPart

• CATProduct

• CATSecondaryProduct

• CATSecondaryPart

• CATDrawing

• catia

• catiaSecondary

• DirectModel

• CATCgm


6-18


• CATWrl

• CATAnalysis

• CATAnalysisComputations

• CATAnalysisResults

• CATCache

• CATProcess

• CATShape

3. A BOM View type named catia is created.

4. CATIA Notes types are created:

• catiaOccurrenceName

• catiaParentPartName

• catiaFileName

• catiaOccurenceOEM

• catiaOccurenceDesc

5. CATIA Relations types are created:

• catiaV5_MML

• catiaV5_DWGLink

• catiaV5_MMLAssy

• catia_MFGLink

• catia_alternateShapeRep

• catia_analysisFilesLink

• catia_analysisLink

• catia_auxiliaryLink

• catia_cache_link


6-19


• catia_componentShapeRep

• catia_designtable_link

• catia_shapeProperties_link

• catia_secondary_link

6. Forms are created:

• catia_model_attributes

• catia_assembly_attributes

• catia_doc_attributes

• catia_published_element

• catia_shapeProperties

• catImport_attributes

7. POM Classes are created:

• POM_catImport_attr_form

• POM_catiaAssyAttributes

• POM_catiaModelAttributes

• POM_catia_absocc

• POM_catia_analysis_userdata

• POM_catia_designtable_link

• POM_catia_doc_attr_form

• POM_catia_dwg_userdata

• POM_catia_mfg_userdata

• POM_catia_mmlAssy_userdata

• POM_catia_mml_userdata

• POM_catia_publication_form

• POM_catia_shapeProperties


6-20


• POM_componentSR_userdata

8. Items to contain the datasets for seed documents are created.

• IMCATIAPart

• IMCATIAProduct

• IMCATIADrawing

• IMCATIAShape

• IMCATIAAnalysis

• IMCATIAProcess

Template Prerequisites

Conflicts may occur when customizations have been previously applied to the Integration. Run the Teamcenter TypeAnalysisTool before applying a new Teamcenter Integration for CATIA V5 template to ensure type collisions will not occur. Refer to Siemens' Teamcenter documentation for information on Template collision check and contact GTAC for support with these errors.

Accessing the Templates

Perform the following steps to access templates provided with the connector (TCICV5_DIR/install/template).

1. Pick Configuration Manager from the Maintenance panel, then pick Next.

2. Pick Perform maintenance on an existing configuration then pick Next.

3. Pick the configuration from which the corporate server was installed from the Configuration Selection pane.

4. Pick Next.

5. Pick Add/Remove Features under the Teamcenter section of the Feature Maintenance panel.

6. Pick the Browse button from the Select Features panel.


6-21


7. Pick All Files from the browsing dialog box to view all the files in the system.

8. Browse to the template files directory, i.e., TCICV5_DIR/install/template for Windows, or browse to the directory containing the extracted template.

9. Ensure Feature Files is selected to view only the template (feature) files available for installation.

10. Pick the required template's feature file (feature_integration4catia.xml).

11. Pick Select.

12. Pick the new template just chosen from the Select Features panel under Teamcenter Corporate Server (it is listed within the Selection list).

13. Pick Next.

14. Enter a username and password in the Teamcenter Administrative User Panel to log on to the server.

15. Pick Next.

16. The Database Template Summary panel displays a list of installed templates. Pick Next.

17. Pick Next from the Confirm Selections panel to confirm the selection and install the new template.


A combination of Teamcenter preferences and BMIDE configuration (using a template) is required in order to enable the display and navigation of objects using specific relation types in MyTeamcenter, Structure Manager and Design Context.

• BMIDE configuration is used to define specific relations which may later display at objects in Teamcenter, such as ItemRevisions and datasets.

• Teamcenter preferences are used to enable the display of these related objects using MyTeamcenter.

The Integration performs the necessary BMIDE configuration; it is only necessary to define Teamcenter preferences to enable the display of specific relations.


6-22


Refer to the following table for important information regarding this process.

If And Result Fix

a custom template is used to apply a BMIDE configuration

TEM is used to apply Teamcenter Integration for CATIA V5 during an update or upgrade

The update or upgrade fails due to detected collisions between the custom template and the Teamcenter Integration for CATIA V5 template. This is expected behavior.

The custom template should not be applied or, if applied, the conflicting BMIDE definitions must be removed from the custom template.

an update is performed (apply changes to existing templates without changing the Teamcenter version).

the updated template and the Integration template (optional) compatible with the current Teamcenter release is applied.

an upgrade is performed (replace one Teamcenter version with another)

Required: the updated customer template and the Integration template compatible with the current Teamcenter release must be applied.

The CATIA V5 Menu in Teamcenter

Teamcenter must be restarted after modifying preferences.

Create Dataset Items Using the PSE Menu

When the I-deas NX Manager is active or the necessary libraries (available from Siemens for Windows, Solaris and HP-UX) have been separately configured and installed, additional options under the CATIA menu of the PSE can be enabled.

These options can be used to create CATPart and CATProduct dataset(s) for selected item revisions, if they do not already exist.

Configuration Configure Teamcenter Loader

6-23


Enable these options by setting IMAN_show_open_in_ideas_button within Teamcenter Preferences.

IMAN_show_open_in_ideas_button = true

The default value is true.

Configure Teamcenter Loader


Features of the Display structure panel are controlled by the following Teamcenter preferences.

Feature Teamcenter Preference and Description

Table Column

PortalPSEColumnsShownPref :Specifies the list of PSE Columns displayed (left-to-right order). To display the Explore Checked Out property, add bl_rev_expl_checkout to this list Default value: List of BOM Lines attributes.

Table Column Size

PortalPSEShownColumnWidthsPref: Specifies the widths for the PSE shown Columns (left-to-right order). Default value: List of column sizes.

Configuration Configure Teamcenter Integration for CATIA V5

6-24


Feature Teamcenter Preference and Description

Display

PSEAutoPackPref: Indicates if the PSE display needs to be packed by default. The default value is 1. PSEImpreciseColorPref: Specifies the color to be used when displaying an imprecise BVR in PSE (defaulted to white). The value can be a standard supported string, an octal number or a hexadecimal number. The standard strings supported are black, white, lightGray, gray, darkGray, red, pink, orange, yellow, green, magenta, cyan and blue. Example for a hexadecimal number is #50b080 which represents Sea Green. The default value is white. PSEPreciseColorPref: Specifies the color to be used when displaying a precise BVR in PSE (defaulted to sea green). The value can be a standard supported string, an octal number or a hexadecimal number. The standard strings supported are black, white, lightGray, gray, darkGray, red, pink, orange, yellow, green, magenta, cyan and blue. Example for a hexadecimal number is #50b080 which represents Sea Green. The default value is #50b080. PSE_expand_on_open: Indicates if an object's root node is expanded when displayed in Structure Manager. The default value is 1.

Configure Teamcenter Integration for CATIA V5

Attribute Mappings CGR Management Ignore Nodes Import Queries Integration Schema Integration Toolbar Multiple CATIA Environments Multi-Model Link (MML) Browsing Theorem/Teamcenter Translator (JT)

Attribute Mappings

Behavior and Modifying CATIA Properties Configuring Attribute Mappings


6-25


For CATDrawings, CATParts, and CATProducts For Design Tables For Foreign Files For the Integration Schema For the Save Manager Preferences Related to Attribute Mappings

Define Attribute Mappings between CATIA and Teamcenter properties. Attribute Mappings are:

• a convenient way to link properties from CAD with properties in Teamcenter

• available for the Save, Load, Import / Export, and Update Title Block processes of Teamcenter Integration for CATIA V5.

• required for Import / Export processes. They are used to store OEM attributes of a CATIA V5 component in their corresponding form in Teamcenter during the Import process.

• used to restore OEM attributes in CATIA V5 components during the Export process.

• can be defined between a CATIA drawing text or drawing parameters and Teamcenter properties.

Refer to Teamcenter's Configuration Guide for supplemental information.

Behavior and Modifying CATIA Properties

The Definition and Revision CATIA properties are not mapped to the Item_ID and ItemRev_ID and the EBS_DatasetUID, EBS_DatasetLastVersion, and EBS_ItemRevName properties are not created.

This behavior applies to Product and Part properties and Drawing parameters. Information in the .dat file is used to create a correspondence between CATIA documents and Teamcenter datasets. Information in CATIA properties is not used.


6-26


Mappings between Revision and Itemrev_ID and Definition and Item_ID do not exist. The EBS_DatasetUID, EBS_DatasetLastVersion, and EBS_ItemRevName properties are not created.

Modify the Behavior of CATIA Properties

Definition/Revision Properties

Mappings between the Definition CATIA property and Item_ID and Revision CATIA property and ItemRev_ID can be defined as follows:

revision : ItemRevision.item_revision_id/master-iman /description="Dokument Name" Definition : ItemRevision.item_id /master-iman /description="Dokument Name"

Reference Properties

The EBS_DatasetUid and EBS_DatasetVersion properties are never created even if a mapping is defined.

Define Teamcenter mappings on the EBS_ItemRevName reference property as follows:

EBS_ItemRevName : ItemRevision.object_name /master-iman /description="Dokument Name"


6-27


Mappings between EBS_DatasetUID and Teamcenter dataset_uid is not permitted because this information is not accessible to Teamcenter mappings. Mappings between EBS_DatasetLastVersion and Teamcenter dataset_version is not permitted because this value is updated after importing the file to the database. If permitted, this would cause the CATIA property value to be modified after performing an update of CATIA properties and/or after the Load process.

Revision = ItemRev_ID Definition = Item_ID

EBS properties are created:

• EBS_DatasetUid = dataset_uid

• EBS_DatasetVersion = dataset_version

• EBS_ItemRevName = Itemrev_Name

Configuring Attribute Mappings

Determine the Real Name of a Form's Properties

Use caution when configuring Attribute Mappings to avoid potential status inconsistencies on parts, products, and/or drawings between Teamcenter and CATIA, caused by incompatible mapping definitions.


6-28


Refer to Teamcenter's Configuration Guide for supplemental information.

Important Notes

• Attribute Mappings are case-sensitive.

• Define which value takes precedence or prevent a difference from occurring at all.

• Properties must be created in the CATIA component prior to defining an attribute mapping on a new CATIA property. They cannot be mapped to non-existing property.

• When createPropForMapping is True and new properties (non-standard) are found, then the new properties are created during the attribute mapping process.

Perform the following steps to define attribute mappings.

1. Export the existing mappings to a text file.

2. Define the mappings.

3. Import the modified file into the database. When the property is created/updated in CATIA, the prefix is removed and the property is created per its type. New properties are created during the attribute mapping process when the createPropForMapping setting is True and new properties (non-standard) are found.

If Then

master = cad mappings are not available on item ID and item revision ID of Teamcenter

master = iman for a CATIA

mappings are not available on EBS_DatasetLastVersion, EBS_BvrLastModifiedDate, Revision and Definition


6-29


component CATIA properties

master = iman, for a drawing

mappings are not available on DatasetUID, ItemID, ItemRevID, catia_type_value and DatasetLastVersion CATIA properties

Determine the Real Name of a Form's Properties

The Real Names of Teamcenter properties must be used. For example, perform the following steps to determine the real name of a form's properties.

1. Open the form.

2. Pick Print the file.

3. Pick the Set result format button, then pick the Real Name option.

The same steps may be performed from within the properties panel.


6-30


Property Name displayed in the Properties Panel in CATIA

Property Name to use for mapping

Part Number partNumber

Revision revision

Definition definition

Nomenclature nomenclature

Source Source

Description (in the Product panel) description

Description (in the Component panel) DescriptionInst

MyProperty (new property created in CATIA) MyProperty

The CATIA parameters names list for a drawing :

• DatasetUID

• ItemID

• ItemRevID

• ItemRev_Name

• catia_type_value

• DatasetLastVersion

Configuring Attribute Mappings for CATDrawings, CATParts and CATProducts


6-31


CATDrawing Parameters and Text within a CATDrawing CATPart Example

Attribute mappings are required for CATDrawing, CATPart and CATProduct, and must be configured for the supplier import process.

Refer to the Export_Mappings.txt file located in the TcIC_DIR\sample folder for detailed configuration information.

CATDrawing Parameters and Text within a CATDrawing

Attribute Mappings can be defined between a CATDrawing text or drawing parameters and Teamcenter properties.

When a CATDrawing parameter is linked to a title block with a CATIA formula, the modified parameter value is propagated to the title block. However, when the title block is modified, it is not propagated back to the parameter.

Perform the following steps to define the attribute map.

1. Ensure an attribute map has been created for a CATDrawing. For example: { Dataset type="CATDrawing" { Item type="item" owner : owning_user.user_name /description="owning user" name : ItemRevision.object_name/master=cad/desciption="ItemRevision name" } }

2. Pick Formula from the Standard toolbar to create a new parameter with the name of the map.

3. Select New Parameter of type from the Formulas: Drawing dialog box.

4. Complete the Edit name or value of the current parameter fields. For example, owner and test1.


6-32


5. Repeat the previous steps for the parameter name, then pick OK when finished.

6. Add text to the drawing. Do not close the text editor.

7. Click on the green text border then use the right-mouse button and pick Attribute link to link the parameter to the text box.


6-33


8. Select Parameters from the specification tree.

9. Select the attribute name just created from the Attribute Link Panel, then pick OK. Repeat the previous steps to link the parameter name.

10. Pick the Update Title Block button from the Integration toolbar. The first text updates with attribute values of the owning user of the CATDrawing and the second text updates with the attribute values of the CATDrawing item revision name.

CATPart Example

Perform the following steps to create a custom attribute, user_data_1, attached to a CATPart.

1. Export the attribute map.

2. Modify the attribute map by adding the following line within the attribute map, as shown below: user_data_1: ItemRevision.GRM(IMAN_master_form).user_data_1.


6-34


3. Save the attribute map file, then Import it. The user_data_1 field has been added to the properties panel.


6-35


Configuring Attribute Mappings for DesignTables

Ensure the correct mappings have been added to the Attribute Mappings file. The same mappings are used for Excel and Text dataset types.

For example:

{ Dataset type-"MSExcel" { Item type-"DesignTable" OEM_partNumber : NR(catimportform).OEM_partNumber description-"Mapping Test" OEM_filePath : NR(catimportform).OEM_filePath /description-"Mapping Test" OEM_definition : NR(catimportform).OEM_definition /description-"Mapping Test" } { Item type-"Item" OEM_partNumber : NR(catimportform).OEM_partNumber /description-"Mapping Test" OEM_filePath : NR(catimportform).OEM_filePath /description-"Mapping Test" OEM_definition : NR(catimportform).OEM_definition /description-"Mapping Test" } } { Dataset type-"Text" { Item type-"DesignTable" OEM_partNumber : NR(catimportform).OEM_partNumber description-"Mapping Test" OEM_filePath : NR(catimportform).OEM_filePath /description-"Mapping Test" OEM_definition : NR(catimportform).OEM_definition /description-"Mapping Test" } { Item type-"Item" OEM_partNumber : NR(catimportform).OEM_partNumber /description-"Mapping Test" OEM_filePath : NR(catimportform).OEM_filePath /description-"Mapping Test" OEM_definition : NR(catimportform).OEM_definition /description-"Mapping Test" }


6-36


Configuring Attribute Mappings for Foreign Files

Refer to the following behavior of foreign files when CATIA_manage_foreignfiles_on_save is true.

Mapping must be added to locate a foreign file in the dataset. A mapping must be added for each dataset type listed in the CATIA_component_dataset_types preference.

Using the dataset catia causes the mapping process to add because catia is listed in the CATIA_component_dataset_types preference by default, even if the dataset is not visible in the preference. Mappings must be set when the catia is used.

Refer to the following example to add mappings for CATIA_component_dataset_types = CATwrl, CATShape.

{ Dataset type-"catia" { Item type-"Item" OEM_revision : GRM(catia_importform_link).OEM_revision /description-"Mapping Test" OEM_partNumber : GRM(catia_importform_link).OEM_partNumber /description-"Mapping Test" OEM_nomenclature : GRM(catia_importform_link).OEM_nomenclature /description-"Mapping Test" OEM_filePath : GRM(catia_importform_link).OEM_filePath /description-"Mapping Test" OEM_dlname : GRM(catia_importform_link).OEM_dlname /description-"Mapping Test" OEM_description : GRM(catia_importform_link).OEM_description /description-"Mapping Test" OEM_definition : GRM(catia_importform_link).OEM_definition /description-"Mapping Test" } } { Dataset type-"CATwrl" { Item type-"Item" OEM_revision : GRM(catia_importform_link).OEM_revision /description-"Mapping Test" OEM_partNumber : GRM(catia_importform_link).OEM_partNumber /description-"Mapping Test" OEM_nomenclature : GRM(catia_importform_link).OEM_nomenclature /description-"Mapping Test" OEM_filePath : GRM(catia_importform_link).OEM_filePath /description-"Mapping Test" OEM_dlname : GRM(catia_importform_link).OEM_dlname /description-"Mapping Test" OEM_description : GRM(catia_importform_link).OEM_description /description-"Mapping


6-37


Test" OEM_definition : GRM(catia_importform_link).OEM_definition /description-"Mapping Test" } } { Dataset type-"CATShape" { Item type-"Item" OEM_revision : GRM(catia_importform_link).OEM_revision /description-"Mapping Test" OEM_partNumber : GRM(catia_importform_link).OEM_partNumber /description-"Mapping Test" OEM_nomenclature : GRM(catia_importform_link).OEM_nomenclature /description-"Mapping Test" OEM_filePath : GRM(catia_importform_link).OEM_filePath /description-"Mapping Test" OEM_dlname : GRM(catia_importform_link).OEM_dlname /description-"Mapping Test" OEM_description : GRM(catia_importform_link).OEM_description /description-"Mapping Test" OEM_definition : GRM(catia_importform_link).OEM_definition /description-"Mapping Test" } }

Configuring Attribute Mappings for the Integration Schema

Perform the following steps to set Attributes Mappings for Import / Export management.

1. Export the existing mappings to a .txt file using the export_attr_mappings utility. Refer to the sample export_mappings.txt file in the TcIC_DIR\sample\AttributesMappings folder, if necessary.

2. Edit the file by adding, removing or modifying mappings. Refer to the sample attribute_mappings.txt file in the TcIC_DIR\sample\AttributesMappings folder, if necessary.

3. Import the mapping file, using the import_attr_mappings utility. Refer to the sample import_mappings.txt file in the TcIC_DIR\sample\AttributesMappings folder, if necessary.

Add lines within the attribute_mappings.txt file, in the TcIC_DIR\sample\AttributesMappings folder, for CATProduct, CATPart and CATDrawing dataset types in your mappings to use the Import/Export processes.


6-38


Configuring Attribute Mappings for the Save Manager

Save Manager attributes mappings are not case sensitive.

CATIA properties can only be mapped to Save Manager properties individually, one at a time.

Save Manager attributes mappings are resolved only during the following scenarios:

• Create New components in CATIA

• The save mode is changed to Create New or Save As New. Save Manager attribute mappings are not applied when the save mode is change to Save As Copy.

• The Clear/Erase button is selected and the save mode is changed to Create New.

• The item type is changed in the Save Manager panel.

Customize Attribute Mappings

Customize the Save Manager Attribute Mappings to automatically complete fields in the Save Manager dialog for new items. For example, use Attribute Mappings to automatically add the CATIA Part Number to the Item Type Name field in the Save Manager.

Any CATIA property may be used as a mapping in the Save Manager, including custom properties. The CATIA filename property can be mapped to an item revision attribute or a dataset attribute in the Save Manager panel.

Use any combination of the following variables in Teamcenter Preferences to map a CATIA property to a Save Manager property.


6-39


• CATIA_savemanager_map_ir_attr: used to map a CATIA property to an item revision attribute in the Save Manager panel.

• CATIA_savemanager_map_ds_attr: used to map a CATIA property to a dataset attribute in the Save Manager panel.

The prefix, attr, may be applied to an item revision or dataset real name property as shown below.

• CATIA_savemanager_map_ir_item_id

• CATIA_savemanager_map_ir_item_revision_id

• CATIA_savemanager_map_ir_object_name

• CATIA_savemanager_map_ir_object_type

• CATIA_savemanager_map_ir_object_desc

• CATIA_savemanager_map_ds_pubr_object_id

• CATIA_savemanager_map_ds_rev

• CATIA_savemanager_map_ds_object_name

• CATIA_savemanager_map_ds_object_type

• CATIA_savemanager_map_ds_object_desc

Any CATIA property may be used, including custom properties, as a mapping in the Save Manager.

CATIA_savemanager_map_ir_item_id = partNumber CATIA_savemanager_map_ds_object_name= description CATIA_savemanager_map_ds_object_desc= custom_CATIA_property


6-40


Modify Behavior

The following Save Manager Attributes must be modified by the Administrator to change their behavior.

CATIA Property Save Manager Property

definition Item ID

revision Revision

partNumber Revision Name

Preferences Related to Attribute Mappings

Create Non-standard CATIA Properties Nomenclature and PartNumber Properties in CATIA


Create Non-standard CATIA Properties

Set CATIA_create_catia_properties_for_mapping to true to create non-standard CATIA properties corresponding to mappings if they are found during the Save and Load processes. Set it to false to prevent non-standard CATIA properties corresponding to mappings from being created, even if they are found.

CATIA_create_catia_properties_for_mapping = false

The default value is false.

This preference corresponds to the previous com.ebsolutions.catia.createPropForMapping property defined in the catiaV5properties.properties file, now obsolete.


6-41


Nomenclature and PartNumber Properties in CATIA

Declare two Teamcenter properties to define the Nomenclature and PartNumber properties in CATIA by setting CATIA_MAP_Property_Nomenclature and CATIA_MAP_Property_PartNumber. A blank line marks the end of the definition.

Multiple values are permitted.

CATIA_MAP_Property_Nomenclature= Dataset.object_name Dataset.creation_date CATIA_MAP_Property_PartNumber= Item.object_name Dataset.object_type

In this example, dataset name (Dataset.object_name) and the dataset creation date (Dataset.creation_date) define a value of the Nomenclature property in CATIA and item name (Item.object_name)define a value of the PartNumber property in CATIA.

Property values are separated by the value of the CATIA_reference_partnumber_separator Teamcenter Preference.

The required format for Teamcenter preferences values is ClassName.RealNameProperty.

The RealNameProperty corresponds to the Teamcenter Property Real Name and ClassName corresponds to values shown below:

ClassName

Item Item

Item Revision ItemRevision

Dataset Dataset

BOMView Revision PSBOMViewRevision


6-42


ClassName

Item Master ItemMaster

ItemRevisionMaster ItemVersionMaster

Perform the following steps to display properties:

1. Pick an item or item revision.

2. Right click then pick Properties... from the pop-up menu.

3. Pick the Print object properties button from the Properties form.

4. The Property Display Name column displays in the Object Properties form. Pick the Set

Result Format button .


6-43


5. Toggle Real Name on from the Print Format form to display the Property Real Name column, then pick Update.

6. The Property Real Name column displays in the Object Properties form. Pick one or more names in the attribute list to define, as needed.


6-44


Multi-Field Key Functionality/Part Number Conflicts

Ensure CATIA_MAP_Property_PartNumber is set to Item.multifieldkey to avoid part number conflicts when managing multi-field key functionality. Attribute values of multi-field key can be defined for an item’s class. Attributes values are ordered as it is defined in the multi-field key.

CATIA_partnumber_separator = _ CATIA_MAP_Property_PartNumber = Item.multifieldkey, ItemRevision.item_revision_id CATIA_MAP_Property_Nomenclature = Item.multifieldkey

For example, an item is Cat2ItemMFK10{item_id,cat2str_3,cat2str4}. The values: item_id = id1, cat2str_3 = value1, cat2str_4 = value2, item_revision_id = A results in PartNumber value = id1_value1_value2_A and the Nomenclature value is id1_value1_value2.


6-45


CGR Management

Overview Configure CATIA Configure Teamcenter

Overview

CGR (.cgr) is a lightweight visualization format adopted by CATIA to visually represent parts when accessed within the context of an assembly. CGR files consume less memory which is helpful with large assemblies.

When the Work with the cache system CATIA option is toggled on, CATIA creates CGR files for each CATPart in the local Cache directory, when an assembly is opened.

CGR and CATShape files can also be saved in Teamcenter during the Save process. This greatly improves the Load process performance and prevents CATIA from creating CGR files on the fly when the assembly is opened.

During the Load process, CATParts and CGR files are exported from Teamcenter, and CGR files are placed into the CATIA cache directory before the assembly is opened in CATIA, allowing faster load of the assembly.

Settings must be configured in order to create cache files. The Integration's CGR Management functionality is available during the Save and Load processes. CGRs can be stored locally or in cache.

Configuration

Activate the CGR Management functionality within the Integration by creating the following configurations in CATIA and in Teamcenter.

Both CATIA and Teamcenter must be configured.


6-46


Configure CATIA

Perform the following steps within CATIA to ensure CATIA cache is activated prior to using the CGR Management functionality.

1. Pick Options.

2. Pick the Cache Management tab from the Options window.

3. Toggle the Work with the cache system option on.

4. It is recommended to enable the GMT timestamp format option to prevent failures during the Winter/Summer time change period. Using local time, rather than GMT, can cause time/date issues to occur.

5. Pick OK when finished.

Configure Teamcenter

Ensure the following Teamcenter configuration/environment settings have been established prior to using the CGR Management functionality.

1. CATIA_cache_dataset_type

2. CATIA_cache_dataset_link

3. CATIA_cache_managed_on_load

4. CATIA_cache_managed_on_save

6-47


5. **CATIA_cache_path

6. **CATIA_CACHE_PATH_ENV (environment setting)

**Settings 5 and 6 define the export location.

CATIA_cache_dataset_type

Name Default Value Purpose

CATIA_cache_dataset_type CATCache Dataset type used to store Cache files. This dataset type must contain two Named References. Values can be modified.

Refer to the following example to define a new dataset type called CATCache2 containing a CGR Named Reference called myCgr and a CATShape Named Reference called myCATshape.

This newly created dataset type can be used to store Cache files by indicating CATIA_cache_dataset_type = CATCache2.

</TcDataset> <TcDataset parentTypeName="Dataset" typeClassName="Dataset" typeName="CATCache2"> <TcDSViewTool name="CatiaExport" /> <TcDSEditTool name="CatiaExport" /> <TcDatasetReference name="myCgr"> <TcDatasetReferenceInfo format="BINARY" template="*.cgr" /> </TcDatasetReference> <TcDatasetReference name="myCatShape"> <TcDatasetReferenceInfo format="BINARY" template="*.CATShape" /> </TcDatasetReference> </TcDataset>


6-48


CATIA_cache_dataset_link, CATIA_cache_managed_on_load, CATIA_cache_managed_on_save


CATIA_cache_dataset_link catia_cache_link Link type used to link Cache dataset with CATPart/catia/jt/CATShape datasets

CATIA_cache_managed_on_load false

Do not manage Cache files during Load processes (false)

Teamcenter must be restarted to apply changes made to this preference.

CATIA_cache_managed_on_save false

Do not manage Cache files during Save processes (false)

Teamcenter must be restarted to apply changes made to this preference.

Export Criteria

Refer to the criteria below to determine the location of exported CGR files based on defined settings.

The Integration determines the location to export CGR files based on the following criteria.

CGR files are exported to the local cache directory when any of the criteria is not met.

1. CGR files are exported to the path defined in the CATIA_CACHE_PATH_ENV environment variable when:

• the path exists on your system and

• the path is a released cache and

• the user has write access.

2. If the CATIA_CACHE_PATH_ENV criteria is not met, CGR files are exported to the path defined in the CATIA_cache_path Teamcenter Preference when:


6-49


• the path exists on your system and

• the path is a released cache and

• the user has write access.

3. If none of the above criteria is met, CGR files are exported to the local cache directory.

Export Location

Ensure the following settings have been established to correctly export CGR files.


CATIA_cache_path Local Cache path as defined within CATIA Options

Path where Cache files are exported to during Load processes.Refer to the export criteria for specific information.

The maximum length of the CATIA_cache_path is 240 characters.

CATIA_CACHE_PATH_ENV environment setting User defined

Path where Cache files are exported to during Load processes. Refer to the export criteria for specific information.

Use the CATIA_CACHE_PATH_ENV environment setting to define the path Cache files are exported to during Load processes.

CATIA_CACHE_PATH_ENV = C:\Released_Cache\Cache1

Configuring Ignore Nodes

A list of permissible Ignore Node prefixes must be manually defined in an IgnoreNodesIdentifiers.txt file.

The IgnoreNodesIdentifiers.txt file is not created during the installation of Teamcenter Integration for CATIA.

Perform the following steps to create the IgnoreNodesIdentifiers.txt file and place the file in its correct location.

1. Create a new text file named IgnoreNodesIdentifiers.txt and enter one prefix per line. Prefixes are case-sensitive.


6-50


2. Save the IgnoreNodesIdentifiers.txt file in the following directory:

• Windows:%TCICV5_DIR%\env\

• UNIX: $TCICV5_DIR/env/

The Load for Compare prefix, comp_ , used in the CATIA_load_for_compare_prefix setting, must not be included in the list of Ignore Nodes prefixes.

Import Queries

Build an Import Query Create New Import Preferences Item Revision Browser Query Supplier Import Queries

Customize queries used during the Import process. Import forms are managed using a GRM Link. As a result, the import query returns the form type.


6-51


Previous to Teamcenter Integration for CATIA V5 (8.3.0), the import forms were managed as a Named Reference to the dataset. Beginning with Teamcenter Integration for CATIA V5 (8.3.0), import forms are now managed using a GRM Link, and as a result: Import queries for CATProduct, CATPart, CATDrawing and CATDesignTables must be changed when installing the 8.3.0 version of the Integration. Named Reference (catimportform) must be replaced by GRM (catia_import_form_link) for attribute mapping

An example of the new import query can be found in TcIC_DIR\sample\ImportExport and an example of the new attribute mapping field can be found in TcIC_DIR\sample\ImportExport.

Build an Import Query

Perform the following steps to build an import query.

1. Log into Teamcenter with Administrator privileges.

2. Pick the Admin tab, then pick Query Builder.

3. Enter a name for your query in the Name field of the Query Builder form. Enter a description, if desired.

4. Pick the Search Class pull-down list.

5. Navigate or expand to POM_application_Object >> WorkspaceObject >> Form as the search class for your query.


6-52


6. Double-click on Attributes within the Form node.

7. Navigate or expand to POM_object >> POM_application_object >> POM_catimport_attr_form to pick your import forms class definition.

The attributes defined for your import forms (such as OEM_definition and OEM_revision) display within the Attributes Selection box


6-53


8. Double-click on each attribute that matches your requirements to add them to your Search Criteria.

9. Pick Create when finished.

Currently, these names should be exactly the same as the ones used for the import form attributes.


6-54


Create New Import Preferences


Modifying all Import preferences is not mandatory. However, query attributes names must match your catImportForm attributes names (case-sensitive), such as OEM_filePath , OEM_definition. As a rule, mappings, form fields and query attributes names must be spelled exactly the same way (case-sensitive). Failure to do so may lead to inconsistent results.

Create New Preferences:

• CATIA_ifs_catpart_query = name of query

• CATIA_ifs_catproduct_query = name of query

• CATIA_ifs_catdrawing_query = name of query

• CATIA_ifs_designtable_query = name of query

• CATIA_ifs_foreignfile_query = name of query


6-55


When the individual queries listed below are created, it is not necessary to create the preferences listed above (CATIA_ifs_).

• ifs_catdrawing_query

• ifs_catproduct_query

• ifs_catpart_query

• ifs_designtable_query

• ifs_foreignfile_query

The Integration executes your queries using the following fields of the Import form:

• OEM_partNumber

• OEM_definition

• OEM_revision

• OEM_nomenclature

• OEM_description

• OEM_filePath

• OEM_dlname

• OEM_Source

When different names and/or different fields for your queries are required, modify Teamcenter Preferences by adding the following and the corresponding catImport form fields used:

Multiple values are permitted for these preferences.

CATIA_ifs_catpart_query = the name of the query

The default value is IFS_CATPart_query.

CATIA_ifs_catproduct_query = the name of the query

The default value is IFS_CATProduct_query.

CATIA_ifs_catdrawing_query = the name of the query


6-56


The default value is IFS_CATDrawing_query.

CATIA_ifs_designtable_query = the name of the query

The default value is IFS_CATDesignTable_query.

CATIA_ifs_foreignfile_query = the name of query

The default value is IFS_CATForeignFile_query.

CATIA_ifs_catpart_query_attr = attr1 attr2 ...

The default values are OEM_partNumber, OEM_definitions, OEM_revision, OEM_nomenclature, OEM_description, OEM_filePath, OEM_dlname.

CATIA_ifs_catproduct_query_attr = attr1 attr2 ...

The default values are OEM_partNumber, OEM_definition, OEM_revision, OEM_nomenclature, OEM_description, OEM_filePath, OEM_dlname.

CATIA_ifs_catdrawing_query_attr = attr1 attr2 ...

The default values are OEM_filePath, OEM_dlname.

CATIA_ifs_designtable_query_attr= attr1 attr2 ...


CATIA_ifs_foreignfile_query_attr= attr1 attr2 ...


6-57



Item Revision Browser Queries

Item revisions queries must be defined for the Item Revision Browser, which displays during the Save process. Queries can be imported from an existing .xml file, as detailed below, or they can be manually created.

Perform the following steps to import the queries from an existing .xml file.



3. Pick Import.

4. Browse on the Read Query Definition window to locate the ItemRevBrowser_query.xml file in the TcIC_DIR\sample\ItemRevBrowser folder.

5. Pick the file, then pick Import. Ensure it is the correct file, then pick OK on the Import window to continue.

6. Pick Create on the Query Builder.

Manually Build the Item Revision Browser Query

Supplier Import Queries must adhere to the following naming convention:

• ItemRevBrowser_query

Supplier Import Queries

Four import queries must be defined for supplier import functions. The queries can be imported from an existing .xml file, as detailed below, or they can be manually created.

Perform the following steps to import the queries.



3. Pick Import.

4. Browse on the Read Query Definition window to locate the four .xml files within the TcIC_DIR\sample\ImportExport folder.

• IFS_CATDrawing_query.xml


6-58


• IFS_CATPart_query.xml

• IFS_CATProduct_query.xml

• IFS_CATDesignTable_query.xml

• IFS_CATForeignFile_query.xml

5. Pick one of the files, then pick Import. Ensure it is the correct file, then pick OK on the Import window to continue.

6. Pick Create on the Query Builder.

7. Repeat the previous steps to import the remaining two files.

Manually Build the Supplier Import Queries

Supplier Import Queries must adhere to the following naming conventions:

• IFS_CATDrawing_query

• IFS_CATPart_query

• IFS_CATProduct_query

• IFS_CATDesignTable_query

• IFS_CATForeignFile_query


6-59


Developing the Integration Schema

The Integration Schema How Teamcenter Integration for CATIA Manages CATIA Components Create the CatiaExport Tool Seed Documents

This section explains how to manually configure the Teamcenter Database schema to customize the Teamcenter Integration for CATIA V5 software on your client workstations.

Refer to Teamcenter Database section for information on applying the default configuration of the Teamcenter database for use with Teamcenter Integration for CATIA V5.

Teamcenter Integration for CATIA V5 is case-sensitive.

The Integration Schema

The following attributes are automatically completed by Teamcenter Integration for CATIA when the TC_Allow_Longer_ID_Name Teamcenter Preference is set to false (default).

Attributes names Type Length Notes

CATIA OCCURRENCE NAME CHAR --- Contains the CATIA V5 occurrence name.

DATASET DESCRIPTION CHAR Up to

72 ---

DATASET NAME CHAR 32 Same as item ID.

DATASET VERSION CHAR --- Automatically incremented.

ITEM ID CHAR 32 Given by Teamcenter Integration for CATIA.


6-60



ITEM NAME CHAR 32 The first 32 characters of the CATIA V5 product, part or drawing.

ITEM REVISION CHAR --- ---

PSE SEQUENCE NUMBER CHAR --- ---

The following attributes are automatically completed by Teamcenter Integration for CATIA when the TC_Allow_Longer_ID_Name Teamcenter Preference is set to true:


CATIA OCCURRENCE NAME CHAR --- Contains the CATIA V5 occurrence name.

DATASET DESCRIPTION CHAR Up to

72 ---

DATASET NAME CHAR 128 Same as item ID.

DATASET VERSION CHAR --- Automatically incremented.

ITEM ID CHAR 128 Given by Teamcenter Integration for CATIA.

ITEM NAME CHAR 128 The first 32 characters of the CATIA V5 product, part or drawing.


6-61



ITEM REVISION CHAR --- ---

PSE SEQUENCE NUMBER CHAR --- ---

How Teamcenter Integration for CATIA Manages CATIA Components

The following can be stored in Teamcenter for each CATIA product, part or drawing:

• An item and an item revision.

• A dataset and CATProduct, CATPart or CATDrawing, and a dataset version.

• A specific link between an item revision and a dataset.

• The BOM view attached to the created item for an assembly.

• A BOM view revision attached to the created item revision.

• A catia_model_attribute type attached to the item revision for a part.

• A catia_assembly_attribute type for a product.

• A catiaOccurrenceName note containing the CATIA occurrence name of the part or the product.

The relative positions of parts or products are stored within the occurrence of the item revision of the BOM during a CATIA session.

Several datasets can be linked to one item. However, a referenced CATPart and a referenced CATProduct cannot be linked to the same item revision. Use standard functionalities of Teamcenter to link a referenced CATpart and a referenced CATProduct to the same item revision.


6-62


Create the CatiaExport Tool

Use the Business Modeler IDE (BMIDE) to create the template and configure the database schema.

The template contains the following:

• CatiaExport Tool

Seed Documents

Item ID names are defined in the following Teamcenter Preferences:

• CATIA_seed_part_id

• CATIA_seed_product_id

• CATIA_seed_drawing_id

• CATIA_seed_analysis_id

• CATIA_seed_catshape_id

• CATIA_seed_process_id

Create a Seed Document

There are two methods to create a seed document.

1. In Teamcenter

2. During the Integration Save process

Any dataset of a corresponding seed document may be loaded when datasets containing seed documents exist and are loaded without a Named Reference.

A dataset cannot be loaded without a Named Reference when seed documents are not defined and when the CATIA Manual input Part Number option not is selected from the Options dialog. In this case, Seed documents must be defined. Due to a CATIA limitation, it is not possible to


6-63


have Dynamic Seeds for a CATDrawing and activate Auxiliary Files, in combination.

Create a Seed Document During the Integration's Save Process

Perform the following steps with Administrator privileges to create a seed document during the Integration's Save process.

1. In Teamcenter, create a new item. Ensure the item ID matches the seed preference value, for example, ensure the item ID matches the value of CATIA_seed_part_id.

2. Add a new dataset to the item just created.

3. In CATIA, create or open a document to use as the seed document.

4. Pick the Save to Teamcenter command in CATIA.

5. Ensure the Dataset Name field in the Save Manager relates to the dataset just added, then continue to Save process.

Create a Seed Document in Teamcenter

A seed item can contain several datasets of the same type. An Integration seed panel displays when several dataset are found during a load process, to select the correct seed document to load.

Perform the following steps with Administrator privileges to create a seed document in Teamcenter.

1. Create the item(s) or item revision(s) in Teamcenter. Ensure it has the same ID as the value defined in the preference for the seed document type.

2. Create the CATpart, CATProduct, CATDrawing, CATAnalysis, CATShape or CATProcess as needed.

3. Add a Named Reference to the dataset. Ensure a valid Named Reference is added based on the seed type.

Multiple Seed Documents

Multiple seed documents can be attached to each item type; CATPart, CATProduct, CATDrawing and CATShape. When multiple seed documents are available for a given type, pick the appropriate seed document. When loading from the PSE, pick the same seed document for individual parts/products or for all parts/products.

The seed document must be created and attached to the dataset first, prior to creating multiple seeds.


6-64


Perform the following steps to create multiple seed documents for a CATPart.

1. Ensure the first seed document has been created.

2. In Teamcenter, add a new dataset with the same dataset type as the existing dataset under the IMCATIAPART/A item revision, i.e., the current seedpart.

3. Add any Named Reference to the dataset just created.

4. Load the dataset in CATIA using the Integration.

5. In CATIA, remove or modify the geometry as needed.

6. Pick a Save process from Teamcenter.

7. Ensure the Dataset Name field in the Save Manager relates to the dataset added under the IMCATIAPART/A, then continue the Save process.

Integration Toolbar

Configure Environment Messages Configure Icons

The Integration toolbar comprises different toolbars.

Save Import Load Add CATShape Utility Replace Load as cgr

Save

Import

Load

6-65


Add CATShape

Utility

Replace Load as cgr

Configure Environment Messages

Perform the following steps to change an icon's tooltip and command displayed in the status bar.

1. Edit the TeamcenterHeader.CATNls file located in the %TCICV5_DIR%\bin\CAA\V5R<CATIA version>\toolbar\intel_a\resources\msgcatalog directory.

2. The following lines display for each icon/command defined in the toolbar. In the example below, Save indicates the icon/command associated to these lines:

TeamcenterHeader.Save.Title = "Cmd Teamcenter" TeamcenterHeader.Save.ShortHelp = "" TeamcenterHeader.Save.Help = "" TeamcenterHeader.Save.LongHelp = ""

Configure Icons

Perform the following steps to associate an icon to a specific menu command.

1. Save the new icon in the %TCICV5_DIR%\bin\CAA\V5R<your CATIA version>\toolbar\intel_a\resources\graphic\icons\normal directory.

2. Open the TeamcenterHeader.CATRsc file located in the %TCICV5_DIR%\bin\CAA\V5R<your CATIA version>\toolbar\intel_a\resources\msgcatalog directory.


6-66


3. Modify the TeamcenterHeader.CATRsc file by replacing the current name of the icon with the new name.

For example, Load, in the line below, refers to the Load command and I_01001UGS_Load indicates the icon name associated to the Load command. Change the I_01001UGS_Load icon name to the new icon to associate it to the Load command.

TeamcenterHeader.Load.Icon.Normal = "I_01001UGS_Load"

Configuring Multiple CATIA Environments

Customize CATIA Running Scripts Launch Different CATIA Versions View the Log Files Preferences Related to Multiple CATIA Environments

Multiple CATIA environments are supported and can be customized for specific environments in order to:

• prevent saving an assembly back to Teamcenter in a different CATIA environment than when previously saved

• prevent delivering data to CATIA that will fail to load due to different CATIA environments

• launch CATIA using the correct version and environment during batch processes.

Customize CATIA Running Scripts

View the Log File before proceeding.

Perform the following modifications to the CATIA running script to control multiple CATIA environments.

The LaunchCatia.bat script for Windows

Use the LaunchCatia.bat script in Windows to permit/prevent CATIA from being launched in a batch mode and to run an interactive CATIA session (use the last launched CATIA version). This script can also be modified to prevent CATIA from starting from Teamcenter.

Permit/Prevent Launch in Batch Mode and Run an Interactive Session

Perform the following modifications to the Windows script, as required.


6-67


Remove the %5 as displayed in red below to prevent CATIA from launching in Batch Mode.

Replace the %5 with -batch as displayed in red below to force CATIA to launch in Batch Mode.


6-68


Modify the path name of the script by modifying the LOG_File variable as shown in red below.

Prevent CATIA from Starting from Teamcenter

Modify LaunchCATIA.bat script as follows to prevent CATIA from starting from Teamcenter.

An error message will display during a load from Teamcenter.


6-69


The LaunchCatia.sh script for UNIX

Use the LaunchCatia.sh UNIX script to launch a new CATIA session (or a CATIA session running in batch mode). If the process wasn't started from CATIA, UNIX is unable to use a running session, for instance, a load launched from the CATIA V5 Teamcenter menu. In that case, a new CATIA session is started.

Perform the following modifications to the UNIX script, as required.

Remove the %5 as displayed in red below to prevent CATIA from launching in Batch Mode.


6-70


Replace the %5 with -batch as displayed in red below to force CATIA to launch in Batch Mode.


6-71


Modify the path name of the script by modifying the LOG_File variable as shown in red below.

Launch Different CATIA Versions

Different CATIA versions can be launched within the Integration, but must be successfully defined by copying and editing configuration files and shortcuts.

Refer to your Administrator and to the Define Different CATIA Versions section to permit different CATIA versions to be launched within the Integration.

Launch a different version of CATIA using a shortcut. Launching CATIA from Teamcenter defaults to the last version of CATIA installed using the Integration.


6-72


View the Log File

Before performing modifications to the CATIA Running Scripts, view the appropriate log file listed below to determine parameters used to run CATIA, the name of the CATScript to launch, etc.

File Location Log File Name

Windows: %WORK_DIR%\tmp LaunchMacro.bat.out

UNIX: $WORK_DIR/tmp LaunchMacro.sh.out

Preferences Related to Multiple CATIA Environments


CATIA Environment Compatibility

Customize the CATIA_CE_Alias_xxx setting, where xxx is the environment found in the catia_doc_attributes form, to indicate the CATIA environment is compatibility

CATIA_CE_Alias_Ugs_ce = Ugs_ce_2

The example above indicates that CATIA is running with the Ugs_ce_2 environment and as a result:

If... Then

an item containing a form is Saved into Teamcenter and the form indicates OEM_CATIA_Env = Ugs_ce_2

The item in CATIA and the Teamcenter environment are compatible.

Both CEs (Ugs_ce and Ugs_ce_2) must be defined within the CATIA_CE_EnvList, using the same spelling.


6-73


Check the Environment During the Load/Save Process

Use CATIA_check_env to control multiple CATIA environments by checking the environment during the load/save processes.

CATIA_check_env = NONE

The default value is NONE.

Value Result

NONE

Default value. Multiple CATIA environments and CATIA revisions are not managed.

• Teamcenter does not save CATIA revisions • Loading of data to CATIA occurs without CATIA revision checks

(leaving the process to native CATIA) • Data loaded may be saved to Teamcenter regardless of last

saved version. • New data may always be saved using the current revision and

environment.

REV

The CATIA version is only managed. The CATIA version and environment is written to the form during a Save operation. The CATIA version is read from the form during a Load operation.

• Multiple CATIA revisions are managed for the Load process • Multiple CATIA environments are not managed for the Save

process • Loading of data to CATIA is prevented when the active CATIA

revision is lower than the saved revision • Data loaded may be saved to Teamcenter regardless of last

saved revision. • New data may always be saved using the current revision and

environment.


6-74


Value Result

ENV

The CATIA version and environment are managed. The CATIA version and environment are written to the form during a Save operation. The CATIA version is read from the form during a Load operation. If a CATIA session does not exist, the environment written in the form of the root is used to launch CATIA with the correct environment.

• Multiple CATIA revisions are managed for the Load process • Multiple CATIA environments are managed for the Save process • The current CATIA environment must be declared • Teamcenter records the CATIA revision and environment • Loaded data to CATIA is prevented when the active CATIA

revision is lower than the saved revision • Data loaded may be saved to Teamcenter provided the current

CATIA environment or defined Alias matches the data being saved

• New data may always be saved using the current revision and environment.

The CATIA_check_env fails when its value is set to ENV and an alias has not been defined. It will not fail if it is set to REV and an alias has not been defined.

6-75


If CATIA is not launched, then the following process determines the correct CATIA environment.

• CATIA_check_env preference

• The catia_env file

• The root item of the assembly being loaded.

Value Result

NONE Default value. Multiple CATIA environments are not managed. The environment used is the default environment as defined within the <ENV></ENV> tags.

REV

The Integration searches the root item of the assembly if the item to be loaded was selected from the PSE, otherwise the root item is the selected item from My Teamcenter. The Integration reads the OEM_CATIA_Version field value of the root item and searches the first environment corresponding to its value. If the search fails, the default environment is used.

ENV

The Integration searches the root item of the assembly if the item to be loaded was selected from the PSE, otherwise the root item is the selected item from My Teamcenter. The Integration reads the OEM_CATIA_Env field value of the root item and searches the first environment corresponding to its value. If the search fails, the default environment is used.

Define the Environment and the Nickname Written in Teamcenter

Customize the CATIA_CE_EnvList setting.

Multiple values are permitted.

The CATIA_CE_EnvList setting must contain the following values.

1. The name of the CATIA text file that contains the CATIA environment definition (i.e., Teamcenter_manager_for_CATIAV5.txt located within the All Users\Application Data\DassaultSystemes\CATEnv directory). For assistance in locating this file, please see your CATIA Administrator.


6-76


2. The nickname that will be written in Teamcenter.

Its value must include both the CATIA_env_name and alias, for example:

CATIA_CE_EnvList = CATIA_env_name_1 Alias_1

The CATIA environment and a CE associated to the CATIA environment must be defined within this setting.

CATIA_CE_EnvList = Teamcenter_manager_for_CATIA_V5 Ugs_ce

Multiple environments may also be defined within this setting. Ensure the setting contains one environment name followed by a nickname.

CATIA_CE_EnvList = Teamcenter_manager_for_CATIA_V5 Ugs_ce CATIA_R16_CAA Ugs_ce_2

Multi-Model Link (MML) Browsing Using My Teamcenter

Teamcenter Preferences for Multi-Model Link (MML) Browsing Using My Teamcenter


Perform the following steps to configure Teamcenter for MML browsing.

1. Edit the following files.

• explorer_user.properties

• Teamcenter Preferences

Teamcenter Integration for CATIA V5 includes changes required for the explorer_user.properties file in the catiacommon.jar file.


6-77


2. Perform the following entries in Teamcenter Preferences. Refer to Teamcenter documentation for the description/behavior of these preferences.

catiaV5_MML_relation_primary = CATPart CATProduct

catiaV5_MMLAssy_relation_primary = CATPart CATProduct

catiaV5_DWGLink_relation_primary = CATDrawing

catia_CgmLink_relation_primary = DrawingSheet

The following example shows the results of a typical browse session after the configuration is completed.


6-78


Configuring the Theorem/Teamcenter Translator

The catia2jt script for Theorem Translator Call catiav5tojtdirect Service in Workflow Preferences related to Dispatcher Services

The catia2jt script for the Theorem Translator

Perform the following steps to configure the catia2jt script for the Theorem translator.

1. Locate the catia2jt.bat or catia2jt file in the following Integration install directory: %TCICV5_DIR%\bin\WIN32 or $TCICV5_DIR/bin/{Os}.

2. Ensure the correct translator path for TS_INST=C:\Translator_Path is included in catia2jt.bat or catia2jt.

3. Define CATIAV5_ENV and CATIAV5_DIRENV. For example, CATIAV5_ENV = Teamcenter_Integration_for_CATIAV5 and CATIAV5_DIRENV = C:\apps\catia\R19\CATEnv.

4. Ensure the correct V5_EXE/V4_EXE line is activated in the catia2jt.bat or catia2jt file (Siemens or Theorem).

Call catiav5tojtdirect Service in Workflow

The TSTK-CreateTranslationRequest handler must be configured to call the catiav5tojtdirect service in workflow.

A handler for each DatasetType must be defined separately in workflow in order to create a JT for each CATIA dataset.

TSTK-CreateTranslationRequest handler syntax:

ProviderName=SIEMENS ServiceName=Catiav5tojtdirect Priority=1 DatasetTypeName=CATPart


6-79


Preferences Related to Dispatcher Services


Use DISPATCHER_rqst_on_specific_dataset_revision to use a specific revision (true) or the latest revision (false, default) of a dataset during Dispatcher Services.

DISPATCHER_rqst_on_specific_dataset_revision = false

The default value is false.

Customizing Teamcenter Integration for CATIA V5

7-1


Customizing Teamcenter Integration Chapter 7:for CATIA V5

BOMView Type Contextual Menu or Toolbar Dataset Browser Define the Environment Display Messages in the System Language Import Spreadsheet Editor Integration Toolbar Item Revision Browser JT: The catia2jt Script MML Browser Display Modify the Look & Feel Save Manager Special Characters Status Window Teamcenter Loader

Customizing Teamcenter Integration for CATIA V5 BOMView Type

7-2


BOMView Type


Customize the BOM View Type by setting CATIA_Bom_name within Teamcenter Preferences.

CATIA_Bom_name= newBomView

The default value is catia.

Create and Customize a Contextual Menu or Toolbar

Create a Contextual Menu Customize a Contextual Menu Create a New Toolbar

Create a Contextual Menu

Refer to this section as a guide to create a new contextual menu and insert commands.

The Teamcenter menu in the CATIA toolbar can be customized like all standard contextual menus in CATIA.

Customizing Teamcenter Integration for CATIA V5 Create and Customize a Contextual Menu or Toolbar

7-3


Implementing the CATIContextualMenu interface involves two main steps:

1. Create the Contextual Menu Description Class

2. Create the Contextual Menu

Create the Contextual Menu Description Class

1. Create the CTXMenuProductAddin.h file. The implementation class is derived from the CATICtxMenuProvider adapter class.

#include "TIE_CATICtxMenuProvider.h" class ExportedByCADPolToolbarContextualMenuAddin CTXMenuProductAddin : public CATBaseUnknown { CATDeclareClass; public : /** * Class constructor */ CTXMenuProductAddin (); /** * Class destructor */ virtual ~CTXMenuProductAddin (); /** * Contextual Menu creation * @return A pointer to the contextual menu created */ HRESULT GetContextualMenu(CATBaseUnknown* i_object, CATCmdContainer* o_contextual_menu); private : /** * Set the titles to the contextual menu */ HRESULT SetContextualMenuTitle(); /** * Copy constructor, must not be implemented * Set as private to prevent from compiler automatic creation as public * @return A pointer to the contextual menu */ CTXMenuProductAddin (CTXMenuProductAddin&); /** * Assigment operator, must not be implemented


7-4


* Set as private to prevent from compiler automatic creation as public * @return A pointer to the contextual menu */ CTXMenuProductAddin& operator=(CTXMenuProductAddin&); };

2. Create the CTXMenuProductAddin.cpp file.

/*---------------------------------------------------------------------------*/ /*Creates the CADPolToolbarHeader command header class*/ MacDeclareHeader(CADPolToolbarHeader); /*---------------------------------------------------------------------------*/ /*Declares the implementation of CTXMenuAddin class*/ CATImplementClass(CTXMenuProductAddin, Implementation, CATBaseUnknown, CATnull); /*---------------------------------------------------------------------------*/ /*Declares the interfaces implemented by CTXMenuProductAddin class*/ #include "TIE_CATICtxMenuProvider.h" TIE_CATICtxMenuProvider(CTXMenuProductAddin);...

The CTXMenuProductAddin class states that it implements the CATICtxMenuProvider interface because of the TIE_ CATICtxMenuProvider macro. The CATImplementClass macro declares that the CTXMenuProductAddin class is an implementation, due to the implementation keyword. The third argument must always be set as CATBaseUnknown or CATNull for any kind of extension. The constructor contains the main code and the destructor is empty.

... CTXMenuProductAddin::CTXMenuProductAddin () : CATBaseUnknown() { Creating the Contextual Menu } CTXMenuProductAddin::~CTXMenuProductAddin () { }

3. Update the interface dictionary, for example, the CADPolToolbar.dico file. The directory's pathname is concatenated at run time in the CATDictionaryPath environment variable. It declares that the CTXMenuProductAddinCusto component implements the CATICtxMenuProvider interface, whose code is located in the libCADPolToolbarContextualMenuAddin shared library or DLL.


7-5


CTXMenuProductAddin CATICtxMenuProvider libCADPolToolbarContextualMenuAddin

Create the Contextual Menu

In this use case, the contextual menu associated with the UIActive object is retrieved first due to the GetContextualMenu method of the adapter class. This menu, p_contextual_menu, is completed with one command (MyCommand_Custo). A separator is also added.

... /*---------------------------------------------------------------------------*/ /*Creates the add-in and arrange the commands of the Contextual Menu*/ HRESULT CTXMenuProductAddin::GetContextualMenu(CATBaseUnknown* i_object, CATCmdContainer* o_contextual_menu) { CATUnicodeString contextual_menu_title; /*contextual menu pointer*/ NewAccess(CATCmdContainer, p_contextual_menu, TcCtxMenuAddin); /*add-in and command for Load Merge Selected Level*/ NewAccess (CATCmdStarter, p_command1, command1); SetAccessCommand (p_command1, "MyCommand_Custo"); AddAccessChild (p_contextual_menu, p_command1); /*separator*/ NewAccess (CATCmdSeparator, p_separator1, separator1); AddAccessChild (o_contextual_menu, p_separator1); /*set the contextual menu title*/ contextual_menu_title = CATMsgCatalog::BuildMessage("CADPolToolbarHeader", "CADPolToolbarHeader.CtxMenu"); p_contextual_menu->SetTitle(contextual_menu_title); SetContextualMenuTitle(); /*set the contextual menu*/ SetAccessNext(p_separator1, p_contextual_menu); return S_OK; } ...

The p_contextual menu, is completed because of the macros contained in the CATCreateWorkshop file:

NewAccess

• A command starter is created as a CATCmdStarter instance using the NewAccess macro. The p_command1 variable handles a pointer to the instance, and command1 is


7-6


its identifier. A separator access is created as a CATCmdSeparator instance using the NewAccess macro. The pSeparator1 variable handles a pointer to the instance and separator1 is its identifier.

SetAccessCommand

• A command header is associated with a command starter using the SetAccessCommand macro. The second parameter of the macro is the command header identifier defined as the first parameter of the command header constructor. For example, MyCommand_Custo.

AddAccessChild/SetAccessNext

• The AddAccessChild macro enables linking the p_command1 access to the last access of _p_contextual_menu. The SetAccessNext macro enables chaining the other accesses to the p_command1 access.

Customize a Teamcenter Contextual Menu

Refer to this section as a guide to insert commands into the Teamcenter contextual menu of an object. The Teamcenter contextual menu provides quick shortcuts to common actions which can be performed on the selection.

The Teamcenter menu in CATIA can be customized like all standard contextual menus in CATIA. Modify LBTcMenuAddin.cpp file of the %TCICV5_DIR%/…/ CV5CAAToolbarTcMenuAddin.m module to customize your own implementation


7-7


.

Use the GetContextualMenu method to insert additional commands and separator.

1. Modify CTXMenuProductAddin.cpp file of the CV5CAAToolbarContextualMenuAddin.m module, provided in the CD-ROM extraction kit, (CV5CAAToolbarContextualMenuAddin.m\src\CTXMenuProductAddin.cpp)to add your own command “MyCommand_Custo” after the Highlight in Teamcenter command and a separator.

... /*---------------------------------------------------------------------------*/ /*Creates the add-in and arrange the commands of the Contextual Menu*/ HRESULT CTXMenuProductAddin::GetContextualMenu(CATBaseUnknown* i_object, CATCmdContainer* o_contextual_menu) { CATUnicodeString contextual_menu_title; /*contextual menu pointer*/ NewAccess(CATCmdContainer, p_contextual_menu, TcCtxMenuAddin); /*add-in and command for Load Merge Selected Level*/ NewAccess (CATCmdStarter, p_command1, command1); SetAccessCommand (p_command1, "Cat2Load_merge_SelectedLevel"); AddAccessChild (p_contextual_menu, p_command1);


7-8


/*add-in and command for Load Merge Target*/ NewAccess (CATCmdStarter, p_command2, command2); SetAccessCommand (p_command2, "Cat2Load_merge_Target"); SetAccessNext (p_command1, p_command2); /*add-in and command for Read Linked Document*/ NewAccess (CATCmdStarter, p_command3, command3); SetAccessCommand (p_command3, "Cat2Read_linked_documents"); SetAccessNext (p_command2, p_command3); /*separator*/ NewAccess (CATCmdSeparator, p_separator1, separator1); SetAccessNext (p_command3, p_separator1); /*add-in and command for Insert*/ NewAccess (CATCmdStarter, p_command4, command4); SetAccessCommand (p_command4, "Cat2Insert"); SetAccessNext (p_separator1, p_command4); /*add-in and command for Replace*/ NewAccess (CATCmdStarter, p_command5, command5); SetAccessCommand (p_command5, "Cat2Replace"); SetAccessNext (p_command4, p_command5); /*add-in and command for ReplaceByRevision*/ NewAccess (CATCmdStarter, p_command6, command6); SetAccessCommand (p_command6, "Cat2ReplaceByRevision"); SetAccessNext (p_command5, p_command6); /*separator*/ NewAccess (CATCmdSeparator, p_separator2, separator2); SetAccessNext (p_command6, p_separator2); /*add-in and command for Replace Load As Cgr*/ NewAccess (CATCmdStarter, p_command7, command7); SetAccessCommand (p_command7, "Cat2ReplaceLoadAsCgr"); SetAccessNext (p_separator2, p_command7); /*separator*/ NewAccess (CATCmdSeparator, p_separator3, separator3); SetAccessNext (p_command7, p_separator3); /*add-in and command for Check-in*/ NewAccess (CATCmdStarter, p_command8, command8); SetAccessCommand (p_command8, "Cat2Check_In_Selection"); SetAccessNext (p_separator3, p_command8); /*add-in and command for Check-out*/ NewAccess (CATCmdStarter, p_command9, command9); SetAccessCommand (p_command9, "Cat2Check_Out_Selection_Ctx"); SetAccessNext (p_command8, p_command9); /* add-in and commande for statesDetailed*/ NewAccess (CATCmdStarter, p_command10, command10); SetAccessCommand (p_command10, "Cat2DetailedStates");


7-9


SetAccessNext (p_command9, p_command10); /* add-in and command for Highlight in Teamcenter */ NewAccess (CATCmdStarter, p_command11, command11); SetAccessCommand (p_command11, "Cat2HighlightInTc"); SetAccessNext (p_command10, p_command11); /*separator*/ NewAccess (CATCmdSeparator, p_separator4, separator4); SetAccessNext (p_command6, p_separator4); /* add-in and command for MyCommand_Custo */ NewAccess (CATCmdStarter, p_command12, command12); SetAccessCommand (p_command12, "MyCommand_Custo"); SetAccessNext (p_command11, p_command12); /*separator*/ NewAccess (CATCmdSeparator, p_separator5, separator5); AddAccessChild (o_contextual_menu, p_separator5); /*set the contextual menu title*/ contextual_menu_title = CATMsgCatalog::BuildMessage("CV5CAAToolbarHeader", "CV5CAAToolbarHeader.TcCtxMenu"); p_contextual_menu->SetTitle(contextual_menu_title); SetContextualMenuTitle(); /*set the contextual menu*/ SetAccessNext(p_separator5, p_contextual_menu); return S_OK; } /*Set the titles to the Contextual Menu*/ HRESULT CTXMenuProductAddin::SetContextualMenuTitle() { CATUnicodeString menu_title; CATCommandHeader *p_command = NULL; /*SetTitle to Load Merge Selected Level*/ ::CATAfrGetCommandHeader("Cat2Load_merge_SelectedLevel", p_command); menu_title = CATMsgCatalog::BuildMessage("CV5CAAToolbarHeader", "CV5CAAToolbarHeader.Cat2Load_merge_SelectedLevel.ShortHelp"); p_command->SetTitle(menu_title); /*SetTitle to Load Merge Target*/ ::CATAfrGetCommandHeader("Cat2Load_merge_Target", p_command); menu_title = CATMsgCatalog::BuildMessage("CV5CAAToolbarHeader", "CV5CAAToolbarHeader.Cat2Load_merge_Target.ShortHelp"); p_command->SetTitle(menu_title); /*SetTitle to Read Linked Document*/ ::CATAfrGetCommandHeader("Cat2Read_linked_documents", p_command);


7-10


menu_title = CATMsgCatalog::BuildMessage("CV5CAAToolbarHeader", "CV5CAAToolbarHeader.Cat2Read_linked_documents.ShortHelp"); p_command->SetTitle(menu_title); /*SetTitle to Insert*/ ::CATAfrGetCommandHeader("Cat2Insert", p_command); menu_title = CATMsgCatalog::BuildMessage("CV5CAAToolbarHeader", "CV5CAAToolbarHeader.Cat2Insert.ShortHelp"); p_command->SetTitle(menu_title); /*SetTitle to Replace*/ ::CATAfrGetCommandHeader("Cat2Replace", p_command); menu_title = CATMsgCatalog::BuildMessage("CV5CAAToolbarHeader", "CV5CAAToolbarHeader.Cat2Replace.ShortHelp"); p_command->SetTitle(menu_title); /*SetTitle to ReplaceByRevision*/ ::CATAfrGetCommandHeader("Cat2ReplaceByRevision", p_command); menu_title = CATMsgCatalog::BuildMessage("CV5CAAToolbarHeader", "CV5CAAToolbarHeader.Cat2ReplaceByRevision.ShortHelp"); p_command->SetTitle(menu_title); /* SetTitle to Replace Load As CGR*/ ::CATAfrGetCommandHeader("Cat2ReplaceLoadAsCgr", p_command); menu_title = CATMsgCatalog::BuildMessage("CV5CAAToolbarHeader", "CV5CAAToolbarHeader.Cat2ReplaceLoadAsCgr.ShortHelp"); p_command->SetTitle(menu_title); /*SetTitle to Check-in*/ ::CATAfrGetCommandHeader("Cat2Check_In_Selection", p_command); menu_title = CATMsgCatalog::BuildMessage("CV5CAAToolbarHeader", "CV5CAAToolbarHeader.Cat2Check_In_Selection.ShortHelp"); p_command->SetTitle(menu_title); /*SetTitle to Check-out*/ ::CATAfrGetCommandHeader("Cat2Check_Out_Selection_Ctx", p_command); menu_title = CATMsgCatalog::BuildMessage("CV5CAAToolbarHeader", "CV5CAAToolbarHeader.Cat2Check_Out_Selection_Ctx.ShortHelp"); p_command->SetTitle(menu_title); /*SetTitle to Detailed States*/ ::CATAfrGetCommandHeader("Cat2DetailedStates", p_command); menu_title = CATMsgCatalog::BuildMessage("CV5CAAToolbarHeader", "CV5CAAToolbarHeader.Cat2DetailedStates.ShortHelp"); p_command->SetTitle(menu_title); /* SetTitle to Highlight in Teamcenter */ ::CATAfrGetCommandHeader("Cat2HighlightInTc", p_command); menu_title = CATMsgCatalog::BuildMessage("CV5CAAToolbarHeader",


7-11


"CV5CAAToolbarHeader.Cat2HighlightInTc.ShortHelp"); p_command->SetTitle(menu_title); /* SetTitle to MyCommand_Custo */ ::CATAfrGetCommandHeader("MyCommand_Custo ", p_command); menu_title = CATMsgCatalog::BuildMessage("CV5CAAToolbarHeader", "CV5CAAToolbarHeader.MyCommand_Custo.ShortHelp"); p_command->SetTitle(menu_title); return S_OK; }

2. Define actions related to MyCommand_Custo command in the CATCommand::Activate() method.

...CATStatusChangeRC MyCommandCusto::Activate(CATCommand* ip_from_client, CATNotification* ip_evt_dat) { CATApplication* p_application = CATApplication::MainApplication(); p_application->AddTimeOut(1, (CATCommand*)this, NULL, (void(*)())MyCommandCusto::Execute); RequestDelayedDestruction(); return(CATStatusChangeRCCompleted); }

3. Define the resource file associated to the command in the CV5CAAToolbarHeader.CATNls and CV5CAAToolbarHeader.CATRsc files.

... CV5CAAToolbarHeader.MyCommand_Custo.Icon.Normal = "I_04003_MyCommand_Custo";

... CV5CAAToolbarHeader.MyCommand_Custo.Title = "Cmd MyCommand_Custo"; CV5CAAToolbarHeader.MyCommand_Custo.ShortHelp = "MyCommand_Custo"; CV5CAAToolbarHeader.MyCommand_Custo.Help = "MyCommand_Custo"; CV5CAAToolbarHeader.MyCommand_Custo.LongHelp = "MyCommand_Custo";


7-12


Create a New Toolbar

Create a Toolbar Create a Toolbar using CAA

Create a Toolbar

Perform the following steps to manually create a toolbar.

1. In CATIA, select Tools >> Customize, pick the Toolbars tab then pick the New... button.

2. Select the new toolbar from the list, then pick Add Commands to add the TcIC commands available from the list. Pick OK when finished.


7-13


Create a Toolbar using CAA

The toolbar can be developed in CAA when TcIC commands are only available in CAA mode.

Perform the following steps to create a new toolbar through the TIE_CATIAfrGeneralWksAddin interface implementation.

Insert an additional toolbar and commands utilizing the CreateToolbars method. In this use case, TLBTcUtilityAddin.cpp, CreateToolbars method implements TLBTcUtilityAddin containing a MyCommand_Custo command.

... /*---------------------------------------------------------------------------*/ #include "TIE_CATIAfrGeneralWksAddin.h" TIE_CATIAfrGeneralWksAddin(TLBTcUtilityAddin); ... /*---------------------------------------------------------------------------*/ CATCmdContainer* TLBTcUtilityAddin::CreateToolbars() {

Customizing Teamcenter Integration for CATIA V5 Dataset Browser

7-14


/*toolbar pointer*/ NewAccess(CATCmdContainer, p_toolbar_utility, TLBTcUtilityAddin); /*add-in and command for Check-in*/ NewAccess (CATCmdStarter, p_command1, command1); SetAccessCommand (p_command1, "MyCommand_Custo"); SetAccessChild (p_toolbar_utility, p_command1); /*set the toolbar title*/ SetAccessTitle(p_toolbar_utility, "TLBTcUtilityAddin"); /*set (1) for a visible toolbar, (-1) for an invisible toolbar otherwise*/ AddToolbarView(p_toolbar_utility, 1, Top); return p_toolbar_utility; } /*---------------------------------------------------------------------------*/ /*Set the commands to the Teamcenter_save toolbar*/ void TLBTcUtilityAddin::CreateCommands() { /* Demonstrator : * - identifier of the command header * - name of the module * - name of the command class * - arguments for the command class */ /*command for Check-in*/ new CADPolToolbarHeader("MyCommand_Custo", "CADPolExecution", "CADMenuContextuel", (void*)NULL); }

3. Define the resource file associated to the command in the CADPolToolbarHeader.CATNls and CADPolToolbarHeader.CATRsc files.

... CADPolToolbarHeader.MyCommand_Custo.Icon.Normal = "I_04003_MyCommand_Custo";

... CADPolToolbarHeader.MyCommand_Custo.Title = "Cmd MyCommand_Custo"; CADPolToolbarHeader.MyCommand_Custo.ShortHelp = "MyCommand_Custo"; CADPolToolbarHeader.MyCommand_Custo.Help = "MyCommand_Custo"; CADPolToolbarHeader.MyCommand_Custo.LongHelp = "MyCommand_Custo";

7-15


Dataset Browser

Add/Remove Columns Column Width and Titles Modify Column Titles Reorder Columns

Use the Dataset Browser to select a dataset to use when saving a document. The Dataset Browser is available from the Save Manager and Item Revision Browser.

Modify the $TCICV5_DIR/env/datasetbrowser.xml file under the Save Module element to customize the Dataset Browser. Ensure the encoding of the modified datasetbrowser.xml file is compatible with the printable character set of the .xml file to avoid unpredictable behavior.

Add/Remove Columns

Add and/or remove columns within the Dataset Browser Table by modifying the column elements found within the nameRef = Save Module attribute. Each column element contains an attribute name (i.e., <Column name="description"/>) specifying the property to display in the column.

Remove a column from the table by removing its column element within the datasetbrowser.xml file. Add a column to the table by adding a new column element within the datasetbrowser.xml file.

For example, add the following lines within the datasetbrowser.xml file:

to add the CATIA File Name column:

<column name="former_file_name"/>

to add the Created Dataset Date column:

<column name="TC Dst creation_date"/>

7-16


Column Width and Titles

Adjust the width of the Database Browser Table columns by modifying the columns' width attribute within each column element found within the nameRef = Save Module attribute. The value of the column width attribute specifies the default width of the column in pixels. If no value is displayed next to the column element, the column widths automatically adjust to fit its content.

For example, to display a width of 60 pixels for the CATIA Status column, the attribute should be written as: <Column name="TC Dst last_mod_date" width="60"/>

Modify Column Titles

Modify column titles of the Dataset Browser Table by modifying the display attribute within each column element found within the nameRef = Save Module attribute.

The column titles display the value in its display attribute. If no value is assigned, the default localized string is used to display the title of the column depending on the name attribute value. The display attribute overrides the column default name, but no localization is applied to the display attribute value.

For example, to display the title, State In CATIA, for the catia_status column, the attribute would be written as: <Column name="TC Dst last_mod_date" display="Last Modification Date"/>

Reorder Columns

Reorder columns within the Dataset Browser by modifying the order of the column elements found within the nameRef = Save Module attribute.

The columns within the Dataset Browser Table display in the same order as displayed within the list. Rearrange the order of this list to rearrange the order of the columns within the table.

The code shown below causes the Dataset Browser to display in the following order:

1. Dst Object

2. Dst Type

3. Dst Description

4. Dst Last Modified Date

5. Dst Checked-out

6. Dst Checked-out User

7. Dst Is Modifiable

Customizing Teamcenter Integration for CATIA V5 Define the Environment

7-17


 <Column name="TC Dst object_string"/> <Column name="TC Dst object_type"/> <Column name="TC Dst object_desc"/> <Column name="TC Dst last_mod_date"/> <Column name="TC Dst checked_out"/> <Column name="TC Dst checked_out_user"/> <Column name="TC Dst is_modifiable"/> </Module>

Define the Environment

Customizing the CATIA_env File

The CATIA_env file is created during the installation of Teamcenter Integration for CATIA, and describes the environment defined during the installation (the CATIA version, installation path and environment filename).

The CATIA_env file also supports multiple CATIA environments (XML Tags <ENV>, CATIA version, installation path, environment filename and CATEnv filepath).

Environment CATIA_env is defined within...

Windows %TCICV5_DIR%\env\catia_env

UNIX $TCICV5_DIR/env/catia_env

When installing Teamcenter Integration for CATIA as a new installation, the CATIA_env file contains only one environment as defined with the information selected during the installation.

Refer to the following information when the installation overwrites an existing installation the CATIA_env file.

• When the previous Integration version corresponds to a 7.0.0 (or higher) release, the CATIA_env file format is correct. A new default block (the <ENV>..</ENV>) contains the information selected during the InstallShield process.

Environments similar to the default environment are not copied. For instance, if the default environment is CATIAV5_R16_CAA then all environments with the same name are not copied to the new CATIA_env file.

7-18


• When the previous Integration version does not correspond to a 7.0.0 (or higher) release, the CATIA_env file format is not correct. The default environment is created, and the InstallShield attempts to update this environment by detecting the CATIA_env directory and verifying the environment exists in this directory (for example CATIA_V5R17_CAA.txt). If an error occurs, the old information is not copied to the new CATIA_env file otherwise a <ENV>..</ENV> block is created.

Customizing the CATIA_env File

Use caution when modifying the CATIA_env file to ensure the following: -- The first block (<ENV>....</ENV>) is the default format. -- Each environment must contain all four pieces of information, listed below.

The CATIA_env file must contain the following four pieces of information:

1. The CATIA V5 release (14, 15, 16, 17...).

2. The path to the CATStart.exe file: C:\ProgramFiles\DassaultSystemes\B16\intel_a\code\bin.

3. The name of the CATIA environment, such as, CATIA_V5R16_CAA which corresponds to the CATIA_V5R16_CAA.txt file.

4. The location of the CATIA environment file. For example: C:\Documents and Settings\All Users\Application Data\DassaultSystemes\CATEnv.

7-19


Each CATIA environment must be defined within the <ENV></ENV> tags. The first <ENV>...</ENV> block corresponds to the default environment. All entries in the CATIA_env file must be mapped to the corresponding entries defined by the CATIA_CE_EnvList preference.

For example:

When the Load command runs from Teamcenter without executing the script in CATIA, the assembly is loaded in CATIA.

When CATIA is not running, the CNEXT command is run with the environment defined in the CATIA_env file.

When working with CAA code, CATIA is run with the CAA environment (e.g. : CATIA_V5R11_CAA for CATIA V5R11) in the environment path defined during the installation of the Integration.

When working with CATScript code, CATIA is run with the default environment; there is no environment name and no path with which to find the environment file in the CATIA_env file.

Customizing Teamcenter Integration for CATIA V5 Display Messages in the System Language

7-20


Display Messages in the System Language

To display messages in the system language, copy the en directory within the messages directory and rename it using the system language name.

You must also translate the messages in both CATIA and Teamcenter directories in the appropriate language. For example:

Language System Language Name

English eg

French fr

Chinese zh

The order of messages in the files is very important. An incorrect order of messages causes them to become corrupted. Do not use more than four consecutive '~' characters in messages because it is reserved for comments. Do not use the '=' character in messages because it is used as separator between a message and its identifier.

Import Spreadsheet Editor

Preferences Related to the Import Spreadsheet Editor

The Import Spreadsheet Editor extends the Save Manager Application and can be customized by modifying the $TCICV5_DIR/env/sprdshteditor.xml file.

Customizing Teamcenter Integration for CATIA V5 Import Spreadsheet Editor

7-21


When the sprdshteditor.xml file is modified, ensure the encoding of the modified sprdshteditor.xml file is compatible with the printable character set of the .xml file to avoid unpredictable behavior.

Refer to the Save Manager Customization section for customization information, replacing savemanager.xml with sprdshteditor.xml.

Display Additional Information Within the Title of the Spreadsheet Editor

The Spreadsheet Editor panel title area can display additional information related to the current Teamcenter connection (User, Group, Role) and CATIA environment. The display format of this information is defined in the CATIA_ui_title_format preference.

When this preference is empty, information related to the current Teamcenter connection (User, Group, Role) and CATIA environment does not display.

Preferences Related to the Spreadsheet Editor Panel


Display Additional Information Within the Title of the Spreadsheet Editor Panel

The Spreadsheet Editor panel title area can display additional information related to the current Teamcenter connection (User, Group, Role) Current Project Name and CATIA environment. Define the title pattern displayed on the Spreadsheet Editor panel using the string below. When this preference is empty, no additional information displays.

{0} = user

{1} = group

Customizing Teamcenter Integration for CATIA V5 Teamcenter Integration for CATIA V5 Toolbar

7-22


{2} = role

{3} = name of the current CATIA environment

{4} = current project name

CATIA_ui_title_format = ({0}–{1}/{2} [{4}] [{3}])

The default value is ({0} – {1} / {2} [{4}] [{3}]) which displays as user-group / role [current project name] [name of current CATIA environment].

This preference is used for the title of the Save Manager panel, Spreadsheet Editor panel and the State Details panel.

Teamcenter Integration for CATIA V5 Toolbar

Hide All or Parts of the Toolbar Icon Descriptions and File Names

Refer to Dassault's CATIA documentation to customize the Integration toolbar.

Hide All or Parts of the Toolbar

Use the Hide method available under the CATCmdContainer class to hide all or parts of the Integration toolbar. For example, to hide the Utility toolbar:

... /*---------------------------------------------------------------------------*/ #include "TIE_CATIAfrGeneralWksAddin.h" TIE_CATIAfrGeneralWksAddin(TLBTcUtilityAddin); ... /*---------------------------------------------------------------------------*/ CATCmdContainer* TLBTcUtilityAddin::CreateToolbars() { /*toolbar pointer*/ NewAccess(CATCmdContainer, p_toolbar_utility, TLBTcUtilityAddin);


7-23


/*add-in and command for Check-in*/ NewAccess (CATCmdStarter, p_command1, command1); SetAccessCommand (p_command1, "MyCommand_Custo"); SetAccessChild (p_toolbar_utility, p_command1); /*set the toolbar title*/ SetAccessTitle(p_toolbar_utility, "TLBTcUtilityAddin"); /*hide the Utility Toolbar*/ p_toolbar_utility->Hide(); return p_toolbar_utility; }

Icon Descriptions and File Names

Refer to the table below for the icon's description and location.

Save Import Load Add CATShape Utility Replace Load as cgr Descriptions and File Names

Save

Import

Load

Add CATShape


7-24


Utility

Replace Load as cgr

Descriptions and File Names

Command Name Description Toolbar Icon

Cat2AddCATShape (CAA only)

Launches the Add CATShape Shape Representations command.

Add CATShape

Cat2CreateAllSpreadsheets or CreateAllSpreadSheets.CATScript

Creates one spreadsheet containing the data of several assemblies in order to import them.

Import

Cat2EditImportSpreadsheet (CAA only)

Opens the Spreadsheet Editor in order to edit and modify the import spreadsheet

Import

Cat2ImportAllAssemblies or ImportAllAssemblies.CATScript

Saves many assemblies originating from a supplier in Teamcenter from CATIA V5.

Import

Cat2Load or Load.CATScript

Loads an assembly from Teamcenter to CATIA V5. Load


7-25



Cat2Load_merge or Load_merge.CATScript

Load Merge an assembly from Teamcenter to CATIA V5 from a selection in the PSE Portal.

Load

Cat2Load_merge_SelectedLevel or Load_merge_SelectedLevel.CATScript

Load Merge a subassembly from Teamcenter to CATIA V5 from a selection in CATIA. Only the selected component and its children parts are exported.

Load

Cat2Load_merge_Target or Load_merge_Target.CATScript

Load Merge an assembly from Teamcenter to CATIA V5 from a selection in CATIA. The selected component and all children components are exported.

Load

Cat2Insert or Insert.CATScript

Permits elements from Teamcenter to be inserted in CATIA.

Load

Cat2Replace or Replace.CATScript

Permits elements from Teamcenter to be replaced in CATIA.

Load

Cat2ReplaceByRevision or Cat2ReplaceByRevision.CATScript

Replaces the element selected in CATIA by the corresponding Revision stored in Teamcenter

Load


7-26



Cat2Refresh or Refresh.CATScript

Reloads a selected checked-in subassembly or component in CATIA.

Load

Cat2Read_linked_documents or Read_linked_documents.CATScript

Reads the linked documents of the components from the active window in CATIA V5 from Teamcenter to CATIA V5.

Load

Cat2SynchronizeActiveShapes (CAA only)

Launches the Synchronize Active Shape Representations command.

Load

Cat2ReplaceLoadAsCgr or Cat2ReplaceLoadAsCgr.CATScript

Replaces a CGR component with the corresponding CATPart from Teamcenter.

Replace Load as cgr

Cat2Save (CAA only)

Saves an assembly in Teamcenter from CATIA V5. The Save mode is selected from a panel in the Portal.

Save

Cat2SaveAs (CAA only)

Saves the selected components as new, existing or revised in Teamcenter from CATIA V5.

Save


7-27



Cat2SaveSelected (CAA only)

Saves a selected component as existing or as new revision in Teamcenter from CATIA V5. For a subassembly, it saves only the first level of children.

Save

Cat2Teamcenter or Teamcenter.CATScript

Displays the Teamcenter window.

Teamcenter Menu

Cat2Documentation (CAA only)

Displays the Teamcenter Integration for CATIA V5 Documentation

Teamcenter Menu

Cat2UserSettings (CAA only)

Connects to the RACLess Application to change Group, Role and Project of the current RACLess Application

Teamcenter Menu

Cat2AboutIntegration (CAA only)

Displays detailed information related to the Teamcenter Integration for CATIA V5 version installed

Teamcenter Menu ---

Cat2Update_TitleBlock or Update_TitleBlock.CATScript

Updates the title block of a drawing in CATIA V5 from Teamcenter.

Utility

Cat2Check_In_Selection (CAA only)

Checks-in the selected references in Teamcenter. Utility

Customizing Teamcenter Integration for CATIA V5 Item Revision Browser

7-28



Cat2Check_Out_Selection (CAA only)

Checks-out the selected references in Teamcenter. Utility

Cat2DetailedStates (CAA only)

Displays status information about elements loaded into CATIA.

Utility

Cat2UpdateStatus (CAA only)

Displays and/or updates the savable status of selected documents in the CATIA specification tree. It also displays the configurable status.

Utility

Cat2HighlightInTc

Highlight occurrences of documents which are selected in the CATIA specification tree, in the Teamcenter window of the Structure Manager.

Utility

Cat2ShowInTeamcenter Show in Teamcenter Utility

Cat2BrowseMML or BrowseMML.CATScript

Launches the Multi-model Links Browser. Utility

Cat2PurgeStagingDir or PurgeStagingDir.CATScript

Purges the staging directory. Utility


7-29



Add/Remove Columns Adjust Column Widths Modify Column Titles Reorder Columns

The Item Revision Browser displays when the Search button is selected from the Save Manager panel or when a selected element is not found in the database during automatic Save as New Revision, Use Existing Item, Use Existing Dataset operations.

Use the Item Revision Browser from the Save Manager panel to search for and select an item revision from the database to be used during the New Revision, Use Existing Item and Use Existing Dataset processes. Search results display in the query results table and the Save Manager uses the selected item.

Refer to the queries import documentation if the itemrevbrowser_query.xml has not been imported into Teamcenter before modifying the search query.

Search results display in the search query table of the Item Revision Browser. Modify the $TCICV5_DIR/env/itemrevbrowser.xml file in the Save Module/Module element to customize this table.

Queries that do not return an item or an item revision are not supported and will not display in the Item Revision Browser.

7-30


Add/Remove Columns


Add and/or remove columns within the search query table by modifying the column elements found within the nameRef = Save Module attribute. Each column element contains an attribute name (i.e., <Column name="item_id"/>) specifying the property to display in the column.

Remove a column from the table by removing its column element within the itemrevbrowser.xml file. Add a column to the table by adding a new column element within the itemrevbrowser.xml file. Refer to the following example, if necessary.

For example, add the following lines within the itemrevbrowser.xml file:




<column name="TC Dst Date Created"/>

to add the item comment of the ItemRev Master Form:

<column name="TC ItemRevMaster item_comment"/>

to add a CATIA description:

<column name="CATIA description"/>

Adjust Column Widths


Adjust column widths of the search query table by modifying the columns' width attribute within each column element found within the nameRef = Save Module attribute.

The value of the column width attribute specifies the default width of the column in pixels. If no value is displayed next to the column element, the column widths automatically adjust to fit its content.

7-31


The following example indicates the CATIA Status column displays a width of 60 pixels.

<Column name="TC Item object_type" width="100"/>



Modify column titles of the search query table by modifying the display attribute within each column element found within the nameRef = Save Module attribute.


The example below indicates the catia_status column displays State In CATIA.

<Column name="TC ItemRev object_name" display="Name"/>

The display attribute does not interact with the editor property line corresponding to this table column.

Reorder Columns


Reorder columns within the search query table by modifying the order of the column elements within the $TCICV5_DIR/env/itemrevbrowser.xml file in the Save Module/Module element .

The columns display in the same order as displayed within the list. Rearrange the order of this list to rearrange the order of the columns within the table.

For example, columns in the Item Revision Browser table shown above are listed in the following order:

• Item ID

• Item Revision ID

• Item Revision Object Name

• Item Object type

Customizing Teamcenter Integration for CATIA V5 JT: The catia2jt Script

7-32


• Item Revision Object Description

• Item Revision Last modified date

 <Module nameRef="IB Module" …  <Column name="TC Item item_id"/> <Column name="TC ItemRev item_revision_id"/> <Column name="TC ItemRev object_name"/> <Column name="TC Item object_type"/> <Column name="TC ItemRev object_desc"/> <Column name="TC ItemRev last_mod_date"/> </Module> </UIApplication>

JT: The catia2jt Script

Teamcenter catia2jt Script Example

There are two main steps in the JT conversion process:

1. Create the JT datasets.

2. Convert and import JT files.

The catia2jt script must be modified prior to converting CATIA V5 documents into JTs, unless the Dispatcher Services method is used.

Teamcenter catia2jt Script Example

The translator batch file uses three parameters:

1. The first parameter is the converting type.

• 0 = convert a product file

• 1 = convert a directory of V4 files, else convert a directory of V5 files

Customizing Teamcenter Integration for CATIA V5 JT: The catia2jt Script

7-33


2. The second parameter is the full path of the file name (if the first parameter = 1) or the input directory.

3. The third parameter is the output directory.

The illustration below was created by setting:

• TS_INST: The directory where the translator is installed (Theorem, by default).

• V5_EXE: The path to the executable file which converts V5 and CATProducts files (Theorem, by default). If the executable is not the same for V5 and CATProduct files, set the path in the command labeled "PRODUCT:" for CATProduct and "V5:" for V5 files. The configuration file is specified in the command for each type.

• V4_EXE: The path to the executable file which converts V4 files (Theorem, by default).

Customizing Teamcenter Integration for CATIA V5 Customize the MML Browser Display

7-34


Customize the MML Browser Display

Options Managing Properties Reset the Browser Display Common Errors

Options

Frame Configuration Tree Table

The Multi-Model Links Browser is fully customizable. Pick File >> Options to customize the display by modifying the following features.

• Frame size.

• The Configuration default to specify the default display features.

• The Tree option which includes the node, links and panel colors and dimensions.


7-35


• The Table option which includes the properties displayed within the table.

Frame

Use the Frame option to specify the default height and width (in pixels) used when the application is launched, and the historic size (number of sessions to store).


7-36


Configuration

Use the Configuration option to specify the default setting for the following features.

Name Icon

Family

State

Depth

Custom

Depth max Maximum number of links to consider (for browsing and display)

Tree

Use the Tree option to specify the display of nodes, links and the layout of different components. Use the color choosers to create a default color and text fields and spinners for sizes.

Use the Transparency selection option to display/hide the transparent rectangle which displays as nodes are selected. It may be a useful feature, but it is resource consuming. Refer to Managing Properties section to indicate the property displayed in the nodes' tooltip.


7-37


Table

Use the Table option to modify, add or remove properties displayed in the table view.

Managing Properties

Any Teamcenter property can be used as the source of what displays in the node's tooltip or in the table columns. The property's real name should be used as the source (not the display name). Teamcenter properties can include:

• the item revision of the dataset displayed in the browser

• the dataset

• Teamcenter file related to the dataset.

For example, to display the Object Name in the table, add object_name in the Identifier and Object Name in the Displayed Name within the Table option of the Browser Customization Panel. The Browser will first search for a property named object_name in the dataset, and if not found, will search within the Teamcenter file.

The item revision, dataset, or file can also be displayed by adding the following prefixes to the property.

• REV. - Item revision properties

• DST. - Dataset properties

• FILE. - Teamcenter file properties.


7-38


Reset the Browser Display

Delete the file containing your local settings to cancel your customizations. Depending on your installation, this file may be located in the following directory.

Save a copy of this file in a safe place when re-installing the Integration in order to save any customizations. After installation, copy the file back to its original place.

TcIC_config_dir = C:\tmp

If TCICV5_DIR = C:\catiman, then the directory name is C-_catiman and the bmml.user.properties path is C:\tmp\.TcIC\C-_catiman\bmml_user.properties.

Customize the MML Browser Display: Common Errors

Error Solution

UNKNOWN PROP incorrectly displays in the node's tooltip or in a table column.

Ensure the property real name is spelled correctly then verify the property exists. Consult Teamcenter documentation to locate the correct property to display.

The message There should not be empty fields displays on the customization dialog box after selecting OK.

Ensure fields are completely correctly.

The java.lang.NumberFormatException message displays in Teamcenter's console when attempting to launch the MML Browser from CATIA V5 or Teamcenter.

The error message may display when local settings have been changed. Reset the Browser Display then restart Teamcenter.

Customizing Teamcenter Integration for CATIA V5 Modify the Look & Feel

7-39


Modify the Look & Feel

When a pse_user.properties file is used to configure the Teamcenter Integration for CATIA menu, it is necessary to add the following entries to this file:

com.ugsolutions.iman.pse.PSEApplication.MENUBAR=com.ebsolutions.catiman.CatiaPSEApplicationMenuBar catiaV5_loadAction=com.ebsolutions.catiman.actions.LoadAction catiaV5_loadAction.NAME=Load in CATIA V5 catiaV5_calculateAssemblyAction=com.ebsolutions.catiman.actions.CalculateAssemblyAction catiaV5_calculateAssemblyAction.NAME=Update assembly mass properties catiaV5_calculateAbsoluteAction=com.ebsolutions.catiman.actions.CalculateAbsoluteAction catiaV5_calculateAbsoluteAction.NAME=Display mass properties in the top assembly origin catiaV5_returnToCatiaActionV5=com.ebsolutions.catiman.actions.ReturnToCatiaAction catiaV5_returnToCatiaActionV5.NAME=Return to CATIA V5 catiaV5_volumeSearchAction=com.ebsolutions.catiman.actions.VolumeSearchAction catiaV5_volumeSearchAction.NAME=Volume search catiaV5_cat_PV_catia2jtAction=com.ebsolutions.catiman.actions.CatPVCatia2JtAction catiaV5_cat_PV_catia2jtAction.NAME=Convert into JT file catiaV5_ebsAboutAction=com.ebsolutions.catiman.actions.EBSAboutAction catiaV5_ebsAboutAction.NAME=About integration catiaV5_loadConsultingAction=com.ebsolutions.catiman.actions.LoadConsultingAction catiaV5_loadConsultingAction.NAME=Load for consulting in CATIA V5 catiaV5_createCatiaPartAction=com.ebsolutions.catiman.actions.CreateCatiaPartAction catiaV5_createCatiaPartAction.NAME=Create CATPart dataset for selection catiaV5_createCatiaPartAction.COMMAND=catiaV5_createCatiaPartCommand catiaV5_createCatiaPartCommand=com.ebsolutions.catiman.commands.CreateDatasetCommand catiaV5_createCatiaAssemblyAction=com.ebsolutions.catiman.actions.CreateCatiaAssemblyAction catiaV5_createCatiaAssemblyAction.NAME=Create CATProduct dataset

Customizing Teamcenter Integration for CATIA V5 Modify the Look & Feel

7-40


for selection catiaV5_createCatiaAssemblyAction.COMMAND=catiaV5_createCatiaAssemblyCommand catiaV5_createCatiaAssemblyCommand=com.ebsolutions.catiman.commands.CreateDatasetCommand catiaV5_loadSelectedLevelAction=com.ebsolutions.catiman.actions.LoadSelectedLevelAction catiaV5_loadSelectedLevelAction.NAME=Load selected level in CATIA V5 catiaV5_exportAssemblyFromPSEAction=com.ebsolutions.catiman.actions.ExportAssemblyFromPSEAction catiaV5_exportAssemblyFromPSEAction.NAME=Export catiaV5_createSprdSheetAction=com.ebsolutions.catiman.actions.CreateSprdSheetAction catiaV5_createSprdSheetAction.NAME=Create export spreadsheet catiaV5_updateOEMFormsAction=com.ebsolutions.catiman.actions.UpdateOEMFormsAction catiaV5_updateOEMFormsAction.NAME=Update OEM import forms catiaV5_browseMMLAction=com.ebsolutions.catiman.actions.BrowseMMLAction catiaV5_browseMMLAction.NAME=Browse multi-model links catiaV5_loadForCompare=com.ebsolutions.catiman.actions.LoadForCompareAction catiaV5_loadForCompare.NAME=Load for compare in CATIA V5 catiaV5_activate_latestActiveShapes.NAME=Activate latest active shapes catiaV5_activate_latestActiveShapes=com.ebsolutions.catiman.actions.ActivateLatestActiveShapesAction catiaV5_backgroundRoundRobin=com.ebsolutions.catiman.actions.BackgroundRoundRobinFromPSEAction catiaV5_backgroundRoundRobin.NAME=Load, update, save

Customizing Teamcenter Integration for CATIA V5 Save Manager

7-41


Save Manager

The Editor Panel Table Toolbar The Save Manager Title Area Preferences Related to the Save Manager

The Save Manager displays when a CATIA user saves an assembly in Teamcenter using the Integration macros. The Save Manager collects information required during the Save process and can be customized.

The Save Manager Editor Panel

The Editor Panel cannot be customized by the .xml file. Properties in this panel are managed by the core of the Interface.

The Save Manager Table

Add/Remove/Hide Columns Change Table Icons Column Widths and Titles Reorder Columns Set the Table/Editor Divider Position

Modify the $TCICV5_DIR/env/savemanager.xml file under the SaveManager/Module element to customize this area of the Save Manager. When the savemanager.xml file is modified, ensure the encoding of the modified savemanager.xml file is compatible with the printable character set of the .xml file to avoid unpredictable behavior.

7-42


Add/Remove/Hide Columns


Add/Remove columns within the Save Manager Table by modifying the column elements found within the nameRef = Save Module attribute. Each column element contains an attribute name (i.e., <Column name="item_id"/>) specifying the property to display in the column.

Remove a column from the table by removing its column element within the savemanager.xml file. Add a column to the table by adding a new column element within the savemanager.xml file. Refer to the following example, if necessary.

• Add Teamcenter properties

• Add CATIA properties (Drawing parameters).

For example, add the following lines within the savemanager.xml file:




<column name="TC Dst creation_date"/>


<column name="TC ItemRevMaster item_comment"/>


<column name="CATIA description"/>


7-43


Add a New Column for Multiple CATIA Environments

Add new column in the Save Manager to display the environment read in the form, if one exists, by adding Column name = env within the savemanager.xml file (in catiman/env).

Add CATIA Properties (Drawing Parameters) as Columns

Refer to the following table to determine available properties and attributes. Modify the xml file as previously indicated.

CATIA Display Name CATIA Real Name Attribute

Definition definition CATIA definition

Description description CATIA description

MyProperty (custom property) MyProperty CATIA MyProperty

Nomenclature nomenclature CATIA nomenclature

Part Number partNumber CATIA partNumber

Revision revision CATIA revision

Source Source CATIA Source

Add Teamcenter Properties as Columns

Modify the .xml file as previously indicated using Teamcenter Property Real Names, for example, TC Item, item_id, TCItemRev item_revision_id, TC ItemMaster object_name, etc. The format is TC xxx yyy.

• xxx is Dst, Bvr, Item, ItemRev, ItemMaster or ItemRevMaster.

• yyy is any attribute/property of the xxx parameter using the real name of the element.


7-44


For example, in an English environment: TC Item item_id TCItemRev item_revision_id TC ItemMaster object_name

Column Definitions

Each Column element uses an attribute name to specify the property to display in the column. Available attributes are listed below.

Property name Description

catia_status Status of the component in CATIA

co_status Indicates Check-out status of the current user

document_type Document type

env CATIA Environment used during the Save process

file_name File name

former_file_name Original CATIA file name

link_type Link type

save_mode Save mode

status Component status

Hide Columns

7-45


Use the visible attribute to hide columns in the Save Manager. For example, <Column name="catia_status" visible="false"/> hides the Status column.

Change Table Icons

Perform the following steps to change the Save Manager Table icons.

1. Uncompress the cat2uimanager.jar file.

2. Locate the default Save Manager Table icons within the com.ebsolutions.savemanager.modules.images package. The icon files are in .png .gif and .jpg formats.

3. Replace the existing icons as needed. For example, replace the product.png file with a new icon file to replace the current default CATProduct icon.

4. When finished, re-jar the cat2uimanager.jar file.

5. Replace the old cat2uimanager.jar file with the new one just created.

6. The Save Manager Table displays new icons.

The icons contained in the package are also used for other Save Manager components such as action buttons. Ensure the correct icon files are modified. By default, the icon size should be 25x25 pixels to fit the Save Manager display.

Column Width and Titles


Adjust Column Width

Adjust the width of the Save Manager Table columns by modifying the columns' width attribute within each column element found within the nameRef = Save Module attribute. The value of the column width attribute specifies the default width of the column in pixels. If no value is displayed next to the column element, the column widths automatically adjust to fit its content.

7-46


For example, to display a width of 60 pixels for the CATIA Status column, the attribute should be written as: <Column name="catia_status" width="60"/>

Change Column Titles

Modify column titles of the Save Manager Table by modifying the display attribute within each column element found within the nameRef = Save Module attribute.


For example, to display the title,State In CATIA, for the catia_status column, the attribute would be written as: <Column name="catia_status" display="State In CATIA"/>

The display attribute does not interact with the editor property line corresponding to this table column. Refer to the Editor Customization section for further details on customizing the Editor.

Reorder Columns


Reorder columns within the Save Manager Table by modifying the order of the column elements found within the nameRef = Save Module attribute.

The columns within the Save Manager Table display in the same order as displayed within the list. Rearrange the order of this list to rearrange the order of the columns within the table.

The code shown below causes the Save Manager Table to display in the following order:

1. Item ID

2. Item Revision ID

3. Type

7-47


4. Status

5. CATIA Status

6. CO Status

7. Save Mode

<?xml version="1.0" encoding="ISO-8859-1"?> ... <UIApplication class="com.ebsolutions.savemanager.Application" ...> ...  <Module nameRef="Save Module" name="save_module" ...>  <Column name="status"/> <Column name="catia_status" width="60"/> <Column name="save_mode"/> <Column name="TC item item_id" width="225"/> <Column name="TC itemRev item_revision_id"/> <Column name="document_type"/> <Column name="TC Item object_type"/> <Column name="co_status" width="29"/> ... </Module> ... </UIApplication>

Set the Table/Editor Divider Position


Determine the position of the table/editor divider in the Save Manager by modifying the Divider element within the within the nameRef = Save Module attribute. The Divider element is at the same level as the Column attribute, contains the location attribute. The value of the location attribute corresponds to a percentage between the left and right side of the Save Manager.

7-48


For example, set the Divider location attribute to .02 so that the default location of the table/editor is 20% from the left side of the Save Manager; <Divider location="0.2"/>

The Save Manager Toolbar

Customize the Right Vertical Toolbar Customize the Top Horizontal Toolbar


Customize the Right Vertical Toolbar

Change the Toolbar Order Customize Toolbar Buttons


Change the Toolbar Order

Ensure to Copy/Paste the entire block of the toolbar definition area within the .xml file, including the DisplayElements of each toolbar containing the button definition. Failure to do so may corrupt the .xml file and will prevent the Save Manager from being displayed. While changing the order of the toolbars, be careful to copy/paste the whole block of the toolbar definition in the xml file.

Change the order of the Save Manager right vertical toolbar by modifying the Toolbar elements found within the nameRef = Save Module attribute. Each Toolbar element defines the properties of each toolbar button within the right side of the Save Manager. Rearrange the order of this list to rearrange the order of the toolbar elements.


7-49


Customize Toolbar Buttons

Customize toolbar buttons within the Save Manager Table by modifying the DisplayElement elements within the Toolbar element of the nameRef = Save Module attribute. Each of the DisplayElement elements define a graphical button in the toolbar. Elements are listed in the table below.

Attribute name

Possible values Description

showTitle true/false Display or hide the button title. By default, the title is not displayed but it is available as a tooltip.

nameRef any String

This attribute overrides the default button title. The value of this attribute displays within the button's tooltip if the showTitle attribute value is False. The value of this attribute displays under the icon button if the showTitle attribute value is True.

identifier any String This attribute identifies the localization of the button. If the nameRef attribute is declared, this identifier is not used because nameRef will be used "as it is " and no localization proceeds.

image any String

This attribute contains the pathname of the button's icon. This path can be a package relative path, as by default in the .xml file, or an absolute local path. Compatible icons formats are .gif, .jpg and .png.

class any String This attribute is designed for a developer customization, and defines the class used to render the button.

action any String This attribute is designed for a developer customization, and defines the action class used when the button is selected.

Every button position can be changed in every toolbar by changing the order of the DisplayElement elements in the corresponding toolbar definition.

7-50


Within the Integration, another button style is provided to illustrate extending the Save Manager components. For example, within the DisplayElement element of the right toolbar definition, replace the <class="com.ebsolutions.savemanager.modules.SaveModuleToolBarButton"/> definition with <class="com.ebsolutions.savemanager.modules.SaveModuleSwingToolBarButton"/> to create a new button style. The button now "swings" each time the mouse hovers it.

Customize the Top Horizontal Toolbar


Modify Button Icons

Supported icon formats are .png, .gif and .jpg. The .bmp format is not supported. Ensure the icons are a 25x25 pixel size to fit into the default display.

Change the icons within the Save Manager toolbar by modifying the DisplayElement found within the nameRef = STATES attribute. The Image attribute within the DisplayElement element defines the location of the button icons.

The value of the image attribute can be relative to a package in the classpath or can be an absolute path on the local drive. By default, icons provided with the interface are located in the .jar files, but the image attribute value can be modified to a local path.

<DisplayElement showTitle="false" image="c:\tmp\jt.jpg" identifier="create_jt_flag" class="com.ebsolutions.savemanager.modules.SaveModuleToolBarCheckBox" action="com.ebsolutions.savemanager.actions.CreateJTAction"/>

7-51


Modify Toolbar Order

Use caution when reordering the toolbar elements. Ensure to Copy/Paste the entire toolbar definition block, including the DisplayElement elements of each toolbar containing the toolbar button definition. Failure to Copy/Paste the entire information may corrupt the .xml file and prevent the Status Window from being displayed.

Modify the order of the Save Manager Table toolbar by reordering the DisplayElement found within nameRef = STATES attribute. A list of DisplayElements defines the Save Manager top horizontal toolbar. A graphical separator is automatically added between each toolbar element. Reorder the list of toolbar elements within DisplayElement, as needed, to reorder the toolbar display.

The example below indicates the Save Manager top horizontal toolbar buttons display in the following order: Compute geometric values button, Create JT button, etc.

<?xml version="1.0" encoding="ISO-8859-1"?> ... <UIApplication class="com.ebsolutions.savemanager.Application" ...> ...  <SaveManagerToolBar nameRef="STATES" identifier="states" ...> <DisplayElement showTitle="false" image="/com/ebsolutions/uimanager/modules/images/cptgeo.gif" identifier="compute_geo_flag" class="com.ebsolutions.uimanager.modules.SaveModuleToolBarCheckBox" action="com.ebsolutions.uimanager.actions.ComputeMassPropertiesAction"/> <DisplayElement showTitle="false" image="/com/ebsolutions/uimanager/modules/images/createjt.png" identifier="create_jt_flag" class="com.ebsolutions.uimanager.modules.SaveModuleToolBarCheckBox" action="com.ebsolutions.uimanager.actions.CreateJTAction"/> ... </SaveManagerToolBar> ... </UIApplication>


7-52


Save Manager Title Area

The Save Manager title area can display additional information related to the current Teamcenter connection (User, Group, Role) and CATIA Environment. The display format of this information is defined in the CATIA_ui_title_format preference.


This preference affects the title of the Save Manager panel, Spreadsheet Editor panel and the State Details panel.

Preferences Related to the Save Manager

Always Display the Save Manager During Save Save a Drawing, Process or Analysis File Use Existing Item Revision Display Additional Information within the Title of the Save Manager Panel


Always Display the Save Manager During Save

Use SAVEMANAGER_always_displayed_on_save to display or hide the Save Manager panel during the Save Existing process on modified files, when no user interaction is required.

Set it to true (default) to always display the Save Manager panel containing all modified files and their parents.

Set it to false to hide the Save Manager panel (only if warnings or errors do not occur) during the Save Existing process. In this case, the Save Existing process proceeds without user interaction.

The Save Manager always displays if there are errors, warnings or a CATIA status set to New.


7-53


SAVEMANAGER_always_displayed_on_save = true


Save a Drawing, Process or Analysis File

Permit the drawing, process and/or analysis file to be saved under the same item revision of the first linked document and indicate Use Existing Item as the Save Mode in the Save Manager by setting CATIA_auto_attach_to_3d_item to true (default) within Teamcenter Preferences.

Set it to false to permit the drawing, process and/or analysis file to be saved under a new item revision and indicate New as the Save Mode in the Save Manager.

When the drawing, process or analysis file is selected with its linked document and:

• The value of this preference is true then the item ID and item revision ID of the linked document is applied to the drawing, process or analysis file and the Save Mode is Existing Item.

• The value of this preference is false then the item ID and item revision ID are automatically assigned and the save mode is manually selected by the user.

CATIA_auto_attach_to_3d_item = true


Use Existing Item Revision

When using the Use Existing Item or Use Existing Dataset options, automatically populate the Revision field with the latest revision available by setting the SAVEMANAGER_use_exising_item_revision preference to latest. To leave the Revision field empty (default), set this preference to none.

This setting must be used in combination with the SAVEMANAGER_map_item_id map.

The Assign Revision button can not be used to find the last revision of a specific item.

SAVEMANAGER_use_existing_item_revision = latest

The default value is NONE.

Display Additional Information within the title of the Save Manager Panel

Customizing Teamcenter Integration for CATIA V5 Special Characters

7-54


The Save Manager title area can display additional information related to the current Teamcenter connection (User, Group, Role) Current Project Name and CATIA environment. Define the title pattern displayed on the Save Manager panel using the string below. When this preference is empty, no additional information displays.

{0} = user

{1} = group

{2} = role






Special Characters

Preferences Related to Special Characters

Customize special characters replaced in CATIA file names by modifying the characters_list file located in the $TCICV5_DIR/env directory.

The characters already defined are characters forbidden by Windows and UNIX operating systems. It is not recommended to delete any of them. They are:

()[]<>:|?/\"*&

The list must be defined on the first line only. The characters must be written without spaces or other separators because all characters defined on the first line will be considered as special characters to be replaced.

During Import: The Import process is stopped and an error message displays when forbidden characters, as defined within the characters_list file, are present in the Import spreadsheet

Customizing Teamcenter Integration for CATIA V5 Status Window Customization

7-55


Preferences Related to Special Characters


Set CATIA_replace_special_character to change the character used to replace the special characters displayed the file name.

CATIA_replace_special_character = -

The default value is _

Status Window Customization

Status Window Table Customization Status Window Title Area Customization Status Window Toolbar Customization Preferences Related to the Status Window

Pick the DetailStates button to display details (information from Teamcenter and CATIA) of elements loaded in CATIA from Teamcenter in the Status Window. This window can be customized.

Status Window Table Customization

Add/Remove Columns Change Table Icons Column Widths and Titles Reorder Columns

Modify the $TCICV5_DIR/env/statedetails.xml file under the SaveManager/Module element to customize this area of the Status Window. When the statedetails.xml file is modified, ensure the encoding of the modified statedetails.xml file is compatible with the printable character set of the .xml file to avoid unpredictable behavior.

7-56


Status Window Table Customization: Add/Remove Columns

Column Definitions Add CATIA Properties (Drawing Parameters) as Columns Add Teamcenter Properties as Columns Hide Columns


Add/Remove columns within the Status Window Table by modifying the column elements found within nameRef = State Details Module attribute.

Each column element contains an attribute name (i.e., <Column name="item_id"/>) specifying the property to display in the column.

Remove a column from the table by removing its column element within the statedetails.xml file. Add a column to the table by adding a new column element. Note that the columns display within the Status Window Table in the order listed within the .xml file. Ensure the new column is added in the correct location.

• Add Teamcenter properties

• Add CATIA properties (Drawing parameters).

For example, add the following lines within the statedetails.xml file:


<Column name="former_file_name"/>


<Column name="TC Dst Date Created"/>

7-57


<Column name="TC ItemRevMaster item_comment"/>


<Column name="CATIA description"/>

Column Definitions

Refer to the table below for columns available to add to the Status Window Table.

Columns can also be hidden.

Property Name Displayed Name (EN) Description

CATIA partNumber CATIA partNumber CATIA part number

catia_status CATIA status Status of component in CATIA: opened, modified, new, modified after synchronization

document_type Type CATIA Document type

env CATIA Environment The CATIA environment used by TcIC

former_file_name File Name CATIA file name

is_env_compatible Compatible CATIA Environment

Indicates if the CATIA Environment used by TcIC is compatible with the current CATIA Environment .


7-58



is_latest_rev Latest Revision Indicates if the item revision of the current document is the latest item revision

modifiable_bvr Modifiable bvr Indicates if the bvr is modified by the current user (RW + CO)

modifiable_dataset Modifiable dataset Indicates if the dataset is modified by the current user (RW + CO)

TC Bvr checked_out_user

Bvr Checked-Out By Name of the user that has checked-out the bvr

TC Dst checked_out Bvr Checked-Out Indicates if the bvr is checked-out by the current user

TC Dst checked_out_user

Dst Checked-Out By

Name of the user that has checked-out the dataset

TC Item item_id Item ID Component item ID

TC ItemRev item_revision_id ItemRev Revision Component item revision ID

TC ItemRev release_status_list

ItemRev Release Status Lifecycle (release) status


7-59



tc_status Modified in Tc

true : when the current item does not exist in Teamcenter or has been modified in Teamcenter after being loaded in CATIA false: when the current item exists in Teamcenter or has not been modified in Teamcenter after being loaded in CATIA

Add CATIA Properties (Drawing Parameters) as Columns

Refer to the following table to determine available properties and attributes. Modify the xml file as previously indicated.

CATIA Display Name CATIA Real Name Attribute

Definition definition CATIA definition

Description description CATIA description

MyProperty (custom property) MyProperty CATIA MyProperty

Nomenclature nomenclature CATIA nomenclature

Part Number partNumber CATIA partNumber

Revision revision CATIA revision

Source Source CATIA Source


7-60


Add Teamcenter Properties as Columns

Modify the xml file as previously indicated using Teamcenter Property Real Names, for example, TC Item, item_id, TCItemRev item_revision_id, TC ItemMaster object_name, etc. The format is TC xxx yyy.

• xxx is Dst, Bvr, Item, ItemRev, ItemMaster or ItemRevMaster.

• yyy is any attribute/property of the xxx parameter using the real name of the element.

For example, in an English environment: TC Item item_id TCItemRev item_revision_id TC ItemMaster object_name

Teamcenter Property Available Attributes

BOM View Revision

TC Bvr ID ; TC Bvr Revision ; TC Bvr Name ; TC Bvr Description ; TC Bvr Type ; TC Bvr Tool Last Used ; TC Bvr Version Number ; TC Bvr Version Limit ; TC Bvr Owner ID ; TC Bvr Group ID ; TC Bvr Date Created ; TC Bvr Date Modified ; TC Bvr Last Modifying User ; TC Bvr Date Archived ; TC Bvr Date Last Backup ; TC Bvr Date Released ; TC Bvr Release Status

Dataset

TC Dst ID ; TC Dst Rev ; TC Dst Name ; TC Dst Description ; TC Dst Type ; TC Dst Tool Last Used ; TC Dst Version Number ; TC Dst Version Limit ; TC Dst Owner ID ; TC Dst Group ID ; TC Dst Date Created ; TC Dst Date Modified ; TC Dst Last Modifying User ; TC Dst Date Archived ; TC Dst Date Last Backup ; TC Dst Date Released ; TC Dst Release Status ; TC Dst k_toolLabel ; TC Dst k_typeLabel ; TC Dst k_formatLabel ; TC Dst k_siteClassLabel

Item

TC Item ID ; TC Item Revision ; TC Item Name ; TC Item Description ; TC Item Type ; TC Item Tool Last Used ; TC Item Version Number ; TC Item Version Limit ; TC Item Owner ID ; TC Item Group ID ; TC Item Date Created ; TC Item Date Modified ; TC Item Last Modifying User ; TC Item Date Archived ; TC Item Date Last Backup ; TC Item Date Released ; TC Item Release Status ; TC Item Unit of Measure

7-61


Teamcenter Property Available Attributes

Item Master

TC ItemMaster ID ; TC ItemMaster Revision ; TC ItemMaster Name ; TC ItemMaster Description ; TC ItemMaster Type ; TC ItemMaster Tool Last Used ; TC ItemMaster Version Number ; TC ItemMaster Version Limit ; TC ItemMaster Owner ID ; TC ItemMaster Group ID ; TC ItemMaster Date Created ; TC ItemMaster Date Modified ; TC ItemMaster Last Modifying User ; TC ItemMaster Date Archived ; TC ItemMaster Date Last Backup ; TC ItemMaster Date Released ; TC ItemMaster Release Status ; TC ItemMaster Form Definition File Name

Item Revision

TC ItemRev ID ; TC ItemRev Revision ; TC ItemRev Name ; TC ItemRev Description ; TC ItemRev Type ; TC ItemRev Tool Last Used ; TC ItemRev Version Number ; TC ItemRev Version Limit ; TC ItemRev Owner ID ; TC ItemRev Group ID ; TC ItemRev Date Created ; TC ItemRev Date Modified ; TC ItemRev Last Modifying User ; TC ItemRev Date Archived ; TC ItemRev Date Last Backup ; TC ItemRev Date Released ; TC ItemRev Release Status

Item Revision Master

TC ItemRevMaster ID ; TC ItemRevMaster Revision ; TC ItemRevMaster Name ; TC ItemRevMaster Description ; TC ItemRevMaster Type ; TC ItemRevMaster Tool Last Used ; TC ItemRevMaster Version Number ; TC ItemRevMaster Version Limit ; TC ItemRevMaster Owner ID ; TC ItemRevMaster Group ID ; TC ItemRevMaster Date Created ; TC ItemRevMaster Date Modified ; TC ItemRevMaster Last Modifying User ; TC ItemRevMaster Date Archived ; TC ItemRevMaster Date Last Backup ; TC ItemRevMaster Date Released ; TC ItemRevMaster Release Status ; TC ItemRevMaster Form Definition File Name ; TC ItemRevMaster item_comment

Hide Columns

Use the visible attribute to hide columns. For example, <Column name="catia_status" visible="false "/> hides the CATIA Status column.

Status Window Table Customization: Change Table Icons

Modify the $TCICV5_DIR/env/statedetails.xml file under the SaveManager/Module element to customize this area of the Status Window. When the statedetails.xml file is modified, ensure

7-62


the encoding of the modified statedetails.xml file is compatible with the printable character set of the .xml file to avoid unpredictable behavior.

Perform the following steps to change the Status Window Table default icons.

The icons contained in the package are used for other Save Manager components such as action buttons. Ensure you modify the correct icon files. The icon size should be 25x25 pixels to display correctly.

1. Uncompress the cat2uimanager.jar file.

2. Locate the default Status Window Table icons within the com.ebsolutions.savemanager.modules.images package. The icon files are in .png .gif and .jpg formats.

3. Replace the existing icons as needed. For example, replace the product.png file with a new icon file to replace the current default CATProduct icon.

4. When finished, re-jar the cat2uimanager.jar file.

Status Window Table Customization: Column Widths and Titles


Adjust Column Width

Adjust the width of the Status Window Table columns by modifying the columns' width attribute found within the nameRef = State Details Module attribute. The value of the column width attribute specifies the default width of the column in pixels. If no value is displayed next to the column element, the column widths automatically adjust to fit its content.

The width attribute below indicates that the CATIA Status column displays with a column width of 60 pixels.

<Column name="catia_status" width="60"/>

7-63



Modify column titles of the Status Window Table by modifying the display attribute found within the nameRef = State Details Module attribute. The column titles display the value in its display attribute. If no value is assigned, the default localized string is used to display the title of the column depending on the name attribute value. The display attribute overrides the column default name, but no localization is applied to the display attribute value.

The display attribute value below indicates the CATIA Status column displays State In CATIA as its title.

<Column name="catia_status" display="State In CATIA"/>

Status Window Table Customization: Reorder Columns


Reorder columns within the Status Window Table by modifying the order of the column elements found within nameRef = State Details Module attribute.

The columns within the Status Window Table display in the same order as displayed within the list. Rearrange the order of the list to rearrange the order of the columns within the table. In the example .xml file shown below, columns in the Status Window Table display in the following order.

<Column name="TC Item item_id"/> <Column name="TC ItemRev item_revision_id"/> <Column name="document_type"/> <Column name="CATIA partNumber"/> <Column name="TC Dst checked_out" /> <Column name="TC Bvr checked_out" /> <Column name="catia_status" width="60"/> <Column name="tc_status"/> <Column name="env"/> <Column name="is_env_compatible"/> <Column name="is_latest_rev"/>

1. Item ID

7-64


2. ItemRev Revision

3. Type

4. CATIA partNumber

5. Dst Checked-Out

6. Bvr Checked-Out

7. CATIA Status

8. Modified In Tc

Use the statedetails.xml file to configure columns:

<Column name="TC Item item_id"/> <Column name="TC ItemRev item_revision_id"/> <Column name="former_file_name"/> <Column name="document_type"/> <Column name="CATIA partNumber"/> <Column name="TC Dst checked_out" /> <Column name="TC Bvr checked_out" /> <Column name="TC Dst checked_out_user" /> <Column name="TC Bvr checked_out_user" /> <Column name="TC Dst is_modifiable"/> <Column name="TC Bvr is_modifiable"/> <Column name="TC ItemRev release_status_list"/> <Column name="catia_status" width="60"/> <Column name="tc_status"/> <Column name="env"/> <Column name="is_env_compatible"/> <Column name="is_latest_rev"/> <Column name="modifiable_dataset"/> <Column name="modifiable_bvr"/>

By default, columns are displayed in the following order:

1. Item ID

2. ItemRev Revision

3. File Name

4. Type

5. CATIA partNumber

6. Dst Checked-Out


7-65


7. Bvr Checked-Out

8. Dst Checked-Out By

9. Bvr Checked-Out By

10. Dst Is Modifiable

11. Bvr Is Modifiable

12. ItemRev Release Status

13. CATIA Status

14. Modified In Tc

15. CATIA Environment

16. Compatible CATIA Environment

Status Window Title Area

The Status Window title area can display additional information related to the current Teamcenter connection (User, Group, Role) Current Project Name and CATIA environment. The display format of this information is defined in the CATIA_ui_title_format preference.


Status Window Toolbar Customization


Customize Status Window Toolbar Buttons

Modify the toolbar buttons of the Status Window Table changing the DisplayElement found within the nameRef = State Details Module attribute. Each DisplayElement defines a graphical button in the toolbar. Refer to the following table for DisplayElement definitions.

7-66


Attribute name

Possible values Description

showTitle true/false Display or hide the button title. By default, the title is not displayed, however, it can be viewed within the button's tooltip.

nameRef any String This attribute overrides the default button title. The value of this attribute displays in the button's tooltip if the showTitle attribute value is false. The value of this attribute displays under the icon button if the showTitle attribute value is true.

identifier any String

This attribute identifies the localization of the button. If the nameRef attribute is declared, the identifier is not used because nameRef will be used "as it is " and no localization proceeds.

image any String This attribute contains the pathname of the button's icon. This path can be a package relative path as by default in the .xml file, or an absolute local path. Compatible icons formats are .gif, .jpg and .png.

class any String This attribute is designed for a developer customization purposes and defines the class used to render the button. .

action any String This attribute is designed for a developer customization purposes and defines the action class used when the button is activated.

Every button position can be changed in every toolbar by changing the order of the DisplayElement elements in the corresponding toolbar definition.

Within the Integration, another button style is provided to illustrate extending the Status Window components. For example, within the DisplayElement element of the right toolbar definition replace the <class=="com.ebsolutions.savemanager.modules.

7-67


SaveModuleToolBarButton"/> definition by <class="com.ebsolutions.savemanager.modules. SaveModuleSwingToolBarButton"/> to create a new button style. The button will swing each time the mouse hovers over it.

Modify Toolbar Order

Modify the order of the Status Window Table toolbar by reordering the toolbar elements found within the nameRef = State Details Module attribute. A list of toolbar elements defines the Status Window right vertical toolbars. A graphical separator is automatically added between each toolbar element. Reorder the list of toolbar elements within the .xml file, as needed, to reorder the right side toolbar display.

Use caution when reordering the toolbar elements. Ensure to Copy/Paste the entire toolbar definition block, including the DisplayElement elements of each toolbar containing the toolbar button definition. Failure to Copy/Paste the entire information may corrupt the .xml file and prevent the Status Window from being displayed.

Preferences Related to the Status Window

Check-in/Check-out Panel Display Additional Information Within the Title of the Status Window Panel


Check-in/Check-out Panel

Set CATIA_cico_ask_confirmation_action_from_ui to true to display the Check-in / Check-out panel containing the OK button and require user interaction to start the action. Set it to false to prevent the display of Check-in / Check-out panel and start the action without user interaction. The Check-in/Check-out panel always displays. even when this preference is set to false if errors occur.

CATIA_cico_ask_confirmation_action_from_ui = true

Customizing Teamcenter Integration for CATIA V5 Teamcenter Loader

7-68


Display Additional Information Within the Title of the Status Window Panel

The Status Window title area can display additional information related to the current Teamcenter connection (User, Group, Role) Current Project Name and CATIA environment. The display format of this information is defined in the CATIA_ui_title_format preference.


{0} = user

{1} = group

{2} = role






Teamcenter Loader

Hide Commands Impact Analysis Loader Size Show in Teamcenter Viewer Size Saved Searches

Modify the $TCICV5_DIR/env/tcicloader.xml file under the loader/module element to customize this area of the Teamcenter Loader panel.

7-69


When the tcicloader.xml file is modified, ensure the encoding of the modified savemanager.xml file is compatible with the printable character set of the .xml file to avoid unpredictable behavior.

Commands, Contextual Menus (in the DisplayElement menu field or in Command name field), Search results (in the History identifier field), can be configured with the tcicloader.xml.

Selecting an option from the Teamcenter Loader Options panel interface edits the $TcIC_config_dir/tcicloader_<checksum>.xml file under <loader_options>.

<loader_options> <option module="loader" name="tree_displaying_order"> <value>Descending</value> </option> </loader_options>

When Search has been launched, the query result is saved in tcicloader.xml and the search is kept for the next time Teamcenter loader displays.

 <History identifier="search_results"> <Item uid="Q_YZZFbX4KsTnB"/> <Item uid="QyaZZFbX4KsTnB"/> <Item uid="A2RZZFbX4KsTnB"/> </History>

Hide Commands

Customize the tcicloader.xml file to hide some commands in the contextual menu with the Command name field.

<Command name="paste" image="/com/ebsolutions/uimanager/modules/images/loader/paste_16.png"/> <Command name="create_folder"/> <Command name="remove_folder"/> <Command name="load" image="/com/ebsolutions/uimanager/modules/images/loader/export_32.png"/> <Command name="open_dataset" image="/com/ebsolutions/uimanager/modules/images/loader/open_16.png"/> <Command name="load_compare" image="/com/ebsolutions/uimanager/modules/images/loader/export_comp_16.png"/> <Command name="load_consulting" image="/com/ebsolutions/uimanager/modules/images/loader/export_consult_16.png"/> <Command name="lus" image="/com/ebsolutions/uimanager/modules/images/loader/lus_16.png"/> <Command name="create_exp_spreadsheet" image="/com/ebsolutions/uimanager/modules/images/loader/create_spreadsheet_16.png"/> <Command name="export"

7-70


image="/com/ebsolutions/uimanager/modules/images/loader/file_export_16.png"/> <Command name="load_as_ref" image="/com/ebsolutions/uimanager/modules/images/loader/export_ref_16.png"/> <Command name="export_as_ref" image="/com/ebsolutions/uimanager/modules/images/loader/file_export_ref_16.png"/> <Command name="display_properties" image="/com/ebsolutions/uimanager/modules/images/loader/properties_32.png"/> <Command name="display_structure" image="/com/ebsolutions/uimanager/modules/images/loader/bomview_32.png"/> <Command name="load_selection"/> <Command name="highlight" image="/com/ebsolutions/uimanager/modules/images/loader/highlight_selected_16.png"/> <Command name="show_in_teamcenter" image="/com/ebsolutions/uimanager/modules/images/loader/sendto_16.png"/> <Command name="bmml" image="/com/ebsolutions/uimanager/modules/images/loader/bmml_16.png"/> <Command name="save_assy_config" image="/com/ebsolutions/uimanager/modules/images/save_assy_config_icon.png"/> <Command name="close_tab" image="/com/ebsolutions/uimanager/modules/images/loader/icon_remove.png"/> <Command name="close_other_tabs"/> <Command name="close_all_tabs" image="/com/ebsolutions/uimanager/modules/images/loader/icon_db_terminate_all.png"/> <Frame name="preview" visible="true" display="false" sizey="240"/> <Frame name="search_bomlines"> <Column name="and_or"/> <Column name="prop_name"/> <Column name="operator"/> <Column name="value"/> </Frame>

Customize the tcicloader.xml file to hide some commands in the CATIA Toolbar using the Command name field.

<DisplayElement showTitle="false" identifier="return_to_catia" image="/com/ebsolutions/uimanager/modules/images/loader/return_to_catia_22.png" class="com.ebsolutions.loader.ui.LoaderModuleToolBarButton" action="com.ebsolutions.loader.actions.raclessactions.Retu

7-71


rnToCATIA"/> <DisplayElement showTitle="false" identifier="start_tc" image="/com/ebsolutions/uimanager/modules/images/loader/defaultapplication_32.png" class="com.ebsolutions.loader.ui.LoaderModuleToolBarButton" action="com.ebsolutions.loader.actions.raclessactions.StartTeamcenter"/>

Impact Analysis

Use the width and position attributes of Impact Analysis field to customize the display of each area in the Impact Analysis tab of the loader. Each area can by customized and configured using the tcicloader.xml file

Use the position attribute to define table position in the tab. The first digit corresponds to the line number in which the table is positioned and the second digit corresponds to the column number in which the table is positioned. Possible values for second digit are 1 or 2.

Array Name Corresponding Display Name

item revisions Available Revision

parents Parents

3d_links Pointed by/Pointing CATPart, CATProduct, Design table

2d_links Pointed by/Pointing CATDrawing, CATProcess, CATAnalysis

other_links Other pointed/pointing documents

Only the item revision field is required.

<Frame name="impact_analysis"> <Table name=”itemrevision” position=”1.1”> <Column name="TC object_string" /> <Column name="type" width=”45” /> <Column name="TC last_mod_date" />

7-72


<Column name="TC owning_user" /> <Column name="is_latest_rev" width=”45” /> </Table> <Table name=”parents” position=”2.1”> <Column name="TC object_string" /> <Column name="type" width=”45” /> <Column name="TC last_mod_date" /> <Column name="TC owning_user" /> </Table> <Table name=”3d_links” position=”3.1”> <Column name="TC object_string" /> <Column name="type" width=”45” /> <Column name="TC last_mod_date" /> <Column name="TC owning_user" /> <Column name="link_type" /> <Column name="source_target" width=”45” /> </Table> <Table name=”2d_links” position=”4.1”> <Column name="TC object_string" /> <Column name="type" width=”45” /> <Column name="TC last_mod_date" /> <Column name="TC owning_user" /> <Column name="link_type" /> <Column name="source_target" width=”45” /> </Table> <Table name=”other_links” position=”5.1”> <Column name="TC object_string" /> <Column name="type" width=”45” /> <Column name="TC last_mod_date" /> <Column name="TC owning_user" /> <Column name="link_type" /> <Column name="source_target" width=”45” /> </Table> </Frame>

Loader Size

Use the sizex and sizey attributes to customize the size of the loader.

UIApplication class="com.ebsolutions.loader.ui.LoaderApplication" nameRef="Teamcenter Loader" image="/com/ebsolutions/uimanager/modules/images/loader/loader_icon.png" sizex="420" sizey="810" lang="">

Show in Teamcenter Menu

Configure the tcicloader.xml file to add or hide the Show in Teamcenter command in the contextual menus of item, item revision and BOM Line selections.


7-73


This command is only available in the contextual menu for the following installations:

• Teamcenter Loader and RAC

• Teamcenter Loader and Active Workspace

• Teamcenter Loader and Active Workspace and RAC

When Teamcenter loader is connected to the RACLess application and Active Workspace is defined as a client in client_env file, use CATIA_show_in_teamcenter_option preference to determine in which client Show in Teamcenter command should be launched between Teamcenter Loader (Loader) or Active Workspace (AW).

On Item/Item Revisions

On BOM Lines

7-74


Viewer Size

Use the sizex and sizey attributes of the Viewer field to customize the size of the JT Viewer in the loader.

<Frame name="structure"> <Viewer table_sizex="420"/> </Frame>

Saved Searches

Modify the $TCICV5_DIR/env/tcicloader_<checksum>.xml file under the <SavedSearches> field to customize the Search Criteria recorded under the Saved Searches.

Criteria and values in the Saved Searches field can be modified.

The number of Most Recently Used Queries can be customized. Use the Clear All button from the Options panel to remove Saved Searches.

Integration Entry Points

8-1


Integration Entry Points Chapter 8:ITK Functions RACLess Entry Points Save Manager User Exit Class

Configuring entry points provides the capability to implement functions called from inside the Integration.

ITK Functions

Overview Item ID/Item Revision List of ITK Functions TC_Custom Libraries

Overview

Common Header Current Process Identifier libcatia_tc_custom Working Environment

A special ITK library is provided to allow customization of some functions used by Teamcenter Integration for CATIA V5 and modify the way in which information is prepared and saved in Teamcenter.

This library is located in the following directories:

• %TC_ROOT%\lib\libcatia_custom.lib for Windows.

• $TC_ROOT/lib/libcatia_custom.so for UNIX.

Common Header

The common header for all ITK functions is as follows:

• #include <cat_USER_customize.h>

• #include <workspaceobject.h>

Integration Entry Points ITK Functions

8-2


• #include <item.h>

Current Process Identifier

Use the SaveScriptUsed global variable, defined in the cat_USER_customize.h file, to identify which Save process is the current process in the cat_USER_customize.c and cat_USER_bom_customize.c files. Refer to the table below for values.

This table is filled in by libcatia and is sent to libcatia_custom. It can not be modified.

Constant Name Constant Value The current process is...

NOT_SAVE_SCRIPT -1 not a Save process.

SAVE_SCRIPT 0 Save As or it is the Save phase of a Load, Update, Save process.

IMPORT_SCRIPT 1 Import

undefined 2 Save

undefined 3 Save As, for at least one element selected in CATIA.

undefined 4 Create the ImportSpreadsheet

undefined 5 Save Selected (Save Selected Level)

SAVE_TARGET_SCRIPT 6 Save Selected (Save Target)

8-3


libcatia_tc_custom

The libcatia_tc_custom is delivered in sample dir of the installation. The libcatia_tc_custom.c and libcatia_tc_custom.h files are located in this folder.

Working Environment

The EnvTab global variable, defined in the cat_USER_customize.h file, contains working environment table. This table can be used in the cat_USER_customize.c and cat_USER_bom_customize.c files. Each line corresponds to data and indexes are defined in the cat_USER_customize.h file as shown below.

This table is filled in by libcatia and is sent to libcatia_custom. It can not be modified.

Constant Name Constant Value

Corresponding Variable or Preference Value

CAT_TMP_DIR 0 Value of <TcIC_tmp_dir> in the tcic_var_env.xml file.

CAT_FILES_DIR 1 Value of <TcIC_files_dir> in the tcic_var_env.xml file.

IM_ITEM_TYPE 2 CATIA_item_type

PART_BOUNDING_BOX_CALCULATION 3 CATIA_part_bounding_box_calculation

CHAR_SEP_ITEMID_ITEMREV 4 FLColumnCatIVFSeparatorPref (Teamcenter preference)

REFERENCE_NAME_SEPARATOR 5 CATIA_partnumber_separator

CATIAV5_SEED_PART 6 CATIA_seed_part_id

8-4


Constant Name Constant Value

Corresponding Variable or Preference Value

CATIAV5_SEED_PRODUCT 7 CATIA_seed_product_id

CATIAV5_SEED_DRAWING 8 CATIA_seed_drawing_id

IM_CATIA_REFERENCE_PRODUCT 9 CATIA_reference_product_partnumber

LANGUAGE 10 Language of the client side

--- 11-12 Reserved for internal use only

IFS_SPRDSHEET_EXP_PATH 13 Value of <TcIC_export_spreadsheet_path> in the tcic_var_env.xml file

IFS_SPRDSHEET_IMP_PATH 14 Value of <TcIC_import_spreadsheet_path> in the tcic_var_env.xml file

CATIAV5_SEED_PROCESS 15 CATIA_seed_process_id

CATIAV5_SEED_ANALYSIS 16 CATIA_seed_process_id

--- 18 Reserved for internal use only

CteEXPORT_DLNAME_REQUIRED 19 CATIA_DLName_required_on_export

8-5


ItemID/Item Revision

The ItemID and the ItemRevision are controlled by the standard Teamcenter ITK functions USER_new_item_id and USER_new_revision_id.

In the PSE window, the sequence number is controlled by the USER_ask_for_new_sequence_no ITK function. Refer to the Teamcenter documentation for specific information on these three functions.

List of ITK Functions

Assembly Configuration Auxiliary Files BOM Line Validation/CATPart, CATProduct Datasets Check In/Check Out Datasets Export as reference/Load as reference External Files Foreign Files Import Spreadsheet Item and Item Revision Item Revision Item Revision Rule JT Load Occurrences Replace by revision Save Save New Revision Secondary Dataset Title Block

Assembly Configuration

Dataset

extern int ExportedByCatiaCustom cat_USER_assyconfig_dataset_info (tag_t i_itemrev_tag, /* */ tag_t i_bomwindow_tag, /* */ tag_t i_dataset_type_tag, /* */ tag_t i_relation_type_tag, /* */ char io_dataset_id[AE_dataset_id_size_c+1], /* <IO> */

8-6


char io_dataset_rev [AE_dataset_rev_size_c+1], /* <IO> */ char io_dataset_name[WSO_name_size_c+1], /* <IO> */ char io_dataset_desc [WSO_desc_size_c+1]) /* <IO> */

Attributes

i_itemrev_tag : tag of the item revision top line where the Assembly Configuration dataset will be attached; i_bomwindow_tag: tag of the BOM window i_dataset_type_tag : the tag of the Assembly Configuration dataset type i_relation_type_tag: the tag of the relation type between the item revision and the Assembly Configuration dataset io_dataset_id : the dataset id built by the function io_dataset_rev: the dataset rev built by the function io_dataset_name: the dataset name built by the function io_dataset_desc: the dataset description built by the function

Description

This function is used before an Assembly Configuration dataset is created. It returns the id, the revision, the name and description with which the dataset will be created, according to information retrieved from the item revision, dataset type and relation.

XML Filename

extern int ExportedByCatiaCustom cat_USER_build_assyconfig_file_name tag_t i_itemrev_tag, /* */ tag_t i_bomwindow_tag, /* */ tag_t i_dataset_type_tag, /* */ char **iop_file_name ) /* <IO> */

Attributes

i_itemrev_tag : tag of the item revision top line where the Assembly Configuration dataset will be attached; i_bomwindow_tag: tag of the BOM window i_dataset_type_tag : the tag of the Assembly Configuration dataset type iop_file_name: the filename of the assembly configuration xml file built by the function.

Description

This function allows the user to define the Assembly Configuration name to save in the dataset. By default, this function returns NULL. In this case, the file name is built by the Integration as following :

<itemId>_<itemRevId>_<RevRule> *

*RevRule corresponds to the active revision rule name of the BOM window.

8-7


Auxiliary Files

cat_USER_auxiliaryFilesInfo customizes the filename of auxiliary files. This function is used during save processes.

extern int ExportedByCatiaCustom cat_USER_auxiliaryFilesInfo ( StructUserDerivedFiles_s i_primary_element, /* */ int i_auxiliaryfiles_tab_size, /* */ StructUserDerivedFiles_s *iop_auxiliaryfiles_tab) /* <I/O> */ { return(!ITK_ok); }

typedef struct StructUserDerivedFiles { tag_t itemrev_tag; /* item rev tag */ tag_t dataset_tag; /* dataset tag */ logical created_in_tc /* flag used to indicate if the dataset has been created during the current process */ char *original_file_name; /* name of the file on disk (name of external files, null if auxiliary files)*/ char *file_name; /* <I/O> name of the file built by the Integration: customizable in the entry point */} StructUserDerivedFiles_s;

Attributes

i_primary_element : information about the primary dataset (StructUserDerivedFiles structure); i_auxiliaryfiles_tab_size: size of iop_auxiliaryfiles_tab tab; iop_auxiliaryfiles_tab : tab of auxiliary files related to the primary datatset

Description

This method is used to customize the filename of Auxiliary files. This function is used during the save and save as/revise post-action processes. The default value for the filename is datasetname_datasetuuid.

The original_file_name parameter must be copied into the file_name parameter of the StructUserDerivedFiles structure to retain the CATIA original file name.

BOM Line Validation/CATPart, CATProduct Datasets

cat_USER_verifyDatasetCreation

cat_USER_verifyDatasetCreation validates the selected BOM line prior to creating a CATPart or CATProduct dataset.

8-8


extern int ExportedByCatiaCustom cat_USER_verifyDatasetCreation ( tag_t bomline, /* */ const char* dsType , /* */ logical* skipCreation, /* <O> */ char** message ) /* <O> */

Attributes

bomline : tag of the selected BOM line; dsType : dataset type corresponding to the selected line; skipCreation : skip dataset creation; message : message to return;

Description

This user exit is called after a preliminary verification of the BOM line is made for dataset creation from the CATIAV5 menu. When the returned error value is not ITK_ok the processing of the structure is aborted. The message returned is reported as an error. When the returned error value is ITK_ok, and the skipCreation value is set to true, the BOM line is skipped and the message is reported to the user as a warning.

Check In/Check Out

cat_USER_entry_point_after_check_all_components

extern int ExportedByCatiaCustom cat_USER_entry_point_after_check_all_components ( int check_in_out, /* */ USER_Part_s *datasets_tab, /* */ int nb_datasets ) /* */

Attributes

check_in_out : value of the check command selected in CATIA: 0 if check out; 1 if check in; datasets_tab : tab of checked datasets; nb_datasets : number of checked datasets.

Description

This function defines an entry point after the Check-In or Check-Out command in Teamcenter.

If the command is Check-in, the USER_Part_s tab contains all components checked in by the process.

8-9


• If a component is already checked in before the check in process, this component will not be set in the tab.

If the command is Check-out, the USER_Part_s tab contains all components checked out by the process.

• If a component is already checked out before the check out process, this component will not be set in the tab.

If the command is Save, the USER_Part_s tab contains all components checked out or checked in by the process.

• If a component is checked out and the Save command is performed with the Check-in option, the component is put in the tab.

• If a component is Save as New, but without the Check-in option, the component is put in the tab. Otherwise, the component is not put in the tab.

The USER_Part_s type is a structure defined as follows :

typedef struct USER_Part { char dataset_uid[28]; char item_id [ITEM_id_size_c]; char item_rev_id[ITEM_id_size_c]; } USER_Part_s;

Dataset

cat_USER_build_dataset_name

extern int ExportedByCatiaCustom cat_USER_build_dataset_name (tag_t i_item_rev, /* */ tag_t i_dataset_type, /* */ tag_t i_relation_type, /* */ char io_dataset_name[WSO_name_size_c+1]) /* <O> */

Attributes

i_item_rev : The tag of the Item Revision; i_dataset_type : The tag of the dataset type i_relation_type : The tag the relation type between the dataset and the item revision io_dataset_name : The dataset name built by the function

Description

8-10


This function is used before a Dataset is created from a CATIA V5 component. It returns the Dataset name.

By default, the name of the dataset is the result of the call to USER_new_dataset_name or as entered in the Save dialog.

The USER_new_dataset_name ITK function does not take the dataset name into account. When USER_new_dataset_name returns an error or a null dataset_name, the cat_USER_build_dataset_name also returns an error or an empty dataset_name. When the dataset name is empty, the dataset name is built with the ItemId/ItemRevId rule. If errors occur, an Unable to create the dataset name error message displays and the Save process stops.

cat_USER_buildFileName

The Named Reference customized file name should not exceed 132 characters, including the file extension, due to an internal Teamcenter limitation. The CATPart, CATShape and jt file names should not exceed 108 characters to ensure cache files are managed correctly.

extern int ExportedByCatiaCustom cat_USER_buildFileName ( tag_t i_item_rev_tag, /* */ tag_t i_dataset_tag, /* */ char **iiop_file_name); /* <I/OF> */

Attributes

i_item_rev_tag : tag of the Item Revision i_dataset_tag : tag of the Dataset iop_file_name : the filename built by the function.

Description

This function is used when the Integration builds the FileName’s primary object during Save or Load process. It returns the FileName customization implemented in the entry point function.

8-11


By default, the FileName of the primary object is build according to CATIA_xxx_file_name_format preference value. For instance, the CATPart documents' FileName is built according to CATIA_part_file_name_format preference value which is itemID_itemRevID, by default.

cat_USER_buildPartNumber

extern int ExportedByCatiaCustom cat_USER_buildPartNumber ( tag_t i_item_rev_tag, /* */ tag_t i_dataset_tag, /* */ char **iiop_partnumber); /* <I/OF> */

Attributes

i_item_rev_tag : tag of the Item Revision i_dataset_tag : tag of the Dataset iop_partnumber : the part number built by the function.

Description

This function is used when the Integration builds the PartNumber’s primary object during Save or Load process. It returns the PartNumber customization implemented in the entry point function.

By default, the FileName of the primary object is build according to Teamcenter mapping or the value of the CATIA_MAP_Property_PartNumber preference.

cat_USER_get_dataset_revision

extern int ExportedByCatiaCustom cat_USER_get_dataset_revision ( tag_t item_rev_tag, /* */ tag_t dataset_tag, /* */ int *dataset_revision ) /* <O> */

Attributes

item_rev_tag : tag of the Item Revision dataset_tag : tag of the Dataset dataset_revision : returned dataset revision value.

Description

This function defines an entry point to allow the user to define the dataset revision used when creating the dataset, for Save As New and Save As New Revision processes. It is called after creating the dataset.

8-12


If this function returns a FailCode or if the dataset revision value is not greater than 1, no dataset revision will be set to the dataset, then the dataset revision will be 1.

If this function returns a valid revision number, and only in this case, this revision number is assigned to the dataset and its anchor. Two saves are performed, one on the dataset anchor and one on the dataset itself. If this function is not customized or returns a FailCode or a revision number greater than 1, only the dataset will be saved.

cat_USER_is_default_dataset

extern ExportedByCatiaCustom cat_USER_is_default_dataset (tag_t i_item_rev_tag, /* */ tag_t *ip_dataset_tag_tab, /* */ tag_t *ip_relation_tag_tab, /* */ int i_dst_tab_size, /* */ logical *op_is_default_dataset, /* <O> */ tag_t *op_dst_tag) /* <O> */ )

Attributes

i_item_rev_tag : tag of the item revision; ip_dataset_tag_tab : array of dataset tags, all datasets have the same type (entry point is called several times when different dataset types exist under the item revision) ip_relation_tag_tab: array of relation tags between an item revision and each dataset of i_dataset_tag_tab i_dst_tab_size: size of i_dataset_tag_tab and i_relation_tag_tab op_is_default_dataset : flag indicating if a default dataset is found op_dst_tag: tag of the default dataset: should be not NULLTAG if o_is_default_dataset = true and if there are many datasets of the same type under the item revision (i_dst_tab_size > 1)

Description

This entry point is called during the Load process, when datasets attached to a part item revision are read. It permits UserA to load an assembly with specific foreign files and UserB to load the same assembly with CATPart files depending on settings within Teamcenter preferences.

This function allows the user to indicate which dataset will be a default dataset, i.e., which dataset to load, depending on the dataset type defined in ip_dataset_tag_tab list.

The CATIA_component_dataset_types setting in Teamcenter preferences is read to define the datasets types' priority. This preference is taken into account when op_is_default_dataset parameter returns false.

This function is called for each dataset type defined in the list returned by the CATIA_CATPart_dataset_type, CATIA_catia_dataset_type and CATIA_component_dataset_types preferences on a leaf assembly.

8-13


When op_is_default_dataset parameter returns true:

• When i_dst_tab_size is equal to 1, the default dataset is returned in i_dataset_tag_tab.

• When i_dst_tab_size is greater than 1, the default dataset is returned in o_dst_tag.

• When o_dst_tag is NULLTAG, the default dataset search continues.

cat_USER_validateCacheDatasetForLoad

extern int ExportedByCatiaCustom cat_USER_validateCacheDatasetForLoad(tag_t i_geo_dataset, /* */ tag_t i_cache_dataset, /* */ tag_t i_load_as_cgr_process, /* */ tag_t *op_is_cache_dataset_valid) /* <O> */

Attributes

i_geo_dataset : tag of the geometry dataset; i_cache_dataset : tag of the cache dataset; i_load_as_cgr_process : boolean to specify when it is a Load as cgr process; op_is_cache_dataset_valid: boolean to specify if the cache dataset is empty

Description

This entry point is called during the Load process, when datasets attached to a part item revision are read. It allows the user to customize the criteria used to determine when a cache dataset is valid for a Load as cgr process. When a cache dataset is not valid, the geometry dataset is loaded instead of the cache, even when the Load as cgr option is activated.

This entry point reads the CATIA_cache_validate_dataset_for_load preference but takes priority over the preference value.


8-14


Export as reference and Load as reference

This method enhances the Export as reference and Load as reference processes which permits exporting and loading structures to a reference directory.

cat_USER_buildReferencePrefixSuffix

cat_USER_buildReferencePrefixSuffix(tag_t i_bom_window,tag_t i_item_rev_tag, tag_t i_dataset_tag, char *i_named_ref_type, tag_t i_file_tag, EnumUSERReferenceType i_type, char **op_prefix, char **op_suffix)

Attributes

i_bom_window: BOM window tag; i_item_rev_tag: Item revision tag; i_dataset_tag: Dataset tag; i_named_ref_type: Named reference type to be loaded; i_file_tag: file tag in the dataset's named reference; i_type: data type (must be a top level, component node, product node or leaf); op_prefix: prefix; op_suffix: suffix;

Description

This method enables the user to define an additional prefix and suffix for the file name in order to avoid file conflicts and staging conflicts. By default, it returns !ITK_ok, therefore only the CATIA_reference_prefix preference value is applied.

The file names are built according to the preference, prefix and suffix values. Refer to the following table:

Prefix Value?

Suffix Value? Result

no no file name = valuePref_fileName

yes no file name = valuePref_FonctionPrefixValue_fileName


8-15


Prefix Value?


no yes file name = valuePref_fileName_FonctionSuffixValue

yes yes file name = aluePref_FonctionPrefixValue_fileName_FonctionSuffixValue

cat_USER_buildReferencePrefixSuffixPartNumber

cat_USER_buildReferencePrefixSuffixPartNumber(tag_t i_bom_window,tag_t i_item_rev_tag, tag_t i_dataset_tag, char *i_named_ref_type, tag_t i_file_tag, EnumUSERReferenceType i_type, char **op_prefix, char **op_suffix)

Attributes

i_bom_window: BOM window tag; i_item_rev_tag: Item revision tag; i_dataset_tag: Dataset tag; i_named_ref_type: Named reference type to be loaded; i_file_tag: file tag in the dataset's named reference; i_type: data type (must be a top level, component node, product node or leaf); op_prefix: prefix; op_suffix: suffix;

Description

This method enables the user to define an additional prefix and suffix for the part in order to avoid part number conflicts. By default, it returns !ITK_ok, therefore only the CATIA_reference_prefix_partnumber preference value is applied.

8-16


The part numbers are built according to the preference, prefix and suffix values. Refer to the following table:

Prefix Value?


no no part number = valuePref_partNumber

yes no part number = valuePref_FonctionPrefixValue_partNumber

no yes part number = valuePref_partNumber_FonctionSuffixValue

yes yes part number = valuePref_FonctionPrefixValue_partNumber_FonctionSuffixValue

External Files

cat_USER_externalFilesInfo customizes the filename of external files. This function is used during save processes.

extern int ExportedByCatiaCustom cat_USER_externalFilesInfo ( StructUserDerivedFiles_s i_primary_element, /* */ int i_externalfiles_tab_size, /* */ StructUserDerivedFiles_s *iop_externalfiles_tab) /* <I/O> */ { return(!ITK_ok); }

typedef struct StructUserDerivedFiles { tag_t itemrev_tag; /* item rev tag */ tag_t dataset_tag; /* dataset tag */ logical created_in_tc /* flag used to indicate if the dataset has been created during the current process */ char *original_file_name; /* name of the file on disk (name of external files, null if external files)*/ char *file_name; /* <I/O> name of the file built by the Integration: customizable in the entry point */} StructUserDerivedFiles_s;

8-17


Attributes

i_primary_element : information about the primary dataset (StructUserDerivedFiles structure); i_externalfiles_tab_size: size of iop_externalfiles_tab tab; iop_externalfiles_tab : tab of external files related to the primary datatset

Description

This method is used to customize the filename of External files. This function is used during save processes. The default value for the filename is primary document filename.external file extension.

The original_file_name parameter must be copied into the file_name parameter of the StructUserDerivedFiles structure to retain the CATIA original file name.

Foreign Files

cat_USER_build_foreign_file_name

extern ExportedByCatiaCustom char *cat_USER_build_foreign_file_name ( tag_t ItemRevTag, /* */ tag_t DatasetTag, /* */ char *old_file_name ) /* */

Attributes

ItemRevTag : tag of the item revision where the foreign dataset will be attached; DatasetTag : tag of the foreign dataset where to save the foreign file; old_file_name : old foreign file name.

Description

This function defines an entry point to allow the user to define the foreign file name to save in the dataset. By default, this function returns NULL. In this case, the file name is built like following: <old_file_name>_<dataset_uid>.<extension>

Modifications to the dataset name or the dataset description in this function can be performed. However, do not save the dataset after these modifications using the AOM_save function, it will be performed later in the code.

8-18


Import Spreadsheet

cat_USER_entry_point_customize_sprdsheet

extern int ExportedByCatiaCustom cat_USER_entry_point_customize_sprdsheet ( EXP_Part_s *part ) /* <I/OF> */

Attributes

part : An EXP_Part_s structure.

Description

This function customizes what is written to the spreadsheet during the Import process. It takes an EXP_Part_s structure as parameter, defined below.

typedef struct EXP_Part { tag_t itemRev_tag; tag_t *dst_tag; int dst_nbr; char OEM_fileName[257]; char OEM_partNbr[129]; char OEM_def[129]; char OEM_rev[129]; char OEM_nomenc[129]; char OEM_desc[257]; char OEM_dlname[129]; char item_id[128]; char itemRev_id[128]; char item_type[ITEM_type_size_c + 1]; char dst_type[WSO_name_size_c + 1]; char item_co[8]; char itemRev_co[8]; char dst_co[8]; char bvr_co[8]; char status[8]; char **userProps; int nbUserProps; char **newData; int newData_nbr; } EXP_Part_s;

The newData field can be used to add data in the spreadsheet. These data will then be added at the end of the current line. The newData_nbr must be set to the number of strings added at the end of the line.

8-19


Item Revision

cat_USER_find_stencil_item_rev_tag

extern int ExportedByCatiaCustom cat_USER_find_stencil_item_rev_tag ( const char item_id[32], /* */ tag_t *item_tag, /* <0> */ tag_t *item_rev_tag ) /* <O> */

Attributes

item_id : The ID of the Item; item_tag : The Item Tag returned by the function; item_rev_tag : The Item Revision Tag returned by the function.

Description

This function is used before a Dataset without a reference name is loaded in CATIA V5. It returns the item tag and the item revision tag of the seed document's item ID. By default, the item revision tag is the latest item revision tag.

Item and Item Revision

cat_USER_verify_item_and_rev

extern int ExportedByCatiaCustom cat_USER_verify_item_and_rev ( char item_id[32], /* */ char item_rev_id[32], /* */ char item_type[32], /* */ tag_t item_tag, /* */ tag_t item_rev_tag ) /* */

Attributes

item_id : ID of the Item; item_rev_id : ID of the Item Revision; item_type : type of the Item; item_tag : tag of the Item; item_rev_tag : tag of the Item Revision.

Description

8-20


This function is used to define an entry point during the save and supplier import form processes. It allows the user to validate the IDs (according to naming rules, for instance) and returns modified values under some circumstances.

For the import process, this entry point is used during the reading of the desc file. If one or more IDs are invalid, the process is stopped and an error file is created listing the invalid IDs.

For the save process, this entry point is used after OK is selected in the Save Item panel. If an ID is invalid, the panel is displayed again.

Item Revision Rule

cat_USER_getLatestRevision

cat_USER_getLatestRevision returns the latest item revision of the input revision list corresponding to the CATIA_latest_revision_set_type preference definition.

extern int ExportedByCatiaCustom cat_USER_getLatestRevision (tag_t *ip_item_rev_list , /* */ int i_item_rev_list_size , /* */ tag_t *op_item_rev_tag) /* <O> */

Attributes

ip_item_rev_list: list of item revision tag; i_item_rev_list_size: size of item revision tag list; op_item_rev_tag : NULLTAG if no match is found or tag of the returned item revision;

Description

This function is used to customize the latest revision type to return and is used in the Import, Replace by revision and Save processes. Use the CATIA_latest_revision_set_type preference to filter elements returned by Import Query during spreadsheet creation and to determine the latest revision type to return.

JT

cat_PV_catia2jt_next

extern int ExportedByCatia cat_PV_catia2jt_next ( tag_t item_rev_tag, /* */ int DMdtsProcess ) /* */

8-21


Attributes

item_rev_tag : tag of the Item Revision; DMdtsProcess : must be set to 1 to avoid a recursivity.

Description

This function creates or updates the JT dataset if necessary to save a new jt file and calls the catia2jt script.

cat_USER_buildJTFromNXFilename

extern int ExportedByCatiaCustom cat_USER_buildJTFromNXFilename(tag_t i_item_rev_tag, /* */ tag_t i_dataset_tag, /* */ char *i_named_ref_type, /* */ tag_t i_file_tag, /* */ char *i_foreignfilename_format, /* */ char **iop_exported_file_name); /* <I/OF> */

Attributes

i_item_rev_tag: Item revision tag; i_dataset_tag: Dataset tag of the JT from NX; i_named_ref_type: Named reference type to be loaded; i_file_tag: File tag of the JT from NX; i_foreignfilename_format: CATIA_foreignfile_file_name_format preference value; io_exported_file_name: Filename used to export the JT file from the staging directory;

Description

This method builds a unique filename for JT datasets created with NX. By default, the filename is built based on the CATIA_foreignfile_file_name_format preference value. This function is called in all load processes.

Teamcenter Integration for CATIA V5 supports direct loading of JTs to CATIA V5 when a license to use Theorem JT to load to CATIA V5 is available. JTs are delivered and inserted from CATIA and links to the JT file are maintained, with correct configurations. JT files are loaded to CATIA using Visualization or Design Mode, depending on the CATIA configuration.

When the returned filename is not unique in the assembly to be loaded, a filename conflict displays. When the function returns a failcode or a null filename,

8-22


the filename for the Named Reference is used to export the JT file from the staging directory.

Load

cat_USER_hasChildren

extern int ExportedByCatiaCustom cat_USER_haschildren( tag_t i_bom_line, /* */ tag_t i_item_rev_tag, /* */ tag_t i_bvr_tag, /* */ logical *op_answer); /* <O> */

Attributes

i_item_rev_tag : The tag of the Item Revision i_bom_line : The tag of the BOMLine i_bvr_tag : The tag of the BOMViewRev op_answer : TRUE if the item corresponds to a Product.

Description

This function is used to determine if a given item will be loaded in CATIA as a Product or a Part depending on specific conditions.

Five boolean variables are available to define various combinations in order to determine which type of document will be loaded in CATIA.

• ExistBVR : Set to true if under the Item when a BOMView type is defined in Teamcenter Preferences.

• EmptyBvr : Set to true if the previous variable, ExistBVR, is also true and theassociated BOMView Revision does not contain occurrences.

• ExistCATProduct : Set to true if the dataset type under the Item revision is defined in Teamcenter Preferences.

• ExistCATPart : Set to true if the dataset type under the Item revision is defined in Teamcenter Preferences.

• ExistOtherDataset : Set to true if the dataset type under the Item revision is defined in Teamcenter Preferences.

In this function, the CATIA_customize_load_process setting defined in Teamcenter Preferences, is used by the VarCATIA_CUSTOM_LOAD variable to determine the criterion used for the Load in CATIA.

8-23


• When the CATIA_customize_load_process option is set to 0 (default value) in Teamcenter Preferences the process analyzes the branches of the BOM tree, and stops when a node does not contain a valid CATIA BOM. In this case, cat_USER_hasChildren returns op_answer=FALSE and the item is considered a leaf of the tree (component).

• When CATIA_customize_load_process option is set to 1 in Teamcenter Preferences, the process analyzes the part and product datasets under the given item revision and checks whether the BOMView revision contains occurrences.

• When CATIA_customize_load_process option is set to 2 in Teamcenter Preferences, the process analyzes the part, product, V4 model and foreign file datasets under the given item revision and checks whether the BOMView Revision contains occurrences.

The cat_USER_hasChildren function returns op_answer=FALSE, indicating a part will be loaded, in three cases:

• A CATPart/V4/Foreign File dataset exists and a CATProduct dataset and BOMView Revision do not exist.

• A CATPart/V4/Foreign File dataset and BOMView Revision containing no occurrences exists and a CATProduct dataset does not.

• A dataset and BOMView Revision do not exist.

Occurrences

cat_USER_isOccurrenceNonCAD

File location: cat_USER_bom_customize.c customer entry point: cat_USER_isOccurrenceNonCAD default return value: false

Attributes

i_bom_line_tag : tag of the selected BOM line; iopp_message_tab <IOF> : contains customer messages; a NULL pointer is given for the first call, customer must allow this array themselves; iop_size_message_tab <IO> : iopp_message_tab array size.

Use Teamcenter allocation functions (MEM_alloc, MEM_crealloc...). Do not use Standard C memory allocation functions.

Description

This entry point is called during the Load and Save process, to check whether the instance corresponding to the i_bom_line_tag must be loaded.

8-24


When this function returns true for i_bom_line_tag, the instance is not loaded in CATIA; when it returns false (default), the current instance is loaded in CATIA.

Remarks

• The Entry point is not called for the root product of an assembly (top level); when the entry point always returns false, only the root product is loaded.

• An error message displays when the PSE selection is a non-CAD occurrence or when one of its parents is a non-CAD occurrence.

cat_USER_isOccurrenceToBeLoaded

File location: cat_USER_bom_customize.c Customer Entry Point: cat_USER_isOccurrenceToBeLoaded default return value: true

Attributes

i_top_line_item_rev_tag, /* tag of top Node (assembly context)*/ i_occuid_path: occuid path of current item; i_parent_item_rev_tag: tag of the parent item revision; i_parent_bomvr_tag: tag of the parent BOMview revision; i_item_rev_tag: tag of the item revision; i_occ_tag : tag of the occurrence.

Description

This function is used during Load processes. The cat_USER_isOccurrenceToBeLoaded entry point is called to determine if the instance corresponding to i_occ_tag must be loaded. If this function returns false for i_occ_tag, the instance is not loaded in CATIA.

The entry point is not called for the assembly root product. If the entry point always returns false, only the root product loads. A warning message, specific to the Load Merge Target, Load Merge Selected, and Refresh processes, displays when items are bypassed by this entry point.

8-25


Replace by revision

The cat_USER_getItemRevisionForReplaceByRevision method enhances the Replace by revision process which permits revising an item in CATIA with a specific revision.

cat_USER_getItemRevisionForReplaceByRevision (tag_t i_item_tag, tag_t i_item_rev_tag, tag_t *o_item_rev_list, int *o_item_rev_list_size);

Attributes

i_tag: Item tag of the selected element to be replaced; i_item_rev_tag: item revision tag of the selected element to be replaced; o_item_rev_list: list of item revisions available for Replace By revision; o_item_rev_list_size: list size;

Description

This method enables the user to define a list of item revisions to be displayed in the Replace By Revision panel.

By default, this method returns all item revisions accessible to the current user except the one corresponding to i_item_rev_tag.

Save

cat_USER_entry_point_after_save_all_files

extern int ExportedByCatiaCustom cat_USER_entry_point_after_save_all_files ( USER_Part_s *datasets_tab, /* */ int nb_datasets ) /* */

Attributes

datasets_tab : The tab of saved datasets; nb_datasets : The number of saved datasets.

8-26


Description

This function defines an entry point after the save of all files and all multi-links of an assembly during the save process. The USER_Part_s type is a structure defined like following :

typedef struct USER_Part { char dataset_uid[28]; char item_id [ITEM_id_size_c]; char item_rev_id[ITEM_id_size_c]; } USER_Part_s;

For example, use the cat_PV_catia2jt_next function to use the JT translator build JT datasets for all saved parts.

Save New Revision

cat_USER_validateForSaveNewRevision

extern int ExportedByCatiaCustom cat_USER_validateForSaveNewRevision ( tag_t i_item_tag, /* */ tag_t i_old_item_rev_tag, /* */ char *i_new_item_rev_id, /* */ tag_t i_dataset_type, /* */ logical *op_is_valid, /* <O> */ char **op_message); /* <O> */

Attributes

i_item_tag : item tag; i_old_item_rev_tag: item rev tag of the old revision. The value is NULLTAG, by default, during the Import/Create ImportSpreadsheet processes; i_new_item_rev_id : item revision ID of the new revision; i_dataset_type: dataset type tag; op_is_valid: boolean used to validate the new revision; op_message: message displayed in the Save Manager

Description

This function is used to validate the Save New Revision or Import New Revision mode.

• When op_is_valid = true; the default behavior is used.

• When op_is_valid = false:

8-27


• The Save process is not available and a message, defined by op_message displays in the Save Manager. If op_message has not been defined, the default message, Unable to create a new revision displays.

Secondary Dataset

cat_USER_secondary_dataset_info

extern int ExportedByCatiaCustom cat_USER_secondary_dataset_info( tag_t ItemRevTag, /* */ tag_t primary_object_tag, /* */ tag_t secondary_dataset_type_tag, /* */ tag_t relation_type_tag, /* */ char DstName[WSO_name_size_c+1], /* <IO> */ char DatasetDescription[WSO_desc_size_c+1]) /* <IO>*/

Attributes

ItemRevTag : tag of the Item Revision; primary_object_tag : tag of the primary object secondary_dataset_type_tag : the tag of the secondary dataset type relation_type_tag : the tag of the relation DstName : the dataset name built by the function. It is truncated after the function call to WSO_name_size_c or TC_LEGACY_ID_NAME_SIZE according to the TC_Allow_Longer_ID_Name Teamcenter Preference DatasetDescription : the description of the dataset

Description

This function is used before a secondary dataset is created. It returns the name and description with which the dataset will be created, according to information retrieved from the Item Revision and the Drawing dataset the secondary dataset will be linked to. This function is currently used for:

• Auxiliary datasets of CATParts, CATProducts, CATProcesses, and CATAnalysis'

• Auxiliary vectorial dataset

• CATComputation and CATAnalysis datasets

• CATCache datasets

• External datasets of CATParts, CATProducts, CATProcesses, CATAnalysis', and CATDrawings

If the auxiliary document is vectorial, the dataset name is defined by Item ID and ItemRev ID, by default.

8-28


If the auxiliary document is not vectorial, the dataset name is defined by sheet referenced by the auxiliary dataset, by default.

cat_USER_secondary_parts_info

extern int ExportedByCatiaCustom cat_USER_secondary_parts_info( StructUserSecondaryPart_s io_parent_prod, /* */ int i_secondary_parts_tab_size, /* */ StructUserSecondaryPart_s **iop_secondary_parts_tab) /* <I/O> */

typedef struct StructUserSecondaryPart { tag_t dataset_tag; /* */ logical modified_in_catia; /* */ char *original_file_name; /* */ char *original_part_number; /* */ char *file_name; /* <IO> */ char *part_number; /* <IO> */ } StructUserSecondaryPart_s;

Attributes

io_parent_prod : information about the parent product of the secondary part; i_secondary_parts_tab_size: size of iop_secondary_parts_tab; iop_secondary_parts_tab : secondary part default value.

Description

This method is used to customize the filename and PartNumber of Secondary Parts. This function is used during save processes.

The default value for the filename is the CATProduct filename followed by dot (.) then an index. The default value for the partnumber is the CATProduct partnumber followed by dot (.) then the same filename index.

The original_file_name parameter must be copied into the file_name parameter and the original_part_number parameter must be copied into the part_number parameter of the StructUserSecondaryPart structure to retain the CATIA original file name and part number.

8-29


Title Block

cat_USER_write_TTB_values

extern int ExportedByCatiaCustom cat_USER_write_TTB_values ( char ***char_array, /* <OF> */ int *size_array, /* <O> */ tag_t ItemRevTag, /* */ tag_t DatasetTag ) /* */

Attributes

char_array : array to be written in, array transferred to client; size_array : number of lines; ItemRevTag : tag of the Item Revision; DatasetTag : tag of the Dataset.

Description

This function sends the user-defined name/value pairs to CATIA V5 in order to complete the title block. The pairs are sent via the string array because the file is written by the client. Each line shall be of the form "<type> <name>|<value>" By default, <type> can be an Item, ItemRev, Dst, ItemMaster, ItemRevMaster and <name> is an iMAN attributes name, such as Description, Name, Owner, etc.

Item Name|GENERAL ASSEMBLY ItemRev Revision|A Mytype MY_ATTRIBUTE|MY_CHARACTER_STRING

The last example shows a line with a type, a name and a value that are not from Teamcenter, but that can be built in the function cat_USER_write_TTB_values.

This line must be written into the array like following :

char **array = (char**)MEM_alloc(sizeof(char*)); array[0]=(char*)MEM_alloc(128*sizeof(char)); strcpy(array[0],"Mytype MY_ATTRIBUTE|MY_CHARACTER_STRING"); (*char_array)=array; (*size_array)=1;

With this example, the identifier of the CATIA V5 text to be updated should be IM_CATIA_MYTYPE MY_ATTRIBUTE. Therefore, the CATIA V5 text will be replaced by MY_CHARACTER_STRING. The information can be retrieved from the item revision or the dataset.


8-30


TC_Custom Libraries

UNIX Windows Sample Scripts

Ensure C compiler is used to compile and that the compiler version matches Teamcenter requirements listed in the Teamcenter documentation.

Use the ITK function files to generate the libcatia_tc_custom.lib and libcatia_tc_custom.dll files for Windows or the libcatia_tc_custom.so or libcatia_tc_custom.sl files for UNIX, depending on platform.

UNIX

Perform the following steps to generate and use the UNIX libcatia_tc_custom shared library.

1. Locate the following three scripts within the $TCICV5_DIR/sample directory.

• compile_libcatia_tc_custom

• compile

• link_custom_tc_exits

2. Ensure you have sufficient rights to execute scripts, then edit compile_libcatia_tc_custom, as required (enter the value for %TC_ROOT% corresponding to the Teamcenter installation location).

Administrator privileges may be required to perform this operation.

3. Read the warning below, then execute the compile_libcatia_tc_custom script.

The resulting libcatia_tc_custom library is placed under the $TC_ROOT/lib directory. To avoid copying the shared library under the $TC_ROOT/lib directory, edit the link_tc_custom_exits script by uncommenting the mv $customLibrary ${TC_USER_LIB} line at the end of the script


8-31


Windows

Perform the following steps to generate and use the Windows libcatia_tc_custom.dll shared library.

1. Locate the following three batch files within the %TCICV5_DIR%\sample directory.

• compile_libcatia_tc_custom.bat

• compile.bat


2. Set VSINSTALLDIR=C:\Program Files\Microsoft Visual Studio 8.

3. Set MSDEV_HOME=%VSINSTALLDIR%\Vc

4. Write call "%VSINSTALLDIR%"\Common7\Tools\vsvars32.bat at the prompt.

5. Ensure you have sufficient rights to execute .bat files.

6. Edit compile_libcatia_tc_custom.bat as required (enter the value for %TC_ROOT% corresponding to the Teamcenter installation location and %MSDEV_HOME%).

7. Execute the compile_libcatia_tc_custom.bat file. Administrator privileges may be required to perform this operation

8. Copy the libcatia_tc_custom.lib file to the %TC_ROOT%\lib directory.

9. Copy the libcatia_tc_custom.dll file to the %TC_ROOT%\bin directory.

Scripts

Refer to the following scripts for Windows or UNIX located in the TcIC_DIR\sample folder.

Scripts to compile/link with Teamcenter for Windows.

• compile_libcatia_tc_custom.bat

• compile.bat


Scripts to call with Teamcenter for UNIX.

• compile_libcatia_tc_custom

• compile

• link_tc_custom_exits


8-32


RACLess Entry Points

Definition of the client_env File List of Functions Available in RACLess Mode The StartRACLessServer.bat File and Project Management JAVA Code Customizations RACLess Command Line Entry Points

RACLess Mode Through Server Support

Teamcenter Integration for CATIA V5 commands can be run without launching a connection through Teamcenter Rich Application Client (RAC). Running these commands without a RAC connection is called a RACLess mode.

The purpose of the RACLess mode is to be fully independent from the RAC application so that external applications can connect to TcIC commands using their own client application, such as Teamcenter Active Workspace or a customized client application, instead of using the Teamcenter Portal as the default client application.

TcIC can be run using a Teamcenter RAC client or in RACLess mode.

Definition of the client_env File

The client application which connects to the Integration is defined in the %TCICV5_DIR%\env\client_env file. By default, this file is set during installation of the Integration.

Teamcenter client communication system (TCCS) manages communication and file transfers between Teamcenter clients and servers. TCCS contains the FMS client cache (FCC), which uploads files from a workstation to a Teamcenter volume and also downloads requested files from the volume to a workstation.

The Integration supports a single host stand-alone TCCS installation defined in the client_env file (TCCS_SA option). TCCS and FCC file transfer is also supported. There is no Client installed.

When the process launched is RAC/RACLess, the first client_0 defined in the client_env is used for the RACLess connection; when -client is not set or is invalid, the first valid client defined in the client_env file is used for the RACLess connection.

Clients in order of priority when connected to the RACLess Application are:

1. RAC

2. Teamcenter Loader (LOADER_CLIENT0)

8-33


3. Embedded Active Workspace (AW_CLIENT0)

4. Standalone Active Workspace (AW_CLIENT1)

5. Full RACLess ( CATIA)

When a RACLess command launches and the client is not connected to the RACLess application, the first client available within the list of available client sessions, defined in client_env file, is used to connect to the RACLess application.

When the Start Teamcenter command launches and the client is not connected to the RACLess Application, a Teamcenter Client panel displays to select the appropriate client, from a list of available client sessions, to connect to the RACLess application.

The RACLess application launches:

• the socket server, defined by the TcIC_socket_port variable, to manage the interface between CATIA and the client (Portal, customized Loader, Active Workspace client…).

• a SOA connection to the Teamcenter server

The %TCICV5_DIR%\env\client_env file is structured as shown. Refer to the table below or click on the definitions for descriptions:

<client> Client Name Client Full Path Category Teamcenter Rich Client or FMS Directory </client>

8-34


Definition Description

Client Name The client current configuration. It's strongly recommended to avoid having the same client name used twice in this file.

Client Full Path The file used to launch the client (Teamcenter loader, portal.bat, fms…). For example, portal_en.bat

Category

Use Client_0 when portal.bat (RAC) or TcICloader.bat (Teamcenter Loader) are the client. Interactive actions like Selection in Teamcenter and Refresh in the Structure Manager are supported, corresponding to a Standard Teamcenter Integration for CATIA V5 installation. Use Client_1 when Active Workspace or Custom Loader are the client. In this case, interactive actions are not supported in Teamcenter Integration for CATIA V5. Use TCCS_SA for a stand-alone TCCS installation. Only full RACLess commands are supported because a client is not installed.

Teamcenter Rich Client or FMS Directory

Use TC_PORTAL_ROOT when the client is portal.bat with Client_0 Use TC_PORTAL_ROOT or FMS_HOME for other clients (Active Workspace, Loader) . Use FMS_HOME when a client is not installed (with TCCS_SA).

Sample of a client_env file for Standard Teamcenter Integration for CATIA V5 (portal.bat client):

<client> Teamcenter C:\Tc10.1.2_20140617\portal\portal.bat Client_0 C:\Tc10.1.2_20140617\portal </client>

Sample of a client_env file for TCCS_SA:

<client> NO RAC TCCS_SA

8-35


C:\Tc10.1.2\tccs </client>

Sample of a client_env file for Teamcenter Integration for CATIA V5 Loader client:

<client> Teamcenter Integration for CATIA V5 Loader C:\TCIC_V5\racless\TcICLoader.bat Client_0 C:\Tc10.1.5_20151030\portal </client>

Sample of a client_env file for Teamcenter Integration for CATIA Loader and Teamcenter Rich Client:

<client> Teamcenter C:\Tc10.1.5_20151030\portal\portal.bat Client_0 C:\Tc10.1.5_20151030\portal </client> <client> Teamcenter Integration for CATIA V5 Loader C:\TCIC_V5\racless\TcICLoader.bat Client_0 C:\Tc10.1.5_20151030\portal </client>

Sample of a client_env file for Embedded Active Workspace client:


When the Teamcenter Embedded Active Workspace Client has been manually added in the client_env file, ensure that the Windows registry has been updated with the %TCICV5_DIR%\aw\aw_keys.reg file and the TcIC_awhosted_menu variable in the %TCICV5_DIR%/env/tcic_var_env.xml file is set to true.

Sample of a client_env file for Standalone Active Workspace client:

<client> Teamcenter Standalone Active Workspace Client http://vm-tcserver33:7031/awc Client_1 C:\Tc10.1.5_tccs_sa\tccs </client>


8-36


When the Teamcenter Standalone Active Workspace Client has been manually added in the client_env file, ensure that the Windows registry is updated with the %TCICV5_DIR%\aw\aw_keys.reg file.

List of Functions Available in RACLess Mode

Key:

Full RACLess: A Teamcenter client is not running and a RACLess connection is established. RAC only: A Teamcenter RAC client is running and a connection to the RACLess application is established. RAC/RACLess: A Teamcenter RAC client is running and a RACLess connection is established.

Function RAC/RACless

About integration Full RACLess, RAC only, RACLess optional

Add CATShape Shape Representations Full RACLess

Browse Multi-Model Links from CATIA Full RACLess

Browse Multi-Model Links from Teamcenter RAC / RACLess

Check In Full RACLess, RAC / RACLess

Check Out Full RACLess, RAC / RACLess

Convert into JT RAC / RACLess

Create CATPart dataset for selection RAC / RACLess

Create CATProduct dataset for selection RAC / RACLess


8-37



Create ExportSpreadsheet RAC / RACLess

Create ImportSpreadsheet Full RACLess

Detailed States Full RACLess

Display mass properties in the top assembly origin RAC / RACLess

Documentation No connection required, RAC only

Export RAC / RACLess

Export as reference RAC / RACLess

Highlight in CATIA RAC / RACLess

Highlight in Teamcenter RAC / RACLess

Import Full RACLess

Insert RAC / RACLess

Load RAC / RACLess

Load as reference RAC / RACLess


8-38



Load for Compare RAC / RACLess

Load for Consulting RAC / RACLess

Load from Teamcenter RAC / RACLess

Load Merge RAC / RACLess

Load Merge Selected Level Full RACLess, RAC / RACLess

Load Merge Target Full RACLess

Load, Update, Save RAC / RACLess

Loader RACLess

Purge Staging Directory No connection required

Read Linked Documents Full RACLess

Refresh Full RACLess

Remove links RAC / RACLess

Replace by revision Full RACLess


8-39



Replace from Teamcenter RAC / RACLess

Replace load as cgr Full RACLess

Return to CATIA V5 RAC only

Revise RAC only

Save Full RACLess

Save As Full RACLess, RAC only

Save Selected Full RACLess

Spreadsheet Editor Full RACLess

Start Teamcenter from CATIA RAC only

Synchronize Active Shapes Full RACLess

Update assembly mass properties RAC / RACLess

Update status Icon in CATIA Full RACLess

Update Title Block Full RACLess


8-40



User settings from CATIA Full RACLess

User Settings from Teamcenter RACLess only

Volume search RAC / RACLess

StartRACLessServer.bat file and Project Management

Launch the StartRACLessServer.bat file Stop the RACLess Connection

The Teamcenter projects which are defined to provide a mechanism for organizing data and implementing access control based on project membership, can also be set during the RACLess connection and used to configure log in.

The client name defined in the client_env file is also set during the RACLess connection and used to configure log in. A cache file is created after the connection is made, stores the log in information and contains User/Group/Role/Host/TCCS parameters.

If the login operation fails, modify TCIC_RETRY_LOGIN_COUNT to define the number of connection attempts and modify TCIC_RETRY_LOGIN_DELAY to define the elapsed time (in seconds) between two connection attempts. By default, both values are 2.

The StartRACLessServer.bat file parameters are defined within the %TCICV5_DIR%\racless directory and support Teamcenter Projects ( -proj) and Teamcenter Client name (-client).

When the -proj parameter is not set or is invalid, the default project is used for the RACLess connection, if it exists for the current user. Set the -proj parameter without a value to permit the user to define the project for the connection. When -proj has been set without a value, no project is used for the RACLess connection.

8-41


The -client parameter defines the client name in the client_env file that is used when launching the command. When the process launched is RAC/RACLess, the first client_0 defined in the client_env is used for the RACLess connection; when -client is not set or is invalid, the first valid client defined in the client_env file is used for the RACLess connection.

Clients in order of priority when connected to the RACLess Application are:

1. RAC

2. Teamcenter Loader (LOADER_CLIENT0)

3. Embedded Active Workspace (AW_CLIENT0)

4. Standalone Active Workspace (AW_CLIENT1)

5. Full RACLess (CATIA)

Launch the StartRACLessServer.bat file

Use the following parameters to launch the StartRaclessServer.bat script.

-u=<user_id> -p=<password> -g=<group> -r=<role> -nl=<lang> -h=<host> (for 2T:iiop:localhost:1572/TcServer1 or 4T: http://vm-tcserver16:7025/tc or 4T TCCS: tccs_4T_t1312b_vm-tcserver16_sso) -proj=<project_id> -client=<client_name>

DOS versions interpret certain characters (for example, % < | >) before executing a command. Use double-quotes ( " ) to avoid bad instructions. When FMS_HOME is defined during the Installation process, JRE_HOME or JAVA_HOME variables are set in the StartRACLessServer.bat file, in the case those variables are defined.

Stop the RACLess connection

In some circumstances, the RACLess connection must be manually stopped to unlock CATIA/Teamcenter during troubleshooting.

There are two methods which can be used to deblock Teamcenter Integration processes to stop the RACLess connection.

• Create a bat file


8-42


• Teamcenter Integration System Tray

Create a .bat file

Create a .bat file containing the following instructions to stop the RACLess connection.

@echo off REM Path of the jdk to use : to be updated if needed set JDK_HOME=C:\Program Files\java\jdk1.7.0_17 C: cd %JDK_HOME%\bin jps -ml > test.racless.log For /F "tokens=1,2" %%i in (test.racless.log) Do IF "%%j"=="com.ebsolutions.soacore.Launcher" taskkill /F /T /PID %%i del test.racless.log

The following conditions should be confirmed before creating or running the .bat file.

1. A Java Development Kit (JDK) is installed on the machine.

2. Users have write access to the JDK directory. If they do not have write access, replace jps -ml > test.racless.log For /F "tokens=1,2" %%i in (test.racless.log) Do IF with jps -ml > %TEMP%\test.racless.log For /F "tokens=1,2" %%i in (%TEMP%\test.racless.log) Do IF "%%

Teamcenter Integration System Tray

The Teamcenter Integration System Tray launches when a RACLess application launches. Use the system tray to control Teamcenter Integration processes. The System Tray is automatically closed when the RACLess application is closed.

The system tray is located at the bottom of the desktop, lower right-hand corner of the screen.

Use Exit Teamcenter Integration for CATIA to unlock Teamcenter Integration processes.


8-43


Remove the following lines in the StarRACLessServer.bat file to deactivate the system tray.

REM Start TcIC System Tray. REM TcIC System Tray is optional. Comment following three lines to turn it off. set MAINCLASS=com.ebsolutions.systray.SystemTrayIconPopup set SYSTRAY_CMD=START "TcIC System Tray" /B "%JRE_HOME%\bin\java" -Xms256M -classpath "%RACLESS_CLASSPATH%" %MAINCLASS% %SYSTRAY_CMD%

Manually launch the system tray by creating a .bat file containing following instructions.

@echo off setlocal REM ******************************************************************************** REM This script launches a SYSTRAY application. REM Set JRE_HOME REM If value JRE_HOME contains spaces, you must enclose the string in double quotes REM Please ensures %JAVA_HOME% defined in CATIA environment file match the expected Java version. REM Otherwise it may create conflicts and prevent CATIA integration to work. REM if defined JAVA_HOME set JRE_HOME=%JAVA_HOME% if defined JRE_HOME set JRE_HOME=%JRE_HOME% if defined JRE64_HOME set JRE_HOME=%JRE64_HOME% if not defined JRE_HOME set JRE_HOME=C:\Program Files\Java\jre7 REM set the classpath REM Specify a list of directories, JAR archives, and ZIP archives to search for. REM Class path entries are separated by semicolons (;). Specifying SYSTRAY_CLASSPATH overrides any setting of the CLASSPATH environment variable. REM If the path entry contains spaces; you must enclose the string in double quotes. REM define RACLESS_DIR set RACLESS_DIR=%~dp0 set SYSTRAY_CLASSPATH=%RACLESS_DIR%Systray.jar;%RACLESS_DIR%lib\swt.jar set PATH=%PATH%;%FMS_HOME%\bin;%FMS_HOME%\lib;%ORIGINAL_PATH% REM java -classpath "%SYSTRAY_CLASSPATH%" -cp C:\TCIC_V5\racless\Systray.jar com.ebsolutions.systray.SystemTrayIconPopup REM java -classpath "%SYSTRAY_CLASSPATH%" -jar Systray.jar set MAINCLASS=com.ebsolutions.systray.SystemTrayIconPopup set SYSTRAY_CMD= "%JRE_HOME%\bin\java" -Xms256M -classpath


8-44


"%SYSTRAY_CLASSPATH%" %MAINCLASS% %* %SYSTRAY_CMD%

Then use the Exit command to manually exit the System Tray.

Ensure that the following path is defined in your PATH environment variable: %SystemRoot%\system32;%SystemRoot%;%SystemRoot%\System32\Wbem

JAVA Code Customizations

Introduction and Implementations Examples of RACLess Customizations Check-in/Check-out Customizations Save Manager and State Details Customizations Silent Import Silent Export Silent Load, Update Save RACless API JAVA Documentation

This section contains methods, pre/post actions and steps required to customize the RACLess processes used within the Teamcenter Integration for CATIA V5 using JAVA SOA RACLess APIs.

Introduction and Implementations

Prerequisites, Folder Hierarchy and File Descriptions Customized Implementations Process Lock Selection Management Silent TcIC RACLess Processes The tcic_selection.xml File User Interface Implementation: Main Classes


8-45


Prerequisites, Folder Hierarchy and File Descriptions

Prerequisites Folder Hierarchy and File Definitions

Samples described in this guide were built using Eclipse version 3.8.0. RACLess APIs have been developed in JAVA SOA technologies.

Prerequisites

• Strong knowledge of JAVA SOA technologies is required.

• JAVA version 1.7.0_17 is required with Teamcenter 10.1.5 and 11.3.0 and higher.

Folder Hierarchy and File Descriptions

RACLess APIs are available within the %TCICV5_DIR%\racless directory, sub-directories and libraries.

Files

The Cat2errormessagehandler.jar, Cat2journaling.jar, Cat2locale.jar, and Cat2utility.jar files are libraries for internal use only.

The Cat2soacore.jar file contains the ICatiaUserExit and ICommandEvent APIs definitions and libraries to enable:


8-46


• customizing an existing process.

• creating a user process.

• Interface implementations.

The StartRaclessServer.bat file launches the RACLess application.

The tcic_extensions.xml file contains the declaration of the ICatiaUserExit and ICommandEvent APIs implementations.

Folders

The extensions sub-directory contains user libraries:

• Pre/post actions definitions

• ICatiaUserExit RACLess

• ICommandEvent user implementation

The lib sub-directory contains the files for Teamcenter SOA Strong.


8-47


Customized Implementations

Introduction The Overload executeProcess Method (Method 1) The Overload Abstract Class Method (Method 2) ProcessConfiguration Class Customize the Log File MessageMgt Abstract Launch Process

Introduction

New processes can be implemented and called during the RACLess application. Each RACLess application class inherits from the RACLessProcessAbstract abstract class.

The following methods and variables are available for this class. Other functions and variables not listed are dedicated for internal use only.

The executeProcess function is the main function called by the RACLess application. The executeProcess function manages events defined in iCommandEvent, ICatiaUserExit entry points, pre/post actions and initialization required for RACLess processes. The executeProcess function should always return an instance of ProcessReturn, for example, the _process_return variable member of the RACLessProcessAbstract class.


8-48


There are two ways to customize:

1. Overload the executeProcess or executeProcess(String[]) functions of all abstracted classes so as not to be dependent on the ICommandEvent class or other RACLess processes.

2. Overload the fourth abstract function to reuse the ICommandEvent management or pre/post actions entry points.

A customized process must always be placed into a specific package such as com.MyCusto

The Overload executeProcess Method (Method 1)

1. In Eclipse, create a new Java project.

2. Enter the Project name then select the compatible JRE version: Java 1.7 for Teamcenter 10.1.5 and Teamcenter 11.3.0 and higher. Pick Next to continue.


8-49


3. Select the Libraries tab, then select the libraries below required for the project. Pick Finish when done.

a. Teamcenter SOA libraries contained in %TCICV5_DIR%\racless\lib

b. Cat2uimanager.jar library contained in %TCICV5_DIR%\racless.


8-50


Result:

Overload the executeProcess function



8-51


4. Select the src folder, right-click and then select New >> Class.

5. Complete the Package: and Name: fields on the New Java Class window.

6. Untoggle public static void main(String[] args) and toggle the Inherited abstract methods option on. Pick the Browse... button next to the Superclass: field.

7. Enter RACLessProcessAbstract in the Choose a type: field. Select RACLessProcessAbstract from the resulting Matching items box, then pick OK.


8-52


8. Pick Finish.

9. Add a new executeProcess function without parameters. The _process_return is set to OK status, by default, indicating the process is successful.


8-53


@Override public ProcessReturn executeProcess() throws Exception { JOptionPane.showMessageDialog(null, "my message"); return _process_return; }

Generate the Library

10. Highlight the project folder, then right-click and pick Export.


8-54


11. Toggle the Java folder open, select JAR file, then pick Next.

12. Select the project then enter a name and library location in the JAR file field. Place the library under the %TCICV5_DIR%\racless\extensions directory.


8-55


The library automatically loads when the RACLess process launches.

Test the Implementation

1. Use the %TCICV5_DIR%\racless\StartRaclessServer.bat command.

2. Launch following instruction in a command line: %TCICV5_DIR%\bin\WIN32\SocketV5.exe com.ExecuteProcessOverride 0 11400. The following message displays:


8-56


The Overload Abstract Class Method (Method 2)


2. Set the Project name then select the compatible JRE version: Java 1.7 for Teamcenter 10.1.2.5 and Teamcenter 11.2.1. Pick Next to continue.


8-57


3. Select the Libraries tab, then select the following libraries required for the project. Pick Finish when done.




8-58


Result:

Overload the abstract class



8-59



5. Complete the Package: and Name: fields.


7. Enter RACLessProcessAbstract in the Choose a type field. Select RACLessProcessAbstract from the resulting Matching Items box, then pick OK.


8-60



8-61


8. Pick Finish.

9. Implement the function as follows:

@Override protected int coreProcess() { JOptionPane.showMessageDialog(null, "coreProcess message"); return 0; } @Override protected int initProcessConfiguration() { _process_configuration = ProcessConfiguration.getDefaultProcessConfiguration(); return 0; } @Override protected int postProcessTasks() { JOptionPane.showMessageDialog(null, "postProcess message"); return 0; }


8-62


@Override protected int preProcessTasks() { JOptionPane.showMessageDialog(null, "preProcess message"); return 0; }




8-63





8-64





2. Launch following instruction in a command line %TCICV5_DIR%\bin\WIN32\SocketV5.exe com.AbstractOverride 0 11400. The following messages displays:


8-65


ProcessConfiguration Class

The configuration of each process must be defined through the ProcessConfiguration class. This configuration is set in the _process_configuration variable. Modify the configuration to change messages without having to modify the main code.

It's recommended to use the default configurations using the following methods:

• getDefaultSilentProcessConfiguration() for silent processes when the display message method is not used

• getDefaultProcessConfiguration() for silent processes when the display message method is used.


8-66


Some of the accessors are for internal use only, but are available to view their values.

getDefaultSilentProcessConfiguration()

The following implementation does not display a message and traces are written to the DefaultSilentCommand.log file.

@Override protected int coreProcess() { MessageMgtAbstract msg_manager = null; msg_manager = _process_configuration.get_message_manager(); msg_manager.showMessage("this is my message", "this is my title", 1); return 0; } @Override protected int initProcessConfiguration() { _process_configuration = ProcessConfiguration.getDefaultSilentProcessConfiguration();


8-67


return 0; }

getDefaultProcessConfiguration()

The sample code shown above displays the following message:

@Override protected int initProcessConfiguration() { _process_configuration = ProcessConfiguration.getDefaultProcessConfiguration(); return 0; }

Customize the Log File

Use the InitLogFile function to define a new log file. In this sample, the log file is created under the %WORK_DIR%\tmp directory and named my_process.log.

@Override protected int initProcessConfiguration() { _process_configuration = ProcessConfiguration.getDefaultSilentProcessConfiguration(); _process_configuration.initLogFile("my_process.log", false); return 0; }

MessageMgtAbstract

Each process manages a configuration like ProcessConfiguration. A message manager exists within each configuration and enables messages to be displayed in a dialog/message box or in the log file through the MessageMgtAbstract, MessageMgtInteractive and MessageMgtSilent classes.


8-68


Use the showMessage function to display messages.

When the getDefaultSilentProcessConfiguration configuration is managed, the MessageMgtSilent function is used and showMessage function writes in the log file.

When the getDefaultProcessConfiguration configuration is managed, the MessageMgtInteractive function is used and the showMessage function displays in a message box.

The forceInteractiveMessage function can be used to force message displays in a dialog box, even when the mode is silent.

Launch Process

The SocketV5.exe file, available under the %TCICV5_DIR%\bin\WIN32 directory, launches processes through socket server management.

Three parameters must be set:

8-69


1. The name of the process including class path and package. For example, com.MyNewProcess.

2. A tag (0 or 1) to specify if the process is a blocking process.

a. 0 if SocketV5.exe is not waiting for the end of com.MyNewProcess before continuing.

b. 1 if SocketV5.exe is waiting for the end of MyNewProcess before continuing.

3. RACLess server socket port, defined in the %TCICV5_DIR%\env\tcic_var_env.xml file.

<TcIC_socket_port> 11400 </TcIC_socket_port>

For example: :

%TCICV5_DIR%\bin\WIN32\socketV5.exe com.sample.SampleSilentImport 0 11400

Process Lock

Lock RACLess processes so that if one process is running, another process cannot be launched until the first one finishes.

Lock management is also available as a customized implementation. Locking the socket server is mandatory to avoid unexpected and incorrect behavior in the sample process.

The example below illustrates what happens when an import RACLess process is currently running and a Purge command launches.


8-70


Through the RACLessProcessAbstract class, it is possible to:

• Lock a process using the lockServer() method. If the method return a value other than 0, then another process is running.

• Unlock a process using the unlockServer() method.

8-71


Selection Management

There are two possibilities for setting selection during a process :

1. tcic_selection.xml file

2. ProcessConfiguration class

Rules

When the selection has been defined by code through ProcessConfiguration, the tcic_selection.xml file is not read.

The user is responsible for releasing the selection at the end of the process.

The tcic_selection.xml file

The tcic_selection.xml file must be created under %WORK_DIR%\tmp and adhere to the following format:

<?xml version="1.0" encoding="UTF-8"?> <selection> <component uid="[…]" bomwindow="[…]"/> <component …/> </selection>

Description

The <selection>…</selection> tag contains a list of Teamcenter Objects (Item, Item Revision, Datasets, BOM Lines, etc. )

Each object is identified by a <component> tag and a uid attribute. Each object under the <component> tag is managed as a ModelObject.

For a BOM Line object, the attribute, bomwindow, must be specified.

For example,

<?xml version="1.0" encoding="UTF-8"?> <selection> <component uid="QPRJPwqqohVQuA"/> <component uid="QjbJPwqqohVQuA"/> <component uid="BOM::40133" bomwindow="BOM::40128"/> <component uid="BOM::40135" bomwindow="BOM::40128"/> <component uid="BOM::40137" bomwindow="BOM::40128"/> <component uid="BOM::40148" bomwindow="BOM::40164"/> </selection>


8-72


The example above indicates, two objects of an Item or ItemRevision or Dataset type, three BOM lines originating from the same BOM Window (BOM::40128) and one BOM line originating from a specific BOM Window (BOM::40164)

ProcessConfiguration

View the ProcessConfiguration class.

The setSelectedElements function defines the list of the selected ModelObject. It is recommended to define this list early in the process; for example in the initProcessConfiguration or preProcessTasks function of your process.

The clearSelectedElements function clears the selection when needed.


8-73


Silent Processes with JAVA Code Customization

Similar to each RACLess process, silent processes also inherit from the RACLessProcessAbstract class.

All RACLess processes are silent processes beginning with Teamcenter Integration for CATIA V5 (10.0.0)

Available processes and their APIs

UserExportCommand : APIs for silent export.

UserLUSCommand : APIs for silent Load, Update, Save.

UserImportCommand : APIs for silent import.

Samples are available under %TCICV5_DIR%\custom_client.

8-74


The tcic_selection.xml File

The tcic_selection.xml file defines the selected BOM lines, the selected Drawing dataset, the selected item revision or the BOM Window.

The tcic_selection.xml file is used to define the configuration used during BOM Window creation. This BOM Window corresponds to the item revision UID defined at the top line of the file and reflects the selected BOM Iines in Teamcenter corresponding to the occurrences UID path defined in the file.

Three types of components are supported:

• itemrevision corresponding to an item revision selected in My Teamcenter or Classification.

• dataset corresponding to a dataset selected in My Teamcenter or Classification.

• bomwindow corresponding to a BOM window selected in the Structure Manager or Design Context.

• The selected BOM lines are listed under the bomwindow component, under <bomline> tags. When no tag is defined for the BOM line, the process is executed on the top line.

The file should be created under %WORK_DIR%\tmp and adhere according the following format. The sample shown below can be found in the online documentation.

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

8-75


<component type="itemrevision" uid="www"/> <component type="dataset" uid="xxx"/> <component type="bomwindow" uid="yyy"> <bomline uid="zzz"/> </component> <component type="itemrevision"> <item item_id="00012" object_type="ICATProduct" object_name="Product1" prop1="124"/> <revision item_revision_id="A"/> </component> <component type="bomwindow"> <item item_id="00012" object_type="ICATProduct" object_name="Product1" prop1="124"/> <revision item_revision_id="A"/> <configuration> <revrule name="mmm"/> <effectivity date="qqq" unit="rrr" item="sss"/> <optionset name="ttt"/> <variantrule name="uuu"/> </configuration> <bomline path="aaa/bbb/ccc/ddd"/> </component> </selection>

The following example illustrates 3 BOM Windows. The sample file can be found in the online documentation.

• A selected BOM line with a configured revision rule.

• No BOM Line selection, so the process is launched on the top line with an option set configured.

• Two selected BOM Lines.

<?xml version="1.0" encoding="UTF-8"?> <selection> <component type="bomwindow"> <item item_id="A1_item_id" object_type="A1_object_type" /> <revision item_revision_id="A1_item_revision_id" /> <configuration> <revrule name="Working; Any Status" /> </configuration> <bomline path="A2_occ_uid/A3_occ_uid" /> </component> <component type="bomwindow"> <item item_id="A10_item_id" object_type="A10_object_type" /> <revision item_revision_id="A10_item_revision_id" /> <configuration> <optionset name="color_blue"/> </configuration> </component> <component type="bomwindow"> <item item_id="A100_item_id" object_type="A100_object_type" /> <revision item_revision_id="A100_item_revision_id" />

8-76


<bomline path="A200_occ_uid/P100_occ_uid" /> <bomline path="A200_occ_uid/A300_occ_uid/P200_occ_uid" /> </component> </selection>

User Interface Implementations: Main Classes

Two interfaces, ICatiaUserExit and ICommandEvent, are available to customize RACLess processes.

ICatiaUserExit

The ICatiaUserExit interface defines five functions called in the following processes.

Function TcIC RACLess Processes

userExitAfterAllExportedFiles(…) userExitAtEndOfLoadProcesses(…) userExitAfterAllExportedFiles(…)

Create Export Spreadsheet Export Background Round Robin

userExitAfterAllImportedFiles(…) Import Background Round Robin

userExitModifyDesc(…)

Create Export Spreadsheet Export Background Round Robin Import

Implementation Example


2. Set the Project name then select the compatible JRE version: Java 1.7 for Teamcenter 10.1.5 and Teamcenter 11.2.1. Pick Next to continue.


8-77





8-78



Create the ICatiaUserExit API Implementation




8-79


6. Untoggle public static void main(String[] args) and toggle the Inherited abstract methods option on. Pick the Add button next to the Interfaces: field.

7. Enter ICatiaUserExit in the Choose interfaces: field, select ICatiaUserExit from the Matching Items box, then pick OK.


8-80


8. Pick Finish.

8-81


As a result ICatiaUserExit is automatically written as:

<code> public class CatiaUserExitImpl implements ICatiaUserExit { @Override public void userExitAfterAllExportedFiles(Vector<String> arg0) throws IOException { // TODO Auto-generated method stub } @Override public int userExitAfterAllExportedFiles(Connection arg0, Vector<String> arg1, Vector<String> arg2, Vector<String> arg3, Vector<String> arg4) { // TODO Auto-generated method stub return 0; } @Override public int userExitAfterAllImportedFiles(Connection arg0, Vector<String> arg1, Vector<String> arg2,

8-82


Vector<String> arg3, Vector<String> arg4) { // TODO Auto-generated method stub return 0; } @Override public void userExitAtEndOfLoadProcesses() throws IOException { // TODO Auto-generated method stub } @Override public void userExitModifyDesc(String arg0) { // TODO Auto-generated method stub } } </code>

9. Modify the userExitAfterAllImportedFiles and userExitModifyDesc functions.

<code> @Override public int userExitAfterAllImportedFiles(Connection i_connection, Vector<String> i_file_name_list, Vector<String> i_item_id_list, Vector<String> i_item_rev_list, Vector<String> i_dataset_uid_list) { for (String str : i_file_name_list) { System.out.println("i_file_name_list->" + str); } for (String str : i_item_id_list) { System.out.println("i_item_id_list->" + str); } for (String str : i_item_rev_list) { System.out.println("i_item_rev_list->" + str); } return 0; } @Override public void userExitModifyDesc(String arg0) { System.out.println("userExitModifyDesc arg=" + arg0); } </code>


8-83


Generate a Library



8-84





8-85


Result: The user library is created and automatically loads during RACLess processes. It is not necessary to update the classpath.

Define additional user entry point implementations

13. Edit the tcic_extensions.xml file within the %TCICV5_DIR%\racless directory to define additional user entry point implementations.

8-86


Each implementation is referenced under a specific <entry> tag; id corresponds to the interface that has been implemented, handler corresponds to the implementation definition (its package and class) and filename corresponds the name of the user library.

<?xml version="1.0" encoding="UTF-8"?> <extensions> <entry id="com.ebsolutions.soacore.extensions.ICatiaUserExit" filename="CatiaUserExitImpl.jar" handler="com.CatiaUserExitImpl"> </entry> </extensions>

Several <entry> tags for the same interface may be defined, but the implementations must be different. For example,

<?xml version="1.0" encoding="UTF-8"?> <extensions> <entry id="com.ebsolutions.soacore.extensions.ICatiaUserExit" filename="CatiaUserExitImpl.jar" handler="com.CatiaUserExitImpl"> </entry> <entry id="com.ebsolutions.soacore.extensions.ICatiaUserExit" filename="sample2.jar" handler="mysample.MyImpl2"> </entry> <entry id="com.ebsolutions.soacore.process.ICommandEvent" filename="CommandEventImpl.jar" handler="com.CommandEventImpl"> </entry> </extensions>

8-87


Each implementation is called by the RACLess processes which call this interface.

Refer to the Import RACLess section for more details related to specific implementations.

In the next example, traces are written to the tcic_racless_out_<timestamp>.log file under the %TEMP% directory. Traces related to userExitModifyDesc calls are shown in red and traces related to userExitAfterAllImportedFiles calls are shown in blue after files are imported.

[…] TcICSOAServices.getTabStr(result_file) userExitModifyDesc arg=SAVE1 send response [SEMAPH] Command sent [SaveFilesCommand] Command dispatched [SaveFilesCommand] callRACLessCommand com.ebsolutions.soacore.process.SaveFilesCommand ICommandEvent : Interface not implemented TcICSOAServices.getTabStr(result_file) TcICSOAServices.getTabStr(import_log_file) i_file_name_list->F:\catiman_tmp\catuii\050372_A.CATProduct i_item_id_list->050372 i_item_rev_list->A userExitModifyDesc arg=SAVE2 send response [SEMAPH] […]

ICommandEvent

Some events are generated during RACLess processes.

• OnStart(): generates at the beginning of RACLess processes.

• OnError(): generates if an error occurred during the process.

• OnDone():generates at the end of RACLess processes, if no error occurred.

These events are defined within the ICommandEvent interface; pre/post actions may be defined for each RACLess processes.


8-88



8-89


Information passed through several events are managed in the OnDoneEventArgs, OnErrorEventArgs and OnStartEventArgs classes.

Configuration, error and/or warning messages are available for each event. The sample below shows an onError event:

@Override public void onError(OnErrorEventArgs arg0) { ProcessConfiguration config = arg0.get_process_configuration(); String[] messages = config.get_message_manager().get_messages(); for (String str: messages) { System.out.println(str); } }


8-90


Implementation Example


2. Enter the Project name then select the compatible JRE version: Java 1.7 for Teamcenter 10.1.5 and Teamcenter 11.3.0 and higher. Pick Next to continue.


8-91






8-92


Result:

Create the ICommandEvent Interface



6. Untoggle public static void main(String[] args) and toggle Inherited abstract methods option. Pick the Add button next to the Interfaces: field.


8-93


7. Enter ICommandEvent in the Choose interfaces: field, select the matching item, then pick Add. Pick OK when finished.


8-94


8-95


8. Pick Finish.

Result:

<code> public class CommandEventImpl implements ICommandEvent { @Override public void onDone(OnDoneEventArgs arg0) { // TODO Auto-generated method stub } @Override public void onError(OnErrorEventArgs arg0) { // TODO Auto-generated method stub } @Override public void onStart(OnStartEventArgs arg0) { // TODO Auto-generated method stub } } </code>

9. Modify the onDone and onStart functions:

8-96


<code> @Override public void onDone(OnDoneEventArgs arg0) { System.out.println("CommandEventImpl::process is finished"); } @Override public void onStart(OnStartEventArgs arg0) { System.out.println("CommandEventImpl::process is started"); } </code>

Generate a Library


8-97





8-98


Result: The user library is created and automatically loads during RACLess processes.

Indicate which interface has been implemented

13. Edit the tcic_extnsions.xml file within the %TCICV5_DIR%\racless directory to indicate which interface has been implemented.

8-99


Each implementation is referenced under a specific <entry> tag; id corresponds to the interface that has been implemented, handler corresponds to the implementation definition (its package and class) and filename corresponds the name of the user library.

<?xml version="1.0" encoding="UTF-8"?> <extensions> <entry id="com.ebsolutions.soacore.process.ICommandEvent" filename="CommandEventImpl.jar" handler="com.CommandEventImpl"> </entry> </extensions>

Several <entry> tags for the same interface may be defined, but the implementations must be different. Each implementation is called by the related process. For example,

<?xml version="1.0" encoding="UTF-8"?> <extensions> <entry id="com.ebsolutions.soacore.extensions.ICatiaUserExit" filename="CatiaUserExitImpl.jar" handler="com.CatiaUserExitImpl"> </entry> <entry id="com.ebsolutions.soacore.process.ICommandEvent" filename="sample3.jar" handler="mysample.MyImpl3"> </entry> <entry id="com.ebsolutions.soacore.process.ICommandEvent" filename="CommandEventImpl.jar" handler="com.CommandEventImpl"> </entry> </extensions>

8-100


Each implementation is called by the related process. Refer to the Import RACLess section for more details related to specific implementations.

In this sample, traces are written to the tcic_racless_out_<timestamp>.log file under the %TEMP% directory. Traces related to onStart calls are shown in red and traces related to onDone calls are shown in blue after files are imported.

[…] Command sent [SaveFilesCommand] Command dispatched [SaveFilesCommand] callRACLessCommand com.ebsolutions.soacore.process.SaveFilesCommand CommandEventImpl::process is started TcICSOAServices.getTabStr(result_file) TcICSOAServices.getTabStr(import_log_file) CommandEventImpl::process is finished send response [SEMAPH] […]

Examples of RACLess Customizations

Refer to the following table for a few examples of RACLess processes which can be customized. A complete list can be found here.

Process Available Customization

Add CATShape ICommandEvent: onStart, onError, onDone


8-101



Check In/Check Out from CATIA ICommandEvent: onStart, onError, onDone

Check- in/Check-out menu in Teamcenter

From the CATIAV5 Teamcenter menu:

• ICommandEvent: onStart, onError, onDone

From a sample and tcic_selection.xml:

• ICommandEvent: onStart, onError, onDone

• Inheritance: DoCheckAction.java

• preProcessTasks

• postProcessTasks

• coreProcess


8-102



RACLess Import

Use the UserImportCommand.java API provided

• CommandEvent: onStart, onError, onDone

From a sample:

• Inheritance: RACLessProcessAbstract.java

• preProcessTasks


• coreProcess

RACLess Export

Use the given UserExportCommand.java API From a sample:


• preProcessTasks


• coreProcess


8-103



RACLess Load, Update, Save

Use the given API UserLUSCommand.java ICommandEvent: onStart, onError, onDone From a sample:


• preProcessTasks


• coreProcess

Synchronize Active Shapes ICommandEvent: onStart, onError, onDone

Other commands launched from CATIA ICommandEvent: onStart, onError, onDone

Check in/Check Out Customization

RACLess ProcessAbstract Implementation Use a Java Project to Compile and Install the Sample

RACLessProcessAbstract Implementation

This class inherits from RACLessProcessAbstract class:

• preProcessTasks() method is empty, by default

• postProcessTasks() method displays a message

• initProcessConfiguration() method defines configuration through the UserExportCommand.getDefaultProcessConfiguration() API


8-104


• coreProcess() method:

• reads the tcic_selection.xml file

• launches DoCheckInAction or DoCheckOutAction on the BOM Lines (calls DoCheckAction command with check mode = CI if mode is set to “CI”, calls DoCheckAction command with check mode = CO if mode is set to “CO”)

Code sample

package com; import javax.swing.JOptionPane; import com.ebsolutions.soacore.process.DoCheckAction; import com.ebsolutions.soacore.process.ProcessConfiguration; import com.ebsolutions.soacore.process.RACLessProcessAbstract; public class CustoCICO extends RACLessProcessAbstract { @Override protected int coreProcess() { try { String CI_ACTION = "mode=CI"; String CO_ACTION = "mode=CO"; DoCheckAction action = new DoCheckAction(); //execute a Check-In Action (DoCheckInAction command is launched), if "mode=CI" //execute a Check-Out Action (DoCheckInAction command is launched), if "mode=CO" action.executeProcess(new String[]{CI_ACTION}); } catch (Exception e) { e.printStackTrace(); } return 0; } @Override protected int initProcessConfiguration() { //Get the default configuration for a silent process _process_configuration = ProcessConfiguration.getDefaultSilentProcessConfiguration(); _process_configuration.initLogFile("RACLessProcessSample.log", true); return 0; } @Override protected int postProcessTasks() { JOptionPane.showMessageDialog(null, "CustoCICO is complete"); return 0; }


8-105


@Override protected int preProcessTasks() { // TODO Auto-generated method stub return 0; } }

Compilation and Installation of the Sample

Perform the following steps to compile and install the sample.

Refer to the notes below before proceeding.

1. Update the following variables in the batch file (compile.bat), if necessary:

a. TC_ROOT

b. FMS_HOME

c. JAVA_HOME

d. TCICV5_DIR

2. Modify the name of the class, if necessary.

3. Modify the name of the jar, if necessary.

4. The compiled .jar file is now available in the current directory.

Install the .jar file

The .jar file can be installed under %TCICV5_DIR%\racless\extensions directory. In this case, the jar is automatically added to the TcIC classpath.

The .jar file can also be installed under another directory. In this case, add the new directory to the TcIC class path.

5. For example, the Cat2SampleSilentExport.jar file is compiled under the F:\Temp directory. Modify the %TCICV5_DIR%\racless\StartRaclessServer.bat file as follows:

a. Add the .jar file to the classpath RACLESS_CLASSPATH set RACLESS_JAVA_CLASSPATH=%RACLESS_CLASSPATH%;%FMS_HOME%\jar\fmsclientcache.jar set RACLESS_JAVA_CLASSPATH=%RACLESS_JAVA_CLASSPATH%;%FMS_HOME%\jar\fscjavaclientproxy.jar set RACLESS_JAVA_CLASSPATH=%RACLESS_JAVA_CLASSPATH%;%FMS_HOME%\jar\fccjavaclientproxy.jar set


8-106


RACLESS_JAVA_CLASSPATH=%RACLESS_JAVA_CLASSPATH%;%FMS_HOME%\jar\fmsutil.jar

Execution

6. Update the following variables in the runCICOCommand.bat file.

a. USER

b. PASSWORD

c. HOST

d. TCICV5_DIR

Notes

When the USER, PASSWORD and HOST variables are set with an empty value, the login RACLess panel displays. These variables should not contain the " character. For example,

set USER=pbu set PASSWORD= set HOST= iiop:localhost:1572/TcServer1


8-107


If the class does not correspond to the com.CustoCICO class, then modify the following line with the correct class name:

"%TCICV5_DIR%\bin\WIN32\socketV5.exe" com.CustoCICO 0 11400

When the socket port has been changed, modify the following line:

"%TCICV5_DIR%\bin\WIN32\socketV5.exe" com.CustoCICO 0 11400

And modify the %TCICV5_DIR%\env\tcic_var_env.xml file:


The tcic_selection.xml file can now be created and runCustcoCICO.bat can be launched.

Use a Java Project to Compile and Install the Sample


2. Enter the Project name then select the compatible JRE version: Java 1.7 with Teamcenter 10.1.5 and Teamcenter 11.3.0 and higher. Pick Next to continue.


8-108






8-109


Result:

Overload the executeProcess function



8-110






8-111


10. Enter RACLessProcessAbstract in the Choose a type: field. Select RACLessProcessAbstract from the resulting Matching items box, then pick OK.

11. Pick Finish.


8-112


Implement functions as follows:

public class CustoCICO extends RACLessProcessAbstract { @Override protected int coreProcess() { try { String CI_ACTION = "mode=CI"; String CO_ACTION = "mode=CO"; DoCheckAction action = new DoCheckAction(); //execute a Check-In Action ("mode=CI") regarding the tcic_selection.xml content //for a Check-Out Action, set the String value to "mode=CO" action.executeProcess(new String[]{CI_ACTION}); } catch (Exception e) { e.printStackTrace(); } return 0; } @Override protected int initProcessConfiguration() { //Get the default configuration for a silent process _process_configuration = ProcessConfiguration.getDefaultSilentProcessConfiguration() _process_configuration.initLogFile("RACLessProcessSample.log", true); return 0; } @Override protected int postProcessTasks() { JOptionPane.showMessageDialog(null, "CustoCICO is complete"); return 0; } @Override protected int preProcessTasks() { // TODO Auto-generated method stub return 0; } }


8-113






8-114






2. Launch following instruction in a command line: %TCICV5_DIR%\bin\WIN32\SocketV5.exe com.CustoCICO 0 11400. The following message displays:


8-115


Save Manager and State Details Customization

Use these steps to implement pre/post actions on buttons in the Save Manager and State Details panel.

1. Pick File >> Java Project to create a new Java project.

2. Enter the project name and verify the correct Java version In the Java Project dialog. For example, Java 1.7 for Teamcenter 10.1.5 and Teamcenter 11.3.0 and higher. Pick Next to continue.





8-116


Result in Eclipse:

4. Create a package named com.custo, then add a class called AppCusto.java. Set the Superclass to SaveManagerApplication.


8-117



8-118


5. Generate a Library


7. Toggle the Java folder open, select the JAR file, then pick Next.


8-119



9. Open the TcIC_DIR\env\Savemanager.xml file and change the Save Manager application as shown below.


8-120


10. Test the customization.

a. Start CATIA and Teamcenter.

b. In CATIA, create A1(P1), then Save.

c. In the Save Manager, assign IDs, then pick the Save button. The new message displays.

Test the Extension

Perform the following steps to test the Save Manager buttons.

1. In CATIA, create a CATPart and Save.

2. In the Save Manager panel:

a. Select the line corresponding to the CATPart then pick Assign.

b. Pick Create JT.

c. Pick Reset IDs.

d. Pick Assign.

e. Apply and Finish the save.

3. View the tcic_racless_out_*.log log file to ensure the implementation is called for each clicked button.

........ EntryPointForButtonSD.userEntryPreButtonAction() For SaveManager START assign process ....... EntryPointForButtonSD.userEntryPreButtonAction() For SaveManager ....... EntryPointForButtonSD.userEntryPostButtonAction() for SaveManager End assign process EntryPointForButtonSD.userEntryPreButtonAction() For SaveManager START create_jt_flag process EntryPointForButtonSD.userEntryPostButtonAction() for SaveManager


8-121


End create_jt_flag process EntryPointForButtonSD.userEntryPreButtonAction() For SaveManager START reset process ....... EntryPointForButtonSD.userEntryPostButtonAction() for SaveManager End reset process EntryPointForButtonSD.userEntryPreButtonAction() For SaveManager START assign process ....... EntryPointForButtonSD.userEntryPostButtonAction() for SaveManager End assign process ....... EntryPointForButtonSD.userEntryPreButtonAction() For SaveManager START application_okAction process EntryPointForButtonSD.userEntryPostButtonAction() for SaveManager End application_okAction process .......

Perform the following tests to test the State Details Panel button.

1. In CATIA, launch the Detailed States process on the CATPart created earlier for the Save Manager button test.

2. In the State Detail Panel, pick Update, then pick Check-in.

3. View the tcic_racless_out_*.log log file to ensure the implementation is called for each clicked button.

........ EntryPointForButtonSD.userEntryPreButtonAction() For StateDetailsApplication START update process ........ EntryPointForButtonSD.userEntryPostButtonAction() For StateDetailsApplication END update process ........ EntryPointForButtonSD.userEntryPreButtonAction() For StateDetailsApplication START check_in process ........ EntryPointForButtonSD.userEntryPostButtonAction() For StateDetailsApplication END check_in process


8-122


Silent Import

UserImportCommand API SampleSilentImport Sample

The Import RACLess process is based on the Data.txt file to launch Import Spreadsheet creation and Import.

The Import RACLess pocess can also be based on parameters given through a command line, then connection information and documents to be imported can be set through parameters.

There are two different methods to launch import RACLess.

1. SampleImportCommandLineWin.bat: Does not permit customized pre/post actions and processes cannot be locked while the Create Import Spreadsheet and Import processes run.

2. runSilentImportCommand.bat. Permits customized pre/post actions and processes can be locked while the Create Import Spreadsheet and Import processes run.

Both ICommandEvent and ICatiaUserExit interfaces can be used in either methods.

Available using the batch method

Available using the RACLess method

ICommandEvent yes yes

ICatiaUserExit yes yes

preProcessTasks no yes

postProcessTasks no yes

Lock/Unlock process partial yes


8-123


Method 1: Launch two CATScript processes

Refer to the %TCICV5_DIR%\custom_client\SilentImport\SampleImportCommandLineWin.bat file to proceed.

Ensure that this method is not so robust in the lock / unlock process management to cause the process to be locked between the spreadsheet creation and import, as it is when creating your own process.

This method does not permit implementing pre/post actions, such as the preProcessTasks and postProcessTasks methods of the RACLessProcessAbstract class.

SampleImportCommandLineWin.bat launches following steps:

• StartRACLessServer.bat file in a silent or non-silent mode to launch the RACLess connection. By default, the .bat file is launched in silent mode.

• CreateAllSpreadSheets.CATScript macro in batch mode.

• ImportAllAssemblies.CATScript in batch mode.

• CloseRACLessServer to close the RACLess connection.

Modify the following lines in the .bat file to customize the sample file.

Start "RACLess Server" /min cmd /c "%TCICV5_DIR%\racless\StartRaclessServer.bat –silent %*" "C:\Program Files\Dassault Systemes\B19\intel_a\code\bin\catstart.exe" -run CNEXT -env CATIA_V5R19_CAA -direnv "C:\Program Files\Dassault Systemes\CATEnv" -object "-batch %WORK_DIR%\Import\%1 -macro %TCICV5_DIR%\CATScript\CreateAllSpreadSheets.CATScript" "C:\Program Files\Dassault Systemes\B19\intel_a\code\bin\catstart.exe" -run CNEXT -env CATIA_V5R19_CAA -direnv "C:\Program Files\Dassault Systemes\CATEnv" -object "-batch %WORK_DIR%\Import\%1 -macro %TCICV5_DIR%\CATScript\ImportAllAssemblies.CATScript" "%TCICV5_DIR%\bin\WIN32\socketV5.exe" CloseRaclessServer 0 11400

• Run SampleImportCommandLineWin.bat without any parameters so that it's based on the Data.txt file and the top level document defined in the Data.txt file is imported.

8-124


• Do not use the Data.txt file to customize the Import process. Instead, run SampleImportCommandLineWin.bat with the following optional arguments.

• -u=<user-id> -p=<password> -g=<group> -r=<role> -h=<host> -nl=<language> -proj=<project_id> -client=<client_name> If –u or –p parameter is not set, the RACLess login panel displays; an empty value with -p parameter: "-p =", is considered a blank password and the RACLess login panel does not display.

In the example below, Product1.CATProduct is defined in Data.txt file, the import process is performed on the TopLevelAssembly.CATProduct passing through SampleImportCommandLineWin.bat defined as %1 parameter.

SampleImportCommandLineWin.bat TopLevelAssembly.CATProduct -u=mylogin -p=mypassword -g=dba -r=DBA -h=http://tcserver:7020/tc/ -client=my_client_name

Note: Remove the "–silent” option from the StartRaclessServer.bat file in the SampleImportCommandLineWin.bat file to execute Import process in non-silent mode.

Method 2: Create a RACLess process that inherits from the RACLessProcessAbstract class

Refer to %TCICV5_DIR%\custom_client\SilentImport\SampleRACLessImport\SampleSilentImport.java class to proceed.

UserImportCommand API


8-125


Do not use default ProcessConfiguration configuration, use the API delivered in the UserImportCommand class.

SampleSilentImport Sample


• preProcessTasks() and postProcessTasks() methods are empty, by default

• initProcessConfiguration() method defines configuration through the UserExportCommand.getDefaultProcessConfiguration() API


• locks the process when possible

• launches:

• createSpreadsheet: CATScript_batch\CreateAllSpreadSheets.CATScript

• import: CATScript_batch\ImportAllAssemblies.CATScript

• unlocks the process


SampleSilentImport is already compiled in %TCICV5_DIR%\ so that it can be used immediately. However, the following steps must be performed to recompile and install the sample if it is necessary to customize it.

1. Locate the sample in %TCICV5_DIR%\custom_client\silent_import\SampleRaclessImport.

8-126


2. Update the following variables in the batch file (compile.bat):

a. TC_ROOT

b. FMS_HOME

c. TCICV5_DIR



5. Launch compile.bat. The compiled .jar file is now available in the current directory.

6. Modify the class path in runSilentImportCommand.bat file to set RACLESS_CLASSPATH="%CD%\Cat2SampleSilentImport.jar"

Execution

7. Set the CATIA_silenced_import = true for silent mode.

8. Run %TCICV5_DIR%\custom_client\SilentImport\SampleRaclessImport\ runSilentImportCommand.bat with the following optional arguments.

a. -u=<user-id> -p=<password> -g=<group> -r=<role> -h=<host> -nl=<language> -proj=<project_id> -client=<client_name> If –u or –p parameter is not set, the RACLess login panel displays; using an empty value with -p parameter: "-p =", is considered as a blank password and the RACLess login panel does not display.

For example: runSilentImportCommand.bat -u=mylogin -p=mypassword -g=dba -r=DBA -h=http://tcserver:7020/tc/ -client=my_client_name


8-127


If the class does not correspond to the com.user.SampleSilentImport class, then modify the following line with the correct class name:

"%TCICV5_DIR%\bin\WIN32\socketV5.exe" com.user.SampleSilentImport 0 11400


"%TCICV5_DIR%\bin\WIN32\socketV5.exe" com.user.SampleSilentImport 0 11400

and modify the %TCICV5_DIR%\env\tcic_var_env.xml file:


The runSilentImportCommand.bat can be launched.

8-128


Silent Export

UserExportCommand API SampleSilentExport Sample

The Silent Export sample uses the tcic_selection.xml file to define the list of documents which can be exported.

Only two contexts are permitted within the tcic_selection.xml file for the export RACLess process; the BOM context, used for exporting an assembly and is equivalent to exporting from the BOM Window (with a specific configuration) and the CATDrawing context, used for exporting a CATDrawing and is equivalent to exporting a selected CATDrawing from My Navigator.

BOM example with configuration usage:

<?xml version="1.0" encoding="UTF-8"?> <selection> <component type="bomwindow"> <item item_id=”A1_item_id” object_type=”A1_object_type” /> <revision item_revision_id=”A1_item_revision_id” /> <configuration> <revrule name="Working; Any Status" /> </configuration> <bomline path=”A2_occ_uid/A3_occ_uid” /> </component> <component type="bomwindow"> <item item_id=”A10_item_id” object_type=”A10_object_type” /> <revision item_revision_id=”A10_item_revision_id” /> <configuration> <optionset name="color_blue"/> </configuration> </component> <component type="bomwindow"> <item item_id=”A100_item_id” object_type=”A100_object_type” /> <revision item_revision_id=”A100_item_revision_id” /> <bomline path=”A200_occ_uid/P100_occ_uid” /> <bomline path=”A200_occ_uid/A300_occ_uid/P200_occ_uid” /> </component> </selection>

CATDrawing Example:

<?xml version="1.0" encoding="UTF-8"?> <selection> <component uid=”existing_catdrawing_dataset_uid” /> <component uid=”existing_catdrawing_dataset_uid” /> </selection>

The samples for the export RACLess process are located under the %TCICV5_DIR%\custom_client\silent_export\Windows\SampleRACless directory.


8-129


There are two different methods to launch Export RACLess:

1. SampleExportCommandLineWin.bat: Does not permit customized pre/post actions and processes cannot be locked between the DoCreateExportSpreadsheetSilentAction and DoExportSilentAction commands.

2. runSilentExportCommand.bat: Permits customized pre/post actions and processes can be locked while the Create Export Spreadsheet and Export processes run.

The Create Export Spreadsheet and Export processes are launched in the same server sessions. Multiple export is possible through the tcic_selection.xml file. Configurations used during Export processes is defined in the tcic_selection.xml file.

SampleExportCommandLineWin.bat launches following steps:


• DoCreateExportSpreadsheetSilentAction command.

• DoExportSilentAction command.



8-130


UserExportCommand API

Do not use default ProcessConfiguration configuration, use the API delivered in the UserExportCommand class.

Use the createSpreadsheet and export functions for the export RACLess process.

The getNumberOfProcess function is used to parse the tcic_selection.xml file and to determine the number of documents to export.

SampleSilentExport Sample


8-131




• initProcessConfiguration() method defines configuration through the UserExportCommand.getDefaultProcessConfiguration() API and sets the silent or non-silent mode.



• reads the tcic_selection.xml file

• loops on each valid document defined in the query.xml file and calls for each document: createSpreadsheet and export

• unlocks the process



1. Locate the sample in %TCICV5_DIR%\custom_client\silent_export\Windows\SampleRacless.


a. TC_ROOT

b. FMS_HOME

c. JAVA_HOME

d. TCICV5_DIR






The .jar file can also be installed under another directory. Add the new directory to the TcIC class path.

8-132


6. For example, the Cat2SampleSilentExport.jar file is compiled under the F:\Temp directory. Modify the %TCICV5_DIR%\racless\StartRaclessServer.bat file as follows:

a. Add the .jar file to the classpath RACLESS_CLASSPATH set RACLESS_CLASSPATH=%RACLESS_CLASSPATH%;%FMS_HOME%\jar\fscjavaclientproxy.jar set RACLESS_CLASSPATH=%RACLESS_CLASSPATH%;%FMS_HOME%\jar\fccjavaclientproxy.jar set RACLESS_CLASSPATH=%RACLESS_CLASSPATH%;%FMS_HOME%\jar\fmsutil.jar set RACLESS_CLASSPATH=%RACLESS_CLASSPATH%;F:\Temp\Cat2SampleSilentExport.jar FOR /R "%RACLESS_DIR%" %%a in (*.jar) DO CALL :AddToPath "%%a"

Execution

7. Run %TCICV5_DIR%\ custom_client\silent_export\Windows\SampleRACLess\runSilentExportCommand.bat with the following optional arguments:

a. -u=<user-id> -p=<password> -g=<group> -r=<role> -h=<host> -nl=<language> -proj=<project_id> -client=<client_name> If –u or –p parameter is not set, the RACLess login panel displays; an empty value with -p parameter: "-p =", is considered a blank password and the RACLess login panel does not display.

For example, runSilentExportCommand.bat -u=mylogin -p=mypassword -g=dba -r=DBA -h=http://tcserver:7020/tc/ -client=my_client_name


8-133


If the class does not correspond to the com.user.SampleSilentExport class, then modify the following line with the correct class name:

"%TCICV5_DIR%\bin\WIN32\socketV5.exe" com.user.SampleSilentExport 0 11400


"%TCICV5_DIR%\bin\WIN32\socketV5.exe" com.user.SampleSilentExport 0 11400

And modify the %TCICV5_DIR%\env\tcic_var_env.xml file:


The tcic_selection.xml file can now be created and runSilentExportCommand.bat can be launched.


8-134


Silent Load, Update, Save

UserLUSCommand API SampleSilentLUS Sample

The Silent Load, Update, Save (LUS) sample uses the tcic_selection.xml file to define the list of documents which can be loaded and saved.

All contexts are permitted in the tcic_selection.xml file for the LUS RACLess processes.

The Load, Update, Save process on multiple BOM windows is possible through the tcic_selection.xml file.

The samples for LUS RACLess processes are located under custom_client\Silent_lus\Windows\SampleRacless.

There are two different methods to launch LUS RACLess:

1. SampleLUSCommandLineWin.bat: Does not permit customized pre/post actions or launching the DoLUSSilentAction command.

2. runSilentLUSCommand.bat: Permits customized pre/post actions and processes can be locked while the LUS process runs.

SampleLUSCommandLineWin.bat launches following steps:


• DoLUSSilentAction command



8-135


UserLUSCommand API

Do not use default ProcessConfiguration configuration, use the API delivered in the UserLUSCommand class.

The executeLUS function manages all documents defined in the tcic_selection.xml file or all documents set in ModelObject Vector by set_documents function.

SampleSilentLUS Sample




8-136


• initProcessConfiguration() method defines configuration through the UserLUSMCommand.getDefaultProcessConfiguration() API and sets the silent or non-silent mode.



• instantiates the UserLUSCommand with the query.xml file date

• launches LUS

• unlocks the process.



1. Locate the sample in %TCICV5_DIR%\custom_client\Silent_lus\Windows\SampleRacless.


a. TC_ROOT

b. FMS_HOME

c. JAVA_HOME

d. TCICV5_DIR






The .jar file can also be installed under another directory. In this case, add this new directory to the TcIC class path.

6. For example, the Cat2SampleSilentLUS.jar file is compiled under the F:\Temp directory. Modify the %TCICV5_DIR%\racless\StartRaclessServer.bat file as follows:

a. Add the .jar file to the classpath RACLESS_CLASSPATH set RACLESS_CLASSPATH=%RACLESS_CLASSPATH%;%FMS_HOME%\jar\fscjavacli

8-137


entproxy.jar set RACLESS_CLASSPATH=%RACLESS_CLASSPATH%;%FMS_HOME%\jar\fccjavaclientproxy.jar set RACLESS_CLASSPATH=%RACLESS_CLASSPATH%;%FMS_HOME%\jar\fmsutil.jar set RACLESS_CLASSPATH=%RACLESS_CLASSPATH%;F:\Temp\Cat2SampleSilentLUS.jar FOR /R "%RACLESS_DIR%" %%a in (*.jar) DO CALL :AddToPath "%%a"

Execution

7. Run %TCICV5_DIR%\ custom_client\silent_lus\Windows\SampleRACLess\runSilentLUSCommand.bat with the following optional arguments:

a. -u=<user-id> -p=<password> -g=<group> -r=<role> -h=<host> -nl=<language> -proj=<project_id> -client=<client_name> If –u or –p parameter is not set, the RACLess login panel displays; an empty value with -p parameter: "-p =", is considered a blank password and the RACLess login panel does not display.

For example: runSilentLUSCommand.bat -u=mylogin -p=mypassword -g=dba -r=DBA -h=http://tcserver:7020/tc/ -client=my_client_name


8-138


If the class does not correspond to the com.user.SampleSilentLUS class, then modify the following line with the correct class name:

"%TCICV5_DIR%\bin\WIN32\socketV5.exe" com.user.SampleSilentLUS 0 11400


"%TCICV5_DIR%\bin\WIN32\socketV5.exe" com.user.SampleSilentLUS 0 11400

and modify the %TCICV5_DIR%\env\tcic_var_env.xml file:


The tcic_selections.xml file can now be created and runSilentLUSCommand.bat can be launched.

RACLess API JAVA Documentation

Refer to the online documentation for access to these files.

RACLess Command Line Entry Points

The Integration provides the ability to run some of the RACLess processes used within the Teamcenter Integration for CATIA V5 directly under a command line.

This chapter contains methods to call the RACLess processes used within the Teamcenter Integration for CATIA V5.

Important Information Related to RACLess and Command Lines

The DoLoginRACLessAction command provides the ability to connect to the RACLess application with an external customized client application, such as Custom Loader, instead of the portal client.

An external client application or Custom Loader must be defined in the client_env file using Client_1 in the Category line to indicate the client is a Custom Loader.

1. Launch StartRACLessServer.bat using the appropriate parameter to set the client parameters.

2. Launch DoLoginRACLessAction in a command line using the appropriate credentials to establish the client connection when the first command is launched.


8-139


Parameter credentials are set through the DoLoginRACLessAction command when the first command launches.

For all processes, ensure the tcic_selection.xml file exists before launching the command, except DoLoginRACLessAction and DoUserSettingsAction. The 11400 value corresponds to the value of the socket port defined for the TcIC_socket_port variable in the tcic_var_env.xml file, except DoLoginRACLessAction.

The socketV5.exe parameter controls the synchronous vs. asynchronous operations of TcIC commands, i.e., CATIA may be locked until the command finishes (value is 0) or remain unlocked (value is 1), depending on the particular command launched from a cmd line.

The best practice is to lock the session, indicated with the value 0 (default). CATIA should remain unlocked (1) when using AW as a client.


Browse Multi-model Links

View multi-model links of a document and its related attributes in Teamcenter. This command uses a tcic_selection.xml file containing a defined BOM window, item revision, dataset or form information. "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoBMMLAction 0 11400

Check In/Check Out menu in Teamcenter

This command uses a tcic_selection.xml file containing a defined BOM window, item revision, dataset, ProductContextInfo or bookmark. Check In: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoCheckInAction 0 11400 Check Out: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoCheckOutAction 0 11400

8-140



Connection to RACLess Application

External client: Share the custom loader credentials to the RACLess application using the command line: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoLoginRACLessAction 0 11400 –client=Loader –u=user_id –h=host List of parameters:

-client=<client_name> (required) -u=<user_id> (optional) -p=<password> (optional) -g=<group> (optional) -r=<role> (optional) -h=<host> (optional) -nl=<lang> ( optional) -u=<user_id> (optional) -proj=<project_id> (optional)

Create CATPart dataset for selection

This command uses a tcic_selection.xml file containing a defined BOM window, item revision, ProductContextInfo or bookmark. Create a CATPart dataset within a command line: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoCreateCATPartDatasetAction 0 11400

Create CATProduct dataset for selection

This command uses a tcic_selection.xml file containing a defined BOM window, item revision, ProductContextInfo or bookmark. Create a CATProduct dataset within a command line: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoCreateCATProductDatasetAction 0 11400

Create Export Spreadsheet

This command uses a tcic_selection.xml file containing a defined BOM window, item revision, dataset, ProductContextInfo or bookmark. Create Export Spreadsheet within a command line: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoCreateExportSpreadsheetAction 0 11400

Export

This command uses a tcic_selection.xml file containing a defined BOM window, item revision, dataset, ProductContextInfo or bookmark. Export a document from Teamcenter in CATIA within a command line:


8-141



"%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoExportAction 0 11400

Export as reference

This command uses a tcic_selection.xml file containing a defined BOM window, item revision, dataset, ProductContextInfo or bookmark. Export a document from Teamcenter in CATIA within a command line for reference: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoExportAsReferenceAction 0 11400

Highlight in CATIA

This command uses a tcic_selection.xml file containing a defined BOM window, ProductContextInfo or bookmark. "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoHighlightInCatiaAction 0 11400

Load

This command uses a tcic_selection.xml file containing a defined BOM window, item revision, dataset, ProductContextInfo or bookmark. Load a document from Teamcenter in CATIA within a command line: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoLoadAction 0 11400

Load as reference

This command uses a tcic_selection.xml file containing a defined BOM window, item revision, dataset, ProductContextInfo or bookmark. Load a document from Teamcenter in CATIA within a command line for reference: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoLoadAsReferenceAction 0 11400

Load for Compare

This command uses a tcic_selection.xml file containing a defined BOM window, item revision, dataset, ProductContextInfo or bookmark. Load a document from Teamcenter in CATIA within a command line for comparison: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoLoadForCompareAction 0 11400

Load for Consulting

This command uses a tcic_selection.xml file containing a defined BOM window, item revision, dataset, ProductContextInfo or bookmark. Load a document from Teamcenter in CATIA within a command line for consulting : "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoLoadForConsultingAction 0 11400

8-142



Load Manager

Display the Load Manager panel to determine options and command to launch in the Open in CATIA command form Active Workspace: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoDisplayLoadManagerAction 0 11400

Load, Update, Save

Load Update Save a document from Teamcenter in CATIA within a command line: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoLUSAction 0 11400 Use the tcic_selection.xml file to locally overload the value of the CATIA_LoadUpdateSave_modified_file preference by adding: <preferences> <preference name="CATIA_LoadUpdateSave_modified_file_option"> <value>PARENTS</value> </preference> </preferences> In this case, the Load, Update, Save process is performed with the PARENTS value when the DoLUSAction is processing. When finished, the value returns to the one set in Teamcenter.

Teamcenter Loader

Display Teamcenter Loader Panel with the command line: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoDisplayLoaderAction 0 11400

Open dataset

This command uses a tcic_selection.xml file containing a defined dataset. Open a dataset document from Teamcenter in CATIA "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoOpenDatasetAction 0 11400

Open in CATIA from Active Workspace

These commands use a tcic_selection.xml file containing a defined BOM window, item revision, dataset, ProductContextInfo or bookmark. DoLoadAction (default) launches when launching Open in CATIA commands when Load Manager is not displayed. DoLoadFromLauncherAction command is taken into account the current CATIA command to determine which type of Load command should be launched from Active Workspace inside CATIA: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoLoadFromLauncherAction 0 11400 By default, DoLoadFromLauncherAction command is used if no specific

8-143



command is defined in TcICLauncher.bat. DoDefaultLoadFromLauncherAction command is taken into account the current CATIA command to determine which type of Load command should be launched with the following configuration CATIA_load_bom_traversal_option set to THROUGH, CATIA_load_as_cgr set to false, CATIA_activate_latestActiveShapes set to 1, CATIA_export_only_active_shapes set to 0 , from Active Workspace inside CATIA: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoDefaultLoadFromLauncherAction 0 11400 DoLoadWithOptionPanelAction command displays Load Manager panel when Open in CATIA is launched: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoLoadWithOptionPanelAction 0 11400

Save Assembly Configuration

This command uses a tcic_selection.xml file containing a defined BOM window, item revision information and configuration to use for BOM window creation, ProductContextInfo or bookmark. Save Assembly configuration file used for the Load as reference process in non-silent mode: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoSaveAssemblyConfigurationAction 0 11400 -dstuid=uid -dstid=id -dstrev=rev -dstname=name -dstdesc=desc -filename=name Save Assembly configuration file used for the Load as reference process in silent mode: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoSilentSaveAssemblyConfigurationAction 0 11400 -dstuid=uid -dstid=id -dstrev=rev -dstname=name -dstdesc=desc -filename=name List of parameters:

-dstuid=<uid >: Dataset uid (optional) -dstid=<id> : Dataset identifier (optional) -dstrev=<rev >: Dataset revision (optional) -dstname=<name> : Dataset name (optional) -dstdesc=<desc >: Dataset description (optional) -filename=<name >: File name (optional)

Silent Create Export Spreadsheet

Create Export Spreadsheet in silent mode within a command line: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoSilentCreateExportSpreadsheetAction 0 11400

8-144



Silent Export

Export a document in a Silent mode from Teamcenter in CATIA within a command line: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoSilentExportAction 0 11400

Silent Load, Update, Save

This command uses a tcic_selection.xml file containing a defined BOM window, item revision, dataset, ProductContextInfo or bookmark. Load Update Save a document in a Silent mode from Teamcenter in CATIA within a command line: "%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoSilentLUSAction 0 11400

User Settings

"%TCICV5_DIR%\bin\WIN32\socketV5.exe" DoUserSettingsAction 0 11400 -g=group -r=role -proj=project_id List of parameters: -g=<group> (optional) -r=<role> (optional) -proj=<project_id> (optional) The RACLess connection is not modified when parameters are not defined. The command is not available when Teamcenter RAC Client is running. If –proj=", then the session launches without the project’s configuration.

Integration Entry Points Save Manager

8-145


Save Manager

Overview

The Save Manager Developer Guide contains methods, class hierarchies and steps required to customize the Save Manager used within the Teamcenter Integration for CATIA V5. The Save Manager collects information needed during the Save process and displays when a CATIA user performs a Save operation on an assembly in Teamcenter, using the Integration Save macros.

Use the samples described in this document as the starting point for your specific customizations. The Save Manager interface has been designed with accessible graphic elements and CATIA datas for customization.

Contact [email protected] for further assistance with customizations, if necessary.

Save Manager Configuration File

Graphical Objects Description XML Tags: Definitions, Descriptions, Hierarchy

The savemanager.xml file is the entry point for every display object, as illustrated below. The .xml file defines elements within the Save Manager panel, such as application, modules, toolbars, display elements and actions associated to the display elements. The SAX parser retrieves the .xml file information.

The savemanager.xml file uses pre-defined schemas to display the Save Manager, and has two levels of customization:

1. High Level customization occurs when modifications to pre-defined options within the .xml file are performed. These pre-defined options are managed by the "out of the box" Integration. Refer to the Customizing the Save Manager for information on high level .xml customizations.

mailto:[email protected]?subject=Save%20Manager%20Developer%20Guide


8-146


2. Low Level customization uses Java components created by administrators to integrate it into the Save Manager or change the behavior of the components. A new code signature definition (class = new class) is added to the .xml file, and the Factories Mechanism instantiates the .xml class definitions.

8-147


Save Manager Configuration File: Graphical Objects Description

The Save Manager interface is composed of several customizable components, as illustrated below.

The Module area includes the display between the top and left toolbars, including the table and the table editor. Refer to the Create a New Module section to customize this area.

Save Manager Configuration File: XML Tags

Definitions Names and Descriptions Hierarchy

Definitions

Use the <TCICV5_DIR>/env/savemanager.xml file provided with the installation to control the appearance and behavior of the Save Manager. Refer to the illustration below for definitions of each xml display tag within the savemanager.xml file.

The default Save Manager includes only one module (the Save Module) but it can manage more than one module. If more than one module is defined in the xml file, a side bar on the left side of the Save Manager displays as many buttons as modules defined. Display the module by picking the button representing that module.


8-148



8-149


Names and Descriptions

Refer to the following chart for tag names and their description.

If an element has multiple definitions, ensure the name, nameRef, or identifier attributes of the new element are changed. If two elements have the same name, only one appears because the Integration considers it unique depending on its key.

Tag Name Possible Parents Tags Possible Children Tags Multiple Definitions

UIApplication No Parent : UIApplication is the root Tag SaveManagerToolBar,Module No

SaveManagerToolBar UIApplication DisplayElement Yes

Module UIAapplication ToolBar Yes

ToolBar Module DisplayElement Yes

DisplayElement SaveManagerToolBar,ToolBar No child Yes

Hierarchy

Each tag in the savemanager.xml file contains a specific hierarchy, as displayed below.

Modifying the tag hierarchy may cause required definitions to be bypassed, and prevent the Save Manager from being displayed.


8-150


Save Manager Entry Point

IEntryPointForButtonAction defines extension points that are called for pre- and post-actions associated to a button of the Save Manager or Spreadsheet panel.

This interface can have several implementations. Each implementation is automatically called when defined in the tcic_extensions.xml file.

Implement the userEntryPreButtonAction and userEntryPostButtonAction method to define your own behavior. Refer to the User Interface Implementation: Main Classes section for details on extension point implementations, if necessary.

Customization Examples

Extensions to be called are defined in the tcic_extensions.xml file.

8-151


<?xml version="1.0" encoding="UTF-8"?> <extensions> <entry id="com.ebsolutions.savemanager.extension.IEntryPointForButtonAction" filename="EntryPointsImplForSM.jar" handler="IEntryPointForButtonActionImpl1"> </entry> <entry id="com.ebsolutions.soacore.extensions.ICatiaUserExit" filename="EntryPointsImplForSM.jar" handler="CatiaUserExitTest1"> </entry> </extensions>

Implement IEntryPointForButtonActionImpl1 to define your own behavior. Traces display in the console when the user clicks on the buttons.

public class IEntryPointForButtonActionImpl1 implements IEntryPointForButtonAction { @Override public boolean userEntryPostButtonAction(String arg0,SaveManagerApplication arg1); { System.out.println("jtrace -->> userEntryPostButtonAction : arg0 = " + arg0 + " - arg1 = " + arg1); return true; } @Override public boolean userEntryPreButtonAction(String arg0,SaveManagerApplication arg1); { System.out.println("trace -->> userEntryPreButtonAction : arg0 = " + arg0 + " - arg1 = " + arg1); return true; } }


8-152


Save Manager Lifecycle

CATIAdatas Concrete Classes Implementation Data and Objects Accessors Interface Construction Managing XML Information Save Module Elements The Factories Mechanism The Listeners

The Save Manager lifecycle begins with the .xml file and ends with data manipulation. The "out of the box" Save Manager is delivered with a powerful, customizable xml engine to meet business needs, and has easy data access. Use Handlers and Interfaces to customize the Save Manager behavior and design.

CATIAdatas

Accessing CATIAdatas Accessing Selected Components The SaveManagerSession Class

Review the following sections to determine how the CATIA structure information is dispatched in the Save Manager.

Accessing CATIAdatas

The Save Manager is designed to access the CATIA structure from everywhere using the getApplication().getUIApplicationSession() methods. The SaveManagerSession is the gate between the graphics elements and CATIAdatas and is populated when created with an InterfaceAbstractUIManagerSession.

The InterfaceAbstractUIManagerSession is an interface used to manipulate the CATIA session and components representation. When the SaveManagerSession class is created, the Integration interface provides the AbstractUIManagerSession object containing all the CATIA structure information. This AbstractUIManagerSession object implements the InterfaceAbstractUIManagerSession allowing it to pass to the SaveManagerSession.

Manipulate CATIA data from the AbstractUIManagerSession object. The getComponents() method provides the AbstractUIManagerComponent that exists in CATIA. From any component, every property of the CATIA document can be accessed using the getProperty(String propName) method or to set any property using the setProperty(String propName, obj value) method.


8-153



8-154


Accessing Selected Components

Use the following steps to retrieve a list of selected components in the Save Manager Table using an action implementation.

1. Retrieve the application using the getSaveManagerApplication() method.

2. From the application, use the getCurrentModule() method to get the SaveModule module (the SaveModule determines which object is selected).

3. Use the getSelectedComponenets() method to get all the AbstractUIManagerComponents selected in the Save Module Table.


8-155


The SaveManagerSession Class

The CATIA information structure is driven by the Integration interface. As mentioned in the Save Manager Handler Definition section, com.ebsolutions.savemanager.SaveManagerSession class is required to create the SaveManagerHandler. The com.ebsolutions.savemanager.SaveManagerSession class is the entry point for the CATIA structure in every display object and action.

As mentioned in the Objects Accessor Methods section, the Application can be accessed from every object using the getApplication() method. The Application contains the SaveManagerSession (the SaveManagerHandler populates the Application with the SaveManagerSession object). Therefore, if you can access the Application, you can access the SaveManagerSession using the getSaveManagerSession() method of the Application class.

Concrete Classes Implementation

Basic Objects Implementations Complex Objects Implementations

Basic Objects Implementations

The Integration provides an implementation for every display class.

If necessary, the implementation and/or abstract classes can be overridden to ensure specific, desired behavior. Overriding concrete classes is helpful for unique needs, such as changing the buttons' display or the toolbar location.

For example: Override the AbstractSaveModule abstract class rather than the AbstractModule class, or override the SaveModuleToolBarButton class rather than the AbstractDisplayElement, for very specific display and behavior. The SaveModuleToolBarButton can be overridden to present a default display, such as a JButton. The AbstractDisplayElement can be customized with a user-specific form, as desired.


8-156


Delivery Implementation Classes Available in the Cat2uimanager.jar File

Abstract class Implementation Classes

AbstractApplication com.ebsolutions.uimanager.AbstractUIManagerApplication com.ebsolutions.savemanager.SaveManagerApplication

AbstractModule AbstractSaveModule com.ebsolutions.uimanager.modules.SaveModule

AbstractToolBar com.ebsolutions.uiapplication.ui.UIApplicationToolBar

AbstractDisplayElement com.ebsolutions.uimanager.modules.SaveModuleToolBarButton com.ebsolutions.uimanager.modules.SaveModuleToolBarCheckBox com.ebsolutions.uimanager.modules.SaveModuleSwingToolBarButton

Complex Objects Implementation

The Cat2uimanager.jar file also contains some complex objects implementations, found in the com.ebsolutions.uimanager.modules package, and can be customized. For instance, customize the internal display of the Save Module or change the part editor display.

• All classes of the com.ebsolutions.uimanager.modules package are concrete implementations of display objects.

• The entry point to use these implementations is the SaveModule. In other words, a module must be redefined to override the SaveModule and change elements of the SaveModule display.

SaveModule Methods

• createDefaultTable(): customizes the table structure representation.

• createDefaultTableEditor(): customizes the part editor (right pane of the Save Manager display).

• createDefaultTableModel(): customizes CATIA data representation

For example, redefine the createDefaultTableEditor() SaveModule method, then return your own implementation of the com.ebsolutions.uimanager.modules.TableEditor.


8-157


Data and Objects Accessors

Data Accessor Methods Objects Accessor Methods User Interface Classes

After objects are created by factories, the SaveManagerHandler calls the public void initialize(Attributes attributes) method of the newly created objects. This method is used for the instantiated class when the class is extending the expected Abstract class as described earlier. The Abstract classes are designed to deliver existing useful methods for an easier customization.

The public void initialize(Attributes attributes) method delegates the xml attributes management to the object itself.

For example: A DisplayElement tag creates an object extending the AbstractDisplayElement class and the AbstractDisplayElement class contains the initialize method. In this case, the created object manages all the attributes of the DisplayElement tag itself, such as storing the icon path, the corresponding action, etc.

If attributes are required in the savemanager.xml file for a specific tag, refer to the following code to override the public void initialize(Attributes attribute) method in a redefined concrete class.

public ConcreteClass extends AbstractModule | | | public void initialize(Attributes attributes) { super.initialize(attributes); String newAttributeName = attributes.getValue("newAttribute"); }

The initialize method is the final xml data population step. After this function, objects corresponding to the savemanager.xml definition are created and populated with all necessary xml values. The next step is to create the user interface classes.

Data Accessor Methods

Every main class represents a display element. The AbstractApplication class (the starting point for the display) extends the JFrame java class. An application redefinition results in changes to the Save Manager frame. Every main class, except the AbstractApplication, does not extend any Java

8-158


component directly. The classes use an abstract createComponent method which must be defined in a concrete class in order to return a JComponent.

Abstract classes store the standard xml data describing the element. Additonal xml data can be added and stored in the concrete class by overriding the initialize(Attributes) method. By default, the method to access the data is as follows. The three basic methods depend on the abstract class, however, one retrieve method exists for each xml data corresponding to your class.

• getIcon() : returns the image attribute value present in the xml

• getName() : returns the identifier attribute value present in the xml

• getNameRef() : returns the nameRef attribute value present in the xml

If custom xml attributes are added, override the initialize(Attributes) method and the create the accessor method. Refer to the table below, if necessary.

Basic Data Accessors For Different Objects

XML Tags Main Class Attribute Method Accessor Comments

<UIApplication> AbstractApplication nameRef getNameRef() ---

<UIApplication> AbstractApplication image getApplicationIcon() Returns an Image object

<UIApplication> AbstractApplication sizex,sizey getApplicationSize() Returns a Point object

<UIApplication> AbstractApplication positionx,positiony getApplicationPosition() Returns a Point object

<SaveManagerToolBar,Toolbar> AbstractToolbar nameRef getNameRef() ---

8-159


XML Tags Main Class Attribute Method Accessor Comments

<SaveManagerToolBar,Toolbar> AbstractToolbar name getName() ---

<Module> AbstractModule name getName() ---

<Module> AbstractModule nameRef getNameRef()

<Module> AbstractModule name getIcon() Returns an Image object

<DisplayElement> AbstractDisplayElement identifier getName() ---

<DisplayElement> AbstractDisplayElement nameRef getNameRef() ---

<DisplayElement> AbstractDisplayElement action getAction() Returns an AbstractAction object

<DisplayElement> AbstractDisplayElement image getIcon() Returns an Image object

<DisplayElement> AbstractDisplayElement showTitle isTitleShow() Returns a boolean

Objects Accessor Methods

The Save Manager process automatically creates a hierarchy between classes.

For example, if an application is defined in the xml file using the <UIApplication> tag and two toolbars are defined within this tag, the toolbars can be accessed in the application redefinition using the getToolbars() method, which returns the AbstractToolbar tab. Then, place the toolbars into the concrete class defined in the xml file to get the full concrete class methods accessible.


8-160


Refer to the following list for a list of the Objects Accessor Methods.

• getToolBars() : returns the toolbar list of the object. Method presents in the AbstractModule and AbstractApplication classes.

• getModules() : returns the modules list of the object. Method presents in the AbstractApplication class.

• getDisplayElements() : returns the display element list of the object. Method presents in the AbstractToolBar class.

• getApplication() : returns the application object. Method presents in every Abstract class. The getApplication() method exists in every class which is helpful when retrieving the first level object (the application). From the first level, every other display object and a CATIA session can be accessed. Every object created by the factories contains its Application information (the application is populated in the newly created object by the SaveManagerHandler).

The schema summarizes the Objects Accessor Methods. Note that the AbstractSaveModule class extends the AbstractModule class, and has, by extension, the same Objects Accessor methods.


8-161



8-162


User Interface Classes

Several abstract classes are used to create the Save Manager display. These abstract classes provide and suggest methods to create java graphical objects. The list below contains available abstract classes known as main classes because of their lowest level within the Save Manager hierarchy.

• AbstractApplication : when extended, creates a new Save Manager Application.

• AbstractModule : when extended, creates a new Module.

• AbstractSaveModule : when extended, creates a new Module with the SaveModule capabilities.

• AbstractTableEditor : when extended, changes the SaveModule table editor.

• AbstractToolBar : when extended, creates a new toolbar.

• AbstractDisplayElement : when extended, creates a new toolbar element.

The AbstractTableEditor class cannot be customized inside the savemanager.xml file. Create a class extending the SaveModule then redefine a new TableEditor to create a new Table Editor.

Interface Construction

The Objects Construction Hierarchy Display Methods

The Objects Construction Hierarchy

At this stage of development, every object is ready to be displayed. The main display object is the Application because it is the JFrame that includes all Save Manager display objects. Review the schema below describing the lifecycle of the Save Manager Frame construction. Note that concrete classes are identified in the xml file by the class attribute value. Concrete classes extend the many abstract classes described throughout this document.


8-163



8-164


The layoutApplication method is provided by the SaveManagerApplication class and is an implementation of the AbstractUIManagerApplication. The AbstractUIManagerApplication class does not provide a method to display it. To implement a new Application:

1. Extend the com.ebsolutions.uimanager.AbstractUIManagerApplication class. This extends the SaveManagerApplication which extends the AbstractUIManagerApplication class.

2. Redefine the layoutApplication method to modify the component display.

The new class must be an extension of com.ebsolutions.uimanager.AbstractUIManagerApplication class because the Integration only handles this class type.

Display Methods

In the schema above, different objects are responsible for their display. Each object displays itself by returning a JComponent corresponding to it. Customize display objects by redefining their methods.

Class Display Method

AbstractUIManagerApplication

No method. Redefines the layoutApplication method in an implementation of the com.ebsolutions.uimanager.AbstractUIManagerApplication class

AbstractToolBar getDisplay()

AbstractModule getDisplay()

AbstractDisplayElement getDisplay()

Every object can retrieve objects composing its display, as described in the Objects Accessor Methods section. For example, the application is able to retrieve toolbars with the getToolbars() method.


8-165


Redefine the getDisplay() method of the parent display to accommodate the children display. All getDisplay() methods are implemented in the Save Manager the same way. For example, create a new module implementation of the com.ebsolutions.savemanager.modules.SaveModule class, then redefine the getDisplay() method to return a JComponent containing the toolbar on the bottom of the display which will display the toolbar on the bottom of the Save Manager.

When implementing such a class, ensure the createComponent() method is redefined and not the getDisplay() method because the getDisplay()method calls the createComponent() method of the object, by default.

Managing XML Information

The SAX Parser Save Manager Handler Definition Save Manager Handler Tasks Custom Handler Examples

The SAX Parser

Simple API for XMLSAX, also known as SAX, was originally a Java-only API. SAX was the first widely adopted API for XML in Java. However, there are versions for several programming language environments other than Java. This API is included with Java and is used in the Save Manager for decoding the savemanager.xml file.

The SAX Parser instance can be retrieved as follows : SAXParser parser = SAXParserFactory.newInstance().newSAXParser(); To initiate the parse, an input stream and handler must be provided: parser.parse(fis, handler); For the Integration, the input stream is the file savemanager.xml and the Handler is the SaveManagerHandler.


8-166


Save Manager Handler Definition

The com.ebsolutions.uiapplication.handlers.SaveManagerHandler class is the main class for the xml data management. It is responsible for the xml information propagation and the first step for the graphical objects creation. The code below initiates a handler to read the savemanager.xml file.

The SaveManagerHandler class is located in the Cat2uimanager.jar file and extends the SAX class org.xml.sax.helpers.DefaultHandler. After this code, when the parse method is called, the SaveManagerHandler class automatically receives the described data provided by the xml stream.

final String catCode = System.getProperty(TCICV5_DIR); final FileInputStream fis = new FileInputStream(catCode + "/env/" + SAVEMANAGER_FILE); final SaveManagerSession session = new SaveManagerSession(); session.setCatiaSession(catSession); // parsing savemanager.xml. final SaveManagerHandler handler = new SaveManagerHandler(session); try { SAXParser parser = SAXParserFactory.newInstance().newSAXParser(); parser.parse(fis, handler); // START THE XML PARSE parser = null; } catch (IOException ex) { ex.printStackTrace(); } catch (ParserConfigurationException ex) { ex.printStackTrace(); } catch (SAXException ex) { ex.printStackTrace(); }

Redefine the Number of DefaultHandler Methods

The com.ebsolutions.uiapplication.handlers.SaveManagerHandler class extends the SAX class org.xml.sax.helpers.DefaultHandler, required for the SAX logic. This class redefines the number of the DefaultHandler methods in order to catch the events of the SAX handler.

8-167


Two common methods within the SaveManagerHandler class are:

• public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException

• public void endElement(String uri, String localName, String qName) throws SAXException

Definitions

The startElement function is called each time a tag and its attributes are decoded from the xml stream.

The endElement function is called each time a close tag is encountered in the xml stream, indicating the tag definition is ending.

The qName string determines the kind of object described in the xml file and its properties. The qName contains the name of the tag currently decoded. For instance:

• <UIApplication>

• <SaveManagerToolBar>

• <Module>

• <DisplayElement>

The attributes attribute argument contains every attribute definition of the qName Tag.

The class attribute indicates which class will be instantiated. The SaveManagerHandler uses this attribute to create the corresponding Factories Mechanism.

Save Manager Handler Tasks

The SaveManagerHandler:

• retrieves tag information from the xml stream

• creates the classes corresponding to the xml definitions

• initializes the objects with the attributes values provided by the xml

• delegates the handler values into the Sub Handler.

The schema below describes the Factory Mechanism used to create the objects corresponding to the xml tags. The Method startElement of the handler analyzes the tags, retrieves the class attribute of each tag and uses the Factory Mechanism to instantiate the class corresponding to the class attribute value.


8-168


8-169


This mechanism results in a list of objects corresponding to the xml definitions. The SaveManagerHandler automatically populates the created objects with their necessary objects. For example, at the end of the SaveManageToolBar definition, the created toolbar is added to the toolbar list in the application. Notice the SaveManagerHandler delegates handling events to an AbstractModuleHandler. This process permits customization of the xml file, so that it is possible to implement customized tags within the savemanager.xml.

The Sub Handler is only available inside the Module tag. The Module tag of the savemanager.xml file contains the attribute moduleHandler, permitting customization of the Module Handler. For example, a CustomModuleHandler class can be created to extend the the AbstractModuleHandler class by replacing the moduleHandler attribute value with the path to your CustomModuleHandler. In this case, every tag inside your Module definition is received. To retrieve the xml tags inside the Module tag, redefine the startElement and endElement functions inside the CustomModuleHandler class.

An action attribute is defined on the DisplayElement tag, and is managed by the AbstractDisplayElement itself. After the element is created by the corresponding factories, an initialization method is called and the attributes list of the tag is passed into this function to determine attribute management. In the case of the DisplayElement object, the initialization method retrieves the action attribute value and calls the ActionFactory to instantiate the corresponding action.

Custom Handler Examples

Redefine the Handler with Additional Tags

The following example demonstrates placing a new xml tag with the custom handler by redefining the handler with additional tags. In this example, redefining the handler is performed without redefining the module.

Both the module handler and the module should be redefined because new xml tag values must be retrieved. A later example addresses developing a complete module and handler. The purpose of this example is only to create and manage xml tags.

Refer to the following values used to add the new tag (Fruit) to the savemanager.xml file and replace the moduleHandler attribute value with the path to the custom handler.

1. The savemanager.xml definition:

<Module nameRef="Save Module" name="save_module" moduleHandler="com.customcompany.savemanager.handlers.CustomModuleHandler" image="/com/ebsolutions/savemanager/modules/images/save.png"

8-170


class="com.ebsolutions.savemanager.modules.SaveModule"> <Fruit name="Apple"/> <Fruit name="Lemon"/> <Fruit name="Orange"/>

2. The moduleHandler attribute value.

package com.customcompany.savemanager.handlers; public class CustomModuleHandler extends AbstractModuleHandler { protected List listFruit; public CustomModuleHandler() { listFruit = new Vector(); } public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException { super.startElement(uri, localName, qName, attributes); if (qName.equals("Fruit")) { String nameFruit= attributes.getValue("name"); listFruit.add(nameFruit); } } public void endElement(String uri, String localName, String qName) throws SAXException { super.endElement(uri, localName, qName); } }

The handler is now able to retrieve the Fruit list. When the savemanager.xml file parsing is complete, the CustomHandler contains the Fruit list in the listFruit vector.

Button

The previous example illustrates adding xml tags in a module. Tags cannot be added on other xml objects. However, other objects can add attributes and be retrieved in the implemented class.

The next example redefines the initialize(Attribute Method) to get the color attribute from the xml and apply it to the button in the createComponent() method redefinition.

public class TestButton extends AbstractDisplayElement { JButton button = null;


8-171


Color color = null; public JComponent createComponent() { JButton myButton = new JButton(); button = myButton; button.setBorder(null); button.setBackground(color); button.setText(name); button.setIcon(new ImageIcon(getIcon())); return myButton; } public void initialize(Attributes attributes) { super.initialize(attributes); setColor(attributes.getValue("color")); } protected void setColor(String col) { try { color = new Color(Integer.parseInt(col)); } catch (Exception k) { } } public String getID() { return name; } }


8-172


Save Module Elements

Refer to the descriptions of classes, delivered with the Integration, which compose the Save Module.

Ensure customizations take place on the correct class. Modifying an existing module is easier than redefining a complete module. However, refer to the illustration below to create a model that extends the SaveModule.

Customize the Table and appearance of the Table Editor by redefining the createDefaultTable() and createDefaultTableEditor() methods in an extended class of the SaveModule. Refer to the code below for an example.

8-173


Factories Mechanism

Factories are based on the java reflection feature. The goal of a factory is to instantiate a class from its signature. The signature class is the package name and includes the class and the name of the class itself. For example, the signature of the famous JFrame class is javax.swing.JFrame.

The factory process is very useful for portable projects. During the Save Manager process, the SaveManagerHandler catches the xml information and uses the factory system to instantiate the classes defined in the class attribute of every tag. Because of this, every Save Manager object is independent and each one customized.

The class attribute value must be a class extends the corresponding Abstract class. Refer to the following table for the list of the factories and Abstract classes.

Available Factories

The basic Save Manager package suggests factories for the Main classes of the Save Manager. Refer to the table below for a factory list and the objects managed.

XML Tags XML Attribute Factory Class Name Instantiable Classes

<UIApplication> class ApplicationFactory AbstractApplication

8-174


XML Tags XML Attribute Factory Class Name Instantiable Classes

<SaveManagerToolBar>,<ToolBar> class ToolBarFactory AbstractToolBar

<Module> moduleHandler ModuleHandlerFactory AbstractModuleHandler

<Module> class ModuleFactory AbstractModule

<DisplayElement> class DisplayElementFactory AbstractDisplayElement

<DisplayElement> action ActionFactory AbstractAction

The Abstract classes listed are seed classes. When a definition is redefined, the class that is redefined must extend the corresponding Abstract class. Abstract classes can be modified to fit classes, as desired.

The Factories classes are not designed to be used independently because the Save Manager uses them to instantiate the classes in the xml file. Ensure the redefined class extends the correct Abstract class corresponding to the schema above. If necessary, refer to the "Custom Handler Example" which illustrates how the CustomModuleHandler extends the abstract class AbstractModuleHandler.

The Listeners

Adding Listeners to Specific Implementations Save Module Listening Capabilities

Listeners, provided in the out of the box delivery of the Save Manager, notify different objects of different events.


8-175


Adding Listeners to Specific Implementations

Refer to the schema before adding components as listeners of AbstractUIManagerSession, Application, ListSelection and Reorder objects.

Recall that the AbstractUIManagerSession and the Application classes can be accessed using the getApplication() and getUIApplicationSession().getCatiaSession() methods. ListSelection and ReorderModel are also accessible by casting the module into a SaveModule, retrieving the table and its models, then adding your component as a listener to them. This will cause notifications each time the event is initiated.

Display Element Implementation

Refer to the sample code below to create a display element implementation to notify each time a selection changes in the Save Table. Elements selected can also be accessible using the tableModel getComponentsAT method.

An overview of the steps is as follows:

1. Implement the ListselectionListener interface.

2. Add your component as a listener to the table selection model.

3. Redefine the valueChanged(ListSelectionEvent e) method to get the new selected components.


8-176


Save Module Listening Capabilities

When customization of Save Manager elements is required, you will get the events inside the module. The module is the main element dispatching events to other objects. The Save Module listens to (receives) four main events, as illustrated below.


8-177


Event Description

AbstractUIManagerSessionEvent

Initiated each time an element in the CATIA session changes, such as when a user modifies a property on at least one AbstractUIManagerComponent. The Save Manager display is updated depending on the affected module.


8-178


Event Description

ApplicationEvent

Initiated each time the Save Manager displays. The Save Manager becomes "invisible" when OK is selected during the Save process. When the Save process is initiated again, the ApplicationEvent scans every listener before setting the Save Manager visible again. The Save Module updates the display after receiving this event.

ReorderEvent

Initiated each time a column in the Save Table is sorted or filtered. The ReorderEvent is dispatched in four functions : two reorder operations and two filter operations. The will function is initiated before the reorder is performed and the ed function is initiated after the reorder is performed. This mechanism keeps the table selection information in the will functions and resets the selection in the ed functions.

ListSelectionEvent

Initiated each time an element selection changes in the Save Table. This event is pre-implemented by the AbstractSaveModule class. The AbstractSaveModule populates the TableEditor with the selected AbstractUIManagerComponents and displays the correct editor, depending on the selection.

Save Manager Workbench

The Cat2uimanager.jar File Setting up an Environment

The Save Manager Development Toolkit contains a specific structure. Refer to the sub-topics above to begin a customization project.


8-179


The Cat2uimanager.jar File

Packages

The RACLess sub-directory, within the Integration directory, contains the necessary .jar files used to create customizations.

The Cat2uimanager.jar file is the package distribution that contains all the necessary classes used to implement your own objects. Use the com.ebsolutions.uiapplication package to create a new Save Manager interface, with specific, customized behavior.

The Teamcenter implementation of the Save Manager contains complete data management and data representations are redefined in the jar file (in the InterfaceCATIASession and InterfaceCATIAcomponent interfaces) to fit Teamcenter metadata requirements. The implementation also drives the Save Manager data with the Teamcenter Server to synchronize visuals and metadata.

Use the com.ebsolutions.uimanager package in your project for Teamcenter specific customizations, rather than creating a new implementation. This package contains implementations to manipulate Teamcenter data, and should be used as a source, rather than implementing a complete, new specific implementation.

Refer to the JAVA Code Customizations section for more information related to implementing a JAVA project.


8-180


Packages

Refer to the illustration and the table below for the available Cat2uimanager.jar file packages:

Package Contents

com.ebsolutions.uiapplication

Contains the basic interfaces available to implement. It is not necessary to use these classes unless redefining the interfaceAbstractUIManagerSession and InterfaceCATIAComponent interfaces is desired.

com.ebsolutions.uiapplication.actions Contains the AbstractAction class. This class can be extended, for example, for a specific button action customization.

com.ebsolutions.uiapplication.exceptions Contains the SaveManagerException class and is empty. This class is reserved for future use.

com.ebsolutions.uiapplication.handlers Contains all the Save Manager handler specific classes. It is not necessary to override these classes (these are the Save Manager engine).


8-181


Package Contents

com.ebsolutions.uiapplication.toolbox

Contains a set of re-usable graphic elements which can be used without any other package restraints. This package includes elements such as CATIA buttons and toolbar styles. Additional classes included are the FilterModel (for a table) and the OrderedMap class, which provides a map to control the order of populated elements. This package can be used outside the Save Manager Toolkit for another java project.

com.ebsolutions.uiapplication.ui

Contains all the abstract classes to extend when implementing a new graphical object. Classes in this package include the AbstractApplication, AbstractModule, AbstractSaveModule, AbstractToolBar and AbstractDisplayElement classes, and provides the basic behaviors for objects, as described within the Save Manager LifeCycle section.

VerticalLayout and HorizontalLayout classes can be helpful for a new Application implementation. These layouts are complete and display graphic elements easily.


8-182


Package Contents

com.ebsolutions.uimanager

Contains the implementations for the corresponding interfaces including AbstractUIManagerSession and AbstractUIManagerComponent Application classes (providing behavior to the Teamcenter version of the Save Manager).

com.ebsolutions.uimanager.actions

Contains all Teamcenter-specific actions. The actions behind the Save Manager buttons are listed within this package and redefined within the savemanager.xml file. Extend one of those to redefine the corresponding action as necessary.

com.ebsolutions.uimanager.commands

Contains specific commands, such as Check-in and Check-out, and must be accessible from CATIA. This package is not re-usable because these commands cannot be redefined through the savemanager.xml file.

com.ebsolutions.uimanager.handlers

Contains the SaveModuleHandler class used to manage the xml tags for the SaveModule. This sub-handler redefines tages such as the Column tag used in the Save Table. A specific Handler redefinition can exist to extend it in order to add new xml tag management.

com.ebsolutions.uimanager.modules

Contains the SaveModule definition and other classes specific to the Teamcenter SaveManager implementation, such as the TableEditor, TableModel and Actionners. Use this package when overriding specific SaveModule parts.


8-183


Setting up an Environment

Example: Customize a Save Manager Button

Use the following example to modify the behavior of the Save button in the Save Manager so that it displays a message when selected.

1. Pick File >> Java Project to create a new Java project.

2. Enter the project name and verify the correct Java version In the Java Project dialog. For example, Java 1.7 for Teamcenter 10.1.5 and Teamcenter 11.3.0 and higher. Pick Next to continue.





8-184


Result in Eclipse:

4. Create a package named com.custo, then add a class called AppCusto.java. Set the Superclass to SaveManagerApplication.


8-185



8-186


5. Generate a Library


7. Toggle the Java folder open, select the JAR file, then pick Next.


8-187



9. Open the TcIC_DIR\env\Savemanager.xml file and change the Save Manager application as shown below.

10. Test the customization.


8-188


a. Start CATIA and Teamcenter.

b. In CATIA, create A1(P1), then Save.

c. In the Save Manager, assign IDs, then pick the Save button. The new message displays.

Creating an Ant Build Script

Use an Ant script within Eclipse to compile and create a .jar file containing your customization. This Ant script can also be used for testing. Refer to the following build example. Adapt these instructions to include paths specific to your needs.


8-189


1. Add the previous .xml file in your java project then add the Eclipse Ant view.

2. Edit the file as necessary.

Modify the properties at the beginning of the buildCusto.xml document specific to your required paths.

3. Drag and drop the build.xml into the Ant view.

4. Double-click on the Custom.compile targets to compile your customization.


8-190


Save Manager Tutorial

Import a Project into Eclipse

Create:

Display Element New Action New Application New Button Style New Module New Toolbar Style

Manage:

Manage CATIAdata Before/After the Save Manager Displays

Change:

Change the Table Display

APIs:

Save Manager API Java Documentation

Sample projects are available in the projectSamples.zip file within the TcIC_DIR\custom_client\SaveManager folder. Use these samples as a starting point for your customizations.

Please ensure the following when using the projectSamples.zip file.

• The provided SaveManagerCustom_3.0.0.jar is compatible with the current Teamcenter version (TC_VERSION) installed.

• Use the SaveManagerCustom_3.0.0.jar available under a different Tcxxx directory to be compatible with a different TC_VERSION supported by the Integration.

• The projectSamples.zip file has been unzipped into a directory and has been imported into Eclipse.


8-191


If necessary, refer to the compiled SaveManagerCustom_3.0.0.jar file, in the TcIC_DIR\custom_client\SaveManager folder, corresponding to the project samples, if difficulties are experienced when generating the SaveManagerCustom_3.0.0.jar file or to view the customizations.

Import a Project into Eclipse

Perform the following steps to import a project into Eclipse. This example refers to the SaveManagerCustom project.

The sample project may be compiled using the Ant script in buildCusto.xml.

1. In Eclipse, pick File >> Import, then select Existing Projects into Workspace within the General folder.

2. Pick Next to continue.


8-192


3. Select the directory containing the extracted projectSamples.zip file, then pick Finish.

Result:


8-193


4. Change the properties of the buildCusto.xml file to successfully generate the SaveManagerCustom_3.0.0.jar file.

Create a New Display Element

Toolbars are designed to receive any type of JComponent, therefore, it is possible to create component types other than buttons. Three examples are provided:

1. Display the current date and time.

2. Display the number of selected elements in the table.

3. Indicate if a CATIA session has changed.

Display the Current Date and Time

The projectSamples.zip file in the TcIC_DIR\custom_client\SaveManager folder, contains a class called com.mycusto.displayelements.sample1.MyOwnDisplayElement, which provides an example of integrating a new JLabel in the Save Manager. This JLabel indicates the current date and time by starting a timer to change the JLabel text and display the current date and time each second. This class is very small.

The savemanager.xml definition for this class, shown below, can be accessed within the savemanager-displayelements-sample1.xml file in the TcIC_DIR\custom_client\SaveManager folder. Add this definition after the destination_folder DisplayElement.

The Save Manager now contains a new label next to the Newstuff box, and displays the current date and time.

When a display element such as a JLabel is redefined, the action attribute is not used because an action cannot be used with a JLabel. However, the action attribute must remain in the DisplayElement declaration within the xml file to avoid exception errors.


8-194


Display the Number of Selected Elements

The projectSamples.zip file in the TcIC_DIR\custom_client\SaveManager folder contains a class called com.mycusto.displayelements.sample2.MyOwnDisplayElement2 which provides an example of retrieving SaveModule information. This display element creates a JLabel to display the number of selected elements in the Save Table.

• Implement the ListSelectionListener interface.

• Redefine the valueChanged(ListSelectionEvent t) method.

• Add the class as a listener to the Table Selection with the module.getTable().getSelectionModel().addListSelectionListener(this); code.

The savemanager.xml definition for this class, shown below, can be accessed within the savemanager-displayelements-sample2.xml file in the TcIC_DIR\custom_client\SaveManager folder. This sample must only be used in the Save Module Toolbar. Placing this sample into the Save Manager Toolbar causes a nullpointerException error because it attempts to get a module that has not been created at this stage of the button creation process. The number of selected elements is specific to the Save Module, and can therefore only be applied toward the Save Module.

Each time the Save Table selection changes, it displays the number of lines selected.

Indicate if a CATIA Session Changed

The projectSamples.zip file in the TcIC_DIR\custom_client\SaveManager folder contains a class called com.mycusto.displayelements.sample3.MyOwnDisplayElement3, which provides an example of how to listen to a AbstractUIManagerSession. This DisplayElement creates a JLabel to indicate if the AbstractUIManagerSession has changed. When the Save Manager displays, this label indicates that the session has not changed, but if a part's property is changed and Applied, the label indicates the session changed. The object is notified in the sessionChanged method.

• Implement the AbstractUIManagerSessionListener Interface.


8-195


• Redefine the sessionChanged(AbstractUIManagerSessionEvent t) method.

• Add the component as a listener of the AbstractUIManagerSession.

• With the AbstractUIManagerSession object, use the addSessionListener(this); code

The savemanager.xml definition for this class, shown below, can be accessed within the savemanager-displayelements-sample3.xml file in the TcIC_DIR\custom_client\SaveManager folder.

Each time the AbstractUIManagerSession changes, the label is notified and displays a message.

Create a New Action

The projectSamples.zip file in the TcIC_DIR\custom_client\SaveManager folder contains three sample actions:

1. Select all lines in the Save Manager Table

2. Assign an Item Revision (CATIA data).

3. Set the Item Revision to the Item ID (CATIA data).

Select all lines in the Save Manager Table

The com.mycusto.actions.sample1.MyOwnAction class selects all lines in the Save Manager Table.

• Retrieve the AbstractUIManagerApplication, then get the SaveModule.

• Get the CATIATable and its selection model.

• Select all the lines on the selection model.


8-196


The sample was tested with the custom button created earlier. The savemanager.xml declaration that applies the com.mycusto.actions.sample1.MyOwnAction action to the custom button is shown below, and can be accessed within the savemanager-actions-sample1.xml file in the TcIC_DIR\custom_client\SaveManager folder.

Result: When the my_custom_button is selected, all lines of the Save Table become highlighted.

Assign an Item Revision (CATIA data)

The com.mycusto.actions.sample2.MyOwnAction2 class assigns the Item Revision Name to the Item ID of the root part of the CATIA assembly. This sample demonstrates how to access the CATIA Structure. Every AbstractUIManagerComponent can be accessed from the CATIASession and assigned a property.

The Item ID property has been set to an editable status with the following code. By default, this property is not editable.

Property itemIDProp = (Property)comp.getComponentProperty(AbstractUIManagerComponent.ITEM_ID); itemIDProp.setEditable(true);

For editable properties, this step is not required and will only be necessary to set the property in the AbstractUIManagerComponent.


8-197


The sample was tested with the custom button created earlier. The savemanager.xml declaration that applies the MyOwnAction2 action to the custom button is shown below, and can be accessed within the savemanager-actions-sample2.xml file in the TcIC_DIR\custom_client\SaveManager folder.

• The module.saveSelection() and module.updateSelection() calls are designed to keep the selection in the table, otherwise, the current table selection is lost after the action.

• The session.check() call is designed to update the table and parts status. If the property set causes a status error, the session.check() function disables the Save button. The check function causes every session listener to update. The SaveModule is listening to the session and updates the Table display as necessary.

Result: When the my_custom_button is selected, the root part Item ID is set to its Item Name.

Set the Item Revision to the Item ID (CATIA data)

The com.mycusto.actions.sample3.MyOwnAction3 class sets the Item Revision Name to the Item ID on all selected parts, instead of the Root Part only. This sample demonstrates how to access the table selected elements. The module.getSelectedElements() method returns every selected AbstractUIManager Component and InterfaceCATIAComponents that are cast into AbstractUIManagerComponents.

The sample was tested with the custom button created earlier. The savemanager.xml declaration that applies the com.mycusto.actions.sample3.MyOwnAction3 action to the custom button is shown below, and can be accessed within the savemanager-actions-sample3.xml file in the TcIC_DIR\custom_client\SaveManager folder.


8-198


Result: When the my_custom_button is selected, the Item ID of the selected parts are set to their Item Name.

Create a New Application

The sample illustrates how to create an application that is using a:

• custom module

• custom module handler

• custom toolbar

• custom display element

• custom display action.

The sub-module handler,com.mycusto.applications.sample1.MyOwnAppliModuleHandler illustrates how to add tags in an xml module definition. The com.mycusto.applications.sample2.MyOwnApplication includes every redefinition possible.

Two display elements contain a custom action which displays a file chooser when a menu button is selected, permitting the user to pick .jpg files. For instance, to permit a selected picture to be rendered in a module. In this sample file, however, no action is defined when the file is selected.

The com.mycusto.applications.sample2.MyOwnApplication2 application in the projectSamples.zip file in the TcIC_DIR\custom_client\SaveManager folder illustrates how to change the display of the Save Manager. Once implemented, this application sample displays the Save Manager toolbars on the left, the modules display inside a tabbed pane and the OK and Cancel buttons are redefined.

8-199


This Application contains the following custom class declarations and three methods:

Custom Class Declarations/Methods

<UIApplication> com.mycusto.applications.sample2.MyOwnApplication2

<SaveManagerToolBar> com.mycusto.applications.sample2.MyOwnToolBarStyle3

Module 1; com.mycusto.applications.sample2.MyOwnAppliModule

Module 1 handler com.mycusto.applications.sample2.MyOwnAppliModuleHandler

Module 2; com.mycusto.applications.sample2.MyOwnModule

Module 2 handler com.mycusto.applications.sample2.MyOwnModuleHandler

layoutApplication() method

called to render the Save Manager application. Every component can be accessed from within this method. Ensure it is determined how the components are displayed in the frame.

showApplication() method

called to set the Save Manager frame visible. This method is also an entry point to manage data before displaying the Save Manager and also after the Save Process has been confirmed.

getStatusBar() method required to return a Status Bar to the Save Module. Redefining this method is not required if the Save Module is not used in your savemanager.xml declaration.

The savemanager.xml definition for this sample can be accessed within the savemanager-applications-sample2.xml file in the TcIC_DIR\custom_client\SaveManager folder.

This sample contains actionlisteners for the OK and Cancel buttons to define the Application status each


8-200


time the buttons are selected. The release() method must also be called to dispose the frame when the buttons are selected because the super.showApplication(frame); method is waiting for the release() command to dispose the frame. These activities can be customized based on the release of the frame or the status of the OK and Cancel buttons, depending on CATIA data, for example.

Create a New Button

Redefine the Toolbar Apply the Button Feature

A button is a DisplayElement tag in the savemanager.xml file, whose extendable class is the AbstractDisplayElement class.

• Extending the AbstractDisplayElement class automatically provides the xml tags (described in the The Data Accessor Methods section).

• The createComponent() method must be redefined. Use the createComponent() method to create your button as a JComponent by applying the button style desired and add it to the end of the function.


8-201


• The getID() method must be redefined. The getID() method is designed to return a unique identifier for this DisplayElement. The name XML attribute value is used for the ID in the example below.

com.mycusto.buttons.sample1.MyOwnButtonStyle Class Example

The com.mycusto.buttons.sample1.MyOwnButtonStyle class in the projectSamples.zip file, in the TcIC_DIR\custom_client\SaveManager folder, describes a button whose icon rotates each time the mouse hovers on it. The com.mycusto.utils.Rotator class, provided in the sample project, calculates the icon rotations.

The Rotator class is a sample class used to demonstrate that it is possible to use customized utilities and include them within your package.

The com.mycusto.buttons.sample1.MyOwnButtonStyle class:

• changes the appearance of the SaveManager button by using new xml attributes from the savemanager.xml file and used in the code.

• contains speed attributes added to the xml file, which passes through the initialize(Attributes attributes) method redefinition and is applied to the timer rotating the button icon.

• Listeners have been added on the button created in the createComponent() method to start/stop the rotation timer.

The savemanager.xml definition for this button, shown below, can be accessed within the savemanager-buttons-sample1.xml file in the TcIC_DIR\custom_client\SaveManager folder.

The Save Manager contains a new button named my_custom_button and rotates when the mouse hovers on it.


8-202


Redefine the Toolbar

The toolbar must also be defined when a button has been redefined in the Save Manager. By default, the SaveManagerToolbar is designed to control its elements. The button implementation will be manipulated by the toolbar to fit in size. In addition, every implemented button is not opaque and the text of the button is mandated by the toolbar. If a specific font is applied to the button, it will not display because the text is separated into a JLabel by the toolbar.

If necessary, redefine the complete Toolbar to accommodate specific needs.

Apply the Button Feature

Replace the class attribute value of every DisplayElement definition in the savemanager.xml file to apply this button feature to every display element in the Save Manager. For example, if MyOwnButtonStyle is applied to every button in the savemanager.xml file, it will display as shown.


8-203


Create a New Module

Notes Important Warning Schema and Location Result

The projectSamples.zip file in the TcIC_DIR\custom_client\SaveManager folder contains a Module implementation demonstrating how to create a module. It is not a fully functional module, its intention is to illustrate module creation, determine differences between modules, and demonstrate how modules listen to their environment.

The com.mycusto.modules.sample1.MyOwnModule module in the projectSamples.zip file in the TcIC_DIR\custom_client\SaveManager folder contains a com.mycusto.modules.sample1.MyTree class which creates a Teamcenter tree corresponding to the item revisions to be Saved. This tree has the same look & feel as the My Teamcenter tree and can be useful for viewing the item revision inside the Save Manager, rather than in Teamcenter. This tree implementation constructs an object tree from the com.ebsolutions.uimanager.AbstractUIManagerApplication class. By default, the root node is the Home folder and children are the item revisions corresponding to the CATIA parts. New parts display with a question mark.

The module also contains the com.mycusto.modules.sample1.EmptyComponent class which extends the IMANComponent type to render an empty element in the Tree. Because this tree uses an TcTreeCellRenderer, it is useful to give a toString() implementation for an empty element.

Notes

• This module extends an AbstractModule because this module does not contain Save Module behaviors or displays. If it did, it would have extended the AbstractSaveModule class.

• Three interfaces are implemented: AbstractUIManagerSessionListener, ApplicationListener and ListSelectionListener to ensure the module listens to the AbstractUIManagerSession, the Application and the Save Module Table.

• Methods added for the listeners are:

• The public void sessionChanged(final AbstractUIManagerSessionEvent ev) method is invoked when the AbstractUIManagerSession changes.

• The public void applicationChanged(ApplicationEvent t) method is invoked when the application changes.

• The public void valueChanged(ListSelectionEvent e) method is invoked each time the Save Module Table selection changes.

• This module may or may not be combined with the Save Module in the savemanager.xml file. If the Save Module is not involved, the listening methods for the Save Module are not invoked.


8-204


• This module can communicate information to the Save Module. For example, when an item revision is selected in the tree, the treeselectionlistener transmits information to the Save Module.

• The Module Handler must also be redefined because the existing Save Module Handler is not compatible with this module. The com.mycusto.modules.sample1.MyOwnModuleHandler extends the AbstractModuleHandler class. To avoid using xml tags, it does not contain redefinitions.

• When the application contains more than one module, each module accesses other modules by retrieving the application using the getModules() application method.

Important Warning

Using the Datas Viewer module alone in the savemanager.xml definition causes Save errors because the Integration interface Save process requires a Save Module. Create a standalone module by extending the com.ebsolutions.uimanager.modules.SaveModule class to fit the Save process needs. NOTE: The Filter button displayed on the bottom right corner of the Save Manager is declared in the createComponent() method of the Save Module implementation. This capability is not implemented when using a standalone module.

Schema and Location

Refer to the schema below for additional information.


8-205


The savemanager.xml definition to implement the com.mycusto.modules.sample1.MyOwnModule module can be accessed within the savemanager-modules-sample1.xml file in the TcIC_DIR\custom_client\SaveManager folder.

When adding toolbar definitions, use the commented code in the sample as a guide. The getToolbars() method retrieves all the module toolbars and the getDisplay() method gets their display. In the example provided, no toolbar is defined for the Datas Viewer module.

Result

Result of the com.mycusto.modules.sample1.MyOwnModule module:


8-206


The Save Module is used in parallel with the Datas Viewer module, i.e, each line selection also selects the corresponding item revision in the Data Viewers module.

Create a New Toolbar Style

The projectSamples.zip file in the TcIC_DIR\custom_client\SaveManager folder contains two sample toolbar redefinitions:

1. Define Button Fonts

2. Toolbar Display

Define Button Fonts

Creating a new toolbar implementation provides more accessibility to its contained elements. By default, the SaveManagerToolBar class drives its elements and prevents some display customizations.

The com.mycusto.toolbars.sample1.MyOwnToolBarStyle toolbar redefinition works in conjunction with the com.mycusto.toolbars.sample1.MyOwnToolBarStyleButton button redefinition. This sample demonstrates a toolbar which uses extra xml parameters to define the text font of the button. By redefining the button, the text can be changed and displayed as needed.

• The font size, fontName, fontStyle and direction attributes have been added to the toolbar definition.

• The initialize(Attributes attributes) method has been redefined in the com.mycusto.toolbars.sample1.MyOwnToolBarStyle class to manage the new settings.


8-207


• The defined font has been set, in the createComponent() method, to every display element and added to the toolbar.

• The direction attribute indicates the horizontal or vertical direction of the toolbar and the display element disposition changes depending on this attribute.

• A gradient color is used in this sample to display the toolbar to keep the same default Save Manager toolbar display.

The xml definition defines this toolbar style for the Save Manager toolbar and for the Save Module toolbar. The difference between the toolbars is the font of the display elements.

This customization can be useful in modifying fonts on the fly within the xml file.

The savemanager.xml definition for this toolbar style is shown below and can be accessed within the savemanager-toolbars-sample1.xml file in the TcIC_DIR\custom_client\SaveManager folder.

The Save Manager Toolbar xml definition:

The Module Toolbar xml definition :

Result:

Toolbar Display

The com.mycusto.toolbars.sample2.MyOwnToolBarStyle2 toolbar redefinition works in conjunction with the com.mycusto.toolbars.sample2.MyOwnToolBarStyleButton2 button redefinition. This sample demonstrates a toolbar with a different display and may be used to provide customization ideas. The sample toolbar is a JMenuBar.


8-208


• The public void initialize(Attributes attributes) method in the MyOwnToolBarStyleButton2 button redefinition class has been redefined to manage a new xml attribute called category.

• The category attribute indicates which toolbar contains the button menu.

• One button has been added within the File menu and two buttons have been added within the Edit menu using the category attribute.

• The MyOwnToolBarStyle2 toolbar class retrieves every Display element and calls the getCategory() method defined in the MyToolBarStyleButton2 class for each of them. This indicates to the toolbar the number of menus required, then adds the corresonding elements using the getDisplay() method.

The MyOwnToolBarStyle2 class is only valid with MyOwnToolBarStyleButton2 Display elements. A cast is explicitly performed in the toolbar, required to get the getCategory() method.

The savemanager.xml definition can be accessed within the savemanager-toolbars-sample2.xml file in the TcIC_DIR\custom_client\SaveManager folder.

Result :

Manage CATIAdata Before and After the Save Manager Displays

The Save Manager element controlling the Save Manager JFrame is the Application. The showApplication() method displays the application. Accessing CATIA data before and after the Save Manager frame displays is possible when this method is redefined within an Application implementation.

The method public synchronized in the showApplication(Frame frame) is redefined in the com.mycusto.applications.sample2.MyOwnApplication2 Application. The entry point before the Save Manager display is just before the call to super.showApplication(frame) and the entry point after the Save Manager display is just after this call.

8-209


Refer to the following example to include the MyOwnApplication2 showApplication(Frame) method in order to add a specific action to the CATIA data before and after the Save Manager displays.

public synchronized int showApplication(Frame frame) { CATIASession catiaSession = (CATIASession)getSaveManagerSession().getCatiaSession(); for(int a - 0 ; < catiaSession.getComponents().size() ; a++) { CATIAComponent cmp - catiaSession.getComponent(a); Property prop - (Property)cmp.getComponentProperty(CATIAComponent.ITEM_NAME); prop.setEditable(true); cmp.setProperty(CATIAComponent.ITEM_NAME,"PartNumber_"+a); IMANComponentItemRevision itemRev - MyUtils.getItemRevision(catiaSession.getIMANSession(),cmp); if(itemRev -- null) { System.out.println("CATIA Document number "+a +" is existing in Teamcenter"); } else { System.out.println("CATIA Document number "+a +" is not existing in Teamcenter"); } } super.showApplication(frame); /*At this step the Save Manager is disposed but you can still access CATIA datas*/ return getAppliStatus(); }

Notice a new value to the item_name property of each document. When the document exists in Teamcenter, the properties are not editable. Use the setEditable(true) method to allow it to be edited.

The MyUtils.getItemRevision(InterfaceCATIAcomponent) method, called in a commented source in this sample, is useful because it retrieves the Item Revision corresponding to the CATIAComponent. Refer to the com.mycusto.utils.MyUtils class for other useful methods used between the CATIA document and Teamcenter objects.


8-210


Change the Table Display

List of CATIA Property Types

The Save Table is a specific Save Module component. The com.ebsolutions.uimanager.modules.CATIATable class is the implementation delivered with the Save Manager toolkit.

The com.ebsolutions.uimanager.modules.CATIATable extends the com.ebsolutions.uiapplication.ui.UIApplicationTable class. The AbstractSaveModule createDefaultTable() method waits for a UIApplicationTable type. Create a class that extends the com.ebsolutions.uiapplication.ui.UIApplicationTable class (or the com.ebsolutions.uimanager.modules.CATIATable, also a UIApplicationTable) to create your own table implementation.

The com.mycusto.savetable.sample1.MyOwnTable class in the projectSamples.zip file in the TcIC_DIR\custom_client\SaveManager folder redefines a Table implementation by redefining the createDefaultTable() method to customize the Save Table.

Customize the Save Table by creating a new module to extend the SaveModule. A sample class called com.mycusto.savetable.sample1.MyOwnModule3, is provided in the projectSamples.zip file in the TcIC_DIR\custom_client\SaveManager folder. This sample class redefines the CreateDefaultTable() method, com.mycusto.savetable.sample1.MyOwnTable. Refer to the following code:

protected UIApplicationTable createDefaultTable() { MyOwnTable table = new MyOwnTable(this); Font f - new Font("Dialog", Font.BOLD, 15); table.getTableHeader().setFont(f); return table; }

The implemented Table MyOwnTable extends the UIApplicationTable class and provides the ability to reorder and filter. The MyOwnModule3 module redefines a table implementation, but the data model has not been redefined allowing the implemented MyOwnTable to interpret the CATIA data model the same as the original Save Module table interprets the CATIA data model.

The createDefaultTable() method is the entry point to change the Save Table. Use the MyOwnTable implementation to define new renderers, for example. Two custom CellRenderer implementations are provided within the sample file:

• com.mycusto.savetable.sample1.MyOwnStringCellRenderer


8-211


• com.mycusto.savetable.sample1.MyOwnIntegerCellRenderer.

Icon customizations are also provided in the two renderers and are accessible using the com.mycusto.utils.MyUtils.getIcon(String) static method.

Ensure icons are loaded only one time. If icons are created manually in the renderer, they load each time a cell displays causing the Save Manager to display slowly.

These renderers manage the cell display in the table depending on data type. Refer to the code below when customizing display of the call, depending on its CATIAComponent property the column displays.

if (model.getColumnID(index).equals(CATIAComponent.STATUS)) { processStatus(((Integer)value).intValue()); }

The two renderers provided manage all properties containing a String and Integer type. The Boolean and List type renderes used in this table sample are used in the Save Manager implementation. The out of the box renderers are :

• com.ebsolutions.uimanager.modules.StringCellRenderer

• com.ebsolutions.uimanager.modules.IntegerCellRenderer

• com.ebsolutions.uimanager.modules.TypeListCellRenderer

• com.ebsolutions.uimanager.modules.BooleanCellRenderer

When implementing a new cell renderer, do not extend the classes listed above in order to avoid problems with the icons.

The 2 renderers provided have similar codes as the classes above and can be used to customize columns as desired. The provided renderers do not extend the above classes, but extend the basic Save Manager renderers.

• com.ebsolutions.uiapplication.ui.DefaultStringSaveManagerCellRenderer

• com.ebsolutions.uiapplication.ui.DefaultSaveManagerCellRenderer

• com.ebsolutions.uiapplication.ui.DefaultIntegerSaveManagerCellRenderer

• com.ebsolutions.uiapplication.ui.DefaultDoubleSaveManagerCellRenderer

• com.ebsolutions.uiapplication.ui.DefaultBooleanSaveManagerCellRenderer


8-212


Using the renderers provided will avoid concrete implementation constraints and can be completely customized. Note that every column cell rendering must then be subsequently redefined.

List of CATIA property types

Property name Property type

link_type Type

file_name String

former_file_name String

document_type String

modifiable_item Integer

modifiable_revision Integer

modifiable_dataset Integer

modifiable_bvr Integer

co_status Integer

catia_status Integer


8-213


Property name Property type

save_mode Integer

status Integer

Extending the classes located in the com.ebsolutions.uimanager.modules package may cause graphics problems if every column is not redefined. The existing renderers will fail to find icons when using the super.getTableCellRendererComponent(...) method.

These two renderers also redefine the color of the error lines to blue. The createDefaultTable() method redefinition changes the font of the table header.

A module handler can be redefined with the addition of xml tags to change the table display. For example, a module handler can be created to retrieve a tableHeaderSize attribute, pass it to the module and apply it to the table header in the createDefaultTable() method.

The sample can be found within the savemanager-savetable-sample1.xml file in the TcIC_DIR\custom_client\SaveManager folder. The screenshot below is the result of the Save Manager interface using this module and save table implementation:


8-214


Save Manager API Java Documentation

The Save Manager API Java Documentation is divided into two sections. Refer to the online documentation for access to these files.

File Description

.uimanager package (

The Cat2uimanager.jar file under %TCICV5_DIR%\racless is the package distribution that contains all the necessary classes used to implement your own objects. Use the com.ebsolutions.uiapplication package to create a new Save Manager interface, with specific, customized behavior. The Teamcenter implementation of the Save Manager contains complete data management and data representations redefined in the .jar file (in the InterfaceCATIASession and InterfaceCATIAcomponent interfaces) to fit Teamcenter metadata requirements. The implementation also drives the Save Manager data with the Teamcenter Server to synchronize visuals and metadata. Use the com.ebsolutions.uimanager package in your project for Teamcenter specific customizations, rather than creating a new implementation. This package contains implementations to manipulate Teamcenter data, and should be used as a source, rather than implementing a complete, new specific implementation. Refer to the packages section for descriptions.

.uiapplication package

Integration Entry Points User Exit Class

8-215


User Exit Class

Entry Point Before Local Save CATIA Settings Access Load Entry Point Save Entry Point

Entry Point Before Local Save

Overview Customize Using CAA APIs Customize Using CATScript Modify CATIA Documents

Overview

The CV5ICAAEntryPoints::entryPointBeforeLocalSave function is called before saving CATIA documents in the staging directory during Save processes. The following CATIA documents are affected by this entry point:

• CATProduct

• CATPart

• CATDrawing

• CATAnalysis

• CATProcess

• CATShape

The CV5ICAAEntryPoints::entryPointBeforeLocalSave function can be customized using CATScript with %TCICV5_DIR%/custom_CATScript/EntryPointBeforeLocalSave.CATScript or CAA APIs, by re-implementing the CV5ECAAEntryPoints::entryPointBeforeLocalSave.

Customize Using CAA APIs

Perform the following steps to customize the CV5ICAAEntryPoints::entryPointBeforeLocalSave function using CAA APIs. The source code has been provided in the %TCICV5_DIR%/custom_CAA/EntryPoints folder.

Refer to the Modify CATIA Documents to modify CATIA documents in the entryPointBeforeLocalSave function.


8-216


1. Modify the implementation of the entryPointBeforeLocalSave of the CV5ECAAEntryPoints class function. This class is an implementation of the CV5ICAAEntryPoints interface.

The source code of the entryPointBeforeLocalSave function has been provided in the %TCICV5_DIR%/ custom_CAA/EntryPoints/CV5CAAEntryPoints/CV5CAAEntryPointsImpl.m/src/CV5ECAAEntryPoints.cpp folder. This function contains two CATUnicodeString parameters:

• i_catia_doc_name (I) : storage name of the document in the CATIA session before save (full file name with path).

• i_new_file_name (I) : new document full file name after save in staging directory.

Refer to the example below which prints the i_catia_doc_name and i_new_file_name in the standard output.

2. Execute %TCICV5_DIR%/custom_CAA/EntryPoints/Custom_CAA_EntryPoints_compilation.vbs


8-217


(Windows) or $TCICV5_DIR/ custom_CAA/EntryPoints/Custom_CAA_EntryPoints_compilation (UNIX) to compile the CV5CAAEntryPoints framework. CAA libraries are created for the CV5CAAEntryPointsInterfaces.m and CV5CAAEntryPointsImpl.m modules. When CAA compilation finishes, old CAA libraries for the CV5CAAEntryPointsInterfaces.m and CV5CAAEntryPointsImpl.m modules are automatically updated in %TCICV5_DIR%/bin/CAA/{CATIA_release}/{OS}, where {CATIA_release} is V5R18, V5R19 or V5R20 and {OS} is intel_a (Windows 32-bit), win_b64 (Windows 64-bit), solaris_a (Solaris) or aix_a (AIX).

Customize Using CATScript

Perform the following steps to customize the CV5ICAAEntryPoints::entryPointBeforeLocalSave function using CATScript.

Refer to Modify CATIA Documents to modify CATIA documents in the CATMain procedure.

3. Create a file named EntryPointBeforeLocalSave.CATScript in the %TCICV5_DIR%/custom_CATScript folder.

4. Create a procedure within the EntryPointBeforeLocalSave.CATScript file, named CATMain with two parameters of type CATBSTR:

• i_catia_doc_name (I): storage name of the document in the CATIA session before save (full file name with path)

• i_new_file_name (I): new document full file name after save in staging directory

The example below prints the i_catia_doc_name and i_new_file_name in the standard output.

Modify CATIA Documents

Perform the following steps to modify CATIA documents.

1. Ensure the document to modify is opened in a CATIA session (it is visible in the CATIA Save Management panel). Perform the sub-steps if it is not:


8-218


a. Open the document in a CATIA session before modifying it.

b. Save the document with the new full filename provided as a parameter of the CV5ICAAEntryPoints::entryPointBeforeLocalSave function if CAA APIs are used or of the CATMain procedure if CATScript is used.

c. Close the document.

2. Add modifications as needed. It is not necessary to save the document, it will be saved by the Integration.

CATIA Settings Access

Example

You must be in a SWT Display Thread to interact with the Teamcenter user interface such as, get the selected context (selected BOMLine) in Teamcenter, before an entry point can be customized.

Use the single java class, CatiaOptionsParser, to access CATIA settings. The javadoc of this class can be found within {install directory}\custom_client\EntryPoints\javadoc and is defined within the com.ebsolutions.catiman.utility package.

This singleton class provides the capability to access several CATIA setting values managed by the Integration:

Setting Description

Setting 1 (logical) CATIA cache activation status

Setting 2 (logical) CATIA cache timestamp activation status


8-219


Setting Description

Setting 3 (logical) CATIA cache GMT timestamp activation status

Setting 4 (single path) CATIA local cache path

Setting 5 (list of paths) CATIA release cache paths

Perform the following steps.

1. Call two methods:

a. get_instance(): Provides the unique instance of the CatiaOptionsParser. The CATIA settings can only be accessed using this method. They cannot be accessed by the CatiaOptionsParser constructor.

b. readCatiaOptionsFile() : Sets several CATIA setting values.

2. Use accessors to retrieve CATIA settings:

• get_catia_cache_is_enabled(): Accessor to the CATIA cache activation status

• get_timestamp_is_enabled(): Accessor to the CATIA timestamp activation status

• get_gmt_timestamp_is_enabled(): Accessor to t e CATIA GMT timestamp activation status

• get_catia_release_cache_paths(): Accessor to the CATIA local cache directory

• get_catia_local_cache_paths(): Accessor to the CATIA release cache directories.

3. Additional functions:

• get_last_error(): Provides access to the last error occurring during a process. For instance, the error message that occurs when the Integration is unable to read CATIA settings

• displaySettings() : Displays the CATIA settings managed by the Integration.


8-220


Example

Example of a function using the CatiaOptionsParser.


8-221


Method Summary

Load Entry Point

userExitAfterAllExportedFiles Function userExitAtEndOfLoadProcesses Function CATIA Side

You must be in a EDT (Event Display Thread) to interact with the Teamcenter user interface such as, get the selected context (selected BOMLine) in Teamcenter, before an entry point can be customized.

The Import/Export process can be extended by other extension points using the com.ebsolutions.catiman.extensions extension.

Create an extension point with a class which implements the ICatiaUserExit interface. This interface provides entry points in Teamcenter.

The following functions are public members of the ICatiaUserExit interface.

• userExitAfterAllExportedFiles function

• userExitAtEndOfLoadProcesses function

This interface can have several implementations. Each implementation is automatically called when defined in tcic_extensions.xml file

Implement the userExitAfterAllExportedFiles or userExitAtEndOfLoadProcesses method to define your own behavior. Refer to the User Interface Implementation: Main Classes section for details on extension point implementations, if necessary.

8-222


The userExitAfterAllExportedFiles Function

Launching a process on Load can only be performed if the document has been exported. To launch a process when the document has been exported, use the entry point method userExitAfterAllExportedFiles in the user's ICatiaUserExit class.

This method is called during every load process:

• after the export of all the files from the database.

• after the creation of the .dat files.

• after the update of the files modification date

• after calling the userExitAfterAllExportedFiles(Vector files_list) entry point.

The prototype of the function is:

• userExitAfterAllExportedFiles(Vector files_list) The input is a string vector compound containing the names of the exported files.

• userExitAfterAllExportedFiles(Connection i_connection, Vector<string> i_file_name_list, Vector<string> i_item_id_list, Vector<string> i_item_rev_list, Vector<string> i_dataset_uid_list)

All vectors are string vector compounds containing exported file information.

• i_connection (I): current TC session

• i_file_name_list (I): Vector contains a list of exported file names in catuii

• i_item_id_list (I): Vector contains a list of exported Item IDs in catuii

• i_item_rev_list (I): Vector contains a list of exported Item Rev in catuii

• i_dataset_uid_list (I): Vector contains a list of exported Dataset UID in catuii

The userExitAtEndOfLoadProcesses Function

Launching a process on Load can be performed even if the document has not been exported. To launch a process when the document has not been exported, use the entry point method userExitAtEndOfLoadProcesses in the user's ICatiaUserExit class.

This method is called during every load process:

• after the export of all the files from the database.

• after the creation of the .dat files.

• after the update of the files modification date.

• after the transmission of the desc file.


8-223


The prototype of the function is userExitAtEndOfLoadProcesses(). Parameters are not required.

CATIA Side

An entry point exists on the CATIA side after the Load process. The EntryPoints.CATScript CATScript must exist in the $TCICV5_DIR/custom_CATScript folder to be activated after the Load process.

If the CATScript does not exist in the correct folder or does not contain the entryPointAfterLoadProcesses() function, the Load process functions as usual. If the CATScript exists in the correct folder and contains the entryPointAfterLoadProcesses() function, the entryPointAfterLoadProcesses launches after the Load process in CATIA.

The CATScript must contain a Sub CATMain() instruction

Sub entryPointAfterLoadProcesses() MsgBox "hello world" End Sub

Processes impacted by this entry point are:

• Browse MML

• Export

• Load.CATScript

• Load_merge.CATScript

• Load_merge_Target

• Load_merge_SelectedLevel

• Refresh

• Read_linked_documents


8-224


Save Entry Point

CATIA Side Before/After Save Entry Point Teamcenter Side/After Save Entry Point

You must be in a EDT (Event Display Thread) to interact with the Teamcenter user interface such as, get the selected context (selected BOMLine) in Teamcenter, before an entry point can be customized.

Use Save Entry/User Exit Points to retrieve a list of saved files in order to apply a post action in CATIA.

These points are managed after the Save process on the Teamcenter Client side and after the Save process on the CATIA side. In addition, an Entry Point/User Exit point can also be managed before the Save process is started in CATIA.

API Limitation: In some cases, body names in the log do not match the body names defined in CAD. This is an expected limitation because the API returns the real name of the body.

CATIA Side

Two entry points exist on the CATIA side; one before the Save process and one after the Save process. Processes impacted by these entry points are:

• Save


8-225


• Save As

• Save Selected

• Import

• Load, Update, Save/Background Round-Robin

CATIA Side: Before Save Entry Point

The EntryPointBeforeSaveProcesses.CATScript CATScript must exist in the $TCICV5_DIR/custom_CATScript folder to activate before the Save process.

The CATScript must contain a Sub CATMain(). If this CATScript does not exist in the correct folder or does not contain a CATMain() function, the Save processes will function as normal. If this CATScript exists in the correct folder and contains the CATMain() function, the CATMain function executes before the Save process in CATIA.

CATIA Side: After Save Entry Point

The EntryPointAfterSaveProcesses.CATScript CATScript must exist in the $TCICV5_DIR/custom_CATScript folder to activate after the Save process.

The CATScript must contain a Sub CATMain(). If this CATScript does not exist in the correct folder or does not contain a CATMain() function, the Save processes will function as normal. If this CATScript exists in the correct folder and contains the CATMain() function, the CATMain function executes after the Save process in CATIA, even if errors occur during the Save process.

Teamcenter Side/After Save Entry Point

The client entry point, userExitAfterAllImportedFiles, is called at the end of each Save process in the user's TClassCatiaUserExit ICatiaUserExit class.

• Save

• Save As

• Save Selected

8-226


• Import

• Load, Update, Save/Background Round-Robin

The prototype of this function is:

• userExitAfterAllImportedFiles (Connection i_connection, Vector<string> i_file_name_list, Vector<string> i_item_id_list, Vector<string> i_item_rev_list, Vector<string> i_dataset_uid_list)

• i_connection (I): current Teamcenter Session

• i_file_name_list (I): Vector contains a list of exported file names in catuii

• i_item_id_list (I): Vector contains a list of exported item ID's in catuii

• i_item_rev_list (I) : Vector contains a list of exported item revisions in catuii

• i_dataset_uid_list (I): Vector contains a list of exported dataset UID in catuii

Only files saved to Teamcenter are listed.

This interface can have several implementations. Each implementation is automatically called when defined in tcic_extensions.xml file. Refer to the User Interface Implementation: Main Classes section for details on extension point implementations, if necessary.

This entry point gives access to geometrical data during the Save process when the CATIA_computeGeometry_option is set to true:

• DataModelManager class provides an access to the GeometricData.

• getInstance():DataModelManager (Singleton)

• getGeometricData():HashMap<String, IGeometricData>

• hasGeometricData():boolean

• Interface IGeometricData : contains Part and Bodies data

• getPartNumber(): String

• getPartMassData(): IMassData

• getAllBodiesMassData(): HashMap<String, IMassData>. The HashMap's key corresponds to the body's name

• Interface IMassData contains Material and Mass data

• isMainBody(): boolean

• getMaterial():String

8-227


• hasMaterial(): boolean = true if a material is set

• getMass(): double. The mass of the product g (gram)

• getDensity(): double. The density of the product g/mm3 (gram per cubic millimeter)

• getCOGPosition():double[3]. Position of the center of gravity with respect to the product axis system mm (millimeter).

• hasCOGPosition(): boolean = true if the position of the center of gravity is calculated.

• getInertiaMoment():double[3]. Moment of inertia [Ixx, Iyy, Izz] gmm2 (square gram millimeter).

• hasInertiaMoment(): boolean = true if a moment of inertia is calculated

• getInertiaProduct():double[3]. Product of inertia [Iyz, Ixz, Ixy] gmm2 (square gram millimeter).

• hasInertiaProduct(): boolean = true if a moment of inertia is calculated

• getInertiaVolume():double. Get inertia volume of a product mm3 (cubic millimeter)

• getInertiaArea():double. Get inertia area of a product (wet area) mm2 (square millimeter)

Sample code implementation

CatiaUserExitImpl.java

package com; import java.io.IOException; import java.util.Arrays; import java.util.HashMap; import java.util.Iterator; import java.util.Set; import java.util.Vector; import com.ebsolutions.soacore.extensions.ICatiaUserExit; import com.ebsolutions.soacore.extensions.datamodel.DataModelManager; import com.ebsolutions.soacore.extensions.datamodel.IGeometricData; import com.ebsolutions.soacore.extensions.datamodel.IMassData; import com.teamcenter.soa.client.Connection; public class CatiaUserExitImpl implements ICatiaUserExit { @Override public void userExitAfterAllExportedFiles(Vector<String> arg0) throws IOException { // TODO Auto-generated method stub } @Override public int userExitAfterAllExportedFiles(Connection arg0, Vector<String> arg1, Vector<String> arg2, Vector<String> arg3, Vector<String> arg4)

8-228


{ // TODO Auto-generated method stub return 0; } @Override public int userExitAfterAllImportedFiles(Connection i_connection, Vector<String> i_file_name_list, Vector<String> i_item_id_list, Vector<String> i_item_rev_list, Vector<String> i_dataset_uid_list) { try { System.out.println("Call " + CatiaUserExitImpl.class.getName() + ".userExitAfterAllImportedFiles()"); if (DataModelManager.getInstance().hasGeometricData() == false) { System.out.println("DataModelManager has not GeometricData"); } else { HashMap<String, IGeometricData> geometric_data = DataModelManager.getInstance().getGeometricData(); if (geometric_data == null) { System.out.println("Error: getGeometricData() returns NULL"); return 0; } Set<String> keys = geometric_data.keySet(); Iterator<String> it = keys.iterator(); while (it.hasNext()) { String key = it.next(); // key is a filename IGeometricData data = geometric_data.get(key); System.out.println(System.lineSeparator()); System.out.println("IGeometricData for [" + key + "]"); System.out.println("PartNumber=" + data.getPartNumber()); IMassData part_mass = data.getPartMassData(); if (null != part_mass) { System.out.println("\t - Part Material=" + part_mass.getMaterial()); System.out.println("\t - Part Density=" + part_mass.getDensity()); System.out.println("\t - part Mass=" + part_mass.getMass()); System.out.println("\t - part Inertia Volume=" + part_mass.getInertiaVolume());

8-229


System.out.println("\t - part Inertia Area=" + part_mass.getInertiaArea()); System.out.println("\t - part COG Position[x,y,z]=" + Arrays.toString(part_mass.getCOGPosition())); System.out.println("\t - part Inertia Moment[xx,yy,zz]=" + Arrays.toString(part_mass.getInertiaMoment())); System.out.println("\t - part Inertia Product[zy,zx,xy]=" + Arrays.toString(part_mass.getInertiaProduct())); } HashMap<String, IMassData> bodies_data = data.getAllBodiesMassData(); Set<String> bodies_keys = bodies_data.keySet(); Iterator<String> it_bodies = bodies_keys.iterator(); while (it_bodies.hasNext()) { String body_key = it_bodies.next(); System.out.println("IGeometricData for body [" + body_key + "]"); IMassData data_body = bodies_data.get(body_key); System.out.println("\t - Body Material=" + data_body.getMaterial()); System.out.println("\t - Body Density=" + data_body.getDensity()); System.out.println("\t - Body Mass=" + data_body.getMass()); System.out.println("\t - Body Inertia Volume=" + data_body.getInertiaVolume()); System.out.println("\t - Body Inertia Area=" + data_body.getInertiaArea()); System.out.println("\t - Body COG Position[x,y,z]=" + Arrays.toString(data_body.getCOGPosition())); System.out.println("\t - Body Inertia Moment[xx,yy,zz]=" + Arrays.toString(data_body.getInertiaMoment())); System.out.println("\t - Body Inertia Product[zy,zx,xy]=" + Arrays.toString(data_body.getInertiaProduct())); } } } } catch(Exception e) { e.printStackTrace(); } return 0; } @Override


8-230


public void userExitAtEndOfLoadProcesses() throws IOException { // TODO Auto-generated method stub } @Override public void userExitModifyDesc(String arg0) { } }

The Preferences .xls File and Configuring the Interface

9-1


The Preferences .xls File and Chapter 9:Configuring the Interface

Configuring the Interface The Configuration Directory, Folders and Files

A complete list of preferences is available in .xls format. Use this file as a quick reference to search and sort for specific preferences.

Please note the .xls file contains basic information such as name and default values, and should only be used as a quick reference. Refer to the documentation for detailed definitions and specific behavior.


The Preferences .xls File and Configuring the Interface Configuring the Interface

9-2


Configuring the Interface

There are two different ways to customize and modify the behavior of the interface:

• Teamcenter Preferences

• tcic_var_env.xml file


Pick Edit >> Options..., then pick Index on the Options dialog window to customize all Teamcenter Preferences.

Customize the tcic_var_env.xml File

The default variables in tcic_var_env.xml (in the %TCICV5_DIR%/env/ directory) are:

If these variables are modified, restart Teamcenter to apply the new values.

Name Default value Purpose

TcIC_assyconfig_menu false

Display Save Assembly Configuration command in the CATIA menu in Teamcenter, in the contextual menu of a selected BOM Line in the Teamcenter Loader and in the Load Manager (true). Display the Activate Terminal Node command in the CATIA toolbar. (true)


9-3



TcIC_awhosted_menu false

Display (true) or hide (false) the TcIC menu when Embedded Active Workspace installation is defined.

TcIC_config_dir %USERPROFILE% (WIN) $HOME (Unix)

TcIC filepath for configuration files.

TcIC_dr1_license false

Support TcIC functionalities (true) when a DR1 license is used.

TcIC_export_dir %WORK_DIR%\Export (WIN) $WORK_DIR/Export (UNIX)

Used only by CATIA

Export filepath

TcIC_export_spreadsheet_path

%WORK_DIR%\Export\ExpSpreadSheet.txt (WIN) $WORK_DIR/Export/ExpSpreadSheet.txt (UNIX)

SpreadSheet file path for EXPORT process

TcIC_files_dir %WORK_DIR%\catuii (WIN) $WORK_DIR/catuii (UNIX)

Directory where product, part, drawing and model files are stored

TcIC_import_data_path %WORK_DIR%\Import\Data.txt (WIN) $WORK_DIR/Import/Data.txt (UNIX)

Used only by CATIA

Data filepath


9-4



TcIC_import_dir %WORK_DIR%\Import (WIN) $WORK_DIR/Import (UNIX)

Used only by CATIA

Import filepath

TcIC_import_spreadsheet_path

%WORK_DIR%\Import\ImpSpreadSheet.txt (WIN) $WORK_DIR/Import/ImpSpreadSheet.txt (UNIX)

Spreadsheet file path for IMPORT process

TcIC_plmvis_license Base

PLM Vis license used when displaying the Teamcenter Loader's JT Viewer. Possible values are Base, Standard, Pro and Mockup NOTE: Teamcenter Integration for CATIA officially only supports Base license.

TcIC_rac_socket_port 11401

TCP port number used for the interface communication between RAC and RACLess.

TcIC_socket_port 11400

TCP port number for the interface communication and the progress indicator.


9-5



TcIC_tmp_dir %WORK_DIR%\tmp (WIN) $WORK_DIR/tmp (UNIX)

Directory where temporary communication files are stored

TcIC_web_server_port 3000

TCP port number used for the Active Workspace web server

Refer to Configuration Directory, Files and Folder for more information on TcIC_config_dir.

The Preferences .xls File and Configuring the Interface The Configuration Directory, Folder and Files

9-6


The Configuration Directory, Folder and Files

File Names and Descriptions Location and Naming Convention

File Names and Descriptions

Configuration files used to manage processes and components are stored within TcIC_config_dir. Refer to the table below for their names and descriptions.

Name Type Description

If the configuration files cannot

be created or read...

bbml_user.properties text Stores information related to the Browse Multi-model Links browser panel.

---

datasetbrowser_<checksum>.xml .xml

Stores information related to dataset browser customizations. <checksum> is the checksum of:<TCICV5_DIR>\ env\ datasetbrowser.xml

a warning displays

itemrevbrowser_<checksum>.xml .xml

Stores information related to item revision browser customizations. <checksum> is the checksum of: <TCICV5_DIR>\ env\ itemrevbrowser.xml

a warning displays

progressbar text

Contains the progress panel position. The settings from this file are read at process start and written to disk when the progress bar closes. If the configuration file cannot be read or created, the default position (top-left corner) will be used without warning or notifications.

there is no warning or notification and the progress bar displays in the default position (upper left corner).

9-7


Name Type Description

If the configuration files cannot

be created or read...

replacebyrevisionpanel_<checksum>.xml .xml

Stores information related to replace by revision panel customizations.<checksum> is the checksum of: <TCICV5_DIR>\env\ replacebyrevisionpanel.xml

a warning displays

savemanager<checksum>.xml .xml

Stores information related to Save Manager panel customizations. <checksum> is the checksum of: <TCICV5_DIR>\ env\ savemanager.xml

a warning displays

sprdshteditor_<checksum>.xml .xml

Stores information related to Spreadsheet Editor panel customizations. <checksum> is the checksum of: <TCICV5_DIR>\ env\ sprdshteditor.xml

a warning displays

statedetails_<checksum>.xml .xml

Stores information related to State Details panel customizations. <checksum> is the checksum of: <TCICV5_DIR>\ env\ statedetails.xml

a warning displays

tcicloader_<checksum>.xml .xml

Stores information related to Integration Loader panel customizations. <checksum> is the checksum of: <TCICV5_DIR>\ env\ tcicloader.xml

there is no warning or notification and the TcIC Loader displays with the default appearance.

9-8


Location and Naming Convention

The location of the configuration folder is set using the value of TcIC_config_dir , defined in the tcic_var_env.xml file.

The configuration folder is created in <TcIC_config_dir > + file separator + .TcIC, based on the following rules:

• The name of the configuration folder is built using the value of the TCICV5_DIR environment variable

• File separators (/ and \) are replaced by underscores ( _ ).’

• The colon (:) is replaced by a dash (-).

For example:

On Windows: If TCICV5_DIR = C:\TcIC, then the directory name is C-_TcIC and the complete path is <TcIC_config_dir >\.TcIC \C-_TcIC.

On UNIX: If TCICV5_DIR = /tmp/TcIC, then the directory name is _tmp_TcIC and the complete path is <TcIC_config_dir >/.TcIC /_tmp_TcIC.

Directories and Filepaths, Environment Variables and Parameter Definitions Table

10-1


Directories and Filepaths, Chapter 10:Environment Variables and Parameter Definitions Table

Directories and Filepaths Parameter Definitions Table System and User Environment Variables

Directories and Filepaths

The default variables in tcic_var_env.xml (in the %TCICV5_DIR%/env/ directory) are:

If these variables are modified, restart Teamcenter to apply the new values.


TcIC_assyconfig_menu false

Display Save Assembly Configuration command in the CATIA menu in Teamcenter, in the contextual menu of a selected BOM Line in the Teamcenter Loader and in the Load Manager (true). Display the Activate Terminal Node command in the CATIA toolbar. (true)

Directories and Filepaths, Environment Variables and Parameter Definitions Table Directories and Filepaths

10-2



TcIC_awhosted_menu false

Display (true) or hide (false) the TcIC menu when Embedded Active Workspace installation is defined.

TcIC_config_dir %USERPROFILE% (WIN) $HOME (Unix)

TcIC filepath for configuration files.

TcIC_dr1_license false

Support TcIC functionalities (true) when a DR1 license is used.

TcIC_export_dir %WORK_DIR%\Export (WIN) $WORK_DIR/Export (UNIX)

Used only by CATIA

Export filepath

TcIC_export_spreadsheet_path

%WORK_DIR%\Export\ExpSpreadSheet.txt (WIN) $WORK_DIR/Export/ExpSpreadSheet.txt (UNIX)

SpreadSheet file path for EXPORT process

TcIC_files_dir %WORK_DIR%\catuii (WIN) $WORK_DIR/catuii (UNIX)

Directory where product, part, drawing and model files are stored

TcIC_import_data_path %WORK_DIR%\Import\Data.txt (WIN) $WORK_DIR/Import/Data.txt (UNIX)

Used only by CATIA

Data filepath

Directories and Filepaths, Environment Variables and Parameter Definitions Table Directories and Filepaths

10-3



TcIC_import_dir %WORK_DIR%\Import (WIN) $WORK_DIR/Import (UNIX)

Used only by CATIA

Import filepath

TcIC_import_spreadsheet_path

%WORK_DIR%\Import\ImpSpreadSheet.txt (WIN) $WORK_DIR/Import/ImpSpreadSheet.txt (UNIX)

Spreadsheet file path for IMPORT process

TcIC_plmvis_license Base

PLM Vis license used when displaying the Teamcenter Loader's JT Viewer. Possible values are Base, Standard, Pro and Mockup NOTE: Teamcenter Integration for CATIA officially only supports Base license.

TcIC_rac_socket_port 11401

TCP port number used for the interface communication between RAC and RACLess.

TcIC_socket_port 11400

TCP port number for the interface communication and the progress indicator.

Directories and Filepaths, Environment Variables and Parameter Definitions Table Parameter Definitions Table

10-4



TcIC_tmp_dir %WORK_DIR%\tmp (WIN) $WORK_DIR/tmp (UNIX)

Directory where temporary communication files are stored

TcIC_web_server_port 3000

TCP port number used for the Active Workspace web server

Parameter Definitions Table

The paths are case-sensitive.

Parameter Type Default Value Description

CAA_Binaries_Unix_Location STRING /CAA_Binaries

UNIX CAA location. Folder structure: CAA_Binaries_Win_Location/<OS>/Caa/V5Rxx (<OS> is SunOS, AIX or HP-UX, xx is the version of CATIA V5)


10-5



CAA_Binaries_Win_Location STRING C:\CAA_Binaries

Windows CAA location. Folder structure: CAA_Binaries_Win_Location/Win32/Caa/V5RXX (XX is the CATIA V5 release number). The same source directory, \Win32, is used for both 32 and 64-bit deployments. Differences between 32 and 64-bit are made at the \V5RXX folder level. The expected structure is shown below; \intel_a contains the 32-bit compiled CAA and \win_b64 contains the 64-bit compiled CAA.

CATEnv_Name STRING Teamcenter_Integration_for_CATIAV5

CATEnv name to be used by Teamcenter Integration for CATIA V5. Indicate No CATEnv Creation if an existing CATEnv will be used.

CATIA_Env_Creation STRING Create CATEnv Create CATEnv generates the CATIA environment named ${CATEnv_Name}

CatiaV5_Env_Unix_location STRING /CATEnv CATEnv location on UNIX client machines. This value must be the same across all UNIX client machines.

CatiaV5_Env_Win_location STRING

C:\Documents and Settings\All Users\Application Data\DassaultSystemes\CATEnv

CATEnv location on Windows client machines. This value must be the same across all Windows client machines.


10-6



catiaV5_integration_TmpDir_Unix_location STRING

/tmp/catiav5_integration_tmp_${LOGNAME}

Location of the Teamcenter Integration for CATIA V5 temporary files on UNIX client machines WORK_DIR. This value must be the same across all UNIX client machines.

catiaV5_integration_TmpDir_Win_location STRING %TEMP%\catiav5

_integration_tmp

Location of the Teamcenter Integration for CATIA V5 temporary files on Windows client machines WORK_DIR. This value must be the same across all Windows client machines.

CatiaV5_Unix_location STRING /opt/DassaultSystemes/B18

CATIA V5 location on UNIX client machines. This value must be the same across all UNIX client machines.

CatiaV5_Unix_Version INT 18 CATIA V5 version on UNIX client machines. It must be the same version across all UNIX client machines.

CatiaV5_Win_location STRING C:\Program Files\Dassault Systemes\B18

CATIA V5 location on Windows client machines. This value must be the same across all Windows client machines.

CatiaV5_Win_Platform STRING 32 bits Defines if CATIA V5 is 32 or 64 bits. This value must be the same across all Windows client machines.

CatiaV5_Win_Version INT 18 CATIA V5 version on Windows client machines. It must be the same version across all Windows client machines.

Tc_Version STRING --- Teamcenter version number

10-7



TcIC_Documentation_Location_UNIX STRING <empty> Location of the user documentation on

UNIX.

TcIC_Documentation_Location_Windows STRING <empty> Location of the user documentation on

Windows.

TcIC_Reference_UNIX_Location STRING $WORK_DIR/refe

rence

Location of the Teamcenter Integration for CATIA V5 reference files on UNIX client machines.

TcIC_Reference_Win_Location STRING %WORK_DIR%\reference

Location of the Teamcenter Integration for CATIA V5 reference files on Windows client machines.

Directories and Filepaths, Environment Variables and Parameter Definitions Table System and User Environment Variables

10-8


System and User Environment Variables

Change system and user environment variables to modify the behavior of the interface. By default the system environment variables are:

Name Type Default value on Windows Purpose

PURGE_MSG STRING both Controls the Purge dialog box

TC_PORTAL_ROOT STRING C:\Tc_Version\portal Teamcenter Rich client directory

TC_ROOT STRING C:\Tc_Version Teamcenter server directory

TCICV5_DIR STRING C:\TCIC_V5 Teamcenter Integration for CATIA V5 installation location

WORK_DIR STRING C:\TCIC_V5_tmp Teamcenter Integration for CATIA V5 temporary files location

Installation Troubleshooting 11-1


Installation Troubleshooting Chapter 11:Error Logs and Preferences Translation Services

Error Logs and Preferences

Activate the Client Log File Activate the Server Log File Display a Warning Message During the Save Process Enable Tracing Events Teamcenter Logs

A log file is created during the installation process and for each process launched if problems occur. Check the log files in the final panel of the installer for additional information.

Information contained in the log file includes warning messages, notifications of issues that may have occurred when attempting to obtain information, and critical error messages indicating possible data corruption.

CATScript and CAA traces are gathered in the same journal file. The journal file is enabled by the CATIA_journal_catia preference.

Installation Troubleshooting Error Logs and Preferences

11-2


Activate the Client Log File


Use the CATIA_journal_client Teamcenter Preference to enable the client journaling option. The default value is NO.

Value Result

YES Enable high-level tracing. Detailed journaling traces are written to a .syslog file and an .xml file. Tracing includes function calls, errors, comments, return values, etc.

NO (default traces)

Enable low-level tracing such as hardware configuration and library versions. Error traces are written to a .syslog file.

Individual files named *_client_"userid"_"randomize number".* are created for each user. A syslog and xml file are created in the %TEMP% folder when the server is running on Windows, and in the /tmp folder on all other operating systems.


11-3


Activate the Server Log File


Use the CATIA_journal_server Teamcenter Preference to enable the server journaling option, based on three levels. The default value is NO.

Value Result

YES Enable high-level tracing. Detailed journaling traces are written to a .syslog file and an .xml file. Tracing includes function calls, errors, comments, return values, etc.

NO (default traces)

Enable low-level tracing such as hardware configuration and library versions. Error traces are written to a .syslog file.

SYSLOG Export all high-level traces to the original Teamcenter Syslog.

Individual files named tcic_server_"userid"_"randomize number"_"command".* are created for each user in the %TEMP% folder on Windows, and in the /tmp folder on all other operating systems.

The tcic_server_*.xml file is readable, but only available to the Developer. Contact your Developer for access.

Display a Warning Message During the Save Processs

Set CATIA_display_warning_messages to true to display the warning message, There are less/more child components for MyComponent in CATIA than in Teamcenter, during the Save process. Set it to false to write the messages in the command log file.

CATIA_display_warning_messages = true


This preference corresponds to the previous com.ebsolutions.catia.displayWarningMessages property defined in the catiaV5properties.properties file, now obsolete.


11-4


Enable Tracing Events

Use the CATIA_journal_catia case-sensitive preference to enable CATScript and CAA tracing events such as macro executions, function calls and errors to be written to the journal file.

The CATIA_journal_catia:

• replaces the TMCJournal environment variable used in previous versions of the Integration

• corresponds to the previous com.ebsolutions.catia.writeTraceFile property defined in the catiaV5properties.properties file, now obsolete.

CATIA_journal_catia = YES

The default value is NO.

Value Result

YES Enable high-level tracing. Detailed journaling traces are written to the journal.syslog file and journal.xml file. Tracing includes function calls, errors, comments, return values, etc.

NO (default traces)

Enable low-level tracing such as hardware configuration and library versions. Error traces are written to a journal.syslog file.

Setting catia_journal_catia to YES instead of CATIA_journal_catia, causes only the .syslog file to be created; the CATIA_journal_catia preference takes its default value of NO.

Journal Name

The journal name is tcic_catia_[user]_[ random_number]_[command].*.

Journal files are located in the named repository for the environment variables; %TEMP% for Windows and $TMP for UNIX. By default, journal files are located in \\temp\\ for Windows and /tmp/ for UNIX, when the environment variables are not created. The catia_trace file, now obsolete, was located in WORK_DIR/tmp.

Installation Troubleshooting Translation Services

11-5


The journal_*.xml file is readable, but accessible only to the Developer. Contact your Developer for access.

Teamcenter Logs

Teamcenter log variables should be set as follows to ensure errors, warnings and other important information is captured:

• TC_JOURNAL = FULL

• TC_JOURNAL_LINE_LIMIT = 0

• TC_SQL_DEBUG = BJPT

Translation Services

Translation Request Did Not Complete Troubleshooting catiav5preview

Translation Request Did Not Complete

dcproxy must be granted access to write to necessary objects in the Access Manager tree. Granting write access is in addition to granting dcproxy write/delete access for DispatcherRequests objects.

Troubleshooting .catiav5preview

Refer to the Verification topic of Translation Services to verify successful deployment of .catiav5preview.

The thumbnail creator is only applicable to Windows platforms and CATIA must be installed on the same machine used to create the thumbnails.

The getmini.exe file exists on the Module component of the Dispatcher (in Module\Translators\ catiav5preview) after it has been deployed. It is recommended to test this executable file prior to using it through the translation service by executing getmini.exe full_path_of_a_CATPart_file_to_translate name_of_the_bmp_ouput_file. If successful, a .bmp file is created.

Execute getmini C:\test\TestPart.CATPart TestPartOutput.bmp

Uninstall Teamcenter Integration for CATIA V5 12-1


Uninstall Teamcenter Integration Chapter 12:for CATIA V5

Client Uninstallation Server Uninstallation Silent Mode

Removing the JVM, installed by default, causes the client uninstallation process to fail.

Uninstall Teamcenter Integration for CATIA V5 (Client)

Removing the JVM installed by default causes the client uninstallation process to fail. The uninstall process does not remove Integration plug-in files from Teamcenter's RAC. Before removing Integration plug-in files, manually sort the files within the portal\plugins directory by using the cat2 prefix. It is not necessary to remove the Cat2ebscomservice.jar file when Teamcenter Integration for CATIA V4 is also used because it is common to both Teamcenter Integration for CATIA V4 and Teamcenter Integration for CATIA V5.

Refer to the following steps to uninstall Teamcenter Integration for CATIA V5 when it has been installed on a Client.

1. Launch the Client uninstaller:

a. Windows: Double-click on Teamcenter Integration for CATIA V5 <version number> Client within the Add or Remove Programs panel.

b. All other installations: Use the <Integration Client location>/Uninstall/Uninstall-TCIC-Client command.

Uninstall Teamcenter Integration for CATIA V5 Uninstall Teamcenter Integration for CATIA V5 (Server)

12-2


2. Read the uninstallation message in the Uninstall window to ensure you are ready to proceed, then pick Uninstall to continue. Please wait a moment for the uninstallation process to begin.

3. Read the uninstallation successful message, then pick Done. Uninstallation is now complete.

Uninstall Teamcenter Integration for CATIA V5 (Server)

Refer to the following steps to uninstall Teamcenter Integration for CATIA V5 when it has been installed on a Server.

1. Launch the Server uninstaller:

a. Windows: Double-click Teamcenter Integration for CATIA V5 <version number> Server within the Add or Remove Programs panel.

b. All other installations: Use the <Teamcenter Server location>/Uninstall_TCIC_Server/Uninstall_TCIC_Server command.

2. Read the uninstallation message in the Uninstall window to ensure you are ready to proceed, then pick Uninstall to continue. Please wait a moment for the uninstallation process to begin.

3. Read the uninstallation successful message, then pick Done. Uninstallation is now complete.

Uninstall Teamcenter Integration for CATIA V5 (Silent Mode)

Launch the command line, %TCICV5_DIR%\Uninstall\Uninstall-TCIC-Client.exe –i silent to initiate the silent uninstaller.

Teamcenter Integration for CATIA V5 (11.0.6) Installation Guide

Documents

Transcript of Teamcenter Integration for CATIA V5 (11.0.6) Installation Guide