SIEMENS

Teamcenter 11.2

Preferences and
Environment
Variables Reference
PLM00026 • 11.2
Contents

Getting started with Teamcenter environment configuration . . . . . . . . . . . . . . . . . . . . . . 1-1

Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Following installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Prerequisites for working with preferences and environment variables . . . . . . . . . . . . . . . 1-1
Syntax definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Basic configuration concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Using environment variables and preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Configure Teamcenter before deploying to other sites . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Installation and upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Important configuration variables for your initial Teamcenter implementation . . . . . . . . . . . 1-3
Basic configuration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Before deploying Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Manually configure the Teamcenter environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Running environment variable script files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Managing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Getting familiar with preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
What are preferences? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Preference definition elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
System and hierarchical preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Managing protection scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Displaying preferences in the rich client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Managing the values of preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
Creating and editing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Editing preference XML files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Edit a preference XML file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
What if preference names change when imported? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Specify dual OS values for a single preference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10

Introduction to environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Introduction to environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Environment variable script files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Setting environment variables for logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Environment variables listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Teamcenter Rapid Start preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Configuration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Business Modeler IDE preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

PLM00026 11.2 Preferences and Environment Variables Reference 3

 Contents
Contents

Finding Business Modeler IDE preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Client interface preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
Data management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-26
Dispatcher preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-51
Email polling preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-129
Full-text search preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-132
Localization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-148
Mail gateway preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-155
NX Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-158
NX Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-158
Preferences set in the .tc_preferences.xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-158
Preferences set in the .tc_ugman_env file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-176
Preferences set in the ug_english.def file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-178
Preferences set in the .ugii_env file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-179
Password preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-180
About password preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-180
Product structure preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-183
Search and query preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-185
Teamcenter services preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-200
Solid Edge integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-201
Remote workflow preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-202
Teamcenter LDAP synchronization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-205
Teamcenter LDAP synchronization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-205
LDAP connection preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-206
Synchronization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-208
Group object mapping preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-212
Role object mapping preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-214
User and person object mapping preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-216
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-219

Administration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Attribute sharing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Authorization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Validation Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

File management and maintenance preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1

Audit Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
Archive, restore, and migration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-9
Action manager daemon preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-14
Subscription Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16
Subscription Monitor preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-19
File caching preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-28
Using file caching preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-28
Caching modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-28
syslog file output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-29
File caching preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-29

4 Preferences and Environment Variables Reference PLM00026 11.2

 Contents

Log file preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-42

Client preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1

Rich client preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
Thin client preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-117
General thin client preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-117
Thin client column and property preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-139
Thin client image preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-142
Thin client DesignContext preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-145
Thin client Teamcenter manufacturing process management preferences . . . . . . . . . . 12-146
Active Workspace preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-154

Workflow preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1

WRKFLW_modify_completed_workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-19

Change management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1

Change Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1

Issue Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1

Content Management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1

Reports, requirements, and scheduling preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1

Systems Engineering preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1

Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1

Schedule Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-23
Report Builder preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-64
Visual reporting preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-69

Classification Admin preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1

Classification preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-1

Data sharing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1

Multi-Site Collaboration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1
Role-based preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1

Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1

Data Exchange preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-69
PLM XML preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-85

Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1

STEP Translator preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-96

Product structure preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1

PLM00026 11.2 Preferences and Environment Variables Reference 5

 Contents
Contents

Modifying the behavior of Product structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1

DesignContext preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1
General RDV preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1
DesignContext product item preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-25
DesignContext product context preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-33
DesignContext context definition preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-41
DesignContext filter configuration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-48
DesignContext interoperability preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-51
DesignContext performance tuning preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-54
Using DesignContext composite properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-56
Multi-Structure Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-57
Structure Manager and Product Configurator preferences . . . . . . . . . . . . . . . . . . . . . . . . . 21-62
Behavior and configuration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-62
Structure Manager column preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-75
Structure Manager display preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-81
Assembly and Product Configurator preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-99
Transform preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-143
Product structure synchronization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-145
BOM grading preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-148
Platform Designer preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-152
Quick spatial search preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-160

Manufacturing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-1

General manufacturing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-1

Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-1

Display preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-30
In-process assembly preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-42
Custom Process View preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-44
In-context ID preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-48
Cloning preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-53
PERT chart preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-63
Accountability check preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-67
Manufacturing studies preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-79
Time management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-90
Logistics planning preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-103
Manufacturing documentation preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-105
Manufacturing search preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-117
Enterprise BOP preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-119
GANTT chart viewer preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-141
Manufacturing features preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-146
Standard text preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-155
Product and manufacturing information (PMI) preferences . . . . . . . . . . . . . . . . . . . . . . . 22-159
Process Simulate preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-161
Line balancing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-164
MES Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-182
Manufacturing 4D planning preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-197
PAD preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-199
Resource management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-201

6 Preferences and Environment Variables Reference PLM00026 11.2

 Contents

Part planning preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-206

Visualization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-1

Solution-specific preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-1

Aerospace and Defense preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-1
Materials Management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-7
Consumer Packaged Goods preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-12
Teamcenter mechatronics process management preferences . . . . . . . . . . . . . . . . . . . . . . 24-12
Vendor management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-46
MRO core preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-65
As-Built Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-77
Service Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-80
As-Maintained preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-80
Service event management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-86
Service Request Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-99
Service Scheduler preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-114
Substance Compliance preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-117
Specification Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-186

Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-1

NX Remote Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-1
Teamcenter Integration for AutoCAD preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-3
Configuring CAE preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-4
Teamcenter Integration for NX I-deas preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-34
Mentor Graphics Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-35
ERP Connect to SAP preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-37
ODBC Driver preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-42
ClearCase Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-44
Linked Data Framework preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-45
Behavior Modeling preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-46

EDA preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-1

Quality data preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-1

ADA License preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-1

4th Generation Design preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-1

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

PLM00026 11.2 Preferences and Environment Variables Reference 7

Chapter 1: Getting started with Teamcenter
environment configuration

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

Following installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Prerequisites for working with preferences and environment variables . . . . . . . . . . . . . . . 1-1
Syntax definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

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

Using environment variables and preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Configure Teamcenter before deploying to other sites . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Installation and upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Important configuration variables for your initial Teamcenter implementation . . . . . . . . . . . 1-3

Basic configuration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Before deploying Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Manually configure the Teamcenter environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Running environment variable script files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

PLM00026 11.2 Preferences and Environment Variables Reference

Chapter 1: Getting started with Teamcenter
environment configuration

Before you begin

Following installation
Teamcenter installation and basic configuration is performed with the Teamcenter Environment
Manager program. After Teamcenter is installed, additional configuration is required.
Completing a Teamcenter Environment Manager installation automatically enables the Teamcenter
environment.
For more information about installation considerations and installation procedures, see the installation
guides for the operating system on which you are running Teamcenter (UNIX and Linux Server
Installation, Linux Client Installation, Windows Server Installation, or Windows Client Installation).
It is also possible to manually configure the Teamcenter environment.
For more information, see Manually configure the Teamcenter environment.

Prerequisites for working with preferences and environment variables

This manual is intended for system administrators, data administrators, and Java developers who
configure the Teamcenter functionality using environment settings. A basic understanding of
object-oriented programming (OOP) and Teamcenter concepts is required.

Syntax definitions
This manual uses a set of conventions to define the syntax of Teamcenter preferences and
environment variables. Following is a sample syntax format:
PUBLISH_PDF_ERROR_LOG_LOC
This environment variable is used with Visualization Illustration. Defines a location for
the Convert/Print error log file different from the default location (c:\Documents and
Setting\user-name\Local Settings\Temp\VisProdlocation\VVCP_error.log).
This log file records all errors occurring during the PDF conversion process. Set this environment
variable with the full path name and file name. For example:
c:\MyFiles\Error.log

The conventions are:

Bold Bold text represents words and symbols you must enter exactly as shown.
In the preceding example, you enter c:\Documents and Setting\, \Local
Settings\Temp\VisProd and \VVCP_error.log exactly as shown.

PLM00026 11.2 Preferences and Environment Variables Reference 1-1

 Chapter
Chapter 1: 1: Getting
Getting started
started with Teamcenter
with Teamcenter environment
environment configuration
configuration

Italic Italic text represents values that you supply.

In the preceding example, you supply values for user-name and location.
Courier font This font, indented, indicates an example of a setting or command you can input.
In the preceding example, you could enter:
c:\MyFiles\Error.log

Basic configuration concepts

Using environment variables and preferences

Much of Teamcenter behavior and display can be configured with environment variables and
preferences.

• Environment variables are settings stored in the tc_profilevars properties file that allow you to
control many aspects of Teamcenter behavior. This script is run directly by Bourne and Korn
shells. C shells must use the tc_cshvars script.

Environment variables are run in script files to configure and control many aspects of Teamcenter.
By setting these variables for each site, Teamcenter can be quickly adapted and configured
to meet any site's needs. Many of these variables point to specific network nodes and/or
directories so that Teamcenter can be used in large and small homogeneous and heterogeneous
environments.

Note

Two environment variables must be set before running Teamcenter: TC_ROOT and
TC_DATA. Teamcenter does not run unless these environment variables are set. These
environment variables must be set through shell commands or a script.

For more information, see Introduction to environment variables.

• Preferences are special environment variables stored in the Teamcenter database and read
whenever a preference value is set or modified in the interface or in the tc_preferences.xml
preference file. Teamcenter offers thousands of preferences designed to configure the product to
your specific needs.

When a Teamcenter session is initiated, preferences are read from the Teamcenter database,
the TC_DATA\tc_preferences.xml file, and the TC_DATA\tc_solutions_preferences.xml
file. Preferences let administrators and users configure many aspects of a session, such as
Teamcenter mail interval checking check out directory. Preferences can apply to the entire site,
a specific user, or a role or group.

o Use preferences to determine user-specific behavior such as user logon names and the
columns displayed by default in a properties table. You can also set preferences for basic
system behavior such as business rules, workflow, application behavior, and security access.

1-2 Preferences and Environment Variables Reference PLM00026 11.2

 Getting started with Teamcenter environment configuration

o Set preferences individually in the Options dialog box accessed from the Edit menu in
the rich client. Update preferences using scripts or input batches of preferences in the
tc_preferences.xml preference file.

For more information, see What are preferences?.

Configure Teamcenter before deploying to other sites

Before you deploy Teamcenter, you should fully complete the configuration process.
Some configuration tasks, such as defining log files, are difficult to redefine once Teamcenter is
deployed.

Installation and upgrades

Teamcenter ships all preference data in the tc_preferences.xml file, stored in the TC_DATA
directory. Teamcenter reads most of the preference data from this directory. Any custom site
preferences created at your site are stored in the Teamcenter database.
During upgrades, the system runs the preferences_manager utility to remove the definitions and
values of any out-of-the-box preferences previously stored in the Teamcenter database.
Note

Previous to Teamcenter 2007, all preferences were stored in the Teamcenter database.
Out-of-the-box preferences are now stored in the TC_DATA directory. Only custom site
preferences are stored in the Teamcenter database.

You can also use the preferences_manager utility during upgrades to convert legacy preference files
to XML format and to import and export preferences to and from the database. This utility parses
the legacy site preference file to XML format.
For more information about this utility, see the Utilities Reference.

Important configuration variables for your initial Teamcenter implementation

Teamcenter offers a wide array of environment variables and preferences which you can use to modify
all aspects of the product. The scope of a preference determines the range of its effect across the
system (site preferences affect the entire site, user preferences affect only a particular user's settings).
To review preferences which should be considered and set before deploying Teamcenter, see
Configuration preferences.
To review preferences which affect the fundamental behavior of the rich client, see Rich client
preferences.

Basic configuration tasks

Before deploying Teamcenter
Teamcenter installation and basic configuration is performed with Teamcenter Environment Manager.
After Teamcenter is installed, additional configuration is required. Configuration tasks include

PLM00026 11.2 Preferences and Environment Variables Reference 1-3

 Chapter
Chapter 1: 1: Getting
Getting started
started with Teamcenter
with Teamcenter environment
environment configuration
configuration

systems-based tasks, such as user organization, file management, and data security. Additionally,
most Teamcenter applications can be configured to meet your site’s needs. Complete the following
basic configuration tasks before deploying Teamcenter at your site.

Manually configure the Teamcenter environment

Teamcenter administrators typically configure site workstations and computers so that users can log
on without manually setting the environment. If this has not been done by your administrator, you
must manually set the Teamcenter environment before you can run a session.
TC_ROOT and TC_DATA are the only environment variable settings required to run the core
Teamcenter application. These variables can be set automatically at logon. However, there
are several stand-alone utilities such as install and clearlocks that also require that the entire
Teamcenter environment be set.
If you are unsure whether to perform this procedure, consult your administrator for additional
information.
Note

The following procedures use default path names. If other path names were specified
during Teamcenter installation, use those path names instead. Consult your administrator
for additional information.

UNIX systems

Manually configuring the Teamcenter environment on UNIX systems requires sourcing the
tc_profilevars and tc_cshvars scripts. To manually set the Teamcenter environment, enter one
of the following sets of commands:
Bourne/Korn shell:
TC_ROOT=/usr/tc2007; export TC_ROOT
TC_DATA=/usr/tc2007/tcdata; export TC_DATA
. $TC_DATA/tc_profilevars

C shell:
setenv TC_ROOT /usr/tc2007
setenv TC_DATA /usr/tc2007/tcdata
source $TC_DATA/tc_cshvars

Sourcing the $TC_DATA/tc_cshvars file creates a csh subshell in which Teamcenter environment
variables are set.

Windows systems

Manually configuring the Teamcenter environment on Windows systems requires running the
tc_profilevars.bat script. This script is called automatically when exiting to an MS-DOS shell from
the Teamcenter menu, but the environment can also be set manually. To manually set the Teamcenter
environment, enter the following commands:
set TC_ROOT=c:\tc2007
set TC_DATA=c:\tc2007\tcdata
call %TC_DATA%\tc_profilevars

1-4 Preferences and Environment Variables Reference PLM00026 11.2

 Getting started with Teamcenter environment configuration

Note

This documentation consistently uses UNIX syntax, when referring to environment variable
names, providing command line examples, and so on). Windows users must make the
following modifications:
Variable UNIX environment variable names are often prefixed with the dollar sign ($);
names Windows environment variable names must be enclosed within two percent
signs (%) in similar circumstances. For example:
UNIX: $My_Environment_Variable

Windows: %My_Environment_Variable%

Path names UNIX path names use forward slashes (/) for subdirectories; Windows path
names use backslashes (\) for subdirectories. For example:
UNIX: My_Dir/My_Subdir/my_file

Windows: My_Dir\My_Subdir\my_file

Running environment variable script files

Teamcenter stores environment variable settings in the tc_profilevars script file, stored in the
TC_DATA directory.
• You can run these scripts directly in Bourne and Korn shells.

• To use C shells, you must use the tc_cshvars script.

When the tc_cshvars script is sourced from a C shell, environment variables are read from the
tc_profilevars script file. This is done so that a single file (tc_profilevars) can be used to store
environment variable settings for an entire site.

PLM00026 11.2 Preferences and Environment Variables Reference 1-5

Chapter 2: Managing preferences

Getting familiar with preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

What are preferences? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Preference definition elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
System and hierarchical preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Managing protection scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Displaying preferences in the rich client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Managing the values of preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8

Creating and editing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9

Editing preference XML files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Creating preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Edit a preference XML file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
What if preference names change when imported? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Specify dual OS values for a single preference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10

PLM00026 11.2 Preferences and Environment Variables Reference

Chapter 2: Managing preferences

Getting familiar with preferences

What are preferences?

Preferences are settings stored in the Teamcenter database that provide a mechanism to control
and define Teamcenter behavior by letting you modify the interface, set default behavior, and specify
default values. Some preferences are read at startup or when you log on to Teamcenter, and others
are read during Teamcenter application usage.
Preferences let you configure many aspects of a session of application behavior, such as how
assemblies are revised, whether extension rules are bypassed for specified operations, and which
Teamcenter objects are displayed in integrations. Each application may have associated preferences.
• The definition of a preference includes all relevant information fields: Name, Protection Scope,
Category, Environment, Type, Multiple or Single (for values), and Description.

• An instance of a preference can override the value for a given preference at a specific location. In
addition to the information in the preference definition, a preference instance includes Location
and Value or Values.

You can manage preferences and set values for preference instances either through a client interface
or by importing manually edited preference XML files.
When working with preferences, you consider the protection scope for the definition of each
preference and the location where each preference instance applies.
• The location specifies the level at which the preference instance value is active. The location for
a preference instance can be Site, Group, Role, User, or Environment Variable. (A location of
None indicates that the preference is defined, but has no instances.)
Note

A preference location of Environment Variable indicates that Environment Variable

is enabled in the preference definition and that the system has a value set for that
environment variable. Preference values set this way are displayed in the preference
instance to let you know this value is set by the environment variable.

• The protection scope determines who can create a preference instance or change the value of a
preference instance. For example, only an administrator can create an instance of a preference
defined with Protection Scope set to Site. Protection scope is a property of the preference
definition.
Based on the protection scope, administrators and users can create or modify instances. An
instance specifies the protection scope and value of a preference at a specific location. The
protection scope also determines precedence behavior when there are multiple instances of
the same preference.

PLM00026 11.2 Preferences and Environment Variables Reference 2-1

 Chapter
Chapter 2: 2: Managing
Managing preferences
preferences

For information about working with preference settings through options in the thin client, see Thin
Client Interface.
For more information about working with preferences and using options in the rich client, see
Teamcenter Basics.
To centralize data model-dependent preferences in the Business Modeler IDE, some preferences,
such as ItemRevision-business-object_Maturity_Level preferences, are converted to Business
Modeler IDE template data model objects, such as business object constants. You can migrate such
preferences using the Preferences Migration Wizard.
For information about migrating preferences to data model objects, see Business Modeler IDE.

Preference definition elements

Administrators can create preference definitions in the Teamcenter rich client Options dialog box.

A preference definition consists of the following elements:

Information box The text box on top on the right side provides information such as
recommended actions and reasons why some actions are unavailable.

2-2 Preferences and Environment Variables Reference PLM00026 11.2

 Managing preferences

Name The preference name must be unique and can contain uppercase and
lowercase letters, numbers, periods, and the underscore character.
Caution

In certain cases, the name you specify is automatically changed by the

software. For example, if you use ug, UG, Ug, or uG in the name, it is
changed to nx in the following instances:
• Beginning of string: ug[specialCharacter]

• Inside string: [specialCharacter]ug[specialCharacter]ug

• End of string: [specialCharacter]ug

Avoid the following special characters:

, comma
. period.
; semicolon
+ plus
- hyphen/minus
_ underscore

Location Specifies the level at which the preference instance value is active. The
location for a preference value can be Site, Group, Role, User, or None.
Note

When Location is None, the preference has a definition but does not
have any instances.

Protection Scope Specifies who can create or edit a preference instance value. Preference
protection scope can be System, User, Role, Group, or Site.
Note

The protection scope of a System preference cannot be changed, and

the value specified for a Site or System protection scope preference
can only be changed by Teamcenter administrators.
The protection scope for User, Role, Group, or Site hierarchical
preferences can only be modified by a system administrator.

Note

The protection scope of a All is no longer valid. This concept is now

represented by the Environment Variable location.
The Preferences and Environment Variables Reference provides
descriptions for approximately 2700 preferences. Of these,

PLM00026 11.2 Preferences and Environment Variables Reference 2-3

 Chapter
Chapter 2: 2: Managing
Managing preferences
preferences

approximately 250 do not have an updated default protection scope and

may have values such as All, Site and User, User and Group, and
so on. Also, some preference descriptions do not include one or more
standard sections for default values or description.
In cases where preference description information is missing or
out-of-date in the Preferences and Environment Variables Reference,
follow these steps to view the correct information:
1. Choose Edit→Options in the rich client to display the Options
dialog box.

2. Click Filters to display the Preferences By Filters pane.

3. Type the preference name in the Search by preference name box.

4. Select the preference from the list.

The preference information is displayed on the right side of the
Options dialog box.

Category Indicates the functional area in which the preference is used.

Preferences are categorized according to the technical area of Teamcenter
they affect. For example, all dataset preferences are assigned to the
Application Encapsulation category and all Multi-Site Collaboration
preferences are assigned to the Multisite category. As a category may contain
a large number of preferences, it may contain subcategories to allow easier
location and identification of a specific preference. For example, the Multisite
category may contain subcategories called Multisite.General, Multisite.ODS,
Multisite.IDSM, and Multisite.RemoteImport. A system administrator can
create new categories or subcategories that are appropriate for your business
practices and assign preferences to those categories and subcategories.
Category is a property on the preference definition and any changes apply
to all existing and new instances. Searches for preferences can be limited
to certain categories.
Environment Specifies whether a preference name can be used (Enabled) as an
environment variable to set the preference value or cannot be used (Disabled)
as an environment variable.
You can declare the preference name as an environment variable with an
appropriate value on the Teamcenter server host if the preference definition
contains the Enabled value.
In such cases, the environment variable is considered an instance of a
preference. When the preference definition specifies Environment as
Enabled, a preference search first checks for an environment variable with the
same name as the preference and, if defined, uses that environment variable
value. Otherwise, the normal search pattern for precedence is followed.

2-4 Preferences and Environment Variables Reference PLM00026 11.2

 Managing preferences

Type Allows you to define one of five types of preferences:

• String
Valid values are any valid string of characters.

• Logical
Valid value is one of any logical pair (on or off, true or false, yes or no,
0 or 1).
Note

Logical preferences may have more than one valid value. For
example, 0, No, Off, and False may all be equivalent valid values
of the same preference that achieve the same result. The value
shown in the Options pane of the user interface may differ from
the possible values listed for a preference, but both values are
valid settings.

• Integer
Valid values are any positive integer.

• Double
Valid values are floating point (real) numbers (-12.34, 99.05).

• Date
Valid values are calendar date and time entries in DD-MM-YYYY
HH-MM-SS format, for example, 23-Fe-2008 16-32-45.
Note

To ensure correct display of date format in the interface, Siemens

PLM Software recommends users set values from the Options
dialog box, rather than through the XML file.

Multiple Specifies whether a preference is defined to accept multiple values (Multiple)

or a single value (Single).
Description Provides information about the functionality affected by the preference.
Value Lists the value or values associated with the preference.
Note

Do not enter localized business object names in preferences. For

example, when entering a value in a preference, you must enter the
business object name as it appears in the database, not the localized
name of the business object.

System and hierarchical preferences

There are two types of preferences:

PLM00026 11.2 Preferences and Environment Variables Reference 2-5

 Chapter
Chapter 2: 2: Managing
Managing preferences
preferences

• System preferences have a protection scope of System, and apply to the entire Teamcenter site.
These preferences provide settings that apply to the entire Teamcenter deployment. Several
system preferences ship with Teamcenter.

• Hierarchical preferences have a protection scope of User, Role, Group, or Site. The system
uses the hierarchy, beginning with User, then checking Role, Group, and Site, to retrieve
a preference value.
The system uses the hierarchy to search for preference values, starting at the level defined by
the protection scope and going up the different levels in the order: from current user, to current
role, then current group, and then site.

For example, the system looks for the preference value of a role protected preference in the following
manner:
• If a value exists for the current role, that value is used.

• If no value exists for the current role, but a value exists for the current group, that value is used.

• If no value exists for the current role or group, but a value exists for the site, that value is used.

• If no value exists for the current role, group, or site, no value is returned.

Preference values can be defined at different levels depending on the defined protection scope:
• Teamcenter administrators can create instances for preferences that have a protection scope of
User, Group, Role, or Site.

• Teamcenter group administrator users can create instances for preferences that have a protection
scope of Group, Role, or User.

• Teamcenter nonadministrator users can only create instances for preferences that have a
protection scope of User.

Managing protection scope

All preferences have a protection scope.
Hierarchical preferences that are available immediately in a new installation each have a default
protection scope of Site, Group, Role, or User. Only system administrators can change the
protection scope for hierarchical preferences.
Administrators can manage protection scope for preferences in two ways:
• In the rich client Options dialog box
This method is best for modifying small numbers of preferences individually.

• Using the preferences_manager utility

This method is best for updating the protection scope, values, and behavior of multiple
preferences.
Note

Some preferences are automatically created when certain functionality is added.

2-6 Preferences and Environment Variables Reference PLM00026 11.2

 Managing preferences

Displaying preferences in the rich client

In the rich client, use the Edit→Options menu command to display the Options dialog box. The
banner at the bottom of this dialog box contains links (Options, Filter, Search, and Organization)
to different panes: Options, Preferences By Filter, Preferences By Search, and Preferences
By Organization.

The Options pane in the Options dialog box lets you interactively select to specify a wide range of
behaviors.

• The Options pane displays a subset of available preference behaviors organized by functional
area on the left side, with descriptive titles and current values on the right side. Some values are
further organized by tabs.

Note

To see the name and protection scope of the preference for the behavior, place your
mouse cursor over the option. This information is available even when the behavior is
not available for editing.

• The Preferences By Filter, Preferences By Search, and Preferences By Organization panes

let administrators define preferences, and, depending on protection scope, let administrator and
nonadministrator users create instances of preferences or change the values of preference

PLM00026 11.2 Preferences and Environment Variables Reference 2-7

 Chapter
Chapter 2: 2: Managing
Managing preferences
preferences

instances to which they have access. Depending on access, these panes display tabs for
Definition, Instances, Category, Import, and Export.
For more information about working with preferences and using options in the rich client, see
Teamcenter Basics.

Managing the values of preferences

The Teamcenter rich client and thin client each provides a user interface to manage the values of
preferences through the Edit→Options menu command, which displays the Options dialog box.
• The thin client Options dialog box provides a limited set of options to change preference values
that affect the thin client. The thin client does not provide direct access to preferences by name.
For information about working with preferences in the thin client, see Thin Client Interface.

• The rich client Options dialog box provides an Options pane, which has an extensive set of
options to change preference values, and the Preferences By Filter, Preferences By Search,
and Preferences By Organization panes, which let administrators create preferences and which
allow others, depending on the access specified by protection scope, set selected preference
instance values directly.

Note

Preferences that affect display order may reorder values automatically when you create a user
preference by changing settings in the Options dialog box.
• For example, you can change the Shown Relations values for item revision relations using
the Options pane in the Options dialog box to display General→Item Revision options.

• To specify the preferred order for values, you can use the Options dialog box Filters pane
to display the user preference, ItemRevision_DefaultChildProperties in this case, and
then use Sort the selection for an alphabetic list and, for selected relations, use the
move up and move down arrows.

Preferences that define columns and column widths cannot be modified from the Options
dialog box.
• These are interdependent preferences. When a column preference is modified, the
corresponding column width preference should also be modified to ensure the table
displays properly in the interface.

• These preferences are most easily modified by right-clicking the Properties table in
the interface and selecting the Insert columns or Remove this column command.
Alternatively, you can modify these preferences using the preferences_manager utility or
editing the preferences XML file.

2-8 Preferences and Environment Variables Reference PLM00026 11.2

 Managing preferences

Creating and editing preferences

Editing preference XML files
Administrators can manually edit preference XML files to create or modify a preference, and then use
the preferences_manager utility to load the XML files, or use the rich client to import the files.
The preferences_manager supports batch operations and effective bulk processing.

Creating preferences

You must be an administrator to create preferences. There are two situations in which
an administrator may want to create a preference.
• Control a feature with a preference not provided out-of-the-box.

• Support a customization.

For more information about creating preferences, see Teamcenter Basics.

Edit a preference XML file

1. Make a copy of the preference XML file, for example, the tc_preferences.xml file.

2. Apply your changes using an XML editor.

3. Import the changes using the preferences_manager utility or the rich client Options dialog box.
For more information about preferences_manager utility, see the Utilities Reference.

To view the changes, use the rich client Edit→Options menu command to display the Options dialog
box, and then locate the new preferences in the Preferences By Filter, Preferences By Search, or
Preferences By Organization pane.

What if preference names change when imported?

You may notice when importing certain preferences that ug gets changed to nx.
You can use the string ug (uppercase, lowercase, or mixed case) in a preference as long as it is
not followed by any of the special characters listed below when it is at the beginning of a preference
name, preceded by a special character at the end of a preference name, or surrounded by any of the
special characters not at the beginning or end of the preference name.
With an underscore being the special character in following examples:
• ug_preference gets changed to nx_preference.

• Preference_for_ug gets changed to Preference_for_nx.

• Preference_ug_setting gets changed to Preference_nx_setting.

PreferenceForUg does not get changed.
The nx replacement is all lowercase if the ug is lowercase, but uppercase if either or both of
the uG characters are uppercase.

PLM00026 11.2 Preferences and Environment Variables Reference 2-9

 Chapter
Chapter 2: 2: Managing
Managing preferences
preferences

The special characters are:

• Underscore _

• Comma ,

• Space

• Period .

• Semicolon ;

• Plus +

• Minus -

For more information about importing preferences, see Teamcenter Basics.

Specify dual OS values for a single preference

If you import preferences using the preferences_manager utility, you can define both UNIX and
Windows values for the same preference. To do so, you must set array to false, directing the system
to return a single value for the preference query, even when multiple values are defined.
Note

If you define both UNIX and Windows values for a preference, the value returned is based on
the server operating system.

1. Create an XML file containing the relevant preference definitions.

2. Set array to false.

3. Define platform values for both UNIX and Windows. For example:
<preference name="TC_audit_log_dir" type="String" array="false" disabled="false">
<preference_description>Specifies the audit log directory.</preference_description>
<context name="Teamcenter">
<value platform="UNX">$TC_LOG/audit</value>
<value platform="WNT">%TC_LOG%\audit</value>
</context>
</preference>

4. Import the XML file to the database with the preferences_manager utility using the OVERRIDE
option.
For more information about this utility, see Utilities Reference.

2-10 Preferences and Environment Variables Reference PLM00026 11.2

Chapter 3: Introduction to environment variables

Introduction to environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Environment variable script files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Setting environment variables for logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

PLM00026 11.2 Preferences and Environment Variables Reference

Chapter 3: Introduction to environment variables

Introduction to environment variables

Use environment variables and script files to configure Teamcenter. Environment settings allow you
to configure and control many aspects of the Teamcenter software. By setting these variables for
each site, Teamcenter can be quickly adapted and configured to meet any site's needs. Many of
these variables point to specific network nodes and/or directories so that Teamcenter can be used in
large and small homogeneous and heterogeneous environments.
Two environment variables must be set before running Teamcenter: TC_ROOT and TC_DATA.
Teamcenter does not run unless these environment variables are set. These environment variables
must be set through shell commands or a script.
Basic environment variables are set during the installation of Teamcenter through the tc_profilevars
script.
For more information, see Manually configure the Teamcenter environment.

Environment variable script files

Teamcenter environment variables are stored in the tc_profilevars script file, stored in the TC_DATA
directory. This script can be run directly by Bourne and Korn shells. C shells must use the tc_cshvars
script. When the tc_cshvars script is sourced from a C shell, environment variables are read from
the tc_profilevars script file. This is done so that a single file (tc_profilevars) can be used to store
environment variable settings for an entire site.
System environment variables are stored as defined by your operating system.

Setting environment variables for logging

Teamcenter saves information in various log files. View log files to identify problems by showing
the state of an application at any given point.
For more information about log files, see System Administration.
You can modify Teamcenter logging behavior by setting environment variables and preferences. Set
the following environment variables to optimize logging information sent to system log and journal files.
For more information about working with log files, see Log file preferences.

PLM00026 11.2 Preferences and Environment Variables Reference 3-1

 Chapter
Chapter 3: 3: Introduction
Introduction to environment
to environment variables
variables

Environment variable name Use

TC_SQL_DEBUG Accepts the following values:
J Copies all SQL statements to the journal file as well as
the system log file.
P Includes profiling data; reports the frequency of use
of each distinct statement in a summary at the end of
log file.
T Includes timing data; reports the time of each SQL
statement.
B Binds variables; expands SQL bind variables (this is
the default setting)
b Reports bind variables in :1 format, rather than
expanding them.
Note

Set to JPT to optimize logging information.

TC_JOURNAL Accepts the following values:
OFF Creates an empty journal file.
SUMMARY Creates a summary report listing the total time
spent on each journal routine.
FULL Creates a full report listing each call.
MODULE Uses the TC_Journal_Modules preference to
select which modules should be journalled.
Note

Set to FULL to optimize logging information.

Set to MODULE to fine tune logging information.
API_JOURNAL Set to FULL to enable Teamcenter Integration for NX
journalling.
TC_POM_JOURNALLING Determines whether the POM module journals nested calls.
Set to N for full journalling.
TC_KEEP_SYSTEM_LOG Accepts the following values:
Y The system log is not deleted, even if there are no
errors.
N The system log is deleted if there are no errors.
Note

Set to Y to retain the system log.

3-2 Preferences and Environment Variables Reference PLM00026 11.2

 Introduction to environment variables

Environment variable name Use

TC_TRACEBACK Accepts the following values:
ON Writes tracebacks to the system log file.
OFF Does not write tracebacks to the system log file.
Note

When errors occur, the system writes tracebacks to

the system log file by default. Use this environment
variable to override the default behavior.
TC_SLOW_SQL Set to a number of seconds. Defaults to 10 seconds.
Note

SQL statements that run longer than the specified time

write explain plans to the system log file.

PLM00026 11.2 Preferences and Environment Variables Reference 3-3

Chapter 4: Environment variables

Environment variables listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

PLM00026 11.2 Preferences and Environment Variables Reference

Chapter 4: Environment variables

Environment variables listing

The following list of Teamcenter environment variables includes a brief description of each variable
and how the variable is set (for example, through the tc_profilevars property file).
AdaptiveApplicationDisplay
Determines whether the adaptive application display functionality is enabled. When enabled,
icons of applications that have not been used in a certain period of time do not display in the
navigation pane, thus rarely used applications are hidden. Users can click the More... button at
the bottom of the navigation pane allows to display the rest of the application icons. The period of
disuse required to trigger this functionality is set in the AdaptiveApplicationDisplayDuration
variable. This variable is set in the client_specific.properties file.
AdaptiveApplicationDisplayDuration
Determines the period of time, in days, an application must not be used to trigger the adaptive
application display functionality. The AdaptiveApplicationDisplay variable must be set for this
environment variable to be implemented. This variable is set in the client_specific.properties
file.
AM_BYPASS
Bypasses Access Manager when logging on to Teamcenter to enable a system administrator to
reload the rule tree. Use this environment variable if the rule tree needs repair. For example,
perhaps an unintended consequence of modifying a rule results in no longer being able to see
your home folder, effectively preventing you from logging in effectively. In this case, setting this
environment variable to any value prompts the system to bypass the AM rule tree when logging in.
AM_MODE
Evaluates the user's group value based on a union of all groups the user belongs to. This
includes groups defined by predefined conditions and by ACLs. When this environment variable
is not set, a user's group is determined by the group value with which the user logged in. Enable
this functionality by setting this variable with any value.
AM_PERFORMANCE_STATISTICS
Collects and displays Access Manager performance statistics for each call to a rule or
accessor function, which are useful for debugging performance issues with rule and accessor
implementations or the rule tree. The statistics are logged to the syslog file at server shutdown.
Enable this functionality by setting this variable with any value.
Note

Because there is a significant performance impact to collect the statistics, the feature is
disabled by default.

For more information about the statistics collected, see Access Manager.

PLM00026 11.2 Preferences and Environment Variables Reference 4-1

 Chapter
Chapter 4: 4: Environment
Environment variables
variables

API_ALWAYS_REFRESH
Determines whether the Refresh Object caching method is enabled. This method caches an
array of refreshed objects during each system operation, such as loading an assembly. Setting
this environment variable to any value disables this caching method.
API_DEFAULT_DIR
Determines the download location for files associated with a part. The default NX startup
directory is used if the API_DEFAULT_DIR environment variable is not set.
API_JOURNAL
Enables journalling of API files. Set to FULL to log all API modules.
API_SET_BYPASS
Set to true to enable DBA bypass of the ACL tree when using import utilities such as import_file.
AUTHORIZATION_MODE
Evaluates all of a user's group and role-in-group settings to determine the effective authorization
rules for the user. If left unset, the system evaluates only the current logon settings.
AUX_PATH
(Optional) Provides auxiliary path information required by applications launched from the rich
client. Add the AUX_PATH variable in the value set for the PATH variable. Using the AUX_PATH
variable reduces the size of the overall PATH value by excluding the existing system values from
the final path values used for rich client startup. This can improve startup performance.
Set the AUX_PATH variable prior to starting the rich client, for example:
• Windows systems
set AUX_PATH=C:\new\path;%AUX_PATH%

• UNIX systems (using ksh)

export AUX_PATH=/new/path:$AUX_PATH

BMF_BYPASS_ALL_EXTENSION_RULES
Determines whether to bypass processing all the extension rules defined through the Business
Modeler IDE when a particular operation is executed. Use this environment variable only for
installations and upgrades. When set to ON, the system bypasses processing of all defined
extension rules. When set to OFF, the system does not bypass processing of defined extension
rules. The default value is OFF.
As an example of when this is used, during the upgrade process, Teamcenter Environment
Manager (TEM) sets this environment variable to ON to bypass processing of extension rules
because processing the rules might cause an upgrade failure. The PLM XML import process
also sets this environment variable to ON to bypass processing extension rules because there
may be a rule that creates a duplicate object.
You can also use the BMF_BYPASS_ALL_EXTENSION_RULES preference to set this behavior.
Note

System administration privileges are required to implement this setting. If the user is not
logged in with system administration privileges, extension rules will not be bypassed,
regardless of the environment variable setting.

4-2 Preferences and Environment Variables Reference PLM00026 11.2

 Environment variables

BYPASS_RULES
Determines whether users logged in as a member of the system administrator group may bypass
processing all business rules, including naming rules. Use this environment variable only for
installations and upgrades. When set to ON, processing of all business rules is bypassed. When
set to OFF, all business rules are processed. The default value is OFF.
As an example of when this is used, during the upgrade process, the Teamcenter Environment
Manager (TEM) can set this environment variable to ON to bypass processing of business rules.
A naming rule validation could cause failure if TEM is looking for a specified object name but
cannot locate it because a naming rule changes the object name.
BMIDE_SCRIPT_ARGS
Sets the memory allocated to the Java heap sizing. For example, set its value to -Xmx1024M
to allocate 1 GB of RAM to the Java heap space on the server (assuming you have that much
memory space available). Create this environment on a corporate server to ensure there is
enough memory to install large templates. You can also set this value on a machine running a
Business Modeler IDE client to ensure there is enough memory to load templates containing a
large amount of data model.
For more information, see Business Modeler IDE.
CLASSPATH
Defines the directory for storing the rich client object log (.log) files when the java.io.tmpdir key
is defined in the Virtual Machine CLASSPATH variable, as follows:
-Djavaio.tmpdir=path-to-temp-directory

DEPLOY_ARCHIVE_ACTIVE
Archives deployment files.
By default, this variable is not defined and considered turned on. Use this environment variable
to turn off deployment archiving by setting the value to false (or off, no, or 0). By default, the
deploy_archive utility is automatically run when you deploy from Teamcenter Environment
Manager (TEM) and the Business Modeler IDE.
For more information, see Business Modeler IDE.
FCC_PROXYPIPENAME
Defines the base name of the set of FIFOs (pipes) used to communicate with the
FCCClientProxy, for example:
set FCC_PROXYPIPENAME=\\.\pipe\FMSClientPipe|/tmp/FMSClientPipe

The value to the left of | is used for Windows hosts, and the value to the right of | is used
for UNIX and Linux hosts.
The value must exactly match the value of the FCC_ProxyPipeName FCC configuration
parameter in the fcc.xml file.
For more information, see System Administration.
Note

Siemens PLM Software recommends you do not set this parameter except under certain
circumstances where it may be required. For more information, contact your Siemens PLM
Software representative.

PLM00026 11.2 Preferences and Environment Variables Reference 4-3

 Chapter
Chapter 4: 4: Environment
Environment variables
variables

FMS_FCCSTARTUPLOG
Enables logging of FCC data. Set to the location (full path and file name) in which you want
the data stored.
FMS_HOME
Specifies the FMS home directory. For server side, FMS_HOME specifies the home directory for
FSC files, and on the client machine, FMS_HOME specifies the home directory for FCC files.
FMS_WINDOWS_MULTIUSER
Allows multiple users of the same Windows client machine to run separate and independent
instances of the FMS client cache (FCC). Set the environment variable to true to enable multiple
users to use the same FMS installation or set to false to run in legacy single-user mode. If set to
true, each user launches their own instance of FCC and has their own FCC cache directory.
For more information, see System Administration.
FSC_HOME
Specifies the path where an FMS server cache (FSC) service can find the configuration
files. Typically, this is set to TC_ROOT\fsc. This environment variable is set through the
TC_DATA/tc_profilevars property file.
HSM_TAKE_BACKUP
Used by the move_tc_files utility, which relocates infrequently accessed Teamcenter files from
high-speed/low-density volumes to low-speed/high-density volumes. This environment variable
specifies whether to store a copy of the original file in the TC_LOG directory before attempting to
move the file to the destination volume.
IMAN_SDL_MAGIC
Dumps a property table into the output page with any error generated while accessing an object
property. This table shows the name type and value of each valid property of the relevant object.
Do not use this facility in production.
IMAN_SYS_UID_DIR
Defines the directory containing the default Teamcenter display libraries. The default Teamcenter
directory structure contains separate subdirectories for character mode (VT100) and graphical
(Motif) interfaces. The TC_DATA/tc_profilevars script uses LIBMODE to set this environment
variable to the proper subdirectory.
IMAN_SYS2_UID_DIR
Defines the directory containing the default uncustomized Teamcenter Integration for NX display
libraries.
JAVA_HOME
Specifies the path to the Java location. Typically, this environment variable is set through the
TC_DATA/tc_profilevars property file. In a run-time environment, this environment variable
points to the same location as the JRE_HOME environment variable. In a development
environment, set this environment variable to point to the same location as the JDK_HOME
environment variable.
JDK_HOME
Specifies the path to the Java Development Kit (JDK) location. JDK is required for customization
of Teamcenter.

4-4 Preferences and Environment Variables Reference PLM00026 11.2

 Environment variables

JRE_HOME
Specifies the path to the Java Runtime Environment (JRE) location. Typically, this environment
variable is set through the TC_DATA/tc_profilevars property file.

Note

As of Teamcenter 10, Siemens PLM Software no longer distributes a JRE for running the
Teamcenter Environment Manager (TEM), rich client, and the Business Modeler IDE. You
must download and install the JRE prior to using any of these Teamcenter components.
This applies to all the platforms for Teamcenter: Windows, Linux, Solaris, and AIX.

JRE64_HOME
Specifies the path to the 64-bit version of the Java Runtime Environment (JRE). This environment
variable is required if have a 64-bit system and you run 64-bit applications that require a JRE.

Note

As of Teamcenter 10, Siemens PLM Software no longer distributes a JRE for running the
Teamcenter Environment Manager (TEM), rich client, and the Business Modeler IDE. You
must download and install the JRE prior to using any of these Teamcenter components.
This applies to all the platforms for Teamcenter: Windows, Linux, Solaris, and AIX.

KNOWLEDGEBASE_EVALUATE
Determines whether the system checks the settings of conditions. This environment variable is
automatically turned off during installation and upgrades to ensure no conditions are evaluated
during the process. This environment variable is set to ON when the installation or upgrade
completes. You can manually set this environment variable to OFF to prevent conditions from
being evaluated.

Conditions consist of one or more conditional statements evaluated at run time to determine
condition results, which are always TRUE or FALSE.

For more information about managing conditions, see Business Modeler IDE.

LANG
Defines non-English locales on UNIX systems. Specify the system locale by setting this
environment variable and the LC_ALL environment variable using the Common Desktop
Environment (CDE). These two variables must be identical to function properly.

For more information about country code values, see UNIX and Linux Server Installation.

Use with the MB_CHARS environment variable to support localizing Teamcenter by modifying
string and date processing behavior to better conform to local usage. Set this environment
variable to a valid locale. Display the list of locales by typing locale -a in a shell.

LC_ALL
Defines non-English locales on UNIX systems. Specify the system locale by setting this
environment variable and the LANG environment variable using the Common Desktop
Environment (CDE). These two variables must be identical to function properly.

For more information about country code values, see UNIX and Linux Server Installation.

PLM00026 11.2 Preferences and Environment Variables Reference 4-5

 Chapter
Chapter 4: 4: Environment
Environment variables
variables

LD_LIBRARY_PATH
Defines the shared display library path for Sun, SGI, and HP platforms. The
TC_DATA/tc_profilevars script searches for shared display libraries using LIBMODE, constructs
a path statement, and exports LD_LIBRARY_PATH.
LDR_CNTRL
Creates a named shared library. Valid only when running on an AIX platform.
By default, AIX does not support a shared library greater than 256 MB. This limitation affects
sites running on an AIX platform and requiring significant processing, for example, if users at
your site expand very large structures in Structure Manager.
You can overcome this limitation of the AIX platform by creating a named shared library. Named
shared library areas work similar to global library areas, designating one segment for shared
library data and one for text data. To use a named shared library in Teamcenter, you must create
an alternate memory model that dedicates both segments to shared library text. Do this by
setting this environment variable to NAMEDSHLIB (named shared library) and specifying the
doubletext32 option for the named shared library area. For example:
LDR_CNTRL=NAMEDSHLIB=tcsp3,doubletext32

On AIX platforms, the number of data segments a process is allowed to use limits the process
memory size. The default number of data segments is one. The size of a data segment is 256
MB. Data segments are shared for both data and stack. The maximum number of additional
data segments a process can use is eight. The memory size can be increased by specifying a
maximum address space, as specified in the following table:

4-6 Preferences and Environment Variables Reference PLM00026 11.2

 Environment variables

Number of Process memory

LDR_CNTRL setting additional segments limit increase
Unset 0 (default) 256 MB
LDR_CNTRL=MAXDATA=0x1000000 1 512 MB
LDR_CNTRL=MAXDATA=0x2000000 2 768 MB
LDR_CNTRL=MAXDATA=0x3000000 3 1 GB
LDR_CNTRL=MAXDATA=0x4000000 4 1.25 GB
LDR_CNTRL=MAXDATA=0x5000000 5 1.5 GB
LDR_CNTRL=MAXDATA=0x6000000 6 1.75 GB
LDR_CNTRL=MAXDATA=0x7000000 7 2 GB
LDR_CNTRL=MAXDATA=0x8000000 8 2.25 GB

Force AIX to use the additional memory by enabling dynamic segment allocation (DSA) by
annotating the address with @DSA. For example:
LDR_CNTRL=MAXDATA=0x8000000@DSA

Siemens PLM Software recommends using the maximum data size and memory. For example:
LDR_CNTRL=NAMEDSHLIB=tcsp3,doubletext32@MAXDATA=0x80000000@DSA

If an invalid setting is used for this environment variable it is ignored and the default usage
(one segment) is defined.
LIBPATH
Defines the shared display library path for the IBM platform only. The TC_DATA/tc_profilevars
script searches for shared display libraries using LIBMODE, constructs a path statement, and
exports LIBPATH.
LOG_CONFIG_LOCATION
Specifies the custom log4j file to use for TCCS logging. When not using a custom log4j file, the
FMS_HOME\log4j.xml file is used (as specified by the LogConfigLocation parameter in the
FMS_HOME\log.properties file).
For more information, see System Administration.
LOG_VOLUME_LOCATION
Specifies the location of the TCCS log volume as defined in the starttccs.bat file. By default,
it is set to the USERPROFILE\Siemens\logs\tccs directory.
For more information, see System Administration.
MB_CHARS
Sets localized dataset naming for languages using character sets other than US ASCII. This
environment variable is normally not set (enabling a single-byte environment); if set to 1 a
multibyte environment is enabled. When a multibyte environment is enabled, Teamcenter
supports dataset names containing Katakana, Kanji, Hiragana, and extended ASCII characters.
This is used for internationalizing Teamcenter.
MGC_HOME
Defines the directory where Mentor Graphics is installed. Used with the Mentor Graphics
Integration only.

PLM00026 11.2 Preferences and Environment Variables Reference 4-7

 Chapter
Chapter 4: 4: Environment
Environment variables
variables

MGC_LOCATION_MAP
Defines the full path (directory and file name) of the Mentor Graphics location map file. Used with
the Mentor Graphics Integration only.

MGC_TC_CONFIG_FILE
Defines the full path (directory and file name) of the Mentor Graphics Integration configuration
file. Used with the Mentor Graphics Integration only.

MGLS_LICENSE_FILE
Defines the full path (directory and file name) of the Mentor Graphics license file. Used with the
Mentor Graphics Integration only.

MOVE_TRANSACTIONS_COUNT
Used by the move_tc_files utility, which relocates infrequently accessed Teamcenter files from
high-speed/low-density volumes to low-speed/high-density volumes. This environment variable
specifies the number of transactions that occur before the utility checks the configuration file and
shuts down the relocation process smoothly.

MOZ_PLUGIN_PATH
Set when using Security Services on a Linux platform. To log into a Security Services-enabled
environment on a Linux platform, set this environment variable to a JRE 1.5 (or later) plug-in
path. For example:
/admin/java/Solaris_JRE_1.5.0_11/plugin/sparc/ns7

NLS_SORT
Specifies how data coming back from an Oracle server is sorted. This environment variable is set
through the TC_DATA/tc_profilevars property file.

NR_BYPASS
Determines whether users logged in as a member of the system administrator group may bypass
processing of naming rules. Use this environment variable only for installations and upgrades.
When set to ON, processing of naming rules is bypassed. When set to OFF, all naming rules are
processed. The default value is OFF.

As an example of when this is used, during the upgrade process, the Teamcenter Environment
Manager (TEM) can set this environment variable to ON to bypass processing of naming rules.
A naming rule validation could cause failure if TEM is looking for a specified object name but
cannot locate it because a naming rule changes the object name.

NXMGR_ALLOW_3_TIER_INTEROP
Determines whether Teamcenter Integration for NX will integrate with Teamcenter in three-tier
mode. Setting this variable allows Teamcenter Integration for NX to work in three-tier mode.

ORACLE_HOME
Specifies the directory where the Oracle software is installed.

ORACLE_SERVER
Defines the Oracle server network node. Protected variable. Set during Teamcenter installation
and added to the TC_DATA/tc_profilevars directory.

4-8 Preferences and Environment Variables Reference PLM00026 11.2

 Environment variables

ORACLE_SID
Defines the unique name of the Oracle database instance associated with TC_DATA. Protected
variable. Set during Teamcenter installation and added to the TC_DATA/tc_profilevars file.
PATH
Defines the TC_DATA/tc_profilevars script appends the operating system PATH environment
variable with the full path of the TC_ROOT/bin directory.
This can be used with the AUX_PATH environment variable.
PLUGIN_LOGFILE
Points to a plug-in message log file for Acrobat Reader.
• Error: Not an ARF file.

Used by File Open: unrecognizable input file format.

• Error: Not Tool XML file.

Used by File Open: unrecognizable input file format.

• Error: PDF file filename not found

Used by File Open: cannot find based PDF file.

• Error: FDF file filename not found.

Used by File Open: cannot find based markup FDF file.

• Error: Unable to open file filename.

Used by File Open: cannot access to the displayed file.

• Warning: The selected file(s) have attached Markups. But cannot be displayed in the
Reader because the based PDF is not comment-right enabled.

Used by File Open by Reader: The plug-in on the Reader requires the based PDF to have
a comment-right enable token embedded in the PDF file for user to view and perform
markup using Reader.

For more information about logging, see System Administration.

POM_PURGE_AGE_LIMIT
Specifies the period in seconds for which unreferenced or unlabeled historical revisions are
protected from purging. Older historical revisions are considered for purging. Enter a negative
value to disable purging, for example, -1.
POM_SCHEMA
Defines the .ull file specification (directory path and file name) of the POM schema file. Protected
variable.
By default, the POM schema file is located in the TC_DATA directory. The file name is very long
and conforms to the following format:
pom_schema_ORACLE_SERVER_ORACLE_SID

PLM00026 11.2 Preferences and Environment Variables Reference 4-9

 Chapter
Chapter 4: 4: Environment
Environment variables
variables

ORACLE_SERVER is the Oracle server network node, and ORACLE_SID is the unique name of
the Oracle database instance.

POM_TRANSMIT_DIR
Specifies the directory path and file name of the POM transmit schema file. This is a protected
variable and requires a separate POM transmit schema file for 64-bit and 32-bit platforms.
By default, the POM transmit schema file is located in the TC_ROOT/pom_transmit directory.
The file name is a concatenation of the site ID and schema version UID.

portalWebServer
Specifies the Web server on which the rich client CGI executable resides, for example:
portalWebServer=http://Web-server/
This variable is set in the site_specific.properties file.

portalCGI
Specifies the path to the rich client CGI executable, for example:
portalCGI=tc/launchapp
This variable is set in the site_specific.properties file.

PUBLISH_PDF_ERROR_LOG_LOC
Used with Visualization Illustration. Defines a location for the Convert/Print error log
file different from the default location (c:\Documents and Setting\user name\Local
Settings\Temp\VisProdxxx\123\VVCP_error.log).
This log file records all errors occurring during the PDF conversion process. Set this environment
variable with the full path name and file name. For example:
c:\MyFiles\Error.log

PUBLISH_PDF_ERRORS
Used with Visualization Illustration. Determines whether the Convert and Print dialog boxes
close when an error occurs. The default value (yes) closes the dialog boxes when an error
occurs. Set to no for the dialog boxes to remain open after an error occurs.

PUBLISH_PDF_INTERVAL
Used with Visualization Illustration. Determines the amount of time (in milliseconds) before the
system issues each subsequent PDF conversion. Use this setting to prevent conflicts between
simultaneous PDF jobs. This situation occurs when publishing a portfolio to PDF using the
multi PDF option. The default setting is 1000.

PUBLISH_PDF_MAX_JOBS
Used with Visualization Illustration. Determines the maximum number of outstanding PDF
conversion jobs that can be run simultaneously. This situation occurs when publishing a portfolio
to PDF using the multi PDF option. The default setting is 10.

PUBLISH_PDF_TIMEOUT
Used with Visualization Illustration. Determines the amount of time (in milliseconds) allotted for
each PDF conversion to complete. The default setting is INFINITE.

4-10 Preferences and Environment Variables Reference PLM00026 11.2

 Environment variables

PUBLISH_PDF_VVCP_DEBUG
Used with Visualization Illustration. Determines whether a Convert/Print log is generated during
PDF conversion. This setting is used for debugging. Enabling logging greatly increases the PDF
conversion time and should only be enabled while debugging. Set to on to enable the logging.
The default setting is off.
This environment variable works in conjunction with the PUBLISH_PDF_VVCP_DEBUG_LOC
environment variable. Both environment variables must be set to enable logging.
PUBLISH_PDF_VVCP_DEBUG_LOC
Used with Visualization Illustration. Determines the location of the Convert/Print log, which is
used for debugging PDF conversion. Enabling logging greatly increases the PDF conversion
time and should only be enabled while debugging. Set this environment variable with the full
path and file name. For example:
c:\Myfiles\VVCP.log

This environment variable works in conjunction with the PUBLISH_PDF_VVCP_DEBUG

environment variable. Both environment variables must be set to enable logging.
PUBLISH_PDF_VVCP_TIMEOUT
Used with Visualization Illustration. Determines the amount of time (in seconds) of the time-out
for convert and print jobs. The default setting (600) is typically adequate for PDF conversions.
Set the value higher if, for example, a particular large, single PDF conversion job is failing due
to a completion time-out.
ROSE
Defines the directory containing the STEP Translator run-time application files. This environment
variable is set through the TC_DATA/tc_profilevars property file and must always point to
TC_DATA. The STEP system fails if drive letters are used in the path pointing to the TC_DATA
directory.
ROSE_DB
Defines the directory containing the STEP Translator run-time data files. This environment
variable is set through the TC_DATA/tc_profilevars property file and it must always point to
TC_DATA. The STEP system fails if drive letters are used in the path pointing to the TC_DATA
directory.
SHLIB_PATH
Defines the shared display library path for the Hewlett-Packard platform only. The
TC_DATA/tc_profilevars script searches for shared display libraries using LIBMODE, constructs
a path statement, and exports SHLIB_PATH.
SITCONS_AUTH_KEY
Specifies a Site Consolidation license key value. The key must be set to authorize the desired
Site Consolidation utilities.
For more information, see Site Consolidation.
The license key value is available from the Global Technical Access Center (GTAC). You can
access GTAC at this URL:
http://support.industrysoftware.automation.siemens.com/gtac.shtml

PLM00026 11.2 Preferences and Environment Variables Reference 4-11

 Chapter
Chapter 4: 4: Environment
Environment variables
variables

You must have a valid WebKey account to use GTAC. If you do not have a WebKey account,
you can request one using the following URL:
https://plmapps.industrysoftware.automation.siemens.com/webkey/
SPLM_LICENSE_SERVER
Specifies the location of the license server for Teamcenter 10.1 and later. This environment
variable replaces the UGS_LICENSE_SERVER environment variable.
The default setting is:
port@host

Replace port with the port number and host with the host name of the license server, for example,
28000@tchost. The port and host values must match those you specified in the SERVER
line of the Teamcenter license file.
Note

You can specify multiple license servers in the value of SPLM_LICENSE_SERVER.

During Teamcenter upgrade, the first entry in this value is designated as the default local
license server.

TAO_ROOT
Defines the directory in which the TAO object request broker (ORB) is installed.
TC_ADMINISTRATION_LOGGING
Enables or suppresses administration logging for the entire site. Administration logging creates
a record of Teamcenter system administration activities such as creating new users, volumes,
and so forth.
If set to ON, administration logging is enabled. The default value is OFF. The preference of the
same name that corresponds to this variable is deprecated as of Teamcenter 11.2.
TC_ALLOW_INCOMPATIBLE_TYPES
Multi-Site checks for compatible schemas during an import from a site that is using a different
version of Teamcenter from the importing site. An import fails if incompatible types are found,
even if the export file does not contain instances of incompatible objects.
Set this environment variable at the importing site to any value to suppress incompatible error
messages, write a warning to the syslog, and continue the import process. You should delete
this variable after all databases are upgraded to same release.
Note

Although any value suppresses the error and continues the import, for clarity, you should
set the value to true.

TC_APPLICATION_LOGGING
Enables or suppresses application logging for the entire site. Application log files are records of
events for applications such as My Teamcenter, Structure Manager, or any Teamcenter utility.
These files are stored in the $TC_TMP_DIR directory.
If set to ON, administration logging is enabled. The default value is OFF. The preference of the
same name that corresponds to this variable is deprecated as of Teamcenter 11.2.

4-12 Preferences and Environment Variables Reference PLM00026 11.2

 Environment variables

TC_APP_UID_DIR
Defines the directory containing customized display libraries used by an entire site. This
environment variable takes precedence over the IMAN_SYS_UID_DIR environment variable so
that site customizations override default display libraries.
TC_BIN
Defines the directory containing Teamcenter binary files. Protected variable. This variable is set
during Teamcenter installation and added to the TC_DATA/tc_profilevars property file.
TC_BYPASS_CANNED_METHODS
Bypasses the defined canned method. For example, various methods may need to be bypassed
during a legacy import.
When a session is started with this environment variable set, the methods defined are bypassed
for all types. Valid values are:
All
Bypass all methods for all types.

method_1
Bypass method_1 for all types that have method_1 configured.

method_1, method_2
Bypass method_1 and method_2 for all types that have method_1 and method_2
configured.

TCCS_CONFIG
Sets the name of the TCCS configuration directory (not the path) containing information about the
various TCCS environments. (The TCCS_CONFIG_HOME environment variable contains the full
path.) This variable is required only when the default TCCS configuration name is not used.
For more information, see System Administration.
TCCS_CONFIG_HOME
Sets the full path to the TCCS configuration home directory. This variable is required only
when the default configuration home location is not used and a custom TCCS configuration
home location is created.
For more information, see System Administration.
TCCS_JAVA
Defines the JRE to use for TCCS. Typically it is set in the starttccs.bat file to point to the
JAVA_HOME or JRE_HOME environment variables.
For information, see System Administration.
TCCS_CONFIG
Sets the TCCS configuration directory containing information about the various TCCS
environments. This variable is required only when the default TCCS configuration name is
not used.
For more information, see System Administration.

PLM00026 11.2 Preferences and Environment Variables Reference 4-13

 Chapter
Chapter 4: 4: Environment
Environment variables
variables

TCCS_CONFIG_HOME
Sets the TCCS home directory. This variable is required only when the default home location is
not used and a custom TCCS home location is created.

For more information, see System Administration.

TC_DATA
Defines the directory containing Teamcenter data files. Protected variable. This variable is set
during Teamcenter installation and added to the TC_DATA/tc_profilevars property file.

TC_DATA_MODEL
Specifies the directory where data model templates are installed. By default, this is set to
TC_DATA/model. This environment variable is set through the TC_DATA/tc_profilevars
property file.

TC_DB_CONNECT
Protected variable. Accesses Oracle database tables by logging in to the Oracle database as
user infodba using a partially encrypted connection string passed to the Oracle database by
Teamcenter. The corresponding password is encrypted for security reasons. This variable is set
during Teamcenter installation and added to the TC_DATA/tc_profilevars property file.

Warning

Because this environment variable is partially encrypted, it cannot be set manually. If

it becomes corrupted or you forget the password, it must be regenerated using the
Teamcenter Environment Manager (TEM).

TC_DISABLE_FLASH
Enables or suppresses display of the Teamcenter logo (flash screen) while the workspace is
loading. This environment variable is set through the TC_DATA/tc_profilevars property file.

TC_FS_SERVICE
Associated with File Management System. This environment variable is set through the
TC_DATA/tc_profilevars property file.

TC_HANDLERS_DEBUG
Determines the amount of workflow handler information sent to the system log file. Set to ALL
to send debug information on all workflow handlers to the system log file. Set to one or more
specific workflow handler names to send debug information on the specified workflow handlers to
the system log file. If left unset, no workflow handler debug information is logged.

TC_HELP_FILE
Defines the directory containing Teamcenter online help files. This variable is set during
Teamcenter installation and added to the TC_DATA/tc_profilevars property file.

TC_HTDOCS
Specifies the directory to hold dynamic files. By default, it is set to TC_ROOT\web\htdoc. This
environment variable is set through the TC_DATA/tc_profilevars property file.

For more information, see Client Customization.

4-14 Preferences and Environment Variables Reference PLM00026 11.2

 Environment variables

TC_INCLUDE
Protected variable. Defines the directory containing custom ITK header files. This environment
variable must be set in order to access custom ITK programs. This environment variable is set
through the TC_DATA/tc_profilevars property file.
TC_INSTALLATION_LOGGING
Enables or suppresses installation logging for the entire site. Contains a record of activities
performed by the Teamcenter Environment Manager installation program. This log file is in the
install directory under the application root directory. The date-time stamp represents the date and
time Teamcenter Environment Manager was run. For example, install0522241627.log indicates
that Teamcenter Environment Manager was run at 4:27 on February 24, 2005.
If set to ON, administration logging is enabled. The default value is OFF. The preference of the
same name that corresponds to this variable is deprecated as of Teamcenter 11.2.
TC_INSTALL_DIR
Specifies the directory for Teamcenter installation files. This environment variable is set through
the TC_DATA/tc_profilevars property file.
TC_JOURNAL
Controls journaling.
Accepts the following values:
OFF Creates an empty journal file.
SUMMARY Creates a summary report listing the total time spent on each journal routine.
FULL Creates a full report listing each call.
MODULE Uses the TC_Journal_Modules preference to select which modules should be
journalled.
Note

Set to FULL to optimize logging information.

Set to MODULE to fine tune logging information.

TC_KEEP_SYSTEM_LOG
Controls the deletion of the system log file.
Accepts the following values:
Y The system log is not deleted, even if there are no errors.
N The system log is deleted if there are no errors.
Note

Set to Y to retain the system log.

TC_LIBRARY
Sets the platform-specific shared display library path. This environment variable is set to the
LD_LIBRARY_PATH, LIB_PATH, or SHLIB_PATH environment variable, depending on the
platform detected when the Teamcenter session is initiated.

PLM00026 11.2 Preferences and Environment Variables Reference 4-15

 Chapter
Chapter 4: 4: Environment
Environment variables
variables

TC_LOG
Defines the directory containing system log files created during Teamcenter sessions. This
directory is created during Teamcenter installation and must not be removed. If this directory
is removed, system log files cannot be created. This environment variable is set through the
TC_DATA/tc_profilevars property file.
The default setting is:
TC_DATA/log_ORACLE_SERVER_ORACLE_SID

ORACLE_SERVER is the Oracle server network node, and ORACLE_SID is the unique name of
the Oracle database instance.
TC_LOG_DIR
This environment variable specifies the directory that error files, log files, and output files are
placed.
TC_LOG_VOLUME_DIR
This environment variable specifies the directory that error files, log files, and output files are
placed.
TC_LOGGER_CONFIGURATION
Specifies the directory containing the logger.properties file. Default loggers are created with
the log levels defined in this properties file.
Specify the directory path or the whole file path to the properties file.
For more information about configuring system logging, see System Administration.
TC_LOG_VOLUME_DIR
Specifies the location of the log volume where the logs are transferred. This environment variable
is set through the TC_DATA/tc_profilevars property file.
TC_LOG_VOLUME_NAME
Specifies the name of the log volume where the logs are transferred. This environment variable is
set through the TC_DATA/tc_profilevars property file.
TC_MASTERFORM_DELEGATE
Sets how the Master forms inherit their access privileges.
When an item is created in Teamcenter, the following Master form objects are created:

• When TC_MASTERFORM_DELEGATE is not set (which is the default), the Item Master
form (Item_master_form) inherits its privileges from its parent item (Item), and the Item
Revision Master form (Item_revision_master_form) inherits its access privileges from its
parent item revision (Item_revision).

• When TC_MASTERFORM_DELEGATE is set, the Item Master form and the Item Revision
Master form derive their privileges through Access Manager rules evaluation independent of
their parent item or item revision.

4-16 Preferences and Environment Variables Reference PLM00026 11.2

 Environment variables

Note

By default, TC_MASTERFORM_DELEGATE is not set. Setting it to any nonnull value

turns off the Master form access privileges delegation. This environment variable is set
through the TC_DATA/tc_profilevars property file.

TC_MFK_INDEX_KEY_SIZE
Specifies the byte size limit of the index key size when creating the key in POM_KEY table. If
the actual index key byte size exceeds the limit, the application returns a failure. You can set it
before evaluating or deploying multifield key definitions based on the database platform limitation.
The default value is 900.
For more information, see Business Modeler IDE.
TC_MSG_ROOT
Specifies the path to where utilities can locate localized error messages. Typically,
this is set to TC_ROOT/lang/textserver/. This environment variable is set through the
TC_DATA/tc_profilevars property file.
TC_no_obsolete_message
Setting this environment variable to any value suppresses ITK warning messages.
TC_NO_TEXTSRV_SHARED_MEMORY
Disables shared memory functionality and reverts system behavior to in-process text
storage when the variable is set to TRUE. Use this environment variable when the
TC_SHARED_MEMORY_DIR environment variable is already set.
For more information about this variable, see System Administration.
TC_NX_DEFAULT_PART
Defines the default NX part file. This environment variable is set through the
TC_DATA/tc_profilevars property file.
TC_ONLINE_HELP
Specifies whether online help is installed. This environment variable is set through the
TC_DATA/tc_profilevars property file.
TC_PERFORMANCE_MONITOR
Automatically displays the Performance Monitor dialog box in the rich client after logon and
enables SQL tracking statistics.
TC_POM_JOURNALLING
Determines whether the POM module journals nested calls.
Set to N for full journalling.
TC_PRINTER
Protected variable. Defines the default Teamcenter printer. Other printers can be accessed
through the Workspace System→Printer command.
TC_ROOT
Top (root) directory of the Teamcenter directory structure. This environment variable must be set
before running the application or command line utilities.

PLM00026 11.2 Preferences and Environment Variables Reference 4-17

 Chapter
Chapter 4: 4: Environment
Environment variables
variables

For more information, see Manually configure the Teamcenter environment.

TC_SECURITY_LOGGING
Enables or suppresses security logging for the entire site. Security logging creates a record of
invalid access of Teamcenter objects and writes the data to the $TC_LOG/security.log file.
Enabling security logging also requires creating a file named security.log in the TC_DATA
directory. The system first checks for the existence of this file; if it exists, it checks the value
of this environmet variable.
If set to ON, security logging is enabled. The default value is OFF. The preference of the same
name that corresponds to this variable is deprecated as of Teamcenter 11.2.
TC_SHARED_MEMORY_DIR
Specifies the directory where the memory backing store files are stored. If you do not set this
environment variable, the TEMP environment variable (Windows) or /tmp (UNIX) directory is
used. On Windows, if the TEMP environment variable is not available, the C:\temp directory is
used.
For more information about this variable, see System Administration.
TC_SKIP_CLIENT_CACHE
Causes the rich client to run in legacy mode and avoid downloading or using a local
client meta cache. Set this environment to any value to activate it, for example,
TC_SKIP_CLIENT_CACHE=1. To unset the variable, leave the value blanks, for example,
TC_SKIP_CLIENT_CACHE=.
The following features provide additional client caching functionality:
• generate_client_meta_cache utility
Caches metadata to improve client interaction with the server. Metadata is cached and
refreshed automatically, but the cache can be regenerated using this utility. The utility is
usually run during installation and upgrade.
For more information, see Utilities Reference.
Note

This utility should be run after a style sheet is edited to keep the style sheet feature
in the client cache folder up-to-date. This utility can also be used to generate the full
client cache folder if for some reason the client cache folder has been deleted.
For more information, see Client Customization.

• ClientCache folder
Stores cached metadata. If you are logged on to the rich client as a database administrator
(DBA), you see the folder under the Home location.
Warning

If the administrator moves, renames, or deletes this folder, all clients fall back to a
nonclient-cached mode.

• Generate Client Cache check box

4-18 Preferences and Environment Variables Reference PLM00026 11.2

 Environment variables

Runs the generate_client_meta_cache utility. The check box is added to Teamcenter

Environment Manager (TEM).
For more information, see Teamcenter Environment Manager Help.

• AUX_PATH environment variable

Adds auxiliary path information required by applications launched from the rich client.

TC_SLOW_SQL
Writes explain plans to the system log file for SQL statements that run longer than the specified
time. The explain plans can be used to suggest indexes that can be added to speed up the
query. Set the environment variable to a number of seconds. The specified value is interpreted
as a floating point time in seconds. If it is set to less than or equal to zero, explain plans are
not written. The time is real time, not CPU time. It only generates explain plans for the first
10 cases. Defaults to 10 seconds.

TC_SOA_MAX_PROPERTIES
Defines the maximum number of properties that can be returned when an object property policy
is enacted while using Teamcenter Services.

For more information, see Teamcenter Services.

TC_SQL_DEBUG
Accepts the following values:

J Copies all SQL statements to the journal file as well as the system log file.

P Includes profiling data; reports the frequency of use of each distinct statement in a
summary at the end of log file.

T Includes timing data; reports the time of each SQL statement.

B Binds variables; expands SQL bind variables (this is the default setting)

b Reports bind variables in :1 format, rather than expanding them.

Note

Set to JPT to optimize logging information.

TCSS_DEBUG_LEVEL
Enables debug output to ‘%appdata%\teamcenter\sso\debug.log file for the .NET library. It
accepts the following case insensitive values:

• true
• false
• debug
• info
• warn
• error
• fatal

PLM00026 11.2 Preferences and Environment Variables Reference 4-19

 Chapter
Chapter 4: 4: Environment
Environment variables
variables

If this variable is not defined, Teamcenter sets the level to warn . If the variable is defined with no
value or and invalid value, Teamcenter sets the level to debug. This behavior is enforced by
the setDebug method in Java and the Debug property in C#.
TC_SSO_APP_ID
Use this environment variable when multiple Teamcenter sites are served by a single identity
provider, or Security Services is configured to use an ID other than Teamcenter (this is the
default when the TC_SSO_APP_ID environment variable is not set). When the multiple sites
have different sets of users authorized to use the application for each installation, or different
identifications in each installation, this environment variable is used to identify which installation is
authenticated.
Set this environment variable in both the TC_DATA/tc_profilevars file for the server and the
client's site_specific.properties file.
This environment variable should be set only if Security Services is enabled using the
TC_SSO_SERVICE environment variable.
TC_SSO_CHANGE_PASSWORD_PAGE
Determines the URL to which the thin client redirects the change password page by setting the
complete URL for the local change password page provided using the identity provider used with
Security Services. This environment variable is optional, and when available, is set through
the TC_DATA/tc_profilevars file.
This environment variable should be set only if Security Services is enabled using the
TC_SSO_SERVICE environment variable.
TC_SSO_LOGIN_PAGE
Determines the URL to which the thin client redirects the logon by setting the complete
URL for the Security Services logon page. This environment variable is set through the
TC_DATA/tc_profilevars file.
This environment variable should be set only if Security Services is enabled using the
TC_SSO_SERVICE environment variable.
TCSSO_LOGIN_SERVICE_URL
Enables the WebSEAL feature within clients. Set this variable to the URL address of the Security
Services Login Service as configured for the WebSEAL proxy server.
TC_SSO_LOGIN_URL
Directs the rich client to use the Security Services application client library to obtain an appToken
from the SSO applet. If the applet is not already running, a browser is launched on the given URL
to start a Security Services session. This environment variable is set in the rich client's properties
file. For the two-tier rich client, the file is the client_specific.properties file. For the four-tier rich
client, the file is the site_specific.properties file.
This environment variable should be set only if Security Services is enabled using the
TC_SSO_SERVICE environment variable.
TC_SSO_SERVICE
Enables Security Services functionality by setting the complete URL the ITK server uses
to communicate with Security Services. This environment variable is set through the
TC_DATA/tc_profilevars file.

4-20 Preferences and Environment Variables Reference PLM00026 11.2

 Environment variables

In the rich client and ITK, the ability to set or change a password in the Teamcenter database
is disabled when this environment variable is set. The Change Password command remains
available from the Actions menu. In the Organization application, the password text field and
blank password check box are disabled.
TC_SYSTEM_LOGGING
Enables or suppresses system logging for the entire site. System logging creates a record of
global system events such as object releases.
If set to ON, system logging is enabled. The default value is OFF. The preference of the same
name that corresponds to this variable is deprecated as of Teamcenter 11.2.
TC_TMP_DIR
Specifies where the utilities should create temporary files. The value must be a full directory path
on a local computer, not a network or UNC path. This value is typically C:\Temp on Windows
and /tmp on UNIX.
This environment variable is set through the TC_DATA/tc_profilevars property file.
TC_TRACEBACK
Controls the writing of tracebacks to the system log file.
Accepts the following values:
ON Writes tracebacks to the system log file.
OFF Does not write tracebacks to the system log file.
Note

When errors occur, the system writes tracebacks to the system log file by default. Use
this environment variable to override the default behavior.

TC_USE_DEFAULT_EXPORT_SITES
Specifies whether to use the TC_default_export_sites preference. Set to YES to enable the
preference.
TC_USE_LOV_SHARED_MEMORY
Determines whether the Teamcenter server loads localized LOV display names into shared
memory. Set this environment variable to either TRUE or FALSE. The default setting is TRUE.
If shared memory cannot be used, the system uses process memory. In rare instances when the
system reports a problem with shared memory and cannot fall back to using process memory, set
this environment variable to FALSE and restart the system.
Note

Because localized LOV display can slow system performance, you can use the
Fnd0LOVDisplayAsEnabled global constant to disable loading localized LOV display
names.

TC_USE_METADATA_SHARED_MEMORY
Determines whether the Teamcenter server uses metadata shared with other Teamcenter servers
or uses metadata local to its own process. The default setting is TRUE. Set the environment
variable to FALSE to run the Teamcenter servers in local memory mode.

PLM00026 11.2 Preferences and Environment Variables Reference 4-21

 Chapter
Chapter 4: 4: Environment
Environment variables
variables

Note

Usage of local metadata causes an increase in memory footprints for Teamcenter servers.

TC_USE_PREFS_SHARED_MEMORY
Determines whether the Teamcenter server loads preferences into shared memory. Set this
environment variable to either TRUE or FALSE. In a four-tier configuration, the default setting is
TRUE. In a two-tier configuration, the default setting is FALSE.
Siemens PLM Software recommends using the default settings.

TC_USER_LIB
Contains user-defined custom libraries. On Windows systems, the TC_DATA/tc_profilevars
file adds this directory to the PATH variable. On UNIX systems, if this variable is set in the
environment, the PATH variable. On UNIX systems, if this variable is set in the environment, the
tc_profilevars file adds this directory to the LD_LIBRARY_PATH, LIB_PATH, or SHLIB_PATH
settings.

TC_USER_MSG_DIR
Points to the directory that contains custom XML text and error message files.
The directory that this variable points to must have a subfolder matching the value of the
TC_language_default preference, for example:
TC_USER_MSG_DIR=path-name/language_locale
Replace language_locale with the language subdirectory name, for example:
TC_USER_MSG_DIR=C:\my_custom_errors\en_US

TC_USER_TOOLS
Protected variable. Contains user-defined software applications. This environment variable is set
through the TC_DATA/tc_profilevars property file.

TC_USER_UID_DIR
Contains customized display libraries used by a single user. This variable takes precedence
over the IMAN_SYS_UID_DIR environment variable and the TC_APP_UID_DIR environment
variables so that user customization overrides default and site display libraries.

TC_USE_TEST_ATTR_MAPPINGS
Determines whether Teamcenter references the test attribute mappings rather than the real
mappings. Set the TC_USE_TEST_ATTR_MAPPINGS environment variable or preference to
any value. This causes Teamcenter to access the test mappings rather than the real mappings.
Remove TC_USE_TEST_ATTR_MAPPINGS from the Teamcenter environment when test
attribute mapping should not be used.

TCVIS_ALSG_ENABLED
Disables support for the viewing of JtSimplification datasets in the Lifecycle Viewer and the
stand-alone viewers, such as Mockup. By default, this variable is not set and JtSimplification
is automatically enabled in properly licensed viewers. Set this variable to False if you want
to disable the functionality.

4-22 Preferences and Environment Variables Reference PLM00026 11.2

 Environment variables

TC_WEB_NO_CACHE
Optimizes performance by caching TcScript parse trees if set to FALSE. Avoids the need to
restart the TcServer process after changes if set to TRUE. Set to TRUE while modifying TcScript
code and then set back to FALSE after you complete your changes.

TC_WSDL_MAX_PROPERTIES
Defines the maximum number of properties that can be returned by WSDL-based clients when
using Teamcenter Services.
For more information, see Teamcenter Services.

TC_XML_ENCODING
Used to include templates from other languages. On the server side, controls the encoding
environment for the XML file generated. The first line in the XML file must specify the encoding
required.

TEAMCENTER_SSL_CERT_FILE
Specifies the path to the SSL certificate authority (CA) file for Teamcenter applications. Set
this environment variable in the TC_DATA/tc_profilevars property file, immediately after the
TC_DATA variable setting, as follows:
TEAMCENTER_SSL_CERT_FILE=${TC_DATA}/pom_transmit/ca-bundle.crt;
export TEAMCENTER_SSL_CERT_FILE

In this example, the CA file (ca-bundle.crt) is located under the pom_transmit directory.

TEMP_FILESEARCHPATH
Sets the temporary path to use for Teamcenter file searches. This environment variable is set
through the TC_DATA/tc_profilevars property file.

TNS_ADMIN
Identifies the path where the tnsnames.ora file and sqlora.net files are located. These are
used when communicating with an Oracle server. This environment variable is set through the
TC_DATA/tc_profilevars property file.

Transient_Volume_Installation_Location
Specifies the node name of the transient volume. It is a location-based logical identifier and is
generally set to the host name of the local machine by the TC_DATA/tc_profilevars script. This
environment variable overrides the preference of the same name. When a four-tier transient
volume is mounted on all Teamcenter server hosts at a given location, use this setting to
configure the distributed transient volume.

TRAVERSAL_THRESHOLD
Specifies the maximum number of objects to be traversed. If the maximum number of objects to
be traversed is more than is specified in the variable, traversal may be incomplete and therefore
the results are incomplete.
For more information about traversal, see PLM XML/TC XML Export Import Administration.

UGII_BASE_DIR
Defines the topmost directory of the NX directory structure, the NX equivalent of TC_ROOT. This
environment variable is set by NX.

PLM00026 11.2 Preferences and Environment Variables Reference 4-23

 Chapter
Chapter 4: 4: Environment
Environment variables
variables

UGII_CHECKING_LEVEL
Enables server checking when it is set to 1. (Set to 0 to disable.) When checking is enabled,
the system uses the TC_DATA\logger.debug.properties file for logging instead of the
logger.properties file. The default settings of the debug file generate useful debugging
messages.
For more information, see System Administration.
UGII_OPTION
Determines how to interpret and convert file specifications. This environment variable can
drastically affect Teamcenter File Services and other Teamcenter behavior. For example,
if you create Teamcenter volumes with mixed-case names and this preference is set to
LOWER, Teamcenter File Services is not able to find your volumes. Therefore, ensure that this
environment variable is set consistent with file specification naming conventions at your site.
This environment variable accepts the following values:
• NONE
File specifications are interpreted without converting case.

• LOWER
Converts the entire file specification (directory and file name) to all lowercase.

• UPPER
Converts the entire file specification (directory and file name) to all uppercase.

• HINAME
Converts the file name to all uppercase but leaves the directory path name unchanged.

• LONAME
Converts the file name to all lowercase but leaves the directory path name unchanged.

UGII_USE_NEW_SURFACE_FILE_FORMAT
Instructs the ug_spacemap utility running on the NX client to perform platform-independent
processing of input and output files. This setting only affects surface files, not SPM file.
UGII_USERFCN
Defines the directory containing NX user function libraries. This environment variable is set
through the TC_DATA/tc_profilevars property file.
UGS_LICENSE_SERVER
Specifies the location of the license server for releases of Teamcenter 10.0 and earlier. Beginning
at Teamcenter 10.1, this environment variable was replaced by the SPLM_LICENSE_SERVER
environment variable.
The default setting is:
port@host

Replace port with the port number and host with the host name of the license server, for example,
28000@tchost. The port and host values must match those you specified in the SERVER
line of the Teamcenter license file.

4-24 Preferences and Environment Variables Reference PLM00026 11.2

 Environment variables

UIL_INCLUDE
Specifies a semicolon-separated list of directories where .uih files to be included are located.
XFILESEARCHPATH
Protected variable. Defines the directory containing X-Window System resource definition files.
This environment variable is set through the TC_DATA/tc_profilevars property file. If not set,
X-Window System uses the HOME directory.

PLM00026 11.2 Preferences and Environment Variables Reference 4-25

Chapter 5: Teamcenter Rapid Start preferences

TCX_Print_Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
TcX_pcf_excluded_types_zip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
TcX_pcf_included_types_pcf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
TCX_Server_Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
WEB_IWantToDefaultActions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

PLM00026 11.2 Preferences and Environment Variables Reference

Chapter 5: Teamcenter Rapid Start preferences

TCX_Print_Extensions

DESCRIPTION
For Teamcenter Rapid Start, specifies the supported file extensions for printing.
VALID
VALUES
bmp
dft
doc
docx
dwg
emf
jpeg
jpg
pdf
ppt
pptx
prt
qaf
tif
xls
xlsx
DEFAULT
PROTECTION
SCOPE
Site preference.

TcX_pcf_excluded_types_zip

DESCRIPTION
For Teamcenter Rapid Start, defines the dataset types that are excluded from the
ZIP container.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 5-1

 Chapter
Chapter 5: 5: Teamcenter
Teamcenter
RapidRapid
Start Start preferences
preferences

TcX_pcf_included_types_pcf

DESCRIPTION
For Teamcenter Rapid Start, defines the dataset types that are included in the PCF
container.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
ACADDWG
SEDRAFT
MSWord
MSExcel
MSPowerPoint
PDF
DirectModel

DEFAULT
PROTECTION
SCOPE
Site preference.

TCX_Server_Printers

DESCRIPTION
For Teamcenter Rapid Start, specifies the names of the printers attached to the
Teamcenter Rapid Start server.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid printer name.
DEFAULT
VALUES
PostScript Printer
Microsoft Office Document Image Writer

DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_IWantToDefaultActions

DESCRIPTION
For Teamcenter Rapid Start, determines the default actions to be displayed in the
I Want To panel.
VALID
VALUES
Accepts one or more strings as values.

5-2 Preferences and Environment Variables Reference PLM00026 11.2

 Teamcenter Rapid Start preferences

DEFAULT
VALUES
Create an Item:typeicons/Item.png:javascript:popupNewBusinessObject
(’Item’, true, false);
Create a Folder:typeicons/Folder.png:javascript: popupNewBusinessObject
(’Folder’, false, true);
Create a Form:typeicons/Form.png:javascript: popupNewBusinessObject
(’Form’, true, true);
Create a Dataset:typeicons/Dataset.png:javascript: popupNewBusinessObject
(’Dataset’,true,true);
Create a Web Link:typeicons/Web_Link.png:javascript: popup
NewBusinessObject
(’Web Link’, true, true);
Create a Process:images/newprocess.png:javascript:initiateProcess();
Create a Review Package:typeicons/create_Review_Pckg.png:javascript:
popupNewBusinessObject(’Review_Pckg’, true, false);
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 5-3

Chapter 6: Configuration preferences

Business Modeler IDE preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Finding Business Modeler IDE preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
AltIdentifier_require_on_create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
ASSIGNED_ITEM_ID_MODIFIABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
ASSIGNED_ITEM_REV_MODIFIABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
BMF_BYPASS_ALL_EXTENSION_RULES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
BMF_CUSTOM_IMPLEMENTOR_PATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
BMF_SUPPRESS_ACTION_RULES_DISPLAY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
BMIDE_ALLOW_FULL_DEPLOY_FROM_CLIENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
BMIDE_ALLOW_LIVE_UPDATES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Bypass_property_rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
BYPASS_RULES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
IdentifierContextPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
IDENTIFIER_deepcopy_types_revise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
IdentifierLengthPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
ITEM_autogenerate_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Live Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
METHOD_CM_execute_before_custom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
NR_BYPASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
TC_dataset_deep_copy_rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9
TC_KEY_STRING_DELIMITER_VALUES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10
TC_MFK_DEFAULT_DOMAIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10
Treat_Curr_Rev_As_Any_Rev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
Treat_Next_Rev_As_Any_Rev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
TYPE_DISPLAY_RULES_list_of_primary_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12
TYPE_DISPLAY_RULES_list_types_of_subclasses . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12

Client interface preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13

Confirmation_shown_on_reservation_dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
Confirm_cancel_checkout_suppressed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
Confirm_checkin_suppressed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
Confirm_checkout_suppressed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
Form_double_click . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
Excel_Office_Launchable_TcTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15
Excel_ViewMarkup_Launchable_TcTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15
HTMLStylesheetIncludes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16
HTMLStylesheetSharedLibs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16
HTMLStylesheetUnsupportedRenderingHints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
LHN_Nav_Items_List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
LOV_hide_desc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
LOV_value_desc_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
OCS_company_email_domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19
OCS_use_email_property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19

PLM00026 11.2 Preferences and Environment Variables Reference

 OCS_use_presence_display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20
Outlook_Office_Launchable_TcTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20
Outlook_Sign_Launchable_TcTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21
Outlook_ViewMarkup_Launchable_TcTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21
PowerPoint_Office_Launchable_TcTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21
PowerPoint_ViewMarkup_Launchable_TcTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-22
Show_Checkout_option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-22
TCDigitalSigningApplicationPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-23
UsePropertyStylesheetPlatformRenderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-23
Word_Export_TcTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-24
Word_Office_Launchable_TcTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25
Word_ViewMarkup_Launchable_TcTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25
Word_Show_Display_Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25

Data management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-26

ADA_allow_license_propagation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-26
ADA_enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27
ADA_saveas_propagated_license_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27
AE_dataset_id_gen_by_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27
AE_dataset_id_postfix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-28
AE_dataset_id_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-28
AE_dataset_id_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-28
AE_dataset_id_usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-29
AE_dataset_id_use_rev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-29
Baseline_allowed_baserev_statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-30
Baseline_allow_edits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-30
Baseline_create_snapshot_folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-30
baselineDryRun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-31
Baseline_dryrun_always . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-31
Baseline_nxmanager_refile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-32
Baseline_precise_bvr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-32
Baseline_refile_not_required_item_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-33
Baseline_refile_required_dstypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-33
Baseline_release_procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-33
Baseline_restricted_item_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-34
BOB_property_optimizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-34
CheckoutOnCreatePref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-35
DATASET_saveas_pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-35
<DATASET TYPE>_saveas_pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-36
IDENTIFIER_idincontext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-37
IP_level_list_ordering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-37
ITAR_level_list_ordering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-39
ITEM_baseline_rev_msg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-41
LicenseUsage_admin_notifier_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-41
LicenseUsage_days_warning_level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-41
LicenseUsage_hours_warning_level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-42
LicenseUsage_module_usage_warning_level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-42
LicenseUsage_show_userId_in_report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-42
license_warning_level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-43
Siemens_PL_email_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-43

Preferences and Environment Variables Reference PLM00026 11.2

 SOACAD_checkout_required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-43
TC_check_object_before_create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-44
TCCheckoutReserveOnly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-44
TCCheckoutReserveOnlyWarningNeeded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-45
TC_Dataset_Import_Exclude_Wildcard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-46
TC_<dataset-type>_<tool-type>_searchBy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-46
TCDefaultKeepLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-46
TCDefaultKeepLimitByType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-47
TC_multi_site_ada_license_user_bypass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-48
TC_Refresh_Warning_Threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-48
TC_session_clearance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-49
Use_DataShare_Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-49
USER_baseline_dryrun_validator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-50
WEB_DSM_install_link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-50

Dispatcher preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-51

DISPATCHER_CLIENT_INSTALLED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-51
DISPLAY_Param_In_NotesText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-51
ETS.Repeating_UI.<ProviderName>.<ServiceName> . . . . . . . . . . . . . . . . . . . . . . . . . 6-52
ETS.PROVIDERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-53
ETS.TRANSLATORS.<ProviderName> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-53
ETS.VALIDATE.<ProviderName>.<ServiceName> . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-53
ETS_trans_rqst_referenced_dataset_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-54
ETS_update_state_delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-54
ETS_released_status_type_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-55
ETS_trans_rqst_user_exit_states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-55
IMAN_capture_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-55
CATIA_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-56
CATIA_checkin_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-56
COMMONcatiatojt_CATPart_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-57
COMMONcatiatojt_CATProduct_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-57
COMMONcatiatojt_ets_ds_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-58
CATIA_work_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-58
CATIA_V4_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-58
CATIA_V4_checkin_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-59
COMMONcatiatojt_catia_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-59
COMMONcatiatojtV4_ets_ds_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-60
IMAN_Drawing_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-60
UGMASTER_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-61
UGPART_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-61
UGSsetobmp_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-61
UGSsetojpg_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-62
UGSsetojt_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-62
UGSsetotif_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-63
UGSsetopdf_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-63
UGSsetoxt_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-64
UGSsetostep_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-64
UGSsetostl_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-65
UGSsetoemf_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-65
UGSsetodxf_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-66

PLM00026 11.2 Preferences and Environment Variables Reference

 UGSsetodwg_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-66
UGSsetosat_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-67
UGSsetoigs_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-67
UGSsetoplmxml_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-68
UGSsetoxgl_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-68
UGSvisprint_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-69
UGSsetojt_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-69
UGSsetobmp_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . 6-70
UGSsetojpg_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . 6-71
UGSsetotif_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . . 6-71
UGSsetopdf_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . 6-72
UGSsetoxt_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . . 6-72
UGSsetostep_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . 6-73
UGSsetostl_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . . 6-73
UGSsetoemf_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . 6-74
UGSsetodxf_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . 6-74
UGSsetodwg_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . 6-75
UGSsetosat_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . 6-75
UGSsetoigs_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . 6-76
UGSsetoplmxml_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . 6-76
UGSsetoxgl_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . 6-77
UGSvisprint_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . . . . 6-77
UGSsetojt_ets_ds_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-78
UGSsetopdf_ets_ds_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-78
UGSsetoplmxml_ets_ds_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-79
UGSsetojpg_ets_ds_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-79
UGSsetojt_<dataset>_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-80
UGSsetobmp_<dataset>_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-80
UGSsetojpg_<dataset>_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-81
UGSsetotif_<dataset>_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-82
UGSsetopdf_SE Draft_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-82
UGSsetoxt_<dataset>_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-83
UGSsetostep_<dataset>_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-83
UGSsetostl_<dataset>_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-84
UGSsetodxf_SE Draft_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-85
UGSsetosat_<dataset>_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-85
UGSsetoigs_<dataset>_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-86
UGSsetoplmxml_<dataset>_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-86
UGSsetoxgl_<dataset>_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-87
UGSvisprint_PDF_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-88
UGSsetojt_<dataset>_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-88
UGSsetobmp_<dataset>_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-89
UGSsetojpg_<dataset>_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-89
UGSsetotif_<dataset>_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-90
UGSsetopdf_SE Draft_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-91
UGSsetoxt_<dataset>_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-91
UGSsetostep_<dataset>_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-92
UGSsetostl_<dataset>_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-92
UGSsetoemf_SE Draft_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-93

Preferences and Environment Variables Reference PLM00026 11.2

 UGSsetodxf_SE Draft_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-93
UGSsetodwg_SE Draft_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-94
UGSsetosat_<dataset>_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-94
UGSsetoigs_<dataset>_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-95
UGSsetoplmxml_<dataset>_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-95
UGSsetoxgl_<dataset>_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-96
UGSvisprint_<dataset>_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-96
UGSsetojt_<dataset>_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-97
UGSsetobmp_<dataset>_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-98
UGSsetojpg_<dataset>_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-98
UGSsetotif_<dataset>_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-99
UGSsetopdf_SE Draft_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-99
UGSsetoxt_<dataset>_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-100
UGSsetostep_<dataset>_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-100
UGSsetostl_<dataset>_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-101
UGSsetoemf_SE Draft_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-101
UGSsetodxf_SE Draft_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-102
UGSsetodwg_SE Draft_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-102
UGSsetosat_<dataset>_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-102
UGSsetoigs_<dataset>_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-103
UGSsetoplmxml_<dataset>_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . 6-103
UGSsetoxgl_<dataset>_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-104
UGSvisprint_PDF_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-104
UGSsetojt_<dataset>_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-105
UGSsetobmp_<dataset>_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-105
UGSsetojpg_<dataset>_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-106
UGSsetotif_<dataset>_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-107
UGSsetopdf_SE Draft_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-107
UGSsetoxt_<dataset>_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-108
UGSsetostep_<dataset>_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-108
UGSsetoemf_SE Draft_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-109
UGSsetodxf_SE Draft_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-109
UGSsetodwg_SE Draft_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-109
UGSsetosat_<dataset>_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-110
UGSsetoigs_<dataset>_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-110
UGSsetoplmxml_<dataset>_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-111
UGSsetoxgl_<dataset>_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-112
UGSvisprint_<dataset>_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-112
UGSsetojt_<dataset>_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-113
UGSsetobmp_<dataset>_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-113
UGSsetojpg_<dataset>_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-114
UGSsetotif_<dataset>_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-114
UGSsetopdf_SE Draft_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-115
UGSsetoxt_<dataset>_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-115
UGSsetostep_<dataset>_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-116
UGSsetostl_<dataset>_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-116
UGSsetoemf_SE Draft_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-117
UGSsetodxf_SE Draft_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-117
UGSsetodwg_SE Draft_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-118

PLM00026 11.2 Preferences and Environment Variables Reference

 UGSsetosat_<dataset>_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-118
UGSsetoigs_<dataset>_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-119
UGSsetoplmxml_<dataset>_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-119
UGSsetoxgl_<dataset>_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-120
UGSvisprint_<dataset>_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-120
UGSvisprint_ets_ds_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-121
VIS_simpgen_admin_group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-121
ETS.PRIORITY.<ProviderName>.<ServiceName> . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-122
ETS.DATASETTYPES.<ProviderName>.<ServiceName> . . . . . . . . . . . . . . . . . . . . . . 6-122
ETS.TRANSLATOR_ARGS.<ProviderName>.<ServiceName> . . . . . . . . . . . . . . . . . . 6-122
SIEMENStozipfile_ets_ds_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-123
SIEMENStozipfile_MSWord_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-123
SIEMENStozipfile_MSWord_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-123
SIEMENStozipfile_MSWord_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-124
SIEMENStozipfile_MSWord_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . . 6-124
SIEMENStozipfile_MSWord_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . . 6-124
SIEMENStozipfile_MSWordX_ets_dst_ds_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-125
SIEMENStozipfile_MSWordX_ets_dst_nr_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-125
SIEMENStozipfile_MSWordX_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-125
SIEMENStozipfile_MSWordX_ets_dst_relation_type . . . . . . . . . . . . . . . . . . . . . . . . . 6-126
SIEMENStozipfile_MSWordX_ets_dst_relation_to_src . . . . . . . . . . . . . . . . . . . . . . . . 6-126
TS_successful_states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-127
TS_unsuccessful_states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-127
TS_inprocess_states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-127
ETS_trans_rqst_referenced_dataset_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-128
ETS.SCOTYPES.SIEMENS.POPULATEFSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-128
ETS.ITEMREVTYPES.SIEMENS.SIMPGEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-129
DISPATCHER_rqst_cancel_referenced_services . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-129

Email polling preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-129

Fnd0EMLPollingRevFrm.JAVARENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-129
Fnd0EMLPollingRevFrm.FORMJAVARENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . 6-130
Email_polling_download_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-130
Fnd0_review_email_attachments_workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-130
EMLPOLLING_default_polling_config_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-131
Mail_server_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-131
TC_mail_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-132

Full-text search preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-132

TC_fts_aci_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-132
TC_fts_any_language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-132
TC_fts_database_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-133
TC_fts_default_AND_operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-134
TC_fts_default_language_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-134
TC_fts_enforce_master_language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-135
TC_fts_engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-135
TC_fts_fsf_host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-136
TC_fts_fsf_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-137
TC_fts_hierarchical_index_delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-137
TC_fts_host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-138

Preferences and Environment Variables Reference PLM00026 11.2

 TC_fts_index_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-138
TC_fts_index_retries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-139
TC_fts_index_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-139
TC_fts_indexed_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-140
TC_fts_indexing_wait_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-140
TC_fts_max_results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-140
TC_fts_query_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-141
TC_fts_realtime_delete_cache_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-141
TC_fts_real_time_indexing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-142
TC_fts_realtime_index_dt_cache_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-142
TC_fts_realtime_index_item_cache_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-142
TC_fts_result_latest_ItemRevision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-143
TC_fts_service_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-143
TC_fts_shared_tmp_dir_autonomy_path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-144
TC_fts_shared_tmp_dir_unix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-144
TC_fts_shared_tmp_dir_wnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-145
TC_fts_supported_files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-146
TC_fts_synonym_search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-146
TC_fts_use_shared_tmp_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-146
TC_fts_windows_autonomy_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-147
<TypeName>_indexed_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-147

Localization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-148

TC_language_data_entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-148
TC_language_default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-150
TC_language_force_thin_client_locale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-151
TC_language_force_thin_client_locale_no_warning . . . . . . . . . . . . . . . . . . . . . . . . . . 6-151
TC_language_localization_display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-152
TC_language_localized_property_value_display . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-152
TC_language_localized_property_value_entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-153
TC_language_no_encoding_discrepancy_warning_message . . . . . . . . . . . . . . . . . . . 6-154

Mail gateway preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-155

Folder_mail_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-155
Mail_internal_mail_activated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-155
Mail_send_file_attachments_activated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-155
Mail_server_charset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-156
Mail_server_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-156
Mail_server_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-156
Mail_OSMail_activated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-157
TC_use_tc_alias_in_pa8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-157
TC_mail_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-158

NX Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-158

NX Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-158
Preferences set in the .tc_preferences.xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-158
API_ugpart_attr_titles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-158
DATASET_saveas_allow_duplicates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-159
DATASET_saveas_allow_name_modification . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-159
DATASET_saveas_always_copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-160

PLM00026 11.2 Preferences and Environment Variables Reference

 DATASET_saveas_force_name_validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-161
DATASET_saveas_never_copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-162
DATASET_saveas_owner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-162
DATASET_saveas_pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-163
<DATASET TYPE>_saveas_pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-164
NX_InterOptWithProductViewDataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-165
NX_Supports_VISSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-165
TC_default_part_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-165
TC_NX_allow_attrsync_master_with_item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-166
TC_NX_Allow_Deepcopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-167
TC_NX_ATTRIBUTES_FORM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-167
TC_NX_Database_Attributes_For_Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-167
TC_NX_DeleteMarkupsOnDrawingSheetImport . . . . . . . . . . . . . . . . . . . . . . . . . . 6-169
TC_NX_DrawingSheet_Deletion_Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-169
TC_NX_Foreign_Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-170
TC_NX_Reference_OccTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-170
TC_ugmaster_name_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-171
TC_NX_Navigator_Override_NX_Load_Option . . . . . . . . . . . . . . . . . . . . . . . . . . 6-171
TC_NX_NEW_COPY_REV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-172
TC_NX_NEW_NR_FORMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-172
TC_NX_nonmaster_additional_forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-172
TC_NX_save_precise_on_uprev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-173
TC_NX_Unit_Of_Measure_As_Geometric_List . . . . . . . . . . . . . . . . . . . . . . . . . . 6-173
TC_NX_Unit_Of_Measure_Each_List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-174
TC_NX_UPDATE_ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-174
TC_NX_View_Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-175
TC_SPSD_FOLDER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-175
TC_SPSD_FOLDER_PATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-176
TC_USE_TEST_ATTR_MAPPINGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-176
Preferences set in the .tc_ugman_env file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-176
UGMAN_InsertItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-176
UGMAN_PartType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-177
UGMAN_ShowPartType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-177
UGMAN_UGPARTNameWRev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-177
Preferences set in the ug_english.def file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-178
UGhookupStructureUpdateOnSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-178
UGhookupStructureUpdateOnLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-178
UGhookupPartDisplayPreference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-178
Preferences set in the .ugii_env file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-179
TRACE_BACK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-179
UGII_KEEP_SYSTEM_LOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-179
UGII_OPTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-179
UGII_TMP_DIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-180

Password preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-180

About password preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-180
PASSWORD_minimum_characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-181
PASSWORD_special_characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-181
PASSWORD_mixed_case_required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-181
PASSWORD_minimum_special_chars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-182

Preferences and Environment Variables Reference PLM00026 11.2

 PASSWORD_minimum_digits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-182
PASSWORD_minimum_alpha . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-182

Product structure preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-183

BOM_enable_mem_mgt_probability_percent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-183
BOM_line_contains_IC_Absoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-184
Fnd0ItemLineLite_bl_line_name_expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-184

Search and query preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-185

Change_Search_Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-185
Default_Business_Object_To_Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-185
Default_Quick_Access_Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-185
Favorite_Business_Objects_To_Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-186
PortalDesignContextSearchEnginePreference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-186
MSS_set_display_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-186
MySearchHistory_Limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-187
QRYColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-187
QRY_dataset_display_option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-188
QRY_exception_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-188
QRY_<query_name>_SortKeys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-188
QRY_<query_name>_SortOrders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-189
QRY_search_classification_hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-189
QRY_search_type_hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-190
Quick_Access_Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-190
Quick_Access_Queries_Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-191
QuickSearchesQueries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-191
search_automatic_wildcard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-192
Searchable_Business_Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-192
SEARCH_RESULT_LOAD_ALL_LIMIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-193
TC_ignore_case_on_search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-193
TC_language_search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-193
TC_QRY_display_latest_dataset_only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-195
QRY_<query_name>_REVRULE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-195
TC_QRY_search_by_rev_rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-195
TC_QRY_search_result_display_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-196
Open_previous_open_search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-196
WEB_max_search_results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-197
WEB_simple_search_default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-197
WEB_simple_search_queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-197
Where_Ref_Avoid_Duplicate_Expansion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-198
WSOM_find_editUserList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-198
WSOM_find_list_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-198
WSOM_find_set_pff_displaydata_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-199
WSOM_find_set_search_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-199

Teamcenter services preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-200

SOA_MaxOperationBracketInactiveTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-200
SOA_MaxOperationBracketTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-200

Solid Edge integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-201

PLM00026 11.2 Preferences and Environment Variables Reference

 SE_TO_PDF_WORKING_DIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-201
SE_TO_PDF_EXECUTABLE_DIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-201
SE_PDF_GEN_WAITING_PERIOD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-201

Remote workflow preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-202

TC_external_local_app_guid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-202
TC_external_proxiable_objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-202
TC_external_proxiable_objects_props . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-203
TC_external_Requirements_proxy_props_internal . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-203
TC_external_Requirements_proxy_props_external . . . . . . . . . . . . . . . . . . . . . . . . . . 6-204
IMAN_external_appl_reg_url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-204
TC_external_application_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-204
TC_external_application_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-205

Teamcenter LDAP synchronization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-205

Teamcenter LDAP synchronization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-205
LDAP connection preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-206
LDAP_service_hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-206
LDAP_port_number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-206
LDAP_use_ssl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-206
LDAP_cert_db_path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-207
LDAP_admin_dn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-207
LDAP_admin_pw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-208
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-208
Synchronization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-208
LDAP_sync_user_flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-208
LDAP_sync_group_flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-209
LDAP_sync_member_flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-209
LDAP_sync_role_flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-210
LDAP_member_list_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-211
LDAP_member_type_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-211
LDAP_object_type_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-212
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-212
Group object mapping preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-212
LDAP_group_base_dn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-212
LDAP_group_query_filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-213
LDAP_group_object_class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-213
LDAP_group_attr_mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-214
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-214
Role object mapping preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-214
LDAP_role_query_filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-214
LDAP_role_object_class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-215
LDAP_role_attr_mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-215
User and person object mapping preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-216
LDAP_attribute_mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-216
LDAP_base_dn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-217
LDAP_ignore_users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-217
LDAP_user_query_filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-218
LDAP_user_object_class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-218
LDAP_person_attr_mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-218

Preferences and Environment Variables Reference PLM00026 11.2

 Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-219

PLM00026 11.2 Preferences and Environment Variables Reference

Chapter 6: Configuration preferences

Business Modeler IDE preferences

Finding Business Modeler IDE preferences

Business Modeler IDE preferences allow you to modify the behavior of Business Modeler IDE data
model objects. To see preferences, in the My Teamcenter application in the rich client, choose
Edit→Options and at the bottom of the Options dialog box click the Filters link or the Search link.

AltIdentifier_require_on_create

DESCRIPTION
Determines whether an alternate identifier is required when creating an identifiable of
the type specified in this preference in a rich client session. Valid values are to a set of
Item types. If an item type is included in this preference, whenever the item revision
associated with this type is created in the rich client, an alternate is required.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter item
type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ASSIGNED_ITEM_ID_MODIFIABLE

DESCRIPTION
Determines whether an automatically generated item ID can be modified by users after
it has been generated.
VALID
VALUES
0 When the item ID is generated by clicking the Assign button, the system
generated item ID cannot be modified by the user.
1 When the item ID is generated by clicking the Assign button, the system
generated item ID can be modified by the user.
DEFAULT
VALUES
0

PLM00026 11.2 Preferences and Environment Variables Reference 6-1

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ASSIGNED_ITEM_REV_MODIFIABLE

DESCRIPTION
Determines whether an automatically generated item revision ID can be modified by
users after it has been generated.
VALID
VALUES
0 When the item revision ID is generated by clicking the Assign button, the
system generated item revision ID cannot be modified by the user.
1 When the item revision ID is generated by clicking the Assign button, the
system generated item revision ID can be modified by the user.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

BMF_BYPASS_ALL_EXTENSION_RULES

DESCRIPTION
Allows you to override the existing extension rules.
Note

This preference can be set using the preference name as an environment

variable.

VALID
VALUES
true You can change the extension rules.
false You cannot change the extension rules.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
System preference.

6-2 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

BMF_CUSTOM_IMPLEMENTOR_PATH

DESCRIPTION
Defines the full path to custom libraries where any custom methods for the Business
Modeler IDE framework are maintained. Alternatively, you can add the custom libraries
to a directory in your system PATH environment variable (for example, TC_BIN).
Multiple path definitions are allowed in this preference, and you can define both
Windows and UNIX/Linux paths at the same time. The application only loads those
that match the current server platform. This preference needs to be set so that the
application knows where to look for custom extensions. Once set, close the rich client
and start it again to load the new site preference values.
VALID
VALUES
Accepts a single string as value. Must be a valid file location.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

BMF_SUPPRESS_ACTION_RULES_DISPLAY

DESCRIPTION
Determines whether to display the Action Rules tab in the Business Modeler IDE
application. Use this tab to configure canned methods. These methods were moved
to the Extensions Rules tab during Teamcenter 2005. If your site created custom
canned methods, however, these custom methods cannot be converted to extension
rules without implementation details such as function name, library, and so on, for
creating an extension. Thus action rules and the Action Rules tab are still supported.
VALID
VALUES
ON Suppresses the Action Rules tab in the Business Modeler IDE application.
OFF Does not suppress the Action Rules tab in the Business Modeler IDE
application.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

BMIDE_ALLOW_FULL_DEPLOY_FROM_CLIENT

DESCRIPTION
Determines whether Business Modeler IDE clients can deploy templates to the
server that contain the full data model, including schema definitions such as classes,
attributes, business objects, properties, and so on.

PLM00026 11.2 Preferences and Environment Variables Reference 6-3

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Set this preference to False so that the schema on a production server cannot be
inadvertently updated from a Business Modeler IDE client. When you use this setting,
you must schedule a server down time to update the schema using the Teamcenter
Environment Manager install wizard. With this setting, you can still use the live
update functionality in the Business Modeler IDE to update non-schema data on the
production server.
Set this preference to True to deploy all data model, including schema changes. This
is typical when you are deploying to a test server where the number of users are
few and updates occur more frequently.
VALID
VALUES
True Allows any Business Modeler IDE client with administrative access to update
the schema, business objects, business rules, and other Business Modeler
IDE objects on the server.
False No Business Modeler IDE client can update the server directly. Templates
must be updated using the Teamcenter Environment Manager install wizard.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

BMIDE_ALLOW_LIVE_UPDATES

DESCRIPTION
Allows live update deployment from the Business Modeler IDE and Teamcenter
Environment Manager (TEM). This preference is set to true when you select the
Allow Live Updates check box on the Live Update preference. You cannot change
this preference directly.
VALID
VALUES
true Allows live updates from the Business Modeler IDE and TEM.
false Prevents live updates from the Business Modeler IDE and TEM.
In this case, updates to a production server can be made only during system
downtime by installing a template using the full deployment feature in TEM.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

6-4 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Bypass_property_rules

DESCRIPTION
Determines whether property rules defined in Business Modeler IDE are bypassed.
VALID
VALUES
0 Property rules are not bypassed.
1 Property rules are bypassed.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

BYPASS_RULES

DESCRIPTION
Allows you to override the existing naming rules.
Note

This preference can be set using the preference name as an environment

variable.

VALID
VALUES
true You can change the naming rules.
false You cannot change the naming rules.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
System preference.

IdentifierContextPref

DESCRIPTION
Defines the separator between the ID or revision ID and the context name in the
object_str property of an identifier.
VALID
VALUES
Accepts a single character as a value.
DEFAULT
VALUES
@

PLM00026 11.2 Preferences and Environment Variables Reference 6-5

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

IDENTIFIER_deepcopy_types_revise

DESCRIPTION
Lists the Identifier business object types that are permitted to be revised when an item
is revised. Identifier business object types are used to define alternate IDs for items.
VALID
VALUES
Accepts identifier and identifier revision business object types, for example:
Identfier
IdentifierRev

You can also list custom identifier business object types, for example:
G5MyIdentfier
G5MyIdentifierRev
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IdentifierLengthPref

DESCRIPTION
Restricts the maximum length of the ID Context Name in the object_str property
of an identifier.
VALID
VALUES
Accepts a single string as a value. Must be a positive integer. The maximum value is
240. (The maximum length of the ID Context Name is 32 characters.)
DEFAULT
VALUES
7
DEFAULT
PROTECTION
SCOPE
User preference.

ITEM_autogenerate_id

DESCRIPTION
Determines whether an initial ID is automatically created when creating an item of the
type specified in this preference in a rich client session.

6-6 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Caution

This preference is deprecated.

VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter item
type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Live Update

DESCRIPTION
Specifies the data model elements to enable for live update.
Select the Allow Live Updates check box to set the BMIDE_ALLOW_LIVE_UPDATES
preference and allow live update deployment from the Business Modeler IDE and
Teamcenter Environment Manager (TEM).
VALID
VALUES
To select the elements to allow for live update, move them from the Available list on
the left to the Selected for Live Updates list on the right:
Alias ID Rule
Alternate ID Rule
Application Extension Point
Application Extension Rule
Business Context
Business Object Constant
Business Object Constant Value Override
Change
Condition
Deep Copy Rule
Dispatcher Service Config
Display Rule
EDA Derived Data
Event Type
Event Type Mapping
Functionality
GRM Rule
Global Constant
Global Constant Value Override
Icon
ID Context
IRDC
LOV

PLM00026 11.2 Preferences and Environment Variables Reference 6-7

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

LOV Attachment
Localization
Naming Rule
Naming Rule Attachment
Occurrence Type
Print Configuration
Property Constant
Property Constant Value Override
Property Renderer
Revision Naming Rule
Status
Storage Media
System Stamp Configuration
Tool
Unit of Measure
Verification Rule
View Type

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

METHOD_CM_execute_before_custom

DESCRIPTION
Determines whether all canned methods are executed at a site before site custom
methods or after site custom methods.
VALID
VALUES
0 All canned methods are registered after site custom methods are registered.

1 All canned methods are registered before site custom methods are registered.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

NR_BYPASS

DESCRIPTION
Allows you to bypass naming rules, when your group is the System Administrator
group.

6-8 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Note

This preference can be set using the preference name as an environment

variable.

VALID
VALUES
True Allows system administrators to bypass naming rules.
False Prevents system administrators from bypassing naming rules.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
System preference.

TC_dataset_deep_copy_rules

DESCRIPTION
Defines which dataset business objects are deep copied when using either the Save
As or Revise command on the primary dataset. A deep copy creates copies of not
only the primary dataset, but also secondary datasets. Use this preference to define
the deep copy of the primary dataset business object, the secondary dataset business
object, and the relation with which the latter is attached to the former.
Note

This preference is deprecated. The recommended best practice is to replace

this preference with deep copy rules in the Business Modeler IDE. Although a
deep copy during the revise action continues to process this preference, the
system ignores preferences with conflicting deep copy rule configurations.

VALID
VALUES
Accepts multiple strings as values. Each value must specify a valid primary dataset,
secondary dataset, and relation in the following format:
primary dataset type:relation type:secondary dataset type
primary dataset type is the dataset attached to the item revision, secondary dataset
type is the dataset business object associated with the primary dataset type, and
relation type is the relation with which the secondary dataset is associated with the
primary dataset. For example:
UGMASTER:IMAN_Rendering:DirectModel
This value specifies that when the Save As or Revise command is performed on a
UGMASTER dataset, any secondary IMAN_Rendering datasets attached with the
DirectModel relation are also copied.
This preference accepts the asterisk (*) character as a wildcard. Use the following
setting to allow deep copy of all primary datasets with any attached secondary dataset
using any relation:

PLM00026 11.2 Preferences and Environment Variables Reference 6-9

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

*:*:*
DEFAULT
VALUES
UGMASTER:IMAN_Rendering:DirectModel
UGPART:IMAN_Rendering: DirectModel
UGALTREP:IMAN_Rendering:DirectModel
DirectModel:TC_Derived:NXDerived
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_KEY_STRING_DELIMITER_VALUES

DESCRIPTION
Sets the delimiters used in the input for multifield key utility arguments.
Set the preference value as two characters you want to use as delimiters. The first
character is the delimiter for separating entries, and the second is for separating the
name and value. If the preference is not set, the system uses the ,= characters as
shown in the following example of input for the get_key_string utility:
item_id=123456,object_type=Document

If you set the preference to $#, the input is:

item_id#123456$object_type#Document

Note

This preference is not created by the Teamcenter installation process. If you

require this functionality, you must create the preference.

VALID
VALUES
Any two ASCII characters.
DEFAULT
VALUES
,=
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_MFK_DEFAULT_DOMAIN

DESCRIPTION
Defines the domain used by the ITEM_find_item ITK function where the multifield
key unique identifier is not used. Using this preference ensures that external CAD
applications that are not multifield key compliant can locate objects in Teamcenter.
A valid value is a domain name. A domain name is the same as the business object
type where the multifield definition is specified (for example, Item). The operation

6-10 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

searches among object types in the specified domain. The multifield key unique
identifier must be item_id for this domain.
VALID
VALUES
A multifield key domain name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Treat_Curr_Rev_As_Any_Rev

DESCRIPTION
Sets the current revision letter for a new revision in a revision naming rule. This
preference applies to CurrentRevLetter revision naming rules.
VALID
VALUES
True Allows the administrator creating a revision naming rule to type any letter
to override the current revision letter (except the letters controlled by the
TcRevisionSkipLetters LOV).

False Prevents administrators from changing the current revision letter.

DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

Treat_Next_Rev_As_Any_Rev

DESCRIPTION
Sets the next revision letter for a new revision in a revision naming rule. This
preference applies to NextRevLetter revision naming rules.
VALID
VALUES
True Allows the administrator creating a revision naming rule to type any letter
to override the next revision letter (except the letters controlled by the
TcRevisionSkipLetters LOV).

False Prevents administrators from changing the next revision letter.

DEFAULT
VALUES
True

PLM00026 11.2 Preferences and Environment Variables Reference 6-11

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TYPE_DISPLAY_RULES_list_of_primary_types

DESCRIPTION
Defines the list of primary business objects on which display rules can be configured in
Business Modeler IDE.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid primary type.
DEFAULT
VALUES
Item
Folder
Dataset
Form
MEOP
MEActivity
MEWorkArea
MEProcess
Identifier
DEFAULT
PROTECTION
SCOPE
Site preference.

TYPE_DISPLAY_RULES_list_types_of_subclasses

DESCRIPTION
Shows business object display rules propagated from the sub-business objects
defined in the list of business objects in the preference.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid primary type.
DEFAULT
VALUES
Identifier
CAEItem
CAEAnalysis
CAEGeometry
CAEModel
Drawing
FND_TraceLink
CCObject
StructureContext
ConfigurationContext
MEActivity

6-12 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

ApperanceGroup

DEFAULT
PROTECTION
SCOPE
Site preference.

Client interface preferences

Confirmation_shown_on_reservation_dialogs

DESCRIPTION
Specifies whether a Don’t show confirmation dialog again check box is displayed
in the Check-Out, Cancel Check-Out, and Check-In dialog boxes in the rich client
and thin client.
VALID
VALUES
true The Don’t show confirmation dialog again check box is displayed.
false The Don’t show confirmation dialog again check box is not displayed.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

Confirm_cancel_checkout_suppressed

DESCRIPTION
Specifies whether the Don’t show confirmation dialog again check box is selected
in the Cancel Check-Out dialog box in the rich client and thin client.
VALID
VALUES
true The check box is selected and cancel checkout proceeds without confirmation.
false The check box is not selected and cancel checkout requires confirmation.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-13

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Confirm_checkin_suppressed

DESCRIPTION
Specifies whether the Don’t show confirmation dialog again check box is selected
in the Check-In dialog box in the rich client and thin client.
VALID
VALUES
true The check box is selected and checkin proceeds without confirmation.

false The check box is not selected and checkin requires confirmation.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

Confirm_checkout_suppressed

DESCRIPTION
Specifies whether the Don’t show confirmation dialog again check box is selected
in the Check-Out dialog box in the rich client and thin client.
VALID
VALUES
true The check box is selected and checkout proceeds without confirmation.

false The check box is not selected and checkout requires confirmation.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

Form_double_click

DESCRIPTION
Specifies, in the rich client and thin client, whether a double-click action on a form
object opens the form in edit mode or view mode.
VALID
VALUES
View Double-click to view objects.

Edit Double-click to edit objects.

DEFAULT
VALUES
View

6-14 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

Excel_Office_Launchable_TcTypes

DESCRIPTION
Specifies business object types required to launch documents from Client for Office
in Microsoft Excel.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Office dataset type.
DEFAULT
VALUE
MSWord
MSWordX
MSWordTemplateX
MSWordTemplate
MSPowerPointX
MSPowerPoint
MSPowerPointTemplate
Outloook
DEFAULT
PROTECTION
SCOPE
Site preference.

Excel_ViewMarkup_Launchable_TcTypes

DESCRIPTION
Defines the Teamcenter types that can be launched for view and markup from
Microsoft Excel.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid PDF dataset type
or Office dataset type that supports view and markup.
DEFAULT
VALUES
MSWord
MSWordX
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-15

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

HTMLStylesheetIncludes

DESCRIPTION
Defines the list of include files to automatically insert into the generated HTML source
when HTML style sheets are used to render the user interface. To use HTML style
sheets to render the user interface, set the UsePropertyStylesheetPlatformRenderer
preference.
For more information about style sheets, see Client Customization.
VALID
VALUES
Fully formed calls to files such as HTML, CSS, JavaScript, and images.
DEFAULT
VALUES
<link href="teamcenter/html_xrt/style/summary.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript"
src="teamcenter/html_xrt/scripts/yui_3.6.0/build/yui/yui-min.js" >
</script>
<script type="text/javascript"
src="teamcenter/html_xrt/scripts/yui_2.9.0/build/yuiloader/yuiloader-min.js" >
</script>
<script type="text/javascript"
src="teamcenter/html_xrt/scripts/knockout-2.1.0.js">
</script>
<script type="text/javascript"
src="teamcenter/html_xrt/scripts/layout/summaryPageLayoutHandler.js">
</script>
<--script type="text/javascript"
src="teamcenter/html_xrt/scripts/mockhost/mockhost.js"-->
<script type="text/javascript"
src="teamcenter/html_xrt/scripts/TcViewModel.js">
</script>
<script type="text/javascript"
src="teamcenter/html_xrt/scripts/calendar.js">
</script>
<script type="text/javascript"
src="teamcenter/html_xrt/scripts/dlov.js">
</script>

DEFAULT
PROTECTION
SCOPE
Site preference.

HTMLStylesheetSharedLibs

DESCRIPTION
Specifies the ZIP datasets downloaded by clients that are required to render style
sheets to HTML output when using HTML style sheets. The ZIP datasets contain
all shared files (HTML, CSS, JavaScript, images, and so on) used by the HTML
style sheets. To use HTML style sheets to render the user interface, set the
UsePropertyStylesheetPlatformRenderer preference.
For more information about style sheets, see Client Customization.
VALID
VALUES
Names of ZIP dataset files.
DEFAULT
VALUES
HTMLStylesheetData

HTMLStylesheetThirdPartyData

6-16 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

HTMLStylesheetUnsupportedRenderingHints

DESCRIPTION
Defines all rendering hints that are unsupported as HTML when using HTML style
sheets. If a hint in this list is encountered in an XML rendering style sheet file, XML
rendering is returned if the client supports XRT rendering. Otherwise, it is rendered
as a string in HTML. To use HTML style sheets to render the user interface, set the
UsePropertyStylesheetPlatformRenderer preference.

For more information about style sheets, see Client Customization.

VALID
VALUES
Names of rendering hints.

For the names of rendering hints, see Client Customization.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

LHN_Nav_Items_List

DESCRIPTION
Specifies rich client navigation pane section order and whether each section is
expanded, collapsed, or displayed at startup.
VALID
VALUES
SearchSection:[true/false]
QuickLinksSection:[true/false]
OpenItemsSection:[true/false]
HistorySection:[true/false]
FavoritesSection:[true/false]
IWantToSection:[true/false]
DEFAULT
VALUES
SearchSection:true
QuickLinksSection:true
OpenItemsSection:true
HistorySection:true
FavoritesSection:true
IWantToSection:true

PLM00026 11.2 Preferences and Environment Variables Reference 6-17

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

LOV_hide_desc

DESCRIPTION
Determines whether side-by-side LOV value/descriptions appear. By default, LOVs
are configured to display the value alongside its description in the user interface. Use
this preference to specify specific LOVs whose descriptions you do not want to display.
Note

The simplest method for defining side-by-side display behavior is by using the
Options dialog box, accessed from the Edit menu. Use this dialog box to set
the LOVs whose value/descriptions you do not want to display side-by-side.
The system automatically writes this setting to the user preference file.

For more information about configuring LOV value/descriptions, see Business Modeler
IDE.
For more information about using the Options dialog box, see Teamcenter Basics.
VALID
VALUES
Accepts multiple strings as values. Each entry indicates an LOV whose
value/description does not display side-by-side. Each string must be the name of a
valid LOV. For example:
LOV_hide_desc=
LOV_name1
LOV_name2

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

LOV_value_desc_separator

DESCRIPTION
Specifies the character to separate LOV values from their descriptions.
Note

The separator is used only by the thin client because a table format is now used
in the rich client to display LOV values and their descriptions.

VALID
VALUES
A single ASCII character.

6-18 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
The default separator is the comma (,) unless the value-description pairs are created
as an interdependent LOV.
When the value-description pairs are created as an interdependent LOV, the default
separator is the forward-slash character (/).
DEFAULT
PROTECTION
SCOPE
Site preference.

OCS_company_email_domain

DESCRIPTION
For the Teamcenter integration with Microsoft Office Communicator, specifies the
company domain name for messages, but only when the OCS_use_email_property
preference value is false.
VALID
VALUES
Any valid e-mail domain.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
EXAMPLE
The e-mail ID for a specific user is user_name@email_domain.
The Person object user name is john_smith and the value of the
OCS_company_email_domain preference is domain is @company_xyz.com, so the
e-mail ID is john_smith@company_xyz.com.

OCS_use_email_property

DESCRIPTION
For the Teamcenter integration with Microsoft Office Communicator, specifies whether
to use the e-mail ID from the e-mail ID field of the user Person object.
VALID
VALUES
true The e-mail ID is taken from the user Person object e-mail data. This is the
default.
false The e-mail ID consists of the user ID and the value of the
OCS_company_email_domain preference.
DEFAULT
VALUE
true

PLM00026 11.2 Preferences and Environment Variables Reference 6-19

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

OCS_use_presence_display

DESCRIPTION
Enables the Teamcenter integration with Microsoft Office Communicator.
VALID
VALUES
true Teamcenter integration with Microsoft Office Communicator functionality is
enabled. This is the default.

false Teamcenter integration with Microsoft Office Communicator functionality is

not enabled.
DEFAULT
VALUE
true
DEFAULT
PROTECTION
SCOPE
Site preference.

Outlook_Office_Launchable_TcTypes

DESCRIPTION
Specifies business object types required to launch documents from Client for Office
in Microsoft Excel.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Office dataset type.
DEFAULT
VALUE
MSWord
MSWordX
MSWordTemplateX
MSWordTemplate
MSPowerPointX
MSPowerPoint
MSPowerPointTemplate
MSExcel
MSExcelX
MSExcelTemplateX
MSExcelTemplate
DEFAULT
PROTECTION
SCOPE
Site preference.

6-20 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Outlook_Sign_Launchable_TcTypes

DESCRIPTION
Defines the Teamcenter types that launch for a digital signature from Microsoft Outlook.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid PDF dataset type.
Note

While PDF can be launched, Microsoft Outlook must remain running to save the
signed PDF file to Teamcenter from Adobe Acrobat or Adobe Reader.

DEFAULT
VALUES
PDF
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
This preference provides limited support for digital signatures, excluding Office dataset
types, until future versions.

Outlook_ViewMarkup_Launchable_TcTypes

DESCRIPTION
Defines the Teamcenter types that launch for view and markup from Microsoft Outlook.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid PDF dataset type
or Office dataset type that supports view and markup.
Note

While PDF can be launched, Microsoft Office must remain running to save the
markup file to Teamcenter from Adobe Acrobat or Adobe Reader.

DEFAULT
VALUES
MSWord
MSWordX
PDF
DEFAULT
PROTECTION
SCOPE
Site preference.

PowerPoint_Office_Launchable_TcTypes

DESCRIPTION
Specifies business object types required to launch documents from Client for Office
in Microsoft PowerPoint.

PLM00026 11.2 Preferences and Environment Variables Reference 6-21

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Office dataset type.
DEFAULT
VALUE
MSWord
MSWordX
MSWordTemplateX
MSWordTemplate
MSExcel
MSExcelX
MSExcelTemplateX
Outlook
DEFAULT
PROTECTION
SCOPE
Site preference.

PowerPoint_ViewMarkup_Launchable_TcTypes

DESCRIPTION
Defines the Teamcenter types that launch for view and markup from Microsoft
PowerPoint.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Office dataset type
that supports view and markup.
DEFAULT
VALUES
MSWord
MSWordX
DEFAULT
PROTECTION
SCOPE
Site preference.

Show_Checkout_option

DESCRIPTION
Controls the availability of the check out option when exporting Teamcenter objects
using live Microsoft Word or Excel.
VALID
VALUES
true The Check out objects before export option in the Export to Word and the
Export to Excel dialog boxes is available. You can check out the Teamcenter
data before exporting to Microsoft Word or Excel.
false The Check out objects before export option in the Export to Word and the
Export to Excel dialog boxes is not available. There is no option to check out
the Teamcenter data before exporting to Microsoft Word or Excel.

6-22 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TCDigitalSigningApplicationPref

DESCRIPTION
Defines the priority list of applications used by the Digitally Sign command on the
selected base datasets.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid tool object name,
for example, PDF_Tool.
Note

Only a tool name that is digital signature capable (Digital Signature Capable
option is selected) is valid.

DEFAULT
VALUES
PDF_Tool
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
Enter the tools in the order of preference.

UsePropertyStylesheetPlatformRenderer

DESCRIPTION
Defines whether XML or HTML style sheets are used to render objects in the summary,
form, create, and save as dialog boxes in Teamcenter clients. When set to false,
XML style sheets are automatically rendered to HTML. (This preference is ignored for
Teamcenter Client for Microsoft Office.)
Use the following preferences to configure HTML style sheets:
HTMLStylesheetIncludes
HTMLStylesheetSharedLibs
HTMLStylesheetUnsupportedRenderingHints

For more information about style sheets, see Client Customization.

VALID
VALUES
true Use XML rendering style sheets.
false Use HTML style sheets.

PLM00026 11.2 Preferences and Environment Variables Reference 6-23

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

Word_Export_TcTypes

DESCRIPTION
Specifies the object types that are available for selection in the Override Object
Template for list of the Export to Word dialog box. For the current export operation,
the selected object type can be associated with an object template other than that
which is assigned by default.
The user selects the alternative template in the Available Object Templates pane
of the Export to Word dialog box. That template defines which property values are
exported for objects of the selected type.
VALID
VALUES
Accepts one or more strings as values. Each string must be the real name of an
existing object type.
Note

For each object type specified in the value, all subtypes are included in the
Override Object Template for list automatically.

DEFAULT
VALUES
SpecElementRevision
FunctionalityRevision
Fnd0SEBlockRevision
Fnd0DiagramRevision
RequirementSpecRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

6-24 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Word_Office_Launchable_TcTypes

DESCRIPTION
Teamcenter types that Client for Office in Microsoft Word requires to decide whether
to call the AppLauncher.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Office dataset type.
DEFAULT
VALUE
MSExcel
MSExcelX
MSExcelTemplateX
MSExcelTemplate
MSPowerPointX
MSPowerPoint
MSPowerPointTemplate
Outlook
DEFAULT
PROTECTION
SCOPE
Site preference.

Word_ViewMarkup_Launchable_TcTypes

DESCRIPTION
Defines the Teamcenter types that launch for view and markup from Microsoft Word.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Office dataset type
that supports view and markup.
DEFAULT
VALUES
MSWord
MSWordX
DEFAULT
PROTECTION
SCOPE
Site preference.

Word_Show_Display_Name

DESCRIPTION
Controls how requirement object names are displayed in the Requirements pane in a
Microsoft Word document in the Client for Office application.
This preference only applies to the following cases:
• Exporting Teamcenter requirement structures to live Word using the Export for
structure editing and work offline option.

PLM00026 11.2 Preferences and Environment Variables Reference 6-25

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

• Opening and loading Teamcenter requirement structures from the Teamcenter

ribbon in Microsoft Word.

VALID
VALUES
true The name of the requirement object is displayed as the DisplayName property
configured in the Business Modeler IDE.
false The name of the requirement object is displayed as a combination of the
object ID and name.
DEFAULT
VALUES
true
Note

In newly installed Teamcenter 10.1.2 environments, the default value is true.

However, it has been observed that in some upgraded Teamcenter 10.1.2
environments, the default value is false and must be adjusted manually.

DEFAULT
PROTECTION
SCOPE
Site preference.

Data management preferences

ADA_allow_license_propagation

DESCRIPTION
Enables the propagation of authorized data access (ADA) licenses from the assigned
workspace objects to their related objects. If the propagation of licenses should not
be allowed during copy actions, such as during the Save As, Revise, and Baseline
commands, clear the value of the ADA_saveas_propagated_license_types
preference.
VALID
VALUES
true Turns on the propagation of ADA licenses.
false Turns off the propagation of ADA licenses.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

6-26 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

ADA_enabled

DESCRIPTION
Enables authorized data access (ADA) features. ADA is a security solution that
complements other Teamcenter security features, such as Access Manager rules
and access control lists (ACLs).
Set this preference to True to display ITAR specific attributes to the user, based on
his current group/role settings. The user can modify the setting if his group/role grant
him write privileges.
VALID
VALUES
True Enables ADA features.
False Disables ADA features.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

ADA_saveas_propagated_license_types

DESCRIPTION
Determines which license types are propagated for ADA, based on propagation rules.
ADA is a security solution that complements other Teamcenter security features, such
as Access Manager rules and access control lists (ACLs).
VALID
VALUES
IP_License Propagates IP_License license types.
ITAR_license Propagates ITAR_License license types.
Exclude_License Propagates Exclude_License license types.
DEFAULT
VALUES
IP_License
ITAR_License
Exclude_License
DEFAULT
PROTECTION
SCOPE
Site preference.

AE_dataset_id_gen_by_type

DESCRIPTION
Determines whether a single ID counter is used for all dataset types, or individual ID
counters are used for each dataset type when a dataset is created and no item or
item revision is selected.

PLM00026 11.2 Preferences and Environment Variables Reference 6-27

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
ON Each dataset type uses its own ID counter to generate dataset IDs.
OFF A single ID counter is used to generate all dataset IDs for all dataset types.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

AE_dataset_id_postfix

DESCRIPTION
Specifies the character string used to form the suffix for the dataset ID when a dataset
is created and no item or item revision is selected.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

AE_dataset_id_prefix

DESCRIPTION
Specifies the character string used to form the prefix for the dataset ID when a dataset
is created and no item or item revision is selected.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

AE_dataset_id_separator

DESCRIPTION
Specifies the character used to separate the variables that form the dataset ID (item
ID and sequence number) when a parent item or item revision is selected. For
example, if the value is set to a dash (-), the selected item is UG001, and the next
available sequence number for the dataset type (within the UG001) is 3, the dataset ID
UG001-3 is generated.
Note

This preference is deprecated. Use the DisplayName business object constant

to specify separators instead.

6-28 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
A dash (-).
DEFAULT
PROTECTION
SCOPE
Site preference.

AE_dataset_id_usage

DESCRIPTION
Determines whether dataset identification functionality is enabled.
VALID
VALUES
ON Dataset ID and Revision ID fields are displayed as required fields in the
New Dataset and Save Dataset As dialog boxes. Automatic generation of
dataset names is disabled.
Caution

Setting site preference AE_dataset_id_usage to ON prevents Content

Management from functioning correctly.

OFF Dataset ID and Revision ID fields are not displayed. Automatic generation of
dataset names is enabled.
DEFAULT
VALUES
OFF
DEFAULT
PROTECTION
SCOPE
Site preference.

AE_dataset_id_use_rev

DESCRIPTION
Determines whether the dataset ID is derived from the item revision when a parent
item revision is selected.
VALID
VALUES
ON Dataset ID is derived from the item revision when a parent item revision
is selected.
OFF Dataset ID is not derived from the item revision when a parent item revision
is selected.
DEFAULT
VALUES
OFF
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-29

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Baseline_allowed_baserev_statuses

DESCRIPTION
Determines which status types permit a baseline to be performed on an item revision.
For example, if you set this preference with Design Approved and QA Approved
statuses, but not Released status, users could create baselines from item revisions
which had received design and QA approval status, but they could not create baselines
for released item revisions.
If no status types are defined, baselines cannot be created for any item revisions that
have been granted any status.
VALID
VALUES
Valid Teamcenter status types.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Baseline_allow_edits

DESCRIPTION
Determines whether the item ID of baselined objects can be modified. Set this
preference to ON to allow users to edit the item ID of items that have been baselined.
Once the item is released, the item ID can no longer be modified.
VALID
VALUES
ON Users can edit the item ID of items that have been baselined. Once the item is
released, the item ID can no longer be modified.

OFF Users cannot edit the item ID of baselined items.

DEFAULT
VALUES
OFF
DEFAULT
PROTECTION
SCOPE
Site preference.

Baseline_create_snapshot_folder

DESCRIPTION
Determines whether a Snapshot folder is created after a baseline operation is
performed. The new Snapshot folder is attached to the baseline revision.
Teamcenter only creates Snapshot folders for imprecise baselines. If you create a
precise baseline, it does not create a snapshot folder even if this preference is set to 1.

6-30 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
0 A Snapshot folder is not created after a baseline is created.

1 A Snapshot folder is created after a baseline is created.

DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

baselineDryRun

DESCRIPTION
Specifies whether or not the Dry Run Creation check box is active when you open the
Baseline dialog box. A dry run produces a report listing error messages encountered
while processing a single item revision or traversing a structure.
VALID
VALUES
0 The Dry Run Creation check box is not checked

1 The Dry Run Creation check box is checked

DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

Baseline_dryrun_always

DESCRIPTION
Specifies whether or not a dry run occurs before the baseline is created. A dry run
produces a report listing error messages encountered while processing a single item
revision or traversing a structure.

Note

Setting this preference does not affect the default value of the Dry Run
Creation check box on the Baseline dialog box. If you want to set the value in
the dialog box, set the Baselinedryrun preference.

This preference ensures that the dry run is performed on the server side. It also allows
for validation configurability. If you want to add site-specific data checks on the base
item revision or structure before baselining, you can do so using a pre or post action
on the ITEM_baseline_rev_msg message. This minimizes rollback during baseline
creation.

PLM00026 11.2 Preferences and Environment Variables Reference 6-31

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
0 Teamcenter does not perform a dry run operation before it creates the baseline.
1 A dry run always occur before the actual baseline is created.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

Baseline_nxmanager_refile

DESCRIPTION
Determines whether to synchronize an assembly using the ugmanager_refile
program.
VALID
VALUES
0 Does not synchronize the assembly.
1 Synchronizes the assembly.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference or user preference.

Baseline_precise_bvr

DESCRIPTION
Specifies which type of baseline, precise or imprecise, can be created.
VALID
VALUES
0 Creates a precise baseline.
1 Creates an imprecise baseline.
2 Allows only a precise baseline to be created. Setting this value in the site
preference file override any value set in a user's preference file.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference or user preference. The site preference values 0 and 1 can be
overwritten by the settings in a user's preference file.

6-32 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Baseline_refile_not_required_item_types

DESCRIPTION
Specifies the item types for which a refile operation is not run during baseline creation.
VALID
VALUES
Accepts multiple strings as values; each string must be a valid Teamcenter item type.
This preference is valid only when the Baseline_nxmanager_refile preference is
set to 1.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Baseline_refile_required_dstypes

DESCRIPTION
Specifies the dataset types that force a refile operation to be performed for any item
types not listed in the Baseline_refile_not_required_item_types site preference.
VALID
VALUES
Accepts multiple strings as values; each string must be a valid Teamcenter dataset
type.
This preference is valid only when the Baseline_nxmanager_refile preference is
set to 1.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Baseline_release_procedures

DESCRIPTION
Lists all possible baseline release processes. A baseline release process must adhere
to a quick release template. Quick release templates are process templates that
define a zero-step release procedure, allowing the baseline to become a released
object that cannot be modified.
Once the baseline process templates are created in Workflow Designer, the process
template names are listed in this preference.
VALID
VALUES
Valid Teamcenter baseline process templates.

PLM00026 11.2 Preferences and Environment Variables Reference 6-33

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Baseline_restricted_item_types

DESCRIPTION
Restricts the item types for which a baseline can be created. Baselines cannot be
created for items of the type listed in this preference. When you baseline a structure
and a restricted item type is found in the structure, Teamcenter displays an error
message and none of the components in the structure is baselined.
VALID
VALUES
Valid Teamcenter item types.
DEFAULT
VALUES
None. The values EngChange and Document are commented out.
DEFAULT
PROTECTION
SCOPE
Site preference.

BOB_property_optimizations

DESCRIPTION
Defines the set of BOB property optimizations applied to object property policy.
VALID
VALUES
Accepts one or more of the following strings as valid values:
none
all
grmCaching
compPropQuery
formBatchLoading
DEFAULT
VALUES
all
DEFAULT
PROTECTION
SCOPE
Site preference.

6-34 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

CheckoutOnCreatePref

DESCRIPTION
Determines whether the system checks out item revisions automatically upon creation.
Sequences are subrevisions of an item revision that document the content of a revision
during its evolution. Checking out an item revision increments the sequence ID.
VALID
VALUES
0 The system does not check out item revisions automatically upon creation.
1 The system automatically checks out item revisions upon creation.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

DATASET_saveas_pattern

DESCRIPTION
Affects the behavior of the Teamcenter SaveAs dialog box as determined
by the implementation of the USER_copied_datasets_details and
USER_copied_dataset_name user exits.
Note

Also affects the behavior of the Teamcenter Integration for NX SaveAs

Non-Master Part File dialog box in the same manner.

This preference is only read by these two user exits. For information about these two
user exits, see the Integration Toolkit Function Reference.
Note

To access the Integration Toolkit Function Reference, install the Teamcenter

developer references when you install Teamcenter online help, or go to the
Global Technical Access Center (GTAC):
https://support.industrysoftware.automation.siemens.com/docs/teamcenter/

Specifies a pattern used to generate and return the output name of nonmaster items
during SaveAs of their master item. The pattern consists of literal text and the following
tokens: ${UserText}, ${ItemID} and ${RevisionID}. Existing dataset names are
expected to match this pattern, where ${ItemID} and ${RevisionID} match the item ID
and revision ID of the owning item revision respectively, and ${UserText} matches any
text in the original name. For example, a typical pattern is:
${UserText}-${ItemID}/${RevisionID}

where the site has decided that the ${UserText} at the beginning is intended to
be the name of the dataset, for example: drawing, and the minus sign (-) is literal
text. If you are saving item revision 001234/B to item revision 002345/A, and the

PLM00026 11.2 Preferences and Environment Variables Reference 6-35

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

dataset's existing name is drawing-001234/B then the name is said to'match against
the pattern. Because the ${UserText} at the start of this pattern matches any string,
the dataset name fea-001234/B would also match against the pattern. However,
drawing_001234/B would not match the pattern as the minus sign is required, and
drawing-001235/B would not match since the item ID is incorrect.
Once an original dataset name has been matched against the pattern, the new dataset
name is generated by replacing the ${ItemID} and ${RevisionID} with the new
revision and item ID in the pattern, and all occurrences of ${UserData} with whatever
text they matched against in the original name. This new name can then be used for
saving the new dataset. Using the example above, the two datasets are saved as
drawing-002345/A and fea-002345/A.
You can modify these generated names using the
DATASET_saveas_allow_name_modification preference. However, if the
DATASET_saveas_force_name_validation preferences is set to true, the
user-edited name is still required to match the pattern.
VALID
VALUES
${UserText} Dataset names are copied forward to the new revision
unchanged.
DEFAULT
VALUES
${UserText}
DEFAULT
PROTECTION
SCOPE
Site preference.

<DATASET TYPE>_saveas_pattern

DESCRIPTION
Performs the same behavior as the DATASET_saveas_pattern preference, but for
a specific dataset type. Use this preference to define different Save As patterns for
different nonmaster datasets.
For example, assign the naming pattern drawing-001234/B to the UGPART dataset,
and the naming pattern drawing-001234 to the UGALTREP dataset by creating the
following two preferences:
UGPART_saveas_pattern=
${UserText}-${ItemID}/${RevisionID}

UGALTREP_saveas_pattern=
${UserText}-${ItemID}
VALID
VALUES
${UserText} Dataset names are copied forward to the new revision
unchanged.
DEFAULT
VALUES
None.

6-36 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IDENTIFIER_idincontext

DESCRIPTION
Determines whether identifier IDs are to be unique within the context or unique with
respect to item IDs.
VALID
VALUES
TRUE Identifier IDs are defined within the context to be unique.
FALSE Item IDs and alternate IDs are to be unique with respect to each other.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

IP_level_list_ordering

DESCRIPTION
Defines a list of intellectual property (IP) classification values and clearance levels that
are assigned to data objects and users for IP access evaluation. The order in which
they appear in the list determines their restrictiveness. The first entry is the lowest
classification, and the last entry is the highest. Access Manager compares these
values to determine user access rights to the object. IP_level_list_ordering is for use
with classification functionality.
Note

When setting IP classification, the values are propagated to related objects

according to the propagation rules defined in Teamcenter (when setting the
value on an item, all revisions and their attached datasets are assigned the
same value). This only applies, however, when setting a value that is more
restrictive than the current value. If you set a less restrictive value on an object,
the value is not propagated to the related objects.
For example, if you set a classification value of Top Secret on the 001–Axel
part, it is propagated to the related objects because its classification is more
restrictive than the IP classification of the related objects (Secret):

PLM00026 11.2 Preferences and Environment Variables Reference 6-37

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

In the following example, however, if you set an IP classification value of Secret)

on the 001–Axel part, it is not be propagated from 001–Axel to the related
objects because it is less restrictive (at a lower level) than the IP classification
level set on the related objects (Top Secret):

You can replace an IP classification level with another of equal value. For
example, in the following example, Confidential is replaced with Secret
because it is at the same level.

Note

Classification values that are of equal value are separated by commas.

VALID
VALUES
Accepts multiple strings as values. Each string must provide a valid IP classification for
an object and the corresponding clearance level on a user. Access Manager compares
these values to determine user access rights to the object.
String order determines classification level: the first entry is the lowest classification,
the last entry is the highest.
Maximum string length is 128 characters.
To indicate classification levels that are equal, separate them with a comma. For
example, to place secret and confidential at the same level, enter the following:
IP_level_list_ordering=
secret, confidential
top-secret

Because a comma separates equal values, you cannot use a comma in the name of
the classification level.
DEFAULT
VALUES
secret
super-secret,top-secret

6-38 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ITAR_level_list_ordering

DESCRIPTION
Defines, in order, the list of valid government classification attributes and corresponding
government clearance levels.
• Government classification is an object attribute that specifies the clearance level
required for users to access the data associated with the object. Government
classification values are typically United States Munitions List (USML) or Export
Control Classification Number (ECCN) codes.

• Government clearance is a user attribute that specifies the level of clearance that
users have to classified data.

The order in which they appear in the list determines their restrictiveness. The first
entry is the lowest classification, and the last entry is the highest. Access Manager
compares these values to determine user access rights to the object. Use this
preference when implementing security controls with International Traffic in Arms
Regulations (ITAR) functionality.
Note

When setting government classification, the values are propagated to related

objects according to the propagation rules defined in Teamcenter (when setting
the value on an item, all revisions and their attached datasets are assigned the
same value). This only applies, however, when setting a value that is more
restrictive than the current value. If you set a less restrictive value on an object,
the value is not propagated to the related objects.
For example, if you set a classification value of Top Secret on the 001–Axel
part, it is propagated to the related objects because its classification is more
restrictive than the government classification of the related objects (Secret):

In the following example, however, if you set a government classification

value of Secret) on the 001–Axel part, it is not propagated from 001–Axel
to the related objects because it is less restrictive (at a lower level) than the
government classification level set on the related objects (Top Secret):

PLM00026 11.2 Preferences and Environment Variables Reference 6-39

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

You can replace a government classification level with another of equal value.
For example, in the following example, Confidential is replaced with Secret
because it is at the same level.

Note

Classification values that are of equal value are separated by commas.

VALID
VALUES
Accepts multiple strings as values. Each string must provide valid government
classifications for an object and the corresponding clearance levels on a user. Access
Manager compares these values to determine user access rights to the object.
String order determines classification level: the first entry is the lowest classification,
the last entry is the highest.
Maximum string length is 128 characters.
To indicate classification levels that are equal, separate them with a comma. For
example, to place secret and confidential at the same level, enter the following:
ITAR_level_list_ordering=
secret, confidential
top-secret

Because a comma separates equal values, you cannot use a comma in the name of
the classification level.
DEFAULT
VALUES
secret
super-secret,top-secret
DEFAULT
PROTECTION
SCOPE
Site preference.

6-40 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

ITEM_baseline_rev_msg

DESCRIPTION
Executes site-specific program to verify the data associated with the baseline item
revision using a verification message. You can register functions as preconditions and
postactions against this message and perform their validations.
DEFAULT
PROTECTION
SCOPE
Site preference.

LicenseUsage_admin_notifier_list

DESCRIPTION
Specifies the identifiers of the administrative users who receive Teamcenter
notifications when the occasional user exceeds the allotted usage and/or grace period
limits specified for the occasional user license level.
VALID
VALUES
Accepts one or more strings as values; each string must be the user ID of an
administrative user.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

LicenseUsage_days_warning_level

DESCRIPTION
Specifies the remaining duration in days in the allotted usage when occasional
logged-on users start receiving warning messages as a notification as they approach
their allotted usage days.
VALID
VALUES
Accepts a single string as value. Must be a positive integer more than zero.
DEFAULT
VALUES
2
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-41

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

LicenseUsage_hours_warning_level

DESCRIPTION
Specifies the remaining duration in hours in the allotted usage when occasional
logged-on users start receiving warning messages as a notification as they approach
their allotted usage hours.
VALID
VALUES
Accepts a single string as value. Must be a single, positive integer more than zero.
DEFAULT
VALUES
5
DEFAULT
PROTECTION
SCOPE
Site preference.

LicenseUsage_module_usage_warning_level

DESCRIPTION
Specifies the number of logons remaining in the month when administrators start
receiving warning messages that the module usage is approaching the allowed limit.
VALID
VALUES
Accepts a single string as value; it must be a single, positive integer more than zero.
DEFAULT
VALUES
5
DEFAULT
PROTECTION
SCOPE
Site preference.

LicenseUsage_show_userId_in_report

DESCRIPTION
Activates the display of the actual user ID in the license usage report.
VALID
VALUES
True Enables the display of the actual user ID in the license usage report.

False Disables the display of the actual user ID in the license usage report.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

6-42 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

license_warning_level

DESCRIPTION
Specifies a threshold number of remaining licenses. When an administrator assigns
license levels or license bundles, the system displays a warning when the number of
remaining licenses is equal to, or lower than, the value of this preference. License
levels and license bundles are assigned using either the Organization application
or the make_user utility.
When assigning a license to a user, the following message appears when a threshold
set to 5 is reached:
The number of available licenses is running low: 5 licenses are left.

When assigning a license bundle to a user, the following message appears when
a threshold set to 5 is crossed:
The number of available licenses is running low: 5 licenses of
bundle bundle-name are left.
VALID
VALUES
Accepts a single string as value. Must be a single, positive integer more than zero.
DEFAULT
VALUES
5
DEFAULT
PROTECTION
SCOPE
Site preference.

Siemens_PL_email_id

DESCRIPTION
Specifies the valid e-mail ID of the Siemens PLM Software licensing account team that
receives notifications when any module usage limit exceeds its allowed usage.
VALID
VALUES
A valid e-mail address.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

SOACAD_checkout_required

DESCRIPTION
Determines whether the system requires checkout of BOM view revisions and datasets
prior to modification.
By default, at sites using SOA CAD Services, the system requires this checkout.
(The client calling createOrUpdateRelativeStructure must checkout the BOM view

PLM00026 11.2 Preferences and Environment Variables Reference 6-43

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

revision prior to structure update by the SOA Web Service. Similarly, the client calling
createOrUpdateParts must checkout the dataset prior to structure update by the SOA
Web Service. Use this preference to bypass these default checkout requirements.
VALID
VALUES
True The system requires the checkout of BOM view revisions and datasets prior to
modification.
False The system bypasses the checkout. (Though the system still verifies the
objects are not checked out by other users before attempting to modify, but
does not require an explicit checkout of the objects.)
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_check_object_before_create

DESCRIPTION
Determines how item revisions are saved and revised using the createObjects
method.
VALID
VALUES
ON When Save As or Revise is performed on an item revision using the
createObjects method, the system checks whether an object of the selected
type already exists. If an object of the selected type already exists, the object
is not created.
OFF When Save As or Revise is performed on an item revision using the
createObjects method, the system does not check if an object of the selected
type already exists. The object is always created.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
User preference.

TCCheckoutReserveOnly

DESCRIPTION
Specifies for which business objects a restore copy is not created during checkout.
If the business object supports sequences, a new sequence is not created during
checkout. In this case, if the checkout is canceled, the business object's contents are
not restored to their original values. Sequences are subrevisions of a business object

6-44 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

that document the content of a revision during its evolution. Checking out a business
object increments the sequence ID.
• You cannot delete the Item value from the object list for this preference.

• If any type of item revision is specified with this preference, sequences are
disabled for that item revision type. The Undo Checkout action does not discard
changes made after the item revision is checked out.
Note

You can display a warning message for object version changes without user
input.
For information, see the TCCheckoutReserveOnlyWarningNeeded
preference.

VALID
VALUES
Accepts multiple strings as values. Each string must be a business object that can
be checked in and out.
DEFAULT
VALUES
Item
PSBOMView
PSBOMViewRevision

Note

If the solution template is installed, more default values are available.

DEFAULT
PROTECTION
SCOPE
Site preference.

TCCheckoutReserveOnlyWarningNeeded

DESCRIPTION
Specifies whether a warning message is displayed for object version change without
user input for objects defined in the TCCheckoutReserveOnly preference.
VALID
VALUES
true A warning message is displayed.
false No warning message is displayed.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-45

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

TC_Dataset_Import_Exclude_Wildcard

DESCRIPTION
Specifies whether dataset types are listed in the types list if the type has only one
named reference defined and if that is associated with a *.* file format.
VALID
VALUES
TRUE A dataset type is not listed in the types list if it has only has one named
reference defined and if that is associated with a *.* file format.
FALSE Dataset types are listed in the types list even if they have only has one
named reference defined and if that is associated with a *.* file format.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
User preference.

TC_<dataset-type>_<tool-type>_searchBy

DESCRIPTION
Launches the specified dataset file type using the specified tool type regardless of the
dataset file extension (when you use the MIME value).
This overrides the Teamcenter behavior, which is to launch the dataset with a specific
tool based on the dataset file extension (for example, always launching a dataset with
an .html extension using Internet Explorer).
VALID
VALUES
EXTENSION Launches the specified dataset file type using the dataset file
extension.
MIME Launches the specified dataset file type using the specified tool type
regardless of the dataset file extension.
DEFAULT
VALUES
EXTENSION
DEFAULT
PROTECTION
SCOPE
Site preference.

TCDefaultKeepLimit

DESCRIPTION
Determines the number of sequences the system maintains as an item revision is
checked in and out of the database. Sequences are subrevisions of item revisions that
document the content of a revision during its evolution. Checking out an item revision
increments the sequence ID. At logon, the system automatically removes the oldest
sequence when the limit specified with this preference is reached.

6-46 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
Accepts a single string as a value. Must be a single, positive integer more than zero.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

TCDefaultKeepLimitByType

DESCRIPTION
Determines the number of sequences the system maintains for the specified business
object as it is checked in and out of the database. Sequences are subrevisions of a
business object that document the content of a revision during its evolution. Checking
out a business object increments the sequence ID. At checkin, the system automatically
removes the oldest sequence when the limit specified with this preference is reached.
• When an item revision is checked out, a new sequence is created. Therefore,
when the number of item revisions sequences is defined as 1, the system keeps
two versions during checkout.

• When the object is checked in, the system purges sequences to comply with
the keep limit.

VALID
VALUES
Accepts multiple string pairs as values. Each string must be a space-delineated pair
consisting of a valid business object and a positive integer more than zero. For
example:
TCDefaultKeepLimitByType=
ItemRevision 3
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
EXAMPLE
Assume the TCDefaultKeepLimitByType value for item revisions is 3.
• When the item revision is checked out the first time, sequence 2 is created. After
checkin, sequence 1 and sequence 2 are available.

• When the item revision is checked out a second time, sequence 3 is created. After
checkin, sequence 1, sequence 2, and sequence 3 are available.

• When the item revision is checked out for the third time, sequence 4 is created.

PLM00026 11.2 Preferences and Environment Variables Reference 6-47

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

o While the item is checked out, sequence 1, sequence 2, sequence 3, and

sequence 4 exist in the system.

o If sequence 4 is checked in, sequence 1 is purged.

o If the checkout is canceled, sequence 4 is deleted.

TC_multi_site_ada_license_user_bypass

DESCRIPTION
Determines whether replicated objects can have corresponding licenses attached
upon import, even when the importing user does not have the required permissions to
attach such a license. This preference defined licenses and determines corresponding
licenses by license ID.
ADA is a security solution that complements other Teamcenter security features, such
as Access Manager rules and access control lists (ACLs).
VALID
VALUES
true Attaches corresponding licenses, even when the importing user does not have
the required permissions to attach such a license.
false Does not attach corresponding licenses when the importing user does not
have the required permissions to attach such a license.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Refresh_Warning_Threshold

DESCRIPTION
Defines a threshold number to show a warning message when users refresh a large
amount of selected objects using the Refresh command in the global toolbar and
menu. Increasing the default value (200) may cause the rich client to take a long time
to complete the refresh process due to its current memory allocation. This preference
applies to the Refresh command in the global toolbar and menu, but not to any refresh
command on the view toolbar or dropdown menu.
VALID
VALUES
Any integer.
DEFAULT
VALUES
200
DEFAULT
PROTECTION
SCOPE
Site preference.

6-48 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

TC_session_clearance

DESCRIPTION
Used in conjunction with NX run-time properties, this preference enables the
establishment of indirect access controls in NX using logging or menu suppression
(blocking) to control classified data that is loaded in an Teamcenter Integration for NX
session.
Note

Allowing data out of the managed environment creates a security vulnerability,

but there may be times you want to grant a user permission to use NX menus
that involve exporting data out of the environment. The Unmanage privilege in
Access Manager allows you to grant users the ability to access these features.

VALID
VALUES
log Enables auditable evidence of the use of various NX commands on classified
data. This is implemented by NX internal mechanisms.

block Suppresses sensitive menus that, if used on classified data, could result in
exporting geometric data outside the NX/Teamcenter managed environment.
The blocking feature also includes logging of less sensitive menu actions.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Use_DataShare_Manager

DESCRIPTION
Activates the use of the Data Share Manager for uploading and downloading files. The
Data Share Manager is an asynchronous file upload and download monitor for File
Management System (FMS) transactions.
VALID
VALUES
true Perform asynchronous file uploads and downloads and monitor them with the
Data Share Manager.

false Use the File Management System (FMS) to perform synchronous file uploads
and downloads.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-49

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Following is a process recommended for administrators to manage the protection

scope:
1. Maintain the value of the Use_Datashare_Manager preference as false and set
to the site protection scope at least until the private key is installed in the database
and the corresponding public key is available to all users. This keeps data sharing
disabled until the public key is properly distributed.

2. Enable user control for testing purposes by setting the protection scope to
User from Site. Then users designated to test the functionality can enable the
Data Share Manager individually by creating a user Use_Datashare_Manager
preference with the value set to true to override the default preference value. This
could be used with a select few users for testing purposes before making the public
key available to all users and rolling out the Data Share Manager into production.

3. After testing is completed, enable the Data Share Manager for all users by setting
the site preference to true. At this point, all users can use the Data Share
Manager. Remember that users need the public key before you enable the Data
Share Manager.
Note

If some users do not want to use the Data Share Manager, they can set
the Use_Datashare_Manager preference to false. Instead, they use the
synchronous import and export mechanism.

USER_baseline_dryrun_validator

DESCRIPTION
Accepts the file name of the file containing the UID strings all baselined item revisions.
This allows sites to run the validations on the entire structure in one pass.
In the rich client interface, the report is displayed on the screen. It can be printed out
and saved in a text file or HTML format. In the ITK interface, a log file is generated.
VALID
VALUES
A single string as a value; must be a valid file name.
DEFAULT
VALUES
None.

WEB_DSM_install_link

DESCRIPTION
Defines the download URL of the Data Share Manager installer for thin client users.
The Data Share Manager is an asynchronous file upload and download monitor for
File Management System (FMS) transactions.
An administrator must first distribute the installer to a location hosted by a web
application server. Then the administrator must enter the URL of that location to this
preference.

6-50 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

When the Data Share Manager is enabled, and end users start a file upload or
download in the thin client, a box is displayed prompting users to install the Data Share
Manager. Users click the Install Data Share Manager link to launch the Data Share
Manager installer from the location set by this preference.

VALID
VALUES
A valid URL address where the Data Share Manager installer is located.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Dispatcher preferences
DISPATCHER_CLIENT_INSTALLED

DESCRIPTION
Specifies if Dispatcher is installed. This preference is used by applications to find
if Dispatcher services are installed. The system sets this preference during a
Teamcenter Environment Manager installation.
VALID
VALUES
TRUE Specifies that Dispatcher Client has been installed.
FALSE Dispatcher Client not installed.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

DISPLAY_Param_In_NotesText

DESCRIPTION
Shows or hides the parameter name in the Note Text box of a standard note.

PLM00026 11.2 Preferences and Environment Variables Reference 6-51

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Example

If your parameter definition is as follows:

Round all sharp corners to [Radius: 0.4, 0.5, 0.6] inches and heat treat to
[Temperature: 200, 220, 230] degrees Fahrenheit.
• If the value of this preference is true, the Note Text box of the standard
note displays the parameter name and parameter values as follows:
Round all sharp corners to Radius 0.01 inches and heat treat to
Temperature 100 degrees Fahrenheit.

• If the value of this preference is false, the Note Text box of the standard
note displays only parameter values as follows:
Round all sharp corners to 0.01 inches and heat treat to 100 degrees
Fahrenheit.

VALID
VALUES
true Shows the parameter name in the Note Text box of the standard note.

false Hides the parameter name in the Note Text box of the standard note.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
System preference.

ETS.Repeating_UI.<ProviderName>.<ServiceName>

DESCRIPTION
Specifies if the option to repeat Dispatcher tasks for a particular provider and service
should be seen in the Translation Selection dialog box.
VALID
VALUES
TRUE The option to repeat Dispatcher tasks is shown in the Translation Selection
dialog box.

FALSE The option to repeat Dispatcher tasks is not shown in the Translation
Selection dialog box.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

6-52 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

ETS.PROVIDERS

DESCRIPTION
Specifies the translator providers.
VALID
VALUES
Accepts multiple strings as values. Must be a valid provider name.
DEFAULT
VALUES
SIEMENS
DEFAULT
PROTECTION
SCOPE
Site preference.

ETS.TRANSLATORS.<ProviderName>

DESCRIPTION
Specifies the translators available for a provider.
VALID
VALUES
Accepts multiple strings as values. Must be a valid translator name.
DEFAULT
PROTECTION
SCOPE
Site preference.

ETS.VALIDATE.<ProviderName>.<ServiceName>

DESCRIPTION
Specifies if default validation can be done on the selected Teamcenter component.
VALID
VALUES
true Specifies that default validation can be done on the selected Teamcenter
component.
false Specifies that default validation can not be done on the selected Teamcenter
component.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-53

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

ETS_trans_rqst_referenced_dataset_types

DESCRIPTION
Specifies which CAD dataset type names may be referenced by translation requests
as primary or secondary objects. A pre-delete action is registered for each of these
dataset types to support deletion of CAD data while a translation is in process.
VALID
VALUES
Accepts multiple strings as values. Must be a valid CAD dataset type name.
DEFAULT
VALUES
IdeasPart
IdeasAssembly
IdeasDrawing
catia
CATPart
CATProduct
UGPART
UGMASTER
UGALTREP
UGSCENARIO
ProPrt
DEFAULT
PROTECTION
SCOPE
Site preference.

ETS_update_state_delay

DESCRIPTION
Specifies the delay time in seconds after which a dispatcher request object can be
updated.

When there are multiple dispatcher clients in a Dispatcher installation, multiple

dispatcher clients can update the state of the same dispatcher request object. The
delay time makes sure that only one dispatcher client updates the dispatcher request
object.

Note

If you set a very high delay time, the performance of the dispatcher request may
be affected. Siemens PLM Software recommends that the delay time should
not be greater than 5 seconds.

VALID
VALUES
Must be a single positive integer.
DEFAULT
VALUES
0

6-54 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ETS_released_status_type_names

DESCRIPTION
Specifies which released status types are copied from an item revision to a
visualization dataset. The status type names are used to filter the setting of the
released date and released status for visualization datasets. When an item revision's
released status type matches a status type defined in this preference, the released
date and released status are copied to the visualization dataset.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid status type name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ETS_trans_rqst_user_exit_states

DESCRIPTION
Specifies which translation request states activate the Dispatcher translation request
state transition user exit.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Dispatcher state.
DEFAULT
VALUES
COMPLETE
DEFAULT
PROTECTION
SCOPE
Site preference.

IMAN_capture_relation_primary

DESCRIPTION
Defines primary relation objects for IMAN_capture relations. Must include
IdeasDrawing for Dispatcher to support I-deas drawings.
Use only a single instance of this preference in the database.

PLM00026 11.2 Preferences and Environment Variables Reference 6-55

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Note

All <relation_business_object>_relation_primary preferences are obsolete and

are replaced by relation properties. Use the Business Modeler IDE to create
and manage relation properties.
For more information about relation properties, see Business Modeler IDE.

VALID
VALUES
Accepts multiple strings as values. Each value must be a valid Teamcenter object.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CATIA_translation_service_name

DESCRIPTION
Specifies the Dispatcher Server provider and service names of the translator to be
used for CATIA v5 check in/save and on demand translations.
VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the Dispatcher Server module configuration
translator.xml file. Values are set in the following format:

provider name.service name

For example: THEOREM.catiatojt

Note

If this preference is not specified, requests for CATIA v5 check in/save and
on demand translations are ignored.

DEFAULT
VALUES
THEOREM.catiatojt
DEFAULT
PROTECTION
SCOPE
Site preference.

CATIA_checkin_generate_vis_data_priority

DESCRIPTION
Determines the CATIA v5 to JT scheduler priority for check in and/or save translations.

6-56 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
0 Generates no translation.
1 Priority for checked-in/save CATIA v5 translations is low.
2 Priority for checked-in/save CATIA v5 translations is medium.
3 Priority for checked-in/save CATIA v5 translations is high.
DEFAULT
VALUES
2
DEFAULT
PROTECTION
SCOPE
Site preference.

COMMONcatiatojt_CATPart_ets_nr_types

DESCRIPTION
Specifies the CATIA v5 CATPart dataset named references necessary for translation.
All named reference types specified by this preference must exist for a dataset of this
type to be translated. If no named reference types are specified, no named reference
type validation is performed.
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
catpart
DEFAULT
PROTECTION
SCOPE
Site preference.

COMMONcatiatojt_CATProduct_ets_nr_types

DESCRIPTION
Specifies the CATIA v5 CATProduct dataset named references necessary for
translation. All named reference types specified by this preference must exist for a
dataset of this type to be translated. If no named reference types are specified, no
named reference type validation is performed.
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
catproduct

PLM00026 11.2 Preferences and Environment Variables Reference 6-57

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

COMMONcatiatojt_ets_ds_types

DESCRIPTION
Specifies the dataset type names of the CATIA v5 datasets which can be translated by
the CATIA v5 to JT translator. If no dataset types are specified, no named reference
type validation is performed. Additional named reference type validation can be
configured for the datasets specified by this preference value.
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing dataset type.
DEFAULT
VALUES
CATProduct
CATPart
DEFAULT
PROTECTION
SCOPE
Site preference.

CATIA_work_dir

DESCRIPTION
Defines the NX CATIA Manager working directory.
VALID
VALUES
Accepts a single string as a value. Must be the same working directory specified
during NX CATIA Manager installation.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CATIA_V4_translation_service_name

DESCRIPTION
Specifies the Dispatcher Server provider and service names of the translator to be
used for CATIA v4 check in and on demand translations.
VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the Dispatcher Server module configuration
translator.xml file. Values are set in the following format:

6-58 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

provider name.service name

For example: UGS.catiav4tojt
Note

If this preference is not specified, requests for CATIA v4 check in and on

demand translations are ignored.

DEFAULT
VALUES
UGS.catiav4tojt
DEFAULT
PROTECTION
SCOPE
Site preference.

CATIA_V4_checkin_generate_vis_data_priority

DESCRIPTION
Specifies the generate visualization data scheduler priority for checked-in/saved
CATIA v4 parts and assemblies.
VALID
VALUES
0 Generates no translation.
1 Dispatcher Server scheduler priority for checked-in CATIA v4 parts and
assemblies is low.
2 Dispatcher Server scheduler priority for checked-in CATIA v4 parts and
assemblies is medium.
3 Dispatcher Server scheduler priority for checked-in CATIA v4 parts and
assemblies is high.
DEFAULT
VALUES
2
DEFAULT
PROTECTION
SCOPE
Site preference.

COMMONcatiatojt_catia_ets_nr_types

DESCRIPTION
Specifies the CATIA v4 dataset named references necessary for translation. All named
reference types specified by this preference must exist for a dataset of this type to
be translated. If no named reference types are specified, no named reference type
validation is performed.
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.

PLM00026 11.2 Preferences and Environment Variables Reference 6-59

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
VALUES
catia
DEFAULT
PROTECTION
SCOPE
Site preference.

COMMONcatiatojtV4_ets_ds_types

DESCRIPTION
Specifies the dataset type names of the CATIA v4 datasets which can be translated by
the CATIA v4 to JT translator. If no dataset types are specified, no named reference
type validation is performed. Additional named reference type validation can be
configured for the datasets specified by this preference value.
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing dataset type.
DEFAULT
VALUES
catia
DEFAULT
PROTECTION
SCOPE
Site preference.

IMAN_Drawing_relation_primary

DESCRIPTION
Defines primary relation objects for IMAN_drawing relations. Must include Item,
ItemRevision and Dataset for Dispatcher to support NX drawings.
Use only a single instance of this preference in the database.
Note

All <relation_business_object>_relation_primary preferences are obsolete and

are replaced by relation properties. Use the Business Modeler IDE to create
and manage relation properties.
For more information about relation properties, see Business Modeler IDE.

VALID
VALUES
Accepts multiple strings as values. Each value must be a valid Teamcenter object.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

6-60 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

UGMASTER_DefaultChildProperties

DESCRIPTION
Defines children of UGMASTER datasets. Must include IMAN_drawing for Dispatcher
to support NX parts.
Note

Use only a single instance of this preference in the database.

VALID
VALUES
Accepts multiple strings as values. Each value must be a valid Teamcenter relation
object.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

UGPART_DefaultChildProperties

DESCRIPTION
Defines children of UGPART datasets. Must include IMAN_drawing for Dispatcher to
support NX parts.
Note

Use only a single instance of this preference in the database.

VALID
VALUES
Accepts multiple strings as values. Each value must be a valid Teamcenter relation
object.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetobmp_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand bitmap (BMP) translations of Solid Edge datasets.

PLM00026 11.2 Preferences and Environment Variables Reference 6-61

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setobmp
If this preference is not specified, requests for checkin and on-demand Solid Edge to
BMP translations are ignored.
DEFAULT
VALUES
UGS.setobmp
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojpg_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand JPEG translations of Solid Edge datasets.
VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setojpg
If this preference is not specified, requests for checkin and on-demand Solid Edge to
JPEG translations are ignored.
DEFAULT
VALUES
UGS.setojpg
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojt_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand JT translations of Solid Edge datasets.

6-62 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setojt
If this preference is not specified, requests for checkin and on-demand Solid Edge
to JT translations are ignored.
DEFAULT
VALUES
UGS.setojt
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetotif_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand TIF translations of Solid Edge datasets.
VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setotif
If this preference is not specified, requests for checkin and on-demand Solid Edge
to TIF translations are ignored.
DEFAULT
VALUES
UGS.setotif
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetopdf_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand PDF translations of Solid Edge datasets.

PLM00026 11.2 Preferences and Environment Variables Reference 6-63

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setopdf
If this preference is not specified, requests for checkin and on-demand Solid Edge to
PDF translations are ignored.
DEFAULT
VALUES
UGS.setopdf
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoxt_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand XT translations of Solid Edge datasets.
VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setoxt
If this preference is not specified, requests for checkin and on-demand Solid Edge
to XT translations are ignored.
DEFAULT
VALUES
UGS.setoxt
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetostep_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand Step translations of Solid Edge datasets.

6-64 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setostep
If this preference is not specified, requests for checkin and on-demand Solid Edge to
Step translations are ignored.
DEFAULT
VALUES
UGS.setostep
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetostl_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand STL translations of Solid Edge datasets.
VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setostl
If this preference is not specified, requests for checkin and on-demand Solid Edge
to STL translations are ignored.
DEFAULT
VALUES
UGS.setostl
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoemf_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand EMF translations of Solid Edge datasets.

PLM00026 11.2 Preferences and Environment Variables Reference 6-65

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setoemf
If this preference is not specified, requests for checkin and on-demand Solid Edge to
EMF translations are ignored.
DEFAULT
VALUES
UGS.setoemf
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetodxf_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand DXF translations of Solid Edge datasets.
VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setodxf
If this preference is not specified, requests for checkin and on-demand Solid Edge to
DXF translations are ignored.
DEFAULT
VALUES
UGS.setodxf
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetodwg_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand DWG translations of Solid Edge datasets.

6-66 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setodwg
If this preference is not specified, requests for checkin and on-demand Solid Edge to
DWG translations are ignored.
DEFAULT
VALUES
UGS.setodwg
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetosat_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand SAT translations of Solid Edge datasets.
VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setosat
If this preference is not specified, requests for checkin and on-demand Solid Edge
to SAT translations are ignored.
DEFAULT
VALUES
UGS.setosat
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoigs_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand IGS translations of Solid Edge datasets.

PLM00026 11.2 Preferences and Environment Variables Reference 6-67

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setoigs
If this preference is not specified, requests for checkin and on-demand Solid Edge
to IGS translations are ignored.
DEFAULT
VALUES
UGS.setoigs
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoplmxml_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand PLM XML translations of Solid Edge datasets.
VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setoplmxml
If this preference is not specified, requests for checkin and on-demand Solid Edge to
PLM XML translations are ignored.
DEFAULT
VALUES
UGS.setoplmxml
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoxgl_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand XGL translations of Solid Edge datasets.

6-68 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.setoxgl
If this preference is not specified, requests for checkin and on-demand Solid Edge to
XGL translations are ignored.
DEFAULT
VALUES
UGS.setoxgl
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSvisprint_translation_service_name

DESCRIPTION
For Teamcenter Rapid Start, specifies the TSTK provider and service names of the
translator to be used for on-demand Visprint translations.
VALID
VALUES
This preference value is specified using the provider and service attribute values from
the corresponding translator element in the TSTK module configuration translator.xml
file. Values are set in the following format:
provider-name.service-name
For example:
UGS.visprint
If this preference is not specified, requests for checkin and on-demand Visprint
translations are ignored.
DEFAULT
VALUES
UGS.visprint
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojt_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.

PLM00026 11.2 Preferences and Environment Variables Reference 6-69

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
A nonzero value is required to display the Solid Edge to JT option on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on-demand translations of UG parts is
low.
2 Dispatcher Server scheduler priority for on-demand translations of UG parts is
medium.
3 Dispatcher Server scheduler priority for on-demand translations of UG parts
is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetobmp_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the Solid Edge to BMP option on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is low.
2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is medium.
3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

6-70 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

UGSsetojpg_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the Solid Edge to JPG option on the Translate
menu.

0 Generates no translation.

1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is low.

2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is medium.

3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetotif_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the Solid Edge to TIF option on the Translate
menu.

0 Generates no translation.

1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is low.

2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is medium.

3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is high.
DEFAULT
VALUES
3

PLM00026 11.2 Preferences and Environment Variables Reference 6-71

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetopdf_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the Solid Edge to PDF option on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is low.
2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is medium.
3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoxt_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the Solid Edge to XT option on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is low.
2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is medium.
3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is high.

6-72 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetostep_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the SE to STEP option on the Translate menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is low.
2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is medium.
3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetostl_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the Solid Edge to STL option on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is low.
2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is medium.

PLM00026 11.2 Preferences and Environment Variables Reference 6-73

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoemf_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the Solid Edge to EMF option on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is low.
2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is medium.
3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetodxf_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the Solid Edge to DXF option on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is low.

6-74 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is medium.
3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetodwg_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the Solid Edge to DWG option on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is low.
2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is medium.
3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetosat_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the Solid Edge to SAT option on the Translate
menu.
0 Generates no translation.

PLM00026 11.2 Preferences and Environment Variables Reference 6-75

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is low.
2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is medium.
3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoigs_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the Solid Edge to IGS option on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is low.
2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is medium.
3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge
parts is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoplmxml_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the Solid Edge to PLMXML option on the
Translate menu.

6-76 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

0 Generates no translation.

1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is low.

2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is medium.

3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoxgl_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand translations of Solid Edge parts.
VALID
VALUES
A nonzero value is required to display the Solid Edge to XGL option on the Translate
menu.
0 Generates no translation.

1 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is low.

2 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is medium.

3 Dispatcher Server scheduler priority for on-demand translations of Solid Edge

parts is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSvisprint_on_demand_generate_vis_data_priority

DESCRIPTION
For Teamcenter Rapid Start, determines the generate visualization data scheduler
priority for on-demand visprint translations.

PLM00026 11.2 Preferences and Environment Variables Reference 6-77

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
A nonzero value is required to display visprint options on the Translate menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on-demand translations of visprint
parts is low.
2 Dispatcher Server scheduler priority for on-demand translations of visprint
parts is medium.
3 Dispatcher Server scheduler priority for on-demand translations of visprint
parts is high.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojt_ets_ds_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the dataset type names of the Solid Edge
datasets that can be translated by the Solid Edge to JT. If no dataset types are
specified, no named reference type validation is performed. Additional named
reference type validation can be configured for the datasets specified by this
preference value.
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing dataset type.
DEFAULT
VALUES
SE Part
SE Assembly
SE SheetMetal
SE Weldment
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetopdf_ets_ds_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the dataset type names of the Solid Edge
datasets that can be translated by the Solid Edge to PDF. If no dataset types are
specified, no named reference type validation is performed. Additional named
reference type validation can be configured for the datasets specified by this
preference value.

6-78 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be an existing dataset type.
DEFAULT
VALUES
SE Draft
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoplmxml_ets_ds_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the dataset type names of the Solid Edge
datasets that can be translated by the Solid Edge to PLM XML. If no dataset
types are specified, no named reference type validation is performed. Additional
named reference type validation can be configured for the datasets specified by this
preference value.
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing dataset type.
DEFAULT
VALUES
SE Part
SE Assembly
SE SheetMetal
SE Weldment
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojpg_ets_ds_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the dataset type names of the Solid Edge
datasets that can be translated by the Solid Edge to JPG. If no dataset types are
specified, no named reference type validation is performed. Additional named
reference type validation can be configured for the datasets specified by this
preference value.
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing dataset type.
DEFAULT
VALUES
SE Part
SE Draft
SE Assembly
SE SheetMetal

PLM00026 11.2 Preferences and Environment Variables Reference 6-79

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

SE Weldment
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojt_<dataset>_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the Solid Edge dataset named references
necessary for translation.
All named reference types specified by the preference must exist to be translated. If no
named reference types are specified, no named reference type validation is performed.
Each dataset requires a separate preference in which dataset is a valid Teamcenter
dataset. For example:
UGSsetojt_SE Part_ets_nr_types=
SE-part
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
UGSsetojt_SE Part_ets_nr_types=
SE-part
UGSsetojt_SE Assembly_ets_nr_types
SE-assembly
UGSsetojt_SE SheetMetal_ets_nr_types
SE-sheetMetal
UGSsetojt_SE Weldment_ets_nr_types
SE-weldment
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetobmp_<dataset>_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the Solid Edge dataset named references
necessary for translation.
All named reference types specified by the preference must exist to be translated. If no
named reference types are specified, no named reference type validation is performed.
Each dataset requires a separate preference in which dataset is a valid Teamcenter
dataset. For example:
UGSsetobmp_SE Draft_ets_nr_types=
SE-draft

6-80 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
UGSsetobmp_SE Draft_ets_nr_types=
SE-draft
UGSsetobmp_SE Part_ets_nr_types
SE-part
UGSsetobmp_SE Assembly_ets_nr_types
SE-assembly
UGSsetobmp_SE Weldment_ets_nr_types
SE-weldment
UGSsetobmp_SE SheetMetal_ets_nr_types
SE-sheetMetal
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojpg_<dataset>_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the Solid Edge dataset named references
necessary for translation.
All named reference types specified by the preference must exist to be translated. If no
named reference types are specified, no named reference type validation is performed.
Each dataset requires a separate preference in which dataset is a valid Teamcenter
dataset. For example:
UGSsetojpg_SE Draft_ets_nr_types=
SE-draft
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
UGSsetojpg_SE Draft_ets_nr_types=
SE-draft
UGSsetojpg_SE Assembly_ets_nr_types=
SE-assembly
UGSsetojpg_SE Weldment_ets_nr_types=
SE-weldment
UGSsetojpg_SE SheetMetal_ets_nr_types=
SE-sheetMetal
UGSsetojpg_SE Part_ets_nr_types=
SE-part

PLM00026 11.2 Preferences and Environment Variables Reference 6-81

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetotif_<dataset>_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the Solid Edge dataset named references
necessary for translation.
All named reference types specified by the preference must exist to be translated. If no
named reference types are specified, no named reference type validation is performed.
Each dataset requires a separate preference in which dataset is a valid Teamcenter
dataset. For example:
UGSsetotif_SE SheetMetal_ets_nr_types=
SE-sheetMetal
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
UGSsetotif_SE SheetMetal_ets_nr_types=
SE-sheetMetal
UGSsetotif_SE Weldment_ets_nr_types =
SE-weldment
UGSsetotif_SE Part_ets_nr_types =
SE-part
UGSsetotif_SE Draft_ets_nr_types =
SE-draft
UGSsetotif_SE Assembly_ets_nr_types=
SE-assembly
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetopdf_SE Draft_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the Solid Edge SE Draft named references
necessary for translation.
All named reference types specified by the preference must exist to be translated. If no
named reference types are specified, no named reference type validation is performed.
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.

6-82 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
SE-part
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoxt_<dataset>_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the Solid Edge dataset named references
necessary for translation.
All named reference types specified by the preference must exist to be translated. If no
named reference types are specified, no named reference type validation is performed.
Each dataset requires a separate preference in which dataset is a valid Teamcenter
dataset. For example:
UGSsetoxt_SE Assembly_ets_nr_types=
SE-assembly
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
UGSsetoxt_SE Assembly_ets_nr_types=
SE-assembly
UGSsetoxt_SE SheetMetal_ets_nr_types
SE-sheetMetal
UGSsetoxt_SE Weldment_ets_nr_types
SE-weldment
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetostep_<dataset>_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the Solid Edge dataset named references
necessary for translation.
All named reference types specified by the preference must exist to be translated. If no
named reference types are specified, no named reference type validation is performed.
Each dataset requires a separate preference in which dataset is a valid Teamcenter
dataset. For example:
UGSsetostep_SE Assembly_ets_nr_types=
SE-assembly

PLM00026 11.2 Preferences and Environment Variables Reference 6-83

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
UGSsetostep_SE Assembly_ets_nr_types=
SE-assembly
UGSsetostep_SE SheetMetal_ets_nr_types
SE-sheetMetal
UGSsetostep_SE Weldment_ets_nr_types
SE-weldment
UGSsetostep_SE Part_ets_nr_types=
SE-part
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetostl_<dataset>_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the Solid Edge dataset named references
necessary for translation.
All named reference types specified by the preference must exist to be translated. If no
named reference types are specified, no named reference type validation is performed.
Each dataset requires a separate preference in which dataset is a valid Teamcenter
dataset. For example:
UGSsetostl_SE Assembly_ets_nr_types =
SE-assembly
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
UGSsetostl_SE Assembly_ets_nr_types =
SE-assembly
UGSsetostl_SE SheetMetal_ets_nr_types
SE-sheetMetal
UGSsetostl_SE Part_ets_nr_types
SE-part
DEFAULT
PROTECTION
SCOPE
Site preference.

6-84 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

UGSsetodxf_SE Draft_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the Solid Edge SE Draft named references
necessary for translation.
All named reference types specified by the preference must exist to be translated. If no
named reference types are specified, no named reference type validation is performed.
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
SE-draft
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetosat_<dataset>_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the Solid Edge dataset named references
necessary for translation.
All named reference types specified by the preference must exist to be translated. If no
named reference types are specified, no named reference type validation is performed.
Each dataset requires a separate preference in which dataset is a valid Teamcenter
dataset. For example:
UGSsetosat_SE Assembly_ets_nr_types=
SE-assembly
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
UGSsetosat_SE Assembly_ets_nr_types=
SE-assembly
UGSsetosat_SE SheetMetal_ets_nr_types=
SE-sheetMetal
UGSsetosat_SE Part_ets_nr_types =
SE-part
UGSsetosat_SE Weldment_ets_nr_types=
SE-weldment
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-85

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

UGSsetoigs_<dataset>_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the Solid Edge dataset named references
necessary for translation.
All named reference types specified by the preference must exist to be translated. If no
named reference types are specified, no named reference type validation is performed.
Each dataset requires a separate preference in which dataset is a valid Teamcenter
dataset. For example:
UGSsetoigs_SE Draft_ets_nr_types=
SE-draft
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
UGSsetoigs_SE Draft_ets_nr_types=
SE-draft
UGSsetoigs_SE Assembly_ets_nr_types
SE-assembly
UGSsetoigs_SE SheetMetal_ets_nr_types
SE-sheetMetal
UGSsetoigs_SE Part_ets_nr_types
SE-part
UGSsetoigs_SE Weldment_ets_nr_types
SE-weldment
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoplmxml_<dataset>_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the Solid Edge dataset named references
necessary for translation.
All named reference types specified by the preference must exist to be translated. If no
named reference types are specified, no named reference type validation is performed.
Each dataset requires a separate preference in which dataset is a valid Teamcenter
dataset. For example:
UGSsetoplmxml_SE Part_ets_nr_types=
SE-part
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.

6-86 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
UGSsetoplmxml_SE Part_ets_nr_types=
SE-part
UGSsetoplmxml_SE Assembly_ets_nr_types=
SE-assembly
UGSsetoplmxml_SE Weldment_ets_nr_types=
SE-weldment
UGSsetoplmxml_SE SheetMetal_ets_nr_types=
SE-sheetMetal
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoxgl_<dataset>_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the Solid Edge dataset named references
necessary for translation.
All named reference types specified by the preference must exist to be translated. If no
named reference types are specified, no named reference type validation is performed.
Each dataset requires a separate preference in which dataset is a valid Teamcenter
dataset. For example:
UGSsetoxgl_SE Part_ets_nr_types =
SE-part
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
UGSsetoxgl_SE Part_ets_nr_types =
SE-part
UGSsetoxgl_SE Assembly_ets_nr_types =
SE-assembly
UGSsetoxgl_SE Weldment_ets_nr_types =
SE-weldment
UGSsetoxgl_SE SheetMetal_ets_nr_types =
SE-sheetMetal
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-87

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

UGSvisprint_PDF_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies PDF dataset named references necessary
for translation.
All named reference types specified by this preference must exist for a dataset of this
type to be translated. If no named reference types are specified, no named reference
type validation is performed.
VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
Adobe-pdf
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojt_<dataset>_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetojt_SE Assembly_ets_dst_relation_type=
IMAN_manifestation
UGSsetojt _SE SheetMetal_ets_dst_relation_type=
IMAN_manifestation
UGSsetojt _SE Weldment_ets_dst_relation_type=
IMAN_manifestation
UGSsetojt _SE Part_ets_dst_relation_type=
IMAN_manifestation
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

6-88 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

UGSsetobmp_<dataset>_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetobmp_SE Assembly_ets_dst_relation_type=
IMAN_manifestation
UGSsetobmp_SE Draft_ets_dst_relation_type=
IMAN_manifestation
UGSsetobmp_SE Weldment_ets_dst_relation_type=
IMAN_manifestation
UGSsetobmp_SE Part_ets_dst_relation_type=
IMAN_manifestation
UGSsetobmp_SE SheetMetal_ets_dst_relation_type=
IMAN_manifestation
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojpg_<dataset>_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetojpg_SE Assembly_ets_dst_relation_type=
IMAN_manifestation
UGSsetojpg_SE SheetMetal_ets_dst_relation_type=
IMAN_manifestation
UGSsetojpg_SE Weldment_ets_dst_relation_type=
IMAN_manifestation
UGSsetojpg_SE Part_ets_dst_relation_type=

PLM00026 11.2 Preferences and Environment Variables Reference 6-89

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

IMAN_manifestation
UGSsetojpg_SE Draft_ets_dst_relation_type=
IMAN_manifestation
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetotif_<dataset>_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetotif_SE Assembly_ets_dst_relation_type=
IMAN_manifestation
UGSsetotif_SE SheetMetal_ets_dst_relation_type=
IMAN_manifestation
UGSsetotif_SE Weldment_ets_dst_relation_type=
IMAN_manifestation
UGSsetotif_SE Part_ets_dst_relation_type=
IMAN_manifestation
UGSsetotif_SE Draft_ets_dst_relation_type=
IMAN_manifestation
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

6-90 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

UGSsetopdf_SE Draft_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoxt_<dataset>_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetoxt_SE Assembly_ets_dst_relation_type=
IMAN_manifestation
UGSsetoxt_SE SheetMetal_ets_dst_relation_type=
IMAN_manifestation
UGSsetoxt_SE Weldment_ets_dst_relation_type=
IMAN_manifestation
UGSsetoxt_SE Part_ets_dst_relation_type=
IMAN_manifestation
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-91

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

UGSsetostep_<dataset>_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetostep_SE Assembly_ets_dst_relation_type=
IMAN_manifestation
UGSsetostep_SE SheetMetal_ets_dst_relation_type=
IMAN_manifestation
UGSsetostep_SE Weldment_ets_dst_relation_type=
IMAN_manifestation
UGSsetostep_SE Part_ets_dst_relation_type=
IMAN_manifestation
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetostl_<dataset>_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetostl_SE Assembly_ets_dst_relation_type=
IMAN_manifestation
UGSsetostl_SE SheetMetal_ets_dst_relation_type=
IMAN_manifestation
UGSsetostl_SE Part_ets_dst_relation_type=
IMAN_manifestation
VALID
VALUES
Accepts a string.

6-92 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoemf_SE Draft_ets_nr_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetodxf_SE Draft_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-93

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

UGSsetodwg_SE Draft_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetosat_<dataset>_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetosat_SE Assembly_ets_dst_relation_type=
IMAN_manifestation
UGSsetosat_SE SheetMetal_ets_dst_relation_type=
IMAN_manifestation
UGSsetosat_SE Part_ets_dst_relation_type=
IMAN_manifestation
UGSsetosat_SE Weldment_ets_dst_relation_type=
IMAN_manifestation
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

6-94 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

UGSsetoigs_<dataset>_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetoigs_SE Assembly_ets_dst_relation_type=
IMAN_manifestation
UGSsetoigs_SE SheetMetal_ets_dst_relation_type=
IMAN_manifestation
UGSsetoigs_SE Part_ets_dst_relation_type=
IMAN_manifestation
UGSsetoigs_SE Weldment_ets_dst_relation_type=
IMAN_manifestation
UGSsetoigs_SE Draft_ets_dst_relation_type=
IMAN_manifestation
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoplmxml_<dataset>_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetoplmxml_SE Assembly_ets_dst_relation_type=
IMAN_manifestation
UGSsetoplmxml_SE SheetMetal_ets_dst_relation_type=
IMAN_manifestation
UGSsetoplmxml_SE Part_ets_dst_relation_type=
IMAN_manifestation
UGSsetoplmxml_SE Weldment_ets_dst_relation_type=

PLM00026 11.2 Preferences and Environment Variables Reference 6-95

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

IMAN_manifestation
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoxgl_<dataset>_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.
If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetoxgl_SE Assembly_ets_dst_relation_type=
IMAN_manifestation
UGSsetoxgl_SE SheetMetal_ets_dst_relation_type=
IMAN_manifestation
UGSsetoxgl_SE Part_ets_dst_relation_type=
IMAN_manifestation
UGSsetoxgl_SE Weldment_ets_dst_relation_type=
IMAN_manifestation
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSvisprint_<dataset>_ets_dst_relation_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the type of relation that has to be created
between the source dataset item revision and the destination dataset.
If the source and destination dataset types are the same, this preference is ignored.

6-96 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

If the source and destination dataset types are different, this preference must be
specified; otherwise the configuration becomes invalid and an error is displayed.

Each dataset requires a separate preference. For example:

UGSvisprint_PDF_ets_dst_relation_type=
IMAN_manifestation
UGSvisprint_ACADDWG_ets_dst_relation_type=
IMAN_manifestation
UGSvisprint_UGPart_ets_dst_relation_type=
IMAN_manifestation
UGSvisprint_UGMASTER_ets_dst_relation_type=
IMAN_manifestation
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojt_<dataset>_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.

Each dataset requires a separate preference. For example:

UGSsetojt_SE Assembly_ets_dst_relation_to_src=
false
UGSsetojt_SE SheetMetal_ets_dst_relation_to_src=
false
UGSsetojt_SE Weldment_ets_dst_relation_to_src=
false
UGSsetojt_SE Part_ets_dst_relation_to_src=
false
VALID
VALUES
Accepts a Boolean value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-97

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

UGSsetobmp_<dataset>_ets_dst_relation_to_src

DESCRIPTION
Specifies whether a relation needs to be created between the source dataset and
the destination dataset.

Each dataset requires a separate preference. For example:

UGSsetobmp_SE SheetMetal_ets_dst_relation_to_src=
false
UGSsetobmp_SE Weldment_ets_dst_relation_to_src=
false
UGSsetobmp_SE Assembly_ets_dst_relation_to_src=
false
UGSsetobmp_SE Part_ets_dst_relation_to_src=
false
UGSsetobmp_SE Draft_ets_dst_relation_to_src=
false
VALID
VALUES
Accepts a Boolean value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojpg_<dataset>_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.

Each dataset requires a separate preference. For example:

UGSsetojpg_SE Part_ets_dst_relation_to_src =
false
UGSsetojpg_SE SheetMetal_ets_dst_relation_to_src =
false
UGSsetojpg_SE Weldment_ets_dst_relation_to_src =
false
UGSsetojpg_SE Assembly_ets_dst_relation_to_src =
false
UGSsetojpg_SE Draft_ets_dst_relation_to_src =
false
VALID
VALUES
Accepts a Boolean value.

6-98 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetotif_<dataset>_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.
Each dataset requires a separate preference. For example:
UGSsetotif_SE Part_ets_dst_relation_to_src =
false
UGSsetotif_SE SheetMetal_ets_dst_relation_to_src =
false
UGSsetotif_SE Weldment_ets_dst_relation_to_src =
false
UGSsetotif_SE Assembly_ets_dst_relation_to_src =
false
UGSsetotif_SE Draft_ets_dst_relation_to_src =
false
VALID
VALUES
Accepts a Boolean value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetopdf_SE Draft_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.
VALID
VALUES
Accepts a Boolean value.
DEFAULT
VALUES
false

PLM00026 11.2 Preferences and Environment Variables Reference 6-99

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoxt_<dataset>_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.
Each dataset requires a separate preference. For example:
UGSsetoxt_SE Part_ets_dst_relation_to_src =
false
UGSsetoxt_SE SheetMetal_ets_dst_relation_to_src =
false
UGSsetoxt_SE Weldment_ets_dst_relation_to_src =
false
UGSsetoxt_SE Assembly_ets_dst_relation_to_src =
false
VALID
VALUES
Accepts a Boolean value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetostep_<dataset>_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.
Each dataset requires a separate preference. For example:
UGSsetostep_SE Part_ets_dst_relation_to_src =
false
UGSsetostep_SE SheetMetal_ets_dst_relation_to_src =
false
UGSsetostep_SE Weldment_ets_dst_relation_to_src =
false
UGSsetostep_SE Assembly_ets_dst_relation_to_src =
false
VALID
VALUES
Accepts a Boolean value.

6-100 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetostl_<dataset>_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.
Each dataset requires a separate preference. For example:
UGSsetostl_SE Part_ets_dst_relation_to_src =
false
UGSsetostl_SE SheetMetal_ets_dst_relation_to_src =
false
UGSsetostl_SE Assembly_ets_dst_relation_to_src =
false
VALID
VALUES
Accepts a Boolean value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoemf_SE Draft_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.
VALID
VALUES
Accepts a Boolean value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-101

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

UGSsetodxf_SE Draft_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.
VALID
VALUES
Accepts a Boolean value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetodwg_SE Draft_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.
VALID
VALUES
Accepts a Boolean value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetosat_<dataset>_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.
Each dataset requires a separate preference. For example:
UGSsetosat_SE Part_ets_dst_relation_to_src =
false
UGSsetosat_SE SheetMetal_ets_dst_relation_to_src =
false
UGSsetosat_SE Weldment_ets_dst_relation_to_src =
false
UGSsetosat_SE Assembly_ets_dst_relation_to_src =
false
VALID
VALUES
Accepts a Boolean value.

6-102 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoigs_<dataset>_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.
Each dataset requires a separate preference. For example:
UGSsetoigs_SE Part_ets_dst_relation_to_src =
false
UGSsetoigs_SE SheetMetal_ets_dst_relation_to_src =
false
UGSsetoigs_SE Weldment_ets_dst_relation_to_src =
false
UGSsetoigs_SE Assembly_ets_dst_relation_to_src =
false
UGSsetoigs_SE Draft_ets_dst_relation_to_src =
false
VALID
VALUES
Accepts a Boolean value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoplmxml_<dataset>_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.
Each dataset requires a separate preference. For example:
UGSsetoplmxml_SE Part_ets_dst_relation_to_src =
false
UGSsetoplmxml_SE SheetMetal_ets_dst_relation_to_src =
false
UGSsetoplmxml_SE Weldment_ets_dst_relation_to_src =
false
UGSsetoplmxml_SE Assembly_ets_dst_relation_to_src =

PLM00026 11.2 Preferences and Environment Variables Reference 6-103

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

false
VALID
VALUES
Accepts a Boolean value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoxgl_<dataset>_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.
Each dataset requires a separate preference. For example:
UGSsetoxgl_SE Part_ets_dst_relation_to_src =
false
UGSsetoxgl_SE SheetMetal_ets_dst_relation_to_src =
false
UGSsetoxgl_SE Weldment_ets_dst_relation_to_src =
false
UGSsetoxgl_SE Assembly_ets_dst_relation_to_src =
false
VALID
VALUES
Accepts a Boolean value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSvisprint_PDF_ets_dst_relation_to_src

DESCRIPTION
For Teamcenter Rapid Start, specifies whether a relation needs to be created between
the source dataset and the destination dataset.
Each dataset requires a separate preference. For example:
UGSvisprint_PDF_ets_dst_relation_to_src =
false
UGSvisprint_ACADDWG_ets_dst_relation_to_src =
false
UGSvisprint_UGPART_ets_dst_relation_to_src =

6-104 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

false
UGSvisprint_UGMASTER_ets_dst_relation_to_src =
false
VALID
VALUES
Accepts a Boolean value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojt_<dataset>_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that
will store the result of Solid Edge translation of the dataset. If no destination named
reference type is specified, the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetojt_SE Assembly_ets_dst_nr_type=
JTPART
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetojt_SE Assembly_ets_dst_nr_type=
JTPART
UGSsetojt_SE SheetMetal_ets_dst_nr_type=
JTPART
UGSsetojt_SE Weldment_ets_dst_nr_type=
JTPART
UGSsetojt_SE Part_ets_dst_nr_type=
JTPART
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetobmp_<dataset>_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that
will store the result of Solid Edge translation of the dataset. If no destination named
reference type is specified, the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:

PLM00026 11.2 Preferences and Environment Variables Reference 6-105

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

UGSsetobmp_SE Assembly_ets_dst_nr_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetobmp_SE Assembly_ets_dst_nr_type=
Image
UGSsetobmp_SE SheetMetal_ets_dst_nr_type=
Image
UGSsetobmp_SE Weldment_ets_dst_nr_type=
Image
UGSsetobmp_SE Part_ets_dst_nr_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojpg_<dataset>_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that
will store the result of Solid Edge translation of the dataset. If no destination named
reference type is specified, the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetojpg_SE Assembly_ets_dst_nr_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetojpg_SE Assembly_ets_dst_nr_type=
Image
UGSsetojpg_SE SheetMetal_ets_dst_nr_type=
Image
UGSsetojpg_SE Weldment_ets_dst_nr_type=
Image
UGSsetojpg_SE Part_ets_dst_nr_type=
Image
UGSsetojpg_SE Draft_ets_dst_nr_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

6-106 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

UGSsetotif_<dataset>_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that
will store the result of Solid Edge translation of the dataset. If no destination named
reference type is specified, the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetotif_SE Assembly_ets_dst_nr_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetotif_SE Assembly_ets_dst_nr_type=
Image
UGSsetotif_SE SheetMetal_ets_dst_nr_type=
Image
UGSsetotif_SE Weldment_ets_dst_nr_type=
Image
UGSsetotif_SE Part_ets_dst_nr_type=
Image
UGSsetotif_SE Draft_ets_dst_nr_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetopdf_SE Draft_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that will
store the result of Solid Edge translation of SE Draft. If no destination named reference
type is specified, the configuration becomes invalid and an error is displayed.
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
PDF_Ref
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-107

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

UGSsetoxt_<dataset>_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that
will store the result of Solid Edge translation of the dataset. If no destination named
reference type is specified, the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetoxt_SE Assembly_ets_dst_nr_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetoxt_SE Assembly_ets_dst_nr_type=
Image
UGSsetoxt_SE SheetMetal_ets_dst_nr_type=
Image
UGSsetoxt_SE Weldment_ets_dst_nr_type=
Image
UGSsetoxt_SE Part_ets_dst_nr_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetostep_<dataset>_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that
will store the result of Solid Edge translation of the dataset. If no destination named
reference type is specified, the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetostep_SE Assembly_ets_dst_nr_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetostep_SE Assembly_ets_dst_nr_type=
Image
UGSsetostep_SE SheetMetal_ets_dst_nr_type=
Image
UGSsetostep_SE Weldment_ets_dst_nr_type=
Image
UGSsetostep_SE Part_ets_dst_nr_type=

6-108 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoemf_SE Draft_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that will
store the result of Solid Edge translation of SE Draft. If no destination named reference
type is specified, the configuration becomes invalid and an error is displayed.
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
SE-draft_image-emf
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetodxf_SE Draft_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that will
store the result of Solid Edge translation of SE Draft. If no destination named reference
type is specified, the configuration becomes invalid and an error is displayed.
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetodwg_SE Draft_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that will
store the result of Solid Edge translation of SE Draft. If no destination named reference
type is specified, the configuration becomes invalid and an error is displayed.
VALID
VALUES
Accepts a string.

PLM00026 11.2 Preferences and Environment Variables Reference 6-109

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
VALUES
DWG
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetosat_<dataset>_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that
will store the result of Solid Edge translation of the dataset. If no destination named
reference type is specified, the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetosat_SE Assembly_ets_dst_nr_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetosat_SE Assembly_ets_dst_nr_type=
Image
UGSsetosat_SE SheetMetal_ets_dst_nr_type=
Image
UGSsetosat_SE Part_ets_dst_nr_type=
Image
UGSsetosat_SE Weldment_ets_dst_nr_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoigs_<dataset>_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that
will store the result of Solid Edge translation of the dataset. If no destination named
reference type is specified, the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetoigs_SE Assembly_ets_dst_nr_type=
Image
VALID
VALUES
Accepts a string.

6-110 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
UGSsetoigs_SE Assembly_ets_dst_nr_type=
Image
UGSsetoigs_SE SheetMetal_ets_dst_nr_type=
Image
UGSsetoigs_SE Part_ets_dst_nr_type=
Image
UGSsetoigs_SE Weldment_ets_dst_nr_type=
Image
UGSsetoigs_SE Draft_ets_dst_nr_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoplmxml_<dataset>_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that
will store the result of Solid Edge translation of the dataset. If no destination named
reference type is specified, the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetoplmxml_SE Assembly_ets_dst_nr_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetoplmxml_SE Assembly_ets_dst_nr_type=
Image
UGSsetoplmxml_SE SheetMetal_ets_dst_nr_type=
Image
UGSsetoplmxml_SE Part_ets_dst_nr_type=
Image
UGSsetoplmxml_SE Weldment_ets_dst_nr_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-111

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

UGSsetoxgl_<dataset>_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that
will store the result of Solid Edge translation of the dataset. If no destination named
reference type is specified, the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetoxgl_SE Assembly_ets_dst_nr_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetoxgl_SE Assembly_ets_dst_nr_type=
Image
UGSsetoxgl_SE SheetMetal_ets_dst_nr_type=
Image
UGSsetoxgl_SE Part_ets_dst_nr_type=
Image
UGSsetoxgl_SE Weldment_ets_dst_nr_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSvisprint_<dataset>_ets_dst_nr_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination named reference type that will
store the result of UGS visprint translation of the dataset. If no destination named
reference type is specified, the configuration becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSvisprint_PDF_ets_dst_nr_type=
Sheet
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSvisprint_PDF_ets_dst_nr_type=
Image
UGSvisprint_ACADDWG_ets_dst_nr_type=
Image
UGSvisprint_UGMASTER_ets_dst_nr_type=
Sheet
UGSvisprint_UGPART_ets_dst_nr_type=

6-112 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Sheet
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojt_<dataset>_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetojt_SE Assembly_ets_dst_ds_type=
DirectModel
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetojt_SE Assembly_ets_dst_ds_type=
DirectModel
UGSsetojt_SE SheetMetal_ets_dst_ds_type=
DirectModel
UGSsetojt_SE Weldment_ets_dst_ds_type=
DirectModel
UGSsetojt_SE Part_ets_dst_ds_type=
DirectModel
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetobmp_<dataset>_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetobmp_SE SheetMetal_ets_dst_ds_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetobmp_SE SheetMetal_ets_dst_ds_type=

PLM00026 11.2 Preferences and Environment Variables Reference 6-113

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Image
UGSsetobmp_SE Weldment_ets_dst_ds_type=
Image
UGSsetobmp_SE Part_ets_dst_ds_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetojpg_<dataset>_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetojpg_SE Assembly_ets_dst_ds_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetojpg_SE Assembly_ets_dst_ds_type=
Image
UGSsetojpg_SE SheetMetal_ets_dst_ds_type=
Image
UGSsetojpg_SE Weldment_ets_dst_ds_type=
Image
UGSsetojpg_SE Part_ets_dst_ds_type=
Image
UGSsetojpg_SE Draft_ets_dst_ds_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetotif_<dataset>_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetotif_SE Assembly_ets_dst_ds_type=
Image

6-114 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetotif_SE Assembly_ets_dst_ds_type=
Image
UGSsetotif_SE SheetMetal_ets_dst_ds_type=
Image
UGSsetotif_SE Weldment_ets_dst_ds_type=
Image
UGSsetotif_SE Part_ets_dst_ds_type=
Image
UGSsetotif_SE Draft_ets_dst_ds_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetopdf_SE Draft_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
PDF
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoxt_<dataset>_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetoxt_SE Assembly_ets_dst_ds_type=
Image
VALID
VALUES
Accepts a string.

PLM00026 11.2 Preferences and Environment Variables Reference 6-115

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
VALUES
UGSsetoxt_SE Assembly_ets_dst_ds_type=
Image
UGSsetoxt_SE SheetMetal_ets_dst_ds_type=
Image
UGSsetoxt_SE Weldment_ets_dst_ds_type=
Image
UGSsetoxt_SE Part_ets_dst_ds_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetostep_<dataset>_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetostep_SE SheetMetal_ets_dst_ds_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetostep_SE SheetMetal_ets_dst_ds_type=
Image
UGSsetostep_SE Weldment_ets_dst_ds_type=
Image
UGSsetostep_SE Part_ets_dst_ds_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetostl_<dataset>_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetostl_SE Assembly_ets_dst_ds_type=

6-116 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

STL
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetostl_SE Assembly_ets_dst_ds_type=
STL
UGSsetostl_SE SheetMetal_ets_dst_ds_type=
STL
UGSsetostl_SE Part_ets_dst_ds_type=
STL
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoemf_SE Draft_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
SE Draft
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetodxf_SE Draft_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-117

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

UGSsetodwg_SE Draft_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
ACADDWG
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetosat_<dataset>_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetosat_SE Assembly_ets_dst_ds_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetosat_SE Assembly_ets_dst_ds_type=
Image
UGSsetosat_SE SheetMetal_ets_dst_ds_type=
Image
UGSsetosat_SE Part_ets_dst_ds_type=
Image
UGSsetosat_SE Weldment_ets_dst_ds_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

6-118 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

UGSsetoigs_<dataset>_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetoigs_SE Assembly_ets_dst_ds_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetoigs_SE Assembly_ets_dst_ds_type=
Image
UGSsetoigs_SE SheetMetal_ets_dst_ds_type=
Image
UGSsetoigs_SE Part_ets_dst_ds_type=
Image
UGSsetoigs_SE Weldment_ets_dst_ds_type=
Image
UGSsetoigs_SE Draft_ets_dst_ds_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoplmxml_<dataset>_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetoplmxml_SE Assembly_ets_dst_ds_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetoplmxml_SE Assembly_ets_dst_ds_type=
Image
UGSsetoplmxml_SE SheetMetal_ets_dst_ds_type=
Image
UGSsetoplmxml_SE Part_ets_dst_ds_type=

PLM00026 11.2 Preferences and Environment Variables Reference 6-119

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Image
UGSsetoplmxml_SE Weldment_ets_dst_ds_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSsetoxgl_<dataset>_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSsetoxgl_SE Part_ets_dst_ds_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSsetoxgl_SE SheetMetal_ets_dst_ds_type=
Image
UGSsetoxgl_SE Part_ets_dst_ds_type=
Image
UGSsetoxgl_SE Weldment_ets_dst_ds_type=
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSvisprint_<dataset>_ets_dst_ds_type

DESCRIPTION
For Teamcenter Rapid Start, specifies the destination dataset type that will store the
result of translation. If no destination dataset type is specified, the configuration
becomes invalid and an error is displayed.
Each dataset requires a separate preference. For example:
UGSvisprint_PDF_ets_dst_ds_type=
Image
VALID
VALUES
Accepts a string.
DEFAULT
VALUES
UGSvisprint_PDF_ets_dst_ds_type=

6-120 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Image
UGSvisprint_ACADDWG_ets_dst_ds_type=
Image
UGSvisprint_UGMASTER_ets_dst_ds_type=
DrawingSheet
DEFAULT
PROTECTION
SCOPE
Site preference.

UGSvisprint_ets_ds_types

DESCRIPTION
For Teamcenter Rapid Start, specifies the dataset type names for translation. If
no dataset types are specified, no named reference type validation is performed.
Additional named reference type validation can be configured for the datasets
specified by this preference value.
VALID
VALUES
Accepts multiple strings as values.
DEFAULT
VALUES
MSWord
MSExcel
MSPowerPoint
SE Draft
UGPART
UGMASTER
ACADDWG
PDF

DEFAULT
PROTECTION
SCOPE
Site preference.

VIS_simpgen_admin_group

DESCRIPTION
Lists the name of the user group that is authorized to run the Simpgen translator
from the RAC Translation menu.
VALID
VALUES
The name of a Teamcenter group.
DEFAULT
VALUES
SimpGenAdmin

PLM00026 11.2 Preferences and Environment Variables Reference 6-121

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ETS.PRIORITY.<ProviderName>.<ServiceName>

DESCRIPTION
Specifies the priority for a particular provider and service.
VALID
VALUES
0 No translation takes place
1 Low priority
2 Medium priority
3 High priority
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ETS.DATASETTYPES.<ProviderName>.<ServiceName>

DESCRIPTION
Specifies the applicable dataset types for a service.
VALID
VALUES
Accepts multiple strings as values. It must be a valid dataset name.
DEFAULT
VALUES
DEFAULT
PROTECTION
SCOPE
Site preference.

ETS.TRANSLATOR_ARGS.<ProviderName>.<ServiceName>

DESCRIPTION
Specifies the arguments that are passed to a service.
VALID
VALUES
String that represent the argument that is passed to a service.
DEFAULT
VALUES
DEFAULT
PROTECTION
SCOPE
Site preference.

6-122 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

SIEMENStozipfile_ets_ds_types

DESCRIPTION
Specifies the datasets that the Siemens PLM Software tozipfile service can translate.
If you do not specify a dataset type, the service configuration is invalid and an error
occurs during translation.
VALID
VALUES
Accepts multiple strings as values. It must be a valid dataset name.
DEFAULT
VALUES
MSWord
MSWordX
DEFAULT
PROTECTION
SCOPE
Site preference.

SIEMENStozipfile_MSWord_ets_dst_ds_type

DESCRIPTION
Specifies the dataset type, which is the result of the Siemens PLM Software tozipfile
translation of a Microsoft Word dataset. If you do not specify a dataset type, the
service configuration is invalid and an error occurs during translation.
VALID
VALUES
Must be a valid dataset name.
DEFAULT
VALUES
Zip
DEFAULT
PROTECTION
SCOPE
Site preference.

SIEMENStozipfile_MSWord_ets_dst_nr_type

DESCRIPTION
Specifies the dataset reference type, which is the result of the Siemens PLM Software
tozipfile translation of a Microsoft Word dataset. If you do not specify a dataset type,
the service configuration is invalid and an error occurs during translation.
VALID
VALUES
Must be a valid dataset reference type.
DEFAULT
VALUES
ZIPFILE

PLM00026 11.2 Preferences and Environment Variables Reference 6-123

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SIEMENStozipfile_MSWord_ets_nr_types

DESCRIPTION
Specifies the source dataset named reference necessary for translation. One of the
dataset named reference types specified by this preference must exist for the Microsoft
Word dataset to be valid for translation. If you do not specify named reference types,
the service configuration is invalid and an error occurs during translation.
VALID
VALUES
Accepts multiple strings as values. It must be a valid dataset reference type.
DEFAULT
VALUES
word
DEFAULT
PROTECTION
SCOPE
Site preference.

SIEMENStozipfile_MSWord_ets_dst_relation_type

DESCRIPTION
Specifies the relation type of the relation to be created between the source dataset
item revision and the destination dataset. If the source and destination dataset types
are the same, this preference is ignored. You must specify this preference if the source
and destination datasets are different; otherwise the service configuration is invalid
and an error occurs during translation.
VALID
VALUES
Must be a valid relation type.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

SIEMENStozipfile_MSWord_ets_dst_relation_to_src

DESCRIPTION
Specifies if a relation must be created between the Microsoft Word source dataset
and destination dataset.
VALID
VALUES
true Creates a relation between the source and destination dataset.

6-124 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

false Does not create a relation between the source and destination dataset.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

SIEMENStozipfile_MSWordX_ets_dst_ds_type

DESCRIPTION
Specifies the dataset type, which will be the result of the Siemens PLM Software
tozipfile translation of a Microsoft WordX dataset. If you do not specify a dataset type,
the service configuration is invalid and an error occurs during translation.
VALID
VALUES
Must be a valid dataset name.
DEFAULT
VALUES
Zip
DEFAULT
PROTECTION
SCOPE
Site preference.

SIEMENStozipfile_MSWordX_ets_dst_nr_type

DESCRIPTION
Specifies the dataset named reference type, which is the result of the Siemens PLM
Software tozipfile translation of a Microsoft WordX dataset. If you do not specify a
dataset type, the service configuration is invalid and an error occurs during translation.
VALID
VALUES
Must be a valid dataset reference type.
DEFAULT
VALUES
ZIPFILE
DEFAULT
PROTECTION
SCOPE
Site preference.

SIEMENStozipfile_MSWordX_ets_nr_types

DESCRIPTION
Specifies the source dataset named reference necessary for translation. One of the
dataset named reference types specified by this preference must exist for the Microsoft
WordX dataset to be valid for translation. If you do not specify named reference types,
the service configuration is invalid and an error occurs during translation.

PLM00026 11.2 Preferences and Environment Variables Reference 6-125

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
Accepts multiple strings as values. It must be a valid dataset reference type.
DEFAULT
VALUES
word
DEFAULT
PROTECTION
SCOPE
Site preference.

SIEMENStozipfile_MSWordX_ets_dst_relation_type

DESCRIPTION
Specifies the relation type of the relation to be created between the source dataset
item revision and the destination dataset. If the source and destination dataset types
are the same, this preference is ignored. You must specify this preference if the source
and destination datasets are different; otherwise, the service configuration is invalid
and an error occurs during translation.
VALID
VALUES
Must be a valid relation type.
DEFAULT
VALUES
IMAN_manifestation
DEFAULT
PROTECTION
SCOPE
Site preference.

SIEMENStozipfile_MSWordX_ets_dst_relation_to_src

DESCRIPTION
Specifies if a relation must be created between the Microsoft WordX source dataset
and destination dataset.
VALID
VALUES
true Creates a relation between the source and destination dataset.
false Does not create a relation between the source and destination dataset.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

6-126 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

TS_successful_states

DESCRIPTION
Specifies all the successful states in the dispatcher client.
VALID
VALUES
Successful state names of the dispatcher client.
DEFAULT
VALUES
COMPLETE
DUPLICATE
DELETE
CANCELLED
SUPERSEDED
NO_TRANS
DEFAULT
PROTECTION
SCOPE
Site preference.

TS_unsuccessful_states

DESCRIPTION
Specifies all the unsuccessful states in the dispatcher client.
VALID
VALUES
Unsuccessful state names of the dispatcher client.
DEFAULT
VALUES
TERMINAL
DEFAULT
PROTECTION
SCOPE
Site preference.

TS_inprocess_states

DESCRIPTION
Specifies all the inprocess states in the dispatcher client.
VALID
VALUES
Inprocess states in the dispatcher client.
DEFAULT
VALUES
PREPARING
SCHEDULED
SUPERSEDING
TRANSLATING
LOADING

PLM00026 11.2 Preferences and Environment Variables Reference 6-127

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ETS_trans_rqst_referenced_dataset_types

DESCRIPTION
Specifies the set of all tool dataset types that a Dispatcher translation request may
reference. This preference is used by Dispatcher to cancel translation requests that
prevent user deletion of datasets.
VALID
VALUES
Valid dataset types.
DEFAULT
VALUES
IdeasPart
IdeasAssembly
IdeasDrawing
catia
CATPart
CATProduct
UGPART
UGMASTER
UGALTREP
UGSCENARIO
ProPrt
MSWord
DEFAULT
PROTECTION
SCOPE
Site preference.

ETS.SCOTYPES.SIEMENS.POPULATEFSC

DESCRIPTION
Specifies the applicable structure context object types for the POPULATEFSC
translator.
VALID
VALUES
Valid structure context object types.
DEFAULT
VALUES
*
DEFAULT
PROTECTION
SCOPE
Site preference.

6-128 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

ETS.ITEMREVTYPES.SIEMENS.SIMPGEN

DESCRIPTION
Specifies the applicable item revision types for the SIMPGEN translator.
VALID
VALUES
Valid item revision types.
DEFAULT
VALUES
*
DEFAULT
PROTECTION
SCOPE
Site preference.

DISPATCHER_rqst_cancel_referenced_services

DESCRIPTION
Specifies the list of all services that should always delete requests when primary
or secondary objects are deleted. This preference is used by Dispatcher to cancel
requests that prevent user deletion of datasets or item revisions.
VALID
VALUES
Provider-name:Service-name
DEFAULT
VALUES
SIEMENS:fmstransfer
DEFAULT
PROTECTION
SCOPE
Site preference.

Email polling preferences

Fnd0EMLPollingRevFrm.JAVARENDERING

DESCRIPTION
Defines the Java class to render the property panel of a form with type Review Email
Polling Revision Form.
VALID
VALUES
Java class to render the property panel of a form.
DEFAULT
VALUES
com.teamcenter.rac.emailpolling.commands.rendering.EmailPollingRevisionForm
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-129

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Fnd0EMLPollingRevFrm.FORMJAVARENDERING

DESCRIPTION
Defines the Java class to render the property panel of a form with type Review Email
Polling Revision Form.
VALID
VALUES
Java class to render property panel of a form.
DEFAULT
VALUES
com.teamcenter.rac.emailpolling.commands.rendering.EmailPollingRevisionForm
DEFAULT
PROTECTION
SCOPE
Site preference.

Email_polling_download_dir

DESCRIPTION
Defines the directory where mail attachments are downloaded for the email polling
functionality.
VALID
VALUES
Accepts single string as a value; each string must be the full operating system path of
the directory.

Note

When a Windows path is used, a double slash is required after the drive
designation, for example:
Email_polling_download_dir=c:\\temp

DEFAULT
VALUES
Windows:

c:\\temp
UNIX:

/tmp
DEFAULT
PROTECTION
SCOPE
Site preference.

Fnd0_review_email_attachments_workflow

DESCRIPTION
Defines the create workflow for email polling functionality.

6-130 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
A Teamcenter Workflow process, although Review Mail Attachments is the
Teamcenter provided default.
DEFAULT
VALUES
Review Mail Attachments
DEFAULT
PROTECTION
SCOPE
Site preference.

EMLPOLLING_default_polling_config_id

DESCRIPTION
Defines the identifier for email polling configuration to be used in the email polling
operation.
VALID
VALUES
Any identifier for email polling configuration.
DEFAULT
VALUES
def_polling_config_id
DEFAULT
PROTECTION
SCOPE
Site preference.

Mail_server_name

DESCRIPTION
Sets the name of the mail gateway server. The server should be a machine running a
sendmail daemon.
This preference must be set to send system e-mail. The placeholder default setting
may return errors if the send command is used.
VALID
VALUES
Text server name or an numeric IP address.
DEFAULT
VALUES
your mail server machine
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-131

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

TC_mail_interval

DESCRIPTION
Determines how often Teamcenter checks for new system mail. This can also be set in
the rich client interface by choosing Edit→Options→Mail.
VALID
VALUES
A single positive integer.
DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
User preference.

Full-text search preferences

TC_fts_aci_port

DESCRIPTION
Specifies the Autonomy Content Infrastructure (ACI) action port number. This port is
used to send action query commands to the Autonomy IDOL server.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts a single string as a value. Must be the number of the port used by the ACI.
This preference setting should be the same as the Port setting in the Autonomy IDOL
server's configuration file.
DEFAULT
VALUES
Teamcenter installation provides an opportunity to install the Autonomy search engine.
If you choose this option, this preference is automatically set to 9000.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_any_language

DESCRIPTION
Enables searches to return documents in any language for your query rather than only
in the query's language.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Valid values are:
• true

6-132 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Searches return documents in any language.

• false
Searches return documents only in the query’s language. This is the default value
for the preference.

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_database_name

DESCRIPTION
Specifies the name of the Autonomy database in which Teamcenter database objects
are indexed.
This preference works in conjunction with the following preferences. Each preference
must be defined correctly to use the Autonomy search engine for indexing and
searching:
TC_fts_engine
TC_fts_host
TC_fts_aci_port
TC_fts_index_port
TC_fts_fsf_host
TC_fts_fsf_port

For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts a single string as a value. Must be a valid database name, in which the
Teamcenter database objects are indexed.
DEFAULT
VALUES
Teamcenter installation provides an opportunity to install the Autonomy search engine.
If you choose this option, this preference is automatically set to the user-defined
database.
Additionally, the database setting can be reset in the Autonomy server configuration
file.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-133

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

TC_fts_default_AND_operator

DESCRIPTION
Activates the default logical operator of keyword search to AND.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Valid values are:
• true
The default logical operator is set to AND.

• false
No default logical operator is set. This is the default value for the preference.

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_default_language_type

DESCRIPTION
Specifies the default language type used by Autonomy for indexing and searching.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts a single string as a value. Must be one of the following supported languages:
English
French
German
Chinese
Japanese
Korean

DEFAULT
VALUES
Teamcenter installation provides an opportunity to install the Autonomy search engine.
If you choose this option, this preference is automatically set to the user-selected
language. This preference setting should be the same as the DefaultLanguageType
setting in the Autonomy server configuration file.
DEFAULT
PROTECTION
SCOPE
Site preference.

6-134 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

TC_fts_enforce_master_language

DESCRIPTION
Specifies the language used to index unlocalized properties in cases where the site
master language should not be used.

For example, if you set an unlocalized locale to one locale, such as ja_JP, but the
SiteMasterLanguage global constant is set to another locale, such as en_US, the
full-text search engine tries to use the SiteMasterLanguage, English, to index
Japanese characters.

In this case, set the TC_fts_enforce_master_language value to japaneseUTF8.

For more information setting the SiteMasterLanguage global constant, see

Teamcenter Localization.

For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts one of the following as a single string as a value.

czechUTF8
germanUTF8
englishUTF8
spanishUTF8
frenchUTF8
italianUTF8
japaneseUTF8
koreanUTF8
polishUTF8
portugueseUTF8
russianUTF8
chineseUTF8
DEFAULT
VALUES
Null
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_engine

DESCRIPTION
Specifies the search engine used by Teamcenter's full text search (FTS) framework.

Search engines are used for searching within text documents such as Microsoft Word
documents, PDF files, and HTML files. An opportunity to install the Autonomy search
engine (includes the IDOL server and the File System Fetch connector) is provided
during installation using the Teamcenter Environment Manager (TEM). Alternatively,
you can define a different plug-and-play search engine using this preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-135

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

This preference works in conjunction with the following preferences. Each preference
must be defined correctly to use the Autonomy search engine for indexing and
searching:
TC_fts_host
TC_fts_aci_port
TC_fts_index_port
TC_fts_fsf_host
TC_fts_fsf_port
TC_fts_database_name

For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
Teamcenter installation provides an opportunity to install the Autonomy search engine.
If you choose this option during the installation, the value for this preference is
automatically set to Autonomy.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_fsf_host

DESCRIPTION
Specifies the IP address or the name of the host machine on which Autonomy
File System Fetch is running. The host and port specified by the TC_fts_fsf_port
preference are used by the FTS to send the import command to File System Fetch,
which imports and indexes documents on the IDOL server.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts a single string as a value. Must be a valid IP address or host name.
DEFAULT
VALUES
Teamcenter installation provides an opportunity to install the Autonomy search engine.
If you choose this option, the IP address of the machine on which to run Autonomy File
System Fetch is user-defined during installation. In this case, the IP address for this
preference is automatically abstracted from the installation settings.
DEFAULT
PROTECTION
SCOPE
Site preference.

6-136 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

TC_fts_fsf_port

DESCRIPTION
Specifies the port number on which Autonomy File System Fetch is listening. The
port and the host specified by the TC_fts_fsf_host preference are used by the FTS
framework to send the import command to File System Fetch, which imports and
indexes documents on the IDOL server.

For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts a single string as a value. Must be a positive integer.
DEFAULT
VALUES
Teamcenter installation provides an opportunity to install the Autonomy search engine.
If you choose this option, this preference is automatically set to 7000.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_hierarchical_index_delete

DESCRIPTION
Specifies whether full-text search index and delete operations are hierarchical.

For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Valid values are:

• true

Subtypes are valid index and delete types. This is the default value for the
preference.

• false

Subtypes are not valid index and delete types.

For example, when the TC_fts_hierarchical_index_delete preference value is true

and the type Item is listed in the preference TC_fts_indexed_types value list, the
subtypes of Item are valid index and delete types.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-137

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

TC_fts_host

DESCRIPTION
Specifies the IP address of the host machine running the Autonomy server.
If the Teamcenter server and the Autonomy server are installed on two different
machines, set the TC_TMP_DIR environment variable with the UNC path of the
Teamcenter server machine to a directory which can be accessed by the Autonomy
server. For example:
%TC_TMP_DIR%=\\ahi3w099\temp

In this situation, the Teamcenter server first creates temporary indexing files in the
$TC_TMP_DIR directory, then the Autonomy server reads the files for indexing.
Note

The TC_TMP_DIR environment variable is located in the tc_profilevars.bat file

in the $TC_DATA directory, or in the start_TcServer1.bat file in the $TC_ROOT
directory.

For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts a single string as a value. Must be the valid IP address of the host machine
running the Autonomy server.
DEFAULT
VALUES
Teamcenter installation provides an opportunity to install the Autonomy search engine.
If you choose this option, the IP address of the machine on which to run the Autonomy
server (IDOL) is user-defined during installation. In this case, the IP address for this
preference is automatically abstracted from the installation settings.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_index_port

DESCRIPTION
Specifies the index port number. This port is used to index documents for the
Autonomy IDOL server.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts a single string as a value. Must be the number of the Autonomy IDOL server's
index port. This preference setting should be the same as the IndexPort setting in the
Autonomy IDOL server’s configuration file.
DEFAULT
VALUES
Teamcenter installation provides an opportunity to install the Autonomy search engine.
If you choose this option, this preference is automatically set to 9001.

6-138 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_index_retries

DESCRIPTION
Specifies the number of times a connection with the Autonomy server is attempted
before exiting. When the number of attempts is exceeded, the system displays the
following error: aciObjectExecute failed with the message: Cannot connect. If this
message displays during full text search indexing or searching, you can increase the
value of this preference and retry.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts a single string as a value. Must be single positive integer.
DEFAULT
VALUES
2
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_index_timeout

DESCRIPTION
Specifies how long, in milliseconds, the client waits for data from the server before
closing the connection. When the length of time is exceeded, the system displays the
following error: aciObjectExecute failed with the message: Cannot connect. If this
message displays during full text search indexing or searching, you can increase the
value of this preference and retry.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts a single string as a value. Must be single positive integer.
DEFAULT
VALUES
90000
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-139

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

TC_fts_indexed_types

DESCRIPTION
Specifies types whose objects can be indexed. The FTS framework uses this
preference to determine if a given object should be indexed. If this preference is not
defined, the FTS framework does not filter out any objects.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid object type name.
DEFAULT
VALUES
Text
MSWord
MSWordX
HTML
MSExcel
MSExcelX
MSPowerPoint
MSPowerPointX
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_indexing_wait_timeout

DESCRIPTION
Specifies the amount of time, in seconds, the FTS search engine is allowed to index
one object. Because this preference is used during real-time indexing for the indexing
of work space objects, its setting significantly affects system performance.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_max_results

DESCRIPTION
Specifies the number of query results returned by the full text search engine. Use this
preference to avoid potential performance overhead on the Autonomy server.
For more information about configuring full-text search, see Application Administration.

6-140 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
A single positive integer.
DEFAULT
VALUES
300
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_query_port

DESCRIPTION
Specifies the query port number. This port is used to query Autonomy IDOL server
content.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
Teamcenter installation provides an opportunity to install the Autonomy search engine.
If you choose this option, this preference is automatically set to 9000 (the same value
as the TC_fts_aci_port preference).
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_realtime_delete_cache_size

DESCRIPTION
Specifies the cache size (number of objects) for real-time, full-text search delete
actions.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Valid values are any positive integer.
DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-141

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

TC_fts_real_time_indexing

DESCRIPTION
Specifies whether object indices are created or updated into the FTS index database
in real time, when the objects are created, modified, or deleted.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
TRUE Performs a real-time index on the objects listed in the TC_fts_indexed_types
preference.
FALSE Does not perform a real-time index on the objects listed in the
TC_fts_indexed_types preference.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_realtime_index_dt_cache_size

DESCRIPTION
Specifies the cache size (number of objects) for the real-time, full-text search dataset
index actions.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Valid values are any positive integer.
Note

Increase the value to cause fewer Autonomy calls to generate indexing and
potentially remove duplicated objects.

DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_realtime_index_item_cache_size

DESCRIPTION
Specifies the cache size (number of objects) for real-time, full text search item index
actions.
For more information about configuring full-text search, see Application Administration.

6-142 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
Valid values are any positive integer.
Note

Increase the value to cause fewer Autonomy calls to generate indexing and
potentially remove duplicated objects.

DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_result_latest_ItemRevision

DESCRIPTION
Specifies whether keyword searches return only the latest item revisions.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Valid values are:
• true
Return only the latest item revisions.

• false
Return all item revisions. This is the default value for the preference.

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_service_port

DESCRIPTION
Specifies the service port number. This port is used to query the Autonomy IDOL
server service.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts a single string as a value.

PLM00026 11.2 Preferences and Environment Variables Reference 6-143

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
VALUES
Teamcenter installation provides an opportunity to install the Autonomy search engine.
If you choose this option, this preference is automatically set to 9002.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_shared_tmp_dir_autonomy_path

DESCRIPTION
Specifies the temporary exchange directory path for the machine where the Autonomy
server is running.
This preference is defined in a new installation but has no default value and no
instance created.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
A valid value can be a UNC path or a local path, using forward slash / as a separator,
such as //myserver/shared, F:/shared, and /tmp.

Note

The user account used to start the Autonomy server must have write privileges
to this directory.
A value specified in this preference overrides values defined by the
TC_fts_shared_tmp_dir_wnt and TC_fts_shared_tmp_dir_unix preferences.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_shared_tmp_dir_unix

DESCRIPTION
Specifies the temporary exchange directory for the UNIX machine where the
Teamcenter server or Autonomy server are running.
This preference is defined in a new installation, but has no default value and no
instance created.
If the Teamcenter server and the Autonomy server are installed on different machines,
you must set either this preference (UNIX) or the TC_fts_shared_tmp_dir_wnt
preference (Windows).

6-144 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Note

Settings for the -workdir and -db arguments of the build_fts_index utility
override this preference.

For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Must be a valid UNIX directory with write privileges for the user starting the Teamcenter
server.

The separator used in this preference value must be the forward slash /, for example,
/mynetwork/mysite/myfolder.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_shared_tmp_dir_wnt

DESCRIPTION
Specifies the temporary exchange directory for the Windows host where the
Teamcenter server or Autonomy server is running.

This preference is defined in a new installation but has no default value and no
instance created.

If the Teamcenter server and the Autonomy server are installed on different machines,
you must set either this preference (Windows) or the TC_fts_shared_tmp_dir_unix
preference (UNIX).

Note

Settings for the -workdir and -db arguments of the build_fts_index utility
override this preference.

For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Must be a valid Windows directory with write privileges for the user starting the
Teamcenter server.

The separator used in the preference value must be the back slash \, for example,
\\mynetwork\mysite\myfolder.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 6-145

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_supported_files

DESCRIPTION
Specifies types of files that can be indexed.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Valid values are file extensions, for example, txt.
DEFAULT
VALUES
Default values are .as, .aw, .csv, .dat, .dc, .dif, .doc, .docm, .docx, .dot, .dotm,
.dotx, .eml, .epub, .fff, .htm, .ip, .mdb, .mif, .msg, .ods, .pdf, .ppt, .pptx, .rtf, .stc,
.sxc, .txt, .various, .vdx, .wo, .wpd, .xml, .xla, .xlam, .xls, .xlsm, .xlsx, .xlt, .xltm,
.xltx, and .xlw.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_synonym_search

DESCRIPTION
Enables synonym searches.
For more information about configuring synonym searches, see Application
Administration.
VALID
VALUES
true Enables synonym searches.

false Disables synonym searches.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_use_shared_tmp_dir

DESCRIPTION
Specifies whether the Autonomy server uses a network-shared folder as a temporary
work directory.

6-146 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Caution

If the Teamcenter server and the Autonomy server are installed on different
machines, this preference must be set to true.

For more information about configuring full-text search, see Application Administration.
VALID
VALUES
true The Autonomy server uses a network-shared folder as a temporary work
directory.
false Autonomy server does not use a network-shared folder as a temporary
work directory.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_fts_windows_autonomy_server

DESCRIPTION
Specifies whether the Autonomy server is installed on a Windows platform.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
true The Autonomy server is installed on a Windows platform.
false The Autonomy server is not installed on a Windows platform.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

<TypeName>_indexed_properties

DESCRIPTION
Specifies the properties to be indexed to the Autonomy database for a particular object
type. This preference supports type (hierarchy) inheritance.
For more information about configuring full-text search, see Application Administration.
VALID
VALUES
Accepts multiple strings as values. Each string must be a combination of a valid type
name and one or more valid property names.
The following example specifies which properties are indexed for Teamcenter forms.

PLM00026 11.2 Preferences and Environment Variables Reference 6-147

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Form_indexed_properties=
object_name
object_desc

The following example specifies which properties are indexed for Teamcenter folders.
Folder_indexed_properties=
object_name
object_desc

The following example specifies which properties are indexed for Adobe files.
Adobe_indexed_properties=
property1
property2
property3
DEFAULT
VALUES
Teamcenter installation provides an opportunity to install the Autonomy search engine.
If you choose this option, Dataset_indexed_properties is automatically created and
set to the following values:

object_name
object_type
object_desc
owning_user
owning_group
creation_date
last_mod_date
date_released
release_status_list
DEFAULT
PROTECTION
SCOPE
Site preference.

Localization preferences

TC_language_data_entry

DESCRIPTION
Defines which locales users may use for data entry. Limit the values of this preference
to locales supported by your database encoding. When this preference is set, the
system displays the following message after a user enters the appropriate credentials:
You must limit data input using locales L10N_a and L10N_b.

L10N_a and L10N_b are values set for this preference.

The system implements this preference as follows:

• If the requested locale does not exist on the Teamcenter server, the connection is
served in English.

6-148 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

• If the requested locale does not belong to the database encoding, and the
Teamcenter server is running on a UTF-8 system (for example, Linux), the
connection is served with this locale.

• If the requested locale does not belong to the database encoding, and the
Teamcenter server is running on a non-UTF-8 system, the connection is served in
English.

• If none of these situations apply, the requested locale is served.

VALID
VALUES
Accepts multiple strings as values. Each string must be one of the following country
codes indicating the desired locale:

cs_CZ
Czech

de_DE
German

en_US
English

es_ES
Spanish

fr_FR
French

it_IT
Italian

ja_JP
Japanese

ko_KR
Korean

ru_RU
Russian

zh_CN
Chinese (as spoken in China)

zh_TW
Chinese (as spoken in Taiwan)

DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 6-149

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_language_default

DESCRIPTION
Defines the default language for the Teamcenter server process.
Teamcenter allows users to select the locale on their clients, regardless of the locale
used by the Teamcenter server pool manager. The only constraints are that requested
locales are properly installed on the server side (which may not be true for customized
locales) and that the server-side system can cope with the locale encoding.
Use this preference to define what the default locale should be in the event that no
locale is passed, for example, no locale is passed from services-oriented architecture
(SOA) or the thin client. The value defines the internal Teamcenter representation
associated with a given language.
VALID
VALUES
Accepts a single string as value. The string must be one of the following country codes
indicating the desired locale or the name of the directory where your Teamcenter
server customized localization files are located:
cs_CZ
Czech
de_DE
German
en_US
English
es_ES
Spanish
fr_FR
French
it_IT
Italian
ja_JP
Japanese
ko_KR
Korean
pl_PL
Polish
pt_BR
Portuguese (Brazilian)

6-150 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

ru_RU
Russian
zh_CN
Chinese (as spoken in China)
zh_TW
Chinese (as spoken in Taiwan)

DEFAULT
VALUES
en_US
DEFAULT
PROTECTION
SCOPE
System preference.

TC_language_force_thin_client_locale

DESCRIPTION
Forces the thin client to start up with the default language as defined by the
TC_language_default preference.
Note

The TC_language_force_thin_client_locale_no_warning preference can be

used to suppress a warning message about the default locale being used when
the TC_language_force_thin_client_locale preference is set to true.

VALID
VALUES
true The thin client always starts with the default locale.
false The thin client starts with the language specified by the ?lang=
URL parameter and the browser preferences.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_language_force_thin_client_locale_no_warning

DESCRIPTION
Suppresses the error message that warns the user that the default language is being
used.

PLM00026 11.2 Preferences and Environment Variables Reference 6-151

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Note

The TC_language_force_thin_client_locale_no_warning preference can

be used only when the TC_language_force_thin_client_locale preference
is set to true.

VALID
VALUES
true Suppresses the default language warning message.
false Allows the default language warning message to display each
time the thin client is launched.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_language_localization_display

DESCRIPTION
Displays translation information as read-only for properties that are localizable.
VALID
VALUES
true Displays translation information.
false Hides translation information.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_language_localized_property_value_display

DESCRIPTION
Specifies the list of languages for displaying localized property values.
VALID
VALUES
Accepts codes representing languages, including the following codes that are
delivered with Teamcenter:
cs_CZ
Czech
de_DE
German

6-152 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

en_US
English
es_ES
Spanish
fr_FR
French
it_IT
Italian
ja_JP
Japanese
ko_KR
Korean
ru_RU
Russian
zh_CN
Chinese (as spoken in China)
zh_TW
Chinese (as spoken in Taiwan)

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
The values may contain more than one locale, which is organized as a list from the
high to low priority. If the property value does not exist in the first locale on the list, the
value is displayed with the second locale, and so on.
RESTRICTIONS
The value entered should be a valid value as defined by the Java standard. It should
also be one of the values defined in TC_language_data_entry, if this preference is set.

TC_language_localized_property_value_entry

DESCRIPTION
Specifies the data entry locale (master locale) of the logged-on user. The master
locale is the one used by the user to create/edit data in a localized property.
VALID
VALUES
Accepts codes representing languages, including the following codes that are
delivered with Teamcenter:

PLM00026 11.2 Preferences and Environment Variables Reference 6-153

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

cs_CZ Czech
de_DE German
en_US English
es_ES Spanish
fr_FR French
it_IT Italian
ja_JP Japanese
ko_KR Korean
ru_RU Russian
zh_CN Chinese (as spoken in China)
zh_TW Chinese (as spoken in Taiwan)
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
If set, all the data entered by the user is now in this language. The system does not
make any determination of whether the data entered by the user actually matches the
character set as defined by this language.
RESTRICTIONS
The value entered for this should be a valid value as defined by the Java standard.
It should also be one of the values defined in TC_language_data_entry, if this
preference is set.

TC_language_no_encoding_discrepancy_warning_message

DESCRIPTION
Prevents the display of the warning message regarding discrepancy between the
Teamcenter server encoding and the database encoding.
VALID
VALUES
True The warning message is never displayed.
False The warning message is always displayed.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
User preference.

6-154 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Mail gateway preferences

Folder_mail_properties

DESCRIPTION
Lists all properties of an object folder that can be sent via Teamcenter mail.
VALID
VALUES
One or more strings as values; each string must be a valid object folder property name.
DEFAULT
VALUES
object_name
owning_user
object_desc
DEFAULT
PROTECTION
SCOPE
User preference.

Mail_internal_mail_activated

DESCRIPTION
Specifies whether the Teamcenter internal mail functionality is available when using
the notify workflow handler.
VALID
VALUES
true the Teamcenter internal mail functionality is available.
false the Teamcenter internal mail functionality is not available.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site.

Mail_send_file_attachments_activated

DESCRIPTION
Activates sending dataset attachments as email file attachments.
This takes effect when the envelope functionality sends messages directly to an email
address instead of a Teamcenter user. When the mail is sent to a Teamcenter user, this
preference has no impact, and the user always receives links to the envelope object.
VALID
VALUES
true Activates sending dataset attachments as email file attachments. The recipient
can open the attached files without requiring a Teamcenter logon or privileges.
Consider site security guidelines before setting this preference to true.

PLM00026 11.2 Preferences and Environment Variables Reference 6-155

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

false Deactivates sending dataset attachments as email file attachments. External

recipients of emails receive only Teamcenter client links to the attached
datasets and not the actual files.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
System preference.

Mail_server_charset

DESCRIPTION
Specifies the Teamcenter mail server character set that is used to send mail.
DEFAULT
VALUES
ISO-8859-1
DEFAULT
PROTECTION
SCOPE
Site preference.

Mail_server_name

DESCRIPTION
Sets the name of the mail gateway server. The server should be a machine running a
sendmail daemon.
This preference must be set to send system e-mail. The placeholder default setting
may return errors if the send command is used.
VALID
VALUES
Text server name or an numeric IP address.
DEFAULT
VALUES
your mail server machine
DEFAULT
PROTECTION
SCOPE
Site preference.

Mail_server_port

DESCRIPTION
Specifies the port number called by the mail gateway server.
This preference must be used in conjunction with the Mail_server_name preference.
VALID
VALUES
Accepts a single string as a value. Must be a valid port number.

6-156 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
25
DEFAULT
PROTECTION
SCOPE
Site preference.

Mail_OSMail_activated

DESCRIPTION
Determines whether operating system e-mail can be set from Teamcenter. When
enabled, users can send OS e-mail by clicking Send to→Envelope.
VALID
VALUES
true OS e-mail can be sent from Teamcenter.
false OS e-mail cannot be sent from Teamcenter. Any value set for the
Mail_server_name preference is ignored.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_use_tc_alias_in_pa8

DESCRIPTION
Allows the use of e-mail addresses longer than 32 characters. If set to ON, the user's
e-mail attribute is assumed to be an address list. The name of this address list must
be less than 32 characters, but the e-mail addresses of list members may exceed
32 characters.
VALID
VALUES
ON Allows e-mail addresses of address list members to exceed 32 characters.
OFF Does not allow e-mail addresses to exceed 32 characters.
DEFAULT
VALUES
OFF
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-157

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

TC_mail_interval

DESCRIPTION
Determines how often Teamcenter checks for new system mail. This can also be set in
the rich client interface by choosing Edit→Options→Mail.
VALID
VALUES
A single positive integer.
DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
User preference.

NX Integration preferences

NX Integration preferences
Use the Teamcenter Integration for NX to create, store, and access your site's NX data within the
Teamcenter database. When NX is used in Teamcenter Integration for NX mode, Teamcenter runs
simultaneously as a separate process. The integration combines the power of NX in modeling and
generating data from geometric shapes, with the power of Teamcenter in storing and retrieving
data in a controlled fashion.
Before running the integration, you must configure customer defaults in NX, and Teamcenter
Integration for NX preferences in Teamcenter.
For more information about setting customer defaults, see the Teamcenter Integration for NX
documentation, in the NX Help.

Preferences set in the .tc_preferences.xml file

API_ugpart_attr_titles

DESCRIPTION
Lists NX attributes to synchronize with Teamcenter. This preference requires the
TC_NX_UPDATE_ATTRIBUTES preference to be set.
Note

This preference is enabled only when the newer method of NX/Teamcenter

attribute synchronization is disabled by setting the UGII _UGMGR_ATTR_SYNC
NX environment variable to OLD.

VALID
VALUES
One or more strings as values; each string must be a valid NX attribute name.

6-158 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
TITLE
CREATOR
PART_TYPE
PART_NO MODEL
MATERIAL
ASSEMB_NO
WEIGHT
TASK_NO
DEFAULT
PROTECTION
SCOPE
Site preference.

DATASET_saveas_allow_duplicates

DESCRIPTION
Affects the behavior of the Teamcenter Integration for NX SaveAs
Non-Master Part File dialog box as determined by the implementation of the
USER_copied_datasets_details user exit. This preference is only read by this user
exit.
For information, see the Integration Toolkit Function Reference.
Note

To access the Integration Toolkit Function Reference, install the Teamcenter

developer references when you install Teamcenter online help, or go to the
Global Technical Access Center (GTAC):
https://support.industrysoftware.automation.siemens.com/docs/teamcenter/

Determines whether duplicate dataset names are allowed for the same item revision.
VALID
VALUES
Yes Duplicate dataset names are allowed for the same item revision.
No Duplicate dataset names are not allowed for the same item revision.
DEFAULT
VALUES
No
DEFAULT
PROTECTION
SCOPE
Site preference.

DATASET_saveas_allow_name_modification

DESCRIPTION
Affects the behavior of the Teamcenter Integration for NX SaveAs
Non-Master Part File dialog box as determined by the implementation of the

PLM00026 11.2 Preferences and Environment Variables Reference 6-159

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

USER_copied_datasets_details and USER_copied_dataset_name user exits. This

preference is only read by these two user exits.

For information about these two user exits, see the Integration Toolkit Function
Reference.

Note

To access the Integration Toolkit Function Reference, install the Teamcenter

developer references when you install Teamcenter online help, or go to the
Global Technical Access Center (GTAC):
https://support.industrysoftware.automation.siemens.com/docs/teamcenter/

Specifies whether Teamcenter's recommendation for the dataset name must

be obeyed, or is a suggestion that can be edited by the user. This preferences
is ignored if the automatically generated name fails validation and the
DATASET_saveas_force_name_validation preference is set to true.
VALID
VALUES
true Allows Teamcenter Integration for NX users to modify automatically generated
names for new nonmaster datasets.

false Does not allow Teamcenter Integration for NX users to modify automatically
generated names for new nonmaster datasets.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

DATASET_saveas_always_copy

DESCRIPTION
Affects the behavior of the Teamcenter Integration for NX SaveAs
Non-Master Part File dialog box as determined by the implementation of the
USER_copied_datasets_details and USER_copied_dataset_name user exits. This
preference is only read by these two user exits.

For information about these two user exits, see the Integration Toolkit Function
Reference.

Note

To access the Integration Toolkit Function Reference, install the Teamcenter

developer references when you install Teamcenter online help, or go to the
Global Technical Access Center (GTAC):
https://support.industrysoftware.automation.siemens.com/docs/teamcenter/

6-160 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Specifies dataset types that must always be copied when the SaveAs command is
implemented against a master part in Teamcenter Integration for NX to create a new
revision.
VALID
VALUES
Valid Teamcenter dataset types.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

DATASET_saveas_force_name_validation

DESCRIPTION
Affects the behavior of the Teamcenter Integration for NX SaveAs
Non-Master Part File dialog box as determined by the implementation of the
USER_copied_datasets_details and USER_copied_dataset_name user exits. This
preference is only read by these two user exits.
For information about these two user exits, see the Integration Toolkit Function
Reference.
Note

To access the Integration Toolkit Function Reference, install the Teamcenter

developer references when you install Teamcenter online help, or go to the
Global Technical Access Center (GTAC):
https://support.industrysoftware.automation.siemens.com/docs/teamcenter/

Specifies whether, once a user has been allowed to modify an automatically generated
dataset name, it must be validated.
VALID
VALUES
true Requires nonmaster datasets created in Teamcenter Integration for NX to
pass the validation check.
false Does not require nonmaster datasets created in Teamcenter Integration for
NX to pass the validation check.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-161

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DATASET_saveas_never_copy

DESCRIPTION
Affects the behavior of the Teamcenter Integration for NX SaveAs
Non-Master Part File dialog box as determined by the implementation of the
USER_copied_datasets_details and USER_copied_dataset_name user exits. This
preference is only read by these two user exits.

For information about these two user exits, see the Integration Toolkit Function
Reference.

Note

To access the Integration Toolkit Function Reference, install the Teamcenter

developer references when you install Teamcenter online help, or go to the
Global Technical Access Center (GTAC):
https://support.industrysoftware.automation.siemens.com/docs/teamcenter/

Specifies dataset types that cannot be copied when the SaveAs command is
implemented against a master part in Teamcenter Integration for NX to create a new
revision.
VALID
VALUES
Valid Teamcenter dataset types.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

DATASET_saveas_owner

DESCRIPTION
Affects the behavior of the Teamcenter Integration for NX SaveAs
Non-Master Part File dialog box as determined by the implementation of the
USER_copied_datasets_details and USER_copied_dataset_name user exits. This
preference is only read by these two user exits.

For information about these two user exits, see the Integration Toolkit Function
Reference.

Note

To access the Integration Toolkit Function Reference, install the Teamcenter

developer references when you install Teamcenter online help, or go to the
Global Technical Access Center (GTAC):
https://support.industrysoftware.automation.siemens.com/docs/teamcenter/

6-162 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Specifies whether the owner of the new nonmaster part being created using the
SaveAs command in Teamcenter Integration for NX should be the user performing the
command, or the owner of the nonmaster part being copied.
VALID
VALUES
Original The owner of the nonmaster part being copied is the owner of
the new nonmaster part being created.
SavingUser The owner of the nonmaster part being copied is the user
performing the SaveAs command.
DEFAULT
VALUES
SavingUser
DEFAULT
PROTECTION
SCOPE
Site preference.

DATASET_saveas_pattern

DESCRIPTION
Affects the behavior of the Teamcenter SaveAs dialog box as determined
by the implementation of the USER_copied_datasets_details and
USER_copied_dataset_name user exits.
Note

Also affects the behavior of the Teamcenter Integration for NX SaveAs

Non-Master Part File dialog box in the same manner.

This preference is only read by these two user exits. For information about these two
user exits, see the Integration Toolkit Function Reference.
Note

To access the Integration Toolkit Function Reference, install the Teamcenter

developer references when you install Teamcenter online help, or go to the
Global Technical Access Center (GTAC):
https://support.industrysoftware.automation.siemens.com/docs/teamcenter/

Specifies a pattern used to generate and return the output name of nonmaster items
during SaveAs of their master item. The pattern consists of literal text and the following
tokens: ${UserText}, ${ItemID} and ${RevisionID}. Existing dataset names are
expected to match this pattern, where ${ItemID} and ${RevisionID} match the item ID
and revision ID of the owning item revision respectively, and ${UserText} matches any
text in the original name. For example, a typical pattern is:
${UserText}-${ItemID}/${RevisionID}

where the site has decided that the ${UserText} at the beginning is intended to
be the name of the dataset, for example: drawing, and the minus sign (-) is literal
text. If you are saving item revision 001234/B to item revision 002345/A, and the

PLM00026 11.2 Preferences and Environment Variables Reference 6-163

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

dataset's existing name is drawing-001234/B then the name is said to'match against
the pattern. Because the ${UserText} at the start of this pattern matches any string,
the dataset name fea-001234/B would also match against the pattern. However,
drawing_001234/B would not match the pattern as the minus sign is required, and
drawing-001235/B would not match since the item ID is incorrect.
Once an original dataset name has been matched against the pattern, the new dataset
name is generated by replacing the ${ItemID} and ${RevisionID} with the new
revision and item ID in the pattern, and all occurrences of ${UserData} with whatever
text they matched against in the original name. This new name can then be used for
saving the new dataset. Using the example above, the two datasets are saved as
drawing-002345/A and fea-002345/A.
You can modify these generated names using the
DATASET_saveas_allow_name_modification preference. However, if the
DATASET_saveas_force_name_validation preferences is set to true, the
user-edited name is still required to match the pattern.
VALID
VALUES
${UserText} Dataset names are copied forward to the new revision
unchanged.
DEFAULT
VALUES
${UserText}
DEFAULT
PROTECTION
SCOPE
Site preference.

<DATASET TYPE>_saveas_pattern

DESCRIPTION
Performs the same behavior as the DATASET_saveas_pattern preference, but for
a specific dataset type. Use this preference to define different Save As patterns for
different nonmaster datasets.
For example, assign the naming pattern drawing-001234/B to the UGPART dataset,
and the naming pattern drawing-001234 to the UGALTREP dataset by creating the
following two preferences:
UGPART_saveas_pattern=
${UserText}-${ItemID}/${RevisionID}

UGALTREP_saveas_pattern=
${UserText}-${ItemID}
VALID
VALUES
${UserText} Dataset names are copied forward to the new revision
unchanged.
DEFAULT
VALUES
None.

6-164 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

NX_InterOptWithProductViewDataset

DESCRIPTION
Determines whether product view datasets associated with item revisions and BOM
views are sent to Teamcenter Integration for NX along with the item revisions and
BOM views.
VALID
VALUES
TRUE Product view datasets associated with item revisions and BOM views are
sent to Teamcenter Integration for NX along with the item revisions and
BOM views.
FALSE Product view datasets associated with item revisions and BOM views are
not sent to Teamcenter Integration for NX along with the item revisions and
BOM views.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

NX_Supports_VISSC

DESCRIPTION
Activates NX support of configuration using the VisStructureContext object during a
Send to NX operation.
VALID
VALUES
true Activates NX support.
false Deactivates NX support. The value must be set to false if using a version
prior to NX 8.5.1.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

TC_default_part_type

DESCRIPTION
Determines the default part type created.

PLM00026 11.2 Preferences and Environment Variables Reference 6-165

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter type.
DEFAULT
VALUES
Item
DEFAULT
PROTECTION
SCOPE
User preference.

TC_NX_allow_attrsync_master_with_item

DESCRIPTION
Use with attribute synchronization functionality. Determines whether Teamcenter
allows synchronization of UGMASTER attributes mapped to item-level properties from
Teamcenter Integration for NX to Teamcenter.
By default, attributes mapped to the properties of the Item Master form attached to
item objects (not item revisions) will synchronize from Teamcenter to Teamcenter
Integration for NX; but not in the reverse direction. These attributes are read-only in
Teamcenter Integration for NX after the first execution of the NX Save command from
the Teamcenter Integration for NX application.
Permitting mapping in the reverse direction (Teamcenter Integration for NX to
Teamcenter) allows mapping attributes to the properties of the Item Master form stored
at the item level. This must not be done. Mapping at the item level may result in loss of
data and/or the appearance of incorrect data.
VALID
VALUES
YES Attributes mapped to the properties of the Item Master form will synchronize
bidirectionally between Teamcenter Integration for NX and Teamcenter.
Caution

This mapping allows multiple item revision objects (Rev/A, Rev/B,

Rev/C, and so on) to overwrite the values stored on the Item Master
form at the item level. Mappings at the item level may result in loss of
data and/or the appearance of incorrect data.

NO Attributes mapped to the properties of the Item Master form will synchronize
only from Teamcenter to Teamcenter Integration for NX.
DEFAULT
VALUES
NO
DEFAULT
PROTECTION
SCOPE
Site preference.

6-166 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

TC_NX_Allow_Deepcopy

DESCRIPTION
Determines whether deep copy functionality is supported with Teamcenter Integration
for NX.
VALID
VALUES
true Deep copy functionality is supported with Teamcenter Integration for NX.

false Deep copy functionality is not supported with Teamcenter Integration for NX.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_NX_ATTRIBUTES_FORM

DESCRIPTION
Specifies the form type used to display the UGPART and UGMASTER attributes.
Note

By default, the access of ImanFile, UGPartAttr, and

UGPartBoundingBoxForm object types are delegated to the parent dataset.
You can use the TC_object_type_delegation to override the delegation
behavior.

VALID
VALUES
A single string as a value; the string must be a valid Teamcenter form type.
DEFAULT
VALUES
UGPartAttr
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_NX_Database_Attributes_For_Load

DESCRIPTION
Specifies the set of customer-defined, non-standard database attributes that are
retrieved for each item type/dataset type whenever a part is loaded.
All database attributes are retrieved for the top-level assembly. This preference
controls the non-standard attributes that are retrieved for the child components of
the top-level assembly and can be used for NX parts, transient parts, and JT parts.
These non-standard attributes are defined using the attribute mapping definitions in

PLM00026 11.2 Preferences and Environment Variables Reference 6-167

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Teamcenter and are refreshed on demand in NX depending on the operation that

requests them. However, this may not necessarily occur when loading a part.
The refreshing of attributes does not impact performance at low latencies, but does
impact performance at higher latencies. If you are working with a latency greater
than 10 milliseconds, it is recommended that you utilize this preference to refresh the
database attributes whenever a part is loaded.
Note

To get an idea of the attributes that are being queried during load operations,
load a sample assembly and check the NX syslog for messages about inefficient
attributes loading.

Note

The following standard database attributes are always loaded for all contexts
and do not have to be specified by this preference:
• DB_PART_NAME

• DB_PART_DESC

• DB_PART_NO

• DB_PART_REV

• DB_PART_TYPE

• DB_UNITS

VALID
VALUES
The value format is three keywords and their values. The keywords are:
ItemType

DatasetType

AttributeTitle

The format informs NX which database attribute to load for a specific context
(ItemType/DatasetType). Values are enclosed in quotation marks. An empty string
(“”) can be applied to either or both of ItemType and DatasetType.
For example:
TC_NX_Database_Attributes_For_Load=
ItemType=”NXPart” DatasetType="UGMASTER" AttributeTitle=”Attribute1”

6-168 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Note

• The wild card designation, "*", can be specified as the value of

AttributeTitle to indicate that all database attributes for that context are
loaded when opening a part in NX.

• A context without any entries in TC_NX_Database_Attributes_For_Load

loads standard database attributes only.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

TC_NX_DeleteMarkupsOnDrawingSheetImport

DESCRIPTION
Deletes the CGM datasets created in Teamcenter for which there are no sheets in NX.
In NX, choose File→Export→Drawings to Teamcenter to open a dialog box that
lists the names of the existing sheets. Select the names of the sheets for which you
want to create (or retain) the CGM datasets and select Delete existing sheets from
Teamcenter.
VALID
VALUES
TRUE
FALSE
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_NX_DrawingSheet_Deletion_Pattern

DESCRIPTION
Contain values for sheet naming patterns. For example, if you want sheet names
called Sheet1, Sheet2, Sheet3, and so on, set this preference to Sheet.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-169

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

TC_NX_Foreign_Datasets

DESCRIPTION
Specifies the non-NX dataset types available to NX when it lists the datasets in an
item revision.
Note

Specifying dataset types in this preference only makes the dataset types
available to NX, it does not enable the application to read the dataset type.

VALID
VALUES
The value format is four values with each value separated by a semicolon. The actual
values are based on these keywords:
DatasetType;NamedReference;NamedReferenceFormat;NamedReferenceTemplate
DatasetType is the extension for files of that type.
NamedReference is the extension for files of that type.
NamedReferenceFormat is the extension for files of that type. Valid values are
BINARY or TEXT.
NamedReferenceTemplate is the extension for files of that type.
For example:
DirectModel;JTPART;BINARY;jt

For example:
SE PART;SE-Part;BINARY;par

Note

The values are case sensitive and all of the entry must be included on one line
for each dataset type.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

TC_NX_Reference_OccTypes

DESCRIPTION
Specifies the occurrence type names that need to be treated as reference geometry
by NX.
VALID
VALUES
Any occurrence type name that needs to be treated as reference geometry.

6-170 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_ugmaster_name_separator

DESCRIPTION
Specifies the separator character used when generating dataset IDs from the parent
item ID and revision for UGMASTER datasets created through the NX Integration or
NX. For example, if the value is set to a slash (/), the parent item ID is NX001, and the
parent revision is A; the dataset ID is generated as NX001/A.
This preference is not added automatically during installation.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_NX_Navigator_Override_NX_Load_Option

DESCRIPTION
Determines which configuration to load when an assembly is opened in Teamcenter
Integration for NX from rich client. Its defined values are referenced only when an
assembly is opened from My Teamcenter; assemblies opened from Structure Manager
obey the revision rules set in Structure Manager.
VALID
VALUES
As Saved Loads the part file as it was saved in Teamcenter Integration
for NX.
Latest Loads the part file with the latest revision rule.
None Ignores the As Saved command and loads the assembly as
defined in the load_options.def file.
DEFAULT
VALUES
Latest
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-171

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

TC_NX_NEW_COPY_REV

DESCRIPTION
Determines the algorithm of the Save As New Revision functionality within
Teamcenter Integration for NX.
VALID
VALUES
YES Improves the performance of the Save As New Revision functionality within
Teamcenter Integration for NX. The performance improvement is most
noticeable in a WAN environment.
NO Performs the Save As New Revision functionality within Teamcenter
Integration for NX using the same method as previous releases.
DEFAULT
VALUES
NO
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_NX_NEW_NR_FORMS

DESCRIPTION
Determines whether the storage of mass properties and part attributes for
use in new assembly update structure algorithms is used. If set to OFF, the
UGII_NEW_UPDATE_STRUCTURE NX environment variable should also be set to
OFF to ensure that update structure continues to work properly.
VALID
VALUES
ON Allows storage of mass properties and part attributes for use in new assembly
update structure algorithms.
OFF Prevents storage of mass properties and part attributes for use in new
assembly update structure algorithms.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_NX_nonmaster_additional_forms

DESCRIPTION
Lists the named references forms to include when creating or updating specific NX
nonmaster dataset types (UGPART, UGALTREP, or UGSCENARIO). Format for the
values is NX-Dataset-type-name:NamedRef-Name. For example:
UGPART:UGPART-BBOX

6-172 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

This preference affects the behavior of NX 18.0 and later versions only and is irrelevant
to the earlier versions. Also, the named reference forms considered have nothing to
do with the regular NX Integration attributes synchronization.
VALID
VALUES
UGALTREP:UGPART-BBOX
UGALTREP:UGPART-MASSPR
UGALTREP:UGPART-ATTRIBUTES
DEFAULT
VALUES
UGALTREP:UGPART-BBOX
UGALTREP:UGPART-MASSPR
UGALTREP:UGPART-ATTRIBUTES
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_NX_save_precise_on_uprev

DESCRIPTION
Determines whether a new assembly, created in Teamcenter Integration for NX using
the Save As command, is created as precise or imprecise. For example, when the
Save As command is invoked upon a precise assembly with a revision rule of Latest
Working, the new assembly is precise or imprecise, depending on the setting of
this preference.
VALID
VALUES
yes Creates a precise assembly.

no Creates an imprecise assembly.

DEFAULT
VALUES
yes
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_NX_Unit_Of_Measure_As_Geometric_List

DESCRIPTION
Allows you to specify a list of units of measure at your site that creates components
as geometric in NX. The wildcard character (*) can be used to designate all units
of measure at your site.
VALID
VALUES
All predefined units of measure in the database.

PLM00026 11.2 Preferences and Environment Variables Reference 6-173

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_NX_Unit_Of_Measure_Each_List

DESCRIPTION
Allows you to specify a list of units of measure at your site that you want to be treated
the same as each, ea, or “” when determining whether a component is geometric.
All components with these units of measure have their quantities rounded to a whole
number in NX.
VALID
VALUES
All predefined units of measure in the database.
DEFAULT
VALUES
None. The values each and ea are hard-coded and do not have to be included
in the preference.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_NX_UPDATE_ATTRIBUTES

DESCRIPTION
Determines whether NX attributes are synchronized with Teamcenter attributes. If
this preference is set, define the attributes by setting the API_ugpart_attr_titles
preference.
Note

This preference is enabled only when the newer method of NX/Teamcenter

attribute synchronization is disabled by setting the UGII_UGMGR_ATTR_SYNC
NX environment variable to OLD.

VALID
VALUES
yes Synchronizes NX attributes with Teamcenter attributes.
no Does not synchronize NX attributes with Teamcenter attributes.
DEFAULT
VALUES
TITLE
CREATOR
PART_TYPE
PART_NO MODEL
MATERIAL

6-174 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

ASSEMB_NO
WEIGHT
TASK_NO
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_NX_View_Type

DESCRIPTION
Sets the BOM view type that Teamcenter Integration for NX uses to read and write
product structure information.
For more information about multiple BOM views, see Structure Manager.
VALID
VALUES
A single string as a value; the string must be a valid Teamcenter BOM view type.
DEFAULT
VALUES
view
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_SPSD_FOLDER

DESCRIPTION
Defines the folder name where released item revisions containing Simulation Process
Studio datasets are stored. After this preference is defined, users can create
Simulation Process Studio processes in any folder in the Teamcenter database. To
see these processes in the Teamcenter Integration for NX palette, export the item
revisions containing Simulation Process Studio datasets to the folder specified by
this preference.
Consumers use this folder to access process templates from Teamcenter Integration
for NX.
During database installation or upgrade, a folder is created with the name specified
by this preference, if the folder does not already exist.
VALID
VALUES
Accepts a single string as a value. Must be a valid Teamcenter folder name.
DEFAULT
VALUES
Simulation Process Studio
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-175

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

TC_SPSD_FOLDER_PATH

DESCRIPTION
Defines multiple folders in the Teamcenter database where authors can create
processes for testing and verification. All processes can be accessed via Teamcenter
Integration for NX, allowing authors to test, validate, and finalize the processes.
VALID
VALUES
Accepts multiple strings as values; each string must be a valid Teamcenter folder name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_USE_TEST_ATTR_MAPPINGS

DESCRIPTION
Determines whether Teamcenter references the test attribute mappings rather
than the real mappings. Set the TC_USE_TEST_ATTR_MAPPINGS preference
or environment variable to any value. This causes Teamcenter to access the test
mappings rather than the real mappings.
Note

Remove TC_USE_TEST_ATTR_MAPPINGS from the Teamcenter environment

when test attribute mappings should not be used.

VALID
VALUES
Any value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Preferences set in the .tc_ugman_env file

UGMAN_InsertItem

DESCRIPTION
Specifies a default object type and paste location when no folder is selected when
creating a new object using the Create Part (Item) dialog box.
VALID
VALUES
1 Inserts datasets into the Newstuff folder.

6-176 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

2 Inserts an item into the Newstuff folder.

3 Inserts an item revision into the Newstuff folder.
DEFAULT
VALUES
2

UGMAN_PartType

DESCRIPTION
Determines the default type of the dataset created using the Create Part (Item) dialog
box. This preference is overridden by setting the UGMAN_ShowPartType preference
to 1.
VALID
VALUES
UGMASTER
UGPART
DEFAULT
VALUES
UGMASTER

UGMAN_ShowPartType

DESCRIPTION
Determines whether the option to select a dataset type is displayed in the Create Part
(Item) dialog box. When set to 1, this preference overrides by the UGMAN_PartType
preference.
VALID
VALUES
0 Does not display an option allowing the user to select a dataset type. In this
case, the UGMAN_PartType preference settings are used.
1 Displays an option allowing the user to select a dataset type. When this
setting is used, the dataset type chosen by the user overrides any dataset
type defined in the UGMAN_PartType preference.
DEFAULT
VALUES
0

UGMAN_UGPARTNameWRev

DESCRIPTION
Specifies the naming convention of new UGMASTER and UGPART datasets created
in the Create Part (Item) dialog box. The naming convention determines whether the
new name contains a revision. The dataset name is not defined by the user in this
dialog box, rather the dataset name is generated automatically based on the settings
of this preference.
VALID
VALUES
0 Creates new UGMASTER and UGPART datasets names without a revision.

PLM00026 11.2 Preferences and Environment Variables Reference 6-177

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

1 Creates new UGMASTER and UGPART datasets names with a revision.

DEFAULT
VALUES
1

Preferences set in the ug_english.def file

UGhookupStructureUpdateOnSave

DESCRIPTION
Determines whether Teamcenter BOM view revisions are updated to
reflect changes made to NX assemblies. This preference is similar to the
UGhookupStructureUpdateOnLoad preference, which updates NX assemblies
when Teamcenter BOM view revisions are changed.
VALID
VALUES
ON Updates BOM view revisions.
OFF Does not update BOM view revisions.
DEFAULT
VALUES
ON

UGhookupStructureUpdateOnLoad

DESCRIPTION
Determines whether NX assemblies are updated to reflect changes made
toTeamcenter BOM view revisions. The update occurs when the NX assembly
is loaded. This preference is similar to the UGhookupStructureUpdateOnSave
preference, which updates Teamcenter BOM view revisions when NX assemblies
are changed.
VALID
VALUES
ON Updates NX assemblies.
OFF Does not update NX assemblies.
DEFAULT
VALUES
ON

UGhookupPartDisplayPreference

DESCRIPTION
Determines the configuration of the Part Selection dialog box.
VALID
VALUES
One or more strings as values; each string must be a valid NX attribute.
DEFAULT
VALUES
None. If this preference is not set, NumberName is assumed.

6-178 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Preferences set in the .ugii_env file

TRACE_BACK

DESCRIPTION
Enables or suppresses NX traceback log files.
VALID
VALUES
ON Enables NX traceback log files.
OFF Suppresses NX traceback log files.
DEFAULT
VALUES
ON. If not set, ON is assumed.
DEFAULT
PROTECTION
SCOPE
Site preference.

UGII_KEEP_SYSTEM_LOG

DESCRIPTION
Determines whether to retain system log files when they contain no errors.
VALID
VALUES
Any value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

UGII_OPTION

DESCRIPTION
Determines how to interpret and convert file specifications. This preference can
drastically affect Teamcenter File Services behavior. For example, if you create
Teamcenter volumes with mixed-case names and this preference is set to LOWER,
Teamcenter File Services is not able to find your volumes. Therefore, ensure that this
preference is set consistent with file specification naming conventions at your site.
VALID
VALUES
NONE File specifications are interpreted without converting case.
LOWER Converts the entire file specification (directory and file name)
to all lowercase.
UPPER Converts the entire file specification (directory and file name)
to all uppercase.

PLM00026 11.2 Preferences and Environment Variables Reference 6-179

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

HINAME Converts the file name to all uppercase but leaves the directory
path name unchanged.
LONAME Converts the file name to all lowercase but leaves the directory
path name unchanged.
DEFAULT
VALUES
LOWER
DEFAULT
PROTECTION
SCOPE
Site preference.

UGII_TMP_DIR

DESCRIPTION
Specifies the temporary directory for storing application log files.
VALID
VALUES
Single string as value; each string must be the full operating system path of the
directory.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Password preferences

About password preferences

Password site preferences are used to specify restrictions on password format. Whenever a
password is set or modified, the system checks these preferences and validates the new password
value against the preference settings.
Use password site preferences to enforce the following password requirements:
• Minimum length

• Mixed case

• Minimum number of numeric characters

• Minimum number of alpha characters

• Nonalphanumeric characters allowed as special characters

• Minimum number of special characters

6-180 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

PASSWORD_minimum_characters

DESCRIPTION
Defines the minimum length required for a new password.
VALID
VALUES
A positive integer whose value does not exceed the maximum storage space allocated
to a password in the database. A value of 0 means no minimum is required.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

PASSWORD_special_characters

DESCRIPTION
Defines which nonalphanumeric characters are valid in a password.
VALID
VALUES
One or more characters entered as a string value. When left unset, any special
characters are allowed. A null string allows no special characters.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
EXAMPLE
Enter the following twelve characters, as a single string, to be allowed in passwords:
~!@#$%^&*()_
Note

You must list the all the special characters you want to allow.
• You cannot leave the valid value blank or set it to True or All.

• You must set this preference to use the

PASSWORD_minimum_special_chars preference.

PASSWORD_mixed_case_required

DESCRIPTION
Determines if mixed case is required in a password.
VALID
VALUES
true Mixed case is required in a password.

PLM00026 11.2 Preferences and Environment Variables Reference 6-181

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

false Mixed case is not required in a password.

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PASSWORD_minimum_special_chars

DESCRIPTION
Determines the minimum number of special characters (defined in the
PASSWORD_special_characters preference) required in a password.
VALID
VALUES
A positive integer whose value, combined with other minimum password length values,
does not exceed the maximum storage space allocated to a password in the database.
A value of 0 means no minimum is required.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

PASSWORD_minimum_digits

DESCRIPTION
Determines the minimum number of digits required in a password.
VALID
VALUES
A positive integer whose value, combined with other minimum password length values,
does not exceed the maximum storage space allocated to a password in the database.
A value of 0 means no minimum is required.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

PASSWORD_minimum_alpha

DESCRIPTION
Determines the minimum number of alphabetic characters required in a password.

6-182 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
A positive integer whose value, combined with other minimum password length values,
does not exceed the maximum storage space allocated to a password in the database.
A value of 0 means no minimum is required.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

Product structure preferences

BOM_enable_mem_mgt_probability_percent

DESCRIPTION
Teamcenter can determine whether a product structure should be fully or partially
expanded, depending on the quantity of server memory used. This preference
specifies a percentage of free server memory, which (if exceeded) causes Teamcenter
to limit structure expansion to conserve memory. It is effective for structure expansions
initiated by the bomwriter and plmxml_export utilities, but not for expansions initiated
in Structure Manager.
VALID
VALUES
Accepts a single integer in the range 0 to 100 as its value. If set to 0, there no limit
on the use of available system memory for expansion.
The following examples show the effect of different settings:
• Example 1:
Total system memory – 4 GB
Total available system memory – 2.5 GB
BOM_enable_mem_mgt_probability_percent= 50
Total system memory used for BOM expansion = 1.25 GB approximately

• Example 2:
Total system memory – 4 GB
Total available system memory – 2.5 GB
BOM_enable_mem_mgt_probability_percent= 25
Total system memory used for BOM expansion = 0.625 GB (625 MB)
approximately

Note

The formula it utilizes to calculate the total system memory used is:
(BOM_enable_mem_mgt_probability_percent X Available System Memory) ÷ 100

PLM00026 11.2 Preferences and Environment Variables Reference 6-183

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
VALUES
70
DEFAULT
PROTECTION
SCOPE
User preference.

BOM_line_contains_IC_Absoc

DESCRIPTION
Specifies if structure lines have additional data such as incremental change
information or absolute occurrence information. Use this preference with the
BOM_enable_mem_mgt_probability_percent preference for better memory
management of structure expansions initiated by the bomwriter and plmxml_export
utilities. It does not affect expansions initiated in Structure Manager.
VALID
VALUES
true Lines in the structure have incremental change information, absolute
occurrence information, or both.
false Lines in the structure do not have incremental change information or absolute
occurrence information.
DEFAULT
VALUE
false
DEFAULT
PROTECTION
SCOPE
User preference.

Fnd0ItemLineLite_bl_line_name_expression

DESCRIPTION
Defines the property expression used for evaluation of the line name for objects of the
Fnd0ItemLineLite business object type.
For more information, see Business Modeler IDE.
VALID
VALUES
The valid value is a string that contains property internal names (always preceded with
the $ character), the character + to signal concatenation, and strings surrounded by
double quotation marks.
DEFAULT
VALUE
$bl_item_item_id+"/"+$bl_rev_item_revision_id+";
"+$bl_rev_sequence_id+"-"+$bl_rev_object_name
DEFAULT
PROTECTION
SCOPE
Site preference.

6-184 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Search and query preferences

Change_Search_Default

DESCRIPTION
Determines which saved query displays in the search panel by default.
VALID
VALUES
Accepts a single string as a value. Must be a valid saved query.
DEFAULT
VALUES
Item ID
DEFAULT
PROTECTION
SCOPE
User preference.

Default_Business_Object_To_Search

DESCRIPTION
Specifies a default business object type to search when the business object Simple
Search view is opened.
VALID
VALUES
The single string internal name of a WorkspaceObject business object type.
DEFAULT
VALUES
Item
DEFAULT
PROTECTION
SCOPE
Site and user preference.
NOTES
Set this preference by changing the Default Business Object Type value in the
Simple Search view preference dialog box.

Default_Quick_Access_Query

DESCRIPTION
Defines the default quick search internal name.
VALID
VALUES
Any valid internal search name.
DEFAULT
VALUES
Item ID
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-185

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Favorite_Business_Objects_To_Search

DESCRIPTION
Specifies a list of business object types users search frequently, for quick access
when the Simple Search view is opened.
VALID
VALUES
Valid values are the internal names of WorkspaceObject business object types.
Accepts one or more strings values.
DEFAULT
VALUES
Item
ItemRevision
Dataset
WorkspaceObject
DEFAULT
PROTECTION
SCOPE
Site and user preference.
NOTES
Set values for this preference for the Simple Search view in the Preferences
(Filtered) dialog box Favorite Business Objects pane.

PortalDesignContextSearchEnginePreference

DESCRIPTION
Specifies the search engine referenced by DesignContext.
VALID
VALUES
CachelessSearchEngineFactory
Note

The value must match one of the keywords defined in the

\com.teamcenter.rac.tcapps\com\teamcenter\rac\designcontext\
designcontext.properties file. If the value set for this preference is not found in
the designcontext.properties file, the default value for this preference is used.

DEFAULT
VALUES
CachelessSearchEngineFactory
DEFAULT
PROTECTION
SCOPE
All.

MSS_set_display_limit

DESCRIPTION
Specifies the number of saved searches shared by others displayed in the My Saved
Searches in the navigation pane.

6-186 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
Zero and any positive integer.
DEFAULT
VALUES
25
DEFAULT
PROTECTION
SCOPE
Site preference.

MySearchHistory_Limit

DESCRIPTION
Determines the number of searches maintained in the search history. When the limit is
reached, the oldest search is deleted.
VALID
VALUES
Accepts a single string as a value. Must be a positive integer.
DEFAULT
VALUES
8
DEFAULT
PROTECTION
SCOPE
User preference.

QRYColumnsShownPref

DESCRIPTION
Determines the queries available for selection from the Find menu in both the rich
client and the thin client.
VALID
VALUES
Valid Teamcenter query classes.
DEFAULT
VALUES
General...
Item...
Item Revision...
Remote...
Checked-Out Dataset...
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-187

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

QRY_dataset_display_option

DESCRIPTION
Determines whether the latest version or all versions of a dataset object are displayed
when query results are returned.
VALID
VALUES
1 Displays all versions of a dataset object.
2 Displays the latest version of a dataset object.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

QRY_exception_list

DESCRIPTION
Specifies the list of queries to be excluded from using join approach on relations and
references.
VALID
VALUES
All saved query names defined in the database (for example, Item ID).
Note

Values are case sensitive and must be the internal name.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

QRY_<query_name>_SortKeys

DESCRIPTION
Determines the class attributes used to sort the query results. This preference must
be used in conjunction with the QRY_query_name_SortOrder preference, which
determines sort order.
VALID
VALUES
The value type of the class attribute must be a primitive value type. For example,
char, int, double or date. If a query name contains one of the following characters,
this character needs to be replaced with the underscore (_) character:
• space character

6-188 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

• return character (\n)

• tab character (\t)

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

QRY_<query_name>_SortOrders

DESCRIPTION
Determines the sort order of query results. This preference must be used in
conjunction with the QRY_query_name_SortKeys preference, which determines the
class attributes used to sort query results.
VALID
VALUES
1 Sorts query results in ascending order.

2 Sorts query results in descending order.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

QRY_search_classification_hierarchy

DESCRIPTION
Specifies whether saved and ad hoc classification queries performed with the My
Teamcenter search feature searches across the classification hierarchy or only the
given class.
VALID
VALUES
true Saved query and ad hoc classification queries search on the given class as
well as on all the classes to which the given class is an ancestor.

false Saved query and ad hoc classification queries search only on the given class.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-189

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

QRY_search_type_hierarchy

DESCRIPTION
Determines whether subtypes are included in query results. The system uses type
hierarchy functionality to query types and subtypes.

Administrators can add this preference in the Options dialog box which can be
accessed from the Edit menu, or in the tc_preferences.xml preferences file. Users
can set this preference to true from the interface:

• In the rich client, click Edit→Options to display the Options dialog box. Select
Search folder from the tree on the left. Select the Query Options tab. Then
check the Enable Hierarchical Type Search check box. Checking this check box
automatically adds this preference to the database, and sets it to true.

• In the thin client, select the Options link from the Settings menu in the Navigation
bar to display the Options dialog box. Click the Search tab. Click Type hierarchy
on search, then select Yes from the list. Checking this check box automatically
adds this preference to the database, and sets it to true.

VALID
VALUES
true Subtypes are included in query results.

false Subtypes are not included in query results.

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

Quick_Access_Queries

DESCRIPTION
Specifies the quick access queries displayed for the search field in the navigation pane.
VALID
VALUES
Internal names of queries defined in the qry_txt_locale.xml file.
DEFAULT
VALUES
Item ID
Keyword Search
Item Name
Dataset Name
DEFAULT
PROTECTION
SCOPE
Site preference.

6-190 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Quick_Access_Queries_Attribute

DESCRIPTION
Defines criteria attributes for quick access queries.
VALID
VALUES
Criteria formatted as follows:
query_internal_name_SearchAttribute=L10N_key
Where:
• query_internal_name is replaced by the internal query name.

• L10N_key is replaced by the query clause user-entry localization key.

DEFAULT
VALUES
Item ID_SearchAttribute=ItemID
Keyword Search_SearchAttribute=Keyword
Item Name_SearchAttribute=ItemName
Dataset Name_SearchAttribute=DatasetName
DEFAULT
PROTECTION
SCOPE
Site preference.

QuickSearchesQueries

DESCRIPTION
For Teamcenter Rapid Start, stores Quick Search query names on the navigator panel.
This site preference is shared between the rich client and the thin client. The format
for this preference value is the key of the actual search name defined in the text
server query .xml files.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
k_find_itemid_name
k_find_itemname_name
k_find_datasetname_name
k_find_fts_name

DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-191

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

search_automatic_wildcard

DESCRIPTION
To enhance local metadata searches, automatically adds the asterisk (*) character
as a prefix, suffix, or both for search criteria for all string attributes. This feature is
available in all Teamcenter clients.
VALID
VALUES
0 Search criteria are not altered.
1 The asterisk (*) character is added as a suffix.
2 The asterisk (*) character is added as a prefix.
3 The asterisk (*) character is added as both a suffix and a prefix.
Note

All other values have the same effect as adding 0.

DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

Searchable_Business_Objects

DESCRIPTION
Acts as a filter to display a shortened list of business object types and their child types.
VALID
VALUES
Valid values are the internal names of WorkspaceObject business object types.
Accepts multiple strings values.
DEFAULT
VALUE
WorkspaceObject
When the Searchable_Business_Objects preference is not set, the
WorkspaceObject type and all of its child types are displayed.
DEFAULT
PROTECTION
SCOPE
All.
NOTES
This preference is set interactively in Teamcenter in the Edit→Options dialog box,
using the Index pane. An administrator can set this preference at the site level, a
group administrator can set this preference at the group or role level, and users can
set this preference at the user level.

6-192 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

SEARCH_RESULT_LOAD_ALL_LIMIT

DESCRIPTION
Specifies how many search results can be loaded at one time into one page in the
search results view.
VALID
VALUES
Any integer greater than zero
DEFAULT
VALUES
400
DEFAULT
PROTECTION
SCOPE
User preference.

TC_ignore_case_on_search

DESCRIPTION
Determines if object searches are case sensitive.
VALID
VALUES
0 Object searches are case sensitive.
1 Mapped attribute searches and saved query searches are case
insensitive when using an appearance set-based search engine (see
PortalDesignContextSearchEnginePreference).
Work part, engineering change, and workflow process searches are case
insensitive when using the Context Definition pane in DesignContext.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
User preference.

TC_language_search

DESCRIPTION
Specifies the locale used in doing search operations. The search criteria specified by
the user is assumed to be in this locale. If the value is not set, the search locale
defaults to the client locale.
Caution

If localization for Classification is enabled, selecting the search language in

the attribute dictionary in the Classification Admin application changes the
value of the TC_language_search preference interactively for all Teamcenter
applications.

PLM00026 11.2 Preferences and Environment Variables Reference 6-193

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
Accepts codes representing languages, including the following codes that are
delivered with Teamcenter:

cs_CZ
Czech

de_DE
German

en_US
English

es_ES
Spanish

fr_FR
French

it_IT
Italian

ja_JP
Japanese

ko_KR
Korean

ru_RU
Russian

zh_CN
Chinese (as spoken in China)

zh_TW
Chinese (as spoken in Taiwan)

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

Warning

Do not change the scope of this preference. The system selectively applies this
preference for a variety of applications, and changing the scope could have
unintended and undesirable consequences.

6-194 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

TC_QRY_display_latest_dataset_only

DESCRIPTION
Enables the display of only the latest version of dataset objects in results of queries
with search class as the super class of dataset or its descendant classes (for example,
queries with search class as WorkspaceObject).
VALID
VALUES
0 Displays all versions of the dataset.
1 Displays only the latest version of dataset objects.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

QRY_<query_name>_REVRULE

DESCRIPTION
Specifies the revision rule applied to search results for searches against the
ItemRevsion class and its subclasses.
In Query Builder, administrator users can associate a revision rule to any ItemRevision
saved query. In the rich client in My Teamcenter, users can execute a saved query
with an associated revision rule and see only results that match both the search
criteria and the revision rule.
The site-level preference is initially set and displayed in Query Builder. This preference
can be changed, and the user-level and group-level preferences can be set through
the Options dialog box displayed by the Edit→Options menu command. The
group-level or user-level preferences, if defined, take precedence.
VALID
VALUES
Any valid revision rule name defined in Structure Manager.
DEFAULT
VALUES
Null.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_QRY_search_by_rev_rule

DESCRIPTION
Specifies the revision rule used for the latest item revision query.
VALID
VALUES
All revision rules defined in the database (for example, Latest Working).

PLM00026 11.2 Preferences and Environment Variables Reference 6-195

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Note

Values are case sensitive.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_QRY_search_result_display_mode

DESCRIPTION
Determines the display of search results returned for queries performed using the
Search view.
VALID
VALUES
1 The total number of found objects is not displayed.

2 The total number of found objects only accounts for objects for which the
user has access privileges.
DEFAULT
VALUES
1
Note

Must be set to 1 in order for the Item Revision search to show the search results
even if there are Schedule revision objects on which the user does not have
access.

DEFAULT
PROTECTION
SCOPE
Site preference.

Open_previous_open_search

DESCRIPTION
Specifies whether the previous search result is open when closing the current search
result in the search results view.
VALID
VALUES
0 Does not open the previous search result.

1 Opens the previous search result.

DEFAULT
VALUES
1

6-196 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
PROTECTION
SCOPE
User preference.

WEB_max_search_results

DESCRIPTION
Defines the default number of objects returned for a search.
VALID
VALUES
A single integer.
DEFAULT
VALUES
30
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_simple_search_default

DESCRIPTION
Defines the default search option to be used while performing quick search fromc the
left navigation panel in thin client.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
Item ID
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_simple_search_queries

DESCRIPTION
Lists single field saved queries to be exposed in the thin client navigation pane quick
search box.
VALID
VALUES
Accepts one or more strings as values, including localized query names.
DEFAULT
VALUES
Item ID
Keyword Search
Item Name
Dataset Name

PLM00026 11.2 Preferences and Environment Variables Reference 6-197

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site and user preference.

Where_Ref_Avoid_Duplicate_Expansion

DESCRIPTION
Simplifies the tree view resulting from the Where referenced Search command. The
subtree of duplicate notes is not displayed.
VALID
VALUES
true Simplifies the tree view by not displaying the subtree of duplicate notes.
false Displays the subtree of duplicate notes.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

WSOM_find_editUserList

DESCRIPTION
Specifies the users for whom the Edit button is displayed on the My Teamcenter
search panel. This button provides access to the feature for extending existing queries.
VALID
VALUES
Any valid Teamcenter user ID.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

WSOM_find_list_separator

DESCRIPTION
Defines the character used to separate multiple entries for queries.
Note

• No setting for this preference disables multiple entries.

• If your search criteria includes a semicolon (;) as part of the search value,
change the default value of this preference to another value, for example
a comma (,) or a pipe (|) character. Otherwise, your search results in
incorrect results.

6-198 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
Accepts a single string as a valid value.
DEFAULT
VALUES
;
DEFAULT
PROTECTION
SCOPE
User preference.

WSOM_find_set_pff_displaydata_limit

DESCRIPTION
Limits the number of objects displayed in the Print dialog box that Teamcenter displays
when a user selects a property finder formatter (PFF) object in the Search Results
view, right-clicks, and chooses Print Table (HTML/TEXT).
For information about PFF objects, see Teamcenter Basics.
VALID
VALUES
Any positive integer.

Note

Performance may become unacceptable if you enter a value exceeding 1000.

DEFAULT
VALUES
300
DEFAULT
PROTECTION
SCOPE
User preference.

WSOM_find_set_search_limit

DESCRIPTION
Determines the number of objects loaded to workspace after performing a Find action
before asking for user confirmation.
VALID
VALUES
Accepts a positive integer as a value.
DEFAULT
VALUES
30
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-199

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Teamcenter services preferences

SOA_MaxOperationBracketInactiveTime

DESCRIPTION
Specifies the maximum time in seconds for an operation bracket without active server
requests.
For more information, see Teamcenter Services.
VALID
VALUES
Single positive integer.
DEFAULT
VALUES
60
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
If an SOA startOperation request is issued, the operation bracket should be
terminated with a stopOperation request. If the client leaves a bracket open without
any server requests for this period of time, the bracket is automatically terminated
upon the next SOA request.

SOA_MaxOperationBracketTime

DESCRIPTION
Specifies the maximum time in seconds for an operation bracket to suppress
redundant refreshes.
For more information, see Teamcenter Services.
VALID
VALUES
Single positive integer.
DEFAULT
VALUES
600
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
If an SOA startOperation request is issued, the operation bracket should be
terminated with a stopOperation request. If bracket lasts longer than specified by
this preference, the bracket is automatically terminated.

6-200 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

Solid Edge integration preferences

SE_TO_PDF_WORKING_DIR

DESCRIPTION
Specifies the staging location for PDF generation.
VALID
VALUES
A valid directory path.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
EXAMPLE
SE_TO_PDF_WORKING_DIR=C:\temp

SE_TO_PDF_EXECUTABLE_DIR

DESCRIPTION
Specifies the location for the SEEC_WorkFlow_PDF_Generation utility.
VALID
VALUES
A valid path to the SEEC_WorkFlow_PDF_Generation.exe executable file.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
EXAMPLE
SE_TO_PDF_EXECUTABLE_DIR=C:\Progra~1\Solide~1\Program\SEEC_WorkFlow_PDF_Generation.exe

SE_PDF_GEN_WAITING_PERIOD

DESCRIPTION
Specifies the number of seconds the TCRS-export-signoff-data handler should wait
for the PDF file to be generated.
VALID
VALUES
Integer
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 6-201

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.
EXAMPLE
SE_PDF_GEN_WAITING_PERIOD=20

Remote workflow preferences

TC_external_local_app_guid

DESCRIPTION
Defines the GUID (general unique identifier) of the home application, in this case,
of Teamcenter. When a link is created, the system submits its GUID to the remote
application so a bi-directional link can be created. This preference is set by the system
during the Remote workflow installation procedure.
VALID
VALUES
During the Remote workflow installation procedure, the GUID can be either manually
entered or automatically generated by the system. Siemens PLM Software
recommends autogenerating the GUID.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_external_proxiable_objects

DESCRIPTION
Defines the Teamcenter objects used to create links to other Teamcenter applications.
VALID
VALUES
Any valid Teamcenter workspace object.
DEFAULT
VALUES
Item
ItemRevision
Dataset
Form
PSBOMViewRevision
PSBOMView
Folder
EPMJob

6-202 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_external_proxiable_objects_props

DESCRIPTION
Defines the Teamcenter properties of each proxy object provided to the remote
application.
VALID
VALUES
Any valid Teamcenter property names of workspace objects.
DEFAULT
VALUES
object_name
object_desc
owning_user
owning_group
obj_icon_url
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_external_Requirements_proxy_props_internal

DESCRIPTION
Defines the properties of each proxy object imported from Teamcenter systems
engineering and requirements management to be stored in Teamcenter.
VALID
VALUES
Any valid Teamcenter property names of workspace objects.
DEFAULT
VALUES
object_app_guid
ext_obj_id
ext_obj_url
ext_obj_name
ext_obj_desc
ext_obj_icon_url
ext_id_num
ext_id_num_list
last_mod_user
last_mod_date
long_text
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-203

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

TC_external_Requirements_proxy_props_external

DESCRIPTION
Defines the properties of each proxy object imported from Teamcenter systems
engineering and requirements management to be stored in Teamcenter.
VALID
VALUES
Any valid Teamcenter property names of workspace objects. Properties specified
in this preference must correlate exactly to the properties specified in the
TC_external_Requirements_proxy_props_internal site preference.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMAN_external_appl_reg_url

DESCRIPTION
Defines the URL of the central application registry to which Teamcenter is registered.
VALID
VALUES
Valid URL address of the central application registry to which Teamcenter is registered.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_external_application_names

DESCRIPTION
Defines the Teamcenter applications to which Teamcenter can create links.
VALID
VALUES
Teamcenter application names as they are defined in the Teamcenter Application
Registry.
For more information, see UNIX and Linux Server Installation or Windows Server
Installation.
DEFAULT
VALUES
Teamcenter Project
Teamcenter Requirements

6-204 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_external_application_types

DESCRIPTION
Defines the Teamcenter application types to which Teamcenter can create links.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
application type as defined in the TC_external_application_names preference.
DEFAULT
VALUES
Project
Requirements

DEFAULT
PROTECTION
SCOPE
Site preference.

Teamcenter LDAP synchronization preferences

Teamcenter LDAP synchronization preferences

Teamcenter's synchronization tool, the ldapsync utility, looks at data in an LDAP directory server and
compares it with data currently in Teamcenter's database. User, person, group, and role entries not in
the database are added. If a user is present in both systems, the most recently modified user data in
one source overwrites the other. For example, if the LDAP information was modified more recently
than the Teamcenter information, the Teamcenter data is synchronized to the LDAP information. If a
Teamcenter user is not found in the LDAP database, the Teamcenter user is deactivated.
Synchronization preferences manage LDAP connection behavior.
Note

For more information about implementing synchronization functionality, see the ldapsync
utility in the Utilities Reference manual.

There are five categories of LDAP synchronization preferences:

• LDAP connection preferences

• Synchronization preferences

• Group object mapping preferences

• Role object mapping preferences

PLM00026 11.2 Preferences and Environment Variables Reference 6-205

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

• User and person object mapping preferences

LDAP connection preferences

LDAP_service_hosts

DESCRIPTION
Defines the list of hosts providing LDAP directory service for the synchronization
installation.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid host name. Define
hosts running the LDAP directory that you want to use for synchronization.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_port_number

DESCRIPTION
Defines the port number used when connecting to the hosts defined in the
LDAP_service_hosts preference. This preference works with the LDAP_use_ssl
preference. If this preference is set to the SSL port on the directory server, but
the LDAP_use_ssl preference is set to FALSE, the directory server ignores the
connection request from the synchronization tool, making it appear that the tool has
hung. When configuring the LDAP synchronization tool to use the SSL, make certain
the LDAP_use_ssl preference is set to TRUE.
VALID
VALUES
Accepts a single string as a value. Must be a single positive integer. Define the
Security Services server port to enable synchronization.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_use_ssl

DESCRIPTION
Determines whether the connection to the LDAP server uses Security Services. If the
LDAP_port_number preference is set to the SSL port on the directory server, but this
preference is set to FALSE, the directory server ignores the connection request from

6-206 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

the synchronization tool, making it appear that the tool has hung. When configuring the
LDAP synchronization tool to use the SSL, make certain this preference is set to TRUE.
VALID
VALUES
TRUE The LDAP server connection uses Security Services. If this setting is used,
the LDAP_cert_db_path preference must also be set.

FALSE The LDAP server connection does not use Security Services.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_cert_db_path

DESCRIPTION
Defines the path to the certificate used for the Security Services connection. The
system only checks this preference if the LDAP_use_ssl preference is set to TRUE.
Ensure this preference points to a correctly configured certificate database. Otherwise,
errors are encountered when configuring the LDAP synchronization tool to use the
SSL.
VALID
VALUES
Accepts a single string as a value. Must be the full path to the certificate database
used for the Security Services connection.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_admin_dn

DESCRIPTION
Defines the user name used by the synchronization tool to connect to the LDAP server.
The user name is the distinguished name (DN) of a LDAP user with search and read
permissions in the LDAP system. The user needn't have modification abilities in LDAP.
VALID
VALUES
Accepts a single string as a value. Must be the DN of a LDAP user with search and
read permissions in the LDAP system.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 6-207

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_admin_pw

DESCRIPTION
Defines the password for the LDAP_admin_dn user preference.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Related topics
• Data Exchange

• Configure the connection to an LDAP server

Synchronization preferences

LDAP_sync_user_flags

DESCRIPTION
Defines the user synchronization setting flags in a chmod-style character string format.
VALID
VALUES
Accepts a single string as a value.
The supported user synchronization flags are:
s (synchronize) If set, enables user synchronization.
c (create) If set, allows new externally managed user and person objects
to be created in Teamcenter during user synchronization.
d (deactivate) If set, allows externally managed user and person objects to be
deactivated in Teamcenter during user synchronization.
u (update) If set, allows externally managed user and person objects to be
updated in Teamcenter during user synchronization.
e (externalize) If set, any internally managed user and person objects found
in Teamcenter to have the same user ID and person name
as a user object in LDAP is converted to externally managed
during user synchronization.

6-208 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
s
c
d
u
e
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_sync_group_flags

DESCRIPTION
Defines the group synchronization setting flags in a chmod-style character string
format.
VALID
VALUES
Accepts a single string as a value.

The supported group synchronization flags are:

s (synchronize) If set, enables group synchronization.

c (create) If set, allows new externally managed group objects to be

created in Teamcenter during group synchronization.

u (update) If set, allows externally managed group objects to be updated in

Teamcenter during group synchronization.

e (externalize) If set, any internally managed group objects found in Teamcenter

to have the same group name as a group object in LDAP is
converted to externally managed during group synchronization.
DEFAULT
VALUES
s
c
u
e
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_sync_member_flags

DESCRIPTION
Defines the group member synchronization setting flags in a chmod-style character
string format.

PLM00026 11.2 Preferences and Environment Variables Reference 6-209

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

Note

Group member synchronization requires both user synchronization and group

synchronization to be enabled. If group member synchronization is enabled but
either user or group synchronization is not, then group member synchronization
is skipped.

VALID
VALUES
Accepts a single string as a value.
The supported group member synchronization flags are:
s (synchronize) If set, enables group member synchronization.
c (create) If set, allows new externally managed group member
objects to be created in Teamcenter during group member
synchronization.
d (deactivate) If set, allows externally managed group member objects to be
deactivated in Teamcenter during user synchronization.
e (externalize) If set, any internally managed group objects found in
Teamcenter to have the same user ID, group name, and role
name as a group member relationship in LDAP is converted to
externally managed during group member synchronization.
DEFAULT
VALUES
s
c
d
e
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_sync_role_flags

DESCRIPTION
Defines the role synchronization setting flags in a chmod-style character string format.
Note

Role synchronization requires group synchronization to be enabled. If

role synchronization is enabled but group synchronization is not, then role
synchronization is skipped.

VALID
VALUES
Accepts a single string as a value.
The supported role member synchronization flags are:
s (synchronize) If set, enables role synchronization.

6-210 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

c (create) If set, allows new externally managed role objects to be created

in Teamcenter during role synchronization.

u (update) If set, allows externally managed role objects to be updated in

Teamcenter during role synchronization.

e (externalize) If set, any internally managed role objects found in Teamcenter

to have the same role name as a role object in LDAP is
converted to externally managed during role synchronization.
DEFAULT
VALUES
s
c
u
e
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_member_list_attr

DESCRIPTION
Defines the LDAP group object attribute that contains the list of member
distinguished names (DN) for the object. This preference applies to objects
representing either groups or roles defined in LDAP. Use this preference only if the
LDAP_member_type_attr preference is set.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
uniqueMember
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_member_type_attr

DESCRIPTION
Defines the LDAP group object attribute that contains the membership type (direct or
indirect) for this object.
VALID
VALUES
TRUE Specifies indirect group membership. If this setting is used, the
LDAP_member_list_attr preference must also be set.

FALSE Specifies direct group membership.

PLM00026 11.2 Preferences and Environment Variables Reference 6-211

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_object_type_attr

DESCRIPTION
Defines the LDAP group object attribute that contains the object type (group or role)
for this object.
VALID
VALUES
group The object represents a group defined in LDAP.
role The object represents a role defined in LDAP.
DEFAULT
VALUES
group
DEFAULT
PROTECTION
SCOPE
Site preference.

Related topics

• LDAP syncrhonization concepts

Group object mapping preferences

LDAP_group_base_dn

DESCRIPTION
Defines the distinguished name (DN) of one or more nodes in the external directory
where the group synchronization process begins searching.
This preference limits which part of the LDAP external directory the sync tool views
when searching for groups to synchronize with Teamcenter.
Use this attribute to improve performance and to partition groups within a single LDAP
database across several Teamcenter installations. If your site's LDAP directory does
not have a high degree of organization, set this value to the lowest level DNs that
encompass all of the Teamcenter groups. For example, a high-level DN is:
dc=net,dc=plm,dc=ugs,dc=com
An example of a specific DN is:
ou=Engineering Groups,ou=groups,dc=net,dc=plm,dc=ugs,dc=com

6-212 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

VALID
VALUES
Accepts a set of one or more strings.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_group_query_filter

DESCRIPTION
Defines a set of conditions that an LDAP object must satisfy to be matched as a group
object for synchronizing with Teamcenter.
If you are familiar with LDAP query filter syntax, use this optional preference, which is
a more sophisticated object matching mechanism.
VALID
VALUES
Accepts a single string in LDAP query filter syntax.
DEFAULT
VALUES
(cn=*)
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_group_object_class

DESCRIPTION
Defines the LDAP object class that the customer uses to model groups to be
synchronized with Teamcenter. If you use multiple classes that all represent groups,
use this preference to specify the common base class of those classes.
This optional preference allows you to define specific subclasses in LDAP to
differentiate groups and roles. If groups and roles both have the same object
class, they must be differentiated by values of the attribute specified using the
LDAP_object_type_attr preference.
VALID
VALUES
Accepts a single string, which is the name of an LDAP object class.
DEFAULT
VALUES
groupOfUniqueNames
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 6-213

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

LDAP_group_attr_mapping

DESCRIPTION
Maps LDAP object attributes to Teamcenter group attributes. The mappings control
what information the synchronization tool (the ldapsync utility) sets in the Teamcenter
group object.
LDAP_group_attr_mapping=
LDAPGroupName
cn
%REPLACE_ME%
LDAPGroupDesc
description
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%
LDAPGroupDBA
%REPLACE_ME%
0
LDAPGroupRole
%REPLACE_ME%
%REPLACE_ME%

VALID
VALUES
Accepts triples of strings.
Each attribute mapping consists of three strings: the attribute identifier, the mapped
LDAP attribute name, and the default value (to be used if there is no LDAP mapped
attribute or if the LDAP mapped attribute value is null).
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Related topics

• Group and role mapping

Role object mapping preferences

LDAP_role_query_filter

DESCRIPTION
Defines a set of conditions that an LDAP object must satisfy to become matched as a
role object for synchronizing with Teamcenter.

6-214 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

This optional preference allows administrators familiar with LDAP query filter syntax to
use a more sophisticated object matching mechanism.
VALID
VALUES
Accepts a string in LDAP query filter syntax.
DEFAULT
VALUES
(cn=*)
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_role_object_class

DESCRIPTION
Defines the LDAP object class used to model roles to be synchronized with
Teamcenter. If you use multiple classes that all represent roles, use this preference to
specify the common base class of those classes.
This optional preference allows you to define specific subclasses in LDAP to
differentiate groups and roles. If groups and roles both have the same object
class, they must be differentiated by values of the attribute specified using the
LDAP_object_type_attr preference.
VALID
VALUES
Accepts a single string. Must be the name of an LDAP object class.
DEFAULT
VALUES
groupOfUniqueNames
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_role_attr_mapping

DESCRIPTION
Maps LDAP attributes to Teamcenter role attributes. The mappings control what
information the synchronization tool sets in the Teamcenter role object.
LDAP_role_attr_mapping=
LDAPRoleName
cn
%REPLACE_ME%
LDAPRoleDesc
description
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%

PLM00026 11.2 Preferences and Environment Variables Reference 6-215

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

VALID
VALUES
Accepts triples of strings.
Each attribute mapping consists of three strings: the Teamcenter attribute name, the
mapped LDAP attribute name, and the default value (to be used if there is no LDAP
mapped attribute or if the LDAP mapped attribute value is null).
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

User and person object mapping preferences

LDAP_attribute_mapping

DESCRIPTION
Maps LDAP attributes to Teamcenter attributes. The mappings control what information
the synchronization tool sets in the Teamcenter user and person objects. For example:
LDAP_attribute_mapping=
LDAPPersonName
cn
%REPLACE_ME%
LDAPEngUserId
uid
%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%
LDAPOsUser
uid
%REPLACE_ME%
LDAPUserGroup
%REPLACE_ME%
Engineering
LDAPUserRole
%REPLACE_ME%
%REPLACE_ME%

VALID
VALUES
Accepts multiple strings, in pairs, as values. Each pair must contain valid LDAP and
Teamcenter attributes.

6-216 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_base_dn

DESCRIPTION
Defines the distinguished name (DN) of the top-level entry under which all user entries
to be checked are defined. Use this preference to limit which part of the LDAP
directory the synchronization tool examines when searching for Teamcenter users.
This functionality can also be used to partition users within a single LDAP database
across several Teamcenter installations.
If a site does not have this degree of organization in its LDAP directory, this value
should be set to the lowest level in the directory that would encompass all of the
Engineering users. Following is an example of how a high-level value might appear:
dc=ugs,dc=com
A more specific entry would look as follows:
ou=Engineering Users,ou=special users,dc=ugs,dc=com
VALID
VALUES
Accepts one or more strings as a value. Must be a valid LDAP directory name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_ignore_users

DESCRIPTION
Defines a set user IDs that should not be processed by the ldapsync utility. This list
normally contains Teamcenter user IDs that are used for administrative purposes and
do not have corresponding entries in the LDAP repository.
VALID
VALUES
Accepts one or more strings.
DEFAULT
VALUES
infodba

PLM00026 11.2 Preferences and Environment Variables Reference 6-217

 Chapter
Chapter 6: 6: Configuration
Configuration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_user_query_filter

DESCRIPTION
Defines a set of conditions that an LDAP object must satisfy to be matched as
a user object for synchronizing with Teamcenter. This optional preference allows
administrators familiar with LDAP query filter syntax to use a more sophisticated object
matching mechanism.
VALID
VALUES
Accepts a single string. Must be in LDAP query filter syntax.
DEFAULT
VALUES
(cn=*)
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_user_object_class

DESCRIPTION
Defines the LDAP object class that the customer uses to model users to be
synchronized with Teamcenter. If you use multiple classes that all represent users,
then this preference should specify the common base class of those classes.
VALID
VALUES
Accepts a single string. Must be the name of an LDAP object class.
DEFAULT
VALUES
inetOrgPerson
DEFAULT
PROTECTION
SCOPE
Site preference.

LDAP_person_attr_mapping

DESCRIPTION
Maps LDAP user attributes to Teamcenter person attributes. The mappings control
what information the synchronization tool sets in the Teamcenter person objects.
LDAP_attribute_mapping=
LDAPPersonName
cn
%REPLACE_ME%
LDAPLastUpdate

6-218 Preferences and Environment Variables Reference PLM00026 11.2

 Configuration preferences

modifyTimestamp
%REPLACE_ME%
PA1
postaladdress
%REPLACE_ME%
PA2
localityName
%REPLACE_ME%
PA3
st
%REPLACE_ME%
PA4
postalCode
%REPLACE_ME%
PA5
co
%REPLACE_ME%
PA6
o
%REPLACE_ME%
PA7
employeeNumber
%REPLACE_ME%
PA8
physicalDeliveryOfficeName
%REPLACE_ME%
PA9
mail
%REPLACE_ME%
PA10
telephoneNumber
%REPLACE_ME%

VALID
VALUES
Accepts triples of strings.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Related topics
• Objects synchronized by the ldapsync utility

PLM00026 11.2 Preferences and Environment Variables Reference 6-219

Chapter 7: Administration preferences

AM_PROJECT_MODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
TC_allow_group_hierarchy_traversal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
TC_allow_remove_owning_project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
TC_org_tree_expansion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
TC_honor_group_privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
TC_project_validate_conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
TC_Project_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
TC_Project_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
TC_Program_Preferred_Items_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
TC_multi_site_project_member_bypass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
TC_object_type_delegation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
TC_set_current_project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
TC_show_all_user_projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
TC_show_digital_signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
TC_current_role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
TC_Web_Browser_Home_URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10

PLM00026 11.2 Preferences and Environment Variables Reference

Chapter 7: Administration preferences

AM_PROJECT_MODE

DESCRIPTION
Determines whether the system evaluates the roles in all the active projects of the
logged in user, or just the role of the current project, when processing the Role in
Project and Role in Projects of Object accessors.
The Teamcenter servers must be restarted after setting this site preference, for the
setting to become effective in Access Manager evaluation.
VALID
VALUES
true System evaluates the roles in all active projects of the logged in user while
processing the Role in Project and Role in Projects of Object accessors.
false System evaluates only the roles of the current project of the logged in user
while processing the Role in Project and Role in Projects of Object
accessors.
DEFAULT
VALUES
false.
Note

If this preference is undefined, default behavior is false.

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_allow_group_hierarchy_traversal

DESCRIPTION
Sets whether access privileges can be propagated across hierarchical groups when
using the Owning Group accessor in an access control list (ACL). By default, the
members of a subgroup receive the same access privileges set on workspace objects
as their parent group who owns the object (the owning group).
Note

The parent group cannot access data if the owning group is a child group of
the parent.

VALID
VALUES
TRUE Allow access to a workspace object to the subgroup of the owning group.

PLM00026 11.2 Preferences and Environment Variables Reference 7-1

 Chapter
Chapter 7: 7: Administration
Administration preferences
preferences

FALSE Limit the access to the owning group of the object only.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.
EXAMPLE
If an object (Item1) has the following:
• An owning group of Group1.

• An organizational structure of:

Group1
Subgroup1
Subgroup2
Subsubgroup1

• An access configuration of:

Has Class (Item)->ItemACL

• An ItemACL of:

Owning Group

World

Then:
• If TC_allow_group_hierarchy_traversal is set to TRUE (the default), the
members of the child groups are granted READ and WRITE privileges to Item1
because it is owned by the parent group.

• If TC_allow_group_hierarchy_traversal is set to FALSE, the members of the

subgroups do not gain READ and WRITE privileges. They are treated as a World
accessor with no access.

TC_allow_remove_owning_project

DESCRIPTION
Allows the removal of a project from the owning_project property of the workspace
object in which the object is assigned if the preference value is set to TRUE. The
user must create this preference; it does not exist in Teamcenter by default. If the
preference does not exist or has a value of FALSE, the project cannot be removed
even though the project can be removed from the project_list property.

7-2 Preferences and Environment Variables Reference PLM00026 11.2

 Administration preferences

If you use the autoAssignToProject extension, you must create this preference and
set its value to TRUE to allow automatic project assignment.
For more information about using the autoAssignToProject extension, see Project
and Program.
VALID
VALUES
TRUE Allows removal of a project from the owning_project property.
FALSE Prevents removal of a project from the owning_project property.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_org_tree_expansion

DESCRIPTION
Enables expansion of the Organization tree based on the number of tree nodes to
achieve better performance and Organization tree view.
If you have a very large organization, expanding the entire organization takes a long
time. Setting this preference could avoid a performance issue.
Note

Setting this preference impacts the Organization tree display in the Workflow
signoff profile and search action Organization tree.

VALID
VALUES
The value of this preference is in the following format:
nodeNumberThreshold:expansionLevel

For example, if the preference value is set to 1000:1, it indicates the Organization
tree to be displayed only expands to level 1 if there are 1000 or more nodes in the
Organization tree to be displayed.
DEFAULT
VALUES
1500:2
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_honor_group_privilege

DESCRIPTION
Controls the display of privileged groups, roles and users under privileged groups. If
set to true, then privileged groups, as well as roles and users under them, are not

PLM00026 11.2 Preferences and Environment Variables Reference 7-3

 Chapter
Chapter 7: 7: Administration
Administration preferences
preferences

displayed to non-privileged login users. This preference does not impact on the
Organization display of login users.
VALID
VALUES
The value of this preference is in the following format:
true, false
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_project_validate_conditions

DESCRIPTION
Determines how the ASSIGN_TO_PROJECT and REMOVE_FROM_PROJECT
access privileges are validated in conjunction with privileged membership validation.
For information about defining privileged membership, see Project and Program.
The behavior of this preference is overruled by
TC_multi_site_project_member_bypass preference settings.
Note

• The TC_project_validate_conditions preference has no effect on which

projects are displayed in the Teamcenter interface. Therefore, it is possible
that users see projects displayed in the interface, for example, in the User
Settings dialog box, that they do not have access to.

• This preference is not included in your Teamcenter installation. You must

add it to the database.

VALID
VALUES
0 The system confirms the user is a privileged member of the
project before allowing the user to assign/remove objects
to/from a project.
1 The system confirms the user is either a privileged member of
the project, or that the user is a regular project member who is
granted the ASSIGN_TO_PROJECT privilege before allowing
the user to assign object to a project. Likewise, a user must be
either a privileged member of the project or be a regular project
member and who is granted the REMOVE_FROM_PROJECT
privilege to remove an object from a project.

7-4 Preferences and Environment Variables Reference PLM00026 11.2

 Administration preferences

2 The system confirms the user is a regular project member and

has the ASSIGN_TO_PROJECT privilege before allowing the
user to assign object to a project. Likewise, a user must have
the REMOVE_FROM_PROJECT privilege to remove an object
from a project.

3 The system confirms the user is a privileged member of the

project and that the user has the ASSIGN_TO_PROJECT
privilege before allowing the user to assign object to a project.
Likewise, a user must be a privileged member of the project
and have the REMOVE_FROM_PROJECT privilege to remove
an object from a project.

4 Allows you to assign users to a project if you are not a member

of the project team. This must be done programmatically using
ITK. You cannot do this through the interface.
The system confirms that the user has ASSIGN_TO_PROJECT
privilege before allowing the user to assign objects to a project.
Likewise, the user must have REMOVE_FROM_PROJECT
privilege to remove an object from a project.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Project_DefaultChildProperties

DESCRIPTION
Specifies a list of properties that can be children of the TC_Project business object
type.
VALID
VALUES
Accepts any valid property name of the TC_Project object.
DEFAULT
VALUES
TC_Program_Preferred_Items
DEFAULT
PROTECTION
SCOPE
User preference.

TC_Project_PseudoFolder

DESCRIPTION
Specifies a list of properties that may be displayed as a pseudo folder under a node of
TC_Project business object type.

PLM00026 11.2 Preferences and Environment Variables Reference 7-5

 Chapter
Chapter 7: 7: Administration
Administration preferences
preferences

VALID
VALUES
Accepts any valid property name of the TC_Project object.
DEFAULT
VALUES
TC_Program_Preferred_Items
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Program_Preferred_Items_relation_primary

DESCRIPTION
Specifies a list of valid primary business object types for the
TC_Program_Preferred_Items relation.
Note

All <relation_business_object>_relation_primary preferences are obsolete and

are replaced by relation properties. Use the Business Modeler IDE to create
and manage relation properties.
For more information about relation properties, see Business Modeler IDE.

VALID
VALUES
Accepts any valid business object type name.
DEFAULT
VALUES
TC_Project
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_multi_site_project_member_bypass

DESCRIPTION
Determines whether a replicated object is assigned to a defined project upon import
to a remote site, regardless of whether the importing user is a privileged project
member of the project.
If the replicated object is imported by a user who is not a privileged project member,
and this preference is set to true, the replicated object is assigned to the defined
project upon import.
If the replicated object is imported by a user who is not a privileged project member,
and this preference is set to false, the replicated object is not assigned to the defined
project upon import.

7-6 Preferences and Environment Variables Reference PLM00026 11.2

 Administration preferences

Note

This preference is not included in your Teamcenter installation. You must add it
to the database.

VALID
VALUES
true Replicated object is assigned to the defined project regardless of whether
the importing user is a privileged project member.

false Replicated object is assigned to the defined project only if the importing
user is a privileged project member.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_object_type_delegation

DESCRIPTION
Configures the Access Manager delegation for object types to a class. The format is
typeName:className, which delegates access for named references of the type
identified by typeName to the owning class identified by className.

By default, the access for the following three object types are delegated to its owning
dataset:

• ImanFile

• UGPartAttr

• UGPartBoundingBoxForm

You do not need to add entries for these types.

Note

This preference is not included in your Teamcenter installation. You must add it
to the database.

VALID
VALUES
typeName:className

typeName is the object whose access is delegated to the owning class className.
DEFAULT
VALUES
Default value

PLM00026 11.2 Preferences and Environment Variables Reference 7-7

 Chapter
Chapter 7: 7: Administration
Administration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.
EXAMPLE
The following example delegates named references objects of the type
MySampleForm to the owning Dataset:
MySampleForm:Dataset

TC_set_current_project

DESCRIPTION
Determines whether the project saved in the previous Teamcenter session for a
particular user is set as the current project in a new session for the same user.
VALID
VALUES
true The project saved in the previous Teamcenter session is set as the current
project in the new Teamcenter session.

false The project saved in the previous Teamcenter session is not set as the
current project in the new Teamcenter session.
DEFAULT
VALUES
true
Note

If this preference is undefined, the default behavior is true.

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_show_all_user_projects

DESCRIPTION
Controls whether all active projects in which a user is a privileged team member are
displayed for selection in the Teamcenter interface or whether only the projects that
correlate to the user's current group and role are displayed for selection.
VALID
VALUES
true The system displays all active projects in which the user is a privileged team
member, regardless of the user's current group and role.

false The system displays only the active projects in which the user is a privileged
team member based on the user's current group and role.
DEFAULT
VALUE
true

7-8 Preferences and Environment Variables Reference PLM00026 11.2

 Administration preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_show_digital_signature

DESCRIPTION
Enables icons to appear to the right of an object in the Home view indicating it has a
valid PKI digital signature or a voided PKI digital signature.
VALID
VALUES
true Enables the display of PKI digital signature icons in the Home view.
false Disables the display of PKI digital signature icons.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_current_role

DESCRIPTION
Specifies whether the user's membership in a role enforces access to objects.
VALID
VALUES
true A member of the role has access to an object only when the role is that user’s
current role.
false A member of the role has access to an object even when the role is not the
user’s current role.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
• The Role in Group, Role in Owning Group, Role in Project, and Role in
Project of Object accessors work on the super set of roles the user possesses in
the relevant group or project, rather than on the current role in the session.

• When the TC_current_role preference is set, it affects the evaluation of the Role
in Owning Group, Role in Group, and Role accessors.

• When the AM_PROJECT_MODE preference is set, it affects the evaluation of the

Role in Project and Role in Project of Object accessors.

PLM00026 11.2 Preferences and Environment Variables Reference 7-9

 Chapter
Chapter 7: 7: Administration
Administration preferences
preferences

TC_Web_Browser_Home_URL

DESCRIPTION
Specifies the default home page for the rich client’s Web Browser view.
For more information about using the Web Browser view, see Application
Administration.
VALID
VALUES
Accepts a single string as a value. URL must be valid.
DEFAULT
VALUES
http://www.plm.automation.siemens.com
DEFAULT
PROTECTION
SCOPE
User preference.

7-10 Preferences and Environment Variables Reference PLM00026 11.2

Chapter 8: Attribute sharing preferences

EINT_adapter_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
EINT_<adapter_name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
ATTRSHARING_datasource_connection_details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
ATTRSHARING_max_rows_expected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
EINT_update_on_save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
EINT_import_selected_rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
EINT_create_new_forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
EINT_form_refresh_pref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
EINT_item_rev_pref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
EINT_copy_to_clipboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
EINT_max_num_rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
EINT_sqlnet_adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4

PLM00026 11.2 Preferences and Environment Variables Reference

Chapter 8: Attribute sharing preferences

EINT_adapter_names

DESCRIPTION
Defines valid adapters.
VALID
VALUES
Names of valid adapters.
DEFAULT
VALUES
EINT_sqlnet_adapter
DEFAULT
PROTECTION
SCOPE
Site preference.

EINT_<adapter_name>

DESCRIPTION
Determines the display name of the specified adapter. A single preference is needed
for each adapter name. For example, if your site was running an ODBC adapter and
an IBI adapter, both a EINT_odbc_adapter and EINT_ibi_adapter preference would
need to be added to the preference file and defined with the desired display name.
VALID
VALUES
A single string; must be the name of a valid adapter.
DEFAULT
VALUES
EINT_sql_adapter= SQLAdapter
DEFAULT
PROTECTION
SCOPE
Site preference.

ATTRSHARING_datasource_connection_details

DESCRIPTION
Defines the data source used for attribute sharing. Only one data source can be
defined at a given time.
VALID
VALUES
Accepts a single string as a value. Must be a valid data source.

PLM00026 11.2 Preferences and Environment Variables Reference 8-1

 Chapter
Chapter 8: 8: Attribute
Attribute sharing
sharing preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ATTRSHARING_max_rows_expected

DESCRIPTION
Defines the maximum number of rows that can be returned from a result set. If the
return exceeds the number of rows defined by this preference, an error message
appears.
VALID
VALUES
Accepts a single string as a value. Must be a positive integer.
DEFAULT
VALUES
100
DEFAULT
PROTECTION
SCOPE
Site preference.

EINT_update_on_save

DESCRIPTION
Determines how to update external data when saving Teamcenter forms.
VALID
VALUES
0 Does not update external data when saving a form.
1 Updates external data when saving a form.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

EINT_import_selected_rows

DESCRIPTION
Determines method of importing selected rows to the query results table.
VALID
VALUES
0 Imports all rows into the query result table.
1 Imports only selected rows into the query result table.

8-2 Preferences and Environment Variables Reference PLM00026 11.2

 Attribute sharing preferences

DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

EINT_create_new_forms

DESCRIPTION
Determines whether or not to create a new form when importing external data. If left
unset, create a new form for the imported data.
VALID
VALUES
0 Updates the existing form with the imported data if found by the given name. If
not found, create a new form for the imported data.
1 Always creates a new form when importing external data.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

EINT_form_refresh_pref

DESCRIPTION
Controls whether or not the refresh operation updates the form data from the external
source.
VALID
VALUES
0 The form data is not updated when the refresh operation is run.
1 A SQL query runs and fetches the external data every time the form is
refreshed.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

EINT_item_rev_pref

DESCRIPTION
Defines the behavior for attaching a form to an item revision when there is no item
revision mapping and the latest version of the item revision is released.

PLM00026 11.2 Preferences and Environment Variables Reference 8-3

 Chapter
Chapter 8: 8: Attribute
Attribute sharing
sharing preferences
preferences

VALID
VALUES
0 Indicates that no new item revision can be created.
1 Creates a new item revision based on the released revision and creates and
attaches a new form to this item revision. Existing forms, if any, are not copied
from the released revision.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

EINT_copy_to_clipboard

DESCRIPTION
Determines the location of new forms after importing external data.
VALID
VALUES
0 Pastes the new forms into the user's Newstuff folder.
1 Copies the new forms to the Teamcenter clipboard.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

EINT_max_num_rows

DESCRIPTION
Determines the number of external data rows results after performing an SQL query
before asking for user confirmation.
VALID
VALUES
Single, positive integer.
DEFAULT
VALUES
30
DEFAULT
PROTECTION
SCOPE
Site preference.

EINT_sqlnet_adapter

DESCRIPTION
Display name for the SQL Net adapter.

8-4 Preferences and Environment Variables Reference PLM00026 11.2

 Attribute sharing preferences

VALID
VALUES
Names of valid adapters.
DEFAULT
VALUES
SQLNetAdapter
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 8-5

Chapter 9: Authorization preferences

TC_authorization_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

PLM00026 11.2 Preferences and Environment Variables Reference

Chapter 9: Authorization preferences

TC_authorization_mode

DESCRIPTION
Determines whether to evaluate all the group memberships of a user and the user's
role in those groups when authorizing access to an application or to evaluate the user's
current group logon and role in that group.
For information about configuring access to an application, see Application
Administration.
Example

To access the Organization application, a user must have dba privileges (be a
member of dba with the role of DBA). If the user is a member of both the dba
and the Engineering groups and logs on under the Engineering group, the user
may or may not have access to the Organization application depending on
how TC_authorization_mode is set:
• If set to on (evaluate all group memberships and the roles in the groups),
the user has administration privileges based on membership in the dba
group, even though the user is not currently logged on under that group.
The user can access the Organization application.

• If set to off (evaluate only the current logon group and the role in that group),
the user does not have administration privileges through the Engineering
group. Therefore, the user cannot access the Organization application.

VALID
VALUES
on Evaluates all the group memberships of a user and the user's roles in those
groups to determine the user's access to an application.
off Evaluates only the user's current logon group and the user's role in that group
to determine the user's access to an application.
DEFAULT
VALUES
off
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 9-1

Chapter 10: Validation Manager preferences

Baseline_precondition_validation_rule_item_revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
NXCheckMateCreate.CREATE_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
NXCheckMate.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
NXCheckMateRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
NXCheckMateRevSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . 10-2
NXCheckMate.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
NXCheckMateSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
NXCMValDataCreate.CREATE_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
NXCMValData.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
NXCMValDataRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4
NXCMValDataRevSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . 10-4
NXCMValData.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4
NXCMValDataSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5
NXRDDVRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5
NXRDDVRevSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5
NXRDDV.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6
NXRDDVSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6
NXRDDVValDataRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6
NXRDDVValDataRevSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . 10-7
NXRDDVValData.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
NXRDDVValDataSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
TC_ALLOW_ADHOC_VALIDATIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
TC_VALIDATION_duplicate_nx_valdata_error_on_import . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
TC_VALIDATION_FILE_TYPES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
TC_VALIDATION_mandatory_checkers_required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9
TC_VALIDATION_override_approval_roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9
TC_Validation_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
TC_VALIDATION_requirement_expressions_separator . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
TC_VALIDATION_requirement_formula_expressions_separator . . . . . . . . . . . . . . . . . . . . 10-11
TC_VALIDATION_RULE_SET_ITEM_REVISIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11
TC_VALIDATION_run_validation_hidden_agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11
TC_VALIDATION_send_envelope_for_override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
TC_VALIDATION_STYLESHEET_DATASETNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
TC_VALIDATION_TIMESTAMP_NREFS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13
TC_VALIDATION_unify_itemrev_validation_form_ownership . . . . . . . . . . . . . . . . . . . . . . 10-13
TC_VALIDATION_ViewValidationWithRuleSetColumnPreferences . . . . . . . . . . . . . . . . . . . 10-14
TC_VALIDATION_ViewValidationWithRuleSetColumnWidthPreferences . . . . . . . . . . . . . . . 10-14
ValidationAgent_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-15
ValidationAgentRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-15
ValidationAgentRevision_Folder_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-15
ValidationAgentRevision_ValData_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-16
ValidationMasterFormColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-16
ValidationMasterFormColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-17

PLM00026 11.2 Preferences and Environment Variables Reference

ValToolAgentRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-17
ValToolAgentRevision_Tool_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-18

Preferences and Environment Variables Reference PLM00026 11.2

Chapter 10: Validation Manager preferences

Baseline_precondition_validation_rule_item_revision

DESCRIPTION
Specifies the validation rule item revision for baseline pre-action handler.
VALID
VALUES
A valid item revision.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

NXCheckMateCreate.CREATE_REGISTEREDTO

DESCRIPTION
Indicates the business object to which the NXCheckMate object creation style sheet
can be applied.
VALID
VALUES
Accepts a single string as a value. It must be a valid Teamcenter business object.
DEFAULT
VALUES
NXCheckMate
DEFAULT
PROTECTION
SCOPE
Site preference.

NXCheckMate.CREATERENDERING

DESCRIPTION
Registers the create style sheet for NXCheckMate objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXCheckMateCreate

PLM00026 11.2 Preferences and Environment Variables Reference 10-1

 Chapter
Chapter 10:10:Validation
Validation Manager
Manager preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

NXCheckMateRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for NXCheckMateRevision objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXCheckMateRevSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

NXCheckMateRevSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the business objects to which the NXCheckMateRevision summary style
sheet can be applied.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXCheckMateRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

NXCheckMate.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for NXCheckMate objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXCheckMateSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

10-2 Preferences and Environment Variables Reference PLM00026 11.2

 Validation Manager preferences

NXCheckMateSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the business objects to which the NXCheckMate summary style sheet can
be applied.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXCheckMate
DEFAULT
PROTECTION
SCOPE
Site preference.

NXCMValDataCreate.CREATE_REGISTEREDTO

DESCRIPTION
Indicates the business objects to which the NXCMValData object creation style sheet
can be applied.
VALID
VALUES
Accepts a single string as a value. It must be a valid Teamcenter business object.
DEFAULT
VALUES
NXCMValData
DEFAULT
PROTECTION
SCOPE
Site preference.

NXCMValData.CREATERENDERING

DESCRIPTION
Registers the create style sheet for NXCMValData objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXCMValDataCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 10-3

 Chapter
Chapter 10:10:Validation
Validation Manager
Manager preferences
preferences

NXCMValDataRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for NXCMValDataRevision objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXCMValDataRevSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

NXCMValDataRevSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the business objects to which the NXCMValDataRevision summary style
sheet can be applied.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXCMValDataRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

NXCMValData.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for NXCMValData objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXCMValDataSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

10-4 Preferences and Environment Variables Reference PLM00026 11.2

 Validation Manager preferences

NXCMValDataSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the business objects to which the NXCMValData summary style sheet can
be applied.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXCMValData
DEFAULT
PROTECTION
SCOPE
Site preference.

NXRDDVRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for NXRDDVRevision objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXRDDVRevSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

NXRDDVRevSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the business objects to which the NXRDDVRevision summary style sheet
can be applied.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXRDDVRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 10-5

 Chapter
Chapter 10:10:Validation
Validation Manager
Manager preferences
preferences

NXRDDV.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for NXRDDV objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXRDDVSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

NXRDDVSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the business objects to which the NXRDDV summary style sheet can be
applied.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXRDDV
DEFAULT
PROTECTION
SCOPE
Site preference.

NXRDDVValDataRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for NXRDDVValDataRevision objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXRDDVValDataRevSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

10-6 Preferences and Environment Variables Reference PLM00026 11.2

 Validation Manager preferences

NXRDDVValDataRevSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the business objects to which the NXRDDVValDataRevision summary
style sheet can be applied.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXRDDVValDataRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

NXRDDVValData.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for NXRDDVValData objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXRDDVValDataSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

NXRDDVValDataSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the business objects to which the NXRDDVValData summary style sheet
can be applied.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
NXRDDVValData
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 10-7

 Chapter
Chapter 10:10:Validation
Validation Manager
Manager preferences
preferences

TC_ALLOW_ADHOC_VALIDATIONS

DESCRIPTION
Determines whether users can set pending validation results to Pass or Fail on the
Validation Master form. Some validation utilities may not return either a pass or fail
result, so the user may have to make an ad hoc decision regarding the success or
failure of the validation.
This preference is applicable for the NX Check-Mate validation agent only.
VALID
VALUES
TRUE Allows users to set pending results to Pass or Fail.
FALSE Does not allow users to set pending results to pass or fail.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VALIDATION_duplicate_nx_valdata_error_on_import

DESCRIPTION
Indicates if an error should be returned when importing an NX validation checker that
has the same checker name as an existing NX validation checker.
VALID
VALUES
TRUE

FALSE

DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VALIDATION_FILE_TYPES

DESCRIPTION
Determines the types of files that can be associated as datasets to validation data or
validation results objects.
This preference is applicable for the NX Check-Mate and NX RDDV
(Requirement-Driven Design Validation) validation agents only.

10-8 Preferences and Environment Variables Reference PLM00026 11.2

 Validation Manager preferences

VALID
VALUES
Accepts one or more strings as values. Each string must contain three string values:
dataset name, RefName and references (which are file extensions in the following
example), defining the types of files that can contain rules or validation results. For
example:
TC_VALIDATION_FILE_TYPES=
Text Text *.mqclog
MSExcel excel *.xls

DEFAULT
VALUES
ValidationResultLog MQCXML *.xml
ValidationResultLog MQCXML *.mqcxml
ValidationResultLog MQC *.mqclog
ValidationResultLog MQC *.log
ValidationResultLog IMAGE_J *.jpg
ValidationResultLog DFA *.dfa
ValidationResultLog MSExcel *.xls
ValidationResultLog XSL *.xsl
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VALIDATION_mandatory_checkers_required

DESCRIPTION
Specifies whether the mandatory checkers are required to be run when performing
validation.
VALID
VALUES
true Mandatory checkers are required.

false Mandatory checkers are not required.

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VALIDATION_override_approval_roles

DESCRIPTION
Specifies the roles that can approve or reject validation result override requests.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter role.

PLM00026 11.2 Preferences and Environment Variables Reference 10-9

 Chapter
Chapter 10:10:Validation
Validation Manager
Manager preferences
preferences

DEFAULT
VALUES
Override Approver
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Validation_relation_primary

DESCRIPTION
Displays validation results under the specified item revision types.

Note

All <relation_business_object>_relation_primary preferences are obsolete and

are replaced by relation properties. Use the Business Modeler IDE to create
and manage relation properties.

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid item revision type.
DEFAULT
VALUES
ItemRevision
ValidationData
ValidationResult
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VALIDATION_requirement_expressions_separator

DESCRIPTION
Defines the string used to separate two requirement expressions for display.
VALID
VALUES
Accepts a single string as a value. The following special characters are recommended
values:

10-10 Preferences and Environment Variables Reference PLM00026 11.2

 Validation Manager preferences

DEFAULT
VALUES
,
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VALIDATION_requirement_formula_expressions_separator

DESCRIPTION
Defines the string used to separate the requirement formula and the requirement
expressions for display.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
where
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VALIDATION_RULE_SET_ITEM_REVISIONS

DESCRIPTION
Defines the list of item revisions that contain validation rule datasets, and which are
displayed in the Rule Setlist of the Rule Set Evaluation tab in the Validation Manager.
You can always type in or paste items and item revisions into the list. Register them
into this preference list after creation.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid item revision.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VALIDATION_run_validation_hidden_agents

DESCRIPTION
List of Validation Agent class names to be hidden in the list in the Run Validation
dialog box.
VALID
VALUES
Accepts multiple strings as value.

PLM00026 11.2 Preferences and Environment Variables Reference 10-11

 Chapter
Chapter 10:10:Validation
Validation Manager
Manager preferences
preferences

DEFAULT
VALUES
NXRDDV
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VALIDATION_send_envelope_for_override

DESCRIPTION
Determines if validation override notifications are sent via operating system mail or
Teamcenter mail.
VALID
VALUES
TRUE Sends validation override notifications via Teamcenter mail.

FALSE Sends validation override notifications via operating system

mail.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VALIDATION_STYLESHEET_DATASETNAME

DESCRIPTION
Specifies a list of style sheet datasets information. This is a blank separated list
containing the dataset type, reference type name, named reference name, style sheet
file name, and validation result log file extension that is used to match this style sheet
dataset.
For example, the NX Check-Mate result log is in PLM XMLformat with .xml as an
extension. It needs a style sheet (checkmat_log.xsl) for a tool (Internet Explorer for
instance) to display its contents in a pre-defined format.
This preference is also used to import style sheet files into the database as style sheet
datasets during installation or the upgrade (post schema) process.
VALID
VALUES
The format is:
dataset-type dataset-reference-type-name dataset-name stylesheet-name.extension
validation-result-file-extension.
DEFAULT
VALUES
XMLReportFormatter XSL ValidationResultMQCXML checkmate_log.xsl *.xml

10-12 Preferences and Environment Variables Reference PLM00026 11.2

 Validation Manager preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VALIDATION_TIMESTAMP_NREFS

DESCRIPTION
Timestamp on a validation result and dataset is compared to decide whether the
result is up-to-date. The following list is an extension to this logic. The list gives the
Namedref list against each dataset type. For the following dataset types, instead of
the dataset timestamp, the named reference timestamp is used to compare the dates.
VALID
VALUES
TRUE Enables the named reference timestamp.

FALSE Disables the named reference timestamp.

DEFAULT
VALUES
UGMASTER UGPART *.prt
UGPART UGPART *.prt
UGALTREP UGPART *.prt
UGSCENARIO UGPART *.prt
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VALIDATION_unify_itemrev_validation_form_ownership

DESCRIPTION
Determines whether the owner of the Validation Results Summary form and associated
report datasets is changed to the same owner of their associated item revision after its
owner is changed.
VALID
VALUES
true Sets the owner of the Validation Results Summary form and validation report
datasets to the new owner of their associated item revision after the item
revision’s owner is changed.

false Leaves the owner of the Validation Results Summary form and validation
report datasets unchanged following a change in their associated item
revision’s owner.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 10-13

 Chapter
Chapter 10:10:Validation
Validation Manager
Manager preferences
preferences

TC_VALIDATION_ViewValidationWithRuleSetColumnPreferences

DESCRIPTION
Defines the list of property names to be displayed as columns in the View Validation
table.
VALID
VALUES
Accepts string array.
DEFAULT
VALUES
validation_status
validation_target
validation_name
validation_result
override_request_state
result_state_flag
validation_application
validation_user
validation_date
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VALIDATION_ViewValidationWithRuleSetColumnWidthPreferences

DESCRIPTION
Specifies the widths of columns displayed in the View Validation table.
VALID
VALUES
Accepts string array.
DEFAULT
VALUES
20
15
25
10
25
15
15
10
15

DEFAULT
PROTECTION
SCOPE
Site preference.

10-14 Preferences and Environment Variables Reference PLM00026 11.2

 Validation Manager preferences

ValidationAgent_DefaultChildProperties

DESCRIPTION
Determines which properties are children of the ValidationAgent business object.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid Teamcenter
property name.
DEFAULT
VALUES
revision_list
DEFAULT
PROTECTION
SCOPE
Site preference.

ValidationAgentRevision_DefaultChildProperties

DESCRIPTION
Determines which properties are children of the ValidationAgentRevision business
object.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid Teamcenter
property name.
DEFAULT
VALUES
TC_validation_data
DEFAULT
PROTECTION
SCOPE
Site preference.

ValidationAgentRevision_Folder_default_relation

DESCRIPTION
Defines the default relation for creation of a Folder object in context of a
ValidationAgentRevision object.
VALID
VALUES
Accepts a single string as a value. It must be a valid Teamcenter relation business
object.
DEFAULT
VALUES
IMAN_reference
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 10-15

 Chapter
Chapter 10:10:Validation
Validation Manager
Manager preferences
preferences

ValidationAgentRevision_ValData_default_relation

DESCRIPTION
Defines the default relation for creation of a ValData Item object in context of an
ValidationAgentRevision object.
VALID
VALUES
Accepts a single string as a value. It must be a valid Teamcenter relation business
object.
DEFAULT
VALUES
TC_validation_data
DEFAULT
PROTECTION
SCOPE
Site preference.

ValidationMasterFormColumnPreferences

DESCRIPTION
Defines the list of property names to be displayed as columns in the
ValidationMasterForm table.
VALID
VALUES
validation_target
validation_name
validation_application
validation_utility_name
validation_user
validation_date
result_state_flag
validation_result
override_to_state
override_request_state
DEFAULT
VALUES
validation_target
validation_name
validation_result
override_request_state
result_state_flag
validation_application
validation_user
validation_date
DEFAULT
PROTECTION
SCOPE
Site preference.

10-16 Preferences and Environment Variables Reference PLM00026 11.2

 Validation Manager preferences

ValidationMasterFormColumnWidthPreferences

DESCRIPTION
Specifies the widths of the shown columns in the ValidationMasterForm table.
VALID
VALUES
10
25
15
10
10
15
10
10
10
15
DEFAULT
VALUES
15
25
10
25
15
15
10
15

DEFAULT
PROTECTION
SCOPE
Site preference.

ValToolAgentRevision_DefaultChildProperties

DESCRIPTION
Determines which properties are children of the ValToolAgentRevision business
object.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid Teamcenter
property name.
DEFAULT
VALUES
TC_validation_data
TC_validation_tool
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 10-17

 Chapter
Chapter 10:10:Validation
Validation Manager
Manager preferences
preferences

ValToolAgentRevision_Tool_default_relation

DESCRIPTION
Defines the default relation for associating a Tool object in context of a
ValToolAgentRevision object.
VALID
VALUES
Accepts a single string as a value. It must be a valid Teamcenter relation business
object.
DEFAULT
VALUES
TC_validation_tool
DEFAULT
PROTECTION
SCOPE
Site preference.

10-18 Preferences and Environment Variables Reference PLM00026 11.2

Chapter 11: File management and maintenance preferences

Audit Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1

Fnd0FileAccessAuditSec_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
Fnd0LicenseExportAuditSec_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
Fnd0ScheduleAuditSec_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
Fnd0SecurityAudit_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
Fnd0SecurityAudit_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3
Fnd0SecurityAuditSec_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3
Fnd0StructureAuditSec_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4
Fnd0WorkflowAuditSec_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4
TC_audit_disabled_dataset_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5
TC_audit_buffer_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5
TC_audit_delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
TC_audit_display_gmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
TC_audit_file_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
TC_audit_log_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7
TC_audit_manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7
TC_audit_manager_version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-8
TC_audit_number_of_logs_to_load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-9
TC_audit_track_changed_properties_only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-9

Archive, restore, and migration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-9

HSM_integration_enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-9
HSM_read_thru_supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-10
HSM_primary_tier_hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11
HSM_secondary_tier_capacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11
Centera_Cluster_IPAddresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-12
TC_enable_backup_modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-12
TC_Store_and_Forward . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-12
TC_Store_and_Forward_Transfer_Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-13

Action manager daemon preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-14

TC_actionmgrd_sleep_minutes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-14
TC_actionmgrd_general_processing_hours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-14
TC_actionmgrd_max_actions_to_dispatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-15
TC_actionmgrd_max_subprocess_to_start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-15
TC_actionmgrd_cloning_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16

Subscription Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16

TC_subscriptionmgrd_sleep_minutes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16
TC_subscriptionmgrd_processing_hours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-17
TC_subscriptionmgrd_max_subscriptions_to_dispatch . . . . . . . . . . . . . . . . . . . . . . . . 11-18
TC_subscriptionmgrd_cloning_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-18
TC_notification_msg_ext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-18

PLM00026 11.2 Preferences and Environment Variables Reference

Subscription Monitor preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-19
Mail_subscription_notify_sub_groups_too . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-19
SCM_notification_history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-19
SCM_notification_WorkspaceObject_props . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-19
TC_automatic_refresh_list_maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-20
TC_automatic_refresh_time_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-20
TC_automatic_refresh_waiting_time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-20
TC_refresh_notify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-21
TC_refresh_notify_list_maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-21
TC_refresh_notify_pull_time_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-22
TC_refresh_notify_Default Protection Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-22
TC_refresh_notify_subscribe_to_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-23
TC_refresh_notify_timed_out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-23
TC_subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-23
TC_subscription_log_event_and_action_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-24
TcActionColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-24
TcActionColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-25
TcEventColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-25
TcEventColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-26
TcSubscriptionColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-26
TcSubscriptionColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-27
<TypeName>_subscribe_to_events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-27

File caching preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-28

Using file caching preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-28
Caching modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-28
syslog file output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-29
File caching preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-29
blobbyVolume_NT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-29
blobbyVolume_UNX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-29
Default_Transient_Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-30
Default_Transient_Volume_Id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-30
Fms_BootStrap_Urls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-30
FMS_SAF_Batch_Transfer_Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-31
FSC_HOME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-32
IMF_display_full_path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-32
Multisite_Ticket_Expiration_Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-33
TC_Populate_FSC_Server_Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-33
TC_shared_server_metadata_cache_mgr_cloning_interval . . . . . . . . . . . . . . . . . . 11-34
TC_shared_server_metadata_cache_mgr_sleep_minutes . . . . . . . . . . . . . . . . . . . 11-34
TC_STAGING_AREA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-34
TC_System_Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-35
TC_Volume_Failover_Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-35
TC_Volume_Failover_Volume_Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-36
TC_Volume_Failover_Volume_Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-36
TC_VOLUME_MONITOR_CRITICAL_LEVEL . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-36
TC_VOLUME_MONITOR_WARNING_LEVEL . . . . . . . . . . . . . . . . . . . . . . . . . . 11-37
TC_Volume_Status_Resync_Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-37
Ticket_Expiration_Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-38
Transient_Volume_Installation_Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-38

Preferences and Environment Variables Reference PLM00026 11.2

 Transient_Volume_RootDir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-39
UNLOAD_LOGGING_LEVEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-39
UNLOAD_MINIMUM_LIFE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-40
UNLOAD_TRIGGER_CEILING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-40
UNLOAD_TRIGGER_FLOOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-41

Log file preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-42

TC_Administration_Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-42
TC_Security_Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-43
TC_allow_inherited_group_volume_access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-43
TC_Application_Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-44
TC_Installation_Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-44
TC_Journalling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-45
TC_Journal_Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-45
TC_KEEP_SYSTEM_LOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-46
RECOVER_TO_UNRELEASED_STATUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-46
RECOVER_TO_VOLUME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-46
TC_sfr_recovery_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-47
TC_sfr_process_life_time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-47

PLM00026 11.2 Preferences and Environment Variables Reference

Chapter 11: File management and maintenance preferences

Audit Manager preferences

Fnd0FileAccessAuditSec_ColumnPreferences

DESCRIPTION
Specifies the list of columns to be displayed on secondary audit table in Audit Manager
for objects of type Fnd0FileAccessAudit.
VALID
VALUES
Property names from the Fnd0FileAccessAudit type.
DEFAULT
VALUES
object_type
object_name

DEFAULT
PROTECTION
SCOPE
User preference.

Fnd0LicenseExportAuditSec_ColumnPreferences

DESCRIPTION
Specifies that a list of columns be displayed in the secondary audit table for objects of
type Fnd0LicenseExportAudit.
VALID
VALUES
Property names from the Fnd0SecondaryAudit class.
DEFAULT
VALUES
object_string
object_type
object_name
fnd0PrimaryObjectID
sequence_id
fnd0ObjectDisplayName
fnd0PrimaryObjectRevID

DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 11-1

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

Fnd0ScheduleAuditSec_ColumnPreferences

DESCRIPTION
Specifies that a list of columns be displayed in the secondary audit table for objects
of type Fnd0ScheduleAudit.
VALID
VALUES
Property names from the Fnd0SecodnaryAudit class.
DEFAULT
VALUES
object_string
object_type
fnd0Object
object_name
fnd0PrimaryObjectID
sequence_id
fnd0ObjectDisplayName
schedule_tag
schedule_tagDisp
fnd0state
fnd0status
cost
currency
user_id
user_name
role_name
discipline_name
group
groupDisp
role
roleDisp
name
DEFAULT
PROTECTION
SCOPE
User preference.

Fnd0SecurityAudit_ColumnPreferences

DESCRIPTION
Specifies the list of columns be displayed in the secondary audit table in Audit Manager
for Fnd0SecurityAudit objects.
VALID
VALUES
Property names from the Fnd0SecurityAudit type.
DEFAULT
VALUES
fnd0LoggedDate
fnd0Event TypeName
object_type

11-2 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

object_name
fnd0UserId
fnd0GroupName
fnd0RoleName
fnd0SecondaryObjectID
fnd0SecondaryObjectType
fnd0SecondaryObjectName
fnd0SecondaryObjDispName

DEFAULT
PROTECTION
SCOPE
User preference.

Fnd0SecurityAudit_ColumnWidthPreferences

DESCRIPTION
Specifies the widths (in pixels) of the columns specified by the
Fnd0SecurityAudit_ColumnPreferences preference.
VALID
VALUES
Positive integer values.
DEFAULT
VALUES
15
15
15
40
15
15
15
15
15
40
15

DEFAULT
PROTECTION
SCOPE
User preference.

Fnd0SecurityAuditSec_ColumnPreferences

DESCRIPTION
Specifies the list of columns be displayed in the secondary audit table in Audit Manager
for objects of type Fnd0SecurityAudit.
VALID
VALUES
Property names from the Fnd0SecurityAudit class.

PLM00026 11.2 Preferences and Environment Variables Reference 11-3

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

DEFAULT
VALUES
object_string
object_type
object_name
fnd0PrimaryObjectID
sequence_id
fnd0ObjectDisplayName
DEFAULT
PROTECTION
SCOPE
User preference.

Fnd0StructureAuditSec_ColumnPreferences

DESCRIPTION
Specifies that a list of columns be displayed in the secondary audit table for objects
of type Fnd0StructureAudit.
VALID
VALUES
Property names from the Fnd0SecodnaryAudit class.
DEFAULT
VALUES
object_string
object_type
object_name
fnd0PrimaryObjectID
sequence_id
fnd0ObjectDisplayName
fnd0PrimaryObjectRevID
DEFAULT
PROTECTION
SCOPE
User preference.

Fnd0WorkflowAuditSec_ColumnPreferences

DESCRIPTION
Specifies that a list of columns be displayed in the secondary audit table for objects
of type Fnd0WorkflowAudit.
VALID
VALUES
Property names from the Fnd0SecodnaryAudit class.
DEFAULT
VALUES
object_string
object_type
object_name
fnd0PrimaryObjectID
sequence_id

11-4 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

fnd0ObjectDisplayName
fnd0PrimaryObjectRevID

DEFAULT
PROTECTION
SCOPE
User preference.

TC_audit_disabled_dataset_types

DESCRIPTION
Specifies the types of datasets to be excluded from producing read file events. This
applies only to read file events.
VALID
VALUES
The string name of the dataset type to exclude, for example, MSExcelX.
DEFAULT
VALUES
CLIPS
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_audit_buffer_size

Note

This preference is deprecated and will be removed in a future version.

DESCRIPTION
Specifies the size of the buffer that holds the audit records during a session. Once
the buffer size is met, the buffer is written to an external file. This number should be
slightly larger than the number of audited events generated during a typical session.
Thus, flushing the buffer to the external file happens only after exiting the session with
no performance penalty.
VALID
VALUES
A positive integer.
DEFAULT
VALUES
1000
DEFAULT
PROTECTION
SCOPE
Group preference.

PLM00026 11.2 Preferences and Environment Variables Reference 11-5

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

TC_audit_delimiter

Note

This preference is deprecated and will be removed in a future version.

DESCRIPTION
Specifies the delimiter that separates fields of audit records.
This preference is used only for audit files in text format. When importing the audit file
into Microsoft Excel or Access, you must specify the same delimiter as you defined
in this preference.
VALID
VALUES
Multiple characters. Siemens PLM Software recommends a single character is used.
Though a single-character entry is not enforced, some spreadsheet programs such as
Excel do not allow multiple character delimiters.
DEFAULT
VALUES
^
DEFAULT
PROTECTION
SCOPE
Group preference.

TC_audit_display_gmt

Note

This preference is deprecated and will be removed in a future version.

DESCRIPTION
Specifies if the logged dates in audit logs are shown in the GMT time zone.
VALID
VALUES
true Logged dates are in the GMT time zone.
false Logged dates are in the local server time zone.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_audit_file_format

Note

This preference is deprecated and will be removed in a future version.

11-6 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

DESCRIPTION
Specifies the format of external audit files.
VALID
VALUES
0 Text format (.txt).
1 XML format (.xml).
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Group preference.

TC_audit_log_dir

Note

This preference is deprecated and will be removed in a future version.

DESCRIPTION
Specifies the directory where audit log files are stored. If the directory specified by
this preference cannot be created, audit log files are saved to the preference's default
setting.
The TC_LOG environment variable must be defined first before starting a Teamcenter
session.
VALID
VALUES
Single string as a value; must be a valid directory path.
DEFAULT
VALUES
%TC_LOG%\audit
DEFAULT
PROTECTION
SCOPE
Group preference.

TC_audit_manager

DESCRIPTION
Determines auditing behavior.

PLM00026 11.2 Preferences and Environment Variables Reference 11-7

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

VALID
VALUES
ON Enables the Audit Manager application.
Enables full auditing functionality, providing access to out-of-the-box audit saved
search and reports, to the Viewing the Audit Logs dialog box, which allows
you to search and view audit information for the selected Teamcenter object.
If a selected object has a legacy audit file attached, such as workflow history,
the user can access this file by using the View Audit File dialog box from the
Viewing the Audit Logs dialog box.
OFF Disables the Audit Manager application; the application is not compatible with
the legacy file-based functionality.
Enables only the legacy View Audit File dialog box, which displays audit
information for the selected object.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_audit_manager_version

DESCRIPTION
Enables or disables different auditing functionality types.
VALID
VALUES
2 Enables the legacy Audit Manager application.
This legacy application provides access to out-of-the-box auditing reports;
to the Viewing the audit logs dialog box, which allows you to search
audit records, and to the View Audit File dialog box, which displays audit
information for the selected object. If a selected object has a legacy audit file
attached, you can access this file from the Viewing the Audit Logs dialog box.
To enable this legacy audit application, you must also set the value of the
TC_audit_manager preference to ON.
3 Enables the new auditing functionality. You must also set the value of the
TC_audit_manager preference to ON.
This auditing functionality allows you to define audit definitions using the
Business Modeler IDE. You can also view audit logs in the Summary view of
some Teamcenter applications.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

11-8 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

TC_audit_number_of_logs_to_load

DESCRIPTION
Specifies the number of audit logs to load in the Summary view of Teamcenter
applications showing audit logs.
VALID
VALUES
Any integer value.
DEFAULT
VALUES
100
DEFAULT
PROTECTION
SCOPE
User preference.

TC_audit_track_changed_properties_only

Note

This preference is deprecated and will be removed in a future version.

DESCRIPTION
Specifies if audit logs are written when there are no changes to any tracked attribute
value.
This preference applies to the Modify event type only.
VALID
VALUES
True Audit logs are written only when a tracked attribute value changes.

False Audit logs are written irrespective of changes in tracked attribute values.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

Archive, restore, and migration preferences

HSM_integration_enabled

DESCRIPTION
Enables the Volume Management application to work with third-party hierarchical
storage management (HSM) software.

PLM00026 11.2 Preferences and Environment Variables Reference 11-9

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

VALID
VALUES
true Enables the Volume Management application to work with
third-party HSM software.
false Disables the Volume Management application from working
with third-party HSM software.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

HSM_read_thru_supported

DESCRIPTION
Declares whether read access to secondary and tertiary volumes is supported. If your
HSM system or hardware platform does not support read access from secondary and
tertiary volumes, the migrated files are moved to a higher tier to be read. For example,
the IBM Tivoli HSM product does not provide read-through capability, and the EMC
DiskXtender HSM product only provides read-through capability on Windows. In such
situations, use reverse migration to return files to the primary tier. If this preference
is set to false, the system moves the migrated files to a higher tier during the read
operation, then during the next migration, returns the files to the tiers from which
they were retrieved.
Note

This preference requires that the HSM_integration_enabled preference be set

to true.

VALID
VALUES
true Migrated files are not moved to a higher tier during the read
operation.
false Migrated files are moved to a higher tier during the read
operation. The files are returned to the tiers from which they
were stored in subsequent migrations.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

11-10 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

HSM_primary_tier_hosts

DESCRIPTION
Defines the host names on which the primary tier volumes are managed by third-party
HSM software.
Note

HSM migration is applied to the volume files residing on hosts defined by

this preference. The hsm_capacity_alert utility estimates the capacities of
the volumes and uses the values defined in this preference to send e-mail
alerts when the primary tier capacity exceeds alert levels. Volumes residing on
hosts not defined by this preference are ignored for HSM migration and the
hsm_capacity_alert utility.

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid host name on which
primary tier volumes reside. If all primary tier volumes are managed by third-party
HSM software, you can set this preference to ALL rather than listing the individual
host names.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

HSM_secondary_tier_capacity

DESCRIPTION
Sends an e-mail alert when the capacity of the second tier volume reaches capacity.
Set this preference to the estimated capacity level of the second tier volume. Compute
this estimate by totalling all storage capacities of all disks mounted on the secondary
tier.
Note

The hsm_capacity_alert utility estimates the capacities of the volumes and

uses the values defined in this preference to send e-mail alerts when the
secondary tier capacity exceeds alert levels.

VALID
VALUES
Accepts a single string as a value. The value must be the estimated capacity of the
second tier volume. For example:
HSM_secondary_tier_capacity= 16.9
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 11-11

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

Centera_Cluster_IPAddresses

DESCRIPTION
Defines EMC Centera cluster IP addresses applicable for archive/restore operations
on an EMC Centera pool.
VALID
VALUES
Valid EMC Centera cluster IP addresses.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_enable_backup_modes

DESCRIPTION
Determines whether backup functionality is enabled.
The integrated backup and recovery feature facilitates third-party backup systems to
perform online backup, allowing Teamcenter to operate continually. This functionality
focuses on the area of backing up metadata and file, and recovering that data in
different restoration scenarios. To accomplish this, the integrated backup feature
places Teamcenter in different operation modes using the backup_modes utility.
VALID
VALUES
true Enables backup functionality.
false Disables backup functionality.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Store_and_Forward

DESCRIPTION
Determines whether store and forward functionality is enabled, improving upload
performance for remote users. This functionality improves end-user file upload times
from clients by uploading files to a temporary volume. Users can continue to work on
their files from the temporary location. The system moves the files to its final destination
according to administer-defined criteria. Files are accessible to FMS at all times.

11-12 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

Enable this functionality by defining a default local volume (an initial upload volume) for
users or groups and setting this preference to true. When users upload files, the files
are temporarily uploaded to the defined initial FMS volume, returning control to the
user in the client. In the background, the files are transferred to the final destination
volume. This allows you to place an FMS volume on the remote users LAN, ensuring
quick uploads into the FMS of this temporary volume. All file transfers are transparent
to end users.
You can view the status of file transfers from the Dispatcher request administration
console.
By default, the store and forward functionality moves files from the local volume to their
final destination volume one at a time (using the fmstranslator Dispatcher translator).
If you set the FMS_SAF_Batch_Transfer_Enabled preference to true, you can use
the store_and_forward Dispatcher translator to upload files in batch.
VALID
VALUES
true Enables store and forward functionality.
false Disables store and forward functionality by instructing the
system to ignore the default local volume setting, uploading files
directly to the destination volume.
This setting is useful to quickly disable store and forward
functionality. For example, if the scheduler or initial volume at a
site goes offline unexpectedly, you can use this setting to quickly
disable store and forward. The alternative is to alter the initial
volume settings of all impacted users, which is a lengthy task.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
User preference.

TC_Store_and_Forward_Transfer_Delay

DESCRIPTION
Determines (in minutes) how long file transfer is delayed between file upload to the
initial volume and file upload to the final destination volume.
Use this preference to improve performance if you have a large amount of revisions
created, cached, and purged at your site. Because the transfer task does not transfer
purged filed, if numerous file revisions are saved frequently at your site, a delay time
long enough to allow revisions to be purged before the transfer to the final destination
volume reduces network traffic.
For example, consider a site where all user files are automatically saved every 15
minutes, and purged after every third revision. If store and forward functionality is
enabled, and this preference is set to 46, the transfer task activates every 46 minutes,
sees that the revisions have been purged, and does not attempt the transfer. Only files
not purged are transferred to the destination volume, decreasing network traffic.

PLM00026 11.2 Preferences and Environment Variables Reference 11-13

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

VALID
VALUES
Any positive integer.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
All.

Action manager daemon preferences

TC_actionmgrd_sleep_minutes

DESCRIPTION
Defines the number of minutes in the sleep period of the actionmgrd process daemon
between dispatching cycles.
VALID
VALUES
Positive integer up to 1440 (the number of minutes in a 24-hour day).
DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_actionmgrd_general_processing_hours

DESCRIPTION
Allows you to define processing periods for the actionmgrd process daemon at
specified times during a 24-hour day. Use this preference as an alternative to the
TC_actionmgrd_sleep_minutes site preference, which is based upon a continuous
sleep/dispatch cycle.
VALID
VALUES
Set this preference using the following syntax:
time range1(sm, mtd);time range2(sm, mtd);time range3(sm, mtd);
time range
Specifies the time range based on a 24-hour clock, expressed in hours and
minutes.
sm
Specifies the sleep minutes applicable during the defined time range. If omitted,
the value of the TC_actionmgrd_sleep_minutes site preference is used.

11-14 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

mtd
Specifies the maximum number of objects to dispatch. If omitted, the value of the
TC_actionmgrd_max_actions_to_dispatch site preference is used.

For example:
TC_actionmgrd_general_processing_hours=
0:00–7:00;12:00–13:00(1,100);18:00–22:00(,50)

Processing is allowed from midnight to 7 a.m. Because neither sleep minutes nor the
maximum number of objects to dispatch are specified, the values of the applicable
site preferences are used.
Processing is allowed from noon to 1 p.m. Because the sm is defined as 1, the sleep
time of the daemon is for 1 minute during this time. Since the mtd is defined as 100, the
daemon dispatches 100 events after every one minute of sleep during the time range.
Processing is allowed from 6 p.m. to 10 p.m. Because the sm is omitted, the value
of the TC_actionmgrd_sleep_minutes site preference is used. Because the mtd is
defined as 50, the daemon dispatches 50 events every time it processes.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_actionmgrd_max_actions_to_dispatch

DESCRIPTION
Defines how many action events are dispatched every time the actionmgrd process
daemon processes actions events in the queue. Only the action events determined to
be ready for execution are processed.
VALID
VALUES
Positive integer up to 500.
DEFAULT
VALUES
50
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_actionmgrd_max_subprocess_to_start

DESCRIPTION
Defines how many events the actionmgrd process daemon dispatched by creating a
separate subprocess to be run by a workflow action handler. Once the defined number
is exceeded, the daemon does not dispatch any event requiring an action handler
to execute as a separate subprocess.

PLM00026 11.2 Preferences and Environment Variables Reference 11-15

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

VALID
VALUES
Positive integer up to 50.
DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_actionmgrd_cloning_interval

DESCRIPTION
Defines the number of cycles the actionmgrd process daemon completes before
cloning and terminating itself to avoid memory leak problems.
VALID
VALUES
Positive integer from 20 to 200.
DEFAULT
VALUES
100
DEFAULT
PROTECTION
SCOPE
Site preference.

Subscription Manager preferences

TC_subscriptionmgrd_sleep_minutes

DESCRIPTION
Defines the number of minutes in the sleep period of the subscriptionmgrd process
daemon between dispatching cycles.
VALID
VALUES
Positive integer up to 1440 (the number of minutes in a 24-hour day).
DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
Site preference.

11-16 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

TC_subscriptionmgrd_processing_hours

DESCRIPTION
Allows you to define processing periods for the subscriptionmgrd process daemon
at specified times during a 24-hour day. Use this preference as an alternative to
the TC_subscriptionmgrd_sleep_minutes site preference, which is based on a
continuous sleep/dispatch cycle.
VALID
VALUES
Set this preference using the following syntax:
time range1(sm, mtd);time range2(sm, mtd);time range3(sm, mtd);
time range
Specifies the time range based on a 24-hour clock, expressed in hours and
minutes.
sm
Specifies the sleep minutes applicable during the defined time range. If omitted,
the value of the TC_subscriptionmgrd_sleep_minutes site preference is used.
mtd
Specifies the maximum number of objects to dispatch. If omitted, the value of
the TC_subscriptionmgrd_max_subscriptions_to_dispatch site preference
is used.

For example:
TC_actionmgrd_general_processing_hours=
0:00–7:00;12:00–13:00(1,100);18:00–22:00(,50)

Processing is allowed from midnight to 7 a.m. Because neither sleep minutes nor the
maximum number of objects to dispatch are specified, the values of the applicable
site preferences are used.
Processing is allowed from noon to 1 p.m. Because the sm is defined as 1, the sleep
time of the daemon is for 1 minute during this time. Since the mtd is defined as 100, the
daemon dispatches 100 events after every one minute of sleep during the time range.
Processing is allowed from 6 p.m. to 10 p.m. Because the sm is omitted, the value of
the TC_subscriptionmgrd_sleep_minutes site preference is used. Because the mtd
is defined as 50, the daemon dispatches 50 events every time it processes.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 11-17

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

TC_subscriptionmgrd_max_subscriptions_to_dispatch

DESCRIPTION
Defines how many subscriptions the subscriptionmgrd process daemon are
dispatched each time it processes TcObjects (not event objects) queued in the
Teamcenter database.
VALID
VALUES
Positive integer up to 500.
DEFAULT
VALUES
50
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_subscriptionmgrd_cloning_interval

DESCRIPTION
Defines the number of cycles the subscriptionmgrd process daemon completes
before cloning and terminating itself to avoid memory leak problems.
VALID
VALUES
Positive integer from 20 to 200.
DEFAULT
VALUES
100
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_notification_msg_ext

DESCRIPTION
Defines the file type attached with Global Change notification e-mail. The system sends
.tmp files by default, which may be blocked by MS Outlook as potentially harmful files.
VALID
VALUES
Accepts a single string as a value. Must be a valid file type extension.
DEFAULT
VALUES
.tmp
DEFAULT
PROTECTION
SCOPE
Site preference.

11-18 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

Subscription Monitor preferences

Mail_subscription_notify_sub_groups_too

DESCRIPTION
Determines whether to include subgroups in subscription notification.
VALID
VALUES
TRUE Subgroups are included in subscription notification.
FALSE Subgroups are not included in subscription notification.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

SCM_notification_history

DESCRIPTION
Determines whether the notification history record is enabled or disabled.
VALID
VALUES
true Enables notification e-mail.
false Suppresses notification e-mail.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

SCM_notification_WorkspaceObject_props

DESCRIPTION
Defines the default properties to be included in notification e-mails.
VALID
VALUES
Any attributes available in the Teamcenter schema.
DEFAULT
VALUES
object_string
object_type
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 11-19

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

TC_automatic_refresh_list_maximum

DESCRIPTION
Determines the maximum number of the objects the system will refresh at a time. Use
this preference to avoid refreshing a large number of objects at a time and decreasing
performance. This preference is used for tuning refresh notification performance.
VALID
VALUES
Accepts a single string as value. If set to 0 or a negative integer, there is no limit on the
number of objects refreshed at one time.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

TC_automatic_refresh_time_interval

DESCRIPTION
Determines the time interval, in minutes, for performing each automatic refresh.
VALID
VALUES
Accepts a single string as value. Must be a positive integer.
DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
All.

TC_automatic_refresh_waiting_time

DESCRIPTION
Determines the waiting time, in minutes, before the system automatically refreshes
data, upon receiving refresh notification.
VALID
VALUES
Accepts a single string as value. If set to 0 or a negative integer, the system
immediately refreshes the object after receiving refresh notification.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
All.

11-20 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

TC_refresh_notify

DESCRIPTION
Determines whether refresh notification functionality is enabled. Refresh notification
allows users to be notified by the system when objects are changed by other users.
When refresh notification is enabled, users can subscribe to the objects, types, or
events for which they receive refresh notification, view a list of objects that have been
modified by other users and require refresh, and choose which objects to refresh.
For more information about using this functionality once it is enabled, see Teamcenter
Basics.
This preference is used in conjunction with the TC_refresh_notify_scope preference.
Note

The Subscription Manager daemon (subscriptionmgrd) must be run to clean

up subscriptions and events that become invalid due to unexpected session
terminations.
For more information about this daemon, see Subscription Monitor.

VALID
VALUES
ON Enables refresh notification functionality.

OFF Suppresses refresh notification functionality.

DEFAULT
VALUES
OFF
DEFAULT
PROTECTION
SCOPE
All.

TC_refresh_notify_list_maximum

DESCRIPTION
Determines the maximum number of objects contained in the refresh notification list.
Limiting the number of objects postpones processing the events of less important
objects. Use this preference for tuning refresh notification performance.
VALID
VALUES
Accepts a single string as value. If set to 0, a negative integer, or not set, there is no
restriction on the number of objects sent to the refresh notification list.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 11-21

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

TC_refresh_notify_pull_time_interval

DESCRIPTION
Determines how often, in minutes, the system automatically performs refresh
notification. (Users can manually invoke this functionality using the Refresh
Notification dialog box at any time.)
VALID
VALUES
Accepts a single string as value. Must be a positive integer.
DEFAULT
VALUES
15
DEFAULT
PROTECTION
SCOPE
All.

TC_refresh_notify_Default Protection Scope

DESCRIPTION
Determines at what level (site, group, or role) refresh notification functionality is
enabled. For example, if the value is set to Group, refresh notification is enabled at
the group level. Members of the group can enable/disable this functionality. If setting
this preference to Role or Group, your current group/role logon determines which
group and role are affected.
This preference is used in conjunction with the TC_refresh_notify preference.
Refresh notification allows users to be notified by the system when objects are
changed by other users. When refresh notification is enabled, users can subscribe
to the objects, types, or events for which they receive refresh notification, view a list
of objects that have been modified by other users and require refresh, and choose
which objects to refresh.
VALID
VALUES
User All users can enable/disable this functionality.
Role Role members can enable/disable this functionality.
Group Group members can enable/disable this functionality.
Site Site administrators can enable/disable this functionality.
DEFAULT
VALUES
User
DEFAULT
PROTECTION
SCOPE
Site preference.

11-22 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

TC_refresh_notify_subscribe_to_types

DESCRIPTION
Defines which types can be selected for refresh notification. Refresh notification can
then be performed upon objects belonging to the specified types. For example, items
and item revisions.
Refresh notification allows users to be notified by the system when objects are
changed by other users. When refresh notification is enabled, users can subscribe
to the objects, types, or events for which they receive refresh notification, view a list
of objects that have been modified by other users and require refresh, and choose
which objects to refresh.
This preference is used in conjunction with the TypeName_subscribe_to_events
preference.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter type.
For example:
Item
ItemRevision
Child types do not automatically inherit refresh notification from parent types.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

TC_refresh_notify_timed_out

DESCRIPTION
Determines the time interval, in minutes, during which transient session subscriptions
are valid after a user’s session is timed out.
VALID
VALUES
Accepts a single string as value. Must be a positive integer.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_subscription

DESCRIPTION
Enables or suppresses subscription functionality.

PLM00026 11.2 Preferences and Environment Variables Reference 11-23

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

VALID
VALUES
ON Enables subscription functionality.
OFF Suppresses subscription functionality.
DEFAULT
VALUES
OFF
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_subscription_log_event_and_action_status

DESCRIPTION
Determines whether to log the status of TcEvent and TcAction objects via the
subscriptionmgrd and actionmgrd process daemons.
VALID
VALUES
ON The subscriptionmgrd process daemon logs the status of each TcEvent
object that it processes. The actionmgrd process daemon logs the status of
each TcAction object that it processes.
OFF Neither process daemon logs the status of their respective objects as they
are processed.
DEFAULT
VALUES
OFF
DEFAULT
PROTECTION
SCOPE
Site preference.

TcActionColumnPreferences

DESCRIPTION
Specifies the columns displayed in the action table.
VALID
VALUES
Any attributes available in the Teamcenter schema; though only attributes belonging to
the following classes yield pertinent results:
EventTypeMapping
TcAction
TcEvent
TcEventType
TcSubscription

DEFAULT
VALUES
Default values include:

11-24 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

objectstr_of_target
target_object_type_name
eventtype_id
subscriber
event_initiator
event_time
handler_parameters
execution_time
retries_togo

DEFAULT
PROTECTION
SCOPE
All.

TcActionColumnWidthPreferences

DESCRIPTION
Specifies the column widths displayed in the action table.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the TcActionColumnPreferences user preference, and so on.
DEFAULT
VALUES
30
15
15
15
15
15
30
15
15
DEFAULT
PROTECTION
SCOPE
User preference.

TcEventColumnPreferences

DESCRIPTION
Specifies the columns displayed in the event table.
VALID
VALUES
Any attributes available in the Teamcenter schema; though only attributes belonging to
the following classes yield pertinent results:
EventTypeMapping
TcAction

PLM00026 11.2 Preferences and Environment Variables Reference 11-25

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

TcEvent
TcEventType
TcSubscription

DEFAULT
VALUES
objectstr_of_target
target_object_type
event_type
event_initiator
event_time

DEFAULT
PROTECTION
SCOPE
All.

TcEventColumnWidthPreferences

DESCRIPTION
Specifies the column widths displayed in the event table.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the TcEventColumnPreferences user preference, and so forth.
DEFAULT
VALUES
30
15
15
15
15
DEFAULT
PROTECTION
SCOPE
All.

TcSubscriptionColumnPreferences

DESCRIPTION
Specifies the columns displayed in the subscription table.
VALID
VALUES
Any attributes available in the Teamcenter schema.
DEFAULT
VALUES
target
object_type
subscriber

11-26 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

event_type
handler_parameters
expiration_date
execution_time
DEFAULT
PROTECTION
SCOPE
All.

TcSubscriptionColumnWidthPreferences

DESCRIPTION
Specifies the column widths displayed in the subscription table.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the TcSubscriptionColumnPreferences user preference, and so on.
DEFAULT
VALUES
30
15
15
30
15
15
DEFAULT
PROTECTION
SCOPE
All.

<TypeName>_subscribe_to_events

DESCRIPTION
Defines the list of events for which refresh notification is sent, whenever those events
occur on the objects of the specified type. (Which types available for refresh notification
are defined via the TC_refresh_notify_subscribe_to_types preference.) You must
create a separate preference for each Teamcenter type eligible for refresh notification;
the values of each preference define the events for which refresh notification is sent.
Refresh notification allows users to be notified by the system when objects are
changed by other users. When refresh notification is enabled, users can subscribe
to the objects, types, or events for which they receive refresh notification, view a list
of objects that have been modified by other users and require refresh, and choose
which objects to refresh.
VALID
VALUES
Accepts multiple preferences, each preference beginning with a valid Teamcenter type
name where the TypeName portion of each preference name must correspond with a
type name defined in the TC_refresh_notify_subscribe_to_types preference. The

PLM00026 11.2 Preferences and Environment Variables Reference 11-27

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

TC_refresh_notify_subscribe_to_types preference defines which types can be

selected for refresh notification.
Accepts multiple strings as values, each string must be a valid event type.
For example:
Item_subscribe_to_events=
__Modify
__Check_In
ItemRevision_subscribe_to_events=
__Modify
__Check_Out
__Delete
DEFAULT
VALUES
None. If no TypeName_subscribe_to_events preferences are created, it is
assumed that Modify is the only event type tracked for the types defined in the
TC_refresh_notify_subscribe_to_types preference.
DEFAULT
PROTECTION
SCOPE
All.

File caching preferences

Using file caching preferences

File caching improves performance when accessing files in Teamcenter volumes over a WAN by
reducing the number of times a file needs to be copied to the user's local machine. File caching is
intended to improve performance for users working on the same parts/assemblies over multiple
sessions. For optimal performance, Siemens PLM Software recommends that the file cache be on
the local machine in order to avoid performance degradation caused by network traffic.
File caching is only intended to work with certain files, such as NX-related files and JT files transferred
to the client.
The first time a file is accessed from a volume it is locally cached based on the settings of the file
caching preferences. Once a file is cached, all further read access to that file takes place from
the cache instead of the volume. The files placed into the cache are owned by the user and have
read-only access.

Caching modes
There are two different access modes: socket mode and NFS mode.
Socket mode
The first time a file is accessed in socket mode the performance should be the same as if caching
was not enabled. However, subsequent attempts to access the file should show improved
performance. The degree of improvement depends on the network involved.

11-28 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

NFS mode
The first time a file is accessed when file caching is enabled in NFS mode, there is some
degradation of performance due to the file being copied into the cache. However, the performance
during subsequent attempts to access the file should be improved, because the file is now being
accessed locally. The degree of improvement depends on the network involved.

syslog file output

When file caching is enabled, the following information is output to the syslog file:
• The current size of files in the cache at startup.
• The read/write status of the cache.
• The size of the cache if the maximum cache size has been exceeded. Once the cache has
exceeded its size limit, no additional files are written to the cache.
• A message regarding the failure to place files in cache is reported from the IMF_export function.
This message includes the file access method used in lieu of placing the files in the cache.

File caching preferences

blobbyVolume_NT

DESCRIPTION
Specifies an alternate volume location on a Windows platform, allowing for constant
Teamcenter availability during hot backup.
VALID
VALUES
Accepts a single string as a value. Must be a valid volume location. Maximum
character length of the string is 15 characters. For example:
c:\temp
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

blobbyVolume_UNX

DESCRIPTION
Specifies an alternate volume location on a UNIX platform, allowing for constant
Teamcenter availability during hot backup.
VALID
VALUES
Accepts a single string as a value. Must be a valid volume location. Maximum
character length of a string is 15 characters. For example:
/tmp

PLM00026 11.2 Preferences and Environment Variables Reference 11-29

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Default_Transient_Server

DESCRIPTION
Specifies the default transient file server location. Environment variable settings
override this FCC configuration file setting.
VALID
VALUES
Accepts a single value. Must be a valid transient file server location. For example:
Default_Transient_Serrver=
http://www.transientserver.com
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Default_Transient_Volume_Id

DESCRIPTION
Defines the corporate server transient volume. This preference must be defined to
enable transfer of multi-site export metadata from site to site when running in a two-tier
environment.
VALID
VALUES
Accepts a single value. Must be a valid transient volume ID.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

Fms_BootStrap_Urls

DESCRIPTION
Determines which FMS server cache manages file downloads. When searching for
an assigned FMS server cache to manage file downloads, the thin client contacts
the FSC servers defined in this preference in the order listed. The server responds
with the FSC server assigned to the thin client, and all subsequent communication

11-30 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

is with that assigned server cache. Environment variable settings override this FCC
configuration file setting.
If there is only the thin client and one FSC server in the network, you must select this
option. Each Teamcenter network must have at least one server listed in the this
preference for thin client use.
For failover purposes, you can include multiple servers. Ensure that you include
all of the FSC addresses that support the failover volumes. Also add the FSCs to
the FMS_HOME\fcc.xml file as priority 0 so that you can get a connection and
automatically pick up the server as long as one of the FSCs is up and running in
the configuration.
Note

This preference can be set using the preference name as an environment

variable.

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid server location. For
example:
Fms_BootStrap_Urls=
http://abc.com
http://def.com:4040
http://ghi.com
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

FMS_SAF_Batch_Transfer_Enabled

DESCRIPTION
Enables FMS Store and Forward in batch transfer mode.
Store and forward functionality can be implemented by two different methods:
• Single file: moves and cleans up files from the local volume one file at a time.
This method uses dispatcher functionality.

• Batch method: queries the Teamcenter database all of the user’s files stored in
local volumes and transfers them to their specified destination volumes.
This method combines move_volume_files utility and dispatcher functionality.

Store and forward functionality defines default local volumes to be temporary local
volumes that allow files to be stored locally before they are automatically transferred to
the final destination volume. This improves end-user file upload times from clients by
uploading files to a temporary volume.

PLM00026 11.2 Preferences and Environment Variables Reference 11-31

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

Store and forward functionality requires installation of dispatcher scheduler, module,

client and the store_and_forward translator.
VALID
VALUES
True Enables store and forward functionality in batch mode.
Note

This requires installation of dispatcher scheduler, module, client and

the store_and_forward translator.

False Disables store and forward functionality in batch mode.

DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

FSC_HOME

DESCRIPTION
Specifies the location of the as-installed code, including the fsc.cfg and bin files.
Environment variable settings override this FSC configuration file setting.
VALID
VALUES
Accepts a single value. Must be a valid Teamcenter directory.
DEFAULT
VALUES
Value set during installation.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMF_display_full_path

DESCRIPTION
Determines whether the full path of a file in a Teamcenter volume appears in rich
client applications.
For example, when clicking the Print button in the Dataset Properties dialog box,
this preference determines whether the References properties display the full path to
the Teamcenter volume in which the dataset is stored.
VALID
VALUES
TRUE Displays the full path of a file in a Teamcenter volume in rich
client applications.
FALSE Disables the display of the full path of a file in a Teamcenter
volume in rich client applications.

11-32 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

DEFAULT
VALUES
FALSE
By default, this preference is not listed in the preferences.xml file. If you do not add
this preference to the file, the default value applies.
DEFAULT
PROTECTION
SCOPE
Site preference.

Multisite_Ticket_Expiration_Interval

DESCRIPTION
Specifies how long, in seconds, the ticket is good for access. Add this value to the
current time when the ticket is generated to calculate the ticket expiration time.
Environment variable settings override this FCC configuration file setting.
VALID
VALUES
Single positive integer.
DEFAULT
VALUES
259200 seconds (72 hours)
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Populate_FSC_Server_Targets

DESCRIPTION
Based on the preference value the exporting site decides to populate the files to the
specific file server cache (FSC) specified by the URL. Multi-Site features use a default
populate target FSC ID for populating files that can be overridden by this preference.
The exporting site interrogates the importing site for the this preference.
VALID
VALUES
A character string representing the FSCID, for example:
FSC_tri6w035_nox
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
Precaching data is supported only within an enterprise and only on the FSCs defined
in the local FMSMaster.xml file (in the FSC_HOME directory).

PLM00026 11.2 Preferences and Environment Variables Reference 11-33

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

TC_shared_server_metadata_cache_mgr_cloning_interval

DESCRIPTION
Defines the cloning interval in minutes for the Shared Cache Manager Service
(SCMS). The default value is 100 minutes. The service is restarted after this interval
on an ongoing basis.
When you create new types, property descriptors or constants in Business Modeler
IDE, the changes made to the metadata in running Teamcenter servers must be
synchronized with the database. The synchronization is accomplished by the
shared_server_metadata_cache_mgr executable. This executable runs as a service
on Windows and as a daemon on UNIX. By default, the service/daemon starts
automatically.
VALID
VALUES
Any value in minutes.
DEFAULT
VALUES
100
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_shared_server_metadata_cache_mgr_sleep_minutes

DESCRIPTION
Defines the sleep time in minutes for the Shared Cache Manager Service (SCMS).
The default value is 10 minutes.
This preference is used by the shared_server_metadata_cache_mgr service to
check for shared server cache updates.
VALID
VALUES
Any value in minutes.
DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_STAGING_AREA

DESCRIPTION
Defines the temporary directory for storing data when using the object_recover utility.
If this preference is not set, the current working directory is used.
VALID
VALUES
Single string as value; each string must be the full operating system path of the
directory.

11-34 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_System_Logging

DESCRIPTION
Enables or suppresses system logging for the entire site. System logging creates a
record of global system events such as object releases.
Note

This preference is deprecated as of Teamcenter 11.2. You can still use the
TC_SYSTEM_LOGGING environment variable to set logging.

VALID
VALUES
ON Enables system logging.
OFF Suppresses system logging.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Volume_Failover_Trigger

DESCRIPTION
Specifies the percentage full a volume must reach to trigger volume failover behavior
for importing files. When volume capacity reaches the percentage full specified by
this preference, importing files are directed to the failover volume specified by the
TC_Volume_Failover_Volume_Name preference.
This preference setting is used by the system only when the
TC_Volume_Failover_Volume_Name preference is set.
VALID
VALUES
Accepts a single float value, from 0–100.
Siemens PLM Software recommends setting this preference between 80 and 95.
Setting this value too low triggers failover behavior too often. Setting this value too
high prevents failover behavior from initiating.
DEFAULT
VALUES
90.0

PLM00026 11.2 Preferences and Environment Variables Reference 11-35

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Volume_Failover_Volume_Map

DESCRIPTION
Specifies a mapping of failover (alternate) volumes. This preference can be used when
a volume is marked as read-only or is otherwise inaccessible for write operations.
Specifying the alternate volume using this preference ensures that future write
operations are done to the alternate volume.
VALID
VALUES
Accepts a single string as a value. The string must include valid volume names. Each
value should be of the form:
source-volume:destination-volume
The mappings can be cascaded such that an entry of the form VolA:VolB and
VolB:VolC indicates that the system should use VolC when VolA is the current volume.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Volume_Failover_Volume_Name

DESCRIPTION
Specifies the volume to use in failover situations during file import. Setting this
preference with a volume name prompts the system to check the original target
volume before import. If the target volume is filled beyond the capacity specified by
the TC_Volume_Failover_Trigger preference, the imported file is directed to the
failover volume specified by this preference.
VALID
VALUES
Accepts a single string as a value; the string must be a valid volume name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VOLUME_MONITOR_CRITICAL_LEVEL

DESCRIPTION
Specifies the percentage full a volume must reach to achieve critical level.

11-36 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

When a volume's capacity reaches critical level, its volume data is colored red in the
Volume Monitor view of the Volume Management perspective. Additionally, such
volumes display when filtering the table tree to list only volumes with a severity of
Critical.
VALID
VALUES
Accepts a single value between 1 and 99, inclusive. The value must be greater than
the value set for the TC_VOLUME_MONITOR_WARNING_LEVEL preference.
DEFAULT
VALUES
90
DEFAULT
PROTECTION
SCOPE
All.

TC_VOLUME_MONITOR_WARNING_LEVEL

DESCRIPTION
Specifies the percentage full a volume must reach to achieve warning level.
When a volume's capacity reaches warning level, its volume data is colored yellow
in the Volume Monitor view of the Volume Management perspective. Additionally,
such volumes display when filtering the table tree to list only volumes with a severity of
Warning.
VALID
VALUES
Accepts a single value between 1 and 99, inclusive. The value must be less than the
value set for the TC_VOLUME_MONITOR_CRITICAL_LEVEL preference.
DEFAULT
VALUES
80
DEFAULT
PROTECTION
SCOPE
All.

TC_Volume_Status_Resync_Interval

DESCRIPTION
Indicates the minimum amount of time (in seconds) that must pass before the
percentage full value of a volume is retrieved from the FSC. The percentage full values
are cached to prevent excessive FSC requests.
The system only checks for this cached value during file import, and only
when volume failover during file import behavior is enabled by setting the
TC_Volume_Failover_Volume_Name preference.
VALID
VALUES
Accepts a single positive integer as a value.

PLM00026 11.2 Preferences and Environment Variables Reference 11-37

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

Siemens PLM Software recommends keeping this setting similar to the default value.
Setting this value too high causes the cached percentage full value to be out of date.
Setting this value too low generates excessive FSC requests.
DEFAULT
VALUES
600
DEFAULT
PROTECTION
SCOPE
Site preference.

Ticket_Expiration_Interval

DESCRIPTION
Specifies how long, in seconds, the ticket is good for access. Add this value to the
current time when the ticket is generated to calculate the ticket expiration time.
Environment variable settings override this FCC configuration file setting.
VALID
VALUES
Single positive integer.
DEFAULT
VALUES
28800 seconds (8 hours)
DEFAULT
PROTECTION
SCOPE
Site preference.

Transient_Volume_Installation_Location

DESCRIPTION
Specifies the node name of the transient volume. It is a location-based logical identifier,
and is generally set to the host name of the local machine by the tc_profilevars
script. When a four-tier transient volume is mounted on all Teamcenter server hosts at
a given location, use this setting to configure the distributed transient volume. The
environment variable of the same name overrides this preference setting.
VALID
VALUES
Accepts a single value. It must be a valid host name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

11-38 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

Transient_Volume_RootDir

DESCRIPTION
Specifies the transient volume's root directory. This preference accepts multiple values
to support a UNIX/Windows heterogeneous site. FMS takes the first value which is
valid for the platform, UNIX or Windows; the validity check is simply the presence or
absence of a backslash (\) character. Environment variable settings override this
FCC configuration file setting.
Transient volumes are file locations to which TcServer processes have direct access.
These locations are typically used for server side file generation operations such as
PLM XML files. Files within transient volumes are typically generated by the TcServer,
read by a client (usually) once, then deleted.
This preference is set during the initial database population. Its value should not
be changed, even if several other Teamcenter installations point to the same
pre-populated database.
VALID
VALUES
Accepts multiple values, in order to support a UNIX/Windows heterogeneous site.
For example:
Transient_Volume_RootDir=
C:\temp
/tmp

Caution

You cannot define the path as a UNC path, for example,

\\server\shared-transient-folder. You must use a direct path
location.
This is partly due to the fact that some ZIP archive utilities do not accept UNC
paths, resulting in failure of exports to Microsoft Excel or Word.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

UNLOAD_LOGGING_LEVEL

DESCRIPTION
Determines the level of detail logged in the in-session and end-session reports sent to
the .unloadlog log file.
VALID
VALUES
0 No log file is created.

PLM00026 11.2 Preferences and Environment Variables Reference 11-39

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

1 In-session report includes number of cache objects and unload

time. End session report includes total number of objects
unloaded and the average unload time.
2 In-session report includes all information from a level 1 report,
as well as memory usage before and after loading. End-session
report includes all information from a level 1 report.
3 In-session report includes all information from a level 2 report,
as well as callback information. End-session report includes
all information from a level 2 report, as well summary unload
reports by type.
4 In-session report includes all information from a level 3 report,
as well object types loaded and unloaded from the cache.
End-session report includes all information from a level 3 report.
Setting this preference to 1 through 4 does not produce a log file unless the FCC
is restarted on the client, for example:
FMS_HOME\bin\fccstat -restart
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
All.

UNLOAD_MINIMUM_LIFE

DESCRIPTION
Determines which unused objects are qualified for memory cleanup, based on when
objects were last accessed.
VALID
VALUES
Accepts any positive integer. The value specifies (in seconds) when an object must
have been last accessed to be qualified for memory cleanup. Objects accessed more
recently than the specified value are not removed from server memory.
DEFAULT
VALUES
1800
DEFAULT
PROTECTION
SCOPE
All.

UNLOAD_TRIGGER_CEILING

DESCRIPTION
Initiates the automatic cleanup of unused objects from the server memory. Specifies
(in kilobytes) what memory size must be reached to initiate the unloading of unused
objects from server memory.

11-40 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

Automatic cleanup is performed during the operation occurring after the specified
ceiling is reached. Thus, the specified memory size might be exceeded if the final
loading action uploads a large amount of data.
For example, if this preference is set to 12000 and memory consumption is at 11900
KB, at least one more load operation is required before the ceiling is reached. If the
next load operation adds a large amount of data, such as 20000 KB, total memory
consumption is 31900 KB when the automatic cleanup begins.
Note

Automatic cleanup of unused objects is enabled by default. This cleanup

alleviates increased memory issues.

Setting the value very low reduces the memory server footprint, but decreases
performance.
VALID
VALUES
Accepts any positive integer. The number must be higher than the value set for the
UNLOAD_TRIGGER_FLOOR preference. If an invalid value is set, the default value
is used. Invalid values are:
• A negative number

• A number lower than the value set for the UNLOAD_TRIGGER_FLOOR

preference

• Non-numerical characters

Setting the value very low reduces the memory server footprint but decreases
performance because most loaded objects are quickly unloaded, and when reloaded,
must be unloaded again.
DEFAULT
VALUES
12000
DEFAULT
PROTECTION
SCOPE
All.

UNLOAD_TRIGGER_FLOOR

DESCRIPTION
Stops the automatic cleanup of unused objects from the server memory. Specifies (in
kilobytes) what memory size must be reached to stop the unloading of unused objects
from server memory after memory cleanup has begun.
Automatic cleanup continues until the memory size specified by this preference is
achieved. However, if the total size of ummovable object exceeds the floor amount,
the specified memory size is not reached.
For example, if objects cannot be removed because their life span does not meet
the requirements specified by the UNLOAD_MINIMUM_LIFE preference, and the

PLM00026 11.2 Preferences and Environment Variables Reference 11-41

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

memory space consumed by these objects exceed the specified floor size, the
specified memory size is not reached.
Note

Automatic cleanup of unused objects is enabled by default. This cleanup

alleviates increased memory issues.

Determining the optimum value for this preference requires investigation, and possibly
experimentation in a working environment.
VALID
VALUES
Accepts any positive integer. The number must be higher than the value set for the
UNLOAD_TRIGGER_CEILING preference. If an invalid value is set, the default value
is used. Invalid values are:
• A negative number

• A number lower than the value set for the UNLOAD_TRIGGER_CEILING

preference

• Non-numerical characters
DEFAULT
VALUES
5000
DEFAULT
PROTECTION
SCOPE
All.

Log file preferences

TC_Administration_Logging

DESCRIPTION
Enables or suppresses administration logging for the entire site. Administration logging
creates a record of Teamcenter system administration activities such as creating new
users, volumes, and so forth.
Note

This preference can be set using the preference name as an environment

variable.
This preference is deprecated as of Teamcenter 11.2. You can still use the
TC_ADMINISTRATION_LOGGING environment variable to set logging.

VALID
VALUES
ON Enables administrative logging.
OFF Suppresses administrative logging.

11-42 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Security_Logging

DESCRIPTION
Enables or suppresses security logging for the entire site. Security logging creates
a record of invalid access of Teamcenter objects and writes the data to the
$TC_LOG/security.log file. Enabling security logging also requires creating a file
named security.log in the TC_DATA directory. The system first checks for the
existence of this file; if it exists, it checks the value of this preference. If set to ON,
security logging is enabled.

Note

This preference can be set using the preference name as an environment

variable.
This preference is deprecated as of Teamcenter 11.2. You can still use the
TC_SECURITY_LOGGING environment variable to set logging.

VALID
VALUES
ON Enables security logging.

OFF Suppresses security logging.

DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_allow_inherited_group_volume_access

DESCRIPTION
Allows a group to inherit access to a Teamcenter volume from its parent group. That is,
if a group is explicitly granted volume access, and this preference is set to a nonzero
number, that group's subgroups (and the subgroup’s children) are implicitly granted
access to that volume.

Note

Inherited access applies to all volumes including default local volumes, also
known as store and forward volumes.

PLM00026 11.2 Preferences and Environment Variables Reference 11-43

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

VALID
VALUES
0 Does not allow groups to inherit access to a volume from its parent group.
Single Allows groups to inherit access to a volume from its parent group.
positive
integer
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Application_Logging

DESCRIPTION
Enables or suppresses application logging for the entire site. Application log files are
records of events for applications such as My Teamcenter, Structure Manager, or any
Teamcenter utility. These files are stored in the $TC_TMP_DIR directory.
Note

This preference can be set using the preference name as an environment

variable.
This preference is deprecated as of Teamcenter 11.2. You can still use the
TC_APPLICATION_LOGGING environment variable to set logging.

VALID
VALUES
ON Enables application logging.
OFF Suppresses application logging.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
User preference.

TC_Installation_Logging

DESCRIPTION
Enables or suppresses installation logging for the entire site. Contains a record of
activities performed by the Teamcenter Environment Manager installation program.
This log file is in the install directory under the application root directory. The date-time
stamp represents the date and time Teamcenter Environment Manager was run. For
example, install0522241627.log indicates that Teamcenter Environment Manager
was run at 4:27 on February 24, 2005.

11-44 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

Note

This preference can be set using the preference name as an environment

variable.
This preference is deprecated as of Teamcenter 11.2. You can still use the
TC_INSTALLATION_LOGGING environment variable to set logging.

VALID
VALUES
ON Enables installation logging.
OFF Suppresses installation logging.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Journalling

DESCRIPTION
Determines whether calls to the ITK are logged in journal files. The data is written
to the program.jnl file.
Note

This preference can be set using the preference name as an environment

variable.

VALID
VALUES
ON Enables journalling.
OFF Suppresses journalling.
DEFAULT
VALUES
OFF
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Journal_Modules

DESCRIPTION
Determines which Teamcenter modules create application journal files when the
TC_Journalling preference is set to On.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter application
module.

PLM00026 11.2 Preferences and Environment Variables Reference 11-45

 Chapter
Chapter 11:11:File management
File management and maintenance
and maintenance preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_KEEP_SYSTEM_LOG

DESCRIPTION
Determines whether to retain new system log files if they do not contain errors.
VALID
VALUES
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

RECOVER_TO_UNRELEASED_STATUS

DESCRIPTION
Enables or suppresses recovering released objects to unreleased status when using
the object_recover utility.
VALID
VALUES
YES Released objects are not recovered.
NO Released object is recovered from the backup metafile
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

RECOVER_TO_VOLUME

DESCRIPTION
Determines which volume receives restored data when using the object_recover
utility. If this preference is not set, all recovered objects are stored to the current
active volume.
VALID
VALUES
Accepts a single string as a value. Must be a valid Teamcenter volume.
DEFAULT
VALUES
None.

11-46 Preferences and Environment Variables Reference PLM00026 11.2

 File management and maintenance preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_sfr_recovery_interval

DESCRIPTION
Specifies (in seconds) how often the system checks for recovered files after a
user-initiated single file recovery action is activated. This preference is used for single
file recovery.
VALID
VALUES
Accepts a single string as a value. Must be a positive integer.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_sfr_process_life_time

DESCRIPTION
Specifies (in minutes) how long the system continues to check for recovered files after
a user-initiated single file recovery action is activated.
VALID
VALUES
Accepts a single string as a value. Must be a positive integer.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 11-47

Chapter 12: Client preferences

Rich client preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1

AE_dataset_default_keep_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
AI_ignore_ic_flag_setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
AI_Incremental_Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-2
AI_request_no_dependancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-2
Allow_Copy_As_Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3
Attachment_Alias_File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4
browserWindowMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4
CCCompositionTypesPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5
CCObject_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5
copyPasteChunkNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5
Create_WorkspaceObject_mru_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-6
Create_WorkspaceObject_mru_max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-6
<dataset_name>.FORM_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-7
<dataset_name>.CREATE_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-7
<dataset_name>.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-8
<dataset_name>.SAVEAS_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-9
<dataset_name>.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-10
Dataset_Alias_File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-10
DATASET_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-11
DATASET_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-12
DATASET_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-12
DATASET_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-13
DATASETTYPE_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-13
DATASETTYPE_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-14
DATASETTYPE_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-14
DATASETTYPE_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-15
DatasetTypesPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-15
defaultViewerConfig.VIEWERCONFIG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-15
Design Revision_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-17
DRAG_AND_DROP_Default_dataset_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-18
DRAG_AND_DROP_file_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-18
DRAG_AND_DROP_SWING_dialog_enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-19
Enable_thumbnails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-19
FLColumnCatIVFSeparatorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-20
FLColumnCatObjSeparatorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-20
FOLDER_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-20
FOLDER_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-21
FOLDER_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-21
FOLDER_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-22
FORM_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-22
FORM_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-23
FORM_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-23

PLM00026 11.2 Preferences and Environment Variables Reference

 FORM_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-24
FormTypesPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-25
GROUP_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-25
GROUP_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-25
GROUP_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-26
GROUP_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-26
HiddenPerspectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-26
HistoryIDList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-28
HistoryMax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-28
HistoryTitleList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-29
HistoryTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-29
IDCAttachmentColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-29
IDCStructureColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-30
IdentifierContextTypeDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-30
IdentifierTypeDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-31
IMAN_3D_snap_shot_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-31
IMAN_customization_libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-31
IMAN_FLASH_FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-32
IMANFILE_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-32
IMANFILE_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-33
IMANFILE_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-33
IMANFILE_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-34
IMANTYPE_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-34
IMANTYPE_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-35
IMANVOLUME_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-35
IMANVOLUME_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-36
IMANVOLUME_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-36
IMANVOLUME_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-37
ImpactAnalysisViewWhereUsedBatchSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-37
Item_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-37
Item_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-38
Item_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-38
<Item>.FilterCriteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-39
ITEM_first_rev_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-39
ITEM_id_postfix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-40
ITEM_id_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-40
ITEM_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-41
ITEM_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-41
ITEM_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-42
ITEM_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-42
<Item>.SUMMARYRENDERING2007 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-43
<ItemRevision>.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-43
<ItemRevision1>_<ItemRevision2>_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . 12-44
<ItemRevision>.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-44
ItemRevision_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-45
ITEMREVISION_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-45
ITEMREVISION_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-46
ITEMREVISION_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-47
ITEMREVISION_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-47

Preferences and Environment Variables Reference PLM00026 11.2

 ItemRevision_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-48
ItemRevision_thumbnail_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-48
ItemRevision_thumbnail_references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-49
Item_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-49
ITEM_smart_baseline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-50
<Item type>_rev_display_all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-50
<Item type>_rev_display_order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-51
<Item type>_rev_display_rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-51
JTTreeTableColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-52
JTTreeTableShownColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-53
MECollaborationContext_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-53
MEOPRevision_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-53
MEProcessRevision_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-54
Multiple_revise_dialog_visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-54
MyTeamcenterQuickLinksSection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-55
OpenAfterCreatePref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-55
PERSON_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-55
PERSON_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-56
PERSON_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-56
PERSON_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-57
PSBOMVIEW_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-57
PSBOMVIEW_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-58
PSBOMVIEW_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-58
PSBOMVIEW_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-59
PSBOMVIEWREVISION_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-59
PSBOMVIEWREVISION_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-60
PSBOMVIEWREVISION_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-61
PSBOMVIEWREVISION_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-61
QuickLinksSection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-62
ReferencersPane_Shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-62
RESERVATION_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-62
RESERVATION_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-63
RESERVATION_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-63
RESERVATION_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-64
Revision_Name_Based_On_ItemRevision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-65
Selection Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-65
Select IR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-65
Structure_Alias_File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-66
TC_AE_<datasettype>_Default_View_Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-67
TC_Allow_Longer_ID_Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-67
TC_Auto_Checkout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-67
TC_auto_delete_folder_references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-68
TC_auto_login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-68
TC_check_out_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-69
TC_checkout_and_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-70
TC_ContextmenuSuppression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-70
TC_control_wildcard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-71
TC_control_wildcard_exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-71
TC_CreateRenderingInheritTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-72

PLM00026 11.2 Preferences and Environment Variables Reference

 TC_days_non_login_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-72
TC_DISABLE_FLASH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-73
TC_display_group_names_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-73
TC_display_real_prop_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-74
TC_display_thumbnail_in_UI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-74
TC_Enable_Implicit_CO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-75
TC_Enable_Legacy_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-75
TC_Enable_LegacySaveAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-76
TC_Graph_Node_Thumbnail_Shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-76
TC_GROUP_PFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-77
TC_ImpactAnalysis_Display_Limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-77
TC_inbox_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-77
TC_<datasettype>_Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-78
TC_markup_named_ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-79
TC_max_display_thumbnails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-79
TC_max_number_of_retries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-79
TC_name_delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-80
TC_name_sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-80
TC_pattern_match_style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-81
TC_RelationBrowser_Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-81
TC_remove_file_on_check_in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-82
TC_retry_time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-82
TC_ROLE_PFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-82
TC_SaveAsRenderingInheritTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-83
TC_show_checkedout_icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-83
TC_suppress_Edit_Latest_Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-84
TC_suppress_inactive_group_members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-84
TC__thumbnail_dataset_type_order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-85
TC__thumbnail_relation_order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-86
TC_Thumbnail_Tooltip_Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-87
TC_USER_PFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-88
TC_user_delimiters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-88
TCViewEnableResponseOnSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-89
TCViewMarkupApplicationPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-89
TC_wc_allow_subgroup_default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-89
TC_wc_setting_modifiable_default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-90
TC_wc_show_all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-90
TOOL_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-91
TOOL_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-91
TOOL_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-92
TOOL_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-92
treeDisplayOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-93
<type>_group_order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-93
<Type>_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-94
<type_name>.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-94
<Type_Name>_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-95
<type_name>.FORMRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-100
<type_name>.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-101
<type_name>.SAVEASRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-102

Preferences and Environment Variables Reference PLM00026 11.2

 <type_name>.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-103
USER_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-103
USER_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-104
USER_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-104
USER_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-105
<viewer_config_id>.VIEWERCONFIG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-105
Viewer.VIEWERCONFIGTOLOAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-106
WhereReferencePOMPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-107
Where_Ref_Avoid_Duplicate_Expansion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-107
WHERE_REFERENCED_RELATIONS_FILTER . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-108
Word_12_installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-108
Word_Export_TcTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-109
WORKSPACEOBJECT_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-110
WORKSPACEOBJECT_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-110
WORKSPACEOBJECT_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-111
WORKSPACEOBJECT_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-111
WS_icon_placement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-112
WSColumnsHiddenPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-112
WSColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-113
WSDisplayTypePref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-113
WS_expand_on_paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-113
WSHiddenColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-114
WsoFolderSavePref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-115
WsoInsertNoSelectionsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-115
WsoInsertSelectionsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-115
WSOM_only_edit_effectivity_in_ecm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-116
WSShownColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-116

Thin client preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-117

General thin client preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-117
appbar_title_contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-117
Create_Folder_mru_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-118
JT_WEB_UI_PREF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-118
TcUseAppLauncher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-119
WEB_active_optimizer_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-120
WEB_Applications_List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-120
WEB_auto_assign_ds_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-120
WEB_column_one_new_window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-121
WEB_core_help_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-121
WEB_create_<business_object>_exclude_types . . . . . . . . . . . . . . . . . . . . . . . . 12-122
WEB_create_<Class>_exclude_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-122
WEB_create_Item_exclude_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-122
WEB_create_WorkspaceObject_exclude_types . . . . . . . . . . . . . . . . . . . . . . . . . 12-123
WEB_dataset_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-124
WEB_dataset_upload_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-124
WEB_default_site_deployed_app_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-124
WEB_default_site_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-125
WEB_disable_structure_read_optimizations . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-125
WEB_displayed_new_menu_objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-126
WEB_EnablePSEVisualization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-126

PLM00026 11.2 Preferences and Environment Variables Reference

 WEB_EnableVisualization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-127
WEB_filter_person . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-127
WEB_filter_user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-127
WEB_help_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-128
WEB_item_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-128
WEB_itemrevision_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-129
WEB_IWantToDefaultActions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-129
WEB_login_page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-130
WEB_menu_entry_new_window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-130
WEB_menu_entry_suppressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-131
WEB_Nav_Items_List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-131
WEB_NX_UseBookmark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-132
WEB_package_multipart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-132
WEB_packaging_extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-133
WEB_processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-133
WEB_protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-133
WEB_show_export_nx_assy_menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-134
WEB_show_summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-134
WEB_show_unconfigured_revs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-134
WEB_status_icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-135
WEB_style_sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-136
WEB_style_sheet_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-136
WEB_style_sheet_list_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-136
WEB_suppressedApplications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-137
WEB_title_contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-137
WEB_unpackage_multipart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-138
WEB_use_lhn_home_component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-138
WEB_use_lhn_inbox_component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-139
Thin client column and property preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-139
WEB_dataset_columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-139
WEB_psm_columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-140
WEB_po_columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-141
WEB_wso_columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-141
Folder_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-142
Thin client image preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-142
WEB_fullsize_image_generate_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-142
WEB_image_size_vert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-143
WEB_image_size_horiz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-143
WEB_show_banner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-143
WEB_show_thumbnail_image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-144
WEB_thumbnail_image_display_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-144
WEB_thumbnail_image_generate_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-144
Thin client DesignContext preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-145
WebDesignContextDefaultSearchDistance . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-145
RDVThinClientBomlinePropsDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-145
RDVThinClientUserProductItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-146
RDVThinClientUserrevisionRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-146
Thin client Teamcenter manufacturing process management preferences . . . . . . . . . . 12-146
Manufacturing report generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-146

Preferences and Environment Variables Reference PLM00026 11.2

 WEB_ZoneProcess_Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-147
WEB_StationProcess_Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-147
WEB_MEWeldOp_Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-149
WEB_MEPrPlantProcess_Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-150
WEB_MELocateCompOp_Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-150
Class_Resource_WeldGun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-151
Class_Resource_Robot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-151
TC_suppress_report_designs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-151
TC_TransferMode_XMLReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-152
TC_Report_Transfer_Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-152
Batch_Report_Request_File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-153
Web_Report_Jars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-153

Active Workspace preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-154

ActiveWorkspaceHosting.URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-154
ActiveWorkspaceHosting.Office.URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-154
ActiveWorkspaceHosting.NX.URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-155
ActiveWorkspaceHosting.RAC.URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-155
ActiveWorkspaceHosting.WorkflowEmail.URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-155
AWC_NX_AddComponentSupportedTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-156
AWC_NX_OpenSupportedTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-156
AWC_OC_OpenSupportedTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-157
AWC_RAC_OpenSupportedTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-158
AWC_VIS_OpenSupportedTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-158
TC_Use_ActiveWorkspace_Inbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-159
TC_Use_ActiveWorkspace_Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-159

PLM00026 11.2 Preferences and Environment Variables Reference

Chapter 12: Client preferences

Rich client preferences

AE_dataset_default_keep_limit

DESCRIPTION
Determines the number of old dataset versions to store in the database. When this
number is exceeded, the oldest dataset version is deleted.
VALID
VALUES
A single positive integer.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

AI_ignore_ic_flag_setting

DESCRIPTION
Specifies the list of AppInterface types for which the incremental change flag setting
is ignored. If an incremental change is active when the SendDataTo menu is used, the
specified AppInterface types track the change.
Use incremental change orders to manage changes to the application interface data.
Any such incremental change data is sent to the external system when the user initiates
a synchronization request. Similarly, data changes caused by a publish request may
result in incremental changes. If a request object in the viewer has incremental
changes associated with it, the corresponding entry in the table is colored blue.
This preference is used with the Application Interface Viewer, which allows you
to monitor and administer data exchanges between Teamcenter and an external
application using the AI service functionality.
For more information about the AI Service, see the Services Reference.
Note

To access the Services Reference, install the Teamcenter developer references

when you install Teamcenter online help, or go to the Global Technical Access
Center (GTAC):
https://support.industrysoftware.automation.siemens.com/docs/teamcenter/

PLM00026 11.2 Preferences and Environment Variables Reference 12-1

 Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid AppInterface type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

AI_Incremental_Export

DESCRIPTION
Determines whether changes to all structures, or only changes to large structures, are
exported when changed. This preference is used with the Application Interface Viewer,
which allows you to monitor and administer data exchanges between Teamcenter and
an external application using the AI service functionality.
For more information about the AI Service, see the Services Reference.
Note

To access the Integration Toolkit Function Reference, install the Teamcenter

developer references when you install Teamcenter online help, or go to the
Global Technical Access Center (GTAC):
https://support.industrysoftware.automation.siemens.com/docs/teamcenter/

VALID
VALUES
true Only changes to large structures are exported.

false All items are exported.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

AI_request_no_dependancy

DESCRIPTION
Determines whether synchronization and publish requests are treated independently.
This preference is used with the Application Interface Viewer, which allows you
to monitor and administer data exchanges between Teamcenter and an external
application using the AI service functionality.
For more information about the AI Service, see the Services Reference.

12-2 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

Note

To access the Services Reference, install the Teamcenter developer references

when you install Teamcenter online help, or go to the Global Technical Access
Center (GTAC):
https://support.industrysoftware.automation.siemens.com/docs/teamcenter/

VALID
VALUES
True Prior synchronization and publish requests are ignored; the current
synchronization or publish request is processed.
False Prior synchronization and publish requests are honored.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
All.

Allow_Copy_As_Revision

DESCRIPTION
Determines the behavior of the Save As menu command when saving item revisions
in the Teamcenter rich client.
Note

This preference has no effect in Teamcenter Integration for NX.

VALID
VALUES
true Lets the user choose the Save-As command for an item revision to save the
new item revision to a new item or, if the user enters the item ID and Revision
values in the Save As dialog box, to an existing item.
false Lets the user choose the Save-As command for an item revision to save
the item revision to a new item but not to an existing item. To create a new
item revision for the existing item in this case the user must use the Revise
command.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
In the rich client, the Save-As and Revise commands are available as buttons in the
Summary view Overview tab and in the File menu.

PLM00026 11.2 Preferences and Environment Variables Reference 12-3

 Chapter
Chapter 12:12:ClientClient preferences
preferences

Attachment_Alias_File

DESCRIPTION
Determines the alias file applied to the intermediate data capture object to display
the attachments of a BOM line in a tree structure format. Alias files determine what
appears in the IDCWindow window. They determine the root of the window, the
children displayed in each line, and the properties for each line. All shipped alias
files are stored in the TC_DATA directory.
For more information about working with intermediate data captures, see
Manufacturing Process Planner.
The alias files contain the following three parent aliases; these three alias components
list all the possible subaliases:
Root Determines the object to be set as the root of the window.

Children Determines the children for each intermediate data capture line.

Property Determines the properties for each intermediate data capture

line. All the properties for the line are defined as the aliases
under the property alias.
VALID
VALUES
Accepts a single string as a value. The string describes the complete path to the
alias XML file.
DEFAULT
VALUES
TC_DATA/attachment_alias.xml
DEFAULT
PROTECTION
SCOPE
Site preference.

browserWindowMode

DESCRIPTION
Specifies whether content from the rich client is displayed in the internal browser or
in an external browser window.
VALID
VALUES
1 Displays content in an external browser.

2 Displays content in the internal browser view with subsequent URLs using the
same view.

3 Displays content in the internal browser view with subsequent URLs using
the new browser views.
DEFAULT
VALUES
1

12-4 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

DEFAULT
PROTECTION
SCOPE
User

CCCompositionTypesPref

DESCRIPTION
Determines which composition types display to users in Multi-Structure Manager
and Manufacturing Process Planner. A composition is a structure that comprises
components from different top lines, in the context of a configured top-level assembly.
It is represented by a single line in the structure.
VALID
VALUES
Accepts one or more strings as a value; each string must be a valid item, operation, or
process type.
DEFAULT
VALUES
MEProcess
MEOP
MEProductBOP
MEGenericBOP
Mes0MESTXLibrary
Mes0MESTXFolder
Mes0MESTXElement
Mfg0MEStudy
DEFAULT
PROTECTION
SCOPE
All.

CCObject_default_relation

DESCRIPTION
Determines the default relation for CCObject types.
VALID
VALUES
Accepts one or more strings as a value; each string must be a valid Teamcenter object.
DEFAULT
VALUES
IMAN_CCContext
DEFAULT
PROTECTION
SCOPE
Site preference.

copyPasteChunkNumber

DESCRIPTION
Specifies the number of selected objects the cut/paste function processes in a group
rather than individually. When the number of objects selected for cutting/pasting meets

PLM00026 11.2 Preferences and Environment Variables Reference 12-5

 Chapter
Chapter 12:12:ClientClient preferences
preferences

or exceeds the number defined in this preference, the objects are processed by the
server in a groups the size of the set value. For example, if this preference is set for
20, and 19 objects are selected to be cut, 19 individual cut actions are processed. If
20 objects were selected to be cut, a single cut action is processed, encompassing
the entire group of selected objects in a single process.
This preference must be manually entered into the database. Create new preferences
using the Options dialog box, accessed from the Edit menu in the rich client.
For information about using this dialog box, see Teamcenter Basics.
VALID
VALUES
Any positive integer.
DEFAULT
VALUES
20 When 20 or more items are selected for cutting or pasting, the
action is processed on the selected objects in groups of 20.
DEFAULT
PROTECTION
SCOPE
Site preference.

Create_WorkspaceObject_mru_list

DESCRIPTION
Displays a list of the object types most recently created in the Business Object Type
dialog box. This dialog box is accessed by choosing File→New→Other in the rich
client or by choosing New→Other in the thin client.
VALID
VALUES
Business object names.
DEFAULT
VALUES
Folder
Item
DEFAULT
PROTECTION
SCOPE
User preference.

Create_WorkspaceObject_mru_max

DESCRIPTION
Defines the number of object types to display in the list under the Most Recently
Used heading in the Business Object Type dialog box. This dialog box is accessed
by choosing File→New→Other in the rich client or by choosing New→Other in the
thin client.
VALID
VALUES
A positive integer.

12-6 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

DEFAULT
VALUE
5
DEFAULT
PROTECTION
SCOPE
User preference.

<dataset_name>.FORM_REGISTEREDTO

DESCRIPTION
Teamcenter form displays are based on an XML style sheet. The style sheet must be
created and registered by a system administrator.
For more information, see Client Customization.
The XML file allows users to define a set of form properties to display, the display
order, and the UI rendering component to be used. The file can be used by both the
rich client and thin client.
This preference is referenced by the style sheet; when a XML style sheet dataset is
selected for display in the viewer, the dataset type defined in this preference is used.
For each <type_name>.FORMRENDERING preference defined, a corresponding
<dataset_name>.FORM_REGISTEREDTO preference must be defined.
VALID
VALUES
Accepts a single string as a value. Must be the type name defined in the corresponding
<type_name>.FORMRENDERING preference.
DEFAULT
VALUES
None. This preference must be manually entered into the database. Create new
preferences using the Options dialog box, accessed from the Edit menu in the rich
client.
For information about using this dialog box, see Teamcenter Basics.
DEFAULT
PROTECTION
SCOPE
Site preference.

<dataset_name>.CREATE_REGISTEREDTO

DESCRIPTION
Indicates the business object type that an XML rendering dataset
is registered to for create style sheet use, using the form of
xml-rendering-style-sheet-dataset.CREATE_REGISTEREDTO=business-object-type.
For example, the ItemCreate.CREATE_REGISTEREDTO=Item preference means
that the ItemCreate XML rendering style sheet dataset is registered as a create type
style sheet to the Item business object type.
Teamcenter property displays are based on an XML rendering style sheet. The style
sheet must be created and registered by a system administrator.
For more information, see Client Customization.

PLM00026 11.2 Preferences and Environment Variables Reference 12-7

 Chapter
Chapter 12:12:ClientClient preferences
preferences

The XML file allows users to define a set of properties to display in creation dialog
boxes, the display order, and the user interface rendering component to be used. The
file can be used by both the rich client and thin client.
This preference is referenced by the style sheet; when an XML style sheet dataset is
selected for display in the viewer, the business object type defined in this preference
is used. For each <type_name>.CREATERENDERING preference defined, a
corresponding <dataset_name>.CREATE_REGISTEREDTO preference must be
defined.
VALID
VALUES
Accepts a single string as a value. It must be the type name defined in the
corresponding <type_name>.CREATERENDERING preference.
DEFAULT
VALUES
None. This preference must be manually entered into the database. Create new
preferences using the Options dialog box, accessed from the Edit menu in the rich
client.
For information about using this dialog box, see Teamcenter Basics.
DEFAULT
PROTECTION
SCOPE
Site preference.

<dataset_name>.REGISTEREDTO

DESCRIPTION
Indicates the business object type that an XML rendering dataset
is registered to for property style sheet use, using the form of
xml-rendering-style-sheet-dataset.REGISTEREDTO=business-object-type.
For example, the Item.REGISTEREDTO=Item preference means that the Item XML
rendering style sheet dataset is registered as a property type style sheet to the Item
business object type.
Teamcenter property displays are based on an XML rendering style sheet. The style
sheet must be created and registered by a system administrator.
For more information, see Client Customization.
The XML file allows users to define a set of properties to display, the display order,
and the user interface rendering component to be used. The file can be used by
both the rich client and thin client.
This preference is referenced by the style sheet; when an XML style sheet dataset is
selected for display in the viewer, the business object type defined in this preference
is used. For each <type_name>.RENDERING preference defined, a corresponding
<dataset_name>.REGISTEREDTO preference must be defined.
VALID
VALUES
Accepts a single string as a value. It must be the type name defined in the
corresponding <type_name>.RENDERING preference.

12-8 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

DEFAULT
VALUES
None. This preference must be manually entered into the database. Create new
preferences using the Options dialog box, accessed from the Edit menu in the rich
client.

For information about using this dialog box, see Teamcenter Basics.
DEFAULT
PROTECTION
SCOPE
Site preference.

<dataset_name>.SAVEAS_REGISTEREDTO

DESCRIPTION
Indicates the business object type that an XML rendering dataset
is registered to for save as style sheet use, using the form of
xml-rendering-style-sheet-dataset.SAVEAS_REGISTEREDTO=business-object-type.
For example, the ItemSaveAs.SAVEAS_REGISTEREDTO=Item preference means
that the ItemSaveAs XML rendering style sheet dataset is registered as a save as
type style sheet to the Item business object type.

Teamcenter property displays are based on an XML rendering style sheet. The style
sheet must be created and registered by a system administrator.

For more information, see Client Customization.

The XML file allows users to define a set of properties to display in creation dialog
boxes, the display order, and the user interface rendering component to be used. The
file can be used by both the rich client and thin client.

This preference is referenced by the style sheet; when an XML style sheet dataset is
selected for display in the viewer, the business object type defined in this preference
is used. For each <type_name>.SAVEASRENDERING preference defined, a
corresponding <dataset_name>.SAVEAS_REGISTEREDTO preference must be
defined.
VALID
VALUES
Accepts a single string as a value. It must be the type name defined in the
corresponding <type_name>.SAVEASRENDERING preference.
DEFAULT
VALUES
None. This preference must be manually entered into the database. Create new
preferences using the Options dialog box, accessed from the Edit menu in the rich
client.

For information about using this dialog box, see Teamcenter Basics.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-9

 Chapter
Chapter 12:12:ClientClient preferences
preferences

<dataset_name>.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the business object type that an XML rendering dataset
is registered to for summary style sheet use, using the form of
xml-rendering-style-sheet-dataset.SUMMARY_REGISTEREDTO=business-object-type.
For example, the ItemSummary.SUMMARY_REGISTEREDTO=Item preference
means that the ItemSummary XML rendering style sheet dataset is registered as a
summary type style sheet to the Item business object type.
Teamcenter property displays are based on an XML rendering style sheet. The style
sheet must be created and registered by a system administrator.
For more information, see Client Customization.
The XML file allows users to define a set of properties to display, the display order,
and the user interface rendering component to be used. The file can be used by
both the rich client and thin client.
This preference is referenced by the style sheet; when an XML style sheet dataset is
selected for display in the viewer, the business object type defined in this preference
is used. For each <type_name>.SUMMARYRENDERING preference defined, a
corresponding <dataset_name>.SUMMARY_REGISTEREDTO preference must be
defined.
VALID
VALUES
Accepts a single string as a value. It must be the type name defined in the
corresponding <type_name>.SUMMARYRENDERING preference.
DEFAULT
VALUES
None. This preference must be manually entered into the database. Create new
preferences using the Options dialog box, accessed from the Edit menu in the rich
client.
For information about using this dialog box, see Teamcenter Basics.
DEFAULT
PROTECTION
SCOPE
Site preference.

Dataset_Alias_File

DESCRIPTION
Determines the alias file applied to the intermediate data capture object to display the
datasets of a BOM line in a tree structure format. Alias files determine what appears
in the IDCWindow window. They determine the root of the window, the children
displayed in each line, and the properties for each line. All shipped alias files are
stored in the TC_DATA directory.
For more information about working with intermediate data captures, see
Manufacturing Process Planner.
The alias files contain the following three parent aliases; these three alias components
list all the possible subaliases:

12-10 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

Root Determines the object to be set as the root of the window.

Children Determines the children for each intermediate data capture line.
Property Determines the properties for each intermediate data capture
line. All the properties for the line are defined as the aliases
under the property alias.
Note

This preference can be set using the preference name as an environment

variable.

VALID
VALUES
Accepts a single string as a value. The string describes the complete path to the
alias XML file.
DEFAULT
VALUES
TC_DATA/dataset_alias.xml
DEFAULT
PROTECTION
SCOPE
Site preference.

DATASET_object_columns_hidden

DESCRIPTION
Determines which dataset object columns are hidden. This preference can also be
set by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter dataset
name. Column widths are defined using the DATASET_object_widths_hidden user
preference.
DEFAULT
VALUES
ref_list
format_used
user_class
dataset_type
tool_used
release_status_list
date_released
archive_info
owning_group
last_mod_user
creation_date
archive_date
last_mod_date
backup_date

PLM00026 11.2 Preferences and Environment Variables Reference 12-11

 Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

DATASET_object_columns_shown

DESCRIPTION
Determines which dataset object columns are displayed. This preference can also be
set by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter object
name. Column widths are defined using the DATASET_object_widths_shown user
preference.
DEFAULT
VALUES
object_name
object_type
owning_user
revision_number
object_desc
DEFAULT
PROTECTION
SCOPE
User preference.

DATASET_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
DATASET_object_columns_hidden user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the DATASET_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
32
16
16
16
16
16
16
16
16
16
16

12-12 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

16
16
16

DEFAULT
PROTECTION
SCOPE
User preference.

DATASET_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
DATASET_object_columns_shown user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the DATASET_object_columns_shown user preference, and so on.
DEFAULT
VALUES
32
9
15
15
32
DEFAULT
PROTECTION
SCOPE
User preference.

DATASETTYPE_object_columns_hidden

DESCRIPTION
Determines which dataset columns are hidden. This preference can also be set by
editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter dataset name.
Column widths are defined using the DATASETTYPE_object_widths_hidden user
preference.
DEFAULT
VALUES
archive_info
owning_group
last_mod_user
owning_user
creation_date
archive_date
last_mod_date

PLM00026 11.2 Preferences and Environment Variables Reference 12-13

 Chapter
Chapter 12:12:ClientClient preferences
preferences

backup_date
description
DEFAULT
PROTECTION
SCOPE
User preference.

DATASETTYPE_object_columns_shown

DESCRIPTION
Determines which dataset columns are displayed. This preference can also be set by
editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter dataset name.
Column widths are defined using the DATASETTYPE_object_widths_shown user
preference.
DEFAULT
VALUES
datasettype_name
list_of_tools
DEFAULT
PROTECTION
SCOPE
User preference.

DATASETTYPE_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
DATASETTYPE_object_columns_hidden user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the DATASETTYPE_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
32
32
32
32
32
32
32
32
20

12-14 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

DEFAULT
PROTECTION
SCOPE
User preference.

DATASETTYPE_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
DATASETTYPE_object_columns_shown user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the DATASETTYPE_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
80
DEFAULT
PROTECTION
SCOPE
User preference.

DatasetTypesPref

DESCRIPTION
Specifies the dataset types listed when users choose the System→New→Dataset
command.
VALID
VALUES
One or more strings as values; each string must be a valid dataset type.
DEFAULT
VALUES
UGMASTER
UGPART
Text
DEFAULT
PROTECTION
SCOPE
Site preference.

defaultViewerConfig.VIEWERCONFIG

DESCRIPTION
Specifies the default Viewer view configuration. This preference defines which
Generic Relationship Management (GRM) rules to expand, and the viewer to use for
each type of object specified in the preference.
To use an alternate configuration, define it using the
<viewer_config_id>.VIEWERCONFIG preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-15

 Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
• teamcenter-type.viewer-ID=named-references
Indicates the viewer to use for each Teamcenter type.
For example, the following entry indicates to use the FormViewer viewer for
Form types:
Form.FormViewer

Optionally, use the = sign to specify named references.

For example, the following entry indicates that for a DirectModel dataset, use the
DirectModelViewer viewer if it has at least one of JTPart, UGPart, or 3DModel
named references:
DirectModel.DirectModelViewer=JTPART,UGPART,3DModel

• SEARCHORDER.ITEMREV2DATASET=GRMs-list
Specifies the Generic Relationship Management rules (GRMs) to expand from
item revision to dataset. Format the GRMs in a comma-separated list, for example:
SEARCHORDER.ITEMREV2DATASET=IMAN_manifestation,IMAN_specification,IMAN_Rendering,
IMAN_Motion,IMAN_3D_snap_shot,SimplifiedRendering,TC_Attaches

• SEARCHORDER.ITEMREV2ITEMREV=
item-revision-type-for-primary-side-of-relation.
GRM-relation-name.item-revision-type-for-secondary-side-of-relation
Specifies the Generic Relationship Management rules (GRMs) to expand from
item revision to item revision, for example:
SEARCHORDER.ITEMREV2ITEMREV=Part Revision.TC_Primary_Design_Representation.Design Revision

The limitation with this value is that only a single hop from an item revision to
another item revision is allowed. Indefinite expansion is not supported because
there could be issues with circular rules.
DEFAULT
VALUES
SEARCHORDER.ITEMREV2DATASET=IMAN_manifestation,IMAN_Rendering,IMAN_specification,IMAN_Motion,
IMAN_3D_snap_shot,SimplifiedRendering,TC_Attaches
DirectModel.DirectModelViewer=JTPART,UGPART,3DModel
DirectModelMotion.ExtendedDirectModelViewer=JTPART
DirectModelMarkup.TCTwoDViewer=Image,Markup
DirectModel3DMarkup.DirectModelViewer=3DModel,3DMarkup
SnapShotViewData.RequestObjectViewer
Vis_Snapshot_2D_View_Data.TCTwoDViewer=AssetImage,ThumbnailImage
Sheet.TCTwoDViewer=Image
DrawingSheet.TCTwoDViewer=Sheet
Image.TCTwoDViewer=Image
Markup.TCTwoDViewer=Image,Markup
MSWord.MSWordViewer=word
MSWordX.MSWordViewer=word
MSExcel.MSExcelViewer=excel
MSExcelX.MSExcelViewer=excel
Text.TextViewer=Text
MSPowerPoint.MSPowerPointViewer=powerpoint
MSPowerPointX.MSPowerPointViewer=powerpoint
WPPSession.SessionViewer
NetworkImage.TCTwoDViewer=Image
TCPublishingPage.PublishingPageViewer
TCPublishingTechnicalPortfolio.PublishingPortfolioViewer
PCBCircuit.TCPCBViewer
PCBPanel.TCPCBViewer
PCBFATF.TCPCBViewer=XFatf
PCBMarkup.TCPCBViewer=markup
SCHFATF.TCPCBViewer=XSCH
SE Draft.TCTwoDViewer=SE-draft_image-emf,SE-draft_image-dxf,SE-draft_image-tif,
SE-draft_image-jpg,SE-draft_image-bmp,SE-draft
JtSimplification.DirectModelViewer=ALSG

12-16 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

PDF.PDFViewer=PDF_Reference,PDF
HTML.HTMLViewer=HTML
JPEG.TCTwoDViewer=JPEG_Reference
TIF.TCTwoDViewer=TIF_Reference
GIF.TCTwoDViewer=GIF_Reference
Bitmap.TCTwoDViewer=Image
PADImage.PADImageViewer=JPEG,TIF,GIF,JPEG_Reference,TIF_Reference,GIF_Reference
XMLRenderingStylesheet.StyleSheetViewer=XMLRendering
MENXObject.MENXObjectViewer
Web Link.URLViewer
Form.FormViewer
Alias.AliasViewer
Identifier.IdentifierViewer
IdentifierRev.IdentifierViewer
RevisionRule.RevisionRuleViewer
VariantRule.VariantRuleViewer
StoredOptionSet.SelectedOptionSetViewer
EngChange Revision.ChangeViewer
icm0.TCClassificationViewer
ReleaseStatus.EffectivityEndItemViewer
AppearanceGroup.AppearanceGroupViewer
User.UserViewer
GroupMember.UserViewer
Group.GroupViewer
Role.RoleViewer
Process.ProcessViewer
EPMTask.ProcessViewer
RequestObject.RequestObjectViewer
AppInterface.AppInterfaceViewer
Cba0PartProxy.PartProxyViewer
Part Revision.PartViewer=JTPART,Text
DrawingSheetProxy.DrawingViewer=Image
Drawing.DrawingViewer

Note

To prioritize which viewer is resolved before other viewers, you may move an
entry up or down in the viewer configuration. If two entries specify viewers for
the same object, the first viewer in the list is loaded.

DEFAULT
PROTECTION
SCOPE
Site preference.

Design Revision_PseudoFolder

DESCRIPTION
Specifies the list of properties that can be displayed as a pseudo folder under a node
for the design revision object.
VALID
VALUES
Accepts multiple strings as values; each value must be a valid Teamcenter form type.
DEFAULT
VALUES
representation_for
CAEAnalysis
MEProcess
MESetup
view
ElectricalDesign
ElectricalHarness

DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-17

 Chapter
Chapter 12:12:ClientClient preferences
preferences

DRAG_AND_DROP_Default_dataset_type

DESCRIPTION
Specifies one or more default dataset types for files added to objects by drag-and-drop
operations.
VALID
VALUES
file-extension:dataset-type Accepts one or more strings as values.

For example:
doc:MSWORD
txt:TEXT
pptx:MSPOWERPOINTX

DEFAULT
VALUES
List of all dataset types present in the Teamcenter database with the supported file
extension for each type as default value for that dataset type.

For example:
doc:MSWORD
docx:MSWORDX
txt:TEXT
ppt: MSPOWERPOINT
pptx: MSPOWERPOINTX

DEFAULT
PROTECTION
SCOPE
All.
NOTES
Users can add new dataset types and supported file extensions.

DRAG_AND_DROP_file_limit

DESCRIPTION
Specifies the number of the files that can be dragged and dropped by each
drag-and-drop operation.
VALID
VALUES
integer-value Any positive integer value.
DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
All.
NOTE
The value must be greater than 1.

12-18 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

DRAG_AND_DROP_SWING_dialog_enable

DESCRIPTION
Specifies whether to show or hide the multiple file drag-and-drop dialog box for
single-file drag-and-drop operations.
VALID
VALUES
true The standard dialog box is displayed for single-file drag and drop operations.

false The multiple file drag-and-drop dialog box is displayed for single-file
drag-and-drop operations.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
All.

Enable_thumbnails

DESCRIPTION
Enables thumbnail datasets for Teamcenter.

By default, My Teamcenter shows preview images of jpeg, png, and bmp files in
the Preview area of the Summary tab. You do not need to enable the thumbnails
functionality to view these preview images.

This preference enables the thumbnails functionality that converts all images
associated with item revision to small thumbnail images. You can view these thumbnail
images in the Preview area of the Summary tab, in the header of the Summary page,
and in search results.

You must perform multiple configurations to enable thumbnail functionality. You must
also assess performance and resource implications before enabling this functionality.

For more information about configuring thumbnail functionality, see Document

Management.
VALID
VALUES
TRUE Enables thumbnail datasets.

FALSE Hides thumbnail datasets.

DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-19

 Chapter
Chapter 12:12:ClientClient preferences
preferences

FLColumnCatIVFSeparatorPref

DESCRIPTION
Specifies the character used to separate an item ID from an item revision ID in an
object column.
Note

This preference is deprecated. Use the DisplayName business object constant

to specify separators instead.

VALID
VALUES
A single ASCII character.
DEFAULT
VALUES
A slash (/).
DEFAULT
PROTECTION
SCOPE
User preference.

FLColumnCatObjSeparatorPref

DESCRIPTION
Specifies the character used to separate an item ID from an item name in an object
column.
Note

This preference is deprecated. Use the DisplayName business object constant

to specify separators instead.

VALID
VALUES
A single ASCII character.
DEFAULT
VALUES
A dash (-).
DEFAULT
PROTECTION
SCOPE
User preference.

FOLDER_object_columns_hidden

DESCRIPTION
Determines which folder object columns are hidden. This preference can also be set
by editing column options directly from the interface.

12-20 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter folder
name. Column widths are defined using the FOLDER_object_widths_hidden user
preference.
DEFAULT
VALUES
contents
release_status_list
revision_number
date_released
archive_info
owning_group
last_mod_user
creation_date
archive_date
last_mod_date
backup_date
DEFAULT
PROTECTION
SCOPE
User preference.

FOLDER_object_columns_shown

DESCRIPTION
Determines which folder object columns are displayed. This preference can also be
set by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter object
name. Column widths are defined using the FOLDER_object_widths_shown user
preference.
DEFAULT
VALUES
object_name
object_type
owning_user
object_desc
DEFAULT
PROTECTION
SCOPE
User preference.

FOLDER_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
FOLDER_object_columns_hidden user preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-21

 Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the FOLDER_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
32
32
32
32
32
32
32
32
32
32
32
DEFAULT
PROTECTION
SCOPE
User preference.

FOLDER_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
FOLDER_object_columns_shown user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the FOLDER_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
16
16
32
DEFAULT
PROTECTION
SCOPE
User preference.

FORM_object_columns_hidden

DESCRIPTION
Determines which form object columns are hidden. This preference can also be set by
editing column options directly from the interface.

12-22 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter form name.
Column widths are defined using the FORM_object_widths_hidden user preference.
DEFAULT
VALUES
data_file
release_status_list
revision_number
date_released
archive_info
owning_group
last_mod_user
creation_date
archive_date
last_mod_date
backup_date
DEFAULT
PROTECTION
SCOPE
User preference.

FORM_object_columns_shown

DESCRIPTION
Determines which form object columns are displayed. This preference can also be
set by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter object name.
Column widths are defined using the FORM_object_widths_shown user preference.
DEFAULT
VALUES
object_name
object_type
owning_user
object_desc
form_file
DEFAULT
PROTECTION
SCOPE
User preference.

FORM_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
FORM_object_columns_hidden user preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-23

 Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the FORM_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
32
32
32
32
32
32
32
32
32
32
32
DEFAULT
PROTECTION
SCOPE
User preference.

FORM_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
FORM_object_columns_shown user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the FORM_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
16
16
32
30
DEFAULT
PROTECTION
SCOPE
User preference.

12-24 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

FormTypesPref

DESCRIPTION
Specifies the form types listed when users choose the File→New→Form command. If
this preference is left undefined, the New Form dialog displays rather than a dropdown
list of form types.
VALID
VALUES
One or more strings as values; each string must be a valid form type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

GROUP_object_columns_hidden

DESCRIPTION
Determines which group object columns are hidden. This preference can also be set
by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter group
name. Column widths are defined using the GROUP_object_widths_hidden user
preference.
DEFAULT
VALUES
list_of_role
volume
DEFAULT
PROTECTION
SCOPE
User preference.

GROUP_object_columns_shown

DESCRIPTION
Determines which group object columns are displayed. This preference can also be
set by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter object
name. Column widths are defined using the GROUP_object_widths_shown user
preference.
DEFAULT
VALUES
name
description

PLM00026 11.2 Preferences and Environment Variables Reference 12-25

 Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

GROUP_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
GROUP_object_columns_hidden user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the GROUP_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
32
32
DEFAULT
PROTECTION
SCOPE
User preference.

GROUP_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
GROUP_object_columns_shown user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the GROUP_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
32
DEFAULT
PROTECTION
SCOPE
User preference.

HiddenPerspectives

DESCRIPTION
Hides specified perspectives in the rich client.
The value listed must be the activity name defined at eclipse.ui.activities extension
point within a given perspective's plugin.xml file.

12-26 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

VALID
VALUES
AccessManager
ADALicense
AppearanceConfiguration
AuditManager
Authorization
CAEManager
CAEStructureDesigner
ChangeManager
ClassificationAdmin
Classification
CMViewerClassic
CommandSuppression
DatabaseUtilities
DesignContext
DPV Measurements
IssueManager
LaunchPad
LifecycleViewer
ManufacturingBOMReconciliation
ManufacturingProcessPlanner
ManufacturingProcessSequencing
Multi-StructureManager
MyTeamcenter
Organization
PartPlanner
PlantDesigner
PlatformDesigner
PLMXMLExportImportAdministration
Project
QueryBuilder
RegistryEditor
RelationBrowser
ReportBuilder
ReportDesigner
ReportGenerator
ResourceManager
ScheduleManager
SetupWizard
StructureManager
SubscriptionMonitor
ValidationManager
VolumeManagement
WorkflowDesigner
WorkflowViewer
DEFAULT
VALUES
CMViewerClassic for Foundation installations; none for Foundation upgrades, GM
Overlay installations, and GM Overlay upgrades.

PLM00026 11.2 Preferences and Environment Variables Reference 12-27

 Chapter
Chapter 12:12:ClientClient preferences
preferences

ChangeManager

LaunchPad

PlatformDesigner
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
You cannot hide the Getting Started or Web Browser perspectives.

HistoryIDList

DESCRIPTION
Defines an array of component UIDs for the left-hand History component in the rich
client. The value of this preference is maintained by the rich client for each user.
VALID
VALUES
Component UIDs assigned by the rich client.
DEFAULT
VALUES
A component UID assigned by the rich client.
DEFAULT
PROTECTION
SCOPE
User preference.
RESTRICTIONS
Do not modify this preference manually. This is a user preference.

HistoryMax

DESCRIPTION
Defines the maximum number of objects stored in the left-hand History navigator
component in the rich client and the thin client.
VALID
VALUES
A positive integer.
DEFAULT
VALUES
20
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
None.

12-28 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

HistoryTitleList

DESCRIPTION
Defines an array of strings representing the text displayed in the left-hand History
component in the rich client. The value of this preference is maintained by the rich
client for each user. This preference is used in conjunction with the HistoryIDList
preference.
VALID
VALUES
Assigned by the rich client.
DEFAULT
VALUES
Home
DEFAULT
PROTECTION
SCOPE
User preference.
RESTRICTIONS
Do not modify this preference manually. This is a user preference.

HistoryTypeList

DESCRIPTION
Defines an array of strings representing the component type for the entries in the
left-hand History component of the rich client. The value of this preference is
maintained by the rich client for each user. This preference is used in conjunction with
the HistoryIDList preference.
VALID
VALUES
Assigned by the rich client.
DEFAULT
VALUES
Folder
DEFAULT
PROTECTION
SCOPE
User preference.
RESTRICTIONS
Do not modify this preference manually. This is a user preference.

IDCAttachmentColumnsShownPref

DESCRIPTION
Determines the columns displayed in the IDCAttachmentTreeTable, used to display
attachments of the captured structure.
VALID
VALUES
Accepts multiple strings as values. Must be a valid IDCLine property.

PLM00026 11.2 Preferences and Environment Variables Reference 12-29

 Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
VALUES
Me_cl_display_string
Me_cl_object_type
Me_cl_relation

DEFAULT
PROTECTION
SCOPE
All.

IDCStructureColumnWidthsPref

DESCRIPTION
Determines the column width for the list of properties.
VALID
VALUES
Accepts multiple strings as values. Each value must be a positive integer, and align,
in order.
DEFAULT
VALUES
15
10
10

DEFAULT
PROTECTION
SCOPE
All.

IdentifierContextTypeDefault

DESCRIPTION
Determines the default ID context type used when an object is imported without an
assigned ID context.
VALID
VALUES
Accepts a single string as a value. Must be a valid ID context type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

12-30 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

IdentifierTypeDefault

DESCRIPTION
Determines the default identifier type used when an object is imported without an
identifier type.
VALID
VALUES
Accepts a single string as a value. Must be a valid identifier type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMAN_3D_snap_shot_relation_primary

DESCRIPTION
Determines the default relation for IMAN_3D_snap_shot types.
Note

All <relation_business_object>_relation_primary preferences are obsolete and

are replaced by relation properties. Use the Business Modeler IDE to create
and manage relation properties.
For more information about relation properties, see Business Modeler IDE.

VALID
VALUES
Accepts one or more strings as a value; each string must be a valid Teamcenter object.
DEFAULT
VALUES
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

IMAN_customization_libraries

DESCRIPTION
Registers multiple customizations of Teamcenter. Enables the library file for each
customization defined in this preference.
For example, the following setting accepts the customizations of both Supplier1 and
Supplier2 by customizing the Supplier1.sl/so/dll library and Supplier2.sl/so/dll
library files:
IMAN_customization_registry=
Supplier1
Supplier2

PLM00026 11.2 Preferences and Environment Variables Reference 12-31

 Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
Accepts one or more strings as values; each string must be a valid customization file.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMAN_FLASH_FILE

DESCRIPTION
Determines the flash screen displayed while the workspace is loading. This preference
is enabled by not setting the TC_DISABLE_FLASH preference.
VALID
VALUES
A single string; this string must be the full operating system path name of a valid
display file.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

IMANFILE_object_columns_hidden

DESCRIPTION
Determines which file name columns are hidden. This preference can also be set by
editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter file name.
Column widths are defined using the IMANFILE_object_widths_hidden user
preference.
DEFAULT
VALUES
text_flag
machine_type
status_flag
time_last_modified
archive_info
owning_group
last_mod_user
creation_date
archive_date
last_mod_date

12-32 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

backup_date

DEFAULT
PROTECTION
SCOPE
User preference.

IMANFILE_object_columns_shown

DESCRIPTION
Determines which file name columns are displayed. This preference can also be set
by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter file name.
Column widths are defined using the IMANFILE_object_widths_shown user
preference.
DEFAULT
VALUES
original_file_name
volume_tag
owning_user
file_name
DEFAULT
PROTECTION
SCOPE
User preference.

IMANFILE_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
IMANFILE_object_columns_hidden user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the IMANFILE_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
32
32
32
32
32
32
32
32
32
32

PLM00026 11.2 Preferences and Environment Variables Reference 12-33

 Chapter
Chapter 12:12:ClientClient preferences
preferences

32
DEFAULT
PROTECTION
SCOPE
User preference.

IMANFILE_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
IMANFILE_object_columns_shown user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the IMANFILE_object_columns_shown user preference, and so on.
DEFAULT
VALUES
32
16
16
32
DEFAULT
PROTECTION
SCOPE
User preference.

IMANTYPE_object_columns_shown

DESCRIPTION
Determines which type object columns are displayed. This preference can also be
set by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter object name.
Column widths are defined using the IMANTYPE_object_widths_shown user
preference.
DEFAULT
VALUES
type_name
type_class
DEFAULT
PROTECTION
SCOPE
User preference.

12-34 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

IMANTYPE_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
IMANTYPE_object_columns_shown user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the IMANTYPE_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
20
DEFAULT
PROTECTION
SCOPE
User preference.

IMANVOLUME_object_columns_hidden

DESCRIPTION
Determines which volume name columns are hidden. This preference can also be set
by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter volume name.
Column widths are defined using the IMANVOLUME_object_widths_hidden user
preference.
DEFAULT
VALUES
last_mod_date
archive_date
creation_date
backup_date
shadow_node_name
shadow_vms_path_name
users
shadow_unix_path_name
vms_path_name
machine_type
archive_info
last_mod_user
owning_user
owning_group
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-35

 Chapter
Chapter 12:12:ClientClient preferences
preferences

IMANVOLUME_object_columns_shown

DESCRIPTION
Determines which volume name columns are displayed. This preference can also be
set by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter volume name.
Column widths are defined using the IMANVOLUME_object_widths_shown user
preference.
DEFAULT
VALUES
volume_name
node_name
unix_path_name
DEFAULT
PROTECTION
SCOPE
User preference.

IMANVOLUME_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
IMANVOLUME_object_columns_hidden user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the IMANVOLUME_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
16
16
16
16
20
80
80
80
80
16
32
16
16
16
DEFAULT
PROTECTION
SCOPE
User preference.

12-36 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

IMANVOLUME_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
IMANVOLUME_object_columns_shown user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the IMANVOLUME_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
20
80
DEFAULT
PROTECTION
SCOPE
User preference.

ImpactAnalysisViewWhereUsedBatchSize

DESCRIPTION
Defines the number of WhereUsed nodes that are sent to the server in a single SOA
request. These nodes are displayed in the Where Used pane of the Impact Analysis
view.
VALID
VALUES
A single positive integer.
DEFAULT
VALUES
30
Note

Increasing the default value may negatively affect the user interface rendering
performance of the Impact Analysis view for the Teamcenter rich client.
Reducing the default value increases the client or server chattiness, which may
also negatively affect performance.

DEFAULT
PROTECTION
SCOPE
User preference.

Item_ColumnPreferences

DESCRIPTION
Defines the list of property names to be displayed as columns for item business object
types. The Item_ColumnWidthPreferences preference specifies the widths of the
columns for these properties.

PLM00026 11.2 Preferences and Environment Variables Reference 12-37

 Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
Any properties of the Item business object.
DEFAULT
VALUES
object_string
object_type
relation
owning_user
owning_group
last_mod_date
checked_out
release_status_list

DEFAULT
PROTECTION
SCOPE
User preference.

Item_ColumnWidthPreferences

DESCRIPTION
Specifies the widths of columns to be displayed for item business object types. The
widths defined in this preference correspond directly to the columns specified in in the
Item_ColumnPreferences preference.
VALID
VALUES
Accepts string array.
DEFAULT
VALUES
30
17
13
9
9
17
6
26

DEFAULT
PROTECTION
SCOPE
User preference.

Item_default_relation

DESCRIPTION
Specifies the relation established when an object is pasted under an item revision.
The relation specified for this preference is the default relation established between
the source and the target item revision.

12-38 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

VALID
VALUES
Accepts a single string as a value. Must be a valid relation type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

<Item>.FilterCriteria

DESCRIPTION
Filter criteria to apply for displaying objects in the project smart folder of the item.
VALID
VALUES
Filter criteria as specified in the Project application.
DEFAULT
VALUES
Item name or item revision.
DEFAULT
PROTECTION
SCOPE
Site preference.

ITEM_first_rev_id

DESCRIPTION
Enables item revision ID sequencing. This preference is the default site preference
that is used for all item types. To apply a different revision sequencing format to a
particular item type, a site preference must be defined for the item type.
The standard naming pattern for an item type-specific preference is
ITEM_TYPE_first_rev_id, where ITEM_TYPE is the item type name. For example,
the site preference for the item type CORP_Part is CORP_Part_first_rev_id.
Revision increments are implemented by assigning a preferred value to the preference.
Revision ID prefixes and postfixes, if used, should be included in the site preference
variable value, enclosed in single quotation marks. For example, if ABC is the revision
ID prefix and XYZ is the postfix, the variable value is `ABC'001`XYZ'.
In this scenario, when a new item is created, it has a revision ID of ABC001XYZ.
When this item is next revised, the value between the revision ID prefix and suffix is
incrementally increased, resulting in a new revision ID of ABC002XYZ.

PLM00026 11.2 Preferences and Environment Variables Reference 12-39

 Chapter
Chapter 12:12:ClientClient preferences
preferences

Note

When creating new revisions of an existing item or item revision, the revision
increments are created according to the previous item revision ID. If the
previous item revision ID matches the pattern of the site preference variable,
the value between the prefix and postfix is incrementally increased. If the
existing revision ID pattern does not match the site preference variable pattern,
the revision increment is done as per current Teamcenter logic.

VALID
VALUES
A single string as a value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ITEM_id_postfix

DESCRIPTION
Specifies a character string added to the end of each new default item ID.
VALID
VALUES
A single string as a value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ITEM_id_prefix

DESCRIPTION
Specifies a character string added to the beginning of each new default item ID.
VALID
VALUES
A single string as a value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

12-40 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

ITEM_object_columns_hidden

DESCRIPTION
Determines which item object columns are hidden. This preference can also be set by
editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter item name.
Column widths are defined using the ITEM_object_widths_hidden user preference.
DEFAULT
VALUES
uom_tag
release_status_list
revision_limit
revision_number
date_released
archive_info
last_mod_user
owning_group
last_mod_date
archive_date
creation_date
backup_date
IMAN_master_form
IMAN_specification
IMAN_manifestation
IMAN_requirement
IMAN_reference
IMAN_master_data
DEFAULT
PROTECTION
SCOPE
User preference.

ITEM_object_columns_shown

DESCRIPTION
Determines which item object columns are displayed. This preference can also be
set by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter object name.
Column widths are defined using the ITEM_object_widths_shown user preference.
DEFAULT
VALUES
item_id
object_name
object_type
owning_user
object_desc

PLM00026 11.2 Preferences and Environment Variables Reference 12-41

 Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

ITEM_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
ITEM_object_columns_hidden user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the ITEM_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
14
32
6
6
32
13
16
16
16
16
32
32
32
32
32
32
32
32
DEFAULT
PROTECTION
SCOPE
User preference.

ITEM_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
ITEM_object_columns_shown user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the ITEM_object_columns_shown user preference, and so on.

12-42 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

DEFAULT
VALUES
20
20
16
16
32
DEFAULT
PROTECTION
SCOPE
User preference.

<Item>.SUMMARYRENDERING2007

DESCRIPTION
Registers the summary style sheet of the My Teamcenter 2007 item.
The summary style sheet refers to the Summary tab in My Teamcenter 2007.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES

Item name Default values

Folder FolderSummary2007
Item ItemSummary2007
ItemRevision ItemRevisionSummary2007
Dataset DatasetSummary2007

DEFAULT
PROTECTION
SCOPE
Site preference.

<ItemRevision>.RENDERING

DESCRIPTION
Registers the properties of the item revision.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
Name of the item revision.
Sci0ItemRevision: If the Substance Compliance IMDS Integration solution is installed.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-43

 Chapter
Chapter 12:12:ClientClient preferences
preferences

<ItemRevision1>_<ItemRevision2>_default_relation

DESCRIPTION
Specifies the default relation between source object (item revision 1) and target
object (item revision 2).
VALID
VALUES
Single string value indicating the valid relation type.
DEFAULT
VALUES
CPTechnicalBriefRevision_CPPackageRoughRevision_default_relation=CP_Results_In_Package_Rough
CPMarketingBriefRevision_CPDesignBriefRevision_default_relation=CP_Has_Design_Brief
CPMarketingBriefRevision_CPTechnicalBriefRevision_default_relation=CP_Has_Technical_Brief
CPThemeBoardRevision_CPGraphicElementRevision_default_relation=CP_Has_Graphical_Element
CPDesignBriefRevision_CPGraphicElementRevision_default_relation=CP_Has_Graphical_Element

DEFAULT
PROTECTION
SCOPE
Site preference.

<ItemRevision>.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet of the item revision.
The summary style sheet refers to the Summary tab in My Teamcenter.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES

Item name Default values

WorkspaceObject WorkspaceObjectSummary
CPBrandEquityRevision CPBrandEquityRevisionSummary
CPMarketingBriefRevision CPMarketingBriefRevisionSummary
CPDesignBriefRevision CPDesignBriefRevisionSummary
CPTechnicalBriefRevision CPTechnicalBriefRevisionSummary
CPPackageRoughRevision CPPackageRoughRevisionSummary
CPPackageConceptRevision CPPackageConceptRevisionSummary
CPPackageItemRevision CPPackageItemRevisionSummary
CPDieLineRevision CPDieLineRevisionSummary
CPArtworkRevision CPArtworkRevisionSummary
CPGraphicElementRevision CPGraphicElementRevisionSummary
CPCopyRevision CPCopyRevisionSummary
CPCopyElementRevision CPCopyElementRevisionSummary
CPFinishProductRevision CPFinishProductRevisionSummary

12-44 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

Item name Default values

TC_Project • ProjectSummary

• CPGProjectSummary
Schedule ScheduleSummary
CPGFormulaMaterRevision CPGFormulaMaterRevisionSummary
CPGRawMaterialRevision CPGRawMaterialRevisionSummary
CPGIngredientRevision CPGIngredientRevisionSummary
CPGChemicalRevision CPGChemicalRevisionSummary
CPSpecificationRevision CPSpecificationRevisionSummary
CPThemeBoardRevision CPThemeBoardRevisionSummary
CPBrandAssetRevision CPBrandAssetRevisionSummary
CPTradeItemRevision CPTradeItemRevisionSummary

DEFAULT
PROTECTION
SCOPE
Site preference.

ItemRevision_default_relation

DESCRIPTION
Specifies the relation established when an object is pasted under an item revision.
The relation specified for this preference is the default relation established between
the source and the target item revision.
This preference also determines the relation used to attach a PLM XML dataset to an
item revision when saving the dataset from Lifecycle Visualization to Teamcenter with
the File→Save As command using the DAK adapter.
VALID
VALUES
Accepts a single string as a value. Must be a valid relation type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ITEMREVISION_object_columns_hidden

DESCRIPTION
Determines which item revision object columns are hidden. This preference can also
be set by editing column options directly from the interface.

PLM00026 11.2 Preferences and Environment Variables Reference 12-45

 Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter item revision
name. Column widths are defined using the ITEMREVISION_object_widths_hidden
user preference.
DEFAULT
VALUES
structure_revisions
object_type
revision_number
date_released
archive_info
owning_group
last_mod_user
creation_date
archive_date
last_mod_date
backup_date
DEFAULT
PROTECTION
SCOPE
User preference.

ITEMREVISION_object_columns_shown

DESCRIPTION
Determines which item revision object columns are displayed. This preference can
also be set by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter object name.
Column widths are defined using the ITEMREVISION_object_widths_shown user
preference.
DEFAULT
VALUES
items_tag
item_revision_id
object_name
owning_user
object_desc
release_status_list
DEFAULT
PROTECTION
SCOPE
User preference.

12-46 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

ITEMREVISION_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
ITEMREVISION_object_columns_hidden user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the ITEMREVISION_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
32
32
32
32
32
32
32
32
32
32
32
DEFAULT
PROTECTION
SCOPE
User preference.

ITEMREVISION_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
ITEMREVISION_object_columns_shown user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the ITEMREVISION_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
10
20
16
32
32
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-47

 Chapter
Chapter 12:12:ClientClient preferences
preferences

ItemRevision_shown_relations

DESCRIPTION
Determines which relations display within an item revision.
VALID
VALUES
Accepts one or more strings as a value; each string must be a valid Teamcenter
relation type.
DEFAULT
VALUES
PSBOMViewRevision
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_UG_udf
IMAN_UG_altrep
IMAN_UG_scenario
IMAN_Simulation
IMAN_Rendering
IMAN_Motion
IMAN_MEMfgModel
IMAN_snapshot
IMAN_3D_snap_shot
IMAN_external_object_link
IMAN_MEWorkInstruction
TC_ProductManual
BOM_Rollup
TC_Attaches
TCEng_rdv_plmxml_configured
TC_Is_Represented_By
TCEng_rdv_plmxml_unconfigured
Snapshot
#IMAN_classification
Note

You must uncomment the IMAN_classification value for this value to display.

DEFAULT
PROTECTION
SCOPE
Site preference.

ItemRevision_thumbnail_relations

DESCRIPTION
Defines priority of relations between item revision and dataset. Teamcenter uses this
priority to determine the dataset to be used to generate thumbnail.

12-48 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

VALID
VALUES
Accepts relationship types.
DEFAULT
VALUES
IMAN_specification
IMAN_manifestation
IMAN_Rendering
IMAN_Motion
IMAN_3D_snap_shot
TC_Attaches
DEFAULT
PROTECTION
SCOPE
Site preference.

ItemRevision_thumbnail_references

DESCRIPTION
Defines priority of reference types for datasets in an item revision. Teamcenter uses
this priority to determine the dataset to be used to generate thumbnail.
VALID
VALUES
Reference types for datasets.
DEFAULT
VALUES
TIF_Reference
JPEG_Reference
AI_Reference
PDF_Reference
JTPART
UGPART
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

Item_shown_relations

DESCRIPTION
Determines which relations display within an item.
VALID
VALUES
Accepts one or more strings as a value; each string must be a valid Teamcenter
relation type.
DEFAULT
VALUES
PSBOMView
ItemRevision

PLM00026 11.2 Preferences and Environment Variables Reference 12-49

 Chapter
Chapter 12:12:ClientClient preferences
preferences

IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_external_object_link
#IMAN_classification
Note

You must uncomment the IMAN_classification value for this value to display.

DEFAULT
PROTECTION
SCOPE
Site preference.

ITEM_smart_baseline

DESCRIPTION
Determines whether the systems functions in smart copy mode, in which only items
that have changed since the previous baseline are copied into the new baseline and
unchanged items are referenced. This contrasts with standard mode, where each item
is copied into the new baseline, regardless of whether it had changed.
VALID
VALUES
true System uses smart copy mode.

false System uses standard mode.

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

<Item type>_rev_display_all

DESCRIPTION
Determines whether to display all item revisions or only the item revisions meeting
the filter criteria defined in the Revision display filter options of the Options dialog
box in the rich client interface. Users set these display options to filter the display of
item revisions in the Teamcenter interface, preventing item revisions they are not
interested in from displaying.
Item-type is the type of item selected from the Select item type dropdown list and
TRUE indicates the user selected that all item revisions display.
VALID
VALUES
TRUE Displays all item revisions.

FALSE Displays only the item revisions meeting the filter criteria.

12-50 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

<Item type>_rev_display_order

DESCRIPTION
Determines the order in which item revisions display if the Revision display filter
options are defined in the Options dialog box in the rich client interface. Users set
these display options to filter the display of item revisions in the Teamcenter interface,
preventing item revisions they are not interested in from displaying.
Item-type is the type of item selected from the Select item type dropdown list and 1
indicates the user selected the item revisions are displayed in descending order.
VALID
VALUES
0 Displays item revisions in ascending order.
1 Displays item revisions in descending order.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

<Item type>_rev_display_rule

DESCRIPTION
Determines which item revisions display if the Revision display filter options are
defined in the Options dialog box in the rich client interface. Users set these display
options to filter the display of item revisions in the Teamcenter interface, preventing
item revisions they are not interested in from displaying.
For example, users can filter the item revision display so that only released item
revisions of production status matching the configured revision rule of Any status,
working displays with the following setting:
Item_rev_display_rule=
3:=: Production:
4:=:Any status, working:

In another example, users can filter the item revision display so that only three item
revisions whose statuses are not prereleased, two of which are in process, display
with the following setting:
Item_rev_display_rule=
3:!=:Pre-Released:3
2: : :2

PLM00026 11.2 Preferences and Environment Variables Reference 12-51

 Chapter
Chapter 12:12:ClientClient preferences
preferences

For more information about setting these rules in the rich client interface, see
Teamcenter Basics.
VALID
VALUES
One or more strings as values; each string in the following format:
status-number:relation-operator:condition:limit
• status-number accepts integers 1 through 4, each integer defining a particular
status.
• relation-operator accepts either the equal sign (=) meaning equal or an
exclamation point and equal sign (!=) meaning not equal.
• condition accepts a valid release status or revision rule.
• limit accepts a positive integer.

relation-operator is valid only when the status-number is set to released (3); there are
no further conditions to define for the working (1) and in process (2) statuses, and a
relation operator is not appropriate for configured revisions.
When released (3) or configured (4) is set for the status, condition accepts any valid
release status or revision rule.
1 Working.
2 In process.
3 Released.
4 Configured.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

JTTreeTableColumnsShownPref

DESCRIPTION
Determines which JT tree table columns are displayed for JT export using PLM XML.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Structure Manager
attribute.
DEFAULT
VALUES
bl_indented_title
bl_jt_editable
DEFAULT
PROTECTION
SCOPE
Site preference.

12-52 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

JTTreeTableShownColumnWidthsPref

DESCRIPTION
Specifies the column width for each column defined in the
JTTreeTableColumnsShownPref preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the JTTreeTableColumnsShownPref preference, and so on.
DEFAULT
VALUES
40
5
DEFAULT
PROTECTION
SCOPE
Site preference.

MECollaborationContext_default_relation

DESCRIPTION
Determines the default relation for MECollaborationContext types.
VALID
VALUES
Accepts one or more strings as a value; each string must be a valid Teamcenter object
type.
DEFAULT
VALUES
IMAN_CCContext
DEFAULT
PROTECTION
SCOPE
User preference.

MEOPRevision_shown_relations

DESCRIPTION
Determines which relations display within a MEOP revision.
VALID
VALUES
Accepts one or more strings as a value; each string must be a valid Teamcenter
relation type.
DEFAULT
VALUES
PSBOMViewRevision
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference

PLM00026 11.2 Preferences and Environment Variables Reference 12-53

 Chapter
Chapter 12:12:ClientClient preferences
preferences

IMAN_MEOutput
IMAN_METarget
IMAN_MEWorkArea
IMAN_3D_snap_shot
DEFAULT
PROTECTION
SCOPE
Site preference.

MEProcessRevision_shown_relations

DESCRIPTION
Determines which relations display within a MEProcess revision.
VALID
VALUES
Accepts one or more strings as a value; each string must be a valid Teamcenter
relation type.
DEFAULT
VALUES
PSBOMViewRevision
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEOutput
IMAN_METarget
IMAN_MEWorkArea
IMAN_3D_snap_shot
DEFAULT
PROTECTION
SCOPE
Site preference.

Multiple_revise_dialog_visible

DESCRIPTION
Specifies whether the Multiple Revise dialog box is displayed when revising multiple
objects.
VALID
VALUES
True or False
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

12-54 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

MyTeamcenterQuickLinksSection

DESCRIPTION
Defines an array of strings representing the section components seen in the left-hand
Quick Links navigation pane in the rich client. This is a user preference.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
HomeSectionComponent
InboxSectionComponent
SavedSearchesSectionComponent
WebLinksSectionComponent
MyViewMarkupSectionComponent

DEFAULT
PROTECTION
SCOPE
User preference.

OpenAfterCreatePref

DESCRIPTION
Determines whether to open an object immediately after creating it.
VALID
VALUES
0 Does not open an object immediately after creating it.
1 Opens an object immediately after creating it.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

PERSON_object_columns_hidden

DESCRIPTION
Determines which person columns are hidden. This preference can also be set by
editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter person
name. Column widths are defined using the PERSON_object_widths_hidden user
preference.
DEFAULT
VALUES
PA5

PLM00026 11.2 Preferences and Environment Variables Reference 12-55

 Chapter
Chapter 12:12:ClientClient preferences
preferences

PA7
PA8
archive_info
owning_group
last_mod_user
owning_user
creation_date
archive_date
last_mod_date
backup_date
PA6
DEFAULT
PROTECTION
SCOPE
User preference.

PERSON_object_columns_shown

DESCRIPTION
Determines which person columns are displayed. This preference can also be set by
editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter person
name. Column widths are defined using the PERSON_object_widths_shown user
preference.
DEFAULT
VALUES
user_name
PA1
PA2
PA3
PA4
PA10
PA9
DEFAULT
PROTECTION
SCOPE
User preference.

PERSON_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
PERSON_object_columns_hidden user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the PERSON_object_columns_hidden user preference, and so on.

12-56 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

DEFAULT
VALUES
32
32
32
32
32
32
32
32
32
32
32
32
DEFAULT
PROTECTION
SCOPE
User preference.

PERSON_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
PERSON_object_columns_shown user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the PERSON_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
20
16
10
10
16
20
DEFAULT
PROTECTION
SCOPE
User preference.

PSBOMVIEW_object_columns_hidden

DESCRIPTION
Determines which BOM view columns are hidden. This preference can also be set by
editing column options directly from the interface.

PLM00026 11.2 Preferences and Environment Variables Reference 12-57

 Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter BOM view
name. Column widths are defined using the PSBOMVIEW_object_widths_hidden
user preference.
DEFAULT
VALUES
revision_number
archive_info
last_mod_user
creation_date
archive_date
last_mod_date
backup_date
date_released
owning_group
DEFAULT
PROTECTION
SCOPE
User preference.

PSBOMVIEW_object_columns_shown

DESCRIPTION
Determines which BOM view columns are displayed. This preference can also be set
by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter BOM view
name. Column widths are defined using the PSBOMVIEW_object_widths_shown
user preference.
DEFAULT
VALUES
parent_item
object_name
object_type
owning_user
dobject_desc
release_status_list
DEFAULT
PROTECTION
SCOPE
User preference.

PSBOMVIEW_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
PSBOMVIEW_object_columns_hidden user preference.

12-58 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the PSBOMVIEW_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
32
32
32
32
32
32
32
32
322
DEFAULT
PROTECTION
SCOPE
User preference.

PSBOMVIEW_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
PSBOMVIEW_object_columns_shown user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the PSBOMVIEW_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
20
10
16
32
32
DEFAULT
PROTECTION
SCOPE
User preference.

PSBOMVIEWREVISION_object_columns_hidden

DESCRIPTION
Determines which BOM view revision columns are hidden. This preference can also
be set by editing column options directly from the interface.

PLM00026 11.2 Preferences and Environment Variables Reference 12-59

 Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter
BOM view revision name. Column widths are defined using the
PSBOMVIEWREVISION_object_widths_hidden user preference.
DEFAULT
VALUES
is_precise
bom_view
revision_number
date_released
archive_info
owning_group
last_mod_user
creation_date
archive_date
last_mod_date
backup_date
DEFAULT
PROTECTION
SCOPE
User preference.

PSBOMVIEWREVISION_object_columns_shown

DESCRIPTION
Determines which BOM view revision columns are displayed. This preference can also
be set by editing column options directly from the interface.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter
BOM view revision name. Column widths are defined using the
PSBOMVIEWREVISION_object_widths_shown user preference.
DEFAULT
VALUES
object_name
object_type
owning_user
object_desc
occs_vla
release_status_list
DEFAULT
PROTECTION
SCOPE
User preference.

12-60 Preferences and Environment Variables Reference PLM00026 11.2

 Client preferences

PSBOMVIEWREVISION_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
PSBOMVIEWREVISION_object_columns_hidden user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the PSBOMVIEWREVISION_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
32
32
32
32
32
32
32
32
32
32
32
DEFAULT
PROTECTION
SCOPE
User preference.

PSBOMVIEWREVISION_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
PSBOMVIEWREVISION_object_columns_shown user preference.
VALID
VALUES
One or more integers as values; each integer defines the column width in characters.
The first value set in this preference defines the column width of the first value set in
the PSBOMVIEWREVISION_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
18
16
32
32
32
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-61

 Chapter
Chapter 12:12:ClientClient preferences
preferences

QuickLinksSection

DESCRIPTION
Defines an array of strings representing the section components seen in the left-hand
Quick Links navigation pane in the rich client. This is a user preference.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
HomeSectionComponent
InboxSectionComponent
SavedSearchesSectionComponent
WebLinksSectionComponent
MyViewMarkupSectionComponent

DEFAULT
PROTECTION
SCOPE
User preference.

ReferencersPane_Shown

DESCRIPTION
Determines whether the Referencers pane appears in My Teamcenter. Users can use
this pane to graphically display reference information regarding the selected object.
VALID
VALUES
True The Referencers option appears in the shortcut menu.

False The Referencers option does not appear.

DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
User preference.

RESERVATION_object_columns_hidden

DESCRIPTION