Download as pdf or txt
Download as pdf or txt
You are on page 1of 1654

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
Determines which reservation 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 reservation
name. Column widths are defined using the RESERVATION_object_widths_hidden
user preference.

12-62 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
VALUES
release_status_list
revision_number
archive_info
last_mod_user
object_desc
date_released
owning_group
creation_date
archive_date
last_mod_date
backup_date
DEFAULT
PROTECTION
SCOPE
User preference.

RESERVATION_object_columns_shown

DESCRIPTION
Determines which reservation 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 reservation
name. Column widths are defined using the RESERVATION_object_widths_shown
user preference.
DEFAULT
VALUES
objects
object_name
object_type
owning_user
node
path
DEFAULT
PROTECTION
SCOPE
User preference.

RESERVATION_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
RESERVATION_object_columns_hidden user preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-63


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

RESERVATION_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
RESERVATION_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 RESERVATION_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
20
16
32
20
40
DEFAULT
PROTECTION
SCOPE
User preference.

12-64 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

Revision_Name_Based_On_ItemRevision

DESCRIPTION
Specifies whether revision names displayed in the rich client Revise dialog box are
based on item revision names or item names.
VALID
VALUES
true Revision names are based on item revision names.

false Revision names are based on item names.


DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

Selection Criteria

DESCRIPTION
Determines which attachments are checked in and out with the selected item revision.
Use either the Selection Criteria preference or the Select IR preference to allow
checking item revisions in and out. If both preferences are specified, the values of the
Selection Criteria take precedence. If only the Select IR preference is set, the item
revision objects are selected without attachments.
VALID
VALUES
Valid values are in the format TypeInternalName followed by 10 spaces and then the
RelationInternalName.
DEFAULT
VALUES
UGMASTER IMAN_Specification
UGPART IMAN_Specification
DEFAULT
PROTECTION
SCOPE
User preference.

Select IR

DESCRIPTION
Determines whether to include the defined item revisions in check in and check out
operations. This same criteria can also be set by users in the interface.

Note

Use either the Selection Criteria preference or the Select IR preference to


allow checking item revisions in and out.

PLM00026 11.2 Preferences and Environment Variables Reference 12-65


Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
Yes Includes the defined item revisions in the check in and check out operations.

No Does not include the defined item revisions in the check in and check out
operations.
DEFAULT
VALUES
Yes
DEFAULT
PROTECTION
SCOPE
User preference.

Structure_Alias_File

DESCRIPTION
Determines the alias file applied to the intermediate data capture object to display
its BOM structure. 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.

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/structure_alias.xml
DEFAULT
PROTECTION
SCOPE
Site preference.

12-66 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

TC_AE_<datasettype>_Default_View_Tool

DESCRIPTION
Specifies the tool used by default to view datasets of a particular type. This setting
overrides the first tool listed in the Tools for View list for that particular dataset type.
Use the Tools for View list to specify tools that can be used to view datasets.
The default viewing tool (defined either with this preference, or as the first tool listed in
the Tools for View list) determines which dataset tool is used when opening datasets
from the View command on the File menu.
VALID
VALUES
Accepts a single string as a value. Must be a valid Teamcenter tool name. Tools are
defined in the Business Modeler IDE application.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site and user preference.

TC_Allow_Longer_ID_Name

DESCRIPTION
Specifies a maximum for name and ID attributes.
VALID
VALUES
true Allows a maximum size of 128 characters for name and ID attributes.

false Sets the maximum size for name and ID attributes at 32 characters.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Auto_Checkout

DESCRIPTION
Enables or suppresses automatic implicit check out of non-NX datasets. Implicit check
out automatically prevents users from gaining write access to a non-NX dataset
if another user has opened it.
VALID
VALUES
ON Enables automatic implicit check out.

OFF Suppresses automatic implicit check out.

PLM00026 11.2 Preferences and Environment Variables Reference 12-67


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_auto_delete_folder_references

DESCRIPTION
Specifies whether to display error messages when an object being deleted is
referenced in other folders.
VALID
VALUES
true Disables display of an error message when an object being deleted is
referenced in other folders.
References from folders to the object being deleted are removed.
Note

Error messages are displayed if the object being deleted is referenced


by objects other than folders.

false Displays an error message when an item being deleted is referenced in other
folders or by other objects.
DEFAULT
VALUE
true
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_auto_login

DESCRIPTION
Enables or suppresses the automatic logon feature for the entire site. Autologon uses
operating system user names and passwords to log on to Teamcenter.

12-68 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

Note

For automatic logon, there are two options:


• The recommended method is to use the Security Services AutoLogin
applet for secure automatic logon using any Teamcenter client or command
line utility.
For information about using the Security Services AutoLogin applet, see
Security Services Installation/Customization.

• Alternatively, the less-secure TC_auto_login preference can be used to


enable command line utilities. This is recommended for command line
utilities only and not for logging on to the rich client.
To enable automatic logon, set enableAutologin=true in the
client_specific.properities file. This method requires the user to click a
Login button in the Teamcenter logon window for automatic logon with
operating system user names and passwords. To log on as a different user,
rather than using the operating system user name and password, a user can
enter a different user name, password, group, and role on the logon window.

VALID
VALUES
TRUE Enables automatic logon.

FALSE Suppresses automatic logon.


DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_check_out_dir

DESCRIPTION
Specifies the operating system directory that contains exported dataset files.

• This preference is read only if the Export Dataset On Check-Out check box is
selected in the checkout dialog box.

• If the TC_checkout_and_export preference is set to 1, the Export Dataset On


Check-Out check box is automatically selected.

VALID
VALUES
Single string as a value; each string must be the full operating system path of the
directory or a null value.

The null value exports the files to the current working operating system directory.

PLM00026 11.2 Preferences and Environment Variables Reference 12-69


Chapter
Chapter 12:12:ClientClient preferences
preferences

Note

When a Windows path is used, a double slash is required after the drive
designation, for example:
TC_check_out_dir=c:\\temp

DEFAULT
VALUES
Windows:
c:\\temp
UNIX:
/tmp
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_checkout_and_export

DESCRIPTION
Specifies whether Teamcenter exports the file to an operating system directory at the
time of checking out a dataset.
VALID
VALUES
0 Do not export the files to the operating system on checkout.
1 Export files on checkout.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
User preference.

TC_ContextmenuSuppression

DESCRIPTION
Refers to dataset name that specifies the suppression definition for a specific group or
role.
VALID
VALUES
Dataset names of Fnd0ContextMenuSuppRuleXML dataset type. For example:
EngineeringGroup
AuthorRole
DEFAULT
VALUES
None.

12-70 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
Preference should always point to a dataset that exists inside Teamcenter. User
should always have read access to the dataset.

TC_control_wildcard

DESCRIPTION
Specifies the number of characters that must be entered before a wildcard character is
entered in a search field. The wildcard character is an asterisk (*).
VALID
VALUES
0 No wildcard restrictions; a wildcard can be used alone or with any
combination of valid characters.

Positive The positive integer indicates the number of characters that must be entered
integer in a search field before the wildcard character can be entered.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_control_wildcard_exception

DESCRIPTION
Specifies the number of characters that must be entered before a wildcard character is
entered in a search field for a specific POM_string attribute of a class. The wildcard
character is an asterisk (*). In the following example, the user must enter at least three
characters in the item search field before a wildcard character can be entered.
TC_control_wildcard_exception=
Item.item_id:3
VALID
VALUES
Valid class name, valid attribute name and a positive integer in the following format:
class-name.attribute-name:positive-integer
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-71


Chapter
Chapter 12:12:ClientClient preferences
preferences

TC_CreateRenderingInheritTypeList

DESCRIPTION
Lists the business object types that allow inheritance of creation rendering style
sheets. Valid values are the business object type names. When a business object
type name is added to this list, the rich client searches through the type hierarchy to
determine the creation style sheet to use.
If a parent type is added, its subtypes are not automatically checked for create
rendering inheritance. The type names added to this preference do not include the
subtypes.
The <type_name>.CREATERENDERING preference defines the create rendering
settings for the parent business object types.
VALID
VALUES
Accepts valid business object type names.
DEFAULT
VALUES
CompositionContext
ConfiguredTechnicalPortfolio
MECollaborationContext
MENCProgram
MENCToolActivity
MEPlantContext
MEProcessContext
MEProductContext
MEResourceContext
MEWorkpiece
Mfg0MEIPA
PrivateAppGrp
PrivateContext
SpecContext
UsageCompareResultsView
VisStructureContext

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_days_non_login_timeout

DESCRIPTION
Determines whether to allow user logon, based on the number of days that have
passed since the user's last recorded logon. Use as a security method to disable logon
for users who have not logged into the system for a specified number of days.
At logon, the system reads the last logon date/time. If the value for the last logon is
NULL, if this preference is not set, or if the last logon time falls within the time period
specified by this preference, then user logon is allowed. The current date/time is
written to the last logon value.

12-72 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

VALID
VALUES
Accepts a single, positive integer as a value. The value represents days.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_DISABLE_FLASH

DESCRIPTION
Enables or suppresses display of the Teamcenter logo (flash screen) while the
workspace is loading. Setting this preference to any value disables the loading of the
flash screen. Leaving this preference unset enables the loading of a flash screen
and points this preference to the IMAN_FLASH_FILE preference, which defines the
specific flash file to be loaded.
VALID
VALUES
Any value (for example, ON, TRUE, or YES).
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

TC_display_group_names_limit

DESCRIPTION
Specifies the limit for the display of group names.
VALID
VALUES
0 or Displays the full group name.
undefined.
1 Displays the first component of the group name.
2 Displays the first two components of the group name; the rest of the full group
name is truncated. An ellipses (...) is appended to the name to indicate the
truncation.
3 Displays the first three components of the group name; the rest of the full
group name is truncated. An ellipses (...) is appended to the name to indicate
the truncation.
4 Displays four or more components of the group name.
DEFAULT
VALUES
0

PLM00026 11.2 Preferences and Environment Variables Reference 12-73


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

TC_display_real_prop_names

DESCRIPTION
Determines whether to display real property names in the rich client.
VALID
VALUES
0 Does not display real property names in the rich client.
1 Displays real property names in the rich client.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
User preference.

TC_display_thumbnail_in_UI

DESCRIPTION
Shows or hides thumbnails in the rich client.
Note

Use this preference with the Enable_thumbnails preference so that


Teamcenter generates small thumbnail images using Dispatcher. Teamcenter
downloads these small thumbnails to the rich client for efficient display. If small
thumbnails are not generated, Teamcenter uses the original image file of the
dataset. This will have performance implication on the rich client for large size
images.

VALID
VALUES
true Shows thumbnails.
false Hides thumbnails.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

12-74 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

TC_Enable_Implicit_CO

DESCRIPTION
Determines whether implicit checkout, save, and checkin is enabled in the Properties
dialog box, form dialog boxes, the Viewer view, and the Summary view.
For more information, see Teamcenter Basics.
VALID
VALUES
true Users can implicitly check out, save, and check in objects using the Properties
dialog box, form dialog boxes, the Viewer view, and the Summary view.

false Users click Check-Out and Edit to modify the object.


DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Enable_Legacy_Create

DESCRIPTION
Determines if either the legacy or the generic dialog box is displayed for the File→New
command for item, folder, and form objects. If no value is specified, the new generic
dialog box is displayed by default. If a value is specified (a type internal name, for
example, Item), the legacy dialog box associated to the given type is displayed.
Note

This preference must be added. It is not an out-of-the-box preference.

VALID
VALUES
Item

Show the legacy create item dialog box by choosing File→New→Item in the rich client.

Folder

Show the legacy create folder dialog box by choosing File→New→Folder in the rich client.

Form

Show the legacy create form dialog box by choosing File→New→Form in the rich client

No Value

Show the generic create item, folder, form wizard by choosing File→New→Item,
File→New→Folder, or File→New→Form in the rich client.

PLM00026 11.2 Preferences and Environment Variables Reference 12-75


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
VALUES
No Value
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Enable_LegacySaveAs

DESCRIPTION
Specifies whether the legacy Save As dialog box is displayed for all types in the
rich client.
VALID
VALUES
true Activates the legacy Save As dialog box for all types in the rich client.

false Activates the new Save As wizard for all types in the rich client.
Note

The Schedule, ScheduleRevision, StructureContext,


ConfigurationContext, CCObject, PSBOMView,
PSBOMViewRevision, GDELine,GDELinkLine, and GDEBOPLine
types use the legacy dialog, even if the TC_Enable_LegacySaveAs
preference is set to false.

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Graph_Node_Thumbnail_Shown

DESCRIPTION
Determines whether thumbnail preview images appear above the type name and
symbol in the graphical display of the Generic Relation Browser view.
Note

Enable the Referencers pane with the ReferencersPane_Shown preference.

VALID
VALUES
True Thumbnail preview images appear in the Generic Relation Browser view if
an image is associated with the selected object.

False Thumbnail preview images do not appear in the Generic Relation Browser
view.

12-76 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
User preference.

TC_GROUP_PFILE

DESCRIPTION
Points to the operating system directory containing group preference files.
VALID
VALUES
A single string; this string must be the full operating system path name to the directory.
DEFAULT
VALUES
None.
The Windows default setting %TC_DATA%\gpfiles and the UNIX default setting
$TC_DATA/gpfiles are commented out.
DEFAULT
PROTECTION
SCOPE
User preference.

TC_ImpactAnalysis_Display_Limit

DESCRIPTION
Defines the maximum number of objects that can be displayed in the Teamcenter rich
client Impact Analysis view when performing a where-referenced, all-level search.
Note

Using a value greater than the default value can cause failure.

VALID
VALUES
Any positive integer.
DEFAULT
VALUES
500
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_inbox_interval

DESCRIPTION
Determines how often, in minutes, Teamcenter checks a user's inbox for new tasks.

PLM00026 11.2 Preferences and Environment Variables Reference 12-77


Chapter
Chapter 12:12:ClientClient preferences
preferences

Note

A small interval, less than 20 minutes, can severely impact performance of a


large database with many users.

VALID
VALUES
1 Disables checking.

0 Checks once during user logon.

time-in-minutes Checks after the defined interval.


DEFAULT
VALUES
15
DEFAULT
PROTECTION
SCOPE
User preference.

TC_<datasettype>_Tool

DESCRIPTION
Specifies the default software application (the Teamcenter tool) used to open the
dataset type specified in the preference name using the System→Open command.
Each dataset type requires a separate preference. For example, TC_UGPART_Tool
and TC_UGMASTER_Tool must be separate preferences.
Set each preference to the latest version of NX present on the system or to the
required software application. For example:
TC_UGMASTER_Tool=
UGII V10-ALL
TC_UGPART_Tool=
UGII V10-ALL
TC_Text_Tool=
NoteEditor
VALID
VALUES
System name of the required software application.
DEFAULT
VALUES
TC_UGMASTER_Tool=
UGII V10-ALL
TC_UGPART_Tool=
UGII V10-ALL
TC_Text_Tool=
NoteEditor
DEFAULT
PROTECTION
SCOPE
Site preference.

12-78 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

TC_markup_named_ref

DESCRIPTION
Specifies the named references that have viewable image files. The named references
of any datasets that require view and markup functionality must be defined in this
preference.
VALID
VALUES
One or more strings as values.
DEFAULT
VALUES
Image
Quickshade-Image
PLT
BMP
CAL
TIFF
Graphics-Interface
JTPART
Sheet
DEFAULT
PROTECTION
SCOPE
User preference.

TC_max_display_thumbnails

DESCRIPTION
Specifies the maximum number of thumbnails that are displayed in the Viewer tab
when selecting multiple objects.
VALID
VALUES
Any integer from 2 to 48, including 2 and 48.
DEFAULT
VALUES
16
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_max_number_of_retries

DESCRIPTION
Sets the number of times Teamcenter retries an operation when it encounters a
database-level (Oracle or SQL Server) lock before reporting an error. The time interval
between retries is set by the TC_retry_time preference.
The value set in this preference may be overridden by the rdv_import_usage utility
when usages are loaded.

PLM00026 11.2 Preferences and Environment Variables Reference 12-79


Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
A single positive integer.
DEFAULT
VALUES
6
DEFAULT
PROTECTION
SCOPE
User preference.
This preference may also be set in an environment variable.

TC_name_delimiter

DESCRIPTION
Specifies an ASCII character used as a delimiter in the person name string.
Teamcenter stores the entire person name (last name, first name, middle name
or initial) as a single string in the database. However, sometimes (such as with the
Teamcenter/STEP Translator) this information must be handled separately. This
delimiter partitions the person name such that another application can break this
single string into multiple strings.
VALID
VALUES
A single ASCII character.
DEFAULT
VALUES
A comma (,).
DEFAULT
PROTECTION
SCOPE
User preference.

TC_name_sequence

DESCRIPTION
Sets the order in which person information (last name, first name, middle name or
initial) is imported and exported from the database.
VALID
VALUES
One or more of the following values:
first First name.
middle Middle name or initial.
last Last name.
space ASCII soft space character.
delimiter ASCII character defined in the TC_name_delimeter preference.
prefix_titles Prefix; for example: Mr., Mrs., Dr.
suffix_titles Suffix; for example: Jr., Ph.D.

12-80 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
VALUES
last
delimiter
space
first
DEFAULT
PROTECTION
SCOPE
User preference.

TC_pattern_match_style

DESCRIPTION
Specifies the wildcard character used for all searches and queries.
VALID
VALUES
1 SQL style: uses the percent sign (%) for multicharacter replacement and an
underscore (_) for single-character replacement.
2 UNIX style: uses an asterisk (*) for multicharacter replacement and a period
(.) for single-character replacement.
3 Windows style: uses an asterisk (*) for multicharacter replacement and a
question mark (?) for single-character replacement.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
User preference.

TC_RelationBrowser_Context

DESCRIPTION
Defines the default context to be selected in the Relation Browser view of the rich
client.
VALID
VALUES
The valid value can be found in the Context tag of the graph_config.xml file.
DEFAULT
VALUES
com.teamcenter.rac.tcgrb.ctx.Default
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-81


Chapter
Chapter 12:12:ClientClient preferences
preferences

TC_remove_file_on_check_in

DESCRIPTION
Determines whether to delete previously exported files from the operating system
directory specified by the TC_check_out_dir preference. This preference is only read
if the TC_checkout_and_export preference is set to 1.
VALID
VALUES
0 Does not delete existing files from the directory during an explicit checkin
while cancelling a checkout.

1 Deletes existing files from the directory during an explicit checkin or while
cancelling a checkout.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_retry_time

DESCRIPTION
Determines how often, in seconds, Teamcenter retries an operation when it encounters
a database-level (Oracle or SQL Server) lock before reporting an error. The number of
retries is defined by the TC_max_number_of_retries preference.
The value set in this preference may be overridden by the rdv_import_usage utility
when usages are loaded.
VALID
VALUES
A single positive integer.
DEFAULT
VALUES
5
DEFAULT
PROTECTION
SCOPE
User preference.
This preference may also be set in an environment variable.

TC_ROLE_PFILE

DESCRIPTION
Points to the operating system directory containing role preference files.
VALID
VALUES
A single string; this string must be the full operating system path name to the directory.

12-82 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
VALUES
None.
The Windows default setting %TC_DATA%\rpfiles and the UNIX default setting
$TC_DATA/rpfiles are commented out.
DEFAULT
PROTECTION
SCOPE
User preference.

TC_SaveAsRenderingInheritTypeList

DESCRIPTION
Lists the business object types that allow inheritance of save as rendering style sheets.
Valid values are the business object type names. When a business object type name
is added to this list, the rich client searches through the type hierarchy to determine
the save as style sheet to use.
If a parent type is added, its subtypes are not automatically checked for save as
rendering inheritance. The type names added to this preference do not include the
subtypes.
The <type_name>.SAVEASRENDERING preference defines the save as rendering
settings for the parent business object types.
VALID
VALUES
Accepts valid business object type names.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_show_checkedout_icon

DESCRIPTION
Enables the display of the checked-out symbol in BOM trees, attachment trees, activity
trees and occurrence group trees, and also in the My Teamcenter view, the Search
Results view, and in detail views.
VALID
VALUES
True The checked-out symbol is displayed in the Structure Manager and My
Teamcenter views. This enhances usability, but it can impact rich client
performance when expanding tree nodes.
False The checked-out symbol is not displayed in the Structure Manager and My
Teamcenter views. This reduces network and database activity and therefore
improves performance compared to the default setting.

PLM00026 11.2 Preferences and Environment Variables Reference 12-83


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
All.

TC_suppress_Edit_Latest_Menu

DESCRIPTION
Enables or suppresses the Edit Latest command in the rich client. This menu
command updates all version-0 datasets to reference the latest saved version in
the database.

Note

This feature is useful in a network environment when multiple users are working
on the same dataset.

VALID
VALUES
TRUE Enables the Edit Latest command in the rich client.

FALSE Suppresses the Edit Latest command in the rich client.


DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_suppress_inactive_group_members

DESCRIPTION
Determines whether all group members or only active group members are displayed in
Teamcenter interfaces. You must set this preference and then relaunch Teamcenter to
activate the display suppression for the thin client. In the rich client, you can switch
between suppress or display inactive group members using the button located on the
Group panel of Organization.

Note

Before using the make_user utility to activate or deactivate group members,


you must set this preference to 0 (zero).

VALID
VALUES
0 Allows system administrators and group administrators to view both active
and inactive group members.

12-84 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

1 Allows system administrators and group administrators to view only active


group members in the group members dialog in applications requiring system
administrator status.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
User preference.

TC__thumbnail_dataset_type_order

DESCRIPTION
Lists the named references order that the preview image is searched.

This preference overrides the order provided in the


TCThumbnail2DFileProvider_OrderedNamedReferences node of the
thumbnail.properties file:
TCThumbnail2DFileProvider_OrderedNamedReferences=Image,ThumbnailImage,
Fnd0IconResourceReference,JPEG_Reference,PNG_Reference,GIF_Reference,
TIF_Reference,UG-QuickAccess-Binary,SE-QuickAccess-Binary,Graphics-Interface,
Markup,BMP,JPEG,Shaded-Image,Mes0BMP,Mes0JPG,Mes0GIF,Mes0PNG,Mes0TIF,
Mes0JPG_Preview

The thumbnail.properties file is found in the following location:


TC_ROOT\portal\plugins\com.teamcenter.rac.viewer_version.jar\
com\teamcenter\rac\viewer\thumbnail\

Rather than using this preference, you can also set the order by creating your own
thumbnail_user.properties file and including it in your custom plug-in.

For instructions about how to create *_user.properties files, see Client Customization.

Note

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


require this functionality, you must create the preference. When you create the
preference name, you must include two underscores after TC.
For information about creating and using preferences, see Teamcenter Basics.

VALID
VALUES
Any named references in a comma-separated list.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-85


Chapter
Chapter 12:12:ClientClient preferences
preferences

NOTES
The Active Workspace client uses the values set by the
TC__thumbnail_dataset_type_order preference.
• If not already defined, the TC__thumbnail_dataset_type_order preference is
created during installation of the Active Workspace client.

• If the TC__thumbnail_dataset_type_order preference is already defined prior to


installation of the Active Workspace client, the existing values and the new values
added for the Active Workspace client are merged.

When this preference is not defined, or is defined during Active Workspace installation,
the Active Workspace client uses the following default dataset type order:
Image
ThumbnailImage
Fnd0IconResourceReference
JPEG_Reference
PNG_Reference
GIF_Reference
TIF_Reference
UG-QuickAccess-Binary
SE-QuickAccess-Binary
Graphics-Interface
Markup
BMP
JPEG
Shaded-Image
Mes0BMP
Mes0JPG
Mes0GIF
Mes0PNG
Mes0TIF
Mes0JPG_Preview

TC__thumbnail_relation_order

DESCRIPTION
Lists the relation order that the preview image is searched.
This preference overrides the order provided in the
TCThumbnail2DFileProvider_OrderedRelationTypes node of the
thumbnail.properties file:
TCThumbnail2DFileProvider_OrderedRelationTypes=Thumbnail,IMAN_manifestation,
IMAN_specification,IMAN_Rendering,IMAN_Motion,IMAN_3D_snap_shot,
TC_Attaches,Fnd0DiagramSnapshot

The thumbnail.properties file is found in the following location:


TC_ROOT\portal\plugins\com.teamcenter.rac.viewer_version.jar\
com\teamcenter\rac\viewer\thumbnail\

Rather than using this preference, you can also set the order by creating your own
thumbnail_user.properties file and including it in your custom plug-in.

12-86 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

For instructions about how to create *_user.properties files, see Client Customization.
Note

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


require this functionality, you must create the preference. When you create the
preference name, you must include two underscores after TC.
For information about creating and using preferences, see Teamcenter Basics.

VALID
VALUES
Any relation business object types in a comma-separated list.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
When this preference is defined, the Active Workspace client uses the values set by
the TC__thumbnail_relation_order preference.
• If not already defined, the TC__thumbnail_relation_order preference is created
during installation of the Active Workspace client.

• If the TC__thumbnail_relation_order preference is already defined prior to


installation of the Active Workspace client, the existing values and the new values
added for the Active Workspace client are merged.

When this preference is not defined, or is defined during Active Workspace installation,
the Active Workspace client uses the following order:
Thumbnail
IMAN_manifestation
IMAN_specification
IMAN_Rendering
IMAN_Motion
IMAN_3D_snap_shot
TC_Attaches

TC_Thumbnail_Tooltip_Properties

DESCRIPTION
Specifies the data that appears over the tooltip of the thumbnail.
VALID
VALUES
Accepts multiple string values. Each string specifies the default view of display of
search result.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 12-87


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_USER_PFILE

DESCRIPTION
Points to the operating system directory containing user preference files.
VALID
VALUES
A single string; this string must be the full operating system path name to the directory.
DEFAULT
VALUES
None. The Windows default setting %TC_DATA%\upfiles and the UNIX default
setting $TC_DATA/upfiles are commented out.
DEFAULT
PROTECTION
SCOPE
User preference.

TC_user_delimiters

DESCRIPTION
Specifies the delimiters that are used to separate the user’s name from the user ID in
the list of users in the Organization application user interface.
Note

• Do not use these same delimiters in either the User ID field or Person
Name field for the user.

• If you accidentally use the characters set in this preference when you
create a user or a person, use the make_user utility to correct the user ID
and person name delimiters.

VALID
VALUES
Any value, for example, bracket characters { } or parentheses ( ).
The default values are used if the preference is empty or if the preference is defined
with more than two values.
DEFAULT
VALUES
()
DEFAULT
PROTECTION
SCOPE
User preference.

12-88 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

TCViewEnableResponseOnSelection

DESCRIPTION
Enables response to selection in specified primary views when an object is selected in
a secondary view in the current view network.
Note

After modifying this preference, you need to reset the perspective or restart
the rich client.

VALID
VALUES
View IDs of primary views
For example, the component view view ID is
com.teamcenter.rac.ui.views.TCComponentView.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TCViewMarkupApplicationPref

DESCRIPTION
Defines the priority list of applications used by the View/Markup command to display
selected base datasets and their associated markup data. Even though defined as a
Site preference, values can be given at a user, role, group, or site level in this order
of priority.
VALID
VALUES
PDF_Tool Provides view and markup capabilities using a PDF tool.

MSWord Provides view and markup capabilities using MSWord.


DEFAULT
VALUES
PDF_Tool
DEFAULT
PROTECTION
SCOPE
All.

TC_wc_allow_subgroup_default

DESCRIPTION
Defines the default setting for the Subgroup Members Allowed check box in the New
Work Context dialog box. This option determines whether subgroup members of the
selected group are allowed to perform a task.

PLM00026 11.2 Preferences and Environment Variables Reference 12-89


Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
true By default, the check box is checked and subgroup members
are allowed to perform a task.
false By default, the check box is not checked and subgroup
members are not allowed to perform a task.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_wc_setting_modifiable_default

DESCRIPTION
Defines the default setting for the User Settings Modifiable check box in the New
Work Context dialog box. This option determines whether user settings defined via the
work context can be changed once the work context is set as the current work context.
VALID
VALUES
true By default, users can reset user settings defined by the work context after the
work context is set as the current work context.
false By default, users cannot reset user settings defined by the work context once
the work context is set as the current work context.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_wc_show_all

DESCRIPTION
Defines the content of the list of work contexts associated with a user.
VALID
VALUES
TRUE System displays work contexts related to the tasks in the user's
Task to Perform folder, followed by any other work contexts
created by the user.
FALSE System displays only work contexts related to the tasks in the
user's Task to Perform folder.
DEFAULT
VALUES
FALSE

12-90 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TOOL_object_columns_hidden

DESCRIPTION
Determines which tool 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 tool name.
Column widths are defined using the TOOL_object_widths_hidden user preference.
DEFAULT
VALUES
site_classification
vendor_name
version
input_formats
output_formats
object_desc
object_type
release_status_list
revision_number
date_released
archive_info
owning_group
last_mod_user
owning_user
creation_date
archive_date
last_mod_date
backup_date
DEFAULT
PROTECTION
SCOPE
User preference.

TOOL_object_columns_shown

DESCRIPTION
Determines which tool 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 tool name.
Column widths are defined using the TOOL_object_widths_shown user preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-91


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
VALUES
object_name
symbol_name
DEFAULT
PROTECTION
SCOPE
User preference.

TOOL_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
TOOL_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 TOOL_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
32
32
32
32
32
32
32
32
32
32
32
32
32
32
32
32
32
32
DEFAULT
PROTECTION
SCOPE
User preference.

TOOL_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
TOOL_object_columns_shown user preference.

12-92 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 TOOL_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
32
DEFAULT
PROTECTION
SCOPE
User preference.

treeDisplayOrder

DESCRIPTION
Determines the order in which data is displayed in trees. Users set this preference
in the General page section of the Options dialog box. When users set the display
order through the interface, the system automatically sets this preference in the user's
preference file.
VALID
VALUES
ascending Data in the tree is sorted in ascending order.
descending Data in the tree is sorted in descending order.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

<type>_group_order

DESCRIPTION
Specifies the grouping of the children components by specified children types in the
preference values for the parent type when expanding the components to show the
children.
VALID
VALUES
Valid values are of business object type, for example:
Item_group_order=Form
Item_group_order=ItemRevision
Item_group_order=MSWord
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 12-93


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

<Type>_PseudoFolder

DESCRIPTION
Determines whether pseudo folders are created when the defined object type is
created, and with which relation. The system automatically creates these preferences
when users select pseudo folder options from the Options dialog box, accessed
from the Edit menu in My Teamcenter.
For more information, see Teamcenter Basics.
The system creates a preference for each item and item revision type for which
Shown Relations are selected from the Related Object tab of the dialog box. The
preferences are stored in the users preference file.
VALID
VALUES
Accepts one or more strings as a value; each string must be a valid Teamcenter
relation type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

<type_name>.CREATERENDERING

DESCRIPTION
Indicates the XML rendering dataset used to render the properties shown in
a creation dialog box for a particular business object type, using the form of
business-object-type.CREATERENDERING=xml-rendering-style-sheet-dataset. For
example, the Item.CREATERENDERING=ItemCreate preference means that for Item
business objects, the ItemCreate XML rendering style sheet dataset is used to render
the properties on creation dialog boxes in the user interface.
Teamcenter property 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 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 determines the XML rendering for displaying the
defined type's properties. If this preference is defined, the
<dataset_name>.CREATE_REGISTEREDTO preference must also be
defined.

12-94 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

Children business object types inherit create rendering settings from their parents if
they are added to the TC_CreateRenderingInheritTypeList preference.
Note

The thin client and rich client are not synchronized in their
<type-name>.CREATERENDERING preference behavior.
For the thin client, the <type-name>.CREATERENDERING XML rendering
style sheet is used for both the New→Other and New→Item menus and most
other New→ actions.
In the rich client, however, the <type-name>.CREATERENDERING XML
rendering style sheet is used only for the New→Other menu. For the
New→Item menu, the legacy automatic layout is used, but the master form
tabs can be styled using the individual <type-name>.FORMRENDERING XML
rendering style sheets.

VALID
VALUES
Accepts a single string as a value. It must be a valid dataset name, which contains
rendering XML.
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.

<Type_Name>_DefaultChildProperties

DESCRIPTION
Determines which properties are children of the indicated type. Each type requires
its own preference. The format for each preference is:
Type_Name_DefaultChildProperties=my_property
VALID
VALUES
Accepts one or more strings as values; each string must be a valid Teamcenter
property name.
DEFAULT
VALUES
Item_DefaultChildProperties=
IMAN_master_form
bom_view_tags
revision_list
IMAN_requirement
IMAN_manifestation

PLM00026 11.2 Preferences and Environment Variables Reference 12-95


Chapter
Chapter 12:12:ClientClient preferences
preferences

IMAN_reference
IMAN_MEView
altid_list

ItemRevision_DefaultChildProperties=
IMAN_master_form_rev
structure_revisions
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_UG_udf
IMAN_UG_altrep
IMAN_UG_scenario
IMAN_Rendering
view
release_status_list
altid_list
IMAN_3D_snap_shot

Folder_DefaultChildProperties=
contents
IMAN_external_object_link

Newstuff Folder_DefaultChildProperties=
contents
IMAN_external_object_link

Mail Folder_DefaultChildProperties=
contents

TaskInBox_DefaultChildProperties=
tasks_to_perform
tasks_to_review

ReviewTeamDefinition_DefaultChildProperties=
valid_signoffs

EPMTask_DefaultChildProperties=
root_target_attachments
root_reference_attachments
release_status_attachments
child_tasks
signoff_profiles
IMAN_external_object_link

EPMTaskDefinition_DefaultChildProperties=
child_taskdefinition

12-96 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

EPMSelectSignoffTaskDefinition_DefaultChildProperties=
child_taskdefinition
signoff_profiles

EPMDoTaskDefinition_DefaultChildProperties=
child_taskdefinition
IMAN_external_object_link

EPMDoTask_DefaultChildProperties=
IMAN_external_object_link

DirectModel_DefaultChildProperties=
Session
DMI_markup
3DMarkup
IMAN_capture

DrawingSheet_DefaultChildProperties=
DMI_markup

Image_DefaultChildProperties=
DMI_markup

User_DefaultChildProperties=
subscribed_inboxes
my_home_folder
Adds
Cancels

EngChange Revision_DefaultChildProperties=
IMAN_master_form_rev
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
affected_items
solution_items
problem_items
reference_items
addressed_by
tasks_to_perform
tasks_to_review
release_status_list
IMAN_external_object_link

Dataset_DefaultChildProperties=
IMAN_external_object_link

MSWord_DefaultChildProperties=

PLM00026 11.2 Preferences and Environment Variables Reference 12-97


Chapter
Chapter 12:12:ClientClient preferences
preferences

IMAN_external_object_link

Form_DefaultChildProperties=
IMAN_external_object_link

ItemMaster_DefaultChildProperties=
IMAN_external_object_link

BOMView_DefaultChildProperties=
IMAN_external_object_link

BOMViewRevision_DefaultChildProperties=
IMAN_external_object_link

MEProcess_DefaultChildProperties=
IMAN_master_form
bom_view_tags
revision_list
IMAN_requirement
IMAN_manifestation
IMAN_reference

MEOP_DefaultChildProperties=
IMAN_master_form
bom_view_tags
revision_list
IMAN_requirement
IMAN_manifestation
IMAN_reference

MEProcessRevision_DefaultChildProperties=
IMAN_master_form_rev
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_Rendering
IMAN_MEMfgModel
IMAN_METarget
IMAN_MEWorkArea
IMAN_MEOutput
IMAN_3D_snap_shot
structure_revisions
view
release_status_list
IMAN_MEWorkInstruction
ProcessSimulate_Details
METimeAnalysisRelation
KinematicsRelation

12-98 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

VisSession
VisItemRevCreatedSnapshot2D
Cps0ModulesInfoRel
Cps0PLCInfoRel
Cps0OpDetailsRel
Cps0PropertiesRel
Mes0MEWIPreviewRelation
Mes0MEWIAssetsRelation
Mes0PDFReportRel
Mes0PDFInputsRel
Mes0TWIRefInfoRelation

MEOPRevision_DefaultChildProperties=
IMAN_master_form_rev
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_Rendering
IMAN_MEMfgModel
IMAN_METarget
IMAN_MEWorkArea
IMAN_MEOutput
IMAN_3D_snap_shot
structure_revisions
view
release_status_list
IMAN_MEWorkInstruction
ProcessSimulate_Details
METimeAnalysisRelation
KinematicsRelation
VisSession
VisItemRevCreatedSnapshot2D
Cps0ModulesInfoRel
Cps0PLCInfoRel
Cps0OpDetailsRel
Cps0PropertiesRel
Mes0MEWIPreviewRelation
Mes0MEWIAssetsRelation
Mes0PDFReportRel
Mes0PDFInputsRel
Mes0TWIRefInfoRelation

CCObject_DefaultChildProperties=
IMAN_CCContext
config_context
IMAN_specification
IMAN_requirement
IMAN_manifestation

PLM00026 11.2 Preferences and Environment Variables Reference 12-99


Chapter
Chapter 12:12:ClientClient preferences
preferences

IMAN_reference

StructureContext_DefaultChildProperties=
contents
configuration_context
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference

ConfigurationContext_DefaultChildProperties=
revision_rule
variant_rule
closure_rule
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference

CPMarketingBriefRevision_DefaultChildProperties=
CP_Has_Technical_Brief
CP_Has_Design_Brief

CPTechnicalBriefRevision_DefaultChildProperties=
CP_Results_In_Package_Rough

CPThemeBoardRevision_DefaultChildProperties=
CP_Has_Graphical_Element

CPDesignBriefRevision_DefaultChildProperties=
CP_Has_Graphical_Element
DEFAULT
PROTECTION
SCOPE

<type_name>.FORMRENDERING

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 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 determines the XML rendering for displaying the
defined type's form properties. If this preference is defined, the
<dataset_name>.FORM_REGISTEREDTO preference must also be defined.

12-100 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

VALID
VALUES
Accepts a single string as a value. It must be a valid dataset name, which contains
rendering XML.
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.

<type_name>.RENDERING

DESCRIPTION
Indicates the XML rendering dataset used to render the properties
shown in a particular business object type, using the form of
business-object-type.RENDERING=xml-rendering-style-sheet-dataset. For
example, the Item.RENDERING=Item preference means that for Item business
objects, the Item XML rendering style sheet dataset is used to render the properties in
the user interface.
Teamcenter property 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 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 determines the XML rendering for displaying the defined type's
properties. If this preference is defined, the <dataset_name>.REGISTEREDTO
preference must also be defined.
VALID
VALUES
Accepts a single string as a value. It must be a valid dataset name, which contains
rendering XML.
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-101


Chapter
Chapter 12:12:ClientClient preferences
preferences

<type_name>.SAVEASRENDERING

DESCRIPTION
Indicates the XML rendering dataset used to render the properties shown in
a Save As dialog box for a particular business object type, using the form of
business-object-type.SAVEASRENDERING=xml-rendering-style-sheet-dataset. For
example, the Item.SAVEASRENDERING=ItemSaveAs preference means that for
Item business objects, the ItemSaveAs XML rendering style sheet dataset is used to
render the properties in creation dialog boxes in the user interface.

Teamcenter property 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 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 determines the XML rendering for displaying the


defined type's properties. If this preference is defined, the
<dataset_name>.SAVEAS_REGISTEREDTO preference must also be
defined.

Child business object types inherit save as rendering settings from their parents if they
are added to the TC_SaveAsRenderingInheritTypeList preference.

Note

The thin client and rich client are not synchronized in their
<type-name>.SAVEASRENDERING preference behavior.
For the thin client, the <type-name>.SAVEASRENDERING XML rendering
style sheet is used for both the New→Other and New→Item menus and most
other New→ actions.
In the rich client, however, the <type-name>.SAVEASRENDERING XML
rendering style sheet is used only for the New→Other menu. For the
New→Item menu, the legacy automatic layout is used, but the master form
tabs can be styled using the individual <type-name>.FORMRENDERING XML
rendering style sheets.

VALID
VALUES
Accepts a single string as a value. It must be a valid dataset name, which contains
rendering XML.
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.

12-102 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

<type_name>.SUMMARYRENDERING

DESCRIPTION
Indicates the XML rendering dataset used to render the properties shown
in the Summary tab for a particular business object type, using the form of
business-object-type.SUMMARYRENDERING=xml-rendering-style-sheet-dataset.
For example, the Item.SUMMARYRENDERING=ItemSummary preference means
that for Item business objects, the ItemSummary XML rendering style sheet dataset
is used to render the properties on the Summary tab in the user interface.
Teamcenter property 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 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 determines the XML rendering for displaying the
defined type's summary properties. If this preference is defined, the
<dataset_name>.SUMMARY_REGISTEREDTO preference must also be defined.
VALID
VALUES
Accepts a single string as a value. It must be a valid dataset name, which contains
rendering XML.
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.

USER_object_columns_hidden

DESCRIPTION
Determines which user 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 user name.
Column widths are defined using the USER_object_widths_hidden user preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-103


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

USER_object_columns_shown

DESCRIPTION
Determines which user 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 USER_object_widths_shown user preference.
DEFAULT
VALUES
user_name
person
user_id
os_username
default_group
volume
DEFAULT
PROTECTION
SCOPE
User preference.

USER_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
USER_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 USER_object_columns_shown user preference, and so on.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

12-104 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

USER_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
USER_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 USER_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
20
20
20
20
20

DEFAULT
PROTECTION
SCOPE
User preference.

<viewer_config_id>.VIEWERCONFIG

DESCRIPTION
Specifies an alternate Viewer view configuration instead of the
defaultViewerConfig.VIEWERCONFIG preference. 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.
Create your own preference using the <viewer-config-id>.VIEWERCONFIG format for
the name. The name must end with .VIEWERCONFIG.
To use this preference instead of the default viewer configuration preference, you must
specify this preference name in the Viewer.VIEWERCONFIGTOLOAD preference.
Note

The Classification application provides a key to Teamcenter Services


so that it can use the g4m<Key>.VIEWERCONFIGTOLOAD
preference instead to load the viewer configuration defined in the
g4m<viewer_config_id>.VIEWERCONFIG preference.

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:

PLM00026 11.2 Preferences and Environment Variables Reference 12-105


Chapter
Chapter 12:12:ClientClient preferences
preferences

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
There is no default value. Enter values for your own configuration.
For an example of values, see the defaultViewerConfig_VIEWERCONFIG
preference.
DEFAULT
PROTECTION
SCOPE
Site preference.

Viewer.VIEWERCONFIGTOLOAD

DESCRIPTION
Defines the Viewer view configuration to load if no key is provided to Teamcenter
Services. This preference must point to a .VIEWERCONFIG preference name.
By default, this preference points to the defaultViewerConfig.VIEWERCONFIG
preference. To point to an alternate preference, enter a
<viewer_config_id>.VIEWERCONFIG preference name.
Note

The Classification application uses the g4m<Key>.VIEWERCONFIGTOLOAD


preference instead of the Viewer.VIEWERCONFIGTOLOAD preference.

12-106 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

VALID
VALUES
Use any already defined preference name in this format:
viewer-config-id.VIEWERCONFIG
DEFAULT
VALUES
defaultViewerConfig.VIEWERCONFIG
DEFAULT
PROTECTION
SCOPE
Site preference.

WhereReferencePOMPref

DESCRIPTION
Specifies whether all instances and classes found in the database that contain
references to a specified instance are displayed in the Impact Analysis view.
VALID
VALUES
0 All instance references to a specified instance search in the
database are not displayed in the Impact Analysis view.

1 All instance references to a specified instance search in


database are displayed in the Impact Analysis view.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Where_Ref_Avoid_Duplicate_Expansion

DESCRIPTION
For where-referenced searches, specifies whether to display the subtrees of duplicate
nodes.
VALID
VALUES
false All nodes are displayed when expanded.

true Duplicate node subtrees are not displayed.


DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-107


Chapter
Chapter 12:12:ClientClient preferences
preferences

WHERE_REFERENCED_RELATIONS_FILTER

DESCRIPTION
Specifies custom relations displayed in the Where Referenced Options relation list.
Added relations are not displayed in the Paste Special, Paste dialog box and are
not defined as child relations.
VALID
VALUES
Accepts string values. Each string must be a relation internal name such as
CP_Has_Copy_Element or CP_Has_Package_Concept.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Word_12_installed

DESCRIPTION
Indicates whether the user has MS Word 2007 installed. To edit requirement content in
a Word window embedded in the View/Edit pane, MS Word 2007 must be installed
and this preference must be set to True. Users can set this preference in the interface
by choosing Edit→Options and selecting the Word 12 Installed check box in the
Requirements Management pane.
The Systems Engineering application itself can be used without MS Word 2007.
For more information about requirement content and using the Systems Engineering,
see Systems Engineering.

Note

Users who do not have MS Word 2007 installed can edit requirement content in
a separate Word window by choosing the File→Open in MS Word Application
command. This method requires the installation of the Office 2007 Compatibility
Pack.

VALID
VALUES
true Indicates that MS Word 2007 is installed.

false Indicates that MS Word 2007 is not installed.


DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

12-108 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

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.

PLM00026 11.2 Preferences and Environment Variables Reference 12-109


Chapter
Chapter 12:12:ClientClient preferences
preferences

WORKSPACEOBJECT_object_columns_hidden

DESCRIPTION
Determines which workspace 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 workspace name.
Column widths are defined using the WORKSPACEOBJECT_object_widths_hidden
user preference.
DEFAULT
VALUES
revision_limit
revision_number
date_released
archive_info
last_mod_user
owning_group
last_mod_date
archive_date
creation_date
backup_date
release_status_list
DEFAULT
PROTECTION
SCOPE
User preference.

WORKSPACEOBJECT_object_columns_shown

DESCRIPTION
Determines which workspace 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 WORKSPACEOBJECT_object_widths_shown
user preference.
DEFAULT
VALUES
object_name
object_type
owning_user
object_desc
DEFAULT
PROTECTION
SCOPE
User preference.

12-110 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

WORKSPACEOBJECT_object_widths_hidden

DESCRIPTION
Specifies the column width for each column defined in the
WORKSPACEOBJECT_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 WORKSPACEOBJECT_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
6
6
16
16
13
16
16
16
16
16
32
DEFAULT
PROTECTION
SCOPE
User preference.

WORKSPACEOBJECT_object_widths_shown

DESCRIPTION
Specifies the column width for each column defined in the
WORKSPACEOBJECT_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 WORKSPACEOBJECT_object_columns_shown user preference, and so on.
DEFAULT
VALUES
32
16
13
32
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-111


Chapter
Chapter 12:12:ClientClient preferences
preferences

WS_icon_placement

DESCRIPTION
Determines the location of icons in the workspace.
VALID
VALUES
1 Above.

2 Right.

3 Below.

4 Left.
DEFAULT
VALUES
4
DEFAULT
PROTECTION
SCOPE
User preference.

WSColumnsHiddenPref

DESCRIPTION
Determines which workspace 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 column name.
Column widths are defined using the WSHiddenColumnWidthsPref user preference.
DEFAULT
VALUES
item_id
item_revision_id
object_name
object_desc
owning_site
creation_date
date_released
backup_date
archive_date
based_on
revision_number
revision_limit
last_mod_user
process_stage
has_variants
protection
export_sites
publication_sites

12-112 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
PROTECTION
SCOPE
User preference.

WSColumnsShownPref

DESCRIPTION
Determines which workspace 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 column name.
Column widths are defined using the WSShownColumnWidthsPref user preference.
DEFAULT
VALUES
object_string
object_type
relation
owning_user
owning_group
last_mod_date
checked_out
DEFAULT
PROTECTION
SCOPE
User preference.

WSDisplayTypePref

DESCRIPTION
Determines the format of the graphical display.
VALID
VALUES
1 Vertical tree.
2 Horizontal tree.
3 Indented BOM.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
User preference.

WS_expand_on_paste

DESCRIPTION
Determines whether to expand a folder immediately after an object has been pasted
into it. Because all objects in the folder must be read before it can be opened, Siemens

PLM00026 11.2 Preferences and Environment Variables Reference 12-113


Chapter
Chapter 12:12:ClientClient preferences
preferences

PLM Software recommends setting this preference to 0 to prevent delays following


the Paste function.
VALID
VALUES
0 Does not expand a folder immediately after an object has been pasted into it.

1 Expands a folder immediately after an object has been pasted into it.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
User preference.

WSHiddenColumnWidthsPref

DESCRIPTION
Specifies the column width for each column defined in the WSColumnsHiddenPref
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 WSColumnsHiddenPref user preference, and so on.
DEFAULT
VALUES
12
8
40
30
12
17
17
17
17
12
3
14
13
15
3
12
30
18
DEFAULT
PROTECTION
SCOPE
User preference.

12-114 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

WsoFolderSavePref

DESCRIPTION
Determines when to save rich client data.
VALID
VALUES
1 Saves each change immediately.
2 Requires manually saving.
3 Prompts user to save changes at exit.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
User preference.

WsoInsertNoSelectionsPref

DESCRIPTION
Determines the default rich client folder referenced when no object is selected.
VALID
VALUES
1 User's Newstuff folder.
2 Top-level folder.
3 None.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
User preference.

WsoInsertSelectionsPref

DESCRIPTION
Determines the location for new objects in the rich client.
VALID
VALUES
1 All selected folders.
3 User's Newstuff folder.
4 Saves the object in the database but does not create a reference to display
the object in the rich client.
DEFAULT
VALUE
1

PLM00026 11.2 Preferences and Environment Variables Reference 12-115


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

WSOM_only_edit_effectivity_in_ecm

DESCRIPTION
Enables or suppresses editing of effectivity data outside of the Change Viewer process.
VALID
VALUES
yes Enables editing of effectivity data outside of the Change Viewer process.
no Suppresses editing of effectivity data outside of the Change Viewer process.
DEFAULT
VALUES
no
DEFAULT
PROTECTION
SCOPE
Site preference.

WSShownColumnWidthsPref

DESCRIPTION
Specifies the column width for each column defined in the WSColumnsShownPref
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 WSColumnsShownPref user preference, and so on.
DEFAULT
VALUES
32
17
13
9
9
17
4
DEFAULT
PROTECTION
SCOPE
User preference.

12-116 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

Thin client preferences


General thin client preferences

appbar_title_contents

DESCRIPTION
Specifies values to be displayed in the title string of the application bar for the thin
client and the rich client.
• Each value must be on its own line.

• Any other values are rendered as literal text with single space separators.
VALID
VALUES
user Specifies the full Teamcenter user name.
userid Specifies the Teamcenter logon user name.
group Specifies the group the logged-on user is assigned to.
role Specifies the role of the logged-on user.
site Specifies the site identifier.
curr_proj Specifies the current project selected.
prev_login_time Specifies the previous logon time.
prev_session_ip Specifies the previous session address.
current_login_time Specifies the logon time for the current session.
locationcode Specifies the location code identifier.
change_notice Specifies the current change notice in the rich client.
Note

This value is not supported by the thin client.

Specifies the organization identifier.


version Specifies the version of selection.
Note

The rich client application bar can also display a value for Organization,
but only when the TcSetOwningOrganization constant is set to true in the
Business Modeler IDE, and Organization is configured for the group to which a
logged-on user belongs.

DEFAULT
VALUES
(
user
(

PLM00026 11.2 Preferences and Environment Variables Reference 12-117


Chapter
Chapter 12:12:ClientClient preferences
preferences

userid
)
-
group
/
role
-
[
site
]
[
loctioncode
]
[
change_notice
]
)
DEFAULT
PROTECTION
SCOPE
User preference.

Create_Folder_mru_list

DESCRIPTION
For the thin client, displays a list of the folders most recently created in the Business
Object Type dialog box. This dialog box is accessed by choosing New→Other in
the thin client.
VALID
VALUES
Business object names.
DEFAULT
VALUES
Folder
DEFAULT
PROTECTION
SCOPE
User preference.

JT_WEB_UI_PREF

DESCRIPTION
Works only with Teamcenter Automotive Edition–GM Overlay. Suppresses specific
user actions within the thin client.
VALID
VALUES
del Suppresses the ability to delete any object; removes the Delete button from
the thin client.
ini Suppresses the ability to initiate a workflow process; removes the Initiate
Process button from the thin client.

12-118 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

nwl Suppresses the ability to create new web links; removes the New Web Link
button from the thin client.

esv Suppresses the ability to launch external structure viewers; removes the
external structure viewers links from the External Structure Viewers section.

tdim Suppresses the ability to view the selected product in 3D.

pvug Suppresses the ability to launch Teamcenter lifecycle visualization products or


NX from a selected object.

pvm Suppresses the ability to create new markups by uploading a file.

wkf Suppresses the ability to perform workflow tasks from the inbox page;
suppresses task hyperlinks.
DEFAULT
VALUES
del
ini
nwl
esv
tdim
pvug
pvm
wkf
DEFAULT
PROTECTION
SCOPE
Site preference.

TcUseAppLauncher

DESCRIPTION
Specifies whether Teamcenter Application Launcher is used to open and edit Office
datasets in the Teamcenter thin client. Using the launcher enables Teamcenter Client
for Microsoft Office.
VALID
VALUES
true Teamcenter Application Launcher is used. Enables Client for Office for the
Teamcenter thin client.

false Teamcenter Application Launcher is not used. Disables Client for Office for
the Teamcenter thin client.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-119


Chapter
Chapter 12:12:ClientClient preferences
preferences

WEB_active_optimizer_server

DESCRIPTION
Sets the location of the ActiveWeb Optimizer Web server.
VALID
VALUES
Accepts a single string as a value. Must be a valid server location using the format
www.foo.com or the IP address. Do not include the port with the IP address.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_Applications_List

DESCRIPTION
Lists applications displayed in the thin client navigation pane as primary or secondary
applications.
VALID
VALUES
Accepts values in the format: application_name:[primary|secondary] where
application_name is the name of the application listed in the thin client toolbar.xml file
as the value of a panel tag name attribute.
DEFAULT
VALUES
myteamcenter:primary
pse:primary
rm:primary
classification:primary
Adhoc Design Context:primary
Design Context:primary
ScheduleManager:primary
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_auto_assign_ds_id

DESCRIPTION
Determines whether a dataset ID should be automatically generated when one is
not provided.
VALID
VALUES
0 Always prompt the user to create a dataset ID.
1 Attempt to automatically generate a dataset ID when one is not provided.

12-120 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_column_one_new_window

DESCRIPTION
Specifies whether a link in the first column of table-based pages opens in a new
window and whether the View link associated with a dataset opens in a new window.
VALID
VALUES
0 Does not open a new window.

1 Does open a new window.


DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_core_help_server

DESCRIPTION
Set to the URL of your site's Teamcenter online help page on the PLM Documentation
Server, for example:
http://myhost:8181/tdoc/tc/10.1.4/help/
Your Teamcenter administrator sets this value during installation of the PLM
Documentation Server.
VALID
VALUES
Accepts a valid web server address.
DEFAULT
VALUES
http://host:port/tdoc/tc/tc-version/help/
where host is the PLM Documentation Server host name, port is the port used by
the PLM Documentation Server, and tc-version is the Teamcenter version or service
pack level.
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-121


Chapter
Chapter 12:12:ClientClient preferences
preferences

WEB_create_<business_object>_exclude_types

DESCRIPTION
Defines the business objects (types) shown in the Type box in the thin client New
Item dialog box. To access the New Item dialog box, choose New→Item (and the
information derived from item):
• Signal: PSSigna

• Connection: Revisable: PSConnection

• Bid Package: BidPackage

• Commercial Part: CommercialPart

VALID
VALUES
Any business object name is a valid value. The list of business objects in the
preference Current Values box are shown in the Type box on the New Item dialog box.
DEFAULT
VALUES
NULL
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_create_<Class>_exclude_types

DESCRIPTION
Defines the business objects (types) shown in the Type box in the thin client New Item
dialog box. To access the New Item dialog box, choose New→Item.
VALID
VALUES
Any item name is a valid value. The list of business objects in the preference Current
Values box are shown in the Type box on the New Item dialog box.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTE
Use this preference to exclude class types from the creation dialog box.

WEB_create_Item_exclude_types

DESCRIPTION
Defines the business objects (types) shown in the Type box in the thin client New Item
dialog box. To access the New Item dialog box, choose New→Item.

12-122 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

VALID
VALUES
Any item name is a valid value. The list of business objects in the preference Current
Values box are shown in the Type box on the New Item dialog box.
DEFAULT
VALUES
PSSignal
PSConnection
CalParm
ParmDef
ParmGrpVal
SwDesignComp
ValidationAgent
ValData
ValidationReq
DesignReq
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTE
Use this preference to exclude item types from the creation dialog box. For example, if
you want to hide Part and Document, list them here.
This is the first preference of the general format Web_create_<Class>_exclude_types.
Others can be created corresponding to the thin client’s additional object creation
interfaces.

WEB_create_WorkspaceObject_exclude_types

DESCRIPTION
Defines the business objects (types) shown in the Type box in the thin client New
Other dialog box. To access the New Other dialog box, choose New→Other.
VALID
VALUES
Any business object name is a valid value. The list of business objects in the
preference Current Values box are shown in the Type box on the New Other dialog
box.
DEFAULT
VALUES
PSSignal
PSConnection
CalParm
ParmDef
ParmGrpVal
SwDesignComp
ValidationAgent
ValData
ValidationReq
DesignReq

PLM00026 11.2 Preferences and Environment Variables Reference 12-123


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.
NOTE
Use this preference to exclude item types from the New Other dialog box. For
example, if you want to hide Part and Document, list them here.
This is a preference of the general format Web_create_<Class>_exclude_types.
Others can be created corresponding to the thin client’s additional object creation
interfaces.

WEB_dataset_shown_relations

DESCRIPTION
Sets the shown relation types for dataset pages. Add Version to this preference to
display dataset versions.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter reference.
DEFAULT
VALUES
Reference
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_dataset_upload_mode

DESCRIPTION
Determines the default upload mode for datasets.
VALID
VALUES
0 The dataset need not be checked out to upload a file to it. Thus automatic
check out is possible.
1 The dataset must be explicitly checked out to upload a file to it.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_default_site_deployed_app_name

DESCRIPTION
Appends the name of the application to be launched to the server URL defined in the
WEB_default_site_server preference. When both the WEB_default_site_server
and Web_default_site_deployed_app_name preferences are set, this concatenated

12-124 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

URL path is included in Teamcenter mail messages via the EPM-notify-report handler,
which adds the thin client job URL to the notification mail message.
A value for this preference may be provided during installation.
VALID
VALUES
Accepts a single string as a value. Must be the name provided for the Teamcenter
application during installation.
DEFAULT
VALUES
tc
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_default_site_server

DESCRIPTION
Sets the server URL to be included in Teamcenter mail messages. You must
also set the Web_default_site_deployed_app_name preference, which
appends the name of the application to be launched to this URL. When both
the WEB_default_site_server and Web_default_site_deployed_app_name
preferences are set, the EPM-notify-report handler adds the thin client job URL to
the notification mail message.
The system also uses this preference's value for generating bookmark files while
interoperating with Teamcenter lifecycle visualization.
VALID
VALUES
This preference must be set in the following format:
wwwserver_name:8080

The server name is the thin client server node name as defined in the browser location
field.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_disable_structure_read_optimizations

DESCRIPTION
Disables optimization in Structure Manager structure that limits depth of examination
to the one currently displayed in browser.

PLM00026 11.2 Preferences and Environment Variables Reference 12-125


Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
False Suppresses the display of variant options defined at a structure level that have
not been expanded in the thin client Structure Manager and are unknown
to Structure Manager.
True Displays variant options defined anywhere in the structure even if they are in
parts of the structure that have not yet been expanded.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_displayed_new_menu_objects

DESCRIPTION
For the thin client, specifies the object types listed by the New menu command.
VALID
VALUES
One or more strings in a comma-delimited list.
DEFAULT
VALUES
Item
Folder
Form
Dataset
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_EnablePSEVisualization

DESCRIPTION
For the Structure Manager application in the thin client, controls display of the
View→Show/Hide Viewer menu command.
Note

The Viewer tab functionality requires that embedded visualization is available


for Windows clients.

VALID
VALUES
0 The View→Show/Hide Viewer menu command is not displayed.
1 The View→Show/Hide Viewer menu command is displayed.
DEFAULT
VALUE
1

12-126 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
PROTECTION
SCOPE
All.

WEB_EnableVisualization

DESCRIPTION
For the My Teamcenter application in the thin client, controls display of the Viewer tab
in the data pane.
Note

The Viewer tab functionality requires that embedded visualization is available


for Windows clients.

VALID
VALUES
0 The Viewer tab in the data pane is not displayed.
1 The Viewer tab in the data pane is displayed.
DEFAULT
VALUE
1
DEFAULT
PROTECTION
SCOPE
All.

WEB_filter_person

DESCRIPTION
Determines whether to automatically filter the SA Person page upon loading.
VALID
VALUES
ON Only a filter field is displayed when the page is opened. Criteria must be
entered into the field. Results display in a list box.
OFF A filter field, filter button, and a list box containing all persons contained in the
database. The list box contents may be extensive for large sites, slowing
loading time.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_filter_user

DESCRIPTION
Determines whether to automatically filter the SA User page upon loading.

PLM00026 11.2 Preferences and Environment Variables Reference 12-127


Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
ON Only a filter field is displayed when the page is opened. Criteria must be
entered into the field. Results display in a list box.

OFF A filter field, filter button, and a list box containing all users contained in the
database. The list box contents may be extensive for large sites, slowing
loading time.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_help_server

DESCRIPTION
Set to the URL of your site's thin client online help page on the PLM Documentation
Server, for example:
http://myhost:8181/tdoc/tc/10.1.4/help/#filename:thin_client_dhtml:getting_started
The part of this value preceding the hash symbol (#) should match the value of the
WEB_core_help_server preference.
VALID
VALUES
Accepts a valid web server address.
DEFAULT
VALUES
http://host:port/tdoc/tc/tc-version/help/#filename:thin_client_dhtml:getting_started
host is the PLM Documentation Server host name, port is the port used by the PLM
Documentation Server, and tc-version is the Teamcenter version or service pack level.
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_item_default_relation

DESCRIPTION
Sets the default relation for the Paste command.
VALID
VALUES
A valid Teamcenter item relation type.
DEFAULT
VALUES
IMAN_reference

12-128 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
PROTECTION
SCOPE
User preference.

WEB_itemrevision_default_relation

DESCRIPTION
Sets the default relation for the Paste command.
VALID
VALUES
A valid Teamcenter item revision relation type.
DEFAULT
VALUES
IMAN_reference
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_IWantToDefaultActions

DESCRIPTION
Populates the left-hand navigator in the thin client with site preferences based on
the following values.
VALID
VALUES
web_lhn_iwantto_create_item:typeicons/
Item.png:javascript:popupNewBusinessObject('Item', true, false)
• The web_lhn_iwantto_create_item string represents the localization key for the
text to show as a link under the I Want To section of the left-hand navigation bar
in the thin client.

• The typeicons/Item.png string represents the icon to show the prefix to the link
text.

• The javascript:popupNewBusinessObject('Item', true, false) string represents


the javascript function to be called when the link is clicked.

web_lhn_iwantto_create_dataset:typeicons/
Dataset.png:javascript:popupNewDatasetDialog()
• The web_lhn_iwantto_create_dataset string represents the localization key for
the text to show as a link under the I Want To section of the left-hand navigation
bar in the thin client.

• The typeicons/Dataset.png string represents the icon to show the prefix to the
link text.

• The javascript:popupNewDatasetDialog() string represents the javascript


function to be called when the link is clicked.

PLM00026 11.2 Preferences and Environment Variables Reference 12-129


Chapter
Chapter 12:12:ClientClient preferences
preferences

web_lhn_iwantto_create_workflow_process:teamcenter/dhtml/images/
process.png:javascript:initiateProcess()
• The web_lhn_iwantto_create_workflow_process string represents the
localization key for the text to show as a link under the I Want To section of the
left-hand navigation bar in the thin client.

• The teamcenter/dhtml/images/process.png string represents the icon to show


the prefix to the link text.

• The javascript:initiateProcess() string represents the javascript function to be


called when the link is clicked.

DEFAULT
VALUES
web_lhn_iwantto_create_item:typeicons/
Item.png:javascript:popupNewBusinessObject('Item', true, false)
web_lhn_iwantto_create_dataset:typeicons/
Dataset.png:javascript:popupNewDatasetDialog()
web_lhn_iwantto_create_workflow_process:teamcenter/dhtml/images/
process.png:javascript:initiateProcess()
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_login_page

DESCRIPTION
Defines the page to be loaded upon logging in to the thin client.
VALID
VALUES
DEFAULT
VALUES
redirs/homefolder
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_menu_entry_new_window

DESCRIPTION
Lists the names of any menu entries to be opened in a new window.
VALID
VALUES
General...
Item — Simple
System Admin
in-CLASS
Web Collection

12-130 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

General Collection
DEFAULT
VALUES
NULL
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_menu_entry_suppressions

DESCRIPTION
Determines which menu commands display in the user interface. Any menu entry key
defined in this preference is removed from the user interface. For example:
WEB_menu_entry_suppressions=
newChangeAction

This example suppresses the Change menu command from displaying in the thin
client. If all possible commands are removed from a menu, the menu itself is deleted.
For more information about configuring the thin client, see Thin Client Interface.
Note

Thin client menu suppression can work together with the newer command
suppression functionality. Siemens PLM Software recommends using the more
detailed command suppression functionality.
For more information on command suppression, see Application Administration.

VALID
VALUES
Accepts multiple strings as values; each string must be a valid Teamcenter menu
entry key.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_Nav_Items_List

DESCRIPTION
Lists items displayed in the thin client navigation pane. The items in the navigation
pane are ordered in the same way as they are entered in this preference.
VALID
VALUES
Accepts item names as listed in the thin client toolbar.xml file as the value of a
section tag id attribute.

PLM00026 11.2 Preferences and Environment Variables Reference 12-131


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
VALUES
quicklinks
history
favorites
iwantto
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_NX_UseBookmark

DESCRIPTION
Allows thin client users to use legacy bookmark formats for thin client to NX
communication. By default, PLM XML file formats are used for NX communication.

Note

This is required for versions of NX prior to NX7.

VALID
VALUES
Accepts one of the following strings as values: True or False.
DEFAULT
VALUES
False.
DEFAULT
PROTECTION
SCOPE
All.

WEB_package_multipart

DESCRIPTION
Defines the directory in which packaged multipart files are stored. This preference
supports markup integration.
VALID
VALUES
Accepts a single string as a value. Must be a valid directory.
DEFAULT
VALUES
/tool_box/zip -q %multipart %filelist

where %multipart is the packaged multipart (output) file name and %filelist is list of
files to be included in this packaged multipart file.
DEFAULT
PROTECTION
SCOPE
Site preference.

12-132 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

WEB_packaging_extension

DESCRIPTION
Defines the file extension for packaged multipart files. This preference supports
markup integration.
VALID
VALUES
A single string; the string must be a valid file extension type.
DEFAULT
VALUES
zip
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_processes

DESCRIPTION
Filters the processes displayed to the user in the New Job dialog box. Not setting this
preference causes all the processes to be displayed.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter workflow
process name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_protocol

DESCRIPTION
Defines the protocol used by the web server; either http:// or https://
VALID
VALUES
http:// Web server uses the http:// protocol.

https:// Web server uses the https:// protocol.


Use this setting if you are running the Teamcenter Web
application and have configured it use a secure socket layer
(SSL).
For more information about configuring the Teamcenter Web
middle tier, see the basic deployment section of Web Application
Deployment.

PLM00026 11.2 Preferences and Environment Variables Reference 12-133


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
VALUES
http://
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_show_export_nx_assy_menu

DESCRIPTION
Enables the Export NX Assembly menu command in the thin client Structure
Manager.
VALID
VALUES
Accepts one of the following strings as values: True or False.
DEFAULT
VALUES
False.
DEFAULT
PROTECTION
SCOPE
All.

WEB_show_summary

DESCRIPTION
Determines whether the Summary view of an object appears at the bottom of the
window when the object is selected.
VALID
VALUES
true The Summary view of an object appears at the bottom of the window when
the object is selected.
false The Summary view of an object does not appear at the bottom of the window
when the object is selected.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_show_unconfigured_revs

DESCRIPTION
Determines whether to display item revisions that have not been configured.
VALID
VALUES
0 Item revisions that have not been configured are not displayed.

12-134 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

1 Item revisions that have not been configured are displayed.


DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
All.

WEB_status_icons

DESCRIPTION
Determines the display of the release status icons and other status icons in the thin
client.
Note

This preference can be modified by users in the interface under the WSO
Status Icons heading in the Edit→Options dialog box.

VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter key:
• configured
The object is configured based on the current revision rule.

• in_process
The object is the target of an active workflow process.

• external_links
The object contains a reference to an external system.

• job
The object is the root task of the workflow process.

• TraceLink
The object has a trace link.

• AllReleaseStatuses
All release statuses for the object are displayed.

• LatestReleaseStatus
Only the latest release status for the object is displayed.
DEFAULT
VALUES
in_process
configured
TraceLink

PLM00026 11.2 Preferences and Environment Variables Reference 12-135


Chapter
Chapter 12:12:ClientClient preferences
preferences

AllReleasedStatuses
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_style_sheet

DESCRIPTION
Determines the style sheet used by the thin client.
VALID
VALUES
Valid style sheet location; can be either a URL or file path name. The location need
not be local.
DEFAULT
VALUES
/css/tc.css
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_style_sheet_list

DESCRIPTION
Defines the list of style sheets available when using the thin client. The style sheets
can be defined by any URL or file path, local or not, but should point to style sheets
with the appropriate classes defined.
VALID
VALUES
Valid style sheet location; can be either a URL or file path name.
DEFAULT
VALUES
/css/tc.css
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_style_sheet_list_names

DESCRIPTION
Defines the list of names presented as configuration options. This values in
this preference must correspond one-for-one with the values defined in the
WEB_style_sheet_list preference.
VALID
VALUES
Teamcenter

12-136 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
VALUES
Teamcenter
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_suppressedApplications

DESCRIPTION
Specifies applications hidden in the thin client.
VALID
VALUES
Accepts values in the format:
application_name

application_name is the name of the application listed in the thin client toolbar.xml file
as the value of a panel tag name attribute.
DEFAULT
VALUES
rm
mse
Adhoc Design Context
Design Context
IssueManager
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_title_contents

DESCRIPTION
Defines the contents of the thin client browser title bar.
• Each value must be on its own line.

• Any other values are rendered as literal text with single space separators.
VALID
VALUES
application Specifies the current application name.
object Specifies the current selected object.
user Specifies the full Teamcenter user name.
group Specifies the group logged-on user is assigned to.
role Specifies the role of logged-on user.
site Specifies the site identifier.
rev_rule Specifies the active revision rule.

PLM00026 11.2 Preferences and Environment Variables Reference 12-137


Chapter
Chapter 12:12:ClientClient preferences
preferences

version Specifies the version of selection.


locationcode Specifies the location code identifier.
DEFAULT
VALUES
application
-
object
-[
site
]

DEFAULT
PROTECTION
SCOPE
User preference.

WEB_unpackage_multipart

DESCRIPTION
Defines the directory in which unpackaged multipart files are stored. This preference
supports markup integration.
VALID
VALUES
Accepts a single string as a value. Must be a valid Teamcenter directory.
DEFAULT
VALUES
/tool_box/unzip -qq %multipart
where %multipart is the packaged multipart (input) file name.
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_use_lhn_home_component

DESCRIPTION
Determines whether the Home contents appear in the Quick Links section of the thin
client navigation pane by default. Setting this preference to 0 improves performance,
particularly in cases where the user has a large Home folder.
Note

Users can also determine whether the Home contents appear by setting the
Show Home Contents in QuickLinks option in the Options dialog box.

VALID
VALUES
1 The Home contents appear in the Quick Links section of the thin client
navigation pane by default.

12-138 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

0 The Home contents do not appear in the Quick Links section of the thin client
navigation pane by default.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_use_lhn_inbox_component

DESCRIPTION
Determines whether the inbox contents appear in the Quick Links section of the thin
client navigation pane by default. Setting this preference to 0 improves performance,
particularly in cases where the user has a large inbox.
Note

Users can also determine whether the inbox contents appear by setting the
Show Home Contents in QuickLinks option in the Options dialog box.

VALID
VALUES
1 The inbox contents appear in the Quick Links section of the thin client
navigation pane by default.
0 The inbox contents do not appear in the Quick Links section of the thin client
navigation pane by default.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
User preference.

Thin client column and property preferences

WEB_dataset_columns

DESCRIPTION
Defines which properties are displayed as columns in dataset pages.
VALID
VALUES
file_size
object_type
last_mod_date
checked_out
DEFAULT
VALUES
file_size

PLM00026 11.2 Preferences and Environment Variables Reference 12-139


Chapter
Chapter 12:12:ClientClient preferences
preferences

object_type
last_mod_date
checked_out
DEFAULT
PROTECTION
SCOPE
User preference.

WEB_psm_columns

DESCRIPTION
Defines which properties are displayed as columns on BOM pages.
VALID
VALUES
bl_config_string
bl_rev_release_status_list
bl_sequence_no bl_all_notes
bl_variant_state
bl_rev_has_variants
bl_variant_condition
bl_is_occ_configured
bl_has_date_effectivity
bl_item_uom_tag
bl_rev_object_desc
bl_has_children
bl_rev_item_revision_id
bl_rev_object_name
bl_item_item_id
bl_item_object_name
bl_line_name
bl_item_object_desc
bl_is_precise
bl_pack_count
bl_is_packed
UG ENTITY HANDLE
UG GEOMETRY
UG NAME
UG REF SET
bl_rev_process_stage
bl_alternate
bl_item_object_type
bl_quantity
bl_compare_change
bl_revision_change
bl_quantity_changebl_view_type
DEFAULT
VALUES
bl_rev_release_status_list
bl_sequence_no

12-140 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

bl_quantity
bl_item_uom_tag
bl_all_notes
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_po_columns

DESCRIPTION
Defines which properties are displayed as columns on the search results page after a
find remote search is performed.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter property
name.
DEFAULT
VALUES
po_object_class
po_object_id
po_object_name
po_owning_site
po_owner_id
po_group_id
po_object_rel_stat_names
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_wso_columns

DESCRIPTION
Defines which properties are displayed as columns on various pages.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter property
name.
DEFAULT
VALUES
actions
object_type
relation
owning_user
owning_group
last_mod_date
checked_out
release_status_list
object_desc

PLM00026 11.2 Preferences and Environment Variables Reference 12-141


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

Folder_ColumnPreferences

DESCRIPTION
Specifies the list of columns to be displayed for folder objects.
VALID
VALUES
object_string
object_type
relation
owning_user
owning_group
last_mod_date
checked_out
release_status_list
DEFAULT
VALUES
object_string
object_type
relation
owning_user
owning_group
last_mod_date
checked_out
release_status_list
DEFAULT
PROTECTION
SCOPE
Site preference.

Thin client image preferences

WEB_fullsize_image_generate_type

DESCRIPTION
Defines which full-size image types are generated on thin client pages.
VALID
VALUES
One or more strings as values; each string must be specified as MIME type/subtype.
For example:
image/jpeg, image/tiff, image/gif, image/cgm,
x-world/x-vrml
DEFAULT
VALUES
image/jpeg

12-142 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_image_size_vert

DESCRIPTION
Defines the vertical dimension for full-size images on thin client pages. Size is set
in pixels.
VALID
VALUES
A single positive integer value.
DEFAULT
VALUES
890
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_image_size_horiz

DESCRIPTION
Defines the horizontal dimension for full-size images on thin client pages. Size is
set in pixels.
VALID
VALUES
A single positive integer value.
DEFAULT
VALUES
1048
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_show_banner

DESCRIPTION
Determines whether to display the current user's name, group, role, and site name
in the banner.
VALID
VALUES
ON Displays the current user's name, group, role, and site name in the banner.
OFF The current user's name, group, role, and site name is not displayed in the
banner.
DEFAULT
VALUES
ON

PLM00026 11.2 Preferences and Environment Variables Reference 12-143


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_show_thumbnail_image

DESCRIPTION
Determines whether to display thumbnail images in thin client pages.
VALID
VALUES
yes Allows thumbnail images to be displayed.
no Does not allow thumbnail images to be displayed.
DEFAULT
VALUES
yes
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_thumbnail_image_display_type

DESCRIPTION
Defines which thumbnail image types can be displayed on thin client pages in order of
preference. The first value is the most preferred image type.
VALID
VALUES
One or more strings as values; each string must be specified as MIME type/subtype.
For example:
image/jpeg, image/tiff, image/gif, image/cgm,
x-world/x-vrml
DEFAULT
VALUES
image/gif
image/jpeg
image/bmp
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_thumbnail_image_generate_type

DESCRIPTION
Defines which thumbnail image types are generated on thin client pages.
VALID
VALUES
One or more strings as values; each string must be specified as MIME type/subtype.
For example:

12-144 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

image/jpeg, image/tiff, image/gif, image/cgm,


x-world/x-vrml
DEFAULT
VALUES
image/gif
DEFAULT
PROTECTION
SCOPE
Site preference.

Thin client DesignContext preferences

WebDesignContextDefaultSearchDistance

DESCRIPTION
Defines the search distances for RDV thin client searches. The search returns all
items within the proximity distance defined by this preference, including items outside
the box zone.
Note

If a proximity value is specified in the third screen of the DesignContext


application, the value is applied to target part appearances and the
WebDesignContextDefaultSearchDistance preference applies only to a box
zone outside the search criteria.

VALID
VALUES
Accepts a single string as a value. The string must be a positive integer.
DEFAULT
VALUES
10.0
DEFAULT
PROTECTION
SCOPE
User preference.

RDVThinClientBomlinePropsDisplay

DESCRIPTION
This preference specifies the BOM line properties displayed in DesignContext in the
thin client. This site preference must contain system names, not display names.
VALID
VALUES
bl_indented_title
bl_variant_state
bl_formula
DEFAULT
VALUES
bl_indented_title

PLM00026 11.2 Preferences and Environment Variables Reference 12-145


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

RDVThinClientUserProductItem

DESCRIPTION
This preference is used to store the Product Item set by the user during the last design
context session in the thin client.
VALID
VALUES
item_name
DEFAULT
VALUES
No default value.
DEFAULT
PROTECTION
SCOPE
User preference.

RDVThinClientUserrevisionRule

DESCRIPTION
This preference is used to store the Revision Rule set by the user during the last
design context session in the thin client.
VALID
VALUES
revision_rule_name
DEFAULT
VALUES
No default value.
DEFAULT
PROTECTION
SCOPE
User preference.

Thin client Teamcenter manufacturing process management preferences

Manufacturing report generation

Manufacturing report generation functionality in the thin client requires the Report Generator and PLM
XML features of Teamcenter. Ensure that you have the appropriate Java Runtime Environment (JRE)
and Lifecycle Visualization software installed on your system. Lifecycle Visualization allows you to
create and view 2D and 3D images in reports.

For the administrative prerequisites for generating thin client reports, see Administering Manufacturing
Planning.

12-146 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

Tip

Be sure to read the section on creating reports in thin client in the Administering Manufacturing
Planning before setting the following preferences. This section contains important prerequisite
and configuration information.

Note

Read the section on using report templates in the Thin Client Interface for information about
using these reports via the thin client.

WEB_ZoneProcess_Reports

DESCRIPTION
Used for Teamcenter manufacturing process management Web reports. Defines
which report formatters (XSL style sheets) can be retrieved when the zone process
report type MEPrZoneProcess is selected from the Generate ME Report menu.
Three report formats can be created from this report type:
Zone Datum Key All datums associated with any MELocateCompOp process
that is a child of any children of the zone display in a table.
Zone Weld Data All welds associated to the MEWeldOP process below the zone
Key are represented in a table.
Inspection Report Contains links to files that help in identification of the location
of a weld.
VALID
VALUES
zone_datum.xsl
zone_weld.xsl
inspection_report.xsl
DEFAULT
VALUES
zone_datum.xsl
zone_weld.xsl
inspection_report.xsl
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_StationProcess_Reports

DESCRIPTION
Used for Teamcenter manufacturing process management Web reports. Defines
which report formatters (XSL style sheets) can be retrieved when the station process
report type MEPrStatnProcess is selected from the Generate ME Report menu. The
following report formats can be created from this report type:
Station Datum Key All datums associated with any MELocateCompOp process
that is a child of any children of the station display in a table.

PLM00026 11.2 Preferences and Environment Variables Reference 12-147


Chapter
Chapter 12:12:ClientClient preferences
preferences

Station Weld Data All welds associated with any MEWeldOp process that is a child
Key of any children of the station display in a table.
Process Flow Displays the image attached to this station process as a
Sheet TMXMisc dataset type, using the following naming convention:
PF_*.jpg. If multiple files match the naming convention, the
entire report structure is repeated, with a different picture
embedded in each.
Contains a table of all the consumed corporate parts
(MEConsumed/MEWorkpiece) and occurrence groups
(MEConsumed/MEWorkpiece) assigned to the station process
and the process hierarchy under it.
Metal Removal Displays the image attached to this station process as a
Sheet TMXMisc dataset type, using the following naming convention:
MR_*.jpg. If multiple files match the naming convention, the
entire report structure is repeated, with a different picture
embedded in each.
Contains a table of all the consumed corporate parts
(MEConsumed/MEWorkpiece) and occurrence groups
(MEConsumed/MEWorkpiece) assigned to the station process
and the process hierarchy under it.
Sealer Application Displays the image attached to this station process as a
Sheet TMXMisc dataset type, using the following naming convention:
SA_*.jpg. If multiple files match the naming convention, the
entire report structure is repeated, with a different picture
embedded in each.
Contains a table of all the consumed corporate parts
(MEConsumed/MEWorkpiece) and occurrence groups
(MEConsumed/MEWorkpiece) assigned to the station process
and the process hierarchy under it.
Hemmer Data Displays the image attached to this station process as a
Sheet TMXMisc dataset type, using the following naming convention:
HD_*.jpg. If multiple files match the naming convention, the
entire report structure is repeated, with a different picture
embedded in each.
Contains a table of all the consumed corporate parts
(MEConsumed/MEWorkpiece) and occurrence groups
(MEConsumed/MEWorkpiece) assigned to the station process
and the process hierarchy under it.

12-148 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

Induction Cure Displays the image attached to this station process as a


Sheet TMXMisc dataset type, using the following naming convention:
IC_*.jpg. If multiple files match the naming convention, the
entire report structure is repeated, with a different picture
embedded in each.
Contains a table of all the consumed corporate parts
(MEConsumed/MEWorkpiece) and occurrence groups
(MEConsumed/MEWorkpiece) assigned to the station process
and the process hierarchy under it.
Fastener Data Displays the image attached to this station process as a
Sheet TMXMisc dataset type, using the following naming convention:
FD_*.jpg. If multiple files match the naming convention, the
entire report structure is repeated, with a different picture
embedded in each.
Contains a table of all the consumed corporate parts
(MEConsumed/MEWorkpiece) and occurrence groups
(MEConsumed/MEWorkpiece) assigned to the station process
and the process hierarchy under it.
VALID
VALUES
station_datum.xsl
station_weld.xsl
process_flow.xsl
metal_removal.xsl
sealer_application.xsl
hemmer_data.xsl
induction_cure.xsl
fastener_data.xsl
DEFAULT
VALUES
station_datum.xsl
station_weld.xsl
process_flow.xsl
metal_removal.xsl
sealer_application.xsl
hemmer_data.xsl
induction_cure.xsl
fastener_data.xsl
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_MEWeldOp_Reports

DESCRIPTION
Used for Teamcenter manufacturing process management Web reports. Defines
which report formatters (XSL style sheets) can be retrieved when the weld operation

PLM00026 11.2 Preferences and Environment Variables Reference 12-149


Chapter
Chapter 12:12:ClientClient preferences
preferences

report type MEWeldOp is selected from the Generate ME Report menu. These report
formats contain links to files that help in identification of location of a weld.
VALID
VALUES
weld_data_8X11.xsl
weld_data_11X17.xsl
DEFAULT
VALUES
weld_data_8X11.xsl
weld_data_11X17.xsl
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_MEPrPlantProcess_Reports

DESCRIPTION
Used for Teamcenter manufacturing process management Web reports. Defines which
report formatter (XSL style sheet) can be retrieved when the MEPrPlantProcess
report type is selected from the Generate ME Report menu. This report format
contains links to files that help in identification of location of a weld.
VALID
VALUES
inspection_report.xsl
DEFAULT
VALUES
inspection_report.xsl
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_MELocateCompOp_Reports

DESCRIPTION
Used for Teamcenter manufacturing process management Web reports. Defines
which report formatter (XSL style sheet) can be retrieved when the CD lead sheet
MELocateCompOp report type is selected from the Generate ME Report menu.
This report format links the Sequence of Zone Datum Key and Station Datum
Key reports.
VALID
VALUES
cd_leadsheet.xsl
DEFAULT
VALUES
cd_leadsheet.xsl

12-150 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

Class_Resource_WeldGun

DESCRIPTION
Used for Teamcenter manufacturing process management Web reports. Defines the
class names for the weld gun used within the report formatter (XSL style sheets).
VALID
VALUES
Weld Guns
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

Class_Resource_Robot

DESCRIPTION
Used for Teamcenter manufacturing process management Web reports. Defines the
class names for the robot used within the report formatter (XSL style sheets).
VALID
VALUES
Robots
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

TC_suppress_report_designs

DESCRIPTION
Determines whether specified manufacturing report formatters display in the
Teamcenter manufacturing process management thin client.
VALID
VALUES
Process-Structures The Process_Structure.xsl report formatter is suppressed.
Process structure reports do not display as a report
template option.
Product-Structures The Product_Structure.xsl report formatter is suppressed.
Product structure reports do not display as a report template
option.

PLM00026 11.2 Preferences and Environment Variables Reference 12-151


Chapter
Chapter 12:12:ClientClient preferences
preferences

Plant-Structures The Plant_Structure.xsl report formatter is suppressed.


Plant structure reports do not display as a report template
option.
DEFAULT
VALUES
Process-Structures
Product-Structures
Plant-Structures
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_TransferMode_XMLReport

DESCRIPTION
Used for Teamcenter manufacturing process management Web reports. Defines the
closure rule used to generate XML files containing reports.
Note

The default value should not be changed.

VALID
VALUES
Accepts a single string as a value. String must be a valid closure rule. The default
value should not be changed.
DEFAULT
VALUES
web_reports
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Report_Transfer_Area

DESCRIPTION
Used for Teamcenter manufacturing process management Web reports. Defines the
absolute path to the working directory in which reports are generated.
Note

The default value should not be changed.

VALID
VALUES
Accepts a single string as a value. String must be the absolute path to the working
directory in which reports are generated. The default value should not be changed.
DEFAULT
VALUES
%TC_ROOT%\web\htdocs\web_reports\temp (Windows)

12-152 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

/vobs/web_src/htdocs/web_reports/temp (UNIX)
DEFAULT
PROTECTION
SCOPE
Site preference.

Batch_Report_Request_File

DESCRIPTION
Used for Teamcenter manufacturing process management Web reports. Defines the
absolute path to the flat file that defines how batch reports are generated.
Note

The default value should not be changed.

VALID
VALUES
Accepts a single string as a value. String must be the absolute path to the flat file.
The default value should not be changed.
DEFAULT
VALUES
%TC_ROOT%\web\htdocs\web_reports\data\batch_request.txt (Windows)
/vobs/web_src/htdocs/web_reports/data/batch_request.txt (UNIX)
DEFAULT
PROTECTION
SCOPE
Site preference.

Web_Report_Jars

DESCRIPTION
Used for Teamcenter manufacturing process management Web reports. Defines
the absolute path to the report JAR files.
Note

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


variable.

Note

The default value should not be changed.

VALID
VALUES
Accepts a single string as a value. String must be the absolute path to the directory in
which the report JAR files for the JT Viewer are stored. The default value should not
be changed.
DEFAULT
VALUES
%TC_ROOT%\web\htdocs\web_reports\jar (Windows)

PLM00026 11.2 Preferences and Environment Variables Reference 12-153


Chapter
Chapter 12:12:ClientClient preferences
preferences

/vobs/web_src/htdocs/web_reports/jar (UNIX)
DEFAULT
PROTECTION
SCOPE
Site preference.

Active Workspace preferences

ActiveWorkspaceHosting.URL

DESCRIPTION
Specifies the URL used by Teamcenter to communicate with Active Workspace for
hosted operations such as search, open item, and others.
This preference takes precedence over the ActiveWorkspaceHosting.NX.URL,
ActiveWorkspaceHosting.Office.URL, and ActiveWorkspaceHosting.RAC.URL
preferences.
VALID
VALUES
A valid URL to your Active Workspace installation.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ActiveWorkspaceHosting.Office.URL

DESCRIPTION
Specifies the URL used by Teamcenter Client for Microsoft Office to communicate with
Active Workspace for hosted operations such as search, open item, and others.
This preference is evaluated before ActiveWorkspaceHosting.URL, which takes
precedence.
VALID
VALUES
A valid URL to your Active Workspace installation.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

12-154 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

ActiveWorkspaceHosting.NX.URL

DESCRIPTION
Specifies the URL used by Teamcenter Integration for NX to communicate with Active
Workspace for hosted operations such as search, open item, and others.

This preference is evaluated before ActiveWorkspaceHosting.URL, which takes


precedence.
VALID
VALUES
A valid URL to your Active Workspace installation.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ActiveWorkspaceHosting.RAC.URL

DESCRIPTION
Specifies the URL used by the rich client to communicate with Active Workspace for
hosted operations such as search, open item, and others.

This preference is evaluated before ActiveWorkspaceHosting.URL, which takes


precedence.
VALID
VALUES
A valid URL to your Active Workspace installation.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ActiveWorkspaceHosting.WorkflowEmail.URL

DESCRIPTION
Specifies the URL used by workflow to communicate with Active Workspace for e-mail
links.

This preference is evaluated before ActiveWorkspaceHosting.URL, which takes


precedence.

Note

You must manually add this preference.

PLM00026 11.2 Preferences and Environment Variables Reference 12-155


Chapter
Chapter 12:12:ClientClient preferences
preferences

VALID
VALUES
A valid URL to your Active Workspace installation.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

AWC_NX_AddComponentSupportedTypes

DESCRIPTION
Enables the specified object types to be added as a component in Teamcenter
Integration for NX when selected in Active Workspace. Only Item, ItemRevision, and
dataset types and subtypes are supported.
Add the values as applicable to your site from the available types provided
out-of-the-box. You can also add additional object types in accordance with the
requirements at your site.
The following values are available out of the box:

• Item
• ItemRevision
• UGMASTER
• UGALTREP
• DirectModel

Note

You must manually add this preference.

VALID
VALUES
Only Item, ItemRevision, and dataset types and subtypes are supported.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

AWC_NX_OpenSupportedTypes

DESCRIPTION
Enables the specified object types to be opened in Teamcenter Integration for NX
when selected in Active Workspace. Only Item, ItemRevision, and dataset types and
subtypes are supported.

12-156 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

Add the values as applicable to your site from the available types provided
out-of-the-box (OOTB). You can also add additional object types in accordance with
the requirements at your site.
The following values are available out of the box:
• Item
• ItemRevision
• UGMASTER
• UGALTREP
• DirectModel
• UGPART
• CAEGeom
• CAEMesh
• CAESolution
• NXMotion
Note

You must manually add this preference.

VALID
VALUES
Only Item, ItemRevision, and dataset types and subtypes are supported.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

AWC_OC_OpenSupportedTypes

DESCRIPTION
Enables opening the specified object types in Teamcenter Client for Microsoft Office
when selected in Active Workspace.
Note

You must manually add this preference.

VALID
VALUES
MSWord
MSWordX
MSWordTemplateX
MSWordTemplate
MSExcel
MSExcelX
MSExcelTemplateX
MSExcelTemplate
Outlook
MSPowerPointX
MSPowerPoint
MSPowerPointTemplate

PLM00026 11.2 Preferences and Environment Variables Reference 12-157


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

AWC_RAC_OpenSupportedTypes

DESCRIPTION
Enables opening the specified object types in the rich client when selected in Active
Workspace.
Note

You must manually add this preference.

VALID
VALUES
Dataset types and subtypes and:
ItemRevision
Folder
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

AWC_VIS_OpenSupportedTypes

DESCRIPTION
Enables opening the specified object types in Teamcenter lifecycle visualization when
selected in Active Workspace.
Note

You must manually add this preference.

VALID
VALUES
DirectModel
UGMaster
Item
ItemRevision
BomLine
BomView
BomViewRevision

Note

These types are supported only if they have product structure child objects and
IMAN_Rendering relations.

12-158 Preferences and Environment Variables Reference PLM00026 11.2


Client preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Use_ActiveWorkspace_Inbox

DESCRIPTION
Specifies whether to display the Active Workspace inbox instead of the rich client inbox
when you click My Worklist in the rich client.
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
True Enable display of the Active Workspace inbox instead of the
rich client inbox.
False Do not enable display of the Active Workspace inbox instead
of the rich client inbox.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Use_ActiveWorkspace_Summary

DESCRIPTION
Specifies whether to display the Active Workspace summary instead of the rich client
Summary view when you click the Summary view tab in the rich client.
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
True Enable display of the Active Workspace summary instead of
the rich client Summary view.
False Do not enable display of the Active Workspace summary
instead of the rich client Summary view.
DEFAULT
VALUES
False

PLM00026 11.2 Preferences and Environment Variables Reference 12-159


Chapter
Chapter 12:12:ClientClient preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

12-160 Preferences and Environment Variables Reference PLM00026 11.2


Chapter 13: Workflow preferences

CR_allow_alternate_procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1
EPM_adhoc_signoffs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1
EPM_ARG_target_user_group_list_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2
EPM_enable_apply_template_changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2
EPM_multiple_processes_targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
EPM_notify_url_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4
EPM_resource_pool_recipients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4
EPM_resource_pool_restrict_subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-5
EPM_skip_dataset_purge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-5
EPM_sub_process_target_inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-6
EPM_task_execution_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-7
EPM_valid_roles_to_assign_responsible_party . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-7
EPM_valid_user_to_apply_assignment_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-8
Global_transfer_access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-9
INBOX_hide_suspended_tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-9
Mail_OS_from_address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-10
RICH_CLIENT_MARKER_ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-10
SIGNOFF_adhoc_quorum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-11
SIGNOFF_fill_in_reviewers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-11
SIGNOFF_required_group_and_role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-12
TASK_MONITOR_SLEEP_TIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-12
TC_CM_approvers_modifier_roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-12
TC_external_default_launch_ui . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-13
TCVIEWER_default_workflow_view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-13
WORKFLOW_new_route_task_panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-14
WORKFLOW_adhoc_process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-14
WRKFLW_admin_for_inactive_user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-15
WORKFLOW_advanced_paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-16
WRKFLW_allow_replica_targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-16
WRKFLW_change_target_lmu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-16
WRKFLW_convert_backward_path_representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-17
WRKFLW_create_remote_workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-17
WRKFLW_display_participants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-17
WRKFLW_error_on_invalid_dynamic_participant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-18
WRKFLW_mail_surrogates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-19

WRKFLW_modify_completed_workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-19
WRKFLW_modify_target_list_access_privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-19
WRKFLW_multisite_apply_template_changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-20
WRKFLW_retain_ACL_objects_on_release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-20
WRKFLW_show_user_assignment_options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-20
WRKFLW_signoff_report_show_sub_process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-21
WRKFLW_task_complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-21

PLM00026 11.2 Preferences and Environment Variables Reference


WRKFLW_use_legacy_template_filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-22

Preferences and Environment Variables Reference PLM00026 11.2


Chapter 13: Workflow preferences

CR_allow_alternate_procedures

DESCRIPTION
Determines whether users can select alternate workflow processes from the New
Process Dialog dialog box using Process Template Filter.
VALID
VALUES
any The dialog box displays the All and Assigned options. The All option is
preselected.
Assigned The dialog box displays the All and Assigned options. The Assigned
option is preselected.
none The dialog box does not display the All and Assigned options. It is
populated with all assigned templates. If no assigned templates are defined
for the logged on group/role, the template section of the dialog box is empty.
DEFAULT
VALUES
none
DEFAULT
PROTECTION
SCOPE
User preference.

EPM_adhoc_signoffs

DESCRIPTION
Determines whether ad hoc signoff functionality is enabled.
VALID
VALUES
ON Ad hoc signoff functionality is enabled. Workflow participants performing
Select Signoff Team tasks can select workflow signoff users individually
and can select profiles.
OFF Ad hoc signoff functionality is disabled. Workflow participants performing
Select Signoff Team tasks can select profiles, but can't select workflow
signoff users individually.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 13-1


Chapter
Chapter 13:13:Workflow
Workflow preferences
preferences

EPM_ARG_target_user_group_list_separator

DESCRIPTION
Determines the separator used when multiple values are used in a handler argument.
If this preference is left unset, a comma is used.
VALID
VALUES
Accepts a single ASCII character as a value.
DEFAULT
VALUES
,
DEFAULT
PROTECTION
SCOPE
All.

EPM_enable_apply_template_changes

DESCRIPTION
Determines whether edits to a workflow template can be applied to all active workflow
processes based on the template.
If this preference is set to NONE, edits to a workflow template cannot be applied to
active workflow processes based that template. The changes in the workflow template
are applied only to future implementations.
If this preference is set to OPTIONAL, administrators can choose on a case-by-case
basis whether to apply template edits to active workflow processes based on the
template. After editing a workflow template and selecting the Set Stage to Available
check box to change its stage to Available, a dialog box appears in which the
administrator must indicate whether to apply the edits to all active workflow processes
based on the template. By selecting Yes in the dialog box, active workflow process
based on the edited template is updated as follows:
• If the edits in the workflow template occur later in the workflow than the active
workflow process has reached, the edits are applied to the workflow.

• If the edits in the workflow template occur earlier, and the active workflow has
already passed the place where the edits were made, the edits do not take effect,
unless the task/path is re-executed using backward branching/loops, or when a
task is demoted.

• If the edits in the workflow template impact an active task, the edits are applied
after the task completes and only take effect if the task is re-executed.

• If the edits delete the currently active task, the next task is started.

If set to AUTOMATIC, edits made to a workflow template are automatically applied


on all active workflow processes based on the edited template. Each active process
based on the edited template is updated by the same methodology as listed previously.
By default, this setting applies the edits in the background. However, this functionality
requires a four-tier architecture environment. (Users running in a two-tier environment

13-2 Preferences and Environment Variables Reference PLM00026 11.2


Workflow preferences

can successfully submit requests for asynchronous processing if there is a four-tier


Teamcenter environment available to accept the request.) Additionally, Dispatcher
must be enabled and configured for asynchronous processing.
Note

If background processing is not configured and supported at your site, active


workflow processes are updated in real time, regardless of this preference
setting. When updating in real time, the Teamcenter interface pauses until
the updates complete.

VALID
VALUES
NONE
Template edits cannot be applied to active workflow processes.
OPTIONAL
Administrators can choose on a case-by-case basis whether to apply template edits to
active workflow processes based on the template.
AUTOMATIC
Edits made to a workflow template are automatically applied on all active workflow
processes that are based on the edited template.
DEFAULT
VALUES
NONE
DEFAULT
PROTECTION
SCOPE
Site preference.

EPM_multiple_processes_targets

DESCRIPTION
Determines whether to allow multiple processes for the same objects.
Additionally, the EPM_sub_process_target_inheritance preference depends upon
the setting of this preference to determine the behavior of the Inherit Targets check
box, which appears as users create workflow subprocesses.
VALID
VALUES
ON Allows multiple processes for the same objects.
OFF Does not allow multiple processes for the same objects.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 13-3


Chapter
Chapter 13:13:Workflow
Workflow preferences
preferences

EPM_notify_url_format

DESCRIPTION
Determines which types of URLs are inserted into Teamcenter's task notification e-mail.
VALID
VALUES
Accepts one or more of the following values:
rich Inserts a URL to task object that launches the rich client when
clicked.
dhtml Inserts a URL to task object that launches the thin client when
clicked.
activeworkspace Inserts a URL to task object that launches Active Workspace
when clicked.
none No URL is inserted in the notification e-mail.
DEFAULT
VALUES
rich
dhtml
activeworkspace
DEFAULT
PROTECTION
SCOPE
All.

EPM_resource_pool_recipients

DESCRIPTION
Specifies the recipients of task notification e-mails based on resource pool data. Task
notification e-mails are sent when a resource pool is selected as a task notification
recipient.
VALID
VALUES
all All members belonging to the resource pools' specified group and
role are notified.
subscribed Only users who are subscribed to the resource pool are notified.
none No users are notified.
DEFAULT
VALUES
subscribed
DEFAULT
PROTECTION
SCOPE
All.

13-4 Preferences and Environment Variables Reference PLM00026 11.2


Workflow preferences

EPM_resource_pool_restrict_subscription

DESCRIPTION
Determines whether users' subscription access to resource pools is restricted. If
restricted, users can only subscribe to resource pools for groups/roles of which they
are a member.
Note

This preference setting is not asserted retroactively.


For example, in a situation where the setting is OFF and users have subscribed
to resource pools of which they are not members, changing the setting to ON
does not remove the existing subscriptions. Only future subscriptions are
restricted.

VALID
VALUES
ON Only the groups/roles of which the user is a member are available for
subscription in the Resource Pool Subscription dialog box.
OFF All users can subscribe to any resource pool; however, they can only
perform tasks if they are valid group/role members.
In the rich client, the Accessible option is selected by default.
In the thin client, the Accessible accessible option is selected by
default.
DEFAULT
VALUES
OFF
DEFAULT
PROTECTION
SCOPE
Site preference.

EPM_skip_dataset_purge

DESCRIPTION
Determines if dataset versions are purged when the EPM-set-status workflow handler
adds a status to a dataset.
VALID
VALUES
true Dataset versions are not purged.
false Dataset versions are purged.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 13-5


Chapter
Chapter 13:13:Workflow
Workflow preferences
preferences

EPM_sub_process_target_inheritance

DESCRIPTION
Works with the EPM_multiple_processes_targets preference to determine the
behavior of the Inherit Targets check box that appears as users create workflow
subprocesses.

Preferences Settings Behavior


EPM_multiple_processes_targets ON When the New Sub-Process dialog box
EPM_sub_process_target_inheritance ON appears, the Inherit Targets check box is
selected by default. Users can clear the
check box.
If left selected, subprocesses inherit the
target objects of the parent process.

EPM_multiple_processes_targets ON When the New Sub-Process dialog box


EPM_sub_process_target_inheritance OFF appears, the Inherit Targets check box is
clear by default. Users can select the check
box.
If left clear, subprocesses do not inherit the
target objects of the parent process.

EPM_multiple_processes_targets OFF When the New Sub-Process dialog box


EPM_sub_process_target_inheritance any setting appears, the Inherit Targets check box is
clear by default. Users can not modify the
check box.
Subprocesses do not inherit the target
objects of the parent process.

Regardless of how these two preferences are set to control the inheritance of target
objects from the parent process, users can always manually add or remove targets
from subprocesses.
VALID
VALUES
ON When the New Sub-Process dialog box appears, the Inherit Targets check
box is selected by default. Users can clear the check box.
OFF When the New Sub-Process dialog box appears, the Inherit Targets check
box is clear by default. Users can select the check box.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

13-6 Preferences and Environment Variables Reference PLM00026 11.2


Workflow preferences

EPM_task_execution_mode

DESCRIPTION
Determines if a local task object is executed asynchronously.
VALID
VALUES
Accepts multiple strings as values. Each string must be one of the following values.
Note

Accepts only one string at a time.

FOREGROUND Processes all tasks synchronously regardless of the task


template’s asynchronous setting.
BACKGROUND Processes all tasks asynchronously regardless of the task
template’s asynchronous setting.
CONFIGURABLE Processes tasks according to their asynchronous setting.
If the task asynchronous setting is set to on, the task is
processed asynchronously. If it is set to off, the task is
processed synchronously.
DEFAULT
VALUES
FOREGROUND
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
• When a task is processed asynchronously, all subsequent tasks that are
automatically triggered are also processed in the same asynchronous session
until either a handler that requires user interaction is encountered, an error is
generated, or the workflow process completes.

EPM_valid_roles_to_assign_responsible_party

DESCRIPTION
Determines the list of privileged users allowed to reassign the responsible party
responsibility of a task.
Warning

As of Teamcenter 10.1.3, this preference is obsolete and is replaced by the


Fnd0AssignTaskPrivilege condition. You must configure the condition so that
it provides the same behavior.

VALID
VALUES
Accepts multiple strings as values. Each string must be one of the following values.
responsible_party Allows the current responsible party to reassign the
responsible party responsibility of a task.

PLM00026 11.2 Preferences and Environment Variables Reference 13-7


Chapter
Chapter 13:13:Workflow
Workflow preferences
preferences

active_surrogate Allows the current surrogate user to reassign the


responsible party responsibility of a task.
task_owner Allows the owning user of the workflow process to reassign
the responsible party responsibility of a task.
task_owning_group Allows all users belonging to the group of the owning
user of the process to reassign the responsible party
responsibility of a task.
world Allows all users to reassign the responsible party
responsibility of a task.
privileged Allows the following users to reassign the responsible
party responsibility of a task:
• Current task owner

• Responsible party

• All administrative users

group::role Allows members of a specific group and role to reassign


the responsible party responsibility of a task. It must be
entered in the following format:
group::role
group is a valid Teamcenter group name and role is a valid
Teamcenter role name.
DEFAULT
VALUES
world
DEFAULT
PROTECTION
SCOPE
Site preference.

EPM_valid_user_to_apply_assignment_list

DESCRIPTION
Determines which users are authorized to use the Assign All Tasks feature for
assigning resources to workflow processes. The feature allows users to assign all
tasks in a new or in-progress workflow process using process assignment lists.
VALID
VALUES
Accepts multiple strings as values. Each string must be one of the following values.
If specifying one or more group/role pairs, each group and role must be a valid
Teamcenter group and role.
owner The owning user of the workflow process is authorized to use
this feature.
owning group All users belonging to the owning group of the workflow process
are authorized to use this feature.

13-8 Preferences and Environment Variables Reference PLM00026 11.2


Workflow preferences

world All users are authorized to use this feature.


privileged Group and site administrators are authorized to use this feature.
group::role Members of the specified group and role are authorized to use
this feature.
DEFAULT
VALUES
owner
DEFAULT
PROTECTION
SCOPE
Site preference.

Global_transfer_access

DESCRIPTION
Sets the access to the global_transfer utility. Using this utility, users can transfer their
own tasks to another user, or other tasks to other users. A group administrator can
transfer multiple assigned tasks to other group members. A system administrator can
transfer any user's tasks to another user.
For more information about this utility, see the Utilities Reference.
Note

All users, regardless of this preference setting, can use the global transfer
functionality to transfer their own tasks to someone else.

VALID
VALUES
0 Allows system administrator access.
1 Allows system administrator and group administrator access.
2 Allows all users access.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

INBOX_hide_suspended_tasks

DESCRIPTION
Determines how a user's inbox displays tasks when they are in either the Suspend
or Resume state.
VALID
VALUES
0 Affects the task and its subtasks it is performed upon. Does not remove/add a
task from/to a user's inbox.

PLM00026 11.2 Preferences and Environment Variables Reference 13-9


Chapter
Chapter 13:13:Workflow
Workflow preferences
preferences

1 Affects the task and its subtasks it is performed upon. It removes/adds tasks
from/to a user's Tasks to Perform inbox folder. Only the process initiator's
inbox displays the task process in his Tasks to Track folder.
2 Affects the entire workflow process related to the task it is performed upon.
Does not remove/add a task from/to a user's inbox.
3 Affects the entire process related to the task it is performed upon. It
removes/adds tasks from/to a user's Tasks to Perform inbox folder. Only the
process initiator's inbox displays the task process in his Tasks to Track folder.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

Mail_OS_from_address

DESCRIPTION
Adds the specified operating system From e-mail address to the notification e-mail
sent by the EPM-notify, EPM-notify-report, and EPM-notify-signoffs handlers.
VALID
VALUES
Any valid operating system e-mail address.
If the preference value is empty, it adds the operating system e-mail address in the
sender’s person definition.
DEFAULT
VALUES
Empty.
DEFAULT
PROTECTION
SCOPE
Site preference.

RICH_CLIENT_MARKER_ID

DESCRIPTION
Defines the server marker identifying the site to launch the Teamcenter object via
the URL inserted into the task notification e-mail (see the EPM_notify_url_format
preference). The Server field in the resulting logon dialog box is populated with this
value.
Note

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


variable.

13-10 Preferences and Environment Variables Reference PLM00026 11.2


Workflow preferences

VALID
VALUES
Accepts a single string as a value. Must be a valid server marker. Typically this is
the server marker used for the Teamcenter installation and the value is found in the
site_specific.properties file.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

SIGNOFF_adhoc_quorum

DESCRIPTION
Determines the constraints placed on changing the quorum value during team
selection.
VALID
VALUES
1 When ad hoc signoff is enabled, changing the quorum value during signoff
team selection is allowed with no constraints.
2 When ad hoc signoff is enabled, changing the quorum value during signoff
team selection is allowed only if the new quorum is greater than that set in the
task's template.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

SIGNOFF_fill_in_reviewers

DESCRIPTION
Determines how group members are selected by the CR-fill-in-reviewers handler.
Preference behavior is determined by the user’s current logon settings.
VALID
VALUES
1 Selects all group members from the user’s current logon setting. Selects
all group members from the user’s default group setting. Selects all group
members from any other groups to which the user belongs.
2 Selects all group members from the user’s current logon setting. Selects all
group members from the user’s default group setting.
3 Selects all group members from the user’s current logon setting.
DEFAULT
VALUES
1

PLM00026 11.2 Preferences and Environment Variables Reference 13-11


Chapter
Chapter 13:13:Workflow
Workflow preferences
preferences

DEFAULT
PROTECTION
SCOPE
All.

SIGNOFF_required_group_and_role

DESCRIPTION
Determines whether a user must be logged in to the correct group/role to perform an
assigned perform-signoffs task.
VALID
VALUES
0 User must be a registered member of the group and role required by the
perform-signoffs task, but does not have to be logged in as a member of
that group or role to perform the task.

1 User must be a registered member of the group and role required by the
perform-signoffs task and must be logged in as a member of that group
or role to perform the task.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

TASK_MONITOR_SLEEP_TIME

DESCRIPTION
Specifies the number of minutes in the sleep period of the Task Manager daemon
between dispatching cycles.
For more information about using this daemon, see System Administration.
VALID
VALUES
Positive integer up to 1,440 (the number of minutes in a 24-hour day).
DEFAULT
VALUES
30
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_CM_approvers_modifier_roles

DESCRIPTION
Lists Teamcenter roles that can create, modify and delete Change Viewer approver
lists.

13-12 Preferences and Environment Variables Reference PLM00026 11.2


Workflow preferences

VALID
VALUES
One or more strings as a value; each string must be a valid Teamcenter role.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_external_default_launch_ui

DESCRIPTION
Determines which Teamcenter client (rich client or thin client) is used to launch remote
Teamcenter objects. For use with remote inbox functionality. If remote workflow
is enabled, this preference determines which client is used to view the Teamcenter
objects contained within remote tasks.
For more information about viewing remote inboxes, see Getting Started with Workflow.
VALID
VALUES
thin Displays remote objects via the thin client.

rich Displays remote objects via the rich client.

dynamic Displays remote objects in same client being used to display local
workflow.
DEFAULT
VALUES
thin
DEFAULT
PROTECTION
SCOPE
User preference.

TCVIEWER_default_workflow_view

DESCRIPTION
Determines the default display of the Viewer tab to either Task View or Process
View. If the view is changed from the default setting during a particular session, that
view is persistent for that session only.
VALID
VALUES
task Displays the Task View window.

process Displays the Process View window.


DEFAULT
VALUES
task

PLM00026 11.2 Preferences and Environment Variables Reference 13-13


Chapter
Chapter 13:13:Workflow
Workflow preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

WORKFLOW_new_route_task_panel

DESCRIPTION
Determines the display of the Task View pane when selecting the Signoff Team for a
Route task. This pane displays either with option buttons for selecting the assignment
action, or with a list box.
Note

The option button display is a legacy method and is not supported.

When using the option button view, by default each name is added to the Signoff Team
with the Review action designation. Users must change this designation one name
at a time. This is time consuming when adding large address lists and a different
designation is required.
When using the list box method, users choose the action designation at the same time
the name is added to the Signoff Team. For example, when adding the QA address list
to the Signoff Team, the user can select the Notify action. Every member of the QA
team is automatically assigned the Notify designation.
For information about configuring Route tasks within a workflow template, see
Workflow Designer. For more information about how Route tasks are performed by
users, see Getting Started with Workflow.
VALID
VALUES
ON Displays the list box view of the Task View pane when selecting the Signoff
Team for a Route task.
OFF Displays the option button view of the Task View pane when selecting
the Signoff Team for a Route task.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

WORKFLOW_adhoc_process

DESCRIPTION
Determines which types of user are allowed to modify the structure and behavior
of an active workflow process.
Users granted this access can modify an active workflow process using Workflow
Viewer in Design mode.

13-14 Preferences and Environment Variables Reference PLM00026 11.2


Workflow preferences

Note

Only one workflow process at a time can be selected for modification using
this method.
You can modify all active workflow processes based on a
selected workflow process template from Workflow Designer if the
EPM_enable_apply_template_changes preference is set to OPTIONAL or
AUTOMATIC.

VALID
VALUES
0 All users have access.

1 System administrators and users granted edit access to Workflow Designer


using the Authorization application have access.

2 System administrators, group administrators, and users granted edit access to


Workflow Designer using the Authorization application have access.
DEFAULT
VALUES
2
DEFAULT
PROTECTION
SCOPE
Site preference.

WRKFLW_admin_for_inactive_user

DESCRIPTION
Specifies the email distribution list to receive a notice when a task or signoff is returned
to a resource pool because the assigned user is inactive.

If this preference is not set, the process owner receives the email notice.

Note

A task or signoff is returned only if the


WRKFLW_error_on_invalid_dynamic_participant preference value is true.

VALID
VALUES
Accepts one or more strings as a value. Each string must be a valid email address.
Separate addresses with a semicolon.
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 13-15


Chapter
Chapter 13:13:Workflow
Workflow preferences
preferences

WORKFLOW_advanced_paste

DESCRIPTION
Determines whether the Advanced Paste option is available in the New Process
dialog box. This option opens the Advanced Paste Attachment dialog box, used to
build and append a single-level list to the process targets or process references list.
The list can be built from a variety of sources, including query results and Structure
Manager.
VALID
VALUES
ON Displays the Advanced Paste option in the New Process dialog box.
OFF Does not display the Advanced Paste option in the New Process dialog box.
DEFAULT
VALUES
OFF
DEFAULT
PROTECTION
SCOPE
User preference.

WRKFLW_allow_replica_targets

DESCRIPTION
Determines if replica objects are attached as replica proposed targets in a workflow.
VALID
VALUES
TRUE Workflows attach replica objects as targets.
FALSE Workflows allow attaching replica objects as targets only if they are
remotely checked out to the current site by the current user.
DEFAULT
VALUE
TRUE
DEFAULT
PROTECTION
SCOPE
Group preference.

WRKFLW_change_target_lmu

DESCRIPTION
Indicates if the value of the last_mod_user (last modifying user) attribute of a workflow
target is changed when a status is applied with the EPM-set-status workflow handler.
VALID
VALUES
TRUE The last_mod_user (last modifying user) attribute value is changed
to the user who completes the task that changes the status.
FALSE The last_mod_user (last modifying user) attribute value is not
changed.

13-16 Preferences and Environment Variables Reference PLM00026 11.2


Workflow preferences

DEFAULT
VALUE
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

WRKFLW_convert_backward_path_representation

DESCRIPTION
Indicates if a check box to convert backward branching paths is displayed when a
process template is taken offline.
VALID
VALUES
true The check box option is displayed when a process template is taken
offline and backward branching paths are present.
false The check box option is not displayed when a process template is
taken offline.
DEFAULT
VALUE
false
DEFAULT
PROTECTION
SCOPE
Site preference.

WRKFLW_create_remote_workflow

DESCRIPTION
Determines if the workflow is created at the remote or the local site.
VALID
VALUES
TRUE An asynchronous request is submitted to create the workflow at the
remote site.
FALSE Workflow is created at the local site.
DEFAULT
VALUE
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

WRKFLW_display_participants

DESCRIPTION
Specifies which dynamic-participant types are shown when you assign dynamic
participants for an object.

PLM00026 11.2 Preferences and Environment Variables Reference 13-17


Chapter
Chapter 13:13:Workflow
Workflow preferences
preferences

VALID
VALUES
allowable Shows all dynamic-participant types that are associated with
the object type.
assignable Shows the dynamic-participant types that you can assign and
are used in any in-progress workflows on the object.
If there is no in-progress workflow, shows all types that you can
assign.
DEFAULT
VALUE
allowable
DEFAULT
PROTECTION
SCOPE
User preference.

WRKFLW_error_on_invalid_dynamic_participant

DESCRIPTION
Determines whether the following action handlers report an error if an assignee
dynamic participant is empty:
• EPM-adhoc-signoffs

• EPM-fill-in-reviewers

• EPM-auto-assign

• EPM-assign-team-selector

• EPM-auto-assign-rest

Note

• The EPM-adhoc-signoffs and EPM-fill-in-reviewers handlers report an


error only if they are assigning required reviewers.

• If the user assigned to the dynamic participant is inactive, the target


task or review is reassigned to a resource pool. Also, a notice of
the reassignment is sent to the email addresses specified by the
WRKFLW_admin_for_inactive_user preference.

VALID
VALUES
TRUE The handlers report an error.
FALSE The handlers do not report an error.
DEFAULT
VALUE
FALSE

13-18 Preferences and Environment Variables Reference PLM00026 11.2


Workflow preferences

DEFAULT
PROTECTION
SCOPE
Group preference.

WRKFLW_mail_surrogates

DESCRIPTION
Determines if surrogate e-mail notifications are sent in the Workflow application.
VALID
VALUES
true E-mail notifications are sent to all active surrogate users.
false E-mail notifications are not sent to all active surrogate users.
DEFAULT
VALUE
true
DEFAULT
PROTECTION
SCOPE
Group preference.

WRKFLW_modify_completed_workflow
Description
Allows removal of targets from completed workflows.

Valid Values
true Users are allowed to remove targets from completed workflows.
false Users are not allowed to move targets from completed workflows.

Default Value
false

Default Protection Scope


Site preference.

WRKFLW_modify_target_list_access_privilege

DESCRIPTION
Specifies the access privilege needed to modify the workflow target list.
VALID
VALUES
Any access privilege.
DEFAULT
VALUE
CHANGE

PLM00026 11.2 Preferences and Environment Variables Reference 13-19


Chapter
Chapter 13:13:Workflow
Workflow preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

WRKFLW_multisite_apply_template_changes

DESCRIPTION
Controls the application of changes to an active replica workflow template after
synchronization with the master template.
VALID
VALUES
true Template changes are applied to active workflow processes based on
that template at the replica site after synchronization.
false Template changes are not applied to active workflow processes based
on that template at the replica site after synchronization.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

WRKFLW_retain_ACL_objects_on_release

DESCRIPTION
Determines the state of access control list (ACL) objects on a target when a release
status is applied.
VALID
VALUES
true Any pre-exisiting ACL objects are not removed when the release
status is applied.
false Any pre-exisiting ACL objects are removed when the release status
is applied.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

WRKFLW_show_user_assignment_options

DESCRIPTION
Sets the display of the Organization and Project Teams tabs when you assign users
to workflow tasks as responsible parties, reviewers, and dynamic participants.

13-20 Preferences and Environment Variables Reference PLM00026 11.2


Workflow preferences

VALID
VALUES
org_default Both the Organization tab and the Project Teams tab are
displayed. The initial active tab is Organization.
org_only Only the Organization tab is displayed.
project_default Both the Project Teams tab and the Organization tab are
displayed. The initial active tab is Project Teams.
project_only Only the Project Teams tab is displayed.
DEFAULT
VALUE
org_default
DEFAULT
PROTECTION
SCOPE
Group preference.

WRKFLW_signoff_report_show_sub_process

DESCRIPTION
Determines if a signoff report for the parent and dependent or independent
subprocesses is generated.
VALID
VALUES
0 Shows signoff details for the parent process as well as dependent or
independent subprocesses.
1 Shows signoff details for the parent process and only dependent
subprocesses. Details for independent subprocesses are not shown.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

WRKFLW_task_complete

DESCRIPTION
Defines the default selection of several key components to use single-click functionality
for the Workflow perform task action.
Note

This preference applies only to Do tasks and Select Signoff Team for review
and route tasks.

PLM00026 11.2 Preferences and Environment Variables Reference 13-21


Chapter
Chapter 13:13:Workflow
Workflow preferences
preferences

VALID
VALUES
true For Do tasks, the Complete value is selected by default for the Done
button.
For Select Signoff Team for review and route tasks, the Ad-hoc
Done check box is selected by default.
Caution

Setting the value to true also sets the associated task_result


property to Complete by default.

false No value is preselected for either task type.


DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

WRKFLW_use_legacy_template_filter

DESCRIPTION
Specifies whether to use the legacy type- and group-based template filter, or the
condition-based template filter.
VALID
VALUES
true Use the legacy type- and group-based template filter.
false Use condition-based template filter.
DEFAULT
VALUE
false
DEFAULT
PROTECTION
SCOPE
Site preference.

13-22 Preferences and Environment Variables Reference PLM00026 11.2


Chapter 14: Change management preferences

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


ChangeItemRevision_Cpd0SubsetDefaults_default_relation . . . . . . . . . . . . . . . . . . . . . 14-1
ChangeItemRevision_Cpd0DesignElement_default_relation . . . . . . . . . . . . . . . . . . . . . 14-1
ChangeItemRevision_Cpd0WorksetRevision_default_relation . . . . . . . . . . . . . . . . . . . . 14-2
ChangeItemRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-3
ChangeItemRevision_ItemRevision_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . 14-3
ChangeItemRevision_Ptn0Partition_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4
ChangeNotice.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-5
ChangeNoticeCreate.CREATE_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-5
ChangeNoticeRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-5
ChangeNoticeRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
ChangeNoticeRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
ChangeNoticeRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
ChangeNoticeRevisionSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . 14-7
ChangeRequest.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
ChangeRequestCreate.CREATE_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
ChangeRequestRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-8
ChangeRequestRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-8
ChangeRequestRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9
ChangeRequestRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9
ChangeRequestRevisionSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . 14-9
CM_bomchange_formtype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-10
CM_change_derivations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-10
CM_Change_History_Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-11
CM_ChangeRequestRevision_Relations_To_Propagate . . . . . . . . . . . . . . . . . . . . . . . 14-11
CM_Cm0DevRqstRevision_Relations_To_Propagate . . . . . . . . . . . . . . . . . . . . . . . . . 14-11
CM_CNR_ChangeHistory_Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-12
CM_Effectivity_DefaultColumns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-12
CM_form_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-13
CM_impacted_item_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-13
CM_Item_ChangeHistory_Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-14
CM_massupdate_allowed_ECR_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-15
CM_massupdate_allowed_ECN_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-15
CM_Massupdate_Impacted_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-16
CM_Massupdate_Problem_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-16
CM_Massupdate_Solution_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-16
CM_Massupdate_Support_Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-17
CM_note_types_to_track . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-17
CM_notehistory_extra_columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-18
CM_ProblemReportRevision_Relations_To_Propagate . . . . . . . . . . . . . . . . . . . . . . . 14-18
CM_pureaddcancel_tooltip_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-18
CM_relation_creation_flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19
CM_solution_items_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-20

PLM00026 11.2 Preferences and Environment Variables Reference


CM_supersedure_tooltip_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-20
CM_track_variant_condition_changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-21
CM_varianthistory_extra_columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-21
CM_work_breakdown_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-21
CMHasImpactedItem_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-22
CMHasProblemItem_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-23
CMHasSolutionItem_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-23
CMHasWorkBreakdown_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-24
CMImplements_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-24
CMReferences_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-25
Cm0DevRqst.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-25
Cm0DevRqstCreate.CREATE_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-25
Cm0DevRqstRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-26
Cm0DevRqstRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-26
Cm0DevRqstRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-27
Cm0DevRqstRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-27
Cm0DevRqstRevisionSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . 14-27
MassUpdateDefaultRevRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-28
ProblemReport.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-28
ProblemReportCreate.CREATE_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . 14-28
ProblemReportRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-29
ProblemReportRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-29
ProblemReportRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-29
ProblemReportRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-30
ProblemReportRevisionSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . 14-30
WEB_Enable_Create_Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-30
CM_color_of_add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-31
CM_color_of_cancel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-31
CM_color_of_common . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-32
CM_color_of_moved . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-32
CM_color_of_notechange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-33
CM_color_of_quantity_change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-33
CM_color_of_reshaped . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-34
CM_color_of_variantchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-34
CM_initial_position_of_sliders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-35
CM_progression_tree_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-35
CM_show_common_parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-36
EngChange Revision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-36
Supercedure_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-37
TC_bomchange_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-37
TC_supercedure_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-38

Preferences and Environment Variables Reference PLM00026 11.2


Chapter 14: Change management preferences

Change Manager preferences

ChangeItemRevision_Cpd0SubsetDefaults_default_relation

DESCRIPTION
When creating a change object in the context of a subset, specifies the relation the
subset has to the created change item revision. The default is that the subset is
a reference item.

VALID
VALUES
Any valid change management relation.
DEFAULT
VALUES
CMReferences
DEFAULT
PROTECTION
SCOPE
User.

ChangeItemRevision_Cpd0DesignElement_default_relation

DESCRIPTION
When creating a change object in the context of a design element, specifies the
relation the design element has to the created change item revision. The default is that
the design element is an impacted item.

PLM00026 11.2 Preferences and Environment Variables Reference 14-1


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

VALID
VALUES
Any valid change management relation.
DEFAULT
VALUES
CMHasImpactedItem
DEFAULT
PROTECTION
SCOPE
User.

ChangeItemRevision_Cpd0WorksetRevision_default_relation

DESCRIPTION
When creating a change object in the context of a workset, specifies the relation the
workset has to the created change item revision. The default is that the workset is
a reference item.

14-2 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

VALID
VALUES
Any valid change management relation.
DEFAULT
VALUES
CMReferences
DEFAULT
PROTECTION
SCOPE
User.

ChangeItemRevision_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of a
ChangeItemRevision node.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of the
ChangeItemRevision object.
DEFAULT
VALUES
IMAN_master_form_rev
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
release_status_list
TC_Attaches
CMImplements
CMImplementedBy
CMHasImpactedItem
CMHasProblemItem
CMReferences
CMHasSolutionItem
CMHasWorkBreakdown
DEFAULT
PROTECTION
SCOPE
Site preference.

ChangeItemRevision_ItemRevision_default_relation

DESCRIPTION
When creating a change object in the context of an item revision, specifies the relation
the item revision has to the created change item revision. The default is that the item
revision is a problem item, as shown in the figure for a change request.

PLM00026 11.2 Preferences and Environment Variables Reference 14-3


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

VALID
VALUES
Any valid change management relation.
DEFAULT
VALUES
CMHasProblemItem
DEFAULT
PROTECTION
SCOPE
User.

ChangeItemRevision_Ptn0Partition_default_relation

DESCRIPTION
When creating a change object in the context of a partition, specifies the relation the
partition has to the created change item revision. The default is that the partition is an
impacted item, as shown in the figure for a change request.

14-4 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

VALID
VALUES
Any valid change management relation.
DEFAULT
VALUES
CMHasImpactedItem
DEFAULT
PROTECTION
SCOPE
User.

ChangeNotice.CREATERENDERING

DESCRIPTION
Registers the create style sheet for change notice objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ChangeNoticeCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

ChangeNoticeCreate.CREATE_REGISTEREDTO

DESCRIPTION
Specifies the types to which the ChangeNoticeCreate style sheet can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ChangeNotice
DEFAULT
PROTECTION
SCOPE
Site preference.

ChangeNoticeRevision_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of a
ChangeNoticeRevision node.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of the
ChangeNoticeRevision object.

PLM00026 11.2 Preferences and Environment Variables Reference 14-5


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

DEFAULT
VALUES
IMAN_master_form_rev
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
release_status_list
TC_Attaches
CMImplements
CMHasImpactedItem
CMHasProblemItem
CMReferences
CMHasSolutionItem
CMHasWorkBreakdown

DEFAULT
PROTECTION
SCOPE
Site preference.

ChangeNoticeRevision.REGISTEREDTO

DESCRIPTION
Specifies the types to which the ChangeNoticeRevisionProperty style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ChangeNoticeRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ChangeNoticeRevision.RENDERING

DESCRIPTION
Registers the properties style sheet for change notice revision objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ChangeNoticeRevisionProperty
DEFAULT
PROTECTION
SCOPE
Site preference.

14-6 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

ChangeNoticeRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for change notice revision objects. The summary
style sheet is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ChangeNoticeRevisionSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

ChangeNoticeRevisionSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the ChangeNoticeRevisionSummary style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ChangeNoticeRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ChangeRequest.CREATERENDERING

DESCRIPTION
Registers the create style sheet for change request objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ChangeRequestCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

ChangeRequestCreate.CREATE_REGISTEREDTO

DESCRIPTION
Specifies the types to which the ChangeRequestCreate style sheet can be applied.

PLM00026 11.2 Preferences and Environment Variables Reference 14-7


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ChangeRequest
DEFAULT
PROTECTION
SCOPE
Site preference.

ChangeRequestRevision_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of a
ChangeRequestRevision node.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of the
ChangeRequestRevision object.
DEFAULT
VALUES
IMAN_master_form_rev
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
release_status_list
TC_Attaches
CMImplements
CMImplementedBy
CMHasImpactedItem
CMHasProblemItem
CMReferences
CMHasWorkBreakdown

DEFAULT
PROTECTION
SCOPE
Site preference.

ChangeRequestRevision.REGISTEREDTO

DESCRIPTION
Specifies the types to which the ChangeRequestRevisionProperty style sheet can
be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.

14-8 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

DEFAULT
VALUES
ChangeRequestRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ChangeRequestRevision.RENDERING

DESCRIPTION
Registers the properties style sheet for change request revision objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ChangeRequestRevisionProperty
DEFAULT
PROTECTION
SCOPE
Site preference.

ChangeRequestRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for change request revision objects. The summary
style sheet is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ChangeRequestRevisionSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

ChangeRequestRevisionSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the ChangeRequestRevisionSummary style sheet
can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ChangeRequestRevision

PLM00026 11.2 Preferences and Environment Variables Reference 14-9


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

CM_bomchange_formtype

DESCRIPTION
Sets the form type to be used for customizing BOMChange attributes.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid Teamcenter form
type.
DEFAULT
VALUES
BomChange Form
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_change_derivations

DESCRIPTION
Defines the type of change to create from a given source type during the derive
change process.
VALID
VALUES
source-type/derived-type
source-type is the type of change from which to derive the change; derived-type is the
type of change to be created.
DEFAULT
VALUES
IssueReport/ChangeRequest
PnM0Penetration/ChangeRequest
ProblemReport/ChangeRequest
ProblemReport/Cm0DevRqst
ChangeRequest/ChangeNotice
Cm0DevRqst/ChangeNotice
Cm0ActionItem/ChangeRequest
Cm0ActionItem/Cm0DevRqst
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
None.

14-10 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

CM_Change_History_Enable

DESCRIPTION
Specifies if the Summary view displays the Change History tab for items, item
revisions, and change notice revisions.
VALID
VALUES
TRUE The Summary view displays the Change History tab for items, item
revisions, and change notice revisions.

FALSE The Summary view does not display the Change History tab for items,
item revisions, and change notice revisions.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
User preference.

CM_ChangeRequestRevision_Relations_To_Propagate

DESCRIPTION
Specifies the list of relations to be propagated when deriving a change from a change
request revision.
VALID
VALUES
One or more strings representing a valid Change Manager relation.
DEFAULT
VALUES
CMHasImpactedItem
CMHasProblemItem
CMReferences
IMAN_reference
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
None.

CM_Cm0DevRqstRevision_Relations_To_Propagate

DESCRIPTION
Specifies the list of relations to be propagated when deriving a change from a deviation
request revision.
VALID
VALUES
One or more strings representing a valid Change Manager relation.

PLM00026 11.2 Preferences and Environment Variables Reference 14-11


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

DEFAULT
VALUES
CMHasImpactedItem
CMHasProblemItem
CMReferences
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
None.

CM_CNR_ChangeHistory_Columns

DESCRIPTION
Specifies the columns to display in the Change History tab of the Summary view of a
change notice revision.
VALID
VALUES
Any item revision properties defined in Business Modeler IDE.
DEFAULT
VALUES
k_ch_solution_ Shows the solution item for the selected change notice.
item
k_ch_impacted_ Shows impacted items for which a solution item is generated.
item You can see the solution item in the k_ch_solution_item
column.
k_ch_inc_ Shows the object incorporated by the selected change notice
changes_of into the solution item. You can see the solution item in the
k_ch_solution_item column.
k_ch_inc_by Shows change notices that fully incorporates a change.
k_ch_inc_into Shows the object that fully incorporates a change.
k_ch_inc_status Shows the incorporation status of a change.
DEFAULT
PROTECTION
SCOPE
User preference.

CM_Effectivity_DefaultColumns

DESCRIPTION
Controls the columns that can be displayed for Effectivity objects.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of the
Effectivity object.

14-12 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

DEFAULT
VALUES
release_status
effectivity_id
range_text
end_item
effectivity_protection

DEFAULT
PROTECTION
SCOPE
Site preference.

CM_form_relation

DESCRIPTION
Specifies the relation to use between change forms and change items.
VALID
VALUES
Any valid Teamcenter relation.
DEFAULT
VALUES
IMAN_reference
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_impacted_item_relation

DESCRIPTION

Note

CM_impacted_item_relation has been deprecated and will be removed in a


future version of Teamcenter. Keep the preference set to its default value until it
is removed.

Defines the list of relations that contain the target of a change process where workflow
handlers attach the objects.
VALID
VALUES
Change Manager relations that contain the target object of a change process. It can
be any of the following relations:
• CMHasImpactedItem

• CMHasSolutionItem

• CMImplements

• CMReferences

PLM00026 11.2 Preferences and Environment Variables Reference 14-13


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

• CMHasProblemItem

• CMHasWorkBreakdown

DEFAULT
VALUES
CMHasImpactedItem
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_Item_ChangeHistory_Columns

DESCRIPTION
Specifies the columns to display in the Change History tab of the Summary view of
an item or item revision.
VALID
VALUES
Any item revision properties defined in Business Modeler IDE.
DEFAULT
VALUES
k_ch_revision Shows the display name of the selected item revision. The
selected item revision is a solution item for the impacted item
that is shown in the k_ch_impacted_item column. You can see
other solution items in the k_ch_markup column.
k_ch_impacted_ Shows the impacted item. You can see the solution items
item for this impacted item in the k_ch_revision column and
k_ch_markup columns.
k_ch_markup Shows solutions items for the impacted item. You can see the
impacted item in the k_ch_impacted_item column.
k_ch_auth_cn Shows the authorizing change notice for the item revision and
the solution items in the k_ch_revision and k_ch_markup
columns, respectively.
k_ch_cn_closure Shows the closure value of the authorizing change notice.
k_ch_cn_maturity Shows the maturity value of the authorizing change notice.
k_ch_cn_ Shows the disposition value of the authorizing change notice.
disposition
k_ch_inc_ Shows the object incorporated by the authorizing change notice
changes_of into the items shown in the k_ch_revision and k_ch_markup
columns.
k_ch_inc_by Shows change notices that fully incorporate a change.
k_ch_inc_into Shows the object that fully incorporates a change.
k_ch_inc_status Shows the incorporation status of a change.

14-14 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

DEFAULT
PROTECTION
SCOPE
User preference.

CM_massupdate_allowed_ECR_types

DESCRIPTION
Specifies the Change Manager change object revision types to be used during the
change request (ECR) process of a two-phase mass update.
This is one of several preferences used to configure mass update functionality.
Use mass updates to perform bulk updates to multiple assemblies, including
designating or replacing substitutes for parts. For example, you can identify and
automatically replace every occurrence of an impacted part with its solution item.
For more information about mass updates during a change management process,
see Change Manager.
VALID
VALUES
ChangeNoticeRevision
DEFAULT
VALUES
ChangeNoticeRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_massupdate_allowed_ECN_types

DESCRIPTION
Specifies the Change Manager change object revision types to be used during the
change notice (ECN) process of a two-phase mass update.
This is one of several preferences used to configure mass update functionality.
Use mass updates to perform bulk updates to multiple assemblies, including
designating or replacing substitutes for parts. For example, you can identify and
automatically replace every occurrence of an impacted part with its solution item.
For more information about mass updates during a change management process,
see Change Manager.
VALID
VALUES
ChangeRequestRevision
DEFAULT
VALUES
ChangeRequestRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 14-15


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

CM_Massupdate_Impacted_PseudoFolder

DESCRIPTION
Defines the Generic Relationship Management (GRM) rule to use when adding
impacted parts to a Change Manager change object during a mass update.
This is one of several preferences used to configure mass update functionality.
Use mass updates to perform bulk updates to multiple assemblies, including
designating or replacing substitutes for parts. For example, you can identify and
automatically replace every occurrence of an impacted part with its solution item.
For more information about mass updates during a change management process,
see Change Manager.
For more information about GRM rules, see Business Modeler IDE.
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_Massupdate_Problem_PseudoFolder

DESCRIPTION
Defines the Generic Relationship Management (GRM) rule to use when adding
problem parts to a Change Manager change object during a mass update.
This is one of several preferences used to configure mass update functionality.
Use mass updates to perform bulk updates to multiple assemblies, including
designating or replacing substitutes for parts. For example, you can identify and
automatically replace every occurrence of an impacted part with its solution item.
For more information about mass updates during a change management process,
see Change Manager.
For more information about GRM rules, see Business Modeler IDE.
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_Massupdate_Solution_PseudoFolder

DESCRIPTION
Defines the Generic Relationship Management (GRM) rule to use when adding
solution items to a Change Manager change object during a mass update.
This is one of several preferences used to configure mass update functionality.
Use mass updates to perform bulk updates to multiple assemblies, including
designating or replacing substitutes for parts. For example, you can identify and
automatically replace every occurrence of an impacted part with its solution item.
For more information about mass updates during a change management process,
see Change Manager.

14-16 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

For more information about GRM rules, see Business Modeler IDE.
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_Massupdate_Support_Change

DESCRIPTION
Specifies that the Change Manager solution is installed for mass update availability.
This preference value must not be changed manually.
This is one of several preferences used to configure mass update functionality.
Use mass updates to perform bulk updates to multiple assemblies, including
designating or replacing substitutes for parts. For example, you can identify and
automatically replace every occurrence of an impacted part with its solution item.
For more information about mass updates during a change management process,
see Change Manager.
VALID
VALUES
true
false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_note_types_to_track

DESCRIPTION
Specifies which product structure note types can be tracked for a particular change
type.
VALID
VALUES
Accepts multiple strings as values; each string must contain a valid Teamcenter
change type, and one or more valid Teamcenter note types using the following syntax:
CM_note_types_to_track=
Change-Type1:Note-Type1,Note-Type2
Change-Type2:Note-Type1,Note-Type4

For example, a valid value is:


ChangeNotice:UG Geometry,UG NAME
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 14-17


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

CM_notehistory_extra_columns

DESCRIPTION
Determines which fields of the BOM change form are included in the Note Change
History dialog box. This dialog box is opened from the Structure Manager application
and tracks note changes for a particular component of an assembly.
VALID
VALUES
Accepts multiple strings as values; each string must contain a persistent property of
the BOM change form, using the following syntax:
CM_notehistory_extra_columns=
Form-Field1
Form-Field2
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_ProblemReportRevision_Relations_To_Propagate

DESCRIPTION
Specifies the list of relations to be propagated when deriving a change from a problem
report revision.
VALID
VALUES
One or more strings representing a valid Change Manager relation.
DEFAULT
VALUES
CMHasProblemItem
CMReferences
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
None.

CM_pureaddcancel_tooltip_properties

DESCRIPTION
Sets the pure add and cancel properties displayed in the genealogy watch box.

14-18 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

VALID
VALUES
Accepts one or more strings as values in the form of bomedit-object.property-name.
The bomedit-object string is the internal name of BOM edit object. The property-name
string is a valid Teamcenter internal property name. Both internal names can be
retrieved from the Business Modeler IDE.
DEFAULT
VALUES
CMBvrTag.object_name
CMProblemBvr.object_name
CMChangeRevTag.owning_user
CMOccurenceTag.seq_no

DEFAULT
PROTECTION
SCOPE
Site preference.

CM_relation_creation_flag

DESCRIPTION
Determines if a newly-created in-context change item is automatically related to the
latest item revision or a user-selected revision. You can set different values for change
items and non-change items.
VALID
VALUES
ChangeItems=1 Automatically creates a relation between the new change
item and the latest revision of the selected existing change
item.
ChangeItems=0 Forces the user to select the existing change item revision
to be related to the new change item.
NonChangeItems=1 Automatically creates a relation between the new change
item and the latest revision of the selected existing
non-change item.
NonChangeItems=0 Forces the user to select the existing non-change item
revision to be related to the new change item.
DEFAULT
VALUES
ChangeItems=1
NonChangeItems=1
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 14-19


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

CM_solution_items_relation

DESCRIPTION

Note

CM_solution_items_relation has been deprecated and will be removed in a


future version of Teamcenter. Keep the preference set to its default value until it
is removed.

Defines the relation containing the objects which are identified as solution objects
by the change process.
VALID
VALUES
Change Manager relation that identifies the solution object. It can be any of the
following relations:

• CMHasSolutionItem

• CMImplements

• CMHasImpactedItem

• CMReferences

• CMHasProblemItem

• CMHasWorkBreakdown

DEFAULT
VALUES
CMHasSolutionItem
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_supersedure_tooltip_properties

DESCRIPTION
Sets the supersedure component properties displayed in the genealogy watch box.
VALID
VALUES
Accepts one or more strings as values in the form of bvrrev-object.property-name.
The bvrrev-object string is the internal name of BOM view revision object. The
property-name string is a valid Teamcenter internal property name. Both internal
names can be retrieved from the Business Modeler IDE.
DEFAULT
VALUES
CMImpactedBvr.object_name

14-20 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

CM_track_variant_condition_changes

DESCRIPTION
Defines the change types for which variant BOM changes can be tracked.
VALID
VALUES
Accepts multiple strings as values; each string must contain a valid Teamcenter
change type using the following syntax:
CM_track_variant_condition_changes=
Change-Type1
Change-Type2
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_varianthistory_extra_columns

DESCRIPTION
Determines which fields of the BOM change form are included in the Variant Change
History dialog box.
VALID
VALUES
Accepts multiple strings as values; each string must contain a persistent property of
the BOM change form, using the following syntax:
CM_varianthistory_extra_columns=
Form-Field1
Form-Field2
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_work_breakdown_relation

DESCRIPTION
Defines the relation containing the work breakdown schedules of the change process.

PLM00026 11.2 Preferences and Environment Variables Reference 14-21


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

VALID
VALUES
Change Manager relation that contains the work breakdown schedules of the change
process. It can be any of the following relations:

• CMHasWorkBreakdown

• CMHasImpactedItem

• CMHasSolutionItem

• CMImplements

• CMReferences

• CMHasProblemItem

DEFAULT
VALUES
CMHasWorkBreakdown
DEFAULT
PROTECTION
SCOPE
Site preference.

CMHasImpactedItem_relation_primary

DESCRIPTION
Specifies the valid primary object types for the CMHasImpactedItem 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 one or more strings as values; each string must be a primary Teamcenter
object.
DEFAULT
VALUES
Item
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

14-22 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

CMHasProblemItem_relation_primary

DESCRIPTION
Specifies the valid primary object types for the CMHasProblemItem 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 one or more strings as values; each string must be a primary Teamcenter
object.
DEFAULT
VALUES
Item
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

CMHasSolutionItem_relation_primary

DESCRIPTION
Specifies the valid primary object types for the CMHasSolutionItem 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 one or more strings as values; each string must be a primary Teamcenter
object.
DEFAULT
VALUES
Item
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 14-23


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

CMHasWorkBreakdown_relation_primary

DESCRIPTION
Specifies the valid primary object types for the CMHasWorkBreakdown 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 one or more strings as values; each string must be a primary Teamcenter
object.
DEFAULT
VALUES
Item
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

CMImplements_relation_primary

DESCRIPTION
Specifies the valid primary object types for the CMImplements 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 one or more strings as values; each string must be a primary Teamcenter
object.
DEFAULT
VALUES
Item
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

14-24 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

CMReferences_relation_primary

DESCRIPTION
Specifies the valid primary object types for the CMReferences 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 one or more strings as values; each string must be a primary Teamcenter
object.
DEFAULT
VALUES
Item
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

Cm0DevRqst.CREATERENDERING

DESCRIPTION
Registers the create style sheet for deviation request objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
Cm0DevRqstCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

Cm0DevRqstCreate.CREATE_REGISTEREDTO

DESCRIPTION
Specifies the types to which the Cm0DevRqstCreate style sheet can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
Cm0DevRqst

PLM00026 11.2 Preferences and Environment Variables Reference 14-25


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

Cm0DevRqstRevision_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of a
Cm0DevRqstRevision node.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of the
Cm0DevRqstRevision object.
DEFAULT
VALUES
IMAN_master_form_rev
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
release_status_list
TC_Attaches
CMImplements
CMImplementedBy
CMHasProblemItem
CMReferences
CMHasWorkBreakdown
DEFAULT
PROTECTION
SCOPE
Site preference.

Cm0DevRqstRevision.REGISTEREDTO

DESCRIPTION
Specifies the types to which the Cm0DevRqstRevision style sheet can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
Cm0DevRqstRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

14-26 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

Cm0DevRqstRevision.RENDERING

DESCRIPTION
Registers the properties style sheet for deviation request revision objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
Cm0DevRqstRevisionProperty
DEFAULT
PROTECTION
SCOPE
Site preference.

Cm0DevRqstRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for deviation request revision objects. The
summary style sheet is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
Cm0DevRqstRevisionSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

Cm0DevRqstRevisionSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the Cm0DevRqstRevisionSummary style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
Cm0DevRqstRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 14-27


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

MassUpdateDefaultRevRule

DESCRIPTION
Specifies the revision rule that is used to perform a where-used search on the target
part of a mass update to find the impacted assemblies (parents of the target).
This is one of several preferences used to configure mass update functionality.
Use mass updates to perform bulk updates to multiple assemblies, including
designating or replacing substitutes for parts. For example, you can identify and
automatically replace every occurrence of an impacted part with its solution item.
For more information about mass updates during a change management process,
see Change Manager.
For more information about setting up where-used searches, see Teamcenter Basics.
VALID
VALUES
Accepts one or more strings as values; each string must be a revision rule.
DEFAULT
VALUES
Latest Working
DEFAULT
PROTECTION
SCOPE
Site preference.

ProblemReport.CREATERENDERING

DESCRIPTION
Registers the create style sheet for problem report objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ProblemReportCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

ProblemReportCreate.CREATE_REGISTEREDTO

DESCRIPTION
Specifies the types to which the ProblemReportCreate style sheet can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ProblemReport

14-28 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ProblemReportRevision_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of a
ProblemReportRevision node.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of the
ProblemReportRevision object.
DEFAULT
VALUES
IMAN_master_form_rev
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
release_status_list
TC_Attaches
CMImplementedBy
CMHasProblemItem
CMReferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ProblemReportRevision.REGISTEREDTO

DESCRIPTION
Specifies the types to which the ProblemReportRevision style sheet can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ProblemReportRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ProblemReportRevision.RENDERING

DESCRIPTION
Registers the properties style sheet for problem report revision objects.

PLM00026 11.2 Preferences and Environment Variables Reference 14-29


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ProblemReportRevisionProperty
DEFAULT
PROTECTION
SCOPE
Site preference.

ProblemReportRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for problem report revision objects. The summary
style sheet is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ProblemReportRevisionSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

ProblemReportRevisionSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the ProblemReportRevisionSummary style sheet can
be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ProblemReportRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_Enable_Create_Change

DESCRIPTION
Determines whether the New→Change→Create, New→Change→Context Create,
and New→Change→Derived Change menu commands are displayed in the thin
client.

14-30 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

VALID
VALUES
true Displays the menu commands.
false Hides the menu commands.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_color_of_add

DESCRIPTION
Specifies the default color to represent BOM adds in the rich client interface. Colors
must be specified in RGB format. Red, green, and blue can be combined in various
proportions to obtain any color in the visible spectrum. Levels of R, G, and B can each
range from 0 to 100 percent of full intensity. Each color level is represented by the
range of decimal numbers from 0 to 255. The total number of available colors is 256 x
256 x 256, or 16,777,216 possible colors.
Users can also set this preference for their environment using the
Edit→Options→Change Management menu command.
VALID
VALUES
Decimal numbers from 0 to 255.
DEFAULT
VALUES
64,79,161
Blue
DEFAULT
PROTECTION
SCOPE
User preference.

CM_color_of_cancel

DESCRIPTION
Specifies the default color to represent BOM cancels in the rich client interface. Colors
must be specified in RGB format. Red, green, and blue can be combined in various
proportions to obtain any color in the visible spectrum. Levels of R, G, and B can each
range from 0 to 100 percent of full intensity. Each color level is represented by the
range of decimal numbers from 0 to 255. The total number of available colors is 256 x
256 x 256, or 16,777,216 possible colors.
Users can also set this preference for their environment using the
Edit→Options→Change Management menu command.
VALID
VALUES
Decimal numbers from 0 to 255.

PLM00026 11.2 Preferences and Environment Variables Reference 14-31


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

DEFAULT
VALUES
255,20,47
Red
DEFAULT
PROTECTION
SCOPE
User preference.

CM_color_of_common

DESCRIPTION
Specifies the default color to represent common components in the rich client interface.
Colors must be specified in RGB format. Red, green, and blue can be combined in
various proportions to obtain any color in the visible spectrum. Levels of R, G, and B
can each range from 0 to 100 percent of full intensity. Each color level is represented
by the range of decimal numbers from 0 to 255. The total number of available colors is
256 x 256 x 256, or 16,777,216 possible colors.
Users can also set this preference for their environment using the
Edit→Options→Change Management menu command.
VALID
VALUES
Decimal numbers from 0 to 255.
DEFAULT
VALUES
135,135,135
Grey
DEFAULT
PROTECTION
SCOPE
User preference.

CM_color_of_moved

DESCRIPTION
Specifies the default color to represent BOM moves in the rich client interface. Colors
must be specified in RGB format. Red, green, and blue can be combined in various
proportions to obtain any color in the visible spectrum. Levels of R, G, and B can each
range from 0 to 100 percent of full intensity. Each color level is represented by the
range of decimal numbers from 0 to 255. The total number of available colors is 256 x
256 x 256, or 16,777,216 possible colors.
Users can also set this preference for their environment using the
Edit→Options→Change Management menu command.
VALID
VALUES
Decimal numbers from 0 to 255.

14-32 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

DEFAULT
VALUES
122,183,122
Green
DEFAULT
PROTECTION
SCOPE
User preference.

CM_color_of_notechange

DESCRIPTION
Specifies the default color to represent BOM note changes in the rich client interface.
Colors must be specified in RGB format. Red, green, and blue can be combined in
various proportions to obtain any color in the visible spectrum. Levels of R, G, and B
can each range from 0 to 100 percent of full intensity. Each color level is represented
by the range of decimal numbers from 0 to 255. The total number of available colors is
256 x 256 x 256, or 16,777,216 possible colors.
Users can also set this preference for their environment using the
Edit→Options→Change Management menu command.
VALID
VALUES
Decimal numbers from 0 to 255.
DEFAULT
VALUES
128,0,128
Purple
DEFAULT
PROTECTION
SCOPE
User preference.

CM_color_of_quantity_change

DESCRIPTION
Specifies the default color to represent BOM quantity changes in the rich client
interface. Colors must be specified in RGB format. Red, green, and blue can be
combined in various proportions to obtain any color in the visible spectrum. Levels of
R, G, and B can each range from 0 to 100 percent of full intensity. Each color level
is represented by the range of decimal numbers from 0 to 255. The total number of
available colors is 256 x 256 x 256, or 16,777,216 possible colors.
Users can also set this preference for their environment using the
Edit→Options→Change Management menu command.
VALID
VALUES
Decimal numbers from 0 to 255.

PLM00026 11.2 Preferences and Environment Variables Reference 14-33


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

DEFAULT
VALUES
255,118,0
Orange
DEFAULT
PROTECTION
SCOPE
User preference.

CM_color_of_reshaped

DESCRIPTION
Specifies the default color to represent BOM reshapes in the rich client interface.
Colors must be specified in RGB format. Red, green, and blue can be combined in
various proportions to obtain any color in the visible spectrum. Levels of R, G, and B
can each range from 0 to 100 percent of full intensity. Each color level is represented
by the range of decimal numbers from 0 to 255. The total number of available colors is
256 x 256 x 256, or 16,777,216 possible colors.
Users can also set this preference for their environment using the
Edit→Options→Change Management menu command.
VALID
VALUES
Decimal numbers from 0 to 255.
DEFAULT
VALUES
153,204,204
Turquoise
DEFAULT
PROTECTION
SCOPE
User preference.

CM_color_of_variantchange

DESCRIPTION
Specifies the default color to represent BOM variant changes in the rich client interface.
Colors must be specified in RGB format. Red, green, and blue can be combined in
various proportions to obtain any color in the visible spectrum. Levels of R, G, and B
can each range from 0 to 100 percent of full intensity. Each color level is represented
by the range of decimal numbers from 0 to 255. The total number of available colors is
256 x 256 x 256, or 16,777,216 possible colors.
Users can also set this preference for their environment using the
Edit→Options→Change Management menu command.
VALID
VALUES
Decimal numbers from 0 to 255.

14-34 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

DEFAULT
VALUES
100,255,50
Sea green
DEFAULT
PROTECTION
SCOPE
User preference.

CM_initial_position_of_sliders

DESCRIPTION
Specifies the initial position of all control sliders in the Graphical History dialog box.
If set to 100, only the affected assembly is displayed. If set to 0, only the problem
assembly appears. Any number in between initially displays both the added and
cancelled parts.
VALID
VALUES
Decimal numbers from 0 to 100.
DEFAULT
VALUES
100
Initial slider position displays only the affected assembly.
DEFAULT
PROTECTION
SCOPE
User preference.

CM_progression_tree_relation

DESCRIPTION
Determines which of two possible relationships to use for the revisions in the
Progression tree.
VALID
VALUES
TC_based_on
Displays the problem/solution relationship where the selected revision is the solution
revision. The problem revision is shown as a parent revision. This relationship can only
be displayed in the Progression tree if the selected revision is part of a change process.
Use this setting if your site is not using change management for BOM tracking.
EC_affected_to_problem_relation
Displays the based on relationship where the revision upon which the selected revision
was based is shown as the parent revision. This relationship is not dependent on the
selected revision being part of a change process.
Use this setting if your site is using change management for BOM tracking.
DEFAULT
VALUES
EC_affected_to_problem_relation

PLM00026 11.2 Preferences and Environment Variables Reference 14-35


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

CM_show_common_parts

DESCRIPTION
Specifies whether or not common parts display during the initial loading of graphical
compare in the rich client interface.
Users can also set this preference for their environment using the
Edit→Options→Change Management menu command.
VALID
VALUES
TRUE Common parts are initially displayed when a graphical compare is loaded.
FALSE Common parts are not initially displayed when a graphical compare is
loaded.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
User preference.

EngChange Revision_DefaultChildProperties

DESCRIPTION
Requires the following relation names. The final setting (release_status_list) is
required to display the current status in My Teamcenter.
VALID
VALUES
IMAN_master_form_rev
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
affected_items
solution_items
problem_items
reference_items
addressed_by
release_status_list
DEFAULT
VALUES
IMAN_master_form_rev
IMAN_specification
IMAN_requirement
IMAN_manifestation

14-36 Preferences and Environment Variables Reference PLM00026 11.2


Change management preferences

IMAN_reference
affected_items
solution_items
problem_items
reference_items
addressed_by
release_status_list
DEFAULT
PROTECTION
SCOPE
Site preference.

Supercedure_DefaultChildProperties

DESCRIPTION
Requires the following relation names.
VALID
VALUES
Adds
Cancels
DEFAULT
VALUES
Adds
Cancels
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_bomchange_export

DESCRIPTION
Determines whether BOMChange objects are included in the export of engineering
change objects.
VALID
VALUES
TRUE BOMChange objects are included in the export of engineering change
objects.
FALSE BOMChange objects are not included in the export of engineering change
objects.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 14-37


Chapter
Chapter 14:14:Change
Change management
management preferences
preferences

TC_supercedure_export

DESCRIPTION
Determines whether supersedure objects are included in the export of engineering
change objects.
VALID
VALUES
TRUE Supersedure objects are included in the export of engineering change
objects.
FALSE Supersedure objects are not included in the export of engineering change
objects.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
All.

14-38 Preferences and Environment Variables Reference PLM00026 11.2


Chapter 15: Issue Manager preferences

ISSUE_issuelist_page_size . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-1
ISSUE_list_table_view_column_candidates . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-1
ISSUE_preview_image_name_separator . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-2
ISSUE_preview_image_size . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-2
ISSUE_preview_tooltip_properties_after_fix . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-3
ISSUE_preview_tooltip_properties_before_fix . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-3
ISSUE_review_issue_menu_items_at_workflow_task . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-3
IssueManagement_WF_template . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-5
IssueReport.CREATERENDERING . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-5
IssueReportCreate.CREATE_REGISTEREDTO . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-6
IssueReportRevision.REGISTEREDTO . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-6
IssueReportRevision.RENDERING . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-6
IssueReportRevision.SUMMARYRENDERING . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-7
IssueReportRevision.SUMMARY_REGISTEREDTO . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-7
IssueReport_DefaultChildProperties . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-7
IssueReport_PseudoFolder . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-8
PnM0Penetration.CREATERENDERING . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-9
PnM0PenetrationCreate.CREATE_REGISTEREDTO . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-9
PnM0PenetrationRevision.REGISTEREDTO . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 15-9
PnM0PenetrationRevision.RENDERING . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 15-10
PnM0PenetrationRevision.SUMMARYRENDERING . . . .. . . . . . . . . . . . . . . . . . . . . . . . 15-10
PnM0PenetrationRevision.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . 15-10
PnM0Penetration_DefaultChildProperties . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 15-11
PnM0Penetration_PseudoFolder . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 15-11
WEB_EnableIssue . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 15-12

PLM00026 11.2 Preferences and Environment Variables Reference


Chapter 15: Issue Manager preferences

ISSUE_issuelist_page_size

DESCRIPTION
Specifies the number of issues displayed per page in an issue list in the Image Home
view of Issue Manager.
VALID
VALUES
integer The larger the number, the more issues displayed per page.
DEFAULT
VALUES
15
DEFAULT
PROTECTION
SCOPE
Site preference.

ISSUE_list_table_view_column_candidates

DESCRIPTION
Defines the list of attributes that can be displayed as columns in the Issue List Details
view for an issue report revision and its children in the Issue Manager application in
the rich and thin clients.
For more information about the Issue List Details view, see Issue Manager.
VALID
VALUES
object A string representing attributes of an issue report.
string
DEFAULT
VALUES
design_review_gate
issue_category
due_date
CMClosure
CMSeverityRating
Requestor
ImageBeforeFix
ImageAfterFix
IsM0IssueSubset
IsM0SnapshotBeforeFix
IsM0SnapshotAfterFix
epm_proposed_responsible_party
epm_proposed_reviewers
object_type

PLM00026 11.2 Preferences and Environment Variables Reference 15-1


Chapter
Chapter 15:15:IssueIssue Manager
Manager preferences
preferences

checked_out_user
checked_out
last_mod_user
last_mod_date
creation_date
owning_user
owning_group
release_status_list
DEFAULT
PROTECTION
SCOPE
Site preference.

ISSUE_preview_image_name_separator

DESCRIPTION
Specifies the delimiter used in the title of an image preview in the Image Preview
view of Issue Manager. The delimiter appears between the issue report revision and
image name.
VALID
VALUES
string Accepts a string.
DEFAULT
VALUES
:
DEFAULT
PROTECTION
SCOPE
Site preference.

ISSUE_preview_image_size

DESCRIPTION
Defines the size in pixels for the image preview in the Image Preview view in Issue
Manager. The two values are, respectively, the horizontal and vertical sizes.
VALID
VALUES
integer Accepts two integers.
DEFAULT
VALUES
250
250
DEFAULT
PROTECTION
SCOPE
Site preference.

15-2 Preferences and Environment Variables Reference PLM00026 11.2


Issue Manager preferences

ISSUE_preview_tooltip_properties_after_fix

DESCRIPTION
Specifies the properties to be displayed in the tool tip for an image preview displayed
in the Issue Preview view of Issue Manager.
VALID
VALUES
string Accepts one or more strings as values; each string must be a property name
of the issue report revision object.
DEFAULT
VALUES
CMClosureComments
CMDispositionComments
DEFAULT
PROTECTION
SCOPE
Site preference.

ISSUE_preview_tooltip_properties_before_fix

DESCRIPTION
Specifies the properties to be displayed in the tool tip for an image preview displayed
in the Issue Preview view of Issue Manager.
VALID
VALUES
Array of strings Accepts one or more strings as values; each string must be a
property name of the issue report revision object.
DEFAULT
VALUES
object_desc (short description of issue)
design_review_gate
issue_category
due_date

DEFAULT
PROTECTION
SCOPE
Site preference.

ISSUE_review_issue_menu_items_at_workflow_task

DESCRIPTION
Defines the decisions that can be selected for a specified review task of an issue
management or penetration request workflow process. The valid format is a task
name followed by a list of decision options separated by a semicolon. You must first
define the review decisions in the issue review decision list of values (LOV) in the
Business Modeler IDE.

For more information, see Issue Manager.

PLM00026 11.2 Preferences and Environment Variables Reference 15-3


Chapter
Chapter 15:15:IssueIssue Manager
Manager preferences
preferences

Example

If you want to specify Submit Fix as the single decision available for the Assign
Issue and Fix Issue workflow task, specify the following:
Assign Issue and Fix Issue;SubmitFix;

The Review Issue dialog box appears.

VALID
VALUES
Array of strings Accepts one or more strings as values, in the format of a task
name followed by a list of decision options separated by a
semicolon.
DEFAULT
VALUES
Review Issue;Defer;Reject;ApproveIssue;
Assign Issue and Fix Issue;SubmitFix;
Final Review;ApproveFix;

DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
Each line starts with workflow task name, followed by the menu commands for the
Review Issue operation for the specified workflow task. The workflow task name must
match the specified template. The default values match the Issue lifecycle workflow
process template provided with Issue Manager.
For more information, see Issue Manager.

15-4 Preferences and Environment Variables Reference PLM00026 11.2


Issue Manager preferences

IssueManagement_WF_template

DESCRIPTION
Specifies the workflow templates that can be used with issue reports or other subclass
objects, such as penetration requests. The format is:
class_name/x/template_name

where:
• class_name is the workspace object name.

• integer is the order in which to use the workflows are applied starting with zero (0).

• template_name is the name of the workflow template.

For example:
IssueReport/0/issue_lifecycle

VALID
VALUES
Array of strings Accepts one or more strings as values, in the format of a object
name followed by an integer and the name of the workflow
process, all separated by a forward slash (/).
DEFAULT
VALUES
IssueReport/0/issue_lifecycle
PnM0Penetration/2/delete_penetration_wf
PnM0Penetration/1/escalated_penetration_wf
PnM0Penetration/0/penetration_wf
DEFAULT
PROTECTION
SCOPE
Site preference.

IssueReport.CREATERENDERING

DESCRIPTION
Registers the create style sheet for issue report objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
IssueReportCreate

DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 15-5


Chapter
Chapter 15:15:IssueIssue Manager
Manager preferences
preferences

IssueReportCreate.CREATE_REGISTEREDTO

DESCRIPTION
Specifies the types to which the IssueReportCreate style sheet can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
IssueReport

DEFAULT
PROTECTION
SCOPE
Site preference.

IssueReportRevision.REGISTEREDTO

DESCRIPTION
Specifies the types to which the IssueReportRevision style sheet can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
IssueReportRevision

DEFAULT
PROTECTION
SCOPE
Site preference.

IssueReportRevision.RENDERING

DESCRIPTION
Registers the properties style sheet for issue report revision objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
IssueReportrevisionProperty

DEFAULT
PROTECTION
SCOPE
Site preference.

15-6 Preferences and Environment Variables Reference PLM00026 11.2


Issue Manager preferences

IssueReportRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for issue report revision objects. The summary
style sheet is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
IssueReportRevisionSummary

DEFAULT
PROTECTION
SCOPE
Site preference.

IssueReportRevision.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the IssueReportRevisionSummary style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
IssueReportRevision

DEFAULT
PROTECTION
SCOPE
Site preference.

IssueReport_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of an
IssueReportRevision node.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of the
IssueReportRevision object.
DEFAULT
VALUES
IMAN_master_form_rev
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference

PLM00026 11.2 Preferences and Environment Variables Reference 15-7


Chapter
Chapter 15:15:IssueIssue Manager
Manager preferences
preferences

release_status_list
TC_Attaches
CMHasImpactedItem
CMImplementedBy
CMHasProblemItems
CMReferences
ImageBeforeFix
ImageAfterFix
IsM0IssueSubset
IsM0SnapshotBeforeFix
IsM0SnapshotAfterFix

DEFAULT
PROTECTION
SCOPE
Site preference.

IssueReport_PseudoFolder

DESCRIPTION
Specifies the list of properties that can be displayed as folders under a node of
IssueReportRevision objects.
VALID
VALUES
Array of strings Accepts one or more strings as values, in the format of a object
name followed by an integer and the name of the workflow
process, all separated by a forward slash (/).
DEFAULT
VALUES
ImageBeforeFix
ImageAfterFix
IsM0IssueSubset
IsM0SnapshotBeforeFix
IsM0SnapshotAfterFix
CMHasProblemItem
CAEAnalysis
ElectricalDesign
ElectricalHarness
MEProcess
MESetup
view

DEFAULT
PROTECTION
SCOPE
Site preference.

15-8 Preferences and Environment Variables Reference PLM00026 11.2


Issue Manager preferences

PnM0Penetration.CREATERENDERING

DESCRIPTION
Registers the create style sheet for penetration request objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
PnM0PenetrationCreate

DEFAULT
PROTECTION
SCOPE
Site preference.

PnM0PenetrationCreate.CREATE_REGISTEREDTO

DESCRIPTION
Specifies the types to which the penetration request style sheet can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
PnM0Penetration

DEFAULT
PROTECTION
SCOPE
Site preference.

PnM0PenetrationRevision.REGISTEREDTO

DESCRIPTION
Specifies the types to which the properties style sheet for penetration requests can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
PnM0PenetrationRevision

DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 15-9


Chapter
Chapter 15:15:IssueIssue Manager
Manager preferences
preferences

PnM0PenetrationRevision.RENDERING

DESCRIPTION
Registers the properties style sheet for penetration request revision objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
PnM0PenetrationRequestRevisionProperty

DEFAULT
PROTECTION
SCOPE
Site preference.

PnM0PenetrationRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for penetration request revision objects. The
summary style sheet is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
PnM0PenetrationRevisionSummary

DEFAULT
PROTECTION
SCOPE
Site preference.

PnM0PenetrationRevision.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the summary style sheet for penetration request objects
can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
PnM0PenetrationRevision

DEFAULT
PROTECTION
SCOPE
Site preference.

15-10 Preferences and Environment Variables Reference PLM00026 11.2


Issue Manager preferences

PnM0Penetration_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of a penetration
request node.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of the
penetration request object.
DEFAULT
VALUES
ImageBeforeFix
ImageAfterFix
IsM0IssueSubset
PnM0PenetratedParts
PnM0PenetratingParts
PnM0CompensationPart
PnM0HangerPart
PnM0HoleCutObject
CMReferences

DEFAULT
PROTECTION
SCOPE
Site preference.

PnM0Penetration_PseudoFolder

DESCRIPTION
Specifies the list of properties that can be displayed as folders under a node of
penetration request objects.
VALID
VALUES
DEFAULT
VALUES
ImageBeforeFix
ImageAfterFix
IsM0IssueSubset
PnM0PenetratedParts
PnM0PenetratingParts
PnM0CompensationPart
PnM0HangerPart
PnM0HoleCutObject
CMReferences

PLM00026 11.2 Preferences and Environment Variables Reference 15-11


Chapter
Chapter 15:15:IssueIssue Manager
Manager preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

WEB_EnableIssue

DESCRIPTION
Controls the ability to create and review issues using the Issue Manager application in
the thin client by setting the display of the New→Issue Report and Tools-→Review
Issue commands. Valid values are true and false (default value).
For more information about using Issue Manager in the thin client, see Thin Client
Interface.
VALID
VALUES
true Displays the New→Issue Report and Tools-→Review Issue commands
in the thin client.
false Suppresses the display of the New→Issue Report and Tools-→Review
Issue commands in the thin client.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

15-12 Preferences and Environment Variables Reference PLM00026 11.2


Chapter 16: Content Management preferences

ContentManagerColumnsShownPref . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-1
ContentManagerDisplayNameWithTypeColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . 16-1
ContentManagerShownColumnWidthsPref . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-2
ctm0DisableS1000DItemIdCheck . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-2
ctm0GraphicClassPref . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-3
ctm0GraphicExtPref . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-3
ctm0GraphicPref.dita.name . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-4
ctm0GraphicPref.dita.text . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-4
ctm0GraphicPref.docBook.name . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-4
ctm0GraphicPref.docBook.text . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-5
ctm0GraphicPref.s1000d.name . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-5
ctm0GraphicPref.s1000d.text . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-5
ctm0GraphicPref.values . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-6
ctm0GraphicUsagePref . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-6
ctm0_processing_data . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-7
ctm0RestoreStateOfPubStructure . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-7
ctm0TopicTypeGroup . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-7
ctm0_translation_graphicpriority . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-8
DCt_Language_fnd0isoLanguageCountryCode_expression .. . . . . . . . . . . . . . . . . . . . . . . 16-8
deploy_absolute_path . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . 16-9
deploy_link_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 16-10
publish_to_file_system . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 16-10
publish_to_file_system_loc . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . 16-10

PLM00026 11.2 Preferences and Environment Variables Reference


Chapter 16: Content Management preferences

ContentManagerColumnsShownPref

DESCRIPTION
Specifies the list of columns that display in the Publication Structure view.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
bl_indented_title
ctm0DocumentTitle
ctm0TopicType
bl_variant_condition
bl_occ_type
bl_rev_release_status_list
bl_item_object_desc
bl_quantity
bl_item_object_type
DEFAULT
PROTECTION
SCOPE
User preference.

ContentManagerDisplayNameWithTypeColumnsShownPref

DESCRIPTION
Stores the internal names of properties that appear as columns in the Publication
Structure view.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
BOMLine.bl_indented_title
Ctm0BOMLine.ctm0DocumentTitle
Ctm0BOMLine.ctm0TopicType
Ctm0BOMLine.bl_variant_condition
Ctm0BOMLine.bl_occ_type
Ctm0BOMLine.bl_rev_release_status_list
Ctm0BOMLine.bl_item_object_desc
Ctm0BOMLine.bl_quantity
Ctm0BOMLine.bl_item_object_type

PLM00026 11.2 Preferences and Environment Variables Reference 16-1


Chapter
Chapter 16:16:Content
Content Management
Management preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

ContentManagerShownColumnWidthsPref

DESCRIPTION
Specifies the column width for the list of columns defined in the
ContentManagerColumnsShownPref preference.
VALID
VALUES
Accepts one or more integers as values.
DEFAULT
VALUES
20
20
10
10
10
20
10
10
15
DEFAULT
PROTECTION
SCOPE
User preference.

ctm0DisableS1000DItemIdCheck

DESCRIPTION
Disables the schema validation check on attributes that comprise the unique identifier
for S1000D objects at the time the objects are created.
VALID
VALUES
true The validation check is disabled.

false The validation check is enabled.


DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
You can also set this preference by choosing Edit→Options→Content Management.
You use the Disable S1000D unique ID schema validation option on the General tab.

16-2 Preferences and Environment Variables Reference PLM00026 11.2


Content Management preferences

ctm0GraphicClassPref

DESCRIPTION
Displays installed graphic classes for selection during import.
VALID
VALUES
Accepts one or more strings as values.
For example, valid values are:
Graphic
S1000D Graphic
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.
NOTES
You can also set this preference by choosing Edit→Options→Content Management.
You edit the values of the Graphic classes list on the Graphic tab.

ctm0GraphicExtPref

DESCRIPTION
Filters the files that are listed for selection when graphics are imported.
VALID
VALUES
Accepts one or more strings as values for valid graphic file extensions.
For example, valid values are:
bmp
eps
gif
jpg
jpeg
png
svg
tiff
wmf
cgm
swf
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 16-3


Chapter
Chapter 16:16:Content
Content Management
Management preferences
preferences

NOTES
You can also set this preference by choosing Edit→Options→Content Management.
You edit the values of the Graphic extensions list on the Graphic tab.

ctm0GraphicPref.dita.name

DESCRIPTION
Specifies the text to display in the Graphic Link Clipboard preference list to represent
the option to use when working with the DITA standard for publications.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUE
DITA
DEFAULT
PROTECTION
SCOPE
Site preference.

ctm0GraphicPref.dita.text

DESCRIPTION
Specifies the default XML tagging to use in the editing tool when a graphic is copied
from Content Management and pasted to content in the editing tool when working
with the DITA standard for publications.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUE
<image href="%f"/>
DEFAULT
PROTECTION
SCOPE
Site preference.

ctm0GraphicPref.docBook.name

DESCRIPTION
Specifies the text to display in the Graphic Link Clipboard preference list to represent
the option to use when working with the DocBook standard or a similar XML standard
for publications.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUE
DocBook

16-4 Preferences and Environment Variables Reference PLM00026 11.2


Content Management preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ctm0GraphicPref.docBook.text

DESCRIPTION
Specifies the default XML tagging to use in the editing tool when a graphic is copied
from Content Management and pasted to content in the editing tool when working with
the DocBook standard or a similar XML standard for publications.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUE
<graphic> <graphic-data name="%f"/> </graphic>
DEFAULT
PROTECTION
SCOPE
Site preference.

ctm0GraphicPref.s1000d.name

DESCRIPTION
Specifies the text to display in the Graphic Link Clipboard preference list to represent
the option to use when working with the S1000D 4.0 or 4.1 standard for publications.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUE
S1000D 4.0/4.1
DEFAULT
PROTECTION
SCOPE
Site preference.

ctm0GraphicPref.s1000d.text

DESCRIPTION
Specifies the default XML tagging to use in the editing tool when a graphic is copied
from Content Management and pasted to content in the editing tool when working with
the S1000D 4.0 or 4.1 standard for publications.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUE
<graphic infoEntityIdent="%f"/>

PLM00026 11.2 Preferences and Environment Variables Reference 16-5


Chapter
Chapter 16:16:Content
Content Management
Management preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ctm0GraphicPref.values

DESCRIPTION
Defines the values listed in the Graphic Link Clipboard preference list. The values
are the publication_standard part of the ctm0GraphicPref.publication_standard.name
preferences that are used to define the default XML tagging used when adding
graphics to content when working with specific technical publication standards.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
docBook
dita
s1000d
DEFAULT
PROTECTION
SCOPE
Site preference.

ctm0GraphicUsagePref

DESCRIPTION
Maps graphic option usages to graphic file extensions, to provide a default selection
when graphics are imported to Content Management. System-defined graphic usages
include: ICON, PDF, PRINT, SOURCE, THUMBNAIL, VIEW, and WEB.
VALID
VALUES
Accepts one or more strings as values, using the following syntax:
graphic-usage=*extension;*extension

For example, a valid value is:


ICON=*.png;*.jpg
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.
NOTES
You can also set this preference by choosing Edit→Options→Content Management.
You edit the values of the Graphic usages list on the Graphic tab.

16-6 Preferences and Environment Variables Reference PLM00026 11.2


Content Management preferences

ctm0_processing_data

DESCRIPTION
Maps processing data properties to content during the XML attribute exchange in
the compose process.
VALID
VALUES
Accepts one or more strings as values, using the following syntax:
propertyName=propertyValue
DEFAULT
VALUES
graphicPath={root-dir}graphics\
graphicPathTarget=NONE
DEFAULT
PROTECTION
SCOPE
All.
NOTES
You can also set this preference by choosing Edit→Options→Content Management.
You edit the values of the Processing data list on the General tab.

ctm0RestoreStateOfPubStructure

DESCRIPTION
Controls the save state of the Publication Structure view.
VALID
VALUES
true The state of the Publication Structure view persists between sessions.

false The state of the Publication Structure view does not persist between
sessions.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
You can also set this preference by choosing Edit→Options→Content Management.
You use the Save state of the Publication Structure option on the General tab.

ctm0TopicTypeGroup

DESCRIPTION
Limits the topic type groups that can be used for creating new topics. If one or more
values are entered, only topic types in the listed groups are available for selection
when new topics are created.

PLM00026 11.2 Preferences and Environment Variables Reference 16-7


Chapter
Chapter 16:16:Content
Content Management
Management preferences
preferences

VALID
VALUES
A valid topic type group.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.
NOTES
You can also set this preference by choosing Edit→Options→Content Management.
You select the topic type group from Topic type group list on the General tab.

ctm0_translation_graphicpriority

DESCRIPTION
Specifies the graphic priority preference assigned to translation orders when they are
created in Content Management.
VALID
VALUES
Accepts a string as a value that must be a valid graphic priority list value.
For example, a valid value is:
EDIT
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.
NOTES
You can also set this preference by choosing Edit→Options→Content Management.
You select the graphic priority from the Translation graphic priority list on the
Graphic tab.

DCt_Language_fnd0isoLanguageCountryCode_expression

DESCRIPTION
Defines the expression value of the run-time property fnd0isoLanguageCountryCode
for the DCt_Language business object. It combines the values of the ISO language
and country code on the language object.
For example, if the language code is en and the country code is US, the value in this
run-time property on DCt_Language for the default value is en-US. However, this
preference can be modified for the value to appear in another way, such as enUS,
en_US, or en.US.

16-8 Preferences and Environment Variables Reference PLM00026 11.2


Content Management preferences

VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
$isoLanguageCode+"-"+$isoCountryCode
DEFAULT
PROTECTION
SCOPE
Site preference.

deploy_absolute_path

DESCRIPTION
Specifies the file path to the folder specified in the publish_to_file_system_loc
preference for published content. This path is platform-specific.
VALID
VALUES
Accepts a single string as value. If publishing for a Web server distribution, this must
be the valid path to the distribution Web application autodeploy publish directory. This
must be a path available to the dispatcher publish module host. It can be a UNC
path or a local directory path.
The UNC path can also be used to specify a shared directory on a different computer
for this preference.
Note

You can use a forward slash (/) or backward slash (\) when specifying path
names for both Windows and UNIX.

Examples:
deploy_absolute_path=//hostname/shared-directory/CMPublishTest
deploy_absolute_path=\\hostname\shared-directory\CMPublishTest

For a local directory example, a valid value is:


C:\bea\user_projects\domains\YourWebApp_domain\autodeploy\publish
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
You can also set this preference by choosing Edit→Options→Content Management.
You type the value in the Deploy absolute path box on the Publish tab.

PLM00026 11.2 Preferences and Environment Variables Reference 16-9


Chapter
Chapter 16:16:Content
Content Management
Management preferences
preferences

deploy_link_prefix

DESCRIPTION
Specifies the URL to connect to the folder storing published content.
VALID
VALUES
Accepts a single string as a value. If set, it should be the valid URL to the folder storing
published content. The result is written in the publish log to allow administrators to
verify the Web access for a distribution Web server.

For example, a valid value is:


http://localhost:7070/publish/
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
You can also set this preference by choosing Edit→Options→Content Management.
You type the value in the Deploy link prefix box on the Publish tab.

publish_to_file_system

DESCRIPTION
Enables publishing to a file system.
VALID
VALUES
true The Publish to File System option appears in the Publish dialog box.

false The option to publish to a file system is unavailable.


DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
You can also set this preference by choosing Edit→Options→Content Management.
You use the Publish to file system option on the Publish tab.

publish_to_file_system_loc

DESCRIPTION
Specifies the name of the parent folder to store published content.

16-10 Preferences and Environment Variables Reference PLM00026 11.2


Content Management preferences

VALID
VALUES
Accepts a single string as a value. This directory is relative to the path defined in the
deploy_absolute_path preference, unless it begins with a forward slash (/) on UNIX
or Linux or drive:\ on Windows. In those cases, it becomes an absolute path.
For example, a valid value is:
dataDirectory
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
You can also set this preference by choosing Edit→Options→Content Management.
You type the value in the Publish to file system location box on the Publish tab.

PLM00026 11.2 Preferences and Environment Variables Reference 16-11


Chapter 17: Reports, requirements, and scheduling preferences

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


ComplyingTraceReportTable_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1
ComplyingTraceReportTable_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . 17-2
CrossProbing_AllowedRelationTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-2
CrossProbing_RelationDepthTraversal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-3
CrossProbing_RelationTraversalType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-3
CrossProbing_Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-4
CrossProbing_SelectedRelationTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-4
DefiningTraceReportTable_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-5
DefiningTraceReportTable_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . 17-6
DuplicateAssignToProject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-6
DuplicateRunInBackground . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-7
FMDiagram_TransferMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-7
Fnd0LogicalBlockRevisionColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-7
FND_Tracelink_Report_Depth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-8
FunctionalityRevisionColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-8
IconShownColumnProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-9
Import_Spec_Info_EXCLUDETYPES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-9
Indirect_Tracelink_Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-9
MultilineColumnProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-10
NE_default_application_domain_template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-11
NE_diagram_domain_perspective_map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-11
NE_relation_rule_grm_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-12
Paragraph RevisionColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-12
REQ_checkout_objects_before_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-13
REQ_ExportToExcel_add_level_column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-13
Requirement RevisionColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-13
RequirementSpec RevisionColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-14
SE_Trace_Report_Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-15
TcAllowedImportExportPeakSpecObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-15
TcNotesAllowedType_DesignReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-16
TcNotesAllowedType_Fnd0LogicalBlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-16
TcNotesAllowedType_Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-17
TcNotesAllowedType_Paragraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-17
TcNotesAllowedType_Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-17
TcNotesAllowedType_RequirementSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-18
TcNotesAllowedType_ValidationReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-18
TC_setProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-18
Tracelink_Edit_enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-19
TraceReport_Default_Expansion_Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-19
TraceReport_Default_Sort_Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-20
TraceReport_Default_TraceLink_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-20
TraceReport_Filter_Available_Object_Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-20

PLM00026 11.2 Preferences and Environment Variables Reference


TraceReport_Filter_Available_Tracelink_Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-21
TraceReport_Filter_Selected_Object_Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-21
TraceReport_Filter_Selected_TraceLink_Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-22
TraceReportTable_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-22
TraceReportTable_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-22

Schedule Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-23


CombinedAvailableAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-23
cost_default_currency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-24
DefaultActualToSystemDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-24
Default_Base_Calendar_Preference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-25
Fnd0QueryFolder_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-25
ProgramViewFilterProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-25
ProgramViewGroupProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-27
Schedule_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-28
ScheduleAvailableAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-28
ScheduleColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-29
ScheduleDeliverableWSOTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-30
ScheduleTask.CHGDETAILRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-31
ScheduleTaskClassNameToCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-31
ScheduleTask_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-32
ScheduleTaskAvailableAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-32
ScheduleTaskAvailableAttributesWithRelations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-34
scheduling_graph_dataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-37
scheduling_graph_dataSource_filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-37
scheduling_graph_date_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-37
scheduling_graph_domain_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-38
scheduling_graph_domain_label_vertical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-38
scheduling_graph_font_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-39
scheduling_graph_font_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-39
scheduling_graph_font_style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-39
scheduling_graph_histogram_single_color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-40
scheduling_graph_reference_calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-40
scheduling_graph_task_legend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-41
scheduling_graph_view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-41
SiteTimeZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-42
SM_ALLOW_INPROCESS_REMOVAL_OF_SUB_SCHEDULE . . . . . . . . . . . . . . . . . . 17-42
SM_ALLOW_USER_ABORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-43
SM_Copy_Schedule_Async . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-43
SM_CriticalPath_Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-44
SM_DEFAULT_WORKFLOW_TEMPLATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-44
SM_DEFERRED_NOTIFICATION_TIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-44
SM_DEFERRED_SHOW_TIMEOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-45
SM_DEFERRED_TIMEOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-45
SM_Delete_Schedule_Async . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-46
SM_Delete_Validation_Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-46
SM_DISPLAY_GANTT_SI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-46
SM_EnforceActualDatesBeforeNow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-47
SM_ENFORCE_ASSIGNMENT_CRITERIA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-47
SM_EVM_Calc_Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-47

Preferences and Environment Variables Reference PLM00026 11.2


SM_EVM_Calc_Preference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-48
SM_EVM_Export_Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-48
SM_EVM_Work_Complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-48
SM_EXEC_VIEW_PROPERTIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-49
SM_GANTT_MONTH_ZM_B_DF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-49
SM_GANTT_MONTH_ZM_T_DF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-50
SM_GANTT_QTR_STRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-50
SM_GANTT_QTR_ZM_B_DF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-51
SM_GANTT_QTR_ZM_T_DF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-51
SM_GANTT_WEEK_ZM_T_DF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-52
SM_GANTT_YEAR_ZM_T_DF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-52
SM_LIMIT_SINGLE_MASTER_SCHEDULE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-53
SM_NEW_TASK_DIALOG_CLOSE_ON_FINISH . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-53
SM_PLMXML_EXPORT_SUB_SCHEDULE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-53
SM_PLMXML_IMPORT_EXISTING_SCHEDULE . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-54
SM_PREVENT_DELETE_STATES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-54
SM_PREVENT_TASK_START_UPDATE_STATES . . . . . . . . . . . . . . . . . . . . . . . . . . 17-55
SM_PREVENT_UPDATE_STATES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-55
SM_PREVENTION_OVERRIDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-56
SM_PV_FILTER_SHOW_SCHEDULES_ON_EMPTY . . . . . . . . . . . . . . . . . . . . . . . . 17-56
SM_Run_Data_Inconsistency_Checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-57
SM_SCHEDULE_DATE_LINKED_TO_ACTUAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-57
SM_SCHEDULING_ENGINE_DATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-58
SM_Structure_Partial_Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-58
SM_TEMPLATE_DATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-59
SM_TIMESHEET_APPROVE_WORKFLOW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-59
SM_TIMESHEET_REVISE_WORKFLOW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-60
SM_Use_Milestone_Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-60
SM_View_CriticalPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-60
SM_WBS_CODE_PREF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-61
SM_WBS_FORMAT_PREF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-61
SM_WBS_INITIAL_PREF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-62
SM_WORKFLOW_STATUS_MAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-62
TaskInbox_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-63
TC_deliverable_class_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-63

Report Builder preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-64


Valid_ReportBuilder_Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-64
Enable_ReportBuilder_Reports_By_Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-65
Default_Crf_OfficeTemplate_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-65
ReportDefinition_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-65
ReportDefinition_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-66
ReportGenerationDlg_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-67
ReportGenerationDlg_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-68
TC_RA_server_parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-68

Visual reporting preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-69


TC_NX_visual_report_additional_item_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-69
TC_NX_visual_report_additonal_secondary_object_types . . . . . . . . . . . . . . . . . . . . . 17-69

PLM00026 11.2 Preferences and Environment Variables Reference


Chapter 17: Reports, requirements, and scheduling preferences

Systems Engineering preferences

ComplyingTraceReportTable_ColumnPreferences

DESCRIPTION
Lists the names of properties that are displayed as columns for complying objects in
traceability reports. Property names are added and deleted as the user inserts and
removes columns in a traceability report.
For more information about working with property columns, see Understanding
property column configuration.
Note

This preference cannot be modified from the Edit→Options dialog box.

VALID
VALUES
Accepts one or more Teamcenter property names as values.
Note

In columns for custom properties, the traceability report displays headings


according to the Real Property Name format.

DEFAULT
VALUES
object_string
object_type
Defining Context
Complying Context
relation_type
owning_user
owning_group
last_mod_date
checked_out
release_status_list

DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 17-1


Chapter
Chapter 17:17:Reports,
Reports, requirements,
requirements, and scheduling
and scheduling preferences
preferences

ComplyingTraceReportTable_ColumnWidthPreferences

DESCRIPTION
Specifies the width of the columns for the properties listed in the
ComplyingTraceReportTable_ColumnPreferences preference. The width values
are modified as the user resizes the columns in a traceability report.
For more information about working with property columns, see Understanding
property column configuration.
Note

This preference cannot be modified from the Edit→Options dialog box.

VALID
VALUES
Accepts one or more integers as values. Each integer defines the column width
in characters.
DEFAULT
VALUES
30
17
12
12
13
9
17
6
26
26
DEFAULT
PROTECTION
SCOPE
User preference.

CrossProbing_AllowedRelationTypes

DESCRIPTION
Lists all relation types and subtypes that users can select as targets for cross-domain
tracing. This master list is displayed in the Available Relations pane of the Options
dialog box.
From the Available Relations pane, the user adds selections to the Shown Relations
pane, which lists the specific relations that are designated for the current cross-domain
tracing operation. The selections in the Shown Relations pane are stored in the
CrossProbing_SelectedRelationTypes preference.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid trace link relation
type or subtype that can be used as a search keyword.

17-2 Preferences and Environment Variables Reference PLM00026 11.2


Reports, requirements, and scheduling preferences

DEFAULT
VALUES
FND_Tracelink
DEFAULT
PROTECTION
SCOPE
Site preference.

CrossProbing_RelationDepthTraversal

DESCRIPTION
Specifies the number of target structures to which the current cross-domain tracing
operation extends. The user can enter this number in the text box of the Relation
Traversal Depth option in the Options dialog box.
VALID
VALUES
Accepts integer values beginning with 0. There is no maximum value.
For example:
1 The trace extends one level in the specified direction, highlighting the
immediate predecessors or successors.
3 The trace extends three levels in the specified direction, highlighting the
immediate predecessors or successors and two of their upstream or
downstream relations.
Note

• With 0, the trace does not highlight any objects, although no error message
is displayed.

• The user sets the direction with the Relations Traversal Type option
in the Options dialog box. The direction value is stored in the
CrossProbing_RelationTraversalType preference.

DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
User preference.

CrossProbing_RelationTraversalType

DESCRIPTION
Defines the direction of the current cross-domain tracing operation. The user sets the
direction with the Relations Traversal Type option in the Options dialog box.
VALID
VALUES
0 Specifies that the source is the primary (defining) object in a relation. The
trace highlights related objects downstream.

PLM00026 11.2 Preferences and Environment Variables Reference 17-3


Chapter
Chapter 17:17:Reports,
Reports, requirements,
requirements, and scheduling
and scheduling preferences
preferences

1 Specifies that the source is secondary (complying) object in a relation. The


trace highlights related objects upstream.
2 Specifies that the source is both a primary (defining) and a secondary
(complying) object in a relation. The trace highlights related objects
downstream and upstream.
DEFAULT
VALUES
2
DEFAULT
PROTECTION
SCOPE
User preference.

CrossProbing_Mode

DESCRIPTION
Specifies the current state of the cross-domain tracing feature.
VALID
VALUES
true Cross-domain tracing is activated.
The value is set to true when the user initiates a trace by clicking the Cross
Probing Mode button on the toolbar.
false Cross-domain tracing is deactivated.
The value is reset to false when the user ends the current trace by clicking
the Cross Probing Mode button on the toolbar.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

CrossProbing_SelectedRelationTypes

DESCRIPTION
Lists the specific relation types and subtypes that are designated as targets for the
current cross-domain tracing operation. These relations are displayed in the Shown
Relations pane of the Options dialog box.
Users select the target relations from the Available Relations pane, which lists all
relation types and subtypes that can be selected for cross-domain tracing. This master
list is controlled by the CrossProbing_AllowedRelationTypes preference.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid trace link relation
type or subtype that can be used as a search keyword.

17-4 Preferences and Environment Variables Reference PLM00026 11.2


Reports, requirements, and scheduling preferences

DEFAULT
VALUES
FND_Tracelink
DEFAULT
PROTECTION
SCOPE
User preference.

DefiningTraceReportTable_ColumnPreferences

DESCRIPTION
Lists the names of properties that are displayed as columns for defining objects in
traceability reports. Property names are added and deleted as the user inserts and
removes columns in a traceability report.
For more information about working with property columns, see Understanding
property column configuration.
Note

This preference cannot be modified from the Edit→Options dialog box.

VALID
VALUES
Accepts one or more Teamcenter property names as values.
Note

In columns for custom properties, the traceability report displays headings


according to the Real Property Name format.

DEFAULT
VALUES
object_string
object_type
Complying Context
Defining Context
relation_type
owning_user
owning_group
last_mod_date
checked_out
release_status_list

DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 17-5


Chapter
Chapter 17:17:Reports,
Reports, requirements,
requirements, and scheduling
and scheduling preferences
preferences

DefiningTraceReportTable_ColumnWidthPreferences

DESCRIPTION
Specifies the width of the columns for the properties listed in the
DefiningTraceReportTable_ColumnPreferences preference. The width values are
modified as the user resizes the columns in a traceability report.
For more information about working with property columns, see Understanding
property column configuration.

Note

This preference cannot be modified from the Edit→Options dialog box.

VALID
VALUES
Accepts one or more integers as values. Each integer defines the column width
in characters.
DEFAULT
VALUES
30
17
12
12
13
9
17
6
26
26

DEFAULT
PROTECTION
SCOPE
User preference.

DuplicateAssignToProject

DESCRIPTION
Controls the status of the Assign Projects to New Items check box in the Duplicate...
dialog box for duplicating Systems Engineering requirement structures. If the
preference is set to true, the Assign Projects to New Items check box is selected
and the section under the Projects header is expanded in the Duplicate... dialog box.
VALID
VALUES
true
false

DEFAULT
VALUES
false

17-6 Preferences and Environment Variables Reference PLM00026 11.2


Reports, requirements, and scheduling preferences

DEFAULT
PROTECTION
SCOPE
User preference.

DuplicateRunInBackground

DESCRIPTION
Defines if the duplicating process for Systems Engineering requirement structures
runs in the background (asynchronous). If the preference is set to true, the Run in
Background check box is selected in the Duplicate... dialog box.
VALID
VALUES
true
false

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

FMDiagram_TransferMode

DESCRIPTION
Specifies the transfer mode used to retrieve generic design element (GDE) lines for
BOM lines.
VALID
VALUES
Accepts a single string as a value. It must be a valid PLM XML transfer mode used to
retrieve GDE lines for BOM lines.
DEFAULT
VALUES
FMDiagramGDEExport
DEFAULT
PROTECTION
SCOPE
Site preference.

Fnd0LogicalBlockRevisionColumnsShownPref

DESCRIPTION
Sets the default columns in a view where the top-level object is a logical block.
The user’s column settings override this preference.
VALID
VALUES
Accepts internal names of the object properties to be displayed in the columns.

PLM00026 11.2 Preferences and Environment Variables Reference 17-7


Chapter
Chapter 17:17:Reports,
Reports, requirements,
requirements, and scheduling
and scheduling preferences
preferences

DEFAULT
VALUES
bl_item_item_id
bl_rev_object_name
bl_has_trace_link
bl_has_attached_notes
fnd0bl_hierarchical_number
bl_fulltext_body_cleartext
bl_item_object_type
bl_rev_owning_user
bl_rev_release_statuses

DEFAULT
PROTECTION
SCOPE
User preference.

FND_Tracelink_Report_Depth

DESCRIPTION
Specifies the level depth of the traceability information displayed in the Traceability
Report and the Trace Links view for both defining and complying views. If you are
displaying the trace link objects in addition to the requirement objects, the level is
multiplied by two.
VALID
VALUES
Integer values.
DEFAULT
VALUES
Default value is set to -1 to display all levels.
DEFAULT
PROTECTION
SCOPE
Site preference.

FunctionalityRevisionColumnsShownPref

DESCRIPTION
Sets the default columns in a view where the top-level object is a function.
The user’s column settings override this preference.
VALID
VALUES
Accepts internal names of the object properties to be displayed in the columns.
DEFAULT
VALUES
bl_item_item_id
bl_rev_object_name
bl_has_trace_link
bl_has_attached_notes
Fnd0FunctionalBOMLine.fnd0bl_hierarchical_number

17-8 Preferences and Environment Variables Reference PLM00026 11.2


Reports, requirements, and scheduling preferences

bl_fulltext_body_cleartext
bl_item_object_type
bl_rev_owning_user
bl_rev_release_statuses

DEFAULT
PROTECTION
SCOPE
User preference.

IconShownColumnProperties

DESCRIPTION
Specifies the columns where an icon is displayed on BOM structure instead of a string
value.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid BOM line property.
DEFAULT
VALUES
fnd0bl_has_trace_link
bl_rev_Fnd0ListsCustomNotes
DEFAULT
PROTECTION
SCOPE
Site preference.

Import_Spec_Info_EXCLUDETYPES

DESCRIPTION
Specifies which specification subclasses are restricted from the Spec type list of
the Import Spec wizard.
VALID
VALUES
Accepts one or more strings as values. Each string must be the internal name of a
valid subclass of the Specification business object.
DEFAULT
VALUES
Specification
DEFAULT
PROTECTION
SCOPE
Site preference.

Indirect_Tracelink_Report

DESCRIPTION
Specifies whether the current cross-domain tracing operation includes indirect trace
links. Indirect trace links are implicitly inherited by the item revisions of target objects.

PLM00026 11.2 Preferences and Environment Variables Reference 17-9


Chapter
Chapter 17:17:Reports,
Reports, requirements,
requirements, and scheduling
and scheduling preferences
preferences

VALID
VALUES
true The trace follows both direct and indirect trace links.
The value is set to true when the user selects the ON checkbox in the
Options dialog box.

false The trace follows only explicit trace links that are directly associated with
target object items.
The value is reset to false when the user clears the ON checkbox in the
Options dialog box.
For example, assume the following:
• An explicit trace link associates defining object 001255-Item 5 directly with
complying object 003499-Item 9.

• Complying object 003499-Item 9 has two item revisions, 003499/A;1-Item 09


and 003499/B;1-Item 09.

• The Indirect_Tracelink_Report value is true.

• Defining object 001255-Item 5 is selected as the source for a cross-domain trace.

When the user initiates the trace, the target views highlight not only complying object
003499-Item 9, but also 003499/A;1-Item 09 and 003499/B;1-Item 09, which inherit
the trace link implicitly.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

MultilineColumnProperties

DESCRIPTION
Specifies the columns where data can be shown on multiple lines. The columns wrap
the words into as many lines as needed.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid BOM line property.
DEFAULT
VALUES
bl_fulltext_body_cleartext
DEFAULT
PROTECTION
SCOPE
Site preference.

17-10 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

NE_default_application_domain_template

DESCRIPTION
Specifies the default application domain and Visio diagram template for the
specified types of BOM line, which is used in requirements management in Systems
Engineering. Default application domains are defined in the Business Modeler IDE by
the Fnd0TcApplication list of values.
VALID
VALUES
ObjectTypeName:valid_application_domain_name,default_visio _template
DEFAULT
VALUES
Functionality:FunctionalModeling,FUNCTIONAL_MODELING_TEMPLATE
Fnd0LogicalBlock:LogicalModeling,LOGICAL_MODELING_TEMPLATE
DEFAULT
PROTECTION
SCOPE

Site preference. Related topics

• Create a diagram

NE_diagram_domain_perspective_map

DESCRIPTION
Specifies the Teamcenter perspectives where diagrams can be opened in Microsoft
Office Visio. The preference values relate perspectives to application domains, which
are designated by the diagram templates on which the diagrams are based.
Application domains are defined in Business Modeler IDE by the Fnd0TcApplication
list of values (LOV).
VALID
VALUES
FunctionalModeling:com.teamcenter.rac.se.ui.SystemsEngineeringPerspective
Relates the FunctionalModeling application domain to the Systems Engineering
perspective.

LogicalModeling:com.teamcenter.rac.se.ui.SystemsEngineeringPerspective
Relates the LogicalModeling application domain to the Systems Engineering
perspective.

domain:com.teamcenter.rac.se.ui.perspective
Replace domain with an application domain name from the Business Modeler IDE.
Replace perspective with a Teamcenter perspective name.

PLM00026 11.2 Preferences and Environment Variables Reference 17-11


Chapter
Chapter 17:17:Related
Related topics
topics

DEFAULT
VALUES
LogicalModeling:com.teamcenter.rac.se.ui.SystemsEngineeringPerspective
FunctionalModeling:com.teamcenter.rac.se.ui.SystemsEngineeringPerspective
DEFAULT
PROTECTION
SCOPE
Site preference.

NE_relation_rule_grm_list

DESCRIPTION
Lists all Generic Relationship Management (GRM) relations that can appear in the
Available GRMs list of the New Diagram Template and Edit Diagram Template
dialog boxes. These selections determine which relations can be represented in
diagrams based on the diagram template.
VALID
VALUES
Accepts one or more strings as values. Each string must be the valid model name of a
relation, not the display name.
DEFAULT
VALUES
IMAN_reference
IMAN_specification
FND_TraceLink
DEFAULT
PROTECTION
SCOPE
User preference.

Paragraph RevisionColumnsShownPref

DESCRIPTION
Sets the default columns in a view where the top-level object is a paragraph.
The user’s column settings override this preference.
VALID
VALUES
Accepts internal names of the object properties to be displayed in the columns.
DEFAULT
VALUES
bl_item_item_id
bl_rev_object_name
bl_has_trace_link
bl_has_attached_notes
fnd0bl_hierarchical_number
bl_fulltext_body_cleartext
bl_item_object_type
bl_rev_owning_user
bl_rev_release_statuses

17-12 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
User preference.

REQ_checkout_objects_before_export

DESCRIPTION
Sets the default condition of the Check out objects before export check box under
Live options in the Export to Word dialog box.
VALID
VALUES
default The check box can be selected and cleared.
default_hide The check box is cleared and unavailable. Objects are exported
to live Word but not checked out.
default_checkout The check box is selected and unavailable. Objects exported to
live Word are explicitly checked out before the output document
is generated.
DEFAULT
VALUES
default_checkout
DEFAULT
PROTECTION
SCOPE
Site preference.

REQ_ExportToExcel_add_level_column

DESCRIPTION
Specifies whether Teamcenter inserts the Level column in Microsoft Excel output files
for structures that exceed eight levels. In these files, Excel's Outline features are
disabled and all objects occupy the same level. The Level column references each
object's structure level in Teamcenter.
VALID
VALUES
false The Level column is suppressed.
true The Level column is inserted in the leftmost position.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

Requirement RevisionColumnsShownPref

DESCRIPTION
Sets the default columns in a view where the top-level object is a requirement.

PLM00026 11.2 Preferences and Environment Variables Reference 17-13


Chapter
Chapter 17:17:Related
Related topics
topics

The user’s column settings override this preference.


VALID
VALUES
Accepts internal names of the object properties to be displayed in the columns.
DEFAULT
VALUES
bl_item_item_id
bl_rev_object_name
bl_has_trace_link
bl_has_attached_notes
fnd0bl_hierarchical_number
bl_fulltext_body_cleartext
bl_item_object_type
bl_rev_owning_user
bl_rev_release_statuses

DEFAULT
PROTECTION
SCOPE
User preference.

RequirementSpec RevisionColumnsShownPref

DESCRIPTION
Sets the default columns in a view where the top-level object is a requirement
specification.
The user’s column settings override this preference.
VALID
VALUES
Accepts internal names of the object properties to be displayed in the columns.
DEFAULT
VALUES
bl_item_item_id
bl_rev_object_name
bl_has_trace_link
bl_has_attached_notes
fnd0bl_hierarchical_number
bl_fulltext_body_cleartext
bl_item_object_type
bl_rev_owning_user
bl_rev_release_statuses

DEFAULT
PROTECTION
SCOPE
User preference.

17-14 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

SE_Trace_Report_Layout

DESCRIPTION
Controls the arrangement of the panes in the Traceability view.
VALID
VALUES
true Panes are arranged horizontally, with the Defining Object pane
on the left and the Complying Object pane on the right.
false Panes are arranged vertically, with the Defining Object pane
on top and the Complying Object pane at bottom.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

TcAllowedImportExportPeakSpecObject

DESCRIPTION
Specifies which business object subclasses can occupy the top level in Systems
Engineering structures that are imported and exported.
To use this preference, you must associate the business object type with the
Fnd0AssociatedBOMLine business constant. In the Business Modeler IDE,
change the value of the Fnd0AssociatedBOMLine business constant to
Fnd0RequirementBOMLine for the business object that you want to be the top line.
VALID
VALUES
Accepts one or more strings as values. Each string must contain the following:
• The name of a valid subclass of the Item business object.

• One of the following parameters:


true The subclass and its child subclasses can occupy the top level.
false Only the subclass can occupy the top level.

For example:
subclass_name:true

PLM00026 11.2 Preferences and Environment Variables Reference 17-15


Chapter
Chapter 17:17:Related
Related topics
topics

Tip

Do not enter multiple values from the same subclass hierarchy. Otherwise,
only the parent’s value is recognized.
For example, assume that the following values are entered:
Document:true
Specification:false
Because the Document subclass is the parent of the Specification subclass,
the Specification value is ignored.

DEFAULT
VALUES
Specification:true
DEFAULT
PROTECTION
SCOPE
Site

TcNotesAllowedType_DesignReq

DESCRIPTION
Specifies the types of custom notes that can be attached with the Quick Create bar to
selected design requirements.
VALID
VALUES
Accepts the internal names of user-defined subtypes of the Fnd0CustomNote
business object.
DEFAULT
VALUES
Fnd0CustomNote
DEFAULT
PROTECTION
SCOPE
Site preference.

TcNotesAllowedType_Fnd0LogicalBlock

DESCRIPTION
Specifies the types of custom notes that can be attached with the Quick Create bar to
selected logical blocks.
VALID
VALUES
Accepts the internal names of user-defined subtypes of the Fnd0CustomNote
business object.
DEFAULT
VALUES
Fnd0CustomNote

17-16 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
Site preference.

TcNotesAllowedType_Functionality

DESCRIPTION
Specifies the types of custom notes that can be attached with the Quick Create bar to
selected functions.
VALID
VALUES
Accepts the internal names of user-defined subtypes of the Fnd0CustomNote
business object.
DEFAULT
VALUES
Fnd0CustomNote
DEFAULT
PROTECTION
SCOPE
Site preference.

TcNotesAllowedType_Paragraph

DESCRIPTION
Specifies the types of custom notes that can be attached with the Quick Create bar
to selected paragraphs.
VALID
VALUES
Accepts the internal names of user-defined subtypes of the Fnd0CustomNote
business object.
DEFAULT
VALUES
Fnd0CustomNote
DEFAULT
PROTECTION
SCOPE
Site preference.

TcNotesAllowedType_Requirement

DESCRIPTION
Specifies the types of custom notes that can be attached with the Quick Create bar to
selected requirements.
VALID
VALUES
Accepts the internal names of user-defined subtypes of the Fnd0CustomNote
business object.
DEFAULT
VALUES
Fnd0CustomNote

PLM00026 11.2 Preferences and Environment Variables Reference 17-17


Chapter
Chapter 17:17:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
Site preference.

TcNotesAllowedType_RequirementSpec

DESCRIPTION
Specifies the types of custom notes that can be attached with the Quick Create bar
to selected requirement specifications.
VALID
VALUES
Accepts the internal names of user-defined subtypes of the Fnd0CustomNote
business object.
DEFAULT
VALUES
Fnd0CustomNote
DEFAULT
PROTECTION
SCOPE
Site preference.

TcNotesAllowedType_ValidationReq

DESCRIPTION
Specifies the types of custom notes that can be attached with the Quick Create bar to
selected validation requirements.
VALID
VALUES
Accepts the internal names of user-defined subtypes of the Fnd0CustomNote
business object.
DEFAULT
VALUES
Fnd0CustomNote
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_setProperties

DESCRIPTION
Defines the overall behavior of object properties settings from live Excel.
VALID
VALUES
SET_PROPERTIES
Sets all properties that have been overwritten since export without asking the user for
confirmation.

17-18 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

QUERY_AND_SET_ALL
Queries all objects to see if they have been overwritten since export. If objects are
found, values for all objects are set only after confirmation from the user.
QUERY_AND_SET_OVERWRITTEN
Queries all objects to see if they have been overwritten since export. If objects
are found, values for overwritten objects are set only after confirmation from the
user. Values that have not been overwritten are automatically updated without user
confirmation.
DEFAULT
VALUES
SET_PROPERTIES
DEFAULT
PROTECTION
SCOPE
Site preference.

Tracelink_Edit_enabled

DESCRIPTION
Enables user to perform any operation related to trace links. This preference can be
set in the Options dialog box by selecting Systems Engineering and either selecting
or clearing the Trace Link Mode check box.
VALID
VALUES
True or False
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
User preference.

TraceReport_Default_Expansion_Level

DESCRIPTION
Specifies the level depth of the traceability information displayed in the Trace Links
view for both defining and complying views. If you are displaying the trace link objects
in addition to the requirement objects, the level is multiplied by two.
VALID
VALUES
Integer values.
DEFAULT
VALUES
2
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 17-19


Chapter
Chapter 17:17:Related
Related topics
topics

TraceReport_Default_Sort_Property

DESCRIPTION
Specifies the default property name for sorting traceability information in the Trace
Links view. The property must be part of the current column configuration.
VALID
VALUES
String value.
DEFAULT
VALUES
object_string
DEFAULT
PROTECTION
SCOPE
Site preference.

TraceReport_Default_TraceLink_type

DESCRIPTION
Specifies the default trace link used when creating trace links using the commands
Start Trace Link and End Trace Link .
VALID
VALUES
Trace link type name.
DEFAULT
VALUES
FND_TraceLink
DEFAULT
PROTECTION
SCOPE
Site preference.

TraceReport_Filter_Available_Object_Types

DESCRIPTION
Specifies the list of available object types under the Available Object Types heading
that you can select for filtering when setting object type filters. You set object type
filters by clicking the Object Type Filters tab in the Trace Links view or Traceview
Settings dialog box. From this list, you select the object types that you want to display
in the in the Trace Links view.
VALID
VALUES
String values.
DEFAULT
VALUES
Requirement
Requirement Revision
Paragraph
Paragraph Revision
RequirementSpec

17-20 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

RequirementSpec Revision
Item
ItemRevision

DEFAULT
PROTECTION
SCOPE
Site preference.

TraceReport_Filter_Available_Tracelink_Types

DESCRIPTION
Specifies the list of available trace link types under the Available Link Types heading
that you can select for filtering when setting trace link type filters. You set trace link
filters by clicking the Link Type Filters tab in the Trace Links view or Traceview
Settings dialog box. From this list, you select the trace link types that you want to
display in the in the Trace Links view.
VALID
VALUES
String values.
DEFAULT
VALUES
FND_TraceLink
DEFAULT
PROTECTION
SCOPE
Site preference.

TraceReport_Filter_Selected_Object_Types

DESCRIPTION
Contains the list of object types under the Selected Object Types heading that are
selected for filtering when setting object type filters. This preference is automatically
updated when you modify the list of selected object types. You set object type filters by
clicking the Object Type Filters tab in the Trace Links view or Traceview Settings
dialog box.
VALID
VALUES
String values.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 17-21


Chapter
Chapter 17:17:Related
Related topics
topics

TraceReport_Filter_Selected_TraceLink_Types

DESCRIPTION
Contains the list of trace link types under the Selected Link Types heading that are
selected for filtering when setting trace link type filters. This preference is automatically
updated when you modify the list of selected trace link types. You set the trace link
type filters by clicking the Link Type Filters tab in the Trace Links view or Traceview
Settings dialog box.
VALID
VALUES
String values.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

TraceReportTable_ColumnPreferences

DESCRIPTION
Specifies the list of columns that display for defining and complying traceability
information in the Trace Links view.
VALID
VALUES
String values.
DEFAULT
VALUES
object_string
object_type
relation_type
owning_user
owning_group
las_mod_date
checked_out
release_status_list
DEFAULT
PROTECTION
SCOPE
User preference.

TraceReportTable_ColumnWidthPreferences

DESCRIPTION
Specifies the column width for the list of columns defined in the
TraceReportTable_ColumnPreferences preference.
VALID
VALUES
Integer values.

17-22 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
31
17
13
9
17
6
26
26
DEFAULT
PROTECTION
SCOPE
User preference.

Schedule Manager preferences


CombinedAvailableAttributes

DESCRIPTION
Defines the list of common Schedule and Schedule Task object attributes displayed
in the Column Chooser dialog box of the Schedule Manager application when a
Program View is opened.
VALID
VALUES
Combined.object Displays object description in the Column Chooser
_desc dialog box of the Schedule Manager application when a
program view is opened.
Combined.start_date Displays start date in the Column Chooser dialog box of
the Schedule Manager application when a program view
is opened.
Combined.finish_date Displays finish date in the Column Chooser dialog box of
the Schedule Manager application when a program view
is opened.
Combined.fnd0status Displays status in the Column Chooser dialog box of the
Schedule Manager application when a program view is
opened.
Combined.priority Displays priority in the Column Chooser dialog box of
the Schedule Manager application when a program view
is opened.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 17-23


Chapter
Chapter 17:17:Related
Related topics
topics

cost_default_currency

DESCRIPTION
Specifies the default currency to use for costs in the system. The value must be a
valid currency code based on the ISO-4217 standard. Set this preference to the
current value listed in the CostCurrency LOV. The default value is USD (United
States dollars). If you want to use EUR as your default currency, change the one
value in the CostCurrency LOV from USD to EUR. Then, specify EUR when using
the cost_default_currency preference.
Note

Siemens PLM Software recommends using only one currency in Teamcenter


because there is no support for currency conversion.

VALID
VALUES
Accepts one of the values listed in the CostCurrency LOV.
DEFAULT
VALUES
USD
DEFAULT
PROTECTION
SCOPE
Site preference.

DefaultActualToSystemDate

DESCRIPTION
Determines whether system date or scheduled date is used when initially setting
actual start date or actual end date, when the user marks a task as in progress or
complete, respectively.
This preference is used with Schedule Manager.
VALID
VALUES
True system date is used as the default date set in actual start date or actual
end date.
False scheduled date is used as the default date set in actual start date or actual
end date.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
All.

17-24 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Default_Base_Calendar_Preference

DESCRIPTION
Determines the internal name of the default calendar when a schedule is created in
Schedule Manager.
VALID
VALUES

Standard
Night Shift
24 Hours
DEFAULT
VALUES
Standard
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
Modify this preference when TCCalendar has multiple translations and users need to
query based on the known locale-independent name.

Fnd0QueryFolder_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of the
Fnd0QueryFolder business object.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of the
Fnd0QueryFolder business object.
DEFAULT
VALUES
Fnd0Contents
DEFAULT
PROTECTION
SCOPE
User preference.

ProgramViewFilterProperties

DESCRIPTION
Specifies the list of attributes for schedule and schedule task objects displayed in the
Filter dialog box of the Schedule Manager application when a program view is opened.
VALID
VALUES
Schedule Displays complete percent in the Filter dialog box of the
Task.complete Schedule Manager application when a program view is
_percent opened.

PLM00026 11.2 Preferences and Environment Variables Reference 17-25


Chapter
Chapter 17:17:Related
Related topics
topics

Schedule Displays actual start date in the Filter dialog box of the
Task.actual_start _date Schedule Manager application when a program view is
opened.
Schedule Displays actual finish date in the Filter dialog box of the
Task.actual_finish Schedule Manager application when a program view is
_date opened.
Schedule Displays work complete in the Filter dialog box of the
Task.work_complete Schedule Manager application when a program view is
opened.
Schedule Displays resource assignment in the Filter dialog box of
Task.Resource the Schedule Manager application when a program view
Assignment is opened.
Schedule Displays object description in the Filter dialog box of the
Task.object_desc Schedule Manager application when a program view is
opened.
Schedule Displays duration in the Filter dialog box of the Schedule
Task.duration Manager application when a program view is opened.
Schedule Task.object Displays object name in the Filter dialog box of the
_name Schedule Manager application when a program view is
opened.
Schedule Task.priority Displays priority in the Filter dialog box of the Schedule
Manager application when a program view is opened.
Schedule Displays start date in the Filter dialog box of the Schedule
Task.start_date Manager application when a program view is opened.
Schedule Displays finish date in the Filter dialog box of the Schedule
Task.finish_date Manager application when a program view is opened.
Schedule Displays work estimate in the Filter dialog box of the
Task.work_estimate Schedule Manager application when a program view is
opened.
Schedule Displays state in the Filter dialog box of the Schedule
Task.fnd0state Manager application when a program view is opened.
Schedule Displays status in the Filter dialog box of the Schedule
Task.fnd0status Manager application when a program view is opened.
Schedule.object_name Displays object name in the Filter dialog box of the
Schedule Manager application when a program view is
opened.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

17-26 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

ProgramViewGroupProperties

DESCRIPTION
Specifies the list of attributes for schedule and schedule task objects displayed in the
Grouping dialog box of the Schedule Manager application when a program view is
opened.
VALID
VALUES
Schedule Displays complete percent in the Grouping dialog box of
Task.complete the Schedule Manager application when a program view
_percent is opened.
Schedule Displays actual start date in the Grouping dialog box of
Task.actual_start _date the Schedule Manager application when a program view
is opened.
Schedule Displays actual finish date in the Grouping dialog box of
Task.actual_finish the Schedule Manager application when a program view
_date is opened.
Schedule Displays work complete in the Grouping dialog box of
Task.work_complete the Schedule Manager application when a program view
is opened.
Schedule Displays resource assignment in the Grouping dialog
Task.Resource box of the Schedule Manager application when a program
Assignment view is opened.
Schedule Displays object description in the Grouping dialog box of
Task.object_desc the Schedule Manager application when a program view
is opened.
Schedule Displays duration in the Grouping dialog box of the
Task.duration Schedule Manager application when a program view is
opened.
Schedule Displays object name in the Grouping dialog box of the
Task.object_name Schedule Manager application when a program view is
opened.
Schedule Task.priority Displays priority in the Grouping dialog box of the
Schedule Manager application when a program view is
opened.
Schedule Displays start date in the Grouping dialog box of the
Task.start_date Schedule Manager application when a program view is
opened.
Schedule Displays finish date in the Grouping dialog box of the
Task.finish_date Schedule Manager application when a program view is
opened.
Schedule Displays work estimate in the Grouping dialog box of
Task.work_estimate the Schedule Manager application when a program view
is opened.

PLM00026 11.2 Preferences and Environment Variables Reference 17-27


Chapter
Chapter 17:17:Related
Related topics
topics

Schedule Displays state in the Grouping dialog box of the Schedule


Task.fnd0state Manager application when a program view is opened.
Schedule Displays status in the Grouping dialog box of the Schedule
Task.fnd0status Manager application when a program view is opened.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Schedule_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of the Schedule
business object.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of the Schedule
business object.
DEFAULT
VALUES
IMAN_reference
DEFAULT
PROTECTION
SCOPE
User preference.

ScheduleAvailableAttributes

DESCRIPTION
Defines the list of common schedule attributes displayed in the Column Chooser
dialog box of the Schedule Manager application when a program view is opened.
VALID
VALUES
Schedule.object_desc Displays the object description in the Column Chooser
dialog box of the Schedule Manager application when a
program view is opened.
Schedule.start_date Displays the start date in the Column Chooser dialog box
of the Schedule Manager application when a program view
is opened.
Schedule.finish_date Displays the finish date in the Column Chooser dialog
box of the Schedule Manager application when a program
view is opened.
Schedule.fnd0status Displays the status in the Column Chooser dialog box of
the Schedule Manager application when a program view
is opened.

17-28 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Schedule.priority Displays the priority in the Column Chooser dialog box of


the Schedule Manager application when a program view
is opened.
Schedule.schedule_type Displays the schedule type in the Column Chooser dialog
box of the Schedule Manager application when a program
view is opened.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ScheduleColumnsShownPref

DESCRIPTION
Specifies the Schedule Task object attributes displayed in the Column Chooser dialog
box of the Schedule Manager application when a Program View is opened.
VALID
VALUES
ScheduleTask.start Displays start date in the Column Chooser dialog box of
_date the Schedule Manager application when a program view
is opened.
ScheduleTask.finish Displays finish date in the Column Chooser dialog box of
_date the Schedule Manager application when a program view
is opened.
ScheduleTask. Displays duration in the Column Chooser dialog box of
duration the Schedule Manager application when a program view
is opened.
ScheduleTask.work Displays work estimate in the Column Chooser dialog
_estimate box of the Schedule Manager application when a program
view is opened.
ScheduleTask.task Displays task type in the Column Chooser dialog box of
_type the Schedule Manager application when a program view
is opened.
ScheduleTask. Displays constraint in the Column Chooser dialog box of
constraint the Schedule Manager application when a program view
is opened.
ScheduleTask.actual Displays actual start date in the Column Chooser dialog
_start_date box of the Schedule Manager application when a program
view is opened.
ScheduleTask.actual Displays actual finish date in the Column Chooser dialog
_finish_date box of the Schedule Manager application when a program
view is opened.

PLM00026 11.2 Preferences and Environment Variables Reference 17-29


Chapter
Chapter 17:17:Related
Related topics
topics

ScheduleTask.work Displays work complete in the Column Chooser dialog


_complete box of the Schedule Manager application when a program
view is opened.
ScheduleTask.complete Displays complete percent in the Column Chooser dialog
_percent box of the Schedule Manager application when a program
view is opened.
ScheduleTask. Displays find state in the Column Chooser dialog box of
fnd0state the Schedule Manager application when a program view
is opened.
ScheduleTask. Displays find status in the Column Chooser dialog box of
fnd0status the Schedule Manager application when a program view
is opened.
ScheduleTask.SI Displays SI in the Column Chooser dialog box of the
Schedule Manager application when a program view is
opened.
ScheduleTask.object Displays object name in the Column Chooser dialog box
_name of the Schedule Manager application when a program view
is opened.
ScheduleTask. Displays resource assignment in the Column Chooser
ResourceAssignment dialog box of the Schedule Manager application when a
program view is opened.
predecessors Displays predecessors in the Column Chooser dialog
box of the Schedule Manager application when a program
view is opened.
successors Displays successors in the Column Chooser dialog box
of the Schedule Manager application when a program view
is opened.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ScheduleDeliverableWSOTypes

DESCRIPTION
Defines the types allowed for the schedule deliverables within Schedule Manager.

17-30 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Note

• When adding a type, subtypes are not considered. For example, adding
the Dataset type allows you to use Microsoft Word, Microsoft WordX, and
Microsoft Excel.
However, adding the Item type does not allow you to use the Document
subtype of Item.

• If you have custom submittal types, add them as values to this preference
so they are associated with schedule tasks in the schedule.
For more information, see Aerospace and Defense Solution.

VALID
VALUES
The type of internal storage class names for any subtype of (and including)
WorkspaceObject business object.
DEFAULT
VALUES
Dataset
Folder
Form
Item
DEFAULT
PROTECTION
SCOPE
Site preference.

ScheduleTask.CHGDETAILRENDERING

DESCRIPTION
Registration of the Change Details style sheet for schedule task objects.
VALID
VALUES
ScheduleTaskChgDetails
Specifies the xml filename that contains the Change Details style sheet.
DEFAULT
VALUES
ScheduleTaskChgDetails
DEFAULT
PROTECTION
SCOPE
Site preference.

ScheduleTaskClassNameToCreate

DESCRIPTION
Specifies the type of schedule task that is created through the quick create option in
the rich client.

PLM00026 11.2 Preferences and Environment Variables Reference 17-31


Chapter
Chapter 17:17:Related
Related topics
topics

VALID
VALUES
Any schedule task type.
DEFAULT
VALUES
ScheduleTask
DEFAULT
PROTECTION
SCOPE
User preference.

ScheduleTask_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of the Schedule
Task business object.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of the Schedule
Task business object.
DEFAULT
VALUES
IMAN_reference
DEFAULT
PROTECTION
SCOPE
User preference.

ScheduleTaskAvailableAttributes

DESCRIPTION
Specifies the Schedule Task object attributes displayed in the Available Columns list
in the Column Chooser dialog box of the Schedule Manager application when a
Program View is opened.
VALID
VALUES
ScheduleTask. Displays Description in the Column Chooser dialog box
object_desc of the Schedule Manager application when a program view
is opened.
ScheduleTask. Displays Start Date in the Column Chooser dialog box of
start_date the Schedule Manager application when a program view
is opened.
ScheduleTask. Displays Finish Date in the Column Chooser dialog box
finish_date of the Schedule Manager application when a program view
is opened.
ScheduleTask. Displays Duration in the Column Chooser dialog box of
duration the Schedule Manager application when a program view
is opened.

17-32 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

ScheduleTask. Displays Work Estimate in the Column Chooser dialog


work_estimate box of the Schedule Manager application when a program
view is opened.
ScheduleTask. priority Displays Priority in the Column Chooser dialog box of
the Schedule Manager application when a program view
is opened.
ScheduleTask. Displays Task Type in the Column Chooser dialog box of
task_type the Schedule Manager application when a program view
is opened.
ScheduleTask. Displays Constraint in the Column Chooser dialog box of
constraint the Schedule Manager application when a program view
is opened.
ScheduleTask. Displays Actual Start Date in the Column Chooser dialog
actual_start_date box of the Schedule Manager application when a program
view is opened.
ScheduleTask. Displays Actual Finish Date in the Column Chooser
actual_finish_date dialog box of the Schedule Manager application when a
program view is opened.
ScheduleTask. Displays Work Complete in the Column Chooser dialog
work_complete box of the Schedule Manager application when a program
view is opened.
ScheduleTask. Displays Work Complete Percent in the Column Chooser
complete_percent dialog box of the Schedule Manager application when a
program view is opened.
ScheduleTask. Displays State in the Column Chooser dialog box of the
fnd0state Schedule Manager application when a program view is
opened.
ScheduleTask. Displays Status in the Column Chooser dialog box of
fnd0status the Schedule Manager application when a program view
is opened.
ScheduleTask. SI Displays Status Indicator in the Column Chooser dialog
box of the Schedule Manager application when a program
view is opened.
ScheduleTask. Displays Schedule in the Column Chooser dialog box of
schedule_tag the Schedule Manager application when a program view
is opened.
ScheduleTask. Displays ResourceAssignment in the Column Chooser
ResourceAssignment dialog box of the Schedule Manager application when a
program view is opened.
DEFAULT
VALUES
ScheduleTask. object_desc
ScheduleTask. start_date

PLM00026 11.2 Preferences and Environment Variables Reference 17-33


Chapter
Chapter 17:17:Related
Related topics
topics

ScheduleTask. finish_date
ScheduleTask. duration
ScheduleTask. work_estimate
ScheduleTask. priority
ScheduleTask. task_type
ScheduleTask. constraint
ScheduleTask. actual_start_date
ScheduleTask. actual_finish_date
ScheduleTask. work_complete
ScheduleTask. complete_percent
ScheduleTask. fnd0state
ScheduleTask. fnd0status
ScheduleTask. SI
ScheduleTask. schedule_tag
ScheduleTask. ResourceAssignment
DEFAULT
PROTECTION
SCOPE
Site preference.

ScheduleTaskAvailableAttributesWithRelations

DESCRIPTION
Specifies the Schedule Task object attributes displayed in the Available Columns list
in the Column Chooser dialog box of the Schedule Manager application.
VALID
VALUES
ScheduleTask. Displays Description in the Column Chooser dialog box
object_desc of the Schedule Manager application.
ScheduleTask. Displays Start Date in the Column Chooser dialog box of
start_date the Schedule Manager application.
ScheduleTask. Displays Finish Date in the Column Chooser dialog box
finish_date of the Schedule Manager application.
ScheduleTask. Displays Duration in the Column Chooser dialog box of
duration the Schedule Manager application.
ScheduleTask. Displays Work Estimate in the Column Chooser dialog
work_estimate box of the Schedule Manager application.
ScheduleTask. priority Displays Priority in the Column Chooser dialog box of the
Schedule Manager application.
ScheduleTask. Displays Task Type in the Column Chooser dialog box of
task_type the Schedule Manager application.
ScheduleTask. Displays Constraint in the Column Chooser dialog box of
constraint the Schedule Manager application.
ScheduleTask. Displays Actual Start Date in the Column Chooser dialog
actual_start_date box of the Schedule Manager application.

17-34 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

ScheduleTask. Displays Actual Finish Date in the Column Chooser


actual_finish_date dialog box of the Schedule Manager application.
ScheduleTask. Displays Work Complete in the Column Chooser dialog
work_complete box of the Schedule Manager application.
ScheduleTask. Displays Work Complete Percent in the Column Chooser
complete_percent dialog box of the Schedule Manager application.
ScheduleTask. Displays State in the Column Chooser dialog box of the
fnd0state Schedule Manager application.
ScheduleTask. Displays Status in the Column Chooser dialog box of the
fnd0status Schedule Manager application.
ScheduleTask. SI Displays Status Indicator in the Column Chooser dialog
box of the Schedule Manager application.
ScheduleTask. Displays Name in the Column Chooser dialog box of the
object_name Schedule Manager application.
ScheduleTask. Displays Task Deliverables in the Column Chooser dialog
sch_task_deliverable_listbox of the Schedule Manager application.
ScheduleTask. Displays Workflow Template in the Column Chooser
workflow_template dialog box of the Schedule Manager application.
ScheduleTask. Displays Workflow Trigger in the Column Chooser dialog
worfklow_trigger _type box of the Schedule Manager application.
ScheduleTask. Displays ResourceAssignment in the Column Chooser
ResourceAssignment dialog box of the Schedule Manager application.
predecessors Displays Predecessors in the Column Chooser dialog box
of the Schedule Manager application.
successors Displays Successors in the Column Chooser dialog box
of the Schedule Manager application.
baseline_start Displays Baseline Start in the Column Chooser dialog
box of the Schedule Manager application.
baseline_finish Displays Baseline Finish in the Column Chooser dialog
box of the Schedule Manager application.
baseline_duration Displays Baseline Duration in the Column Chooser dialog
box of the Schedule Manager application.
baseline Displays Baseline Work Estimate in the Column Chooser
_workestimate dialog box of the Schedule Manager application.
baseline Displays Baseline Work Complete in the Column
_workcomplete Chooser dialog box of the Schedule Manager application.
baseline_ Displays Baseline Work Complete Percent in the Column
workcompletepercent Chooser dialog box of the Schedule Manager application.
ScheduleTask. Displays Owner in the Column Chooser dialog box of the
owning_user Schedule Manager application.

PLM00026 11.2 Preferences and Environment Variables Reference 17-35


Chapter
Chapter 17:17:Related
Related topics
topics

time_slack Displays Time Slack in the Column Chooser dialog box


of the Schedule Manager application.
ScheduleTask. Displays WBS Code in the Column Chooser dialog box
wbs_code of the Schedule Manager application.
ScheduleTask. Displays Associated Processes in the Column Chooser
fdp0AssociatedProcesses
dialog box of the Schedule Manager application.
DEFAULT
VALUES
ScheduleTask. object_desc
ScheduleTask. start_date
ScheduleTask. finish_date
ScheduleTask. duration
ScheduleTask. work_estimate
ScheduleTask. priority
ScheduleTask. task_type
ScheduleTask. constraint
ScheduleTask. actual_start_date
ScheduleTask. actual_finish_date
ScheduleTask. work_complete
ScheduleTask. complete_percent
ScheduleTask. fnd0state
ScheduleTask. fnd0status
ScheduleTask. SI
ScheduleTask. object_name
ScheduleTask. sch_task_deliverable_list
ScheduleTask. workflow_template
ScheduleTask. worfklow_trigger _type
ScheduleTask. ResourceAssignment
predecessors
successors
baseline_start
baseline_finish
baseline_duration
baseline _workestimate
baseline _workcomplete
baseline_ workcompletepercent
ScheduleTask. owning_user
time_slack
ScheduleTask. wbs_code
ScheduleTask. fdp0AssociatedProcesses
DEFAULT
PROTECTION
SCOPE
Site preference.

17-36 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

scheduling_graph_dataSource

DESCRIPTION
Specifies data source for resource graph. When set to randomSample, the system
uses a random sample generator. When set to TeamcenterDB (default), the system
uses the Teamcenter database.
Warning

This preference must be set to TeamcenterDB in a production environment.

VALID
VALUES
randomSample The system uses a random sample generator as the data
source for resource graphs.
TeamcenterDB The system uses the Teamcenter database as the data source
for resource graphs.
DEFAULT
VALUES
TeamcenterDB
DEFAULT
PROTECTION
SCOPE
Site preference.

scheduling_graph_dataSource_filter

DESCRIPTION
Used with Schedule Manager resource graphs. Specifies the filtering method used
when creating resource graphs.
VALID
VALUES
none No filter is applied.
selection Users can select which schedules are used to create the
resource graph.
current The current schedule is used to create the resource graph.
DEFAULT
VALUES
none
DEFAULT
PROTECTION
SCOPE
Site preference.

scheduling_graph_date_format

DESCRIPTION
Used with Schedule Manager resource graphs. Determines the date and time display
in resource graphs.

PLM00026 11.2 Preferences and Environment Variables Reference 17-37


Chapter
Chapter 17:17:Related
Related topics
topics

VALID
VALUES
Accepts a single string as a value. The string can be any pattern that describes date
and time format.
DEFAULT
VALUES
EEE, MMM d
DEFAULT
PROTECTION
SCOPE
Site preference.

scheduling_graph_domain_interval

DESCRIPTION
Used with Schedule Manager resource graphs. Determines the marked intervals on
the domain axis. Set this preference with any segmented time line value such as day
(default) or week, or with integer values such as 1 for a day or 7 for a week.
VALID
VALUES
Accepts multiple strings as values. Each string must be a segmented time line value or
positive integer. For example:
day
week
1440
10080
DEFAULT
VALUES
day
DEFAULT
PROTECTION
SCOPE
Site preference.

scheduling_graph_domain_label_vertical

DESCRIPTION
Used with Schedule Manager resource graphs. Determines whether domain labels
are vertical or horizontal.
VALID
VALUES
True Domain labels are vertical.
False Domain labels are horizontal.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

17-38 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

scheduling_graph_font_name

DESCRIPTION
Used with Schedule Manager resource graphs. Determines the font displayed in
resource graphs.
VALID
VALUES
Accepts a single string as a value. The string must be a valid font type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

scheduling_graph_font_size

DESCRIPTION
Used with Schedule Manager resource graphs. Determines the font size displayed in
resource graphs.
VALID
VALUES
Accepts a single string as a value. The string must be a positive integer, representing
a reasonable font size.
DEFAULT
VALUES
8
DEFAULT
PROTECTION
SCOPE
Site preference.

scheduling_graph_font_style

DESCRIPTION
Used with Schedule Manager resource graphs. Determines the font style displayed in
resource graphs.
VALID
VALUES
0 Normal font.
1 Bold font.
2 Italic font.
3 Bold and italic font.
DEFAULT
VALUES
0

PLM00026 11.2 Preferences and Environment Variables Reference 17-39


Chapter
Chapter 17:17:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
Site preference.

scheduling_graph_histogram_single_color

DESCRIPTION
Used with Schedule Manager resource graphs. Determines whether single or multiple
colors bars are used in resource graphics.
Note

• If this preference is set to True, the bar tool tip display depends on the value
of the scheduling_graph_task_legend preference.

• If this preference is set to False, the bar tool tip is truncated to show only
the task name, schedule name, and date.

VALID
VALUES
True A single color bar is used.
False Multiple color bars are used.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

scheduling_graph_reference_calendar

DESCRIPTION
Specifies the calendar type to use for domain (x = days) and range (y = availability/work
allocation) axes in the resource graph.
VALID
VALUES
resource_calendar_type Specifies the domain for the resource calendar.
system_calendar_type Specifies the domain for the system calendar.
DEFAULT
VALUES
resource_calendar_type
DEFAULT
PROTECTION
SCOPE
Site preference

17-40 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

scheduling_graph_task_legend

DESCRIPTION
Used with Schedule Manager resource graphs. Determines whether legends are
displayed for stacked bars.
Note

• If this preference is set to True, the bar tool tip is truncated to show only the
task name, schedule name, and date.

• If this preference is set to False, the bar tool tip is expanded, displaying
additional task and assignee information, such as work, capacity,
availability, load, and calendar.

• However, if the scheduling_graph_histogram_single_color preference


is set to False, the bar tool tip is truncated even if this preference is set
to False.

VALID
VALUES
True Legends are displayed for stacked bars.
False Legends are not displayed for stacked bars.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

scheduling_graph_view

DESCRIPTION
Used with Schedule Manager resource graphs. Determines whether scroll bars are
included in resource graphs.
VALID
VALUES
Classic Resource graphs display with scroll bars.
Native Resource graphs display without scroll bars.
DEFAULT
VALUES
Native
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 17-41


Chapter
Chapter 17:17:Related
Related topics
topics

SiteTimeZone

DESCRIPTION
Stores the time zone of the server. Use this preference to determine the time zone
used by the TCCalendars in the scheduling logic. This preference is used with
Schedule Manager.
VALID
VALUES
Accepts a single value pair indicating a time zone ID from the zoneinfo database (also
known as the Olson database) in the following format:
region/city
For example:
Europe/Paris
Refer to the zoneinfo database (http://en.wikipedia.org/wiki/Zoneinfo) for the complete
list of zone IDs. The system checks for a valid value and displays an error message
when Schedule Manager is launched if an invalid value is detected.
DEFAULT
VALUES
You must set this preference, as there is no default value.
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_ALLOW_INPROCESS_REMOVAL_OF_SUB_SCHEDULE

DESCRIPTION
Prevents removal of started subschedules.
The value of this preference is overridden by the value of the
SM_PREVENT_DELETE_STATES preference for subschedules. In other words, if a
subschedule’s state is one of the set values of SM_PREVENT_DELETE_STATES, it
cannot be deleted or removed, even if this preference is set to true.
For example, the subschedule cannot be removed or deleted if the following conditions
exist:
• SM_ALLOW_INPROCESS_REMOVAL_OF_SUB_SCHEDULE is set to true.

• SM_PREVENT_DELETE_STATES is set to in_progress, complete, aborted.

• The subschedule state is set to aborted.


Note

After you change this preference’s value, you must log off and then log on
for it to take effect.

VALID
VALUES
true

17-42 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

false
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_ALLOW_USER_ABORT

DESCRIPTION
Specifies if schedule participants can abort schedule tasks.
Note

After you change this preference’s value, you must log off and then log on
for it to take effect.

VALID
VALUES
true
false
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_Copy_Schedule_Async

DESCRIPTION
Determines the default selection when the user performs the Save As or Create
a Schedule from Template command.
VALID
VALUES
True Asychronously determines the default selection.
False Synchronously determines the default selection.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 17-43


Chapter
Chapter 17:17:Related
Related topics
topics

SM_CriticalPath_Color

DESCRIPTION
Sets the color for display of critical path.
VALID
VALUES
A user can set any value to this preference. The value specified must be a valid
comma-separated integer code specified using three 8-bit unsigned integers (0
through 255) representing the intensities of red, green, and blue.
DEFAULT
VALUES
Red255,0,0(RGB)
DEFAULT
PROTECTION
SCOPE
All.
NOTES
This value is set when a user selects the color from the color dialog box.

SM_DEFAULT_WORKFLOW_TEMPLATE

DESCRIPTION
Defines the workflow template to be used as the default for a schedule task.
VALID
VALUES
A valid workflow template name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_DEFERRED_NOTIFICATION_TIME

DESCRIPTION
Specifies the notification time in minutes before the user is warned that the deferred
session is about to expire.
Note

After you change this preference’s value, you must log off and then log on
for it to take effect.

VALID
VALUES
Any numerical value indicating the number of minutes until deferred session expires.
DEFAULT
VALUES
0

17-44 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
User preference.

SM_DEFERRED_SHOW_TIMEOUT

DESCRIPTION
Specifies whether the timer button is displayed or not.
Note

After you change this preference’s value, you must log off and then log on
for it to take effect.

VALID
VALUES
True Displays the timer button.
false Hides the timer button.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
This preference is ignored when timeout is disabled. The checkbox in the Schedule
Manager user interface controls the value in this preference.

SM_DEFERRED_TIMEOUT

DESCRIPTION
Specifies the time-out in minutes before the deferred session expires.
Note

After you change this preference’s value, you must log off and then log on
for it to take effect.

VALID
VALUES
Any numerical value indicating the time-out in minutes until deferred session expires.
0 turns off the time-out.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 17-45


Chapter
Chapter 17:17:Related
Related topics
topics

SM_Delete_Schedule_Async

DESCRIPTION
Determines the behavior when you choose to delete a schedule.
VALID
VALUES
true Asynchronously determines the default selection.
false Synchronously determines the default selection.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_Delete_Validation_Files

DESCRIPTION
Determines if the Schedule Manager translator should delete or preserve the
temporary XML validation files.
VALID
VALUES
true
false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_DISPLAY_GANTT_SI

DESCRIPTION
Activates the display of the Gantt status indicator in the Schedule Manager application.
VALID
VALUES
True Shows the Gantt status indicator.
False Hides the Gantt status indicator.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

17-46 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

SM_EnforceActualDatesBeforeNow

DESCRIPTION
In Schedule Manager, determines if dates must be set to a date prior to the current
date, or if they can be set to any date.
VALID
VALUES
true Forces the use of a date prior to current date.

false Specifies that any date can be used.


DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_ENFORCE_ASSIGNMENT_CRITERIA

DESCRIPTION
Determines if Schedule Manager enforces assignment criteria, such as discipline,
placeholder, or qualification, when assigning resources to schedule tasks.
VALID
VALUES
true Enforces the assignment criteria.

false Specifies that any user can be assigned regardless of the assignment criteria
defined on schedule tasks.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_EVM_Calc_Labels

DESCRIPTION
Specifies whether earned value management (EVM) calculations are displayed as
EVM labels or C/SCSC (cost/schedule control systems criteria) labels.
VALID
VALUES
EVM
C/SCSC
DEFAULT
VALUES
EVM

PLM00026 11.2 Preferences and Environment Variables Reference 17-47


Chapter
Chapter 17:17:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
All.

SM_EVM_Calc_Preference

DESCRIPTION
Specifies whether earned value management (EVM) calculations are based on cost
or hours.
VALID
VALUES
Cost
Hours
DEFAULT
VALUES
Hours
DEFAULT
PROTECTION
SCOPE
All.

SM_EVM_Export_Units

DESCRIPTION
Specifies whether units are displayed in the Microsoft Excel spreadsheet upon export.
VALID
VALUES
True Exports the units to the Microsoft Excel spreadsheet.
False Does not export the units to the Microsoft Excel spreadsheet.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
All.

SM_EVM_Work_Complete

DESCRIPTION
Specifies whether earned value management (EVM) calculations are based on percent
of work completed or actual hours of work completed.
VALID
VALUES
Percent Complete
Actual Hours
DEFAULT
VALUES
Percent Complete

17-48 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
All.

SM_EXEC_VIEW_PROPERTIES

DESCRIPTION
Specifies the properties displayed in the execution view and the order in which they
are displayed. Valid values are internal attribute names of a schedule task object.
The code retrieves the value for this preference in this property order: user, role,
group, or site.
VALID
VALUES
Accepts one or more of the following strings as valid values. Each string must provide
a valid internal property name of a schedule task object.
DEFAULT
VALUES
schedule_tag
object_name
object_description
fnd0status
SI
complete_percent
work_complete
work_remaining
actual_start_date
actual_finish_date
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_GANTT_MONTH_ZM_B_DF

DESCRIPTION
Defines the date format at the bottom of the Gantt chart for viewing the month.
VALID
VALUES
MM/dd/yyyy
Format using a combination of the valid characters that make up the date pattern, for
example, MM for month character, dd for day number, and yyyy for year.
Note

The month character MM allows you to enter the number of the month. For
example, enter 01 for January, 02 for February, and so on.

Values for month, day, and year are enclosed in quotation marks.
The default separator is the forward-slash character (/).

PLM00026 11.2 Preferences and Environment Variables Reference 17-49


Chapter
Chapter 17:17:Related
Related topics
topics

The information is specific to iconographic languages.


DEFAULT
VALUES
MM/dd
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_GANTT_MONTH_ZM_T_DF

DESCRIPTION
Defines the date format at the top of the Gantt chart for viewing the month.
VALID
VALUES
MMMM/dd/yyyy
Format using a combination of the valid characters that make up the date pattern, for
example, MMMM for month character, dd for day number, and yyyy for year.
Note

The month character MMMM allows you to enter four letters for the month. For
example, enter Janu for January, Febr for February, and so on.

Values for month, day, and year are enclosed in quotation marks.
The default separator is the forward slash character (/).
The information is specific to iconographic languages.
DEFAULT
VALUES
MMMM/yyyy
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_GANTT_QTR_STRT

DESCRIPTION
Specifies the starting month of the first quarter of the year.
VALID
VALUES
Any number between 1 (January) and 12 (December).
DEFAULT
VALUES
1 (January)
DEFAULT
PROTECTION
SCOPE
Site preference.

17-50 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

SM_GANTT_QTR_ZM_B_DF

DESCRIPTION
Defines the date format at the bottom of the Gantt chart for viewing the quarter of
the year.
VALID
VALUES
n/yyyy
Format using a combination of the valid characters that comprise the date pattern, for
example, n for quarter character and yyyy for year.
Values for quarter and year are enclosed in quotation marks.
The default separator is the forward slash character (/).
The information is specific to iconographic languages.
DEFAULT
VALUES
n/yyyy
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_GANTT_QTR_ZM_T_DF

DESCRIPTION
Defines the date format at the top of the Gantt chart for viewing the quarter of the year.
VALID
VALUES
MMM/dd/yyyy
Format using a combination of the valid characters that comprise the date pattern, for
example, MMM for month character, dd for day number, and yyyy for year.
Note

The month character MMM allows you to enter three letters for the month. For
example, enter Jan for January, Feb for February, and so on.

Values for month, day, and year are enclosed in quotation marks.
The default separator is the forward slash character (/).
The information is specific to iconographic languages.
DEFAULT
VALUES
MMM
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 17-51


Chapter
Chapter 17:17:Related
Related topics
topics

SM_GANTT_WEEK_ZM_T_DF

DESCRIPTION
Defines the date format at the top of the Gantt chart for the viewing the week.
VALID
VALUES
MMM/dd/yyyy
Format using a combination of the valid characters that make up the date pattern, for
example, MMM for month character, dd for day number, and yyyy for year.
Note

The month character MMM allows you to enter three letters for the month. For
example, enter Jan for January, Feb for February, and so on.

Values for month, day, and year are enclosed in quotation marks.
The default separator is the forward slash character (/).
The information is specific to iconographic languages.
DEFAULT
VALUES
MMM
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_GANTT_YEAR_ZM_T_DF

DESCRIPTION
Defines the date format at the top of the Gantt chart for viewing the year.
VALID
VALUES
MM/dd/yyyy
Format using a combination of the valid characters that make up the date pattern, for
example, MM for month character, dd for day number, and yyyy for year.
Note

The month character MM allows you to enter the number of the month. For
example, enter 01 for January, 02 for February, and so on.

Values for month, day, and year are enclosed in quotation marks.
The default separator is the forward slash character (/).
The information is specific to iconographic languages.
DEFAULT
VALUES
yyyy

17-52 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
Site preference.

SM_LIMIT_SINGLE_MASTER_SCHEDULE

DESCRIPTION
Limits the schedule to one master schedule.
VALID
VALUES
true
false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_NEW_TASK_DIALOG_CLOSE_ON_FINISH

DESCRIPTION
Determines if the New Task dialog box is closed after the user clicks the Finish button.
VALID
VALUES
True Closes the dialog box.
False Leaves the dialog box open.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
User preference.

SM_PLMXML_EXPORT_SUB_SCHEDULE

DESCRIPTION
Enables exporting of subschedules when exporting a master schedule.
VALID
VALUES
true Exports subschedules with the master schedule.
false Exports the master schedule without the subschedules.
DEFAULT
VALUES
true

PLM00026 11.2 Preferences and Environment Variables Reference 17-53


Chapter
Chapter 17:17:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
Site preference.

SM_PLMXML_IMPORT_EXISTING_SCHEDULE

DESCRIPTION
Allows re-importing a schedule that is already in the system. Set to False to block the
import of the schedule that is already in the system.
VALID
VALUES
True Re-imports the schedule after deleting all of its related data.

False Blocks import operation if the schedule is already present in the system.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_PREVENT_DELETE_STATES

DESCRIPTION
Specifies the states in which schedules and tasks cannot be deleted.
The value of this preference takes precedence over the value of the
SM_ALLOW_INPROCESS_REMOVAL_OF_SUB_SCHEDULE preference
for subschedules. In other words, if a subschedule’s state is one of the
set values of this preference, it cannot be deleted or removed, even if the
SM_ALLOW_INPROCESS_REMOVAL_OF_SUB_SCHEDULE preference is set to
true.

Note

After you change this preference’s value, you must log off and then log on
for it to take effect.

VALID
VALUES
Accepts one or more of the following internal state values:

• in_progress

• complete

• closed

• aborted

17-54 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
System preference.

SM_PREVENT_TASK_START_UPDATE_STATES

DESCRIPTION
Prevents the changing of the start date of the tasks with the specified state.
Note

After you change this preference’s value, you must log off and then log on
for it to take effect.

VALID
VALUES
Accepts one or more of the following internal state values:
• in_progress

• complete

• closed

• aborted

DEFAULT
VALUES
None
DEFAULT
PROTECTION
SCOPE
System preference.

SM_PREVENT_UPDATE_STATES

DESCRIPTION
Locks the schedules and tasks that have the specified states, which prevents updates
to them.
Note

After you change this preference’s value, you must log off and then log on
for it to take effect.

VALID
VALUES
Accepts one or more of the following internal state values:
• in_progress

PLM00026 11.2 Preferences and Environment Variables Reference 17-55


Chapter
Chapter 17:17:Related
Related topics
topics

• complete

• closed

• aborted
DEFAULT
VALUES
None
DEFAULT
PROTECTION
SCOPE
System preference.

SM_PREVENTION_OVERRIDE

DESCRIPTION
Determines if execution updates are allowed despite the value of the
SM_PREVENT_UPDATE_STATES preference.
Note

After you change this preference’s value, you must log off and then log on
for it to take effect.

VALID
VALUES
ALWAYS_ON
Execution data updates are always allowed.

ALWAYS_OFF
Execution data updates are prevented for the states specified by the
SM_PREVENT_UPDATE_STATES preference, but allowed for other states.

Schedule Based
Execution data updates are always allowed if the schedule’s Enable
Execution Override flag is set to on. Otherwise, the setting of the
SM_PREVENT_UPDATE_STATES preference is enforced.
DEFAULT
VALUES
Schedule Based
DEFAULT
PROTECTION
SCOPE
System preference.

SM_PV_FILTER_SHOW_SCHEDULES_ON_EMPTY

DESCRIPTION
Determines if schedule nodes are displayed when no tasks are returned from a
filter-only criteria in the Program View.

17-56 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Note

This preference comes into play when a filter is applied but has no grouping
condition.

VALID
VALUES
true
false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

SM_Run_Data_Inconsistency_Checks

DESCRIPTION
Activates the automatic validation of schedules for data inconsistencies immediately
after loading.
Note

You can set this preference to false to deactivate validation and increase
performance when opening schedules. However, schedule data inconsistencies
are not detected.

VALID
VALUES
true Automatically runs the validation.
false Does not run the validation.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

SM_SCHEDULE_DATE_LINKED_TO_ACTUAL

DESCRIPTION
Link planned and actual schedule dates.
If you select ALWAYS_ON, the planned schedule dates and actual schedule dates are
linked as follows:
• Changing the actual start or finish date changes the scheduled start or finish date.

• Changing the scheduled start or finish date does not change the actual start or
finish date, respectively.

PLM00026 11.2 Preferences and Environment Variables Reference 17-57


Chapter
Chapter 17:17:Related
Related topics
topics

• The Gantt chart always reflects the scheduled start and finish dates, not the actual
start and finish dates.

If this option is selected, the dates default to the scheduled date regardless of how
the system is configured.
If this option is not selected, the actual start and finish dates are set to the configured
default (either today or scheduled) set up by the system administrator.
VALID
VALUES
ALWAYS_ON Enables date linking.
ALWAYS_OFF Disables date linking.
SCHEDULE_BASED Disables date linking unless the schedule Are Dates Linked
option is selected.
DEFAULT
VALUES
SCHEDULE_BASED
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_SCHEDULING_ENGINE_DATE

DESCRIPTION
Sets the default behavior for new schedules determining if they are scheduled from the
start or end date of the schedule.
VALID
VALUES
Start
Finish
DEFAULT
VALUES
Start
DEFAULT
PROTECTION
SCOPE
All.
NOTES
This preference determines the default setting for new schedules.

SM_Structure_Partial_Context

DESCRIPTION
Specifies the load behavior for loading subschedules in a master schedule context.
VALID
VALUES
0 Loads the full schedule, including all of the sub schedules. This value results
in slower loading than other values.

17-58 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

1 Partially loads all subschedules and loads them inline on demand. This value
yields the best performance if there are subschedules. When you insert a
schedule only the schedule summary is inserted. For Costing and EVM, if the
subschedules have not been loaded, the system loads them and continues.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
The values directly affect system performance.

SM_TEMPLATE_DATE

DESCRIPTION
Specifies the start date of schedules created from a template.
VALID
VALUES
true Specifies the start date of the template is used as the start date
of the new schedules created from it. This is the default value.
false Specifies the current date is used as the start date of the new
schedules.
DEFAULT
VALUES
true

SM_TIMESHEET_APPROVE_WORKFLOW

DESCRIPTION
Overrides the default workflow. It uses a customized workflow. If this preference
is not set, the default workflow is used.
VALID
VALUES
The allowed values are names of approval workflows. For example:
TimeSheetApproval
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
The defined workflow is used when the timesheet entries are submitted.
This preference must be added by an administrator to override the default workflows.

PLM00026 11.2 Preferences and Environment Variables Reference 17-59


Chapter
Chapter 17:17:Related
Related topics
topics

SM_TIMESHEET_REVISE_WORKFLOW

DESCRIPTION
Overrides the default workflow. It uses a customized workflow. If this preference
is not set, the default workflow is used.
VALID
VALUES
The allowed values are names of approval workflows. For example:
TimeSheetRevise
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
The defined workflow is used when the timesheet entries are submitted.
This preference must be added by an administrator to override the default workflows.

SM_Use_Milestone_Wizard

DESCRIPTION
Determines whether to launch the New Milestone wizard when you create a milestone.
VALID
VALUES
True
False
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_View_CriticalPath

DESCRIPTION
Sets the default display of critical path.
VALID
VALUES
True Critical path is displayed.
False Critical path is not displayed.
DEFAULT
VALUES
False

17-60 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
This value is set when the user chooses the menu to enable viewing critical path.

SM_WBS_CODE_PREF

DESCRIPTION
Determines whether the work breakdown structure (WBS) code is generated and
validated in schedules.
VALID
VALUES
true WBS code is generated and validated.
false WBS code is not generated nor validated. The user can define any WBS code
without character format restrictions.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

SM_WBS_FORMAT_PREF

DESCRIPTION
Specifies the default work breakdown structure (WBS) format to be used by schedules
when they are created. The format used by the individual schedules can be changed
at the schedule level.
For more information on setting the default format for new schedules, see Schedule
Manager Guide.
VALID
VALUES
The valid values must follow this format:
[?N,?A,?a]{[.,-,/,+][?N,?A,?a]}*
? Whole number representing the minimum character length of a given section.
If no number is provided, then 1 is assumed.
N Whole number.
A Uppercase English alphabet character (A-Z).
a Lowercase English alphabet character (a-z).
. Valid separation character.
- Valid separation character.
/ Valid separation character.

PLM00026 11.2 Preferences and Environment Variables Reference 17-61


Chapter
Chapter 17:17:Related
Related topics
topics

+ Valid separation character.


DEFAULT
VALUES
N.N
DEFAULT
PROTECTION
SCOPE
All.
NOTES
[?N,?A,?a] represents a single section. A minimum of two sections and one separator
must be defined.

SM_WBS_INITIAL_PREF

DESCRIPTION
Specifies the initial starting point for work breakdown structure (WBS) codes, based on
the default WBS format.
For more information on setting the default initial value for new schedules, see
Schedule Manager Guide.
VALID
VALUES
Some examples of valid values include:
1
1.2
2.2
The values must comply with the format.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
All.

SM_WORKFLOW_STATUS_MAP

DESCRIPTION
Defines the workflow status rules mapping between the Workflow Task and Schedule
Task statuses.
VALID
VALUES
workflow-task-status.schedule-task-status
Valid values for workflow-task-status:
• In Process

• Completed

• Late

17-62 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

• Aborted

Valid values for schedule-task-status:


• in_progress

• complete

• late

• aborted
DEFAULT
VALUES
• In Process.in_progress

• Completed.complete

• Late.late

• Aborted.aborted
DEFAULT
PROTECTION
SCOPE
Site preference.

TaskInbox_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of the TaskInbox
business object.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of the
TaskInbox business object.
DEFAULT
VALUES
contents
nd0ScheduleTasks
DEFAULT
PROTECTION
SCOPE
User preference.

TC_deliverable_class_list

DESCRIPTION
Defines the types allowed for the schedule deliverables within Schedule Manager.
Caution

Do not use this preference. Use the ScheduleDeliverableWSOTypes


preference instead.

PLM00026 11.2 Preferences and Environment Variables Reference 17-63


Chapter
Chapter 17:17:Related
Related topics
topics

Note

When adding a type, subtypes are not considered. For example, adding the
Dataset type allows you to use Microsoft Word, Microsoft WordX, and Microsoft
Excel.
However, adding the Item type does not allow you to use the Document
subtype of Item.

VALID
VALUES
The type of internal storage class names for any subtype of (and including)
WorkspaceObject business object.
DEFAULT
VALUES
Dataset
Folder
Form
Item

DEFAULT
PROTECTION
SCOPE
Site preference.

Report Builder preferences

Valid_ReportBuilder_Sources

DESCRIPTION
Specifies all valid sources available to the common reporting framework reporting
engine.
VALID
VALUES
Accepts one or more strings as values. Any invalid string is ignored.
Teamcenter
TcRA
Office Template
Visual Report
DEFAULT
VALUES
Teamcenter
DEFAULT
PROTECTION
SCOPE
Site preference.

17-64 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Enable_ReportBuilder_Reports_By_Source

DESCRIPTION
Specifies the reports displayed in the Tools→Reports→Report Builder Reports
menu.
VALID
VALUES
Accepts one or more strings as values. Any invalid string is ignored.
DEFAULT
VALUES
Teamcenter
TcRA
Office Template
DEFAULT
PROTECTION
SCOPE
Site preference.

Default_Crf_OfficeTemplate_relation

DESCRIPTION
Specifies the relation between the report definition and the associated Microsoft Office
template.
VALID
VALUES
Any valid relation.
DEFAULT
VALUES
IMAN_reference
DEFAULT
PROTECTION
SCOPE
Site preference.

ReportDefinition_ColumnPreferences

DESCRIPTION
Determines which columns are displayed in the Report Builder application. This
preference can also be set by editing column options directly from the interface.
Note

Column widths are defined using the


ReportDefinition_ColumnWidthPreferences preference.

VALID
VALUES
Accepts one or more strings as values. Each string must be one of the following
report definition attributes:
rd_id
rd_name

PLM00026 11.2 Preferences and Environment Variables Reference 17-65


Chapter
Chapter 17:17:Related
Related topics
topics

rd_type
rd_class
rd_state
rd_source
rd_query_source
rd_property_source
owning_group
owning_user
last_mod_date
last_mod_user

DEFAULT
VALUES
rd_id
rd_name
rd_type
rd_class
rd_state
rd_source
rd_query_source
rd_property_source
owning_group
owning_user
last_mod_date
last_mod_user

DEFAULT
PROTECTION
SCOPE
Site preference.

ReportDefinition_ColumnWidthPreferences

DESCRIPTION
Specifies the column width for each column defined in the
ReportDefinition_ColumnPreferences preference.
VALID
VALUES
Accepts 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 ReportDefinition_ColumnPreferences preference, and so on.
DEFAULT
VALUES
20
20
13
17
13
9

17-66 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

17
17
9
9
17
17
17
DEFAULT
PROTECTION
SCOPE
Site preference.

ReportGenerationDlg_ColumnPreferences

DESCRIPTION
Determines which columns are displayed in the Report Generation wizard. This
preference can also be set by editing column options directly from the interface.
Note

Column widths are defined using the


ReportGenerationDlg_ColumnWidthPreferences preference.

VALID
VALUES
Accepts one or more strings as values. Each string must be one of the following
report definition attributes:
rd_id
rd_name
rd_type
rd_class
rd_state
rd_source
rd_query_source
rd_property_source
owning_group
owning_user
last_mod_date
last_mod_user

DEFAULT
VALUES
rd_id
rd_name

DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 17-67


Chapter
Chapter 17:17:Related
Related topics
topics

ReportGenerationDlg_ColumnWidthPreferences

DESCRIPTION
Specifies the column width for each column defined in the
ReportGenerationDlg_ColumnPreferences preference.
VALID
VALUES
Accepts 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 ReportGenerationDlg_ColumnPreferences preference, and so on.
DEFAULT
VALUES
20
20
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_RA_server_parameters

DESCRIPTION
Configures the Teamcenter reporting and analytics (Reporting and Analytics)
parameters at the site level: server host, port, and application name. Use Reporting
and Analytics, powered by eQube, to view, modify, and create reports.
VALID
VALUES
Accepts multiple strings as values in the following format:
Host:application-server-host-name
Port:port-number
Context:application-context
ServletName:eQube-servlet-name
ServiceDashboard:action=url of the Reporting and Analytics dashboard
DEFAULT
VALUES
Host:localhost Port:80 Context:eQube ServletName:eQubeServlet
ServideDashboard:action=Dashboard
DEFAULT
PROTECTION
SCOPE
Site preference.

17-68 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Visual reporting preferences

TC_NX_visual_report_additional_item_types

DESCRIPTION
Specifies the additional item types that appear in the Teamcenter property selection
dialog box of the NX visual reporting client.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid item type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_NX_visual_report_additonal_secondary_object_types

DESCRIPTION
Specifies the additional business object types that appear in the Teamcenter property
selection dialog box of the NX visual reporting client.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid business object
type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 17-69


Chapter 18: Classification Admin preferences

GCS_classify_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1
ICS_allow_deprecated_lovs_on_copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1
ICS_allow_deprecated_lovs_on_update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-2
ICS_allow_min_max_range_override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-2
ICS_allow_remote_parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-3
ICS_allowed_chars_for_class_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-3
ICS_application_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-4
ICS_attribute_displayable_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-4
ICS_attribute_mapping_unit_support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-5
ICS_available_languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-5
ICS_classification_master_site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-6
ICS_classification_site_for . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-6
ICS_copy_classid_pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-7
ICS_display_unformatted_numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-8
ICS_enforce_min_max_constraints_on_copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-8
ICS_enforce_min_max_constraints_on_update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-9
ICS_ico_id_case_sensitive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-9
ICS_import_attribute_find_free_dbindex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-10
ICS_import_attribute_use_dbindex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-10
ICS_import_view_drop_attributes_not_in_class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-10
ICS_mapping_target_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-11
ICS_migrate_classid_pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-12
ICS_new_classid_pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-12
ICS_override_unit_definition_precision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-13
ICS_perform_xmlschema_validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-13
ICS_share_related . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-14
ICS_synchronize_automatically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-14
ICS_synchronize_sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-15
ICS_unit_active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-15
ICS_unit_default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-15
ICS_use_view_attributes_when_moving_icos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-16
ICS_view_selection_order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-16
ICS_web_preferred_jt_image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-17
ICS_web_preferred_unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-17
ICS_web_search_in_unit_system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-18

PLM00026 11.2 Preferences and Environment Variables Reference


Chapter 18: Classification Admin preferences

GCS_classify_type

DESCRIPTION
Determines whether items/item revisions are created and classified for components
with connection points.
Note

Siemens PLM Software recommends you set this preference to ItemRevision.

When assigning connection points to nonclassifying classification objects (ICOs), a


new classified object is created to receive the connection points. To make the target
object a classified resource, the target ICO must classify a newly-created object,
usually an item revision or a similar classified object type. Use this preference to
define the target object’s type.
Note

Siemens PLM Software recommends you set the following preferences to the
same value as this preference:
• MRMClassifyResource

• ICS_classify_new

• ICS_mapping_target_type

VALID
VALUES
Accepts a single string as a value. Must be Item, ItemRevision, or a valid custom
item or item revision type.
DEFAULT
VALUES
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_allow_deprecated_lovs_on_copy

DESCRIPTION
Determines whether users can copy classification objects (ICOs) that use deprecated
LOV values for classification properties.
This preference applies for users performing the following actions in Teamcenter:

PLM00026 11.2 Preferences and Environment Variables Reference 18-1


Chapter
Chapter 18:18:Classification
Classification Admin
Admin preferences
preferences

• Performing a Revise or SaveAs operation on an Item or Item Revision from


anywhere outside Classification.

• Revising product structure that contains the classified objects.

VALID
VALUES
True Allows users to create copies of ICOs that use deprecated LOV values for
classification properties.

False Prevents users from copying ICOs that use deprecated LOV values for
classification properties.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_allow_deprecated_lovs_on_update

DESCRIPTION
Determines whether users can update and save classification objects (ICOs) that use
deprecated LOV values for their classification properties.
VALID
VALUES
True Allows users to use deprecated LOV values for classification properties.

False Requires users to use nondeprecated LOV values for the classification
properties.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_allow_min_max_range_override

DESCRIPTION
Determines whether the system allows Classification Admin to specify values to the
following:

• Class attribute minimum and/or maximum constraints outside the range of


Dictionary attribute minimum and/or maximum constraints.

• View attribute minimum and/or maximum constraints outside the range of Class
attribute minimum and/or maximum constraints.

18-2 Preferences and Environment Variables Reference PLM00026 11.2


Classification Admin preferences

VALID
VALUES
True Allows Classification Admin to specify values.
False Does not allow Classification Admin to specify values.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_allow_remote_parent

DESCRIPTION
Determines whether classes and views can be added under classes that are not
locally owned.
VALID
VALUES
true Classes and views can be added under classes that are not locally owned.
false Classes and views cannot be added under classes that are not locally owned.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_allowed_chars_for_class_id

DESCRIPTION
Specifies the special characters that are permissible in group or class IDs in the
classification hierarchy. By default, you cannot use a space or any of the following
special characters:
|%*:(){}[] \
You can, however, specify a subset of these characters that are permissible using
this preference.
To assist you in converting legacy group or class IDs, you can use the smlutility utility
to find IDs that contain invalid characters.
VALID
VALUES
Accepts any of the special characters either within quotation marks (if you want to
include the space character) or without quotation marks.
For example, if you set the value of this preference to %*, group or class IDs can
contain these two characters, but the others in the list are not permitted. If you set the

PLM00026 11.2 Preferences and Environment Variables Reference 18-3


Chapter
Chapter 18:18:Classification
Classification Admin
Admin preferences
preferences

value of this preference to “{ }”, the two brackets and the space character between
them are permissible in the IDs.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
This preference is not available by default. To use it, you must create it manually.

ICS_application_names

DESCRIPTION
Specifies the application names replacing the Application 1 ... Application 5 labels
for applicability attributes in Classification Admin. These names are then displayed
in a tooltip in the Classification application where you can identify which attributes
must be set for that particular application.
VALID
VALUES
Accepts a list of five strings, each of which is an application name or any other
meaningful string representing the use of the attribute, for example, NX CAM or Part
Family Template.
Note

If you modify the application names in this preference, you must specify all five
of them. If the preference specifies fewer than five names, Teamcenter does
not recognize the preference.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTE
This preference is not delivered with the software by default. You must add it to the
database manually.

ICS_attribute_displayable_properties

DESCRIPTION
Displays the list of attribute properties on classification properties in the Classification
application.
The administrator provides valid dictionary attribute properties and user-defined
properties, for example:
• AttributeID

18-4 Preferences and Environment Variables Reference PLM00026 11.2


Classification Admin preferences

• Name
VALID
VALUES
Accepts strings.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_attribute_mapping_unit_support

DESCRIPTION
Specifies the dataset and item types for which classification unit support, including
optimization, is active when mapping attributes to NX. If you do not set this value,
when you map an attribute whose value is 100,000 mm to an NX attribute, only the
value 100,000 is transferred. If you set this preference for the object type that you
map, and the value is optimized in Teamcenter, the value 0.1 m is transferred to NX.
VALID
VALUES
Accepts a list of valid Teamcenter item types and dataset types. For example:
EDAComAllegro (dataset type)
EDAComPart (item type)
UGMASTER (dataset type)
Mfg0MEResource (item type)
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_available_languages

DESCRIPTION
Determines which languages display in the Alias Names box of the Class Details tab
when users create a class. Users select one language from the list, which determines
the language of the alias name.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid language code.
For example:
cn
de
en
es

PLM00026 11.2 Preferences and Environment Variables Reference 18-5


Chapter
Chapter 18:18:Classification
Classification Admin
Admin preferences
preferences

fr
it
jp
kr
ru
tw
DEFAULT
VALUES
en
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_classification_master_site

DESCRIPTION
Determines whether the current site can perform class modifications requiring access
to all descendents. Set this preference to true at the site you want to be the master site.
A site is the master site for a class or group if all descendants are owned at this
site. (Therefore different parts of the hierarchy can be mastered by different sites.)
You cannot add child classes/groups to parents that are not locally owned. You
must transfer the ownership to the site that is allowed to add children. By tracking
ownership, the master site keeps track of where classes are added locally.
Note

When your classification hierarchy is exchanged between sites using XML or


SML files, rather than Teamcenter Multi-Site Collaboration functionality, the
same change must be applied to all sites.

VALID
VALUES
true The site can perform class modifications requiring access to all descendents.
false The site cannot perform class modifications requiring access to all
descendents.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_classification_site_for

DESCRIPTION
Allows a site that supports Classification to classify workspace objects for other
sites that may not support Classification (for example, a site running Teamcenter
Enterprise). For the current site to be able to classify workspace objects for the other

18-6 Preferences and Environment Variables Reference PLM00026 11.2


Classification Admin preferences

site, the other site (which does not support Classification) must share replicas of the
objects to be classified to the current site. The preference is set on the current site
(which supports Classification) and contains a list of all such sites for which the current
site can classify objects.
For example, site A runs Classification. Site B runs Teamcenter Enterprise and
therefore does not support Classification. At site A, this preference is set as follows:
ICS_classification_site_for = site B
This allows site A to classify objects for site B after those objects are replicated
to site A.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
Multi-Site site.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
This preference is not included in the installation. You must create it.

ICS_copy_classid_pattern

DESCRIPTION
Determines the pattern of a class ID when a class is copied.
All classes in Classification have unique identifiers. When performing a copy of
a class (hierarchy), users must enter a new class ID for all classes to be copied.
These new class IDs can also be automatically generated for one class or for all
classes of a hierarchy. Use this preference to determine the pattern of class IDs when
the classes are copied.
VALID
VALUES
Accepts a single string as a value. Can be any string, used alone or in conjunction
with the following placeholders:
${P} Represents the class ID of the parent class.
${NNN} Represents a three digit numerical sequence. Any number of digits can be
defined.
${CID} Represents the original class ID when a class is copied.
For example, ${CID}${NNN} generates SourceID000, where SourceID is the original
class ID and 000 is the next iterative number.
Another example, ${NNNN} generates 0000, where 00000 is the next iterative number.
Another example, ${P}_${NNN} generates Parent_000, where Parent is the name of
the parent class and 000 is the next iterative number.

PLM00026 11.2 Preferences and Environment Variables Reference 18-7


Chapter
Chapter 18:18:Classification
Classification Admin
Admin preferences
preferences

Another example, ${CID}.new generates SourceID.new, where SourceID is the


original class ID, suffixed by .new.
DEFAULT
VALUES
${CID}${NN}
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_display_unformatted_numbers

DESCRIPTION
Specifies whether Teamcenter shows leading zeros when displaying attribute values.
VALID
VALUES
Accepts the value true or a list of attributes IDs for which the leading zeros should
be shown.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
All.
NOTE
This preference is not delivered with the software by default. You must add it to the
database manually.

ICS_enforce_min_max_constraints_on_copy

DESCRIPTION
Determines whether Classification allows copying existing classification objects (ICOs)
whose property values do not conform to the minimum and/or maximum constraints.
This preference applies for users performing the following actions in Teamcenter:
• Performing a Revise or SaveAs operation on a classified item or item revision
from anywhere outside Classification.

• Revising a product structure that contains the classified objects.


Note

If you revise an item revision but the item is classified, the new item revision
does not contain any classification information so the revise action does not
honor the maximum and minimum constraints.

VALID
VALUES
True Classification does not allow copying existing ICOs whose property values do
not conform to the minimum and/or maximum constraints.

18-8 Preferences and Environment Variables Reference PLM00026 11.2


Classification Admin preferences

False Classification allows copying existing ICOs whose property values do not
conform to the minimum and/or maximum constraints.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_enforce_min_max_constraints_on_update

DESCRIPTION
Determines whether Classification enforces minimum and/or maximum constraints
on all classification property values during updating and saving classification objects
(ICOs).
VALID
VALUES
True Enforces minimum and/or maximum constraints on all classification property
values when updating and saving ICOs.

False Does not enforce minimum and/or maximum constraints on all classification
property values when updating and saving ICOs.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_ico_id_case_sensitive

DESCRIPTION
Determines whether the classification object (ICO) ID is case sensitive. Set this
preference to prevent the creation of IDs that have the same characters but different
case, such as Abc and ABC.
VALID
VALUES
true The classification object ID is case sensitive.

false The classification object ID is not case sensitive.


DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 18-9


Chapter
Chapter 18:18:Classification
Classification Admin
Admin preferences
preferences

ICS_import_attribute_find_free_dbindex

DESCRIPTION
Specifies that Teamcenter should find the next free dbindex position in the database if
the specified dbindex position is already in use when importing Classification Admin
data using PLM XML or XML data.
This preference is only evaluated if the ICS_import_attribute_use_dbindex
preference is set.
VALID
VALUES
True Teamcenter tries to find the next dbindex position when importing data.
False If the specified dbindex position is in use, Teamcenter displays an error.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
If this preference does not exist in the database, Teamcenter uses the default value
of False.

ICS_import_attribute_use_dbindex

DESCRIPTION
Specifies the use of the dbindex position in the database when importing Classification
Admin data.
When you import PLM XML or XML data in Classification Admin, the dbindex position
is used. To disable this, set this preference to False.
VALID
VALUES
True Teamcenter uses the dbindex position when importing data.
False Teamcenter ignores dbindex position when importing data.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_import_view_drop_attributes_not_in_class

DESCRIPTION
Enables the PLM XML import of views to continue when the operation encounters an
attribute not contained in the parent class.

18-10 Preferences and Environment Variables Reference PLM00026 11.2


Classification Admin preferences

VALID
VALUES
True The attribute is ignored and the import continues.
False Teamcenter aborts the import upon encountering an attribute that is not
contained in the parent class.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
All.

ICS_mapping_target_type

DESCRIPTION
Determines whether the mapping target item or item revision is classified.
Note

Siemens PLM Software recommends you set this preference to ItemRevision.

You can map classification objects (ICOs) from one class of your class structure to
another as needed, such as when converting catalog data to customer data. To make
the target object a classified resource, the target ICO must classify a newly created
object, usually an item revision or a similar classified object type. Use this preference
to define the target object’s type.
For more information, see Classification.
Note

Siemens PLM Software recommends you set the following preferences to the
same value as this preference:
• MRMClassifyResource

• ICS_classify_new

• GCS_classify_type

VALID
VALUES
Accepts a single string as a value. Must be Item, ItemRevision, or a valid custom
item or item revision type.
DEFAULT
VALUES
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 18-11


Chapter
Chapter 18:18:Classification
Classification Admin
Admin preferences
preferences

ICS_migrate_classid_pattern

DESCRIPTION
Determines the pattern of a class ID when migrating legacy SML subclasses to
abstract subclasses and storage classes.
All classes in Classification have unique identifiers. When SML subclasses are
migrated, a new abstract class is created for each SML class and a storage class is
created directly below the new abstract class for each subclass belonging to the SML
class being migrated. Use this preference to determine the pattern of the class IDs
when subclasses are migrated.
VALID
VALUES
Accepts a single string as a value. Can be any string, used alone or in conjunction
with the following placeholders:
${P} Represents the class ID of the parent class.
${NNN} Represents a three digit numerical sequence. Any number of digits can be
defined.
${CID} Represents the original class ID when a class is migrated.
${SID} Represents the original class ID of the SML subclass being migrated.
For example, ${CID}${SID}${NNN} generates SMLClassIDSubclassID000, where
SMLClassID is the original class ID, SubclassID is the original class ID of the SML
subclass being migrated and 000 is the next iterative number.
Another example, ${NNNN} generates 0000, where 00000 is the next iterative number.
Another example, ${SID}_${NNN} generates SubclassID_000, where SubclassID is
the original class ID of the SML subclass being migrated and 000 is the next iterative
number.
DEFAULT
VALUES
${CID}${SID}${NN}
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_new_classid_pattern

DESCRIPTION
Determines the pattern of the class ID when a new class is created.
All classes in Classification have unique identifiers. Use this preference to determine
the pattern of the class ID when a new class is created.
VALID
VALUES
Accepts a single string as a value. Can be any string, used alone or in conjunction
with the following placeholders:
${P} Represents the class ID of the parent class.

18-12 Preferences and Environment Variables Reference PLM00026 11.2


Classification Admin preferences

${NNN} Represents a three digit numerical sequence. Any number of digits can be
defined.
For example, ${P}${NNN} generates Parent000, where Parent is the name of the
parent class, and 000 is the next iterative number.
Another example, ${NNNNNN} generates 000000, where 000000 is the next iterative
number.
Another example, ${P}.new generates Parent.new, where Parent is the name of the
parent class, suffixed by .new.
DEFAULT
VALUES
${P}${NN}
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_override_unit_definition_precision

DESCRIPTION
Specifies whether Teamcenter overrides the precision defined in the Decimal Places
attribute in the unit definition ICO while displaying the attribute value of the attributes
for which optimized display is turned on.
VALID
VALUES
true Teamcenter overrides the number of decimal places specified in the unit
definition.
false Teamcenter displays the number of decimal places specified in the unit
definition.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
All.

ICS_perform_xmlschema_validation

DESCRIPTION
Activates schema validation during a classification XML import operation. Set this to
false if you run Teamcenter on the Solaris platform.
VALID
VALUES
Accepts one of the following values:
true Schema validation takes place during the XML import operation.
false Schema validation is ignored during XML import operation.

PLM00026 11.2 Preferences and Environment Variables Reference 18-13


Chapter
Chapter 18:18:Classification
Classification Admin
Admin preferences
preferences

DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_share_related

DESCRIPTION
Determines which related objects of a Classification class/view are shared when the
class/view is shared. Use this preference with shared Classification functionality.
VALID
VALUES
Accepts one or more of the following values:

classImage Shares class images.

viewImage Shares view images.

partFamilyTemplates Shares part family templates.


DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_synchronize_automatically

DESCRIPTION
Enables automatic synchronization of Classification data to the sites specified in the
ICS_synchronize_sites preference.
VALID
VALUES
0 Classification hierarchy data is not shared to the selected sites whenever
the data is saved.

1 Classification hierarchy data is automatically shared to the selected sites


whenever the data is saved.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

18-14 Preferences and Environment Variables Reference PLM00026 11.2


Classification Admin preferences

ICS_synchronize_sites

DESCRIPTION
Specifies the sites with which Classification data can be shared with Multi-Site
Collaboration. The sites specified in this preference appear in the Shared Sites dialog
box in the Class Details pane in Classification Admin.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter site name.
Site names must be entered into the database in a Organization/Sites format.
For more information about creating Teamcenter sites, see Multi-Site Collaboration
and Organization.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_unit_active

DESCRIPTION
Specifies the active system of measurement that is initially displayed when a
classification class is defined to hold both metric and nonmetric values.
VALID
VALUES
0 Metric system of measurement.
1 Nonmetric system of measurement.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_unit_default

DESCRIPTION
Specifies the default system of measurement when creating a class in the
Classification Admin application.
VALID
VALUES
0 Metric system of measurement.
1 Nonmetric system of measurement.
2 Both metric and nonmetric systems of measurement.

PLM00026 11.2 Preferences and Environment Variables Reference 18-15


Chapter
Chapter 18:18:Classification
Classification Admin
Admin preferences
preferences

DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_use_view_attributes_when_moving_icos

DESCRIPTION
Determines which attribute values are set when an classification object (ICO) is moved
to a different class. Use this site preference to set only the attribute values visible to
the user, or to set all attribute values, during ICO moves.
Moving classes in Classification is similar to copying classes, but is performed via
drag-and-drop from the Classification hierarchy tree. A user can move classes when
the class is not shared, he has read access to all children of the class, and the new
parent class is locally owned.
VALID
VALUES
true Only attribute values which the current user can see in his view are set when
an ICO is moved to a different class.

false All attribute values are set when an ICO is moved to a different class.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_view_selection_order

DESCRIPTION
Determines the order in which Classification views are searched, based on the current
user ID.
VALID
VALUES
Accepts the following strings as values. The order of the values determines the order
in which the views are searched.

USER

PROJECT

ROLE

GROUP

18-16 Preferences and Environment Variables Reference PLM00026 11.2


Classification Admin preferences

DEFAULT
VALUES
USER
PROJECT
ROLE
GROUP
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_web_preferred_jt_image

DESCRIPTION
Determines which JT image is displayed in the Classification thin client when users
select TcVis from the View menu. Use this preference to determine which image
(single JT or JTs of BOM lines) displays when the classification objects contains both a
single JT image and is a BOM assembly with JTs in the BOM lines.
Note

When the classification object contains only one image, the JT displays as
follows:

• When the classified object contains a single JT file (as a direct model dataset)
the JT file appears.
• When the classified object is a BOM assembly, the JTs of the BOM lines display.

VALID
VALUES
BOM_Assembly Displays BOM assembly JTs.

Single_JT Displays single JT.


DEFAULT
VALUES
BOM_Assembly
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_web_preferred_unit

DESCRIPTION
Specifies the unit system in which to display a selected classification object (ICO) in
the Classification thin client application.
VALID
VALUES
metric Displays an ICO in the metric system.

non-metric Displays an ICO in a nonmetric system.

PLM00026 11.2 Preferences and Environment Variables Reference 18-17


Chapter
Chapter 18:18:Classification
Classification Admin
Admin preferences
preferences

DEFAULT
VALUES
None.
Note

If this preference is not defined, Teamcenter displays ICOs in the unit system of
measurement associated with the class. If the class is configured to use both
unit systems of measurement, the ICOs are initially displayed in the metric
unit system of measurement.

DEFAULT
PROTECTION
SCOPE
User preference.

ICS_web_search_in_unit_system

DESCRIPTION
Specifies the unit system when searching for classification objects (ICOs) in the
Classification thin client application.
VALID
VALUES
metric Search in the metric system only.
non-metric Search in the nonmetric system only.
both Search in both the metric and nonmetric systems, with switching
enabled in the Query tab.
DEFAULT
VALUES
None.
Note

If this preference is not defined, Teamcenter uses the value specified by the
ICS_web_preferred_unit preference.

DEFAULT
PROTECTION
SCOPE
User preference.

18-18 Preferences and Environment Variables Reference PLM00026 11.2


Chapter 19: Classification preferences

g4mViewerConfig.VIEWERCONFIG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-1
g4m<Key>.VIEWERCONFIGTOLOAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-2
ICS_array_attribute_value_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-3
ICS_attribute_mapping_trim_zeros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-3
ICS_classify_immediately . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-4
ICS_classify_new . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-4
ICS_classify_sendto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-5
ICS_classifiable_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-5
ICS_datasettype_for_class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-6
ICS_default_instance_document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-7
ICS_default_class_document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-7
ICS_default_root_selector_entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-8
ICS_enable_graphical_browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-9
ICS_force_mandatory_attribute_check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-9
ICS_GraphicsBuilder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-9
ICS_hierarchy_sort_option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-10
ICS_ico_action_after_saveas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-10
ICS_itemrev_master_dataset_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-11
ICS_master_datasettypes_for_itemrev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-11
ICS_max_number_of_components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-12
ICS_presented_class_documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-12
ICS_presented_instance_documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-13
ICS_root_selector_entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-14
ICS_search_default_revision_rule_<application name> . . . . . . . . . . . . . . . . . . . . . . . . . . 19-14
ICS_search_filter_by_read_access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-15
ICS_search_use_revision_rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-16
ICS_show_autofilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-16
ICS_show_ico_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-16
ICS_table_header_style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-17
ICS_table_pagesize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-17
ICS_use_access_control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-17
ICS_user_defined_button_class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-18
MRMClassifyResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-18
NXGraphicsBuilder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-19

PLM00026 11.2 Preferences and Environment Variables Reference


Chapter 19: Classification preferences

g4mViewerConfig.VIEWERCONFIG

DESCRIPTION
Specifies an alternate Viewer view configuration to use for the Classification (g4m)
application, and is used in place of the <viewer_config_id>.VIEWERCONFIG
preference. This preference defines which Generic Relationship Management (GRM)
rules to expand for the Classification application only.
The Classification application provides a key to Teamcenter Services so that it can use
the g4m<Key>.VIEWERCONFIGTOLOAD preference to load the viewer configuration
set in this preference.
VALID
VALUES
• teamcenter-type.viewer-ID=named-references
Indicates the viewer to use for each Teamcenter type.

• SEARCHORDER.ITEMREV2DATASET=GRMs-list
Specifies the Generic Relationship Management rules (GRMs) to expand from
item revision to dataset.

• 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
Item.DefaultViewer
ItemRevision.DefaultViewer
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

PLM00026 11.2 Preferences and Environment Variables Reference 19-1


Chapter
Chapter 19:19:Classification
Classification preferences
preferences

MSPowerPointX.MSPowerPointXViewer=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
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
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
EPMJob.ProcessViewer
RequestObject.RequestObjectViewer
AppInterface.AppInterfaceViewer
Cba0PartProxy.PartProxyViewer
Part Revision.PartViewer=JTPART,Text
DrawingSheetProxy.DrawingViewer=Image
Drawing.DrawingViewer

DEFAULT
PROTECTION
SCOPE
Site preference.

g4m<Key>.VIEWERCONFIGTOLOAD

DESCRIPTION
Defines the Viewer view configuration to load when a Classification (g4m) key
is provided to Teamcenter Services. This preference points to a Classification
g4m<viewer_config_id>.VIEWERCONFIG preference name.
Note

This is an internal-only preference used by Classification, and currently there


is no way for customers to define their own key and pass it to the Teamcenter
Services for use by a viewer configuration preference. Customers must use
the Viewer.VIEWERCONFIGTOLOAD preference instead to load a custom
viewer configuration.

VALID
VALUES
Use any already defined Classification (g4m) preference name in this format:
g4mviewer-config-id.VIEWERCONFIG

19-2 Preferences and Environment Variables Reference PLM00026 11.2


Classification preferences

DEFAULT
VALUES
g4mViewerConfig.VIEWERCONFIG
Tip

To ensure that the classification viewers display the same attachments


as the Teamcenter viewer, you can set the value of this preference to
defaultViewerConfig.VIEWERCONFIG.

DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_array_attribute_value_separator

DESCRIPTION
Defines a separator used when listing the values of a variable length array attribute in
the results table in Classification and Resource Manager.
For more information about enabling applicable attributes, see Classification.
VALID
VALUES
Accepts a single character as a value.
DEFAULT
VALUES
,
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_attribute_mapping_trim_zeros

DESCRIPTION
Determines whether, during attribute mapping between NX and Classification, leading
and/or trailing zeros are stripped from Classification attribute values when they are
sent to NX.
VALID
VALUES
keep Does not change the Classification attribute value. For example,
001.3400 is transferred as 001.3400 to NX.
leading Leading zeros are stripped from the Classification attribute
value. For example, 001.3400 is transferred as 1.3400 to NX.
both Leading and trailing zeros are stripped from the Classification
attribute value. For example, 001.3400 is transferred as 1.34
to NX.
DEFAULT
VALUES
keep

PLM00026 11.2 Preferences and Environment Variables Reference 19-3


Chapter
Chapter 19:19:Classification
Classification preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

ICS_classify_immediately

DESCRIPTION
Determines the default setting of the Classify Immediately option in the New
Item, Save As, and Revise dialog boxes. This preference is valid only when the
ICS_classify_new preference is set.
VALID
VALUES
0 The Classify Immediately option is not selected by default when the dialog
box appears.
1 The Classify Immediately option is selected by default when the dialog box
appears.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_classify_new

DESCRIPTION
Enables the Classify Immediately option in the New Item, Save As, and Revise
dialog boxes, and specifies whether it is the item or the item revision that is
classified. The Classify Immediately option is displayed only if the item type that
you create is listed in the ICS_classifiable_types preference. When you specify
Item or ItemRevision, this is valid for all the item or revision types listed in the
ICS_classifiable_types preference.
VALID
VALUES
Item Immediately classifies the item.
ItemRevision Immediately classifies the item revision.
DEFAULT
VALUES
ItemRevision
DEFAULT
PROTECTION
SCOPE
User preference.

19-4 Preferences and Environment Variables Reference PLM00026 11.2


Classification preferences

ICS_classify_sendto

DESCRIPTION
Controls which of the available applications are displayed when you use the Send To
command in Classification and Resource Manager.
VALID
VALUES
Accepts a list of strings as values. Each string must be a valid Teamcenter application
ID or application name.
DEFAULT
VALUES
com.teamcenter.rac.ui.perspectives.navigatorPerspective
com.teamcenter.rac.pse.PSEApplication
com.teamcenter.rac.designcontext.DesignContextApplication
com.teamcenter.rac.cme.mrm.MRMApplication
com.teamcenter.rac.classification.icm.ICMApplication
com.teamcenter.rac.cme.fse.FSEApplication
com.teamcenter.rac.cme.pmp.PMPApplication
com.teamcenter.rac.cme.mpp.MPPApplication
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_classifiable_types

DESCRIPTION
Specifies the list of Teamcenter types that can be classified. If you create new child
business objects or new business objects and want to be able to classify them, you
must add their names to this preference.
VALID
VALUES
Valid Teamcenter types. The two default values, Item and ItemRevision, are
considered a set. Therefore, if the item is classified the item revision cannot be
classified, but it inherits the classification record from the item. This also works in the
reverse; if the item revision is classified, the item cannot be classified, but inherits
the classification record.
Any types defined for the following preferences should be also defined for this
preference:
• MRMClassifyResource

• ICS_classify_new

• GCS_classify_type
DEFAULT
VALUES
Item
ItemRevision
Mfg0MEResource

PLM00026 11.2 Preferences and Environment Variables Reference 19-5


Chapter
Chapter 19:19:Classification
Classification preferences
preferences

Mfg0MEResourceRevision
Mfg0MEEquipment
Mfg0MEEquipmentRevision
Mfg0MENCMachine
Mfg0MENCMachineRevision
Mfg0MENCTool
Mfg0MENCToolRevision
MENCMachining
MENCMachining Revision
CPMarketingBrief
CPMarketingBriefRevision
CPThemeBoard
CPThemeBoardRevision
CommercialPart
CommercialPart Revision
ManufacturerPart
ManufacturerPart Revision
PSSignal
PSSignal Revision
Signal
SignalRevision
Message
MessageRevision
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
The values listed must be the internal business object names and not the display
names. You can find the internal language-independent names in the Business
Modeler IDE application.

ICS_datasettype_for_class

DESCRIPTION
Specifies the type of dataset used when images are added to subclasses.
VALID
VALUES
A valid Teamcenter dataset.
DEFAULT
VALUES
UGPART
DEFAULT
PROTECTION
SCOPE
All.

19-6 Preferences and Environment Variables Reference PLM00026 11.2


Classification preferences

ICS_default_instance_document

DESCRIPTION
Determines which of the named reference file types defined in the
ICS_presented_instance_documents preference displays in the instance viewer by
default. Limiting the values defined in this preference can quicken viewing time. For
example, by not specifying BOMAssembly object in this preference, BOM assemblies
have to be expressly selected to appear. This saves users time when paging through
classification objects of large assemblies. When none of the document types defined
in this preference are associated with a classification object, the instance viewer
displays no attachment by default.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid named reference
file type that has been defined in the ICS_presented_instance_documents
preference.
DEFAULT
VALUES
JTPART
Image
Markup
3DModel
3DMarkup
JPEG
Graphics-Interface
Shaded-Image
Common-Graphics-Meta
Direct-Model-Data
UGPART
word
JPEG_Reference
GIF_Reference
DEFAULT
PROTECTION
SCOPE
All.

ICS_default_class_document

DESCRIPTION
Determines which of the documents defined in the ICS_presented_class_documents
preference display by default.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid named reference
file type that has been defined in the ICS_presented_class_documents preference.
DEFAULT
VALUES
ICS-ClassImage
ICS-ClassImage1

PLM00026 11.2 Preferences and Environment Variables Reference 19-7


Chapter
Chapter 19:19:Classification
Classification preferences
preferences

ICS-ClassImage2
ICS-ClassImage3
ICS-ClassImage4
ICS-ClassImage5
ICS-ClassImage6
ICS-ClassImage7
ICS-ClassImage8
ICS-ClassImage9
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_default_root_selector_entries

DESCRIPTION
Determines which classes display in the root node selection list. By default, this list
displays only Classification Root.
Use this preference to allow users to select a class to become the root node of their
Classification hierarchy from a predefined list. Users access this list by clicking in
the title bar of the hierarchy pane. The root node selection list appears. If your site has
a very complex classification hierarchy, use this preference to allow users to select any
point in the hierarchy to be their root node. You can store any number of classes in the
options list to change the hierarchy root node.
For more information about viewing a subset of your site's hierarchy, see Classification.
Note

Users can add additional classes to this list using the Add Current Class
command, which modifies the ICS_root_selector_entries preference.

VALID
VALUES
Accepts multiple string pairs as values. Each string pair must be in the following format:
Class ID
Description
DEFAULT
VALUES
ICM
Classification Root
DEFAULT
PROTECTION
SCOPE
Site preference.

19-8 Preferences and Environment Variables Reference PLM00026 11.2


Classification preferences

ICS_enable_graphical_browser

DESCRIPTION
Enables the Graphical Browser tab in Classification and the Classification Search
Dialog. You can browse through the classification hierarchy by viewing thumbnail
graphics representing each class.
For more information about using the graphical browser, see Classification.
VALID
VALUES
true Makes the graphical browser tab visible in the hierarchy pane.
false Removes the Graphical Browser tab from the user interface.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_force_mandatory_attribute_check

DESCRIPTION
Activates a check that all mandatory attributes contain values during the creation of
any Classification object (ICO).
This preference is used for all situations that do not involved user interface interaction
(both rich and thin client). For activities performed in the user interface, the preference
is ignored.
For more information, see Classification.
VALID
VALUES
true Classification checks that all mandatory attributes contain values when
you save or create a Classification object using any method.
false Classification does not check that mandatory attributes contain values
when you save or create a Classification object.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_GraphicsBuilder

DESCRIPTION
Specifies the name of the preference that points to the graphics builder utility that is
used by Classification to enable the graphic creation functionality in the Classification
application.

PLM00026 11.2 Preferences and Environment Variables Reference 19-9


Chapter
Chapter 19:19:Classification
Classification preferences
preferences

For more information, see Classification Administration.


VALID
VALUES
Accepts a list of preferences that point to the associated graphics builder utility.
DEFAULT
VALUES
NXGraphicsBuilder
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_hierarchy_sort_option

DESCRIPTION
Determines how the classification hierarchy tree is sorted and displayed. The tree
is sorted and displayed alphanumerically in ascending order based on the value
assigned.
VALID
VALUES
-600 Class ID/subclass ID. Groups are treated as classes.
-607 Name.
-612 User1.
-613 User2.
DEFAULT
VALUES
-600
DEFAULT
PROTECTION
SCOPE
All.

ICS_ico_action_after_saveas

DESCRIPTION
Determines the action to be taken when users use the Copy, Revise, or Save As
commands on a classified object.
When users use the Copy, Revise, or Save As commands on a workspace object, the
GRM relations are copied to the new object. Therefore, when the object is a classified
object, the IMAN_classification relation is copied to the new object, resulting in a
situation where two objects (the object created by the Copy, Revise, or Save As
command and the original object) reference the same classification record.
Set this preference to delete to avoid this situation.
VALID
VALUES
copy Creates a copy of the original classification record with a resource ID
matching the ID of the new object, thus classifying the new object.

19-10 Preferences and Environment Variables Reference PLM00026 11.2


Classification preferences

delete Deletes the IMAN_classification relation between the new object and the
classification record of the original object. The new object can then be
classified using standard Classification procedures.
DEFAULT
VALUES
copy
DEFAULT
PROTECTION
SCOPE
All.

ICS_itemrev_master_dataset_relation

DESCRIPTION
Specifies the relationship between the item revision and the dataset type that is
defined in the ICS_master_datasettypes_for_itemrev preference.
VALID
VALUES
Valid Teamcenter datasets.
DEFAULT
VALUES
IMAN_specification
DEFAULT
PROTECTION
SCOPE
All.

ICS_master_datasettypes_for_itemrev

DESCRIPTION
Specifies the dataset types that can be classified, when used in conjunction with
the ICS_classifiable_types preference. For example, if Dataset is included as
a classifiable type in the ICS_classifiable_types preference and UGMASTER is
included as a value for the ICS_master_datasettypes_for_itemrev preference,
item/item revision/UGMASTER are considered a set and the following configuration
rules apply:
• If the item is classified, the item revisions and corresponding dataset cannot be
classified, but they inherit the classification record from the item.
• If an item revision is classified, the corresponding dataset and item cannot be
classified. Other revisions of the same item can, however, be classified.
• If the dataset is classified, the corresponding item revision and item cannot be
classified. Other revisions and datasets, however, can be classified.

VALID
VALUES
Valid Teamcenter relation.
DEFAULT
VALUES
UGMASTER

PLM00026 11.2 Preferences and Environment Variables Reference 19-11


Chapter
Chapter 19:19:Classification
Classification preferences
preferences

DEFAULT
PROTECTION
SCOPE
All.

ICS_max_number_of_components

DESCRIPTION
Determines the maximum number of components an assembly can contain before
a warning appears. When the selected assembly (typically a resource assembly)
contains more than the defined number of components, the warning states the selected
assembly is large and requires the user to confirm loading the assembly. The user can
click Yes to display the assembly, or No to not display the assembly. If set to 0 or left
undefined, assemblies are always displayed, regardless of size, without warning.
VALID
VALUES
0 All assemblies are always displayed, with no warning regarding
assembly size.
Single positive If assembly has less components than the number defined, no
integer warning appears when displaying the assembly. If assembly has
more components than the number defined, a warning appears:
The assembly contains more than # components.
Do you really want to show it?
DEFAULT
VALUES
100
DEFAULT
PROTECTION
SCOPE
All.

ICS_presented_class_documents

DESCRIPTION
Determines which named references display in the class viewer. The system searches
all datasets of the selected class for named references. Any named references
corresponding to the values of this preference display as a tab in the class viewer.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid named reference.
DEFAULT
VALUES
ICS-ClassImage
ICS-ClassImage1
ICS-ClassImage2
ICS-ClassImage3
ICS-ClassImage4
ICS-ClassImage5
ICS-ClassImage6
ICS-ClassImage7

19-12 Preferences and Environment Variables Reference PLM00026 11.2


Classification preferences

ICS-ClassImage8
ICS-ClassImage9
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_presented_instance_documents

DESCRIPTION
Determines which named references display in the instance viewer. The system
searches all datasets of the selected object for named references. Any named
references corresponding to the values of this preference display as a tab in the
instance viewer.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid named reference,
or one of the following values:
BOMAssembly
JTAssembly
DEFAULT
VALUES
BOMAssembly
JTAssembly
JTPART
Image
Markup
3DModel
3DMarkup
JPEG
Graphics-Interface
Shaded-Image
Common-Graphics-Meta
Direct-Model-Data
UGPART
HTML
word
excel
PDF
PDF_Reference
JPEG_Reference
GIF_Reference
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 19-13


Chapter
Chapter 19:19:Classification
Classification preferences
preferences

ICS_root_selector_entries

DESCRIPTION
Determines the class and description text for the classes that users have selected
to display in the root node selection list.
Typically, this preference is populated by users selecting a class, then selecting the
Add Current Class command from the Option menu in the Classification application.
The system prompts users for a description of the selected class. By default, the
descriptive text is the class name. The user's selections are added as values to this
preference.
This preference can also be modified by users right-clicking a class and choosing the
Add current class to root selector option on the shortcut menu.
VALID
VALUES
Accepts multiple string pairs as values. Each string pair must be in the following format:
Class ID
Description
For example:
ICM
Classification Root
MRM
Resource Management
TLCAC
Catalog Components
TLCUC
Customer Components
TLCUA
Customer Assemblies

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_search_default_revision_rule_<application name>

DESCRIPTION
Specifies the default revision rule used for a classification search.
Users can select revision rules to apply to classification searches from the
Classification application and from the Classification Search Dialog in other
applications. Users can select a default revision rule for searches (and thus, set this
preference from the interface) by clicking to the right of the Revision Rule link to
display the revision rule shortcut menu, then choosing Save as default.

19-14 Preferences and Environment Variables Reference PLM00026 11.2


Classification preferences

VALID
VALUES
Accepts a single string as a value. It must be a valid revision rule. The suffix of the
preference name indicates the application for which this functionality is enabled. Thus,
the Classification suffix determines the default revision rule for searches performed in
the Classification application, the Resource_Manager suffix determines the default
revision rule for searches performed using the Classification dialog box in the
Resource Manager application, and so on. For example:
ICS_search_default_revision_rule_Classification=
Latest Working

Note

The suffix is dependent on the user's language setting. The name of the
application must be written in the language setting used by the user. If a user's
language setting is German, the example would be:
ICS_search_default_revision_rule_Klassifizierung=
Latest Working

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_search_filter_by_read_access

DESCRIPTION
Specifies whether the classification search filters out the ICOs for which the user does
not have read access on the classified object while performing the search. Privileges
on the class definition are not honored when this preference is set.

Caution

Setting this preference to true has a negative performance impact on the


search mechanism.

VALID
VALUES
true The classification search returns only those ICOs for which the user has read
access.

false The classification search returns all ICOs. When paging through the results,
the user receives a message each time an ICO is reached for which there is
no read access.
DEFAULT
VALUES
false

PLM00026 11.2 Preferences and Environment Variables Reference 19-15


Chapter
Chapter 19:19:Classification
Classification preferences
preferences

DEFAULT
PROTECTION
SCOPE
System preference.

ICS_search_use_revision_rule

DESCRIPTION
Determines whether revision rules can be used for a classification search.
VALID
VALUES
true Enables revision rules functionality for classification searches.

false Disables revision rules functionality for classification searches.


DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

ICS_show_autofilter

DESCRIPTION
Determines whether auto filter functionality is enabled in Classification.
VALID
VALUES
true Auto filter functionality is enabled in Classification. The Auto filter button
displays before the text fields of attributes.

false Auto filter functionality is not enabled in Classification.


DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_show_ico_id

DESCRIPTION
Displays the internal ICO ID. Use this if your company has workflow that requires the
ICO ID and not the workspace object ID or alternate ID that is displayed by default.
VALID
VALUES
0 Teamcenter displays the workspace object ID or the alternate ID as the ICO ID.

1 Teamcenter displays the internal ICO ID.

19-16 Preferences and Environment Variables Reference PLM00026 11.2


Classification preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
This preference is not delivered with the software. You must add it manually.

ICS_table_header_style

DESCRIPTION
Controls the display of attribute names in the table page header.
VALID
VALUES
Short Displays abbreviated attribute names.
Long Displays the full attribute name.
DEFAULT
VALUES
Short
DEFAULT
PROTECTION
SCOPE
All.

ICS_table_pagesize

DESCRIPTION
Determines the number of rows (instances) initially displayed in the Classification table
page in the thin client.
VALID
VALUES
A positive integer.
DEFAULT
VALUES
5
DEFAULT
PROTECTION
SCOPE
All.

ICS_use_access_control

DESCRIPTION
Determines the availability of the Classification access control feature.
VALID
VALUES
0 Disables access control functionality.
1 Enables access control functionality.

PLM00026 11.2 Preferences and Environment Variables Reference 19-17


Chapter
Chapter 19:19:Classification
Classification preferences
preferences

DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

ICS_user_defined_button_class

DESCRIPTION
Determines where the system searches for the user-defined button classes in the
Classification and Resource Manager applications.
For more information about user-defined button classes, see Classification
Administration.
VALID
VALUES
USER1 System searches in the User 1 field of the attribute in the dictionary, class,
and view for the Java class defined for the user-defined button.
USER2 System searches in the User 2 field of the attribute in the dictionary, class,
and view for the Java class defined for the user-defined button.
DEFAULT
VALUES
None.
If left undefined, the system uses the settings in the registry (property file) to determine
the Java class for the user-defined button.
DEFAULT
PROTECTION
SCOPE
Site preference.

MRMClassifyResource

DESCRIPTION
Determines whether new items and item revisions are classified at the time they are
created using the File→New→Resource menu command.
Note

Regardless of this preference's settings, existing objects can still be classified


using the Classify Item and Classify Item Revision menu commands.

VALID
VALUES
Accepts a single string as a value. The string must be either Item or ItemRevision.
Note

Siemens PLM Software recommends classifying item revisions during creation,


otherwise some functionality (revisioning, propagated attributes, statuses) is
limited.

19-18 Preferences and Environment Variables Reference PLM00026 11.2


Classification preferences

DEFAULT
VALUES
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

NXGraphicsBuilder

DESCRIPTION
Specifies the path to the NX graphics builder utility used by Classification to enable the
graphic creation functionality in the Classification application.
For more information, see Classification Administration.
VALID
VALUES
Accepts a list of options and values as follows:
ActivationMethod
Specifies the activation method for the graphics builder executable. This is
normally set to TCE_Activation.
You must set this option.
CommandLine
Specifies the path to the graphics builder executable script,
start_nx_graphicsbuilder.bat, typically located in the
Teamcenter_root\bin\nx_graph directory. The path to the graphics builder batch
file included with the software by default is set by the installation procedure.
You must set this option.
ScriptEvaluationPath
Specifies the path to the directory containing the ics_graphicsbuilder.tcl file.
This option is optional.
evaluateScript
Specifies whether to perform script evaluation of newly created classes. Valid
values are yes, no, and not set.
This option is optional.
evaluateScriptWhenNotSet
Permits graphics builder to evaluate TCL scripts even when TCL script evaluation
is defined as not set for the Classification object's class.
This option is optional.
DEFAULT
VALUES
ActivationMethod:TCE_Activation
CommandLine:path-to-graphics-builder-executable-script
\start_nx_graphicsbuilder.bat

PLM00026 11.2 Preferences and Environment Variables Reference 19-19


Chapter
Chapter 19:19:Classification
Classification preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

19-20 Preferences and Environment Variables Reference PLM00026 11.2


Chapter 20: Data sharing preferences

Data sharing preference value updates during upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1

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


Role-based preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1
TC_always_exclude_dataset_files_on_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1
TC_bom_level_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-2
TC_dataset_vers_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-2
TC_modified_only_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-2
TC_ownership_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-3
TC_relation_export_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-3
TC_sync_auto_synchronize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-4
Baseline_auto_remote_checkout_allowed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-5
HUB_no_export_record_transfer_site_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-6
IDSM_Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-6
IDSM_Compression_Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-6
IDSM_do_not_resend_up_to_date_file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-7
IDSM_dsa_sites_permitted_to_push_admin_data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-8
IDSM_dsa_notification_email_address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-8
IDSM_exclude_unpublished_components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-8
IDSM_ft_buffer_kb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-9
IDSM_ft_client_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-9
IDSM_ft_get_port_number_from_services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-10
IDSM_ft_port_number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-10
IDSM_ft_server_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-11
IDSM_ft_use_rpc_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-11
IDSM_global_dsa_set_local_volume_on_import . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-11
IDSM_global_dsa_set_volume_on_import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-12
IDSM_global_dsa_sites_permitted_to_push_admin_data . . . . . . . . . . . . . . . . . . . . . . 20-12
IDSM_permitted_checkout_sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-13
IDSM_permitted_checkout_users_from_site_<sitename> . . . . . . . . . . . . . . . . . . . . . . 20-13
IDSM_permitted_sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-14
IDSM_permitted_transfer_sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-14
IDSM_permitted_transfer_users_from_site_<sitename> . . . . . . . . . . . . . . . . . . . . . . . 20-14
IDSM_permitted_users_from_site_<sitename> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-15
IDSM_proxy_client_alternate_proxy_host_for . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-15
IDSM_proxy_server_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-16
IDSM_restricted_sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-16
ITEM_autopublish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-16
ITEM_autopublish_ignore_errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-17
ITEM_autopublish_sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-18
ITEM_id_allow_if_registry_down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-18
ITEM_id_always_register_on_creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-18
ITEM_id_registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-19

PLM00026 11.2 Preferences and Environment Variables Reference


ITEM_id_registry_site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-19
ITEM_id_unregister_on_delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-19
ITEM_relation_types_update_lmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-20
ODS_multiprocess_idle_subprocess_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-20
ODS_multiprocess_initial_subprocess_count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-21
ODS_multiprocess_max_subprocess_count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-21
ODS_multiprocess_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-22
ODS_permitted_sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-22
ODS_proxy_server_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-22
ODS_publication_sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-23
ODS_restricted_sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-23
ODS_searchable_sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-23
ODS_searchable_sites_excluded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-24
ODS_site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-25
ODS_suppress_pubrec_if_no_access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-25
TC_<daemon-name>_<site-id>_prog_number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-25
TC_<daemon-name>_<site-name>_port_number . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-26
TC_<daemon-name>_<site-name>_prog_number . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-27
Tc_allow_users_edit_pfdata_options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-27
TC_altrep_update_lmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-28
TC_appref_registry_site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-28
TC_assembly_xml_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-29
TC_background_object_export_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-29
TC_bom_level_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-29
TC_check_remote_user_priv_from_sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-30
TC_classes_using_non_island_cico . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-31
TC_cms_relation_optset_map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-32
TC_dataset_vers_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-32
TC_default_export_sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-33
TC_directly_transferable_classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-33
TC_disallow_release_status_on_replica . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-34
TC_disallowed_replica_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-34
TC_do_not_define_sites_on_import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-35
TC_do_not_insert_imported_objects_into_folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-36
TC_EMAIL_AFTER_BACKGROUND_REMOTE_IMPORT . . . . . . . . . . . . . . . . . . . . . 20-36
Tc_export_pfmember_replica . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-37
TC_external_app_reg_url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-37
TC_follow_ownership_chain_max_site_count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-37
TC_force_remote_sites_exclude_files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-38
TC_hub_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-38
TC_identify_plmxml_import_dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-40
TC_idsm_client_def_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-41
TC_idsm_client_initial_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-41
TC_idsm_proxy_server_site_table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-41
TC_ie_error_report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-42
TC_master_locale_<site_name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-42
TC_modified_only_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-43
TC_Multisite_tcxml_TOS_Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-44
TC_ods_client_extra_attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-44

Preferences and Environment Variables Reference PLM00026 11.2


TC_ods_client_def_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-46
TC_ods_client_initial_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-46
TC_ods_proxy_server_site_table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-46
TC_on_demand_sync_broadcast_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-47
TC_ownership_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-47
TC_plmxml_import_item_filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-48
TC_plmxml_sync_dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-48
TC_post_export_script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-49
TC_pre_import_script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-49
TC_preserve_original_owner_on_sync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-50
Tc_preserve_replica_pfmember_ownership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-51
TC_publish_item_or_itemrev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-51
Tc_publish_pfdata_with_assemblies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-52
Tc_publish_pfmembers_with_pftemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-52
Tc_publish_pftemplate_with_pfmember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-53
TC_publishable_classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-53
TC_publishable_<business-object-name>_contexts . . . . . . . . . . . . . . . . . . . . . . . . . . 20-54
TC_reference_update_lmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-55
TC_rendering_update_lmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-55
TC_relation_export_on_transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-56
TC_relation_required_on_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-56
TC_relation_required_on_transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-57
TC_remote_checkin_assy_option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-58
TC_remote_checkin_exclude_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-59
TC_remote_checkin_preserve_replica_owning_user_and_group . . . . . . . . . . . . . . . . . 20-59
TC_remote_checkin_relation_send_as_replica . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-61
TC_replication_exclude_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-61
TC_replica_volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-61
TC_retain_group_on_import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-62
TC_split_shared_status_on_replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-62
TC_stub_dataset_files_after_ownership_transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-63
TC_subscribable_replica_classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-63
TC_sync_max_assy_level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-64
TC_sync_projects_with_owning_site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-65
TC_sync_revision_rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-66
TC_transfer_area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-67
TC_truncate_file_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-68
TC_use_group_admin_as_default_replica_owner . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-68
TC_validate_stub_tickets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-68

Data Exchange preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-69


Alt_id_default_idContext_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-69
Alt_id_default_identifier_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-69
BRIEFCASE_export_CAD_incomplete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-70
BRIEFCASE_import_validation_rule_item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-71
Briefcase_pkg_file_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-72
GMS_expired_or_locked_ada_licenses_bypass . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-72
GMS_offline_use_TcGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-73
GMS_tcxml_string_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-74
GMS_UID_mapping_dbname_index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-74

PLM00026 11.2 Preferences and Environment Variables Reference


GMS_UID_mapping_remote_site_index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-75
GS_USER_NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-75
GS_USER_PASSWORD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-75
PDX_pkg_file_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-76
SRM_hostname_portnumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-77
TC_default_gms_site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-77
TC_default_gms_transfer_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-78
TC_gms_import_default_transfermode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-78
TC_gms_enable_immediate_option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-78
TC_gms_export_default_transfermode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-79
TC_gms_export_transfermode_for_<site_name> . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-79
TC_gms_gs_bos_service_url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-79
TC_gms_gs_server_url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-80
TC_gms_gs_uri . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-80
TC_gms_monitoring_gui_total_number_of_steps_for_transfer . . . . . . . . . . . . . . . . . . . 20-80
TC_gms_sso_enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-81
TIE_allow_import_with_different_SML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-81
TIE_Attachment_Window_Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-81
TIE_exp_pending_object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-82
TIE_fast_traversal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-83
TIE_itemrev_infer_delete_skip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-83
TIE_reference_objects_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-84
TIE_validate_against_xsd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-85

PLM XML preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-85


BOMWriter_export_key_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-85
BOMWriter_write_boundingbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-86
PIE_<transfer_mode_name>_process_in_chunks . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-86
PIE_<transfer_mode_name>_unload_objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-87
PIE_allow_import_with_different_sml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-88
PIE_Extra_Error_Info_to_Xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-88
PIE_IMF_FOR_CAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-89
PIE_transfermode_languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-89
PLMXML_continue_on_error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-89
PLMXML_export_key_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-90
PLMXML_export_packed_bom_<transfer-mode-name> . . . . . . . . . . . . . . . . . . . . . . . 20-90
PLMXML_IC_Delta_export_transfermodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-91
PLMXML_import_default_password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-92
PLMXML_log_file_content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-92
PLMXML_overwrite_objects_on_import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-93
PLMXML_put_objects_in_newstuff_on_import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-93
PLMXML_put_pie_log_in_syslog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-94
PLMXML_sdk_threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-94
PLMXML_use_pre_plm_appname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-95
TC_export_child_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-95
TC_export_parent_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-96

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


STEP_<relation_type> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-96
STEP_approved_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-96

Preferences and Environment Variables Reference PLM00026 11.2


STEP_default_BOMView_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-97
STEP_default_datasettype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-97
STEP_default_item_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-98
STEP_design_specification_pref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-98
STEP_drawing_pref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-98
STEP_cad_filename_pref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-98
STEP_export_data_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-99
STEP_export_directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-99
STEP_FILETYPE_2_DATATYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-99
STEP_DMI_markup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-100
STEP_IMAN_master_data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-100
STEP_IMAN_specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-101
STEP_IMAN_manifestation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-101
STEP_IMAN_requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-101
STEP_IMAN_reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-102
STEP_IMAN_UG_altrep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-102
STEP_IMAN_UG_scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-102
STEP_import_directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-102
STEP_informative_doc_role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-103
STEP_make_or_buy_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-103
STEP_material_specification_pref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-103
STEP_not_yet_approved_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-104
STEP_part_items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-104
STEP_process_specification_pref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-104
STEP_surface_finish_specification_pref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-105
TC_organization_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-105

PLM00026 11.2 Preferences and Environment Variables Reference


Chapter 20: Data sharing preferences

Data sharing preference value updates during upgrade

When a site is upgraded to a new version, there may be changes in the default
values for preferences as a result of new features or functionality. You can search for
preferences in the rich client to check the values.
Some of the changes are required to support functionality that you may or may not
use. Unless otherwise indicated, these changes have minor, if any, impact on data
sharing performance.

Multi-Site Collaboration preferences

Role-based preferences

TC_always_exclude_dataset_files_on_export

DESCRIPTION
Determines whether the dataset named reference file is excluded from export. Use
this preference in conjunction with the on-demand retrieval of dataset volume files
functionality. This preference affects Multi-Site transfers only and is ignored by Global
Services.
For more information about this functionality, see Multi-Site Collaboration.
VALID
VALUES
true Excludes the dataset named reference file from export. This
ensures a given role can never store replica volume data at a
remote site. This setting forces the remote user to retrieve the
volume data from the owning site.
false Does not exclude the dataset named reference file from export.
DEFAULT
VALUES
Not applicable.
DEFAULT
PROTECTION
SCOPE
Role preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-1


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

TC_bom_level_export

DESCRIPTION
Controls assembly export options: prevents the entire assembly from being exported;
allows the entire assembly to be exported, but prevents transferring site ownership,
or allows the entire assembly to be exported. This preference does not apply when
running command-line utilities such as the item_export or the data_share utility.
VALID
VALUES
0 Prevents a user from exporting an entire assembly by disabling
the Include Entire BOM button in the Import/Export Options
dialog box.
9999 Prevents a user from transferring site ownership of an entire
assembly by disabling the Include Entire BOM button in
the Import/Export Options dialog box when the Transfer
Ownership button is selected.
Commented Allows the entire assembly to be exported.
DEFAULT
VALUES
Not applicable.
DEFAULT
PROTECTION
SCOPE
Role preference.

TC_dataset_vers_export

DESCRIPTION
Prevents a user from exporting all dataset versions (unless transferring site ownership)
by disabling the Include All Versions button in the Import/Export Options dialog
box. This role-based preference applies even when running command-line utilities
such as the item_export or the data_share utility.
VALID
VALUES
Accepts the value FALSE. If set to any other value, the system ignores the preference
setting.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Role preference.

TC_modified_only_export

DESCRIPTION
Prevents a user from turning off the Include Modified Objects Only button in the
Import/Export Options dialog box. This option usually results in better overall

20-2 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

import/export efficiency. This preference does not apply when running command-line
utilities such as the item_export or the data_share utility.
VALID
VALUES
Accepts the value TRUE. If set to any other value, the system ignores the preference
setting.
DEFAULT
VALUES
Not applicable.
DEFAULT
PROTECTION
SCOPE
Role preference.

TC_ownership_export

DESCRIPTION
Prevents a user from transferring site ownership by disabling the Transfer Ownership
button in the Import/Export Options dialog box.
VALID
VALUES
Accepts the value FALSE. If set to any other value, the system ignores the preference
setting.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Role preference.

TC_relation_export_hidden

DESCRIPTION
Prevents users in certain roles from seeing all available relation types in the
Import/Export Options dialog box. This prevents users from including the hidden
relation types for import/export operations. All hidden relation types are automatically
excluded from the import/export operations.
Note

The OBJIO-send-target-objects action handler does not support use of the


TC_relation_export_hidden preference. The action handler fails when it runs
the preference. As a workaround, use the -exclude_relation argument in the
OBJIO-send-target-objects action handler.

VALID
VALUES
A list of valid relation type names, one name per line. The database name, not the
display name, of a relation type must be given. Invalid values in the list are ignored.

PLM00026 11.2 Preferences and Environment Variables Reference 20-3


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Role preference.

TC_sync_auto_synchronize

DESCRIPTION
Indicates whether Teamcenter automatically synchronizes replicas at remote sites
when the master object is modified. For Teamcenter 9.1 and later releases, the
Synchronize automatically checkbox in the Remote Export Options and Remote
Import Options dialog boxes is not user selectable. Automatic synchronization is
controlled only by this preference. The checkbox value is read-only and provided for
informational purposes.
Note

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


require this functionality, you must create the preference.

For information about creating and using preferences, see Teamcenter Basics.
Tip

Siemens PLM Software recommends that you use the following values when
creating this preference:
• Protection Scope: Role

• Category: Data Sharing.Multi-Site Collaboration

• Environment: Disabled

You must select Logical from the Type list and Single from the Multiple box.

VALID
VALUES
One of any logical pair (true or false, on or off, 0 or 1).
TRUE The Synchronize automatically checkbox is selected in the Remote
Export Options dialog box. Teamcenter performs automatic synchronization
of remote objects.

FALSE The Synchronize automatically checkbox is cleared in the Remote


Export Options dialog box. Teamcenter does not perform automatic
synchronization of remote objects.
DEFAULT
VALUES
None.

20-4 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

You must create this preference manually. If the preference does not exist, the
Synchronize automatically checkbox is cleared and Teamcenter does not perform
automatic synchronization of remote objects.
DEFAULT
PROTECTION
SCOPE
Role preference.

Baseline_auto_remote_checkout_allowed

DESCRIPTION
Determines whether automatic remote checkout of replicated objects is allowed during
a baseline operation. If allowed, replica items, and BOM views of replica item revisions,
will be (automatically) checked out during baseline operations. The resulting baseline
object is owned by the original owning site once the item or BOM view is remotely
checked back in (automatically) after the baseline operation successfully completes.
Use this preference at sites using the remote check out/check in method, rather than
the method of transferring ownership of objects. If your site often creates baselines of
remote objects, enabling this preference improves system performance.
Caution

Before setting this preference to True, ensure that the baseline business rules
are the same at the owning site and remote site. Otherwise, revision IDs
produced at the baseline will be of inconsistent values.
For more information about setting business rules, see Business Modeler IDE.

Caution

The status type to be applied at the replica site must also exist at the owning site.

VALID
VALUES
True or On or 1 Automatic remote checkout of replicated objects is allowed
(case insensitive) during baseline operations.
False or Off or 0 Automatic remote checkout of replicated objects is not allowed
(case insensitive) during baseline operations. Users can remote checkout replica
objects manually, and proceed with a baseline operation.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-5


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

HUB_no_export_record_transfer_site_list

DESCRIPTION
Prevents the distribution of export records when site ownership is transferred from the
hub. Use this preference to hide sensitive site information from unauthorized sites.
This preference is valid only for a hub site. When an export record is created at the
importing site, the site objects are created if they do not already exist. As a result,
information that may be confidential (such as the site ID, site name, and IP address)
could be inadvertently distributed without this preference.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid site authorized to
transfer site ownership from the hub.
DEFAULT
VALUES
None. If this preference is not defined, all export records are always be transferred to
the new owning site of the data.
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_Compression

DESCRIPTION
Enables or disables data compression during remote import operations.
For data compression to be employed between two Multi-Site Collaboration sites,
both sites must set this preference to True to enable compression, and both sites
must specify the same compression type by setting the IDSM_Compression_type
preference.
VALID
VALUES
TRUE Enables compression at the site during remote import
operations.

FALSE Disables data compression during remote import operations.


DEFAULT
VALUES
TRUE (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_Compression_Type

DESCRIPTION
Specifies the type of data compression use by Multi-Site Collaboration.

20-6 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

Currently, InfoZip is the only compression type Multi-Site Collaboration supports. If the
IDSM_Compression preference is defined, this preference must also be defined to
enable data compression.
Tip

InfoZip does not need to be manually installed; it is embedded in the


Teamcenter software. The %TC_BIN%\compress.pl script (Windows) or
$TC_BIN/compress.pl script (UNIX) is used to complete the compression. The
compress.pl is installed with the TC_ROOT directory.

VALID
VALUES
Infozip Specifies the use of InfoZip data compression.
DEFAULT
VALUES
Infozip (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_do_not_resend_up_to_date_file

DESCRIPTION
Specifies whether Teamcenter must prevent the retransmission of a replicated file that
is still current at the time an attempt to reimport or resend the file is made. Set this
preference value to TRUE to prevent retransmission. This preference applies whether
or not transfer of site ownership is involved. If no value is set for the preference,
Teamcenter always retransmits the files.
Warning

If this preference value is set to TRUE at a site, instruct the site’s users not
to delete replicas if they intend to reimport the object. This can cause new
metadata but without the required file. If a missing file occurs, temporarily
disable this preference, reimport the dataset, and then enable the preference.

VALID
VALUES
TRUE Prevents the retransmission of up-to-date files.
FALSE Allows the retransmission of up-to-date files.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-7


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

IDSM_dsa_sites_permitted_to_push_admin_data

DESCRIPTION
Defines the remote sites that are permitted to distribute system administration data
to the local site. This enforces site-level security; if a remote site is not defined in
this preference, that site cannot perform distributed system administration functions
that affect the local site.

This is the first preference to be checked whenever a remote site tries to send system
administration data to the local site. If this initial check results in a rejection of the
request, the other distributed system administration preferences are not checked.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter site name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_dsa_notification_email_address

DESCRIPTION
Determines which administrators are notified by e-mail when system administration
data (such as organization data, relation types, revision rules) is received from a
remote site with the dsa_util utility.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter e-mail
address, separated by a semicolon.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_exclude_unpublished_components

DESCRIPTION
Prevents automatic replication of unpublished components when a published assembly
is replicated.

This preference can be used only in conjunction with remote imports; it is not used
when you choose Tools→Export→Objects from the My Teamcenter menu to export
components.

20-8 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

VALID
VALUES
TRUE Unpublished components are not included when you perform a
remote import of a published assembly and the Include Entire
BOM command is enabled.
FALSE All components—published and unpublished—are included.
DEFAULT
VALUES
TRUE (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_ft_buffer_kb

DESCRIPTION
Sets the size of the network send and receive buffers in kilobytes. The maximum
default is 64K for traditional TCP implementations and is adequate for the majority
of users.
Users with extremely high-performance networks may want to increase this setting.
On some operating systems, you may need to enable the RFC1323 (Large Windows)
TCP feature to increase buffers beyond the default.
Calculate the optimum buffer size by multiplying the bandwidth by the delay. Typically,
the peak bandwidth of a network link is expressed in megabits per second (Mbit/s).
For example, a T1 line is rated at 1.544 Mbits/s. The round-trip delay for a link can
be measured with a trace route, and for WAN links is typically between 50 m/sec
and 250 m/sec.
For example, a 200 m/sec delay, 2 Mbits/s path, the bandwidth delay product
is 400 Kbit/s, or 50 Kbytes/s. In this example, for optimal performance, set the
IDSM_ft_buffer_kb site preference to at least 50.
VALID
VALUES
Size of network send/receive butters in kilobytes.
DEFAULT
VALUES
64K (Commented out)
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_ft_client_timeout

DESCRIPTION
Sets the amount of time, in seconds, that the client waits for file transfer connections to
respond before terminating the request.

PLM00026 11.2 Preferences and Environment Variables Reference 20-9


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

VALID
VALUES
A positive integer.
DEFAULT
VALUES
30 (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_ft_get_port_number_from_services

DESCRIPTION
Determines where the IDSM retrieves the TCP/IP port number.
VALID
VALUES
TRUE Overrides the IDSM_ft_port_number preference setting and
instructs the IDSM to look up the TCP/IP port number in the
/etc/services file for the service named idsmft. On Windows,
the file is located at system32\drivers\etc\services.
FALSE Does not override the IDSM_ft_port_number preference
setting.
DEFAULT
VALUES
FALSE (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_ft_port_number

DESCRIPTION
Specifies the TCP/IP port number to use for file transfers. Must be different from the
one in use for IDSM and ODS, and must not conflict with other registered system
services.
Siemens PLM Software recommends the default setting be changed to an unused
port number in the reserved port range. Contact your network administrator for this
information.
VALID
VALUES
Valid port number.
DEFAULT
VALUES
47953 (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

20-10 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

IDSM_ft_server_timeout

DESCRIPTION
Sets the amount of time in seconds that the client and server wait for file transfer
connections to respond before giving up.
VALID
VALUES
A positive integer.
DEFAULT
VALUES
30 (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_ft_use_rpc_mode

DESCRIPTION
Determines which file transfer mode is used.
VALID
VALUES
TRUE Forces the use of the original Classic File Transfer mode. This
mode is a slower remote procedure call (RPC) based transfer
mode.

FALSE Does not force the use of the original Classic File Transfer
mode.
DEFAULT
VALUES
FALSE (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_global_dsa_set_local_volume_on_import

DESCRIPTION
Sets the local default volume for a user based on the name of the users default group
name only for the initial import. Sets the local default volume for a group based on
the group name only for the initial import.
VALID
VALUES
Enter values as Group-name:Volume-name, one entry per line, for example:
Engineering:DrawingVol
DEFAULT
VALUES
None

PLM00026 11.2 Preferences and Environment Variables Reference 20-11


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
This preference allows the importing site of users and groups to define what the
local default volume is for initial import. The local default volume for a user is set by
mapping its default group name to the volume name specified in the preference. The
default local volume for a group is set by mapping the group name to the volume
name specified in the preference.
RESTRICTIONS
1. Subsequent imports and synchronizations ignore this preference and preserve
any existing value.

2. Not applicable for migration.

IDSM_global_dsa_set_volume_on_import

DESCRIPTION
Sets the default volume for a user based on the name of the users default group name
only for the initial import. Sets the default volume for a group based on the group
name only for the initial import.
VALID
VALUES
Enter values as Group-name:Volume-name, one entry per line, for example:
Engineering:DrawingVol
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
This preference allows the importing site of users and groups to define what the
default volume is for initial import. The local volume for a user is set by mapping its
default group name to the volume name specified in the preference. The default
volume for a group is set by mapping the group name to the volume name specified
in the preference.
RESTRICTIONS
1. Subsequent imports and synchronizations ignore this preference and preserve
any existing value.

2. Not applicable for migration.

IDSM_global_dsa_sites_permitted_to_push_admin_data

DESCRIPTION
Defines the remote sites that are permitted to use Multi-Site export to push organization
data to the local site. This enforces site-level security; if a remote site is not defined in

20-12 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

this preference, that site cannot perform Multi-Site organization functions that affect
the local site.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter site name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_permitted_checkout_sites

DESCRIPTION
Defines which remote sites are authorized to check out objects owned by the local
site. If not defined, no site is allowed to checkout any object from this site.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter site name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_permitted_checkout_users_from_site_<sitename>

DESCRIPTION
Defines which user IDs from the sites specified by the
IDSM_permitted_checkout_sites site preference are authorized to transfer
ownership of objects owned by the local site.
If this preference is not defined, all users from a site defined by the
IDSM_permitted_checkout_sites site preference can perform remote checkouts of
objects owned by the local site.
Note

Defining the TC_check_remote_user_priv_from_sites preference overrides


this preference.

VALID
VALUES
One or more strings; each string must be a valid Teamcenter user ID.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 20-13


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_permitted_sites

DESCRIPTION
Lists which sites can access your data via the IDSM server.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter site name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_permitted_transfer_sites

DESCRIPTION
Defines which sites are authorized to transfer ownership of objects owned by the site
served by an IDSM server. If not defined, no site is allowed to transfer ownership of
any object from this site.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter site name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_permitted_transfer_users_from_site_<sitename>

DESCRIPTION
Defines which user IDs from the sites specified by the IDSM_permitted_transfer_sites
site preference are authorized to transfer ownership of objects owned by the site
served by an IDSM server.
Note

Defining the TC_check_remote_user_priv_from_sites preference overrides


this preference.

VALID
VALUES
One or more strings; each string must be a valid Teamcenter user ID.

20-14 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

DEFAULT
VALUES
None. If not defined, all users from the remote site are authorized to transfer data from
the local site, provided the site is defined in the IDSM_permitted_transfer_sites
site preference.
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_permitted_users_from_site_<sitename>

DESCRIPTION
Defines which user IDs from the sites specified by the IDSM_permitted_sites site
preference are authorized to replicate data owned by the site served by an IDSM
server.
Note

Defining the TC_check_remote_user_priv_from_sites preference overrides


this preference.

VALID
VALUES
One or more strings; each string must be a valid Teamcenter user ID.
DEFAULT
VALUES
None. If not defined, all users from the remote site are authorized to replicate data from
the local site, provided the site is defined in the IDSM_permitted_sites site preference.
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_proxy_client_alternate_proxy_host_for

DESCRIPTION
Allows proxy clients to optionally specify an alternate proxy host. If the initial
communication with the primary proxy host fails, the request is automatically sent to
the alternate proxy host.
VALID
VALUES
IDSM_proxy_client_alternate_proxy_host_for_gmproxy1= gmproxy2
gmproxy1 is the regular proxy host node name and gmproxy2 is the node name of
the alternate proxy host.
Alternatively, an IP address can be used instead of the node name. The node name
entry should match the entry for the node name in the site definition database. If the IP
address is used in the database, the IP address should also be used in this preference
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 20-15


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_proxy_server_type

DESCRIPTION
Determines whether proxy server mode is available for the IDSM. A valid value
enables the proxy server mode. When not set, the proxy server mode is disabled.
VALID
VALUES
Relay Enables relay proxy server mode.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IDSM_restricted_sites

DESCRIPTION
Lists which sites cannot access your data via the IDSM server.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter site name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ITEM_autopublish

DESCRIPTION
Enables or suppresses the automatic publication of all newly created items and the
automatic republication of items when the item ID is modified. Newly created items are
published to the ODS site specified by the ITEM_autopublish_sites site preference.
When an existing item ID is modified, it is republished only if it is already currently
published and then only to the ODS sites to which it has already been published.
The ITEM_autopublish_sites site preference does not determine which ODS site
to use for republication.

20-16 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

VALID
VALUES
TRUE Enables the automatic publication of all newly created items
and the automatic republication of items when the item ID is
modified.
FALSE Suppresses the automatic publication of all newly created items
and the automatic republication of items when the item ID is
modified.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ITEM_autopublish_ignore_errors

DESCRIPTION
Determines whether to ignore publication errors detected during automatic publication.
When a publication error is detected, any item creations/modifications known to be
successful at that point are retained; failed items can be published manually at your
convenience. This preference requires the ITEM_autopublish site preference to
be set.
Errors caused by invalid ODS site preference settings are ignored by this preference.
Note

Errors due to item creation or modification are not covered by this preference;
the preference applies only to publication errors.

VALID
VALUES
TRUE When automatic publishing is enabled via the
ITEM_autopublish site preference, ignores publication errors
detected during automatic publication.
FALSE When automatic publishing is enabled via the
ITEM_autopublish site preference, publication errors
prompt the system to cancel the item creation or modification.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-17


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

ITEM_autopublish_sites

DESCRIPTION
Defines the ODS site to which newly created items are published. This preference
requires the ITEM_autopublish site preference to be set.
VALID
VALUES
Accepts a single string as a value. Must be a valid ODS site.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ITEM_id_allow_if_registry_down

DESCRIPTION
Determines if items can be created if the registry server is not available. If the registry
is not active, this preference is ignored.
VALID
VALUES
TRUE Items can be created when the item ID registry server is
unavailable.
FALSE Items cannot be created when the item ID registry server is
unavailable.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

ITEM_id_always_register_on_creation

DESCRIPTION
Determines if item IDs are automatically registered when items are created or the
item ID is changed.
VALID
VALUES
TRUE Automatically registers item IDs to the item ID registry when
items are created or the item ID is changed.
FALSE Does not register item IDs to the item ID registry when items are
created or the item ID is changed.
DEFAULT
VALUES
FALSE

20-18 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ITEM_id_registry

DESCRIPTION
Activates the item ID registry.
VALID
VALUES
TRUE During item creation (immediately before the new item is saved
to the database), the system checks the item ID registry for
duplicates. Creating the item fails if a duplicate is found.
FALSE The item ID registry is not checked for duplicates while creating
a new item.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

ITEM_id_registry_site

DESCRIPTION
Identifies the site name upon which the item ID registry server is running.
This preference must be set if the item ID registry is active. If the registry is not active,
this preference is ignored.
VALID
VALUES
A single string as a value; each string must be a valid Teamcenter site name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ITEM_id_unregister_on_delete

DESCRIPTION
Determines if item IDs are automatically unregistered when items are deleted or the
item ID is changed.
VALID
VALUES
TRUE Automatically removes item IDs from the item ID registry when
items are deleted or the item ID is changed.

PLM00026 11.2 Preferences and Environment Variables Reference 20-19


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

FALSE Does not remove item IDs to the item ID registry when items are
deleted or the item ID is changed.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

ITEM_relation_types_update_lmd

DESCRIPTION
Determines which relation types cause the update of the last modification date of the
parent object when the secondary object of a class dataset or form is modified, or if the
relation is added/removed from the parent object. If the relation is added/removed,
the last modification date of the parent object is updated regardless of the class of the
secondary object.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
relation. Excepting the IMAN_RES_audit and IMAN_RES_checkout relations, which
are not valid values for this preference.
DEFAULT
VALUES
IMAN_master_form
IMAN_specification
IMAN_requirement
The IMAN_master_form, IMAN_specification and IMAN_requirement relation types
are implied entries in this preference and cannot be excluded.
DEFAULT
PROTECTION
SCOPE
Site preference.

ODS_multiprocess_idle_subprocess_timeout

DESCRIPTION
Defines the length of time a multiprocess subprocess can be idle before it is taken
out of service and terminated.
Used when the Object Directory Services (ODS) is running in multiprocess mode. In
this mode, the ODS maintains a minimum number of subprocesses to respond to
client requests. Additional subprocesses are created on demand, up to a maximum
number (defined by the ODS_multiprocess_max_subprocess_count preference)
when the number of concurrent outstanding client requests exhaust the capacity of
the minimum number of subprocesses.
This preference's idle timeout setting applies to the subprocesses created on demand.
The timeout is specified in minutes.

20-20 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

VALID
VALUES
Any positive integer.
DEFAULT
VALUES
10 (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

ODS_multiprocess_initial_subprocess_count

DESCRIPTION
Determines the number of subprocesses created and logged into the database by the
parent Object Directory Services (ODS) process at startup.
If too few subprocesses are created, remote users may notice a delay due to the time
required to create a subprocess and log on to the database. If too many subprocesses
are created, strain may be placed on system resources, resulting in slow performance.
VALID
VALUES
Any positive integer.
DEFAULT
VALUES
5 (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

ODS_multiprocess_max_subprocess_count

DESCRIPTION
Determines the maximum number of precreated subprocesses that can be created
by the parent Object Directory Services (ODS) process.
If the maximum number is too low, remote users may experience noticeable delays
when performing ODS-related operations. If the maximum number is too high,
too many system processes could be created, thus straining system resources and
causing slow performance.
VALID
VALUES
Any positive integer.
DEFAULT
VALUES
10 (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-21


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

ODS_multiprocess_mode

DESCRIPTION
Enables or suppresses multiprocess Object Directory Services (ODS) operations,
providing improved service when the ODS server process is being monopolized by
remote operations such as report generation and object publication. Multiprocess
mode can also be used to improve performance when service from the ODS server is
slow due to high numbers of operations running at multiple remote sites.
VALID
VALUES
TRUE Enables multiprocess Object Directory Services (ODS)
operations.

FALSE Suppresses multiprocess Object Directory Services (ODS)


operations.
DEFAULT
VALUES
TRUE (Commented out).
DEFAULT
PROTECTION
SCOPE
All.

ODS_permitted_sites

DESCRIPTION
Sets which sites can access the Object Directory Services (ODS) database.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter site name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ODS_proxy_server_type

DESCRIPTION
Determines whether proxy server mode is available for the ODS. A valid value enables
the proxy server mode. When not set, the proxy server mode is disabled.
VALID
VALUES
Relay Enables relay proxy server mode.
DEFAULT
VALUES
None.

20-22 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ODS_publication_sites

DESCRIPTION
Lists Object Directory Services (ODS) sites that can be used to publish an object
simultaneously. The list serves as the recommended ODS list when publishing
to multiple sites using Commands→Publish→To ODS Publication List menu
commands.
This list plus the default ODS comprise the list of authorized ODS sites to which
users can publish.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter site name and
must be designated as providing ODS.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ODS_restricted_sites

DESCRIPTION
Sets which sites cannot access the Object Directory Services (ODS) database.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter site name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ODS_searchable_sites

DESCRIPTION
Specifies the ODS sites that Teamcenter searches for published remote objects during
a remote search.
The sites set in this preference are listed in the Shown column for the ODS
Searchable Sites section in the Options dialog box.

PLM00026 11.2 Preferences and Environment Variables Reference 20-23


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

Nonadministrator users can create an instance at the user location in the Details pane
of the Options dialog and add or remove values to override any site location settings.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter site name as
defined in the Organization application.
RESTRICTIONS
Values that appear in ODS_searchable_sites preference for the site location are
mutually exclusive from the values in ODS_searchable_sites_excluded preference
for the site location.
Values that appear in ODS_searchable_sites preference for a user location are
mutually exclusive from the values in ODS_searchable_sites_excluded preference
for that user location.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

ODS_searchable_sites_excluded

DESCRIPTION
Specifies the sites that Teamcenter does not include in searches for published remote
objects during a remote search.
The sites set in this preference are listed in the Shown column for the ODS
Searchable Sites Excluded section in the Options dialog box.
Nonadministrator users can create an instance at the user location in the Details pane
of the Options dialog and add or remove values to override any site location settings.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter site name as
defined in the Organization application.
RESTRICTIONS
Values that appear in ODS_searchable_sites_excluded preference for the site
location are mutually exclusive from the values in ODS_searchable_sites preference
for the site location.
Values that appear in ODS_searchable_sites_excluded preference for a user
location are mutually exclusive from the values in ODS_searchable_sites preference
for that user location.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

20-24 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

ODS_site

DESCRIPTION
Sets the default Object Directory Services (ODS) site.
VALID
VALUES
A single string as a value; must be a valid Teamcenter site name and must be
designated as the providing ODS site.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ODS_suppress_pubrec_if_no_access

DESCRIPTION
Prevents users at remote sites from knowing about publication records to which their
site has no access, and is used only at Object Directory Services (ODS) sites.

This preference is used only at ODS sites.

For information about ODS sites, see Multi-Site Collaboration.


VALID
VALUES
TRUE Protected publication records are invisible, (that is, they do not
exist for those users that do not have access). For remote sites
running pre-V6.0 software, protected publication records are
automatically invisible.

FALSE Users at remote sites that do not have read access to a


publication record see an Access Denied message in the
object list window. Find Remote produces this message.
DEFAULT
VALUES
FALSE (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_<daemon-name>_<site-id>_prog_number

DESCRIPTION
Determines which custom remote procedure call (RPC) program number the IDSM or
ODS server runs on the specified site name. This preference is only for use with a
proxy configuration.

PLM00026 11.2 Preferences and Environment Variables Reference 20-25


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

Note

The IDSM or ODS server must first be properly configured to run on the custom
RPC program number.

VALID
VALUES
The syntax for this preference is TC_daemon-name_site-id_prog_number where the
daemon name is either the ODS or IDSM process (specified in lowercase), the site-id
is the ID of a valid Multi-Site Collaboration site, and the prog_number is a valid open
network computing (ONC) RPC number. For example:
TC_ods_1122334455_prog_number=
536875580
TC_idsm_1122334455_prog_number=
536875590

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_<daemon-name>_<site-name>_port_number

DESCRIPTION
Allows you to bypass the remote procedure call (RPC) portmapper service (rpcbind).
You may want to avoid using the portmapper service for security reasons. The
portmapper bypass configuration allows you to configure the ODS and IDSM servers
to run on specific port numbers.
VALID
VALUES
The syntax for this preference is TC_daemon-name_site-name_port_number where
the daemon name is either the ODS or IDSM process (specified in lowercase), and the
site name is the name of a valid Multi-Site Collaboration site. For example:
TC_ods_athens_port_number=
47000
TC_idsm-athens_port_number=
47001
TC_ods_rome_port_number=
57000
TC_idsm_rome_port_number=
57001
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

20-26 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

TC_<daemon-name>_<site-name>_prog_number

DESCRIPTION
Determines which custom remote procedure call (RPC) program number the IDSM
or ODS server runs on the specified site name. This preference is not valid for a
proxy configuration.
Note

The IDSM or ODS server must first be properly configured to run on the custom
RPC program number.

VALID
VALUES
The syntax for this preference is TC_daemon-name_site-name_prog_number where
the daemon name is either the ODS or IDSM process (specified in lowercase), the site
name is the name of a valid Multi-Site Collaboration site, and the prog_number is a
valid open network computing (ONC) RPC number. For example:
TC_ods_athens_prog_number=
536875580
TC_idsm_athens_prog_number=
536875590

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Tc_allow_users_edit_pfdata_options

DESCRIPTION
Determines whether options for publishing part family member items and templates
can be modified by general users in the Options dialog box, accessed from the Edit
menu. Users with system administrator privileges can always edit these options from
the Options dialog box, regardless of how this preference is set.
VALID
VALUES
TRUE General users can modify options for publishing part family
member items and templates using the Options dialog box.
FALSE General users cannot modify options for publishing part family
member items and templates using the Options dialog box.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-27


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

TC_altrep_update_lmd

DESCRIPTION
Determines whether the last modified date of a locally owned item revision is updated
when an object with an associated altrep relation is modified.
The last modified date of the parent item is automatically updated as a consequence
of the associated item revision update.
VALID
VALUES
TRUE The last modified date of the item revision is modified when an
object with an associated altrep relation is modified.

FALSE The last modified date of the item revision is not modified when
an object with an associated altrep relation is modified.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_appref_registry_site

DESCRIPTION
Defines which Object Directory Services (ODS) site is used for all Application
Reference ITK operations. For use with Teamcenter Integration for NX I-deas
migration. When I-deas data is migrated to Teamcenter, these APIs are used to ensure
duplicate GUIDs are not created.
For more information about the Application Reference ITK module, 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/

Use this preference to direct all API operations to a site other than the default ODS site
(defined by the ODS_site site preference). This allows a separate ODS, dedicated to
item GUIDs, to be setup independent of a regular ODS.
VALID
VALUES
A single string as a value; must be a valid Teamcenter site name.
DEFAULT
VALUES
The value defined in the ODS_site site preference.

20-28 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_assembly_xml_relation

DESCRIPTION
Indicates the relation name that is used to relate the PLM XML data generated for
the assembly.
Modify this preference value if you must have the PLM XML dataset attached using
a specific relation for business needs.
VALID
VALUES
Any existing relation name.
DEFAULT
VALUES
IMAN_Specification
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_background_object_export_dir

DESCRIPTION
Defines the directory where export data is stored when a background export is
performed using the rich client.
When an interactive, non-remote background export operation is performed using
the rich client, the export data is stored in a subdirectory of the defined directory;
the subdirectory name is defined by the user in the Object Export dialog box. For
example, if the user specifies that the export data be stored in the directory named
my_item100, the background export output is placed in the following directory:
/mydisk/mydir/my_item100
VALID
VALUES
Valid disk drive and directory name.
DEFAULT
VALUES
c:\background_expdir (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_bom_level_export

DESCRIPTION
Controls assembly export options: prevents the entire assembly from being exported;
allows the entire assembly to be exported, but prevents transferring site ownership,

PLM00026 11.2 Preferences and Environment Variables Reference 20-29


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

or allows the entire assembly to be exported. This preference does not apply when
running command-line utilities such as the item_export or the data_share utility.
VALID
VALUES
0 Prevents a user from exporting an entire assembly by disabling
the Include Entire BOM button in the Import/Export Options
dialog box.
9999 Prevents a user from transferring site ownership of an entire
assembly by disabling the Include Entire BOM button in
the Import/Export Options dialog box when the Transfer
Ownership button is selected.
Commented Allows the entire assembly to be exported.
DEFAULT
VALUES
Not applicable.
DEFAULT
PROTECTION
SCOPE
User preference.
Note

This value is generated by the system and should not be changed.

TC_check_remote_user_priv_from_sites

DESCRIPTION
Determines whether individual remote user privileges are checked before remote
users are allowed to perform the remote operations listed below. Use this preference
to list the remote sites included in this security check. Whenever remote operations are
attempted from any remote site named in this preference, the system evaluates current
AM rules for the IDSM site for the remote user ID. The security check is implemented
on the IDSM server and applies to any remote site named by the local site.
If this preference is not set, the system applies AM rules only at the site
level. In this situation, only the remote site’s AM privileges are checked
against the AM rule tree of the owning site; access to individual objects at
the owning site are not validated against individual remote user privileges.
In this scenario, the IDSM_permitted_users_from_site_<sitename>,
IDSM_permitted_transfer_users_from_site_<sitename> and
IDSM_permitted_checkout_users_from_site_<sitename> preferences
can be used to determine remote user access to replicate, transfer, and to check in
or to check out remote data. You will override these three preferences if you set the
TC_check_remote_user_priv_from_sites preference.
The remote operations affected are:
• Remote import

• Remote import with transfer of ownership

20-30 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

• Remote check out

• Remote export

• Remote export with transfer of ownership

• Data share utilities

• Pull synchronization

• On demand synchronization
VALID
VALUES
Accepts one or more strings as values. Each string must be the name of a valid
remote site.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_classes_using_non_island_cico

DESCRIPTION
Defines a list of classes that use standard Multi-Site, non-island based checkin and
checkout behavior.
Note

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


require this functionality, you must create the preference.

Tip

Siemens PLM Software recommends that you use the following values when
creating this preference:
• Protection Scope: Site
• Category: Data Sharing.Multi-Site Collaboration
• Environment: Disable

VALID
VALUES
One or more strings. Each string must be a valid Teamcenter class name.
DEFAULT
VALUES
Dataset
Form
Item
ItemRevision
Schedule

PLM00026 11.2 Preferences and Environment Variables Reference 20-31


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

ScheduleTask
ScheduleTaskRevision
PSBOMView
PSBOMViewRevision

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_cms_relation_optset_map

DESCRIPTION
Controls mapping of Teamcenter relation names to the TC XML transfer option sets.
Set this preference only when you want to control the relations that are included or
excluded when an object is replicated.
Multi-Site Collaboration allows you to include or exclude relations during transfers.
During TC XML transfers, Multi-Site maps the user supplied relations to the
corresponding TC XML transfer option set entry using the name-value pairs set by
this preference.
Use this preference to include or exclude relation objects during data_share or
data_sync utility transactions that use the -low_level argument (TC XML transfers).
For an example of using this preference with the data_share or data_sync utility, see
the Utilities Reference.
VALID
VALUES
One or more name-value pair strings, for example:
IMAN_rendering,opt_rel_rendering

The name must be a valid Teamcenter relation, and the value must be a valid TC
XML transfer options set entry.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_dataset_vers_export

DESCRIPTION
Prevents a user from exporting all dataset versions (unless transferring site ownership)
by disabling the Include All Versions button in the Import/Export Options dialog
box. This role-based preference applies even when running command-line utilities
such as the item_export or the data_share utility.

20-32 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

Note

This preference is a behind-the-scenes preference that is created when a user


selects various import/export commands; it is used internally by the system
and should not be modified.

VALID
VALUES
Defined by system.
DEFAULT
VALUES
Not applicable.
DEFAULT
PROTECTION
SCOPE
User preference.

TC_default_export_sites

DESCRIPTION
Specifies the list of default export target sites. This list is used to specify the target
sites when exporting using an ITK program. This preference is used only if the
TC_USE_DEFAULT_EXPORT_SITES environment variable is defined and set to
any value.
Note

This preference is not used with interactive Teamcenter and is intended only
for compatibility with ITK programs.

VALID
VALUES
Any valid site IDs.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_directly_transferable_classes

DESCRIPTION
Prevents any attachment of a replicated item from being transferred independent of
the item. This prevent users replicating items containing attachments, then remote
importing the attachments with a transfer of ownerships which prevents other users
from further replicating the item because ownership of the item is no longer consistent.
This situation can also cause synchronization problems.
To prevent direct transfer of ownership of all classes of objects except items and item
revisions, set this preference to Item. To enable direct transfer of other classes, such
as Folder, add the Folder class as a value.

PLM00026 11.2 Preferences and Environment Variables Reference 20-33


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

VALID
VALUES
Accepts one or more strings as values; each string must be a valid Teamcenter
object class.
DEFAULT
VALUES
Item
ItemRevision
Dataset
Folder
Form
PSBOMView
PSBOMViewRevision
EPMTaskTemplate
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_disallow_release_status_on_replica

DESCRIPTION
Specifies whether replicas are allowed to be released (have a release status).
VALID
VALUES
true Prevents replicas from being released.
false Allows replicas to be released (have a release status).
DEFAULT
VALUE
true
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_disallowed_replica_relations

DESCRIPTION
Prevents adding local attachments to replicas. Without this preference, relation types
other than IMAN_specification, IMAN_requirement and IMAN_master_form can
be used to attach files to replica items and item revisions. This makes it possible for
users to attach important data to the replica even though the attachment is strictly local
data that cannot be synchronized to other sites. This can be unacceptable, especially
when the attachments are UG Altreps.
Use this preference to prevent the attachment of manifestations, references, and UG
Altreps to replica items and item revisions.

20-34 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

VALID
VALUES
IMAN_manifestation Prevents the attachment of manifestations to replica items
and item revisions.

IMAN_reference Prevents the attachment of references to replica items and


item revisions.

IMAN_UG_altrep Prevents the attachment of UG Altreps to replica items and


item revisions.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_do_not_define_sites_on_import

DESCRIPTION
Specifies whether or not sites that are not defined in an importing sites database are
automatically defined when objects are imported to the site from a hub site.
Use this preference to prevent sites that are unknown to each other, such as supplier
sites, from being automatically defined in the importing site’s database, for example:

• Supplier sites ABC and XYZ exchange data through hub site HUB. The hub site
is defined in both site ABC’s and site XYZ’s database. Site ABC is not define in
site XYZ’s database and site XYZ is not defined in site ABC’s database because
they are unknow to each other.

• Site ABC exports a replica object to the hub site. Site XYZ imports site ABC’s
replica object from the hub site. By default, the import process defines site ABC in
site XYZ’s database making the site information visible to the site XYZ users.

• Define this preference at site XYZ with site ABC as the value. This prevents
site ABC from being defined in site XYZ’s database during the import process
and prevents users at site XYZ from seeing information about site ABC. Do the
same for site XYZ at site ABC to prevent uses at either site from knowing about
the other site.

VALID
VALUES
One or more strings, for example:
SupplierABC

The name must be a valid Teamcenter site name.


DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 20-35


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_do_not_insert_imported_objects_into_folder

DESCRIPTION
Determines whether imported objects are added to the user's home folder. This
preference affects imported objects pushed to a specific user at a remote site and
objects imported by the user using the item_import utility.
In situations where the home folder contains thousands of objects, set this preference
to TRUE to improve performance.
VALID
VALUES
TRUE Imported objects are not inserted into the specific user's home
folder. Objects are stored in the database with no reference to
any folder. To locate the imported objects, users must search
the database.
FALSE Imported objects are inserted into the specific user's home
folder.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_EMAIL_AFTER_BACKGROUND_REMOTE_IMPORT

DESCRIPTION
Controls whether an e-mail notification is sent after completion of a background
remote import operation.
The e-mail address must be defined in the person object of the user who started the
remote import. Otherwise, an e-mail is not sent.
VALID
VALUES
TRUE An e-mail notification is sent after completion of a background
remote import operation.
FALSE An e-mail notification is not sent after completion of a
background remote import operation.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

20-36 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

Tc_export_pfmember_replica

DESCRIPTION
Determines whether part family member replicas can be exported, or remote imported,
from a remote site to another remote site. This preference applies when exporting or
remote importing assemblies containing the part family member replica components.
VALID
VALUES
TRUE Allows the export of part family member replica components.
FALSE Does not allow the export of part family member replica
components.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_external_app_reg_url

DESCRIPTION
Contains the URL for of the Application Registry Web application (WAR file)
deployment. This value is required to enable Teamcenter-to-Teamcenter remote
inbox functionality.
For information more about installing and deploying the Application Registry Web
application, see the Application Registry and the Teamcenter Interoperability guide.
Teamcenter administrators with valid WebKey accounts can access the Teamcenter
Interoperability guide at the following location:
http://support.ugs.com/docs/tc_eng/8/en/tss00004.pdf
VALID
VALUES
A single string as a value representing the URL of the ApplicationRegistry.war file
This must be in the following format:
http://appserver-host:port-number/ApplicationRegistry
DEFAULT
VALUES
None
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_follow_ownership_chain_max_site_count

DESCRIPTION
Sets a limit on the number of sites that are queried before a replica’s owner is
designated as unknown. When the site known as the owning site returns a new
owning site, the report function queries the new owning site for the replica’s state.

PLM00026 11.2 Preferences and Environment Variables Reference 20-37


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

This activity continues until the owning site returns the replica’s state or the value
set in the preference is reached. When the limit is reached the function checks the
TC_on_demand_sync_broadcast_mode preference to determine whether to use
broadcast mode or to designate the ownership as unknown.
VALID
VALUES
You may use any integer value up to the number of known sites.
No limit Specifies Multi-Site shall continue to query for the replicas
owner until all known sites are queried.
DEFAULT
VALUES
No limit
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_force_remote_sites_exclude_files

DESCRIPTION
Determines if the exporting site sends replica files to the file server cache (FSC) or
stores it in the volume. The exporting site interrogates the importing site for the
this preference value. Therefore, this preference impacts the exporting site only for
online cases.
VALID
VALUES
TRUE Stores the replica files in the FSC.
FALSE Stores the replica files in the volume.
DEFAULT
VALUE
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
• The TC_force_remote_sites_exclude_files preference does not override the
display of any options in the rich client. It is a silent override.

• This preference must be set at the importing site.

TC_hub_groups

DESCRIPTION
Defines replication behavior for sharing data via Multi-Site Collaboration hubs. The
replication behavior is managed by assigning hub clients (sites connected to a hub for
data sharing purposes) to arbitrary hub groups.
The following rules govern behavior of hub group memberships. Given the following
example:

20-38 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

TC_hub_groups=
Company 1:partner
Company 2:partner
Company 3:supplier
Company 4:supplier

• When the site importing from the hub, and the real owning site of the replica
being imported from the hub, are in the same hub group, then the requesting site
receives its copy directly from the real owning site. In the above example, assume
Company 1 sends a replica of Item 1 to the hub. If Company 2 replicates Item 1
from the hub, the hub does not send Item 1 to Company 2, but redirects the request
to Company 1 because Company 1 and Company 2 are in the same hub group.

This behavior applies to components when importing a whole assembly. However,


for Company 2 to automatically receive components owned by Company 1, the
Include Distributed Components import/export command must be selected;
otherwise, the components owned by Company 1 are stubbed at Company 2.

• When the site importing from the hub and the real owning site of the replica
being imported from the hub are in different hub groups, then the requesting site
receives its copy from the hub (which is normal hub replication behavior). In the
above example, assume that Company 1 sends a replica of Item 1 to the hub. If
Company 3 tries to replicate Item 1 from the hub, the hub sends a replica of Item 1
to Company 3 because Company 1 and Company 3 are in different hub groups.

• When publishing a replica that resides on the hub when the owning site of the
replica and the target ODS are in the same hub group, the publication is not
allowed. If the owning site and the target ODS are in different hub groups, the
publication is allowed.

In the above example, assume each site has its own ODS that is accessible from
the hub. Also assume that Company 1 sends a replica of Item 1 to the hub. If a
user logged onto the hub tries to publish Item 1 to the ODS of Company 2 the
publication is not allowed because Company 1 and Company 2 are in the same hub
group. Presumably, Company 1 and Company 2 are already sharing data directly
with each other and there is no need to share replicas via the hub. Alternatively, if
the user is logged onto the hub and tries to publish Item 1 to the ODS of Company
3, then the publication is allowed. This enables Company 1 to search Company
3's ODS and still receive its replicas from the hub and not from Company 3.

VALID
VALUES
Accepts one or more strings as values. Define the preference only in the hub
database, using the following format:

TC_hub_groups=
site1:hub group1
site2:hub group2
site3:hub group3
Where site is the name of the hub client site. Do not enter the hub site itself as a value.

PLM00026 11.2 Preferences and Environment Variables Reference 20-39


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

And where hub group is a user-assigned name (maximum 32 characters) used


for grouping client sites; such customer-defined grouping is the suggested method
of managing replication and publication behavior for data shared via Multi-Site
Collaboration hubs.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_identify_plmxml_import_dataset

DESCRIPTION
Specifies the relation name, dataset type, and the named reference that identifies
the dataset used to parse the named reference PLM XML file and identify the item
revisions to be imported.
VALID
VALUES

Note

Although this preference accepts multiple string values, this to allow importing
any PLM XML file. For use with controlled replication of structured context
objects, this preference must be a single string containing the dataset type,
relation name, and named reference type.

Multiple string values delimited by colons (:) representing any existing dataset type,
relation name, and named reference type in the following format:
<dataset-type>:<relation>:<named-reference—type>

If a named reference type is not specified, ConfiguredAssembly is used.


DEFAULT
VALUES
DirectModelAssembly:IMAN_reference:ConfiguredAssembly
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
All values in the preference must exist in the Teamcenter database.
NOTES
Modify this preference value when the attached PLM XMLL dataset must be processed
for import using a specific relation, dataset type, and named reference for your
business needs.

20-40 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

TC_idsm_client_def_timeout

DESCRIPTION
Sets the basic timeout interval, in seconds, before network nodes (clients) attempting
to connect to the IDSM terminate the request. This timeout value is used for all
subsequent IDSM requests.
VALID
VALUES
Single numerical value. Siemens PLM Software recommends 300.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_idsm_client_initial_timeout

DESCRIPTION
Sets the basic timeout interval, in seconds, before network nodes (clients) attempting
to connect to the IDSM terminate the request. This timeout value is used for the initial
request to the IDSM; this may take longer than subsequent requests.
VALID
VALUES
Single numerical value. Siemens PLM Software recommends 300.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_idsm_proxy_server_site_table

DESCRIPTION
Maps the target site ID with its real node name so that the proxy server can redirect a
requesting site's first remote procedure call (RPC) message to the target site.
VALID
VALUES
This preference must list all sites (both client sites and server sites) that use the proxy
host. This list provides the information needed to map site IDs to their real node
names. The list is also used to discriminate against clients that are not authorized to
use the proxy host. The proxy denies access to any requesting site not on the site
table list. For example:
TC_idsm_proxy_server_site_table=
Site 1 ID:real-node-name-for-Site 1
Site 2 ID:real-node-name-for-Site 2

PLM00026 11.2 Preferences and Environment Variables Reference 20-41


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

Site ID is the site ID of either an internal or external site that uses the proxy host and
real-node-name-for-Site is the actual node name for the site ID.
The IP address can be used instead of the node name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_ie_error_report

DESCRIPTION
Determines whether a failure report is created. This preference is automatically
set by the system when users select the Save Options As Default option in the
Synchronization Preferences dialog box.
Tip

While it is possible for users to manually set this preference through the
Options dialog box accessed from the Edit menu, or for administrators to
manually edit the tc_preferences.xml file, this is not the suggested practice.

The dialog box allows users to perform on-demand synchronization (as opposed to
administrative-based synchronization using utilities, or automatic synchronization
which only occurs when the master object is modified.) This functionality provides
users with immediate visual confirmation that the synchronization has succeeded or
failed. Access the dialog box by choosing Multi-Site Collaboration→Synchronize
from the Tools menu, or right-clicking on object and choosing Multi-Site
Synchronization from the shortcut menu.
VALID
VALUES
TRUE A failure report is generated.
FALSE A failure report is not generated.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
User preference.

TC_master_locale_<site_name>

DESCRIPTION
Specifies the master language for the given site defined in the site pane of the
Organization application. This language is used as the locale for exports to the site or
as the locale when importing from the specified remote site to the local site.

20-42 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

This preference must be set for all monolingual sites in a Multi-Site environment that
also contains multilingual sites. This includes monolingual Teamcenter 8.2 sites and
sites that are running pre-Teamcenter 8.2 versions.
VALID
VALUES
Accepts the standard Java language codes consisting of a two-character language
string and a two-character country string separated by an underscore character. Each
string must be one of the following codes indicating the desired locale:
cs_CZ
de_DE
en_US
es_ES
fr_FR
it_IT
ja_JP
ko_KR
ru_RU
zh_CN
zh_TW
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_modified_only_export

DESCRIPTION
Prevents a user from turning off the Include Modified Objects Only button in the
Import/Export Options dialog box. This option usually results in better overall
import/export efficiency. This preference does not apply when running command-line
utilities such as the item_export or the data_share utility.
Note

This preference is a behind-the-scenes preference that is created when a user


selects various import/export options; it is used internally by the system and
should not be modified.

VALID
VALUES
Defined by the system.
DEFAULT
VALUES
Not applicable.
DEFAULT
PROTECTION
SCOPE
Role preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-43


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

TC_Multisite_tcxml_TOS_Mapping

DESCRIPTION
Provides a map of the export site transfer option set (TOS) to the import site TOS
that Multi-Site uses for TC XML transfers. The preference allows execution of
postactions registered in the import transfer mode for Multi-Site TC XML-based
imports. Postactions allow you to set up utilities, such as the appmodel_fix_scope
utility, to run automatically after a low-level TC XML import.
To use this preference, the import postaction must be specified as the action rule
in the import site TOS.
For information about creating a TOS for this preference, see Multi-Site Collaboration.
VALID
VALUES
One or more pairs of comma-delimited strings, for example:
ExportingSiteOptionSet,ImportingSiteOptionSet
DEFAULT
VALUES
MultiSiteExpOptSet,MultiSiteImpOptSet
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_ods_client_extra_attributes

DESCRIPTION
Specifies and describes extra attributes of an object being published that you want
stored in the publication record. Only string attributes can be specified. The attribute
must have an initial value.
When adding custom attributes to the publication record, you may want to populate
these extra attributes when an object is published. For example, a new security
level attribute is added to the publication record and you want to specify where the
publication code retrieves the security information associated with the object being
published.
Use this preference for attributes that are part of the object’s extended attributes (or
any attributes from the Master form, if the object is an item or item revision).
In multifield key (MFK) environments, this preference must be defined on the ODS
client side and must contain the required publication record key attributes.
Note

When the custom attribute is not part of the object or its master form, you must
implement a user exit to populate the custom publication record attributes.

VALID
VALUES
Accepts multiple strings as values. Each string must be in the following format:
class-name::object-POM-attribute:pub-record-POM-attribute:option

20-44 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

class-name Specifies the name of the class that defines the


po_pom_attr_name attribute. This is required only
if po_pom_attr_name is used in multiple classes, in
which case you must qualify the attribute name. This
entry is optional and is normally not used.
object-POM-attribute Specifies the POM name of the extra non-array string
attribute of the object being published. This should
either be part of the class definition of the object or
part of its master form (for items and item revisions).
This entry is required.
pub-record-POM-attribute Specifies the POM name of the extra non-array string
attribute of the publication record class where the
value of po_pom_attr_name is stored. This should
be part of the publication record class definition at
both client and server sides. This entry is required.
Note

This attribute name cannot start with pubr,


which is reserved for internal use.

option Indicates whether an extra attribute is mandatory or


not. To indicate that an extra attribute is mandatory,
set the option value to MANDATORY. This is an
optional entry; if given, the attribute is assumed to be
optional. This value may also be set to EXTERNAL
to indicate that the attribute is not published from this
site but should be returned by a search operation. In
this case, the po_pom_attr_name should be same
as pr_pom_attr_name.
For example:
form_attr1:security:MANDATORY
immutable:immutable:EXTERNAL
DEFAULT
VALUES
None.
Note

If left undefined, no extra attributes are published through preference


settings. Publications of extra attributes can still be performed through the
USER_ods_client_publish_extra_attributes user exit.

DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-45


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

TC_ods_client_def_timeout

DESCRIPTION
Sets the basic timeout interval, in seconds, before network nodes (clients) attempting
to connect to the Object Directory Services (ODS) terminate the request. This timeout
value is used for all subsequent ODS requests.
VALID
VALUES
Single numerical value. Siemens PLM Software recommends 300.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_ods_client_initial_timeout

DESCRIPTION
Sets the basic timeout interval, in seconds, before network nodes (clients) attempting
to connect to the Object Directory Services (ODS) terminate the request. This timeout
value is used for the initial request to the ODS; this may take longer than subsequent
requests.
VALID
VALUES
Single numerical value. Siemens PLM Software recommends 300.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_ods_proxy_server_site_table

DESCRIPTION
Maps the target site ID with its real node name so that the proxy server can redirect a
requesting site's first remote procedure call (RPC) message to the target site.
VALID
VALUES
This preference must list all sites (both client sites and server sites) that use the proxy
host. This list provides the information needed to map site IDs to their real node
names. The list is also used to discriminate against clients that are not authorized to
use the proxy host. The proxy denies access to any requesting site not on the site
table list. For example:
TC_ods_proxy_server_site_table=
Site 1 ID:real-node-name-for-Site 1
Site 2 ID:real-node-name-for-Site 2

20-46 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

Site ID is the site ID of either an internal or external site that uses the proxy host and
real-node-name-for-Site is the actual node name for the site ID.
The IP address can be given instead of the node name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_on_demand_sync_broadcast_mode

DESCRIPTION
Controls the report function's query scope when the site known by the current site as
the owning site denies ownership.
VALID
VALUES
TRUE Queries all known sites to find the owner (broadcast mode).

FALSE Performs sequential queries to sites in the ownership


chain until it reaches the limit designated by the
TC_follow_ownership_chain_max_site_count preference.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_ownership_export

DESCRIPTION
Prevents a user from transferring site ownership by disabling the Transfer Ownership
button in the Import/Export Options dialog box.

Note

This preference is a behind-the-scenes preference that is created when a user


selects various import/export commands; it is used internally by the system
and should not be modified.

VALID
VALUES
Defined by system.
DEFAULT
VALUES
Not applicable.

PLM00026 11.2 Preferences and Environment Variables Reference 20-47


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

TC_plmxml_import_item_filter

DESCRIPTION
Specifies a property and its associated value used to prevent certain not up-to-date
item revisions from being imported during controlled replication. If this preference is
not set, all item revisions are imported.
VALID
VALUES
Multiple string values delimited by colons (:) representing any BOMLine property used
as the filtering value in the following format:
<identifier>:<value>

If multiple values are specified for the same property, the first value processed is used.
DEFAULT
VALUES
None
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
For the GM Overlay, the preference is set to bl_item_object_type:CORP_vehicle.

TC_plmxml_sync_dataset

DESCRIPTION
Specifies the relation name, dataset type, and the named reference that must be
used to create datasets using the existing PLM XML file. Also, relates the PLM XML
to the structure context object (SCO), or root item revision of a configured assembly,
for which it is generated.
VALID
VALUES
String value delimited by colons (:) representing any existing dataset type, relation
name, and named reference type in the following format:
<dataset-type>:<relation>:<named-reference—type>

If a named reference type is not specified, ConfiguredAssembly is used.


DEFAULT
VALUES
DirectModelAssembly:IMAN_reference:ConfiguredAssembly
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
All values in the preference must exist in the Teamcenter database.

20-48 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

NOTES
Modify this preference value when the PLM XML ataset must be attached using a
specific relation, dataset type, and named reference for your business needs.

TC_post_export_script

DESCRIPTION
Automatically compresses export data using the standard_post_export_script.pl
script when a user performs a local export operation using any of the following
methods:

Object Export command


item_export utility
Customized ITK program that exports objects via OBJIO functions

If this preference is not defined, no compression occurs.

Note

This script does not apply during remote export, which employs a different
compression/decompression method.

VALID
VALUES
Complete path name of script. If only the script name is given, the script is assumed to
be stored in the TC_BIN directory.
DEFAULT
VALUES
standard_post_export_script.pl (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_pre_import_script

DESCRIPTION
Automatically decompresses export data using the standard_post_export_script.pl
when a user performs an import operation using any of the following methods:

Files→Import→Objects command
item_export utility
Customized ITK program that exports objects via OBJIO functions

If this preference is not defined, no decompression occurs.

Note

This script does not apply during remote import, which employs a different
compression/decompression method.

PLM00026 11.2 Preferences and Environment Variables Reference 20-49


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

VALID
VALUES
Complete path name of script. If only the script name is given, the script is assumed to
be stored in the TC_BIN directory.
DEFAULT
VALUES
standard_post_export_script.pl (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_preserve_original_owner_on_sync

DESCRIPTION
Determines whether the owning user and group of a replica are kept the same as
that of the master copy when synchronizing an object. This preferences is used by
the data_sync utility to determine the owning user and group at a replica site when
synchronizing changes to an object.
VALID
VALUES
One of any logical pair (true or false, on or off, 0 or 1).

TRUE The owning user and group are updated at the replica site when
the master object ownership changes, for example:

1. At the master site, the obj001 item is owned by the


designer1 user. Replicate the object to the target site and
the replica obj001 object is owned by the designer1 user.

2. At the master site, change the obj001 object owner to the


designer2 user and add a dataset to the item revision also
owned by the designer2 user.

3. Run the data_sync utility with the


TC_preserve_original_owner_on_sync preference set
to TRUE at the replica site. The owner of the replicated
obj001 item is changed to the designer2 user and a
dataset is added to the item revision also owned by the
designer2 user.

Note

The owning user and group must be defined at


both the master and replica site to synchronize the
ownership at the replica site. Otherwise, the replica
ownership does not change.

FALSE The owning user and group are preserved at the replica site
when the master object ownership changes.

20-50 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

DEFAULT
VALUES
None.
Note

If no value is defined for this preference, synchronization uses the FALSE value
behavior.

DEFAULT
PROTECTION
SCOPE
Site preference.

Tc_preserve_replica_pfmember_ownership

DESCRIPTION
Determines whether part family members created at a site, which are based on
a replica part family template, is owned by the master site or the local site. This
preference is applicable when creating part family members from Teamcenter
Integration for NX.
VALID
VALUES
TRUE Part family members are created with the same site ownership
as that of their template.
FALSE Part family members are created with the local site ownership.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_publish_item_or_itemrev

DESCRIPTION
Controls the publication behavior of item revision objects. When you select an item
revision object to publish, by default, Teamcenter publishes only the item revision
object. You can change this behavior to publish the parent item object of the item
revision object or both the item revision object and its parent item object.
VALID
VALUES
1 Teamcenter publishes only the item revision object.
2 Teamcenter publishes only the parent item of the item revision object.
3 Teamcenter publishes both the parent item and the item revision object.
DEFAULT
VALUES
1

PLM00026 11.2 Preferences and Environment Variables Reference 20-51


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

DEFAULT
PROTECTION
SCOPE
Role preference

Tc_publish_pfdata_with_assemblies

DESCRIPTION
Determines how part family data is published when publishing assemblies. This
preference can also be set by system administrators in the Options dialog box,
accessed from the Edit menu. General users can set this preference from the
Options dialog box only if the Tc_allow_users_edit_pfdata_options preference is
set to TRUE.

Note

This preference is effective only when publishing assembly level items with the
include BOM option.

VALID
VALUES
Members Publishes part family member components in the assembly.

Templates Publishes part family templates rather than the part family
member components in the assembly.

Both Publishes both part family member components and part family
templates in the assembly.

None Publishes neither part family member components nor part


family templates in the assembly.
DEFAULT
VALUES
Members
DEFAULT
PROTECTION
SCOPE
All.

Tc_publish_pfmembers_with_pftemplate

DESCRIPTION
Determines whether to publish related part family member items when
publishing part family template items. This preference can also be set by
system administrators in the Options dialog box, accessed from the Edit menu.
General users can set this preference from the Options dialog box only if the
Tc_allow_users_edit_pfdata_options preference is set to TRUE.

Note

This preference is effective only when publishing part family template items.

20-52 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

VALID
VALUES
TRUE Publishes the corresponding part family member items.
FALSE Does not publish the corresponding part family member items.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
All.

Tc_publish_pftemplate_with_pfmember

DESCRIPTION
Determines whether to publish corresponding part family templates when
publishing part family member items. This preference can also be set by
system administrators in the Options dialog box, accessed from the Edit menu.
General users can set this preference from the Options dialog box only if the
Tc_allow_users_edit_pfdata_options preference is set to TRUE.
Note

This preference is effective only when publishing part family member items.

VALID
VALUES
TRUE Publishes the corresponding part family templates.
FALSE Does not publish the corresponding part family templates.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
All.

TC_publishable_classes

DESCRIPTION
Defines Teamcenter classes that can be published to the Object Directory Services
(ODS) site.
VALID
VALUES
One or more strings. Each string must be one of the following Teamcenter class
names or None.
Item
Dataset
Form
Folder

PLM00026 11.2 Preferences and Environment Variables Reference 20-53


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

If the preference is not defined, only items can be published. If set to a single value
of None, publication is disabled; other Multi-Site Collaboration operations can still
be performed.
DEFAULT
VALUES
Item
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_publishable_<business-object-name>_contexts

DESCRIPTION
Defines contexts to publish for a given business object type. If the context of the
identifier object matches the contexts specified in the preference, identifiers that are
attached to the business object are published to the Object Directory Service (ODS)
when the object is published. You must define this preference to publish alternate ID
information to the ODS for a specific type of business object. This allows alternate ID
values to be used as search criteria for remote objects.
Note

If you set the ITEM_autopublish preference to TRUE, creating an Item object or


any Item subtype objects publishes the Item or Item subtype object to the ODS
site specified in the ITEM_autopublish_sites preference. However, alternate
identifiers for the objects are not sent as part of the published information. You
must publish the objects manually to publish the alternate ID information.

Note

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


require this functionality, you must create the preference.

For information about creating and using preferences, see Teamcenter Basics.
Tip

Siemens PLM Software recommends that you use the following values when
creating this preference:
• Protection Scope: Site
• Environment: Disabled
• Category: MultiSiteCollaboration

You must select String from the Type list and Multiple from the Multiple box.
VALID
VALUES
The preference name must be in the form:
TC_publishable_business-object-name_contexts

business-object-name represents a valid Teamcenter business object context.

20-54 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

The preference values must be valid Teamcenter identifier types. For example, to
publish Ident0001 identifier types for the IDContext business object context:
TC_publishable_Ident001_contexts=IDContext001
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_reference_update_lmd

DESCRIPTION
Determines whether the last modified date of a locally owned item revision is updated
when an object with an associated reference relation is modified.
The last modified date of the parent item is automatically updated as a consequence
of the associated item revision update.
VALID
VALUES
TRUE The last modified date of the item revision is modified when an
object with an associated reference relation is modified.
FALSE The last modified date of the item revision is not modified when
an object with an associated reference relation is modified.
DEFAULT
VALUES
TRUE (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_rendering_update_lmd

DESCRIPTION
Determines whether the last modified date of a locally owned item revision is updated
when an object with an associated rendering relation is modified.
The last modified date of the parent item is automatically updated as a consequence
of the associated item revision update.
VALID
VALUES
TRUE The last modified date of the item revision is modified when an
object with an associated rendering relation is modified.
FALSE The last modified date of the item revision is not modified when
an object with an associated rendering relation is modified.
DEFAULT
VALUES
TRUE (Commented out).

PLM00026 11.2 Preferences and Environment Variables Reference 20-55


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_relation_export_on_transfer

DESCRIPTION
Determines which interpart relation types are included when an object is
exported/imported regardless of whether the export is a replica or with transfer of
ownership.
If the exporting site and the importing site have conflicting rules, the rule at the
exporting site prevails. For example, if the importing site does not require the
manifestation relation but the exporting site does, manifestations are included.
Caution

Relations that are in this preference override relations that are also included in
the TC_relation_required_on_transfer preference.
To avoid having replicated participants missing in the Assign Participants
dialog box, do not include the HasParticipant relation in this preference value.

VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
relation. An exception is the IMAN_RES_checkout relation, which is not a valid value
for this preference.
DEFAULT
VALUES
IMAN_master_form
IMAN_requirement
IMAN_specification
IMAN_ic_intent
IMAN_CCContext
IMAN_StructureContent
IMAN_SCTypeData
TC_Attaches
TCCalendar_Rel_Type
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_relation_required_on_export

DESCRIPTION
Determines which relation types are included when an object is exported/imported
without transfer of site ownership.

20-56 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

If the exporting site and the importing site have conflicting rules, the rule at the
exporting site prevails. For example, if the importing site does not require the
manifestation relation but the exporting site does, manifestations are included.

Caution

To avoid having replicated participants missing in the Assign Participants


dialog box, do not include the HasParticipant relation in this preference value.

VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
relation. Excepting the IMAN_RES_audit and IMAN_RES_checkout relations, which
are not valid values for this preference.

NONE is also a valid value, indicating there are no required relation types for export,
except for the implied relation types listed above.
DEFAULT
VALUES
IMAN_master_form
IMAN_requirement
IMAN_specification
IMAN_ic_intent
IMAN_CCContext
IMAN_StructureContent
IMAN_SCTypeData
TC_Attaches
TCCalendar_Rel_Type
The IMAN_master_form and IMAN_ic_intent_rtype relation types are implied entries
in this preference and cannot be excluded.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_relation_required_on_transfer

DESCRIPTION
Determines which relation types are included when an object is exported/imported
with transfer of site ownership.

If the exporting site and the importing site have conflicting rules, the rule at the
exporting site prevails. For example, if the importing site does not require the
manifestation relation but the exporting site does, manifestations are included.

Caution

Use this preference for relation types that are required for ownership transfer.
Do not include any relation type required for ownership transfer in the
TC_relation_export_on_transfer preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-57


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
relation. Excepting the IMAN_RES_checkout relation, which is not a valid value
for this preference.
NONE is also a valid value, indicating there are no required relation types for export,
except for the implied relation types listed above.
DEFAULT
VALUES
IMAN_master_form
IMAN_requirement
IMAN_specification
IMAN_RES_audit
IMAN_ic_intent
IMAN_CCContext
IMAN_StructureContent
IMAN_SCTypeData
TC_Attaches
TCCalendar_Rel_Type
IMAN_vi_linked_module
IMAN_vi_sos
IMAN_classification
Fnd0ShapeRelation
The IMAN_master_form, IMAN_ic_intent_rtype and IMAN_RES relation types are
implied entries in this preference and cannot be excluded.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_remote_checkin_assy_option

DESCRIPTION
Determines how the system manages newly added components when a remotely
checked out BOM view revision (BVR) or item revision is remotely checked in. The
typical use case is for a remote user to remotely check out a BVR to add new
components owned by the local site (the site adding the component). When the
BVR is remotely checked in, this preference determines how these locally owned
components are handled.
Warning

This preference is deprecated as of Teamcenter 10.1.1 and will be removed in a


future release. This functionality has been replaced by options in the standard
Teamcenter Import and Export Options dialog boxes. To avoid behavior that
is inconsistent with user intent, Siemens PLM Software recommends that you
do not use this preference.

20-58 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

VALID
VALUES
0 The components are stubbed upon remote check in. A copy is
not sent to the site that owns the BVR. Instead, at the owning
site, the component is replaced by a POM stub. When the
assembly containing the BVR is opened at the owning site via
Structure Manager, the application prompts the user to remotely
import the component.
1 The components are sent to the owning site as replicas. Site
ownership of the components remains with the site performing
the remote check in.
2 Site ownership of the components is transferred to the site
that owns the BVR. The components at the site performing the
remote check in become replicas.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
User.

TC_remote_checkin_exclude_relations

DESCRIPTION
Determines which relations prompt the system not to transfer attachments as part of
the replica when a parent object is remotely checked in.
How the system checks in locally attached objects is determined both by this
preference and the relations added to the Include Reference list. The Include
Reference list defines the types of related objects to be imported and exported. The
list displays in the Advanced tab of the Multi-Site Collaboration, Import Remote
section of the Options dialog box, accessed from the Edit menu.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid Teamcenter relation.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_remote_checkin_preserve_replica_owning_user_and_group

DESCRIPTION
Determines how ownership is assigned to replica revisions upon checkin. This
preference must be set at both sites to take effect.

PLM00026 11.2 Preferences and Environment Variables Reference 20-59


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

Note

If this preference is set at only the owning site (and not also at the remote site),
the preference acts as if it was not set.

Warning

Do not set this preference to TRUE at the remote site and FALSE at the owning
site. In this situation, the system displays an error.

VALID
VALUES
TRUE The ownership assigned to the replica revision is preserved,
regardless of which user checks in the replica.
For example, consider an item created at Site A by User 1.
A remote export is performed on the item with transfer of
ownership to Site B User 1.
User 1 at Site A then checks out the item, revises Rev1 of the
item, and checks it back in. User 1 at Site A then checks out
Rev2 of the item, changes ownership of the item to User 2 at
Site B, and checks it back in. Both Site A and Site B see the
ownership of Rev2 is User 2.
Note

In this example, User 1 must be a valid user at both sites


and User 2 must be a valid user at both sites.

FALSE The user checking in the replica is assigned ownership,


regardless of any ownership assignments made by the user.
This preserves the concept of unified ownership.
For example, consider an item created at Site A by User 1.
A remote export is performed on the item with transfer of
ownership to Site B by User 1.
User 1 at Site A then checks out the item, revises Rev1 of the
item, and checks it back in. User 1 at Site A then checks out
Rev2 of the item, changes ownership of the item to User 2 at
Site B, and checks it back in. Site A sees the ownership of Rev2
as User 2, but Site B sees the ownership of Rev2 as User 1.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

20-60 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

TC_remote_checkin_relation_send_as_replica

DESCRIPTION
Determines which relations prompt the system to transfer attachments as part of the
replica when a parent object is remotely checked in.
How the system checks in locally attached objects is determined both by this
preference and the relations added to the Include Reference list. The Include
Reference list defines the types of related objects to be imported and exported. The
list displays in the Advanced tab of the Multi-Site Collaboration, Import Remote
section of the Options dialog box, accessed from the Edit menu.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid Teamcenter relation.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_replication_exclude_types

DESCRIPTION
Specifies a list of item types that are ignored by the replication process that uses PLM
XML data contents to individually synchronize objects.
Modify this preference value if you must omit specific item types from replication.
VALID
VALUES
Any existing item type.
DEFAULT
VALUES
There is no default value.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_replica_volume

DESCRIPTION
Identifies the volume where replica files are placed upon import. Use to direct all replica
files into a specific volume. This volume does not need to be backed up because they
are replica files, you can retrieve a copy from the owning site if you lose any of the
files. You can also use operating system facilities to determine which files have not
been accessed for a certain period of time, thereby determining unnecessary replicas.
VALID
VALUES
Single valid volume name.

PLM00026 11.2 Preferences and Environment Variables Reference 20-61


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

TC_retain_group_on_import

DESCRIPTION
Determines group ownership of the import. When importing an object to a site where
the original object's user and group are not defined, the replicated object's owning
group is defined as the importing user's group.
To preserve the replica's group ownership even when the original owning user is not
defined locally (but the group is defined locally) set to TRUE.
VALID
VALUES
TRUE Retains group ownership of the import when the owning group
of the original object is define locally.
FALSE General rules of replica ownership applies.
DEFAULT
VALUES
TRUE (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_split_shared_status_on_replication

DESCRIPTION
Determines whether to split the release status when replicating a object that has a
shared release status that references the item revision and its related dataset objects.
For exports with ownership transfer, the shared release status is always split.
VALID
VALUES
TRUE Replicated objects have shared release status split from the
related objects. The release status references only the item
revision at both the remote and owning site.

20-62 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

FALSE Replicated objects do not have the shared release status object
split from the related objects. The release status references
the item revision and all related objects at both the remote and
owning site.
Caution

Setting this preference value to TRUE increases the


chance of an instance in use error occurring during
Multi-Site operations, especially when objects with
release statuses are replicated at the same time by
different users.

DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_stub_dataset_files_after_ownership_transfer

DESCRIPTION
Specifies whether replica files are stubbed at the original owning site when the
ownership is transferred to another site. The Multi-Site transfer of ownership feature
creates full ImanFile objects at the new owning site and adds full operating system
files to the volume. This preference indicates whether the original owning site has the
option to stub the replica ImanFile objects and purge the files from the volume.
VALID
VALUES
TRUE Allows the replica files to be stubbed at the original owning site.
FALSE Forces the full object files to remain on the original owning
site's volume.
DEFAULT
VALUE
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_subscribable_replica_classes

DESCRIPTION
Defines the list of WorkspaceObject classes whose replicas can be subscribed to
for update notification. When users subscribe to the Replica Updated event for a
replica object at a replica site, they are notified when the replica is updated due to
re-import or synchronization. The notification is sent only for the objects of classes
defined by this preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-63


Chapter
Chapter 20:20:Data Data sharing
sharing preferences
preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid workspace object
implementation class, such as ItemImpl, ItemRevisionImpl, DatasetImpl,
DocumentImpl, DocumentRevisonImpl.

Note

In the case of the item and item revision classes, Teamcenter accepts the object
class (Item, ItemRevision) in addition to the object implementation class.

DEFAULT
VALUES
None. When not defined, no subscription functionality for replicas is enabled.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_sync_max_assy_level

DESCRIPTION
Defines the maximum assembly level reported when performing synchronization
in Report Only mode from the Synchronization Preferences dialog box. This
preference affects only the number of levels displayed in the report, not the maximum
assembly level synchronized.

This preference is automatically set by the system when users select the Save
Options As Default option in the dialog box.

Tip

While is possible for users to manually set this preference through the Options
dialog box accessed from the Edit menu, or for administrators to manually edit
the tc_preferences.xml file, this is not the suggested practice.

The dialog box allows users to perform on-demand synchronization (as opposed to
administrative-based synchronization using utilities, or automatic synchronization
which only occurs when the master object is modified.) This functionality provides
users with immediate visual confirmation that the synchronization has succeeded or
failed. Access the dialog box by choosing Multi-Site Collaboration→Synchronize
from the Tools menu, or right-clicking on object and choosing Multi-Site
Synchronization from the shortcut menu.
VALID
VALUES
-1 All assembly levels are reported.

Any positive integer The number of levels specified by the integer is reported.
DEFAULT
VALUES
-1

20-64 Preferences and Environment Variables Reference PLM00026 11.2


Data sharing preferences

DEFAULT
PROTECTION
SCOPE
User preference.

TC_sync_projects_with_owning_site

DESCRIPTION
Controls the synchronization of the project list of replicas with the project list of the
master object when projects are removed at the owning site.
By default, if one or more projects are removed from the master object, Teamcenter
does not change the project list for the replica object during synchronization. This
allows the replica to maintain a project list independent of the master object. However,
if the master object has no projects assigned, Teamcenter removes all projects from
the replica object.
This preference overrides the default behavior. For push operations, you must define
the preference at the remote IDSM site. For pull operations, you must define the
preference at the local importing site.
Note

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


require this functionality, you must create the preference.

Tip

Siemens PLM Software recommends that you use the following values when
creating this preference:
• Protection Scope: Site

• Category: Data Sharing.Multi-Site Collaboration

• Environment: Disabled

You must select String from the Type list and Multiple from the Multiple box.

VALID
VALUES
Accepts one or more strings as values. Acceptable values are:
• FALSE
Overrides the default behavior of removing projects from the replica object when
there are no projects assigned to the master object. This allows the replica object
to maintain a project list when the master object has no projects assigned to it.
FALSE must be the only entry for the preference.

• ALL
Indicates that for all owning sites, when a project is removed from the master
object project list, that project is also removed from the replica object list; and

PLM00026 11.2 Preferences and Environment Variables Reference 20-65


Chapter
Chapter 20:20:Related
Related topics
topics

when all projects are removed from the master object, all projects are removed
from the replica object.

• site-name
Indicates the ALL value behavior applies to the specified site. You can enter a list
of sites, one site name per line. Invalid site names are ignored.
The default behavior applies to all sites not specified.

DEFAULT
VALUES
None.
If this preference is not defined, the default behavior applies to all sites.
DEFAULT
PROTECTION
SCOPE

Site preference.Related topics

• What are preferences?

TC_sync_revision_rules

DESCRIPTION
Defines the revision rules which display in the Synchronization Preferences dialog
box. If not defined, all available revision rules appear.
The dialog box allows users to perform on-demand synchronization (as opposed to
administrative-based synchronization using utilities, or automatic synchronization
which only occurs when the master object is modified.) This functionality provides
users with immediate visual confirmation that the synchronization has succeeded or
failed. Access the dialog box by choosing Multi-Site Collaboration→Synchronize
from the Tools menu, or right-clicking an object and choosing Multi-Site
Synchronization from the shortcut menu.
In the dialog box, users select a revision rule from the Revision Rule list. The selected
revision rule is passed to the owning site of the selected component and is used by the
owning site to determine which item revision to synchronize. It is a required field if the
object selected for synchronization is an item.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter revision
rule.
DEFAULT
VALUES
None. If not defined, all available revision rules appear in the revision rule list.

20-66 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_transfer_area

DESCRIPTION
Sets the directory for temporarily storing data during import and export. If not set, the
current working directory is used to store data during import and export.
VALID
VALUES
Full OS path to the directory.
This string can be a single line value, for example:
TC_transfer_area=
/tmp

This string can also contain multiple lines to support a heterogeneous site. In this case,
Teamcenter uses the first valid value for the platform (UNIX or Windows). Validity is
determined by the presence of a backslash (\). For example, where the Windows path
uses C: as the drive letter, the preference is set for both UNIX and Windows as:
TC_transfer_area=
/tmp
c:\temp

Note

UNC paths are specified with a triple backslash. When the Windows path is
specified in UNC format, the preference for both UNIX and Windows is defined
as:
TC_transfer_area=
/tmp
\\\hostx\share_area

DEFAULT
VALUES
/tmp
Note

Typically, the /tmp directory is a volatile area of the file system. Files in this
directory can be deleted when the system is rebooted. Siemens PLM Software
strongly recommends setting up another permanent transfer directory and
setting this preference to that directory.

DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-67


Chapter
Chapter 20:20:Related
Related topics
topics

TC_truncate_file_name

DESCRIPTION
Determines if truncation of an original file name is necessary. Implement so Multi-Site
Collaboration can transport data between releases.
VALID
VALUES
TRUE Truncates the original file name to the length of 30.
FALSE Does not truncate the original file name to the length of 30. Only
set to FALSE if all sites are running V7.0 or higher.
DEFAULT
VALUES
TRUE (Commented out).
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_use_group_admin_as_default_replica_owner

DESCRIPTION
Determines whether the owning user of an imported object is the group administrator
of the owning group when the owning user is not a member of the owning group at
the importing site.
For example: the master copy at the owning site (Site 1) is owned by the user Joe,
in the Design group, and it is imported at Site 2, where Joe is not a member of the
Design group. If this preference is set to TRUE, the system searches the list of group
administrators for the Design group at Site 2, assigning ownership to the first group
administrator in the list.
VALID
VALUES
TRUE Assigns ownership of an imported object to the group
administrator of the owning group when the owning user is not a
member of the owning group at the importing site.
FALSE General rules of replica ownership applies.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_validate_stub_tickets

DESCRIPTION
Determines whether Teamcenter validates stub tickets and has the site where the
associated file was transferred generate a new stub ticket for any found to be invalid.

20-68 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
TRUE Validates stub tickets.

FALSE Does not validate stub tickets.


DEFAULT
VALUE
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
The frequency of synchronizing POM_stub objects with owning ImanFile objects is a
determining factor for setting this preference. The overwhelming majority of the time,
Teamcenter can find the file in local whole file cache. Rarely, Teamcenter must seek
the file in the owning site’s volume or in the FSC. There is a chance the file is absent
from the owning site’s volume due to a recently performed ownership transfer to a third
site. To ensure a stub ticket is valid, the Teamcenter site that the file was transferred to
must generate the latest stub ticket, which requires a LAN/WAN trip to the owning site.
The generated ticket can be used to search the file under the local whole file cache.
This sacrifices performance by requiring a LAN/WAN trip to the owning site to generate
the ticket for every POM_stub object.

Data Exchange preferences

Alt_id_default_idContext_type

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

Alt_id_default_identifier_type

DESCRIPTION
Specifies a default Identifier type. This is required for import operations when the
type is not specified by a user.

PLM00026 11.2 Preferences and Environment Variables Reference 20-69


Chapter
Chapter 20:20:Related
Related topics
topics

VALID
VALUES
Accepts multiple strings as values. Must be a valid Identifier type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

BRIEFCASE_export_CAD_incomplete

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

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


require this functionality, you must create the preference.
For information about creating and using preferences, see Teamcenter Basics.

Tip

Siemens PLM Software recommends that you use the following values when
creating this preference:
• Protection Scope: Site
• Category: General
• Environment: Disabled

You must select Logical from the Type box and Single from the Multiple box.

VALID
VALUES
One of any logical pair (true or false, on or off, 0 or 1).
TRUE CAD incomplete assemblies are allowed in briefcase export
files. The success of the operation depends on the completion
of the ug_clone utility process.
FALSE CAD incomplete assemblies are blocked from briefcase export
files and Teamcenter generates an error message indicating the
export failed because the CAD is not complete.
DEFAULT
VALUE
None.

20-70 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PREFERENCE
SCOPE
Siemens PLM Software recommends this preference be restricted by site.

BRIEFCASE_import_validation_rule_item

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

Note

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


require this functionality, you must create the preference.
For information about creating and using preferences, see Teamcenter Basics.

Tip

Siemens PLM Software recommends that you use the following values when
creating this preference:
• Protection Scope: Site
• Category: General
• Environment: Disabled

You must select String from the Type box and Single from the Multiple box.

VALID
VALUES
Two strings separated by a slash (/) character that identify a ValidationRule dataset
under the item revision. The strings are:
ItemID Identifies the item related to the dataset containing the validation rules,
for example:
000167

RevID Identifies the revision of the item related to the dataset containing the
validation rules, for example:
B

For this example, the value is:


000167/B
DEFAULT
VALUE
None.

PLM00026 11.2 Preferences and Environment Variables Reference 20-71


Chapter
Chapter 20:20:Related
Related topics
topics

DEFAULT
PREFERENCE
SCOPE
Siemens PLM Software recommends this preference be restricted by site.

Briefcase_pkg_file_name

DESCRIPTION
Defines the file name format for briefcase packages (named references attached to
dataset objects). The format is based on the keywords representing attributes of the
object being exported. The format is any combination of one or more of the attributes
specified in the following valid values and any text string representing a constant in
the file name.
VALID
VALUES
Any text string The text forms a part of the package file name. Add SPLM as a
prefix for the following format:
SPLM_00001_A_Site1_31-Sep-2011_19-48-30.bcz

ItemID The item ID attribute forms a part of the package file name.
Add ItemId as the attribute following the prefix for the following
format:
BCZ_00001_A_assembly1_31-Sep-2011_19-48-30.bcz

RevID The revision ID attribute forms part of the package file name.
Add RevID as the second attribute for the following format:
BCZ_00001_A_Site1_31-Sep-2011_19-48-30.bcz

ItemName The object’s item name forms part of the package file name.
Add ItemName as the third attribute for the following format:
BCZ_00001_A_assembly1_31-Sep-2011_19-48-30.bcz

TargetSite The remote site name forms part of the package file name. Add
TargetSite as the third attribute for the following format:
BCZ_00001_A_Site1_31-Sep-2011_19-48-30.bcz

TimeStamp The time stamp forms part of the package file name. Add
TimeStamp as the last attribute for the following format:
BCZ_00001_A_assembly1_31-Sep-2011_19-48-30.bcz
DEFAULT
VALUE
BCZ:ItemId:RevId:TargetSite:TimeStamp
DEFAULT
PROTECTION
SCOPE
Site preference.

GMS_expired_or_locked_ada_licenses_bypass

DESCRIPTION
Controls the check for expired or locked license status by the TC XML importer when
importing an object with an ADA License. License objects must already exist at the

20-72 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

importing site to be attached to an object during import. The importing process does
not allow an expired or locked license to be attached to an object. You can use this
preference to allow the importer to bypass the license status check.
Note

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


require this functionality, you must create the preference.

For information about creating and using preferences, see Teamcenter Basics.
Tip

Siemens PLM Software recommends that you use the following values when
creating this preference:
• Protection Scope: Site
• Environment: Disabled
• Category: TC XML Import Export.Import

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

GMS_offline_use_TcGS

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

PLM00026 11.2 Preferences and Environment Variables Reference 20-73


Chapter
Chapter 20:20:Related
Related topics
topics

DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

GMS_tcxml_string_separator

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

GMS_UID_mapping_dbname_index

DESCRIPTION
Lists the databases for remote Teamcenter Enterprise sites involved in data exchange.
The indices of the databases specified are used for generating unique object UIDs
in PLM XML.
VALID
VALUES
Enter values as instance-name:dbname1, dbname2, for example, svli60:sum501a.
To determine these values, search the Teamcenter Enterprise fmsmaster.xml file for
the accesson id value, for example, accesson id = “rhgtpqksvli60sum501a-aaG”.
Split this value as follows:
1. Drop the last three characters (aaG).

2. In the remaining string, record the last eight characters (ignore any hyphens) as
the dbname value, for this example, sum501a.

3. Record the next six characters as the instance name, for this example, svli60.

20-74 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

GMS_UID_mapping_remote_site_index

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

GS_USER_NAME

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

GS_USER_PASSWORD

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

PLM00026 11.2 Preferences and Environment Variables Reference 20-75


Chapter
Chapter 20:20:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
Site preference.

PDX_pkg_file_name

DESCRIPTION
Specifies the format for the name of the PDX package file when exported from
Teamcenter. The format of the preference value is (all values are optional):
PDX-string:ItemId:RevId:ItemName:TargetSite:TimeStamp

Note

You can use the following keywords in this preference.

• ItemId

• ItemName

• RevId

• TargetSite

• TimeStamp

VALID
VALUES
PDX-string PDX-string is a string constant prefixed to the package file
name of each exported package. You can use this to identify
the package as desired, such as by the originating site.
ItemId Includes the item ID of the exported object as part of the
package file name.
ItemName Includes the item name of the exported object as part of the
package file name.
RevId Includes the revision ID of the exported object as part of the
package file name.
TargetSite Includes the site name the object exported to as part of the
package file name.
TimeStamp Includes the time stamp information at the time the object is
exported as part of the package file name.
Any combination of values is valid. The following are a few examples:
PDX:ItemId:RevId:ItemName:TargetSite
PDX:ItemId:ItemName:TargetSite
ItemId:RevId:ItemName
PDX:ItemId:RevId:ItemName:TargetSite:TimeStamp

20-76 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Note

Based on the last example, the package file name for the 000303/A Mem_Assy
object package, exported to the Zurich site is:
PDX_00001_A_Mem_Assy_Zurick_4-Feb-2008_18-14-00.pdx

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

SRM_hostname_portnumber

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

TC_default_gms_site

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

PLM00026 11.2 Preferences and Environment Variables Reference 20-77


Chapter
Chapter 20:20:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_default_gms_transfer_mode

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

TC_gms_import_default_transfermode

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

TC_gms_enable_immediate_option

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

20-78 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
Role preference.

TC_gms_export_default_transfermode

DESCRIPTION
Specifies the PLM XML transfer mode used when exporting from Briefcase.
VALID
VALUES
Accepts a single string as a value. Must be a valid PLM XML import transfer mode.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_gms_export_transfermode_for_<site_name>

DESCRIPTION
Specifies the export transfer mode for a specific site. If this preference is not set, the
transfer mode specified by the TC_gms_export_default_transfermode preference
is used.
VALID
VALUES
Accepts a single string as a value. Must be a valid PLM XML transfer mode.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_gms_gs_bos_service_url

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

PLM00026 11.2 Preferences and Environment Variables Reference 20-79


Chapter
Chapter 20:20:Related
Related topics
topics

TC_gms_gs_server_url

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

TC_gms_gs_uri

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

TC_gms_monitoring_gui_total_number_of_steps_for_transfer

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

20-80 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

TC_gms_sso_enabled

DESCRIPTION
Determines whether Global Services uses Security Services to provide single sign-on
(SSO) capability. If this preference is not set to true, the following preferences must
be set to provide user credentials for Global Services:
• GS_USER_NAME

• GS_USER_PASSWORD
VALID
VALUES
true SSO is enabled for Global Services.
false SSO is not enabled for Global Services. User ID and password
preferences must be defined so that users can log onto Global
Services.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

TIE_allow_import_with_different_SML

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

TIE_Attachment_Window_Filter

DESCRIPTION
Lists the Generic Relationship Management (GRM) rules to consider when fetching
BOM line attachments. This improves performance by limiting the exported BOM line

PLM00026 11.2 Preferences and Environment Variables Reference 20-81


Chapter
Chapter 20:20:Related
Related topics
topics

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

TIE_exp_pending_object

DESCRIPTION
Determines whether to export a pending object as a full replica or as a stub. When
Data Exchange is performing an export, it sets an export lock for the affected objects
at the beginning of the transfer. If a second export is initiated while a previous export
that contains the same object is pending, the object lock is still set by the pending
transfer. If this preference is set to export pending objects as a stub, it causes Data
Exchange to export the object as a POM_stub object containing only the object's
identifying information.

Caution

If this preference is set to false (or not set), a pending object that is exported as
a stub can cause a transfer to be incomplete or to fail. To avoid this problem,
set the preference to true.

VALID
VALUES
true Exports the object as a full replica.

false Exports the object as stub.


DEFAULT
VALUE
false
DEFAULT
PROTECTION
SCOPE
Site preference.

20-82 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

TIE_fast_traversal

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

TIE_itemrev_infer_delete_skip

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

Then the import process infers that the additional revisions found at the importing site
no longer exist and deletes them (infer delete function).
Note

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


require this functionality, you must create the preference.

For information about creating and using preferences, see Teamcenter Basics.

PLM00026 11.2 Preferences and Environment Variables Reference 20-83


Chapter
Chapter 20:20:Related
Related topics
topics

Tip

Siemens PLM Software recommends that you use the following values when
creating this preference:
• Protection Scope: Site
• Environment: Disabled
• Category: TC XML Import Export.Import

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

TIE_reference_objects_list

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

bo_name Name of a Teamcenter business object.


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

20-84 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TIE_validate_against_xsd

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

PLM XML preferences


BOMWriter_export_key_properties

DESCRIPTION
Specifies whether the multifield key (MFK) properties defined for objects are included
in a BOMWriter export file. If your Teamcenter environment does not have objects that
can have duplicate item_id attributes (MFK properties), you may set this preference to
FALSE.
VALID
VALUES
TRUE All the multifield key properties for exported objects are included
in the BOMWriter export file.
FALSE Only a single key property for exported object is included in the
BOMWriter export file.
RESTRICTIONS
Multifield key functionality must be enabled for your Teamcenter sites participating in
data sharing sites when this preference set to TRUE.
DEFAULT
VALUES
TRUE

PLM00026 11.2 Preferences and Environment Variables Reference 20-85


Chapter
Chapter 20:20:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
User preference.

BOMWriter_write_boundingbox

DESCRIPTION
Enables the export of bounding box information during a bomwriter utility export.
VALID
VALUES
True Exports bounding box information during a bomwriter utility
export.
False Does not export bounding box information during a bomwriter
utility export.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

PIE_<transfer_mode_name>_process_in_chunks

DESCRIPTION
Specifies which objects unload in batches. Users can set this preference to unload
objects they no longer need in memory to improve performance. This preference
is used in conjunction with the PIE_<transfer_mode_name>_unload_objects
preference.
Users must create a preference for each transfer mode type from which they want
to unload objects, and set the preference with values specifying which object types
are unloaded in batches. For example:
PIE_sampleExport_unload_objects=
all
VALID
VALUES
Accepts the following object types as values. Alternatively, users can
specify all to indicate that all objects defined in the corresponding
PIE_<transfer_mode_name>_unload_objects preference are unloaded in batches.
Value entries are case-sensitive.
ImanItemBOPLine
BOMLine
Item
ItemRevision
Form
Dataset
RecordObject

20-86 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

PIE_<transfer_mode_name>_unload_objects

DESCRIPTION
Specifies which objects to unload from memory and in what order. Users can set this
preference to unload objects they no longer need in memory to improve performance.
Caution

If users unload objects, such as BOM lines, needed by other rich client functions
or features, errors might occur. Ensure all objects are saved to the database
before unloading.

Users must create a preference for each transfer mode type from which they want to
unload objects, and set the preference with values specifying object types are to be
unloaded. For example:
PIE_sampleExport_unload_objects=
ImanItemBOPLine
BOMLine
Item
ItemRevision

Caution

These preferences define the processing order of the specified objects and the
forced unloading of the same objects. (The first object listed as a value, is
processed first, the second is processed second, and so on.) If objects are
unloaded in an improper order, the existence of dependent objects cannot be
translated and their child objects are bypassed, even if closure rules specify
traversal of these objects. Users must know which objects can be processed
and unloaded first, and list the objects in the correct order, or errors will occur.

VALID
VALUES
Accepts the following object types as values. Value entries are case-sensitive.
ImanItemBOPLine
BOMLine
Item
ItemRevision
Form
Dataset
RecordObject
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 20-87


Chapter
Chapter 20:20:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
User preference.

PIE_allow_import_with_different_sml

DESCRIPTION
Controls the import behavior when the site master language of the exporting site does
not match that of the importing site. By default, if the site master language in the .xml
file does not match the importing site’s site master language, the PLM XML import is
allowed. To deny the import, set the preference value to false.
VALID
VALUES
True Allows PLM XML import if the site master language in the .xml
file does not match the importing site’s site master language.

False Prohibits PLM XML import if the site master language in the .xml
file does not match the importing site’s site master language.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

PIE_Extra_Error_Info_to_Xml

DESCRIPTION
Determines whether to throw an exception on the client side with the body containing
the errors logged in the PLM XML import/export (PIE) log file. Set this to YES if you
want to see the results of a PLM XML import.
VALID
VALUES
YES Throws an exception on the client side with the body of the
exception containing the errors logged in the PLM XML
import/export (PIE) log file.

SUCCESS Adds the success elements to the log file in addition to any
errors.

NO Does not log errors or successes.


DEFAULT
VALUES
NO
DEFAULT
PROTECTION
SCOPE
All.

20-88 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

PIE_IMF_FOR_CAD

DESCRIPTION
Determines whether PLM XML import/export functionality uses the IMF ITK function,
or the ug_clone utility to import/export CAD files from ImanVolume.
VALID
VALUES
YES Uses the IMF ITK function to import/export CAD data files.
NO Uses the ug_clone utility to import/export the following dataset
types: UGMASTER, UGPART, UGALTREP, UGSCENARIO,
and NXSIMULATION.
DEFAULT
VALUES
YES
DEFAULT
PROTECTION
SCOPE
Site preference.

PIE_transfermode_languages

DESCRIPTION
Specifies a default list of languages that are associated with a transfer mode. These
languages are included when the associated transfer mode is used for export, unless
otherwise excluded by the user.
VALID
VALUES
Values should be organized in the following format:
<TransferMode_name><:><language1,language2, …>.

The language must follow the standard Java locale naming conventions: the locale
2letterlanguage_2LETTERAREA.
For example:
ConfiguredDataExportDefault:en_US,fr_FR
BOMWriterExport:en_US,de_DE,zh_CN
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site and user preference.
RESTRICTIONS
This preference is valid only during export, so the preference value should only specify
export transfer modes.

PLMXML_continue_on_error

DESCRIPTION
Determines whether import and export operations continue after an error has occurred.

PLM00026 11.2 Preferences and Environment Variables Reference 20-89


Chapter
Chapter 20:20:Related
Related topics
topics

VALID
VALUES
TRUE The import or export operation continues when there is an
import or export error.
FALSE The import or export operation aborts when there is an import
or export error.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
User preference.

PLMXML_export_key_properties

DESCRIPTION
Specifies whether the multifield key properties defined for objects are included in
the PLM XML export file. If your Teamcenter environment does not have objects
that can have duplicate item_id attributes (multifield key properties), you may set
this preference to FALSE.
VALID
VALUES
TRUE All the multifield key properties for exported objects are included
in the PLM XML export file.
FALSE Only a single key property (item_id) for exported object is
included in the PLM XML export file.
RESTRICTIONS
Multifield key functionality must be enabled for your Teamcenter sites participating in
data sharing when this preference value is TRUE.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
User preference.

PLMXML_export_packed_bom_<transfer-mode-name>

DESCRIPTION
Determines whether the assembly should be unpacked before a PLM XML export
using the transfer mode specified in the preference name.
Warning

When you export a packed BOM, you may lose data in the exported XML file.
Therefore, do not import an XML file with a packed BOM into Teamcenter.
Change this preference value only if you plan to use the XML file in a third-party
application and want to improve export performance.

20-90 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
TRUE The assembly remains packed for the PLM XML export.

FALSE The assembly is unpacked before the PLM XML export.


DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
User preference.

PLMXML_IC_Delta_export_transfermodes

DESCRIPTION
Specifies the list of transfer modes that can be used for incremental change (IC) based
PLM XML exports and the mode of export (Delta or Full) to use with each transfer
mode.
When a user selects any of the listed transfer modes when performing a PLM XML
export, instead of full assembly, only the objects that are directly/indirectly affected by
IC objects along with the object’s parental hierarchy and descendants are exported.
Both the Delta and Full modes initiate the export of ICs, but the Delta mode filters out
the lines that are not affected by ICs, whereas the Full mode does no filtering.
VALID
VALUES
Multiple strings containing a transfer mode name and the export mode separated
by a colon, for example:
ICDeltaExportDefault:Delta
The name can be any transfer mode for IC-based delta export that includes the basic
minimum closure rules required for IC-based delta export to work properly.
The export mode valid values are Delta or Full.
DEFAULT
VALUES
ICDeltaExportDefault:Delta
DEFAULT
PROTECTION
SCOPE

Site preference.Related topics

• Closure rules for incremental change exports

PLM00026 11.2 Preferences and Environment Variables Reference 20-91


Chapter
Chapter 20:20:Related
Related topics
topics

PLMXML_import_default_password

DESCRIPTION
Defines the password used while importing a new user using PLM XML.

For security reasons, PLM XML does not export passwords to XML files. By default,
during import, new users are created with the user name and password the same. If
strong password preferences are set at the target site, importing users may fail. If your
site uses strong password rules, define the value of this preference with a password
that satisfies your site's rules. The system imports all user objects with the password
defined by this preference.

Note

Each new user should change their password upon initial logon.

VALID
VALUES
Accepts a single string as a value. Must be a password that meets the importing
site's password rules.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLMXML_log_file_content

DESCRIPTION
Determines the amount of information added to the PLM XML translation log. During
large PLM XML translations, full logging can consume significant resources and
generates a large memory footprint. Optimize performance by tuning the log file
behavior through this preference.

Note

The PLM XML translation log is always generated, enabling analysis of


translation performance, and signaling you when the translation is complete.
The minimum amount of information you can tune the system to provide is the
translation header and a list of any errors generated.

VALID
VALUES
basic Logs the translation header and a list of any errors generated.
This setting generates the least overhead for translation
reporting.

summary Logs the translation header, summary, warnings, and a list of


any errors generated.

20-92 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

detailed Logs the translation header, summary, warning, errors, and a


closure rule analysis report. This setting generates the most
overhead for translation reporting.
DEFAULT
VALUES
summary
DEFAULT
PROTECTION
SCOPE
Site preference.

PLMXML_overwrite_objects_on_import

DESCRIPTION
Determines whether an imported object overwrites an existing version of the same
object at the local site. Only writable properties of the object is overwritten when this
preference is set to YES. The user requires write access for an overwrite to occur.
VALID
VALUES
YES The import operation overwrites the database copy of the object
with the contents of the PLM XML file.
NO The import operation ignores the contents of the PLM XML file
for existing objects. New objects are created normally.
DEFAULT
VALUES
NO
DEFAULT
PROTECTION
SCOPE
User preference.

PLMXML_put_objects_in_newstuff_on_import

DESCRIPTION
Determines whether data imported via PLM XML is automatically stored in the
Newstuff folder.
VALID
VALUES
TRUE After a successful PLM XML import, a folder is created in the
Newstuff folder using the name of the imported .xml file. The
imported objects are copied to that folder. Only the root objects
represented by the traverseRootRefs attribute of the Header
element in the PLM XML file are copied. For example, when the
following test.xml file is imported, objects pointed to by id2 are
copied to the folder named test.xml in the NewStuff folder:
<Header id="id1" traverseRootRefs="#id2"
transferContext="TestTransferMode"></Header>

FALSE Data imported via PLM XML is not stored in the Newstuff folder.
Data is located using the Search command.

PLM00026 11.2 Preferences and Environment Variables Reference 20-93


Chapter
Chapter 20:20:Related
Related topics
topics

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

PLMXML_put_pie_log_in_syslog

DESCRIPTION
Specifies whether the contents of the PLM XML import/export (PIE) log file is copied to
the syslog file or not. This PIE log file is in the same location as the PLM XML file of
the same name and contains the results of any PLM XML import or export transaction.
VALID
VALUES
TRUE All messages that are printed to the PLM XML import/export
(PIE) log file are also recorded in the syslog file.
FALSE All messages that are printed to the PLM XML import/export
(PIE) log file are not recorded in the syslog file.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
User preference.

PLMXML_sdk_threshold

DESCRIPTION
Defines the number of live PLM XML objects that exist at one time before serialization
of the objects occurs. Serialization writes the objects to the disk then loads them
back on command. Because excessive serialization can degrade performance,
Siemens PLM Software recommends you enable serialization only for larger structures
(exceeding a 3 GB process limit) to optimize performance.
VALID
VALUES
Any positive integer, for example, 100000 or 1000000.
DEFAULT
VALUES
None. (No serialization.)
DEFAULT
PROTECTION
SCOPE
User preference.

20-94 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

PLMXML_use_pre_plm_appname

DESCRIPTION
Determines the Teamcenter product name used during PLM XML export. Use this
preference when exporting PLM XML data between Teamcenter 2007 (or later) and
earlier versions of Teamcenter.
Teamcenter 2007 (or later) PLM XML data writes the product name as Teamcenter
and earlier versions writes the product name as TcEng. During PLM XML export, the
product name is identified for each transfer mode and thus the product name written
for any given transfer mode differs with product versions.
Use this preference to list the transfer modes to be exported to earlier versions of
Teamcenter. The product name will be written as TcEng for the transfer modes
specified as values of this preference, allowing Teamcenter 2007 PLM XML data to be
exported to earlier Teamcenter versions.
For more information about using transfer modes and PLM XML export functionality,
see PLM XML/TC XML Export Import Administration.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid transfer mode
name.
DEFAULT
VALUES
None. (The product name is written as Teamcenter during PLM XML export.)
DEFAULT
PROTECTION
SCOPE
User preference.

TC_export_child_groups

DESCRIPTION
Determines whether child groups are exported along with the selected group during
PLM XML export. Set this preference to OFF to improve performance if groups at your
site contain a large number of child groups.
VALID
VALUES
ON Enables export of child groups when exporting groups using
PLM XML.
OFF Disables export of child groups when exporting groups using
PLM XML.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-95


Chapter
Chapter 20:20:Related
Related topics
topics

TC_export_parent_groups

DESCRIPTION
Determines whether parent groups are exported along with the selected group during
PLM XML export. Set this preference to OFF to improve performance when groups at
your site have a large number of parent groups.
VALID
VALUES
ON Enables export of parent groups when exporting groups using
PLM XML.
OFF Disables export of parent groups when exporting groups using
PLM XML.
DEFAULT
VALUES
ON
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP Translator preferences


STEP_<relation_type>

DESCRIPTION
Supports only the STEP AP214. These preferences have names of the relation types
as their values. These values represent a relation type and are used to determine
the Teamcenter and user-defined relation types from the relation-type part of the
preference.
VALID
VALUES
One or more strings; each string must be a valid relation type.
DEFAULT
VALUES
IMAN_specification
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_approved_status

DESCRIPTION
Supports only STEP AP214. Sets the defined item type as approved. Imports
approved STEP data into Teamcenter as in-process data. This is accomplished by
defining a list of strings that, when detected during import, denote approved status.
VALID
VALUES
One or more strings.

20-96 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
approved
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_default_BOMView_type

DESCRIPTION
Serves as an error recovery mechanism that allows assembly import when the
BOMView type cannot be determined because either the frame_of_reference field
has no meaningful name or the name is not in the set of view names.
The STEP processor uses the product_definition_context_frame_of_reference
field to determine the BOMView type.
If the frame_of_reference field has no meaningful name (it is either blank or empty
string), the translator fails to create the BOM view, and the assembly structure is lost.
If the frame_of_reference field entry is a name that is not in the set of view names
and the user does not have permission to create a new view name, the BOM view
and its attendant assembly structure is dropped. In these circumstances, use this
preference to allow the assembly to be imported.
VALID
VALUES
DEFAULT
VALUES
used
DEFAULT
PROTECTION
SCOPE

STEP_default_datasettype

DESCRIPTION
Supports only STEP AP214. Used to retrieve the default dataset type name when it
cannot be obtained from the Teamcenter database via the dataset tool tag or inferred
from the file extension.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
Text
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-97


Chapter
Chapter 20:20:Related
Related topics
topics

STEP_default_item_type

DESCRIPTION
Obtains the default Teamcenter item type. Used as an argument to create an item
entity of Teamcenter, in the database.
VALID
VALUES
DEFAULT
VALUES
Item
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_design_specification_pref

DESCRIPTION
Maps Teamcenter dataset types to the STEP design specification classification.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
Text
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_drawing_pref

DESCRIPTION
Maps Teamcenter dataset types to the STEP drawing classification.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
UGPART
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_cad_filename_pref

DESCRIPTION
Maps Teamcenter dataset types to the STEP CAD file classification.

20-98 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
UGMASTER
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_export_data_format

DESCRIPTION
Sets STEP data format used for this export operation.
VALID
VALUES
AP203
AP214
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_export_directory

DESCRIPTION
Sets export (destination) directory when exporting data via the Teamcenter/STEP
Translator. This is where the STEP physical file is written.
VALID
VALUES
Single string; must be the full operating system path to the directory.
DEFAULT
VALUES
Current working directory.

STEP_FILETYPE_2_DATATYPE

DESCRIPTION
Serves as an error recovery mechanism when a dataset cannot be created because
the descriptive_representation_item field either does not contain the name of a tool
in the list of Teamcenter tools, or the named tool is not associated to a dataset type.
Pre-V7.0.2, the STEP AP214 processor used the descriptive_representation_item
field to determine which dataset type is associated to external files. If this field did not
contain the name of a tool in the list of tools, or if the named tool was not associated to
a dataset type, the dataset is not created and the external file is dropped. In these
circumstances, use this preference as an error recovery method.

PLM00026 11.2 Preferences and Environment Variables Reference 20-99


Chapter
Chapter 20:20:Related
Related topics
topics

If the STEP AP214 translator cannot find an appropriate tool, it try to infer the correct
tool from the file extension. Use this preference to define a list of file types and tool
names that the AP214 translator use to assign the appropriate tool and dataset type.
VALID
VALUES
One or more strings, in the following format:
extension_name1 whitespace tool_name1
extension_name2 whitespace tool_name2
extension_name3 whitespace tool_name3

extension_name* is a file extension without the dot character, whitespace is any


amount of space without a new line character, and tool_name is a valid Teamcenter
tool that is associated with a dataset type.
The string NULL_EXTENSION is a special extension name and is reserved for files
that may not have an extension. For example:
STEP_FILETYPE_2_DATATYPE=
doc Text
model CATIA_Part
prt UGMASTER
NULL_EXTENSION UGPART
DEFAULT
VALUES
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_DMI_markup

DESCRIPTION
Maps Teamcenter dataset types to the STEP DMI_markup classification.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
Markup
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_IMAN_master_data

DESCRIPTION
Maps Teamcenter dataset types to the STEP IMAN_master_data file classification.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
Mdata

20-100 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_IMAN_specification

DESCRIPTION
Maps Teamcenter dataset types to the STEP IMAN_specification file classification.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
Specs
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_IMAN_manifestation

DESCRIPTION
Maps Teamcenter dataset types to the STEP IMAN_manifestation file classification.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
Manif
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_IMAN_requirement

DESCRIPTION
Maps Teamcenter dataset types to the STEP IMAN_requirement file classification.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
Requi
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-101


Chapter
Chapter 20:20:Related
Related topics
topics

STEP_IMAN_reference

DESCRIPTION
Maps Teamcenter dataset types to the STEP IMAN_reference file classification.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
Refer
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_IMAN_UG_altrep

DESCRIPTION
Maps Teamcenter dataset types to the STEP IMAN_UG_altrep classification.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
Altrep
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_IMAN_UG_scenario

DESCRIPTION
Maps Teamcenter dataset types to the STEP IMAN_UG_scenario classification.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
Scena
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_import_directory

DESCRIPTION
Sets location of STEP physical file when importing data via the Teamcenter/STEP
Translator.

20-102 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
Single string; must be the full operating system path to the directory.
DEFAULT
VALUES
Current working directory.
DEFAULT
PROTECTION
SCOPE

STEP_informative_doc_role

DESCRIPTION
Supports only STEP AP214. Determines the document role of the dataset based on its
defined relation type to the specified item revision. The default role is obligatory if the
relation type is not listed under this preference.
VALID
VALUES
One or more strings; each string must be a valid informative relation type (for example,
IMAN_reference).
DEFAULT
VALUES
IMAN_specification
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_make_or_buy_attr

DESCRIPTION
Defines the item revision master attribute that stores the STEP make_or_buy value
for item revisions imported via the Teamcenter/STEP Translator.
VALID
VALUES
Single string; must be a valid item revision master attribute.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_material_specification_pref

DESCRIPTION
Maps Teamcenter dataset types to the STEP material specification classification.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.

PLM00026 11.2 Preferences and Environment Variables Reference 20-103


Chapter
Chapter 20:20:Related
Related topics
topics

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_not_yet_approved_status

DESCRIPTION
Supports only STEP AP214. Sets the item type as not yet approved. Use this
preference to import not yet approved STEP data into Teamcenter as working data.
Do this by defining a list of strings that, when detected during import, denote not yet
approved status.
VALID
VALUES
One or more strings.
DEFAULT
VALUES
not_yet_approved
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_part_items

DESCRIPTION
Defines the Teamcenter item type as a member of the STEP part classification.
VALID
VALUES
One or more strings; each string must be a valid item type name.
DEFAULT
VALUES
item
DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_process_specification_pref

DESCRIPTION
Maps Teamcenter dataset types to the STEP process specification classification.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
None.

20-104 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
Site preference.

STEP_surface_finish_specification_pref

DESCRIPTION
Maps Teamcenter dataset types to the STEP surface finish specification classification.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter dataset type name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_organization_id

DESCRIPTION
Defines an organizational identifier for your enterprise.
VALID
VALUES
Single string as value; string must be a valid organization ID.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 20-105


Chapter 21: Product structure preferences

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

DesignContext preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1


General RDV preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1
EPM_tessellation_target_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1
EPM_tessellation_servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1
LOU_display_name_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-2
PortalDesignContextProcess.WorkPartProperties . . . . . . . . . . . . . . . . . . . . . . . . . 21-2
PortalDesignContextProcess.WorkPartOrChangeAttachmentTypes . . . . . . . . . . . . . 21-2
RDV_audit_report_usage_attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-3
RDV_audit_report_occurrence_attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-4
RDV_authoring_override_user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-5
RDV_auto_functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-6
RDV_auto_populate_occ_notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-6
RDV_build_intent_atth_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-7
RDVCreateSCOForClearance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-8
RDV_Create_SCO_WITHOUT_APN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-8
RDV_copied_occurrence_notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-8
RDV_Copy_Variability_For_SaveAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-9
RDV_default_Architecture_Breakdown_RevRule . . . . . . . . . . . . . . . . . . . . . . . . . . 21-9
RDV_enable_product_lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-10
RDV_export_nve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-10
RDVIgnoreErrorConnectReleasedPartsServer . . . . . . . . . . . . . . . . . . . . . . . . . . 21-11
RDV_install_configuration_rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-11
RDV_occurrence_business_rule_check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-12
RDV_part_business_rule_check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-12
RDV_set_default_3DBox_dimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-12
RDV_set_default_3DBox_search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-13
RDV_set_default_3D_Manipulator_ON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-13
RDV_default_find_inside_parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-14
RDV_default_find_intersecting_parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-14
RDV_set_default_slider_increment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-14
RDV_set_default_true_shape_filtering_ON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-15
RDV_set_default_use_selections_from_tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-15
RDV_show_targets_on_results_dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-16
RDV_show_targets_on_spatial_dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-16
RDV_partnumber_validation_rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-17
RDV_part_occ_note_mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-17
RDV_product_code_mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-17
RDV_user_defined_units_of_measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-18
RDVReleasedPartsProcessAssemType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-18
RDVReleasedPartsCollectorServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-19
RDV_show_itemid_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-19

PLM00026 11.2 Preferences and Environment Variables Reference


RDV_show_lou_prop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-20
RDV_turn_audit_logging_on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-20
RDV_uneditable_part_occ_notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-20
RDV_usage_attribute_set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-21
RDV_usage_occurrence_notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-21
RDV_valid_partnumber_rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-22
RDV_variant_expression_overlap_checking_mode . . . . . . . . . . . . . . . . . . . . . . . 21-22
RDV_variant_overlays_uses_true_availability . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-23
BOMWriterDirectModelRelationType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-23
BOMWriterNoDescendantsInPLMXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-23
BOMWriterNoDirectParents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-24
DesignContext product item preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-25
PortalDesignContextConsiderProductItemQuery . . . . . . . . . . . . . . . . . . . . . . . . . 21-25
PortalDesignContextProductItemProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-26
PortalDesignContextProductItemProperties.<attribute-value> . . . . . . . . . . . . . . . . 21-27
PortalDesignContextProductItemColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . 21-27
PortalDesignContextProductItemColumnsShownPrefWidth . . . . . . . . . . . . . . . . . . 21-28
PortalDesignContextProductItemColumnsHiddenPref . . . . . . . . . . . . . . . . . . . . . . 21-29
PortalDesignContextProductItemColumnsHiddenPrefWidth . . . . . . . . . . . . . . . . . . 21-31
DesignContextRDVContextObject AddToECObjectPseudo FolderPreference . . . . . . 21-33
DesignContext product context preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-33
DesignContextBOMWriterNoDescendantsInPLMXML . . . . . . . . . . . . . . . . . . . . . . 21-33
DesignContextLoadRDVContextObjectMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-34
DesignContextPickUpNewBackgroundAppearance . . . . . . . . . . . . . . . . . . . . . . . 21-34
RDVLoadAppearanceGroupMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-34
PortalDesignContextProductContextProperties . . . . . . . . . . . . . . . . . . . . . . . . . . 21-35
PortalDesignContextProductContextColumnsShownPref . . . . . . . . . . . . . . . . . . . 21-36
PortalDesignContextProductContextColumnsShownPrefWidth . . . . . . . . . . . . . . . 21-36
PortalDesignContextProductContextColumnsHiddenPref . . . . . . . . . . . . . . . . . . . 21-37
PortalDesignContextProductContextColumnsHiddenPrefWidth . . . . . . . . . . . . . . . 21-39
DesignContext context definition preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-41
PortalDesignContextProductItemQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-41
PortalDesignContextECObject.TYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-42
PortalDesignContextECObject.WorkPartProperties . . . . . . . . . . . . . . . . . . . . . . . 21-42
PortalDesignContextECObject.WorkPartRelationships . . . . . . . . . . . . . . . . . . . . . 21-43
PortalDesignContextExcludedWorkPart.Types . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-44
PortalDesignContextAllowNoWorkParts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-44
PortalDesignContextIsInstallationAssemblyMethod . . . . . . . . . . . . . . . . . . . . . . . 21-45
PortalDesignContextIsInstallationAssemblyMethod.hasIRType.Type . . . . . . . . . . . . 21-46
PortalDesignContextIsInstallationAssemblyMethod.has_bomline_prop.name . . . . . . 21-46
PortalDesignContextIsInstallationAssemblyMethod.has_bomline_prop.value . . . . . . 21-47
PortalDesignContextFindInstallationTreeWalkIncrement . . . . . . . . . . . . . . . . . . . . 21-47
PortalDesignContextSupportInstallationAssemblySelection . . . . . . . . . . . . . . . . . . 21-47
PortalDesignContextUseUnconfigurableSearchResults . . . . . . . . . . . . . . . . . . . . . 21-48
DesignContext filter configuration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-48
PortalDesignContextSearchEnginePreference . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-48
DesignContextIncludeSubComponentsForSpatialSearch . . . . . . . . . . . . . . . . . . . 21-49
DesignContext_ItemID_Query_lookup_string . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-49
DesignContextMaximumShownTabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-49

Preferences and Environment Variables Reference PLM00026 11.2


PortalDesignContextAlwaysResetFilterConfigurationPanel . . . . . . . . . . . . . . . . . . 21-50
DesignContextPreciseRevRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-50
DesignContext interoperability preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-51
PortalDesignContextCADbookmarkType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-51
PortalDesignContextVISbookmarkType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-52
DesignContext_PSE_Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-52
TC_show_open_in_nx_button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-53
SEEC_TcClient_Enable_Open_Cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-53
DesignContext performance tuning preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-54
RDVClearanceProxyServers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-54
PortalDesignContextMaxMatchingObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-54
PortalDesignContextMaxMatchingBOMLines . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-55
PortalDesignContextSetVariantRulesMaxTargetAppearances . . . . . . . . . . . . . . . . 21-55
Using DesignContext composite properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-56

Multi-Structure Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-57


ALLOC_Group_Allocation_Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-57
ALLOC_Product_Representation_Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-57
ALLOC_Target_Occurrence_Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-58
ALLOC_Source_Occurrence_Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-58
ALLOC_source_target_cardinality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-59
ALLOC_map_copy_allocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-60
Default_StructureContext_Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-60
PartStructureDepthForCompletenessCheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-61
MEDataPanelPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-61

Structure Manager and Product Configurator preferences . . . . . . . . . . . . . . . . . . . . . . . . . 21-62


Behavior and configuration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-62
BOM_objects_excluded_from_split . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-62
CFMEffConfigItemProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-62
CFM_ITEM_TYPE_RULE_INCLUDE_SUB_TYPES . . . . . . . . . . . . . . . . . . . . . . . 21-63
ClosureRulesForBomExpansion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-64
GDE_objects_with_integer_quantity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-64
Property_Comparator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-65
PSE_check_read_access_for_Rev_Rule_entry . . . . . . . . . . . . . . . . . . . . . . . . . . 21-65
PSE_default_view_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-66
PSE_Display_Pending_Edits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-66
PSE_expand_on_open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-67
PSE_ROLL_UP_TEMPLATES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-67
ROLL_UP_QUANTITY_FLAG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-68
PSEshowToolBar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-68
PS_Default_Rev_For_Occ_Cond_Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-69
PS_Bypass_Occurrence_Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-69
PS_Find_Number_Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-69
PS_new_seqno_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-70
PS_replace_with_substructure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-70
PS_wu_configd_imprecise_only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-71
PUBLISH_AlignableSourceTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-72
PUBLISH_AlignableTargetTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-72
REV_RULE_WHERE_USED_DEFAULT_VALUE . . . . . . . . . . . . . . . . . . . . . . . . . 21-72

PLM00026 11.2 Preferences and Environment Variables Reference


SkipClosureRuleEquivalent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-73
TC_BOM_Precision_Preference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-73
TC_show_open_in_pse_button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-74
TC_config_rule_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-74
Vis_InterOptWithProductViewDataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-74
VISTopLevelRef_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-75
Structure Manager column preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-75
BOM_Properties_For_Column_Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-75
PortalPSEColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-76
PortalPSEShownColumnsWidthPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-77
PSEDisplayNameWithTypeColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . 21-77
PSESearchColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-78
PSESearchShownColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-79
variant_item_column_width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-79
variant_option_column_width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-79
variant_description_column_width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-80
variant_value_column_width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-80
variant_state_column_width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-80
variant_values_column_width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-81
vrule_reln_column_width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-81
Structure Manager display preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-81
application name.ic_icon_level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-81
application name.ic_show_remove_icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-82
BOMCompareVisibleModes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-82
BOM_Display_Referencer_Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-83
BOM_Display_Variant_Super_Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-84
BOM_Display_Attachments_Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-84
BOM_Frozen_Column_Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-84
BOM_MARKUP_ADD_FONT_STYLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-85
BOM_MARKUP_ADD_FOREGROUND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-85
BOM_MARKUP_STRIKE_FOREGROUND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-86
Displayed_Decimals_for_Qty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-86
IC_baseline_carry_forward_active_changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-86
IC_baseline_carry_forward_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-87
ICPanelBomChangeDefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-87
ICPanelBomChangeWidths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-88
ICPanelAttachChangeDefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-88
ICPanelAttachChangeWidths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-89
ICPanelOccAttrChangeDefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-89
ICPanelOccAttrChangeWidths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-90
Incremental_Change_Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-90
Incremental_Change_ReleaseStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-91
MoveICCreationToMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-91
New_Ic_Dialog_last_ic_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-91
PSEDisplayTypePref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-92
PSEOccNotesNoCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-92
PSE_icon_placement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-93
PSE_show_option_family_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-93
PSE_show_option_item_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-94

Preferences and Environment Variables Reference PLM00026 11.2


PSEPreciseColorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-94
PSEImpreciseColorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-94
PSESubstituteColorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-95
PSEAutoPackPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-95
PSEShowSubstitutesPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-95
PSE_enable_related_substitutes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-96
PSEAdditionColorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-96
PSEChangedColorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-97
PSEIsNewVILinkedToModule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-97
PSEShowDataPanelDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-97
PSEVariantRuleDialogTableSort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-98
TC_ExportConfigUGNXAssembly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-98
Assembly and Product Configurator preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-99
AbsOccGrmCopyRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-99
AbsOccGrmSecondaryCopyRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-101
BOM_Additional_Packing_Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-102
BOM_Additional_Ref_Designator_Search_Criteria . . . . . . . . . . . . . . . . . . . . . . . 21-103
BOM_Enable_Quantity_Validation_Against_Ref_Designator . . . . . . . . . . . . . . . . 21-103
BOM_Enable_Ref_Designator_Value_Packing . . . . . . . . . . . . . . . . . . . . . . . . . 21-104
BOMExcludeFromPackCheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-105
Cfg0CompoundOptionValueMemberTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-105
Cfg0DefaultOptionFamilyNamespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-105
Cfg0EvaluateAvailability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-106
Cfg0ExpressionGridColumnProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-106
Cfg0ExpressionGridSelectionCharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-107
Cfg0OptionsViewColumnsWidths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-107
Cfg0OptionsViewHistoryUIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-108
Cfg0OptionsViewPropertyColumns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-108
Cfg0OptionsViewSortProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-109
CFMOccEffMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-109
ConfigureToLoadEnableDefaultVariantConfig . . . . . . . . . . . . . . . . . . . . . . . . . . 21-109
DisableSaveSos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-110
Fnd0Branch_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-110
Fnd0Branch_Fnd0Branch_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-111
Fnd0Branch_ItemRevision_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-111
Fnd0Branch_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-111
JTContentBomLineProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-112
JTContentHintPropertyPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-112
JT_File_Excluded_Refsets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-113
JT_File_OverrideChildren_Refsets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-113
JT_File_Priority_Refsets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-114
PCA_enable_authoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-115
PS_Duplicate_FindNo_Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-116
PSEAllowLegacyVICreation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-116
PSEAutoViCreateEmptyVI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-116
PSEAutoViNamePrefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-117
PSEAutoViNewItemPopup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-117
PSEAutoViStopVICreationForUnconfiguredModule . . . . . . . . . . . . . . . . . . . . . . 21-118
PSEBypassVISearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-118

PLM00026 11.2 Preferences and Environment Variables Reference


PSECopyAbsOccDuringVICreation preference . . . . . . . . . . . . . . . . . . . . . . . . . 21-119
PSECopyArrangementsDuringVICreation preference . . . . . . . . . . . . . . . . . . . . . 21-119
PSECreateVISameType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-120
PSEEnableBranchConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-120
PSEEnableFilteringUnconfigdDueToClassicVariantsPref . . . . . . . . . . . . . . . . . . . 21-120
PSEIsNewVIisLinkedToModule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-121
PSE_prompt_for_remote_import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-121
PSESavedConfigRelationTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-122
PSEShowUnconfigdEffPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-122
PSEShowUnconfigdVarPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-123
PSEVariantsMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-124
PSM_classic_variants_logical_families . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-124
PSM_classic_variants_numeric_families . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-125
PSM_classic_variants_text_families . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-126
PSM_global_option_item_ids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-128
PS_option_value_delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-128
PS_Reference_Designator_Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-129
PS_variant_value_protect preference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-129
RAC_expand_below_batch_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-130
Rollup_Variant_Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-130
RollUp_Variant_Traverse_Level_Is_InstallationAssembly . . . . . . . . . . . . . . . . . . 21-131
ShowModuleIcons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-132
TCAllowedChildTypes_DesignReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-132
TCAllowedChildTypes_Fnd0LogicalBlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-133
TCAllowedChildTypes_Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-133
TCAllowedChildTypes_<ItemTypeOrGDEType> . . . . . . . . . . . . . . . . . . . . . . . . 21-134
TCAllowedChildTypes_Paragraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-135
TCAllowedChildTypes_Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-135
TCAllowedChildTypes_RequirementSpec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-136
TCAllowedChildTypes_ValidationReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-136
TCAllowedParentTypes_itemtype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-137
TC_CFG_PRODUCTS_USE_VARIABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-137
TC_Default_SVR_Relationship . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-139
TCEnforceSingleType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-139
TC_Fnd0SoaConfigFilterCriteria_AutoPublishRevisable . . . . . . . . . . . . . . . . . . . 21-140
TC_JT_voxel_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-141
TC_Undefined_Variant_State_Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-141
TC_ValidApprovedStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-141
TC_VariantConfigurable_MaxCacheSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-142
TC_variant_configurator_relationship . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-142
Transform preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-143
Using transform data to position components . . . . . . . . . . . . . . . . . . . . . . . . . . 21-143
PS_assume_old_transform_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-143
PS_assume_legacy_transform_units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-144
PS_allow_plmxml_transforms_with_no_legacy_factor . . . . . . . . . . . . . . . . . . . . 21-144
PS_convert_legacy_transform_to_plmxml . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-145
Product structure synchronization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-145
Synchronize dataset and BOM view revision changes . . . . . . . . . . . . . . . . . . . . 21-145
PS_structure_change_condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-146

Preferences and Environment Variables Reference PLM00026 11.2


PS_variant_value_protect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-147
TC_BVRSYNCFORM_DELEGATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-147
BOM grading preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-148
CondValData.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-148
CondValData.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-148
CondValDataCreate.CREATE_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . 21-148
CondValdataRevSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . 21-148
CondValDataRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-149
CondValDataRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-149
CondValDataRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . 21-149
CondValDataSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . 21-150
CondValResult.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-150
CondValResultSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . 21-150
CondValidation_NoData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-150
CONDVALIDATION_Keep_PrevRev_Result . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-151
ConditionValidationResultColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . 21-151
ConditionValidationResultColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . 21-152

Platform Designer preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-152


<Architecture_Type>_generic_id_mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-152
ArchitectureModeler_add_design_business_rule_check . . . . . . . . . . . . . . . . . . . . . . 21-153
ArchitectureModeler_add_design_occurrence_business_rule_check . . . . . . . . . . . . . 21-153
ArchitectureModeler_locking_retry_count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-154
ArchitectureModeler_multiple_installation_assemblies_condition . . . . . . . . . . . . . . . . 21-154
ArchitectureModeler_part_solution_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-155
ArchitectureModeler_remove_design_business_rule_check . . . . . . . . . . . . . . . . . . . 21-155
ArchitectureModeler_RemoveDesign_Max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-156
ArchitectureModeler_remove_design_occurrence_business_rule_check . . . . . . . . . . . 21-156
ArchitectureModeler_replace_design_business_rule_check . . . . . . . . . . . . . . . . . . . 21-157
ArchitectureModeler_replace_design_occurrence_business_rule_check . . . . . . . . . . . 21-157
ArchitectureModeler_update_designs_business_rule_check . . . . . . . . . . . . . . . . . . . 21-158
ArchitectureModeler_update_design_occurrences_business_rule_check . . . . . . . . . . 21-158
ArchitectureModeler_use_all_installation_assemblies . . . . . . . . . . . . . . . . . . . . . . . 21-159
RDV_platformdesigner_assign_bulk_variability . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-159
RDIP_report_invalid_thoughts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-160

Quick spatial search preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-160


QSEARCH_avoid_check_for_cycles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-160
QSEARCH_avoid_shrinkage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-161
QSEARCH_check_for_cycles_on_index_check . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-161
QSEARCH_chunk_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-162
QSEARCH_DEBUG_TEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-162
QSEARCH_deletion_chunk_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-163
QSEARCH_disable_bbox_for_product_scoping . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-163
QSEARCH_dispatcher_not_available . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-164
QS_QSEARCH_ENABLED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-164
QSEARCH_filter_queries_by_product_scoping . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-165
QSEARCH_force_simplify_to_one_box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-165
QSEARCH_force_update_even_if_up_to_date . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-166
QSEARCH_foreground_processing_halted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-166

PLM00026 11.2 Preferences and Environment Variables Reference


QSEARCH_foreground_processing_time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-167
QSEARCH_ignore_indexable_candidates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-167
QSEARCH_log_date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-168
QSEARCH_logging_level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-168
QSEARCH_print_detail_before_cycle_checking . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-169
QSEARCH_processing_halted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-169
QSEARCH_processing_recursion_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-170
QSEARCH_processing_retry_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-170
QSEARCH_query_chunk_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-170
QSEARCH_queue_recurring_background_updates . . . . . . . . . . . . . . . . . . . . . . . . . 21-171
QSEARCH_recurring_background_update_survival_time . . . . . . . . . . . . . . . . . . . . . 21-171
QSEARCH_recurring_background_update_interval . . . . . . . . . . . . . . . . . . . . . . . . . 21-172
QSEARCH_replace_indexes_by_modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-172
QSEARCH_retain_processed_entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-173
QSEARCH_types_to_avoid_processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-173
QSEARCH_update_enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-174
QSEARCH_use_bulk_filtering_on_queueing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-174
QS_USE_SEARCH_BOTTOM_UP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-175
QS_IGNORE_JT_USER_VOLUME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-175
QS_SPATIAL_ENABLED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-176
QS_TRUSHAPE_GENERATION_ENABLED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-176
QS_BBOX_GENERATION_ENABLED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-177
QS_BBOX_GENERATION_FROM_NX_ENABLED . . . . . . . . . . . . . . . . . . . . . . . . . 21-177
QS_MAX_CHILDS_TO_PROCESS_IN_BOTTOMUP . . . . . . . . . . . . . . . . . . . . . . . 21-178
QS_MAX_QUERY_EXECUTION_TIME_FOR_BOTTOMUP . . . . . . . . . . . . . . . . . . . 21-179
QS_NX_RELATION_POST_ACTION_ENABLED . . . . . . . . . . . . . . . . . . . . . . . . . . 21-179
QS_remote_master_site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-179
QS_remote_master_site_override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-180
QS_START_CIRCULAR_STRUCTURE_CHECK_SIZE . . . . . . . . . . . . . . . . . . . . . . 21-180
RDV_QSEARCH_REFINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-181
RDV_QSEARCH_REVISION_RULE_NAMES . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-181
RDV_QSEARCH_STREAMING_MODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-182
StructureManagerIncludeSubComponentsForSpatialSearch . . . . . . . . . . . . . . . . . . . 21-182
TC_qsearch_remote_query_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-183

Preferences and Environment Variables Reference PLM00026 11.2


Chapter 21: Product structure preferences

Modifying the behavior of Product structure


Teamcenter product structure applications include Structure Manager, DesignContext, Multi-Structure
Manager, and Platform Designer. These applications enable you configure, edit, and display part and
assembly data.
Use product structure preferences to enable and modify the behavior of these applications.

DesignContext preferences
General RDV preferences

EPM_tessellation_target_type

DESCRIPTION
Identifies potential NX datasets for tessellation as part of a workflow process. The
RDV-tessellation-handler handler compares the targets set in this preference with
the targets identified for the workflow process.
VALID
VALUES
Valid NX dataset types.
DEFAULT
VALUES
UGMASTER
UGALTREP
DEFAULT
PROTECTION
SCOPE
Site preference.

EPM_tessellation_servers

DESCRIPTION
Used by the RDV-tessellation-handler handler to connect to the tessellation server.
The handler sends messages to the server running on the specified host/port,
the server processes each of the messages to perform tessellations. Setting this
preference to None indicates there is no tessellation server and that tessellation
occurs on the client itself.
By default, the handler attempts to perform client-side tessellation.
VALID
VALUES
Valid port host name and port number.

PLM00026 11.2 Preferences and Environment Variables Reference 21-1


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

LOU_display_name_properties

DESCRIPTION
Determines the display name of the LOU node in the NVE tree. Applies if you use the
Replace Design in Product feature in Platform Designer, Structure Manager, and
My Teamcenter.
VALID
VALUES
Accepts a list of valid BOM line properties. The LOU node name is a concatenation of
the values listed in this preference.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

PortalDesignContextProcess.WorkPartProperties

DESCRIPTION
Specifies a list of properties for finding associated work parts related to a workflow
process. If the object in process is added to the RDV context, the associated work
parts are automatically added to the RDV context. Engineering change requests are
automatically added if they are attached as reference attachments.
VALID
VALUES
Valid Teamcenter properties.
DEFAULT
VALUES
root-task:root_target_attachments
root-task:root_reference_attachments
DEFAULT
PROTECTION
SCOPE
Site preference.

PortalDesignContextProcess.WorkPartOrChangeAttachmentTypes

DESCRIPTION
Specifies a list of properties for finding workflow processes related to a workflow
process or engineering change being added to the RDV context. If the workflow
process is related to the work part or engineering change via one of the listed

21-2 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

references, and it is not yet complete, it is automatically added to the RDV context.
Workflow processes and their work part or engineering change objects can be
automatically added using this preference.
VALID
VALUES
Valid EPM attachment types, indicated by a specific integer as follows:
1 EPM_target_attachment
3 EPM_reference_attachment
4 EPM_signoff_attachment
5 EPM_release_status_attachment
6 EPM_comment_attachment
7 EPM_instruction_attachment
1000 EPM_user_attachment
DEFAULT
VALUES
1
3
DEFAULT
PROTECTION
SCOPE
Site preference.

RDV_audit_report_usage_attributes

DESCRIPTION
Defines which occurrence notes display in the usage audit report. Users create the
audit report by selecting an installation assembly (or any other higher level assembly
in the product structure) and generating an audit report.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter occurrence
note.
DEFAULT
VALUES
Plant Cost Form
USAGE_Partnumber
USAGE_Quantity
USAGE_UPCFNA
USAGE_DLS
USAGE_PLS
USAGE_UPC
USAGE_FNA
USAGE_ModelCode
USAGE_FNM
USAGE_HandCode
USAGE_UOM

PLM00026 11.2 Preferences and Environment Variables Reference 21-3


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

USAGE_Status
USAGE_LessFinishIndicator
USAGE_StockDisposition
USAGE_Key
USAGE_Torque1
USAGE_Torque2
USAGE_ServiceStockDisp
USAGE_EWO
USAGE_EWOStatus
USAGE_MOS01
USAGE_Product
USAGE_ModelYear
USAGE_EngineerCode
USAGE_EngineerName
USAGE_ActivityCode
USAGE_SDC
USAGE_VPPS
USAGE_SMT
USAGE_BasePart
USAGE_FirstUsedYear
USAGE_EGM
USAGE_SMTMgr
USAGE_MathStatus
USAGE_NewCO
USAGE_PADNumber
USAGE_PADSubItemNumber
USAGE_UPCOld
USAGE_FNAOld
USAGE_QuantityOld
USAGE_ModelCodeOld
DEFAULT
PROTECTION
SCOPE
All.

RDV_audit_report_occurrence_attributes

DESCRIPTION
Defines which occurrence notes display in the occurrence audit report. Users create
the audit report by selecting any level of an architecture breakdown and generating
an audit report.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter occurrence
note.
DEFAULT
VALUES
Plant Cost Form
USAGE_Partnumber
USAGE_Quantity

21-4 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

USAGE_UPCFNA
USAGE_DLS
USAGE_PLS
USAGE_UPC
USAGE_FNA
USAGE_ModelCode
USAGE_FNM
USAGE_HandCode
USAGE_UOM
USAGE_Status
USAGE_LessFinishIndicator
USAGE_StockDisposition
USAGE_Key
USAGE_Torque1
USAGE_Torque2
USAGE_ServiceStockDisp
USAGE_EWO
USAGE_EWOStatus
USAGE_MOS01
USAGE_Product
USAGE_ModelYear
USAGE_EngineerCode
USAGE_EngineerName
USAGE_ActivityCode
USAGE_SDC
USAGE_VPPS
USAGE_SMT
USAGE_BasePart
USAGE_FirstUsedYear
USAGE_EGM
USAGE_SMTMgr
USAGE_MathStatus
USAGE_NewCO
USAGE_PADNumber
USAGE_PADSubItemNumber
USAGE_UPCOld
USAGE_FNAOld
USAGE_QuantityOld
USAGE_ModelCodeOld
DEFAULT
PROTECTION
SCOPE
All.

RDV_authoring_override_user

DESCRIPTION
Specifies the Teamcenter user ID required when adding components to installation
assemblies, or when modifying existing components in product structure using any

PLM00026 11.2 Preferences and Environment Variables Reference 21-5


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

of the following wizards. Any defined workflow rule checks are performed against
this user.
Add Design To Product wizard

Replace Design In Product wizard

Remove Design From Product wizard


VALID
VALUES
Accepts one or more strings; each string must be a valid Teamcenter user ID. If unset,
the system processes the current user's ID.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

RDV_auto_functionality

DESCRIPTION
Enables the Audit Report menu command in Structure Manager when set to True.
VALID
VALUES
True Enables the Audit Report menu command in Structure
Manager.
False Disables the Audit Report menu command in Structure
Manager.
DEFAULT
VALUES
False.
DEFAULT
PROTECTION
SCOPE
All.
NOTES
Values are case sensitive. Any invalid values are ignored.

RDV_auto_populate_occ_notes

DESCRIPTION
Specifies a multivalue property that contains the lists of note types that are
prepopulated in the Enter Part Data step of the Add Part to Product wizard or the
Replace Part in Product wizard.
VALID
VALUES
Accepts one or more strings as values. These strings have the following format:
Field-1#Field-2#Field-3#Field-4

21-6 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Field-1 Specifies the display name of occurrence note types.


Field-2 Specifies whether the value is retrieved from a property on the specified
object or is a constant.
PROP The value is retrieved from a property.
CONST The value is a constant.
Field-3 Specifies the object. If the value of Field-2 is PROP, the valid values of
Field-3 are:
PRODUCT
PRODUCT_REV
PART
PART_REV
ABE
ABE_REV
DEFAULT

If the value of Field-2 is CONST, the valid value of Field-3 is DEFAULT.


Field-4 Specifies the property name or constant value. If the value of Field-2
is PROP, the valid value is the property name of the object specified in
Field-3. If the value of Field-2 is CONST, this field contains the value
of the constant.
DEFAULT
VALUES
Usage_Product#PROP#PRODUCT_REV#items_tag:item_id
DEFAULT
PROTECTION
SCOPE
User preference.

RDV_build_intent_atth_type

DESCRIPTION
Defines the attachment type for the build intent of a CORP_Build object when a new
version of a Tracking vehicle definition is imported. Tracking vehicle definitions are
imported as CORP_Build objects with an attached saved variant rule which contains
all the set option values. This rule is attached with a specification relation to the
CORP_Build revision. Tracking vehicle information is imported in the form of a PLM
XML file.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter relation
type.
DEFAULT
VALUES
IMAN_manifestation

PLM00026 11.2 Preferences and Environment Variables Reference 21-7


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
All.

RDVCreateSCOForClearance

DESCRIPTION
Defines if real-time clearance analysis results are stored for subsequent retrieval.
VALID
VALUES
TRUE An SCO (structure context object) containing clearance analysis
results is created after real-time analysis is complete.
FALSE An SCO is not created after real-time analysis is complete.
DEFAULT
VALUES
TRUE.
DEFAULT
PROTECTION
SCOPE
Site preference.

RDV_Create_SCO_WITHOUT_APN

DESCRIPTION
Defines if the structure context objects (SCOs) created in DesignContext include
appearance path nodes (APNs) for the BOM lines. This preference does not affect
SCOs created in other applications.
VALID
VALUES
TRUE Each SCO is created without APNs for the BOM lines.
FALSE Each SCO is created with APNs for the BOM lines.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
All.
NOTES
Installing the GM Overlay sets the value of this preference to TRUE.

RDV_copied_occurrence_notes

DESCRIPTION
Specifies the note types whose values are copied from the instance of the associated
part solution when present, that is, sharing the same named variant expression, to the
occurrence of the design solution in Structure Manager. This list must match that in the
RDV_usage_occurrence_notes preference.

21-8 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter occurrence
note.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

RDV_Copy_Variability_For_SaveAs

DESCRIPTION
Determines whether variability is copied to a new item when performing a Save As
action on an item. When the value of this preference is set to TRUE, Teamcenter
checks if the original item is designated as a Product item (RDV-specific). If it is, the
variability is copied to the new item. If it is not, variability is not copied.
An item is defined as a Product item using the following preferences:
PortalDesignContextProductItemProperties
PortalDesignContextProductItemProperties.object_type
PortalDesignContextProductItemProperties.object_desc

VALID
VALUES
TRUE Variability is copied to the new item when performing a Save
As action.
FALSE Variability is not copied to the new item when performing a
Save As action.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

RDV_default_Architecture_Breakdown_RevRule

DESCRIPTION
Defines the default revision rule the Platform Designer application uses to open an
architecture breakdown.
VALID
VALUES
Accepts a single string as a value. Must be a valid Teamcenter revision rule.
DEFAULT
VALUES
Latest Released

PLM00026 11.2 Preferences and Environment Variables Reference 21-9


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
All.

RDV_enable_product_lock

DESCRIPTION
Allows the rdv_import_usage utility to obtain locks on the product revision or top-level
architecture node if they are held by other non-system administration processes.
VALID
VALUES
TRUE Allows the utility to obtain the necessary locks if they are held
by other processes.
FALSE Does not allow the utility to obtain the necessary locks if they
are held by other processes.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

RDV_export_nve

DESCRIPTION
Determines whether named variant expressions (NVEs) are exported during a multisite
replication session.
NVEs are referenced by various variant expression blocks (VEBs). Because any VEBs
included in an architecture structure own the NVEs, these NVEs only need to be
exported during architecture export, not during the export of other assemblies. Use
this preference to allow users to determine the export of NVEs in a given session.
VALID
VALUES
TRUE NVEs are exported during multisite replication sessions.
FALSE NVEs are not exported during multisite replication sessions.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

21-10 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

RDVIgnoreErrorConnectReleasedPartsServer

DESCRIPTION
Determines whether the RDV-add-released-parts-queue workflow handler checks if
the Released Parts Collector server is running.
VALID
VALUES
True Allows the RDV-add-released-parts-queue workflow
handler to check if the Released Parts Collector server is
running. If the server is running, the item types defined in
the RDVReleasedPartsProcessAssemType preference are
released. If the server is not running, the item types are not
released.
False The item types defined in the
RDVReleasedPartsProcessAssemType preference are
released, regardless of whether the Released Parts Collector
server is running.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

RDV_install_configuration_rules

DESCRIPTION
Defines the revision rules used to configure the installation assembly in a product.
The Add Design To Product wizard creates new occurrences in the Installation
Assembly revision that is configured by the revision rule defined in this preference.
If your site chooses to grant write access only to Work In Process (WIP) revisions
this would be a WIP revision rule. For example, Latest Working. This includes
user-defined revision rules set with the RDV_authoring_override_user preference.
VALID
VALUES
Accepts one or more strings; each string must be a valid Teamcenter revision rule.
DEFAULT
VALUES
Latest Working
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-11


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

RDV_occurrence_business_rule_check

DESCRIPTION
Defines the list of process templates used to implement business rule checks for
occurrences of the part.
VALID
VALUES
Accepts one or more strings; each string must be a valid Teamcenter process template.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

RDV_part_business_rule_check

DESCRIPTION
Defines the list of process templates used to implement business rule checks for
individual parts.
VALID
VALUES
Accepts one or more strings; each string must be a valid Teamcenter process template.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

RDV_set_default_3DBox_dimensions

DESCRIPTION
Specifies the default option for 3D box dimensions. It applies to spatial searches. It
applies to spatial searches in the Structure Manager, Multi Structure Manager, and
Manufacturing Process Planner applications.
VALID
VALUES
0
Centroid and size.
1
Origin and size.
2
Maximum and minimum extents.

21-12 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
VALUES
2
DEFAULT
PROTECTION
SCOPE
User preference.

RDV_set_default_3DBox_search

DESCRIPTION
Specifies the default option type for spatial searches. Applies to spatial searches in
the Structure Manager, Multi Structure Manager, and Manufacturing Process Planner
applications.
VALID
VALUES
true
Sets the 3D box search option as default.
false
Sets the proximity search option as default.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

RDV_set_default_3D_Manipulator_ON

DESCRIPTION
Specifies the default option type for 3D manipulators.
VALID
VALUES
true
3D manipulators are on by default.
false
3D manipulators are off by default.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-13


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

RDV_default_find_inside_parts

DESCRIPTION
Specifies whether parts inside or outside the 3D bounding box during a spatial search
are searched by default. Applies to spatial searches in the Structure Manager, Multi
Structure Manager, and Manufacturing Process Planner applications.
VALID
VALUES
true
Parts inside the 3D bounding box are searched by default.
false
Parts outside the 3D bounding box are searched by default.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

RDV_default_find_intersecting_parts

DESCRIPTION
Specifies whether parts intersecting with the 3D bounding box during a spatial search
are excluded from or included in the results by default. Applies to spatial searches in
the Structure Manager, Multi Structure Manager, and Manufacturing Process Planner
applications.
VALID
VALUES
true
Intersecting parts are included by default.
false
Intersecting parts are excluded by default.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

RDV_set_default_slider_increment

DESCRIPTION
Specifies the default increment of the slider.
VALID
VALUES
Any positive floating value.

21-14 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
VALUES
0.01
DEFAULT
PROTECTION
SCOPE
User preference.

RDV_set_default_true_shape_filtering_ON

DESCRIPTION
Specifies the default option for TruShape filtering.
VALID
VALUES
true
TruShape filtering is on by default.
false
TruShape filtering is off by default.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

RDV_set_default_use_selections_from_tree

DESCRIPTION
Specifies the default option for the target part selections. Applies to spatial searches in
the Structure Manager, Multi Structure Manager, and Manufacturing Process Planner
applications.
VALID
VALUES
true
Use selections from the tree.
false
Use selections from the table.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-15


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

RDV_show_targets_on_results_dialog

DESCRIPTION
Specifies if the target parts table is displayed in the results dialog box after a proximity
search. Applies to spatial searches in the Structure Manager and Multi Structure
Manager applications. This preference is also applicable to the Manufacturing Process
Planner application but only honored when searching filtered in-process assemblies.
It is not honored in the structure search. The target parts table is visible at all times
on the Structure Search Results view.
VALID
VALUES
true
The target parts table is displayed.
false
The target parts table is not displayed.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

RDV_show_targets_on_spatial_dialog

DESCRIPTION
Specifies if the target parts table is displayed in the spatial search dialog box during
a proximity search. It applies to spatial searches in the Structure Manager and
Multi Structure Manager. This preference also applies to spatial searches in the
Manufacturing Process Planner application, but it is honored only for the structure
search. It is not honored when searching filtered in-process assemblies. The target
parts table is visible at all times on the Spatial Filter dialog box.
VALID
VALUES
true
The target parts table is displayed.
false
The target parts table is not displayed.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

21-16 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

RDV_partnumber_validation_rule

DESCRIPTION
Specifies a single-value property that determines if a design solution has a valid part
number. A naming rule has to be created in Business Modeler IDE and the pattern
specified for this naming rule determines what is a valid part number. The name of this
naming rule must be set in this preference.
VALID
VALUES
Accepts a string as a value. This string represents the name of the naming rule.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.
NOTES
Values are case sensitive. Any invalid values are ignored.

RDV_part_occ_note_mappings

DESCRIPTION
Specifies a multivalue property that contains the lists of values that prepopulate
the notes displayed in the Enter Part Data step of the Add Part to Product
wizard or the Replace Part in Product wizard. The note types are specified in
RDV_auto_populate_occ_notes preference.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.
NOTES
This preference is no longer evaluated. Use the RDV_auto_populate_occ_notes
preference.

RDV_product_code_mapping

DESCRIPTION
Specifies a single-value mapping property that contains the value to prepopulate
the Usage_Product note displayed in the Enter Part Data step of the Add Part to
Product wizard.
VALID
VALUES
Accepts a string as a value.

PLM00026 11.2 Preferences and Environment Variables Reference 21-17


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
VALUES
Items_tag:item_id
DEFAULT
PROTECTION
SCOPE
All.
NOTES
This preference is no longer evaluated. Use the RDV_auto_populate_occ_notes
preference.

RDV_user_defined_units_of_measure

DESCRIPTION
Specifies a single-value mapping property that contains the value to prepopulate
the Usage_Product note displayed in the Enter Part Data pane of the Add Part
to Product wizard.
VALID
VALUES
METERS

MILLIMETERS

INCHES

UNKNOWN
DEFAULT
VALUES
UNKNOWN
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
If you specify MILLIMETERS, METERS, or INCHES, the search is performed in the
specified units. If you specify UNKNOWN, the search is performed in the units of the
assy_units property set on the top level BVR. If this property is not set, the search
is performed in the units specified in the PS_assume_legacy_transform_units
preference.

RDVReleasedPartsProcessAssemType

DESCRIPTION
Defines the Item types which can be processed during the structure update process.
When an installation assembly is modified and released, it is added to the queue and
updated asynchronously. The system uses the RDV-add-released-parts-queue
workflow handler to pass the installation assembly to the list of assemblies for
processing. This preference determines which Item types the handler is allowed to
process.

21-18 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter item
type. For example:
RDVReleasedPartsProcessAssemType=
CORP_Install
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

RDVReleasedPartsCollectorServer

DESCRIPTION
Defines the host name and port number of the machine on which the Released Parts
Collector server is running.
VALID
VALUES
Accepts a single string as a value. Must define the host name and port number
in the following format:
host name:port number
For example:
trysun12:1551
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

RDV_show_itemid_prefix

DESCRIPTION
Determines if the XO chart headers of the Replace Design in Product feature include
the item ID. This feature is available in Platform Designer, Structure Manager, and
My Teamcenter.
VALID
VALUES
TRUE The XO chart headers include the item ID.
FALSE The XO chart headers do not include the item ID.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 21-19


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

RDV_show_lou_prop

DESCRIPTION
Registers new property columns and adds them to the Available Properties list in
Structure Manager and Platform Designer. The user can then add any of these
columns by right-clicking and choosing Insert Column from the list. Teamcenter
shows the properties of the configured part solutions of an architecture breakdown
element (ABE), as a comma-separated string on the ABE itself.
VALID
VALUES
Any valid property name prefixed with bl_lou_.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

RDV_turn_audit_logging_on

DESCRIPTION
Determines whether audit logging for global RDV is enabled. These audit logs contain
information about the changes in the vehicle assembly structure (VAS) over a period
of time, including logging changes to the assembly structure from sources other than
Teamcenter (such as NX or other CAD application integrations).
VALID
VALUES
true The audit log file is updated whenever the Replace Design in
Product wizard and the Add design to Product wizard are
run by users.
false The audit log file is not updated.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

RDV_uneditable_part_occ_notes

DESCRIPTION
Specifies the occurrence notes that are not editable in the Enter Part Data screen of
the Add Part to Product wizard or the Replace Part in Product wizard.

21-20 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
Accepts multiple strings as values.
DEFAULT
VALUES
Usage_product
DEFAULT
PROTECTION
SCOPE
All.
NOTES
Values are case sensitive. Any invalid values are ignored.

RDV_usage_attribute_set

DESCRIPTION
Defines the list of attributes applied when a usage record is imported for the first time.

A ArchPartUsage occurrence type is created under the Top Level Architecture


node. This occurrence points to the CORP_Part object if a CORP_Part object
with the corresponding part number exists. (If not, a placeholder CORP_Part
object is created with an alphanumeric ID and attached to the occurrence.) Which
attributes are imported into Teamcenter as part of the Usage Record are specified
by this preference. Corresponding occurrence note names are specified by the
RDV_usage_occurrence_notes preference.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter attribute.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

RDV_usage_occurrence_notes

DESCRIPTION
Defines the occurrence note names that are displayed in the Enter Part Data step of
the Add Part to Product wizard or the Replace Part in Product wizard.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
occurrence note.
DEFAULT
VALUES
Usage_Product, Usage_PartNumber, Usage_Quantity.

PLM00026 11.2 Preferences and Environment Variables Reference 21-21


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
All.
NOTES
Values are case sensitive.
Any invalid values are ignored.

RDV_valid_partnumber_rule

DESCRIPTION
Defines the naming rule used for part number validation.
VALID
VALUES
Accepts a single string as a value. Must be a valid Teamcenter naming rule.
For more information regarding naming rules, see Business Modeler IDE.
DEFAULT
VALUES
null
DEFAULT
PROTECTION
SCOPE
All.

RDV_variant_expression_overlap_checking_mode

DESCRIPTION
Determines the mode used to check overlap between variant expressions. Architecture
breakdown structures may be configured to check for named variant expression (NVE)
consistency. This consistency check rejects NVEs that overlap with other NVEs.
VALID
VALUES
1 The system assumes an unlimited continuum of values in
the product variability. For example, the system assumes an
unlimited number of intermediate values between Length = 2
meter and Length = 3 meter, such as a length of 2.50 meters.
2 The system uses the defined variability, with exactly and only
those values allocated.
5 Same as setting 1, but NVEs are permitted on architecture
elements even when they go beyond the variability specified for
this element.
6 Same as setting 2, but NVEs are permitted on architecture
elements even when they go beyond the variability specified for
this element.
DEFAULT
VALUES
1

21-22 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
All.

RDV_variant_overlays_uses_true_availability

DESCRIPTION
Determines whether rule checks and variability are evaluated in the variants overlay
only (VOO) analysis when using RDV.
VALID
VALUES
TRUE Expands conditions into True Availability statements. May slow
VOO analysis.

FALSE Conditions are not expanded.


DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
All.

BOMWriterDirectModelRelationType

DESCRIPTION
Used with the bomwriter utility. The system searches the direct model based on the
relation type specified in this preference.
The bomwriter utility's PLM XML file outputs direct model (JT) information available
in the product structure. The system retrieves this information based on the relation
type specified in this preference.
VALID
VALUES
Accepts a single string as a value. Must be a valid Teamcenter relation type.
DEFAULT
VALUES
IMAN_Rendering
DEFAULT
PROTECTION
SCOPE
Site preference.

BOMWriterNoDescendantsInPLMXML

DESCRIPTION
Used with the bomwriter utility. Controls export of descendants (children and
grandchildren) of selected BOM lines when Teamcenter lifecycle visualization or NX is
launched from the Teamcenter rich client.

PLM00026 11.2 Preferences and Environment Variables Reference 21-23


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

This preference determines whether the bomwriter utility generates PLM XML files
which include descendants of the selected BOM lines.
Set this preference to TRUE (suppressing descendants) if the application for which the
PLM XML file is intended supports navigating Teamcenter structures (such as NX). If
the file is intended for other applications (such as Teamcenter lifecycle visualization
mockup) you may want to include descendents as they cannot load substructures on
demand.
VALID
VALUES
TRUE Descendents of selected BOM lines are not exported in the
PLM XML file, and are not displayed in Teamcenter lifecycle
visualization or NX.

FALSE Descendents of selected BOM lines are exported in the PLM


XML file, and are displayed in Teamcenter lifecycle visualization
or NX.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

BOMWriterNoDirectParents

DESCRIPTION
Used with the bomwriter utility. Controls export of predecessors (parents and
grandparents) of selected BOM lines when Teamcenter lifecycle visualization or NX is
launched from the Teamcenter rich client.
This preference determines whether the bomwriter utility generates PLM XML files
which include predecessors of the selected BOM lines.
VALID
VALUES
TRUE Predecessors of selected BOM lines (except the root node)
are not exported in the PLM XML file, and are not displayed in
Teamcenter lifecycle visualization or NX.

FALSE Predecessors of selected BOM lines (except the root node) are
exported in the PLM XML file, and are displayed in Teamcenter
lifecycle visualization or NX.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

21-24 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DesignContext product item preferences

PortalDesignContextConsiderProductItemQuery

DESCRIPTION
Enables or disables further filtering of product items in DesignContext.
The DesignContext application identifies a product item based on the configuration of
the PortalDesignContextProductItemProperties preference. This list can be further
refined by a saved query configured in the PortalDesignContextProductItemQuery
preference. When the PortalDesignContextConsiderProductItemQuery preference
is set to true, Teamcenter uses the saved query to further filter the available
product items. If the saved query results does not find any product items using
the PortalDesignContextProductItemProperties preference setting, Teamcenter
displays an error.
For example:

Product items Product items returned


found from default by saved query
DesignContext (PortalDesignContext Filtered list of product
configuration ProductItemQuery) items
Prod1, Prod2, Prod3, Prod3, Prod12, Prod34, and Prod3 and Prod5
Prod4, and Prod5 Prod5
Prod1, Prod2, Prod3, Prod11, Prod12, Prod13, None
Prod4, and Prod5 Prod14, and Prod15
Prod1, Prod2, Prod3, None None
Prod4, and Prod5
Prod3 and Prod4 Prod3, Prod12, Prod13, Prod3
Prod14, and Prod 15

VALID
VALUES
true Filter the search result of available product items using the
query specified in the PortalDesignContextProductItemQuery
preference.
false Do not filter the search result of available product items.
DEFAULT
VALUES
false.
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 21-25


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

PortalDesignContextProductItemProperties

DESCRIPTION
Specifies the standard for identifying a product item, that is, the top-level item of
the assembly structure from a product perspective. The product item represents a
long-term engineering project, for example, a washing machine or refrigerator program.
The DesignContext application displays items matching all
PortalDesignContextProductItemProperties properties in the Product Items table in
the Context Definition pane. The Platform Designer application filters the result of the
saved query specified with the PortalDesignContextProductItemQuery preference
down to those items matching all PortalDesignContextProductItemProperties
properties.
Setting this preference is required.
Note

For each composite property specified in the list, you must also set a
PortalDesignContextProductItemProperties.property-value preference.

VALID
VALUES
Any composite property. For examples of composite properties, see the default
values for the PortalDesignContextProductItemColumnsShownPref and
PortalDesignContextProductItemColumnsHiddenPref preferences.
Other valid properties, such as properties on item or item revision master forms, may
depend on customization at your site.
In the following example, the setting item_master_tag:Project_ID is a composite
property:
PortalDesignContextProductItemProperties=
object_type
item_master_tag:Project_ID
PortalDesignContextProductItemProperties.object_type=
Product
PortalDesignContextProductItemProperties.item.master_tag:Project_ID=
Approved
In the following example, specifying process_stage implies that a workflow process
was started on the product item based on a process template named ProductProcess.
Specifying owning_group implies the owning group of the item is Product Group.
PortalDesignContextProductItemProperties=
process_stage_list
owning_group
PortalDesignContextProductItemProperties.process_stage_list=
ProductProcess
PortalDesignContextProductItemProperties.owning_group=
Product Group

21-26 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
VALUES
PortalDesignContextProductItemProperties=
object_type
object_desc
PortalDesignContextProductItemProperties.object_type=
Item
PortalDesignContextProductItemProperties.object_desc=
Product
The default values dictate that an item is considered a product item if it has the type
Item and a description of Product.
DEFAULT
PROTECTION
SCOPE
All.

PortalDesignContextProductItemProperties.<attribute-value>

DESCRIPTION
Identifies the value of an attribute specified as a product item property on the
PortalDesignContextProductItemProperties preference.
Setting this preference is required. You must set one of these preferences for each
attribute specified for the product item.
For example:
PortalDesignContextProductItemProperties.object_type=
FM0_Vehicle
PortalDesignContextProductItemProperties.process_stage=
RDV/Vehicle
PortalDesignContextProductItemProperties.owning_group=
Vehicle
PortalDesignContextProductItemProperties.object_type.item_master_tag:Project_ID=
RDV Assembly
VALID
VALUES
A valid property attribute value for each product item property.
DEFAULT
VALUES
object_type=Item
object_desc=Product
DEFAULT
PROTECTION
SCOPE
All.

PortalDesignContextProductItemColumnsShownPref

DESCRIPTION
Specifies the list of attributes displayed in DesignContext and the order in which they
are displayed in the table displaying selected product items.

PLM00026 11.2 Preferences and Environment Variables Reference 21-27


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES
Composite properties on product item objects. Composite properties accept any
attribute that the Java API getProperty method on the rich client IMANComponent
class accepts.
For standard Teamcenter, the valid values are the default values shown in the following
example. Other valid attributes, such as attributes on Item Master Forms, depend on
the attributes your site exposes in UID files.
DEFAULT
VALUES
Item.object_string
Item.object_name
Item.object_desc
Item.process_stage
Item.process_stage_list
Item.current_job
Item.object_type
Item.owning_user
Item.owning_group
DEFAULT
PROTECTION
SCOPE
All.

PortalDesignContextProductItemColumnsShownPrefWidth

DESCRIPTION
Specifies the widths of the columns for the product item properties defined with the
PortalDesignContextProductItemColumnsShownPref preference.
VALID
VALUES
Any positive integer representing the number of characters that are
visible (assuming an average character width). Each value defined in this
preference corresponds with a product item property value defined in the
PortalDesignContextProductItemColumnsShownPref preference.
DEFAULT
VALUES
15
10
8
10
13
8
4
16
8

21-28 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
All.

PortalDesignContextProductItemColumnsHiddenPref

DESCRIPTION
Specifies the hidden product item properties.
VALID
VALUES
Composite properties on product item revision objects. Composite properties
accept any attribute that the Java API getProperty method on the rich client
IMANComponent class accepts.
For standard Teamcenter the valid values are the default values shown in the example
below. Other valid attributes, such as attributes on item revision master forms, depend
on the attributes your site exposes in UID files.
DEFAULT
VALUES
Item.creation_date
Item.item_id
Item.owning_site
Item.archive_date
Item.backup_date
Item.based_on
Item.checked_out
Item.configuration_object_tag
Item.date_released
Item.expl_checkout
Item.export_sites
Item.has_variants
Item.ics_classified
Item.ics_subclass_name
Item.is_frozen
Item.is_modifiable
Item.last_mod_date
Item.last_mod_user
Item.last_release_status
Item.bom_view_tags
Item.IMAN_master_form
Item.item_master_tag
Item.IMAN_manifestation
Item.IMAN_reference
Item.IMAN_Rendering
Item.IMAN_requirement
Item.protection
Item.publication_sites
Item.release_status_list
Item.release_statuses
Item.reservation

PLM00026 11.2 Preferences and Environment Variables Reference 21-29


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

Item.revision_list
ItemRevision.revision_list:object_string
ItemRevision.revision_list:object_desc
ItemRevision.revision_list:object_name
ItemRevision.revision_list:object_type
ItemRevision.revision_list:owning_user
ItemRevision.revision_list:owning_group
ItemRevision.revision_list:process_stage
ItemRevision.revision_list:process_stage_list
ItemRevision.revision_list:current_job
ItemRevision.revision_list:item_revision_id
ItemRevision.revision_list:release_status_list
ItemRevision.revision_list:release_statuses
ItemRevision.revision_list:structure_revisions
ItemRevision.revision_list:item_master_tag
ItemRevision.revision_list:date_released
ItemRevision.revision_list:IMAN_master_form_rev
ItemRevision.revision_list:creation_date
ItemRevision.revision_list:based_on
ItemRevision.revision_list:owning_site
ItemRevision.revision_list:backup_date
ItemRevision.revision_list:archive_date
ItemRevision.revision_list:checked_out
ItemRevision.revision_list:expl_checkout
ItemRevision.revision_list:export_sites
ItemRevision.revision_list:has_variants
ItemRevision.revision_list:ics_classified
ItemRevision.revision_list:ics_subclass_name
ItemRevision.revision_list:IMAN_specification
ItemRevision.revision_list:IMAN_manifestation
ItemRevision.revision_list:IMAN_reference
ItemRevision.revision_list:IMAN_Rendering
ItemRevision.revision_list:IMAN_requirement
ItemRevision.revision_list:IMAN_UG_altrep
ItemRevision.revision_list:IMAN_UG_expression
ItemRevision.revision_list:IMAN_UG_promotion
ItemRevision.revision_list:IMAN_UG_scenario
ItemRevision.revision_list:IMAN_UG_udf
ItemRevision.revision_list:IMAN_UG_wave_geometry
ItemRevision.revision_list:IMAN_UG_wave_part_link
ItemRevision.revision_list:IMAN_UG_wave_position
ItemRevision.revision_list:is_frozen
ItemRevision.revision_list:is_modifiable
ItemRevision.revision_list:last_mod_date
ItemRevision.revision_list:last_mod_user
ItemRevision.revision_list:last_release_status
ItemRevision.revision_list:protection
ItemRevision.revision_list:publication_sites
ItemRevision.revision_list:reservation

21-30 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
All.

PortalDesignContextProductItemColumnsHiddenPrefWidth

DESCRIPTION
Specifies the widths of the columns for the hidden product item properties defined in
the PortalDesignContextProductItemColumnsHiddenPref preference.
VALID
VALUES
Any positive integer representing the number of characters that are visible
(assuming an average character width). Each value defined in this preference
corresponds with a hidden product item property value defined in the
PortalDesignContextProductItemColumnsHiddenPref preference.
DEFAULT
VALUES
12
6
8
9
11
7
3
16
10
19
8
6
10
10
7
9
12
13
14
11
10
12
10
10
11
10
12
10
10
12
8
17

PLM00026 11.2 Preferences and Environment Variables Reference 21-31


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

26
29
28
28
32
29
27
26
25
26
30
29
29
27
30
31
30
28
29
30
28
26
26
25
26
26
30
33
30
26
28
28
30
30
31
30
25
34
31
33
23
25
27
27
30
31
27
25

21-32 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
User preference.

DesignContextRDVContextObject AddToECObjectPseudo FolderPreference

DESCRIPTION
Specifies the pseudofolder used to add a structure context object to an Engineering
Change item revision.

Structure context objects created in a DesignContext session are added to the


Engineering Change item revisions and process objects currently active in the
DesignContext session by placing them in the pseudofolder defined by this preference.
The contents of this pseudofolder can be viewed in My Teamcenter.
VALID
VALUES
Valid Teamcenter pseudofolder name.
DEFAULT
VALUES
IMAN_reference
DEFAULT
PROTECTION
SCOPE
User preference.

DesignContext product context preferences

DesignContextBOMWriterNoDescendantsInPLMXML

DESCRIPTION
Defines if PLMXML files, generated by the BOM Writer for interoperability (open in
NX) in the Design Context application, should have descendants of the selected BOM
Lines.
VALID
VALUES
true The descendants of the selected BOM Lines will not appear in
the generated PLMXML file.

false The descendants of the selected BOM Lines will appear in the
generated PLMXML file.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-33


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DesignContextLoadRDVContextObjectMode

DESCRIPTION
Specifies the mode DesignContext uses to evaluate a structure context object (SCO),
either static mode or dynamic mode. When evaluating an SCO in static mode, the
existing results are returned. When evaluating an SCO in dynamic mode, the results
are updated against the current data and modified as necessary.
VALID
VALUES
0 Static mode. Returns the results already stored in the SCO.

1 Reevaluates the stored results against current data and updates


the SCO with new results.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
All.

DesignContextPickUpNewBackgroundAppearance

DESCRIPTION
Determines whether unselected background appearances data is stored with the
structure context object data during the save operation.
VALID
VALUES
TRUE Saves unselected background appearances data with the
structure context object data during the save operation.

FALSE Does not save unselected background appearances data with


the structure context object data during the save operation.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
User preference.

RDVLoadAppearanceGroupMode

DESCRIPTION
Determines how an appearance group is loaded in the viewer. Appearance groups
contain references to search criteria objects and contain MEAppearancePathNodes
as attachments. The items corresponding to the MEAppearancePathNodes are
loaded in the viewer based on this preference. Three loading methods are used when
items are loaded.

21-34 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
1 The child item of the first occurrence, based on date, is loaded.

2 The child item of the last created occurrence, based on date,


is loaded.

3 The child item of the occurrence configured to the default


revision rule is loaded.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
User preference.

PortalDesignContextProductContextProperties

DESCRIPTION
Specifies the standard for identifying the product context: the item revisions of a
DesignContext product item that represent the same generic product structure. Ideally
this is one item revision.

Values are entered as a list of attributes. All item revisions sharing the same values on
all product context attributes form one product context.
VALID
VALUES
Any attribute that the Java API getProperty method on the rich
client IMANComponent class accepts. For standard Teamcenter, the
list of valid values is a combination of the default values listed for
the PortalDesignContextProductContextColumnsShownPref and
PortalDesignContextProductContextColumnsHiddenPref preferences.

Other valid attributes, such as attributes on item or item revision master forms, depend
on the attributes your site exposes in UID files.

Note

You can specify a composite property.


For more information about composite properties, see Using DesignContext
composite properties.

DEFAULT
VALUES
ItemRevision.object_name
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-35


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

PortalDesignContextProductContextColumnsShownPref

DESCRIPTION
Specifies the list of attributes DesignContext displays in the table of selected
product contexts and the order of display. Typically, this preference lists a
combination of attributes of the item revision and item revision master form.
Users can set this preference from the rich client interface by choosing the
Edit→Options→DesignContext→ProductContext command.
Siemens PLM Software recommends that you start with the list of properties defined
for the PortalDesignContextProductContextProperties preference.
VALID
VALUES
Composite properties on product item objects. Composite properties accept any
attribute that the Java API getProperty method on the rich client IMANComponent
class accepts.
For more information about composite properties, see Structure Manager and Product
Configurator preferences.
For standard Teamcenter the valid values are the default values shown in the example
below. Other valid attributes, such as attributes on item master forms, depend on the
attributes your site exposes in UID files.
DEFAULT
VALUES
These values are composite properties.
ItemRevision.object_string
ItemRevision.object_name
ItemRevision.object_desc
ItemRevision.based_on
ItemRevision.items_tag
ItemRevision.creation_date
ItemRevision.date_released
ItemRevision.last_mod_user
ItemRevision.last_mod_date
DEFAULT
PROTECTION
SCOPE
User preference.

PortalDesignContextProductContextColumnsShownPrefWidth

DESCRIPTION
Specifies the widths of the columns for the product context properties.
For more information, see the
PortalDesignContextProductContextColumnsShownPref preference.
VALID
VALUES
Any positive integer representing the number of characters that are visible (assuming
an average character width).

21-36 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
VALUES
18
10
10
15
16
12
12
10
10
DEFAULT
PROTECTION
SCOPE
User preference.

PortalDesignContextProductContextColumnsHiddenPref

DESCRIPTION
Specifies the widths of the columns for the product context properties.
For more information, see the
PortalDesignContextProductContextColumnsShownPref preference.
VALID
VALUES
Composite properties on product item revision objects. Composite properties
accept any attribute that the Java API getProperty method on the rich client
IMANComponent class accepts.
For more information about composite properties, see Structure Manager and Product
Configurator preferences.
For standard Teamcenter the valid values are the default values shown in the example
below. Other valid attributes, such as attributes on item revision master forms, depend
on the attributes your site exposes in UID files.
DEFAULT
VALUES
ItemRevision.IMAN_specification
ItemRevision.IMAN_master_form_rev
ItemRevision.item_revision_id
ItemRevision.archive_date
ItemRevision.backup_date
ItemRevision.checked_out
ItemRevision.current_job
ItemRevision.expl_checkout
ItemRevision.export_sites
ItemRevision.has_variants
ItemRevision.ics_classified
ItemRevision.ics_subclass_name
ItemRevision.IMAN_requirement
ItemRevision.IMAN_manifestation
ItemRevision.IMAN_reference

PLM00026 11.2 Preferences and Environment Variables Reference 21-37


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

ItemRevision.IMAN_Rendering
ItemRevision.IMAN_UG_altrep
ItemRevision.IMAN_UG_expression
ItemRevision.IMAN_UG_promotion
ItemRevision.IMAN_UG_scenario
ItemRevision.IMAN_UG_udf
ItemRevision.IMAN_UG_wave_geometry
ItemRevision.IMAN_UG_wave_part_link
ItemRevision.IMAN_UG_wave_position
ItemRevision.is_frozen
ItemRevision.is_modifiable
ItemRevision.item_master_tag
ItemRevision.last_release_status
ItemRevision.object_type
ItemRevision.owning_group
ItemRevision.owning_site
ItemRevision.owning_user
ItemRevision.process_stage
ItemRevision.process_stage_list
ItemRevision.protection
ItemRevision.publication_sites
ItemRevision.release_status_list
ItemRevision.release_statuses
ItemRevision.reservation
ItemRevision.structure_revisions
Item.items_tag:object_desc
Item.items_tag:object_name
Item.items_tag:object_string
Item.items_tag:object_type
Item.items_tag:owning_group
Item.items_tag:owning_site
Item.items_tag:owning_user
Item.items_tag:archive_date
Item.items_tag:backup_date
Item.items_tag:based_on
Item.items_tag:checked_out
Item.items_tag:configuration_object_tag
Item.items_tag:creation_date
Item.items_tag:current_job
Item.items_tag:date_released
Item.items_tag:expl_checkout
Item.items_tag:export_sites
Item.items_tag:has_variants
Item.items_tag:ics_classified
Item.items_tag:ics_subclass_name
Item.items_tag:is_frozen
Item.items_tag:is_modifiable
Item.items_tag:item_id
Item.items_tag:last_mod_date

21-38 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Item.items_tag:last_mod_user
Item.items_tag:last_release_status
Item.items_tag:bom_view_tags
Item.items_tag:IMAN_manifestation
Item.items_tag:IMAN_master_form
Item.items_tag:IMAN_reference
Item.items_tag:IMAN_Rendering
Item.items_tag:IMAN_requirement
Item.items_tag:item_master_tag
Item.items_tag:process_stage
Item.items_tag:process_stage_list
Item.items_tag:protection
Item.items_tag:publication_sites
Item.items_tag:release_status_list
Item.items_tag:release_statuses
Item.items_tag:reservation
Item.items_tag:revision_list
DEFAULT
PROTECTION
SCOPE
User preference.

PortalDesignContextProductContextColumnsHiddenPrefWidth

DESCRIPTION
Specifies the widths of the columns for the hidden product context properties.
For more information, see
PortalDesignContextProductContextColumnsShownPref.
VALID
VALUES
Any positive integer representing the number of characters that are visible (assuming
an average character width).
DEFAULT
VALUES
15
14
6
10
12
4
10
19
9
6
9
13
9
10
8

PLM00026 11.2 Preferences and Environment Variables Reference 21-39


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

11
6
11
10
9
7
13
13
13
6
9
11
15
8
10
8
16
10
14
12
10
10
12
8
14
18
19
19
18
20
18
19
18
19
16
18
25
19
18
20
20
18
19
19
24
16
19
16
19

21-40 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

20
24
20
23
22
20
21
22
21
19
23
16
21
23
21
17
20
DEFAULT
PROTECTION
SCOPE
User preference.

DesignContext context definition preferences

PortalDesignContextProductItemQuery

DESCRIPTION
Identifies a query that corresponds to the configurable definition of product item
characteristics.
Specifies the name of a saved query that allows Teamcenter to find product items
based on configurable criteria. You can use the Query Builder application to create
and save this query.
Siemens PLM Software recommends that you create a query with built-in constraints
according to the settings of the PortalDesignContextProductItemProperties
preference.
Teamcenter refers to this preference to find or filter for product items in one of the
following applications:
• Product Configurator (Teamcenter variant and effectivity configurators)

• DesignContext

• Platform Designer
VALID
VALUES
Name of any saved query. Use Query Builder to list available saved queries.
DEFAULT
VALUES
Item Revision

PLM00026 11.2 Preferences and Environment Variables Reference 21-41


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
• This preference can be set by an environment variable.

• If no query matches the specified name, for example, if the name is specified in a
foreign language or read access is denied, Teamcenter:
1. Checks the DesignContext_ItemID_Query_lookup_string preference for an
I18N text server lookup key that maps to a localized saved query name to use
instead of the query name specified in the preference.

2. If the query still fails, sets the query name to Item.

3. If the search class of the saved query is Item Revision, uses the saved query
as a subquery of another query that returns the corresponding items.

4. If the query still fails, returns an error.

PortalDesignContextECObject.TYPE

DESCRIPTION
Specifies the workspace object type used to authorize design changes. Typically
this is an Change Item type, but this preference also allows you to integrate custom
change strategies, for example, using a form to authorize design changes.
If the type corresponds to objects extending from the item revision class, the primary
property displayed in DesignContext is the item ID that has an input field for the item
revision ID. In all other cases, the primary property is the name of the object.
VALID
VALUES
Any Teamcenter change object type.
DEFAULT
VALUES
For new change (Change Manager) objects, the default value is
ChangeRequestRevision. For classic change objects, the default value is
EngChangeRevision.
DEFAULT
PROTECTION
SCOPE
User preference.

PortalDesignContextECObject.WorkPartProperties

DESCRIPTION
Specifies a list of change object relationship properties for finding associated
work parts when a user adds or selects a new change object. Work parts are the
components the user intends to modify or to be the focus of a design session. The list
should specify all properties referencing related work parts that are to be added or
selected in the Work Parts list.

21-42 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
Any property on the change object specified in the
PortalDesignContextECObject.TYPE preference, typically, relationships available as
properties. The relationships specified on this preference are often the same as the
properties specified on the PortalDesignContextECObject.WorkPartRelationships
preference. However, this is not the case if you use the standard Change Viewer.
For new change (Change Manager) objects, possible values are:
CMHasSolutionItem
CMHasProblemItem
CMHasImpactedItem
CMReferences
CMImplementedBy
CMImplements
CMHasWorkBreakdown
For classic change objects, possible values are:
solution_items
problem_items
affected_items
reference_items
addressed_by
DEFAULT
VALUES
solution_items
problem_items
affected_items
reference_items
addressed_by
DEFAULT
PROTECTION
SCOPE
User preference.

PortalDesignContextECObject.WorkPartRelationships

DESCRIPTION
Specifies Teamcenter relationships between work parts and the change objects that
authorize changes on these work parts. These relationships are used to find the
change objects when users add or select work parts.
VALID
VALUES
Any relationships on the change object specified in the
PortalDesignContextECObject.TYPE preference that reference work parts. The
relationships specified in this preference are often the same as the properties specified
on the PortalDesignContextECObject.WorkPartProperties preference. This is not
true, however, for the standard Change Viewer.
For new change (Change Manager) objects, possible values are:

PLM00026 11.2 Preferences and Environment Variables Reference 21-43


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

CMHasSolutionItem
CMHasProblemItem
CMHasImpactedItem
CMReferences
CMImplements
CMHasWorkBreakdown
For classic change objects, possible values are:

EC_affected_item_rel
EC_solution_item_rel
EC_problem_item_rel
EC_reference_item_rel
EC_addressed_by_rel
DEFAULT
VALUES
EC_affected_item_rel
EC_solution_item_rel
EC_problem_item_rel
EC_reference_item_rel
EC_addressed_by_rel
DEFAULT
PROTECTION
SCOPE
User preference.

PortalDesignContextExcludedWorkPart.Types

DESCRIPTION
Specifies the item types excluded from the Work Part list in DesignContext. For sites
that have not yet migrated to Teamcenter Change Viewer, Siemens PLM Software
recommends excluding EngChange items.
VALID
VALUES
Any Teamcenter item type.
DEFAULT
VALUES
EngChange
DEFAULT
PROTECTION
SCOPE
All.

PortalDesignContextAllowNoWorkParts

DESCRIPTION
Specifies whether DesignContext requires users to enter at least one work part in
the Work Part list in the Context Definition window before displaying the Context
Configuration window.

21-44 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

When DesignContext is used only for modifying assemblies or components, you may
want to require users to have at least one work part in the Context Definition window
before the Context Configuration window displays; this may help inexperienced
users to work with the application.
Experienced users may use DesignContext for design review sessions of large pieces
of the product model or for product model reviews. This requires users to use filters to
configure a product context on the second window that they have yet to specify on
the third window.
VALID
VALUES
0 Requires at least one work part in the Work Parts list to
continue. DesignContext displays a warning that no work parts
are provided and displays the initial window again.

1 Allows users to continue to the Context Configuration window


without work parts in the Work Parts list.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
All.

PortalDesignContextIsInstallationAssemblyMethod

DESCRIPTION
Specifies the standard for identifying an installation assembly, that is, the assembly
that defines the existence and purpose of a component in a product structure. Each
appearance of a part can be defined in only one installation assembly at a time.
The values specify the name of a Teamcenter Java API method for the
DesignContextApplication class. The standard methods are listed below. Your
enterprise can create custom Java methods for use with this preference.
Siemens PLM Software recommends setting this preference.
VALID
VALUES
hasIRType
Returns the closest parent assembly up the tree that has a specific item type.
If you specify this value, you must also specify the required item type using the
PortalDesignContextIsInstallationAssemblyMethod.hasIRType.Type preference.

has_bomline_prop
Returns the closes parent assembly up the tree that has a BOM line property.

isPrecise
Returns the first assembly down the path, beginning at the product item that has
a precise BOM View revision.

PLM00026 11.2 Preferences and Environment Variables Reference 21-45


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

transformsComponents
Returns the first assembly down the path, beginning at the product item that transforms
components below it into product space.
DEFAULT
VALUES
hasIRType
DEFAULT
PROTECTION
SCOPE
All.

PortalDesignContextIsInstallationAssemblyMethod.hasIRType.Type

DESCRIPTION
Specifies the item type used to identify an installation assembly using the hasIRType
method.
For more information about using the hasIRType, see the description of the
PortalDesignContextIsInstallationAssemblyMethod preference.
For information about item types, see Business Modeler IDE.
Setting this preference is required when using the hasIRType method.
VALID
VALUES
Accepts a single string as a value. Can be any valid Teamcenter item type.
DEFAULT
VALUES
ItemRevision
DEFAULT
PROTECTION
SCOPE
All.

PortalDesignContextIsInstallationAssemblyMethod.has_bomline_prop.name

DESCRIPTION
Specifies the BOM line property name used to identify an installation
assembly using the has_bomline_prop method. Use this preference with the
PortalDesignContextIsInstallationAssemblyMethod.has_bomline_prop.value
preference to identify installation assemblies by BOM line name and value.
VALID
VALUES
Accepts a single string as a value. Can be any valid property name or run-time
property name on a BOM line.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

21-46 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

PortalDesignContextIsInstallationAssemblyMethod.has_bomline_prop.value

DESCRIPTION
Specifies the BOM line property value used to identify an installation
assembly using the has_bomline_prop method. Use this preference with the
PortalDesignContextIsInstallationAssemblyMethod.has_bomline_prop.name
preference to identify installation assemblies by BOM line name and value.
VALID
VALUES
Accepts a single string as a value. Can be any valid property value or run-time
property value on a BOM line.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PortalDesignContextFindInstallationTreeWalkIncrement

DESCRIPTION
Specifies the direction the tree is maneuvered through to find the installation assembly
for the specified BOM line.
VALID
VALUES
-1 Traverses down from the top of the tree towards the BOM line.

1 Traverses up from the BOM line towards the root.


DEFAULT
VALUES
-1
DEFAULT
PROTECTION
SCOPE
All.

PortalDesignContextSupportInstallationAssemblySelection

DESCRIPTION
Determines whether installation assemblies can be selected from search results.
VALID
VALUES
TRUE Installation assemblies can be selected from search results.

FALSE Installation assemblies cannot be selected from search results.


DEFAULT
VALUES
FALSE

PLM00026 11.2 Preferences and Environment Variables Reference 21-47


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
All.

PortalDesignContextUseUnconfigurableSearchResults

DESCRIPTION
Determines whether unconfigurable search results display in search results.
Unconfigurable search results always prompt an error message (such as No revision
found for current revision rule). This preference determines whether, after the error
message displays, the unconfigurable search results display in the search results list.
VALID
VALUES
TRUE Unconfigurable search results display.

FALSE Unconfigurable search results do not display.


DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
All.

DesignContext filter configuration preferences

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.

21-48 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DesignContextIncludeSubComponentsForSpatialSearch

DESCRIPTION
Specifies whether proximity searches should include or exclude the subcomponents of
a subassembly. It is useful in cases when the subassemblies may not have geometry
of their own.
VALID
VALUES
TRUE The search is executed on the subcomponents in the
subassembly, as well as the subassembly itself.
FALSE The search is executed only on the subassembly, not on the
subcomponents.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

DesignContext_ItemID_Query_lookup_string

DESCRIPTION
Determines the I18n key used to retrieve the internationalized name of the saved
query used to find work parts. DesignContext evaluates this preference when the
PortalDesignContextProductItemQuery preference is not set or points to an
inaccessible query.
VALID
VALUES
Accepts a single string as a value. Must be a valid user entry name which matches
the internationalized name for the ItemID lookup key.
DEFAULT
VALUES
k_find_item_name
This key maps to ItemID in the English locale.
DEFAULT
PROTECTION
SCOPE
All.

DesignContextMaximumShownTabs

DESCRIPTION
Determines the maximum number of search tabs which are stored and display in the
Filter Configuration window of DesignContext.
VALID
VALUES
Single, positive integer.

PLM00026 11.2 Preferences and Environment Variables Reference 21-49


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
VALUES
5
DEFAULT
PROTECTION
SCOPE
User preference.

PortalDesignContextAlwaysResetFilterConfigurationPanel

DESCRIPTION
Determines whether the third window is always reset when transitioning from the
second window of DesignContext.
VALID
VALUES
TRUE The third window is always reset when transitioning from the
second window.
FALSE The third window is not reset when transitioning from the second
window.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
All.

DesignContextPreciseRevRule

DESCRIPTION
Enables searching the product structure based on precise revision rules when
an appearance set is not available for the required precise revision rule, but an
appearance set is available for a similar revision rule containing all the same clauses
except the precise clause.
The search is performed upon a product configuration similar, but not identical to, the
product configuration configured in DesignContext.
Use this method when the difference between the two revision rules only affects piece
part revisions that are very similar in form, fit and function.
When the difference between the two revision rules affect assembly revisions, consider
that different assembly revisions may define different structures and/or different
component positions. In this case, enabling this preference can cause the search to
return misleading results.
Set this preference using the following format:
DesignContextPreciseRevRule.rule-name.suffix
rule-name is the name of the similar revision rule containing all the same clauses
except the precise clause and suffix is PRECISE. For example:
DesignContextPreciseRevRule.Alpha Best_App.PRECISE=

21-50 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Alpha Best
VALID
VALUES
Accepts a single string as a value. Must be the name of a valid revision rule.
DEFAULT
VALUES
PRECISE
DEFAULT
PROTECTION
SCOPE
User preference.

DesignContext interoperability preferences

PortalDesignContextCADbookmarkType

DESCRIPTION
Specifies a bookmark type for the CAD application used with DesignContext.
Users can view this preference and set it for their environments using the
Edit→Options→DesignContext menu command.
VALID
VALUES
1 Generates a bookmark file that can be read by a CAD
application.
2 Generates a bookmark that can be read by both a CAD
application and a visualization application. This setting expands
the entire assembly structure into the bookmark, but marks all
but the selected BOM lines with the VISUALIZE=NO flag.
16 Generates a bookmark that can be read by a visualization
application and contains only the selected BOM lines and
traverses the entire assembly but adds the children of selected
assemblies to the bookmark for display by the visualization
application. Use this bookmark type for visualizing very large
assemblies. You can use OR 16 with 2.
32 Generates a bookmark that excludes children of explicitly
selected children in a visualization application. The visualization
application displays a tree that does not have the children of
the selected subassemblies. If 32 is specified without 16, 32 is
ignored. You can use OR 32 with 18.
64 Generates a bookmark that includes the children of explicitly
selected assemblies but marks them with the VISUALIZE=NO
flag so they are not loaded in the visualization application.
DEFAULT
VALUES
50
Derived from 2 + 16 + 32.

PLM00026 11.2 Preferences and Environment Variables Reference 21-51


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

PortalDesignContextVISbookmarkType

DESCRIPTION
Specifies a bookmark type for the visualization application used with DesignContext.
Users can view this preference and set it for their environments using the
Edit→Options→DesignContext→General menu command.
VALID
VALUES
1 Generates a bookmark file that can be read by a CAD
application.
2 Generates a bookmark that can be read by both a CAD
application and a visualization application. This setting expands
the entire assembly structure into the bookmark, but marks all
but the selected BOM lines with the VISUALIZE=NO flag.
16 Generates a bookmark that can be read by a visualization
application and contains only the selected BOM lines and
traverses the entire assembly but adds the children of selected
assemblies to the bookmark for display by the visualization
application. Use this bookmark type for visualizing very large
assemblies. You can use OR 16 with 2.
32 Generates a bookmark that excludes children of explicitly
selected children in a visualization application. The visualization
application displays a tree that does not have the children of
the selected subassemblies. If 32 is specified without 16, 32 is
ignored. You can use OR 32 with 18.
64 Generates a bookmark that includes the children of explicitly
selected assemblies but marks them with the VISUALIZE=NO
flag so they are not loaded in the visualization application.
DEFAULT
VALUES
50
Derived from 2 + 16 + 32.
DEFAULT
PROTECTION
SCOPE
User preference.

DesignContext_PSE_Synchronization

DESCRIPTION
Determines whether DesignContext search results are automatically synchronized
with Structure Manager, in which case the resulting BOM lines are automatically
selected in Structure Manager.

21-52 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
TRUE DesignContext search results are automatically synchronized
with Structure Manager. The BOM lines returned in the search
results are automatically selected in Structure Manager.
FALSE DesignContext search results are not automatically
synchronized with Structure Manager. No BOM lines are
selected in Structure Manager.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
User preference.

TC_show_open_in_nx_button

DESCRIPTION
Specifies whether the Open in NX button is displayed for interoperation with NX.
VALID
VALUES
true Displays the Open in NX button in DesignContext.
false Does not display the Open in NX button in DesignContext.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

SEEC_TcClient_Enable_Open_Cmd

Description

Enables or disables the Start/Open in Solid Edge command button in the rich client.
Note

This preference is added as part of Solid Edge integration when you choose to install Teamcenter
preferences.

Valid Values

1 Displays the Start/Open in Solid Edge button in the rich client.


0 Does not display the Start/Open in Solid Edge button in the rich client.

PLM00026 11.2 Preferences and Environment Variables Reference 21-53


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

Default Values
1

Default Protection Scope


User preference.

DesignContext performance tuning preferences

RDVClearanceProxyServers

DESCRIPTION
Specifies the database connection used by the clearance proxy server to connect to
the clearance database.
VALID
VALUES
DATASOURCE=<System-running-clearanceDB-proxy>:
<Port-for-clearanceDB-proxy-server>:CONNECT_DATA=<Oracle-connection-name>:
FILTER_NAME=<blank>
An example value is cleardb:7206:CLDB:xyzFilter.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
• The FILTER_NAME field is optional and specifies the clearance calculator in
the clearance database.

• Multiple values may be entered if the site has multiple proxies.


For more information, see ClearanceDB Administration.
RESTRICTIONS
This preference must be set to use the integrated clearance management feature
in DesignContext.

PortalDesignContextMaxMatchingObjects

DESCRIPTION
Specifies the maximum number of components that a query can match (for example,
work parts, change items, or CR jobs). Input the user provides in the DesignContext
Context Definition pane may cause new Teamcenter objects to be loaded.
Note

If the user enters wildcards in any fields of the Context Definition pane, or
while executing the product item query, response times may be unacceptable.

21-54 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

If the number of matching components exceeds the limit, DesignContext


displays a warning, and users can provide more restrictive search criteria.
Users can view this preference and set it for their environments by choosing the
Edit→Options→DesignContext→General menu command.
VALID
VALUES
Accepts any positive integer. Siemens PLM Software recommends using the default
initially and not exceeding 1000.
DEFAULT
VALUES
40
DEFAULT
PROTECTION
SCOPE
User preference.

PortalDesignContextMaxMatchingBOMLines

DESCRIPTION
Specifies the maximum search limit for searches in DesignContext's Filter
Configuration pane. If the number of matches exceed this number a confirmation
window appears. The user can cancel or proceed at this point. Use this preference is
to avoid long searches that accidentally match a very large number of components.
If the number of matching components exceeds the limit, DesignContext displays
a confirmation message allowing users to either continue or cancel the query.
Users can view this preference and set it for their environments by choosing the
Edit→Options→DesignContext→General menu command.
VALID
VALUES
Accepts any positive integer. Siemens PLM Software recommends using the default
initially and not exceeding 1000.
DEFAULT
VALUES
300
DEFAULT
PROTECTION
SCOPE
User preference.

PortalDesignContextSetVariantRulesMaxTargetAppearances

DESCRIPTION
Specifies the maximum number of target appearances for the Valid Overlays Only
button on the DesignContext Filter Configuration window, thus limiting the processing
time spent determining and evaluating the set of variant rules configuring a set of
target appearances.
Users can view this preference and set it for their environments choosing the
Edit→Options→DesignContext→General menu command.

PLM00026 11.2 Preferences and Environment Variables Reference 21-55


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES
Any positive integer; integers higher than 1000 are unlikely. Siemens PLM Software
recommends using the default initially.
DEFAULT
VALUES
5
DEFAULT
PROTECTION
SCOPE
User preference.

Using DesignContext composite properties


A composite property of an object defines a path to associated objects, resulting in the evaluation of
a property on the associated objects. Each step in the chain de-references the next related object
in the path.
The syntax for defining composite properties is:
[object-type-name.][reference-property
[(criteria-property=criteria-value
[,criteria-property=criteria-value]):]
[reference-property[(criteria-property=criteria-value
[, criteria-property=criteria-value])]:]]property
object-type-name
Specifies a Teamcenter object type name.

reference-property
Specifies a typed reference, untyped reference, typed relation, or untyped relation.

criteria-property
Specifies any valid composite property (implemented using recursion). It is a criteria list in case
the reference-property value is ambiguous.

property
Specifies any property that the Java API getProperty method on the rich client IMANComponent
class accepts.

The following example evaluates the product_year attribute on the item revision master of an item
revision:
item_master_tag:product_year

The following example evaluates the Project_ID attribute on the item master of the item of an item
revision:
item_tag:item_master_tag:Project_ID

The following example evaluates the MyCustomProperty attribute of all objects in the
IMAN_master_form pseudofolder of the item of an item revision that have the MyCustomItemForm
object type. The example returns all values in a comma-separated list:

21-56 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

item_tag:IMAN_master_form:(object_type=MyCustomItemFor:MyCustomProperty

The following example evaluates the Project_ID property on each item revision of a specified item:
ItemRevision Master.revision_list:item_master_tag:Project_ID

Note

If three item revisions share the same Project_ID of 3200, the duplicated values are shown as
3200(x3). A list of values is separated by the substring comma (,). The item revision master
prefix specifies that the physical property is on an object of type item revision master.

Multi-Structure Manager preferences


ALLOC_Group_Allocation_Types

DESCRIPTION
For use with allocation functionality. Specifies the allocation types that can be used
in the specified allocation map. For example, ensure the Allocation_One allocation
type is created only in association with the AllocationMap_one allocation map by
setting this preference to:
AllocationMap_one:Allocation_One
VALID
VALUES
Allocation map type:Allocation type,Allocation type
Where Allocation map type is a valid Teamcenter allocation map type, and all
Allocation type entries are valid Teamcenter allocation types.
DEFAULT
VALUES
AllocationMap:Allocation
DEFAULT
PROTECTION
SCOPE
Site preference.

ALLOC_Product_Representation_Types

DESCRIPTION
For use with allocation functionality. Specifies which BOM view types can be used to
create allocations in the specified allocation map. For example, ensure allocations
are created only between MEProcess and View types for the AllocationMap_one
allocation context by setting this preference to:
AllocationMap_one:MEProcess,View
VALID
VALUES
Allocation map type:View type1,View type2
Where Allocation map type is a valid Teamcenter allocation map type, and all View
type entries are valid subtypes of Teamcenter views.

PLM00026 11.2 Preferences and Environment Variables Reference 21-57


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
VALUES
AllocationMap:view,CAEAnalysis,MEProcess,MESetup
DEFAULT
PROTECTION
SCOPE
Site preference.

ALLOC_Target_Occurrence_Types

DESCRIPTION
For use with allocation functionality. Specifies which components can be used as
target components for a given allocation type.
VALID
VALUES
Allocation type::Target component type
Where Allocation type is a valid Teamcenter allocation type, and Target component
type is a valid Teamcenter object type used in a product structure.
DEFAULT
VALUES
Allocation:Item,PSConnection,PSSignal,RouteLocation,GeneralDesign Element,
GeneralDesignElementLink
DEFAULT
PROTECTION
SCOPE
Site preference.

ALLOC_Source_Occurrence_Types

DESCRIPTION
For use with allocation functionality. Specifies the components that can be used as
source components for a given allocation type.
VALID
VALUES
Allocation type::Source component type
Where Allocation type is a valid Teamcenter allocation type, and Source component
type is a valid Teamcenter object type used in a product structure.
DEFAULT
VALUES
Allocation:Item,PSConnection,PSSignal,RouteLocation,GeneralDesign Element,
GeneralDesignElementLink
DEFAULT
PROTECTION
SCOPE
Site preference.

21-58 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

ALLOC_source_target_cardinality

DESCRIPTION
For use with allocation functionality. Specifies the cardinality permitted between a
given allocation type and other product structure object types.
Note

Specify valid target components for a particular allocation type


using the ALLOC_Target_Occurrence_Types preference. Specify
valid source components for a particular allocation type using the
ALLOC_Source_Occurrence_Types preference.

The system supports multiple sources and targets for allocation using cardinality
functionality. The system supports the following allocation relationships:
One-to-one
Many-to-one
One-to-many
Many-to-many
Example

For example, you can use this preference to enforce a cardinality allowing the
Network_Port type allocation to participate only in one-to-one relationships.
Allocations using this type can contain only a single source and a single target.
To do so, set this preference to:
Network_Port::1,1

VALID
VALUES
Allocation subtype::1,1 Where Allocation subtype specifies the allocation type; this
specified allocation type can only be used in one-to-one
relationships.
Allocation subtype::1,n Where Allocation subtype is a valid Teamcenter object
type; this specified object type can be used in one-to-many
relationships.
Allocation subtype::n,1 Where Allocation subtype is a valid Teamcenter object
type; this specified object type can be used in many-to-one
relationships.
Allocation subtype::n,n Where Allocation subtype is a valid Teamcenter object type;
this specified object type can be used in many-to-many
relationships.
DEFAULT
VALUES
Allocation::n,n
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-59


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

ALLOC_map_copy_allocations

DESCRIPTION
For use with allocation functionality. Determines whether the allocation set is carried
forward when the allocation map is saved as a new allocation map, or revised. By
default, the allocation set is carried forward during either of these actions. Prevent
the allocation set from being carried forward by setting this preference with the names
of the revision action (saveAs, or Revise) which you do not want to carry forward
the allocation set.
VALID
VALUES
saveAs The allocation set is not carried forward when the allocation
map is saved as a new allocation map.

Revise The allocation set is not carried forward when the allocation
map is revised.
DEFAULT
VALUES
saveAs
Revise
DEFAULT
PROTECTION
SCOPE
Site preference.

Default_StructureContext_Type

DESCRIPTION
Determines which type of structure context is created when saving a loaded object
as a context.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid type and be
of the following format:

item_type:structure_context_type
DEFAULT
VALUES
MEProcess:MEProcessContext

MEOP:MEProcessContext

MEWorkarea:MEPlantContext

Item:MEProductContext

MEGenericBOP:MEProcessContext

MEProductBOP:MEProcessContext

Mes0MESTXLibrary:MEProcessContext

21-60 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

PartStructureDepthForCompletenessCheck

DESCRIPTION
Determines how many levels Teamcenter traverses when you perform a completeness
check of the part structures resulting from CAD BOM alignment.
VALID
VALUES
Accepts any numeric value. If you enter 0 or a negative value, a completeness check
is not performed.
DEFAULT
VALUES
10000
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
If you change the value of this preference, you must restart the Teamcenter server for
the change to take effect.

MEDataPanelPosition

DESCRIPTION
Specifies where to open the data pane of a structure, either to the right of the structure
or below the structure.
VALID
VALUES
right Displays the data pane to the right of the structure.
bottom Displays the data pane below the structure.
DEFAULT
VALUES
bottom
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 21-61


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

Structure Manager and Product Configurator preferences

Behavior and configuration preferences

BOM_objects_excluded_from_split

DESCRIPTION
Contains a list of object types and subtypes that are excluded from a Split Occurrence
operation.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
object type or subtype.
DEFAULT
VALUES
Connection
Signal
Software
DEFAULT
PROTECTION
SCOPE
Site preference.

CFMEffConfigItemProperties

DESCRIPTION
Determines the properties and values that define when an item is a configuration
item. If this preference is not set, the system uses the default property of the
is_configuration_item POM_attribute.
You specify one or more properties and values that identify an item as an effectivity
configuration item. A configuration item defines an effectivity boundary in a product
structure, that is, a point at which the product context is modified. (This is point at
which the revision rule end item changes.)
VALID
VALUES
Any item property with its value on the following line prefixed with == characters. To
use a simple logical property to define configuration items, configure this preference
in the following format:
is_configuration_item
==Y

For example, to use items of the Product type as configuration items, configure this
preference in the following format:
object_type
==Product
DEFAULT
VALUES
is_configuration_item == Y

21-62 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
• You can configure any chain of reference properties separated by a : character,
terminating with a non-reference property and value. For example, to use items
that have an object type of Item Master by the item_master_tag property of the
item, configure the preference as follows:
item_master_tag:object_type
==Item Master

• You can use multiple values in a conditional statement. For example, to use an
object type of Product or Vehicle, configure the preference as follows:
object_type
== Product
== Vehicle

• You can use multiple properties in an OR statement. For example, to use the
presence of a logical property or item type, configure the preference as follows:
is_configuration_item
==Y
object_type
==Product
==Vehicle

• You can use multiple properties in an AND statement by including the & token.
For example, to use a logical property and item type, configure the preference as
follows:
is_configuration_item
==Y
&
object_type
==Product
==Vehicle

CFM_ITEM_TYPE_RULE_INCLUDE_SUB_TYPES

DESCRIPTION
Determines whether an assembly containing subtypes can be configured based on the
base type's revision rule.
For example, given the following type hierarchy
PART
HYD_PART

ELE_PART

PUMP_PART

when the following revision rule is applied


has item type (PART) { AP status, by unit #}

PLM00026 11.2 Preferences and Environment Variables Reference 21-63


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

the revision rule for the item type PART applies to the base type and all its subtypes
if this preference is set to true.
VALID
VALUES
true Allows users to configure assemblies when the base item types
(item type of each line in the assembly), or one of the subtypes
matches the Has Item Type revision rule entry.
false Allows user to configure assemblies only when the base item
types (item type of each line in the assembly) matches the Has
Item Type revision rule entry.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

ClosureRulesForBomExpansion

DESCRIPTION
Structure Manager allows the user to limit expansion of the product structure if a full
expansion is not required. For example, you may not want to expand a subassembly if
it is not assigned to your current project. Use this preference to specify one or more
existing closure rules containing expansion constraints from which the user can select
when expanding the structure.
VALID
VALUES
Accepts one or more strings as values. Each string must be the name of a valid
closure rule of type export.
DEFAULT
VALUES
BOMExpandSkipByProjAssignment
BOMExpandProcessByProjectAssign
BOMExpandSkipByItemType
BOMExpandProcessByItemType
BOMExpandSkipByVariableItemType
BOMExpProcessVariableItemType
BOMExpandSkipByPartSource
BOMExpandProcessByPartSource
DEFAULT
PROTECTION
SCOPE
Site preference.

GDE_objects_with_integer_quantity

DESCRIPTION
Contains a list of general design element (GDE) objects or subclasses for which the
user can specify only an integer value as the quantity.

21-64 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
Accepts one or more strings as values. Each string must be a valid GDE object or
subclass.
DEFAULT
VALUES
Interface
DEFAULT
PROTECTION
SCOPE
Site preference.

Property_Comparator

DESCRIPTION
Determines the order in which BOM lines are sorted and the method by which they
are sorted. By default, Teamcenter provides two comparators, a lexicographical
comparator and a sequence number comparator. You can sort the lines on any BOM
line property using one of these comparators.
VALID
VALUES
property_name= Sorts the display on the property_name BOM line property
Lexicographical using the lexicographical comparator. For example, if you set
the preference to bl_item_object_name=Lexicographical, the
display is sorted by the item name property.
FindNumber Sorts the display by the sequence (find) number property.
DEFAULT
VALUES
None. By default, this preference does not exist and (if required) you should create it.
If it is not set to an alternative value, the display is sorted on the find number.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
• A customizer can use the IPropertyComparatorService extension point to map
other properties to a comparator and sort the display by those properties.

• This preference affects all applications that display BOM lines, including Structure
Manager and Manufacturing Process Planner.

PSE_check_read_access_for_Rev_Rule_entry

DESCRIPTION
Determines if Teamcenter evaluates revision rules according to the user's read access,
allowing the optional display of the first configured entry to which the user has access.

PLM00026 11.2 Preferences and Environment Variables Reference 21-65


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES
true Revision rules are evaluated according to read access and
Teamcenter displays the first accessible revision. If no revisions
are accessible, Teamcenter displays an UNREADABLE tag.

false Revision rules are not evaluated according to read access.


If the first configured revision is not accessible, Teamcenter
displays it as UNREADABLE.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
This preference only affects the evaluation of imprecise entries, not precise
entries. Only Working, Status, Latest and Override revision rule entries return
read-accessible item revisions.

PSE_default_view_type

DESCRIPTION
Determines which view type preference DesignContext and Structure Manager queries
use. By default, the system uses the TC_NX_View_Type preference, which in turn, is
set to view by default.
VALID
VALUES
A single string as a value; the string must be a valid Teamcenter preference, set to
a valid query type.
DEFAULT
VALUES
TC_NX_View_Type
DEFAULT
PROTECTION
SCOPE
All.

PSE_Display_Pending_Edits

DESCRIPTION
Determines whether pending edit markup functionality is enabled for editing actions
such as adding, deleting, or modifying property attributes. These pending edits can be
saved to the database, cancelled, or reversed.
Note

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


variable.

21-66 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Note

This editing mode is not available when an absolute occurrence or incremental


change context is set. BOM compares cannot be run on objects containing
pending edits.

VALID
VALUES
true Pending edit markup is enabled for editing actions.

false Pending edit markup is not enabled for editing actions.


DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

PSE_expand_on_open

DESCRIPTION
Determines whether the root node of an assembly is expanded when opened in
Structure Manager, Manufacturing Process Planner, and Multi-Structure Manager.
VALID
VALUES
0 The root node of an assembly is not expanded when opened
in Structure Manager, Manufacturing Process Planner, and
Multi-Structure Manager.

1 The root node of an assembly is expanded when opened


in Structure Manager, Manufacturing Process Planner, and
Multi-Structure Manager.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

PSE_ROLL_UP_TEMPLATES

DESCRIPTION
Determines which rollup templates are kept as user favorites. This preference is set
automatically when a user selects favorites using the Roll Up Templates Manager.
VALID
VALUES
The system automatically adds values to this preference when a user selects favorites
using the Roll Up Templates Manager.

PLM00026 11.2 Preferences and Environment Variables Reference 21-67


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

ROLL_UP_QUANTITY_FLAG

DESCRIPTION
Determines if the BOM properties rollup feature includes the quantity in the calculation
when rolling up property values in a structure. For example, if the quantity on a line
is 2 and this preference is set to true, the value is doubled for both the line and the
substructure.

By default, this preference does not exist and you must add it to the system if it is
required.
VALID
VALUES
true Teamcenter includes the quantity value when performing rollup
calculations.

false Teamcenter does not include the quantity value when


performing rollup calculations.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site or user logical preference.

PSEshowToolBar

DESCRIPTION
Controls the default setting of the Display→Show Toolbar menu command.
VALID
VALUES
YES Displays the toolbar.

NO Does not display the toolbar.


DEFAULT
VALUES
YES
DEFAULT
PROTECTION
SCOPE
User preference.

21-68 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

PS_Default_Rev_For_Occ_Cond_Validation

DESCRIPTION
Defines the default revision used when the system validates a child item.
VALID
VALUES
Any valid release status including:
Latest
Latest Working
TM Released
DEFAULT
VALUES
Latest
DEFAULT
PROTECTION
SCOPE
Site preference.

PS_Bypass_Occurrence_Condition

DESCRIPTION
Bypasses occurrence condition validations for specified actions and operations.
VALID
VALUES
Import
Duplicate
Baseline
Revise
SaveAs
DEFAULT
VALUES
None. Bypasses validations of all actions and operations.
DEFAULT
PROTECTION
SCOPE
Site preference.

PS_Find_Number_Validation

DESCRIPTION
Determines whether the system validates find numbers. If validation is enabled with
this preference, an error displays when the find number is zero or is not unique within
the parent structure.
A find number is a unique number assigned to each line in the product structure. When
users add an item to the product structure, the line receives the next available find
number in the defined sequence. Users can rearrange the structure in find numbers
by clicking the Find Number column header. This rearrangement persists for future
Structure Manager sessions.

PLM00026 11.2 Preferences and Environment Variables Reference 21-69


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES
true The system validates the Find Number.
false The system does not validate the Find Number.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PS_new_seqno_mode

DESCRIPTION
Determines how new find numbers are allocated when items are inserted into a BOM
view or BOM view revision.
VALID
VALUES
new Every item is given a new find number within the current BOM
view, starting with 10 and increasing by 10.
existing If an item of the same ID already exists in the BOM view, the
inserted item is given the same find number. If not, the item is
given a new find number as above.
none No find number is allocated to items inserted into a BOM view;
users can add their own later.
DEFAULT
VALUES
new
DEFAULT
PROTECTION
SCOPE
Site preference.

PS_replace_with_substructure

DESCRIPTION
Determines whether substructures below the selected node can be replaced, along
with the selected node.
Users can replace an item representing a node in the structure with another item.
All data associated with the original node is preserved. This preference determines
whether substructures can also be replaced.
For more information about replacing nodes in product structures, see Structure
Manager.
VALID
VALUES
true The selected node and its entire substructure (if any) are
replaced without prompting.

21-70 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

false If the selected node contains a substructure, the system


displays an error message and does not complete the
replacement action.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
All.

PS_wu_configd_imprecise_only

DESCRIPTION
Determines whether parent item revisions are included in Where Used search results,
regardless of whether they are configured by the revision rule.
Where Used search results are filtered to include only those revisions configured by
the selected revision rule. The revision rule is applied at each level, up to and including
the top level. The system displays any intermediate level non-configured revisions
referenced by precise occurrences, if the top of the chain of precise links is configured.
VALID
VALUES
true Search results omit parent item revision objects that are not
configured by the revision rule. This may occur if the specified
revision rule contains only non-precise entries.
Note

This setting is equivalent to the default behavior in


Teamcenter Engineering 9.1 and earlier releases.

false Search results include all parent item revision objects,


regardless of whether they are configured by the revision rule.
For example, use this setting to make a where-used query on
Part1–A to identify every occurrence where Part1 is used with A
as its configured revision. You obtain the same results whether
you query one level at a time or all levels simultaneously,
including with mixed precise and imprecise structures. You do
not find any imprecise parent assemblies that are not configured
by the selected revision rule.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-71


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

PUBLISH_AlignableSourceTypes

DESCRIPTION
Determines which types are PublishLink sources. A PublishLink copies information
from a source occurrence to a target occurrence. For example, transform data is
copied from a design occurrence to a part occurrence.
VALID
VALUES
Accepts multiple strings values. Each string must be a valid item type. The string can
also contain subtypes of the item. For example:
Item,Design
DEFAULT
VALUES
Item,Design
DEFAULT
PROTECTION
SCOPE
Site preference.

PUBLISH_AlignableTargetTypes

DESCRIPTION
Determines which types are PublishLink targets. A PublishLink copies information
from a source occurrence to a target occurrence. For example, transform data is
copied from a design occurrence to a part occurrence.
VALID
VALUES
Accepts multiple strings values. Each string must be a valid item type. The string can
also contain subtypes of the item. For example:
Item,Part
DEFAULT
VALUES
Item,Part
DEFAULT
PROTECTION
SCOPE
Site preference.

REV_RULE_WHERE_USED_DEFAULT_VALUE

DESCRIPTION
Sets the default revision rule for where-used searches in Structure Manager. This
preference does not exist by default and the user must create it.
VALID
VALUES
Accepts a single string as a value. The string must be a valid revision rule.
DEFAULT
VALUES
None.

21-72 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
User preference.

SkipClosureRuleEquivalent

DESCRIPTION
If you use closure rules to limit the expansion of the product structure, use this
preference to determine whether the closure rule is re-evaluated each time you apply it
or only if changes are made to the applied closure rule.
VALID
VALUES
True The closure rule is always evaluated each time you apply it, even if there is no
change in the closure rule or its variables or values.
False The closure rule is evaluated only if changes are made to the variables or
values of the closure rule that is already applied on the same window or if an
altogether new closure rule is applied on the window.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
User preference.

TC_BOM_Precision_Preference

DESCRIPTION
Determines whether a new BOM view or BOM view revision should be precise or
imprecise. The Add Design To Product wizard creates new occurrences based on
this preference setting.
This preference can be set in the Options dialog box of either the rich client or the
thin client.
VALID
VALUES
Precise New BOM views and BOM view revisions are created precise.
Imprecise New BOM views and BOM view revisions are created imprecise.
DEFAULT
VALUES
Imprecise
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-73


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

TC_show_open_in_pse_button

DESCRIPTION
Determines whether the Open in Structure Manager button displays in the toolbar.
VALID
VALUES
true Displays the button in the toolbar.
false Does not display the button in the toolbar.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

TC_config_rule_name

DESCRIPTION
Specifies the default revision rule used when selecting the product context based on
the chosen product item. If not defined, Latest Working/Any Release Status is used.
VALID
VALUES
One or more strings as values; each string must be a valid revision rule.
DEFAULT
VALUES
Latest Working
DEFAULT
PROTECTION
SCOPE
All.

Vis_InterOptWithProductViewDataset

DESCRIPTION
Determines whether product view datasets associated with item revisions and BOM
views are sent to Teamcenter lifecycle visualization 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 lifecycle visualization along with
the item revisions and BOM views.
FALSE Product view datasets associated with item revisions and BOM
views are not sent to Teamcenter lifecycle visualization along
with the item revisions and BOM views.
DEFAULT
VALUES
FALSE

21-74 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

VISTopLevelRef_relation_primary

DESCRIPTION
Contains a list of valid primary object types for the VISTopLevelRef 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
SnapshotViewData 3D product view object types are valid for this relation.
DEFAULT
VALUES
SnapshotViewData
DEFAULT
PROTECTION
SCOPE
Site preference.

Structure Manager column preferences

BOM_Properties_For_Column_Selection

DESCRIPTION
Specifies the system names of the available property columns that will be displayed
in Structure Manager when the user inserts a column. This preference can be set at
each of the required levels, that is, Site, Group, Role, and User.
Note

This preference is not included in the default Teamcenter installation. If


required, you must add it to the database.

VALID
VALUES
Any valid BOM line property name, including any additional BOM line
property names derived by using the Fnd0BOMLineItemConfigProps,
Fnd0BOMLineRevConfigProps, BOMLineFormConfiguredProperties, and
BOMLineRevConfiguredProperties global constants.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 21-75


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
All.
NOTES
1. When you define the available columns for a given scope, they must be a subset
of the next higher level scope. For example, the columns for the Group scope
must be a subset of those defined for the Site scope.

2. If no site preference value is defined in any scope, all valid BOM line properties
are listed in the Insert Column dialog box.

3. If any displayed property is not in the final list of preference values in all scopes
listed in the Insert Column dialog box and you remove it from the Structure
Manager display, you cannot add it back again.

4. If you, as a user, want to configure the list of displayed properties, review the
current list of properties that are displayed, identify the properties you want to see,
and use this preference to set the display.

PortalPSEColumnsShownPref

DESCRIPTION
Specifies the list of Structure Manager columns displayed from left-to-right.
To display the Explore Checked Out property, add the bl_rev_expl_checkout value
to this list.
Note

Depending on your system configuration, you may also have to set the
PSEDisplayNameWithTypeColumnsShownPref preference.

VALID
VALUES
Accepts multiple strings as values. It must be a valid BOM line property.
DEFAULT
VALUES
bl_indented_title
bl_item_object_type
bl_config_string
bl_rev_release_status_list
bl_sequence_no
bl_part_source
bl_uom
bl_ref_designator
bl_all_notes
bl_variant_state
bl_rev_has_variants
bl_variant_condition
bl_is_occ_configured
bl_has_date_effectivity

21-76 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

bl_rev_checked_out
fnd0bl_has_active_markup

DEFAULT
PROTECTION
SCOPE
Site preference.

PortalPSEShownColumnsWidthPref

DESCRIPTION
Determines the column width for the list of properties defined in the
PortalPSEColumnsShownPref preference.
VALID
VALUES
Accepts multiple strings as values. Each value must be a positive integer, and align, in
order, with a value defined in the PortalPSEColumnsShownPref preference.
DEFAULT
VALUES
41
15
18
16
9
5
3
9
19
4
4
16
4
4

DEFAULT
PROTECTION
SCOPE
Site preference.

PSEDisplayNameWithTypeColumnsShownPref

DESCRIPTION
Specifies the internal names of BOM line properties whose display names appear as
columns from left-to-right in the Structure Manager application.
This preference must contain the same set of BOM line properties that are specified
in the PortalPSEColumnsShownPref preference. The only difference is that the
property names in this preference must be prefixed with the type name.

PLM00026 11.2 Preferences and Environment Variables Reference 21-77


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES
Accepts multiple strings as values. Each value must be a valid BOM line property
prefixed with a valid type.
Each value must correspond with a value defined in the
PortalPSEColumnsShownPref preference. Values must be listed in the same order
in both preferences.
The default type for Structure Manager properties is BOMLine.
DEFAULT
VALUES
BOMLine.bl_indented_title
BOMLine.bl_item_object_type
BOMLine.bl_config_string
BOMLine.bl_rev_release_status_list
BOMLine.bl_sequence_no
BOMLine.bl_part_source
BOMLine.bl_uom
BOMLine.bl_ref_designator
BOMLine.bl_all_notes
BOMLine.bl_variant_state
BOMLine.bl_rev_has_variants
BOMLine.bl_variant_condition
BOMLine.bl_is_occ_configured
BOMLine.bl_has_date_effectivity
BOMLine.bl_rev_checked_out
BOMLine.fnd0bl_has_active_markup
DEFAULT
PROTECTION
SCOPE
Site preference.

PSESearchColumnsShownPref

DESCRIPTION
Determines which columns are displayed in the search results table, in left-to-right
order. Column width is defined using the PSESearchShownColumnWidthsPref
preference.
VALID
VALUES
One or more strings as values; each string must be a valid Structure Manager attribute.
DEFAULT
VALUES
bl_item_object_name
bl_item_item_id
bl_item_object_desc
bl_formatted_parent_name
bl_formatted_ancestor_name
bl_appearance_validity_in
bl_appearance_validity_out

21-78 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
User preference.

PSESearchShownColumnWidthsPref

DESCRIPTION
Determines column width for each column defined in the
PSESearchColumnsShownPref preference.
VALID
VALUES
One or more integers as values; each integer determines the column width in
characters. The first value listed in this preference determines the column width of the
first column defined in the preference, PSESearchColumnsShownPref and so on.
DEFAULT
VALUES
30
20
30
32
32
20
20
DEFAULT
PROTECTION
SCOPE
User preference.

variant_item_column_width

DESCRIPTION
Determines the width of the item column in the Variant Rule dialog box. There is
no mechanism to reorder the columns.
VALID
VALUES
A positive integer.
DEFAULT
VALUES
20
DEFAULT
PROTECTION
SCOPE
User preference.

variant_option_column_width

DESCRIPTION
Determines the width of the option column in the Variant Rule dialog box. There is
no mechanism to reorder the columns.

PLM00026 11.2 Preferences and Environment Variables Reference 21-79


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES
A positive integer.
DEFAULT
VALUES
24
DEFAULT
PROTECTION
SCOPE
User preference.

variant_description_column_width

DESCRIPTION
Determines the width of the description column in the Variant Rule dialog box. There
is no mechanism to reorder the columns.
VALID
VALUES
A positive integer.
DEFAULT
VALUES
20
DEFAULT
PROTECTION
SCOPE
User preference.

variant_value_column_width

DESCRIPTION
Determines the width of the value column in the Variant Rule dialog box. There is
no mechanism to reorder the columns.
VALID
VALUES
A positive integer.
DEFAULT
VALUES
25
DEFAULT
PROTECTION
SCOPE
User preference.

variant_state_column_width

DESCRIPTION
Determines the width of the state column in the Variant Rule dialog box. There is
no mechanism to reorder the columns.
VALID
VALUES
A positive integer.

21-80 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
VALUES
30
DEFAULT
PROTECTION
SCOPE
User preference.

variant_values_column_width

DESCRIPTION
Determines the width of the values column in the Variant Rule dialog box. There is
no mechanism to reorder the columns.
VALID
VALUES
A positive integer.
DEFAULT
VALUES
30
DEFAULT
PROTECTION
SCOPE
User preference.

vrule_reln_column_width

DESCRIPTION
Determines the width of the variant rule release column in the Variant Rule dialog box.
There is no mechanism to reorder the columns.
VALID
VALUES
A positive integer.
DEFAULT
VALUES
20
DEFAULT
PROTECTION
SCOPE
User preference.

Structure Manager display preferences

application name.ic_icon_level

DESCRIPTION
Determines which incremental change (IC) context icons, if any, are displayed. Display
of IC context icons can be determined for various rich client applications, such as
Structure Manager, Manufacturing Process Planner, and Multi-Structure Manager.
Siemens PLM Software recommends setting this preference by selecting the Display
Icons option from the Incremental Change command in the Tools menu of the

PLM00026 11.2 Preferences and Environment Variables Reference 21-81


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

relevant application. Check the level to which you want icons displayed. The rich client
automatically inserts the name of the application at the beginning of the preference
name.
VALID
VALUES
None Displays no context icons.
All Displays all context icons.
Current Displays icons for only the context currently being edited.
DEFAULT
VALUES
All
DEFAULT
PROTECTION
SCOPE
User preference.

application name.ic_show_remove_icons

DESCRIPTION
Determines whether the Remove incremental change icon is displayed. Display of
this icon can be determined for various rich client applications, such as Structure
Manager, Manufacturing Process Planner, and Multi-Structure Manager.
Siemens PLM Software recommends setting this preference by selecting the Display
Icons option from the Incremental Change command in the Tools menu of the
relevant application. Check the Hide Remove Icons entry. The rich client automatically
inserts the name of the application at the beginning of the preference name.
VALID
VALUES
True Displays the Remove incremental change icon in the BOM lines of the
specified application.
False Does not display the Remove incremental change icon in the BOM lines
of the specified application.
DEFAULT
VALUES
All
DEFAULT
PROTECTION
SCOPE
User preference.

BOMCompareVisibleModes

DESCRIPTION
Determines which compare modes display in the BOM Compare dialog box and
are returned by the BOM_compare_ask_modes ITK function. If this preference
is removed, the default setting is used.
For more information about comparing product structures, see Structure Manager.

21-82 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
IMAN_bcm_single_level_seq
IMAN_bcm_single_level
IMAN_bcm_var_level_seq
IMAN_bcm_var_level
IMAN_bcm_ext_var_level_seq
IMAN_bcm_ext_var_level
IMAN_bcm_lowest_level_seq
IMAN_bcm_lowest_level
IMAN_bcm_every_level

Use the following compare modes for item-based logical BOM (LBOM) compares:
IMAN_lbcm_var_level
IMAN_lbcm_single_level
IMAN_lbcm_lowest_level
Use the following compare modes for occurrence-based logical BOM (LBOM)
compares:
IMAN_lbcm_var_level_occ
IMAN_lbcm_single_level_occ

Note

Any custom compare mode must also be listed as a value in order for the mode
to display in the BOM Compare dialog box.

DEFAULT
VALUES
IMAN_bcm_single_level_seq
IMAN_bcm_single_level
IMAN_bcm_var_level_seq
IMAN_bcm_var_level
IMAN_bcm_lowest_level
IMAN_lbcm_single_level_occ
DEFAULT
PROTECTION
SCOPE
User preference.

BOM_Display_Referencer_Panel

DESCRIPTION
Controls the display behavior of the Referencers tab in the data pane.
VALID
VALUES
True Referencers tab is displayed in the data pane.

False Referencers tab is not displayed in the data pane.

PLM00026 11.2 Preferences and Environment Variables Reference 21-83


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
VALUE
True
SCOPE
Site preference.

BOM_Display_Variant_Super_Panel

DESCRIPTION
Controls the display behavior of the Variant tab in the data pane.
VALID
VALUES
True Variant tab is displayed in the data pane.
False Variant tab is not displayed in the data pane.
DEFAULT
VALUE
True
SCOPE
Site preference.

BOM_Display_Attachments_Panel

DESCRIPTION
Controls the display behavior of the Attachments tab in the data pane.
VALID
VALUES
True Attachments tab is displayed in the data pane.
False Attachments tab is not displayed in the data pane.
DEFAULT
VALUE
True
SCOPE
Site preference.

BOM_Frozen_Column_Count

DESCRIPTION
Controls the scrolling behavior of the structure tree and other columns. The first n
number of columns indicated by this preference are frozen for horizontal scrolling.
VALID
VALUES
Positive integer.
DEFAULT
VALUE
0
SCOPE
User and site preference.

21-84 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

NOTES
• This preference freezes a specified number of columns independently of the
selected column configuration. You cannot freeze specific columns.

• If you leave at least one column unfrozen, vertical scroll bars are always available.
This configuration provides easier navigation, especially if you are comparing
structures in a split window.

• Platform Designer does not support this feature. If you use Platform Designer, you
should leave this preference set to 0.

BOM_MARKUP_ADD_FONT_STYLE

DESCRIPTION
Specifies the text font style when a user adds a markup to a BOM line in Structure
Manager or a markup space in 4G Designer.
VALID
VALUES
0 (plain text)
1 (bold text)
2 (italic text)
3 (bold and italic text)
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

BOM_MARKUP_ADD_FOREGROUND

DESCRIPTION
Specifies the color of the markup text added to a BOM line by a user in Structure
Manager or in a markup space in 4G Designer.
VALID
VALUES
Specifies three color values in order of precedence in the format N1,N2,N3, where
each value is an integer in the range 0 to 255. Enter color values in red, green, blue
(RGB) code, where, for example, 0, 0, 0 represents the color black and 0, 255, 255
represents the color aqua.
DEFAULT
VALUES
0, 255, 0
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-85


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

BOM_MARKUP_STRIKE_FOREGROUND

DESCRIPTION
Specifies the color of the strikethrough marking if a user deletes a BOM line or edits a
property in Structure Manager or removes an object in a markup space in 4G Designer.
VALID
VALUES
Specify three color values in order of precedence in the format N1,N2,N3, where
each value is an integer in the range 0 to 255. Enter color values in red, green, blue
(RGB) code, where, for example, 0, 0, 0 represents the color black and 0, 255, 255
represents the color aqua.
DEFAULT
VALUES
0, 255, 0
DEFAULT
PROTECTION
SCOPE
Site preference.

Displayed_Decimals_for_Qty

DESCRIPTION
Determines how many decimal places are displayed in the Quantity property column.
This setting affects all product structure applications including Structure Manager and
Microsoft Office Excel Live integration.
VALID
VALUES
Any integer value greater than 0.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IC_baseline_carry_forward_active_changes

DESCRIPTION
Determines if active changes are carried forward when the user creates an incremental
change baseline. An active change is one which is currently effective or may be
effective in the future.
VALID
VALUES
True Carry over active changes when creating an incremental change baseline.
False Do not carry over active changes when creating an incremental change
baseline.
DEFAULT
VALUE
False

21-86 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IC_baseline_carry_forward_status

DESCRIPTION
Specifies status names Teamcenter considers if active changes are carried forward
when the user creates an incremental change baseline. An active change is one which
is currently effective or may be effective in the future.
VALID
VALUES
Any valid status name.
DEFAULT
VALUE
Pending
DEFAULT
PROTECTION
SCOPE
Site preference.

ICPanelBomChangeDefs

DESCRIPTION
Determines column order in the tree of the IC Data Panel window for the columns
listing the incremental changes made to the BOM line. Rearranging columns in the IC
Data Panel window automatically sets/resets the values of this preference.
VALID
VALUES
Arrays containing all of the following strings, in any order:
type
icContext
icRelStat
icEffectivity
icIntent
icConfiguredBy
DEFAULT
VALUES
type
icContext
icRelStat
icEffectivity
icIntent
icConfiguredBy
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 21-87


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

ICPanelBomChangeWidths

DESCRIPTION
Determines column width in the tree of the IC Data Panel window for the columns
listing the incremental changes made to the BOM line.
VALID
VALUES
Arrays of integers of length six.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

ICPanelAttachChangeDefs

DESCRIPTION
Determines column order in the tree of the IC Data Panel window for the columns listing
the incremental changes made to attachments to the BOM line. Rearranging columns
in the IC Data Panel window automatically sets/resets the values of this preference.
VALID
VALUES
Arrays containing all of the following strings, in any order:
type
icContext
icRelStat
icEffectivity
icIntent
icConfiguredBy
line
relation
absocc_rootline
DEFAULT
VALUES
type
icContext
icRelStat
icEffectivity
icIntent
icConfiguredBy
line
relation
absocc_rootline
DEFAULT
PROTECTION
SCOPE
All.

21-88 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

ICPanelAttachChangeWidths

DESCRIPTION
Determines column width in the tree of the IC Data Panel window for the columns
listing the incremental changes made to attachments to the BOM line.
VALID
VALUES
Arrays of integers of length nine.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

ICPanelOccAttrChangeDefs

DESCRIPTION
Determines column order in the tree of the IC Data Panel window for the columns
listing the incremental changes made to occurrence attributes. Rearranging columns
in the IC Data Panel window automatically sets/resets the values of this preference.
VALID
VALUES
Arrays containing all of the following strings, in any order:
type
icContext
icRelStat
icEffectivity
icIntent
icConfiguredBy
attribute
attr_value
absocc_rootline
DEFAULT
VALUES
type
icContext
icRelStat
icEffectivity
icIntent
icConfiguredBy
attribute
attr_value
absocc_rootline
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 21-89


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

ICPanelOccAttrChangeWidths

DESCRIPTION
Determines column width in the tree of the IC Data Panel window for the columns
listing the incremental changes made to occurrence attributes.
VALID
VALUES
Arrays of integers of length nine.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

Incremental_Change_Management

DESCRIPTION
Enables incremental change functionality and reveals the relevant menu commands.
By default, this functionality is disabled.
Enabling incremental change using the site preference activates this functionality in all
applications where it is available, including Structure Manager, Manufacturing Process
Planner, Part Planner, and Multi-Structure Manager. Individual users can use the
corresponding user preference to hide the incremental change menu commands.
An incremental change groups multiple structure changes to a given component (such
adding a component, removing a component, modifying attachments, and so on).
You can then apply effectivity to this incremental change to configure the associated
changes. This change control method allows several independent structure changes
to be made concurrently, including the addition or removal of unrelated components.
Those changes can be implemented in any sequence. This method is suitable for
large, flat structures without nested subassemblies or components. Teamcenter's
other change control method (revisioning) is not suitable for this type of structure, as a
separate revision would be required for every permutation of change.
For information about creating incremental changes, see Structure Manager.
VALID
VALUES
true Enables incremental change functionality and reveals the menu
commands.
false Disables incremental change functionality and hides the menu
commands.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site or user preference.

21-90 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Incremental_Change_ReleaseStatus

DESCRIPTION
Specifies the status type that is assigned to a new change object.
This feature is available in Structure Manager, Manufacturing Process Planner, Part
Planner, and Multi-Structure Manager.
For information about creating incremental changes, see Structure Manager or, in the
manufacturing environment, Manufacturing Process Planner.
VALID
VALUES
Accepts any valid Teamcenter status.
DEFAULT
VALUES
Pending
DEFAULT
PROTECTION
SCOPE
Site or user preference.

MoveICCreationToMenu

DESCRIPTION
Determines whether the Create IC Object button is displayed on the incremental
change toolbar or the Tools→Incremental Change→Create command is displayed in
the main toolbar. (This command may be suppressed with Command Suppression if
your site restricts the ability of users to create incremental changes.)
VALID
VALUES
true The Tools→Incremental Change→Create command is
displayed and the Create IC Object button is hidden.
false The Tools→Incremental Change→Create command is hidden
and the Create IC Object button is displayed.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTE
This preference is not applicable to Manufacturing Process Planner, Part Planner,
and Plant Designer.

New_Ic_Dialog_last_ic_type

DESCRIPTION
Ensures the change type last used in the New Incremental Change dialog box is set
by default when the dialog box is next used. The default setting is only for convenience
and can be changed in the dialog box.

PLM00026 11.2 Preferences and Environment Variables Reference 21-91


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES
The system sets this preference automatically the first time a user makes a change
type selection in the New Incremental Change dialog box.
The latest value selected in the dialog box is defined in this preference by the system
as different change types are selected within the dialog box. If the preference is not
set (in other words, the first time the dialog box is used) the dialog box selects the first
change type in the list.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

PSEDisplayTypePref

DESCRIPTION
Specifies the Structure Manager graphical display format.
VALID
VALUES
1 Vertical tree.
2 Horizontal tree.
3 Indented BOM.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
User preference.

PSEOccNotesNoCopy

DESCRIPTION
Determines which occurrence notes are not copied when users copy and paste a
PSOccurrence. You can set this behavior on a run-time basis by specifying it to be a
user preference or retain the value between sessions by making it a site preference.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid occurrence note.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference if you want to retain the value between sessions.

21-92 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

User preference if you want to be able to change the value during a Teamcenter
session.

PSE_icon_placement

DESCRIPTION
Determines the location of icons within Structure Manager.
VALID
VALUES
1 Above.
2 Right.
3 Below.
4 Left.
DEFAULT
VALUES
4
DEFAULT
PROTECTION
SCOPE
User preference.

PSE_show_option_family_prefix

DESCRIPTION
Determines if the Variant Formula BOM line property cell suppresses the variant
option family when the value is unique in the viewed context. If the top level item
revision declares only a single variant option family with a value of (for example)
StereoCD, the Variant Formula property suppresses the family name when displaying
variant condition formulae in this BOM window. Thus, [ItemID]Model = Model_X &
[ItemID]Engine = V6 becomes Model_X & V6. if the PSE_show_option_item_prefix
preference is also set to OFF.
VALID
VALUES
TRUE A unique variant option family is not suppressed in the Variant
Formula BOM line property cell.
FALSE A unique variant option family is suppressed in the Variant
Formula BOM line property cell.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 21-93


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

PSE_show_option_item_prefix

DESCRIPTION
Determines whether the item ID displays as a prefix before the option name.
VALID
VALUES
0 Does not display the item ID before the option name. For
example, if the option color is defined on item 000101, the
option displays as:
color
1 Displays the item ID before the option name. For example, if the
option color is defined on item 000101, the option displays as:
[000101]color
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
All.

PSEPreciseColorPref

DESCRIPTION
Determines the display color for precise BOM view revisions.
VALID
VALUES
Single string as a value; must be a valid color defined by your system at the X-Window
System level.
DEFAULT
VALUES
seagreen
DEFAULT
PROTECTION
SCOPE
User preference.

PSEImpreciseColorPref

DESCRIPTION
Determines the display color for imprecise BOM view revisions.
VALID
VALUES
Single string as a value; must be a valid color defined by your system at the X-Window
System level.
DEFAULT
VALUES
slate gray

21-94 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
User preference.

PSESubstituteColorPref

DESCRIPTION
Determines the display color for substitutes.
VALID
VALUES
Single string as a value; must be a valid color defined by your system at the X-Window
System level.
DEFAULT
VALUES
blue
DEFAULT
PROTECTION
SCOPE
User preference.

PSEAutoPackPref

DESCRIPTION
Determines whether to place all occurrences on a single line.
For more information on packing occurrences, see Structure Manager.
VALID
VALUES
0 Does not pack identical occurrences on a single line.

1 Packs identical occurrences on a single line.


DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
User preference.

PSEShowSubstitutesPref

DESCRIPTION
Determines how Structure Manager displays substitutes.
VALID
VALUES
0 Structure Manager does not display substitutes as separate
BOM lines.

1 Structure Manager displays substitutes as separate BOM lines.

PLM00026 11.2 Preferences and Environment Variables Reference 21-95


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
User preference.
NOTE
Platform Designer does not support substitutes. If you use Platform Designer, you
should leave this preference set to 0.

PSE_enable_related_substitutes

DESCRIPTION
Determines whether the Related Substitutes menu command displays in Structure
Manager. Substitute part relationships are used to manage dependencies between
substitute part selections. When there are dependencies between substitute part
selections, you can relate the substitute part of one occurrence with substitute parts
of the other occurrence. You can define these relationships for any occurrence in
any BOM view revision.
VALID
VALUES
True The Related Substitutes menu command displays in Structure
Manager.
False The Related Substitutes menu command does not display
in Structure Manager.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
All.

PSEAdditionColorPref

DESCRIPTION
Determines the highlight color of an occurrence that has been added when displaying
BOM compare results.
VALID
VALUES
Single string as a value; must be a valid color defined by your system at the X-Window
System level.
DEFAULT
VALUES
red
DEFAULT
PROTECTION
SCOPE
User preference.

21-96 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

PSEChangedColorPref

DESCRIPTION
Determines the highlight color of an occurrence that has been changed when
displaying BOM compare results.
VALID
VALUES
Single string as a value; must be a valid color defined by your system at the X-Window
System level.
DEFAULT
VALUES
orange
DEFAULT
PROTECTION
SCOPE
User preference.

PSEIsNewVILinkedToModule

DESCRIPTION
Determines if variant items are linked to the generic component.
VALID
VALUES
true (variant items are linked to the generic component by default).
false (variant items are not linked to the generic component by default).
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

PSEShowDataPanelDefault

DESCRIPTION
Determines whether the data pane is shown by default when Structure Manager starts.
VALID
VALUES
true The data pane opens automatically when Structure Manager starts. The last
tab selected in the user’s previous session is visible.

false The data pane does not open automatically when Structure Manager starts.
The user may manually open the data pane.

DEFAULT
VALUES
false

PLM00026 11.2 Preferences and Environment Variables Reference 21-97


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

PSEVariantRuleDialogTableSort

DESCRIPTION
Determines the order in which specified columns in the Variant Rule dialog window
are sorted.
VALID
VALUES
The preference must contain two entries:
• The name of one or more columns, for example:
Item
Option
Desc
Value
State

• The sort order of the specified columns, either 1 for an ascending sort and -1
for a descending sort.

DEFAULT
VALUES
All five columns are sorted in descending order.
DEFAULT
PROTECTION
SCOPE
User preference.

TC_ExportConfigUGNXAssembly

DESCRIPTION
Determines whether the Tools→Export NX Configured Assembly command
displays in Structure Manager.
VALID
VALUES
TRUE The Tools→Export NX Configured Assembly command
displays in Structure Manager. Use this setting only if NX is
installed on the client machine.
FALSE The Tools→Export NX Configured Assembly command does
not display in Structure Manager.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

21-98 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Assembly and Product Configurator preferences

AbsOccGrmCopyRules

DESCRIPTION
Determines system behavior when revising a BOM view revision that is copying
forward absolute GRM overrides. Use this preference to specify the class of the GRM,
the class of the secondary object, the relation, and the action taken during the revision.

If you are using the Wiring Harness Design Tools Integration and have installed KBL
functionality, see Wiring Harness Design Tools Integration for additional required
values.

Tip

When adding new values (copy rules) to this preference, verify the rule by
revising it at least once, and then check the system log to confirm no errors
were recorded while reading the preference. Testing this preference requires an
assembly containing absolute occurrence override attachments.

VALID
VALUES
Accepts multiple strings as values. Strings are case sensitive and trailing blanks
are not allowed. Each string is a concatenation of class, relation, and action values
which must be in the following format:

class.AbsOccData:Class-Name-2:Relation:Relation-Type:Action
class.AbsOccData: Specifies the class of the primary object. This class name must
always be class.AbsOccData:.

Class-Name-2 Specifies the class of the secondary object. This value must be
either class.Form or class.Dataset, or * to indicate either the
form or dataset class.

Note

This functionality accepts only forms and datasets as


secondary objects. If any other objects are defined, the
system will apply the Ignore action.
This preference does not control the default copy
behavior. If Teamcenter encounters a relationship
between two objects that is not defined in this preference,
it performs an Ignore action. This response changed
with effect from Teamcenter 9.

Relation The relation must always be Relation. All other types are
ignored.

Relation-Type Specifies the relation type used when applying the action. Must
be a valid relation type.

PLM00026 11.2 Preferences and Environment Variables Reference 21-99


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

Action Specifies the action is performed on the secondary object. Must


be one of the following values:
Clone Creates a new GRM that points to the
copied form or dataset.
Ignore The GRM is not copied to the new BOM
view revision.
Reference Creates a new GRM that points to the old
form or dataset.
The following example specifies that a new GRM points to a form copied using the
TC_Feature_Form_Relation:
class.AbsOccData:class.Form:Relation.TC_Feature_Form_Relation:Clone

The following example specifies that a new GRM points to a form copied using the
IMAN_master_form relation:
class.AbsOccData:class.Form:Relation.IMAN_master_form:Clone

The following example specifies that the IMAN_Rendering relation is ignored and
such datasets are not copied to the new BOM view revision:
class.AbsOccData:*:Relation.IMAN_Rendering:Ignore

The following example specifies that new GRMs are created that point to all of the old
forms or datasets. This example also revert the behavior of this preference to the
pre-Teamcenter 9.0 default behavior, as described in the Notes.
class.AbsOccData:*:*:Reference

Caution

Use entries such as the previous example with care and test them before
deploying in a production environment. They may cause other rules in the
AbsOccGrmCopyRules preference to be ignored and not enforced.

DEFAULT
VALUES
class.AbsOccData:class.Form:Relation.TC_Feature_Form_Relation:Clone
class.AbsOccData:class.Form:Relation.IMAN_master_form:Clone
class.AbsOccData:*:Relation.IMAN_Rendering:Ignore
class.AbsOccData:class.Form:Relation.Mfg0TCContextFeatureFormRel:Clone
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
Before Teamcenter 9.0, the default behavior was to copy the secondary object for
the Generic Relationship Management (GRM) absolute occurrence override as a
reference. Any GRM absolute occurrence override is copied but its secondary data
(such as a form or dataset) is referenced when performing a Revise or Save-As
operation on an Item Revision object that is the context for the GRM absolute
occurrence override.
In Teamcenter 9.0 and subsequent versions, the default behavior is to ignore when
copying GRM absolute occurrence overrides. Any GRM absolute occurrence override

21-100 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

is not copied when performing a Revise or Save-As operation on an Item Revision


object that is the context for the GRM absolute occurrence override.
To revert to the pre-Teamcenter 9.0 default behavior, add the following value as the
last value in the AbsOccGrmCopyRules preference:
"class.AbsOccData:*:*:Reference"

Note

Values in the AbsOccGrmCopyRules preference are read first to last. The


system scans the values, beginning with the first value, until it finds a rule
that matches the object and GRM that is being processed during a Revise or
Save-As operation. This means the new preference value (to restore the old
reference default behavior) takes precedence over any additional rules (after
the new value) from being read and used. Use caution when adding and placing
values in the AbsOccGrmCopyRules preference.

AbsOccGrmSecondaryCopyRules

DESCRIPTION
Determines system behavior when revising a context BOM view revision (BVR) that
is copying absolute occurrence General Relationship Management (GRM) relation
overrides forward to the new item revision. Use this preference to specify a reverse
lookup for absolute occurrence GRM relation overrides by identifying the class of the
GRM relation, the class of the primary object, the relation type, and the action taken
during the revision.
Caution

An assembly with trace links to absolute occurrence objects is required to test


this preference. When adding new values (copy rules) to this preference, verify
the rule by revising an item revision object related to the trace link at least
once. Then, check the syslog file to verify no errors are thrown while reading
the preference.

VALID
VALUES
Accepts multiple strings as values. Strings are case sensitive and trailing blanks are
not allowed. Each string is a concatenation of class, relation, and action values that
must be in the following format:
class-name-1:class.AbsOccData:Relation:relation-type:action
class-name-1 Specifies the class of the primary object, for example,
class.ItemRevision.
class.AbsOccData Specifies the class of the secondary object. This class name
must always be class.AbsOccData.
Relation The relation must always be Relation. All other types are
ignored.
relation-type Specifies the relation type used when applying the action. It
must be a valid relation type.

PLM00026 11.2 Preferences and Environment Variables Reference 21-101


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

action Specifies the action that is performed on the primary object. It


must be one of the following values:
Ignore The GRM relation is not copied to the
new BOM view revision.

Reference Creates a new GRM relation that points to


the same primary object that was defined
on the original absolute occurrence GRM
relation object.
The following rule example specifies that a new trace link points to a copied
AbsOccData object using FND_Tracelink where the item revision is a reference:
class.ItemRevision:class.AbsOccData:Relation.FND_Tracelink:Reference

Note

The following rule example reflects the default COTS behavior for the carry
forward of trace links on item revision objects to the latest revision.
*:class.AbsOccData:Relation.FND_Tracelink:Reference

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
If you want to conduct a reverse lookup for GRM relation overrides, values must be
defined for this preference.
Caution

This preference supplies instructions for a reverse lookup during a revise


operation, which can impact performance. If no rules are defined for this
preference, this secondary search is not performed, and there is no associated
performance impact.

BOM_Additional_Packing_Criteria

DESCRIPTION
Determines which properties users can add to the pack criteria. Users can add any
properties defined by this preference to the pack criteria.
For more information about packing or unpacking lines with reference designators,
see Structure Manager.
VALID
VALUES
Accepts one or more strings as values. Strings must be entered in one of the following
three formats:

21-102 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Property-name-only Lines with the same value of the property are packed. For
example, use the following value to pack all lines containing the
same value for the bl_ref_designator property:
bl_ref_designator

Property-name: When the specified property has the specified value, the line is
property-value not packed. For example, use the following value to ensure that
lines containing the NoLoad property with the value of True
are not packed:
NoLoad:True

Property-name: When the specified property is empty, the line is not packed. For
<blank-value> example, use the following value to ensure that lines containing
the bl_ref_designator property with an empty value are not
packed:
bl_ref_designator:
DEFAULT
VALUES
empty
DEFAULT
PROTECTION
SCOPE
Site preference.

BOM_Additional_Ref_Designator_Search_Criteria

DESCRIPTION
Determines which properties users can add to the search criteria for the reference
designator, within the same parent. Users can add any properties defined by this
preference to search criteria within the same parent.
For more information about packing or unpacking lines with reference designators,
see Structure Manager.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid BOM line property
name.
DEFAULT
VALUES
empty
DEFAULT
PROTECTION
SCOPE
Site preference.

BOM_Enable_Quantity_Validation_Against_Ref_Designator

DESCRIPTION
Verifies whether the quantity is blank or 1 when the reference designator is assigned.
For more information about packing or unpacking lines with reference designators,
see Structure Manager.

PLM00026 11.2 Preferences and Environment Variables Reference 21-103


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES
true Verifies that when a reference designator value is assigned,
the quantity is either blank or 1. Verifies that when a quantity
that is neither blank nor 1 is to be set, the reference designator
value of the line is not assigned. An error appears when the
values do not comply.

For example, when the reference designator is C1 and a user


changes the quantity to 3, an error appears. Or, if the quantity
is 3 and a user sets the reference designator to C1, an error
appears.

false The system does not validate reference designator values.


DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

BOM_Enable_Ref_Designator_Value_Packing

DESCRIPTION
Determine whether the system packs reference designator values when packing lines.

Setting this preference to true allows you to pack or unpack product structure lines that
include reference designators. For example, if you pack six occurrences of the same
part with different reference designators, the Ref Designator property column shows a
concatenated set of reference designators. Thus, if reference designator values are
C1, C2, C3, C6, C12, C13, they will be packed to C1-C3,C6,C12-C13.

For more information about packing or unpacking lines with reference designators,
see Structure Manager.

Note

• You cannot edit the reference designators of packed lines.

• After modifying this preference, you must restart both the rich client and
Structure Manager.

VALID
VALUES
true The system packs reference designator values.

false The system does not pack reference designator values.


DEFAULT
VALUES
true

21-104 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

BOMExcludeFromPackCheck

DESCRIPTION
Defines which attributes are ignored during the default pack check. For example, set
this preference to seqno to allow the exclusion of find numbers from the BOM line
pack check.
For more information about packing or unpacking lines with reference designators,
see Structure Manager.
VALID
VALUES
seqno Excludes find numbers from the BOM line pack check. Allows
BOM lines with distinct find numbers to be packed.
none No attributes are ignored during the default pack check. BOM
lines must have the same part number and the find number
to be packed.
DEFAULT
VALUES
none
DEFAULT
PROTECTION
SCOPE
Site preference.

Cfg0CompoundOptionValueMemberTypes

DESCRIPTION
Defines the type of member option values that a Compound Option Value can hold.
VALID
VALUES
Accepts values in the format CompoundOptionValue::OptionValue.
DEFAULT
VALUES
Cfg0SummaryOptionValue::Cfg0LiteralOptionValue
Cfg0PackageOptionValue::Cfg0LiteralOptionValue
DEFAULT
PROTECTION
SCOPE
Site preference.

Cfg0DefaultOptionFamilyNamespace

DESCRIPTION
Specifies the default option family namespace property value for new option families
created in the Variant Options view in the Product Configurator.

PLM00026 11.2 Preferences and Environment Variables Reference 21-105


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES
Any valid property value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

Cfg0EvaluateAvailability

DESCRIPTION
Enables the evaluation of availability rules defined in the product context during
configuration validation using the Variant Configuration view in the Product
Configurator application and in consuming applications such as 4GD.
VALID
VALUES
true Enables availability rules when validating a configuration.
false Disables availability rules when validating a configuration.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

Cfg0ExpressionGridColumnProperties

DESCRIPTION
Specifies a list of option properties that are displayed in the Variant Expression
Editor of the Product Configurator. The object ID of the option is always displayed and
should not be specified in this preference.
VALID
VALUES
Any valid property value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

21-106 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Cfg0ExpressionGridSelectionCharacters

DESCRIPTION
Specifies a list of characters that are displayed in the Variant Expression Editor of
the Product Configurator to represent variant expression selections. You must specify
two character values, the first value representing a positive selection and the second
value representing a negative selection.
VALID
VALUES
Any character.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Cfg0OptionsViewColumnsWidths

DESCRIPTION
Specifies the column widths for the columns in the tree table of the Variant
Options view of the Product Configurator. The columns are specified in the
Cfg0OptionsViewPropertyColumns preference, and their widths are listed in the
same order in this preference.
VALID
VALUES
A list of integer values, each of which specifies a column width in pixels.
DEFAULT
VALUES
150
100
100
80
60
60
60
60
60
80
80
60
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-107


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

Cfg0OptionsViewHistoryUIDs

DESCRIPTION
Contains the history of the last 20 objects opened in the Variant Options view of
the Product Configurator.
Caution

Teamcenter populates this preference dynamically; you should not modify it


manually.

VALID
VALUES
The UIDs of variant options.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

Cfg0OptionsViewPropertyColumns

DESCRIPTION
Specifies a list of properties that are displayed as columns in the tree table of the
Variant Options view of the Product Configurator.
VALID
VALUES
Any option property.
DEFAULT
VALUES
Cfg0AbsConfiguratorWSO.cfg0ObjectId
Cfg0OptionFamily.cfg0FamilyNamespace
Cfg0OptionFamily.object_type
Cfg0OptionFamily.object_desc
Cfg0OptionFamily.cfg0ValueDataType
Cfg0OptionFamily.cfg0UOM
Cfg0OptionFamily.cfg0IsDiscretionary
Cfg0OptionFamily.cfg0HasFreeFormValues
Cfg0OptionFamily.cfg0IsMultiselect
Cfg0OptionFamily.cfg0MinimumValue
Cfg0OptionFamily.cfg0MaximumValue
Cfg0OptionFamily.cfg0Sequence
DEFAULT
PROTECTION
SCOPE
User preference.

21-108 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Cfg0OptionsViewSortProperty

DESCRIPTION
Specifies the default property column by which the data in the tree table of the Variant
Options view of the Product Configurator is sorted.
VALID
VALUES
Any property specified in the Cfg0OptionsViewPropertyColumns preference.
DEFAULT
VALUES
Cfg0OptionFamily.cfg0Sequence
DEFAULT
PROTECTION
SCOPE
User preference.

CFMOccEffMode

DESCRIPTION
Determines which occurrence effectivity mode is used.
VALID
VALUES
legacy Enables the legacy (date-based) mode for all occurrence
effectivity data.
maintenance Newly created occurrence effectivities use the current (date
or unit) mode, existing occurrence effectivities use the legacy
(date-based) mode.
upgrade Existing occurrence effectivities are upgraded to the current
(date or unit) mode when they are modified.
DEFAULT
VALUES
legacy
DEFAULT
PROTECTION
SCOPE
Site preference.

ConfigureToLoadEnableDefaultVariantConfig

DESCRIPTION
Enables or disables the Do not show this dialog automatically when opening BOM
check box in the Variant Rule or Configure dialog box in Structure Manager. The
selected BOM line must also have at least one child line and classic variants defined
to enable the check box. This check box is displayed only if you have enabled the
configure to load feature.
VALID
VALUES
True Hides the Do not show this dialog automatically when
opening BOM check box in Structure Manager.

PLM00026 11.2 Preferences and Environment Variables Reference 21-109


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

False Shows the Do not show this dialog automatically when


opening BOM check box in Structure Manager.
INITIAL
VALUE
False
DEFAULT
PROTECTION
SCOPE
All.
NOTES
This preference is not included in the default tc_preferences.xml file, but is created
when you first run the system.
You can set this preference to true by selecting the Do not show this dialog
automatically when opening BOM check box or from the Options dialog box in the
rich client. You can only set it to false from the Options dialog box in the rich client.

DisableSaveSos

DESCRIPTION
Controls the saving of saved option sets (SOSs). Use this preference to manage the
transition of variant data from SOSs to variant rules. If you set this preference to true,
you should update all external references (for example, briefcases and Multi-Site
replications) to the corresponding variant rules.
VALID
VALUES
true Users may create new SOSs or modify existing SOSs.

false Users cannot create new SOSs or modify existing SOSs.


DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

Fnd0Branch_DefaultChildProperties

DESCRIPTION
Specifies a list of properties that can be used as children of a branch.
VALID
VALUES
Fnd0BranchContent
Fnd0BranchToBranchRelation
DEFAULT
VALUES
Fnd0BranchContent
Fnd0BranchToBranchRelation

21-110 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

Fnd0Branch_Fnd0Branch_default_relation

DESCRIPTION
Specifies the default relation Teamcenter creates between the two objects, when you
paste a branch object under another branch object.
VALID
VALUES
Fnd0BranchToBranchRelation
DEFAULT
VALUES
Fnd0BranchToBranchRelation
DEFAULT
PROTECTION
SCOPE
Site preference.

Fnd0Branch_ItemRevision_default_relation

DESCRIPTION
Specifies the default relation Teamcenter creates between the two objects, when you
paste an item revision object under a branch object.
VALID
VALUES
Fnd0BranchContent
DEFAULT
VALUES
Fnd0BranchContent
DEFAULT
PROTECTION
SCOPE
Site preference.

Fnd0Branch_PseudoFolder

DESCRIPTION
Specifies a list of properties that can be displayed as a pseudo-folder under a branch
object
VALID
VALUES
Fnd0BranchContent
DEFAULT
VALUES
Fnd0BranchContent

PLM00026 11.2 Preferences and Environment Variables Reference 21-111


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference. (Preferences of user scope may be created.)

JTContentBomLineProperties

DESCRIPTION
Specifies which attributes from JT content hint forms are included as BOM line
properties when a structure is expanded.
Note

JT content hint information is returned for all BOM lines when the object
property policy for BOM lines is set to return the bl_JTHint_Contents property.

Setting this preference allows the client to recognize specified types of content in
the corresponding JT files without having to download and examine the files. The
client uses this information to optimize performance when downloading JT files. By
determining which JT files contain content of interest, a smaller number of JT files are
retrieved from the server when expanding a structure.
When this preference is not set, JT content information is not added to BOM line
properties and JT files must be downloaded, opened, and read to determine if they
contain data of interest.
VALID
VALUES
Accepts one or more strings as values. Each string must be attribute names on JT
content hint forms. Any strings that are not valid attributes of JT content hint forms are
ignored.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

JTContentHintPropertyPolicy

DESCRIPTION
Lists those attributes that may be in JT Content Hint forms that are to be included in
the JTContentHint BOM line property. Values are not case sensitive. Any invalid
values are ignored.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
None.

21-112 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
All.

JT_File_Excluded_Refsets

DESCRIPTION
Specifies JT files you do not want Lifecycle Visualization to load, for example, empty.
VALID
VALUES
Valid NX reference set names.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

JT_File_OverrideChildren_Refsets

DESCRIPTION
Specify strings used to name monolithic DirectModel datasets attached to assembly
nodes representing end items like supplier built assemblies that you do not want
to expand. As you expand the levels of the structure, nodes containing datasets
conforming to this naming convention do not expand. Instead, the viewer uses the
monolithic JT files to display the subassemblies.
Note

The strings should not include .jt file extension.

VALID
VALUES
Strings used for reference set names such as monolithic or $monolithic. To match
the ends of names, start the string with an *. For example, *-mono matches all file
names that end with -mono.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
This preference can have a major impact on visualization performance. It should
be leveraged when monolithic DirectModel datasets are available to represent
subassemblies.
If you have:

PLM00026 11.2 Preferences and Environment Variables Reference 21-113


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

• Monolithic DirectModel datasets attached to subassemblies that are end items


(like a supplier built assembly) or perhaps consumed as assemblies in the BOP.

• Named the DirectModel datasets with a name like monolithic.jt.

• Set the preference JT_File_OverrideChildren_Refsets to be equal to monolithic


or $monolithic.

Then:
• As you expand the structure in the viewer, the subassemblies with monolithic
JTs do not expand.

• The viewer uses the monolithic JT files to display the assemblies.

• This symbol indicates a node has a monolithic JT file.

• You can use Show SubComponents to show the structure within in the monolithic
JT and use the check boxes to show and hide individual subcomponents.

JT_File_Priority_Refsets

DESCRIPTION
Determines the load order of NX reference sets contained within DirectModel files.
NX reference sets enable you to display different geometry configurations within the
context of a single assembly.
DirectModel support of NX reference sets can take two forms:
• DirectModel datasets created prior to Teamcenter 8, which consist of multiple JT
files named according to the available reference sets

• DirectModel datasets created using Teamcenter 8 or later, which may consist of a


single JT file that contains all of the information necessary to define the geometry
configurations for each reference set

Note

• Values specified for the JT_File_Priority_Refsets preference are case


sensitive.

• By default, the JT_File_Priority_Refsets preference is applicable only for


the viewers embedded within Teamcenter applications such as Structure
Manager and My Teamcenter. For the Lifecycle Viewer to use the reference
set loading order specified with this preference, select the Teamcenter
Reference Set settings take precedence check box in the Lifecycle
Viewer 3D Loader Preferences.

21-114 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES

For a mixture of
For DirectModel For DirectModel DirectModel datasets
datasets created using datasets created prior to created using different
Teamcenter 8 or later Teamcenter 8 releases
$EMPTY EMPTY $EMPTY
$ENTIREPART ENTIREPART EMPTY
$LASTSAVED LASTSAVED $ENTIREPART
$MODEL MODEL ENTIREPART
[user-defined] [user-defined] $LASTSAVED
LASTSAVED
$MODEL
MODEL
[user-defined]

DEFAULT
VALUES
$LASTSAVED
$ENTIREPART
$MODEL
$EMPTY
DEFAULT
PROTECTION
SCOPE
User preference.

PCA_enable_authoring

DESCRIPTION
Determines whether users can create or edit variant option data in the Product
Configurator application.
VALID
VALUES
TRUE Users can create or edit variant option data in the Product
Configurator application.
FALSE Users cannot create or edit variant option data in the Product
Configurator application. All data in the application is view-only.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-115


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

PS_Duplicate_FindNo_Update

DESCRIPTION
Determines whether duplicate find numbers of the same item are updated.
For more information about packing or unpacking lines with reference designators,
see Structure Manager.
VALID
VALUES
true Duplicate find numbers of the same item are updated.
false Duplicate find numbers of the same item are not updated.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

PSEAllowLegacyVICreation

DESCRIPTION
Determines whether variant items can be created using legacy variant options, and
whether variant items can be created for non-modules. Additionally, if this preference
is set to true and the PSEVariantsMode preference is set to legacy, the Create VI
button displays in the rich client toolbar.
VALID
VALUES
true Allows variant items to be created with legacy variant options.
Allows variant items creation for non-modules.
false Does not allow variant items to be created with legacy variant
options. Does not allow variant items creation for non-modules.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PSEAutoViCreateEmptyVI

DESCRIPTION
Determines whether a variant item is created when a non-module is encountered
during automatic variant item creation.

21-116 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
true A variant item is created for a given BOM line when a
non-module is encountered. The system continues to the
bottom of the generic structure, assigning empty variant items
(variant items with no variant configuration) for each item that is
not a module.
false A variant item is not created for a given BOM line when a
non-module is encountered.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

PSEAutoViNamePrefix

DESCRIPTION
If the PSEAutoViNewItemPopup preference is set to false, this preference defines
the naming prefix scheme used for automatic variant item creation.
VALID
VALUES
Accepts a single string as a value. The value is used as the prefix of the automatically
created variant item. For example, if you set this preference to VI_, when users create
a generic item called Wheel, the name of the variant item is VI_Wheel.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

PSEAutoViNewItemPopup

DESCRIPTION
Determines whether users are prompted for an item identifier, item revision identifier
and item name each time the automatic creation process creates a variant item.
VALID
VALUES
true Users are prompted for this information each time a variant item
is created via the Item Creation dialog box.
false The system automatically assigns values according to
predefined numbering and naming schemes. For example,
if you have a generic item called 00100/A Generic Wheel,
Teamcenter creates a generic item called 00200/A VI_Generic
Wheel.

PLM00026 11.2 Preferences and Environment Variables Reference 21-117


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

PSEAutoViStopVICreationForUnconfiguredModule

DESCRIPTION
Determines whether automatic variant item creation stops when the system encounters
an unconfigured module.
VALID
VALUES
true The system stops when it encounters an unconfigured module.
However, it does continue to check the other sibling branches.

false The system continues to the bottom of the generic structure,


displaying warning messages for each unconfigured module
encountered.

Note

This is the best practice for most business environments.

DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

PSEBypassVISearch

DESCRIPTION
Determines whether the Create VI button appears in the Configure dialog box in the
rich client. If this preference is set to true, the button displays as soon as a value is set
for each option, allowing users to bypass the manual search for similarly configured
variant items before creating a new variant item.
Triggers an alternative variant item creation process, useful if Business Modeler IDE
rules prevent normal variant item creation.
VALID
VALUES
true Bypasses the manual search for similarly configured variant
items before creating a new variant item.

false Requires the manual search for similarly configured variant


items before creating a new variant item.

21-118 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PSECopyAbsOccDuringVICreation preference

DESCRIPTION
When you copy variant items, absolute occurrence data and appearance path nodes
(APNs) are copied by default. This may cause performance issues if you copy a
large number of variant items. This preference allows you to select whether absolute
occurrence data and APNs are copied.
VALID
VALUES
true Absolute occurrence data and APNs are copied.

false Absolute occurrence data and APNs are not copied.


DEFAULT
VALUE
None. (By default, this preference does not exist in the system.)
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
Use this preference with the PSECopyArrangementsDuringVICreation preference
to determine whether arrangements are copied.

PSECopyArrangementsDuringVICreation preference

DESCRIPTION
When you copy variant items, arrangements are copied by default. This may cause
performance issues if you copy a large number of variant items. This preference
allows you to select whether arrangements are copied.
VALID
VALUES
true Arrangements are copied.

false Arrangements are not copied.


DEFAULT
VALUE
None. (By default, this preference does not exist in the system.)
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-119


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

NOTES
Set both this preference and the PSECopyAbsOccDuringVICreation preference
to true to copy arrangements.

PSECreateVISameType

DESCRIPTION
Determines whether variant items are always created as the same type as the parent,
using the SaveAs creation method.
Triggers an alternative variant item creation process, useful if Business Modeler IDE
rules prevent normal variant item creation.
VALID
VALUES
true Automatically creates variant items as the same type as the
parent, using the SaveAs creation method.
false Does not provide an alternative item creation process. Does
not automatically create variant items as the same type as the
parent, using the SaveAs creation method.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PSEEnableBranchConfiguration

DESCRIPTION
Enables or disables the availability of branches to configure revisions in the structure.
VALID
VALUES
True Enables branch-based configurations. By default, no branches
are provided and you must create the necessary branches after
enabling this capability
False Disables branch-based configurations.
INITIAL
VALUE
False
DEFAULT
PROTECTION
SCOPE
Site preference.

PSEEnableFilteringUnconfigdDueToClassicVariantsPref

DESCRIPTION
Enables or disables the configure to load feature in Structure Manager. The user can
change the value set in this preference using the View→Enable Classic Variant

21-120 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Configure to Load menu command in Structure Manager or from the Options dialog
box in the rich client. When this feature is enabled, the Filter unconfigured BOM
lines due to Classic Variants check box in the Variant Rule or Configure dialog
box is enabled.
VALID
VALUES
True Enables the configure to load feature in Structure Manager. The
Tools→Show Unconfigured Variants command is disabled.
False Disables the configure to load feature in Structure Manager. The
Tools→Show Unconfigured Variants command is enabled.
INITIAL
VALUE
False
DEFAULT
PROTECTION
SCOPE
User preference.
NOTE
This preference is not included in the default tc_preferences.xml file, but is created
when you first run the system.

PSEIsNewVIisLinkedToModule

DESCRIPTION
Determines whether a component reuse is automatically linked to its module during
creation. By default, the system does not link a component reuse (also known as a
variant item, or VI) to the module from which it was instantiated upon creation. Set this
preference to false if users at your site frequently want to create VIs as a starting point,
and thus do not need them linked to the module from which they were instantiated.
If this preference is removed from the database, the system behaves as if it were
set to true.
VALID
VALUES
true Allows users to link VIs to its module.
false VIs are not linked to its module.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PSE_prompt_for_remote_import

DESCRIPTION
When users select a BOM line for import containing a child line which is a stub
reference to an item in another database, this preference determines whether the
system automatically asks if users want to import the referenced item.

PLM00026 11.2 Preferences and Environment Variables Reference 21-121


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES
true The system automatically asks if users want to import the
referenced item.
false The system does not prompt users to import the referenced
item.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
All.

PSESavedConfigRelationTypes

DESCRIPTION
Determines the relation type available when saving an option set or variant
configuration to the module being configured. (Users can choose to save option
sets/variant configurations to the Home folder, the Newstuff folder, or to the module
being configured. This preference affects the final method.)
VALID
VALUES
Valid Teamcenter reference type.
DEFAULT
VALUES
IMAN_specification
IMAN_manifestation
ImanRelation
DEFAULT
PROTECTION
SCOPE
All.

PSEShowUnconfigdEffPref

DESCRIPTION
Determines whether to display BOM lines containing effectivity data that do not match
the current revision rule, by default, when a structure is opened in Structure Manager.
This site preference has a corresponding user preference of the same name.
Users can set this user preference through the View→Show Unconfigured By
Occurrence Effectivity menu command. The first time a user selects this option, a
PSEShowUnconfigdEffPref user preference instance is created and stored in the
user's BLOB file. User preferences take precedence over site preferences.
There are some cases where you may want BOM lines to display at your site regardless
of whether their variant conditions match the current variant rule, and yet you want
to determine whether a given BOM line is configured. To do so, set the following
properties in the Properties table as indicated to display an unconfigured BOM line:

21-122 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

bl_is_variant is set to Y
bl_variant_state is blank
VALID
VALUES
true BOM lines are displayed regardless of whether their occurrence
date effectivity data matches the current revision rule.
false BOM lines are hidden if their occurrence date effectivity data
does not match the current revision rule.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

PSEShowUnconfigdVarPref

DESCRIPTION
Determines whether to display BOM lines containing variant conditions that are not
configured for the current variant rule, by default, when a structure is opened in
Structure Manager. This preference is relevant for both modular and legacy variant
functionality.
This site preference has a corresponding user preference of the same name. Users
can set the user preference through the View→Show Unconfigured Variants menu
command. The first time a user selects this option, a PSEShowUnconfigdVarPref
user preference instance is created and stored in the user's BLOB file. User
preferences take precedence over site preferences.
There are some cases where you may want BOM lines to display at your site
regardless of whether their variant conditions are configured for the current variant
rule, and yet you want to determine whether a given BOM line is configured. To do
so, set the following properties in the Properties table as indicated to display an
unconfigured BOM line:
bl_is_variant is set to Y
bl_variant_state is blank
VALID
VALUES
true BOM lines are displayed regardless of whether their variant
conditions are configured for the current variant rule. For
example, use this setting when you want to write the entire
Structure Manager window to a tab-delimited file in order to
import the BOM into an Excel spreadsheet.
false BOM lines are hidden if their variant conditions are not configure
for the current variant rule.
DEFAULT
VALUES
true

PLM00026 11.2 Preferences and Environment Variables Reference 21-123


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

PSEVariantsMode

DESCRIPTION
Determines which mode of variants functionality is used: modular, legacy, or a hybrid
of both modes.
The legacy variants functionality does not provide all the encapsulation advantages
that the modular variants functionality enforces, nor is it possible to create variant
items within a structure containing legacy variants.
The hybrid mode allows legacy variants to be displayed, edited and configured using
the modular variants dialog boxes. This is the recommended mode during migration
from legacy to modular variants functionality. Once the migration is complete, this
preference setting should be changed to modular.
VALID
VALUES
modular Modular variant functionality is used. Legacy variant data
cannot be viewed, edited, or configured.
hybrid A hybrid of modular and legacy variant functionality is used,
allowing variant modules to be defined in structures containing
legacy variant data.
legacy Legacy variant functionality is used.
DEFAULT
VALUES
hybrid
DEFAULT
PROTECTION
SCOPE
All.

PSM_classic_variants_logical_families

DESCRIPTION
Configures logical variant option family mode detection. Use this preference to allow
classic variant options that have been created in earlier Teamcenter versions to follow
the logical variant family behavior provided in this version.
VALID
VALUES
Accepts multiple values in the format:
[owning-option-item-id]option-family-name

For example:
[002091]IncludeEnvelopeGeometry
.

21-124 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

If the preference ends with a single period ., the list is considered to be exhaustive, that
is, the list contains all numeric values. Any other value is then forced to be nonnumeric.
DEFAULT
VALUES
None (empty list)
DEFAULT
PROTECTION
SCOPE
Site.

PSM_classic_variants_numeric_families

DESCRIPTION
Manually controls variant option value mode detection for specific variant option
families when you use classic variant configuration. By default, a classic variant option
family is considered a numeric family if all values are numeric. A value is considered
numeric if it begins with the following pattern:
[{+|-}] digits [.digits] [{e|E} [{+|-}] digits]

You can use the ISO C standard function strtod() to convert the value to a number,
so that the unit of measure trailer does not conflict for any value in this family. For
example:

Family Values Value Mode Notes


Engine 110 H.P. Numeric Matching unit of
measure trailer H.P.
95 H.P.
Engine 110 Numeric Unit of measure
trailers are not in
95 H.P. conflict.
Engine 110 Numeric Unit of measure
trailers are not in
95 conflict.
Engine 80.9 kW Lexicographic Unit of measure
trailer H.P. conflicts
95 H.P. with kW.

In some circumstances, the system may detect the wrong mode. For example:

Unit of
Numeric value measure
Family Values trailer Conflict
FAM1 1D0 1.0 ““ No
1D2 100.0 ““ No
1D4 10000.0 ““ No
1M6 1.0 M6 No
1E2 100.0 ““ No

PLM00026 11.2 Preferences and Environment Variables Reference 21-125


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

In this example, the following expressions evaluate to TRUE because all elemental
expressions are identical.
[SCOPE]FAM1 = 1D0 & [SCOPE]FAM1 = 1.0 & [SCOPE]FAM1 = 1 & [SCOPE]FAM1 = 1M6
[SCOPE]FAM1 = 1D2 & [SCOPE]FAM1 = 100.0 & [SCOPE]FAM1 = 100 & [SCOPE]FAM1 = 1E2

Use the PSM_classic_variants_numeric_families preference to avoid incorrect


value mode by listing variant families that should be forced to numeric value mode.
If the preference ends with a single period (.), the list is considered to be exhaustive,
that is, the list contains all numeric values. For example, if you set this preference to
[SCOPE]FAM3 and [SCOPE]FAM3, any other value such as [SCOPE]FAM3 is then
forced to be nonnumeric.
If you attempt to use a nonnumeric value in a family that is forced to be numeric
causes an error.
See also the PSM_classic_variants_text_families preference.
VALID
VALUES
Accepts multiple values in the format:
[owning option item id]option family name

For example:
[10001C2C61]AHV
.

If the preference ends with a single period ., the list is considered to be exhaustive, that
is, the list contains all numeric values. Any other value is then forced to be nonnumeric.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

PSM_classic_variants_text_families

DESCRIPTION
Manually controls variant option value mode detection for specific variant option
families when you use classic variant configuration. By default, a classic variant option
family is considered a text family if at least one value is nonnumeric. A value is
considered numeric if it begins with the following pattern:
[{+|-}] digits [.digits] [{e|E} [{+|-}] digits]

You can use the ISO C standard function strtod() to convert the value to a number,
so that the unit of measure trailer does not conflict for any value in this family. For
example:

Family Values Value mode Notes


Engine 110 H.P. Numeric Matching unit of
measure trailer H.P.
95 H.P.

21-126 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Family Values Value mode Notes


Engine 110 Numeric Unit of measure
trailers are not in
95 H.P. conflict.
Engine 110 Numeric Unit of measure
trailers are not in
95 conflict.
Engine 80.9 kW Lexicographic Unit of measure
trailer H.P. conflicts
95 H.P. with kW.

In some circumstances, the system may detect the wrong mode. For example:

Unit of
Numeric value measure
Family Values trailer Conflict
FAM1 1D0 1.0 ““ No
1D2 100.0 ““ No
1D4 10000.0 ““ No
1M6 1.0 M6 No
1E2 100.0 ““ No

In this example, the following expressions evaluate to TRUE because all elemental
expressions are identical.
[SCOPE]FAM1 = 1D0 & [SCOPE]FAM1 = 1.0 & [SCOPE]FAM1 = 1 & [SCOPE]FAM1 = 1M6
[SCOPE]FAM1 = 1D2 & [SCOPE]FAM1 = 100.0 & [SCOPE]FAM1 = 100 & [SCOPE]FAM1 = 1E2

Use the PSM_classic_variants_text_families preference to avoid incorrect value


mode by listing variant families that should be forced to text value mode. In this
example, you should set this preference to [SCOPE]FAM1 and [SCOPE]FAM2.
If the preference ends with a single period (.), the list is considered to be exhaustive,
that is, the list contains all nonnumeric values. Any other value is then forced to be
numeric.
If you attempt to use a nonnumeric value in a family that is forced to be numeric
causes an error.
See also the PSM_classic_variants_numeric_families preference.
VALID
VALUES
Accepts multiple values in the format:
[owning option item id]option family name

For example:
[10001C2C61]AHV
.

PLM00026 11.2 Preferences and Environment Variables Reference 21-127


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

If the preference ends with a single period ., the list is considered to be exhaustive, that
is, the list contains all nonnumeric values. Any other value is then forced to be numeric.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PSM_global_option_item_ids

DESCRIPTION
Specifies a list of item IDs for items that contain global option definitions. These
definitions can be reused when authoring variant modules. In the rich client, you
can drop these global options into the module for which they are required. Set this
preference by listing the IDs of all items that contain global options. For example:
000400
000410
000420

To add items to the list of IDs from within Structure Manager, select an item and choose
Tools→Variants→Set/Unset Global Option Item. When you use this method, the
item’s UID is added to the list, for example:
000400
000410
000420
wVJ9K8VxIZ0KDB
VALID
VALUES
Valid Teamcenter item IDs that contain global options.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

PS_option_value_delimiter

DESCRIPTION
Specifies the delimiter to separate individual option values in variant rules if the option
has multiple option values set. For example, if the option has values Red OR Blue
OR Green, it is represented as Red(OR)Blue(OR)Green when this preference is set
to (OR).
VALID
VALUES
Any delimiter string.
DEFAULT
VALUES
(OR)

21-128 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
System preference.

PS_Reference_Designator_Validation

DESCRIPTION
Determines whether the system performs special reference designator validation.
If enabled, the format and uniqueness of the values of the reference designator is
verified. Packed lines cannot be modified.

For validation, all reference designators must be in the format prefix number, where
prefix is a string of one or more uppercase letters and number is an integer. For
example, C1, TS105, or CK109TS43). Formats such as c1 and %O are not valid.

For more information about packing or unpacking lines with reference designators,
see Structure Manager.
VALID
VALUES
true Special reference designator validation is enabled.

false Special reference designator validation is not enabled.


DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PS_variant_value_protect preference

DESCRIPTION
Protects a specified product structure option value from unwanted modifications by
rich client users. This preference applies only to classic variants.
VALID
VALUES
all All option values are protected. No options can be deleted.

refd_by_expr Option values referenced by any variant expression except


declarations are protected.

none Provides the same behavior as the refd_by_expr value.


Option values referenced by any variant expression except
declarations are protected. In a future version of Teamcenter,
this value will be made obsolete.
DEFAULT
VALUE
refd_by_expr

PLM00026 11.2 Preferences and Environment Variables Reference 21-129


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
If you allow users to delete referenced option values, each deleted option value is
displayed as a ? character wherever it is referenced.

RAC_expand_below_batch_size

DESCRIPTION
Determines the batch size in which BOM lines are processed when users click
View→Expand Below. The selected BOM lines are expanded in levels of batches,
the maximum size of each batch is the size set by this preference.
VALID
VALUES
Accepts a single integer as a value. A positive integer defines the number of lines
processed per batch. Use -1 to indicate no maximum size, in which case all lines in a
single level are processed in a single batch.
DEFAULT
VALUES
1000
DEFAULT
PROTECTION
SCOPE
All.

Rollup_Variant_Feature

DESCRIPTION
Determines whether variants on the EBOM are rolled up to the MBOM. When selected,
Teamcenter adds the variant conditions of all the parent BOM lines of the selected
line to its own variant condition. The resulting variant condition is called the rollup
variant condition of the target BOM line. Teamcenter performs a roll up of variant
conditions when a user performs an Assign, Compare or Propagate action on a
linked EBOM and MBOM.
VALID
VALUES
true
false
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
The following table shows the effect of this preference with different values of the
MEAlignedPropertiesList preference.

21-130 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Rollup_Variant_Feature bl_condition_tag bl_condition_tag


preference value included in not included in
MEAlignedPropertiesList MEAlignedPropertiesList
preference preference
false No roll up occurs and a The variant condition is
variant condition is copied not set on the line or rolled
“as is”. up.
true The variant condition on the The variant condition is
source EBOM line is rolled not set on the line or rolled
up and copied to the target up.
MBOM line.

RollUp_Variant_Traverse_Level_Is_InstallationAssembly

DESCRIPTION
Determines whether the installation assembly needs to be considered as the highest
level of loaded structure for the upward traversal when rolled-up variant conditions
are calculated.
VALID
VALUES
true Rollup variant conditions are calculated up to the installation
assembly in the BOM structure, if one exists. Otherwise, rollup
variant conditions are calculated up to the top line of the loaded
structure.
false Rollup variant conditions are calculated up to top line of the
loaded structure.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTE
This preference is effective only if the Rollup Variant Feature preference is set to true.
The following installation assembly preferences must also be set:
• PortalDesignContextIsInstallationAssemblyMethod

• PortalDesignContextIsInstallationAssemblyMethod.hasIRType.Type

• PortalDesignContextIsInstallationAssemblyMethod.has_bomline_prop.name

• PortalDesignContextIsInstallationAssemblyMethod.has_bomline_prop.value

PLM00026 11.2 Preferences and Environment Variables Reference 21-131


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

ShowModuleIcons

DESCRIPTION
Determines whether modular variants are indicated in item and item revision icons. If
set to true, the icon of items and item revisions containing a module are displayed
in gray scale.
Note

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


variable.

Setting this preference to true impacts performance. Siemens PLM Software


recommends that if modular variants are not used at your site, the default setting is
kept.
VALID
VALUES
true Displays icons of items and item revision containing modular
variants in gray scale.
false Does not display icons of items and item revision containing
modular variants in gray scale.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

TCAllowedChildTypes_DesignReq

DESCRIPTION
Defines the item types permitted in a design requirement parent structure. This
preference is valid only when the TCEnforceSingleType preference is set to false.
Design requirement objects are defined by the DesignReq business object type.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter business
object internal name.
DEFAULT
VALUES
Requirement
Paragraph
DesignReq
ValidationReq
DEFAULT
PROTECTION
SCOPE
Site preference.

21-132 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

TCAllowedChildTypes_Fnd0LogicalBlock

DESCRIPTION
Defines the item types permitted in a logical block parent structure. This preference is
valid only when the TCEnforceSingleType preference is set to false.
Logical block objects are defined by the Fnd0LogicalBlock business object type.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter business
object internal name.
DEFAULT
VALUES
Fnd0LogicalBlock
PSConnection
Connection
GCS_CP
GCS_CP_Plug
GCS_CP_Socket
Network
ArcWeld
DatumPoint
WeldPoint
ProductRelation
InterpartEquation
InterpartLink
MatingConstraint
TC_Link
Connection_Terminal
Network_Port
ProductInterface
CsysProductInterface
GeoProductInterface
ParProductInterface
PSSignal
Message
Signal
Fnd0LogicConn
Fnd0LogicIntrfce
DEFAULT
PROTECTION
SCOPE
Site preference.

TCAllowedChildTypes_Functionality

DESCRIPTION
Defines the item types permitted in a function parent structure. This preference is valid
only when the TCEnforceSingleType preference is set to false.
Function objects are defined by the Functionality business object type.

PLM00026 11.2 Preferences and Environment Variables Reference 21-133


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter business
object internal name.
DEFAULT
VALUES
Functionality
PSConnection
Connection
GCS_CP
GCS_CP_Plug
GCS_CP_Socket
Network
ArcWeld
DatumPoint
WeldPoint
ProductRelation
InterpartEquation
InterpartLink
MatingConstraint
TC_Link
Connection_Terminal
Network_Port
ProductInterface
CsysProductInterface
GeoProductInterface
ParProductInterface
PSSignal
Message
Signal
DEFAULT
PROTECTION
SCOPE
Site preference.

TCAllowedChildTypes_<ItemTypeOrGDEType>

DESCRIPTION
Defines the item and/or GDE types permitted in a parent structure. This preference
is valid only when the TCEnforceSingleType preference has been set to false.
Teamcenter checks this preference when child items or occurrences are added to a
BVR in Structure Manager. If you want to add restricted item types to the parent
BVR with a different relation (for example, references), they should be specified
in this preference.
Note

GDEs are general design elements used to model electrical interfaces.

21-134 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter item
type or GDE type.
DEFAULT
VALUES
TCAllowedChildTypes_CPPackageItem=CPPackageItem
TCAllowedChildTypes_CPArtwork=CPGraphicElement, CPCopy, CPDieLline
TCAllowedChildTypes_CPCopy=CPCopyElement
TCAllowedChildTypes_CPFinishProduct=CPFinishProduct, CPPackageItem, CPGFormulaMaster, Part

DEFAULT
PROTECTION
SCOPE
Site preference.

TCAllowedChildTypes_Paragraph

DESCRIPTION
Defines the item types permitted in a paragraph parent structure. This preference is
valid only when the TCEnforceSingleType preference is set to false.
Paragraph objects are defined by the Paragraph business object type.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter business
object internal name.
DEFAULT
VALUES
Requirement
Paragraph
DesignReq
ValidationReq
DEFAULT
PROTECTION
SCOPE
Site preference.

TCAllowedChildTypes_Requirement

DESCRIPTION
Defines the item types permitted in a requirement parent structure. This preference is
valid only when the TCEnforceSingleType preference is set to false.
Requirement objects are defined by the Requirement business object type.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter business
object internal name.
DEFAULT
VALUES
Requirement
Paragraph
DesignReq

PLM00026 11.2 Preferences and Environment Variables Reference 21-135


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

ValidationReq
DEFAULT
PROTECTION
SCOPE
Site preference.

TCAllowedChildTypes_RequirementSpec

DESCRIPTION
Defines the item types permitted in a requirement specification parent structure. This
preference is valid only when the TCEnforceSingleType preference is set to false.
Requirement specification objects are defined by the RequirementSpec business
object type.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter business
object internal name.
DEFAULT
VALUES
RequirementSpec
Requirement
Paragraph
DesignReq
ValidationReq
DEFAULT
PROTECTION
SCOPE
Site preference.

TCAllowedChildTypes_ValidationReq

DESCRIPTION
Defines the item types permitted in a validation requirement parent structure. This
preference is valid only when the TCEnforceSingleType preference is set to false.
Validation requirement objects are defined by the ValidationReq business object type.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter business
object internal name.
DEFAULT
VALUES
Requirement
Paragraph
DesignReq
ValidationReq
DEFAULT
PROTECTION
SCOPE
Site preference.

21-136 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

TCAllowedParentTypes_itemtype

DESCRIPTION
Indicates the list of valid parent item types for a given child type.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter class.
DEFAULT
VALUES
TCAllowedParentTypes_CPGraphicElement=CPArtwork
TCAllowedParentTypes_CPCopy=CPArtwork
TCAllowedParentTypes_CPDieLine=CPArtwork
TCAllowedParentTypes_CPCopyElement=CPCopy
TCAllowedParentTypes_CPFinishProduct=CPFinishProduct
TCAllowedParentTypes_CPGFormulaMater=CPFinishProduct, CPGFormulaMater
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_CFG_PRODUCTS_USE_VARIABILITY

DESCRIPTION
Manually enforces or disables the evaluation of variability allocation statements if they
exist for a given item revision. Variability allocation statements allow Teamcenter to
import only some of the values of a variant option family in a product.
If you leave this preference unset, Teamcenter dynamically determines this
configuration setting. The performance of this dynamic configuration is impacted by
the value set for the PortalDesignContextProductItemQuery preference.
You can view and manage variability allocation statements with the Product
Configurator or Platform Designer applications.
Technically, variability allocation statements are specialized VariantExpression
objects using the corresponding operator code, for example,
PS_variant_operator_assy_uses+BOM_variant_op_rhs_is_string =
1002.
For more information about these objects, see the $TC_INCLUDE/bom/bom_tokens.h
file.
If an item revision has variability allocation statements and their evaluation is not
disabled, the Teamcenter variant configurators recognize only explicitly allocated
variant option values. Otherwise, they recognize all variant option values that exist on
the declared variant option family revision.
Setting this preference is recommended but not required. If you are unsure, set this
preference to TRUE.

PLM00026 11.2 Preferences and Environment Variables Reference 21-137


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES

Effect on item
Effect on item revisions without
Effect on revisions with variability
classic variant variability allocation
configurator allocation statements
Preference value initialization statements
TRUE No database Teamcenter Teamcenter
query is executed configurators configurators
when initializing recognize only recognize all
a Teamcenter allocated variant variant or effectivity
variant or effectivity or effectivity option values of
configurator. configuration option all declared option
values. families.
FALSE No database query Teamcenter Teamcenter
is executed when configurators configurators
initializing a classic recognize all recognize all
variant configurator. variant or effectivity variant or effectivity
configuration option values of
option values of all declared option
all declared option families.
families.
unset A database query Teamcenter Teamcenter
is executed once configurators configurators
when initializing recognize only recognize all
a Teamcenter allocated variant variant or effectivity
configurator or effectivity option values of
(variant or configuration option all declared option
effectivity). If at values. families.
least one product
item exists with
variability allocation
statements, the
system behaves
as if set to
TRUE, otherwise
it behaves as if set
to FALSE.

DEFAULT
VALUES
False.
DEFAULT
PROTECTION
SCOPE
Site preference.

21-138 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

TC_Default_SVR_Relationship

DESCRIPTION
Defines the relationship between a saved variant rule and the item to which it refers.
VALID
VALUES
The name of any relationship.
DEFAULT
VALUES
IMAN_reference
DEFAULT
PROTECTION
SCOPE
User preference.

TCEnforceSingleType

DESCRIPTION
Determines whether items in a structure are restricted to a single item or GDE type,
thus determining whether structures must be homogeneous, or can be heterogeneous.
Note

GDEs are general design elements used to model electrical interfaces.

VALID
VALUES
true Items in a structure are restricted to a single item or GDE type.
Users can only create homogeneous structures; any children
added must be the same type as the parent.
Note

When this preference is set to true, the values of


the TCAllowedChildTypes_<ItemTypeOrGDEType>
preference are ignored.

false Items in a structure are not restricted to a single item or GDE


type. The system restricts item/GDE types to the types defined
in the TCAllowedChildTypes_<ItemTypeOrGDEType>
preference.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-139


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

TC_Fnd0SoaConfigFilterCriteria_AutoPublishRevisable

DESCRIPTION
Controls whether effectivity changes made in a private edit state by effectivity or
variant-related APIs are automatically published before the SOA call returns.
Effectivity and variant data for POM revisable objects can only be changed if the object
is in the private edit state. Therefore, Fnd0SoaConfigFilterCriteria SOA services (for
example, setting an effectivity or variant condition) automatically put revisable objects
into a private edit space if the configuration data changes.
If this preference is set to TRUE, changes to revisable objects that are in a private
edit state in an Fnd0SoaConfigFilterCriteria SOA service call are automatically
published as part of the same SOA call. This causes the revision number to increment
in each Fnd0SoaConfigFilterCriteria SOA service call. Effectivity and variant
data changes are therefore immediately visible to other users, if they have read
access. Revisable objects that are already in a private edit state before calling
an Fnd0SoaConfigFilterCriteria SOA service call remain in this state without
automatically publishing changes that were made in this SOA service.
Depending on your business processes, consider setting this preference to FALSE.
Users can then accumulate more private edit changes for the revisable object before
committing all their private edits in a single publish action. Private edits are not visible
to other users with read access when they are published.
VALID
VALUES
TRUE Effectivity changes made in a private edit state by effectivity or
variant-related SOA APIs are automatically published before
the SOA call returns.
FALSE Effectivity changes made in a private edit state by effectivity
or variant-related SOA APIs are not automatically published
before the SOA call returns.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES

Note

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


variable.
This preference replaces the obsolete
TC_Fnd0SoaConfigFilterCriteria_AutoCheckinRevisable preference.

21-140 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

TC_JT_voxel_size

DESCRIPTION
Specifies the size of the voxels, in millimeters, used to save the spatial representation
of the product when spatial data is generated from JT files.
Users should base this setting upon their knowledge of the model's geometry. Smaller
values provide a higher quality of results with less false positives but increase
disk space requirements and may increase search times. Larger values improve
performance but can degrade quality.
Appearance spatial cache supports mixed-size components spatial maps. Users must
modify this value depending upon actual geometry size.
VALID
VALUES
A positive real number.
DEFAULT
VALUES
12.75
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Undefined_Variant_State_Enabled

DESCRIPTION
Determines if the undefined variant occurrence state is enabled. This state is indicated
by the ? symbol.
VALID
VALUES
true If any of the variant options in the variant condition is not set in
the variant rule, the corresponding variant occurrence assumes
an undefined (?) state.
false If any of the variant options in the variant condition is not set in
the variant rule, the corresponding variant occurrence assumes
a defined (Y) state.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_ValidApprovedStatus

DESCRIPTION
Determines the valid approved status of an item revision. Use this preference to
determine whether occurrences within an item revision can be updated when a new
item revision is created in precise mode. Users update such occurrences by selecting

PLM00026 11.2 Preferences and Environment Variables Reference 21-141


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

a BOM line and choosing Edit→Show Superseded. All children revisions containing
a status specified by this preference are updated. A symbol next to each child line
indicates the update.
VALID
VALUES
Accepts multiple strings as values. Each value must be a valid Teamcenter status.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_VariantConfigurable_MaxCacheSize

DESCRIPTION
Configures the size of the Teamcenter variant data cache.
The Teamcenter server caches variant data for configurable objects to prevent
repeated frequent database queries for the same set of configurable objects. Use this
preference to optimize the balance between the memory footprint of the tcserver
process and the performance impact of an increased database SQL query count.
The cache is automatically purged on a last-accessed basis. Cached values are
automatically refreshed for loaded and up-to-date objects when Teamcenter accesses
a cached value that belongs to an object that has changed since its value was cached.
VALID
VALUES
Any integer greater than zero.
DEFAULT
VALUES
50000
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_variant_configurator_relationship

DESCRIPTION
Specifies the relationship between an application model (for example, a collaborative
design) and the related item when using a variant configurator such as the Product
Configurator.
VALID
VALUES
The name of any relationship.
DEFAULT
VALUES
Mdl0HasVariantConfiguratorContext

21-142 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

Transform preferences

Using transform data to position components


Teamcenter uses transform data to position components in an assembly. The system creates
transform data for each component in an assembly. When an Teamcenter assembly is opened in
NX via Teamcenter Integration for NX, it interprets the transform data to reconstruct the assembly.
Teamcenter Integration for NX provides several options for managing Teamcenter transform data.
For more information, see Teamcenter Integration for NX documentation in the NX Help.
Teamcenter and Teamcenter Integration for NX transform data is currently written in an PLM XML
format, which uses metres as its unit of measure. Legacy transform data was written in millimeters
and inches.
Note

Do not combine legacy and current transform measurements.


For more information about updating transform data using the ugmanager_refile utility, see
the NX Help Library.

PS_assume_old_transform_format

DESCRIPTION
Determines how Teamcenter interprets the format of legacy transform data.
Note

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


variable.

VALID
VALUES
In_Legacy_Format
Assumes all legacy transforms are in the same format as legacy NX transforms.
Written_By_UG
Assumes all old transforms are in the same format as legacy NX transforms.
Assumes all old transforms were written by Teamcenter Integration for NX. The
PS_convert_legacy_transform ITK routine attempts to obtain the parent's unit
information when converting transforms to eXT format.
Unknown
No assumptions made. Use this setting when the transform data was written by an
application other than Teamcenter Integration for NX.
DEFAULT
VALUES
Unknown

PLM00026 11.2 Preferences and Environment Variables Reference 21-143


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

PS_assume_legacy_transform_units

DESCRIPTION
Determines how Teamcenter interprets the unit of measure for legacy transform data.
Teamcenter and NX currently use meters for transform units of measure; legacy
measurements were in inches or millimeters. This preference affects all data using
legacy transforms which have no database-resident indication of the unit measurement
with which they were stored.
Note

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


variable.

If the PS_assume_old_transform_format preference is set to Written_By_UG, the


PS_convert_legacy_transform ITK routine attempts to obtain the unit of the parent
NX part from this preference.
VALID
VALUES
Inches Assumes transform data is measured in inches.
Millimeters Assumes transform data is measured in millimeters.
Unknown No assumption made. Use this setting when transform data is
in mixed units, for example, when transform data from NX is in
both millimeters and inches.
DEFAULT
VALUES
Unknown
DEFAULT
PROTECTION
SCOPE
Site preference.

PS_allow_plmxml_transforms_with_no_legacy_factor

DESCRIPTION
Allows Teamcenter to use the PS_set_plmxml_transform ITK call to set PLM
XML transform data without first having to define a legacy transform factor via the
PS_set_legacy_transform_factor ITK call. Use this preference when you have a
new set up of Teamcenter with no legacy data, and thus no need to convert to or from
legacy transform data.
VALID
VALUES
Yes Ignores the legacy factor.
No Requires the legacy factor.

21-144 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
VALUES
Yes
DEFAULT
PROTECTION
SCOPE
Site preference.

PS_convert_legacy_transform_to_plmxml

DESCRIPTION
Allows Teamcenter to display legacy transforms in a PLM XML format. This preference
is only effective if a legacy transform exists and no PLM XML transform is assigned.
Note

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


variable.

VALID
VALUES
true Teamcenter tries to convert the legacy transform to PLM XML
format for display purposes only.

false Teamcenter displays the legacy transform as is.


DEFAULT
VALUE
false
DEFAULT
PROTECTION
SCOPE
User preference.

Product structure synchronization preferences

Synchronize dataset and BOM view revision changes

Structure Manager can synchronize dataset and BOM view revision changes by comparing the
time listed in the last_struct_mod_date field of the BVRSyncInfo form, attached as a named
reference to UGMASTER datasets, with the struct_last_mod_date field of the BOM view revision.
The struct_last_mod_date field is only updated when a significant change occurs to the BOM
view revision. Use the PS_structure_change_condition preference to define what constitutes
a significant change.
Each time Teamcenter Integration for NX opens a dataset, these two fields are compared. When
the date of the struct_last_mod_date field is later, Teamcenter Integration for NX synchronizes its
internal structure. Synchronization behavior is determined by two Teamcenter Integration for NX
preferences: UGMGR_StructureUpdateOnLoad and UGMGR_StructureUpdateOnSave.
For information about these preferences, see the Teamcenter Integration for NX documentation
in the NX Help.

PLM00026 11.2 Preferences and Environment Variables Reference 21-145


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

PS_structure_change_condition

DESCRIPTION
Determines which changes to a BOM view revision are considered significant, and thus
noted in the struct_last_mod_date field of the BOM view revision. Changes to any of
the attributes listed as a value of this preference updates the struct_last_mod_date
field.
Note

The following note types must be used with this preference to ensure correct
synchronization with Teamcenter Integration for NX:
NoteType:UG NAME
NoteType:UG GEOMETRY
NoteType:UG REF SET
NoteType:UG ENTITY HANDLE
NoteType:UG ALTREP

VALID
VALUES
Transform
Any change to the transform updates the struct_last_mod_date field.
SequenceNumber
Any change to the sequence number updates the struct_last_mod_date field.
Quantity
Any change to the quantity updates the struct_last_mod_date field.
PreferredAlternate
Setting the preferred alternate on the occurrence updates the struct_last_mod_date
field.
NoteType:note type name
Any changes to the specified note types updates the struct_last_mod_date field.
The note types listed above must be used with this preference to ensure correct
synchronization with Teamcenter Integration for NX.
ClientData:attribute name
Any changes to client data on the occurrence updates the struct_last_mod_date field.
DEFAULT
VALUES
Transform
SequenceNumber
Quantity
PreferredAlternate
NoteType:UG NAME
NoteType:UG GEOMETRY
NoteType:UG REF SET
NoteType:UG ENTITY HANDLE
NoteType:UG ALTREP

21-146 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

PS_variant_value_protect

DESCRIPTION
Protects a specified product structure option value from unwanted modifications by
rich client users. This preference applies only to classic variants.
VALID
VALUES
none No option value is protected.
all All option values are protected. No options can be deleted.
refd_by_expr Option values referenced by any variant expression except
declarations are protected.
DEFAULT
VALUE
refd_by_expr
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
If you allow users to delete referenced option values, each deleted option value is
displayed as a ? character wherever it is referenced.

TC_BVRSYNCFORM_DELEGATE

DESCRIPTION
Determines whether the BVRSYNCFORM named reference inherits delegated write
access from the UGMASTER dataset.
VALID
VALUES
true The BVRSYNCFORM named reference inherits the write
access privilege from the UGMASTER dataset.
false The BVRSYNCFORM named reference does not inherit the
write access privilege from the UGMASTER dataset.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-147


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

BOM grading preferences

CondValData.CREATERENDERING

DESCRIPTION
Registers a data creation style sheet for CondValData item objects. The CondValData
object contains verification rules that are used by the Validation Manager checker.
DEFAULT
VALUES
CondValDataCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

CondValData.SUMMARYRENDERING

DESCRIPTION
Registers a summary style sheet for CondValData item objects. The CondValData
object contains verification rules that are used by the Validation Manager checker.
DEFAULT
VALUES
CondValDataSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

CondValDataCreate.CREATE_REGISTEREDTO

DESCRIPTION
Indicates the business object type to which the CondValData item creation style sheet
can be applied. The CondValData object contains verification rules that are used by
the Validation Manager checker.
DEFAULT
VALUES
CondValData
DEFAULT
PROTECTION
SCOPE
Site preference.

CondValdataRevSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the business object type to which the CondValDataRevision summary style
sheet can be applied. The CondValDataRevision object is a specific revision of the
CondValData object that contains verification rules used by the Validation Manager
checker.

21-148 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
VALUES
CondValDataRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

CondValDataRevision.REGISTEREDTO

DESCRIPTION
Indicates the business object type to which the CondValDataRevision style sheet
can be applied. The CondValDataRevision object is a specific revision of the
CondValData object that contains verification rules used by the Validation Manager
checker.
DEFAULT
VALUES
CondValDataRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

CondValDataRevision.RENDERING

DESCRIPTION
Registers the properties style sheet for CondValDataRevision objects. The
CondValDataRevision object is a specific revision of the CondValData object that
contains verification rules used by the Validation Manager checker.
DEFAULT
VALUES
CondValDataRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

CondValDataRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for CondValDataRevision objects. The
CondValDataRevision object is a specific revision of the CondValData object that
contains verification rules used by the Validation Manager checker.
DEFAULT
VALUES
CondValDataRevSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-149


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

CondValDataSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the business object types to which the CondValData summary style sheet
can be applied. The CondValData object contains verification rules that are used by
the Validation Manager checker.
DEFAULT
VALUES
CondValData
DEFAULT
PROTECTION
SCOPE
Site preference.

CondValResult.SUMMARYRENDERING

DESCRIPTION
Defines the name of the summary style sheet for CondValResult objects. The
CondValData object contains verification rules that are used by the Validation
Manager checker. The setting determines how detail information about the BOM
grading result displays in the Detail Information pane in Structure Manager.
DEFAULT
VALUES
CondValResultSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

CondValResultSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the business object type to which the CondValResult summary style sheet
can be applied. The CondValData object contains verification rules that are used by
the Validation Manager checker. The setting determines how detail information about
the BOM grading result displays in the Detail Information pane in Structure Manager.
DEFAULT
VALUES
CondValResult
DEFAULT
PROTECTION
SCOPE
Site preference.

CondValidation_NoData

DESCRIPTION
Defines your company policy on the handling of no-data results in condition validation
results.

21-150 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
PASS Passes no-data results.
FAIL Fails no-data results.
NODATA Reports the results as having no data.
DEFAULT
VALUES
NODATA
DEFAULT
PROTECTION
SCOPE
Site preference.

CONDVALIDATION_Keep_PrevRev_Result

DESCRIPTION
Controls whether Teamcenter keeps BOM grading results generated by previous
checker revisions when a checker runs.
VALID
VALUES
TRUE BOM results generated by an earlier revision of a checker are
not deleted when the BOM is validated against a later revision
of the same checker.
FALSE BOM results generated by an earlier revision of a checker are
deleted when the BOM is validated against a later revision of
the same checker.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

ConditionValidationResultColumnPreferences

DESCRIPTION
Specifies the columns displayed in the validation results Detail Information pane
in Structure Manager. You can remove columns from this preference but not add
columns. Use the ConditionValidationResultColumnWidthPreferences preference
to set the widths of the specified columns.
VALID
VALUES
CondValResult.validation_target, CondValResult.valdata_revision,
CondValResult.condition_name,
CondValResult.validation_date,
CondValResult.validation_result,
CondValResult.override_to_state,
CondValResult.override_request_state

PLM00026 11.2 Preferences and Environment Variables Reference 21-151


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
VALUES
CondValResult.validation_target, CondValResult.valdata_revision,
CondValResult.condition_name,
CondValResult.validation_date,
CondValResult.validation_result,
CondValResult.override_to_state,
CondValResult.override_request_state
DEFAULT
PROTECTION
SCOPE
Site preference.

ConditionValidationResultColumnWidthPreferences

DESCRIPTION
Specifies the widths of the columns displayed in the validation results Detail
Information pane in Structure Manager. The widths are specified in the same order
as the columns are listed in the ConditionValidationResultColumnPreferences
preference.
VALID
VALUES
Any valid numerical value.
DEFAULT
VALUES
30
20
20
20
15
20
35
DEFAULT
PROTECTION
SCOPE
Site preference.

Platform Designer preferences


<Architecture_Type>_generic_id_mapping

DESCRIPTION
Determines whether to prepopulate the Architecture Element ID field with the data
defined by this preference.
VALID
VALUES
Requires creating a composite preference name concatenating the desired architecture
type with _generic_id_mapping, then setting the preference with a string. The string
must be define valid Teamcenter data. For example:
Physical_generic_id_mapping=

21-152 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

IMAN_master_form_rev:Unit_No

This example prepopulates the Architecture Element ID field with the contents of the
Unit No field in the revision master form of the item revision selected to be added as
a solution to the physical architecture breakdown.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ArchitectureModeler_add_design_business_rule_check

DESCRIPTION
Specifies the process template used to perform the business rule check for compliance
to standards. The system checks this preference value before adding a design to a
product. The business rule check process has the following elements as targets:
Architecture Revision
Architecture Breakdown
Product Item
Add Design

The workflow process for this template is initiated before the edit takes place, causing
the operation to cancel out if the workflow process cannot complete successfully
(subject to workflow handlers configured for this workflow process template).
VALID
VALUES
Accepts a single string as a value. Must be a valid process template.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ArchitectureModeler_add_design_occurrence_business_rule_check

DESCRIPTION
Specifies the process template used to perform the business rule check for compliance
to occurrence standards. The system checks this preference value before adding a
design occurrence. The business rule check process has the following elements
as targets:
Architecture Revision
Architecture Breakdown
Product Item
Installation Assembly

PLM00026 11.2 Preferences and Environment Variables Reference 21-153


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

The workflow process for this template is initiated after the edit takes place, causing
the operation to roll back if the workflow process cannot complete successfully (subject
to workflow handlers configured for this workflow process template).
VALID
VALUES
Accepts a single string as a value. Must be a valid process template.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ArchitectureModeler_locking_retry_count

DESCRIPTION
Determines the number of times the system attempts to explicitly lock the system for
edits (such as Add, Remove, Replace).

When changing product architecture data in Platform Designer, multiple users might
attempt to save changes simultaneously. Such simultaneous saves are serialized by
locking the common product. If a save is blocked because the product is already
locked, Platform Designer makes as many additional attempts to lock the product
as specified in this preference.
VALID
VALUES
Accepts a positive integer as a value.
DEFAULT
VALUES
3
DEFAULT
PROTECTION
SCOPE
Site preference.

ArchitectureModeler_multiple_installation_assemblies_condition

DESCRIPTION
Determines the behavior of the
ArchitectureModeler_use_all_installation_assemblies preference.
VALID
VALUES
NONE The system refers to the value of the
ArchitectureModeler_use_all_installation_assemblies
preference.

21-154 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Warning The system refers to the value of the


ArchitectureModeler_use_all_installation_assemblies
preference. If more than one installation assembly is found, a
warning displays to the user.
Error If more than one installation assembly is found, the system
stops searching and displays an error to the user.
DEFAULT
VALUES
Warning
DEFAULT
PROTECTION
SCOPE
Site preference.

ArchitectureModeler_part_solution_properties

DESCRIPTION
Lists all line of usage (LOU) occurrence notes and properties that Teamcenter
aggregates and displays in the architecture breakdown element (ABE). Users can
then view properties of an LOU associated with an ABE without viewing the actual
LOU object.
VALID
VALUES
bl_lou_usage_partnumber
bl_lou_usage_quantity
bl_lou_usage_architecture_id
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ArchitectureModeler_remove_design_business_rule_check

DESCRIPTION
Specifies the process template used to perform the business rule check for compliance
to standards. The system checks this preference value before removing a design from
a product. The business rule check process has the following elements as targets:
Architecture Revision
Architecture Breakdown
Product Item
Remove Design

The workflow process for this template is initiated before the edit takes place, causing
the operation to cancel out if the workflow process cannot complete successfully
(subject to workflow handlers configured for this workflow process template).

PLM00026 11.2 Preferences and Environment Variables Reference 21-155


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES
Accepts a single string as a value. Must be a valid process template.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ArchitectureModeler_RemoveDesign_Max

DESCRIPTION
Determines the maximum number of designs which can be removed at one time from
a product assembly using the RDV Remove Action command.
VALID
VALUES
Accepts a single string as a value. Must be a positive integer.
DEFAULT
VALUES
30
DEFAULT
PROTECTION
SCOPE
User preference.

ArchitectureModeler_remove_design_occurrence_business_rule_check

DESCRIPTION
Specifies the process template used to perform the business rule check for compliance
to occurrence standards. The system checks this preference value before removing
a design occurrence. The business rule check process has the following elements
as targets:
Architecture Revision
Architecture Breakdown
Product Item
Installation Assembly

The workflow process for this template is initiated after the edit takes place, causing
the operation to roll back if the workflow process cannot complete successfully (subject
to workflow handlers configured for this workflow process template).
VALID
VALUES
Accepts a single string as a value. Must be a valid process template.
DEFAULT
VALUES
None.

21-156 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ArchitectureModeler_replace_design_business_rule_check

DESCRIPTION
Specifies the process template used to perform the business rule check for compliance
to standards. The system checks this preference value before replacing a design in a
product. The business rule check process has the following elements as targets:
Architecture Revision
Architecture Breakdown
Product Item
Replace Design

The workflow process for this template is initiated before the edit takes place, causing
the operation to cancel out if the workflow process cannot complete successfully
(subject to workflow handlers configured for this workflow process template).
VALID
VALUES
Accepts a single string as a value. Must be a valid process template.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ArchitectureModeler_replace_design_occurrence_business_rule_check

DESCRIPTION
Specifies the process template used to perform the business rule check for compliance
to occurrence standards. The system checks this preference value before replacing
a design occurrence. The business rule check process has the following elements
as targets:
Architecture Revision
Architecture Breakdown
Product Item
Installation Assembly

The workflow process for this template is initiated after the edit takes place, causing
the operation to roll back if the workflow process cannot complete successfully (subject
to workflow handlers configured for this workflow process template).
VALID
VALUES
Accepts a single string as a value. Must be a valid process template.

PLM00026 11.2 Preferences and Environment Variables Reference 21-157


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ArchitectureModeler_update_designs_business_rule_check

DESCRIPTION
Specifies the process template used to perform the business rule check for compliance
to standards. The system checks this preference value before updating a design from
a product. The business rule check process has the following elements as targets:
Architecture Revision
Architecture Breakdown
Product Item
Remove Design

The workflow process for this template is initiated before the edit takes place, causing
the operation to cancel out if the workflow process cannot complete successfully
(subject to workflow handlers configured for this workflow process template).
VALID
VALUES
Accepts a single string as a value. Must be a valid process template.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ArchitectureModeler_update_design_occurrences_business_rule_check

DESCRIPTION
Specifies the process template used to perform the business rule check for compliance
to occurrence standards. The system checks this preference value before updating
a design occurrence. The business rule check process has the following elements
as targets:
Architecture Revision
Architecture Breakdown
Product Item
Installation Assembly

The workflow process for this template is initiated after the edit takes place, causing
the operation to roll back if the workflow process cannot complete successfully (subject
to workflow handlers configured for this workflow process template).

21-158 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
Accepts a single string as a value. Must be a valid process template.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ArchitectureModeler_use_all_installation_assemblies

DESCRIPTION
Determines whether the system stops at the first installation assembly found, or
continues walking up the tree, searching for additional installation assemblies.
VALID
VALUES
TRUE System continues searching for additional installation
assemblies.
FALSE System does not continue searching for additional installation
assemblies.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

RDV_platformdesigner_assign_bulk_variability

DESCRIPTION
Determines if the user can add and remove variability on the product context in bulk
with Platform Designer.
VALID
VALUES
true The user can add and remove variability on the product context
in bulk.
false The user cannot add and remove variability on the product
context in bulk.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-159


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

RDIP_report_invalid_thoughts

DESCRIPTION
Specifies if an error message is displayed when one of the thoughts is invalid when
performing the Replace Design in Product operation in the Structure Manager
application.
For more information, see Structure Manager.
VALID
VALUES
TRUE The error message is displayed.
FALSE The error message is not displayed.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Quick spatial search preferences

QSEARCH_avoid_check_for_cycles

DESCRIPTION
Allows the disabling of cycle checking during the cacheless search spatial index
update process.
VALID
VALUES
True
Disables the checking and filtering out of cycles during a cacheless spatial index
update.
False
Enables the checking and filtering out of cycles during a cacheless spatial index
update.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
Siemens PLM Software does not recommend disabling cycle checking when
performing cacheless spatial index updates. This can adversely impact the
performance of spatial indexing process, as well as the efficiency of spatial search.

21-160 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Consult with Siemens PLM Software GTAC services before switching this preference
to True.

QSEARCH_avoid_shrinkage

DESCRIPTION
Disables shrinkage of cacheless search spatial indexes when they are updated,
even if the underlying geometry is shrunk. This may improve spatial index update
performance at the cost of some loss of performance of spatial search.
VALID
VALUES
True
Disables the shrinkage of spatial index box volume by the cacheless spatial indexer.
False
Enables the shrinkage of spatial index box volume by the cacheless spatial indexer.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

QSEARCH_check_for_cycles_on_index_check

DESCRIPTION
Enables the checking and reporting of cycles when performing a health check of
cacheless search spatial indexes using the command qsearch_process_queue
with the -check_structure_indexes, -check_indexes, or -check_product_indexes
options.
VALID
VALUES
True
Enables the reporting of cycles when checking cacheless spatial search indexes.
False
Disables the reporting of cycles when checking cacheless spatial search indexes.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-161


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

QSEARCH_chunk_size

DESCRIPTION
Tells the search engine, as well as the cacheless search spatial indexer, the size
of chunk to be used for batch processing of search (internally). The value of this
preference should be balanced. If it is too small, it results in high chattiness between
the server, database, and client. If it is too high, it may overload the database, making
the underlying RDBMS less responsive to other concurrent client requests.
This preference is also used by the qsearch_process_queue utility to process the
objects in batches of this size to generate the spatial indexes.
VALID
VALUES
Positive integer.
Specifies the maximum number of objects to process in one batch.
DEFAULT
VALUES
5000
Note

Use the default value. However, you may change it to a higher or lower
number, based on the analysis of search executions and responsiveness of
the underlying RDBMS.

DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
Change only if advised by Siemens PLM Software.

QSEARCH_DEBUG_TEXT

DESCRIPTION
Enables or disables the reporting of debug information during cacheless searches.
VALID
VALUES
1 Enables the reporting of debug information during cacheless
searches in Structure Manager or DesignContext.

0 Disables the reporting of debug information during cacheless


searches in Structure Manager or DesignContext.
DEFAULT
VALUE
0
DEFAULT
PROTECTION
SCOPE
User preference.

21-162 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

QSEARCH_deletion_chunk_size

DESCRIPTION
Specifies the maximum number of objects (spatial indexes or queue entries) to delete
at a time.
VALID
VALUES
Positive integer.
Specifies the maximum number of objects (spatial indexes or queue entries) to delete
at a time.
DEFAULT
VALUES
1000
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
This is an internal tuning preference and is not for casual use. Do not change the
default value.

QSEARCH_disable_bbox_for_product_scoping

DESCRIPTION
Disables sending translation requests to the dispatcher during spatial indexing when a
nonindexable structure is added under an indexable structure.
Dispatcher requests are used to create bounding box data for cacheless searches.

Note

This preference applies only to product-scoped cacheless search functionality.


It does not affect data for which nonproduct-scoped indexing is in effect.
This preference is used only when product scoping is enabled. If you
disable the preference, bounding boxes for the newly added subassembly
are not created. You have the option to manually create them using the
create_or_update_bbox_and_tso command line utility, which must be
executed through a custom automated cron job on UNIX systems or a
scheduled task on Windows systems. This ensures the bounding boxes are
up-to-date with the changes made in the indexable structure.

VALID
VALUES
True Disables dispatcher requests.

False Enables dispatcher requests.


DEFAULT
VALUES
False

PLM00026 11.2 Preferences and Environment Variables Reference 21-163


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

QSEARCH_dispatcher_not_available

DESCRIPTION
Activates or deactivates the dispatcher that generates spatial indexes for cacheless
searches. For example, you may want to deactivate this dispatcher for debugging
purposes. This preference does not affect other dispatcher instances.
VALID
VALUES
False The dispatcher is configured and cacheless searches are
available in Structure Manager or DesignContext.

True The dispatcher is deactivated and cacheless searches are not


available in Structure Manager or DesignContext.
DEFAULT
VALUE
False
DEFAULT
PROTECTION
SCOPE
Site preference.

QS_QSEARCH_ENABLED

DESCRIPTION
Enables or disables the cacheless search mechanism.
VALID
VALUES
true Enables the cacheless search mechanism with attribute
searches in Structure Manager.

false Disables the cacheless search mechanism. Select this value if


you use appearance searches.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
During installation, you can choose to deactivate the cacheless search mechanism.
Enabling this mechanism incurs a processing overhead while Teamcenter creates
the necessary secondary data. If you have a large amount of legacy data, creation
may take an appreciable time.

21-164 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

RESTRICTIONS
If this mechanism is disabled during upgrade, Teamcenter does not generate the
secondary data and users are unable to perform cacheless spatial searches.

QSEARCH_filter_queries_by_product_scoping

DESCRIPTION
Enables product-scoped cacheless search. This preference must be set by the
qsearch_process_queue utility.
• When the qsearch_process_queue utility is run with the
–enable_product_scoping parameter, the preference is set to 1 to
enable product-scoped cacheless search.
When set to 1, it allows spatial indexing and bounding box generation utilities to
work in the scope of one or more specified products.

• When the qsearch_process_queue utility is run with the


–disable_product_scoping parameter, the preference is set to 0 to
disable product-scoped cacheless search.
VALID
VALUES
1
Enables product-scoped cacheless search.
0
Disables product-scoped cacheless search.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

QSEARCH_force_simplify_to_one_box

DESCRIPTION
Specifies that the cacheless search spatial indexer use one simplified bounding box
per node in the product structure trees that are indexed.
VALID
VALUES
True
Enables the calculation of a single simplified box by cacheless spatial search.
False
Disables the calculation of a single simplified box by cacheless spatial search.
DEFAULT
VALUES
True

PLM00026 11.2 Preferences and Environment Variables Reference 21-165


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
Siemens PLM Software does not recommend changing this preference when
performing cacheless spatial index updates. This can adversely impact the
performance of spatial indexing process, as well as the efficiency of spatial search.
Consult with Siemens PLM Software GTAC services before switching this preference
to False.

QSEARCH_force_update_even_if_up_to_date

DESCRIPTION
When propagating changes to spatial indexes up a structure, if an index is not changed
as a consequence of changes from below, that index does not normally cause further
propagation upwards. This preference can be used to force propagation regardless
of whether the index changed.
VALID
VALUES
True
Change propagation goes up the entire structure, regardless of whether an index
change is detected.
False
Change propagation halts at any point where no index change is detected.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
This is an internal tuning preference and is not for casual use. Do not change the
default value.

QSEARCH_foreground_processing_halted

DESCRIPTION
Specifies whether foreground processing of the cacheless search (QSearch) spatial
indexes is enabled or disabled. Siemens PLM Software recommends you set this
preference to true when working on a production environment or when the number
of changes to the structure each day is very large. The Teamcenter Dispatcher
qsearchprocessqueue service must be running to process the indexing requests
when this preference is set to true.

21-166 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
true Disables the processing of spatial indexes in the foreground
and creates Dispatcher requests to process the spatial indexes
in the background.
false Enables spatial index generation in the foreground. If index
generation does not complete in the specified time period, it
creates a Dispatcher request that generates the spatial indexes
in the background.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

QSEARCH_foreground_processing_time

DESCRIPTION
When foreground processing of QSearch index generation is enabled, this specifies
how long (in seconds) to spend processing before stopping and leaving the remaining
processing to be done in the background.
VALID
VALUES
Positive integer.
DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
Siemens PLM Software does not recommend changing this preference. This can
adversely impact the performance of Teamcenter. Consult with Siemens PLM Software
GTAC services before changing this preference.

QSEARCH_ignore_indexable_candidates

DESCRIPTION
Controls whether to avoid marking the new substructure as indexable when a new
unindexable substructure is added into an existing indexable structure.
VALID
VALUES
True
Does not mark the new substructure as indexable.
False

PLM00026 11.2 Preferences and Environment Variables Reference 21-167


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

Marks the new substructure as indexable.


DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
This is an internal tuning preference and is not for casual use. Do not change the
default value.

QSEARCH_log_date

DESCRIPTION
Specifies whether to prefix each line with the current time and date, while logging
spatial index updates (as controlled by QSEARCH_logging_level).
VALID
VALUES
True
Prefixes each line of logging with the current time and date.
False
Does not prefix each line of logging with the current time and date.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

QSEARCH_logging_level

DESCRIPTION
Controls how much to log when performing spatial index updates. Useful values are
between 1 and 6, with higher numbers meaning more logging. 0 means no logging.
VALID
VALUES
Positive integer.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

21-168 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

QSEARCH_print_detail_before_cycle_checking

DESCRIPTION
When checking whether the repeated updating of an object's spatial index is potentially
being caused by looping a cycle indefinitely, this controls whether to print extra details
about the relevant object. Normally only the tag and UID are printed; if this preference
is set, the class and other details about the object are also printed.
VALID
VALUES
True
Prints the class and other details, as well as the tag and UID.
False
Prints only the tag and UID.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
This is an internal tuning preference and is not for casual use. Do not change the
default value.

QSEARCH_processing_halted

DESCRIPTION
Controls whether all processing of update entries is halted. Normally background
processing is always enabled; only foreground processing can be halted using
QSEARCH_foreground_processing_halted.
VALID
VALUES
True
Processing of update entries is halted.
False
Processing of update entries is allowed.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
This is an internal tuning preference and is not for casual use. Do not change the
default value.

PLM00026 11.2 Preferences and Environment Variables Reference 21-169


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

QSEARCH_processing_recursion_limit

DESCRIPTION
Controls how many levels of dependency to process when propagating changes up
a structure. Each level of dependency is a transition from an item to occurrence
thread or vice versa, so the number of apparent levels that can be processed within a
structure is half the preference value. This provides a way to stop if the processing
reaches a point where it loops a cycle indefinitely.
VALID
VALUES
Positive integer.
Specifies the maximum number of levels of dependency to process.
DEFAULT
VALUES
200
DEFAULT
PROTECTION
SCOPE
Site preference.

QSEARCH_processing_retry_limit

DESCRIPTION
When processing update entries, controls how many times to try to gain an exclusive
lock, so that multiple updaters do not try to process the same entries.
VALID
VALUES
Positive integer.
Specifies how many times the system should try to gain an exclusive lock.
DEFAULT
VALUES
5
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
This is an internal tuning preference and is not for casual use. Do not change the
default value.

QSEARCH_query_chunk_size

DESCRIPTION
When performing bulk queries, controls how many objects to hand to one query. If
more than the specified objects are provided, the objects are divided into chunks and
the query is run once for each chunk and results are combined.
VALID
VALUES
Positive integer.

21-170 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Specifies the maximum number of objects to hand to one query.


DEFAULT
VALUES
2000
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
This is an internal tuning preference and is not for casual use. Do not change the
default value.

QSEARCH_queue_recurring_background_updates

DESCRIPTION
Specifies whether to create a recurring dispatcher request for
qsearch_process_queue.
Note

The QSEARCH_foreground_processing_halted preference must


be set to true before setting this preference. Recurring dispatcher
requests will be executed on a regular time interval by dispatcher.
You may also set the following two preferences to specify the
time interval and life span of the recurring dispatcher request:
QSEARCH_recurring_background_update_survival_time and
QSEARCH_recurring_background_update_interval.

VALID
VALUES
True
A recurring dispatcher request is created.
False
A dispatcher request is created, but it is not a recurring request.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
This preference enables an experimental capability that should not normally be
switched on without the recommendation of Teamcenter development.

QSEARCH_recurring_background_update_survival_time

DESCRIPTION
Specifies the life of the recurring request being created for the
qsearch_process_queue utility.

PLM00026 11.2 Preferences and Environment Variables Reference 21-171


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

Note

The QSEARCH_queue_recurring_background_updates preference must be


set to true before setting this preference. Recurring dispatcher requests are
executed on a regular time interval by dispatcher.

VALID
VALUES
Time in seconds.
DEFAULT
VALUES
31536000
DEFAULT
PROTECTION
SCOPE
Site preference.

QSEARCH_recurring_background_update_interval

DESCRIPTION
Specifies the time interval for recurring requests being created for the
qsearch_process_queue utility.
Note

The QSEARCH_queue_recurring_background_updates preference must be


set to true before setting this preference. Recurring dispatcher requests are
executed on a regular time interval by dispatcher.

VALID
VALUES
Time in seconds.
DEFAULT
VALUES
86400
DEFAULT
PROTECTION
SCOPE
Site preference.

QSEARCH_replace_indexes_by_modify

DESCRIPTION
When updating the spatial index information for an object, controls whether to retain
the existing indexes and update their values, rather than creating new indexes and
deleting the old ones.
VALID
VALUES
True
Retains the existing indexes and updates their values.
False

21-172 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

Creates new indexes and deletes the old ones.


DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
This is an internal tuning preference and is not for casual use. Do not change the
default value.

QSEARCH_retain_processed_entries

DESCRIPTION
Controls whether to retain update entries after processing them and mark them as
processed, instead of deleting them. This can be useful for confirming that processing
has taken place, but increases storage.
VALID
VALUES
True
Retains update entries after processing them and marks them as processed.
False
Deletes update entries after processing them.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
This is an internal tuning preference and is not for casual use. Do not change the
default value.

QSEARCH_types_to_avoid_processing

DESCRIPTION
Specifies item types to avoid while performing a cacheless search. This allows you
to restrict the search to object types that have valid matches and avoid unnecessary
processing of object types that can never have valid matches.
VALID
VALUES
An array of strings representing the object type names as values. The string must
contain the type name of at least one valid object type, for example, Architecture.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 21-173


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
When you save items and datasets, Teamcenter triggers the generation of cacheless
search index boxes. Consequently, frequent saving of non-geometry objects adds
multiple entries in the cacheless search update queue. Creation of these entries can
be restricted by adding non-geometry item types to this preference.

QSEARCH_update_enabled

DESCRIPTION
Enables or disables the automatic updating of indexes used by the cacheless spatial
search mechanism.
Note

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


variable.

VALID
VALUES
true Enables automatic updates of spatial search indexes. The
spatial index box data needed for spatial searches is generated
for modified parts.
false Disables automatic updates of spatial search indexes. Spatial
index box data is not generated when parts are modified; spatial
searches are unavailable due to lack of spatial data.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

QSEARCH_use_bulk_filtering_on_queueing

DESCRIPTION
Controls whether to perform queries in bulk or one-per-object when deciding which
set of objects are suitable for processing.
VALID
VALUES
True
Performs such queries in bulk.
False
Performs such queries one-per-object.

21-174 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
This is an internal tuning preference and is not for casual use. Do not change the
default value.

QS_USE_SEARCH_BOTTOM_UP

DESCRIPTION
Specifies if you want to use bottom-up traversal for attributes searches when
performing cacheless attribute search in Teamcenter.
Note

This preference can be modified to not use bottom-up search, if the size of
structures being searched is very small, and the top-down search approach is
expected to function better. Consult with the Siemens PLM Software GTAC
team before making this change.

VALID
VALUES
True
Use the bottom-up search, unless it exceeds the time limit or maximum lines generated
during bottom-up traversal.
False
Do not use bottom-up traversal. Instead, use the top-down search.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

QS_IGNORE_JT_USER_VOLUME

DESCRIPTION
Determines if Teamcenter stores TruShape data files in the volume of the JT file owner
when the create_or_update_bbox_and_tso command runs.
VALID
VALUES
False TSO (TruShape data) files are stored in the JT file owner’s
volume.
True TSO (TruShape data) files are not stored in the JT file owner’s
volume.

PLM00026 11.2 Preferences and Environment Variables Reference 21-175


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
VALUE
False
DEFAULT
PROTECTION
SCOPE
Site preference.

QS_SPATIAL_ENABLED

DESCRIPTION
Enables or disables spatial searches (for example, proximity or box searches) within
the cacheless search mechanism. If spatial searches are disabled, the user can still
make attribute searches.
VALID
VALUES
true Enables spatial searches.
false Disables spatial searches.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

QS_TRUSHAPE_GENERATION_ENABLED

DESCRIPTION
Enables or disables the generation of TruShape data needed by the cacheless spatial
search mechanism. This preference is initially set by the Teamcenter Environment
Manager (TEM) during installation, according to the cacheless search options selected.
VALID
VALUES
true Enables the generation of TruShape data needed by the
cacheless spatial search mechanism.
false Disables the generation of TruShape data needed by the
cacheless spatial search mechanism.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
During installation, you can choose to deactivate the generation of TruShape data.
Enabling generation incurs a processing overhead while Teamcenter creates the

21-176 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

necessary secondary data. If you have a large amount of legacy data, creation may
take an appreciable time.
This preference should be set to False if you use the Teamcenter Integration for NX,
as TruShape files are automatically saved in the NX datasets. (You must also explicitly
configure NX to save TruShape data.)
RESTRICTIONS
If creation is disabled during upgrade, Teamcenter does not generate the secondary
data and users are unable to perform cacheless spatial searches. Warning messages
may also be generated during other types of search.

QS_BBOX_GENERATION_ENABLED

DESCRIPTION
Enables or disables the generation of bounding box data needed by the cacheless
spatial search mechanism. This preference is initially set by the Teamcenter
Environment Manager (TEM) during installation, according to the cacheless search
options selected.
VALID
VALUES
true Enables the generation of bounding box data needed by the
cacheless spatial search mechanism.
false Disables the generation of bounding box data needed by the
cacheless spatial search mechanism.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
During installation, you can choose to deactivate the generation of bounding box
data. Enabling generation incurs a processing overhead while Teamcenter creates
the necessary secondary data. If you have a large amount of legacy data, creation
may take an appreciable time.
This preference should be set to False if you use the Teamcenter Integration for NX,
as bounding boxes are automatically generated from the NX bounding box forms.
RESTRICTIONS
If creation is disabled during upgrade, Teamcenter does not generate the secondary
data and users are unable to perform cacheless spatial or box zones searches.
Warning messages may also be generated during other types of search.

QS_BBOX_GENERATION_FROM_NX_ENABLED

DESCRIPTION
Enables or disables the generation of bounding box data from the UGPART-BBOX
form of an NX dataset.

PLM00026 11.2 Preferences and Environment Variables Reference 21-177


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

VALID
VALUES
true Enables the generation of bounding box data needed by the
cacheless spatial search mechanism.
false Disables the generation of bounding box data needed by the
cacheless spatial search mechanism.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

QS_MAX_CHILDS_TO_PROCESS_IN_BOTTOMUP

DESCRIPTION
Tells the search engine how many unconfigured lines can be kept in the stack before
the system reverts to the top-down approach.
Note

The preference value should be set after considering the size of the structure
and the number of revison of the items in it. The preference allows you to tune
the performance of attribute searches. If the number of lines encountered while
traversing the structure exceeds the number set in this preference, the search
switches to the top-down approach. Siemens PLM Software recommends that
you test different values based on specific structure content to find the best
performance. If you are working on large structures and searching for small set
of items that are not widely used, the bottom-up traversal approach results in
the best performance. You must adjust/increase this preference value so that
the bottom-up queries do not get timed-out.

Note

This preference works only when bottom-up approach for search is used.

VALID
VALUES
Positive integer.
Specifies the number of unconfigured lines to keep in the stack.
DEFAULT
VALUES
50000
DEFAULT
PROTECTION
SCOPE
All.
RESTRICTIONS
This preference works only when bottom-up approach is used.

21-178 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

QS_MAX_QUERY_EXECUTION_TIME_FOR_BOTTOMUP

DESCRIPTION
Defines a maximum time for each query to execute and return results. This preference
is effective only when you use bottom-up searches. Set a value that prevents slow
queries from adversely affecting system performance.
VALID
VALUES
Any value in milliseconds.
DEFAULT
VALUE
500
DEFAULT
PROTECTION
SCOPE
Site preference.

QS_NX_RELATION_POST_ACTION_ENABLED

DESCRIPTION
Determines if Teamcenter generates bounding box data automatically when you import
NX assemblies. This preference is effective both for product-scoped cacheless search
and full database cacheless search.
VALID
VALUES
true Teamcenter generates bounding box data for imported NX
assemblies.
false Teamcenter does not generate bounding box data for imported
NX assemblies.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

QS_remote_master_site

DESCRIPTION
Specifies one or more remote sites at which the cacheless search engine executes
searches. Only set this preference if you use cacheless searches in a Multi-Site
Collaboration environment.
VALID
VALUES
One or more key value pairs, each comprising a product ID and its owning master
site, for example:
Product2:remote site2
Product3:remote site 3

PLM00026 11.2 Preferences and Environment Variables Reference 21-179


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
VALUES
DEFAULT:site_name

Note

Ensure you specify a name for the default remote site, which is always searched.

DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
• Siemens PLM Software recommends that only the site administrator modifies
this preference.

• You can specify multiple values in this preference and each value identifies a
different site at which product top levels are owned or replicated. However, for
an individual search, the system only queries a single remote site, depending on
the selected product.

• This preference may be overridden by the QS_remote_master_site_override


user preference.

QS_remote_master_site_override

DESCRIPTION
Allows the user to identify a preferred remote site at which the cacheless search
engine executes searches. Only set this preference if you use cacheless searches in
a Multi-Site Collaboration environment.
VALID
VALUES
A single key value pair comprising a product ID and its owning master site, for
example, ABC00005:site1.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
This user preference overrides the setting of the QS_remote_master_site site
preference.

QS_START_CIRCULAR_STRUCTURE_CHECK_SIZE

DESCRIPTION
Enables or disables checking for circular structures (cycles) during cacheless searches.

21-180 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

VALID
VALUES
1 Enables checking for circular structures during cacheless
searches in Structure Manager or DesignContext.

0 Disables checking for circular structures during cacheless


searches in Structure Manager or DesignContext.
DEFAULT
VALUE
0
DEFAULT
PROTECTION
SCOPE
User preference.

RDV_QSEARCH_REFINE

DESCRIPTION
Enables the use of TruShape data to refine DesignContext searches. This preference
applies only if you use the cacheless search engine. Users can select the Refine
Cacheless Search→Use True Shape Search user option to change this setting
for their own searches.
VALID
VALUES
true Spatial searches in DesignContext use TruShape and bounding
box data.

false Spatial searches in DesignContext use bounding box data, not


TruShape data.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
All.

RDV_QSEARCH_REVISION_RULE_NAMES

DESCRIPTION
Specifies the names of preferred revision rules for DesignContext searches. This
preference applies only if you use the cacheless search engine.
VALID
VALUES
Accepts a single string as a value. The string contains one or more valid revision
rule names.
DEFAULT
VALUES
None

PLM00026 11.2 Preferences and Environment Variables Reference 21-181


Chapter
Chapter 21:21:Product
Product structure
structure preferences
preferences

DEFAULT
PROTECTION
SCOPE
All.

RDV_QSEARCH_STREAMING_MODE

DESCRIPTION
Specifies how the third screen of DesignContext is updated with search results. This
preference applies only if you use the cacheless search engine.
VALID
VALUES
true Teamcenter updates the tables in streaming mode. The user
can interrupt the update process at any time.
false Teamcenter updates the tables only when all the search results
are available. The user cannot interrupt the update process.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

StructureManagerIncludeSubComponentsForSpatialSearch

DESCRIPTION
Specifies if a proximity search of a selected subassembly considers the components of
the subassembly.
VALID
VALUES
true The proximity search includes the selected subassembly and
all its components as targets.
false The proximity search includes only the selected subassembly
as the target, not any of its components. For example, use
this setting if you want to search for parts in the vicinity of
geometry at the assembly level (for example, in the case of
wire harnesses).
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

21-182 Preferences and Environment Variables Reference PLM00026 11.2


Product structure preferences

TC_qsearch_remote_query_timeout

DESCRIPTION
Specifies a timeout period for remote cacheless search queries initiated from the
Structure Manager application. Set a value that prevents slow queries from affecting
system performance.
VALID
VALUES
Any value in seconds.
DEFAULT
VALUE
3600
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 21-183


Chapter 22: Manufacturing preferences

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


Baseline_omitted_occurrence_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-1
controllingOccsForProcessConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-1
ME_reuse_assm_xform_precision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-2
ME_reuse_override_immediate_context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-2
ME_reuse_use_absxform_id_for_multiple_align . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-3
ME_UNCONFIGURED_ASSIGNED_OCCURRENCES_DEFAULT_VALUE_ON_EXPORT
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-3
MEAlignedPropertiesList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-4
MEAlignedPropertiestoExcludeFromDetection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-4
MEAlignedPropertiestoExcludeFromInitialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-5
MEAlignedPropertiestoExcludeFromSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-5
MEAlignmentCheckReportLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-6
MEAlignmentCheckReportDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-6
MEAlignmentCheckReportStylesheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-6
MEAssignAttachmentContext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-7
MEAssignAttachmentAndRelationToUseInCopyRule . . . . . . . . . . . . . . . . . . . . . . . . . . 22-7
MEAssignCustomizedOccurrenceType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-8
MEAssignProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-9
MEConfiguringStructuresMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-9
MEConsiderFlowsOnReSequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-10
MEIncrementalChangeMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-11
MEManufacturingDefaultBVR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-11
MEMBOM_Mirror_MakeRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-11
MEMBOM_Mirror_ReplaceMakeOnChange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-12
MEMBOM_Mirror_RemoveLineWithIDIC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-12
MEMBOM_Mirror_IDICOnChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-13
MEMBOM_TypePrefixSuffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-14
MEOccTypeConsumed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-14
MERelationTypePartsDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-14
MERelationTypeUsedEquipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-15
MERelationTypePartsAssigned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-16
MERelationTypePartsConsumed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-16
MERelationTypePartsHandled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-17
MERelationTypePartsAssembled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-17
MERelationTypePartsDisassembled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-17
MERelationTypePartsOtherAssigned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-18
MERelationTypePartsFeature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-18
MESaveAsSC_PasteType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-19
MEStockAbleBomLinePropertyName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-19
MESyncOccGroupconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-20
MEValidStockAbleValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-20
Mfg0BvrProcess_AffectedChildrenProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-20

PLM00026 11.2 Preferences and Environment Variables Reference


MPP_DefaultCandidateSearchCriteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-21
MPP_BrokenLinkSearchCriteriaList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-22
MSE_ICS_default_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-22
PLMXML_Pre_Expand_BOP_Rule_Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-22
ReportXMLGenerationRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-23
Rollup_Variant_Optimized_Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-25
TC_CRF_overwrite_existing_dataset_content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-25
tm0tsm_ActivityReport.XSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-25
tm0tsm_TestResultStatus.COLORS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-26
tm0tsm_TestCases.ROOTFOLDER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-27
2D_Viewer_default_load_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-27
typeAndRuleForProcessConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-27

Display preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-30


FindCheckedOutColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-30
FindCheckedOutColumnsShownWidthPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-31
TC_ContextMenuSuppression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-31
MEActiveParentColorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-31
MEAttachmentPanelEnableRefreshChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-32
MEBlankDisplayTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-33
MEExpandFirstLevelOnLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-33
MEExpandToSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-34
MEHideChangesIconsForAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-34
MELineLinkedIconsProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-35
MEMaxOpenViewsSameType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-36
MEPerspectiveMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-36
MESecondStructurePosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-38
MEShowConfigurationHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-38
MEShowSuppressedOccsDefaultState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-38
MEShowUnconfiguredAssignedOccurrencesDefaultState . . . . . . . . . . . . . . . . . . . . . . 22-39
MEShowUnconfiguredOccurrencesEffectivityDefaultState . . . . . . . . . . . . . . . . . . . . . . 22-39
MEShowUnconfiguredChangesDefaultState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-40
MEShowUnconfiguredVariantsDefaultState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-40
MSE_load_related_product_process_plant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-41
TC_show_checkout_objects_on_exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-41

In-process assembly preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-42


MEDynamicIPARemoveOccTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-42
MERelationTypeAssemblyTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-42
TCVIS_Check_For_Duplica . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-42
TCVIS_Keep_Duplica_Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-43
TCVIS_Show_Consumed_Part_Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-43

Custom Process View preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-44


Mfg0BvrProcess.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-44
Mfg0BvrOperation.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-44
MECustomViewChildLinesColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-45
MECustomViewConsumedItemsColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . 22-45
MECustomViewConsumedItemsColumnWidthPref . . . . . . . . . . . . . . . . . . . . . . . . . . 22-46
MECustomViewChildLinesCommandNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-46

Preferences and Environment Variables Reference PLM00026 11.2


MECustomViewConsumedItemsCommandNames . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-47
MECustomViewConsumedItemsOccTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-47

In-context ID preferences . . . . . . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-48


MECopyIdInContextToAssignedLine . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-48
MECopyIdInContextLowerLevels . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-48
MECreateIdInContextforAssignedchildlines ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-49
MEIdGenerationPropertySetting . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-49
ME_angular_tolerance . . . . . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-50
ME_translation_tolerance . . . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-51
MEIdGenerationOnAssignEnabled . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-51
MEIdGenerationAllowDuplicates . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-52
MEPostAssignIDICMaker . . . . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-52

Cloning preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-53


Clone_Pending_Release_Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-53
Clone_Secured_Release_Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-53
Item.Item.PasteDuplicateTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-53
MEOP.MEProcess.PasteDuplicateTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-54
MEProcess.MEProcess.PasteDuplicateTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-55
MEWorkarea.MEWorkarea.PasteDuplicateTemplate . . . . . . . . . . . . . . . . . . . . . . . . . 22-55
PasteDuplicateTemplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-56
Plant.Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-57
Plant.Template.Cloning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-57
Process.Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-58
Process.Template.Cloning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-58
Process.Template.Ignoring_Consumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-59
Process.Template.Mapping_Consumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-60
Process.Template.Referencing_Consumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-61
Product.Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-62
Product.Template.Cloning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-62
TC_ignore_project_info_on_clone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-63

PERT chart preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-63


PertChart.<object_type>.BGColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-63
PertChart.<object_type>.Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-64
PertChart.AutoSizeMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-65
PertChart.BoxAutoSizeMaxWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-65
PertChart.BoxDefaultWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-66
PertChart.BoxDefaultHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-66
PertChartCreationLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-66

Accountability check preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-67


DefaultAccountabilityCheckProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-67
AdditionalAccountabilityCheckProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-68
AccountabilityCheckReportStylesheetName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-68
MEAccountabilityCheckSourceStructureExpansionFilterRules . . . . . . . . . . . . . . . . . . . 22-69
MEAccountabilityCheckTargetStructureExpansionFilterRules . . . . . . . . . . . . . . . . . . . 22-69
MEAccountabilityCheckEnableFilteringRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-70
MEAccountabilityCheckEnableNetEffectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-70

PLM00026 11.2 Preferences and Environment Variables Reference


MEAccountabilityCheckParentDelimiterInHierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . 22-71
MEAccountabilityCheckPropertiesInHierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-71
MEAccountabilityCheckPropertyDelimiterInHierarchy . . . . . . . . . . . . . . . . . . . . . . . . . 22-71
MEAccountabilityCheckReportProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-72
MEAccountabilityCheckSettings.<structureType>.<structureType> . . . . . . . . . . . . . . . . 22-72
MEAccountabilityMarkBrokenLinksClosureRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-73
MEAccountabilityMarkBrokenLinksColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-73
MEAccountabilityMarkBrokenLinksCountTrigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-74
MEAccountabilityMarkInBaseViewColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-74
MEResultViewSourceColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-75
MEResultViewSourceColumnsShownWidthPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-75
MEResultViewTargetColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-76
MEResultViewTargetColumnsShownWidthPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-76
MEAccountabilityCheckAllowableReturnedLines . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-76
MEAdditionalPropagatableProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-77
MEAccountabilityCheckIncludedActivityProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-77
MEAccountabilityCheckMappedAttrGrpsForComparison . . . . . . . . . . . . . . . . . . . . . . . 22-78
MEAccountabilityCheckMappedAttrGrpsForPropagation . . . . . . . . . . . . . . . . . . . . . . . 22-78

Manufacturing studies preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-79


CC_ExtraPLMXMLInstanceAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-79
CopyPasteTemplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-80
MEProcess.Mfg0MESimStudy.CopyPasteTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . 22-80
MEOP.Mfg0MESimStudy.CopyPasteTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-81
Mfg0MEPlantBOP.Mfg0MESimStudy.CopyPasteTemplate . . . . . . . . . . . . . . . . . . . . . 22-82
Mfg0MEStudy_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-82
Mfg0MEStudy_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-83
StudyAllowedTemplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-83
StudyTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-84
StudyEventBasedPublishRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-84
StudyEventBasedSyncRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-86
StudyTimeBasedPublishRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-87
StudyTimeBasedSyncRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-89

Time management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-90


MEAvailableTimeUnits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-90
MECurrentTimeUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-91
METimeTabFilteredComponents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-91
MEOperationActivitiesFilteredComponents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-92
MEActivityTypeColors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-92
MEDefaultActivityType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-93
METimesActivityShownColumns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-93
METimesActivityShownColumnWidths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-94
METimeAnalysisReportDefinitionID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-94
MEAllocatedTimeReportDefinitionID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-94
METimeAnalysisReportStylesheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-95
MEAllocatedTimeReportStylesheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-95
METimeDataCardPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-96
METimeDataCardConversionFactor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-96
METIMEAllocatedTimePopulationMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-96

Preferences and Environment Variables Reference PLM00026 11.2


METIMEPopulateAllocatedTimeUsedSources . . . . .... . . . . . . . . . . . . . . . . . . . . . . 22-97
METIMEPopulateAllocatedTimeUpToLevelEnabled .... . . . . . . . . . . . . . . . . . . . . . . 22-98
METIMEPopulateAllocatedTimeUpToLevel . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . 22-98
METIMEPopulateAllocatedTimeZeroValuesEnabled ... . . . . . . . . . . . . . . . . . . . . . . 22-99
METimeSystemWebServiceLocation . . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . 22-99
METimeSystemSearchCriterionFields . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . 22-100
METimeSystemSearchResultFields . . . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . 22-100
METimeSystemUpdateIncludeStructure . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . 22-101
METimeSystemUpdateStructureLevel . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . 22-102
METimeSystemFieldMappingDataset . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . 22-102
MEActivityCustomTimeProperties . . . . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . 22-103

Logistics planning preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-103


MEPlantRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-103
MEPlantRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-103
MEPlantRevision_CompanyLocation_default_relation . . . . . . . . . . . . . . . . . . . . . . . 22-104
MEPlantRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-104

Manufacturing documentation preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-105


AppInterface_TCPublishingTechnicalPortfolio_default_relation . . . . . . . . . . . . . . . . . 22-105
AppInterface_TCPublishingTechnicalPortfolio_shown_relations . . . . . . . . . . . . . . . . . 22-105
IMAN_MEWorkInstruction_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-106
IMAN_PortfolioConfiguredPage_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . 22-106
IMAN_PortfolioPage_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-107
IMAN_PublishingPageAssetContext_relation_primary . . . . . . . . . . . . . . . . . . . . . . . 22-107
IMAN_TCPublishedPortfolio_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-108
ItemRevision_TCPublishingPage_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . 22-108
<TC Publishing Page type>_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . 22-109
<TC Publishing Technical Portfolio type>_DefaultChildProperties . . . . . . . . . . . . . . . . 22-109
ME3DPDFAllowedImageDatasetTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-109
ME3DPDFAllowedReportTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-110
ME3DPDFEncodingTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-111
ME3DPDFReportDatasetType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-111
TCPUBLISH_BATCH_CLASSES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-112
TCPUBLISH_BATCH_ROLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-112
TCPUBLISH_BATCH_<role>_PAGE_TEMPLATE_FAVORITES . . . . . . . . . . . . . . . . 22-113
TCPUBLISH_BATCH_<role>_PORTFOLIO_TEMPLATE_FAVORITES . . . . . . . . . . . . 22-113
TCPUBLISH_BATCH_<role>_TEMPLATES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-113
TCPublish_synchronized_asset_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-113
TCPublishing_Activities_Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-114
TCPublishing_Aliases.Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-114
TCPublishing_Aliases.IMAN_MEWorkInstruction . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-115
TCPublishing_Default_Alias_File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-115
TechnicalPortfolioRoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-116
TechnicalPortfolioTransferMode_IMAN_MEWorkInstruction . . . . . . . . . . . . . . . . . . . 22-116
VisAssetPopulatedByEndobj_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-116

Manufacturing search preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-117


ME_Proximity_search_result_occ_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-117
ME_Proximity_search_result_occ_group_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-117

PLM00026 11.2 Preferences and Environment Variables Reference


ME_Proximity_FilteredIPA_root_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-117
ME_Proximity_FilteredIPA_suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-118
MEAdvancedSearchResultsViewColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . 22-118
MEAdvancedSearchResultsViewColumnsShownWidthPref . . . . . . . . . . . . . . . . . . . . 22-119

Enterprise BOP preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-119


MEDisplayOnAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-119
MEGenericBopContextColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-119
MEProductBopContextColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-120
MEGenericBopContextPartitionColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . 22-120
MEProductBopContextPartitionColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . 22-121
MEProductBopContextPartitionColumnsShownWidthsPref . . . . . . . . . . . . . . . . . . . . 22-121
MEAssignmentIndicationDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-121
MEAssignmentIndicationGraphicsMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-122
MEAssignmentIndicationTransparencyValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-122
MEAssignmentStateBypassICForStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-122
MEAssignmentStateEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-123
MEAssignmentStatesForTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-123
MEAssignmentStateInitial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-124
MERetainResolvedParts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-124
MEAssignmentsViewColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-125
MEAssignmentsViewColumnsShownWidthPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-125
MELogicalDesignatorFormNameSuffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-126
MELogicalDesignatorDelimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-126
GenericBOPTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-126
ProductBOPTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-127
GenericBOPAllowedTemplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-128
ProductBOPAllowedTemplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-128
MEGenericBOP.MEGenericBOP.PasteDuplicateTemplate . . . . . . . . . . . . . . . . . . . . . 22-129
MEGenericBOP.MEProductBOP.PasteDuplicateTemplate . . . . . . . . . . . . . . . . . . . . . 22-129
MEProductBOP.MEProductBOP.PasteDuplicateTemplate . . . . . . . . . . . . . . . . . . . . . 22-130
MEProductBOP.MEGenericBOP.PasteDuplicateTemplate . . . . . . . . . . . . . . . . . . . . . 22-131
PasteDuplicateTemplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-131
PasteDuplicateAllowedPlantBOPTemplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-132
MEGenericBOP.Mfg0MEPlantBOP.PasteDuplicateTemplate . . . . . . . . . . . . . . . . . . . 22-133
MEProductBOP.Mfg0MEPlantBOP.PasteDuplicateTemplate . . . . . . . . . . . . . . . . . . . 22-133
Mfg0MEPlantBOP.Mfg0MEPlantBOP.PasteDuplicateTemplate . . . . . . . . . . . . . . . . . . 22-134
Mfg0MEPlantBOPRevisionColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-135
Mfg0MEPlantBOPRevisionDisplayNameColumnsShownPref . . . . . . . . . . . . . . . . . . 22-135
Mfg0MEPlantBOPRevisionShownColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . 22-135
Mfg0MEPlantBOPRevisionOccGroupColumnsShownPref . . . . . . . . . . . . . . . . . . . . . 22-136
Mfg0MEPlantBOPRevisionOccGroupDisplayNameColumnsShownPref . . . . . . . . . . . 22-136
Mfg0MEPlantBOPRevisionOccGroupShownColumnWidthsPref . . . . . . . . . . . . . . . . . 22-137
MEProcessIconPropertyNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-137
MEOperationIconPropertyNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-138
MEAllocationLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-138
ProductBOPAllocationCloningRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-139
ProductBOPAllocationTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-139
PlantBOPAllowedTemplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-140
PlantBOPTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-140

Preferences and Environment Variables Reference PLM00026 11.2


GANTT chart viewer preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-141
MEGANTTElementHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-141
MEGANTTElementRGBfillColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-141
MEGANTTDefaultDisplayMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-142
MEGANTTDefaultDurationTimeMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-142
MEGANTTDefaultEditMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-142
MEGANTTDefaultMarkedColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-143
MEGANTTDefaultDurationTimeColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-143
MEGANTTDefaultFlowColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-144
MEGANTTMarkedFlowColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-144
MEGANTTimplicitFlowColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-144
MEGANTTPropagateDurationUpToLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-145
MEGANTTPropagateDurationUpToLevelEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . 22-145

Manufacturing features preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-146


ArcWeldRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-146
ArcWeldRevision_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-146
MEAPCSearchType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-147
MEImportMFGsManufacturingFeatureIdAttributeName . . . . . . . . . . . . . . . . . . . . . . . 22-148
MEImportMFGsPartIdAttributeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-148
Mfg0TCContextFeatureFormRel_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . 22-148
MEMFGDisplayName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-149
MEMFGView_AssignmentFilterDefaultValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-149
MEMFGViewDisplayNameColumnShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-150
MEMFGViewShownColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-150
MEMFGViewSubPanelColumnShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-151
MEMFGViewSubPanelShownColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . 22-151
MENEWMFG_DefaultJTDatasetNameForSpecificWeldType . . . . . . . . . . . . . . . . . . . 22-151
MENEWMFG_DefaultWeldPointJTDatasetName . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-153
MENEWMFG_DefaultDatumJTDatasetName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-153
MENEWMFG_LastJTFilePathBrowsed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-153
MEShowWeldPointsConnectedToConfiguredOutParts . . . . . . . . . . . . . . . . . . . . . . . 22-154
ProcessStationForAutomatedMfgAssignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-154
WeldTimeForAutomatedMfgAssignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-155

Standard text preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-155


Mes0TWiRefInfoRelation_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-155
MEWiWorkInstructionTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-155
MEWiStandardTextTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-156
MEWiPreviewFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-156
MEWiDcdNotEditableProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-157
MEWiEnableAddSymbolCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-158
METWICreateTextControlsOnSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-158

Product and manufacturing information (PMI) preferences . . . . . . . . . . . . . . . . . . . . . . . 22-159


Mci0PMIImportNxToTcPMIIDPropertyMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-159
Mci0PMIImportNxToTcPropertiesMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-159
Mci0PMI_Details_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-160
Mci0PMI_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-160
Mci0PMI_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-160

PLM00026 11.2 Preferences and Environment Variables Reference


Mci0PMIXmlRel_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-161

Process Simulate preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-161


MEDataSetsToBeCheckoutForProcessSimulate . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-161
MEFormsToBeCheckoutForProcessSimulate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-162
MEReportColumnsForProcessSimulate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-162
MEReportColumnWidthForProcessSimulate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-163
PLMXML_pre_expand_bop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-163
PLMXML_pre_expand_max_line_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-164
PLMXML_pre_expand_batch_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-164

Line balancing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-164


MEConstraintsViewAutomaticLayoutOffAppendPositionPref . . . . . . . . . . . . . . . . . . . 22-164
MEConstraintsViewDefaultAutomaticLayoutModePref . . . . . . . . . . . . . . . . . . . . . . . 22-165
MEConstraintViewPreloadedPredecessorLevels . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-165
MEConstraintViewPreloadedSuccessorLevels . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-166
MELBBalancingOverviewReportID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-166
MELBBalancingOverviewStylesheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-167
MELBChartColors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-167
MELBChartDnDSourceTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-170
MELBChartDnDTargetParentTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-170
MELBChartProcessOperationTypeDefaultValues . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-171
MELBChartProcessOperationTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-171
MELBChartStationNameDisplayPattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-172
MELBChartStationTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-173
MELBConstraintsConsistencyReportID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-173
MELBConstraintsConsistencyStylesheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-174
MELBConstraintsViolationReportID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-174
MELBConstraintsViolationStylesheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-174
MELBLineDetailReportID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-175
MELBLineDetailStylesheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-175
MEProcessResourcesViewDisplayNameColumnsShownPref . . . . . . . . . . . . . . . . . . 22-176
MEProcessResourcesViewColumnsShownWidthPref . . . . . . . . . . . . . . . . . . . . . . . . 22-176
TWP.AppearanceColors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-177
TWP.BoundariesMargin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-178
TWP.ExecutionPosition.Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-178
TWP.Operation.Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-178
TWP.ProcessLine.Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-179
TWP.Station.Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-179
TWP.StationAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-180
TWP.StationDefaultSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-181
TWP.Tooltips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-181
TWP.VisibilityOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-182

MES Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-182


AppInterface_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-182
AppInterface_shown_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-183
MEMESAutomaticDeltaReleaseDecision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-183
MEMESEnableModifiedReviseBehavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-184
MEMESEnableReleaseToProduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-184

Preferences and Environment Variables Reference PLM00026 11.2


MEMESGenerateWIRepFiles_Trans_Batch_Interval . . . . . . . . . . . . . . . . . . . . . . . . 22-184
MEMESGenerateWIRepFiles_Trans_Continue_On_Error . . . . . . . . . . . . . . . . . . . . . 22-185
MEMESGenerateWIRepFiles_Trans_DebugMode . . . . . . . . . . . . . . . . . . . . . . . . . . 22-185
MEMESGenerateWIRepFiles_Trans_Log_Folder . . . . . . . . . . . . . . . . . . . . . . . . . . 22-186
MEMESGenerateWIRepFiles_Trans_Wait_Time . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-186
MEMESPendingReleaseStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-186
MEMESProductionChangeObjectTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-187
MEMESProductionProblemRevisionRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-187
MEMESProductionSearchChangeObjectColumnsNames . . . . . . . . . . . . . . . . . . . . . 22-187
MEMESProductionSites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-188
MEMESProductionSolutionRevisionRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-188
MEMESProductionUpdateWorkflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-188
MEMESProductionWorkflowAndApplicationInterfaceType . . . . . . . . . . . . . . . . . . . . . 22-189
MEMESReleaseExportTransferMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-189
MEMESReleasedStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-189
MEMESReleaseStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-190
MEMESReleaseToProductionExportTransferMode . . . . . . . . . . . . . . . . . . . . . . . . . 22-190
MEMESReleaseToProductionImportTransferMode . . . . . . . . . . . . . . . . . . . . . . . . . . 22-191
MEMESReleaseTraversalClosureRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-191
MEMESProductionSites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-191
MEMESUpdateWorkflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-192
MEMESURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-192
MEMESWorkflowAndApplicationInterfaceType . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-193
MEMESWorkInProgressReleaseStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-193
MEWiWorkInstructionMacroTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-193
MEMESWorkAreaAssignedValidationObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-194
MES_3DPDF_UPDATE_WORKFLOW_BATCH_INTERVAL . . . . . . . . . . . . . . . . . . . 22-194
MES_3DPDF_UPDATE_WORKFLOW_CONTINUE_ON_ERROR . . . . . . . . . . . . . . . 22-195
MES_3DPDF_UPDATE_WORKFLOW_LOG_FOLDER . . . . . . . . . . . . . . . . . . . . . . 22-195
MES_3DPDF_UPDATE_WORKFLOW_WAIT_TIME . . . . . . . . . . . . . . . . . . . . . . . . 22-196
RequestObject_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-196
RequestObject_shown_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-196

Manufacturing 4D planning preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-197


ME4DSearchCriteriaDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-197
ME4DProcessStartDateFromTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-197
ME4DResultsViewColumnsWidthPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-198
ME4DResultsViewDisplayNameColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . 22-198
ME4DRelationTypePartsConsumed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-199

PAD preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-199


MEPSDTableShownColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-199
MEPSDTableColumnsShownPref.SORTING_COLUMN . . . . . . . . . . . . . . . . . . . . . . 22-200
MEPADChildTypesPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-200
MEPSDTableColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-201

Resource management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-201


MRMApplicabilitySelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-201
MRMExpandUptoLevelOnLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-202
MRMGTCVendorCatalogRootDir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-202

PLM00026 11.2 Preferences and Environment Variables Reference


MRMItemTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-202
MRMNeutralCSYSPrefixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-203
MRMPlugCSYSPrefixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-203
MRMPropagationAlternateAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-204
MRMPropagationRevisionRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-205
MRMSocketCSYSPrefixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-205

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


NX_supported_operation_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-206
TC_NX_FileNewPAXFiles_NX<version> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-206
MEActivityReferenceNonActivityChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-207

Preferences and Environment Variables Reference PLM00026 11.2


Chapter 22: Manufacturing preferences

General manufacturing preferences

Baseline_omitted_occurrence_types

DESCRIPTION
Determines which BOM lines display when building a manufacturing baseline. BOM
lines containing occurrence notes defined in this preference are omitted.
Manufacturing baselines are a convenient method of releasing composition/process
structures whose contents do not change over time.
VALID
VALUES
Accepts multiple strings as values; each string must be a valid occurrence type.
DEFAULT
VALUES
MEResource
Omits all BOM lines containing MEResource occurrence notes from a manufacturing
baseline.
DEFAULT
PROTECTION
SCOPE
Site preference.

controllingOccsForProcessConfiguration

DESCRIPTION
Controls automatic configuration of operations and processes. If no value is set, the
configuration of operations is not affected by the configuration of consumed items.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid occurrence type.
DEFAULT
VALUES
MEConsumed
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-1


Chapter
Chapter 22:22:Related
Related topics
topics

ME_reuse_assm_xform_precision

DESCRIPTION
Sets the precision of transform comparisons in reused assembly. Transform values
with differences smaller than the specified precision are treated as identical when
comparing.
For more information, see Manufacturing Process Planner.
VALID
VALUES
A floating point number.
DEFAULT
VALUE
1e-7
DEFAULT
PROTECTION
SCOPE

Site preference.Related topics

• Create a reused assembly in an MBOM

ME_reuse_override_immediate_context

DESCRIPTION
Sets the top line in the EBOM as the context for finding instances of a single part in
a search.
For more information, see Create a reusable assembly in an MBOM.
VALID
VALUES
0

true

false

DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

22-2 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

ME_reuse_use_absxform_id_for_multiple_align

DESCRIPTION
When creating reused assemblies, if a part does not have an in-context ID, searches
for patterns and automatically aligns parts.
For more information, see Manufacturing Process Planner.
VALID
VALUES
1

DEFAULT
VALUE
This is a hidden preference. You must add it manually using string type, site level.
DEFAULT
PROTECTION
SCOPE
Site preference.

ME_UNCONFIGURED_ASSIGNED_OCCURRENCES_DEFAULT_VALUE_ON_EXPORT

DESCRIPTION
Controls the state of the Show Unconfigured Assigned Occurrences flag for export.
For more information, see Manufacturing Process Planner.
VALID
VALUES
TRUE The Show Unconfigured Assigned Occurrences flag is set
to TRUE, and all the assigned occurrences are shown in the
export.
FALSE The Show Unconfigured Assigned Occurrences flag is set
to FALSE, and the assigned occurrences are hidden when
exporting.
DEFAULT
VALUES
None.
If this preference is not set, Teamcenter behaves as though the value is set to FALSE,
and the assigned occurrences are hidden when exporting.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
The preference is not delivered with Teamcenter. You must create it manually.

PLM00026 11.2 Preferences and Environment Variables Reference 22-3


Chapter
Chapter 22:22:Related
Related topics
topics

MEAlignedPropertiesList

DESCRIPTION
Defines a base list of BOM line properties that Teamcenter considers during the
initialization, comparison, and synchronization of aligned occurrences in the EBOM
and MBOM. Only property values that are available in the current context of the BOM
line are considered; that is, they may be override values.
VALID
VALUES
Any valid BOM line properties.
DEFAULT
VALUES
bl_plmxml_abs_xform
bl_quantity
bl_uom
bl_all_notes
bl_occurrence_type
bl_part_source
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
If Teamcenter should consider all occurrence notes, specify the bl_all_notes property.
The bl_child_item and bl_substitute_list properties may also be specified.
If you add the bl_condition_tag to the list, Teamcenter aligns classic variant
conditions between the EBOM and MBOM. This allows you to configure the MBOM
with the options defined on the EBOM.
The bl_variant_condition property is not supported for alignment because it is
intended for use with modular variants. You cannot configure the MBOM in the context
of the EBOM if you are working with modular variants.
RESTRICTIONS
Teamcenter uses the properties specified in this preference during synchronization
actions. Any property that Teamcenter cannot set in the BOM Line column may not
synchronize correctly. The bl_child_item and bl_substitute_list properties are
exceptions to this restriction.

MEAlignedPropertiestoExcludeFromDetection

DESCRIPTION
Defines a list of BOM line properties that are not compared when aligning occurrences
in the EBOM and MBOM.
VALID
VALUES
Any valid BOM line properties.
DEFAULT
VALUES
bl_uom

22-4 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

bl_all_notes
bl_part_source
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
If Teamcenter should exclude all occurrence notes, specify the bl_all_notes property.

MEAlignedPropertiestoExcludeFromInitialization

DESCRIPTION
Defines a list of BOM line properties that are not copied to the aligned target
occurrence during initialization.
VALID
VALUES
Any valid BOM line properties.
DEFAULT
VALUES
bl_uom
occ_type
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
If Teamcenter should exclude all occurrence notes, specify the bl_all_notes property.

If a property is not specified in the MEAlignedPropertiesList preference, it is ignored.


RESTRICTIONS
Teamcenter uses the ChildItem property during the creation of the target occurrence,
even it is listed in this preference for inclusion.

MEAlignedPropertiestoExcludeFromSync

DESCRIPTION
Defines a list of BOM line properties that are not copied to the aligned target
occurrence during synchronization.
VALID
VALUES
Any valid BOM line properties.
DEFAULT
VALUES
bl_uom
bl_all_notes
bl_part_source
occ_type

PLM00026 11.2 Preferences and Environment Variables Reference 22-5


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
If Teamcenter should exclude all occurrence notes, specify the bl_all_notes property.

MEAlignmentCheckReportLocation

DESCRIPTION
Defines if a persisted EBOM-MBOM alignment report is stored in a dataset in the My
Teamcenter Newstuff folder or if it is attached to the item revision of the top line of
the target window.
VALID
VALUES
0 The alignment check report is stored in the Newstuff folder.
1 The alignment check report is stored on the item revision of the
top line of the target window.
DEFAULT
VALUE
0
DEFAULT
PROTECTION
SCOPE
User preference.

MEAlignmentCheckReportDefinition

DESCRIPTION
Contains the name of the report definition that controls the creation of the
EBOM-MBOM alignment check report. A default report definition is provided but you
can supply a custom report definition if necessary.
VALID
VALUES
A single character string that contains the name of an existing report definition object.
DEFAULT
VALUE
AlignmentCheckReportDefinition
DEFAULT
PROTECTION
SCOPE
Site preference.

MEAlignmentCheckReportStylesheet

DESCRIPTION
Contains the name of the Microsoft Excel style sheet on which the EBOM-MBOM
alignment check report is based. A default style sheet is provided, but you can supply
a custom style sheet if necessary.

22-6 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
A single character string that contains the name of an existing Microsoft Excel style
sheet.
DEFAULT
VALUE
AlignmentCheckReport.xls
DEFAULT
PROTECTION
SCOPE
Site preference.

MEAssignAttachmentContext

DESCRIPTION
Indicates the context of the in-context attachments after assignment.
VALID
VALUES
TopLine All in-context attachments are copied or referenced (depending on the
value of MEAssignAttachmentAndRelationToUseInCopyRule) to
the target structure in the context of the top line of the target structure.
DirectParent All in-context attachments are copied or referenced (depending on the
value of MEAssignAttachmentAndRelationToUseInCopyRule) to
the target structure in the context of the direct parent of the line being
assigned. This is the default value if the preference is not set.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

MEAssignAttachmentAndRelationToUseInCopyRule

DESCRIPTION
Defines the attachment and relation types that are referenced or copied when
assigning from an EBOM to an MBOM.
VALID
VALUES
Accepts one or more strings as values, each string must have the following format:
AttachmentType:RelationType:CopyRule
AttachmentType and RelationType are the internal names of the attachment and
relation types, and CopyRule is either the Copy or Reference rule.
Currently, only Reference is supported.
For example, if you create a custom form and attach it to an object, the Attachments
view is displayed as follows:

PLM00026 11.2 Preferences and Environment Variables Reference 22-7


Chapter
Chapter 22:22:Related
Related topics
topics

The attachment type is Customform, and the relation type is Specifications. To


define the attachment and relation type for this example, the preference has the
following value:
Customform:IMAN_specification:Reference
The internal name of the relation is IMAN_specification. The internal and display
name of the custom form are the same.
DEFAULT
VALUES
None.
If this preference is not set, no attachment is carried over when performing an assign
operation.
DEFAULT
PROTECTION
SCOPE
Site preference.

MEAssignCustomizedOccurrenceType

DESCRIPTION
By default, if a relation (occurrence) type is defined for a BOM line and you assign the
BOM line to a process or operation, Teamcenter assigns it using the same relation
(occurrence) type. Use this preference to configure a different relation (occurrence)
type to apply to assignment, paste, and drag-and-drop actions.
VALID
VALUES
The value format is A.B:C, where:
• A is the item type of a process or operation.
• B is the item type of the assigned BOM line that possesses the occurrence type.
• C is the occurrence type to be used instead.

For example:
MEAssignCustomizedOccurrenceType=
MEProcess.WeldPoint:MEConsumed
MEProcess.DatumPoint:MEConsumed
MEOP.WeldPoint:MEConsumed
MEOP.DatumPoint:MEConsumed
MEMachining.WeldPoint:MEConsumed
MEMachining.DatumPoint:MEConsumed
DEFAULT
VALUES
MEProcess.WeldPoint:MEWeldPoint
MEProcess.DatumPoint:MEConsumed
MEOP.WeldPoint:MEWeldPoint

22-8 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEOP.DatumPoint:MEConsumed
MEMachining.WeldPoint:MEConsumed
MEMachining.DatumPoint:MEConsumed
MEProcess.MEWorkarea:MEWorkArea
MEOP.MEWorkarea:MEWorkArea
MEMachining.MEWorkarea:MEWorkArea
MEProcess.Item:MEConsumed
MEOP.Item:MEConsumed
MEProcess.AppearanceGroup:MEWorkpiece
MEOP.AppearanceGroup:MEWorkpiece
MEProcess.All:MEConsumed
MEOP.All:MEConsumed
MEProcess.MEProcess:Empty
MEProcess.MEOP:Empty
All.All:Empty
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
This preference is updated automatically when you modify the Default Occurrence
Type list on the Manufacturing tab of the preferences Options dialog box.

MEAssignProperties

DESCRIPTION
Specifies BOM line properties that are copied over when assigning from an engineering
bill of materials (EBOM) to a manufacturing bill of materials (MBOM) and from a
product to a process.
For more information, see Manufacturing Process Planner.
VALID
VALUES
Accepts valid internal property names.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

MEConfiguringStructuresMode

DESCRIPTION
Defines what configuring structures mode is used when loading structures into
Manufacturing Process Planner. By default, the loaded composition structures (for
example, processes) are only configured by their related loaded BOM structures.
Examples of related structures are:

PLM00026 11.2 Preferences and Environment Variables Reference 22-9


Chapter
Chapter 22:22:Related
Related topics
topics

• Associated product and plant of a process which were loaded together per the
MSE_load_related_product_process_plant preference.

• Structures contained in a loaded collaboration context.

For more information about configuring structures, see Manufacturing Process Planner.
VALID
VALUES
AllToAll All loaded BOM structures configure all loaded
composition structures.
RelatedStructuresOnly Only the product or plant structures related to a specific
process structure configure it. Examples of related
structures are:
• Associated product and plant of a process
that were loaded together per the
MSE_load_related_product_process_plant
preference.

• Structures contained in a loaded collaboration context


configure processes from the same collaboration
context.

DEFAULT
VALUES
AllToAll
DEFAULT
PROTECTION
SCOPE
Site preference.

MEConsiderFlowsOnReSequence

DESCRIPTION
Specifies the default state of the Consider flows check box in the Re-sequence
dialog box in Manufacturing Process Planner and Part Planner. After the first time you
open the dialog box, the check box state is stored in a cookie.
For more information, see Manufacturing Process Planner or the Part Planner.
VALID
VALUES
true The Consider flows check box is selected.
false The Consider flows check box is cleared.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

22-10 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEIncrementalChangeMode

DESCRIPTION
Specifies whether incremental change is applied per application or per structure in
Manufacturing Process Planner, Part Planner, and Plant Designer.
For more information about enabling incremental change management, see
Manufacturing Process Planner.
VALID
VALUES
application Incremental change works per application. If you set an
incremental change, it is set for all the loaded structures.
structure Incremental change works per structure. If you set an
incremental change, it is relevant only for the selected structure
and for the secondary views connected to the selected structure.
In this mode, each structure can use its own incremental
change.
DEFAULT
VALUES
application
DEFAULT
PROTECTION
SCOPE
Site preference.

MEManufacturingDefaultBVR

DESCRIPTION
Determines which BOM view revision is opened in Manufacturing Process Planner and
Part Planner when more than one BOM view revision is defined in the related product.
If not defined, the BOM view revision first created for the product is opened.
VALID
VALUES
Accepts a single string as value. The string must be a valid BOM view revision. For
example:
Manufacturing
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

MEMBOM_Mirror_MakeRules

DESCRIPTION
When running the me_create_mbom utility, defines the key/value pairs of BOM line
properties and their corresponding values used to determine if a new manufacturing bill
of materials (MBOM) node is to be created for each BOM line that matches the criteria.

PLM00026 11.2 Preferences and Environment Variables Reference 22-11


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts the following format:
KEY:BOM-line-property-internal-name,VALUE:property-value1[|VALUE:property-value2]
If this preference does not contain a value, the item is shared between engineering
BOM (EBOM) and manufacturing BOM (MBOM) structures.
DEFAULT
VALUES
KEY:GCS CP,VALUE:Make|VALUE:Phantom
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMBOM_Mirror_ReplaceMakeOnChange

DESCRIPTION
When running the me_create_mbom utility, enables the replacement of manufacturing
BOM (MBOM) lines that were changed from Make to Buy in the engineering BOM
(EBOM), during the MBOM update from the EBOM.
VALID
VALUES
TRUE Teamcenter replaces the Make part in the MBOM with a Buy
part from the EBOM during the update.
FALSE Teamcenter does not replace the Make part with a Buy part
from the EBOM. It adds the EBOM Buy part to the MBOM
structure without removing the original Make part.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMBOM_Mirror_RemoveLineWithIDIC

DESCRIPTION
Enables the deletion of manufacturing bill of material (MBOM) lines whose in-context
ID (top level) values do not match existing engineering BOM (EBOM) lines during
MBOM update from the EBOM using the me_create_mbom utility.
VALID
VALUES
TRUE Teamcenter deletes the MBOM line if its value does not match
its corresponding EBOM line.
FALSE Teamcenter does not delete any lines based on a mismatch of
in-context ID.

22-12 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMBOM_Mirror_IDICOnChildren

DESCRIPTION
Determines whether the in-context ID (IDIC) is retained on a make part in the MBOM
when updating it using the me_create_mbom utility after changing a make part to a buy
part in the EBOM. When updating, if the MEMBOM_Mirror_ReplaceMakeOnChange
preference is set to false, both the original make part and the buy part exist in
the MBOM after updating. This causes the accountability check to display multiple
matches. Removing the IDIC on the make part ensures that there is only one match
in an accountability check. If the MEMBOM_Mirror_ReplaceMakeOnChange
preference is set to true, the make line is replaced with the buy line from the EBOM
so this preference is irrelevant.
Caution

You must exercise caution when removing an IDIC on any part. This can cause
problems in other areas, for example, if the part is consumed in an process
structure, you lose the link to that line.

This preference is relevant only when the MEMBOM_Mirror_ReplaceMakeOnChange


preference is set to false.
VALID
VALUES
TRUE Teamcenter deletes the IDIC on the MBOM make part and
an accountability check between the EBOM and the MBOM
displays the make part in the MBOM as missing in the source.
FALSE Teamcenter does not delete the IDIC and an accountability
check between the EBOM and MBOM results in multiple
matches.
DEFAULT
VALUES
None. If not set, the default value is FALSE.
DEFAULT
PROTECTION
SCOPE
User preference.
NOTES
By default, this preference is not available. You must create it manually.

PLM00026 11.2 Preferences and Environment Variables Reference 22-13


Chapter
Chapter 22:22:Related
Related topics
topics

MEMBOM_TypePrefixSuffix

DESCRIPTION
Defines the item type created in a manufacturing bill of materials (MBOM) when
running the me_create_mbom utility. It also defines the prefix and suffix for the name
of the item instance.
VALID
VALUES
Accepts the following format:
item-type,prefix,suffix
A comma is used as a separator. The prefix or the suffix are optional.
DEFAULT
VALUES
Item,M_
DEFAULT
PROTECTION
SCOPE
Site preference.

MEOccTypeConsumed

DESCRIPTION
Specifies valid relation (occurrence) types for consumed relations.
VALID
VALUES
An array of strings, where each string represents a relation (occurrence) type.
DEFAULT
VALUES
MEConsumed
UserConsumed
DEFAULT
PROTECTION
SCOPE
Site preference.

MERelationTypePartsDefault

DESCRIPTION
Defines the default assignment type selected in the Assign Parts by Logical
Designator dialog box in Manufacturing Process Planner.

22-14 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
Accepts a valid internal occurrence type name.
DEFAULT
VALUE
MEConsumed
DEFAULT
PROTECTION
SCOPE
Site preference.

MERelationTypeUsedEquipment

DESCRIPTION
Defines the relation (occurrence) types that Teamcenter interprets as tool or equipment
assignments to operations or processes. The values entered in this preference are
displayed in the Create Tool Requirement dialog box in Manufacturing Process
Planner. The first value in the list is displayed as the default occurrence type.

PLM00026 11.2 Preferences and Environment Variables Reference 22-15


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts a list of strings, where each string represents a relation (occurrence) type.
DEFAULT
VALUE
METool
MEResource
MECompoundResource
MEPlantSpecificTool
DEFAULT
PROTECTION
SCOPE
Site preference.

MERelationTypePartsAssigned

DESCRIPTION
Defines the relation (occurrence) types that Teamcenter interprets as product
assignments to processes.
VALID
VALUES
An array of strings, where each string represents a relation (occurrence) type.
DEFAULT
VALUE
MEAssign
DEFAULT
PROTECTION
SCOPE
Site preference.

MERelationTypePartsConsumed

DESCRIPTION
Defines the relation (occurrence) types that Teamcenter interprets as part
consumptions by operations and processes.

22-16 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
An array of strings, where each string represents a relation (occurrence) type.
DEFAULT
VALUE
MEConsumed
DEFAULT
PROTECTION
SCOPE
Site preference.

MERelationTypePartsHandled

DESCRIPTION
Defines the relation (occurrence) types that Teamcenter interprets as part handling
during an operation.
VALID
VALUES
An array of strings, where each string represents a relation (occurrence) type.
DEFAULT
VALUE
MEHandle
DEFAULT
PROTECTION
SCOPE
Site preference.

MERelationTypePartsAssembled

DESCRIPTION
Defines the relation (occurrence) types that Teamcenter interprets as part assembly
during an operation or process.
VALID
VALUES
An array of strings, where each string represents a relation (occurrence) type.
DEFAULT
VALUE
MEAssemble
DEFAULT
PROTECTION
SCOPE
Site preference.

MERelationTypePartsDisassembled

DESCRIPTION
Defines the relation (occurrence) types that Teamcenter interprets as part disassembly
during an operation or process.

PLM00026 11.2 Preferences and Environment Variables Reference 22-17


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
An array of strings, where each string represents a relation (occurrence) type.
DEFAULT
VALUE
MEDisassemble
DEFAULT
PROTECTION
SCOPE
Site preference.

MERelationTypePartsOtherAssigned

DESCRIPTION
Defines the relation (occurrence) types that Teamcenter interprets as other product
actions; that is, actions other than consumption, handling, assembly, and disassembly
for operations and assignment for processes.
VALID
VALUES
An array of strings, where each string represents a relation (occurrence) type.
DEFAULT
VALUE
MEOther
METarget
DEFAULT
PROTECTION
SCOPE
Site preference.

MERelationTypePartsFeature

DESCRIPTION
Defines the relation that indicates a consumed item is a manufacturing feature, for
example, a weld point. You can add custom relations to this preference if you create
them.
VALID
VALUES
An array of strings, where each string represents a relation (occurrence) type.
DEFAULT
VALUE
MEFeatureAssign
MEWeldPoint
DEFAULT
PROTECTION
SCOPE
Site preference.

22-18 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MESaveAsSC_PasteType

DESCRIPTION
Specifies which object in a selected BOM line is pasted as a root when creating a
structure context in Manufacturing Process Planner.
For more information, see Manufacturing Process Planner.
VALID
VALUES
Accepts one of the following values:

• Item

• ItemRevision

• BOMView

• BOMViewRevision

If no BOMViewRevision object exists in the selection and that value is defined in


this preference, Teamcenter uses the ItemRevision object instead. This occurs with
product root BOM lines without children as they do not contain any BOMViewRevision
object. If no BOMView object exists in the selection and that value is defined,
Teamcenter uses the Item object instead.
DEFAULT
VALUE
BOMViewRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

MEStockAbleBomLinePropertyName

DESCRIPTION
Defines the name of the property that is used to determine whether a BOM line
is stockable. Setting this preference is required when working with product and
manufacturing information and effectivity in Manufacturing Process Planner.
For more information, see Manufacturing Process Planner.
VALID
VALUES
Accepts the name of a valid Teamcenter property.
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-19


Chapter
Chapter 22:22:Related
Related topics
topics

MESyncOccGroupconfig

DESCRIPTION
Controls the synchronization of the configurations between the occurrence group
window and the base view.
VALID
VALUES
true When you change the configuration of an occurrence group
tab, Teamcenter immediately applies the same configuration
to the base view.
false Teamcenter copies the configuration from the occurrence group
tab to the base view the next time the base view becomes
visible. This improves performance when working with large
structures in the base view, but other structures linked to the
base view (such as a process structure associated with a
product) are updated only when switching to the base view tab.
DEFAULT
VALUE
true
DEFAULT
PROTECTION
SCOPE
Site preference.

MEValidStockAbleValues

DESCRIPTION
Defines the value of the MEStockAbleBomLinePropertyName property that is used
to determine whether a BOM line is stockable. Setting this preference is required when
working with product and manufacturing information and effectivity in Manufacturing
Process Planner.
For more information, see Manufacturing Process Planner.
VALID
VALUES
Accepts the name of a valid Teamcenter property.
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Mfg0BvrProcess_AffectedChildrenProperties

DESCRIPTION
Defines the list of properties on a process object that are affected if children are
added or removed.

22-20 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Note

This preference is used for internal purposes only. Do not change the value of
this preference.

VALID
VALUES
Accepts one or more strings as values, each string must be a valid Teamcenter
property.
DEFAULT
VALUES

Mfg0sub_elements
bl_rev_ps_children
bl_has_children
bl_child_element
Mfg0successors
Mfg0all_material
Mfg0assigned_material
Mfg0consumed_material
Mfg0used_equipment
bl_child_lines
bl_child_item
bl_occ_child_item
DEFAULT
PROTECTION
SCOPE
User preference.

MPP_DefaultCandidateSearchCriteria

DESCRIPTION
Specifies a default list of properties used to determine candidates containing broken
links that need to be repaired. Candidates are those for which the values of the
specified properties match the values of the broken link's properties.
For more information about reconciling broken links, see Manufacturing Process
Planner.
VALID
VALUES
Set this preference using the following syntax:
logical.property
logical Specifies whether the match is mandatory or optional, meaning
that at least one of the optional property values must match.
Valid values are Mandatory or Optional.
property Specifies any BOM line property.
DEFAULT
VALUES
Mandatory.bl_item_item_id

PLM00026 11.2 Preferences and Environment Variables Reference 22-21


Chapter
Chapter 22:22:Related
Related topics
topics

Caution

Do not remove the default value or incorrect results may be obtained. The
bl_item_item_id property must always be included in the list.

DEFAULT
PROTECTION
SCOPE
Site preference.

MPP_BrokenLinkSearchCriteriaList

DESCRIPTION
Specifies a list of preferences that define candidate search criteria.
VALID
VALUES
Accepts one or more strings as values, each string must be a valid preference name.
DEFAULT
VALUES
MPP_DefaultCandidateSearchCriteria
DEFAULT
PROTECTION
SCOPE
Site preference.

MSE_ICS_default_type

DESCRIPTION
Indicates the default occurrence type when adding resources to processes or
operations. In the Classification Search Dialog, on selection of a classified item, the
system tries to identify the appropriate occurrence type using the source and target
types and referring to the MEAssignCustomizedOccurrenceType preference. If, for
any reason (for example, multiple items selected), the system fails to resolve the
occurrence type to use, it refers to this preference to set the occurrence type.
VALID
VALUES
Accepts a single string as value. The string must be a valid PSEoccurrence type,
such as MEResource, METool, MEConsumed, or MEOther.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLMXML_Pre_Expand_BOP_Rule_Name

DESCRIPTION
Specifies the name of a closure used to pre-expand process structures prior to
a PLM XML export operation in the Manufacturing Process Planner application.

22-22 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Pre-expansion on large structures increases the performance of the command and


reduces the load on the database server. If the preference is not set, no pre-expansion
is done.
For more information, see Administering Manufacturing Planning.
VALID
VALUES
Accepts a valid Teamcenter closure rule. Teamcenter supplies you with the
PreExpandProcess closure rule to perform the pre-expansion.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

ReportXMLGenerationRules

DESCRIPTION
Defines the specific components of a BOM to be included or excluded in an XML report.
VALID
VALUES
The preference syntax contains the following four fields. The primary, secondary,
and relation fields accept an asterisk (*) as a wildcard.
primary: secondary: relation: action
These fields must be set in the following format:
class.name/type.name : class.name/type.name : relation.name/attribute.name :
Ignore/PublishCurrent/PublishChildren/PublishBOM
Latter fields are subservient to former fields, allowing specific primary rules to override
general rules set using wildcards.
The relation.name/attribute.name specification must be one of the following:
• Teamcenter relation type: either a wildcard or a Teamcenter relation type name.

• BOM structure occurrence type: either a wildcard, null entry (for no occurrence
type), or the occurrence type name.

• Folder content: specified with the string contents.

The action setting must be one of the following:


• Ignore: does not publish the specified component.

• PublishCurrent: publishes only the current BOM line or attachment.

• PublishChildren: publishes only the current BOM line or attachment and its
respective children.

PLM00026 11.2 Preferences and Environment Variables Reference 22-23


Chapter
Chapter 22:22:Related
Related topics
topics

• PublishBOM: publishes the entire BOM structure defined by the default revision
rule, with the current component as the top line.

The following examples illustrate valid settings for this preference:


• Publish the entire BOM structure:
*:*:OccType.*:PublishChildren:

• Publish the entire, current, BOM structure, except for any BOM lines containing
the MEConsumed and MEResource occurrence types (The specific rules of the
first two lines override the general rule of the third line.):
*:*:OccType.MEConsumed:PublishCurrent
*:*:OccType.MEResource:PublishCurrent
*:*:OccType.*:PublishChildren

• Publish the entire attachment structure:


*:*:Relation.*:PublishChildren

• Publish the entire attachment structure, except any attachment with a


IMAN_METarget orIMAN_MEWorkArea relation. In the first case, publish the
entire BOM structure with the defined attachment as the top line of the structure.
In the second case, publish only the current attachment without its children. (The
specific rules of the first two lines override the general rule of the third line):
*:*:Relation.IMAN_METarget:PublishBOM
*:*:Relation.IMAN_MEWorkArea:PublishCurrent
*:*:Relation.*:PublishChildren

• Publish the entire attachment structure, and ignore the


TC_NX_nonps_occurrence relation.
*:*:Relation.TC_NX_nonps_occurrence:Ignore

Note

Using this avoids the problem where the PS - BOM


Structure report fails to expand subassemblies. Add the
*:*:Relation.TC_NX_nonps_occurrence:Ignore rule before the
*:*:Relation.*:PublishChildren rule.

DEFAULT
VALUES
*:*:Relation.TC_based_on:Ignore
*:*:Relation.IMAN_RES_checkout:Ignore
*:*:OccType.MEConsumed:PublishCurrent
*:*:OccType.MEResource:PublishCurrent
*:*:OccType.*:PublishChildren
*:*:Relation.IMAN_METarget:PublishChildren
*:*:Relation.IMAN_MEWorkArea:PublishChildren
*:*:Relation.*:PublishChildren
DEFAULT
PROTECTION
SCOPE
Site preference.

22-24 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Rollup_Variant_Optimized_Format

DESCRIPTION
When working with rolled-up variant expressions in Manufacturing Process Planner
or Multi-Structure Manager, defines whether the expressions are optimized. When
variant expressions become too long from the roll-up process, Teamcenter can
optimize them for storage and display.
For more information, see Manufacturing Process Planner.
VALID
VALUES
TRUE Teamcenter optimizes rolled-up variant expressions for storage
and display.
FALSE Teamcenter does not optimize rolled-up variant expressions for
storage and display. This is the default if no value is set.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
This preference is not delivered with the software. You must create it manually.

TC_CRF_overwrite_existing_dataset_content

DESCRIPTION
Determines if a newly generated report, such as the EBOM-MBOM alignment check
report or the time analysis report, replaces the existing contents of the dataset or if it
is appended.
VALID
VALUES
true The newly generated report replaces the existing contents of
the dataset.
false The newly generated check report is appended to the dataset.
DEFAULT
VALUE
true
DEFAULT
PROTECTION
SCOPE
Site preference.

tm0tsm_ActivityReport.XSL

DESCRIPTION
Provides the name of the dataset that contains the XSL style sheet to generate the
HTML report when using the Test Manager view in Manufacturing Process Planner.

PLM00026 11.2 Preferences and Environment Variables Reference 22-25


Chapter
Chapter 22:22:Related
Related topics
topics

For more information, see Manufacturing Process Planner.


VALID
VALUES
Accepts a Test Activity Report XSL (Tm0ReportXSL) dataset type that contains
one Tm0XSL named reference to the XSL file. If Teamcenter does not find this
named reference, the report generation displays an error. You can also provide an
additional Tm0Image named reference to an image file that renders the company logo
in the HTML report header. If you do not provide a Tm0Image named reference, the
generated report does not contain any image in its header.
DEFAULT
VALUES
DefaultTestActivityReportXSL
DEFAULT
PROTECTION
SCOPE
User preference.

tm0tsm_TestResultStatus.COLORS

DESCRIPTION
Provides the rendering color for the test instances in the Search Results table of
the Test Manager view.
For more information, see Manufacturing Process Planner.
VALID
VALUES
Accepts multiple entries, each having the following syntax:
test-result-status:color-name
A colon : is used as the delimiter. The test result status values on the left of
the delimiter must match the internal names defined in the Result Status LOV
(Tm0ResultStatus) and must be either passed or failed. If you do not provide a value
for a given status, Teamcenter uses the default color (black). The color names to the
right of the delimiter must be one of the following: red, green, blue, cyan, yellow, or
gray. Teamcenter ignores any other value and uses the default color (black). Neither
the test result status values nor the color names are case-sensitive (both failed:ReD
and FaiLed:rEd are valid values with identical representation).
DEFAULT
VALUES
passed:green
failed:red
DEFAULT
PROTECTION
SCOPE
User preference.

22-26 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

tm0tsm_TestCases.ROOTFOLDER

DESCRIPTION
Provides the root folder name or path to save and load test cases. You may use a
back slash or a forward slash as the separator to specify the path.
For more information, see Manufacturing Process Planner.
VALID
VALUES
Accepts a folder path with either back or forward slash separators.
DEFAULT
VALUES
DPA/TestCases
DEFAULT
PROTECTION
SCOPE
User preference.

2D_Viewer_default_load_relation

DESCRIPTION
Defines the relation type to be used to locate the default 2D dataset to be loaded in the
2D Viewer tab if multiple 2D datasets exist.
VALID
VALUES
Relation type names, not display names.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.
NOTES
If this preference is not set, the 2D dataset loaded by default is the first 2D dataset in
the attachment list associated with the selected BOM line. If multiple 2D datasets have
this relationship, then the first 2D dataset returned is loaded by default.

typeAndRuleForProcessConfiguration

DESCRIPTION
Configures process or compositions in the bill of process. This preference
specifies what parent types in the process should be configured out
depending on child occurrences of controlling types as defined by the
controllingOccsForProcessConfiguration preference.
You can also use this preference to configure out processes based on child
relationships. If you do this, the controllingOccsForProcessConfiguration
preference is ignored.
For more information about configuring structures, see Manufacturing Process Planner.

PLM00026 11.2 Preferences and Environment Variables Reference 22-27


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts strings separated by a colon as follows:
parent-item-subtype:One | All | AllLoaded |
OneLoaded[OCCType:occurrence-type | CHILD:child-type]

parent-item-subtype
Specifies the item, operation, or process subtype as defined in the Business
Modeler IDE application. This value is case-sensitive and must exactly match
the business object specified in Business Modeler IDE. The second string after
the colon must be one of the following:
One The parent is configured out if any one of its controlling occurrences
is configured out.
All The parent is configured out only if all its controlling occurrences
are configured out.
AllLoaded The parent is configured out only if all its loaded controlling
occurrences are configured out. Loaded occurrences are
occurrences that are referenced from another top line that is defined
as the configuring structure.
This parameter is not relevant for defining child types.
OneLoaded The parent process is configured out if one of its loaded controlling
occurrences are configured out.
This parameter is not relevant for defining child types.
OCCType:occurrence-type | CHILD:child-type
Specifies that the filtering is based on the designated occurrence types or the
designated child types. You can enter multiple occurrence types or multiple
child types separated by a comma. Specifying this optional group of values for
the preference causes the configuration mechanism to ignore the value of the
controllingOccsForProcessConfiguration preference.

The following examples show the preference without the optional parameters.
The explanation of these examples assumes that the value for the
controllingOccsForProcessConfiguration preference is MEConsumed.

MEOP:One Configures out parent operations of MEOP


type if one of the consumed occurrences of
MEConsumed type is configured out.
MEProcess:All Configures out parent operations of MEProcess
if all consumed occurrences of MEConsumed
type are configured out.
MEPSD:AllLoaded Configures out parent operations of MEPSD if all
loaded consumed occurrences of MEConsumed
type are configured out.

22-28 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

The following examples show the preference with the optional parameters:

MEOP:One:OCCType:MEConsumed Configures out parent


operations of MEOP
type if one of the
consumed occurrences
of MEConsumed type is
configured out.
MEOP:All:OCCType:MEConsumed Configures out parent
operations of MEOP type if all
of the consumed occurrences
of MEConsumed type are
configured out.
MEOP:OneLoaded:OCCType:MEConsumed Configures out parent
operations of MEOP
type if one of the loaded
consumed occurrences
of MEConsumed type is
configured out.
MEOP:AllLoaded:OCCType:MEConsumed Configures out parent
operations of MEOP
type if all of the loaded
consumed occurrences of
MEConsumed type are
configured out.
MEOP:All:OCCType:MEAssign Configures out parent
operations of MEOP type
if all of the consumed
occurrences of MEAssign
type are configured out.
MEOP:One:OCCType:MEConsumed,MEAssign Configures out parent
operations of MEOP
type if one of the
consumed occurrences of
MEConsumed or MEAssign
type is configured out.
MEProcess:All:CHILD:MEOP Configures out parent
operations of MEProcess
type if all of the child
occurrences of MEOP type
are configured out.
MEOP:One:OCCType:MEConsumed Configures out parent
operations of MEOP
type if one of the
consumed occurrences
of MEConsumed type is
configured out.

PLM00026 11.2 Preferences and Environment Variables Reference 22-29


Chapter
Chapter 22:22:Related
Related topics
topics

MEProcess:One:CHILD:MEOP Configures out parent


operations of MEProcess
type if one of the child
occurrences of MEOP type is
configured out.
MEPROCESS:All:OCCType:MEConsumed Configures out parent
operations of MEProcess
type if all of the
consumed occurrences
of MEConsumed type are
configured out.

If this preference has no value, parent lines such as operations are not configured out
by their children or consumed objects.
DEFAULT
VALUES
MEOP:One
MENCMachining:One
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
No blank spaces are allowed in the preference value. The preference is case sensitive.

Display preferences

FindCheckedOutColumnsShownPref

DESCRIPTION
Defines the columns displayed in the Find Checked Out Objects dialog box.
VALID
VALUES
Accepts multiple strings as values; each string must be a valid column name.
DEFAULT
VALUES
object_string
object_type
checked_out_change_id
checked_out_date
DEFAULT
PROTECTION
SCOPE
All.

22-30 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

FindCheckedOutColumnsShownWidthPref

DESCRIPTION
Defines the width of the columns displayed in the dialog of the Find Checked
Out Objects command, as defined by the FindCheckedOutColumnsShownPref
preference.
VALID
VALUES
Accepts positive integers. The number of values should be the same as the number of
values in the FindCheckedOutColumnsShownPref preference.
DEFAULT
VALUES
22
18
22
18
DEFAULT
PROTECTION
SCOPE
All.

TC_ContextMenuSuppression

DESCRIPTION
Specifies the name of the Context Menu Suppression dataset containing the
ContextMenuCustomization.xml file that is saved automatically when suppressing
context menu commands for a particular perspective, view, and object type.
For more information about customizing the context menu, see Administering
Manufacturing Planning.
VALID
VALUES
Accepts the name of the Context Menu Suppression dataset containing the
ContextMenuCustomization.xml file.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

MEActiveParentColorPref

DESCRIPTION
Specifies the color to be used as highlighting when displaying an active parent for the
Paste Here command in the structure view.
VALID
VALUES
Accepts a standard supported string, an octal number, or a hexadecimal number. The
standard supported strings are:

PLM00026 11.2 Preferences and Environment Variables Reference 22-31


Chapter
Chapter 22:22:Related
Related topics
topics

black
white
lightGray
gray
darkGray
red
pink
orange
yellow
green
magenta
cyan
blue
The default color is sea green (#50b080).
DEFAULT
VALUES
#50b080
DEFAULT
PROTECTION
SCOPE
User preference.

MEAttachmentPanelEnableRefreshChildren

DESCRIPTION
Specifies whether the Attachments view is updated when a structure is modified.
Note

Setting this preference to true can cause performance problems with very
large structures.

VALID
VALUES
true Teamcenter updates the Attachments view each time a structure is modified.
false Teamcenter does not update the Attachments view automatically. You must
use the Refresh Current Structure menu command to update the view
manually.
DEFAULT
VALUES
None (equivalent to false).
DEFAULT
PROTECTION
SCOPE
All.
NOTES
This preference is not delivered with the software. You must create it manually.

22-32 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEBlankDisplayTypes

DESCRIPTION
Stores commonly used types (item, plant, and occurrence) that you want to display
or blank using the Display by Type or Blank by Type commands in Manufacturing
Process Planner, Part Planner, or Plant Designer. The values you list in this preference
appear in the list of available types in the menu command. You can also set this
preference in the rich client interface by choosing Edit→Options→Manufacturing
and clicking the Graphics tab.
VALID
VALUES
Accepts a list of string values. Each entry in the list must be of the following format:
structure-type:type-name
For example:
Product:Item
Product:WeldPoint
Plant:MEWorkArea
Occurrence:MEConsumed
DEFAULT
VALUES
Product:Item, Product:Part,
Product:WeldPoint, Plant:MEWorkarea,
Plant:MEPlant, Plant:MESite,
Plant:MELine, Occurrence:MEWeldPoint,
Occurrence:MEConsumed, Occurrence:MEOther,
Product:ManufacturerPart, Product:CommercialPart,
Product:ArcWeld, Product:DatumPoint,
Product:PSConnection, Plant:MEDepartment,
Plant:MEStation, Plant:MEProductLocation,
Occurrence:MEAssemble, Occurrence:MEAssign,
Occurrence:MEFeatureAssign, Occurrence:MEHandle,
Occurrence:MEMachineTool, Occurrence:MEResource,
Occurrence:METool, Occurrence:MEWorkArea,
Occurrence:MEWorkPiece
DEFAULT
PROTECTION
SCOPE
User preference.

MEExpandFirstLevelOnLoad

DESCRIPTION
Specifies whether the root node of a structure (product, process or plant) is expanded
to the first level when it is opened in Manufacturing Process Planner.

PLM00026 11.2 Preferences and Environment Variables Reference 22-33


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
true The root node is expanded when opened in Manufacturing
Process Planner.
false The root node is not expanded when opened in Manufacturing
Process Planner.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
You can also set this preference by selecting the Expand First Level On Load check
box in the preferences Options pane.

MEExpandToSelection

DESCRIPTION
Specifies the behavior of the selection synchronization in manufacturing applications.
Depending on the value of this preference, when using commands such as Find in
other structure, Teamcenter expands the other hierarchy and highlights the selection.
VALID
VALUES
true The synchronizing view partially expands to the selected line
and highlights it.
false The synchronizing view highlights the selected line only if it is
currently expanded. If a hierarchy was previously expanded
and then collapsed, Teamcenter considers it collapsed. If the
structure is collapsed, nothing is highlighted.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
You can also set this preference by selecting the Expand to Selection check box in
the preferences Options pane.

MEHideChangesIconsForAttributes

DESCRIPTION
Controls the display of the incremental change and the in-context edit symbols on the
BOM structure. By default, symbols appear for all attribute changes in a structure.
Adding an attribute to this list eliminates the display of the change symbols for this

22-34 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

attribute. The changes are still recorded (either in the incremental change or the
context) but the symbols are not displayed.
VALID
VALUES
Valid property names for structure data overrides, for example, bl_sequence_no.
DEFAULT
VALUES
MEUILocation
DEFAULT
PROTECTION
SCOPE
Site preference.

MELineLinkedIconsProperty

DESCRIPTION
Specifies whether the manufacturing applications display a symbol beside a linked
structure line in a product (when linked as MEConsumed) or for a linked line in
a work area (for all occurrence types).
VALID
VALUES
No value.
The linked symbols are not displayed.
fnd0bl_assigned_as
The linked symbols are displayed in a reference pane (product or work area), indicating
that a product component or work area object is linked (for example, consumed or
used) in a process pane.
Note

Assigning a value to this preference slows the product/process structure loading.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.
NOTES
This preference replaces the Show_ME_line_linked_icons preference for
Teamcenter 8.3 and later. When upgrading to one of these versions, you must migrate
the Show_ME_line_linked_icons preference as follows:
If Show_ME_line_linked_icons was set to true, set
MELineLinkedIconsProperty to fnd0bl_assigned_as.

If Show_ME_line_linked_icons was set to false, leave


MELineLinkedIconsProperty with no value assigned.

PLM00026 11.2 Preferences and Environment Variables Reference 22-35


Chapter
Chapter 22:22:Related
Related topics
topics

MEMaxOpenViewsSameType

DESCRIPTION
Defines the number of structures of any given type that you can open at the same time.
VALID
VALUES
Accepts a positive integer value.
DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
Site preference.

MEPerspectiveMode

DESCRIPTION
Defines the behavior of how views open in manufacturing perspectives. You can
specify a mode for each manufacturing perspective in the user interface using the
Window→Perspective Mode menu command. You can set the default mode for
each perspective using this preference.
For more information about specifying the mode, see Manufacturing Process Planner.
VALID
VALUES
Accepts a list of strings separated by a colon as follows:
perspective-id:mode

perspective-id Specifies the unique name of the manufacturing perspective.


The following default perspectives are available by default:
• The Manufacturing Process Planner default perspective:
com.teamcenter.rac.cme.mpp.MSEPerspective

• The Manufacturing - Process Sequencing perspective:


com.teamcenter.rac.cme.mpp.ProcessSequencing

• The Manufacturing - BOM Reconciliation perspective:


com.teamcenter.rac.cme.mpp.BOMReconciliation

If you create a new perspective by using the Save Perspective


As menu command, you must select the mode using the
Window→Perspective Mode menu command.

22-36 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

mode Specifies how the views open in the perspective. There are
two options:
OpenExplicitOnly Opens structures in existing views where
available. Any other open but not yet
loaded structures are only opened in a
view when explicitly opened (for example,
by right-clicking the structure in the Open
Items list and choosing Activate). For
example, if you send a product with an
associated process and plant to the
Manufacturing - Process Sequencing
perspective, the following occurs:
• The process view is filled because
the Manufacturing - Process
Sequencing perspective contains an
empty process view.

• The product opens in a new view


because you opened it explicitly
(sent the product to the perspective).

• The plant is loaded, but no view


opens for it because it was implicitly
opened and there was no empty
plant view available for it in the
perspective.

Note

Prior to Teamcenter 10.0,


manufacturing perspectives
open structures using the
OpenExplicitOnly mode.

OpenAllStrategy Teamcenter opens a new view for each


structure being opened. When objects
are opened in another perspective,
Teamcenter opens a new view for them
in this perspective as well.
DEFAULT
VALUES
com.teamcenter.rac.cme.mpp.MSEPerspective:OpenAllStrategy
The default mode for perspectives that do not have a mode set in this preference is
OpenExplicitOnly.
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-37


Chapter
Chapter 22:22:Related
Related topics
topics

MESecondStructurePosition

DESCRIPTION
Specifies which alignment of the second structure position to use, either to the right
or on the bottom.
VALID
VALUES
right Displays the second structure on the right.
bottom Displays the second structure on the bottom.
DEFAULT
VALUES
right
DEFAULT
PROTECTION
SCOPE
All.

MEShowConfigurationHeader

DESCRIPTION
Specifies whether to show the configuration header in manufacturing views in
Manufacturing Process Planner, Part Planner, and Plant Designer. The header shows
configuration information such as revision rule, variant rule, effectivity, and incremental
change context.
VALID
VALUES
true The configuration header is shown in primary views.
false The configuration header is not shown in primary views.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

MEShowSuppressedOccsDefaultState

DESCRIPTION
Specifies the default state of the Show Suppressed Occurrences button or menu
command when an application is opened or a new BOM window is created.
The Show Suppressed Occurrences button is available in the Manufacturing
Process Planner and Part Planner applications. The Show Suppressed Occurrences
menu command is available in Multi-Structure Manager and Structure Manager.
VALID
VALUES
true The Show Suppressed Occurrences button is on when the
application is opened.

22-38 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

false The Show Suppressed Occurrences button is off when the


application is opened.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

MEShowUnconfiguredAssignedOccurrencesDefaultState

DESCRIPTION
Specifies the default state of the Show Unconfigured Assigned Occurrences button
or menu command when an application is opened or a new BOM window is created.
The Show Unconfigured Assigned Occurrences button is available in the
Manufacturing Process Planner and Part Planner applications. The menu command
is available in Multi-Structure Manager.
VALID
VALUES
true The Show Unconfigured Assigned Occurrences button is on
when the application is opened.
false The Show Unconfigured Assigned Occurrences button is off
when the application is opened.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

MEShowUnconfiguredOccurrencesEffectivityDefaultState

DESCRIPTION
Specifies the default state of the Show Unconfigured Occurrence Effectivity button
or menu option when an application is opened or a new BOM window is created.
The Show Unconfigured Occurrence Effectivity button is available in the
Manufacturing Process Planner and Part Planner applications. The menu option is
available in Multi-Structure Manager and Structure Manager.
VALID
VALUES
true The Show Unconfigured Occurrence Effectivity button is on.
false The Show Unconfigured Occurrence Effectivity button is off.
DEFAULT
VALUES
true

PLM00026 11.2 Preferences and Environment Variables Reference 22-39


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
Site preference.

MEShowUnconfiguredChangesDefaultState

DESCRIPTION
Specifies the default state of the Show Unconfigured Changes button or menu
command when an application is opened or a new BOM window is created.
The Show Unconfigured Changes button is available in the Manufacturing
Process Planner and Part Planner applications. The menu command is available in
Multi-Structure Manager and Structure Manager.
VALID
VALUES
true The Show Unconfigured Changes button is on when the
application is opened.
false The Show Unconfigured Changes button is off when the
application is opened.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

MEShowUnconfiguredVariantsDefaultState

DESCRIPTION
Specifies the default state of the Show Unconfigured Variants button or menu
command when an application is opened or a new BOM window is created.
The Show Unconfigured Variants button is available in the Manufacturing Process
Planner and Part Planner applications. The menu command is available in
Multi-Structure Manager and Structure Manager.
VALID
VALUES
true The Show Unconfigured Variants button is on when the
application is opened.
false The Show Unconfigured Variants button is off when the
application is opened.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

22-40 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MSE_load_related_product_process_plant

DESCRIPTION
Automatically loads related structures (product, plant or process) when a product, plant
or process is opened in Manufacturing Process Planner.
VALID
VALUES
true Related structures are automatically loaded when opening a
structure in Manufacturing Process Planner.
false Related structures are not loaded when opening a structure in
Manufacturing Process Planner.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
You can also set this preference by selecting the Load Related Structures for
Plant/Process/Product check box in the preferences Options pane.

TC_show_checkout_objects_on_exit

DESCRIPTION
Specifies if the Find Checked Out Objects dialog box is displayed when exiting
Teamcenter. The dialog box displays all objects checked out to the user in the
database.
VALID
VALUES
True The Find Checked Out Objects dialog box is displayed when
exiting Teamcenter.
False The Find Checked Out Objects dialog box is not displayed
when exiting Teamcenter.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 22-41


Chapter
Chapter 22:22:Related
Related topics
topics

In-process assembly preferences


MEDynamicIPARemoveOccTypes

DESCRIPTION
Determines which occurrence types to consider for removal from aggregated parts of
the predecessors in the given process structure to generate the dynamic in-process
assembly (DIPA).
VALID
VALUES
Accepts the name of a valid Teamcenter occurrence type.
DEFAULT
VALUE
MEDisassembled
DEFAULT
PROTECTION
SCOPE
Site preference.

MERelationTypeAssemblyTree

DESCRIPTION
Defines the relation type that indicates that the assigned occurrence group is an
assembly type when creating in-process assemblies in Manufacturing Process Planner.
VALID
VALUES
A single string.
DEFAULT
VALUES
MEWorkpiece.
SCOPE
Site preference.

TCVIS_Check_For_Duplica

DESCRIPTION
Determines whether to check if a duplicate part is already loaded in the viewer when
loading in-process assembly (IPA) graphics to the view. Setting this preference to true
prevents Teamcenter from loading a part more than once. You can further configure
IPA viewer behavior by setting the following preferences:
• TCVIS_Keep_Duplica_Map

• TCVIS_Show_Consumed_Part_Only

For more information about using in-process assemblies, see Manufacturing Process
Planner
VALID
VALUES
true Teamcenter displays only the consumed part in the viewer even if the
non-consumed part is loaded first.

22-42 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

false Teamcenter displays the first part it loads, regardless of whether it is consumed
or not.
DEFAULT
VALUES
None (equivalent to false)
DEFAULT
PROTECTION
SCOPE
User.
NOTES
This preference is not delivered with the software. You must create it manually.

TCVIS_Keep_Duplica_Map

DESCRIPTION
Specifies whether the check for duplicate parts that occurs if
TCVIS_Check_For_Duplica is set to true is in effect for the entire viewer
session or if the check occurs each time an operation is loaded. By default, the
duplicate check scope is for each load operation (that is, each click on an IPA node).
For more information about using in-process assemblies, see Manufacturing Process
Planner.
VALID
VALUES
true Teamcenter performs a duplicate check once per session.

false Teamcenter performs a duplicate check each time an operation is loaded.


DEFAULT
VALUES
None (equivalent to false)
DEFAULT
PROTECTION
SCOPE
All.
NOTES
This preference is not delivered with the software. You must create it manually.
This preference does not affect the loading of product views to the view.

TCVIS_Show_Consumed_Part_Only

DESCRIPTION
Specifies that, when checking for duplicate parts while loading in-process assemblies,
the viewer displays consumed parts.
The check for duplicate parts is performed when the TCVIS_Check_For_Duplica
preference is set to true.
For more information about using in-process assemblies, see Manufacturing Process
Planner

PLM00026 11.2 Preferences and Environment Variables Reference 22-43


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
true Teamcenter displays only the consumed part in the viewer even if the
non-consumed part is loaded first.
false Teamcenter displays the first part it loads, regardless of whether it is consumed
or not.
DEFAULT
VALUES
None (equivalent to false)
DEFAULT
PROTECTION
SCOPE
All.
NOTES
This preference is not delivered with the software. You must create it manually.
This preference does not affect the loading of product views to the view.

Custom Process View preferences

Mfg0BvrProcess.SUMMARYRENDERING

DESCRIPTION
Specifies the name of a dataset that holds an XML style sheet that defines what
appears in the Custom Process View in Manufacturing Process Planner.
For more information, see Manufacturing Process Planner.
VALID
VALUES
Accepts one string that is a valid dataset name.
DEFAULT
VALUES
Mfg0BvrProcessSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

Mfg0BvrOperation.SUMMARYRENDERING

DESCRIPTION
Specifies the name of a dataset that holds an XML style sheet that defines what
appears in the Custom Process View in Manufacturing Process Planner.
For more information, see Manufacturing Process Planner.
VALID
VALUES
Accepts one string that is a valid dataset name.

22-44 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
Mfg0BvrOperationSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

MECustomViewChildLinesColumnsShownPref

DESCRIPTION
Specifies the columns to display in the main table on the left side of the Custom
Process View in Manufacturing Process Planner.

For more information, see Manufacturing Process Planner.


VALID
VALUES
Accepts a list of valid Teamcenter properties that are displayed as columns in the table
in the order that they appear in this list.
DEFAULT
VALUES
BOMLine.bl_indented_title
BOMLine.description
BOMLine.bl_sequence_no
DEFAULT
PROTECTION
SCOPE
Site preference.

MECustomViewConsumedItemsColumnsShownPref

DESCRIPTION
Specifies the columns to display in the dependent tables on the right side of the
Custom Process View in Manufacturing Process Planner.

For more information, see Manufacturing Process Planner.

Note

This preference applies to all tables displayed on the right side of the view.

VALID
VALUES
Accepts a list of valid Teamcenter properties that are displayed as columns in the table
in the order that they appear in this list.
DEFAULT
VALUES
BOMLine.bl_indented_title
BOMLine.description
BOMLine.bl_occ_type

PLM00026 11.2 Preferences and Environment Variables Reference 22-45


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
User preference.

MECustomViewConsumedItemsColumnWidthPref

DESCRIPTION
Specifies the widths of the columns defined in the
MECustomViewConsumedItemsColumnsShownPref preference.
For more information, see Manufacturing Process Planner.
Note

This preference applies to all tables displayed on the right side of the view.

VALID
VALUES
Accepts a list of integers each representing the width of one column. The number
of entries in this preference should equal the number of columns defined in the
MECustomViewConsumedItemsColumnsShownPref preference.
DEFAULT
VALUES
30,15,20
DEFAULT
PROTECTION
SCOPE
User preference.

MECustomViewChildLinesCommandNames

DESCRIPTION
Defines the commands to be displayed above the table in the left side of the Custom
Process View in Manufacturing Process Planner.
For more information, see Manufacturing Process Planner.
VALID
VALUES
Accepts the IDs of each command in the order they should appear.
command-1
command-2
DEFAULT
VALUES
com.teamcenter.rac.newMEOperation
com.teamcenter.rac.cme.stylesheet.removeline

DEFAULT
PROTECTION
SCOPE
Site preference.

22-46 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

RESTRICTIONS
If you do not use existing commands, the commands you list here must have
associated command handlers configured during installation.

MECustomViewConsumedItemsCommandNames

DESCRIPTION
Defines the commands to be displayed above each table on the right side of the
Custom Process View in Manufacturing Process Planner.
For more information, see Manufacturing Process Planner.
VALID
VALUES
Accepts the IDs of each command in the order they should appear.
command-1
command-2
...
DEFAULT
VALUES
com.teamcenter.rac.cme.stylesheet.cut
com.teamcenter.rac.cme.stylesheet.copy
com.teamcenter.rac.cme.stylesheet.paste
com.teamcenter.rac.cme.stylesheet.removeline
com.teamcenter.rac.cme.stylesheet.assignconsumeditems:Mfg0consumed_material
com.teamcenter.rac.cme.stylesheet.assignparts:Mfg0used_equipment
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
If you do not use existing commands, the commands you list here must have
associated command handlers configured during installation.

MECustomViewConsumedItemsOccTypes

DESCRIPTION
Defines the occurrence types for each table that is displayed on the right side on
the Custom Process View in Manufacturing Process Planner. Each entry in this
preference creates a new table on the right side of the view.
For more information, see Manufacturing Process Planner.
VALID
VALUES
Accepts valid Manufacturing Process Planner occurrence types in the order the tables
should appear.
DEFAULT
VALUES
Mfg0consumed_material:MEConsumed
Mfg0used_equipment:MEResource

PLM00026 11.2 Preferences and Environment Variables Reference 22-47


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
User preference.
RESTRICTIONS
This preference must contain a value.

In-context ID preferences
MECopyIdInContextToAssignedLine

DESCRIPTION
Determines if the in-context ID is copied to the assigned line during an assignment
operation. When this preference is set to True, you do not have to expand a target
structure before performing an accountability check or when using the Find in Other
Panel menu command.
For more information about performing an accountability check, see Manufacturing
Process Planner.
For more information about using the Find in Other Panel menu command, see
Manufacturing Process Planner.
VALID
VALUES
True The in-context ID is copied to the assigned line during an
assignment operation. If no in-context ID is present, Teamcenter
creates one and then copies it.
False The in-context ID is not copied (even if one is present) to the
assigned line during an assignment operation.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

MECopyIdInContextLowerLevels

DESCRIPTION
Determines if the in-context ID is copied to the assigned line for the subprocesses and
suboperations during an assignment operation.
See also the MECopyIdInContextToAssignedLine preference.
VALID
VALUES
True The in-context ID is copied only for the items that are assigned
to the subprocesses and suboperations during an assignment
operation. The in-context ID of the subprocess or suboperation
is not copied.

22-48 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

False The in-context ID is not copied to the assigned line for the
subprocesses and suboperations during an assignment
operation.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

MECreateIdInContextforAssignedchildlines

DESCRIPTION
Defines in-context IDs (IDICs) for child lines up to the specified level. When structure
lines with children are copied from an engineering BOM (EBOM) to a manufacturing
BOM (MBOM), the IDIC is created for the parent line only. If the parent line is deleted
in the MBOM, all its children move up one level in the hierarchy but do not have any
IDIC assigned to them. When you run an accountability check, these child lines are
mistakenly displayed as missing in target. To rectify this problem, set this preference
to a meaningful number of levels.
Caution

You may experience performance issues if you set this preference. Performance
decreases relative to the number of levels you set.

VALID
VALUES
Accepts an integer value equal to zero or higher representing the number of levels
down from a parent line that are assigned an IDIC when assigning a parent line from
an EBOM to an MBOM. If this preference is set to zero, Teamcenter does not assign
an IDIC to any child lines. This is the default behavior if this preference is not set.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
This preference is not delivered with Teamcenter. You must create it manually.

MEIdGenerationPropertySetting

DESCRIPTION
Defines a list of BOM line properties for which values are to be formulated using
specified property values from other BOM lines. This is customizable based on item
type. If a rule is independent of the item type, use Item for the item type. If there is no
exact match for the specified item type, Teamcenter uses the closest parent type.
For more information, see Administering Manufacturing Planning.

PLM00026 11.2 Preferences and Environment Variables Reference 22-49


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts a string with the following format:
type:item-type,key:property-being-set,prop:first-property-to-concatenate,prop:
second-property-to-concatenate...
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
EXAMPLES
• The following entry specifies that the values for the bl_usage_address property
on BOM lines of type Item are formulated using the values for the bl_item_item_id
and bl_item_object_type properties:
type:Item,key:bl_usage_address,prop:bl_item_item_id,prop:bl_item_object_type

• The following entry specifies that the values for the bl_abs_occ_id property on
Item type BOM lines are formulated using the values for the bl_item_item_id
and bl_plmxml_abs_xform properties:
type:Item,key:bl_abs_occ_id,prop:bl_item_item_id,prop:bl_plmxml_abs_xform

• If you do not want to use a smart IDIC, you can add the following rule entry
(assuming there are no other conflicting entries). Alternatively, for the same
behavior, do not set this preference.
type:Item,key:bl_abs_occ_id,prop: bl_absocc_uid_in_topline_context

ME_angular_tolerance

DESCRIPTION
Defines the tolerance value (in degrees) under which small variations in the rotation
section of a transform are considered equal. This value is used to normalize Euler
angles of the rotation vector to the closest integer (floor). For example, if the rotation
angle is changed from 1.11 to 1.12 and this preference is set to 0.1, the calculation
is as follows:
floor (1.11/0.1)=11 and floor (1.12/0.1)=11
Because these results are equal (11), the angles are not flagged as different. Lowering
the preference value to .01 results in the following calculation:
floor (1.11/0.01)=111 and floor (1.12/0.01)=112
These results are no longer equal meaning that the rotation between 1.11 and 1.12
are considered two different positions.
For more information, see Administering Manufacturing Planning.
VALID
VALUES
Accepts a double value representing a degree amount.

22-50 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
0.1
DEFAULT
PROTECTION
SCOPE
Site preference.

ME_translation_tolerance

DESCRIPTION
Defines the tolerance value (in millimeters) under which small variations in the
translation section of a transform are considered equal. This value is used to normalize
translation vectors to the closest integer (floor). For example, if the part is moved from
1.11 to 1.12 and this preference is set to 0.1, the calculation is as follows:

floor (1.11/0.1)=11 and floor (1.12/0.1)=11


Because these results are equal (11), the positions are not flagged as different.
Lowering the preference value to .01 results in the following calculation:

floor (1.11/0.01)=111 and floor (1.12/0.01)=112


These results are no longer equal meaning that the translation from 1.11 to 1.12
constitutes two different positions.

For more information, see Administering Manufacturing Planning.


VALID
VALUES
Accepts a double value representing a millimeter amount.
DEFAULT
VALUES
0.001
DEFAULT
PROTECTION
SCOPE
Site preference.

MEIdGenerationOnAssignEnabled

DESCRIPTION
Controls whether the MEIdGenerationPropertySetting preference is used to
generate absolute occurrence values (in-context IDs) during the assign action.

For more information about creating smart in-context IDs (IDICs), see Administering
Manufacturing Planning.
VALID
VALUES
true The smart IDIC is generated when assigning from one structure
to another.

PLM00026 11.2 Preferences and Environment Variables Reference 22-51


Chapter
Chapter 22:22:Related
Related topics
topics

false The smart IDIC is not generated when assigning from one
structure to another. Teamcenter creates IDICs based on
the values of the MECopyIdInContextToAssignedLine and
MECopyIdInContextLowerLevels preferences.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

MEIdGenerationAllowDuplicates

DESCRIPTION
Allows duplicate values for IDs generated for BOM line properties based on the value
of the MEIdGenerationPropertySetting preference.

For more information, see Administering Manufacturing Planning.


VALID
VALUES
true The value of the property created by the recipe found in the
MEIdGenerationPropertySetting preference must not be
unique.

false The value of the property created by the recipe found in the
MEIdGenerationPropertySetting preference must be unique.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

MEPostAssignIDICMaker

DESCRIPTION
Defines the list of context types allowed as input parameter to the
postAssignIDICMaker service-oriented architecture operation of the
TcSoaManufacturing service. The subtypes of the specified types are also available.

For more information, see Manufacturing Process Planner.


VALID
VALUES
Accepts the name of a valid Teamcenter context types.
DEFAULT
VALUE
None.

22-52 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
Site preference.

Cloning preferences
Clone_Pending_Release_Status

DESCRIPTION
Specifies the release status type that will be assigned to any newly created incremental
change revisions during cloning.
VALID
VALUES
Accepts a string representing a valid release status type.
DEFAULT
VALUES
Pending
DEFAULT
PROTECTION
SCOPE
Site preference.

Clone_Secured_Release_Status

DESCRIPTION
Lists all release status types that should be considered secured (no longer modifiable)
when cloning incremental change revisions. Any statuses listed are cloned as ICRev
with a Clone_Pending_Release_Status value.
VALID
VALUES
Accepts one or more strings representing valid release status types.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Item.Item.PasteDuplicateTemplate

DESCRIPTION
Lists the cloning rules to be used when cloning a product structure from a product
structure using the Paste Duplicate menu command.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter cloning
rule.

PLM00026 11.2 Preferences and Environment Variables Reference 22-53


Chapter
Chapter 22:22:Related
Related topics
topics

For more information about creating cloning rules, see Administering Manufacturing
Planning.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:OccType.*:Clone
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.IMAN_specification:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
DEFAULT
PROTECTION
SCOPE
Site preference.

MEOP.MEProcess.PasteDuplicateTemplate

DESCRIPTION
Lists the cloning rules to be used when cloning an operation from a process using
the Paste Duplicate menu command.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter cloning
rule.
For more information about creating cloning rules, see Administering Manufacturing
Planning.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Map.Reference
*:*:OccType.MEWorkArea:Map.Reference
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.IMAN_specification:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.METimeAnalysisRelation:Clone
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone

22-54 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
Site preference.

MEProcess.MEProcess.PasteDuplicateTemplate

DESCRIPTION
Lists the cloning rules to be used when cloning a process from a process using the
Paste Duplicate menu command.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter cloning
rule.

For more information about creating cloning rules, see Administering Manufacturing
Planning.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Map.Reference
*:*:OccType.MEWorkArea:Map.Reference
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.IMAN_specification:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.METimeAnalysisRelation:Clone
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
DEFAULT
PROTECTION
SCOPE
Site preference.

MEWorkarea.MEWorkarea.PasteDuplicateTemplate

DESCRIPTION
Lists the cloning rules to be used when cloning a plant structure from a plant structure
using the Paste Duplicate menu command.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter cloning
rule.

PLM00026 11.2 Preferences and Environment Variables Reference 22-55


Chapter
Chapter 22:22:Related
Related topics
topics

For more information about creating cloning rules, see Administering Manufacturing
Planning.
DEFAULT
VALUES
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:OccType.*:Clone
*:*:Attribute.items_tag:Clone
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.IMAN_specification:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
DEFAULT
PROTECTION
SCOPE
Site preference.

PasteDuplicateTemplates

DESCRIPTION
Defines the list of cloning rules that are considered by the Paste Duplicate command.
Teamcenter chooses the appropriate rule by matching the type names that are used
as the rule name prefixes with the type names of the contexts participating in the
Paste Duplicate operation.
VALID
VALUES
Accepts the names of cloning rules in the format
SourceContextType.TargetContextType.RuleName.
DEFAULT
VALUES
MEGenericBOP.MEProductBOP.PasteDuplicateTemplate
MEProductBOP.MEProductBOP.PasteDuplicateTemplate
MEGenericBOP.MEGenericBOP.PasteDuplicateTemplate
MEProductBOP.MEGenericBOP.PasteDuplicateTemplate
MEOP.MEGenericBOP.PasteDuplicateTemplate
MEOP.MEProductBOP.PasteDuplicateTemplate
MEProcess.MEGenericBOP.PasteDuplicateTemplate
MEProcess.MEProductBOP.PasteDuplicateTemplate
MEProcess.MEProcess.PasteDuplicateTemplate
MEOP.MEProcess.PasteDuplicateTemplate
MEWorkarea.MEWorkarea.PasteDuplicateTemplate
Item.Item.PasteDuplicateTemplate
DEFAULT
PROTECTION
SCOPE
All.

22-56 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Plant.Template

DESCRIPTION
Defines the plant templates used in creating a plant. Each plant template contains
the action rules used in creating a plant from the plant template. Plant templates
are available from Manufacturing Process Planner, Part Planner, and Multi-Structure
Manager.
Note

Definition of individual templates must be created first via


Plant.Template.template name preferences. For example, the
Plant.Template.Cloning preference. These preferences define the action rules
used in creating the product structure from the product template.

VALID
VALUES
Accepts multiple strings as values. Each string must be the template name suffix of
each Plant.Template.template name preference name.
DEFAULT
VALUES
Cloning
DEFAULT
PROTECTION
SCOPE
All.

Plant.Template.Cloning

DESCRIPTION
Defines the action rules used in creating a plant from a plant template. Plant templates
are available from Manufacturing Process Planner, Part Planner, and Plant Designer.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter naming
rule. Naming rules are created in Business Modeler IDE.
For more information, see Business Modeler IDE.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.IMAN_specification:Clone
class.Folder:*:Attribute.contents:Reference

PLM00026 11.2 Preferences and Environment Variables Reference 22-57


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
All.

Process.Template

DESCRIPTION
Defines the process templates used in creating a process structure. Each process
template contains the action rules used in creating a process structure from the
process template.
Note

Definition of individual templates must be created first


using the Process.Template.Mapping_Consumes,
Process.Template.Referencing_Consumes, and
Process.Template.Ignoring_Consumes preferences.

VALID
VALUES
Accepts multiple strings as values. Each string must be the template name suffix of
each Process.Template.template name preference name.
DEFAULT
VALUES
Mapping_Consumes
Referencing_Consumes
Ignoring_Consumes

DEFAULT
PROTECTION
SCOPE
All.

Process.Template.Cloning

DESCRIPTION
Defines the action rules used in creating a process from a process template. Process
templates are available from Manufacturing Process Planner and Part Planner.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter naming
rule. Naming rules are created in the Business Modeler IDE.
For more information, see Business Modeler IDE.
DEFAULT
VALUES
*:*:Relation.IMAN_3D_snap_shot:Clone
*:*:Relation.VISTopLevelRef:Clone
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
*:*:OccType.Mes0MEDCD:Clone
*:*:Relation.Mes0MEWIAssetsRelation:Clone

22-58 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

*:*:Relation.Mes0MEWIPreviewRelation:Clone
*:*:Relation.Mes0MESymbolRelation:Reference
*:*:Relation.Mes0MEDCD_Details:Clone
*:*:Relation.Mes0MEDCD_Override:Clone
*:*:Relation.Mes0MEPF_Details:Clone
*:*:Relation.Mes0MEPF_Override:Clone
*:*:Relation.Mes0PDFReportRel:Clone
*:*:Relation.Mes0TWIRefInfoRelation:Clone
DEFAULT
PROTECTION
SCOPE
All.

Process.Template.Ignoring_Consumes

DESCRIPTION
Defines the action rules used in creating a process structure from a process template,
ignoring any MEConsumed product elements. Typically, when creating a new process
structure, the mapped product elements must share the same absolute occurrence
or ID of absolute occurrence with the product template.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter naming
rule. Naming rules are created in the Business Modeler IDE.
For more information, see Business Modeler IDE.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Ignore
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.IMAN_specification:Clone
*:*:Relation.IMAN_classification:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
*:*:OccType.Mes0MEDCD:Clone
*:*:Relation.Mes0MEWIAssetsRelation:Clone
*:*:Relation.Mes0MEWIPreviewRelation:Clone
*:*:Relation.Mes0MESymbolRelation:Reference
*:*:Relation.Mes0MEDCD_Details:Clone
*:*:Relation.Mes0MEDCD_Override:Clone
*:*:Relation.Mes0MEPF_Details:Clone

PLM00026 11.2 Preferences and Environment Variables Reference 22-59


Chapter
Chapter 22:22:Related
Related topics
topics

*:*:Relation.Mes0MEPF_Override:Clone
*:*:Relation.Mes0PDFReportRel:Clone
*:*:Relation.Mes0TWIRefInfoRelation:Clone
DEFAULT
PROTECTION
SCOPE
All.

Process.Template.Mapping_Consumes

DESCRIPTION
Defines the action rules used in creating a process structure from a process template
by mapping the MEConsumed and MEWorkArea product elements. When creating a
new process structure, the mapped product elements must share the same absolute
occurrence or ID of absolute occurrence with the product template.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter naming
rule. Naming rules are created in the Business Modeler IDE.
For more information, see Business Modeler IDE.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Map.Reference
*:*:OccType.MEWorkArea:Map.Reference
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.IMAN_specification:Clone
*:*:Relation.IMAN_classification:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.METimeAnalysisRelation:Clone
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
*:*:OccType.Mes0MEDCD:Clone
*:*:Relation.Mes0MEWIAssetsRelation:Clone
*:*:Relation.Mes0MEWIPreviewRelation:Clone
*:*:Relation.Mes0MESymbolRelation:Reference
*:*:Relation.Mes0MEDCD_Details:Clone
*:*:Relation.Mes0MEDCD_Override:Clone
*:*:Relation.Mes0MEPF_Details:Clone
*:*:Relation.Mes0MEPF_Override:Clone
*:*:Relation.Mes0PDFReportRel:Clone
*:*:Relation.Mes0TWIRefInfoRelation:Clone

22-60 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
All.

Process.Template.Referencing_Consumes

DESCRIPTION
Defines the action rules used in creating a process structure from a process template
by referencing MEConsumed product elements. When creating a new process
structure, the referenced product elements must share the same absolute occurrence
or ID of absolute occurrence with the product template.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter naming
rule. Naming rules are created in the Business Modeler IDE.
For more information, see Business Modeler IDE.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Reference
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.IMAN_specification:Clone
*:*:Relation.IMAN_classification:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
*:*:OccType.Mes0MEDCD:Clone
*:*:Relation.Mes0MEWIAssetsRelation:Clone
*:*:Relation.Mes0MEWIPreviewRelation:Clone
*:*:Relation.Mes0MESymbolRelation:Reference
*:*:Relation.Mes0MEDCD_Details:Clone
*:*:Relation.Mes0MEDCD_Override:Clone
*:*:Relation.Mes0MEPF_Details:Clone
*:*:Relation.Mes0MEPF_Override:Clone
*:*:Relation.Mes0PDFReportRel:Clone
*:*:Relation.Mes0TWIRefInfoRelation:Clone
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 22-61


Chapter
Chapter 22:22:Related
Related topics
topics

Product.Template

DESCRIPTION
Defines the product templates used in creating a product structure. Each product
template contains the action rules used in creating a product structure from the product
template. Product templates are available from Manufacturing Process Planner, Part
Planner, and Multi-Structure Manager.
Note

Definition of individual templates must be created first via


Product.Template.template name preferences. For example, the
Product.Template.Cloning preference. These preferences define the action
rules used in creating the product structure from the product template.

VALID
VALUES
Accepts multiple strings as values. Each string must be the template name suffix of
each Product.Template.template name preference name.
DEFAULT
VALUES
Cloning
DEFAULT
PROTECTION
SCOPE
All.

Product.Template.Cloning

DESCRIPTION
Defines the action rules used in creating a product structure from a product template.
Product templates are available from Manufacturing Process Planner, Part Planner,
and Multi-Structure Manager.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter naming
rule. Naming rules are created in Business Modeler IDE.
For more information, see Business Modeler IDE.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.IMAN_specification:Clone
*:*:Relation.IMAN_3D_snap_shot:Clone
*:*:Relation.VisTopLevelRef:Clone

22-62 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

class.Folder:*:Attribute.contents:Reference

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_ignore_project_info_on_clone

DESCRIPTION
Specifies whether project and program information is carried over to the new
object when cloning in Manufacturing Process Planner, Structure Manager, and
Multi-Structure Manager.
For more information about cloning, see Manufacturing Process Planner.
VALID
VALUES
true Project information is ignored when cloning a new item.
false Project information is carried over when cloning a new item.
This is the default value if the preference is not set.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

PERT chart preferences


PertChart.<object_type>.BGColor

DESCRIPTION
Defines the background color of the PERT nodes by defining the R, G, and B values
of the background boxes in the PERT chart. Object_type refers to an operation,
activity, or plant business object (type), such as MEOP, MEProcess, MEActivity, or
MEPrStation.
VALID
VALUES
Any valid RGB values.
DEFAULT
VALUES
You can define a general entry in the preference file that defines the background color
for nodes per PERT chart type. Those entries are:
• PertChart.NodeDefault.BGColor=220,120,0
Defines the background color for nodes in Process/Station Flow PERT chart that
do not have an explicit background color definition.

PLM00026 11.2 Preferences and Environment Variables Reference 22-63


Chapter
Chapter 22:22:Related
Related topics
topics

• PertChart.ActivityDefault.BGColor=0,120,120
Defines the background color for nodes in the Activity PERT chart that do not
have an explicit background color definition.

If the PERT module cannot find any background color definition for a specific node, it
uses gray (128, 128, 128).
DEFAULT
PROTECTION
SCOPE
User, group, or site preference.

PertChart.<object_type>.Text

DESCRIPTION
Defines the text to be displayed in the PERT node by specifying which node fields
appear. Object_type refers to an operation, activity, or plant business object (type),
such as MEOP, MEProcess, MEActivity, or MEPrStation.
VALID
VALUES
<free-text>[property-name]<free-text>... where:

<free-text> Any text except square parentheses [ ].


Any property name. Must be wrapped
[property-name] by square parentheses, for example:
[object_name].

You can select the fields from the activity attributes.


For example:
PertChart.MEOP.Text=Revision: [bl_bomview_rev] Class: [bl_line_object_class]

Causes the PERT chart to display the operation node text as follows:
Revision: 00000000 Class: MEOP Revision
Causes the PERT chart to display the activity node text as follows:
PertChart.MEActivity.Text=Name: [object_name] Desc: [object_desc]

Name: act1 Desc: act1 description


You can define default entries for any types that are not explicitly defined, for example:
Used for all types derived from
PertChart.NodeDefault.Text=
operation/process and work area class.
Used for all types derived from activity
PertChart.ActivityDefault.Text=
class.

Special cases — The following are special cases regarding the formula definition:
• If the property name does not exist for the specified object, an empty value is
displayed in the node text. No error message is displayed.
If the following formula is defined in the preference file for operations:

22-64 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

PertChart.MEOP.Text=Name: [object_name] NAN: [bbb]

The following text is displayed in the node—assuming the operation is named op1:
Name: op1 NAN:

• In the case of incorrect formula format, the application tries to display the correct
section of the formula. No error message is displayed.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User, group, or site preference.

PertChart.AutoSizeMode

DESCRIPTION
Enables or disables auto-size in the PERT chart. When auto-size is off, the size of the
all newly created PERT nodes is uniform. When auto-size is on, the size of the newly
created PERT nodes is automatically fitted to the displayed text, including allowing
for multiple lines.
VALID
VALUES
yes Enables auto-size.

no Disables auto-size.
DEFAULT
VALUES
yes
DEFAULT
PROTECTION
SCOPE
User, group, or site preference.

PertChart.BoxAutoSizeMaxWidth

DESCRIPTION
If PertChart.AutoSizeMode is on, configures the maximal width to be used when
new PERT nodes are created.
VALID
VALUES
A positive integer.
If the PERT node text is larger than 250 pixels, the application splits the text into
multiple lines as needed.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 22-65


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
User, group, or site preference.

PertChart.BoxDefaultWidth

DESCRIPTION
If PertChart.AutoSizeMode is off, configures the default width to be used when new
PERT nodes are created. The value is common for all PERT chart types; for example,
once it is defined in the Process PERT chart, the Activity Flow chart and Station Flow
chart use this value to define the width of newly created PERT nodes.
VALID
VALUES
A positive integer indicating the number of pixels.
DEFAULT
VALUES
None.
If no values are entered, the node is 110 pixels wide.
DEFAULT
PROTECTION
SCOPE
User, group, or site preference.

PertChart.BoxDefaultHeight

DESCRIPTION
If PertChart.AutoSizeMode is off, configures the default height to be used when new
PERT nodes are created. The value is common for all PERT chart types; for example,
once it is defined in the Process PERT chart, the Activity Flow chart and Station Flow
chart use this value to define the height of newly created PERT nodes.
VALID
VALUES
A positive integer indicating the number of pixels.
DEFAULT
VALUES
None.
If no value is entered, the node is 20 pixels high.
DEFAULT
PROTECTION
SCOPE
User, group, or site preference.

PertChartCreationLayout

DESCRIPTION
Defines where newly created nodes are placed in the PERT chart. If the value is
Horizontal, all newly created nodes are put at the top right corner; otherwise, they are
placed at the bottom left corner.

22-66 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

For more information about using the PERT chart, see Manufacturing Process Planner.
VALID
VALUES
Horizontal All newly created nodes are placed at the top right corner of
the PERT chart.
Vertical All newly created nodes are placed at the bottom left corner
of the PERT chart.
DEFAULT
VALUES
Vertical
DEFAULT
PROTECTION
SCOPE
All.

Accountability check preferences

DefaultAccountabilityCheckProperties

DESCRIPTION
Determines which properties the system checks by default when performing an
accountability check.
An accountability check compares a bill of materials (BOM) with a bill of process (BOP)
to ensure all lines in the source BOM are consumed in the target BOP. This allows you
to ensure that all occurrences of product components and features are used in the
process structure as consumed items. You can compare the entire assembly or only a
subassembly to the selected process.
For more information about using accountability checks, see Manufacturing Process
Planner.
If the Compare additional properties option in the Accountability Checkbox dialog
box is not selected, the values defined in this preference are the only properties upon
which the accountability check is performed.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid item property.
DEFAULT
VALUES
bl_item_item_id
bl_rev_item_revision_id
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-67


Chapter
Chapter 22:22:Related
Related topics
topics

AdditionalAccountabilityCheckProperties

DESCRIPTION
Determines the additional properties the system checks when performing an
accountability check.
An accountability check compares a bill of materials (BOM) with a bill of process (BOP)
to ensure all lines in the source BOM are consumed in the target BOP. This allows you
to ensure that all occurrences of product components and features are used in the
process structure as consumed items. You can compare the entire assembly or only a
subassembly to the selected process.
For more information about using accountability checks, see Manufacturing Process
Planner.
The system checks this preference when the Compare additional properties option
in the Accountability Checkbox dialog box is selected. Any properties defined by
this preference are included in the accountability check.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid property of the selected
BOM line.
DEFAULT
VALUES
bl_rev_object_name
bl_rev_object_type
bl_plmxml_abs_xform
bl_quantity
bl_sequence_no
bl_abs_occ_id
bl_jt_refsetname

DEFAULT
PROTECTION
SCOPE
User preference.

AccountabilityCheckReportStylesheetName

DESCRIPTION
Determines which XSL style sheet of the report definition should be used to generate
the accountability check report.
A user can add more than one XSL style sheet to the report definition. If this
preference is defined and a style sheet with this name is found, the accountability
check report is generated by using the style sheet that is found. Otherwise, the default
style sheet is used.
An accountability check compares a bill of materials (BOM) with a bill of process (BOP)
to ensure all lines in the source BOM are consumed in the target BOP. This allows you
to ensure that all occurrences of product components and features are used in the
process structure as consumed items. You can compare the entire assembly or only a
subassembly to the selected process.

22-68 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

For more information about using accountability checks, see Manufacturing Process
Planner.
VALID
VALUES
Accepts strings as value. Each string must be a valid style sheet name from the
accountability check report definition.
DEFAULT
VALUES
In case the preference is not found or the style sheet defined in the preference is not
found, acc_chk_rpt_excel.xsl is taken.
DEFAULT
PROTECTION
SCOPE
User preference.

MEAccountabilityCheckSourceStructureExpansionFilterRules

DESCRIPTION
Provides a list of closure rule names to be used for source structure traversal for
the accountability check.
For more information about filtering the structures for an accountability check, see
Manufacturing Process Planner.
VALID
VALUES
Accepts a list of closure rule names that exist in the database to be used for traversal
of the source structure.
DEFAULT
VALUES
AccountabilityAll
AccountabilityLeavesOnly
AccountabilityLinkedAssmOrLeaves
AccountabilityProcessConsumption
AccountabilityProcessAssignments
AccountabilityProcessAllNoAssign
AccountabilityProcessAll
AccountabilityProcessOnlyWithPA
ACPlantBOPDerivedProcessesAndOps
DEFAULT
PROTECTION
SCOPE
Site preference.

MEAccountabilityCheckTargetStructureExpansionFilterRules

DESCRIPTION
Provides a list of closure rule names to be used for the target structure traversal for
the accountability check.

PLM00026 11.2 Preferences and Environment Variables Reference 22-69


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts a list of closure rule names that exist in the database to be used for traversal
of the target structure.
DEFAULT
VALUES
AccountabilityAll
AccountabilityLeavesOnly
AccountabilityLinkedAssmOrLeaves
AccountabilityProcessConsumption
AccountabilityProcessAssignments
AccountabilityProcessAllNoAssign
AccountabilityProcessAll
AccountabilityProcessOnlyWithPA
ACPlantBOPDerivedProcessesAndOps
DEFAULT
PROTECTION
SCOPE
Site preference.

MEAccountabilityCheckEnableFilteringRules

DESCRIPTION
Determines whether the Expand Below by Filter Rule menu command for the filtering
rule verification is enabled.
VALID
VALUES
true The Expand Below by Filter Rule menu command is available.
false The Expand Below by Filter Rule menu command is hidden.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

MEAccountabilityCheckEnableNetEffectivity

DESCRIPTION
Specifies whether the net effectivities are compared when the accountability check
tests for a partial match.
VALID
VALUES
true Net effectivities are checked.
false Net effectivities are not checked.
DEFAULT
VALUES
false

22-70 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
Site preference.

MEAccountabilityCheckParentDelimiterInHierarchy

DESCRIPTION
Lists the BOM Line properties to be added as columns to the accountability check
Excel report for each source line in the Manufacturing Process Planner application.
Cells in the column contain the value of the property for each BOM Line.
For more information about using the accountability check in batch mode, see
Manufacturing Process Planner.
VALID
VALUES
Accepts a list of valid Teamcenter internal property names.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

MEAccountabilityCheckPropertiesInHierarchy

DESCRIPTION
Lists the BOMLine properties to be concatenated for each parent in the value of the
property "Hierarchy From Root" (mfg0BlHierarchyFromRoot), which is a concatenation
of all parents of a BOMLine.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid property of the parent
BOMLine.
DEFAULT
VALUES
bl_item_item_id
bl_rev_object_name
bl_sequence_no
DEFAULT
PROTECTION
SCOPE
Site preference.

MEAccountabilityCheckPropertyDelimiterInHierarchy

DESCRIPTION
Defines the delimiter to separate the parents of a BOMLine in the hierarchy from root
in the Manufacturing Process Planner application.

PLM00026 11.2 Preferences and Environment Variables Reference 22-71


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts a list of valid Teamcenter internal property names.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

MEAccountabilityCheckReportProperties

DESCRIPTION
Lists the BOM Line properties to be added as columns to the accountability check
Excel report for each source line in the Manufacturing Process Planner application.
Cells in the column contain the value of the property for each BOM Line.
For more information about using the accountability check in batch mode, see
Manufacturing Process Planner.
VALID
VALUES
Accepts a list of valid Teamcenter internal property names.
Example

If a team leader or manager needs an accountability check report to verify


which BOM lines in a Process view are missing in the source MBOM view, the
administrator could add the properties bl_indented_title and bl_sequence_no
to the preference. The sections Source Properties and Target Properties
would then allow them to compare MBOM source lines and Process view
target lines. To get the parent chain of each line in the report, the administrator
could then add the property fnd0bl_parent_chain. When the team leader or
manager generates the accountability check report, an extra Parent Chain
column is displayed in the Source Properties and Target Properties sections
. The Parent Chain value is a concatenation of all the parents of the target,
starting from the top line parent on the left all the way down to the immediate
parent line on the right.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

MEAccountabilityCheckSettings.<structureType>.<structureType>

DESCRIPTION
References the dataset in which Teamcenter stores the accountability check setting
that a user creates for two specific structure types. The name of this preference

22-72 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

depends on the types of structures that are used as the scope of the accountability
check for which the setting is saved. For example, if a user opens an engineering
BOM and a manufacturing BOM, selects accountability check options for these
two structures, and saves them as an available setting, the resulting setting is
stored in the MEAccountabilityCheckSettings.BOM.BOM preference. If a product
BOP and a plant BOP are used to create the setting, the setting is saved in the
MEAccountabilityCheckSettings.PBOP.PlantBOP preference.
Use this preference to publish saved accountability check settings for users, groups,
or roles.
For more information, see Administering Manufacturing Planning.
Teamcenter creates this preference automatically. Do not change its values.
VALID
VALUES
Automatically created by Teamcenter. Do not change.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

MEAccountabilityMarkBrokenLinksClosureRule

DESCRIPTION
Defines the name of the closure rule used by the Mark Broken Links command in
the Manufacturing Process Planner application. This command is used to find broken
links in process structures.
For more information about using accountability checks, see Manufacturing Process
Planner.
VALID
VALUES
Accepts a valid Teamcenter closure rule.
DEFAULT
VALUES
MarkBrokenLinks
DEFAULT
PROTECTION
SCOPE
User preference.

MEAccountabilityMarkBrokenLinksColor

DESCRIPTION
Specifies the background color used by the Mark Broken Links command in the
Manufacturing Process Planner application to mark broken link lines.
For more information about using accountability checks, see Manufacturing Process
Planner.

PLM00026 11.2 Preferences and Environment Variables Reference 22-73


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts a valid RGB (red green blue) code representing a color. This code represents
any color as a combination of three digits, each of which is between 0 and 255. The
three digits are separated by commas.
DEFAULT
VALUES
255,0,0
DEFAULT
PROTECTION
SCOPE
User preference.

MEAccountabilityMarkBrokenLinksCountTrigger

DESCRIPTION
Specifies the minimum number of broken links that causes an information pane to be
displayed by the Mark Broken Links command in the Manufacturing Process Planner
application. The pane shows the total number of broken links found by the command.

For more information about using accountability checks, see Manufacturing Process
Planner.
VALID
VALUES
Accepts a positive integer.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
User preference.

MEAccountabilityMarkInBaseViewColor

DESCRIPTION
Specifies the background color used by the Mark In Base View command in the
Manufacturing Process Planner application to mark lines in the base view.

For more information about using accountability checks, see Manufacturing Process
Planner.
VALID
VALUES
Accepts a valid RGB (red green blue) code representing a color. This code represents
any color as a combination of three digits, each of which is between 0 and 255. The
three digits are separated by commas.
DEFAULT
VALUES
153,153,255

22-74 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
User preference.

MEResultViewSourceColumnsShownPref

DESCRIPTION
Defines the columns to display in the Accountability Check view source table.
For more information about working with this view, see Manufacturing Process Planner.
VALID
VALUES
Accepts valid Teamcenter internal property names in the order the columns should
appear in the table.
DEFAULT
VALUES
bl_indented_title
bl_item_object_type
bl_item_object_desc

DEFAULT
PROTECTION
SCOPE
Site preference.

MEResultViewSourceColumnsShownWidthPref

DESCRIPTION
Defines the width of the columns displayed in the Accountability Check view source
table as defined by the MEResultViewSourceColumnsShownPref preference.
For more information about working with this view, see Manufacturing Process Planner.
VALID
VALUES
Accepts an integer value representing the width in pixels of the column.
DEFAULT
VALUES
50
50
50
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
The values of this preference are set automatically by Teamcenter through interaction
with the user interface. You do not need to change these manually.

PLM00026 11.2 Preferences and Environment Variables Reference 22-75


Chapter
Chapter 22:22:Related
Related topics
topics

MEResultViewTargetColumnsShownPref

DESCRIPTION
Defines the columns to display in the Accountability Check view target table.
For more information about working with this view, see Manufacturing Process Planner.
VALID
VALUES
Accepts valid Teamcenter internal property names in the order the columns should
appear in the table.
DEFAULT
VALUES
bl_indented_title
bl_item_object_type
bl_item_object_desc
DEFAULT
PROTECTION
SCOPE
Site preference.

MEResultViewTargetColumnsShownWidthPref

DESCRIPTION
Defines the width of the columns displayed in the Accountability Check view target
table as defined by the MEResultViewTargetColumnsShownPref preference.
For more information about working with this view, see Manufacturing Process Planner.
VALID
VALUES
Accepts an integer value representing the width in pixels of the column.
DEFAULT
VALUES
50
50
50
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
The values of this preference are set automatically by Teamcenter through interaction
with the user interface. You do not need to change these manually.

MEAccountabilityCheckAllowableReturnedLines

DESCRIPTION
Specifies the maximum number of lines that can be returned by the accountability
check. This includes all the source and target lines to be colored, as well as their
parent lines.

22-76 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

For more information about using the accountability check, see Manufacturing Process
Planner.
VALID
VALUES
Accepts a positive integer less than or equal to 10,000.
DEFAULT
VALUES
10000
DEFAULT
PROTECTION
SCOPE
Site preference.

MEAdditionalPropagatableProperties

DESCRIPTION
Defines the list of read-only properties that are displayed in the Propagation Settings
dialog box. A property is displayed and selectable for propagation only if it is selected
in the Partial Match tab of the Accountability Check dialog box.
For more information about using the accountability check, see Manufacturing Process
Planner.
VALID
VALUES
Accepts a list of valid Teamcenter properties.
DEFAULT
VALUES
bl_variant_condition
DEFAULT
PROTECTION
SCOPE
Site preference.

MEAccountabilityCheckIncludedActivityProperties

DESCRIPTION
Defines the default list of properties to be included when comparing equivalent
activities for partial match when using the accountability check.
VALID
VALUES
Accepts an array of strings representing the activity property names.
DEFAULT
VALUES
al_current_name
al_current_desc
al_object_name
al_object_desc
al_activity_object_name
al_activity_object_desc
al_activity_current_name

PLM00026 11.2 Preferences and Environment Variables Reference 22-77


Chapter
Chapter 22:22:Related
Related topics
topics

al_activity_current_desc
al_activity_object_string
al_activity_long_description
al_activity_time_system_code
al_activity_time_system_category
al_activity_time_system_frequency
al_activity_time_system_unit_time
al_activity_time
al_activity_calc_time
al_activity_duration_time
al_activity_work_time
al_activity_start_time
al_activity_calc_start_time
me_cl_object_name
me_cl_object_desc
me_cl_current_name
me_cl_current_desc
me_cl_display_string

SCOPE
Site preference.

MEAccountabilityCheckMappedAttrGrpsForComparison

DESCRIPTION
Defines a list of attribute groups that have mappings with MBOM forms. In the
Accountability Check dialog box, the attribute groups specified by this preference are
displayed on the Attribute Groups tab under the Partial Match tab. You can select
attribute groups from the Available Attribute Groups pane on this tab to compare
them for mismatches during an accountability check.
VALID
VALUES
Accepts one or more strings containing valid attribute group names. By default,
Teamcenter does not provide attribute groups. Your Teamcenter administrator or
customizer must define the attribute groups for your Teamcenter sites in the Business
Modeler IDE.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

MEAccountabilityCheckMappedAttrGrpsForPropagation

DESCRIPTION
Defines a list of attribute groups that have mappings with MBOM forms. In the
Propagation Settings dialog box, you can select attribute groups from this list to
propagate differences during an accountability check.

22-78 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
One or more strings containing valid attribute group names. By default, Teamcenter
does not provide attribute groups. Your Teamcenter administrator or customizer must
define the attribute groups for your Teamcenter sites in the Business Modeler IDE.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Manufacturing studies preferences

CC_ExtraPLMXMLInstanceAttributes

DESCRIPTION
Defines any additional options to be used when exporting a tool design package to
NX or when using the cc_writer command line utility.
For more information about creating studies, see Manufacturing Process Planner.
VALID
VALUES
Accepts a string containing the following format:
target:Instance,key:KeyEntry,prop:PropEntry[,key:KeyEntry,prop:PropEntry]...
[,target:Part,key:KeyEntry,prop:PropEntry[,key:KeyEntry,prop:PropEntry]...]
KeyEntry Specifies the string that appears as the title attribute in the PLM
XML code for the UserValue element.
PropEntry Specifies the string that appears as the value attribute in the
PLM XML code for the UserValue element.
The following is an example of a multi-entry value:
target:Instance,key:__PLM_CLONE_STABLE_INST_UID,
prop:bl_clone_stable_occurrence_id,key:__PLM_APPUID,prop:bl_apn_uid,
target:Part,key:__PLM_OBJECT_NAME,prop:object_name
DEFAULT
VALUE
target:Instance,key:__PLM_CLONE_STABLE_INST_UID,prop:
bl_clone_stable_occurrence_id
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-79


Chapter
Chapter 22:22:Related
Related topics
topics

CopyPasteTemplates

DESCRIPTION
Lists the cloning rule names to be used when pasting processes, operations, and
partitions within enterprise bill of process (EBOP) structures or study structures.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter cloning
rule.
DEFAULT
VALUES
MEGenericBOP.MEProductBOP.CopyPasteTemplate
MEProductBOP.MEProductBOP.CopyPasteTemplate
MEGenericBOP.MEGenericBOP.CopyPasteTemplate
MEProductBOP.MEGenericBOP.CopyPasteTemplate
MEProcess.Mfg0MESimStudy.CopyPasteTemplate
MEOP.Mfg0MESimStudy.CopyPasteTemplate
Mfg0MEPlantBOP.Mfg0MESimStudy.CopyPasteTemplate
Mfg0MESimStudy.MEProcess.CopyPasteTemplate
Mfg0MESimStudy.MEOP.CopyPasteTemplate
Mfg0MESimStudy.Mfg0MEPlantBOP.CopyPasteTemplate
DEFAULT
PROTECTION
SCOPE
Site preference.

MEProcess.Mfg0MESimStudy.CopyPasteTemplate

DESCRIPTION
Lists the cloning rules to be used when the Paste operation is used to create new
instances in a study starting from a bill of process (BOP) structure.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter cloning
rule.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:type.MEWorkareaRevision:OccType.*:Reference
*:type.Mfg0MERobotRevision:OccType.*:Reference
*:*:OccType.Null:Clone
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0StudyLinkRel:EBOPCreate
*:*:Relation.IMAN_specification:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone

22-80 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.METimeAnalysisRelation:Clone
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
*:*:Relation.Cps0ModulesInfoRel:Clone
*:*:Relation.Cps0PLCInfoRel:Clone
*:*:Relation.Cps0OpDetailsRel:Clone
*:*:Relation.Cps0ToolInfoRel:Clone
*:*:Relation.Cps0RobotProgRel:Clone
*:*:Relation.Cps0ConnectivityDefRel:Clone
*:*:Relation.ProcessSimulate_Details:Clone
DEFAULT
PROTECTION
SCOPE
Site preference.

MEOP.Mfg0MESimStudy.CopyPasteTemplate

DESCRIPTION
Lists the cloning rules to be used when the Paste operation is used to create new
instances in a study starting from a bill of process (BOP) structure.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter cloning
rule.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEAssign:Ignore
*:*:OccType.MEHandle:Ignore
*:*:OccType.MEAssemble:Ignore
*:*:OccType.MEDisassemble:Ignore
*:*:OccType.MEOther:Ignore
*:*:OccType.METarget:Ignore
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0StudyLinkRel:EBOPCreate
*:*:Relation.IMAN_specification:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.METimeAnalysisRelation:Clone
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
*:*:Relation.Cps0ModulesInfoRel:Clone
*:*:Relation.Cps0PLCInfoRel:Clone

PLM00026 11.2 Preferences and Environment Variables Reference 22-81


Chapter
Chapter 22:22:Related
Related topics
topics

*:*:Relation.Cps0OpDetailsRel:Clone
*:*:Relation.Cps0ToolInfoRel:Clone
*:*:Relation.Cps0RobotProgRel:Clone
*:*:Relation.Cps0ConnectivityDefRel:Clone
*:*:Relation.ProcessSimulate_Details:Clone
DEFAULT
PROTECTION
SCOPE
Site preference.

Mfg0MEPlantBOP.Mfg0MESimStudy.CopyPasteTemplate

DESCRIPTION
Lists the cloning rules to be used when the Paste operation is used to create new
instances in a study starting from a bill of process (BOP) structure.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter cloning
rule.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:type.MEWorkareaRevision:OccType.*:Reference
*:type.Mfg0MERobotRevision:OccType.*:Reference
*:*:OccType.Null:Clone
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0StudyLinkRel:EBOPCreate
*:*:Relation.IMAN_specification:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.METimeAnalysisRelation:Clone
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
DEFAULT
PROTECTION
SCOPE
Site preference.

Mfg0MEStudy_ColumnPreferences

DESCRIPTION
Specifies the list of columns to be displayed for objects of type Mfg0MEStudy.

This preference is internal and should be modified automatically by Teamcenter only.

22-82 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
Accepts the internal name of each column in the order they appear.
DEFAULT
VALUE
object_string
object_type
object_desc
DEFAULT
PROTECTION
SCOPE
Site preference.

Mfg0MEStudy_ColumnWidthPreferences

DESCRIPTION
Specifies the widths for the columns defined in the
Mfg0MEStudy_ColumnPreferences preference.

This is an internal preference and should be modified automatically by Teamcenter


only.
VALID
VALUES
Accepts positive integers. The number of values should be the same as the number of
values in the Mfg0MEStudy_ColumnPreferences preference.
DEFAULT
VALUES
30
17
18
DEFAULT
PROTECTION
SCOPE
Site preference.

StudyAllowedTemplates

DESCRIPTION
Defines the names of the cloning rules to be used when cloning one study to another
study.

For more information about creating studies, see Manufacturing Process Planner.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter cloning
rule.
DEFAULT
VALUE
StudyTemplate

PLM00026 11.2 Preferences and Environment Variables Reference 22-83


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
Site preference.

StudyTemplate

DESCRIPTION
Defines the cloning rules to be used when creating a study from another study
structure.
For more information about creating studies, see Manufacturing Process Planner.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter cloning
rule.
DEFAULT
VALUE
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Ignore
*:*:OccType.MEAssign:Ignore
*:*:OccType.MEHandle:Ignore
*:*:OccType.MEAssemble:Ignore
*:*:OccType.MEDisassemble:Ignore
*:*:OccType.MEOther:Ignore
*:*:OccType.METarget:Ignore
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.IMAN_classification:Clone
*:*:Relation.Mfg0StudyLinkRel:EBOPReference
*:*:Relation.IMAN_specification:Clone
*:*:Relation.IMAN_MEView:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.METimeAnalysisRelation:Clone
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
DEFAULT
PROTECTION
SCOPE
Site preference.

StudyEventBasedPublishRule

DESCRIPTION
Defines the default rules for publishing from an isolated study to the original structure.

22-84 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

The values in this preference are set by an administrator in the Manufacturing Process
Planner application using the Managing Synchronization Rules dialog box.
VALID
VALUES
Accepts a string containing the following format:
object-name:property-name:change-type
object-name Specifies the internal name of the object type.
property-name Specifies the internal name of the property on the object type.
change-type Specifies the change type for the rule.
Valid values for change-type are:
AddedToStudy Specifies an action when the property is
added to the isolated study.
Changed Specifies an action when the property is
changed. This is mainly for properties
and not new objects
DeletedInStudy Specifies an action when the property is
removed from the isolated study.
MissingInStudy Specifies an action when the property is
added to the bill of process after the last
synchronization to the isolated study.
RemovedFromBOP Specifies an action when the property is
removed from the bill of process.
For example:
A value of Mfg0BvrContinuousJoinOperation:Mfg0calc_start_time:Changed
means that any modification to the Mfg0calc_start_time property on an object of
type Mfg0BvrContinuousJoinOperation between the isolated study and the bill of
process initiates a publication change to the isolated study.
DEFAULT
VALUE
Mode:Include
Mfg0BvrOperation:bl_rev_ProcessSimulate_Details
Mfg0BvrProcess:bl_rev_ProcessSimulate_Details
Mfg0BvrProcessArea:bl_rev_ProcessSimulate_Details
Mfg0BvrProcess:Mfg0sub_elements
Mfg0BvrOperation:Mfg0predecessors
Mfg0BvrProcess:Mfg0predecessors
Mfg0BvrProcessArea:Mfg0predecessors
Mfg0BvrOperation:Mfg0consumed_material
Mfg0BvrProcess:Mfg0consumed_material
Mfg0BvrProcessArea:Mfg0consumed_material
Mfg0BvrOperation:Mfg0used_equipment
Mfg0BvrProcess:Mfg0used_equipment
Mfg0BvrProcessArea:Mfg0used_equipment

PLM00026 11.2 Preferences and Environment Variables Reference 22-85


Chapter
Chapter 22:22:Related
Related topics
topics

Mfg0BvrOperation:Mfg0allocated_features
Mfg0BvrProcess:Mfg0allocated_features
Mfg0BvrProcessArea:Mfg0allocated_features
Mfg0BvrOperation:Mfg0calc_dur_start_time
Mfg0BvrOperation:Mfg0calc_duration
Mfg0BvrOperation:Mfg0calc_start_time
Mfg0BvrProcessArea:Mfg0allocated_ops
MfgBvrBOPWorkarea:bl_all_child_lines
DEFAULT
PROTECTION
SCOPE
Site preference.

StudyEventBasedSyncRule

DESCRIPTION
Defines the default rules for synchronizing to an isolated study from the original
structure.
The values in this preference are set by an administrator in the Manufacturing Process
Planner application using the Managing Synchronization Rules dialog box.
VALID
VALUES
Accepts a string containing the following format:
object-name:property-name:change-type
object-name Specifies the internal name of the object type.
property-name Specifies the internal name of the property on the object type.
change-type Specifies the change type for the rule.
Valid values for change-type are:
AddedToStudy Specifies an action when the property is
added to the isolated study.
Changed Specifies an action when the property is
changed.
DeletedInStudy Specifies an action when the property is
removed from the isolated study.
MissingInStudy Specifies an action when the property is
added to the bill of process after the last
synchronization to the isolated study.
RemovedFromBOP Specifies an action when the property is
removed from the bill of process.
For example:
A value of Mfg0BvrContinuousJoinOperation:Mfg0calc_start_time:Changed
means that any modification to the Mfg0calc_start_time property on an object of

22-86 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

type Mfg0BvrContinuousJoinOperation between the isolated study and the bill of


process initiates a publication change to the isolated study.
DEFAULT
VALUE
Mode:Include
Mfg0BvrOperation:bl_rev_ProcessSimulate_Details
Mfg0BvrProcess:bl_rev_ProcessSimulate_Details
Mfg0BvrProcessArea:bl_rev_ProcessSimulate_Details
Mfg0BvrProcess:Mfg0sub_elements
Mfg0BvrProcessArea:Mfg0sub_elements
Mfg0BvrOperation:Mfg0predecessors
Mfg0BvrProcess:Mfg0predecessors
Mfg0BvrProcessArea:Mfg0predecessors
Mfg0BvrOperation:Mfg0consumed_material
Mfg0BvrProcess:Mfg0consumed_material
Mfg0BvrProcessArea:Mfg0consumed_material
Mfg0BvrOperation:Mfg0used_equipment
Mfg0BvrProcess:Mfg0used_equipment
Mfg0BvrProcessArea:Mfg0used_equipment
Mfg0BvrOperation:Mfg0allocated_features
Mfg0BvrProcess:Mfg0allocated_features
Mfg0BvrProcessArea:Mfg0allocated_features
Mfg0BvrOperation:Mfg0calc_dur_start_time
Mfg0BvrOperation:Mfg0calc_duration
Mfg0BvrOperation:Mfg0calc_start_time
Mfg0BvrProcessArea:Mfg0allocated_ops
MfgBvrBOPWorkarea:bl_all_child_lines
DEFAULT
PROTECTION
SCOPE
Site preference.

StudyTimeBasedPublishRule

DESCRIPTION
Defines the default rules for synchronizing from an isolated study to the original
structure.
The values in this preference are set by an administrator in the Manufacturing Process
Planner application using the Managing Synchronization Rules dialog box.
VALID
VALUES
Accepts a string containing the following format:
object-name:property-name:change-type
object-name Specifies the internal name of the object type.
property-name Specifies the internal name of the property on the object type.

PLM00026 11.2 Preferences and Environment Variables Reference 22-87


Chapter
Chapter 22:22:Related
Related topics
topics

change-type Specifies the change type for the rule.


Valid values for change-type are:
AddedToStudy Specifies an action when the property is
added to the isolated study.
Changed Specifies an action when the property is
changed.
DeletedInStudy Specifies an action when the property is
removed from the isolated study.
MissingInStudy Specifies an action when the property is
added to the bill of process after the last
synchronization to the isolated study.
RemovedFromBOP Specifies an action when the property is
removed from the bill of process.
For example:
A value of Mfg0BvrContinuousJoinOperation:Mfg0calc_start_time:Changed
means that any modification to the Mfg0calc_start_time property on an object of
type Mfg0BvrContinuousJoinOperation between the isolated study and the bill of
process initiates a publication change to the isolated study.
DEFAULT
VALUE
Mode:Include
Mfg0BvrOperation:bl_rev_ProcessSimulate_Details
Mfg0BvrProcess:bl_rev_ProcessSimulate_Details
Mfg0BvrProcessArea:bl_rev_ProcessSimulate_Details
Mfg0BvrProcess:Mfg0sub_elements
Mfg0BvrProcessArea:Mfg0sub_elements
Mfg0BvrOperation:Mfg0predecessors
Mfg0BvrProcess:Mfg0predecessors
Mfg0BvrProcessArea:Mfg0predecessors
Mfg0BvrOperation:Mfg0consumed_material
Mfg0BvrProcess:Mfg0consumed_material
Mfg0BvrProcessArea:Mfg0consumed_material
Mfg0BvrOperation:Mfg0used_equipment
Mfg0BvrProcess:Mfg0used_equipment
Mfg0BvrProcessArea:Mfg0used_equipment
Mfg0BvrOperation:Mfg0allocated_features
Mfg0BvrProcess:Mfg0allocated_features
Mfg0BvrProcessArea:Mfg0allocated_features
Mfg0BvrOperation:Mfg0calc_dur_start_time
Mfg0BvrOperation:Mfg0calc_duration
Mfg0BvrOperation:Mfg0calc_start_time
Mfg0BvrProcessArea:Mfg0allocated_ops
MfgBvrBOPWorkarea:bl_all_child_lines

22-88 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
Site preference.

StudyTimeBasedSyncRule

DESCRIPTION
Defines the default rules for synchronizing to an isolated study from the original
structure.
The values in this preference are set by an administrator in the Manufacturing Process
Planner application using the Managing Synchronization Rules dialog box.
VALID
VALUES
Accepts a string containing the following format:
object-name:property-name:change-type
object-name Specifies the internal name of the object type.
property-name Specifies the internal name of the property on the object type.
change-type Specifies the change type for the rule.
Valid values for change-type are:
AddedToStudy Specifies an action when the property is
added to the isolated study.
Changed Specifies an action when the property is
changed.
DeletedInStudy Specifies an action when the property is
removed from the isolated study.
MissingInStudy Specifies an action when the property is
added to the bill of process after the last
synchronization to the isolated study.
RemovedFromBOP Specifies an action when the property is
removed from the bill of process.
For example:
A value of Mfg0BvrContinuousJoinOperation:Mfg0calc_start_time:Changed
means that any modification to the Mfg0calc_start_time property on an object of
type Mfg0BvrContinuousJoinOperation between the isolated study and the bill of
process initiates a publication change to the isolated study.
DEFAULT
VALUE
Mode:Include
Mfg0BvrOperation:bl_rev_ProcessSimulate_Details
Mfg0BvrProcess:bl_rev_ProcessSimulate_Details
Mfg0BvrProcessArea:bl_rev_ProcessSimulate_Details
Mfg0BvrProcess:Mfg0sub_elements
Mfg0BvrProcessArea:Mfg0sub_elements

PLM00026 11.2 Preferences and Environment Variables Reference 22-89


Chapter
Chapter 22:22:Related
Related topics
topics

Mfg0BvrOperation:Mfg0predecessors
Mfg0BvrProcess:Mfg0predecessors
Mfg0BvrProcessArea:Mfg0predecessors
Mfg0BvrOperation:Mfg0consumed_material
Mfg0BvrProcess:Mfg0consumed_material
Mfg0BvrProcessArea:Mfg0consumed_material
Mfg0BvrOperation:Mfg0used_equipment
Mfg0BvrProcess:Mfg0used_equipment
Mfg0BvrProcessArea:Mfg0used_equipment
Mfg0BvrOperation:Mfg0allocated_features
Mfg0BvrProcess:Mfg0allocated_features
Mfg0BvrProcessArea:Mfg0allocated_features
Mfg0BvrOperation:Mfg0calc_dur_start_time
Mfg0BvrOperation:Mfg0calc_duration
Mfg0BvrOperation:Mfg0calc_start_time
Mfg0BvrProcessArea:Mfg0allocated_ops
MfgBvrBOPWorkarea:bl_all_child_lines
DEFAULT
PROTECTION
SCOPE
Site preference.

Time management preferences

MEAvailableTimeUnits

DESCRIPTION
Defines the list of customized (additional) available time units. Each value contains a
unique unit ID in English and a multiplier to convert from this unit to seconds (default
unit).
VALID
VALUES
Accepts one or more strings as values, each string must be formatted as follows:

unitID:multiplierToSeconds
For example:

myTimeUnitID:112.25
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
The time unit ID must be unique and in English.

22-90 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MECurrentTimeUnit

DESCRIPTION
Defines the ID of the time unit (as defined in the MEAvailableTimeUnits preference)
in which all new time data is displayed. Set this value using the Time pane in the ME
section of the preferences interface for the change to take effect without restarting
the application.
VALID
VALUES
Accepts a string as value that must be one of the out of the box time unit IDs listed
below or one of the IDs from the MEAvailableTimeUnits preference. This value
must be in English.
second
minute
10th_min
100th_min
1000th_min
hour
day
TMU
MOD
FAC

DEFAULT
VALUES
second
DEFAULT
PROTECTION
SCOPE
User preference.

METimeTabFilteredComponents

DESCRIPTION
Defines which objects are filtered out in the Activities section on the Time pane.
VALID
VALUES
Accepts any general object type, such as Form or Dataset, or a specific type such
as AllocationMap Master. You cannot filter out an activity. If an activity is listed
in this preference, it is ignored.
DEFAULT
VALUES
Form
Dataset
Folder

PLM00026 11.2 Preferences and Environment Variables Reference 22-91


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
All.

MEOperationActivitiesFilteredComponents

DESCRIPTION
Defines which objects are filtered out in the Operation Activities pane.
VALID
VALUES
Accepts any general object type, such as Form or Dataset, or a specific type such
as AllocationMap Master. You cannot filter out an activity. If an activity is listed
in this preference, it is ignored.
DEFAULT
VALUES
Form
Dataset
Folder
DEFAULT
PROTECTION
SCOPE
All.

MEActivityTypeColors

DESCRIPTION
Specifies the colors associated with the types of activities, as defined in the
time_system_category property of the MEActivity class. A color is represented by
a string composed of the red, green, and blue values of the color, separated by a
decimal point.
VALID
VALUES
Accepts one or more strings as a value. Each string must have the following format:
type;color
type is a value of the time_system_category property and color is the red, green, and
blue values of the corresponding color, separated by decimal point.
DEFAULT
VALUES
NA;212.208.200
VA;0.128.0
NVA;255.0.0
NVABR;255.165.0

DEFAULT
PROTECTION
SCOPE
Site and user preference.

22-92 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

RESTRICTIONS
The values of this preference should be set by the site manager.

MEDefaultActivityType

DESCRIPTION
Specifies the default type of a new activity created in the Activity section in the
operation Times pane in Manufacturing Process Planner.
VALID
VALUES
Accepts a string as a value. The value must be MEActivity or the name of a derived
class.
DEFAULT
VALUES
MEActivity
DEFAULT
PROTECTION
SCOPE
Site preference.

METimesActivityShownColumns

DESCRIPTION
Lists the column names of the attributes that are shown in the Activity table in the
operation Times pane in Manufacturing Process Planner.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid property of
CfgActivityLine.
DEFAULT
VALUES
me_cl_display_string
al_activity_time_system_code
al_activity_time_system_unit_time
al_activity_time_system_frequency
al_activity_work_time
al_activity_time_system_category
al_activity_time_system_description

DEFAULT
PROTECTION
SCOPE
Site and user preference.
NOTES
The values should not be modified directly, but by inserting, reordering, and removing
columns in the table.

PLM00026 11.2 Preferences and Environment Variables Reference 22-93


Chapter
Chapter 22:22:Related
Related topics
topics

METimesActivityShownColumnWidths

DESCRIPTION
Lists the widths of columns that appear in the Activity section of the operation Times
pane in Manufacturing Process Planner.
VALID
VALUES
One or more positive integers.
DEFAULT
VALUES
20
10
10
10
10
20
DEFAULT
PROTECTION
SCOPE
Site and user preference.
NOTES
You should not modify the values directly. Set these values by resizing columns in
the table.
RESTRICTIONS
The number of entries must match the entries of the METimesActivityShownColumns
preference.

METimeAnalysisReportDefinitionID

DESCRIPTION
Specifies the ID for the Time Analysis report.
VALID
VALUES
Accepts a valid report ID string.
DEFAULT
VALUES
TC_TIME_ANALYSIS_REPORT
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
You can also set this preference in the Time Reports section of the Time pane in the
Manufacturing section of the preferences Options dialog box.

MEAllocatedTimeReportDefinitionID

DESCRIPTION
Specifies the ID for the Allocated Time report.

22-94 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
Accepts a valid report ID string.
DEFAULT
VALUES
TC_ALLOCATED_TIME_REPORT
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
You can also set this preference in the Time Reports section of the Time pane in the
Manufacturing section of the preferences Options dialog box.

METimeAnalysisReportStylesheet

DESCRIPTION
Specifies the name of the XSL style sheet used for the Time Analysis report.
VALID
VALUES
Accepts a valid style sheet name.
DEFAULT
VALUES
TimeAnalysisReport.xls
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
You can also set this preference in the Time Reports section of the Time pane in the
Manufacturing section of the preferences Options dialog box.

MEAllocatedTimeReportStylesheet

DESCRIPTION
Specifies the name of the XSL style sheet used for the Allocated Time report.
For more information about creating time reports, see Manufacturing Process Planner.
VALID
VALUES
Accepts a valid style sheet name.
DEFAULT
VALUES
AllocatedTimeReport.xsl
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
You can also set this preference in the Time Reports section of the Time pane in the
Manufacturing section of the preferences Options dialog box.

PLM00026 11.2 Preferences and Environment Variables Reference 22-95


Chapter
Chapter 22:22:Related
Related topics
topics

METimeDataCardPath

DESCRIPTION
Specifies the location of the data card as URI. Use the goto protocol to navigate to an
MTM data card, and the file protocol to navigate to a custom HTMLdata card.
VALID
VALUES
A character string.
DEFAULT
VALUES
goto://MTMDataCard.eng
DEFAULT
PROTECTION
SCOPE
Site and user preference.
NOTES
You can also set this preference by typing a path name in the Data Card Location box
on the Time pane in the Manufacturing section of the preferences Options dialog box.

METimeDataCardConversionFactor

DESCRIPTION
Specifies the factor to convert from data card time units to seconds. It is applied to
time values from a data card. The standard MTM data cards hold times in TMU.
For more information about using MTM data cards, see Manufacturing Process
Planner.
VALID
VALUES
A character string.
DEFAULT
VALUES
goto://MTMDataCard.eng
DEFAULT
PROTECTION
SCOPE
Site and user preference.
NOTES
You can also set this preference by typing a value in the Time Unit Factor box on the
Time pane in the Manufacturing section of the preferences Options dialog box.

METIMEAllocatedTimePopulationMode

DESCRIPTION
Specifies which mode is used in the Populate allocated time command in the Time
pane.
For more information about working with allocated time, see Manufacturing Process
Planner.

22-96 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
0
Estimated time
1
Simulated time
2
Time analysis duration
3
Customized
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site and user preference.
RESTRICTIONS
The values of this preference should be set by the site manager.

METIMEPopulateAllocatedTimeUsedSources

DESCRIPTION
Specifies which time sources are used in which order when using the custom
allocated time population mode in the Time pane. The order of sources in this
preference defines the precedence in which they are used.
For more information about working with allocated time, see Manufacturing Process
Planner.
VALID
VALUES
A list of strings containing the used sources for population of allocated time. The list
can contain any of the following.
0
Allocated time
1
Simulated time
2
Time analysis duration
3
Estimated time
DEFAULT
VALUES
0

PLM00026 11.2 Preferences and Environment Variables Reference 22-97


Chapter
Chapter 22:22:Related
Related topics
topics

1
2
3
DEFAULT
PROTECTION
SCOPE
Site and user preference.
RESTRICTIONS
The values of this preference should be set by the site manager.

METIMEPopulateAllocatedTimeUpToLevelEnabled

DESCRIPTION
Specifies whether the option to update the allocated time to a certain level (Populate
up to level) is active in the Populate Allocated Time dialog box in the Time pane.
For more information about working with allocated time, see Manufacturing Process
Planner.
VALID
VALUES
True
The Populate up to level option is available.
False
The Populate up to level option is not available.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site and user preference.
RESTRICTIONS
The values of this preference should be set by the site manager.

METIMEPopulateAllocatedTimeUpToLevel

DESCRIPTION
Specifies the level to which the Populate Allocated Time command should be
executed.
For more information about working with allocated time, see Manufacturing Process
Planner.
VALID
VALUES
An integer value greater than or equal to 0. Setting this preference to 0 indicates that
all levels are populated.
DEFAULT
VALUES
0

22-98 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
Site and user preference.
RESTRICTIONS
The values of this preference should be set by the site manager.

METIMEPopulateAllocatedTimeZeroValuesEnabled

DESCRIPTION
Specifies whether zero values are populated while executing the Populate Allocated
Time command in the Time pane.
For more information about working with allocated time, see Manufacturing Process
Planner.
VALID
VALUES
True
Zero values are populated.
False
Zero values are not populated.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site and user preference.
RESTRICTIONS
The values of this preference should be set by the site manager.

METimeSystemWebServiceLocation

DESCRIPTION
Specifies the location of the WSDL description for the time system web service.
For more information about working with the TiCon integration, see Manufacturing
Process Planner.
VALID
VALUES
Accepts a string as value. The string must be a valid WSDL location.
For example:
http://localhost:4848/TiConService/?wsdl
http://your-company.com:52000/TiConService/?wsdl
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 22-99


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
You must restart Teamcenter for any changes in this preference value to take effect.
RESTRICTIONS
The values of this preference should be set by the site manager.

METimeSystemSearchCriterionFields

DESCRIPTION
Specifies the time system fields that can be searched for. You can group the fields in
different configurations.
For more information about working with the TiCon integration, see Manufacturing
Process Planner.
VALID
VALUES
One or more strings. Each string must have the following format:
configuration:fields
fields is a comma-separated list of field names. If you leave the configuration value
empty, the field appears in the default configuration.
DEFAULT
VALUES
:code,index,variant, dataareaid
DEFAULT
PROTECTION
SCOPE
Site and user preference.
NOTES
The search configurations combine both the criterion and result fields.
Although you can enter multiple configurations, Teamcenter currently displays only
the default configuration.
You cannot see changes made in this preference until you log off TiCon, close the
TiCon Search view, and log back on.

METimeSystemSearchResultFields

DESCRIPTION
Specifies the time system fields that are displayed in the search result when performing
a TiCon search in Manufacturing Process Planner. You can group the fields in different
configurations.
For more information about working with the TiCon integration, see Manufacturing
Process Planner.
VALID
VALUES
One or more strings. Each string must have the following format:

22-100 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

configuration:field_1;width_1,field_2;width_2,...field_n;width_n
field_x represents the time system field and width_x specifies the initial width of the
field_x column in the search result table. If you leave the configuration value empty,
the field appears in the default configuration.
DEFAULT
VALUES
:code;80,index;50,variant;50,dataareaid;80,description;160,tg;80,indicator1id;80
DEFAULT
PROTECTION
SCOPE
Site and user preference.
NOTES
The search configurations combine both the criterion and result fields.

Although you can enter multiple configurations, Teamcenter currently displays only
the default configuration.

You cannot see changes made in this preference until you log off TiCon, close the
TiCon Search view, and log back in.

You must close all TiCon Search views before changing this preference. If you do not,
Teamcenter overwrites your changes when you close the TiCon Search view.

METimeSystemUpdateIncludeStructure

DESCRIPTION
Specifies if the time element structure is included in assign and update actions when
working in the TiCon integration in Manufacturing Process Planner.

For more information about working with the TiCon integration, see Manufacturing
Process Planner.
VALID
VALUES
true
The structure is included.

false
The structure is not included.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site and user preference.
NOTES
You should modify this preference indirectly by changing the level setting in the Time
Element Insertion section of the TiCon Search view.

PLM00026 11.2 Preferences and Environment Variables Reference 22-101


Chapter
Chapter 22:22:Related
Related topics
topics

METimeSystemUpdateStructureLevel

DESCRIPTION
Specifies the level up to which the time element structure is included in assign and
update actions when working in the TiCon integration in Manufacturing Process
Planner.
For more information about working with the TiCon integration, see Manufacturing
Process Planner.
VALID
VALUES
An integer value representing the level, or -1 for unlimited.
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site and user preference.
NOTES
This preference should be modified indirectly by changing the level setting in the Time
Element Insertion section of the TiCon Search view.

METimeSystemFieldMappingDataset

DESCRIPTION
Specifies the dataset containing an XML file with the mapping of time system fields to
activity properties. The value of each specified field is applied to the corresponding
property whenever data is copied from the time system to Teamcenter.
For more information about setting up the mapping file, see Administering
Manufacturing Planning.
For more information about working with the TiCon integration, see Manufacturing
Process Planner
VALID
VALUES
A string with the format name:type:reference, where name specifies the name of the
dataset, type the dataset type, and reference the reference type for the file.
For example:
FieldMapping:Text:Text
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
RESTRICTIONS
The value of this preference should be set by the site manager.

22-102 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEActivityCustomTimeProperties

DESCRIPTION
Specifies the list of customer-defined properties of the CfgActivityLine class that are
treated as times in the activity tree of Activities and Time views. The values of these
properties are displayed in the time units selected in the Manufacturing section of
the Options dialog box.
For more information about working with the TiCon integration, see Manufacturing
Process Planner.
VALID
VALUES
One or more strings in a list. Each string must be a valid customer-defined property.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site and user preference.

Logistics planning preferences


MEPlantRevision.RENDERING

DESCRIPTION
Registers property style sheets for plant revision objects in Manufacturing Process
Planner when using logistics management.
For more information about logistics planning, see Manufacturing Process Planner.
VALID
VALUES
Accepts a valid style sheet name.
DEFAULT
VALUES
MEPlantRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

MEPlantRevision_DefaultChildProperties

DESCRIPTION
Defines the list of properties that can be used as children of the MEPlantRevision
object visible in Teamcenter.
For more information about logistics planning, see Manufacturing Process Planner.
VALID
VALUES
Accepts the internal name of Teamcenter properties.

PLM00026 11.2 Preferences and Environment Variables Reference 22-103


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
VALUE
IMAN_master_form
bom_view_tags
revision_list
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEView
IMAN_vi_sos
IMAN_external_object_link
TC_WorkContext_Relation
TC_AuditLog
commercialparts
LocationInCompany
ContactInCompany
TC_Quality_Document
DEFAULT
PROTECTION
SCOPE
Site preference.

MEPlantRevision_CompanyLocation_default_relation

DESCRIPTION
Specifies the relation that is created when a Plant Revision object is pasted to a
CompanyLocation object in a logistics bill of process.
For more information about logistics planning, see Manufacturing Process Planner.
VALID
VALUES
Accepts a valid Teamcenter relation type.
DEFAULT
VALUES
LocationInCompany
DEFAULT
PROTECTION
SCOPE
Site preference.

MEPlantRevision.SUMMARYRENDERING

DESCRIPTION
Registers summary style sheets for plant revision objects in Manufacturing Process
Planner when using logistics management.
For more information about logistics planning, see Manufacturing Process Planner.
VALID
VALUES
Accepts a valid style sheet name.

22-104 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
MEPlantRevisionSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

Manufacturing documentation preferences

AppInterface_TCPublishingTechnicalPortfolio_default_relation

DESCRIPTION
Used for configuring Teamcenter manufacturing process management technical
portfolios. Defines the default relation used when a TCPublishingTechnicalPortfolio
dataset is pasted under an intermediate data capture (IDC) while creating technical
portfolios.
VALID
VALUES
Accepts a single string as a value. Must be a valid Teamcenter relation.
DEFAULT
VALUES
IMAN_TCPublishedPortfolio
DEFAULT
PROTECTION
SCOPE
All.

AppInterface_TCPublishingTechnicalPortfolio_shown_relations

DESCRIPTION
Used for configuring Teamcenter manufacturing process management
technical portfolios. Defines the relations available when pasting a
TCPublishingTechnicalPortfolio dataset under an intermediate data capture (IDC)
while creating technical portfolios.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid
Teamcenter relation and it must include the value set for the
AppInterface_TCPublishingTechnicalPortfolio_default_relation
preference.
DEFAULT
VALUES
IMAN_TCPublishedPortfolio
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 22-105


Chapter
Chapter 22:22:Related
Related topics
topics

IMAN_MEWorkInstruction_relation_primary

DESCRIPTION
Defines which Teamcenter objects are used as primary objects with a
IMAN_MEWorkInstruction 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 multiple strings as values. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
ItemRevision
AppearanceGroup
PSOccurrence
DEFAULT
PROTECTION
SCOPE
All.

IMAN_PortfolioConfiguredPage_relation_primary

DESCRIPTION
Used for configuring Teamcenter manufacturing process management technical
portfolios. Defines which Teamcenter objects are used as primary objects with a
IMAN_PortfolioConfiguredPage relation.
The default value of this preference should not be changed.
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 string must be a valid Teamcenter object.
DEFAULT
VALUES
TCPublishingTechnicalPortfolio
DEFAULT
PROTECTION
SCOPE
All.

22-106 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

IMAN_PortfolioPage_relation_primary

DESCRIPTION
Used for configuring Teamcenter manufacturing process management technical
portfolios. Defines which Teamcenter objects are used as primary objects with a
IMAN_PortfolioPage relation.
The default value of this preference should not be changed.
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 string must be a valid Teamcenter object.
DEFAULT
VALUES
TCPublishingTechnicalPortfolio
DEFAULT
PROTECTION
SCOPE
All.

IMAN_PublishingPageAssetContext_relation_primary

DESCRIPTION
Used for configuring Teamcenter manufacturing process management
technical portfolios. Defines which Teamcenter objects can be used with a
IMAN_PublishingPageAssetContext relation.
The default value of this preference should not be changed.
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 string must be a valid Teamcenter object.
DEFAULT
VALUES
IMAN_TCPublishedPortfolio

PLM00026 11.2 Preferences and Environment Variables Reference 22-107


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
All.

IMAN_TCPublishedPortfolio_relation_primary

DESCRIPTION
Used for configuring Teamcenter manufacturing process management technical
portfolios. Defines which Teamcenter objects are used as primary objects with a
IMAN_TCPublishedPortfolio 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 multiple strings as values. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
TCPublishingTechnicalPortfolio
AppInterface
DEFAULT
PROTECTION
SCOPE
All.

ItemRevision_TCPublishingPage_default_relation

DESCRIPTION
Used for configuring Teamcenter manufacturing process management technical
portfolios. Defines the default relation created when a publishing page is pasted
within an item revision.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter relation.
DEFAULT
VALUES
IMAN_MEWorkInstruction
DEFAULT
PROTECTION
SCOPE
All.

22-108 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

<TC Publishing Page type>_DefaultChildProperties

DESCRIPTION
Used for configuring Teamcenter manufacturing process management technical
portfolios. Determines which properties are children of the indicated publishing page
type. Each type requires its own preference. The format for each preference is:

Publishing-Page-type-name_DefaultChildProperties=Teamcenter property
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter property.
DEFAULT
VALUES
IMAN_PublishingPageAssetContext
VisAssetPopulatedByEndobj
DEFAULT
PROTECTION
SCOPE
All.

<TC Publishing Technical Portfolio type>_DefaultChildProperties

DESCRIPTION
Used for configuring Teamcenter manufacturing process management technical
portfolios. Determines which properties are children of the indicated technical portfolio
type. Each type requires its own preference. The format for each preference is:

Technical-Portfolio-type-name_DefaultChildProperties=Teamcenter property
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter property.
DEFAULT
VALUES
IMAN_PortfolioPage
IMAN_PortfolioConfiguredPage
IMAN_TCPublishedPortfolio
DEFAULT
PROTECTION
SCOPE
All.

ME3DPDFAllowedImageDatasetTypes

DESCRIPTION
Specifies a list of 2D product views and dataset types that are available to choose
from when creating new 2D PDF reports.
VALID
VALUES
Accepts one or more strings which are valid dataset types.

PLM00026 11.2 Preferences and Environment Variables Reference 22-109


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
VALUES
SnapShotViewData
Bitmap
JPEG
GIF
TIF
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

ME3DPDFAllowedReportTemplate

DESCRIPTION
Specifies a list of PDF templates that are available to choose from for 3D PDF report
generation. The order defines the default template.
VALID
VALUES
Accept one or more strings as values; each string must be a name of a valid
Mes0PDFReportTemplate object.
DEFAULT
VALUES
3DPDF Work instructions
3DPDF Rich textual work instructions
2DPDF Work-instructions
3DPDF Work instructions with 2D images
3DPDF Work instructions (Process Simulate)
Animated PDF Work-instructions
2DPDF Work Instruction with activities
3DPDF Work Instructions with activities
Part list with 3D
Part List
Tool List
2DPDF Multipage work instructions
2DPDF Work Instructions - Paper Based

DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
The list can contain templates for both Teamcenter and Process Simulate data.
The first Teamcenter data template in the list is used as the default template for a
Teamcenter scenario, and the first Process Simulate data template in the list is used
as the default template for a Process Simulate scenario.

For more information, see Administering Manufacturing Planning.

22-110 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

ME3DPDFEncodingTypes

DESCRIPTION
Provides a list of encoding types required by the 3DPDF mechanism when generating
reports containing Process Simulate data. The XML files that are used to create the
report must be set with an encoding type that supports the specific language in which
the report is being generated.
The 3DPDF report is generated using the first value in the list.
For more information about generating 3D PDF reports, see Manufacturing Process
Planner.
VALID
VALUES
Accepts a list of encoding types supporting the following languages.
Windows-1252: French, German, Italian, Spanish, Swedish, Scottish,
Portuguese, Irish, Dutch, Albanian, Finnish, Danish, Norwegian
Windows-1251: Russian, Bulgarian, Serbian, Ukranian, Uzbek

GB-2312: Simplified Chinese

ISO-8859-8: Hebrew

Windows-1250: Croatian, Czech, Hungarian, Polish, Romanian, Transliterated


Serbian, Slovak

Shift_JIS: Japanese

EUC-KR: Korean

Big5: Traditional Chinese

DEFAULT
VALUES
Windows-1252
Windows-1251
GB-2312
ISO-8859-8
Windows-1250
Shift_JIS
EUC-KR
Big5
DEFAULT
PROTECTION
SCOPE
Site preference.

ME3DPDFReportDatasetType

DESCRIPTION
Specifies the type of dataset that is created for new PDF reports.

PLM00026 11.2 Preferences and Environment Variables Reference 22-111


Chapter
Chapter 22:22:Related
Related topics
topics

For more information about generating 3D PDF reports, see Manufacturing Process
Planner.
VALID
VALUES
A single string which is a valid dataset type derived from Mes0PDFReport.
DEFAULT
VALUES
Mes0PDFReport
DEFAULT
PROTECTION
SCOPE
Site preference.

TCPUBLISH_BATCH_CLASSES

DESCRIPTION
Defines the list of Teamcenter classes to use on the TC Publish Batch Select Types
and Templates wizard page.
VALID
VALUES
Accepts any valid Teamcenter class.
DEFAULT
VALUES
ItemRevision
MEProcessRevision
MEOPRevision
MEActivity

DEFAULT
PROTECTION
SCOPE
Site preference.

TCPUBLISH_BATCH_ROLE

DESCRIPTION
Defines a role relation between the publishing page and its owning object.
VALID
VALUES
Accepts any string identifier.
DEFAULT
VALUES
IMAN_MEWorkInstruction
TC_MEProductManual
DEFAULT
PROTECTION
SCOPE
All.

22-112 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

TCPUBLISH_BATCH_<role>_PAGE_TEMPLATE_FAVORITES

DESCRIPTION
Stores a list of template favorites for the publish batch process.
VALID
VALUES
The IDs of the templates in the database separated by a comma.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

TCPUBLISH_BATCH_<role>_PORTFOLIO_TEMPLATE_FAVORITES

DESCRIPTION
Stores a list of template favorites for the batch updating of portfolios.
VALID
VALUES
The IDs of the portfolio templates in the database separated by a comma.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

TCPUBLISH_BATCH_<role>_TEMPLATES

DESCRIPTION
Lists templates that are associated with Teamcenter classes. These templates are
used for the create task.
VALID
VALUES
The IDs of the templates in the database separated by a comma.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

TCPublish_synchronized_asset_relations

DESCRIPTION
Defines names of relation types that link parent publishing page datasets with other
objects, where the links in Teamcenter must match those stored as asset properties via

PLM00026 11.2 Preferences and Environment Variables Reference 22-113


Chapter
Chapter 22:22:Related
Related topics
topics

the createRelation path element attribute in the alias definition. Causes the relations
to be created and removed in Teamcenter to match what is saved in the dataset.
VALID
VALUES
Relation type names.
DEFAULT
VALUES
VisAssetPopulatedByEndobj
DEFAULT
PROTECTION
SCOPE
All.
NOTES
Relations not in this list are not removed if an asset is deleted or repopulated.

TCPublishing_Activities_Role

DESCRIPTION
Determines the role of all publishing page datasets attached to activities used in
Manufacturing Process Planner. The role also determines the name displayed on
the publishing page tab. Users use this tab to create published pages containing
manufacturing data.
VALID
VALUES
Accepts a single string as a value. Must be a valid relation type used to define the
role of publishing page datasets.
DEFAULT
VALUES
IMAN_MEWorkInstruction

Note

If this value is changed, a closure rule and transfer mode is required to generate
portfolios. Define the desired transfer mode using the transfer mode defined by
the TechnicalPortfolioTransferMode_IMAN_MEWorkInstruction preference
as a template, creating a new preference pointing to the transfer node. Define
the role using the TechnicalPortfolioRoles preference.

DEFAULT
PROTECTION
SCOPE
All.

TCPublishing_Aliases.Activities

DESCRIPTION
Determines which alias file dataset names appear when users load alias files for
activity pages. If left undefined, all alias files appear. This preference is used for
Manufacturing Process Planner.

22-114 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid alias file dataset.
DEFAULT
VALUES
Installed Aliases
DEFAULT
PROTECTION
SCOPE
All.

TCPublishing_Aliases.IMAN_MEWorkInstruction

DESCRIPTION
Used for configuring Teamcenter manufacturing process management technical
portfolios. Defines which alias datasets display when loading alias files for
IMAN_MEWorkInstruction pages. If not configured, all alias files are listed.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter alias
dataset.
DEFAULT
VALUES
Installed Aliases
DEFAULT
PROTECTION
SCOPE
All.

TCPublishing_Default_Alias_File

DESCRIPTION
Used for configuring Teamcenter manufacturing process management technical
portfolios. Defines the default alias file loaded when a new publishing page is viewed.
Warning

The default alias file is automatically loaded by the system. This file is subject to
update in the future. Do not change the default setting. Create your own alias
files using the TechnicalPortfolioRoles preference.

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter alias
dataset.
DEFAULT
VALUES
Installed Aliases
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 22-115


Chapter
Chapter 22:22:Related
Related topics
topics

TechnicalPortfolioRoles

DESCRIPTION
Used for configuring Teamcenter manufacturing process management technical
portfolios. Use this preference to define the roles of technical portfolios. You can
create custom alias files, which are tracked by the system on a per-role basis. Alias
files accept a single named reference.
VALID
VALUES
Accepts a single string as a value. Must be a valid Teamcenter relation.
DEFAULT
VALUES
IMAN_MEWorkInstruction
DEFAULT
PROTECTION
SCOPE
All.

TechnicalPortfolioTransferMode_IMAN_MEWorkInstruction

DESCRIPTION
Used for configuring Teamcenter manufacturing process management technical
portfolios. Defines the transfer mode of the specified technical portfolio. TransferMode
objects control the related data exported into a PLM XML document.
VALID
VALUES
Accepts a single string as a value. Must be a valid Teamcenter TransferMode object.
DEFAULT
VALUES
ConfiguredDataExportDefault
DEFAULT
PROTECTION
SCOPE
All.

VisAssetPopulatedByEndobj_relation_primary

DESCRIPTION
Defines primary objects permitted for VisAssetPopulatedByEndobj relations.
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
Object type names.

22-116 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
TCPublishingPage
DEFAULT
PROTECTION
SCOPE
All.

Manufacturing search preferences

ME_Proximity_search_result_occ_type

DESCRIPTION
Defines the occurrence type that represents a proximity search result collection in the
process structure.
VALID
VALUES
Accepts a single string as value. The string must be a valid occurrence type.
DEFAULT
VALUE
MEFilteredIPA
DEFAULT
PROTECTION
SCOPE
Site preference.

ME_Proximity_search_result_occ_group_type

DESCRIPTION
Defines the occurrence group type that represents a proximity search result collection
in the process structure.
VALID
VALUES
Accepts a single string as value. The string must be a valid occurrence group type.
DEFAULT
VALUE
MEProximityResult
DEFAULT
PROTECTION
SCOPE
Site preference.

ME_Proximity_FilteredIPA_root_name

DESCRIPTION
Defines the name of the flat list collection that holds all the proximity search result
groups.

PLM00026 11.2 Preferences and Environment Variables Reference 22-117


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts a single string as value. The string must be a valid occurrence group type.
DEFAULT
VALUE
Proximity_Search_Results
DEFAULT
PROTECTION
SCOPE
Site preference.

ME_Proximity_FilteredIPA_suffix

DESCRIPTION
Defines the suffix of the filtered IPA names when the occurrence group holds proximity
search result.
VALID
VALUES
Accepts a single string as value.
DEFAULT
VALUE
_fipa
DEFAULT
PROTECTION
SCOPE
Site preference.

MEAdvancedSearchResultsViewColumnsShownPref

DESCRIPTION
Specifies the list of the columns displayed in the Search Result pane in the Structure
Search Results view when performing a manufacturing structure search.
VALID
VALUES
The system name of each column in the order you want them to appear, that is,
value_1, value_2 and so on.
DEFAULT
VALUE
bl_indented_title
bl_item_object_type
bl_item_object_desc
DEFAULT
PROTECTION
SCOPE
Site preference.

22-118 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEAdvancedSearchResultsViewColumnsShownWidthPref

DESCRIPTION
Specifies the width of the columns displayed in the Search Result pane
in the Structure Search Results view when performing a manufacturing
structure search. This setting affects each column defined in the
MEAdvancedSearchResultsViewColumnsShownPref preference.
VALID
VALUES
Integers that define the number of characters permitted in each
column. There should be one value for each column defined in the
MEAdvancedSearchResultsViewColumnsShownPref preference, and the values
are applied in the same order (that is, the first value in this preference is applied to the
first column in the MEAdvancedSearchResultsViewColumnsShownPref and so on).
DEFAULT
VALUE
50
50
50
DEFAULT
PROTECTION
SCOPE
Site preference.

Enterprise BOP preferences

MEDisplayOnAssign

DESCRIPTION
Enables the display of assigned parts in the corresponding graphics in the Paste
command of the Manufacturing Process Planner application.
VALID
VALUES
true
false
DEFAULT
VALUE
true
DEFAULT
PROTECTION
SCOPE
All.

MEGenericBopContextColumnsShownPref

DESCRIPTION
Specifies the list of the columns displayed in the base view of the generic BOP.

PLM00026 11.2 Preferences and Environment Variables Reference 22-119


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
The system name of each column in the order you want them to appear, that is,
value_1, value_2 and so on.
DEFAULT
VALUE
bl_indented_title
bl_item_object_desc
logical_designator
DEFAULT
PROTECTION
SCOPE
All.

MEProductBopContextColumnsShownPref

DESCRIPTION
Specifies the list of the columns displayed in the base view of the product BOP.
VALID
VALUES
The system name of each column in the order you want them to appear, that is,
value_1, value_2 and so on.
DEFAULT
VALUE
bl_indented_title
bl_item_object_desc
logical_designator
DEFAULT
PROTECTION
SCOPE
All.

MEGenericBopContextPartitionColumnsShownPref

DESCRIPTION
Specifies the list of the columns displayed in the Partitions pane of the generic BOP.
VALID
VALUES
The system name of each column in the order you want them to appear, that is,
value_1, value_2 and so on.
DEFAULT
VALUE
bl_indented_title
bl_item_object_desc
Mfg0ld_representation
DEFAULT
PROTECTION
SCOPE
All.

22-120 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEProductBopContextPartitionColumnsShownPref

DESCRIPTION
Specifies the list of the columns displayed in the Partitions pane of the product BOP.
VALID
VALUES
The system name of each column in the order you want them to appear, that is,
value_1, value_2 and so on.
DEFAULT
VALUE
bl_indented_title
bl_item_object_desc
Mfg0ld_representation
DEFAULT
PROTECTION
SCOPE
All.

MEProductBopContextPartitionColumnsShownWidthsPref

DESCRIPTION
Specifies the width of the columns displayed in the Partitions tab
of the product BOP. This setting affects each column defined in the
MEProductBopContextPartitionColumnsShownPref preference.
VALID
VALUES
Integers that define the number of characters permitted in each
column. There should be one value for each column defined in the
MEProductBopContextPartitionColumnsShownPref preference, and the values
are applied in the same order (that is, the first value in this preference is applied to the
first column in the MEProductBopContextPartitionColumnsShownPref and so on).
DEFAULT
VALUE
25
25
50
DEFAULT
PROTECTION
SCOPE
All.

MEAssignmentIndicationDefault

DESCRIPTION
Specifies the default Accountability Check favorite to be used internally for the Visual
Assignment Check feature.
VALID
VALUES
Format: AssignmentIndication_<Source type><Target type>:<Default AC favorite
name>.

PLM00026 11.2 Preferences and Environment Variables Reference 22-121


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
All.

MEAssignmentIndicationGraphicsMode

DESCRIPTION
Holds the last selected graphics mode in the Visual Assignment Check view.
VALID
VALUES
This is an internal preference. Do not modify this value.
DEFAULT
VALUE
Blank
DEFAULT
PROTECTION
SCOPE
All.

MEAssignmentIndicationTransparencyValue

DESCRIPTION
Defines the transparency value to be used in the Visual Assignment Check.
VALID
VALUES
0.1 - 0.9
DEFAULT
VALUE
0.9
DEFAULT
PROTECTION
SCOPE
All.

MEAssignmentStateBypassICForStatus

DESCRIPTION
Bypasses the changes to be tracked in the incremental change (IC) context during
the resolve action in enterprise bill of process (EBOP) structures in Manufacturing
Process Planner.
VALID
VALUES
Accepts the names of the release statuses for which incremental change is to be
turned off.
release-status:true|false

22-122 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

For example:
Prototype:true
Pre-release:true
Production:false
Published:false
default:false
none:false

If there is no value in this preference or the preference contains an empty value,


Teamcenter turns off incremental change for every release status and for structures
that do not contain any release status.
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
All.

MEAssignmentStateEnable

DESCRIPTION
Enables the assignment state for resolved assigned occurrence objects in enterprise
bill of process (EBOP) structures in Manufacturing Process Planner. When you resolve
part assignments, you can set a state for the assignment allowing it to go through
a manual review and approval process.
VALID
VALUES
true Teamcenter assigns a state to the resolved part.
false Teamcenter does not assign a state to the resolved part.
DEFAULT
VALUE
true
DEFAULT
PROTECTION
SCOPE
All.

MEAssignmentStatesForTarget

DESCRIPTION
Specifies the assignment states that are considered to reference the consumed parts
in the target structure when cloning or allocating a process structure. When cloning or
allocating a process or operation, only the parts that have the assigned states specified
in this preference are carried over and consumed by the cloned process or operation.
If no value is specified, all the consumed parts are referenced in the target structure.
VALID
VALUES
Accepts any of the following values:

PLM00026 11.2 Preferences and Environment Variables Reference 22-123


Chapter
Chapter 22:22:Related
Related topics
topics

No State
Pending
Accepted
Rejected
DEFAULT
VALUE
Pending
DEFAULT
PROTECTION
SCOPE
All.

MEAssignmentStateInitial

DESCRIPTION
Specifies the initial value given to the assignment state of resolved assigned
occurrence objects during the Resolve Logical Part Assignments operation in
enterprise bill of process (EBOP) structures in Manufacturing Process Planner.
VALID
VALUES
Accepts one of the following values:
No State
Pending
Accepted
Rejected
DEFAULT
VALUE
Pending
DEFAULT
PROTECTION
SCOPE
All.

MERetainResolvedParts

DESCRIPTION
Specifies whether the resolved parts under a logical assignment are retained if the
logical assignment is resolved. If you set this preference to true:
• Parts from all products for which the resolve action is carried out are displayed as
consumed parts.

• If parts are configured out of the structure, they are still displayed in the
Assignments view.

• If you remove a part from the product structure, you can still see the part in the
Assignments view although it is not visible in the structure view.

22-124 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
true Teamcenter does not remove the existing resolved part when
resolving again.
false Teamcenter removes the existing resolved part when it resolves
again.
DEFAULT
VALUE
false
DEFAULT
PROTECTION
SCOPE
All.

MEAssignmentsViewColumnsShownPref

DESCRIPTION
Specifies the list of the columns displayed in the Assignments view.
VALID
VALUES
The system name of each column in the order you want them to appear, that is,
value_1, value_2 and so on.
DEFAULT
VALUE
bl_indented_title
bl_item_object_type
bl_item_object_desc, bl_occ_type
DEFAULT
PROTECTION
SCOPE
All.

MEAssignmentsViewColumnsShownWidthPref

DESCRIPTION
Specifies the width of the columns displayed in the Assignments view. This setting
affects each column defined in the MEAssignmentsViewColumnsShownPref
preference.
VALID
VALUES
Integers that define the number of characters permitted in each
column. There should be one value for each column defined in the
MEAssignmentsViewColumnsShownPref preference, and the values are applied in
the same order (that is, the first value in this preference is applied to the first column in
the MEAssignmentsViewColumnsShownPref and so on).
DEFAULT
VALUE
50
50
50

PLM00026 11.2 Preferences and Environment Variables Reference 22-125


Chapter
Chapter 22:22:Related
Related topics
topics

50
DEFAULT
PROTECTION
SCOPE
All.

MELogicalDesignatorFormNameSuffix

DESCRIPTION
Specifies the suffix to the logical designator form. The form name for operations or
processes is:
item_id-this_preference_value
The form name for partitions is:
partition_name-this_preference_value
VALID
VALUES
Any string.
DEFAULT
VALUE
LD
DEFAULT
PROTECTION
SCOPE
All.

MELogicalDesignatorDelimiter

DESCRIPTION
Specifies the delimiter in the displayed name of the logical designator form. The
format is:
value_1this_preference_value....value_nthis_preference_value
VALID
VALUES
Any character.
DEFAULT
VALUE
;
DEFAULT
PROTECTION
SCOPE
All.

GenericBOPTemplate

DESCRIPTION
Defines the action rules when using a generic BOP as the template for the creation of a
product BOP. Generic BOP templates are available in Manufacturing Process Planner.

22-126 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter naming
rule. Naming rules are created in Business Modeler IDE.
For more information, see Business Modeler IDE.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Ignore
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0METraceOriginRel:EBOPCreate
*:*:Relation.Mfg0MELogicalDesignatorRel:Clone
*:*:Relation.IMAN_specification:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
DEFAULT
PROTECTION
SCOPE
All.
NOTES
• Product assignments are not mapped.

• The logical designator form is cloned with the process or operation.

• The partition structure (if any) is cloned.

ProductBOPTemplate

DESCRIPTION
Defines the action rules when using a product BOP as the template for creating another
product BOP. Product BOP templates are available in Manufacturing Process Planner.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter naming
rule. Naming rules are created in Business Modeler IDE.
For more information, see Business Modeler IDE.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone

PLM00026 11.2 Preferences and Environment Variables Reference 22-127


Chapter
Chapter 22:22:Related
Related topics
topics

*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Ignore
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0METraceOriginRel:EBOPReference
*:*:Relation.Mfg0MELogicalDesignatorRel:Clone
*:*:Relation.IMAN_specification:Clone
*:*:Relation.IMAN_MEView:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference

DEFAULT
PROTECTION
SCOPE
All.

GenericBOPAllowedTemplates

DESCRIPTION
Defines the cloning rules available when using a generic BOP as a template for the
creation of a product BOP. The rules in this preference are displayed in the Cloning
Rule menu of the Configuration pane of the Enter Template Information step in
the New Product BOP wizard.
VALID
VALUES
Accepts a list of names of cloning rules.
DEFAULT
VALUES
GenericBOPTemplate
DEFAULT
PROTECTION
SCOPE
All.

ProductBOPAllowedTemplates

DESCRIPTION
Defines the cloning rules available when using a product BOP as a template for the
creation of another product BOP. The rules in this preference are displayed in the
Cloning Rule menu of the Configuration pane of the Enter Template Information
step in the New Product BOP wizard.
VALID
VALUES
Accepts a list of names of cloning rules.
DEFAULT
VALUES
ProductBOPTemplate

22-128 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
All.

MEGenericBOP.MEGenericBOP.PasteDuplicateTemplate

DESCRIPTION
Defines the default cloning rule used when the Paste Duplicate command is executed
between one generic BOP context and another generic BOP context.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter naming
rule. Naming rules are created in Business Modeler IDE.
For more information, see Business Modeler IDE.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Ignore
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0METraceOriginRel:Ignore
*:*:Relation.Mfg0MELogicalDesignatorRel:Clone
*:*:Relation.IMAN_specification:Clone
*:*:Relation.IMAN_MEView:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference

DEFAULT
PROTECTION
SCOPE
All.

MEGenericBOP.MEProductBOP.PasteDuplicateTemplate

DESCRIPTION
Defines the default cloning rule used when the Paste Duplicate command is executed
between a generic BOP context and a product BOP context.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter naming
rule. Naming rules are created in Business Modeler IDE.
For more information, see Business Modeler IDE.

PLM00026 11.2 Preferences and Environment Variables Reference 22-129


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Ignore
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0METraceOriginRel:Ignore
*:*:Relation.Mfg0MELogicalDesignatorRel:Clone
*:*:Relation.IMAN_specification:Clone
*:*:Relation.IMAN_MEView:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
DEFAULT
PROTECTION
SCOPE
All.

MEProductBOP.MEProductBOP.PasteDuplicateTemplate

DESCRIPTION
Defines the default cloning rule used when the Paste Duplicate command is executed
between a product BOP context and another product BOP context.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter naming
rule. Naming rules are created in Business Modeler IDE.
For more information, see Business Modeler IDE.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Ignore
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0METraceOriginRel:Ignore
*:*:Relation.Mfg0MELogicalDesignatorRel:Clone
*:*:Relation.IMAN_specification:Clone
*:*:Relation.IMAN_MEView:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone

22-130 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
DEFAULT
PROTECTION
SCOPE
All.

MEProductBOP.MEGenericBOP.PasteDuplicateTemplate

DESCRIPTION
Defines the default cloning rule used when the Paste Duplicate command is executed
between a product BOP context and a generic BOP context.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter naming
rule. Naming rules are created in Business Modeler IDE.
For more information, see Business Modeler IDE.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.MEConsumed:Ignore
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0METraceOriginRel:Ignore
*:*:Relation.Mfg0MELogicalDesignatorRel:Clone
*:*:Relation.IMAN_specification:Clone
*:*:Relation.IMAN_MEView:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
DEFAULT
PROTECTION
SCOPE
All.

PasteDuplicateTemplates

DESCRIPTION
Defines the list of cloning rules that are considered by the Paste Duplicate command.
Teamcenter chooses the appropriate rule by matching the type names that are used
as the rule name prefixes with the type names of the contexts participating in the
Paste Duplicate operation.

PLM00026 11.2 Preferences and Environment Variables Reference 22-131


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts the names of cloning rules in the format
SourceContextType.TargetContextType.RuleName.
DEFAULT
VALUES
MEGenericBOP.MEProductBOP.PasteDuplicateTemplate
MEProductBOP.MEProductBOP.PasteDuplicateTemplate
MEGenericBOP.MEGenericBOP.PasteDuplicateTemplate
MEProductBOP.MEGenericBOP.PasteDuplicateTemplate
MEOP.MEGenericBOP.PasteDuplicateTemplate
MEOP.MEProductBOP.PasteDuplicateTemplate
MEProcess.MEGenericBOP.PasteDuplicateTemplate
MEProcess.MEProductBOP.PasteDuplicateTemplate
MEProcess.MEProcess.PasteDuplicateTemplate
MEOP.MEProcess.PasteDuplicateTemplate
MEWorkarea.MEWorkarea.PasteDuplicateTemplate
Item.Item.PasteDuplicateTemplate
DEFAULT
PROTECTION
SCOPE
All.

PasteDuplicateAllowedPlantBOPTemplates

DESCRIPTION
Defines the list of cloning rules names to be used when pasting duplicate objects
(clones) between different types of plant bills of process.
VALID
VALUES
Accepts the names of cloning rules in the format
SourceContextType.TargetContextType.RuleName where:

SourceContextType Specifies the root object type of the source structure.


TargetContextType Specifies the root object type of the target structure.
RuleName Specifies the name of the cloning rule used.

DEFAULT
VALUES
MEGenericBOP.Mfg0MEPlantBOP.PasteDuplicateTemplate
MEProductBOP.Mfg0MEPlantBOP.PasteDuplicateTemplate
Mfg0MEPlantBOP.Mfg0MEPlantBOP.PasteDuplicateTemplate
MEProcess.Mfg0MEPlantBOP.PasteDuplicateTemplate
MEOP.Mfg0MEPlantBOP.PasteDuplicateTemplate

DEFAULT
PROTECTION
SCOPE
User preference.

22-132 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEGenericBOP.Mfg0MEPlantBOP.PasteDuplicateTemplate

DESCRIPTION
Defines the default cloning rule used when the Paste Duplicate command is executed
between a generic BOP context and a plant BOP context.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter cloning
rule.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0METraceOriginRel:Ignore
*:*:Relation.Mfg0MELogicalDesignatorRel:Clone
*:*:Relation.IMAN_specification:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.METimeAnalysisRelation:Clone
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
DEFAULT
PROTECTION
SCOPE
User preference.

MEProductBOP.Mfg0MEPlantBOP.PasteDuplicateTemplate

DESCRIPTION
Defines the default cloning rule used when the Paste Duplicate command is executed
between a product BOP context and a plant BOP context.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter cloning
rule.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.*:Reference

PLM00026 11.2 Preferences and Environment Variables Reference 22-133


Chapter
Chapter 22:22:Related
Related topics
topics

*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0METraceOriginRel:Ignore
*:*:Relation.Mfg0MELogicalDesignatorRel:Clone
*:*:Relation.IMAN_specification:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.METimeAnalysisRelation:Clone
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
DEFAULT
PROTECTION
SCOPE
User preference.

Mfg0MEPlantBOP.Mfg0MEPlantBOP.PasteDuplicateTemplate

DESCRIPTION
Defines the default cloning rule used when the Paste Duplicate command is executed
between a plant BOP context and a plant BOP context.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter cloning
rule.
Note

The EBOPReference action is applied only for origin links if the paste action is
within the same plant BOP structure. All other cases use the Ignore action.

DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0METraceOriginRel:EBOPReference
*:*:Relation.Mfg0MELogicalDesignatorRel:Clone
*:*:Relation.IMAN_specification:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.METimeAnalysisRelation:Clone
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
DEFAULT
PROTECTION
SCOPE
User preference.

22-134 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Mfg0MEPlantBOPRevisionColumnsShownPref

DESCRIPTION
Defines the columns displayed in the base view of a plant BOP.
VALID
VALUES
Accepts the internal name of each column in the order you want them to appear.
For example:
value_1, value_2, and so on.
DEFAULT
VALUES
bl_indented_title
bl_item_object_type
bl_item_object_desc

DEFAULT
PROTECTION
SCOPE
Site preference.

Mfg0MEPlantBOPRevisionDisplayNameColumnsShownPref

DESCRIPTION
Stores the internal names of the BOM line properties that are displayed as columns
in the plant view.
This preference is an internal preference and should be modified by the code only.
VALID
VALUES
Accepts the internal name of each column in the order you want them to appear.
For example:
object_type, property_name, and so on.
DEFAULT
VALUES
BOMLine.bl_indented_title
BOMLine.bl_item_object_type
BOMLine.bl_item_object_desc

DEFAULT
PROTECTION
SCOPE
Site preference..

Mfg0MEPlantBOPRevisionShownColumnWidthsPref

DESCRIPTION
Specifies the width of the columns displayed in the base view of
the plant BOP. This setting affects each column defined in the
Mfg0MEPlantBOPRevisionColumnsShownPref preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-135


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts a list of integers that define the number of characters permitted in
each column. There should be one value for each column defined in the
Mfg0MEPlantBOPRevisionColumnsShownPref preference, and the values are
applied in the same order (that is, the first value in this preference is applied to the first
column in the Mfg0MEPlantBOPRevisionColumnsShownPref, and so on).
DEFAULT
VALUES
25
25
25
DEFAULT
PROTECTION
SCOPE
Site preference.

Mfg0MEPlantBOPRevisionOccGroupColumnsShownPref

DESCRIPTION
Defines the columns to display in the partition tab of the plant BOP.
VALID
VALUES
Accepts the internal name of each column in the order you want them to appear.
For example:
value_1, value_2, and so on.
DEFAULT
VALUES
Bl_indented_title
bl_item_object_type
bl_item_object_desc

DEFAULT
PROTECTION
SCOPE
Site preference.

Mfg0MEPlantBOPRevisionOccGroupDisplayNameColumnsShownPref

DESCRIPTION
Specifies the internal names of the BOP line properties that are displayed as columns
in the partition tab of plant BOP structures.
This preference is an internal preference and should be modified by the code only.
VALID
VALUES
Accepts the internal name of each column in the order they are to appear. For example:
object_type, property_name, and so on.

22-136 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
BOMLine.bl_indented_title
BOMLine.bl_item_object_type
BOMLine.bl_item_object_desc

DEFAULT
PROTECTION
SCOPE
Site preference.

Mfg0MEPlantBOPRevisionOccGroupShownColumnWidthsPref

DESCRIPTION
Defines the width of the columns displayed in the
partitions tab of the plant BOP, as defined by the
Mfg0MEPlantBOPRevisionOccGroupDisplayNameColumnsShownPref
preference.
This setting affects each column defined in the
Mfg0MEPlantBOPRevisionOccGroupDisplayNameColumnsShownPref
preference.
VALID
VALUES
Accepts one or more integers as values. The number
of integers should match the number of columns in the
Mfg0MEPlantBOPRevisionOccGroupDisplayNameColumnsShownPref
preference.
DEFAULT
VALUES
25
25
50
DEFAULT
PROTECTION
SCOPE
All.

MEProcessIconPropertyNames

DESCRIPTION
Specifies whether plant BOP structures display an allocation indication symbol for
processes if they are allocated from a product BOP.
VALID
VALUES
No value.
The linked symbols are not displayed.
Mfg0has_origin
The symbol is displayed on processes in plant BOP structures if they are allocated
from a product BOP.

PLM00026 11.2 Preferences and Environment Variables Reference 22-137


Chapter
Chapter 22:22:Related
Related topics
topics

Note

Assigning a value to this preference slows the structure loading.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

MEOperationIconPropertyNames

DESCRIPTION
Specifies whether plant BOP structures display an allocation indication symbol for
operations if they were allocated from a product BOP.
VALID
VALUES
No value.
The linked symbols are not displayed.
Mfg0has_origin
The symbol is displayed on operations in plant BOP structures if they are allocated
from a product BOP
Note

Assigning a value to this preference slows the structure loading.

DEFAULT
VALUES
Mfg0has_origin
DEFAULT
PROTECTION
SCOPE
User preference.

MEAllocationLevel

DESCRIPTION
Defines the type of process area that can have an operation or process allocation. If
no type is defined, there is no limitation on the operation allocation.
For more information about allocating processes and operations, see Manufacturing
Process Planner.
VALID
VALUES
Accepts one or more strings as values. Each string must be a persistent item
subclass, for example:
Mfg0MEProcLine

22-138 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Note

The subclass types are not inherited. You must add each new subclass to the
preference individually.

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ProductBOPAllocationCloningRule

DESCRIPTION
Specifies the name of the cloning rule used for allocating from a product BOP to
a plant BOP.
System administrators can configure new cloning rules for specific use cases and
modify this preference to use the new cloning rules for selected users.
VALID
VALUES
Accepts a valid cloning rule name.
DEFAULT
VALUES
ProductBOPAllocationTemplate
DEFAULT
PROTECTION
SCOPE
All.

ProductBOPAllocationTemplate

DESCRIPTION
Specifies the cloning rule used when allocating from a product BOP.
VALID
VALUES
Accepts a valid cloning rule name.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0METraceOriginRel:EBOPCreate
*:*:Relation.Mfg0MELogicalDesignatorRel:Clone

PLM00026 11.2 Preferences and Environment Variables Reference 22-139


Chapter
Chapter 22:22:Related
Related topics
topics

*:*:Relation.IMAN_specification:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.METimeAnalysisRelation:Clone
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
DEFAULT
PROTECTION
SCOPE
All.

PlantBOPAllowedTemplates

DESCRIPTION
Specifies the list of cloning rules available for cloning a plant BOP from a plant BOP.
System administrators can configure new cloning rules for specific use cases and
modify this preference to expose them as choices to selected users.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid cloning rule name.
DEFAULT
VALUES
PlantBOPTemplate
DEFAULT
PROTECTION
SCOPE
All.

PlantBOPTemplate

DESCRIPTION
Specifies the default cloning rule when using a plant BOP as the template for creating
another plant BOP.
For more information about cloning rules, see Getting Started with Manufacturing.
VALID
VALUES
Accepts a valid cloning rule name.
DEFAULT
VALUES
*:*:Attribute.items_tag:Clone
*:*:Attribute.structure_revisions:Clone
*:*:Attribute.bom_view:Clone
*:*:Attribute.parent_item:Clone
*:*:Attribute.variant_expression_block:Clone
*:*:OccType.Null:Clone
*:*:OccType.*:Reference
*:*:Relation.IMAN_Rendering:Clone
*:*:Relation.Mfg0MELogicalDesignatorRel:Clone
*:*:Relation.IMAN_specification:Clone

22-140 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

*:*:Relation.IMAN_MEView:Clone
*:class.MEActivity:Relation.IMAN_MEFolder:Clone
class.MEActivity:*:Attribute.contents:Clone
class.Folder:*:Attribute.contents:Reference
*:*:Relation.METimeAnalysisRelation:Clone
*:*:Relation.Mfg0TCContextFeatureFormRel:Clone
DEFAULT
PROTECTION
SCOPE
All.

GANTT chart viewer preferences

MEGANTTElementHeight

DESCRIPTION
Specifies the height of one element of the Gantt chart in the navigation and the
representation area (the amount of pixels that are used for one element). There is no
space between the elements (10 elements use 10 times the space of one element).
VALID
VALUES
Positive integers.
DEFAULT
VALUES
14
DEFAULT
PROTECTION
SCOPE
All.

MEGANTTElementRGBfillColor

DESCRIPTION
Specifies the default fill color of the elements in red, green blue (RGB) code. For
example, 0;0;0 represents the color black and 0;255;255 represents the color aqua.
VALID
VALUES
String of the format int;int;int with int:=0|1|2|..|255.
DEFAULT
VALUES
149;202;255
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 22-141


Chapter
Chapter 22:22:Related
Related topics
topics

MEGANTTDefaultDisplayMode

DESCRIPTION
Specifies the default display mode is used on startup of a Gantt chart viewer.
VALID
VALUES
show_calculated_duration_time
Displays the calculated startup time of a Gantt chart viewer using the calculated
duration bar that appears on top of the duration bar of each level that has descendants.
hide_calculated_duration_time
Hides the calculated startup time of a Gantt chart viewer. The calculated duration bar
does not appear.
DEFAULT
VALUES
hide_calculated_duration_time
DEFAULT
PROTECTION
SCOPE
All.

MEGANTTDefaultDurationTimeMode

DESCRIPTION
Specifies the default duration time mode is used on startup of a Gantt chart viewer.
VALID
VALUES
allocated_Time Specifies the startup time allocated for the Gantt chart viewer.
Allocated time is the official duration time of an operation.
estimated_Time Specifies the estimated time allocated for the Gantt chart
viewer. Estimated time is useful for early planning stages.
DEFAULT
VALUES
allocated_Time
DEFAULT
PROTECTION
SCOPE
All.

MEGANTTDefaultEditMode

DESCRIPTION
Specifies the default edit mode used on startup of a Gantt chart viewer.
VALID
VALUES
full_edit_mode
Specifies the full edit mode to be used on startup of a Gantt chart viewer. In the full edit
mode, you can use the toolbar buttons to edit the elements in the Gantt chart viewer.

22-142 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

restricted_edit_mode
Specifies the restricted edit mode to be used on startup of a Gantt chart viewer. In
the restricted edit mode, you can still change the duration of an element using the
context menu of the element.
DEFAULT
VALUES
full_edit_mode
DEFAULT
PROTECTION
SCOPE
All.

MEGANTTDefaultMarkedColor

DESCRIPTION
Specifies the default color a marked element has in the representation area of the
Gantt chart viewer. For example, 0;0;0 represents the color black and 0;255;255
represents the color aqua.
VALID
VALUES
String of the format int;int;int with int:=0|1|2|..|255.
DEFAULT
VALUES
255;255;255
DEFAULT
PROTECTION
SCOPE
All.

MEGANTTDefaultDurationTimeColor

DESCRIPTION
Specifies the default color the duration time bar has in the representation area of the
Gantt chart viewer. For example, 0;0;0 represents the color black and 0;255;255
represents the color aqua.
VALID
VALUES
String of the format int;int;int with int:=0|1|2|..|255.
DEFAULT
VALUES
0;255;255
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 22-143


Chapter
Chapter 22:22:Related
Related topics
topics

MEGANTTDefaultFlowColor

DESCRIPTION
Specifies the default color a flow has in the representation area of the Gantt chart
viewer. For example, 0;0;0 represents the color black and 0;255;255 represents
the color aqua.
VALID
VALUES
String of the format int;int;int with int:=0|1|2|..|255.
DEFAULT
VALUES
0;255;255
DEFAULT
PROTECTION
SCOPE
All.

MEGANTTMarkedFlowColor

DESCRIPTION
Specifies the default color a marked flow has in the representation of the Gantt chart
viewer. For example, 0;0;0 represents the color black and 0;255;255 represents
the color aqua.
VALID
VALUES
String of the format int;int;int with int:=0|1|2|..|255.
DEFAULT
VALUES
0;255;255
DEFAULT
PROTECTION
SCOPE
All.

MEGANTTimplicitFlowColor

DESCRIPTION
Specifies the default color an implicit flow has in the representation area of the Gantt
chart viewer. For example, 0;0;0 represents the color black and 0;255;255 represents
the color aqua.
VALID
VALUES
String of the format int;int;int with int:=0|1|2|..|255.
DEFAULT
VALUES
0;255;255
DEFAULT
PROTECTION
SCOPE
All.

22-144 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEGANTTPropagateDurationUpToLevel

DESCRIPTION
Specifies the level up to which the duration propagation is executed in the Gantt chart
when running the Propagate Calculated Duration command. The number of levels is
counted from the top level object downwards.

This value is only used if the MEGANTTPropagateDurationUpToLevelEnabled


preference is set to True, otherwise, Teamcenter propagates to level 0.

For more information about working with the Gantt chart, see Manufacturing Process
Planner.
VALID
VALUES
A positive integer number (including 0). Setting this value to 0 indicates that all levels
are propagated up.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site and user preference.
RESTRICTIONS
The values of this preference should be set by the site manager.

MEGANTTPropagateDurationUpToLevelEnabled

DESCRIPTION
Specifies if the Propagate up to level option is enabled in the Duration
Propagation dialog box in the Gantt view and whether the value of the
MEGANTTPropagateDurationUpToLevel preference is used. In other words, if this
preference is set to False, and the value of MEGANTTPropagateDurationUpToLevel
is set to 3, Teamcenter propagates up to level 0, as it ignores the value set in
MEGANTTPropagateDurationUpToLevel.

For more information about working with the Gantt chart, see Manufacturing Process
Planner.
VALID
VALUES
True
The Propagate up to level option is enabled in the Duration Propagation dialog box.

False
The Propagate up to level option is not enabled in the Duration Propagation dialog
box.
DEFAULT
VALUES
False

PLM00026 11.2 Preferences and Environment Variables Reference 22-145


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
Site and user preference.
RESTRICTIONS
The values of this preference should be set by the site manager.

Manufacturing features preferences


ArcWeldRevision_DefaultChildProperties

DESCRIPTION
Lists the relations that make forms attached to an ArcWeldRevision object visible
in Teamcenter.
For more information about working with manufacturing features, see Manufacturing
Process Planner.
VALID
VALUES
One or more strings representing valid Teamcenter relations.
DEFAULT
VALUE
IMAN_Rendering
TC_Connected_To
TC_Feature_Form_Relation
Mfg0TCContextFeatureFormRel

DEFAULT
PROTECTION
SCOPE
Site preference.

ArcWeldRevision_shown_relations

DESCRIPTION
Specifies the relations to show when expanding ArcWeldRevision object.
For more information about working with manufacturing features, see Manufacturing
Process Planner.
VALID
VALUES
One or more strings representing valid Teamcenter relations.
DEFAULT
VALUE
Mfg0TCContextFeatureFormRel
DEFAULT
PROTECTION
SCOPE
Site preference.

22-146 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEAPCSearchType

DESCRIPTION
Defines the type of the parts that are searched by the Auto Weld Part Connector
dialog box.
For more information about working with weld points, see Manufacturing Process
Planner.
VALID
VALUES
Accepts a strings as value. The string must be a valid Teamcenter type.
DEFAULT
VALUES
Item
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-147


Chapter
Chapter 22:22:Related
Related topics
topics

MEImportMFGsManufacturingFeatureIdAttributeName

DESCRIPTION
Specifies which BOM line property is used as the feature ID when importing weld
points from an external system.
For more information about importing weld points, see Manufacturing Process Planner.
VALID
VALUES
Any valid occurrence note.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

MEImportMFGsPartIdAttributeName

DESCRIPTION
Specifies which BOM line property is used as the part ID when importing weld points
from an external system.
For more information about importing weld points, see Manufacturing Process Planner.
VALID
VALUES
Any valid occurrence note.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Mfg0TCContextFeatureFormRel_relation_primary

DESCRIPTION
Specifies the list of valid primary object types for the TCContextFeatureFormRel
relation. The is the relation used to attach the form containing the override feature
attributes to the process or operation when creating manufacturing features.
For more information about working with manufacturing features, see Manufacturing
Process Planner.
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.

22-148 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
One or more strings representing valid Teamcenter object types.
DEFAULT
VALUE
DatumpointRevision
ArcWeldRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMFGDisplayName

DESCRIPTION
Defines the customized display name in the tree structure for weld points, arc welds,
and datum points.
For more information about creating features, see Manufacturing Process Planner.
VALID
VALUES
Accepts the five following Teamcenter properties.
bl_item_item_id
bl_item_object_name
bl_rev_item_revision_id
bl_rev_object_name
bl_occurrence_name
You can use multiple properties, for example:
bl_item_item_id
bl_item_object_name
The weld point display name is then 000171;WP1
DEFAULT
VALUES
bl_occurrence_name
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMFGView_AssignmentFilterDefaultValue

DESCRIPTION
Defines the filter type to be used when opening an assignment filter in the MFG View.
The value of the filter type previously selected by the user in the MFG View is stored
in the preference for the next session.
VALID
VALUES
ASSIGNED The MFG View opens in assigned mode.

PLM00026 11.2 Preferences and Environment Variables Reference 22-149


Chapter
Chapter 22:22:Related
Related topics
topics

UNASSIGNED The MFG View opens in unassigned mode.


DEFAULT
VALUE
ASSIGNED
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMFGViewDisplayNameColumnShownPref

DESCRIPTION
Specifies the list of columns displayed in the MFG View pane.
VALID
VALUES
The System name of each column in the order you want them to appear, that is,
value_1, value_2 and so on.
DEFAULT
VALUE
BOMLine.bl_indented_title
Mfg0BvrWeldPoint.Mfg0designation
BOMLine.description
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMFGViewShownColumnWidthsPref

DESCRIPTION
Specifies the width of the columns displayed in the MFG View pane. This setting
affects each column defined in the MEMFGViewDisplayNameColumnShownPref
preference.
VALID
VALUES
Integers that define the number of characters permitted in each
column. There should be one value for each column defined in the
MEMFGViewDisplayNameColumnShownPref preference, and the values are
applied in the same order (that is, the first value in this preference is applied to the first
column in the MEMFGViewDisplayNameColumnShownPref and so on).
DEFAULT
VALUE
40
20
30
DEFAULT
PROTECTION
SCOPE
Site preference.

22-150 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEMFGViewSubPanelColumnShownPref

DESCRIPTION
Specifies the columns displayed in the Connected Parts section of the Manufacturing
Features view.

For more information about using the Manufacturing Features view, see
Manufacturing Process Planner.
VALID
VALUES
Accepts any valid column name.
DEFAULT
VALUE
bl_indented_title
description
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMFGViewSubPanelShownColumnWidthsPref

DESCRIPTION
Specifies the width of the columns displayed in the Connected Parts
section of the MFG View. This setting affects each column defined in the
MEMFGViewSubPanelColumnShownPref preference.
VALID
VALUES
Integers that define the number of characters permitted in each
column. There should be one value for each column defined in the
MEMFGViewSubPanelColumnShownPref preference, and the values are applied in
the same order (that is, the first value in this preference is applied to the first column in
the MEMFGViewSubPanelColumnShownPref and so on).
DEFAULT
VALUE
40
50
DEFAULT
PROTECTION
SCOPE
Site preference.

MENEWMFG_DefaultJTDatasetNameForSpecificWeldType

DESCRIPTION
Specifies the name of the JT dataset that is attached by default to each newly created
weld point. The JT file used is dependent on the number of parts connected.

For more information about importing features, see Manufacturing Process Planner.

PLM00026 11.2 Preferences and Environment Variables Reference 22-151


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts a string of the following format:
weld-type:number-of-connected-parts:dataset-name
weld-type
Specifies the type of weld. The possible values are:
Geo
Process
Respot

number-of-connected-parts
Specifies the number of parts connected to each weld point. The possible values
are:
<2
2
3
4
>4

dataset-name
Specifies the name of the JT file containing the weld point representation.

DEFAULT
VALUES
Geo:<2:rswp_2t_dim_ctrl
Geo:2:rswp_2t_dim_ctrl
Geo:3:rswp_3t_dim_ctrl
Geo:4:rswp_4t_dim_ctrl
Geo:>4:rswp_4t_dim_ctrl
Respot:<2:rswp_2t
Respot:2:rswp_2t
Respot:3:rswp_3t
Respot:4:rswp_4t
Respot:>4:rswp_4t
Process:<2:rswp_2t_pro_ctrl
Process:2:rswp_2t_pro_ctrl
Process:3:rswp_3t_pro_ctrl
Process:4:rswp_4t_pro_ctrl
Process:>4:rswp_4t_pro_ctrl
DEFAULT
PROTECTION
SCOPE
Site preference.

22-152 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MENEWMFG_DefaultWeldPointJTDatasetName

DESCRIPTION
Specifies the name of the JT dataset that is attached by default to every newly created
manufacturing feature.
VALID
VALUES
A single character string that represents the name of a dataset that contains a JT
file of the same name.
DEFAULT
VALUES
rswp_2t
DEFAULT
PROTECTION
SCOPE
Site preference.

MENEWMFG_DefaultDatumJTDatasetName

DESCRIPTION
Specifies the name of the JT dataset that is attached by default to every newly created
datum at import.
For more information about working with features, see Manufacturing Process Planner.
VALID
VALUES
The Teamcenter business object type, followed by the control direction and dataset
name, in the following format:
type:control_direction:datasetname
DEFAULT
VALUES
MeasurementDatum:default:datum_measurement
SphereDatum:default:mpaw_datumlocfea
PinDatum:default:mpaw_datumlocfea
DEFAULT
PROTECTION
SCOPE
Site preference.

MENEWMFG_LastJTFilePathBrowsed

DESCRIPTION
Specifies the path to which a user previously browsed to find the custom JT file to
associate with a manufacturing feature.
VALID
VALUES
An operating system path.

PLM00026 11.2 Preferences and Environment Variables Reference 22-153


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

MEShowWeldPointsConnectedToConfiguredOutParts

DESCRIPTION
Enables the display of weld points when connected parts are configured out, in the
manufacturing applications.
For more information about working with weld points, see Manufacturing Process
Planner.
VALID
VALUES
True Teamcenter displays weld points even if their connected parts
are configured out.
False Teamcenter hides weld points if at least one of the connected
parts is configured out.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

ProcessStationForAutomatedMfgAssignment

DESCRIPTION
Defines the list of object types and their properties that are supported by the
Automated Manufacturing Feature Assignment menu command in Manufacturing
Process Planner.
For more information about automatically assigning features, see Manufacturing
Process Planner.
VALID
VALUES
Accepts a list of any valid process type and property with a double format separated by
a colon.
internal-process-type-name:internal-property-name
DEFAULT
VALUES
MEProcess:Mfg0allocated_time
DEFAULT
PROTECTION
SCOPE
Site preference.

22-154 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

WeldTimeForAutomatedMfgAssignment

DESCRIPTION
Defines the list of manufacturing feature object types and their properties that are
supported by the Automated Manufacturing Feature Assignment menu command
in Manufacturing Process Planner.
For more information about automatically assigning features, see Manufacturing
Process Planner.
VALID
VALUES
Accepts a list of any valid feature type and property with a double format separated by
a colon.
internal-name-of-feature-type:internal-property-name
DEFAULT
VALUES
WeldPoint:Mfg0weld_time
DEFAULT
PROTECTION
SCOPE
Site preference.

Standard text preferences


Mes0TWiRefInfoRelation_relation_primary

DESCRIPTION
Indicates the list of valid primary object types for the Mes0TWiRefInfoRelation
relation.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
relation object.
DEFAULT
VALUES
MEOPRevision
MEProcessRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

MEWiWorkInstructionTemplate

DESCRIPTION
Specifies a name of a specification template that contains a Microsoft Word document
used as a work instruction template. The template is used as a starting point for work
instruction documents.

PLM00026 11.2 Preferences and Environment Variables Reference 22-155


Chapter
Chapter 22:22:Related
Related topics
topics

For more information about creating work instructions using the standard text library,
see Manufacturing Process Planner.
VALID
VALUES
Accepts a valid Teamcenter specification template name.
DEFAULT
VALUES
WI_TC10OOTB_spec_template
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
When creating your own work instruction template, it is advisable to duplicate the
WI_TC10OOTB_spec_template template provided by Teamcenter, and then modify it
to suit your needs.

MEWiStandardTextTemplate

DESCRIPTION
Specifies a name of a specification template that contains a Microsoft Word document
used as a standard text template. The template is used as a starting point for standard
text documents.
For more information about creating work instructions using the standard text library,
see Manufacturing Process Planner.
VALID
VALUES
Accepts a valid Teamcenter specification template name.
DEFAULT
VALUES
STX_TC109OOTB_spec_template
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
When creating your own standard text template, it is advisable to duplicate the
STX_TC10OOTB_spec_template template provided by Teamcenter, and then modify
it to suit your needs.

MEWiPreviewFormat

DESCRIPTION
Specifies the available file types for the format of the preview files created in the
standard text editor and in the work instruction editor. Teamcenter creates a document
of the file type specified by the first string.
For more information about creating work instructions using the standard text library,
see Manufacturing Process Planner.

22-156 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
Accepts one of the following file formats supported by the Word Save As command:
pdf
mht
docx
rtf

DEFAULT
VALUES
pdf
mht
docx
rtf
Note

If you retained PDF as the default preview format, Adobe Reader must be
installed on your system. If you installed 64-bit rich client Adobe Acrobat, there
is no support for viewing the PDF preview file. In this case, the preview opens
in a stand-alone window and not in the Teamcenter application.

DEFAULT
PROTECTION
SCOPE
Site preference.

MEWiDcdNotEditableProperties

DESCRIPTION
Specifies the list of data collection properties (DCDs) that cannot be edited in the
Properties dialog box of the Work Instructions view.
For more information about creating work instructions using the standard text library,
see Manufacturing Process Planner.
VALID
VALUES
Accepts strings of the following format:
DCD_type:att1,att2,…
DCD_type is a descendant type of the DCD base form.
DEFAULT
VALUES

Mes0MEIntegerDCDForm:Mes0ValuePlaceholder
Mes0MERealDCDForm:Mes0ValuePlaceholder
Mes0MEStringDCDForm:Mes0ValuePlaceholder
Mes0MEBooleanDCDForm:Mes0ValuePlaceholder
Mes0METimeDCDForm:Mes0ValuePlaceholder
Mes0MEEndTimeDCDForm:Mes0ValuePlaceholder
Mes0MEBuyoffDCDForm:Mes0ValuePlaceholde

PLM00026 11.2 Preferences and Environment Variables Reference 22-157


Chapter
Chapter 22:22:Related
Related topics
topics

Mes0MEDurationDCDFrm:Mes0ValuePlaceholder
Mes0MEImageDCDForm:mes0ValuePlaceholder
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
You can define a list either for a basic DCD type or a derived customized type.

MEWiEnableAddSymbolCommand

DESCRIPTION
Specifies whether the Add Symbol and Remove Symbol buttons are displayed in
the Standard Text view or the Work Instruction view.
VALID
VALUES
STXView The Add Symbol and Remove Symbol buttons are displayed
in the Standard Text view.
TWIView The Add Symbol and Remove Symbol buttons are displayed
in the Work Instruction view.
DEFAULT
VALUES
By default, this preference is not set and Teamcenter displays the buttons in the
Standard Text view.
DEFAULT
PROTECTION
SCOPE
Site preference.

METWICreateTextControlsOnSave

DESCRIPTION
Specifies whether content controls are created automatically for free text in work
instructions documents.
For more information about creating work instructions using the standard text library,
see Manufacturing Process Planner.
VALID
VALUES
true Content controls are created automatically.
false Content controls are not created automatically.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

22-158 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

NOTES
This preference supports multiple languages.

Product and manufacturing information (PMI) preferences


Mci0PMIImportNxToTcPMIIDPropertyMap

DESCRIPTION
Maps the NX product manufacturing information (PMI) ID property to the Teamcenter
PMI ID property.
For more information about working with PMI, see Manufacturing Process Planner.
Caution

Changing the value of this preference can lead to a loss of data created in either
NX or Teamcenter when synchronizing between the two.

VALID
VALUES
Accepts two property names separated by a colon, as follows:
NX-property-name:Teamcenter-property-name
DEFAULT
VALUE
K2001:mci0PmiID
DEFAULT
PROTECTION
SCOPE
Site preference.

Mci0PMIImportNxToTcPropertiesMap

DESCRIPTION
Maps the NX product manufacturing information (PMI) properties to the Teamcenter
PMI properties.
For more information about working with PMI, see Manufacturing Process Planner.
VALID
VALUES
Accepts two property names separated by a colon, as follows:
NX-property-name:Teamcenter-property-name
DEFAULT
VALUE
K2101:mci0NominalValue
K2111:mci0UpperSpecLimit
K2110:mci0LowerSpecLimit
K2900:mci0GDandTText
K2802:mci0GDandTCode
B2009:mci0DimensionType

PLM00026 11.2 Preferences and Environment Variables Reference 22-159


Chapter
Chapter 22:22:Related
Related topics
topics

K2504:mci0ChangeStatusText
K2002:itp4BalloonID
DEFAULT
PROTECTION
SCOPE
Site preference.

Mci0PMI_Details_relation_primary

DESCRIPTION
Defines the primary object for the Mci0PMI_Details relation.
For more information about working with PMI, see Manufacturing Process Planner.
VALID
VALUES
Accepts a valid Teamcenter object.
DEFAULT
VALUE
Mci0PMI
DEFAULT
PROTECTION
SCOPE
Site preference.

Mci0PMI_shown_relations

DESCRIPTION
Specifies the relations to be shown in the rich client when the product manufacturing
information (PMI) object is expanded.
For more information about working with PMI, see Manufacturing Process Planner.
VALID
VALUES
Accepts a list of valid Teamcenter relations.
DEFAULT
VALUE
Mci0PMI_Details
Mci0PMIBop_Details
DEFAULT
PROTECTION
SCOPE
Site preference.

Mci0PMI_DefaultChildProperties

DESCRIPTION
Defines the default relations for product manufacturing information (PMI).
For more information about working with PMI, see Manufacturing Process Planner.
VALID
VALUES
Accepts a list of valid Teamcenter relations.

22-160 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUE
Mci0PMI_Details
Mci0PMIBop_Details
DEFAULT
PROTECTION
SCOPE
Site preference.

Mci0PMIXmlRel_relation_primary

DESCRIPTION
Defines the primary object for the Mci0PMIXmlRel relation.
For more information about working with PMI, see Manufacturing Process Planner.
VALID
VALUES
Accepts a valid Teamcenter object.
DEFAULT
VALUE
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

Process Simulate preferences


MEDataSetsToBeCheckoutForProcessSimulate

DESCRIPTION
Indicates which datasets to check out when running any of the scenarios that include
datasets. It stores pairs of dataset types and relations.
VALID
VALUES
Accepts string values with the following format:
Dataset type:Relation
DEFAULT
VALUES
ProcessSimulateSceneDetails:IMAN_specification
ProcessSimulateSimDetails:IMAN_specification
ProcessSimulate3DRep:IMAN_specification
ProcessSimulateSceneDetails:IMAN_reference
ProcessSimulateSimDetails:IMAN_reference
ProcessSimulate3DRep:IMAN_reference
ProcessSimulateSceneDetails:ProcessSimulate_Details
ProcessSimulateSimDetails:ProcessSimulate_Details
ProcessSimulate3DRep:ProcessSimulate_Details
Kinematics:KinematicsRelation

PLM00026 11.2 Preferences and Environment Variables Reference 22-161


Chapter
Chapter 22:22:Related
Related topics
topics

ProcessSimulateCompDetails:ProcessSimulate_Details
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
Specifying the wildcard, *, as the relation includes all possible relations for that dataset
type.

MEFormsToBeCheckoutForProcessSimulate

DESCRIPTION
Indicates which forms to check out. It stores pairs of form types and the relation.
VALID
VALUES
Accepts string values with the following format:
Type:Relation
DEFAULT
VALUES
ProcessSimulateActivity:*
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
Specifying the wildcard, *, as the relation includes all possible relations. In other words,
this type of form is always checked out.

MEReportColumnsForProcessSimulate

DESCRIPTION
Indicates the ordered list of column names displayed in the report for failed checkout
objects in the Process Simulate Check-Out menu command.
VALID
VALUES
Accepts valid column names in the order you want them to appear:
value_1, value_2, ...

DEFAULT
VALUES
object_string
object_type
checked_out_user
object_desc
DEFAULT
PROTECTION
SCOPE
Site preference.

22-162 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEReportColumnWidthForProcessSimulate

DESCRIPTION
Specifies the widths for the columns displayed in the report for failed checkout
objects in the Process Simulate Check-Out menu command, as defined in the
MEReportColumnsForProcessSimulate preference.
VALID
VALUES
Accepts integer values. The number of integers must match the number of columns
described in the MEReportColumnsForProcessSimulate preference.
DEFAULT
VALUES
22
18
22
18
DEFAULT
PROTECTION
SCOPE
Site preference.

PLMXML_pre_expand_bop

DESCRIPTION
Specifies whether or not to pre-expand structures within Teamcenter before running
the PLM XML expand operation. This reduces the time it takes to send data from
Teamcenter to Process Simulate.
If the value of the PLMXML_pre_expand_max_line_limit preference is set to 0 and
this preference value is set to TRUE, the structure is pre-expanded, meaning that the
PLMXML_pre_expand_batch_size preference is set to its maximum value and the
value of the PLMXML_pre_expand_max_line_limit preference is disregarded.
Setting this preference can affect the performance of other PLM XML exports of
structures from manufacturing applications.
VALID
VALUES
TRUE The structure is pre-expanded.
FALSE The structure is not pre-expanded.
DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-163


Chapter
Chapter 22:22:Related
Related topics
topics

PLMXML_pre_expand_max_line_limit

DESCRIPTION
Sets the maximum number of lines in a structure that are to be expanded prior to
running the PLM XML expand operation. Structures that are a target for export can be
fully expanded prior to their export step, which provides a performance improvement.
However, there are memory concerns with large structures whereby a full expansion
may take more than the available memory of the system. This preference sets a limit.
VALID
VALUES
0 No lines are pre-expanded.
-1 There is no limit on the number of lines to pre-expand.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

PLMXML_pre_expand_batch_size

DESCRIPTION
Sets batch size for each single expansion of a structure prior to running the PLM XML
expand operation. Structures that are a target for export can be fully expanded prior
to their export step, which provides a performance improvement. However, there are
memory concerns with large structures whereby a full expansion may take more than
the available memory of the system. This preference sets a limit. Values must be
greater than 0. The smaller the batch size, the more likely that the value set in the
PLMXML_pre_expand_max_line_limit preference will not be exceeded but at the
cost of less performance gain.
VALID
VALUES
Accepts any integer value greater than 0.
DEFAULT
VALUES
1000
DEFAULT
PROTECTION
SCOPE
Site preference.

Line balancing preferences


MEConstraintsViewAutomaticLayoutOffAppendPositionPref

DESCRIPTION
Defines the position of nodes newly added to the Line Balancing Constraints view.

22-164 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

If the automatic layout mode is turned off, Teamcenter places new nodes into the
Line Balancing Constraints view in the position defined by this preference. When
calculating where to put the node, Teamcenter draws an imaginary box around all
existing nodes, and then places the new node in one of three positions—bottom left,
bottom right, or top right of the existing nodes.
For more information about using the automatic layout, see Manufacturing Process
Planner.
VALID
VALUES
Accepts one of the following strings:
LOWER_LEFT Places a new node at the bottom left of existing nodes.
LOWER_RIGHT Places a new node at the bottom right of existing nodes.
UPPER_RIGHT Places a new node at the top right of existing nodes.
DEFAULT
VALUES
LOWER_RIGHT
DEFAULT
PROTECTION
SCOPE
All.

MEConstraintsViewDefaultAutomaticLayoutModePref

DESCRIPTION
Defines the initial state of the Automatic Layout button when opening a new Line
Balancing Constraints view. When on, Teamcenter automatically organizes the
placement of nodes after each operation that you perform in the view, such as adding
or deleting nodes, or adding or deleting constraints.
For more information about using the Line Balancing Constraints view, see
Manufacturing Process Planner.
VALID
VALUES
true The automatic layout mode is turned on by default.
false The automatic layout mode is turned off by default.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
All.

MEConstraintViewPreloadedPredecessorLevels

DESCRIPTION
Specifies the level of predecessors that are loaded automatically when a new scope is
set in the Line Balancing Constraints view.

PLM00026 11.2 Preferences and Environment Variables Reference 22-165


Chapter
Chapter 22:22:Related
Related topics
topics

For more information about line balancing, see Manufacturing Process Planner.
VALID
VALUES
Accepts a single positive integer or 0.
DEFAULT
VALUES
2
DEFAULT
PROTECTION
SCOPE
All.

MEConstraintViewPreloadedSuccessorLevels

DESCRIPTION
Specifies the level of successors that are loaded automatically when a new scope is
set in the Line Balancing Constraints view.
For more information about line balancing, see Manufacturing Process Planner.
VALID
VALUES
Accepts a single positive integer or 0.
DEFAULT
VALUES
2
DEFAULT
PROTECTION
SCOPE
All.

MELBBalancingOverviewReportID

DESCRIPTION
Specifies the ID of the report definition used for the Line Balancing Overview report.
For more information about configuring line balancing reports, see Administering
Manufacturing Planning.
VALID
VALUES
Accepts the ID of an existing Line Balancing Overview report.
DEFAULT
VALUES
TC_LB_OVERVIEW
DEFAULT
PROTECTION
SCOPE
All.

22-166 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MELBBalancingOverviewStylesheet

DESCRIPTION
Specifies the name of the XSL style sheet used for the Line Balancing Overview
report.
For more information about configuring line balancing reports, see Administering
Manufacturing Planning.
VALID
VALUES
Accepts an XSL file name, for example, MyLBOverviewReport.xsl.
DEFAULT
VALUES
TCLineBalancingReport.xsl
DEFAULT
PROTECTION
SCOPE
All.

MELBChartColors

DESCRIPTION
Specifies the colors used in the line balancing chart.
For more information about line balancing, see Manufacturing Process Planner.
VALID
VALUES
Accepts a list of strings; each string has the following format:
Type:color-type; Class:class-name; Foreground:rgb-value;
Background:rgb-value; LineColor:rgb-value; TextColor:rgb-value;
Type Specifies the object to be colored in the defined fashion. This is
a mandatory keyword. Valid values are:
Normal
Specifies the color scheme for normal objects.

Selection
Specifies the color scheme for selected objects.

Highlight
Specifies the color scheme for highlighted objects, the
negative values of the TimesPerBar class, and the tooltip
entries marking a subgroup.

LimitViolation
Specifies the color scheme for objects above the capacity
line.

Emphasized

PLM00026 11.2 Preferences and Environment Variables Reference 22-167


Chapter
Chapter 22:22:Related
Related topics
topics

Specifies the color scheme for operations with probability


strictly lower than 100%.

EmphasizedLimitViolation
Specifies the color scheme for operations with probability
strictly lower than 100% and above the capacity line.

Dimmed
Specifies the color scheme for separation lines for subgroup
entries.

Grid
Specifies the color scheme for grid lines.

LimitLine
Specifies the color scheme for the capacity line.

Class Specifies the class type that is colored for color types. This
keyword is mandatory.
Valid values are:
Operation
Specifies boxes displayed in the bar area representing
processes and operations.

Station
Specifies boxes displayed in the axis area representing
stations.

CycleTimeLines
Specifies the horizontal lines representing the multiple of
the cycle time.

CapacityLine
Specifies the line that shows the capacity of each station.

AverageLine
Specifies the horizontal line that shows the height of the
average work content over the different product variants.

TimesPerBar
Specifies the time values shown on the top of each bar.

Overlay
Specifies the box showing the maximum and minimum work
contents of all product variants.

22-168 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Tooltip
Specifies the tooltip area, including the fill colors and color
of text.

TooltipSeparator
Specifies the lines between tooltip entries.

Teamcenter uses the Operation value as default.


Foreground and Specifies the fill colors of boxes representing operations and
Background stations. Valid values consist of red, green, and blue color
values separated by a comma. This field is ignored for the Grid
and LimitLine color types and can be left blank.
LineColor Specifies the color of lines for Grid and LimitLine color types.
For all others, this value specifies the border color. Valid values
consist of red, green, and blue color values separated by a
comma.
TextColor Specifies the color of text. Valid values consist of red, green,
and blue color values separated by a comma.
DEFAULT
VALUES
Type:Normal;Class:Operation;Foreground:230, 234, 221;Background:101, 129, 46;
LineColor:64, 86, 21;
Type:Selection;Class:Operation;Foreground:255, 255, 255;Background:57, 99, 165;
LineColor:16, 78, 139;
Type:Highlight;Class:Operation;Foreground:255, 255, 0;Background:255, 128, 64;
LineColor:16, 78, 139;
Type:LimitViolation;Class:Operation;Foreground:241, 220, 220;Background:168, 38, 40;
LineColor:112, 15, 17;
Type:Emphasized;Class:Operation;Foreground:230, 234, 221;Background:150, 180, 40;
LineColor:64, 86, 21
Type:EmphasizedLimitViolation;Class:Operation;Foreground:241, 220, 220;
Background:210, 76, 80;LineColor:112, 15, 17
Type:Normal;Class:Station;Foreground:255, 255, 255;Background:255, 255, 255;
TextColor:0, 0, 255; LineColor:0, 0, 255
Type:Selection;Class:Station;Foreground:49, 106, 197;Background:49, 106, 197;
TextColor:255, 255, 255;LineColor:49, 106, 197;
Type:Normal;Class:CycleTimeLines;LineColor:192, 192, 192;
Type:Normal;Class:CapacityLine;LineColor:0, 0, 0;
Type:Normal;Class:AverageLine;LineColor:0, 128, 255;
Type:Normal;Class:TimesPerBar;TextColor:0, 0, 0;
Type:Highlight;Class:TimesPerBar;TextColor:255, 0, 0;
Type:Normal;Class:Overlay;Foreground:0, 128, 255;Background:0, 128, 255;
LineColor:0, 128, 255
Type:Normal;Class:Tooltip;Foreground:198, 226, 255;Background:185, 211, 238;
TextColor:0, 0, 255;
Type:Highlight;Class:Tooltip;Foreground:198, 226, 255;Background:185, 211, 238;
TextColor:14, 16, 114;

PLM00026 11.2 Preferences and Environment Variables Reference 22-169


Chapter
Chapter 22:22:Related
Related topics
topics

Type:Normal;Class:TooltipSeparator;LineColor:0, 0, 255;
Type:Highlight;Class:TooltipSeparator;LineColor:147, 147, 255;
Type:Dimmed;Class:TooltipSeparator;LineColor:171, 203, 235;
Type:LimitLine;LineColor:255, 0, 0;
Type:Grid;LineColor:125, 125, 125;
Type:Highlight;Foreground:255, 255, 255;Background:186, 85, 211;
LineColor:16, 78, 139;

DEFAULT
PROTECTION
SCOPE
All.

MELBChartDnDSourceTypes

DESCRIPTION
Specifies whether you can drag and drop processes or operations in the line balancing
chart.
For more information about configuring line balancing reports, see Administering
Manufacturing Planning.
VALID
VALUES
Internal names of MEOP or any of its subtypes.
Internal names of MEProcess or any of its subtypes.
Caution

MEProcess enables drag and drop for all process types.

DEFAULT
VALUES
MEOP
DEFAULT
PROTECTION
SCOPE
User preference.

MELBChartDnDTargetParentTypes

DESCRIPTION
Specifies the types of parent objects to which processes or operations can be dropped
in the line balancing chart.
This can include processes as well as process area types.
For more information about configuring line balancing reports, see Administering
Manufacturing Planning.
VALID
VALUES
Internal names of MEProcess or any of its subtypes.
Internal names of Mfg0MEProcArea or any of its subtypes.

22-170 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
MEProcess
Mfg0MEProcArea

DEFAULT
PROTECTION
SCOPE
User preference.

MELBChartProcessOperationTypeDefaultValues

DESCRIPTION
Specifies which types of objects have view options (View Menu→View Options) in
the line balancing chart.
This preference lets users quickly change the MELBChartProcessOperationType
preference from the line balancing chart interface.
For more information about configuring line balancing reports, see Administering
Manufacturing Planning.
VALID
VALUES

Value Description
MEOP Operation.
MEProcess Process.
custom-object-name If an assembly line uses multiple types of operations, an
administrator can define custom values for each. For
example, if an assembly line planner wants to limit processes
and operations in the line balancing chart view so that only
riveting and welding operations are visible, the administrator
can define these custom views and give them custom names
such as MERivetOP, MERivetProcess, MEWeldOP, and
MEWeldProcess. The planner can then quickly switch
between them in the line balancing chart view options.

DEFAULT
VALUES
MEOP
MEProcess

DEFAULT
PROTECTION
SCOPE
User preference.

MELBChartProcessOperationTypes

DESCRIPTION
Specifies the types of objects used as processes or operations, and whether processes
with no operations, or operations with processes, are shown in the line balancing chart.

PLM00026 11.2 Preferences and Environment Variables Reference 22-171


Chapter
Chapter 22:22:Related
Related topics
topics

Substructures are ignored even if they contain objects of the types included in this
preference.
For more information about configuring line balancing reports, see Administering
Manufacturing Planning.
Note

Users can quickly change this preference in the line balancing


chart by choosing View Menu→View Options→MEProcess or
MEOP. View options can also include custom names defined in
MELBChartProcessOperationTypeDefaultValues.

VALID
VALUES
Internal names of MEProcess or any of its subtypes.
Internal names of MEOP or any of its subtypes.
Caution

MEProcess enables drag and drop for all process types.

DEFAULT
VALUES
MEOP
DEFAULT
PROTECTION
SCOPE
User preference.

MELBChartStationNameDisplayPattern

DESCRIPTION
Defines the display pattern of the station line names in the Line Balancing Chart
view in Manufacturing Process Planner.
For more information about line balancing, see Manufacturing Process Planner.
The Line Balancing Chart view uses regular expressions as patterns to display only
particular portions of the station line names. The parts to be displayed are marked by
groups. The corresponding part strings of the names are displayed.
For example, when applying the pattern .*([sS]t)ation([ .0-9]*).* to station line name
000140/A;1-station 1.1 for the assembling front axle, the string st matches the
regular expression group ([sS]t), and the string 1.1 matches the regular expression
group ([ .0-9]*).
The result is that the display string is st 1.1 for this pattern.
VALID
VALUES
Accepts a valid regular expression that matches the station line names. The regular
expression must contain at least one group.
If the pattern is not defined correctly or if no group is defined, Teamcenter displays the
original line name text.

22-172 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

The following examples shows some patterns and corresponding results for the line
name 000140/A;1-station 1.1 for assembling front axle.

Pattern Result
[ 0]*([0-9]*)/.* 140
.*(station.*) station 1.1 for assembling front axle
.*([sS]t)ation([ .0-9]*).* st 1.1

DEFAULT
VALUES
[ 0]*([0-9a-zA-Z]*)/.*
DEFAULT
PROTECTION
SCOPE
All.

MELBChartStationTypes

DESCRIPTION
Specifies the types of process areas used as stations on the X axis of the line
balancing chart.
If this preference is empty, Teamcenter uses the MEAllocationLevel preference
value. If MEAllocationLevel is empty, the line balancing chart uses objects of the
type Mfg0MEProcArea.
For more information about configuring line balancing reports, see Administering
Manufacturing Planning.
VALID
VALUES
Internal names of Mfg0MEProcArea or any of its subtypes.
DEFAULT
VALUES
Mfg0MEProcStatn
DEFAULT
PROTECTION
SCOPE
User preference.

MELBConstraintsConsistencyReportID

DESCRIPTION
Specifies the ID of the report definition used for the constraints consistency report.
For more information about configuring line balancing reports, see Administering
Manufacturing Planning.
VALID
VALUES
Accepts an existing ID of a Constraints Consistency Check report.

PLM00026 11.2 Preferences and Environment Variables Reference 22-173


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
VALUES
TC_LB_CONSTRAINTS_CONSISTENCY
DEFAULT
PROTECTION
SCOPE
All.

MELBConstraintsConsistencyStylesheet

DESCRIPTION
Specifies the name of the XSL style sheet used for the Constraints Consistency
Check report.
For more information about configuring line balancing reports, see Administering
Manufacturing Planning.
VALID
VALUES
Accepts an XSL file name, for example, myConsistencyReport.xsl.
DEFAULT
VALUES
TCLineBalancingReport.xsl
DEFAULT
PROTECTION
SCOPE
All.

MELBConstraintsViolationReportID

DESCRIPTION
Specifies the ID of the report definition used for the Constraints Violation Check
report.
For more information about configuring line balancing reports, see Administering
Manufacturing Planning.
VALID
VALUES
Accepts the ID of an existing Constraints Violation Check report.
DEFAULT
VALUES
TC_LB_CONSTRAINTS_VIOLATION
DEFAULT
PROTECTION
SCOPE
All.

MELBConstraintsViolationStylesheet

DESCRIPTION
Specifies the name of the XSL style sheet used for the Constraints Violation Check
report.

22-174 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

For more information about configuring line balancing reports, see Administering
Manufacturing Planning.
VALID
VALUES
Accepts an XSL file name, for example, MyConstraintsViolationReport.xsl.
DEFAULT
VALUES
TCLineBalancingReport.xsl
DEFAULT
PROTECTION
SCOPE
All.

MELBLineDetailReportID

DESCRIPTION
Specifies the ID of the report definition used for the Balancing Line Detail report.

For more information about configuring line balancing reports, see Administering
Manufacturing Planning.
VALID
VALUES
Accepts the ID of an existing Balancing Line Detail report.
DEFAULT
VALUES
TC_LB_LINE_DETAIL
DEFAULT
PROTECTION
SCOPE
All.

MELBLineDetailStylesheet

DESCRIPTION
Specifies the name of the XSL style sheet used for the Balancing Line Detail report.

For more information about configuring line balancing reports, see Administering
Manufacturing Planning.
VALID
VALUES
Accepts an XSL file name, for example, MyLBLineDetailReport.xsl.
DEFAULT
VALUES
TCLineBalancingReport.xsl
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 22-175


Chapter
Chapter 22:22:Related
Related topics
topics

MEProcessResourcesViewDisplayNameColumnsShownPref

DESCRIPTION
Defines the columns to display in the Process Resources view in Manufacturing
Process Planner.
For more information about working with this view, see Manufacturing Process Planner.
VALID
VALUES
Accepts a list of valid Teamcenter object and internal property names separated by
a period.
object-type-name.internal-property-name
DEFAULT
VALUES
bl_line_name
BOMLine.bl_item_object_type
Mfg0BvrProcess.Mfg0allocated_time
Mfg0BvrProcessArea.Mfg0capacity
DEFAULT
PROTECTION
SCOPE
User preference.

MEProcessResourcesViewColumnsShownWidthPref

DESCRIPTION
Defines the width in pixels of the columns displayed in the Process
Resources view of Manufacturing Process Planner, as defined by the
MEProcessResourcesViewDisplayNameColumnsShownPref preference.
This setting affects each column defined in the
MEProcessResourcesViewDisplayNameColumnsShownPref preference.
VALID
VALUES
Accepts one or more integers as values. The number
of integers should match the number of columns in the
MEProcessResourcesViewDisplayNameColumnsShownPref preference.
DEFAULT
VALUES
45
25
25
25
DEFAULT
PROTECTION
SCOPE
All.

22-176 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

TWP.AppearanceColors

DESCRIPTION
Defines the colors to be shown for various elements in the Time Way Planner view of
the Manufacturing Process Planner application.
For more information about using the Time Way Planner view, see Manufacturing
Process Planner.
VALID
VALUES
Accepts the following format:
Object:object-name;BackgroundColor:RGB-code;ConflictColor:RGB-code
;DuplicateColor:RGB-code;ExceedingColor:RGB-code;ForegroundColor:RGB-code
Object:object-name
Specifies the object whose appearance is customized. The value is Operation,
Station, or ProductionZoneLine.
BackgroundColor:RGB-code
Specifies the background color of the object specified in the Object parameter.
For ProductionZoneLine, this is the boundary color.
ConflictColor:RGB-code
Applicable to operations only, specifies the color when a conflict is detected, for
example, overlapping operations, or operations starting at the same position.
DuplicateColor:RGB-code
Applicable to operations only, specifies the color whenever an operation occurs in
multiple execution positions.
ExceedingColor:RGB-code
Applicable to operations only, specifies the color whenever an operation exceeds
the cycle time of station.
ForegroundColor:RGB-code
Applicable to process zone and line boundaries only (ProductionZoneLine),
specifies the color for text.

DEFAULT
VALUES
Object:Operation;BackgroundColor:0,255,64;ConflictColor:255,0,0;
DuplicateColor:255,255,0;ExceedingColor:0,255,255
Object:ProductionZoneLine;BackgroundColor:255,0,128;ForegroundColor:0,0,0
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-177


Chapter
Chapter 22:22:Related
Related topics
topics

TWP.BoundariesMargin

DESCRIPTION
Defines the margin in pixels between the production line, zone, and station boundaries
in the Time Way Planner view of the Manufacturing Process Planner application.
For more information about using the Time Way Planner view, see Manufacturing
Process Planner.
VALID
VALUES
Accepts an integer as input.
DEFAULT
VALUES
10
DEFAULT
PROTECTION
SCOPE
User preference.

TWP.ExecutionPosition.Text

DESCRIPTION
Defines the text that is displayed as header of an Execution Position column in the
Time Way Planner view of the Manufacturing Process Planner application.
For more information about using the Time Way Planner view, see Manufacturing
Process Planner.
VALID
VALUES
Accepts one of the following:
object_string Property name for the execution position name.
Mfg0Acronym Property name for the execution position acronym.
Teamcenter ignores any other value and displays acronyms as default text.
DEFAULT
VALUES
Mfg0Acronym
DEFAULT
PROTECTION
SCOPE
User preference.

TWP.Operation.Text

DESCRIPTION
Defines the text that is displayed as header of an operation in the Time Way Planner
view of the Manufacturing Process Planner application.
For more information about using the Time Way Planner view, see Manufacturing
Process Planner.

22-178 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

VALID
VALUES
Accepts the following format:
legend[property-name]
legend Any string that is displayed as it is entered.
property-name The internal name of the property on the process line. The
property-name string is replaced by the property display name,
for example, the value Name: [bl_rev_object_name] is
displayed as Name: Object Name.
DEFAULT
VALUES
[bl_item_item_id]-[bl_rev_item_revision_id]; [bl_rev_object_name]
DEFAULT
PROTECTION
SCOPE
User preference.

TWP.ProcessLine.Text

DESCRIPTION
Defines the text that is displayed as header of a process line in the Time Way Planner
view of the Manufacturing Process Planner application.
For more information about using the Time Way Planner view, see Manufacturing
Process Planner.
VALID
VALUES
Accepts the following format:
legend[property-name]
legend Any string that is displayed as it is entered.
property-name The internal name of the property on the process line. The
property-name string is replaced by the property display name,
for example, the value Name: [bl_rev_object_name] is
displayed as Name: Object Name.
DEFAULT
VALUES
[bl_item_item_id]-[bl_rev_item_revision_id]; [bl_rev_object_name]
DEFAULT
PROTECTION
SCOPE
User preference.

TWP.Station.Text

DESCRIPTION
Defines the text that is displayed as the header of a station in the Time Way Planner
view of the Manufacturing Process Planner application.

PLM00026 11.2 Preferences and Environment Variables Reference 22-179


Chapter
Chapter 22:22:Related
Related topics
topics

For more information about using the Time Way Planner view, see Manufacturing
Process Planner.
VALID
VALUES
Accepts the following format:

legend[property-name]
legend Any string that is displayed as it is entered.

property-name The internal name of the property on the process line. The
property-name string is replaced by the property display name,
for example, the value Name: [bl_rev_object_name] is
displayed as Name: Object Name.
DEFAULT
VALUES
[bl_item_item_id]-[bl_rev_item_revision_id]; [bl_rev_object_name]
DEFAULT
PROTECTION
SCOPE
User preference.

TWP.StationAttribute

DESCRIPTION
Defines the text that is displayed as the footer of a station in the Time Way Planner
view of the Manufacturing Process Planner application.

For more information about using the Time Way Planner view, see Manufacturing
Process Planner.
VALID
VALUES
Accepts the following format:

legend[property-name]
legend Any string that is displayed as it is entered.

property-name The internal name of the property on the process line. The
property-name string is replaced by the property display name,
for example, the value Name: [bl_rev_object_name] is
displayed as Name: Object Name.
DEFAULT
VALUES
Name:[bl_rev_object_name]/ Cycle Time:[Mfg0cycle_time]/
Capacity:[Mfg0capacity]/ Allocated Time:[Mfg0allocated_time]
DEFAULT
PROTECTION
SCOPE
User preference.

22-180 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

TWP.StationDefaultSize

DESCRIPTION
Defines the default dimensions (in pixels) to be applied to stations when displayed in
the Time Way Planner view of Manufacturing Process Planner application.

For more information about using the Time Way Planner view, see Manufacturing
Process Planner.
VALID
VALUES
Accepts two integers in a list. The first integer represents the width and the second the
height of each station.
DEFAULT
VALUES
100, 150
DEFAULT
PROTECTION
SCOPE
User preference.

TWP.Tooltips

DESCRIPTION
Defines the properties to be displayed as tooltips for the elements in the Time Way
Planner view of the Manufacturing Process Planner application.

For more information about using the Time Way Planner view, see Manufacturing
Process Planner.
VALID
VALUES
Accepts the following format:

Object:object-name:TooltipProperties:[property-name]
object-name Only the Operation object name is supported.

property-name The internal name of the operation. The property-name


string is replaced by the property display name and its
value, for example, the value Name: [bl_rev_object_name]
is displayed as Name: Object Name. You can
add multiple values using a separator, for example,
TooltipProperties:[property1],[property2],[property3].
DEFAULT
VALUES
Object:Operation;TooltipProperties:[bl_rev_object_name],
[Mfg0allocated_time],[Mfg0calc_start_time]
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-181


Chapter
Chapter 22:22:Related
Related topics
topics

TWP.VisibilityOptions

DESCRIPTION
Defines the visibility options in the Time Way Planner view of the Manufacturing
Process Planner application.
For more information about using the Time Way Planner view, see Manufacturing
Process Planner.
VALID
VALUES
Accepts the following format:
visibility-option:[true|false]
The visibility options are:
ShowCarpet Specifies whether the carpet is visible in the Time Way Planner
view.
ShowOperations Controls the visibility of operations in Time Way Planner view.
ShowProduct Controls the visibility of the product image on stations in the
Image Time Way Planner view.
ShowBoundaries Controls the visibility of process area, line, and zone boundaries
in the Time Way Planner view.
DEFAULT
VALUES
ShowCarpet:true
ShowOperations:true
ShowProductImage:true
ShowBoundaries:true
DEFAULT
PROTECTION
SCOPE
User preference.

MES Integration preferences


AppInterface_default_relation

DESCRIPTION
Specifies the relation that has to be created when an object is pasted under an
AppInterface object. The relation specified for this preference is the default relation
that is created between the source and the target AppInterface object.
For more information about using the MES Integration, see Manufacturing Execution
System Integration.
VALID
VALUES
Accepts a valid Teamcenter relation type.

22-182 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
Fnd0LogRelation
DEFAULT
PROTECTION
SCOPE
Site preference.

AppInterface_shown_relation

DESCRIPTION
Specifies the list of relations that Teamcenter displays when expanding an
AppInterface object.
For more information about using the MES Integration, see Manufacturing Execution
System Integration.
VALID
VALUES
Accepts a list of valid Teamcenter relation types.
DEFAULT
VALUES
Fnd0LogRelation
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESAutomaticDeltaReleaseDecision

DESCRIPTION
Determines the behavior of the Release to Execution command.
For more information about using the Manufacturing Execution System Integration,
see Manufacturing Execution System Integration.
VALID
VALUES
true The user has a choice of either performing a full release or a delta release.
false The system makes the decision automatically.
DEFAULT
VALUES
false
The user must change this preference to true to perform a full release.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-183


Chapter
Chapter 22:22:Related
Related topics
topics

MEMESEnableModifiedReviseBehavior

DESCRIPTION
Controls the default revise behavior.
VALID
VALUES
True The Revision Effectivity dialog box is displayed to allow users
to set revision effectivity after performing the revise operation.
False The Revision Effectivity dialog box is not displayed.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESEnableReleaseToProduction

DESCRIPTION
Specifies whether the Release to Production command should be enabled.
VALID
VALUES
• True
Enables the command.

• False
Disables the command.

DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESGenerateWIRepFiles_Trans_Batch_Interval

DESCRIPTION
Specifies the interval time in seconds that the caller waits before checking the
generatemeswirep translator response.
For more information about using the Manufacturing Execution System Integration,
see Manufacturing Execution System Integration.
VALID
VALUES
Accepts an integer representing a time in seconds.

22-184 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
60
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESGenerateWIRepFiles_Trans_Continue_On_Error

DESCRIPTION
Specifies if the caller continues to process if the generatemeswirep translator fails.
For more information about using the Manufacturing Execution System Integration,
see Manufacturing Execution System Integration.
VALID
VALUES
true The caller continues to process if the translator fails.
false The caller ceases processing if the translator fails.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESGenerateWIRepFiles_Trans_DebugMode

DESCRIPTION
Specifies if the generatemeswirep translator executes in debugging mode.
For more information about using the Manufacturing Execution System Integration,
see Manufacturing Execution System Integration.
VALID
VALUES
true The translator writes detailed information in a log file that is located in the
staging directory configured for the translator.
false Less detailed information is printed in the log file.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-185


Chapter
Chapter 22:22:Related
Related topics
topics

MEMESGenerateWIRepFiles_Trans_Log_Folder

DESCRIPTION
Specifies the default Teamcenter folder where the generatemeswirep translator log
files are located.
For more information about using the Manufacturing Execution System Integration,
see Manufacturing Execution System Integration.
VALID
VALUES
Accepts a valid Teamcenter folder name
DEFAULT
VALUES
Home/Newstuff
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESGenerateWIRepFiles_Trans_Wait_Time

DESCRIPTION
Specifies the total duration in seconds that the caller waits for the generatemeswirep
translator to respond.
For more information about using the Manufacturing Execution System Integration,
see Manufacturing Execution System Integration.
VALID
VALUES
Accepts an integer representing a time in seconds.
DEFAULT
VALUES
600
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESPendingReleaseStatus

DESCRIPTION
Specifies the release status to be attached to the item revisions and incremental
change revisions before they are exported to the manufacturing execution system.
For more information about using the Manufacturing Execution System Integration,
see Manufacturing Execution System Integration.
VALID
VALUES
Accepts a valid Teamcenter release status.
DEFAULT
VALUES
Mei0PendingRelease

22-186 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESProductionChangeObjectTypes

DESCRIPTION
Defines the list of change object types displayed in the Search Change Items dialog
box.
VALID
VALUES
Valid change object type names.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESProductionProblemRevisionRelation

DESCRIPTION
Defines the relation to get problem items attached to the engineering change object.
VALID
VALUES
A valid relation name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESProductionSearchChangeObjectColumnsNames

DESCRIPTION
Defines the list of column names displayed in the Search Change Items dialog box.
VALID
VALUES
Valid column names.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-187


Chapter
Chapter 22:22:Related
Related topics
topics

MEMESProductionSites

DESCRIPTION
Defines the list of production sites that can use the Release to Production command
in Manufacturing Process Planner.
VALID
VALUES
A valid production site name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESProductionSolutionRevisionRelation

DESCRIPTION
Defines the relation to get the solution items attached to the engineering change object.
VALID
VALUES
A valid relation name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESProductionUpdateWorkflows

DESCRIPTION
Defines the update release workflow processes that can use the Release to
Production command in Manufacturing Process Planner.
VALID
VALUES
A valid workflow process name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

22-188 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEMESProductionWorkflowAndApplicationInterfaceType

DESCRIPTION
Defines the full release workflow and the associated application interface types that
can use the Release to Production command in Manufacturing Process Planner.
VALID
VALUES
A valid workflow name and the application interface type separated by a colon (:), for
example, workflow_name:application_interface_type.
DEFAULT
VALUES
ReleaseToProduction:Mei0ExecutionPlanAI
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESReleaseExportTransferMode

DESCRIPTION
Defines the transfer mode to be used for exporting the data to the Manufacturing
Execution System.
For more information about using the MES Integration, see Manufacturing Execution
System Integration.
VALID
VALUES
Accepts a valid Teamcenter closure rule.
DEFAULT
VALUES
MESExport
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESReleasedStatus

DESCRIPTION
Specifies the release statuses attached to the item revisions and incremental change
revisions after they are exported to the manufacturing execution system.
For more information about using the Manufacturing Execution System Integration,
see Manufacturing Execution System Integration.
VALID
VALUES
Accepts a valid Teamcenter release status.
DEFAULT
VALUES
Default value

PLM00026 11.2 Preferences and Environment Variables Reference 22-189


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESReleaseStatus

DESCRIPTION
Defines the release status flag to be used during the release status validity check for
a specific type and its subtypes when running the Manufacturing Execution System
Integration. If, for a data type, the release status is not specified in this preference,
Teamcenter checks that any released status exists when validating the data for release.
For more information about using the MES Integration, see Manufacturing Execution
System Integration.
VALID
VALUES
Accepts a list of string values representing the business object revision name
combined with the release status name as follows:
object-revision-type:release-status-name
For example:
MEOPRevision:TCM Release
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESReleaseToProductionExportTransferMode

DESCRIPTION
Defines the transfer mode to use for exporting data to production.
VALID
VALUES
An internal name of any transfer mode available in the database.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

22-190 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEMESReleaseToProductionImportTransferMode

DESCRIPTION
Defines the transfer mode to use for importing data to Teamcenter using the Release
to Production command in Manufacturing Process Planner.
VALID
VALUES
An internal name of any transfer mode available in the database.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESReleaseTraversalClosureRule

DESCRIPTION
Defines the closure rule to be used for the validation check traversal, recursive
release, and for exporting the data when using the Manufacturing Execution System
Integration. This expands the structure only to the assignment level.
For more information about using the MES Integration, see Manufacturing Execution
System Integration.
VALID
VALUES
Accepts a valid Teamcenter closure rule.
DEFAULT
VALUES
AccountabilityAll
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESProductionSites

DESCRIPTION
Defines the list of manufacturing execution system (MES) sites used by the Release
to Execution menu command. The sites you list must be registered as sites in the
Organization application.
For more information about using the MES Integration, see Manufacturing Execution
System Integration.
VALID
VALUES
Accepts a list of string values containing the names of sites running manufacturing
execution systems to which you want to send work packages.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 22-191


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESUpdateWorkflows

DESCRIPTION
Specifies the update workflows displayed in the Release changes to MES dialog.

For more information about using the Manufacturing Execution System Integration,
see Manufacturing Execution System Integration.
VALID
VALUES
Accepts a valid Teamcenter workflow name.
DEFAULT
VALUES
ReleaseUpdateToMES
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESURL

DESCRIPTION
Defines the value of the manufacturing execution system (MES) URL and its display
name to be used when the Web browser is opened by the Launch MES Web Page
menu command when running the Manufacturing Execution System Integration. The
way in which the Web browser opens (for example, in a separate window or in a tab)
is specified by the browserWindowMode preference.

For more information about using the MES Integration, see Manufacturing Execution
System Integration.
VALID
VALUES
Accepts a list of string values representing the display name of the URL combined
with the URL as follows:

display-name:URL
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
This preference lists the URL as a string. No check is made on the validity of the URL.

22-192 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEMESWorkflowAndApplicationInterfaceType

DESCRIPTION
Defines the workflow and its associated application interface type used by the Release
to Execution command. The workflow names are populated through the Release
to Execution menu command.
For more information about using the Manufacturing Execution System Integration,
see Manufacturing Execution System Integration.
VALID
VALUES
Accepts a list of string values containing a valid Teamcenter workflow name and
application interface type as follows:
workflow-name:application-interface-type
DEFAULT
VALUES
ReleaseToMES:Mei0ExecutionPlanAI
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESWorkInProgressReleaseStatus

DESCRIPTION
Specifies the release status to be attached to the item revisions and incremental
change revisions on creation.
For more information about using the Manufacturing Execution System Integration,
see Manufacturing Execution System Integration.
VALID
VALUES
Accepts a valid Teamcenter release status.
DEFAULT
VALUES
Mei0WorkInProgress
DEFAULT
PROTECTION
SCOPE
Site preference.

MEWiWorkInstructionMacroTemplate

DESCRIPTION
Defines the name of the dataset that contains the template to be used for loading the
work instruction document for the generatemeswirepfiles dispatcher request in the
Manufacturing Execution System Integration.
For more information about using the MES Integration, see Manufacturing Execution
System Integration.

PLM00026 11.2 Preferences and Environment Variables Reference 22-193


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts a valid Teamcenter specification template.
DEFAULT
VALUES
TWI_TC101OOTB_macro_spec_template
DEFAULT
PROTECTION
SCOPE
Site preference.

MEMESWorkAreaAssignedValidationObjects

DESCRIPTION
Defines the list of object types that are checked during the validation of the assigned
work area.
For more information about using the MES Integration, see Manufacturing Execution
System Integration.
VALID
VALUES
Accepts one of the following:
• MEProcess

• MEOP

• The internal name of any object derived from an MEProcess or MEOP object.

DEFAULT
VALUES
Mfg0MECompOP
DEFAULT
PROTECTION
SCOPE
Site preference.

MES_3DPDF_UPDATE_WORKFLOW_BATCH_INTERVAL

DESCRIPTION
Specifies the time interval in seconds after which the MES-Update3DPDFReports
action handler checks for the request status when updating 3D PDF documents before
sending them to a manufacturing execution system.
For more information, see Manufacturing Execution System Integration.
VALID
VALUES
Accepts a positive integer value.
DEFAULT
VALUES
60

22-194 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
PROTECTION
SCOPE
Site preference.

MES_3DPDF_UPDATE_WORKFLOW_CONTINUE_ON_ERROR

DESCRIPTION
Specifies whether the MES-Update3DPDFReports action handler should continue
if any of the requests fail or return with an error when updating 3D PDF documents
before sending them to an manufacturing execution system.
For more information, see Manufacturing Execution System Integration.
VALID
VALUES
True The action handler continues to process requests if it encounters
a problem.
False If the action handler encounters a problem, it stops processing
requests and returns an error message.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

MES_3DPDF_UPDATE_WORKFLOW_LOG_FOLDER

DESCRIPTION
Specifies the folder name where all log file datasets are created when updating 3D
PDF documents. If any 3D PDF request fails during the workflow, a new dataset is
created in this folder with the generated log file.
For more information about using the Manufacturing Execution System Integration,
see Manufacturing Execution System Integration.
VALID
VALUES
Accepts an existing Teamcenter folder name.
DEFAULT
VALUES
newstuff
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-195


Chapter
Chapter 22:22:Related
Related topics
topics

MES_3DPDF_UPDATE_WORKFLOW_WAIT_TIME

DESCRIPTION
Specifies the total time in seconds for completing all requests when updating 3D
PDF reports in preparation for transferring them to an external manufacturing
execution system. If all requests do not complete in this time frame, the
MES-Update3DPDFReports action handler returns an error message.
For more information about using the Manufacturing Execution System Integration,
see Manufacturing Execution System Integration.
VALID
VALUES
Accepts a positive integer value.
DEFAULT
VALUES
600
DEFAULT
PROTECTION
SCOPE
Site preference.

RequestObject_default_relation

DESCRIPTION
Specifies the relation that is created when an object is pasted under an application
interface request object. The relation specified for this preference is the default relation
that is created between the source and the target request object.
For more information about using the MES Integration, see Manufacturing Execution
System Integration.
VALID
VALUES
Accepts a valid Teamcenter relation type.
DEFAULT
VALUES
Fnd0LogRelation
DEFAULT
PROTECTION
SCOPE
Site preference.

RequestObject_shown_relation

DESCRIPTION
Specifies the list of relations that Teamcenter displays when expanding an application
interface request object.
For more information about using the MES Integration, see Manufacturing Execution
System Integration.
VALID
VALUES
Accepts a list of valid Teamcenter relation types.

22-196 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

DEFAULT
VALUES
Fnd0LogRelation
DEFAULT
PROTECTION
SCOPE
Site preference.

Manufacturing 4D planning preferences

ME4DSearchCriteriaDate

DESCRIPTION
Defines the date property to be used from the process object when the results of a
spatial search are filtered on the server. Teamcenter uses this preference only if the 4D
Planning solution is deployed and the user chooses the 4D Analysis menu command.
For more information about using 4D planning, see Manufacturing Process Planner.
VALID
VALUES
Accepts a single string as value. The string must be a valid date property such as
fdp0ScheduledStartDate or fdp0ScheduledFinishDate.
DEFAULT
VALUE
fdp0ScheduledStartDate
DEFAULT
PROTECTION
SCOPE
Site preference.

ME4DProcessStartDateFromTask

DESCRIPTION
Maps the fdp0ScheduledStartDate runtime property on the process business object
to the appropriate property on the task business object when the process runtime
property is initialized. If you modify this preference, four runtime properties on the
process object are affected:
• fdp0ScheduledFinishDate

• fdp0ScheduledDuration

• fdp0ScheduledWorkEstimate

• fdp0ScheduledCalculatedDuration

You must reload the structures (process and schedule) to get the updated values.
For more information about using 4D planning, see Manufacturing Process Planner.

PLM00026 11.2 Preferences and Environment Variables Reference 22-197


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts a single string as value. The value must be a date property on the task object.
The valid values are:
• start_date

• actual_start_date

DEFAULT
VALUE
start_date
DEFAULT
PROTECTION
SCOPE
Site preference.

ME4DResultsViewColumnsWidthPref

DESCRIPTION
Defines the width (in pixels) of the 4D Results view columns as defined by the
ME4DResultsViewDisplayNameColumnsShownPref preference.
For more information about using 4D planning, see Manufacturing Process Planner.
VALID
VALUES
Accepts one or more integers as values. The number of integers should match the
number of columns in the ME4DResultsViewDisplayNameColumnsShownPref
preference.
DEFAULT
VALUE
45
15
15
15
DEFAULT
PROTECTION
SCOPE
User preference.

ME4DResultsViewDisplayNameColumnsShownPref

DESCRIPTION
Specifies the internal names of the BOP line properties that are displayed as columns
in the 4D Results view. This preference is an internal preference and should be
modified by the code only.
For more information about using 4D planning, see Manufacturing Process Planner.
VALID
VALUES
Accepts the internal name of each column in the order they are to appear. The syntax
for the value is:

22-198 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

type-internal-name.property-internal-name
DEFAULT
VALUE
BOMLine.bl_indented_title
Mfg0BvrCompOP.fdp0ScheduledStartDate
Mfg0BvrCompOP.fdp0ScheduledFinishDate
Mfg0BvrCompOP.fdp0ScheduledCalDuration
DEFAULT
PROTECTION
SCOPE
User preference.

ME4DRelationTypePartsConsumed

DESCRIPTION
Defines the consume relationship between assignment parts and work orders or
processes when running a 4D analysis search in Manufacturing Process Planner.
For more information, see Manufacturing Process Planner.
VALID
VALUES
Accepts the internal name of a valid Teamcenter occurrence type.
DEFAULT
VALUE
MEConsumed
DEFAULT
PROTECTION
SCOPE
Site preference.

PAD preferences
MEPSDTableShownColumnWidthsPref

DESCRIPTION
Specifies the column widths for the columns (identified by
MEPSDTableColumnsShownPref) that are used in the MEPSD table section of the
PAD user interface at the MEPAD level.
VALID
VALUES
Positive whole numbers.
DEFAULT
VALUES
36
19
25
25
36

PLM00026 11.2 Preferences and Environment Variables Reference 22-199


Chapter
Chapter 22:22:Related
Related topics
topics

DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
When a user modifies the preference, a user-level preference gets generated.
RESTRICTIONS
The value of this preference is to be set by the site manager only.

MEPSDTableColumnsShownPref.SORTING_COLUMN

DESCRIPTION
Specifies the column that is used for sorting table data in the MEPSD table section of
the PAD user interface at the MEPAD level.
VALID
VALUES
Accepts only one string as a valid value.
DEFAULT
VALUES
bl_sequence_no.true

DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
When a user modifies the preference, a user level preference gets generated.
RESTRICTIONS
The value of this preference is to be set by the site manager only.

MEPADChildTypesPref

DESCRIPTION
Specifies the default child types to be displayed in the MEPSD table section of the
PAD user interface at the MEPAD level.
VALID
VALUES
Accepts only one string as a valid value.
DEFAULT
VALUES
*:MEPSD
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
When a user modifies the preference, a user-level preference gets generated.
RESTRICTIONS
The value of this preference is to be set by the site manager only.

22-200 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

MEPSDTableColumnsShownPref

DESCRIPTION
Specifies the list of column names that will be displayed in the MEPSD table section of
the PAD user interface at the MEPAD level.
VALID
VALUES
The values should be valid column names.
DEFAULT
VALUES
BOMLine.bl_indented_title
BOMLine.bl_sequence_no
BOMLine.bl_rev_object_name
BOMLine.bl_rev_object_desc
BOMLine.bl_variant_condition

DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
When a user modifies the preference, a user-level preference gets generated.
RESTRICTIONS
The value of this preference is to be set by the site manager only.

Resource management preferences

MRMApplicabilitySelection

DESCRIPTION
Defines whether, by default, the Highlighted or Filtered buttons are selected.
For more information about viewing attributes applicable to a specific application,
see Resource Manager.
VALID
VALUES
Accepts either Highlighted or Filtered.
DEFAULT
VALUES
Highlighted
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-201


Chapter
Chapter 22:22:Related
Related topics
topics

MRMExpandUptoLevelOnLoad

DESCRIPTION
Defines the number of levels an assembly is expanded when it is opened in Resource
Manager.
For more information about working with resource structures, see Resource Manager.
VALID
VALUES
Accepts an integer.
DEFAULT
VALUES
2
DEFAULT
PROTECTION
SCOPE
Site preference.

MRMGTCVendorCatalogRootDir

DESCRIPTION
Defines the root directories on the Teamcenter server where the generic vendor tool
catalogs are stored.
For more information, see Resource Manager.
VALID
VALUES
Accepts a valid operating system path. You can specify multiple entries.
DEFAULT
VALUES
D:\VendorCatalogs
DEFAULT
PROTECTION
SCOPE
Site preference.

MRMItemTypes

DESCRIPTION
Specifies what item type is selected as default based on the currently selected class
in the New Resource dialog box in the Resource Manager application. This item
type is used for the specified class and all its child classes. You can overwrite the
item type in child classes.
For more information about creating new resources, see Resource Manager.
VALID
VALUES
Accepts one or more pairs of strings as values. In each string pair, the first value must
be a valid Classification class ID, and the second value must be a valid business
object (type).
The most common item types used with Resource Manager are:

22-202 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

Display name Internal name


Resource Mfg0MEResource
MENCTool Mfg0MENCTool
MEMachine Mfg0MEMachine
MEEquipment Mfg0MEEquipment

DEFAULT
VALUES
MRM
Mfg0MEResource
MACHINES
Mfg0MEMachine
TOOLS
Mfg0MENCTool
DEFAULT
PROTECTION
SCOPE
All.

MRMNeutralCSYSPrefixes

DESCRIPTION
Customizes the prefixes of the coordinate system names that are used for Resource
Manager automatic positioning. Teamcenter checks coordinate system names in the
precedence that is defined in this preference.
For more information, see Resource Manager.
VALID
VALUES
Accepts a list of strings representing the custom prefixes for names of coordinate
systems.
DEFAULT
VALUES
NEUTRAL
SCOPE
Site preference.
NOTES
• The preference is not installed with the software. You must add it manually.

• Prefixes are not case-sensitive.

MRMPlugCSYSPrefixes

DESCRIPTION
Customizes the prefixes of the coordinate system names that are used for Resource
Manager automatic positioning. Teamcenter checks coordinate system names in the
precedence that is defined in this preference.
For more information, see Resource Manager.

PLM00026 11.2 Preferences and Environment Variables Reference 22-203


Chapter
Chapter 22:22:Related
Related topics
topics

VALID
VALUES
Accepts a list of strings representing the custom prefixes for names of coordinate
systems.
DEFAULT
VALUES
Plug
MCS
SCOPE
Site preference.
NOTES
• The preference is not installed with the software. You must add it manually.

• Prefixes are not case-sensitive.

MRMPropagationAlternateAttributes

DESCRIPTION
Specifies alternate attributes that are used for attribute value propagation. By
default, Teamcenter checks if the propagated attribute exists and is filled out in
the components. If so, this attribute value is propagated to the root node ICO.
This preference allows you to define alternate attributes that are checked during
propagation. Additional rules can be defined in the scope of specific classes.
For more information about propagating attributes, see Resource Manager.
VALID
VALUES
Accepts a string of the following format:
class-for-which-rule-is-valid::first-alternate-attribute-ID::second-alternate-attribute-ID::...
For example:
TAG003_DRILL::-40018::-40024,-40021
This rule is valid if the resource assembly is in the class with ID TAG003_DRILL or in a
subclass of this class. If the assembly class has a propagated attribute with ID -40018,
Teamcenter starts at the propagation start point and checks if the components have
an attribute whose ID is -40018. If this attribute does not exist, it next checks for an
attribute with ID -40024, and if this does not exist, then for -40021. If a value is found,
it is propagated. If a value is not found in either the main attribute or in the alternate
attributes, the propagated attribute remains empty. If you want to define a rule that is
valid for all classes, use class ID ICM (the classification root class).
DEFAULT
VALUES
Teamcenter does not initially set a default value for the preference. However, if you
install the Manufacturing Resource Library, Teamcenter sets the following default
values:
TAG003_DRILL::-40018::-40024,-40021
TAG002_MILL::-40245::-40254
TAG003_DRILL::-40254::-40245
TA_DRILL_10_20::-40091::-40271

22-204 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

TA_TURN_10::-40073::-40270
TA_TURN_20_20::-40073::-40270
TA_TURN_20_30::-40073::-40270
TA_TURN_30_20::-40073::-40270
TAG002_MILL::-40019::-40026
TAG002_MILL::-40020::-40027
DEFAULT
PROTECTION
SCOPE
User preference.

MRMPropagationRevisionRule

DESCRIPTION
Determines the revision rule used during the propagation of attributes. For example,
when the user saves a resource assembly and there is a propagation start point (PSP)
defined in the assembly, the system propagates the attribute values to the assembly
level. The specified revision rule configures the component revisions that are used
during this propagation.
VALID
VALUES
Accepts a single string as value. The string must be a valid revision rule defined in the
database, such as Latest Working or Latest by Alpha Rev Order.
DEFAULT
VALUES
Latest Working
DEFAULT
PROTECTION
SCOPE
Site preference.

MRMSocketCSYSPrefixes

DESCRIPTION
Customizes the prefixes of the coordinate system names that are used for Resource
Manager automatic positioning. Teamcenter checks coordinate system names in the
precedence that is defined in this preference.
For more information, see Resource Manager.
VALID
VALUES
Accepts a list of strings representing the custom prefixes for names of coordinate
systems.
DEFAULT
VALUES
Socket
CSW
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 22-205


Chapter
Chapter 22:22:Related
Related topics
topics

NOTES
• The preference is not installed with the software. You must add it manually.

• Prefixes are not case-sensitive.

Part planning preferences

NX_supported_operation_types

DESCRIPTION
Determines which defined operation types are supported by the NX CAM Integration.
Manufacturing engineers use the Part Planner application to outline the fabrication
process plans necessary to manufacture components. The individual process
planning operations are part of the fabrication process of a component. By default,
the Teamcenter manufacturing process management – NX CAM Integration uses
the MENCMachining operation type to support the NX CAM integration. Use this
preference to define additional operation types to be supported by the integration.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
operation type.
DEFAULT
VALUES
MENCMachining
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_NX_FileNewPAXFiles_NX<version>

DESCRIPTION
Specifies the item IDs of the PAX files pointing to different NX versions of CAM
templates. This preference must be suffixed by the version number of the NX
installation from which you are importing the templates. For example, if you import
templates from NX 7.5, name this preference TC_NX_FileNewPAXFiles_NX75.
VALID
VALUES
Accepts one or more Teamcenter item IDs. Each item comprises a text dataset
containing an imported PAX file.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

22-206 Preferences and Environment Variables Reference PLM00026 11.2


Related topics

NOTES
By default, this preference is not found in the database. You must enter it manually.

MEActivityReferenceNonActivityChildren

DESCRIPTION
Specifies whether the datasets attached to an MEActivity object are copied or
referenced when copying the MENCRevision item or saving it as a new revision.
For more information about , see Getting Started with Manufacturing.
VALID
VALUES
TRUE The datasets are copied as references when an MENCRevision
item is copied or revised.
This is the default if this preference is not set.
FALSE The datasets are copied as new objects when an
MENCRevision item is copied or revised.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site.
NOTES
This preference is not installed with the software. If you need to change the default
behavior, you must add this preference manually.
For information about creating and using preferences, see Teamcenter Basics.

PLM00026 11.2 Preferences and Environment Variables Reference 22-207


Chapter 23: Visualization preferences

3DMarkup_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-1
DMI_markup_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-1
INTEROP_ExtraPLMXMLInstanceAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-2
Interop_Vis_Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-3
Interop_Vis_Attributes_Admin_Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-4
ItemRevision_DirectModel3DMarkup_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-5
ItemRevision_Vis_Session_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-6
JT_File_Use_Monolithic_Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-6
ManagedIssueList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-7
ManagedIssueListQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-7
ManagedIssueServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-8
MetaDataStamp_template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-8
PLM_End_Item_Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-9
SecondaryVMUDatasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-9
TC_DIS_2D_named_ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-10
TC_DIS_3D_named_ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-10
TC_DIS_Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-11
TC_ENABLE_REPOSITION_DIALOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-11
TC_Schematic_BOMView_Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-12
TC_show_open_in_vmu_button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-12
TCVIS_reposition_all_arrangements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-12
TCVIS_Selection_From_Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-13
Vis_Doc_OpenOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-14
VIS_expand_below_batch_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-14
VIS_LAUNCH_LOGIN_PROMPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-14
VIS_mmvindexgen_admin_group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-15
VIS_multi_file_datasettypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-15
Vis_PV_capture3DGeomAssetAsOutline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-16
Vis_PV_ImageCapture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-16
Vis_PV_ImageCaptureHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-17
Vis_PV_ImageCaptureResolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-17
Vis_PV_ImageCaptureType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-18
Vis_PV_ImageCaptureWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-18
Vis_PV_ThumbnailHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-19
Vis_PV_ThumbnailQuality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-19
Vis_PV_ThumbnailWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-19
Vis_PV_Play_Motion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-20
Vis_PV_Show_Name_Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-20
Vis_PV_Geometry_Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-21
Vis_PV_HowTo_Configure_BOM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-21
Vis_PV_InvalidConfigWarnLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-22
Vis_PV_BlockingViewToggles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-22
VisMarkup_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-23

PLM00026 11.2 Preferences and Environment Variables Reference


VisSession_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-23
VisualReport_Use_Classification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-24
VMU_Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-24
VMU_FileSearchOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-25
VMU_RelationSearchOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23-26

Preferences and Environment Variables Reference PLM00026 11.2


Chapter 23: Visualization preferences

3DMarkup_relation_primary

DESCRIPTION
Indicates the list of valid primary object types for the 3Dmarkup relation. These are
the dataset types that you can mark up with the 3D markup tools. The format is
relation-name_relation_primary=List of valid primary object types. This preference is
applicable for the stand-alone viewer and the Lifecycle Viewer.
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
One or more strings as values; each string must be a valid Teamcenter dataset type.
DEFAULT
VALUES
DirectModel
DirectModelAssembly
DEFAULT
PROTECTION
SCOPE
Site preference.

DMI_markup_relation_primary

DESCRIPTION
Indicates the list of valid primary object types for the DMI_markup relation. These
are the dataset types that you can mark up with the 2D markup tools. The format is
relation-name_relation_primary=List of valid primary object types. This preference is
applicable for the stand-alone viewer and the Lifecycle Viewer.
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
One or more strings as values; each string must be a valid Teamcenter dataset type.
DEFAULT
VALUES
DirectModel

PLM00026 11.2 Preferences and Environment Variables Reference 23-1


Chapter
Chapter 23:23:Visualization
Visualization preferences
preferences

DrawingSheet
Image
DEFAULT
PROTECTION
SCOPE
Site preference.

INTEROP_ExtraPLMXMLInstanceAttributes

DESCRIPTION
Determines the mapping of Structure Manager BOM line attributes to Lifecycle
Visualization attributes.
Note

• This preference is applicable only for PLM XML generated by the


BOMWriter. For the SOA-based Teamcenter integration with Lifecycle
Visualization 8 and later, use the Interop_Vis_Attributes and
Interop_Vis_Attributes_Admin_Filter preferences.

• This preference works only with stand-alone Lifecycle Visualization and


the Lifecycle Viewer.

VALID
VALUES
Accepts multiple string pairs as values. Each group of strings must be in the following
format:
target:root/part/instance/occurrence
key:Lifecycle Visualization attribute name
prop:BOM line property
|propuid:bomline property tag value converted to UID
|literal: literal string
|attr:attribute name

target:root writes user attributes to the ProductRevisionView element of the top


BOM line item revision in the generated PLM XML file.
target:part writes user attributes to all ProductRevisionView elements in the
generated PLM XML file.
target:instance writes user attributes to all Instance elements in the generated PLM
XML file.
target:occurrence writes user attributes to all Occurrence elements in the generated
PLM XML file.
For example, the following values create the following mappings:
target:Occurrence
key:USER_DATA_1
prop:bl_ItemRevision Master_user_data_1
target:Instance

23-2 Preferences and Environment Variables Reference PLM00026 11.2


Visualization preferences

key:COMMENTS
prop:bl_ItemRevision Master_item_comment
key:CATEGORY
literal:CRITICALPART
target:Part
key:BOM_VIEW_TAG
propuid:bl_bomview

Maps the user_data_1 attribute from the child Item Revision Master form to the
USER_DATA_1 Lifecycle Visualization attribute. This mapping is written on all
Occurrence elements.
Maps the comments attribute from the child Item Revision Master form to the
COMMENTS Lifecycle Visualization attribute. This mapping is written on all Instance
elements.
Maps the CRITICALPART (literal string) to the CATEGORY Lifecycle Visualization
attribute. This mapping is written on all Instance elements.
Maps the bl_bomview (UID value) to the BOM_VIEW_TAG Lifecycle Visualization
attribute. This mapping is written on all ProductRevisionView elements.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Interop_Vis_Attributes

DESCRIPTION
Indicates which Teamcenter attributes are available when an assembly is displayed
in Lifecycle Visualization. The Lifecycle Visualization Teamcenter Integration
Preferences dialog box (File→Preferences→Teamcenter Integration→Attributes)
provides a convenient user interface for managing this preference.
The Interop_Vis_Attributes preference corresponds to the right column in the
Teamcenter Integration Preferences dialog box as shown.

PLM00026 11.2 Preferences and Environment Variables Reference 23-3


Chapter
Chapter 23:23:Visualization
Visualization preferences
preferences

VALID
VALUES
A list of Teamcenter BOM line attributes. If Interop_Vis_Attributes_Admin_Filter
is set, Interop_Vis_Attributes must be a subset of it.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

Interop_Vis_Attributes_Admin_Filter

DESCRIPTION
Indicates which Teamcenter attributes are presented to users when assemblies are
viewed in Lifecycle Visualization Teamcenter Integration Preferences dialog box
(File→Preferences→Teamcenter Integration→Attributes). Those presented are
the ones that users can then display (see the Interop_Vis_Attributes preference
description).
The Interop_Vis_Attributes_Admin_Filter preference corresponds to the left column
in the Teamcenter Integration Preferences dialog box as shown.

23-4 Preferences and Environment Variables Reference PLM00026 11.2


Visualization preferences

If there is no setting for the Interop_Vis_Attributes_Admin_Filter preference, the


left column lists all BOM line attributes as candidates for users to select display (that
is, candidates to move to right column).
VALID
VALUES
A list of Teamcenter BOM line attributes. If Interop_Vis_Attributes_Admin_Filter
is set, Interop_Vis_Attributes must be a subset of it.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

ItemRevision_DirectModel3DMarkup_default_relation

DESCRIPTION
Specifies the relation that has to be created when a DirectModel3DMarkup dataset
is pasted under an item revision. The relation specified for this preference is the
default relation that is created between the DirectModel3DMarkup dataset and the
target item revision. This preference is applicable for the stand-alone viewer and
the Lifecycle Viewer.
Warning

This preference is set automatically by the application and must not be modified.

VALID
VALUES
A valid Teamcenter relation.

PLM00026 11.2 Preferences and Environment Variables Reference 23-5


Chapter
Chapter 23:23:Visualization
Visualization preferences
preferences

DEFAULT
VALUES
VisMarkup
DEFAULT
PROTECTION
SCOPE
Site preference.

ItemRevision_Vis_Session_default_relation

DESCRIPTION
Specifies the relation that has to be created when a Vis_Session dataset is pasted
under an item revision. The relation specified for this preference is the default relation
that is created between the Vis_Session dataset and the target item revision. This
preference is applicable for the stand-alone viewer and the Lifecycle Viewer.
Warning

This preference is set automatically by the application and must not be modified.

VALID
VALUES
A valid Teamcenter relation.
DEFAULT
VALUES
VisSession
DEFAULT
PROTECTION
SCOPE
Site preference.

JT_File_Use_Monolithic_Icon

DESCRIPTION
Specifies whether a monolithic icon is displayed to indicate the presence of
structure in a JT file in the BOM tree of the Structure Manager and Manufacturing
Process Planner applications.
VALID
VALUES
true The monolithic icon is displayed when a monolithic JT file containing
structure is loaded in the viewer.
false The monolithic icon is not displayed unless the node is affected by the
JT_File_OverrideChildren_Refsets preference.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

23-6 Preferences and Environment Variables Reference PLM00026 11.2


Visualization preferences

ManagedIssueList

DESCRIPTION
Specifies the thin client URL of your Teamcenter visual issues list. This preference is
applicable for the stand-alone viewer only. When you use the View existing issues
command in the stand-alone viewer, the thin client displays the specified list.
Note

By default, the visual issues list includes all IssueReport Revisions. To display
only visual issues that match predefined search criteria, you must also set the
ManagedIssueListQuery preference.

VALID
VALUES
Accepts a single string as a value. Must be a valid URL.
Example

http://tcserver:7001/tc/webclient?TC_file=search/issuelist.html

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ManagedIssueListQuery

DESCRIPTION
Specifies the name of a saved search to use when working with visual issues in the
stand-alone viewer. By default, when you use the View existing issues command,
the thin client displays a list of all existing IssueReport Revisions. If you have created
a custom search to find IssueReport Revisions according to criteria such as Owning
Group and Issue Category, you can specify to use that search instead of the default.
For more information on creating a custom search for IssueReport Revisions, see the
Issue Manager Guide.
VALID
VALUES
Accepts a string as a value. Must be the name of a saved search.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 23-7


Chapter
Chapter 23:23:Visualization
Visualization preferences
preferences

ManagedIssueServer

DESCRIPTION
Specifies to use the legacy visual issues feature, which interfaces with Teamcenter
community collaboration, or the Teamcenter visual issues system. This preference is
applicable for the stand-alone viewer only.
VALID
VALUES
True or False. Type True to use the Teamcenter visual issues system in the
stand-alone viewer, or False to use the legacy visual issues feature.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

MetaDataStamp_template

DESCRIPTION
Specifies the item ID of the item revision that provides the MetaDataStamp template
dataset. The MetaDataStamp template drives the formatting styles used in rendering
the text and watermark stamp content.
The default MDS_default_styles_template.mds template file is located in the
$TC_DATA directory on the Teamcenter server machine; it is imported to the database
as a dataset called MDS_default_styles_template.
Note

To replace the default template, do one of the following:


• Delete the Item containing the MetaDataStamp Template dataset from the
database. Place the custom MDS_default_styles_template file inside the
$TC_DATA folder and run the add_mds_template import script to add the
new template to the database. Note that the template file must be named
MDS_default_styles_template.

• In the rich client, perform a search to locate the


MDS_default_styles_template dataset. Right-click the dataset, choose
Named References, and then delete the existing dataset and re-import
the new one.

VALID
VALUES
The item ID of the item revision that contains the MetaDataStamp template dataset.

23-8 Preferences and Environment Variables Reference PLM00026 11.2


Visualization preferences

Note

If your Teamcenter environment is configured to use multifield keys with


the item business object type, the MetaDataStamp_template value must
consist of the values of the multifield key properties associated with the item.
For example, if the unique keys are the item ID and the object type, set the
MetaDataStamp_template value as follows:
item_id=MDS_default_styles_template,object_type=DMTemplate
To obtain the key information, use the get_key_string utility.

DEFAULT
VALUES
MDS_default_styles_template
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM_End_Item_Key

DESCRIPTION
Indicates which Teamcenter occurrence note (BOM line attribute key/name) is used
to identify an occurrence as an end item. If the identified occurrence note exists on
an occurrence and has a value of True, that occurrence is treated as an end item
by the viewer.
VALID
VALUES
A string representing the key/name of the corresponding Teamcenter occurrence note.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

SecondaryVMUDatasets

DESCRIPTION
Defines the dataset types, connected using a secondary relationship, used to search
for files in ambiguous conditions. Ambiguous conditions result from performing file
operations on objects or datasets.
These are the non-VMU dataset types that can contain VMU datasets. VMU datasets
are datasets that can be directly launched from the rich client or the thin client into the
Lifecycle Viewer or a stand-alone viewer.
VALID
VALUES
The existing NX dataset values.

PLM00026 11.2 Preferences and Environment Variables Reference 23-9


Chapter
Chapter 23:23:Visualization
Visualization preferences
preferences

DEFAULT
VALUES
UGMASTER
UGPART
UGALTREP
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_DIS_2D_named_ref

DESCRIPTION
Defines the possible reference names of 2D file types that are capable of 2D markups.
This preference is applicable for the Lifecycle Viewer and the viewers embedded in
Teamcenter applications such as My Teamcenter and Structure Manager.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter reference name.
DEFAULT
VALUES
Quickshade-Image
PLT
BMP
CAL
TIFF
Graphics-Interface
Sheet
PDF
JPEG
TIF
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_DIS_3D_named_ref

DESCRIPTION
Defines the possible reference names of 3D file types that are capable of 3D markups.
This preference is applicable for the Lifecycle Viewer and the viewers embedded in
Teamcenter applications such as My Teamcenter and Structure Manager.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter reference name.
DEFAULT
VALUES
ConfiguredAssembly
UGPART
IMAGE

23-10 Preferences and Environment Variables Reference PLM00026 11.2


Visualization preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_DIS_Search

DESCRIPTION
The search schemas used when searches are performed from the file dialogs within
the stand-alone viewers and the Lifecycle Viewer.
VALID
VALUES
One or more strings as values; each string must be an existing Teamcenter search
schema.
DEFAULT
VALUES
Dataset…
Item…
Item Revision…
Part
DEFAULT
PROTECTION
SCOPE
User preference.

TC_ENABLE_REPOSITION_DIALOG

DESCRIPTION
Specifies whether to use the Reposition or the Transformation dialog boxes to
transform parts in the rich client embedded viewers.
VALID
VALUES
true Specifies the following:
• Reposition is an option on the Graphics menu.

• The Reposition – Exploded View dialog box appears when you choose
Graphics→Reposition→Temporary Position.

• The Reposition – BOM Line Edit dialog box appears when you choose
Graphics→Reposition→Persistent Position.

false Specifies the following:


• Transformation is an option on the Graphics menu.

• The Persistent Transformation dialog box appears when you choose


Graphics→Transformation→Persistent Transformation.

• The Temporary Transformation dialog box appears when you choose


Graphics→Transformation→Temporary Transformation.

PLM00026 11.2 Preferences and Environment Variables Reference 23-11


Chapter
Chapter 23:23:Visualization
Visualization preferences
preferences

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

TC_Schematic_BOMView_Types

DESCRIPTION
Determines whether Lifecycle Visualization is used in schematic mode or 3D mode. If
left unset, Lifecycle Visualization is used in 3D mode.
VALID
VALUES
Takes multiple strings as values. Each value must be a set of BOM View types. It is
intended that the types represent logical BOMs. For example:
Piping System View
Electrical System View

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_show_open_in_vmu_button

DESCRIPTION
Specifies whether the Start/Open in Lifecycle Visualization button is displayed in the
rich client and the View→Teamcenter Visualization menu command is displayed in
the thin client.
VALID
VALUES
Accepts one of the following strings as values: True or False.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

TCVIS_reposition_all_arrangements

DESCRIPTION
Controls the extent of persistent transformations in arrangements. If
undefined or set to True, persistent transformations made using the

23-12 Preferences and Environment Variables Reference PLM00026 11.2


Visualization preferences

Graphics→Transformation→Persistent Transformation menu command are


applied to all arrangements in the structure; if set to False, persistent transformations
are applied only to the active arrangement.
VALID
VALUES
True Persistent transformations are applied to all arrangements in
the structure.
False Persistent transformations are applied only to the active
arrangement.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
User preference.

TCVIS_Selection_From_Viewer

DESCRIPTION
Controls the selection behavior for packed structure in the embedded viewer. If
undefined or set to False, selecting a part associated with a packed structure line in
the embedded viewer also selects all other parts encompassed by the parent line
of packed structure; if set to True, parts associated with packed structure lines are
selected individually.
Note

If you select a part associated with a parent line of packed structure, parts
associated with the child lines encompassed by the parent line are also
selected. If you want to select only the part directly associated with a parent line
of packed structure, you must first unpack the structure.

VALID
VALUES
True Parts associated with packed structure lines are selected
individually in the embedded viewer.
False Selecting a part associated with a packed structure line also
selects all of the other parts associated with the parent line of
packed structure.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 23-13


Chapter
Chapter 23:23:Visualization
Visualization preferences
preferences

Vis_Doc_OpenOption

DESCRIPTION
Specifies the behavior for opening a document in the embedded or stand-alone
Lifecycle Visualization viewer when the same document is already open in that viewer.
VALID
VALUES
CreateNewDocument Opens a duplicate document window.

ActivateExistingDocument Makes the already open document window active.


DEFAULT
VALUES
ActivateExistingDocument
DEFAULT
PROTECTION
SCOPE
User preference.

VIS_expand_below_batch_size

DESCRIPTION
Defines the batch size of BOM lines to expand for all assembly expand operations in
the Lifecycle Viewer and the stand-alone application viewer. BOM lines are expanded
in each assembly level in batches, the size of which is defined by this preference.

Note

Use the RAC_expand_below_batch_size preference to specify the batch size


of expand operations in the Structure Manager viewer.

VALID
VALUES
Accepts a single integer as a value. A positive integer defines the number of lines
processed per batch. Use -1 to indicate no maximum batch size, in which case all
lines in a single level are processed in a single batch.
DEFAULT
VALUES
50
DEFAULT
PROTECTION
SCOPE
User preference.

VIS_LAUNCH_LOGIN_PROMPT

DESCRIPTION
Controls whether Lifecycle Visualization viewers display the logon prompt when
opening data from Teamcenter. Note that when Teamcenter Security Services single
sign-on authentication is enabled, you need to log on only once, regardless of what
the preference is set to.

23-14 Preferences and Environment Variables Reference PLM00026 11.2


Visualization preferences

Caution

Setting VIS_LAUNCH_LOGIN_PROMPT to False creates a security risk


because of the nonprompted login.

VALID
VALUES
True The Lifecycle Visualization viewers require a user name and
password to open Teamcenter data.
False The viewers do not require a logon.
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
System preference.

VIS_mmvindexgen_admin_group

DESCRIPTION
Specifies what user group has the authority to run the mmvindexgen harvester.
Note

Create the MmvIndexGenAdmin user group and add those users with the
authority to run the mmvindexgen harvester, or change the default value of this
preference to the name of an existing user group.

VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
MmvIndexGenAdmin
DEFAULT
PROTECTION
SCOPE
Site preference.

VIS_multi_file_datasettypes

DESCRIPTION
Specifies the visualization dataset types that can contain more than one named
reference. Users can view the selected named reference in the My Teamcenter
embedded viewer.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter dataset type.
DEFAULT
VALUES
DirectModel

PLM00026 11.2 Preferences and Environment Variables Reference 23-15


Chapter
Chapter 23:23:Visualization
Visualization preferences
preferences

DrawingSheet

DEFAULT
PROTECTION
SCOPE
Site preference.

Vis_PV_capture3DGeomAssetAsOutline

DESCRIPTION
Activates the creation of outline capture when you save a product view in Lifecycle
Visualization.
Note

This preference is only used if 3D Geometry Asset Capture is enabled for


product view save with no menus.

VALID
VALUES
True
False
DEFAULT
VALUES
False

DEFAULT
PROTECTION
SCOPE
Site preference.

Vis_PV_ImageCapture

DESCRIPTION
Indicates whether an Image Capture should be added when a product view is created.
It also is used to determine how the Image Capture options are configured.
VALID
VALUES
One of the following strings:
• NoImageCapture – an Image Capture is not generated.

• CaptureUsingPrefs – an Image Capture is generated using Teamcenter


preferences that affect Image Capture generation.

• CaptureUsingDialog – an Image Capture is generated and the application uses


the Image Export dialog option to configure the Image Capture.

DEFAULT
VALUES
NoImageCapture

23-16 Preferences and Environment Variables Reference PLM00026 11.2


Visualization preferences

DEFAULT
PROTECTION
SCOPE
User preference.

Vis_PV_ImageCaptureHeight

DESCRIPTION
Defines the height in pixels of the preview image created when saving a product view
from Lifecycle Visualization.
Note

This preference is only used if Image Capture is selected for product views,
and if you clear Use Image Export Dialog.

VALID
VALUES
A positive integer from 1 to 1040.
Note

When you select a value of 0 for either width or height, both values are
calculated automatically.

DEFAULT
VALUES
400

DEFAULT
PROTECTION
SCOPE
Site preference.

Vis_PV_ImageCaptureResolution

DESCRIPTION
Defines the resolution of the preview image created when saving a product view from
Lifecycle Visualization.
VALID
VALUES
A positive integer from 1 (lowest resolution) to 1040 (highest resolution).
DEFAULT
VALUES
250

DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 23-17


Chapter
Chapter 23:23:Visualization
Visualization preferences
preferences

Vis_PV_ImageCaptureType

DESCRIPTION
Defines the format of the preview image created when saving a product view from
Lifecycle Visualization.
Note

This preference is only used if Image Capture is selected for product views,
and if you clear Use Image Export Dialog.

VALID
VALUES
BMP 24bit
BMP 8bit
BMP BW
JPEG 24bit
PNG 24bit
PNG 8bit
PNG BW
TIFF 24bit
TIFF 8bit
TIFF BW
DEFAULT
VALUES
JPEG 24bit

DEFAULT
PROTECTION
SCOPE
Site preference.

Vis_PV_ImageCaptureWidth

DESCRIPTION
Defines the width in pixels of the preview image created when saving a product view
from Lifecycle Visualization.
Note

This preference is only used if Image Capture is selected for product views,
and if you clear Use Image Export Dialog.

VALID
VALUES
A positive integer from 1 to 1040.
Note

When you select a value of 0 for either width or height, both values are
calculated automatically.

23-18 Preferences and Environment Variables Reference PLM00026 11.2


Visualization preferences

DEFAULT
VALUES
600

DEFAULT
PROTECTION
SCOPE
Site preference.

Vis_PV_ThumbnailHeight

DESCRIPTION
Defines the height of thumbnails created in Lifecycle Visualization.
VALID
VALUES
A positive integer from 1 to 1040.
DEFAULT
VALUES
80

DEFAULT
PROTECTION
SCOPE
Site preference.

Vis_PV_ThumbnailQuality

DESCRIPTION
Defines the resolution of a thumbnail created in Lifecycle Visualization.
VALID
VALUES
A positive integer from 1 (lowest) to 1040 (highest).
DEFAULT
VALUES
100

DEFAULT
PROTECTION
SCOPE
Site preference.

Vis_PV_ThumbnailWidth

DESCRIPTION
Defines the width in pixels of thumbnails created when saving a Product View from
Lifecycle Visualization.
VALID
VALUES
A positive integer from 1 to 1040.

PLM00026 11.2 Preferences and Environment Variables Reference 23-19


Chapter
Chapter 23:23:Visualization
Visualization preferences
preferences

DEFAULT
VALUES
80

DEFAULT
PROTECTION
SCOPE
Site preference.

Vis_PV_Play_Motion

DESCRIPTION
Indicates whether the motion file (if one exists) should be played automatically using
the current view when the product view is applied.
VALID
VALUES
True
False
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
User preference.
NOTE
This preference is only supported by embedded viewers.

Vis_PV_Show_Name_Dialog

DESCRIPTION
Indicates whether the application displays the name of a product view when it was
created. If set to false, the product view name is generated automatically.
VALID
VALUES
True
False
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
User preference.

23-20 Preferences and Environment Variables Reference PLM00026 11.2


Visualization preferences

Vis_PV_Geometry_Asset

DESCRIPTION
Indicates whether the application captures a 3D Geometry Asset when a product view
is created. This preference also specifies if an outline capture should be captured with
the 3D Geometry Asset.
VALID
VALUES
One of the following strings:
NoGeoAsset – a 3D Geometry Asset is not captured.
GeoAssetWithOutline – a 3D Geometry Asset is captured along with an Outline
Capture.
GeoAssetWithoutOutline – a 3D Geometry Asset is captured without an Outline
Capture.
DEFAULT
VALUES
NoGeoAsset
DEFAULT
PROTECTION
SCOPE
User preference.
NOTE
This preference replaces the previously existing Business Modeler IDE business
object constant named Fnd0VisPVGeoAsset. This change is made to allow greater
flexibility to the administrators in controlling how this information is set.

Vis_PV_HowTo_Configure_BOM

DESCRIPTION
Indicates how the BOM window is to be configured before a product view is
applied to it. This configuration is captured in the product view with the use of the
VisStructureContext object. This object records the Revision Rule, Variant Rule,
Assembly Arrangement and Occurrence Effectivity.
VALID
VALUES
One of the following strings:
• UseCurrent – the product view is applied without modifying the configuration of
the BOM window. The current configuration is used.

• UsePV – the BOM recipe that is recorded in the product view is used to configure
the BOM window.
DEFAULT
VALUES
UseCurrent
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 23-21


Chapter
Chapter 23:23:Visualization
Visualization preferences
preferences

Vis_PV_InvalidConfigWarnLevel

DESCRIPTION
Defines the intervention level when you capture a product view containing an active
view toggle state.
VALID
VALUES
Off – User is allowed to create/update PV without any intervention. Legacy behavior.
Warning – A warning message is displayed to the user alerting the presence of active
view toggles on the BOM window.
Prevent – User shall not be allowed to proceed with creation of the product view.
DEFAULT
VALUES
Warning
DEFAULT
PROTECTION
SCOPE
Site preference.

Vis_PV_BlockingViewToggles

DESCRIPTION
Defines the list of the view toggles states that can affect how product views are created.
For more details about blocking view toggles, see the
Vis_PV_InvalidConfigWarnLevel preference.
VALID
VALUES
Show Unconfigured Variants
Show Unconfigured Changes
Show Unconfigured Assigned Occurrences
Show Unconfigured By Occurrence Effectivity
Show Suppressed Occurrences
Show GCS Connection Points
DEFAULT
VALUES
Show Unconfigured Variants
Show Unconfigured Changes
Show Unconfigured Assigned Occurrences
Show Unconfigured By Occurrence Effectivity
DEFAULT
PROTECTION
SCOPE
Site preference.

23-22 Preferences and Environment Variables Reference PLM00026 11.2


Visualization preferences

VisMarkup_relation_primary

DESCRIPTION
Indicates the valid primary object type for the Visualization 3DMarkup relation. The
format is relation-name_relation_primary=valid primary object type. This preference
is applicable for the stand-alone viewers and the Lifecycle Viewer.

Warning

This preference is set automatically by the application and must not be modified.

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
A valid Teamcenter dataset type.
DEFAULT
VALUES
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

VisSession_relation_primary

DESCRIPTION
Indicates the valid primary object type for the Visualization Session relation. The
format is relation-name_relation_primary=valid primary object type. This preference
is applicable for the stand-alone viewers and the Lifecycle Viewer.

Warning

This preference is set automatically by the application and must not be modified.

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
A valid Teamcenter dataset type.
DEFAULT
VALUES
ItemRevision

PLM00026 11.2 Preferences and Environment Variables Reference 23-23


Chapter
Chapter 23:23:Visualization
Visualization preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

VisualReport_Use_Classification

DESCRIPTION
Specifies that you want to use the Classification application when you work with
visual reports.
VALID
VALUES
Accepts Boolean types of True/False.
DEFAULT
VALUE
False
DEFAULT
PROTECTION
SCOPE
User preference.

VMU_Datasets

DESCRIPTION
Determines the datasets that can be directly launched in Teamcenter lifecycle
visualization using the File→Open in VMU command in the rich client, or using the
View link from a dataset page in the thin client. To open files such as .tiff files and
PDF files, the dataset types used to manage these files must be appended to the
existing values for this preference. You must also add the custom reference names
within these custom dataset types to the VMU_FileSearchOrder preference.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter dataset type.
DEFAULT
VALUES
ClearanceDBConnection
ClearanceDBReport
ClearanceResults
ClearanceResultsFilter
DirectModel
DirectModel3DMarkup
DirectModelAnimation
DirectModelAssembly
DirectModelFlowChart
DirectModelIllustrationBook
DirectModelIllustrationSheet
DirectModelMarkup
DirectModelMotion
DirectModelSession
DrawingSheet

23-24 Preferences and Environment Variables Reference PLM00026 11.2


Visualization preferences

ECADDFX
Image
JtSimplification
Markup
Nastran
PADImage
PADReport
PCBFATF
PCBMarkup
SCHFATF
SnapShotViewData
Text
VisJackEnvironment
VisJackFigure
VisJackPosture
VisJackPsurf
VisMovieCapture
VisPublishGeometryAsset
VisPublishTechnicalIllustration
VisPublishTechnicalPortfolio
VisPublishVisioStencil
VisPublishVisioTemplate
VisQualityCluster
Vis_Session
VSAProcessDoc
VSAMeasurementDoc
Zone

DEFAULT
PROTECTION
SCOPE
Site preference.

VMU_FileSearchOrder

DESCRIPTION
Defines the order that reference names are used to search for files in ambiguous
conditions. Ambiguous conditions result from performing file operations on objects or
datasets. Add your custom dataset types to the VMU_Datasets preference to launch
them in Teamcenter lifecycle visualization. You must also add the custom reference
names within these custom dataset types to the VMU_FileSearchOrder preference.
VALID
VALUES
One or more strings as a values; each string must be a named reference that exists
within datasets that can be loaded in Teamcenter lifecycle visualization mockup.
DEFAULT
VALUES
Markup
Image
JTPART

PLM00026 11.2 Preferences and Environment Variables Reference 23-25


Chapter
Chapter 23:23:Visualization
Visualization preferences
preferences

JTSESSION
Package
ConfiguredAssembly
3DModel
Quickshade-Image
PLT
BMP
CAL
TIFF
Graphics-Interface
Sheet
Process
Measurement
FlowChart
Animation
Motion
IllustrationBook
IllustrationSheet
DEFAULT
PROTECTION
SCOPE
Site preference.

VMU_RelationSearchOrder

DESCRIPTION
Defines the ordered list of relations used for searching relations between visualization
datasets and items or item revisions. New relations must be added to the list.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter relation.
DEFAULT
VALUES
IMAN_Rendering
IMAN_specification
IMAN_MOTION
IMAN_3D_snap_shot
IMAN_manifestation
TC_Attaches
DEFAULT
PROTECTION
SCOPE
Site preference.

23-26 Preferences and Environment Variables Reference PLM00026 11.2


Chapter 24: Solution-specific preferences

Aerospace and Defense preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-1


UsingAssignFinishDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-1
Cm0GnReviewRevision_Cm0ActionItemRevision_default_relation . . . . . . . . . . . . . . . . . 24-1
ADSPart.SUMMARYRENDERING=ADSPartSummary . . . . . . . . . . . . . . . . . . . . . . . . . 24-1
ADSPart.SUMMARY_REGISTEREDTO=ADSPart . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-2
ADSDrawing.SUMMARYRENDERING=ADSDrawingSummary . . . . . . . . . . . . . . . . . . . 24-2
ADSDrawingSummary.SUMMARY_REGISTEREDTO=ADSDrawing . . . . . . . . . . . . . . . 24-3
ADSDesign.SUMMARYRENDERING=ADSDesignSummary . . . . . . . . . . . . . . . . . . . . . 24-3
ADSDesign.SUMMARY_REGISTEREDTO=ADSDesign . . . . . . . . . . . . . . . . . . . . . . . . 24-3
ADSDrawing_Revision_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-4
ADS_Lists_DrawingRevisions_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-4
ADS_Lists_PartRevisions_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-4
ADS_Lists_Parts_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-5
ADSTechDocument Revision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . 24-5
ADSTechDocument Revision_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-6
DefaultSubmittalType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-6
TC_customization_libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-7
TC_LAST_USED_PATTERNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-7

Materials Management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-7


CommercialPartRevision_Mat1MaterialRevision_default_relation . . . . . . . . . . . . . . . . . . 24-7
ItemRevision_Mat1MaterialRevision_ default_relation . . . . . . . . . . . . . . . . . . . . . . . . . 24-8
ManufacturerPart_Mat1MaterialRevision_default_relation . . . . . . . . . . . . . . . . . . . . . . . 24-8
ManufacturerPartRevision_Mat1MaterialRevision_default_relation . . . . . . . . . . . . . . . . . 24-8
Mat1MaterialRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-9
Mat1MaterialRevision_Mat1Substance_default_relation . . . . . . . . . . . . . . . . . . . . . . . . 24-9
Mat1MaterialRevision_PsuedoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-10
MaterialManagement_feature_installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-10
MATERIALMGMT_material_creator_roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-10
MATERIALMGMT_material_creator_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-11
Part_Revision_Mat1MaterialRevision_default_relation . . . . . . . . . . . . . . . . . . . . . . . . 24-11

Consumer Packaged Goods preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-12


TC_Interspec_URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-12

Teamcenter mechatronics process management preferences . . . . . . . . . . . . . . . . . . . . . . 24-12


Connected_ToRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-12
Implemented_ByRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-13
Realized_ByRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-13
APN_absolute_path_name_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-14
GDE_exclude_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-14
GDELink_default_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-15
GDEOcc_display_instance_num_for_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-15

PLM00026 11.2 Preferences and Environment Variables Reference


TC_releasable_logical_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-16
ESM_Software_Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-16
ESM_<Category>_Software_Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-17
ESM_Processor_Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-18
ESM_processor_direct_child_of_hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-18
ESM_Processor_is_gateway_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-19
ESM_Processor_linked_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-19
ESM_Processor_programmableInService_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-20
ESM_Processor_memoryType_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-20
ESM_Processor_byteOrder_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-20
ESM_Processor_architecture_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-21
ESM_HW_Compatibility_Report_TransferMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-21
ESM_SW_Compatibility_Report_TransferMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-22
ESM_HW_Compatibility_Report_HTML_StyleSheet_Dataset . . . . . . . . . . . . . . . . . . . 24-22
ESM_SW_Compatibility_Report_HTML_StyleSheet_Dataset . . . . . . . . . . . . . . . . . . . 24-22
ESM_HW_Compatibility_Report_Excel_StyleSheet_Dataset . . . . . . . . . . . . . . . . . . . . 24-23
ESM_SW_Compatibility_Report_Excel_StyleSheet_Dataset . . . . . . . . . . . . . . . . . . . . 24-23
ESM_Compatibility_Report_Excel_Template_Dataset . . . . . . . . . . . . . . . . . . . . . . . . 24-23
ParmDefIntRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-24
datasetParmDefIntRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-24
ParmDefDblRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-24
datasetParmDefDblRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-25
ParmDefStrRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-25
datasetParmDefStrRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-25
ParmDefBoolRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-26
datasetParmDefBoolRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-26
ParmDefDateRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-26
datasetParmDefDateRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-27
ParmDefHexRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-27
datasetParmDefHexRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-27
ParmDefSEDRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-28
datasetParmDefSEDRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-28
ParmDefBCDRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-28
datasetParmDefBCDRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-29
ParmGrpValRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-29
datasetParmGrpValRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-29
ParmDefBitDefRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-30
datasetParmDefBitDefRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-30
ParmGrpDef.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-30
datasetParmGrpDef.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-31
ParmDef.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-31
datasetParmDef.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-31
ParmGrpDefRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-32
datasetParmGrpDefRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-32
ProductVariant.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-32
datasetProductVariant.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-33
ProductVariant.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-33
datasetProductVariantCreate.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-33
ProductVariantIntent.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-34

Preferences and Environment Variables Reference PLM00026 11.2


datasetProductVariantIntent.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-34
ProductVariantIntent.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-34
datasetProductVariantIntentCreate.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . 24-35
Ccd0ColumnPreference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-35
CCDM_grp_rev_val . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-36
HRN_wire_length_data_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-36
HRN_associated_part_relation_secondary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-37
HRN_node_referenced_component_relation_secondary . . . . . . . . . . . . . . . . . . . . . . 24-37
HRN_part_data_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-38
HRN_fixing_assignment_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-39
SIG_asystem_source_rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-39
SIG_asystem_target_rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-40
SIG_asystem_transmitter_rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-40
SIG_pvariable_rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-41
SIG_redundant_rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-41
TC_relation_required_on_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-42
ParmGroup_Assigned_Hierarchy_Shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-42
Parameter_Assigned_Columns_Shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-43
Parameter_Available_Columns_Shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-43
OverrideContRev_Assigned_Columns_Shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-44
OverrideContRev_Available_Columns_Shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-44
MemoryLayoutRevOrBlock_Assigned_Columns_Shown . . . . . . . . . . . . . . . . . . . . . . . 24-44
MemoryRecord_Assigned_Columns_Shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-45
MemoryOverrideRecord_Assigned_Columns_Shown . . . . . . . . . . . . . . . . . . . . . . . . . 24-45
ConvOverrideRecord_Assigned_Columns_Shown . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-45
ConvOverrideRecord_Available_Columns_Shown . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-46

Vendor management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-46


BidPackageLineItem_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-46
BidPackageLineItem_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-46
BidPackageLineItem_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-47
BidPackageRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-47
BidPackageRevision_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-48
CommercialPart_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-48
CommercialPart_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-49
CompanyLocation_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-49
CompanyLocation_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-49
ContactInCompany_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-50
LocationInCompany_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-50
ManufacturerPart_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-51
ManufacturerPart_DefaultPSEProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-51
ManufacturerPart_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-52
ManufacturerPartRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-52
ManufacturerPart Revision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-53
ManufacturerPart Revision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . 24-53
ManufacturerPartRevSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . 24-53
ManufacturerPart.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-54
ManufacturerPart.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-54
ManufacturerPart.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-54
ManufacturerPartSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . 24-55

PLM00026 11.2 Preferences and Environment Variables Reference


ProvidedFrom_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-55
PseudoFolder.ContactInCompany_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . 24-56
PseudoFolder.lineitems_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-56
PseudoFolder.LocationInCompany_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . 24-56
PseudoFolder.ProvidedFrom_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-57
PseudoFolder.TC_part_quote_rel_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . 24-57
Quote_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-58
Restricted_Vendor_Part_Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-58
Restricted_Vendor_Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-58
TC_Distributor_info_form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-59
TC_Manufacturer_info_form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-59
TC_part_quote_rel_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-59
TC_Quality_Document_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-60
TC_Supplier_info_form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-60
TC_vendor_part_rel_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-61
Vendor_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-61
Vendor_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-62
VendorRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-62
VendorRevision_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-63
VMRepresents_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-63
VMS_Maintain_Vendor_History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-64
VMS_vendor_part_selection_rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-64

MRO core preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-65


HierarchicalWSO_HierarchicalWSO_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . 24-65
Item_CharacteristicDefinition_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-65
ItemRevision_CharacteristicDefinition_default_relation . . . . . . . . . . . . . . . . . . . . . . . . 24-65
LogBook_PhysicalPart_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-66
LogBook_WorkspaceObject_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-66
Lot.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-66
Lot_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-67
MRONeutralColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-67
MRONeutralShownColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-68
ManufacturingIdCharsForPhysicalPartIdPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-68
MROAlternateColorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-69
MRODeviatedColorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-69
MROExtraToDesignColorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-69
MROMissingColorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-70
MROSubstituteColorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-70
PartLogisticsForm.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-70
PartNumberCharsForPhysicalPartIdPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-71
PhysicalContext_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-71
PhysicalElement_Company_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-72
PhysicalPart_Company_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-72
PhysicalPart_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-72
PhysicalPartRelationsToExport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-73
PhysicalPart.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-73
PhysicalPartRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-74
PhysicalPartRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-74
PhysicalRealization_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-74

Preferences and Environment Variables Reference PLM00026 11.2


SerialNumberCharsForPhysicalPartIdPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-75
SerialNumberGenerator_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-75
SerialNumberGenerator.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-76
TransactionElement_Dataset_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-76
UtilizationViewColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-76

As-Built Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-77


AsBuiltManagerColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-77
AsBuiltManagerShownColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-78
DefaultAsBuiltCompareProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-78
AdditionalAsBuiltCompareProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-79
DefaultAsBuiltAccCheckProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-79
AdditionalAsBuiltAccCheckProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-79

Service Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-80


As-Maintained preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-80
AdditionalAsMaintainedAccCheckProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-80
AdditionalAsMaintainedCompareProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-80
DefaultAsMaintainedAccCheckProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-80
DefaultAsMaintainedCompareProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-81
Disposition_Propagate_To_Child . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-81
MroConfigRuleName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-81
MRODefaultLocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-82
PhysicalLocation_CompanyLocation_default_relation . . . . . . . . . . . . . . . . . . . . . . 24-82
PhysicalLocationContainsColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-82
PhysicalLocation_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-83
ServiceManagerAssetGroupColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . 24-83
ServiceManagerAssetGroupColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . 24-84
ServiceManagerColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-84
ServiceManagerShownColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-85
ServiceManagerPhysicalLocationColumnsShownPref . . . . . . . . . . . . . . . . . . . . . 24-85
ServiceManagerPhysicalLocationColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . 24-86
Service event management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-86
ActivityCost.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-86
ActivityCost.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-86
ActivityEntryValue.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . 24-87
ActivityEntryValue.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-87
ActivityEntryValue.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-87
FaultCode.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-88
FaultCode.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-88
FaultCode.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-88
MRODefaultLogBook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-89
PartMovement_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-89
PartMovementDefaultRemoveLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-89
PartMovement.ENABLE_PROPERTIES_EDIT . . . . . . . . . . . . . . . . . . . . . . . . . . 24-89
PartMovement.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-90
PartMovement.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-90
PartMovement.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-90
ServiceAction.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-91
ServiceAction.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-91

PLM00026 11.2 Preferences and Environment Variables Reference


ServiceDiscrepancy_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-91
ServiceDiscrepancy.ENABLE_PROPERTIES_EDIT . . . . . . . . . . . . . . . . . . . . . . . 24-92
ServiceDiscrepancy_FaultCode_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . 24-92
ServiceDiscrepancy.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . 24-92
ServiceDiscrepancy.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-93
ServiceDiscrepancy_ServiceEvent_default_relation . . . . . . . . . . . . . . . . . . . . . . . 24-93
ServiceDiscrepancy_ServiceGroup_default_relation . . . . . . . . . . . . . . . . . . . . . . . 24-93
ServiceDiscrepancy.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-93
ServiceEvent_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-94
ServiceEvent.ENABLE_PROPERTIES_EDIT . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-94
ServiceEvent.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-94
ServiceEvent.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-95
ServiceEvent.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-95
ServiceGroup.ENABLE_PROPERTIES_EDIT . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-95
ServiceGroup.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-96
ServiceGroup.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-96
ServiceGroup.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-96
TransactionElement.COLUMNS_SHOW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-97
TransactionElement.COLUMNS_WIDTH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-97
TransactionElement_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-97
TransactionElement_Document_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . 24-98
TransactionElement_DocumentRevision_default_relation . . . . . . . . . . . . . . . . . . . 24-98
TransactionElement_PhysicalElement_default_relation . . . . . . . . . . . . . . . . . . . . . 24-98
TransactionElement_PhysicalElementRevision_default_relation . . . . . . . . . . . . . . . 24-99

Service Request Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-99


ActivityCost.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-99
ActivityCost_SRP0RqstActivityRevision.MROCREATERENDERING . . . . . . . . . . . . . . 24-99
ActivityCost_SRP0ServiceOffering.MROCREATERENDERING . . . . . . . . . . . . . . . . . 24-100
ActivityCost_SRP0ServiceRequest.MROCREATERENDERING . . . . . . . . . . . . . . . . 24-100
CM_SRP0DgSrvRequestRevision_displayed_pseudofolders . . . . . . . . . . . . . . . . . . . 24-100
CM_SRP0PrSrvRequestRevision_displayed_pseudofolders . . . . . . . . . . . . . . . . . . . 24-101
CM_SRP0RqstActivityRevision_displayed_pseudofolders . . . . . . . . . . . . . . . . . . . . . 24-101
CompanyContact.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-102
CompanyLocation.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-102
SR_CHANGE_HOME_SITE_PREFERENCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-102
SRP0DgSrvRequest.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-103
SRP0DgSrvRequestRevision.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . 24-103
SRP0DgSrvRequestRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-103
SRP0DgSrvRequestRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . 24-104
SRP0DgSrvRequestRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . 24-104
SRP0PrSrvRequest.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-104
SRP0PrSrvRequestRevision.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . 24-105
SRP0PrSrvRequestRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-105
SRP0PrSrvRequestRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . 24-105
SRP0PrSrvRequestRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . 24-105
SRP0RequalifyRqstActivityRevision.MROCREATERENDERING . . . . . . . . . . . . . . . . 24-106
SRP0RqstActivity.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-106
SRP0RqstActivityRevision.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . . 24-107
SRP0RqstActivityRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-107

Preferences and Environment Variables Reference PLM00026 11.2


SRP0RqstActivityRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . 24-107
SRP0RqstActivityRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . 24-107
SRP0RqstActivityRevision_ServiceDiscrepancy_default_relation . . . . . . . . . . . . . . . . 24-108
SRP0ServiceCatalog.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . 24-108
SRP0ServiceCatalog.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-108
SRP0ServiceCatalog.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-109
SRP0ServiceCatalog_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-109
SRP0ServiceCatalog_HWSOStructure_default_relation . . . . . . . . . . . . . . . . . . . . . . 24-109
SRP0ServiceCatalog_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-110
SRP0ServiceCatalog_SRP0ProductCatalog_default_relation . . . . . . . . . . . . . . . . . . 24-110
SRP0ServiceDiscrepancy.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . 24-110
SRP0ServiceOffering.MROCREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-111
SRP0ServiceOffering.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-111
SRP0ServiceOffering.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-111
SRP0ServiceOffering_ActivityCost_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . 24-112
SRP0ServiceOffering_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-112
SRP0ServiceOffering_HWSOStructure_default_relation . . . . . . . . . . . . . . . . . . . . . . 24-112
SRP0ServiceOffering_SRP0ServiceCatalog_default_relation . . . . . . . . . . . . . . . . . . 24-113
SRP0ServiceOfferingTable_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-113
SRP0StatusViewColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-113

Service Scheduler preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-114


PART_MOVEMENT_VALIDATION_ERROR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-114
SAS0_default_revision_rule_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-114
SF_CANCEL_MA_EXTENSION_ROLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-115
SF_DEFAULT_WF_TEMPLATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-115
SSF0MaintActTableColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-115
SSF0MaintActTableNumberMAsToDisplayPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-116
ServiceDiscrepancy_SSS0JobActivityRevision_default_relation . . . . . . . . . . . . . . . . . 24-116

Substance Compliance preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-117


CMD_Response-Record_Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-117
CommercialPart Revision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . 24-117
CommercialPart Revision_Mat1MaterialRevision_default_relation . . . . . . . . . . . . . . . 24-117
CommercialPart Revision_Scp0SubstanceCmplResult_default_relation . . . . . . . . . . . 24-118
IMDS_bomline_quantity_attrib_maps_to . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-118
IMDS_cancel_msd_request_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-118
IMDS_cancel_subs_declaration_request_workflow . . . . . . . . . . . . . . . . . . . . . . . . . 24-119
IMDS_CC_file_type_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-119
IMDS_CMS_file_type_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-119
IMDS_daily_file_download_attempts_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-120
IMDS_download_client_path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-120
IMDS_download_files_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-120
IMDS_download_utility_path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-121
IMDS_file_done_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-121
IMDS_file_error_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-121
IMDS_file_module_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-122
IMDS_file_process_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-122
IMDS_import_transfer_optionset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-123
IMDS_MCAll_file_type_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-123

PLM00026 11.2 Preferences and Environment Variables Reference


IMDS_MDS_Create_Permitted_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-123
IMDS_MDS_Create_Permitted_roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-124
IMDS_MDS_Internal_Release_Permitted_groups . . . . . . . . . . . . . . . . . . . . . . . . . . 24-124
IMDS_MDS_Internal_Release_Permitted_roles . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-124
IMDS_mds_part_send_unique_attrib_maps_to . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-125
IMDS_MDS_Permitted_Actions_LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-125
IMDS_MDS_Propose_Permitted_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-125
IMDS_MDS_Propose_Permitted_roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-126
IMDS_MDS_Publish_Permitted_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-126
IMDS_MDS_Publish_Permitted_roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-126
IMDS_MDS_Review_Upload_XSL_Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-127
IMDS_MDS_Send_Permitted_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-127
IMDS_MDS_Send_Permitted_roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-127
IMDS_Module_Create_Permitted_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-128
IMDS_Module_Create_Permitted_roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-128
IMDS_Module_Permitted_Actions_LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-128
IMDS_Module_Publish_Permitted_roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-129
IMDS_Module_Release_Internally_Permitted_groups . . . . . . . . . . . . . . . . . . . . . . . 24-129
IMDS_Module_Release_Internally_Permitted_roles . . . . . . . . . . . . . . . . . . . . . . . . . 24-129
IMDS_msd_request_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-130
IMDS_NIAll_file_type_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-130
IMDS_Own_Company_IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-130
IMDS_Own_Material_MDS_attrib_maps_to . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-131
IMDS_Own_MDS_part_object_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-131
IMDS_Own_MDS_part_unique_attrib_maps_to . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-131
IMDS_parameter_file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-132
IMDS_ppm_classification_IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-132
IMDS_processing_allowed_file_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-132
IMDS_Processing_Summary_Mail_Notifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-133
IMDS_Received_MDS_part_object_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-134
IMDS_Received_MDS_part_unique_attrib_maps_to . . . . . . . . . . . . . . . . . . . . . . . . 24-134
IMDS_result_email_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-134
IMDS_Result_File_Download_Client_Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-135
IMDS_Result_File_Download_Directory_Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-135
IMDS_Result_File_Extract_Directory_Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-135
IMDS_result_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-136
IMDS_SAAll_file_type_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-136
IMDS_SARAll_file_type_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-136
IMDS_SB_file_type_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-137
IMDS_Send_Mail_Done . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-137
IMDS_set_GADSL_flag_during_validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-137
IMDS_SGAll_file_type_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-138
IMDS_split_files_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-138
IMDS_split_utility_path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-139
IMDS_SRAll_file_type_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-139
IMDS_transform_dat_to_xml_utility_path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-139
IMDS_upload_client_path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-140
IMDS_upload_files_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-140
IMDS_upload_xsl_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-140

Preferences and Environment Variables Reference PLM00026 11.2


IMDS_use_calculated_weight_as_measured_weight . . . . . . . . . . . . . . . . . . . . . . . . 24-141
IMDS_valid_download_file_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-141
IMDS_validate_before_send_to_IMDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-141
IMDS_validate_object_and_upload_to_imds_workflow . . . . . . . . . . . . . . . . . . . . . . . 24-142
IMDS_Upload_Vendor_Part_Selection_Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-142
IMDS_Uploadable_Vendor_Part_Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-143
IMDS_VP_Use_Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-143
Item.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-143
ItemRevision_Scp0SubstanceCmplResult_default_relation . . . . . . . . . . . . . . . . . . . . 24-144
ItemRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-144
ManufacturerPart_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-145
ManufacturerPart_Mat1MaterialRevision_default_relation . . . . . . . . . . . . . . . . . . . . . 24-145
ManufacturerPart_Scp0AbstractDecl_default_relation . . . . . . . . . . . . . . . . . . . . . . . 24-146
ManufacturerPart_Scp0SubstanceCategory_default_relation . . . . . . . . . . . . . . . . . . 24-146
ManufacturerPart_Scp0SupplierExemption_default_relation . . . . . . . . . . . . . . . . . . . 24-146
ManufacturerPart Revision_Mat1MaterialRevision_default_relation . . . . . . . . . . . . . . 24-147
ManufacturerPart Revision_Scp0SubstanceCmplResult_default_relation . . . . . . . . . . 24-147
ManufacturerPart_Scp0SubstanceCmplResult_default_relation . . . . . . . . . . . . . . . . . 24-147
Mat1Material.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-148
MATERIALMGMT_material_creator_roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-148
MSD_Response_Record_Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-148
Part Revision_Scp0SubstanceCmplResult_default_relation . . . . . . . . . . . . . . . . . . . 24-149
Scp0ApplyExemptForm.FORMJAVARENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . 24-149
Scp0AprvSubsDeclForm.FORMJAVARENDERING . . . . . . . . . . . . . . . . . . . . . . . . . 24-149
Scp0ApplyExemptForm.JAVARENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-150
Scp0AprvSubsDeclForm.JAVARENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-150
Scp0CancelMSDReqForm.FORMJAVARENDERING . . . . . . . . . . . . . . . . . . . . . . . . 24-150
Scp0CancelMSDReqForm.JAVARENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-151
Scp0Exemption.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-151
Scp0ExemptionSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . 24-151
Scp0ItemRevisionSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . 24-152
Scp0ManufacturerPartSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . 24-152
Scp0Mat1MaterialSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . 24-152
Scp0Regulation.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-153
Scp0RegulationSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . 24-153
Scp0ReqSubsDeclForm.JAVARENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-153
Scp0ReqSubsDeclForm.FORMJAVARENDERING . . . . . . . . . . . . . . . . . . . . . . . . . 24-154
Scp0Smelter.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-154
Scp0SmelterSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . 24-154
Scp0SndToCmplChkForm.FORMJAVARENDERING . . . . . . . . . . . . . . . . . . . . . . . . 24-155
Scp0SndToCmplChkForm.JAVARENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-155
Scp0SubstanceCmplResult_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . 24-155
Scp0SubstanceCmplResult_Scp0Exemption_default_relation . . . . . . . . . . . . . . . . . . 24-156
Scp0SubstanceCmplResult.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . 24-156
Scp0SubstanceCmplResultSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . 24-156
Scp0VendorSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . 24-157
SUBSCMPL_additional_notifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-157
SUBSCMPL_apply_exemption_workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-157
SUBSCMPL_brand_image_dataset_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-158

PLM00026 11.2 Preferences and Environment Variables Reference


SUBSCMP_cmd_allow_uncertified_smelters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-158
SUBSCMPL_cmd_always_send_blank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-158
SUBSCMPL_cmd_auto_request_on_msd_approve . . . . . . . . . . . . . . . . . . . . . . . . . 24-159
SUBSCMPL_cmd_default_excel_file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-159
SUBSCMPL_cmd_default_xml_file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-159
SUBSCMPL_cmd_smelter_import_attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-160
SUBSCMPL_cmd_smelter_unique_attrib_maps_to_xml . . . . . . . . . . . . . . . . . . . . . . 24-160
SUBSCMPL_compliance_check_url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-161
SUBSCMPL_compliance_server_host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-161
SUBSCMPL_compliance_server_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-162
SUBSCMPL_confidential_material_accessor_groups . . . . . . . . . . . . . . . . . . . . . . . . 24-162
SUBSCMPL_confidential_material_accessor_roles . . . . . . . . . . . . . . . . . . . . . . . . . 24-162
SUBSCMPL_configured_export_optionset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-162
SUBSCMPL_configured_export_transfermode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-163
SUBSCMPL_decl_skipped_extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-163
SUBSCMPL_invalid_statuses_for_apply_exemption . . . . . . . . . . . . . . . . . . . . . . . . 24-163
SUBSCMPL_mail_approval_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-164
SUBSCMPL_msd_always_send_blank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-164
SUBSCMPL_msd_create_new_materials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-165
SUBSCMPL_msd_create_new_substances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-165
SUBSCMPL_msd_default_pdf_file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-166
SUBSCMPL_msd_default_xml_file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-166
SUBSCMPL_msd_done_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-166
SUBSCMPL_msd_error_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-167
SUBSCMPL_msd_exchange_CO_user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-167
SUBSCMPL_MSD_expiry_duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-167
SUBSCMPL_msd_file_naming_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-168
SUBSCMPL_msd_import_notifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-168
SUBSCMPL_msd_include_pdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-168
SUBSCMPL_msd_incomplete_composition_limit . . . . . . . . . . . . . . . . . . . . . . . . . . 24-169
SUBSCMPL_msd_part_import_attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-169
SUBSCMPL_msd_part_unique_attrib_maps_to . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-170
SUBSCMPL_msd_partial_disclosure_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-170
SUBSCMPL_msd_processing_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-170
SUBSCMPL_msd_request_expiry_duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-171
SUBSCMPL_msd_supplier_part_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-171
SUBSCMPL_MSD_to_tcxml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-171
SUBSCMPL_msd_use_unknown_material . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-172
SUBSCMPL_msd_use_unknown_substance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-172
SUBSCMPL_msd_vendor_unique_attrib_maps_to . . . . . . . . . . . . . . . . . . . . . . . . . 24-172
SUBSCMPL_notify_suppliers_validation_verdict . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-173
SUBSCMPL_part_material_mass_tolerance_lower . . . . . . . . . . . . . . . . . . . . . . . . . 24-173
SUBSCMPL_part_material_mass_tolerance_upper . . . . . . . . . . . . . . . . . . . . . . . . . 24-173
SUBSCMPL_provide_substance_name_in_failure_reason . . . . . . . . . . . . . . . . . . . . 24-174
SUBSCMPL_provide_textual_failure_reason . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-174
SUBSCMPL_regulation_creator_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-175
SUBSCMPL_regulation_creator_roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-175
SUBSCMPL_regulation_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-175
SUBSCMPL_report_individual_validation_results . . . . . . . . . . . . . . . . . . . . . . . . . . 24-176

Preferences and Environment Variables Reference PLM00026 11.2


SUBSCMPL_report_session_validation_results . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-176
SUBSCMPL_request_cmd_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-176
SUBSCMPL_request_msd_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-177
SUBSCMPL_request_msd_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-177
SUBSCMPL_request_subs_declaration_workflow . . . . . . . . . . . . . . . . . . . . . . . . . . 24-177
SUBSCMPL_review_cmd_declaration_workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-178
SUBSCMPL_review_subs_declaration_workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-178
SUBSCMPL_send_materials_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-178
SUBSCMPL_send_msd_ind_import_log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-179
SUBSCMPL_send_msd_session_import_log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-179
SUBSCMPL_statuses_for_failed_item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-179
SUBSCMPL_subs_declaration_auto_approve . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-180
SUBSCMPL_substance_compliance_check_workflow . . . . . . . . . . . . . . . . . . . . . . . 24-180
SUBSCMPL_substance_composition_tolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-181
SUBSCMPL_substance_name_display_length . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-181
SUBSCMPL_unconfigured_export_optionset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-181
SUBSCMPL_unconfigured_export_transfermode . . . . . . . . . . . . . . . . . . . . . . . . . . 24-182
SUBSCMPL_unknown_material_ext_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-182
SUBSCMPL_unknown_material_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-182
SUBSCMPL_unknown_substance_cas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-183
SUBSCMPL_unknown_substance_ext_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-183
SUBSCMPL_unknown_substance_tc_unique_id . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-183
SUBSCMPL_unknown_substance_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-184
SUBSCMPL_valid_statuses_for_apply_exemption . . . . . . . . . . . . . . . . . . . . . . . . . 24-184
SUBSCMPL_valid_statuses_with_exemptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-184
SubstanceCompliance_feature_installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-185

Specification Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-186


CPGFormulaMaterRevision_Cpm0SensoryEvaluation_default_relation . . . . . . . . . . . . 24-186
CPGFormulaMaterRevision_Cpm0Nutrient_default_relation . . . . . . . . . . . . . . . . . . . 24-186
CPGFormulaMaterRevision_Cpm0Microbiological_default_relation . . . . . . . . . . . . . . 24-186
CPGFormulaMaterRevision_Cpm0ChemPhysAnal_default_relation . . . . . . . . . . . . . 24-187
CPGFormulaMaterRevision_Cpm0Certification_default_relation . . . . . . . . . . . . . . . . 24-187
CPGFormulaMaterRevision_Cpm1Contaminant_default_relation . . . . . . . . . . . . . . . 24-187
CPGFormulaMaterRevision_Cpm0Additive_default_relation . . . . . . . . . . . . . . . . . . . 24-188
CPGFormulaMaterRevision_Cpm0FoodAllergen_default_relation . . . . . . . . . . . . . . . 24-188
CPGFormulaMaterRevision_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-188
CPGFormulaMaterRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . 24-189
CPSpecificationRevision_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24-190
CPSpecificationRevision_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . 24-190

PLM00026 11.2 Preferences and Environment Variables Reference


Chapter 24: Solution-specific preferences

Aerospace and Defense preferences

UsingAssignFinishDialog

DESCRIPTION
Opens the Open by Name dialog box or the Classification Search dialog box when
you right-click an item and choose the Assign Finish menu command.
VALID
VALUES
TRUE Opens the Open by Name dialog box that enables you to
search for finish or finish groups.

FALSE Opens the Classification Search dialog that enables you to do


a classification search for finish or finish groups.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

Cm0GnReviewRevision_Cm0ActionItemRevision_default_relation

DESCRIPTION
Specifies the default relation between the Cm0GnReviewRevision object and
Cm0ActionItemRevision object.
VALID
VALUES
Cm0RaisesActionItems
DEFAULT
VALUES
Cm0RaisesActionItems
DEFAULT
PROTECTION
SCOPE
Site preference.

ADSPart.SUMMARYRENDERING=ADSPartSummary

DESCRIPTION
Registers the ADSPartSummary style sheet for the ADSPart business object.

PLM00026 11.2 Preferences and Environment Variables Reference 24-1


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

The summary style sheet is used to render the properties in the Summary tab in My
Teamcenter.
VALID
VALUES
ADSPartSummary
DEFAULT
VALUES
ADSPartSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

ADSPart.SUMMARY_REGISTEREDTO=ADSPart

DESCRIPTION
Indicates that the ADSPartSummary style sheet is registered as a summary type style
sheet to the ADSPart business object.
VALID
VALUES
ADSPart
DEFAULT
VALUES
ADSPart
DEFAULT
PROTECTION
SCOPE
Site preference.

ADSDrawing.SUMMARYRENDERING=ADSDrawingSummary

DESCRIPTION
Registers the ADSDrawingSummary style sheet for the ADSDrawing business
object.
The summary style sheet is used to render the properties in the Summary tab in My
Teamcenter.
VALID
VALUES
ADSDrawingSummary
DEFAULT
VALUES
ADSDrawingSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

24-2 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

ADSDrawingSummary.SUMMARY_REGISTEREDTO=ADSDrawing

DESCRIPTION
Indicates that the ADSDrawingSummary style sheet is registered as a summary type
style sheet to the ADSDrawing business object.
VALID
VALUES
ADSDrawing
DEFAULT
VALUES
ADSDrawing
DEFAULT
PROTECTION
SCOPE
Site preference.

ADSDesign.SUMMARYRENDERING=ADSDesignSummary

DESCRIPTION
Registers the ADSDesignSummary style sheet for the ADSDesign business object.
The summary style sheet is used to render the properties in the Summary tab in My
Teamcenter.
VALID
VALUES
ADSDesignSummary
DEFAULT
VALUES
ADSDesignSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

ADSDesign.SUMMARY_REGISTEREDTO=ADSDesign

DESCRIPTION
Indicates that the ADSDesignSummary style sheet is registered as a summary type
style sheet to the ADSDesign business object.
VALID
VALUES
ADSDesign
DEFAULT
VALUES
ADSDesign
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-3


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

ADSDrawing_Revision_PseudoFolder

DESCRIPTION
Determines which properties are displayed as pseudo folders within an ADSDrawing
Revision object.
VALID
VALUES
Accepts one or more strings as values, each string must be a Teamcenter property.
DEFAULT
VALUES
ADS_Lists_DrawingRevisions
DEFAULT
PROTECTION
SCOPE
Site preference.

ADS_Lists_DrawingRevisions_relation_primary

DESCRIPTION
Determines the valid primary object types for the
ADS_Lists_DrawingRevisions_relation_primary relation. All ADS drawings created
for a given ADSTechDocument are associated to that ADSTechDocument Revision
with the ADS_Lists_DrawingRevisions_relation_primary 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 one or more strings as values. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
ADSTechDocument Revision
DEFAULT
PROTECTION
SCOPE
Site preference.

ADS_Lists_PartRevisions_relation_primary

DESCRIPTION
Determines the valid primary object types for the ADS_Lists_PartRevisions relation.
All ADS part and ADS design revisions created on a given ADSTechDocument are
associated to that ADSTechDocument Revision with the ADS_Lists_PartRevisions
relation.

24-4 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific 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 one or more strings as values. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
ADSTechDocument Revision
DEFAULT
PROTECTION
SCOPE
Site preference.

ADS_Lists_Parts_relation_primary

DESCRIPTION
Determines the valid primary object types for the ADS_Lists_Parts_relation_primary
relation. All ADS part and ADS design revisions created on a source document
other than an assembly are termed foreign components. When a foreign component
is added to an assembly, the ADS_Lists_Parts relation is created between the
source document revision of the assembly, and the item corresponding to the foreign
component.
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 values. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
ADSTechDocument Revision
DEFAULT
PROTECTION
SCOPE
Site preference.

ADSTechDocument Revision_DefaultChildProperties

DESCRIPTION
Determines which properties can be used as children of the selected
ADSTechDocument Revision type.

PLM00026 11.2 Preferences and Environment Variables Reference 24-5


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
property.
DEFAULT
VALUES
ADS_Lists_PartRevisions
ADS_Lists_DrawingRevisions
ADS_Lists_Parts
DEFAULT
PROTECTION
SCOPE
Site preference.

ADSTechDocument Revision_PseudoFolder

DESCRIPTION
Determines which properties are displayed as pseudo folders within a
ADSTechDocument Revision object.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
property.
DEFAULT
VALUES
ADS_Lists_PartRevisions
ADS_Lists_DrawingRevisions
ADS_Lists_Parts
DEFAULT
PROTECTION
SCOPE
Site preference.

DefaultSubmittalType

DESCRIPTION
Sets the default submittal type in the Submittal Type list in the Generate Submittal
Delivery Schedule dialog box.
For more information, see Aerospace and Defense Solution.
Note

This preference is not created by Teamcenter. If you require this functionality,


you must create the preference.

VALID
VALUES
The display name of the custom submittal to be used as the default selection.
DEFAULT
VALUES
None.

24-6 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Group preference.

TC_customization_libraries

DESCRIPTION
Initializes the vendor management and product structure and parts list (PSPL)
customization libraries that assist in the storage of executable codes.
VALID
VALUES
Accepts one or more strings as values, each string must be a valid library name.
DEFAULT
VALUES
libvm
libpspl
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_LAST_USED_PATTERNS

DESCRIPTION
Stores the last selected naming pattern for a given business object property.
VALID
VALUES
Accepts one or more strings as values, each string must be a valid naming pattern.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

Materials Management preferences

CommercialPartRevision_Mat1MaterialRevision_default_relation

DESCRIPTION
Specifies the default paste relation for the commercial part object with a material
revision.
VALID
VALUES
Mat1UsesMaterial

PLM00026 11.2 Preferences and Environment Variables Reference 24-7


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
Mat1UsesMaterial
DEFAULT
PROTECTION
SCOPE
Site preference.

ItemRevision_Mat1MaterialRevision_ default_relation

DESCRIPTION
Defines the default paste relation of the item revision object with a material revision.
VALID
VALUES
Mat1UsesMaterial
DEFAULT
VALUES
Mat1UsesMaterial
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPart_Mat1MaterialRevision_default_relation

DESCRIPTION
Specifies the default paste relation for a manufacturer part object with a material
revision.
VALID
VALUES
Mat1UsesMaterial
DEFAULT
VALUES
Mat1UsesMaterial
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPartRevision_Mat1MaterialRevision_default_relation

DESCRIPTION
Specifies the default paste relation for manufacturer part revision object with a material
revision.
VALID
VALUES
Mat1UsesMaterial
DEFAULT
VALUES
Mat1UsesMaterial

24-8 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

Mat1MaterialRevision_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of the material revision
node.
VALID
VALUES
IMAN_master_form_rev
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEView
IMAN_vi_sos
IMAN_external_object_link
IMAN_specification
TC_WorkContext_Relation
TC_AuditLog
TC_Is_Represented_By
release_status_list
Mat1UsesSubstance

DEFAULT
VALUES
IMAN_master_form_rev
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEView
IMAN_vi_sos
IMAN_external_object_link
IMAN_specification
TC_WorkContext_Relation
TC_AuditLog
TC_Is_Represented_By
release_status_list
Mat1UsesSubstance
DEFAULT
PROTECTION
SCOPE
User preference.

Mat1MaterialRevision_Mat1Substance_default_relation

DESCRIPTION
Defines the default paste relation of the material revision object with substance.

PLM00026 11.2 Preferences and Environment Variables Reference 24-9


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Mat1UsesSubstance
DEFAULT
VALUES
Mat1UsesSubstance
DEFAULT
PROTECTION
SCOPE
Site preference.

Mat1MaterialRevision_PsuedoFolder

DESCRIPTION
Specifies the list of properties that can be displayed as a pseudo folder under a node
for the material revision object.
VALID
VALUES
Mat1UsesMaterial
DEFAULT
VALUES
Mat1UsesMaterial
DEFAULT
PROTECTION
SCOPE
Site preference.

MaterialManagement_feature_installed

DESCRIPTION
Specifies whether the Materials Management solution is installed. Do not modify
this preference manually.
VALID
VALUES
true
false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
System preference.

MATERIALMGMT_material_creator_roles

DESCRIPTION
Specifies the roles that are allowed to create materials.

24-10 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
Any valid internal role name.
DEFAULT
VALUES
IMAN_master_form
Materials Analyst
Compliance Officer
DEFAULT
PROTECTION
SCOPE
Site preference.

MATERIALMGMT_material_creator_groups

DESCRIPTION
Specifies the groups that are allowed to create materials. Valid values are the internal
names of the groups.
VALID
VALUES
Any group allowed to create the material.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Part_Revision_Mat1MaterialRevision_default_relation

DESCRIPTION
Defines the default paste relation of the part revision object with a material revision.
VALID
VALUES
Mat1UsesMaterial
DEFAULT
VALUES
Mat1UsesMaterial
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-11


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

Consumer Packaged Goods preferences


TC_Interspec_URL

DESCRIPTION
Stores the base URL of the Interspec thin client. It is used to launch the Interspec thin
client from Teamcenter.
VALID
VALUES
Accepts one string as a value and the string must be a valid URL. For example:
http://Hostname/SpecificationModule.version/Site/Login/Login.aspx

Contact the Interspec administrator for the exact URL value.


DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
All.

Teamcenter mechatronics process management preferences


Connected_ToRules

DESCRIPTION
Defines any constraints on the valid primary/secondary object combination allowed for
the Connected_To Generic Relationship Management (GRM) relation. GRM rules
contain a primary type, a relation type, and multiple secondary types. If no constraint is
defined for a given primary object or its superTypes, then there is no constraint on
the combination of secondary objects allowed for the Connected_To relationship
with the given primary object.
For more information about GRM rule construction and management, see Business
Modeler IDE.
VALID
VALUES
Accepts multiple strings as values.
Constraints are defined in the following format:
primaryObjectType:secondaryObjectType1,secondaryObjectType2
primaryObjectType is any type or subtype of PSConnection or GDELink
class/subclass, and secondaryObjectType is any valid ImanType type.
DEFAULT
VALUES
Connection:Network_Port,Connection_Terminal
TC_Link:Network_Port,Connection_Terminal
WeldPoint:Item
DatumPoint:Item

24-12 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

ProductRelation:ProductInterface
ArcWeld:Item
DEFAULT
PROTECTION
SCOPE
Site preference.

Implemented_ByRules

DESCRIPTION
Defines any constraints on the valid primary/secondary object combination allowed for
the Implemented_By Generic Relationship Management (GRM) relation. GRM rules
contain a primary type, a relation type, and multiple secondary types. If no constraint
is defined for a given primary object or its superTypes, there is no constraint on the
combination of secondary objects allowed for the Implemented_By relationship with
the given primary object.

For more information about GRM rule construction and management, see Business
Modeler IDE.
VALID
VALUES
Accepts multiple strings as values.

Constraints are defined in the following format:

primaryObjectType:secondaryObjectType1,secondaryObjectType2
The object types are any valid ImanType type.
DEFAULT
VALUES
Connection_Terminal:Item
Connection:Item

DEFAULT
PROTECTION
SCOPE
Site preference.

Realized_ByRules

DESCRIPTION
Defines any constraints on the valid primary/secondary object combination allowed
for the Realized_By Generic Relationship Management (GRM) relation. GRM rules
contain a primary type, a relation type, and multiple secondary types. If no constraint
is defined for a given primary object or its superTypes, there is no constraint on the
combination of secondary objects allowed for the Realized_By relationship with the
given primary object.

For more information about GRM rule construction and management, see Business
Modeler IDE.

PLM00026 11.2 Preferences and Environment Variables Reference 24-13


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Accepts multiple strings as values.
Constraints are defined in the following format:
primaryObjectType:secondaryObjectType1,secondaryObjectType2
The object types are any valid ImanType type.
DEFAULT
VALUES
Interfaces:Interfaces
DEFAULT
PROTECTION
SCOPE
Site preference.

APN_absolute_path_name_separator

DESCRIPTION
Defines the separator used between the parentNodeName and the childNodeName
while displaying the absolute path name for a given AppearancePathNode.
VALID
VALUES
Accepts a single string as a value. The following special characters are recommended
values:
.
,
;
/
#

DEFAULT
VALUES
->
DEFAULT
PROTECTION
SCOPE
Site preference.

GDE_exclude_list

DESCRIPTION
Defines the hierarchical object types and subtypes the system excludes when
generating a list of types to display in the Item Element creation dialog box. Any valid
Teamcenter mechatronics process management general design elements (GDE)
type defined in this preference will not display in the drop-down list of possible types
to create.

24-14 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid, domain-specific
Teamcenter GDE type.
DEFAULT
VALUES
InterfaceDefinition
ProcessVariable
DEFAULT
PROTECTION
SCOPE
Site preference.

GDELink_default_type

DESCRIPTION
Defines the default general design element (GDE) type used when creating a new
connection when a user does not specify a GDE type during creation.
VALID
VALUES
Accepts a single string as a value. Must be a valid, Teamcenter GDE type.
DEFAULT
VALUES
TC_Link
DEFAULT
PROTECTION
SCOPE
Site preference.

GDEOcc_display_instance_num_for_types

DESCRIPTION
Determines which GDE types an instance number on the GDEOccurrence. (Some,
but not all, GDEOccurrence objects related to interfaces require the display of the
instance numbers.) The GDE types specified in this preference will display in a
structure with an instance number included with the GDEOccurrence title and name.
For more information regarding the use of this preference with the wiring harness
integration, see Wiring Harness Design Tools Integration.
VALID
VALUES
Accepts multiple strings as values. Each value must be a valid Teamcenter GDE type.
KBL (KabelBaumListe – wire harness description list) is a standard for wiring models
that enhances the STEP AP212 model. The KBL object model provides high-level
components that represent wires, harnesses, and parts in a vehicle that hosts the
harness. This model is a subset of AP212 model and models represent wire harness
data in a similar way. If KBL functionality has been installed, the following KBL type
names must be defined.
HRN_Core
HRN_Cavity

PLM00026 11.2 Preferences and Environment Variables Reference 24-15


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

HRN_Slot

DEFAULT
VALUES
Interfaces
DEFAULT
PROTECTION
SCOPE
All.

TC_releasable_logical_types

DESCRIPTION
Specifies which releasable logical types are displayed in the Process Selector dialog
box. The dialog box lists unreleased logical components of a selected assembly.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid release type.
DEFAULT
VALUES
PSConnectionRevision
PSSignalRevision
GeneralDesignElement

DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_Software_Categories

DESCRIPTION
Used for the Embedded Software Manager (ESM). Defines the different categories of
software in use at the site. The default software categories are automatically defined
during installation of the Embedded Software Manager when the option to install
default software categories is taken. If the option to install the defaults is not taken
during installation, this preference must be set manually.
For every software category defined in this preference, a corresponding
ESM_Category_Software_Types preference must be created. For example, if the
values of the ESM_Software_Categories preference are:
ESM_Software_Categories=
PrimeBootloader
SecBootLoader
Application
Calibration
Config
The following three preferences must be created:
ESM_Bootloader_Software_Types=

24-16 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

Bootloader
ESM_Calibration_Software_Types=
Calibration_Type_1
Calibration_Type_2
ESM_Application_Software_Types=
Strategy

VALID
VALUES
Accepts multiple strings as values. Each string must be a category of software.
DEFAULT
VALUES
If the option to install default software categories is taken during installation, the
default values are:
Bootloader
Calibration
Strategy
DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_<Category>_Software_Types

DESCRIPTION
Used for the Embedded Software Manager (ESM). Defines the different types used
to describe the related software category defined in the ESM_Software_Categories
preference. The default software types are automatically defined during installation of
the Embedded Software Manager when the option to install default software categories
and types is taken. If the option to install the defaults is not taken during installation,
this preference must be set manually.
For every software category defined in the ESM_Software_Categories preference,
a corresponding ESM_Category_Software_Types preference must be created. For
example, if the values of the ESM_Software_Categories preference are:
ESM_Software_Categories=
Bootloader
Calibration
Application

The following three ESM software types preferences must be created:


ESM_Bootloader_Software_Types=
Bootloader
ESM_Calibration_Software_Types=
Calibration_Type_1
Calibration_Type_2
ESM_Application_Software_Types=
Application

PLM00026 11.2 Preferences and Environment Variables Reference 24-17


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter item type
(or subtype) corresponding to that category of the software.
DEFAULT
VALUES
If the option to install default software categories is taken during installation, a
preference for each category is created, containing the values of the corresponding
category type.
DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_Processor_Type

DESCRIPTION
Used for the Embedded Software Manager (ESM). Defines the processor types used
to represent the ECU hardware processor.
VALID
VALUES
Accepts a single value. Must be a valid Teamcenter item type (or item subtype).
DEFAULT
VALUES
If the option to implement a default processor is taken during installation, the default
value is:
Processor
DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_processor_direct_child_of_hardware

DESCRIPTION
Used for the Embedded Software Manager (ESM). Specifies the number of levels a
ESM processor is located below the hardware in a BOM structure.

Note

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


variable.

VALID
VALUES
TRUE Indicates the processor is one level below the hardware.

FALSE Indicates the processor is more than one level below hardware.

24-18 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
User preference.

ESM_Processor_is_gateway_attr

DESCRIPTION
Used for the Embedded Software Manager (ESM). Defines the existing processor's
Revision Master form’s logical attribute. This attribute determines whether the
processor is a Gateway processor or not.
VALID
VALUES
Accepts a single value. Must represent the logical attribute on the Revision Master
form of the item type defined in the ESM_Processor_Type preference.
DEFAULT
VALUES
If the option to implement a default processor is taken during installation, the default
value is:
is_gateway
DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_Processor_linked_attr

DESCRIPTION
Used for the Embedded Software Manager (ESM). Defines the name of the existing
processor revision master form’s logical attribute that determines whether the
processor is linked. This attribute specifies whether the processor is linked to the
network.
VALID
VALUES
Accepts a single value. Must be an existing item types’s revision master form’s logical
attribute representing if a processor is linked.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-19


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

ESM_Processor_programmableInService_attr

DESCRIPTION
Used for the Embedded Software Manager (ESM). Defines the name of the existing
processor revision master form’s logical attribute that determines whether the
processor is programmable while in service.
VALID
VALUES
Accepts a single value. Must be an existing item types’s revision master form’s logical
attribute representing whether a processor is programmable in service.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_Processor_memoryType_attr

DESCRIPTION
Used for the Embedded Software Manager (ESM). Defines the name of the existing
processor revision master form’s string attribute that determines the memory type
attribute of the processor.
VALID
VALUES
Accepts a single value. Must be an existing item types’s revision master form’s string
attribute representing the processor’s memory type.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_Processor_byteOrder_attr

DESCRIPTION
Used for the Embedded Software Manager (ESM). Defines the name of the existing
processor revision master form’s string attribute that determines the processor’s byte
order.
VALID
VALUES
Accepts a single value. Must be an existing item types’s revision master form’s string
attribute representing the byte order used by the processor.
DEFAULT
VALUES
None.

24-20 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_Processor_architecture_attr

DESCRIPTION
Used for the Embedded Software Manager (ESM). Defines the name of the existing
processor revision master form’s string attribute that determines the processor’s
architecture.
VALID
VALUES
Accepts a single value. Must be an existing item types’s revision master form’s string
attribute representing the architecture (32-bit or 64-bit) used by the processor.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_HW_Compatibility_Report_TransferMode

DESCRIPTION
Used for the Embedded Software Manager (ESM). Determines the transfer mode used
while generating the PLM XML file containing the compatibility reports of software
for a selected hardware. Depending on the transfer mode, you may have to modify
the corresponding ESM_HW_Compatibility_Report_HTML_StyleSheet_Dataset
style sheet preference so that, if the transfer mode generates more information, the
style sheet displays it correctly.
Transfer mode objects combine rules and property sets to define the context of the
PLM XML import or export operation. These objects are presented as context options
when you import or export objects or system data using the Teamcenter applications.
For more information, see PLM XML/TC XML Export Import Administration.
VALID
VALUES
Accepts a single value. Must be a valid Teamcenter transfer mode.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-21


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

ESM_SW_Compatibility_Report_TransferMode

DESCRIPTION
Used for the Embedded Software Manager (ESM). Determines the transfer mode used
while generating the PLM XML file containing the compatibility reports of hardware for
a selected software. Depending on the transfer mode, you may have to modify the
corresponding ESM_SW_Compatibility_Report_HTML_StyleSheet_Dataset style
sheet preference so that, if the transfer mode generates more information, the style
sheet displays it correctly.
Transfer mode objects combine rules and property sets to define the context of the
PLM XML import or export operation. These objects are presented as context options
when you import or export objects or system data using the Teamcenter applications.
For more information, see PLM XML/TC XML Export Import Administration.
VALID
VALUES
Accepts a single value. Must be a valid Teamcenter transfer mode.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_HW_Compatibility_Report_HTML_StyleSheet_Dataset

DESCRIPTION
Used for the Embedded Software Manager (ESM). Determines the name of the
dataset containing the style sheet used to display the compatible software of a given
hardware in HTML format.
VALID
VALUES
Accepts a single value. Must be a valid Teamcenter dataset.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_SW_Compatibility_Report_HTML_StyleSheet_Dataset

DESCRIPTION
Used for the Embedded Software Manager (ESM). Determines the name of the
dataset containing the style sheet used to display the compatible hardware of a given
software in HTML format.
VALID
VALUES
Accepts a single value. Must be a valid Teamcenter dataset.

24-22 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_HW_Compatibility_Report_Excel_StyleSheet_Dataset

DESCRIPTION
Used for the Embedded Software Manager (ESM). Determines the name of the
dataset containing the style sheet used to display the compatible software of a given
hardware in Excel format.
VALID
VALUES
Accepts a single value. Must be a valid Teamcenter dataset.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_SW_Compatibility_Report_Excel_StyleSheet_Dataset

DESCRIPTION
Used for the Embedded Software Manager (ESM). Determines the name of the
dataset containing the style sheet used to display the compatible hardware of a given
software in Excel format.
VALID
VALUES
Accepts a single value. Must be a valid Teamcenter dataset.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ESM_Compatibility_Report_Excel_Template_Dataset

DESCRIPTION
Used for the Embedded Software Manager (ESM). Determines the name of the
dataset containing the Excel template used to display the hardware-software and
software-hardware compatibility reports.
VALID
VALUES
Accepts a single value. Must be a valid Teamcenter dataset.

PLM00026 11.2 Preferences and Environment Variables Reference 24-23


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

ParmDefIntRevision.RENDERING

DESCRIPTION
Sets the rendering component for ParmDefIntRevision business object and all its
children. The value of this preference is a dataset name that contains the XML style
sheet used for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.
DEFAULT
VALUES
datasetParmDefIntRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetParmDefIntRevision.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ParmdefIntRevision properties style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ParmDefIntRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ParmDefDblRevision.RENDERING

DESCRIPTION
Sets the rendering component for ParmDefDblRevision business object and all its
children. The value of this preference is a dataset name that contains the XML style
sheet used for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.

24-24 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
datasetParmDefDblRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetParmDefDblRevision.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ParmDefDblRevision properties style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ParmDefDblRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ParmDefStrRevision.RENDERING

DESCRIPTION
Sets the rendering component for ParmDefStrRevision business object and all of
children. The value of this preference is a dataset name that contains the XML style
sheet used for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.
DEFAULT
VALUES
datasetParmDefStrRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetParmDefStrRevision.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ParmDefStrRevision properties style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.

PLM00026 11.2 Preferences and Environment Variables Reference 24-25


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
ParmDefStrRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ParmDefBoolRevision.RENDERING

DESCRIPTION
Sets the rendering component for ParmDefBoolRevision business object and all its
children. The value of this preference is a dataset name that contains the XML style
sheet used for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.
DEFAULT
VALUES
datasetParmDefBoolRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetParmDefBoolRevision.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ParmDefBoolRevision properties style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ParmDefBoolRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ParmDefDateRevision.RENDERING

DESCRIPTION
Sets the rendering component for ParmDefDateRevision business object and all its
children. The value of this preference is a dataset name that contains the XML style
sheet used for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.

24-26 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
datasetParmDefDateRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetParmDefDateRevision.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ParmDefDateRevision properties style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ParmDefDateRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ParmDefHexRevision.RENDERING

DESCRIPTION
Sets the rendering component for ParmDefHexRevision business object and all its
children. The value of this preference is a dataset name that contains the XML style
sheet used for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.
DEFAULT
VALUES
datasetParmDefHexRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetParmDefHexRevision.REGISTEREDTO

DESCRIPTION
Indicates the types to which theParmDefHexRevision properties style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.

PLM00026 11.2 Preferences and Environment Variables Reference 24-27


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
ParmDefHexRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ParmDefSEDRevision.RENDERING

DESCRIPTION
Sets the rendering component for ParmDefSEDRevision business object and all its
children. The value of this preference is a dataset name that contains the XML style
sheet used for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.
DEFAULT
VALUES
datasetParmDefSEDRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetParmDefSEDRevision.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ParmDefSEDRevision properties style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ParmDefSEDRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ParmDefBCDRevision.RENDERING

DESCRIPTION
Sets the rendering component for ParmDefBCDRevision business object and all its
children. The value of this preference is a dataset name that contains the XML style
sheet used for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.

24-28 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
datasetParmDefBCDRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetParmDefBCDRevision.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ParmDefBCDRevision properties style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ParmDefBCDRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ParmGrpValRevision.RENDERING

DESCRIPTION
Sets the rendering component for ParmDefGrpValRevision business object and all its
children. The value of this preference is a dataset name that contains the XML style
sheet used for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.
DEFAULT
VALUES
datasetParmGrpValRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetParmGrpValRevision.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ParmGrpValRevision properties style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.

PLM00026 11.2 Preferences and Environment Variables Reference 24-29


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
ParmGrpValRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ParmDefBitDefRevision.RENDERING

DESCRIPTION
Sets the rendering component for ParmDefBitDefRevision business object and all its
children. The value of this preference is a dataset name that contains the XML style
sheet used for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.
DEFAULT
VALUES
datasetParmDefBitDefRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetParmDefBitDefRevision.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ParmDefBitDefRevision properties style sheet can
be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ParmDefBitDefRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ParmGrpDef.RENDERING

DESCRIPTION
Sets the rendering component for ParmGrpDef business object and all its children.
The value of this preference is a dataset name that contains the XML style sheet used
for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.

24-30 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
datasetParmGrpDef
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetParmGrpDef.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ParmGrpDef properties style sheet can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ParmGrpDef
DEFAULT
PROTECTION
SCOPE
Site preference.

ParmDef.RENDERING

DESCRIPTION
Sets the rendering component for ParmDef business object and all its children. The
value of this preference is a dataset name that contains the XML style sheet used for
rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.
DEFAULT
VALUES
datasetParmDef
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetParmDef.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ParmDef properties style sheet can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ParmDef

PLM00026 11.2 Preferences and Environment Variables Reference 24-31


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ParmGrpDefRevision.RENDERING

DESCRIPTION
Sets the rendering component for GrpDefRevision business object and all its children.
The value of this preference is a dataset name that contains the XML style sheet used
for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.
DEFAULT
VALUES
datasetParmGrpDefRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetParmGrpDefRevision.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ParmGrpDefRevision properties style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ParmGrpDefRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ProductVariant.RENDERING

DESCRIPTION
Sets the rendering component for ProductVariant business object and all its children.
The value of this preference is a dataset name that contains the XML style sheet used
for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.
DEFAULT
VALUES
datasetProductVariant

24-32 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

datasetProductVariant.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ProductVariant properties style sheet can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ProductVariant
DEFAULT
PROTECTION
SCOPE
Site preference.

ProductVariant.CREATERENDERING

DESCRIPTION
Registers the create style sheet for ProductVariant objects.
VALID
VALUES
Dataset name containing the custom style sheet.
DEFAULT
VALUES
datasetProductVariantCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetProductVariantCreate.REGISTEREDTO

DESCRIPTION
Indicates the types to which the ProductVariantCreate properties style sheet can be
applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ProductVariant
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-33


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

ProductVariantIntent.RENDERING

DESCRIPTION
Sets the rendering component for the ProductVariantIntent business object and all its
children. The value of this preference is a dataset name that contains the XML style
sheet used for rendering the components of this type.
VALID
VALUES
Dataset name containing the custom style sheet.
DEFAULT
VALUES
datasetProductVariantIntent
DEFAULT
PROTECTION
SCOPE
Site preference.

datasetProductVariantIntent.REGISTEREDTO

DESCRIPTION
Sets the rendering component for ProductVariantIntent business object and all its
children. The value of this preference is a dataset name that contains the XML style
sheet used for rendering the components of this type.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ProductVariantIntent
DEFAULT
PROTECTION
SCOPE
Site preference.

ProductVariantIntent.CREATERENDERING

DESCRIPTION
Registers the create style sheet for ProductVariantIntent objects.
VALID
VALUES
Dataset name containing the custom style sheet.
DEFAULT
VALUES
datasetProductVariantIntent
DEFAULT
PROTECTION
SCOPE
Site preference.

24-34 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

datasetProductVariantIntentCreate.REGISTEREDTO

DESCRIPTION
Sets the rendering component for ProductVariantIntentCreate business object and
all its children. The value of this preference is a dataset name that contains the XML
style sheet used for rendering the components of this type.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ProductVariantIntent
DEFAULT
PROTECTION
SCOPE
Site preference.

Ccd0ColumnPreference

DESCRIPTION
Lists the names of the attributes which needs to be shown in the Group Value
Parameter table in addition to the ones already displayed by default. By default, the
following attributes are displayed in the table:
object_name
object_type
minValues
maxValues
intialvalues

To add attributes in addition to the default attributes, the attribute names need to be
specified as value of this preference. For example:
size
sizeUnits
Refer to the data model to know what attributes of ParmDefRevision or its subclass
can be used to specify as values for this preference.
VALID
VALUES
object_name
object_type
minValues
maxValues
intialvalues
size
sizeUnits
comments

Other custom attributes.

PLM00026 11.2 Preferences and Environment Variables Reference 24-35


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
To be filled by users. It should be the property names of the ParmDefGrpValRevision
business object.
DEFAULT
PROTECTION
SCOPE
Site and user preference.

CCDM_grp_rev_val

DESCRIPTION
Adds parameter group type entries to this preference if you want to restrict adding any
group value to specific types of group. This preference is not created in COTS. You
need to create this preference if you want this functionality.
VALID
VALUES
Organization group
Packetted group
Parameter breakdown
Parameter group
Parameter dictionary
Any other custom group type

DEFAULT
VALUES
To be created and filled by users. Valid group type represents attribute of the
ParmDefGrpRevision business object.
DEFAULT
PROTECTION
SCOPE
Site preference.

HRN_wire_length_data_relation_primary

DESCRIPTION
Some occurrences in the HRN model may have a wire length type and wire length
value associated with them. More than one wire length object may be associated
to these occurrences. This preference determines the primary object types whose
occurrences can participate in the HRN_wire_length_data relation that associates the
primary object with a wire length object.
For more information regarding the use of this preference with the wiring harness
integration, see Wiring Harness Design Tools Integration.
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.

24-36 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
Accepts multiple strings as values. Each value must be a valid Teamcenter object.
Do not delete this preference.
DEFAULT
VALUES
HRN_Core
HRN_GeneralWire
DEFAULT
PROTECTION
SCOPE
Site preference.

HRN_associated_part_relation_secondary

DESCRIPTION
A cavity in a harness assembly may be associated with occurrences that fill the cavity
space. These occurrences are associated to the cavity with the HRN_associated_part
relation. This preference determines the KBL types whose occurrences can be
associated with the cavity in a harness assembly.
KBL (KabelBaumListe – wire harness description list) is a standard for wiring models
that enhances the STEP AP212 model. The KBL object model provides high-level
components that represent wires, harnesses, and parts in a vehicle that hosts the
harness. This model is a subset of AP212 model and models represent wire harness
data in a similar way. If KBL functionality has been installed, the following KBL type
names must be defined.
For more information regarding the use of this preference with the wiring harness
integration, see Wiring Harness Design Tools Integration.
VALID
VALUES
Accepts multiple strings as values. Each value must be a valid Teamcenter object.
Do not delete this preference.
DEFAULT
VALUES
HRN_CavityPlug
HRN_CavitySeal
HRN_GenTerminal
DEFAULT
PROTECTION
SCOPE
Site preference.

HRN_node_referenced_component_relation_secondary

DESCRIPTION
A node object may have referenced components located at the node. These
referenced components are occurrences that are associated with the node object by
the HRN_node_referenced_component relation. This preference determines the

PLM00026 11.2 Preferences and Environment Variables Reference 24-37


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

permitted secondary object types whose occurrences can be attached to the node as
referenced components.
For more information regarding the use of this preference with the wiring harness
integration, see Wiring Harness Design Tools Integration.
VALID
VALUES
Accepts multiple strings as values. Each value must be a valid Teamcenter object.
Do not delete this preference.
DEFAULT
VALUES
HRN_Accessory
HRN_Fixing
HRN_AssemblyPart
HRN_ConHousing
HRN_GenTerminal
HRN_WireProtect
DEFAULT
PROTECTION
SCOPE
Site preference.

HRN_part_data_relation_primary

DESCRIPTION
Some occurrences in a harness assembly may have instance data set on them,
for example, id and alias_id. This data is attached to the instance with the
HRN_part_instance_data relation. This preference determines the object types
whose occurrences can participate as primary types in the association with instance
data.
For more information regarding the use of this preference with the wiring harness
integration, see Wiring Harness Design Tools Integration.
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.
Do not delete this preference.
DEFAULT
VALUES
HRN_Accessory
HRN_AssemblyPart
HRN_GenTerminal
HRN_Fixing

24-38 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

HRN_CoPackPart
DEFAULT
PROTECTION
SCOPE
Site preference.

HRN_fixing_assignment_relation_primary

DESCRIPTION
A fixing occurrence or an accessory occurrence may be associated with a segment
object as a fixing assignment. This preference determines the permitted object
types whose occurrences may be associated with the segment object by the
HRN_fixing_assignment relation.
For more information regarding the use of this preference with the wiring harness
integration, see Wiring Harness Design Tools Integration.
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.
Do not delete this preference.
DEFAULT
VALUES
HRN_Accessory
HRN_Fixing
DEFAULT
PROTECTION
SCOPE
Site preference.

SIG_asystem_source_rules

DESCRIPTION
Defines which Teamcenter types and/or classes can be associated with a frame or
a signal as a source system. When a class is specified, subtypes are included. If
this preference is not set, users can associate a frame or signal to any Teamcenter
object that can participate in a relation.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter class or
type. Values are set in the following format:
frame or signal: class or type
For example:

PLM00026 11.2 Preferences and Environment Variables Reference 24-39


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

Frame:Item
Signal:Interfaces
DEFAULT
VALUES
Frame:Item
Signal:Interfaces
DEFAULT
PROTECTION
SCOPE
Site preference.

SIG_asystem_target_rules

DESCRIPTION
Defines which Teamcenter types can be associated with the signal as a target system.
If this preference is not set, users can associate a signal to any Teamcenter object
that can participate in a relation.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter type
corresponding to the secondary object for the desired association. For example, to
restrict valid targets for a frame to item and its subtypes, and for the signal to Interfaces
and its subtypes, set the values as:

Frame:Item
Signal:Interfaces
DEFAULT
VALUES
Frame:Item
Signal:Interfaces
DEFAULT
PROTECTION
SCOPE
Site preference.

SIG_asystem_transmitter_rules

DESCRIPTION
Defines which Teamcenter types can be associated with the signal as a transmitter
system. If this preference is not set, users can associate a signal to any Teamcenter
object that can participate in a relation.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter type
corresponding to the secondary object for the desired association. For example, to
restrict valid transmitters for a PSSignal subtype or subclass to PSConnection and
its subtypes, set the values as:

PSSignal:Connection

24-40 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
PSSignal:PSConnection
DEFAULT
PROTECTION
SCOPE
Site preference.

SIG_pvariable_rules

DESCRIPTION
Defines which Teamcenter types can be associated with the signal as a process
variable. If this preference is not set, users can associate a signal to any Teamcenter
object that can participate in a relation.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter type
corresponding to the secondary object for the desired association. For example, to
restrict valid process variables for a signal or subtype to ProcessVariable and its
subtypes, set the values as:
Signal:ProcessVariable
DEFAULT
VALUES
Signal:ProcessVariable
DEFAULT
PROTECTION
SCOPE
Site preference.

SIG_redundant_rules

DESCRIPTION
Defines which Teamcenter types can be associated with the signal as a redundant
signals (or frames) type. If this preference is not set, users can associate a signal to
any Teamcenter object that can participate in a relation.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter type
corresponding to the secondary object for the desired association. For example, to
restrict valid redundants for a frame and its subtypes to Frame and its subtypes,
and valid redundants for a signal and its subtypes to Signal and its subtypes, set
the values as:
Frame:Frame
Signal:Signal

DEFAULT
VALUES
Frame:Frame
Signal:Signal

PLM00026 11.2 Preferences and Environment Variables Reference 24-41


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_relation_required_on_export

DESCRIPTION
Specifies the list of default relations required for the export operation.
VALID
VALUES
Relation names (not relation display names).
DEFAULT
VALUES
Depends on the deployed schemas.
IMAN_master_form
IMAN_requirement
IMAN_specification
IMAN_ic_intent
IMAN_CCContext
IMAN_StructureContent
IMAN_SCTypeData
TC_Attaches
HasParticipant
TCCalendar_Rel_Type

If you have installed CCDM, the following relations are added to this preference:
Ccd0HasMemoryLayout
Ccd0HasOverrideContainer
DEFAULT
PROTECTION
SCOPE
Site preference.

ParmGroup_Assigned_Hierarchy_Shown

DESCRIPTION
Specifies the hierarchy visibility in the assigned parameter group.
VALID
VALUES
True
False
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

24-42 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

Parameter_Assigned_Columns_Shown

DESCRIPTION
Lists the properties of the parameter definition revision that can be displayed in the
assigned view. These properties should belong to the type and/or the subtype of
ParmDefRevision.
VALID
VALUES
A string list
DEFAULT
VALUES
object_string
ccdOConversionRule
minValues
maxValues
initialValues
validValues
initialValue
bitDef
DEFAULT
PROTECTION
SCOPE
Site preference.

Parameter_Available_Columns_Shown

DESCRIPTION
Lists the properties of the parameter definition revision that can be displayed in the
available view. These specified properties should belong to the type and/or the
subtype of ParmDefRevision.
VALID
VALUES
A string list
DEFAULT
VALUES
object_string
ccdOConversionRule
minValues
maxValues
initialValues
tableDefinition
validValues
initialValue

PLM00026 11.2 Preferences and Environment Variables Reference 24-43


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

bitDef
DEFAULT
PROTECTION
SCOPE
Site preference.

OverrideContRev_Assigned_Columns_Shown

DESCRIPTION
Lists the properties of the override container revision that can be displayed in the
assigned view. These specified properties should belong to the type and/or the
subtype of Ccd0OverrideContRevision.
VALID
VALUES
A string list
DEFAULT
VALUES
item_revision_id
DEFAULT
PROTECTION
SCOPE
Site preference.

OverrideContRev_Available_Columns_Shown

DESCRIPTION
Lists the properties of the override container revision that can be displayed in the
available view. These specified properties should belong to the type and/or the
subtype of Ccd0OverrideContRevision.
VALID
VALUES
A string list
DEFAULT
VALUES
item_revision_id
DEFAULT
PROTECTION
SCOPE
Site preference.

MemoryLayoutRevOrBlock_Assigned_Columns_Shown

DESCRIPTION
Lists the properties of the memory layout revision or the memory block that can be
displayed in the assigned view. These specified properties should belong to the type
and/or the subtype of Ccd0MemoryLayoutRevision or Mem0MemoryBlock.
VALID
VALUES
A string list

24-44 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
mem0StartAddress
DEFAULT
PROTECTION
SCOPE
Site preference.

MemoryRecord_Assigned_Columns_Shown

DESCRIPTION
Lists the properties of the memory record that can be displayed in the assigned
view. These specified properties should belong to the type and/or the subtype of
Mem0MemoryRecord.
VALID
VALUES
A string list
DEFAULT
VALUES
mem0OffsetAddr
DEFAULT
PROTECTION
SCOPE
Site preference.

MemoryOverrideRecord_Assigned_Columns_Shown

DESCRIPTION
Lists the properties of the memory override record that can be displayed in the
assigned view. These specified properties should belong to the type and/or the
subtype of Ccd0MemoryOverrideRecord.
VALID
VALUES
A string list
DEFAULT
VALUES
ccd0OffsetAddr
DEFAULT
PROTECTION
SCOPE
Site preference.

ConvOverrideRecord_Assigned_Columns_Shown

DESCRIPTION
Lists the properties of the conversion override record that can be displayed in the
assigned view. These specified properties should belong to the type and/or the
subtype of Ccd0ConvOverrideRecord.
VALID
VALUES
A string list

PLM00026 11.2 Preferences and Environment Variables Reference 24-45


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
ccd0ConversionRule
DEFAULT
PROTECTION
SCOPE
Site preference.

ConvOverrideRecord_Available_Columns_Shown

DESCRIPTION
Lists the properties of the conversion override record that can be displayed in the
available view. These specified properties should belong to the type and/or the
subtype of Ccd0ConvOverrideRecord.
VALID
VALUES
A string list
DEFAULT
VALUES
ccd0ConversionRule
DEFAULT
PROTECTION
SCOPE
Site preference.

Vendor management preferences

BidPackageLineItem_default_relation

DESCRIPTION
Specifies the object default paste relation.
VALID
VALUES
Accepts a single string value; it must be a valid type name.
DEFAULT
VALUES
TC_part_quote_rel
DEFAULT
PROTECTION
SCOPE
Site preference.

BidPackageLineItem_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of bid package line
items.

24-46 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
Accepts one or more strings as values; each must be a valid property name.
DEFAULT
VALUES
TC_part_quote_rel
DEFAULT
PROTECTION
SCOPE
Site preference.

BidPackageLineItem_PseudoFolder

DESCRIPTION
Specifies the list of properties that can be displayed as a pseudo folder under a node
for BidPackageLineItem objects.
Note

Modify to apply a style sheet to a new type.

VALID
VALUES
Accepts one or more strings as values; each must be a valid property name.
DEFAULT
VALUES
TC_part_quote_rel
DEFAULT
PROTECTION
SCOPE
Site preference.

BidPackageRevision_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of the BidPackage
revision node.
VALID
VALUES
Accepts one or more strings as values; each must be a valid property name.
DEFAULT
VALUES
IMAN_master_form_rev
bom_view_tags
revision_list
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEView
IMAN_vi_sos
IMAN_external_object_link
IMAN_specification

PLM00026 11.2 Preferences and Environment Variables Reference 24-47


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

TC_WorkContext_Relation
TC_AuditLog
TC_Is_Represented_By
lineitems
DEFAULT
PROTECTION
SCOPE
Site preference.

BidPackageRevision_PseudoFolder

DESCRIPTION
Specifies the list of properties that can be displayed as a pseudo folder under a node
for the BidPackageRevision object.
VALID
VALUES
Accepts one or more strings as values; each must be a valid property name.
DEFAULT
VALUES
lineitems
DEFAULT
PROTECTION
SCOPE
Site preference.

CommercialPart_DefaultChildProperties

DESCRIPTION
Enables the viewing of the specified relation types for commercial parts.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
IMAN_master_form
bom_view_tags
revision_list
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEView
IMAN_vi_sos
IMAN_external_object_link
TC_WorkContext_Relation
TC_AuditLog
vendors
vendorparts

24-48 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
All.

CommercialPart_PseudoFolder

DESCRIPTION
Specifies the list of properties that can be displayed as a pseudo folder under a node
for a CommercialPart object.
Note

The preference must be enabled to let the user view and manage the dataset
associated with a commercial part.

VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
vendors
vendorparts

DEFAULT
PROTECTION
SCOPE
All.

CompanyLocation_DefaultChildProperties

DESCRIPTION
Enables viewing of specified relation types for vendor parts.
VALID
VALUES
Accepts one or more strings as values; each string must be a VendorLocation
property.
DEFAULT
VALUES
ContactInCompany
DEFAULT
PROTECTION
SCOPE
All.

CompanyLocation_PseudoFolder

DESCRIPTION
Specifies the list of properties displayed as a pseudo folder under a node for a
CompanyLocation object.

PLM00026 11.2 Preferences and Environment Variables Reference 24-49


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Accepts one or more strings as values; each string must be a VendorLocation
property.
DEFAULT
VALUES
ContactInCompany
DEFAULT
PROTECTION
SCOPE
Site preference.

ContactInCompany_relation_primary

DESCRIPTION
Enables the ContactInCompany relation for the specified business objects.
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 values, each string must be a valid type.
DEFAULT
VALUES
Item
ItemRevision
CompanyLocation
DEFAULT
PROTECTION
SCOPE
All.

LocationInCompany_relation_primary

DESCRIPTION
Enables the LocationInCompany relation for the specified business objects.
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 values, each string must be any type.

24-50 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
Item
ItemRevision
DEFAULT
PROTECTION
SCOPE
All.

ManufacturerPart_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of Manufacturer Part
node.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of
ManufacturerPart.
DEFAULT
VALUES
IMAN_master_form
bom_view_tags
revision_list
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEView
IMAN_vi_sos
IMAN_external_object_link
TC_WorkContext_Relation
TC_AuditLog
vendors
commercialparts
TC_Quality_Document
ProvidedFrom
Mat1UsesMaterial, Scp0PartToSubsCmplResult, Scp0SubsCmplDocs

DEFAULT
PROTECTION
SCOPE
User preference.

ManufacturerPart_DefaultPSEProperties

DESCRIPTION
Enables viewing of the related properties for vendor parts in Structure Manager.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of
ManufacturerPart or a property of the VMRepresents relation.

PLM00026 11.2 Preferences and Environment Variables Reference 24-51


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
item_id
vendor_part_num
object_name
vendor_id
vendor_name
TC_Location
preferred_status
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPart_PseudoFolder

DESCRIPTION
Specifies the list of properties that can be displayed as a pseudo folder under a node
for ManufacturerPart objects.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of
ManufacturerPart.
DEFAULT
VALUES
vendors
commercialparts
TC_Quality_Document
ProvidedFrom
Mat1UsesMaterial, Scp0PartToSubsCmplResult, Scp0SubsCmplDocs
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPartRevision.REGISTEREDTO

DESCRIPTION
Indicates the types to which the vendor part revision properties style sheet can be
applied.
Note

Modify to apply a style sheet to a new type.

VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ManufacturerPart Revision

24-52 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPart Revision.RENDERING

DESCRIPTION
Registers the properties style sheet for vendor part revision objects.
Note

Modify to use a new style sheet.

VALID
VALUES
Accepts one string as a value; it must be a valid dataset name.
DEFAULT
VALUES
ManufacturerPartRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPart Revision.SUMMARYRENDERING

DESCRIPTION
Registers the summary styles sheet for vendor part revision objects.
VALID
VALUES
Accepts one string as a value; it must be a valid dataset name.
DEFAULT
VALUES
ManufacturerPartRevSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPartRevSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the types to which the vendor part revision summary style sheet can be
applied.
Note

Modify to apply a style sheet to a new type.

VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.

PLM00026 11.2 Preferences and Environment Variables Reference 24-53


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
ManufacturerPart Revision
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPart.REGISTEREDTO

DESCRIPTION
Indicates the types to which the vendor part properties style sheet can be applied.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ManufacturerPart
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPart.RENDERING

DESCRIPTION
Registers the properties style sheet for vendor part objects.
Note

Modify to use a new style sheet.

VALID
VALUES
Accepts one string as a value; it must be a valid dataset name.
DEFAULT
VALUES
ManufacturerPart
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPart.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for vendor part objects.
Note

Modify to use a new style sheet.

24-54 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
Accepts one string as a value; it must be a valid dataset name.
DEFAULT
VALUES
ManufacturerPartSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPartSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Indicates the types to which the vendor part summary style sheet can be applied.
Note

Modify to apply a style sheet to a new type.

VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
ManufacturerPart
DEFAULT
PROTECTION
SCOPE
Site preference.

ProvidedFrom_relation_primary

DESCRIPTION
Enables the ProvdedFrom relation for the specified business objects.
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 values; each string must be a valid type.
DEFAULT
VALUES
ManufacturerPart
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 24-55


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

PseudoFolder.ContactInCompany_ColumnPreferences

DESCRIPTION
Specifies the list of properties that can be displayed when a ContactInCompany
pseudo folder is selected in the Details view.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid property name.
DEFAULT
VALUES
CompanyContact.object_string
CompanyContact.title
CompanyContact.first_name
CompanyContact.last_name
CompanyContact.phone_business
CompanyContact.fax_number
CompanyContact.email_address
DEFAULT
PROTECTION
SCOPE
Site preference.

PseudoFolder.lineitems_ColumnPreferences

DESCRIPTION
Specifies the list of properties that can be displayed when the BidpackageLineItems
pseudo folder is selected in the Details view.
VALID
VALUES
Accepts one or more strings as values; each must be a valid type.property name.
DEFAULT
VALUES
PseudoFolder.object_string
BidPackageLineItem.object_type
BidPackageLineItem.quantity
BidPackageLineItem.cust_line_item_attrs
BidPackageLineItem.configuration_context
BidPackageLineItem.part
DEFAULT
PROTECTION
SCOPE
Site preference.

PseudoFolder.LocationInCompany_ColumnPreferences

DESCRIPTION
Specifies the list of properties that can be displayed when a LocationInCompany
pseudo folder is selected in the Details view.

24-56 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
Accepts one or more strings as values; each string must be a valid property name.
DEFAULT
VALUES
CompanyLocation.object_string
CompanyLocation.street
CompanyLocation.city
CompanyLocation.state_province
CompanyLocation.postal_code
CompanyLocation.country
DEFAULT
PROTECTION
SCOPE
Site preference.

PseudoFolder.ProvidedFrom_ColumnPreferences

DESCRIPTION
Specifies the list of properties that can be displayed when a ProvidedFrom pseudo
folder is selected in the Details view.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid property name.
DEFAULT
VALUES
CompanyLocation.object_string
CompanyLocation.street
CompanyLocation.city
CompanyLocation.state_province
CompanyLocation.postal_code
CompanyLocation.country
DEFAULT
PROTECTION
SCOPE
Site preference.

PseudoFolder.TC_part_quote_rel_ColumnPreferences

DESCRIPTION
Specifies the list of properties that can be displayed when a Quotes pseudo folder
is selected in the Details view.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid property name.
DEFAULT
VALUES
PseudoFolder.object_string
Quote.object_type
Quote.currency

PLM00026 11.2 Preferences and Environment Variables Reference 24-57


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

Quote.quoted_quantity
Quote.tooling_cost
Quote.vendor
Quote.unit_price
relation
DEFAULT
PROTECTION
SCOPE
Site preference.

Quote_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of quotes.
VALID
VALUES
Accepts one or more strings as values; each must be a valid property name.
DEFAULT
VALUES
vendor
DEFAULT
PROTECTION
SCOPE
Site preference.

Restricted_Vendor_Part_Statuses

DESCRIPTION
Defines the list of restricted vendor part revision release statuses with which users
cannot associate commercial part/revisions with vendor parts.
VALID
VALUES
Accepts one or more strings as values; each string must be a status type.
DEFAULT
VALUES
Obsolete
DEFAULT
PROTECTION
SCOPE
Site preference.

Restricted_Vendor_Statuses

DESCRIPTION
Defines the list of restricted vendor release statuses with which users cannot associate
vendor parts with vendors.
VALID
VALUES
Accepts one or more strings as values; each string must be a status type.

24-58 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
Obsolete
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Distributor_info_form

DESCRIPTION
Specifies the Distributor role default form type.
VALID
VALUES
Accepts a single string value; it must be a valid form type name.
DEFAULT
VALUES
DistributorInfo
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Manufacturer_info_form

DESCRIPTION
Specifies the Manufacturer role default form type.
VALID
VALUES
Accepts a single string value; it must be a valid form type name.
DEFAULT
VALUES
ManufacturerInfo
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_part_quote_rel_relation_primary

DESCRIPTION
Specifies the primary type for the TC_part_quote_rel 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.

PLM00026 11.2 Preferences and Environment Variables Reference 24-59


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Accepts one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
BidPackageLineItem
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Quality_Document_relation_primary

DESCRIPTION
Enables the TC_Quality_Document relation for the specified business objects.
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 values; each string must be a valid type.
DEFAULT
VALUES
Vendor
VendorRevision
ManufacturerPart
ManufacturerPart Revision
DEFAULT
PROTECTION
SCOPE
All.

TC_Supplier_info_form

DESCRIPTION
Specifies the Supplier role default form type.
VALID
VALUES
Accepts a single string value; it must be a valid form type name.
DEFAULT
VALUES
SupplierInfo
DEFAULT
PROTECTION
SCOPE
Site preference.

24-60 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

TC_vendor_part_rel_relation_primary

DESCRIPTION
Indicates the list of valid primary object types for the TC_vendor_part_rel 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 one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
Item
DEFAULT
PROTECTION
SCOPE
Site preference.

Vendor_DefaultChildProperties

DESCRIPTION
Enables viewing of the specified relation types for vendors.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of Vendor.
DEFAULT
VALUES
IMAN_master_form
bom_view_tags
revision_list
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEView
IMAN_vi_sos
IMAN_external_object_link
TC_WorkContext_Relation
TC_AuditLog
vendorparts
commercialparts
LocationInCompany
ContactInCompany
TC_Quality_Document

PLM00026 11.2 Preferences and Environment Variables Reference 24-61


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
All.

Vendor_PseudoFolder

DESCRIPTION
Specifies the list of properties that can be displayed as a pseudo folder under a node
for a Vendor object.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of Vendor.
DEFAULT
VALUES
vendorparts
commercialparts
LocationInCompany
ContactInCompany
TC_Quality_Document
DEFAULT
PROTECTION
SCOPE
All.

VendorRevision_DefaultChildProperties

DESCRIPTION
Enables viewing of specified relation types for vendor revisions.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of
VendorRevision.
DEFAULT
VALUES
IMAN_master_form_rev
bom_view_tags
revision_list
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEView
IMAN_vi_sos
IMAN_external_object_link
IMAN_specification
TC_WorkContext_Relation
TC_AuditLog
TC_Is_Represented_By
release_status_list
LocationInCompany

24-62 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

ContactInCompany
TC_Quality_Document
vendor_role_info

DEFAULT
PROTECTION
SCOPE
All.

VendorRevision_PseudoFolder

DESCRIPTION
Specifies the list of properties that can be displayed as a pseudo folder under a node
for VendorRevision objects.
Note

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


variable.

VALID
VALUES
Accepts one or more strings as values; each string must be a property of
VendorRevision.
DEFAULT
VALUES
LocationInCompany
ContactInCompany
TC_Quality_Document
CAEAnalysis
MEProcess
MESetup
view
interpart_equations
mating_constraints
geometric_interfaces
interpart_links
parametric_interfaces

DEFAULT
PROTECTION
SCOPE
User preference.

VMRepresents_relation_primary

DESCRIPTION
Indicates the list of valid primary object types for the VMRepresents relation.

PLM00026 11.2 Preferences and Environment Variables Reference 24-63


Chapter
Chapter 24:24:Solution-specific
Solution-specific 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 one or more strings as values; each must be a valid type name.
DEFAULT
VALUES
Item
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

VMS_Maintain_Vendor_History

DESCRIPTION
Controls whether the system moves or copies data during change vendor operations.
VALID
VALUES
TRUE If the preference is set to TRUE, the system copies the vendor
data.

FALSE If the preference is set to FALSE, the system moves the vendor
data.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

VMS_vendor_part_selection_rule

DESCRIPTION
Stores the active condition name corresponding to current vendor part selection rule.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid condition.
DEFAULT
VALUES
showAllVendorParts

24-64 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
• Site preference.

• User preference.

MRO core preferences

HierarchicalWSO_HierarchicalWSO_default_relation

DESCRIPTION
Specifies the default relation between two hierarchical workspace objects.
VALID
VALUES
Accepts one or more strings as a value. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
HWSOStructure
DEFAULT
PROTECTION
SCOPE
Site preference.

Item_CharacteristicDefinition_default_relation

DESCRIPTION
Specifies the default relation created when a characteristics definition object is pasted
under an item object.
VALID
VALUES
Accepts one or more strings as a value. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
NeutralCharacteristics
DEFAULT
PROTECTION
SCOPE
Site preference.

ItemRevision_CharacteristicDefinition_default_relation

DESCRIPTION
Specifies the default relation created when a characteristics definition object is pasted
under an item revision object. The default value for this preference is InvalidRelation
to disallow creating a relation between an item revision object and a characteristics
definition object.

PLM00026 11.2 Preferences and Environment Variables Reference 24-65


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Accepts one or more strings as a value. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
InvalidRelation
DEFAULT
PROTECTION
SCOPE
Site preference.

LogBook_PhysicalPart_default_relation

DESCRIPTION
Defines the default relationship between a log book and a physical part.
VALID
VALUES
Accepts one or more strings as a value. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
physicalAssetTag
DEFAULT
PROTECTION
SCOPE
Site preference.

LogBook_WorkspaceObject_default_relation

DESCRIPTION
Defines the default relationship created when workspace object is pasted under a log
book. The default value of this preference is InvalidRelation to disallow the creation
of any relation with a log book.
VALID
VALUES
Accepts one or more strings as a value. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
InvalidRelation
DEFAULT
PROTECTION
SCOPE
Site preference.

Lot.SUMMARYRENDERING

DESCRIPTION
Specifies the lot objects summary style sheet registry.
VALID
VALUES
Accepts a single string as a value, which must be a valid dataset name.

24-66 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
LotSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

Lot_DefaultChildProperties

DESCRIPTION
Specifies a list of properties that can be used for Lot children.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid Teamcenter relation
object.
DEFAULT
VALUES
designItemTag
DEFAULT
PROTECTION
SCOPE
Site preference.

MRONeutralColumnsShownPref

DESCRIPTION
Specifies the columns displayed in the MRO neutral item structure table.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid neutral BOM line
property.
DEFAULT
VALUES
bl_indented_title
bl_item_object_type
bl_occurrence_name
bl_quantity
bl_uom
npbl_is_item_serialized
npbl_is_item_lot
npbl_is_item_traceable
npbl_preserve_quantity
npbl_is_item_rotable
npbl_is_item_consumable
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-67


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

MRONeutralShownColumnWidthsPref

DESCRIPTION
Specifies the column widths displayed in the MRO neutral item structure 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 MRONeutralColumnsShownPref user preference, and so forth.
DEFAULT
VALUES
20
15
12
10
10
10
10
10
10
10
10
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturingIdCharsForPhysicalPartIdPref

DESCRIPTION
Specifies the number of characters to use from the manufacturing ID when generating
the physical part item ID. The physical part item ID is a combination of characters from
part number, serial number, and manufacturing ID properties. The total number of
characters for the physical part item ID should not exceed 128 characters. The first
entry in the preference is the number of characters to use from the manufacturing ID
property for the physical part item ID. The second entry in the preference indicates
whether to use the characters from the beginning of the manufacturing ID (a value
of 0) or from the end of the part number (a value of 1).
If this preference is not found, the last 40 characters of the manufacturing ID are used.
VALID
VALUES
Any positive integers.
DEFAULT
VALUES
40
1

24-68 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

MROAlternateColorPref

DESCRIPTION
Specifies the color to use when displaying an alternate physical part.
VALID
VALUES
The value can be a standard supported string, an octal number, or a hexadecimal
number. The standard strings supported are black, white, lightGray, gray, darkGray,
red, pink, orange, yellow, green, magenta, cyan, and blue. An example of a
hexadecimal number is #50b080, which represents sea green.
DEFAULT
VALUES
cyan
DEFAULT
PROTECTION
SCOPE
Site preference.

MRODeviatedColorPref

DESCRIPTION
Specifies the color to use when displaying a deviated physical part.
VALID
VALUES
The value can be a standard supported string, an octal number, or a hexadecimal
number. The standard strings supported are black, white, lightGray, gray, darkGray,
red, pink, orange, yellow, green, magenta, cyan, and blue. An example of a
hexadecimal number is #50b080, which represents sea green.
DEFAULT
VALUES
yellow
DEFAULT
PROTECTION
SCOPE
Site preference.

MROExtraToDesignColorPref

DESCRIPTION
Specifies the color to use when displaying a physical part that is extra to design.
VALID
VALUES
The value can be a standard supported string, an octal number, or a hexadecimal
number. The standard strings supported are black, white, lightGray, gray, darkGray,

PLM00026 11.2 Preferences and Environment Variables Reference 24-69


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

red, pink, orange, yellow, green, magenta, cyan, and blue. An example of a
hexadecimal number is #50b080, which represents sea green.
DEFAULT
VALUES
orange
DEFAULT
PROTECTION
SCOPE
Site preference.

MROMissingColorPref

DESCRIPTION
Specifies the color to use when displaying a missing physical part.
VALID
VALUES
The value can be a standard supported string, an octal number, or a hexadecimal
number. The standard strings supported are black, white, lightGray, gray, darkGray,
red, pink, orange, yellow, green, magenta, cyan, and blue. An example of a
hexadecimal number is #50b080, which represents sea green.
DEFAULT
VALUES
red
DEFAULT
PROTECTION
SCOPE
Site preference.

MROSubstituteColorPref

DESCRIPTION
Specifies the color to use when displaying a substitute physical part.
VALID
VALUES
The value can be a standard supported string, an octal number, or a hexadecimal
number. The standard strings supported are black, white, lightGray, gray, darkGray,
red, pink, orange, yellow, green, magenta, cyan, and blue. An example of a
hexadecimal number is #50b080, which represents sea green.
DEFAULT
VALUES
blue
DEFAULT
PROTECTION
SCOPE
Site preference.

PartLogisticsForm.SUMMARYRENDERING

DESCRIPTION
Determines the registration of the summary style sheet for part logistics form objects.

24-70 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
Accepts a string as a value. Each string must be a valid style sheet dataset object
name.
DEFAULT
VALUES
PartLogisticsFormSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

PartNumberCharsForPhysicalPartIdPref

DESCRIPTION
Specifies the number of characters to use from the part number when generating
the physical part item ID. The physical part item ID is a combination of characters
from part number, serial number, and manufacturing ID properties. The total number
of characters for the physical part item ID should not exceed 128 characters. The
first entry in the preference is the number of characters to use from the part number
property for the physical part item ID. The second entry in the preference indicates
whether to use the characters from the beginning of the part number (a value of 0) or
from the end of the part number (a value of 1).
If this preference is not found, the last 40 characters of the part number are used.
VALID
VALUES
Any positive integers.
DEFAULT
VALUES
40
1
DEFAULT
PROTECTION
SCOPE
Site preference.

PhysicalContext_relation_primary

DESCRIPTION
Specifies the valid primary object types list for the physical context 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.

PLM00026 11.2 Preferences and Environment Variables Reference 24-71


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Accepts one or more stings as values. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
PhysicalPartRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

PhysicalElement_Company_default_relation

DESCRIPTION
Defines the default relationship created when company object is pasted under a
physical element class object.
VALID
VALUES
Accepts one or more strings as a value. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
PhysicalElementOwner
DEFAULT
PROTECTION
SCOPE
Site preference.

PhysicalPart_Company_default_relation

DESCRIPTION
Defines the default relationship created when company object is pasted under a
physical part.
VALID
VALUES
Accepts one or more strings as a value. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
PhysicalPartManufacturer
DEFAULT
PROTECTION
SCOPE
Site preference.

PhysicalPart_DefaultChildProperties

DESCRIPTION
Defines the list of properties that can be displayed as children of a physical part.

24-72 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
Accepts one or more strings as a value. Each string must be a valid Teamcenter
property name.
DEFAULT
VALUES
AllowedDeviation
IMAN_master_form
bom_view_tags
revision_list
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEView
IMAN_vi_sos
IMAN_external_object_link
PhysicalElementOwner
PhysicalPartManufacturer
TC_WorkContext_Relation
TC_AuditLog
TC_sst_record
DEFAULT
PROTECTION
SCOPE
Site preference.

PhysicalPartRelationsToExport

DESCRIPTION
Defines the relations that are exported with a physical part when the physical part is
secondary in the relation.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid relation class name.
DEFAULT
VALUES
Values are added by dependent templates.
The asmaintained template adds the following value:
AssetContains
DEFAULT
PROTECTION
SCOPE
Site preference.

PhysicalPart.SUMMARYRENDERING

DESCRIPTION
Determines the registration for the physical part object's summary style sheet.

PLM00026 11.2 Preferences and Environment Variables Reference 24-73


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Accepts a single string as a value, which must be a valid dataset name.
DEFAULT
VALUES
PhysicalPartSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

PhysicalPartRevision_DefaultChildProperties

DESCRIPTION
Determines the properties that can be used as children for the indicated type.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid Teamcenter relation
object.
DEFAULT
VALUES
PhysicalContext
PhysicalRealization
DEFAULT
PROTECTION
SCOPE
Site preference.

PhysicalPartRevision.SUMMARYRENDERING

DESCRIPTION
Registers the physical part revision object's summary style sheet.
VALID
VALUES
Accepts a single string as a value, which must be a valid dataset name.
DEFAULT
VALUES
PhysicalPartRevisionSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

PhysicalRealization_relation_primary

DESCRIPTION
Specifies the valid primary object types list for the physical realization relation.

24-74 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific 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 one or more stings as values. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
PhysicalPartRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

SerialNumberCharsForPhysicalPartIdPref

DESCRIPTION
Specifies the number of characters to use from the serial number when generating the
physical part item ID. The physical part item ID is a combination of characters from
part number, serial number, and manufacturing ID properties. The total number of
characters for the physical part item ID should not exceed 128 characters. The first
entry in the preference is the number of characters to use from the serial number
property for the physical part item ID. The second entry in the preference indicates
whether to use the characters from the beginning of the part number (a value of 0) or
from the end of the serial number (a value of 1).
If this preference is not found, the last 40 characters of the serial number are used.
VALID
VALUES
Any positive integers.
DEFAULT
VALUES
40
1
DEFAULT
PROTECTION
SCOPE
Site preference.

SerialNumberGenerator_DefaultChildProperties

DESCRIPTION
Specifies the properties list that can be used as children for the indicated type.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid Teamcenter relation
object.

PLM00026 11.2 Preferences and Environment Variables Reference 24-75


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
designItemTag
DEFAULT
PROTECTION
SCOPE
Site preference.

SerialNumberGenerator.SUMMARYRENDERING

DESCRIPTION
Registers the serial number generator objects' summary style sheet.
VALID
VALUES
Accepts a single string as a value, which must be a valid dataset name.
DEFAULT
VALUES
SerialNumberGeneratorSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

TransactionElement_Dataset_default_relation

DESCRIPTION
Specifies the default relation when a dataset is associated with a transaction element.
VALID
VALUES
Accepts a single string as a value. It must be a valid Teamcenter relation business
object.
DEFAULT
VALUES
TC_Attaches
DEFAULT
PROTECTION
SCOPE
Site preference.

UtilizationViewColumnsShownPref

DESCRIPTION
Specifies the columns displayed in the Utilization view in left to right order.
VALID
VALUES
Accepts one or more strings as values. The strings are property names from the
utilization object.
DEFAULT
VALUES
util_characteristic_name

24-76 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

util_unit
util_time_since_new
util_last_value
util_last_recorded_date
The asmaintained template adds the following value:
util_time_on_parent
The serviceeventmanagement template adds the following values:
util_time_since_repair
util_time_since_overhaul
DEFAULT
PROTECTION
SCOPE
Site preference.

As-Built Manager preferences

AsBuiltManagerColumnsShownPref

DESCRIPTION
Specifies the columns displayed in the As-Built structure table.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid BOM line property
and a valid As-Built BOM line property.
DEFAULT
VALUES
bl_indented_title
bl_item_object_type
phbl_part_used_is
phbl_part_usage_name
phnl_serial_number
phbl_lot_number
phbl_part_number
phbl_installation_time
phbl_mfg_date
phbl_mfgr_org_id
phbl_physical_quantitiy
phbl_physical_uid
bl_item_item_id
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-77


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

AsBuiltManagerShownColumnWidthsPref

DESCRIPTION
Specifies the column widths displayed in the As-Built structure 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 AsBuiltManagerShownColumnWidthsPref user preference, and so forth.
DEFAULT
VALUES
20
10
10
10
10
10
10
15
15
10
10
15
10
DEFAULT
PROTECTION
SCOPE
Site preference.

DefaultAsBuiltCompareProperties

DESCRIPTION
Specifies the default As-Built compare properties.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid BOM line property
and a valid As-Built BOM line property.
DEFAULT
VALUES
phbl_part_number
phbl_part_usage_name

DEFAULT
PROTECTION
SCOPE
Site preference.

24-78 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

AdditionalAsBuiltCompareProperties

DESCRIPTION
Specifies the default As-Built compare properties.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid BOM line property
and a valid As-Built BOM line property.
DEFAULT
VALUES
phbl_part_used_is
DEFAULT
PROTECTION
SCOPE
Site preference.

DefaultAsBuiltAccCheckProperties

DESCRIPTION
Specifies the default As-Built accountability check properties.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid BOM line property
and a valid As-Built BOM line property.
DEFAULT
VALUES
phbl_part_number
phbl_part_used_is
DEFAULT
PROTECTION
SCOPE
Site preference.

AdditionalAsBuiltAccCheckProperties

DESCRIPTION
Specifies the additional As-Built accountability check properties.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid BOM line property
and a valid As-Built BOM line property.
DEFAULT
VALUES
phbl_part_usage_name
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-79


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

Service Manager preferences

As-Maintained preferences

AdditionalAsMaintainedAccCheckProperties

DESCRIPTION
Specifies the additional as-maintained accountability check properties.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid BOM line property
and a valid as-maintained BOM line property.
DEFAULT
VALUES
phbl_part_usage_name
DEFAULT
PROTECTION
SCOPE
Site preference.

AdditionalAsMaintainedCompareProperties

DESCRIPTION
Specifies the default as-maintained compare properties.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid BOM line property
and a valid as-maintained BOM line property.
DEFAULT
VALUES
phbl_part_used_is
DEFAULT
PROTECTION
SCOPE
Site preference.

DefaultAsMaintainedAccCheckProperties

DESCRIPTION
Specifies the default as-maintained accountability check properties.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid neutral BOM line
property and a valid as-maintained BOM line property.
DEFAULT
VALUES
phbl_part_number
phbl_part_used_is

24-80 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

DefaultAsMaintainedCompareProperties

DESCRIPTION
Specifies the default as-maintained compare properties.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid neutral BOM line
property and a valid as-maintained BOM line property.
DEFAULT
VALUES
phbl_part_number
phbl_part_usage_name
DEFAULT
PROTECTION
SCOPE
Site preference.

Disposition_Propagate_To_Child

DESCRIPTION
Determines if the disposition defined during the generation or duplication of the
as-maintained structure is propagated to all of the children parts generated.
VALID
VALUES
One of any logical pairs (true or false, on or off, 0 or 1).
true Propagates the disposition to all child parts of the structure.
false Applies the disposition only to the top part of the structure.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

MroConfigRuleName

DESCRIPTION
Specifies the default configuration rule to use when opening as-maintained physical
part revisions. If this rule does not exist, the system defaults to Today Serviceable.
VALID
VALUES
Accepts a string as a value. Each string must be a valid as-maintained revision rule
name.

PLM00026 11.2 Preferences and Environment Variables Reference 24-81


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
Today Serviceable
DEFAULT
PROTECTION
SCOPE
Site preference.

MRODefaultLocations

DESCRIPTION
Specifies the default locations to use for the Generate As-Maintained Structure
and Un-Install Physical Part actions.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid location name
from the physical location object.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PhysicalLocation_CompanyLocation_default_relation

DESCRIPTION
Defines the default relationship between a company location and a physical location.
VALID
VALUES
Accepts one or more strings as a value. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
PhysicalLocationDetails
DEFAULT
PROTECTION
SCOPE
Site preference.

PhysicalLocationContainsColumnsShownPref

DESCRIPTION
Specifies the columns displayed in the Contains view when the selected component is
a physical location.
VALID
VALUES
Accepts one or more stings as values.

24-82 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
partNumber
serialNumber
lotNumber
manufacturerOrgId
manufacturingDate
DEFAULT
PROTECTION
SCOPE
Site preference.

PhysicalLocation_DefaultChildProperties

DESCRIPTION
Defines the default child properties for a physical location.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
property name.
DEFAULT
VALUES
IMAN_master_form
bom_view_tags
revision_list
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEView
IMAN_vi_sos
IMAN_external_object_link
PhysicalElementOwner
PhysicalLocationDetails

DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceManagerAssetGroupColumnsShownPref

DESCRIPTION
Specifies the list of columns displayed for an asset group in Service Manager in left
to right order.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid asset group
property.

PLM00026 11.2 Preferences and Environment Variables Reference 24-83


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
object_name
object_desc
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceManagerAssetGroupColumnWidthsPref

DESCRIPTION
Specifies the column widths displayed for an asset group in Service Manager in left
to right order.
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 ServiceManagerAssetGroupColumnsShownPref user preference and so forth.
DEFAULT
VALUES
20
20
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceManagerColumnsShownPref

DESCRIPTION
Specifies the columns displayed for physical parts opened in Service Manager in
left to right order.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid as-maintained
BOM line property.
DEFAULT
VALUES
bl_indented_title
bl_item_object_type
phbl_part_used_is
phbl_part_usage_name
phnl_serial_number
phbl_lot_number
phbl_part_number
phbl_installation_time
phbl_mfg_date
phbl_mfgr_org_id
phbl_physical_quantity

24-84 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

phbl_physical_uid
bl_item_item_id
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceManagerShownColumnWidthsPref

DESCRIPTION
Specifies the column widths displayed for physical parts in Service Manager in left
to right order.
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 ServiceManagerShownColumnWidthsPref user preference and so forth.
DEFAULT
VALUES
20
10
10
10
10
10
10
15
15
10
10
15
10
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceManagerPhysicalLocationColumnsShownPref

DESCRIPTION
Specifies the columns displayed for a physical location.
VALID
VALUES
Accepts one or more stings as values. Each string must be a valid as-maintained
BOM line property.
DEFAULT
VALUES
plbl_location_name
plbl_location_description
plbl_location_type

PLM00026 11.2 Preferences and Environment Variables Reference 24-85


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceManagerPhysicalLocationColumnWidthsPref

DESCRIPTION
Specifies the column widths displayed for the physical location in left to right order.
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
ServiceManagerPhysicalLocationColumnWidthsPref user preference and so forth.
DEFAULT
VALUES
20
20
20
DEFAULT
PROTECTION
SCOPE
Site preference.

Service event management preferences

ActivityCost.RENDERING

DESCRIPTION
Determines the registration of the viewer style sheet for activity cost objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ActivityCost
DEFAULT
PROTECTION
SCOPE
Site preference.

ActivityCost.SUMMARYRENDERING

DESCRIPTION
Determines the registration of the summary style sheet for activity cost objects.
VALID
VALUES
Accepts a single string as a value.

24-86 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
ActivityCostSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

ActivityEntryValue.MROCREATERENDERING

DESCRIPTION
Determines the registration of the create style sheet for activity entry value objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ActivityEntryValueCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

ActivityEntryValue.RENDERING

DESCRIPTION
Determines the registration of the viewer style sheet for activity entry value objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ActivityEntryValue
DEFAULT
PROTECTION
SCOPE
Site preference.

ActivityEntryValue.SUMMARYRENDERING

DESCRIPTION
Determines the registration of the summary style sheet for activity entry value objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ActivityEntryValueSummary

PLM00026 11.2 Preferences and Environment Variables Reference 24-87


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

FaultCode.MROCREATERENDERING

DESCRIPTION
Determines the registration of the create style sheet for fault code objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
FaultCodeCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

FaultCode.RENDERING

DESCRIPTION
Determines the registration of the viewer style sheet for fault code objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
FaultCode
DEFAULT
PROTECTION
SCOPE
Site preference.

FaultCode.SUMMARYRENDERING

DESCRIPTION
Determines the registration of the summary style sheet for fault code objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
FaultCodeSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

24-88 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

MRODefaultLogBook

DESCRIPTION
Determines the registration of the create style sheet for service discrepancy objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ServiceLogBook
DEFAULT
PROTECTION
SCOPE
Site preference.

PartMovement_DefaultChildProperties

DESCRIPTION
Defines the default child properties for part movement objects.
VALID
VALUES
Accepts multiple strings as values.
DEFAULT
VALUES
MovedPart
DEFAULT
PROTECTION
SCOPE
Site preference.

PartMovementDefaultRemoveLocation

DESCRIPTION
Determines the default physical location to use when you create a service event that
is related to a part movement.
VALID
VALUES
A valid physical location.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PartMovement.ENABLE_PROPERTIES_EDIT

DESCRIPTION
Allows edits to the part movement properties. To allow edits, set the value to false.

PLM00026 11.2 Preferences and Environment Variables Reference 24-89


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PartMovement.MROCREATERENDERING

DESCRIPTION
Determines the registration of the summary style sheet for part movement objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
PartMovementCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

PartMovement.RENDERING

DESCRIPTION
Determines the registration of the viewer style sheet for part movement objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
PartMovement
DEFAULT
PROTECTION
SCOPE
Site preference.

PartMovement.SUMMARYRENDERING

DESCRIPTION
Determines the registration of the summary style sheet for part movement objects.
VALID
VALUES
Accepts a single string as a value.

24-90 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
PartMovementSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceAction.RENDERING

DESCRIPTION
Determines the registration of the viewer style sheet for service action objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ServiceAction
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceAction.SUMMARYRENDERING

DESCRIPTION
Determines the registration of the summary style sheet for service action objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ServiceActionSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceDiscrepancy_DefaultChildProperties

DESCRIPTION
Defines the default child properties for service discrepancy objects.
VALID
VALUES
Accepts multiple strings as values.
DEFAULT
VALUES
CorrectiveAction
InProgress
fault_code

PLM00026 11.2 Preferences and Environment Variables Reference 24-91


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceDiscrepancy.ENABLE_PROPERTIES_EDIT

DESCRIPTION
Allows edits to the service discrepancy properties. To allow edits, set the value to true.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceDiscrepancy_FaultCode_default_relation

DESCRIPTION
Defines the relationship between a service discrepancy and a fault code.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
fault_code
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceDiscrepancy.MROCREATERENDERING

DESCRIPTION
Determines the registration of the create style sheet for service discrepancy objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ServiceDiscrepancyCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

24-92 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

ServiceDiscrepancy.RENDERING

DESCRIPTION
Determines the registration of the viewer style sheet for service discrepancy objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ServiceDiscrepancy
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceDiscrepancy_ServiceEvent_default_relation

DESCRIPTION
Defines the relationship between a service discrepancy and a service event.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
CorrectiveAction
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceDiscrepancy_ServiceGroup_default_relation

DESCRIPTION
Defines the relationship between a service discrepancy and a service group.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
InvalidRelation
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceDiscrepancy.SUMMARYRENDERING

DESCRIPTION
Determines the registration of the summary style sheet for service discrepancy objects.

PLM00026 11.2 Preferences and Environment Variables Reference 24-93


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ServiceDiscrepancySummary
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceEvent_DefaultChildProperties

DESCRIPTION
Defines the default child properties for service event objects.
VALID
VALUES
Accepts multiple strings as values.
DEFAULT
VALUES
Completed
InProgress
CorrectiveAction
HMSOStructure
activity_entry_value
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceEvent.ENABLE_PROPERTIES_EDIT

DESCRIPTION
Allows edits to the service event properties. To allow edits, set the value to true.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceEvent.MROCREATERENDERING

DESCRIPTION
Determines the registration of the create style sheet for service event objects.

24-94 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ServiceEventCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceEvent.RENDERING

DESCRIPTION
Determines the registration of the viewer style sheet for service event objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ServiceEvent
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceEvent.SUMMARYRENDERING

DESCRIPTION
Determines the registration of the summary style sheet for service event objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ServiceEventSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceGroup.ENABLE_PROPERTIES_EDIT

DESCRIPTION
Allows edits to the service group properties. To allow edits, set the value to true.
VALID
VALUES
Accepts a single string as a value.

PLM00026 11.2 Preferences and Environment Variables Reference 24-95


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceGroup.MROCREATERENDERING

DESCRIPTION
Determines the registration of the create style sheet for service group objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ServiceGroupCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceGroup.RENDERING

DESCRIPTION
Determines the registration of the viewer style sheet for service group objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ServiceGroup
DEFAULT
PROTECTION
SCOPE
Site preference.

ServiceGroup.SUMMARYRENDERING

DESCRIPTION
Determines the registration of the summary style sheet for service group objects.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
ServiceGroupSummary

24-96 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TransactionElement.COLUMNS_SHOW

DESCRIPTION
Determines which columns are displayed in the transaction element structure in left
to right order.
VALID
VALUES
Accepts multiple strings as values.
DEFAULT
VALUES
object_name
transaction_id
DEFAULT
PROTECTION
SCOPE
Site preference.

TransactionElement.COLUMNS_WIDTH

DESCRIPTION
Determines the widths for the columns displayed in the transaction element structure
in left to right order.
VALID
VALUES
Accepts multiple strings as values.
DEFAULT
VALUES
20
20
DEFAULT
PROTECTION
SCOPE
Site preference.

TransactionElement_DefaultChildProperties

DESCRIPTION
Defines the default child properties for transaction element objects.
VALID
VALUES
Accepts multiple strings as values.
DEFAULT
VALUES
InProgress
HWSOStructure

PLM00026 11.2 Preferences and Environment Variables Reference 24-97


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

TransactionElement_Document_default_relation

DESCRIPTION
Defines the relationship between a transaction element and a document.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
IMAN_reference
DEFAULT
PROTECTION
SCOPE
Site preference.

TransactionElement_DocumentRevision_default_relation

DESCRIPTION
Defines the relationship between a transaction element and a document revision.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
IMAN_reference
DEFAULT
PROTECTION
SCOPE
Site preference.

TransactionElement_PhysicalElement_default_relation

DESCRIPTION
Defines the relationship between a transaction element and a physical element.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
InProgress
DEFAULT
PROTECTION
SCOPE
Site preference.

24-98 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

TransactionElement_PhysicalElementRevision_default_relation

DESCRIPTION
Defines the relationship between a transaction element and a physical element
revision.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
InvalidRelation
DEFAULT
PROTECTION
SCOPE
Site preference.

Service Request Manager preferences


ActivityCost.MROCREATERENDERING

DESCRIPTION
Registers the create style sheet for an activity cost.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ActivityCostCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

ActivityCost_SRP0RqstActivityRevision.MROCREATERENDERING

DESCRIPTION
Registers the create style sheet for an activity cost that is created from a requested
activity.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ActivityCost_SRP0RqstActivityRevisionCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-99


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

ActivityCost_SRP0ServiceOffering.MROCREATERENDERING

DESCRIPTION
Registers the create style sheet for an activity cost that is created from a service
offering.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ActivityCost_SRP0ServiceOfferingCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

ActivityCost_SRP0ServiceRequest.MROCREATERENDERING

DESCRIPTION
Registers the create style sheet for an activity cost that is created from a service
request.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ActivityCost_SRP0ServiceRequestCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_SRP0DgSrvRequestRevision_displayed_pseudofolders

DESCRIPTION
Defines the list of pseudofolders and their corresponding relationships for a delegated
service request revision.
VALID
VALUES
Valid relations that display as pseudofolders for a delegated service request revision.
DEFAULT
VALUES
MROProductFolder/SRP0MROProduct
CMSolutionItems/CMHasSolutionItem
PerformsFolder/SRP0Performs
CustomerContactFolder/SRP0CustomerContact
LocationInCompanyFolder/LocationInCompany

24-100 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

CM_SRP0PrSrvRequestRevision_displayed_pseudofolders

DESCRIPTION
Defines the list of pseudofolders and their corresponding relations for a primary
service request revision.
VALID
VALUES
Valid relations that display as pseudofolders for a primary service request revision.
DEFAULT
VALUES
MROProductFolder/SRP0MROProduct
CMSolutionItems/CMHasSolutionItem
IncludesActivityFolder/SRP0IncludesActivity
PerformsFolder/SRP0Performs
DelegatesToFolder/SRP0DelgatesTo
CustomerContactFolder/SRP0CustomerContact
LocationInCompanyFolder/LocationInCompany
DEFAULT
PROTECTION
SCOPE
Site preference.

CM_SRP0RqstActivityRevision_displayed_pseudofolders

DESCRIPTION
Defines the list of pseudofolders and their corresponding relations for a requested
activity revision.
VALID
VALUES
Valid relations that display as pseudofolders for a requested activity revision.
DEFAULT
VALUES
MROProductFolder/SRP0MROProduct
CMImpactedItems/CMHasImpactedItem
CMProblemItems/CMHasProblemItem
CMSolutionItems/CMHasSolutionItem
ActivityDiscrepancyFolder/SRP0ActivityDiscrepancy
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-101


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

CompanyContact.MROCREATERENDERING

DESCRIPTION
Registers the create style sheet for a company contact.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0CompanyContactCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

CompanyLocation.MROCREATERENDERING

DESCRIPTION
Registers the create style sheet for a company location.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0CompanyLocationCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

SR_CHANGE_HOME_SITE_PREFERENCE

DESCRIPTION
Lists the system-defined saved searches currently located in the Request Home view.
Click the Manage Request Home saved searches button in the Request Home view
to manage the values of this site preference.
VALID
VALUES
The system-defined saved searches currently located in the Request Home view.
DEFAULT
VALUES
My Open Requests/1/My Open Requests/NO_QUERY_CRITERIA_OR_VALUE,
/NO_QUERY_CRITERIA_OR_VALUE,/NOT_SAVED_SEARCH/
DEFAULT
PROTECTION
SCOPE
Site preference.

24-102 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

SRP0DgSrvRequest.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for a delegated service request. The summary
style sheet is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0DgSrvRequestSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0DgSrvRequestRevision.MROCREATERENDERING

DESCRIPTION
Registers the create style sheet for a delegated service request revision.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0DgSrvRequestRevisionCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0DgSrvRequestRevision.RENDERING

DESCRIPTION
Registers the viewer style sheet for a delegated service request revision.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0DgSrvRequestRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-103


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

SRP0DgSrvRequestRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for a delegated service request revision. The
summary style sheet is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0DgSrvRequestRevisionSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0DgSrvRequestRevision_DefaultChildProperties

DESCRIPTION
Determines which properties are children of a delegated service request revision.
VALID
VALUES
A valid list of default child properties for a delegated service request revision.
DEFAULT
VALUES
MROProductFolder
CMHasSolutionItem
PerformsFolder
CustomerContactFolder
LocationInCompanyFolder
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0PrSrvRequest.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for a primary service request. The summary style
sheet is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0PrSrvRequestSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

24-104 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

SRP0PrSrvRequestRevision.MROCREATERENDERING

DESCRIPTION
Registers the create style sheet for a primary service request revision.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0PrSrvRequestRevisionCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0PrSrvRequestRevision.RENDERING

DESCRIPTION
Registers the viewer style sheet for a primary service request revision.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0PrSrvRequestRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0PrSrvRequestRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for a primary service request revision. The
summary style sheet is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0PrSrvRequestRevisionSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0PrSrvRequestRevision_DefaultChildProperties

DESCRIPTION
Determines which properties are children of a primary service request revision.

PLM00026 11.2 Preferences and Environment Variables Reference 24-105


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
A valid list of default child properties for a primary service request revision.
DEFAULT
VALUES
MROProductFolder
CMHasSolutionItem
IncludesActivityFolder
PerformsFolder
DelegatesToFolder
CustomerContactFolder
LocationInCompanyFolder
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0RequalifyRqstActivityRevision.MROCREATERENDERING

DESCRIPTION
Registers the create style sheet for a requalified requested activity revision.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0RequalifyRqstActivityRevisionCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0RqstActivity.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for a requested activity. The summary style sheet
is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0RqstActivitySummary
DEFAULT
PROTECTION
SCOPE
Site preference.

24-106 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

SRP0RqstActivityRevision.MROCREATERENDERING

DESCRIPTION
Registers the create style sheet for a requested activity revision.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0RqstActivityRevisionCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0RqstActivityRevision.RENDERING

DESCRIPTION
Registers the viewer style sheet for a requested activity revision.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0RqstActivityRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0RqstActivityRevision.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for a requested activity revision. The summary
style sheet is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0RqstActivityRevisionSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0RqstActivityRevision_DefaultChildProperties

DESCRIPTION
Determines which properties are children of a requested activity revision.

PLM00026 11.2 Preferences and Environment Variables Reference 24-107


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
A valid list of default child properties for a requested activity revision.
DEFAULT
VALUES
MROProductFolder
CMHasImpactedItem
CMHasProblemItem
CMHasSolutionItem
ActivityDiscrepancyFolder
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0RqstActivityRevision_ServiceDiscrepancy_default_relation

DESCRIPTION
Determines the default relation between a requested activity revision and a service
discrepancy.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
SRP0ActivityDiscrepancy
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceCatalog.MROCREATERENDERING

DESCRIPTION
Registers the create style sheet for a service catalog.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0ServiceCatalogCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceCatalog.RENDERING

DESCRIPTION
Registers the viewer style sheet for a service catalog.

24-108 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0ServiceCatalog
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceCatalog.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for a service catalog. The summary style sheet
is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0ServiceCatalogSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceCatalog_DefaultChildProperties

DESCRIPTION
Determines which properties are children of a service catalog.
VALID
VALUES
A valid list of default child properties for a service catalog.
DEFAULT
VALUES
SRP0ProductCatalog
HWSOStructure
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceCatalog_HWSOStructure_default_relation

DESCRIPTION
Determines the default relation between a service catalog and a hierarchical
workspace object.

PLM00026 11.2 Preferences and Environment Variables Reference 24-109


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

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

SRP0ServiceCatalog_PseudoFolder

DESCRIPTION
Defines the list of pseudofolders and their corresponding relations for a service catalog.
VALID
VALUES
Valid relations that will display as pseudofolders for a service catalog.
DEFAULT
VALUES
SRP0ProductCatalog
HWSOStructure
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceCatalog_SRP0ProductCatalog_default_relation

DESCRIPTION
Determines the default relation between a service catalog and a product catalog.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
SRP0ServiceCatalog
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceDiscrepancy.MROCREATERENDERING

DESCRIPTION
Registers the create style sheet for a service discrepancy.
VALID
VALUES
Any registered XML rendering style sheet.

24-110 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
SRP0ServiceDiscrepancyCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceOffering.MROCREATERENDERING

DESCRIPTION
Registers the create style sheet for a service offering.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0ServiceOfferingCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceOffering.RENDERING

DESCRIPTION
Registers the viewer style sheet for a service offering.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0ServiceOffering
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceOffering.SUMMARYRENDERING

DESCRIPTION
Registers the summary style sheet for a service offering. The summary style sheet
is used for the Summary tab.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
SRP0ServiceOfferingSummary

PLM00026 11.2 Preferences and Environment Variables Reference 24-111


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceOffering_ActivityCost_default_relation

DESCRIPTION
Determines the default relation between a service offering and an activity cost.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
ActivityCost
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceOffering_DefaultChildProperties

DESCRIPTION
Determines which properties are children of a service offering.
VALID
VALUES
A valid list of default child properties for a service offering.
DEFAULT
VALUES
SRP0ServiceOffering
HWSOStructure
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceOffering_HWSOStructure_default_relation

DESCRIPTION
Determines the default relation between a service offering and a hierarchical
workspace object.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
HWSOStructure

24-112 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceOffering_SRP0ServiceCatalog_default_relation

DESCRIPTION
Determines the default relation between a service offering and a service catalog.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Teamcenter object.
DEFAULT
VALUES
HWSOStructure
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0ServiceOfferingTable_ColumnPreferences

DESCRIPTION
Determines the service offering property names to appear as columns in the service
offering search results table.
VALID
VALUES
A valid property name of a service offering.
DEFAULT
VALUES
object_string
SRP0ServiceCode
SRP0ServiceOfferingNumber
SRP0Narrative
srp0ServiceCatalog
object_type
DEFAULT
PROTECTION
SCOPE
Site preference.

SRP0StatusViewColumnsShownPref

DESCRIPTION
Determines the list of the property names to appear as columns in the Service Request
Manager Status view.
VALID
VALUES
A valid property name from a primary or delegated service request or requested
activity to appear as a column in the Service Request Manager Status view.

PLM00026 11.2 Preferences and Environment Variables Reference 24-113


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
object_string
object_type
srp0ParentRequest
CMClosure
CMDisposition
CMMaturity
SRPoInitializationDate
SRP0NeededByDate
DEFAULT
PROTECTION
SCOPE
Site preference.

Service Scheduler preferences

PART_MOVEMENT_VALIDATION_ERROR

DESCRIPTION
Specifies whether to display an error or send an e-mail warning if a user attempts to
complete a job card or job task with a part movement that did not define a physical part.
VALID
VALUES
TRUE Displays an error if the part movement did not define a physical part.
FALSE Sends an e-mail to the current user with a warning that the part movement
did not define a physical part.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

SAS0_default_revision_rule_name

DESCRIPTION
Specifies the default configuration rule to be used when opening a service plan in the
Generate Maintenance Schedule dialog box. If this rule does not exist, the system
defaults to Latest Working.
VALID
VALUES
A valid configuration rule.
DEFAULT
VALUES
Any Status; Working

24-114 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SF_CANCEL_MA_EXTENSION_ROLE

DESCRIPTION
Specifies the role required to cancel a maintenance action.
VALID
VALUES
A valid role.
DEFAULT
VALUES
DBA
DEFAULT
PROTECTION
SCOPE
Site preference.

SF_DEFAULT_WF_TEMPLATE

DESCRIPTION
Specifies the workflow template to use when submitting a maintenance action for
approval to extend the due date.
VALID
VALUES
A valid workflow template name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

SSF0MaintActTableColumnsShownPref

DESCRIPTION
Defines the properties displayed in the columns of the Maintenance Action table in
the Generate Maintenance Schedule dialog box.
VALID
VALUES
Valid internal property names.
DEFAULT
VALUES
object_name
due_date
ssf0IsOverdue

PLM00026 11.2 Preferences and Environment Variables Reference 24-115


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

ssf0IsScheduled
transaction_note
ssf0AutoComplete
ssf0Asset
InProgress
CorrectiveAction
SSF0RequirementActions
SSF0ConfiguresServicePlan
DEFAULT
PROTECTION
SCOPE
User preference.

SSF0MaintActTableNumberMAsToDisplayPref

DESCRIPTION
Defines the number of maintenance actions displayed in each page in the
Maintenance Action table in the Generate Maintenance Schedule dialog box.
VALID
VALUES
Any positive integer.
DEFAULT
VALUES
50
DEFAULT
PROTECTION
SCOPE
User preference.

ServiceDiscrepancy_SSS0JobActivityRevision_default_relation

DESCRIPTION
Determines the default relation between a service discrepancy and a job activity
revision (job card or job task).
VALID
VALUES
CorrectiveAction
DEFAULT
VALUES
CorrectiveAction
DEFAULT
PROTECTION
SCOPE
Site preference.

24-116 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

Substance Compliance preferences


CMD_Response-Record_Object

DESCRIPTION
Defines the name of the business object that must be created to create a record when
the response type is CMD in the email polling functionality.
VALID
VALUES
Scp0EmailResponseRecord
DEFAULT
VALUES
Scp0EmailResponseRecord
DEFAULT
PROTECTION
SCOPE
Site preference.

CommercialPart Revision_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of a commercial part
revision node.
VALID
VALUES
Mat1UsesMaterial
Scp0PartToSubsCmplResult
Scp0SubsCmplDocs

DEFAULT
VALUES
Mat1UsesMaterial
Scp0PartToSubsCmplResult
Scp0SubsCmplDocs

DEFAULT
PROTECTION
SCOPE
User preference.

CommercialPart Revision_Mat1MaterialRevision_default_relation

DESCRIPTION
Specifies the default paste relation for a commercial part object with material revision.
VALID
VALUES
Mat1UsesMaterial
DEFAULT
VALUES
Mat1UsesMaterial

PLM00026 11.2 Preferences and Environment Variables Reference 24-117


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

CommercialPart Revision_Scp0SubstanceCmplResult_default_relation

DESCRIPTION
Specifies the default paste relation for a commercial part revision object with a
substance compliance result.
VALID
VALUES
specific_value_1
DEFAULT
VALUES
Scp0PartToSubsCmplResult
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_bomline_quantity_attrib_maps_to

DESCRIPTION
Defines the property of objects of type BOMLine to be used to map the unique attribute
supplied in the International Material Data System (IMDS) files.
VALID
VALUES
Internal name of the property.
DEFAULT
VALUES
bl_real_quantity
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_cancel_msd_request_xsl_name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert the substance
declaration cancel request TC XML file to an International Material Data System
(IMDS) XML file.
VALID
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/tcxml_to_imds_request.xsl
Windows: TC_DATA\tcsc_imds_integration\xsl\tcxml_to_imds_request.xsl
DEFAULT
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/tcxml_to_imds_request.xsl

24-118 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

Windows: TC_DATA\tcsc_imds_integration\xsl\tcxml_to_imds_request.xsl
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_cancel_subs_declaration_request_workflow

DESCRIPTION
Specifies the name of the workflow to be run when the substance declaration
cancellation request is called from the user interface.
VALID
VALUES
Cancel Substance Declaration Request
DEFAULT
VALUES
Cancel Substance Declaration Request
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_CC_file_type_xsl_name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert the International
Material Data System (IMDS) company information XML file to a TC XML file.
VALID
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/imds_company_tcxml.xsl
Windows: TC_DATA\tcsc_imds_integration\xsl\imds_company_tcxml.xsl
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_CMS_file_type_xsl_name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert the International
Material Data System (IMDS) CMS XML file to a TC XML file.
VALID
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/imds_cms_tcxml.xsl
Windows: TC_DATA\tcsc_imds_integration\xsl\imds_cms_tcxml.xsl

PLM00026 11.2 Preferences and Environment Variables Reference 24-119


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_daily_file_download_attempts_limit

DESCRIPTION
Specifies the maximum attempts allowed to download a particular file from the
International Material Data System (IMDS) server. The value is used by the
imds_download_file utility.
VALID
VALUES
Any positive integer.
DEFAULT
VALUES
5
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_download_client_path

DESCRIPTION
Specifies the location of the directory for the International Material Data System
(IMDS) download batch client. The value is used by the imds_download_file utility.
VALID
VALUES
Any single string value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_download_files_dir

DESCRIPTION
Specifies the location of the directory to be used to download daily files on the
Teamcenter server. The value is used by the imds_download_process_files utility.
VALID
VALUES
Any single string value.

24-120 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_download_utility_path

DESCRIPTION
Specifies the location of the directory on the Teamcenter server for the International
Material Data System (IMDS) download utility. The value is used by the
imds_download_process_files utility.
VALID
VALUES
UNIX: TC_BIN/imds_download_file
Windows: TC_BIN\imds_download_file.exe
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_file_done_dir

DESCRIPTION
Specifies the location of the directory to be used to move files that are
processed successfully on the Teamcenter server. The value is used by the
imds_download_process_files utility.
VALID
VALUES
Any single string value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_file_error_dir

DESCRIPTION
Specifies the location of the directory to be used to move files that are not
processed successfully on the Teamcenter server. The value is used by the
imds_download_process_files utility.

PLM00026 11.2 Preferences and Environment Variables Reference 24-121


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Any single string value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_file_module_separator

DESCRIPTION
Lists the module separators for specific International Material Data System (IMDS)
file types.

The values are used by the imds_split_file and imds_download_process_files


utilities. If no separator is provided for a specific file type, the utilities do not split
the particular file type.
VALID
VALUES
A valid value is the International Material Data System (IMDS) file type, a comma, and
the record identifier to be used as a separator. The IMDS Web site contains more
details about valid file types and record identifiers.
DEFAULT
VALUES
CMS,MC
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_file_process_dir

DESCRIPTION
Specifies the location of the directory to be used to move files for processing on the
Teamcenter server. The value is used by the imds_download_process_files utility.
VALID
VALUES
Any single string value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

24-122 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

IMDS_import_transfer_optionset

DESCRIPTION
Specifies the location of the directory to import the International Material Data System
(IMDS) files into Teamcenter. The value is used by the imds_download_process_files
utility.
VALID
VALUES
The value of the TransferOptionSet option in the PLM XML Import Export
Administration application.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_MCAll_file_type_xsl_name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert the International
Material Data System (IMDS) Material Classification (MC) XML file to a TC XML file.
VALID
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/imds_materialclassification_lov.xsl

Windows:
TC_DATA\tcsc_imds_integration\xsl\imds_materialclassification_lov.xsl
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_MDS_Create_Permitted_groups

DESCRIPTION
Specifies the groups that are allowed to create a material data sheet (MDS) in the
International Material Data System (IMDS).
VALID
VALUES
Any internal names of the groups.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 24-123


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_MDS_Create_Permitted_roles

DESCRIPTION
Specifies the roles that are allowed to create a material data sheet (MDS) in the
International Material Data System (IMDS).
VALID
VALUES
Any internal names of the roles.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_MDS_Internal_Release_Permitted_groups

DESCRIPTION
Specifies the groups that are allowed to internally release a material data sheet (MDS)
in the International Material Data System (IMDS).
VALID
VALUES
Any internal names of the groups.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_MDS_Internal_Release_Permitted_roles

DESCRIPTION
Specifies the roles that are allowed to internally release a material data sheet (MDS) in
the International Material Data System (IMDS).
VALID
VALUES
Any internal names of the roles.
DEFAULT
VALUES
None.

24-124 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_mds_part_send_unique_attrib_maps_to

DESCRIPTION
Defines the name of the attribute of the type IMDS_msd_part_object_name that
must be used to map the unique attribute provided in the International Material Data
System (IMDS) files.
VALID
VALUES
Any single string value.
DEFAULT
VALUES
item_id
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_MDS_Permitted_Actions_LOV

DESCRIPTION
Specifies the list of values (LOV) for permitted actions related to a material data sheet
(MDS) in the International Material Data System (IMDS).
VALID
VALUES
Any internal LOV name.
DEFAULT
VALUES
Sci0MDSPermittedActions
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_MDS_Propose_Permitted_groups

DESCRIPTION
Specifies the groups that are allowed to propose a material data sheet (MDS) in the
International Material Data System (IMDS).
VALID
VALUES
Any internal names of the groups.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 24-125


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_MDS_Propose_Permitted_roles

DESCRIPTION
Specifies the roles that are allowed to propose a material data sheet (MDS) to other
vendors in the International Material Data System (IMDS).
VALID
VALUES
Any internal names of the roles.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_MDS_Publish_Permitted_groups

DESCRIPTION
Specifies the groups that are allowed to publish a material data sheet (MDS) in
International Material Data System (IMDS).
VALID
VALUES
Any internal names of the groups.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_MDS_Publish_Permitted_roles

DESCRIPTION
Specifies the roles that are allowed to publish a material data sheet (MDS) in the
International Material Data System (IMDS).
VALID
VALUES
Any internal names of the roles.
DEFAULT
VALUES
None.

24-126 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_MDS_Review_Upload_XSL_Name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert TC XML files to
the International Material Data System (IMDS) review status upload XML file.
VALID
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/tcxml_to_imds_status_upload.xsl
Windows: TC_DATA\tcsc_imds_integration\xsl\tcxml_to_imds_status_upload.xsl
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_MDS_Send_Permitted_groups

DESCRIPTION
Specifies the groups that are allowed to send a material data sheet (MDS) to the
International Material Data System (IMDS).
VALID
VALUES
Any internal names of the groups.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_MDS_Send_Permitted_roles

DESCRIPTION
Specifies the roles that are allowed to send a material data sheet (MDS) to the
International Material Data System (IMDS).
VALID
VALUES
Any internal names of the roles.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 24-127


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Module_Create_Permitted_groups

DESCRIPTION
Specifies the groups that are allowed to create modules in the International Material
Data System (IMDS).
VALID
VALUES
Any internal names of the groups.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Module_Create_Permitted_roles

DESCRIPTION
Specifies the roles that are allowed to create modules in the International Material
Data System (IMDS).
VALID
VALUES
Any internal names of the roles.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Module_Permitted_Actions_LOV

DESCRIPTION
Specifies the list of values (LOV) for permitted actions related to a module in the
International Material Data System (IMDS).
VALID
VALUES
Any internal LOV name.
DEFAULT
VALUES
Sci0ModulePermittedActions

24-128 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Module_Publish_Permitted_roles

DESCRIPTION
Specifies the roles that are allowed to publish modules in the International Material
Data System (IMDS).
VALID
VALUES
Any internal names of the roles.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Module_Release_Internally_Permitted_groups

DESCRIPTION
Specifies the groups that are allowed to internally release modules in the International
Material Data System (IMDS).
VALID
VALUES
Any internal names of the groups.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Module_Release_Internally_Permitted_roles

DESCRIPTION
Specifies the roles that are allowed to internally release modules in the International
Material Data System (IMDS).
VALID
VALUES
Any internal names of the roles.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 24-129


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_msd_request_xsl_name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert an International
Material Data System (IMDS) result XML file to a TC XML file.
VALID
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/imds_result_to_tcxml.xsl
Windows: TC_DATA\tcsc_imds_integration\xsl\imds_result_to_tcxml.xsl
DEFAULT
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/imds_result_to_tcxml.xsl
Windows: TC_DATA\tcsc_imds_integration\xsl\imds_result_to_tcxml.xsl
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_NIAll_file_type_xsl_name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert the International
Material Data System (IMDS) Norm Institute (NI) XML file to a TC XML file.
VALID
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/imds_norminstitute_tcxml.xsl
Windows: TC_DATA\tcsc_imds_integration\xsl\imds_norminstitute_tcxml.xsl
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Own_Company_IDs

DESCRIPTION
Specifies the IDs of the owning company.
VALID
VALUES
Any integer.

24-130 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Own_Material_MDS_attrib_maps_to

DESCRIPTION
Defines the name of the material revision attribute that must be used to map the
standard material number supplied in the International Material Data System (IMDS)
files.
VALID
VALUES
Any single string value.
DEFAULT
VALUES
item_id
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Own_MDS_part_object_name

DESCRIPTION
Specifies the object class name used by the imds_download_process_files utility to
search for International Material Data System (IMDS) objects in Teamcenter.
VALID
VALUES
Any single string value.
DEFAULT
VALUES
ItemRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Own_MDS_part_unique_attrib_maps_to

DESCRIPTION
Defines the name of the attribute of the type IMDS_Own_MDS_part_object_name
that must be used to map the unique attribute provided in the International Material
Data System (IMDS) files.
VALID
VALUES
Any single string value.

PLM00026 11.2 Preferences and Environment Variables Reference 24-131


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
item_id
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_parameter_file

DESCRIPTION
Specifies the International Material Data System (IMDS) parameter file to be used by
the IMDS .dat file to XSL transformation utility.
VALID
VALUES
UNIX: TC_DATA/tcsc_imds_integration/configuration/imds_parameter_file.txt
Windows:
TC_DATA\tcsc_imds_integration\configuration\imds_parameter_file.txt
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_ppm_classification_IDs

DESCRIPTION
Specifies the IDs for polymeric parts making.
VALID
VALUES
Any single string value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_processing_allowed_file_types

DESCRIPTION
Specifies the valid International Material Data System (IMDS) file types that can be
processed by the International Material Data System (IMDS) .dat file to XML transform
utility.
VALID
VALUES
CMSAll

24-132 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

CCAll
SBAl
NIAll
SARAll
SAAll
SGAll
MCAll
CMSDaily
CCDaily
SBDaily
DEFAULT
VALUES
CMSAll
CCAll
SBAl
NIAll
SARAll
SAAll
SGAll
MCAll
CMSDaily
CCDaily
SBDaily
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Processing_Summary_Mail_Notifiers

DESCRIPTION
Specifies the additional e-mail IDs for a success or failure notification after the
International Material Data System (IMDS) file processing utility completes processing
the IMDS files. If no value is specified, only the user who initiated the processing utility
is notified with the success or failure message.
VALID
VALUES
Any valid e-mail ID.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-133


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

IMDS_Received_MDS_part_object_name

DESCRIPTION
Specifies the object class name used by the imds_download_process_files utility to
search for International Material Data System (IMDS) objects received in Teamcenter.
VALID
VALUES
Any single string value.
DEFAULT
VALUES
ManufacturerPart
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Received_MDS_part_unique_attrib_maps_to

DESCRIPTION
Defines the name of the attribute of the type
IMDS_Received_MDS_part_object_name that must be used to map the unique
attribute provided in the International Material Data System (IMDS) files.
VALID
VALUES
Any single string value.
DEFAULT
VALUES
item_id
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_result_email_xsl_name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert an International
Material Data System (IMDS) result XML file to an email to be sent to the vendor.
VALID
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/imds_result_to_email_content.xsl
Windows: TC_DATA\tcsc_imds_integration\xsl\imds_result_to_email_content.xsl
DEFAULT
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/imds_result_to_email_content.xsl
Windows: TC_DATA\tcsc_imds_integration\xsl\imds_result_to_email_content.xsl
DEFAULT
PROTECTION
SCOPE
Site preference.

24-134 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

IMDS_Result_File_Download_Client_Path

DESCRIPTION
Specifies the location of the directory containing the International Material Data System
(IMDS) download batch client. The value is used by the imds_process_result_file
utility.
VALID
VALUES
Any valid directory string.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Result_File_Download_Directory_Path

DESCRIPTION
Specifies the location of the final directory to be used to download the result files
from the International Material Data System (IMDS). The value is used by the
imds_process_result_file utility.
VALID
VALUES
Any valid directory string.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Result_File_Extract_Directory_Path

DESCRIPTION
Specifies the location of the final directory to be used to extract the result file from the
ZIP file generated by International Material Data System (IMDS) and downloaded by
the download utility. The value is used by the imds_process_result_file utility.
VALID
VALUES
Any valid directory string.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-135


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

IMDS_result_xsl_name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert the TC XML file
to an International Material Data System (IMDS) request XML file.
VALID
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/tcxml_to_imds_request.xsl
Windows: TC_DATA\tcsc_imds_integration\xsl\tcxml_to_imds_request.xsl
DEFAULT
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/tcxml_to_imds_request.xsl
Windows: TC_DATA\tcsc_imds_integration\xsl\tcxml_to_imds_request.xsl
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_SAAll_file_type_xsl_name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert the International
Material Data System (IMDS) Substance Application (SA) XML file to a TC XML file.
VALID
VALUES
UNIX:
TC_DATA/tcsc_imds_integration/xsl/imds_substanceapplicationcode_tcxml.xsl
Windows:
TC_DATA\tcsc_imds_integration\xsl\imds_substanceapplicationcode_tcxml.xsl
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_SARAll_file_type_xsl_name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert the International
Material Data System (IMDS) Substance Application Relation (SAR) XML file to a
TC XML file.
VALID
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/imds_substance_app_rel_tcxml.xsl
Windows:
TC_DATA\tcsc_imds_integration\xsl\imds_substance_app_rel_tcxml.xsl

24-136 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_SB_file_type_xsl_name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert the International
Material Data System (IMDS) Substance (SB) XML file to a TC XML file.
VALID
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/imds_substance_tcxml.xsl
Windows: TC_DATA\tcsc_imds_integration\xsl\imds_substance_tcxml.xsl
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Send_Mail_Done

DESCRIPTION
Sets up the International Material Data System (IMDS) result import process to e-mail
the process summary to specified users.
VALID
VALUES
true
false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
System preference.

IMDS_set_GADSL_flag_during_validation

DESCRIPTION
Indicates whether the Global Automotive Declarable Substance List (GADSL) flag
must be set to true when validating a material object in Teamcenter before uploading
the material to International Material Data System (IMDS).

PLM00026 11.2 Preferences and Environment Variables Reference 24-137


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
true
false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
System preference.

IMDS_SGAll_file_type_xsl_name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert the International
Material Data System (IMDS) Substance Group (SG) XML file to a TC XMLfile.
VALID
VALUES
UNIX:
TC_DATA/tcsc_imds_integration/xsl/imds_substancegroup_member_tcxml.xsl
Windows:
TC_DATA\tcsc_imds_integration\xsl\imds_substancegroup_member_tcxml.xsl
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_split_files_dir

DESCRIPTION
Specifies the location of the directory to be used to split files before processing on the
Teamcenter server. The value is used by the imds_download_process_files utility.
VALID
VALUES
Any single string value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

24-138 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

IMDS_split_utility_path

DESCRIPTION
Specifies the location of the directory on the Teamcenter server for the
International Material Data System (IMDS) split utility. The value is used by the
imds_download_process_files utility.
VALID
VALUES
UNIX: TC_BIN/imds_split_file
Windows: TC_BIN\imds_split_file.exe
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_SRAll_file_type_xsl_name

DESCRIPTION
Specifies the name and location of the XSL file to be used to convert the International
Material Data System (IMDS) Substance Replacement (SR) XML file to a TC XML file.
VALID
VALUES
UNIX: TC_DATA/tcsc_imds_integration/xsl/imds_substance_replacement.xsl
Windows: TC_DATA\tcsc_imds_integration\xsl\imds_substance_replacement.xsl
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_transform_dat_to_xml_utility_path

DESCRIPTION
Specifies the location of the directory on the Teamcenter server for the International
Material Data System (IMDS) .dat file to XML transform utility. The value is used by
the imds_download_process_files utility.
VALID
VALUES
UNIX: TC_BIN/imds_transform_dat_to_xml
Windows: TC_BIN\imds_transform_dat_to_xml.exe
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 24-139


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_upload_client_path

DESCRIPTION
Specifies the absolute path to send data to the International Material Data System
(IMDS) upload batch client.
VALID
VALUES
Any valid directory string.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_upload_files_dir

DESCRIPTION
Specifies the location of the directory on the Teamcenter server from where to upload
the International Material Data System (IMDS) files to the IMDS server.
VALID
VALUES
Any valid directory string.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_upload_xsl_name

DESCRIPTION
Specifies the location of the XSL file to be used to convert TC XML files to the
International Material Data System (IMDS) XML files.
VALID
VALUES
(UNIX): TC_DATA/tcsc_imds_integration/xsl/tcxml_to_imds.xsl
(Windows): TC_DATA\tcsc_imds_integration\xsl\tcxml_to_imds.xsl
DEFAULT
VALUES
None.

24-140 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_use_calculated_weight_as_measured_weight

DESCRIPTION
Indicates whether International Material Data System (IMDS) must use calculated
weight as measured weight for a Teamcenter object.
VALID
VALUES
true
false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
System preference.

IMDS_valid_download_file_types

DESCRIPTION
Specifies the International Material Data System (IMDS) file types to be used. The
value is used by the imds_download_process_files utility.
VALID
VALUES
See the IMDS Web site for details about valid values.
DEFAULT
VALUES
CCDaily
SBDaily
CMSDaily
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_validate_before_send_to_IMDS

DESCRIPTION
Indicates whether the data to be uploaded on International Material Data System
(IMDS) must be validated in Teamcenter before uploading it to IMDS.
VALID
VALUES
true
false

PLM00026 11.2 Preferences and Environment Variables Reference 24-141


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_validate_object_and_upload_to_imds_workflow

DESCRIPTION
Specifies the name of the workflow to be run, when the data to be uploaded on
International Material Data System (IMDS) must be validated in Teamcenter before
uploading it to IMDS.
VALID
VALUES
Validate Object and upload to IMDS
DEFAULT
VALUES
Validate Object and upload to IMDS
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_Upload_Vendor_Part_Selection_Criteria

DESCRIPTION
Specifies the selection criteria for the vendor part. Ensure to use the same value as
specified for the IMDS_Upload_Vendor_Part_Selection_Criteria variable defined in the
stylesheet by the IMDS_upload_xsl_name preference.
VALID
VALUES
0 Indicates a single vendor part with the status defined in the
IMDS_Uploadable_Vendor_Part_Status preference.
1 Indicates all preferred parts.
2 Indicates all vendor parts irrespective of their status.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

24-142 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

IMDS_Uploadable_Vendor_Part_Status

DESCRIPTION
Specifies the status of the vendor part. Ensure to use the same value as specified for
the IMDS_Uploadable_Vendor_Part_Status variable defined in the stylesheet by the
IMDS_upload_xsl_name preference.
VALID
VALUES
preferred
backup
DEFAULT
VALUES
preferred
DEFAULT
PROTECTION
SCOPE
Site preference.

IMDS_VP_Use_Revision

DESCRIPTION
Specifies the revision of the vendor part to be used to search the vendor part in
Teamcenter. The value is used by the imds_transform_dat_to_xml utility.
VALID
VALUES
0 Indicates that the first revision must be used.

1 Indicates that the latest revision must be used.


DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

Item.RENDERING

DESCRIPTION
Specifies the registration of a properties style sheet for Item objects when the
Substance Compliance International Material Data System (IMDS) Integration solution
is installed.
VALID
VALUES
Sci0Item
DEFAULT
VALUES
Sci0Item

PLM00026 11.2 Preferences and Environment Variables Reference 24-143


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

ItemRevision_Scp0SubstanceCmplResult_default_relation

DESCRIPTION
Specifies the default paste relation for an item revision object with a substance
compliance result.
VALID
VALUES
Scp0PartToSubsCmplResult
DEFAULT
VALUES
Scp0PartToSubsCmplResult
DEFAULT
PROTECTION
SCOPE
Site preference.

ItemRevision.SUMMARYRENDERING

DESCRIPTION
Specifies the registration of a summary style sheet for Mat1Material objects.
Substance Compliance overrides the base ItemRevision.SUMMARYRENDERING
preference setting value (BaseItemRevSummary style sheet) with the
Scp0ItemRevisionSummary style sheet, which has everything from the
BaseItemRevSummary style sheet plus a new page for materials and substance.
If the Substance Compliance IMDS Integration solution is installed, specifies the
registration of a summary style sheet for ItemRevision objects.
VALID
VALUES
Scp0ItemRevisionSummary
Sci0ItemRevisionSummary: If the Substance Compliance IMDS Integration solution
is installed.
DEFAULT
VALUES
Scp0ItemRevisionSummary
Sci0ItemRevisionSummary: If the Substance Compliance IMDS Integration solution
is installed.
DEFAULT
PROTECTION
SCOPE
User preference.

24-144 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

ManufacturerPart_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of a manufacturer
part node.
VALID
VALUES
Accepts one or more strings as values; each string must be a property of the
ManufacturerPart type.
DEFAULT
VALUES
IMAN_master_form
bom_view_tags
revision_list
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEView
IMAN_vi_sos
IMAN_external_object_link
TC_WorkContext_Relation
TC_AuditLog
vendors
commercialparts
TC_Quality_Document
ProvidedFrom
Mat1UsesMaterial
Scp0PartToSubsCmplResult
Scp0SubsCmplDocs

DEFAULT
PROTECTION
SCOPE
User preference.

ManufacturerPart_Mat1MaterialRevision_default_relation

DESCRIPTION
Specifies the default paste relation for a manufacturer part object with a material
revision.
VALID
VALUES
Mat1UsesMaterial
DEFAULT
VALUES
Mat1UsesMaterial
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-145


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

ManufacturerPart_Scp0AbstractDecl_default_relation

DESCRIPTION
Specifies the default paste relation for the manufacturer part object with material
substance declaration query.
VALID
VALUES
Scp0AbstractDeclResponse
DEFAULT
VALUES
Scp0AbstractDeclResponse
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPart_Scp0SubstanceCategory_default_relation

DESCRIPTION
Specifies the default paste relation for the manufacturer part object with substance
category.
VALID
VALUES
Scp0UsesSubstanceCategory
DEFAULT
VALUES
Scp0UsesSubstanceCategory
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPart_Scp0SupplierExemption_default_relation

DESCRIPTION
Specifies the default paste relation for the manufacturer part object with material
substance declaration exemption.
VALID
VALUES
Scp0UsesExemption
DEFAULT
VALUES
Scp0UsesExemption
DEFAULT
PROTECTION
SCOPE
Site preference.

24-146 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

ManufacturerPart Revision_Mat1MaterialRevision_default_relation

DESCRIPTION
Specifies the default paste relation for the material revision of a manufacturer part
revision object.
VALID
VALUES
Mat1UsesMaterial
DEFAULT
VALUES
Mat1UsesMaterial
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPart Revision_Scp0SubstanceCmplResult_default_relation

DESCRIPTION
Specifies the default paste relation for a manufacturer part revision object with a
substance compliance result.
VALID
VALUES
Scp0PartToSubsCmplResult
DEFAULT
VALUES
Scp0PartToSubsCmplResult
DEFAULT
PROTECTION
SCOPE
Site preference.

ManufacturerPart_Scp0SubstanceCmplResult_default_relation

DESCRIPTION
Specifies the default paste relation for a manufacturer part object with a substance
compliance result.
VALID
VALUES
Scp0PartToSubsCmplResult
DEFAULT
VALUES
Scp0PartToSubsCmplResult
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-147


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

Mat1Material.SUMMARYRENDERING

DESCRIPTION
Specifies the registration of a summary style sheet for Mat1Material objects.
VALID
VALUES
Scp0Mat1MaterialSummary
Sci0Mat1MaterialSummary: If the Substance Compliance IMDS Integration solution
is installed.
DEFAULT
VALUES
Scp0Mat1MaterialSummary
Sci0Mat1MaterialSummary: If the Substance Compliance IMDS Integration solution
is installed.
DEFAULT
PROTECTION
SCOPE
User preference.

MATERIALMGMT_material_creator_roles

DESCRIPTION
Specifies the roles that are allowed to create materials.
VALID
VALUES
Any valid internal role name.
DEFAULT
VALUES
IMAN_master_form
Materials Analyst
Compliance Officer
DEFAULT
PROTECTION
SCOPE
Site preference.

MSD_Response_Record_Object

DESCRIPTION
Defines the name of the business object that must be created to create a record when
the response type is MSD in the email polling functionality.
VALID
VALUES
Scp0EmailResponseRecord
DEFAULT
VALUES
Scp0EmailResponseRecord

24-148 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

Part Revision_Scp0SubstanceCmplResult_default_relation

DESCRIPTION
Specifies the default paste relation for a part revision object with a substance
compliance result.
VALID
VALUES
Scp0PartToSubsCmplResult
DEFAULT
VALUES
Scp0PartToSubsCmplResult
DEFAULT
PROTECTION
SCOPE
Site preference.

Scp0ApplyExemptForm.FORMJAVARENDERING

DESCRIPTION
Specifies the Java renderer to the review apply exemption form viewer pane.
VALID
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.ApplyExemptionsForm
DEFAULT
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.ApplyExemptionsForm
DEFAULT
PROTECTION
SCOPE
Site preference.

Scp0AprvSubsDeclForm.FORMJAVARENDERING

DESCRIPTION
Specifies the Java renderer to the review substance declaration form viewer pane.
VALID
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.
ReviewSubstanceDeclarationForm
DEFAULT
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.
ReviewSubstanceDeclarationForm

PLM00026 11.2 Preferences and Environment Variables Reference 24-149


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

Scp0ApplyExemptForm.JAVARENDERING

DESCRIPTION
Specifies the Java renderer to the review apply exemption form property pane.
VALID
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.ApplyExemptionsForm
DEFAULT
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.ApplyExemptionsForm
DEFAULT
PROTECTION
SCOPE
Site preference.

Scp0AprvSubsDeclForm.JAVARENDERING

DESCRIPTION
Specifies the Java renderer to the review material substance form viewer pane.
VALID
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.
ReviewSubstanceDeclarationForm
DEFAULT
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.
ReviewSubstanceDeclarationForm
DEFAULT
PROTECTION
SCOPE
Site preference.

Scp0CancelMSDReqForm.FORMJAVARENDERING

DESCRIPTION
Specifies the Java renderer for the cancel request material substance declaration
form viewer pane.
VALID
VALUES
Any valid ID.
DEFAULT
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.CancelMSDRequestForm

24-150 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

Scp0CancelMSDReqForm.JAVARENDERING

DESCRIPTION
Specifies the Java renderer for the cancel request material substance declaration
form property pane.
VALID
VALUES
Any valid ID.
DEFAULT
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.CancelMSDRequestForm
DEFAULT
PROTECTION
SCOPE
Site preference.

Scp0Exemption.SUMMARYRENDERING

DESCRIPTION
Specifies the registration of summary style sheet for Scp0Exemption objects.
VALID
VALUES
Scp0ExemptionSummary
DEFAULT
VALUES
Scp0ExemptionSummary
DEFAULT
PROTECTION
SCOPE
User preference.

Scp0ExemptionSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the Scp0ExemptionSummary summary style sheet
can be applied.
VALID
VALUES
Scp0Exemption
DEFAULT
VALUES
Scp0Exemption

PLM00026 11.2 Preferences and Environment Variables Reference 24-151


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

Scp0ItemRevisionSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the Scp0ItemRevisionSummary summary style sheet
can be applied.
VALID
VALUES
ItemRevision
DEFAULT
VALUES
ItemRevision
DEFAULT
PROTECTION
SCOPE
User preference.

Scp0ManufacturerPartSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the Scp0ManufacturerPartSummary summary style
sheet can be applied.
VALID
VALUES
ManufacturerPart
DEFAULT
VALUES
ManufacturerPart
DEFAULT
PROTECTION
SCOPE
User preference.

Scp0Mat1MaterialSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the Scp0Mat1MaterialSummary summary style sheet
can be applied.
VALID
VALUES
Mat1Material
DEFAULT
VALUES
Mat1Material

24-152 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
User preference.

Scp0Regulation.SUMMARYRENDERING

DESCRIPTION
Specifies the registration of the summary style sheet for Scp0Regulation objects.
VALID
VALUES
Scp0RegulationSummary
DEFAULT
VALUES
Scp0RegulationSummary
DEFAULT
PROTECTION
SCOPE
User preference.

Scp0RegulationSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the Scp0RegulationSummary summary style sheet
can be applied.
VALID
VALUES
Scp0Regulation
DEFAULT
VALUES
Scp0Regulation
DEFAULT
PROTECTION
SCOPE
User preference.

Scp0ReqSubsDeclForm.JAVARENDERING

DESCRIPTION
Specifies the Java renderer for the request material substance form property pane.
VALID
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.
SubstanceDeclarationRequestForm
DEFAULT
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.
SubstanceDeclarationRequestForm

PLM00026 11.2 Preferences and Environment Variables Reference 24-153


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

Scp0ReqSubsDeclForm.FORMJAVARENDERING

DESCRIPTION
Specifies the Java renderer for the request material substance form viewer pane.
VALID
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.
SubstanceDeclarationRequestForm
DEFAULT
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.
SubstanceDeclarationRequestForm
DEFAULT
PROTECTION
SCOPE
Site preference.

Scp0Smelter.SUMMARYRENDERING

DESCRIPTION
Specifies the registration of the summary style sheet for Scp0SmelterSummary
objects.
VALID
VALUES
Scp0Smelter
DEFAULT
VALUES
Scp0Smelter
DEFAULT
PROTECTION
SCOPE
User preference.

Scp0SmelterSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the Scp0SmelterSummary summary style sheet can be
applied.
VALID
VALUES
Scp0Smelter
DEFAULT
VALUES
Scp0Smelter

24-154 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
User preference.

Scp0SndToCmplChkForm.FORMJAVARENDERING

DESCRIPTION
Specifies the Java renderer to the send to compliance check form property pane.
VALID
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.
SendToComplianceCheckForm
DEFAULT
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.
SendToComplianceCheckForm
DEFAULT
PROTECTION
SCOPE
Site preference.

Scp0SndToCmplChkForm.JAVARENDERING

DESCRIPTION
Specifies the Java Renderer to the send to compliance check form property pane.
VALID
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.
SendToComplianceCheckForm
DEFAULT
VALUES
com.teamcenter.rac.subscmpl.commands.rendering.
SendToComplianceCheckForm
DEFAULT
PROTECTION
SCOPE
Site preference.

Scp0SubstanceCmplResult_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of a substance
compliance result node.
VALID
VALUES
Scp0SubsCmplToExemption
DEFAULT
VALUES
Scp0SubsCmplToExemption

PLM00026 11.2 Preferences and Environment Variables Reference 24-155


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

Scp0SubstanceCmplResult_Scp0Exemption_default_relation

DESCRIPTION
Specifies the default paste relation for a substance compliance result object with an
application exemption.
VALID
VALUES
Scp0SubsCmplToExemption
DEFAULT
VALUES
Scp0SubsCmplToExemption
DEFAULT
PROTECTION
SCOPE
Site preference.

Scp0SubstanceCmplResult.SUMMARYRENDERING

DESCRIPTION
Specifies the registration of summary style sheet for Scp0SubstanceCmplResult
objects.
VALID
VALUES
Scp0SubstanceCmplResultSummary
DEFAULT
VALUES
Scp0SubstanceCmplResultSummary
DEFAULT
PROTECTION
SCOPE
User preference.

Scp0SubstanceCmplResultSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the Scp0SubstanceCmplResultSummary summary
style sheet can be applied.
VALID
VALUES
Scp0SubstanceCmplResult
DEFAULT
VALUES
Scp0SubstanceCmplResult

24-156 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
User preference.

Scp0VendorSummary.SUMMARY_REGISTEREDTO

DESCRIPTION
Specifies the types to which the Scp0VendorSummary summary style sheet can be
applied.
VALID
VALUES
Vendor
DEFAULT
VALUES
Vendor
DEFAULT
PROTECTION
SCOPE
User preference.

SUBSCMPL_additional_notifiers

DESCRIPTION
Specifies the additional e-mail IDs for a success or failure notification after a substance
compliance check. If no value is specified, only the user who initiated the compliance
check is notified with the success or failure message.
VALID
VALUES
Any valid e-mail ID.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

SUBSCMPL_apply_exemption_workflow

DESCRIPTION
Specifies the name of the workflow to instantiate when an apply exemption action is
invoked from the user interface.
VALID
VALUES
Apply Exemptions
DEFAULT
VALUES
Apply Exemptions

PLM00026 11.2 Preferences and Environment Variables Reference 24-157


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_brand_image_dataset_name

DESCRIPTION
Specifies the dataset name that holds the brand image of the compliance check
provider shown on the substance compliance dashboard.
VALID
VALUES
A valid dataset name.
DEFAULT
VALUES
brandImage
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMP_cmd_allow_uncertified_smelters

DESCRIPTION
Indicates if uncertified smelters are allowed in Teamcenter. By default, only certified
smelters are allowed.
VALID
VALUES
true
false
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_cmd_always_send_blank

DESCRIPTION
Determines if a blank conflict mineral declaration (CMD) form in IPC XML 1755 format
must be sent to the suppliers on the first and subsequent CMD requests. By default, a
blank CMD form is sent on the first request, and the most recently received form is
sent on the subsequent requests.
VALID
VALUES
true
false

24-158 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_cmd_auto_request_on_msd_approve

DESCRIPTION
Specifies whether the conflict mineral declaration (CMD) request must be automatically
sent to the supplier when the compliance officer approves the material substance
declaration (MSD) that lists a conflict mineral. By default, the CMD request is sent
when the MSD listing a conflict mineral is approved.
VALID
VALUES
true
false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_cmd_default_excel_file

DESCRIPTION
Specifies the default IPC Microsoft excel file sent to the supplier on requesting for
a conflict mineral declaration.
VALID
VALUES
CFSI_CMRT3-02.xls
DEFAULT
VALUES
CFSI_CMRT3-02.xls
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_cmd_default_xml_file

DESCRIPTION
Specifies the default IPC XML file sent to the supplier on requesting for a conflict
mineral declaration.

PLM00026 11.2 Preferences and Environment Variables Reference 24-159


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
IPC_1755.xml
DEFAULT
VALUES
IPC_1755.xml
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_cmd_smelter_import_attributes

DESCRIPTION
Lists the smelter attributes that must be imported from the conflict mineral declaration
(CMD) form sent by the supplier.
VALID
VALUES
scp0Authority
scp0ContactName
scp0CMDComment
scp0CertificationValidUntil
scp0LinkToCnflictMnrlPolicy
scp0AuditedBy
scp0AuditedStatus
scp0Smltr100PercentRecycled
scp0SmltrProposedNextSteps
scp0IsKnown
scp0DUNSNumber
scp0NoUse
scp0SmelterLocation
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_cmd_smelter_unique_attrib_maps_to_xml

DESCRIPTION
Specifies the name of the smelter attribute that must be used to map the unique
attribute availble in the conflict mineral declaration received from the supplier.
VALID
VALUES
scp0identity
DEFAULT
VALUES
scp0identity

24-160 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_compliance_check_url

DESCRIPTION
Defines the URL to the server for a substance compliance check.
VALID
VALUES
A valid URL formatted as shown in the default value, where:

• TcIF_Server is replaced with a valid server name.

• TcIF_Server_Port is replaced with a valid port identifier.

DEFAULT
VALUES
POST http://TcIF_Server:TcIF_Server_Port/securityproxy/controller/publish?
publisher=test&type=complianceCheck&source_attr_name=sourceSid%5E%5EUID%5E%5EItemId%5E
%5ERevision%5E%5EType%5E%5Eregulations%5E%5EOwner%5E%5EOptionset%5E%5ETransfermode%5E
%5Erevrule%5E%5EsvruleUID%5E%5EprocessUnconfiguredByOccEff%5E%5EprocessSuppressedOcc%5E
%5EprocessUnconfiguredVariants%5E%5EprocessUnconfiguredChanges%5E%5ESSOUserID%5E
%5ESSOSessionKey%5E%5ENotifiers&source_attr_values=SOURCESID%5E%5EITEMUID%5E%5EITEMID%5E
%5EITEMREVISION%5E%5EITEMREVTYPE%5E%5EREGULATION%5E%5EOWNER%5E%5EOPTIONSET%5E
%5ETRANSFERMODE%5E%5EREVRULE%5E%5ESVRULEUID%5E%5EPROCESSUNCONFIGUREDBYOCCEFF%5E
%5EPROCESSSUPPRESSEDOCC%5E%5EPROCESSUNCONFIGUREDVARIANTS%5E%5EPROCESSUNCONFIGUREDCHANGES
%5E%5ESSOUSERID%5E%5ESSOSESSIONKEY%5E%5ENOTIFIERSLIST&output=xml HTTP/1.1\nConnection:
keep-Alive\nHost: TcIF_Server\nContent-Type: text/xml\nCache-Control:
no-cache\n\n

Note

Replace TcIF_Server and TcIF_Server_Port with appropriate values, and enter


the URL as a single line, with spaces as shown in the default value.

DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_compliance_server_host

DESCRIPTION
Specifies the host name of the server for a substance compliance check.
VALID
VALUES
Host string.
DEFAULT
VALUES
SUSBCMPL_SERVER
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-161


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

SUBSCMPL_compliance_server_port

DESCRIPTION
Specifies the port number of the server for a substance compliance check.
VALID
VALUES
Valid port number.
DEFAULT
VALUES
7001
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_confidential_material_accessor_groups

DESCRIPTION
Specifies the list of groups that are allowed to view the substances of the confidential
material.
VALID
VALUES
Valid values are the internal names of the groups.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_confidential_material_accessor_roles

DESCRIPTION
Specifies the list of roles that are allowed to view the substances of the confidential
material.
VALID
VALUES
Valid values are the internal names of the roles.
DEFAULT
VALUES
Compliance Officer
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_configured_export_optionset

DESCRIPTION
Specifies the default option for TC XML export of configured product structures.

24-162 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
The name of a transfer option set defined in the PLM XML/TC XML Export Import
Administration application.
DEFAULT
VALUES
ComplianceCheckConfiguredExportOptionSet
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_configured_export_transfermode

DESCRIPTION
Specifies the default transfer mode for TC XML export of configured product structures.
VALID
VALUES
The name of a transfer mode defined in the PLM XML/TC XML Export Import
Administration application.
DEFAULT
VALUES
TIEExportDefaultTM
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_decl_skipped_extensions

DESCRIPTION
Lists the extensions that are skipped while processing the supplier declarations in
Teamcenter.
VALID
VALUES
zip
DEFAULT
VALUES
zip
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_invalid_statuses_for_apply_exemption

DESCRIPTION
Specifies the invalid statuses of the compliance result for which exemptions are not
required.

PLM00026 11.2 Preferences and Environment Variables Reference 24-163


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Valid values are the internal values for the Scp0SubstanceComplianceStatus list of
values (LOV).
0 PASS
1 FAIL
2 Unapproved PASS
3 Unapproved FAIL
4 Approved PASS
5 Approved FAIL
6 Invalid
7 No Data
DEFAULT
VALUES
5
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_mail_approval_status

DESCRIPTION
Indicates whether an approval or rejection status for a specific material substance
declaration must be sent to the supplier in an email.
VALID
VALUES
true
false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_always_send_blank

DESCRIPTION
Specifies whether to:
• Send a blank IPC XML document to the vendor on the first and subsequent
requests.
Or

24-164 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

• Send a blank IPC XML document on the first request and send the most recently
declared IPC XML document on subsequent requests.
VALID
VALUES
true Send a blank IPC XML document to the vendor on the first and subsequent
requests.
false Send a blank IPC XML document on the first request and send the most
recently declared IPC XML document on subsequent requests.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_create_new_materials

DESCRIPTION
Specifies whether to create a new material in the Teamcenter database when no
matching material is found in the material substance declaration import.
VALID
VALUES
true Create a new material.
false Do not create a new material.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_create_new_substances

DESCRIPTION
Specifies whether to create a new substance in Teamcenter database when no
matching substance is found in the material substance declaration import.
VALID
VALUES
true Create a new substance.
false Do not create a new substance.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-165


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

SUBSCMPL_msd_default_pdf_file

DESCRIPTION
Specifies the default IPC PDF file name for a material substance declaration request.
The system searches for this file from the TC_DATA directory.
VALID
VALUES
Any valid file name with the .pdf file name extension.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_default_xml_file

DESCRIPTION
Specifies the default IPC XML file name for a material substance declaration request.
The system searches for this file from the TC_DATA directory.
VALID
VALUES
Any valid file name with the .xml file name extension.
DEFAULT
VALUES
IPC_1752-2v1.1.xml
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_done_dir

DESCRIPTION
Specifies the location of the final directory to which all the files are moved after
successful completion of material substance declaration import.
VALID
VALUES
Any valid directory string.
DEFAULT
VALUES
import-directory/done
DEFAULT
PROTECTION
SCOPE
Site preference.

24-166 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

SUBSCMPL_msd_error_dir

DESCRIPTION
Specifies the location of the final directory to which all the files are moved in case
of failure in processing a part.
VALID
VALUES
Any valid directory string.
DEFAULT
VALUES
import-directory/error
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_exchange_CO_user

DESCRIPTION
Specifies the user ID of the compliance officer to whom the reminders of the material
substance declaration (MSD) requests must be sent.
VALID
VALUES
Any valid user ID.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_MSD_expiry_duration

DESCRIPTION
Specifies the duration in days after which the material substance declaration (MSD)
provided by the supplier expires.
VALID
VALUES
Any integer.
DEFAULT
VALUES
180
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-167


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

SUBSCMPL_msd_file_naming_prefix

DESCRIPTION
Specifies the prefix to be used in the file names of the material substance declarations.
This prefix is used to search the given directory to choose the valid material substance
declaration files in the material substance declaration import.
For example, if the value is MSD, all files with MSD*.xml are selected from the given
directory.
VALID
VALUES
Any single string value that is a valid file name prefix.
DEFAULT
VALUES
IPC_
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_import_notifiers

DESCRIPTION
Specifies e-mail addresses for notification and sessions log to be sent at the end of
each material substance declaration import session.
VALID
VALUES
Any valid string value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_include_pdf

DESCRIPTION
Specifies whether a blank IPC PDF file must be sent to the vendors with the IPC XML
document as part of a material substance declaration request.
VALID
VALUES
true Send a blank PDF file.

false Do not send a blank PDF file.


DEFAULT
VALUES
false

24-168 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_incomplete_composition_limit

DESCRIPTION
Specifies the limit below which the incomplete composition of substances for a material
is not allowed in the material substance declaration import.
For example, if material P with mass 100g has substances S and T with masses 45g
each, the composition percentage becomes (45 +45)/100 = 90%.
If the limit value is specified to be 91, the given composition is not allowed, but for 85
or all values less than 90, the given composition is allowed.
The default value is 0, which indicates all partial disclosures are allowed.
VALID
VALUES
A single numeric value from 0 to 100.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_part_import_attributes

DESCRIPTION
Specifies the additional attributes on a part that need to be read from the input material
substance declaration file.
VALID
VALUES
scp0msdEffectiveDate
scp0SupplierAccepted
scp0LegalDeclType
scp0UncertainityState
scp0MSDInstanceID
scp0Attachments
DEFAULT
VALUES
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-169


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

SUBSCMPL_msd_part_unique_attrib_maps_to

DESCRIPTION
Specifies the name of the attribute of the vendor part that maps the unique attribute
supplied by the material substance declaration document.
VALID
VALUES
Any single string value.
DEFAULT
VALUES
object_name
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_partial_disclosure_limit

DESCRIPTION
Specifies the limit below which the material disclosure of the part is not allowed in the
material substance declaration import.
For example, if part P with mass 100g has materials M and N with masses 45g each,
the partial disclosure becomes (45 +45)/100 = 90%.
If the limit value is specified to be 91, the given disclosure is not allowed, but for 85
or all values less than 90, given disclosure is allowed.
The default value is 0, which indicates all partial disclosures are allowed.
VALID
VALUES
A single numeric value from 0 to 100.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_processing_dir

DESCRIPTION
Specifies the location of the processing directory to which all the files are first moved
before starting a material substance declaration import.
VALID
VALUES
Any valid directory string.
DEFAULT
VALUES
import-directory/processing

24-170 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_request_expiry_duration

DESCRIPTION
Specifies the duration in days after which the material substance declaration (MSD)
request sent to the supplier expires.
VALID
VALUES
Any integer.
DEFAULT
VALUES
30
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_supplier_part_id

DESCRIPTION
Specifies the name of the attribute of the vendor part that is mentioned in the e-mail
sent to the vendor.
VALID
VALUES
The name of the attribute of the vendor part.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_MSD_to_tcxml

DESCRIPTION
Specifies the XSL file to be used to import a material substance declaration (MSD).
VALID
VALUES
msd_to_tcxml.xsl
DEFAULT
VALUES
msd_to_tcxml.xsl

PLM00026 11.2 Preferences and Environment Variables Reference 24-171


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_use_unknown_material

DESCRIPTION
Specifies whether an unknown material is allowed to compensate for a material
declaration deficit for partial disclosure in the material substance declaration import.
VALID
VALUES
true An unknown material is allowed to compensate for a material declaration
deficit for partial disclosure in the material substance declaration import.
false An unknown material is not allowed to compensate for a material declaration
deficit for partial disclosure in the material substance declaration import.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_use_unknown_substance

DESCRIPTION
Specifies whether an unknown substance is allowed to compensate for a material
declaration deficit for incomplete composition in the material substance declaration
import.
VALID
VALUES
true An unknown substance is allowed to compensate for a material declaration
deficit for partial disclosure in the material substance declaration import.
false An unknown substance is not allowed to compensate for a material declaration
deficit for partial disclosure in the material substance declaration import.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_msd_vendor_unique_attrib_maps_to

DESCRIPTION
Specifies the name of the attribute of the vendor that maps the unique attribute
supplied by the material substance declaration document.

24-172 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
Any single string value.
DEFAULT
VALUES
object_name
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_notify_suppliers_validation_verdict

DESCRIPTION
Specifies whether the validation results must be sent to the suppliers when the
administrator completes the declaration validation task.
VALID
VALUES
Yes
No
DEFAULT
VALUES
Yes
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_part_material_mass_tolerance_lower

DESCRIPTION
Specifies the amount of deviation allowed in the part mass to be less than the
aggregated mass of the attached materials.
VALID
VALUES
Double
DEFAULT
VALUES
0.0000001
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_part_material_mass_tolerance_upper

DESCRIPTION
Specifies the amount of deviation allowed in the part mass to be greater than the
aggregated mass of the attached materials.

PLM00026 11.2 Preferences and Environment Variables Reference 24-173


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

VALID
VALUES
Double
DEFAULT
VALUES
0.0000001
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_provide_substance_name_in_failure_reason

DESCRIPTION
Specifies whether both the name of the substance and the Chemical Abstracts Service
(CAS) number must be provided in the failure reason available in the compliance
result in My Teamcenter.
VALID
VALUES
true
false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_provide_textual_failure_reason

DESCRIPTION
Specifies whether to allows text in place of exemption codes in the failure reason
of a compliance result.
VALID
VALUES
true
false

DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

24-174 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

SUBSCMPL_regulation_creator_groups

DESCRIPTION
Specifies the groups that are allowed to create regulations and exemptions.
VALID
VALUES
Valid values are the internal names of the groups.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_regulation_creator_roles

DESCRIPTION
Specifies the roles that are allowed to create regulations and exemptions.
VALID
VALUES
Valid values are the internal names of the roles.
DEFAULT
VALUES
Compliance Officer
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_regulation_separator

DESCRIPTION
Specifies the separator character to be used while sending the parts for a compliance
check against one or more regulations.
VALID
VALUES
$
DEFAULT
VALUES
$
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-175


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

SUBSCMPL_report_individual_validation_results

DESCRIPTION
Determines whether the validation results for each supplier declaration must be
emailed to the respective supplier. By default, the validation result is sent to the
supplier.
VALID
VALUES
true
false

DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_report_session_validation_results

DESCRIPTION
Determines whether the results a supplier declaration validation session must be
emailed to the administrator. By default, the validation result is sent to the administrator.
VALID
VALUES
true
false

DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_request_cmd_mode

DESCRIPTION
Specifies the conflict mineral declaration (CMD) request mode. The CMD can be
requested either in excel format or in IPC XML format. The default format is IPC XML.
VALID
VALUES
0 Microsoft Excel document is sent to the supplier.

1 IPC XML document is sent to the supplier.


DEFAULT
VALUES
1

24-176 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_request_msd_format

DESCRIPTION
Specifies the default IPC XML file format for the material substance declaration
requests.
VALID
VALUES
IPC_1752A IPC 1752A format XML document is sent to the vendors.
IPC_1752-2 IPC 1752-2 v1.1 format XML document is sent to the vendors.
DEFAULT
VALUES
IPC_1752A
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_request_msd_mode

DESCRIPTION
Specifies the format of the material substance declaration.
VALID
VALUES
0 Microsoft Excel
1 IPC XML
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_request_subs_declaration_workflow

DESCRIPTION
Specifies the name of the workflow to instantiate when a request substance declaration
action is invoked from the user interface.
VALID
VALUES
Request Substance Declaration
DEFAULT
VALUES
Request Substance Declaration

PLM00026 11.2 Preferences and Environment Variables Reference 24-177


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_review_cmd_declaration_workflow

DESCRIPTION
Specifies the name of the workflow to instantiate when a conflict mineral declaration is
created or imported to Teamcenter.
VALID
VALUES
Review Conflict Mineral Declaration
DEFAULT
VALUES
Review Conflict Mineral Declaration
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_review_subs_declaration_workflow

DESCRIPTION
Specifies the name of the workflow to instantiate when a substance declaration action
is created or imported to Teamcenter.
VALID
VALUES
Review Substance Declaration
DEFAULT
VALUES
Review Substance Declaration
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_send_materials_list

DESCRIPTION
Specifies whether to export the list of all material revision instances in Teamcenter
along with the material substance declaration request.
VALID
VALUES
true
false
DEFAULT
VALUES
true

24-178 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_send_msd_ind_import_log

DESCRIPTION
Enables the material substance declaration import process to e-mail the generated
individual log files to the designated individuals.
VALID
VALUES
true
false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

SUBSCMPL_send_msd_session_import_log

DESCRIPTION
Enables the material substance declaration import process to e-mail the generated
session log files to the designated individuals.
VALID
VALUES
true
false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

SUBSCMPL_statuses_for_failed_item

DESCRIPTION
Specifies the status of the compliance result for which an item can be marked as
Failed in the substance compliance Dashboard view.
VALID
VALUES
Valid values are the internal values for the Scp0SubstanceComplianceStatus list of
values (LOV).
0 PASS

PLM00026 11.2 Preferences and Environment Variables Reference 24-179


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

1 FAIL
2 Unapproved PASS
3 Unapproved FAIL
4 Approved PASS
5 Approved FAIL
6 Invalid
7 No Data
DEFAULT
VALUES
1
3
5
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_subs_declaration_auto_approve

DESCRIPTION
Specifies if the substance declaration for the items should be bypassed from the
approval process.
VALID
VALUES
true
false
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_substance_compliance_check_workflow

DESCRIPTION
Specifies the name of the workflow to instantiate when an action to initiate a substance
compliance check is invoked from the user interface.
VALID
VALUES
Initiate Substance Compliance Check
DEFAULT
VALUES
Initiate Substance Compliance Check

24-180 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_substance_composition_tolerance

DESCRIPTION
Specifies the value of the tolerance within which the substance composition must
be searched to find the closet matching material in the imported material substance
declaration.
VALID
VALUES
Double
DEFAULT
VALUES
0.0001
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_substance_name_display_length

DESCRIPTION
Specifies the length of the name of the substance to be displayed in the reason for
failure in a compliance result.
VALID
VALUES
Any integer
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_unconfigured_export_optionset

DESCRIPTION
Specifies the default option for TC XML export of unconfigured product structures.
VALID
VALUES
The name of a transfer option set defined in the PLM XML/TC XML Export Import
Administration application.
DEFAULT
VALUES
ComplianceCheckUnconfiguredExportOptionSet

PLM00026 11.2 Preferences and Environment Variables Reference 24-181


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_unconfigured_export_transfermode

DESCRIPTION
Specifies the default transfer mode for TC XML export of unconfigured product
structures.
VALID
VALUES
The name of a transfer mode defined in the PLM XML/TC XML Export Import
Administration application.
DEFAULT
VALUES
TIEExportDefaultTM
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_unknown_material_ext_id

DESCRIPTION
Specifies an external identifier of an unknown material used to compensate the partial
disclosure of the material substance declaration for a part.
VALID
VALUES
Any single string value.
DEFAULT
VALUES
UNKNOWN
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_unknown_material_name

DESCRIPTION
Specifies the name of an unknown material created to compensate the partial
disclosure of the material substance declaration for a part.
VALID
VALUES
Any single string value.
DEFAULT
VALUES
UNKNOWN

24-182 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_unknown_substance_cas

DESCRIPTION
Specifies the Chemical Abstracts Service (CAS) number of an UNKNOWN substance.
VALID
VALUES
The CAS number of an unknown substance.
DEFAULT
VALUES
0000-00-0
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_unknown_substance_ext_id

DESCRIPTION
Specifies the external identification of an UNKNOWN substance.
VALID
VALUES
The external identifier of an UNKNOWN substance.
DEFAULT
VALUES
0000-00-0
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_unknown_substance_tc_unique_id

DESCRIPTION
Specifies the Teamcenter unique identifier of an UNKNOWN substance.
VALID
VALUES
The Teamcenter unique identifier of an UNKNOWN substance.
DEFAULT
VALUES
0000-00-0
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-183


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

SUBSCMPL_unknown_substance_name

DESCRIPTION
Specifies the name of an UNKNOWN substance.
VALID
VALUES
The name of an unknown substance.
DEFAULT
VALUES
UNKNOWN
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_valid_statuses_for_apply_exemption

DESCRIPTION
Specifies the valid status of the compliance result for which exemptions can be applied.
VALID
VALUES
Valid values are the internal values for the Scp0SubstanceComplianceStatus list of
values (LOV).
0 PASS
1 FAIL
2 Unapproved PASS
3 Unapproved FAIL
4 Approved PASS
5 Approved FAIL
6 Invalid
7 No Data
DEFAULT
VALUES
2
3
DEFAULT
PROTECTION
SCOPE
Site preference.

SUBSCMPL_valid_statuses_with_exemptions

DESCRIPTION
Lists the valid status of the compliance result that can have exemptions.

24-184 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
Valid values are the internal values for the Scp0SubstanceComplianceStatus list of
values (LOV).
0 PASS
1 FAIL
2 Unapproved PASS
3 Unapproved FAIL
4 Approved PASS
5 Approved FAIL
6 Invalid
7 No Data
DEFAULT
VALUES
2
3
4
5
DEFAULT
PROTECTION
SCOPE
Site preference.

SubstanceCompliance_feature_installed

DESCRIPTION
Specifies whether the Substance Compliance application is installed. Do not modify
this preference manually.
VALID
VALUES
true
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
System preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-185


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

Specification Manager preferences

CPGFormulaMaterRevision_Cpm0SensoryEvaluation_default_relation

DESCRIPTION
Specifies the default relation between CPGFormulaMaterRevision and
Cpm0SensoryEvaluation.
VALID
VALUES
Cpm0Has_SensoryEvalAsIs
DEFAULT
VALUES
Cpm0Has_SensoryEvalAsIs
DEFAULT
PROTECTION
SCOPE
Site preference.

CPGFormulaMaterRevision_Cpm0Nutrient_default_relation

DESCRIPTION
Specifies the default relation between CPGFormulaMaterRevision and
Cpm0Nutrient.
VALID
VALUES
Cpm0Has_Nutrient
DEFAULT
VALUES
Cpm0Has_Nutrient
DEFAULT
PROTECTION
SCOPE
Site preference.

CPGFormulaMaterRevision_Cpm0Microbiological_default_relation

DESCRIPTION
Specifies the default relation between CPGFormulaMaterRevision and
Cpm0Microbiological.
VALID
VALUES
Cpm0Has_Microbiological
DEFAULT
VALUES
Cpm0Has_Microbiological
DEFAULT
PROTECTION
SCOPE
Site preference.

24-186 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

CPGFormulaMaterRevision_Cpm0ChemPhysAnal_default_relation

DESCRIPTION
Specifies the default relation between CPGFormulaMaterRevision and
Cpm0ChemPhysAnal.
VALID
VALUES
Cpm0Has_ChemPhysAsIs
DEFAULT
VALUES
Cpm0Has_ChemPhysAsIs
DEFAULT
PROTECTION
SCOPE
Site preference.

CPGFormulaMaterRevision_Cpm0Certification_default_relation

DESCRIPTION
Specifies the default relation between CPGFormulaMaterRevision and
Cpm0Certification.
VALID
VALUES
Cpm0Has_Certification
DEFAULT
VALUES
Cpm0Has_Certification
DEFAULT
PROTECTION
SCOPE
Site preference.

CPGFormulaMaterRevision_Cpm1Contaminant_default_relation

DESCRIPTION
Specifies the default relation between CPGFormulaMaterRevision and
Cpm1Contaminant.
VALID
VALUES
Cpm0Has_Contaminant
DEFAULT
VALUES
Cpm0Has_Contaminant
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-187


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

CPGFormulaMaterRevision_Cpm0Additive_default_relation

DESCRIPTION
Specifies the default relation between CPGFormulaMaterRevision and
Cpm0Additive.
VALID
VALUES
Cpm0Has_Additive
DEFAULT
VALUES
Cpm0Has_Additive
DEFAULT
PROTECTION
SCOPE
Site preference.

CPGFormulaMaterRevision_Cpm0FoodAllergen_default_relation

DESCRIPTION
Specifies the default relation between CPGFormulaMaterRevision and
Cpm0FoodAllergen.
VALID
VALUES
Cpm0Has_Allergen
DEFAULT
VALUES
Cpm0Has_Allergen
DEFAULT
PROTECTION
SCOPE
Site preference.

CPGFormulaMaterRevision_default_relation

DESCRIPTION
Specifies the default relation when CPGFormulaMaterRevision is associated with
any object.
VALID
VALUES
Cpm0Has_SpecData
DEFAULT
VALUES
Cpm0Has_SpecData
DEFAULT
PROTECTION
SCOPE
Site preference.

24-188 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

CPGFormulaMaterRevision_DefaultChildProperties

DESCRIPTION
Specifies the list of child properties of CPGFormulaMaterRevision.
VALID
VALUES
IMAN_reference
IMAN_UG_udf
IMAN_UG_altrep
IMAN_UG_scenario
IMAN_Simulation
IMAN_Rendering
IMAN_manifestation
IMAN_master_form_rev
TC_Generic_Architecture
structure_revisions
structure_revisions
IMAN_requirement
IMAN_Motion
IMAN_3D_snap_shot
view
release_status_list
IMAN_external_object_link
TC_WorkContext_Relation
representation_for
IMAN_MEWorkInstruction
TC_ProductManual
BOM_Rollup
TC_Is_Represented_By
TC_Attaches
TCEng_rdv_plmxml_configured
TCEng_rdv_plmxml_unconfigured
TC_sst_record
VisItemRevCreatedSnapshot2D
ProcessSimulate_Details
SimplifiedRendering
VisSession
VisMarkup
KinematicsRelation
Thumbnail_Source
Fnd0StruObjAttrOverride
Fnd0ListsParamReqments
Fnd0ListsCustomNotes
Cpm1Has_Allergens
Cpm1Has_Additives
Cpm1Has_AllergensAdditives
Cpm1Has_Acidity
Cpm1Has_Contaminant
Cpm1Has_Certification
Cpm1Has_RegionalAllergen

PLM00026 11.2 Preferences and Environment Variables Reference 24-189


Chapter
Chapter 24:24:Solution-specific
Solution-specific preferences
preferences

Cpm1Has_TreeNut
Cpm1Has_Body
Cpm1Has_Certification
Cpm1Has_ChemPhysAsIs
Cpm1Has_ChemPhysAsPrep
Cpm1Has_Finish
Cpm1Has_FlavorAndAroma
Cpm1Has_FoodSafetyOrganism
Cpm1Has_Microbiological
Cpm1Has_Nutrient
Cpm1Has_SensoryEvalAsIs
Cpm1Has_SensoryEvalAsPrep
Cpm1Has_SpecData

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CPSpecificationRevision_ColumnPreferences

DESCRIPTION
Specifies the columns to display for the specification revision object.
VALID
VALUES
Any valid property names of the specification revision object.
DEFAULT
VALUES
object_string
object_type
relation
owning_user
owning_group
last_mod_date
checked_out
release_status_list

DEFAULT
PROTECTION
SCOPE
Site preference.

CPSpecificationRevision_ColumnWidthPreferences

DESCRIPTION
Specifies the width of columns for the columns defined in the
CPSpecificationRevision_ColumnPreferences preference.

24-190 Preferences and Environment Variables Reference PLM00026 11.2


Solution-specific preferences

VALID
VALUES
Any valid positive integer value.
DEFAULT
VALUES
30
17
13
9
9
17
6
26

DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 24-191


Chapter 25: Integration preferences

NX Remote Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-1


AIE_overwrite_default_import_item_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-1
AIE_no_BVR_edit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-1
AIE_POST_EXPORT_SCRIPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-2
AIE_PRE_IMPORT_SCRIPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-3

Teamcenter Integration for AutoCAD preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-3


ACAD_COMPONENT_ONLY_MODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-3

Configuring CAE preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-4


CAE_always_remesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-4
CAE_ancestorMapping_level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-4
CAE_apply_partial_match . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-5
CAE_Apply_Reuse_Rules_to_SubAssemblies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-5
CAE_attribute_propagate_summary_dataset_name . . . . . . . . . . . . . . . . . . . . . . . . . . 25-6
CAE_batch_meshing_always_create_new . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-6
CAE_batch_meshing_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-7
CAE_batch_meshing_import_file_extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-7
CAE_batch_meshing_root_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-7
CAE_batch_meshing_tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-8
CAE_Config_Rule_Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-8
CAE_create_GeneratedByRelationship . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-9
CAE_datamap_files_location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-9
CAE_datamap_object_creation_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-10
CAE_default_batch_meshing_tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-10
CAE_derivation_log_content_scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-10
CAE_derivation_log_dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-11
CAE_derivative_rules_datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-11
CAE_derivative_rules_groupslist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-11
CAE_derivative_rules_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-12
CAE_derivative_rules_location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-12
CAE_derivative_rules_sitelist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-12
CAE_enable_AncestorMapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-13
CAE_enable_Mark_up_to_date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-13
CAE_input_geometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-14
CAE_Inspector_summary_dataset_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-14
CAE_meshing_params_criteria_source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-14
CAE_my_favorite_simulation_tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-15
CAE_my_simulation_tools_on_toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-15
CAE_package_template_site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-16
CAE_package_template_group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-16
CAE_package_template_user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-16
CAE_packages_create_subfolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-17

PLM00026 11.2 Preferences and Environment Variables Reference


CAE_packages_output_location_folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-17
CAE_persist_derivation_log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-17
CAE_persist_StructureMapLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-18
CAE_pre_processor_additional_output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-18
CAE_pre_processor_alternate_input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-18
CAE_pre_processor_primary_input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-19
CAE_pre_processor_primary_output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-19
CAE_pre_processor_startup_scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-19
CAE_pre_processor_tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-20
CAE_post_processor_additional_output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-20
CAE_post_processor_primary_input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-21
CAE_post_processor_primary_output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-21
CAE_post_processor_startup_scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-21
CAE_post_processor_tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-22
CAE_processlog_content_scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-22
CAE_Product_Structure_Default_Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-22
CAE_RevisionRule_Persist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-23
CAE_Root_BOMLineAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-24
CAE_Root_Item_Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-24
CAE_significant_relation_types_for_CAEAnalysis . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-24
CAE_significant_relation_types_for_CAEModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-25
CAE_simulation_data_monitor_config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-25
CAE_Simulation_Structure_Default_Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-25
CAE_simulation_tool_config_dsname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-26
CAE_solver_additional_output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-27
CAE_solver_startup_scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-27
CAE_solver_primary_input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-27
CAE_solver_primary_output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-28
CAE_solver_tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-28
CAE_startup_scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-28
CAE_structure_expansion_filter_rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-29
CAE_structureMap_log_dataset_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-29
CAE_tool_configuration_root . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-30
CAE_tool_configuration_unix_temp_location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-30
CAE_tool_configuration_windows_temp_location . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-30
CAE_Validate_StructureMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-31
CAELoadItemRevision Master_viewerprops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-31
CAEBCItemRevision Master_viewerprops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-32
CAEConnItemRevision Master_viewerprops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-32
CAEAnalysisRevision Master_viewerprops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-33
Item_Revision_type_name_CAEBomCompare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-34
MEMaxOpenViewsSameType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-34

Teamcenter Integration for NX I-deas preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-34


IDEAS_manager_library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-34
TC_SHOW_OPEN_IN_IDEAS_BUTTON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-35

Mentor Graphics Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-35


MGCItemRevision_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-35
MGCItemRevision_relations_as_folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-36

Preferences and Environment Variables Reference PLM00026 11.2


IMAN_MGC_Viewpoint_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-36
IMAN_MGC_Component_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-36
IMAN_MGC_Design_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-37

ERP Connect to SAP preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-37


TC_ERP_mapping_files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-37
ENABLE_ERP_integration_configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-38
MEDoNotUseSCTypeForColumns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-38
TC_ERP_current_schema_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-39
TC_SAP_alt_bomview_file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-40
TC_ERP_uom_mapping_file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-40
TC_ERP_rellog_file_path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-41
TC_SAP_cad_tables_path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-41
TC_SAP_sapcad_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-41
IMAN_SAP_sideinfo_file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-42
TC_ERP_dataset_types_to_transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-42

ODBC Driver preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-42


TC_ODBC_release_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-42

ClearCase Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-44


SCM_ClearCase_Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-44
SCM_ClearCase_UNCO_Keep_Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-44
SCM_CheckIn_Identical_Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-44

Linked Data Framework preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-45


LIS_RelatedLinkTabVisible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-45
TC_LDF_host_url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-45
LDF_FQDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-46

Behavior Modeling preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-46


Bhm0FilterEntriesForBehaviorModl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-46
Bhm0AdditionalData_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-46
Bmh0BehaviorModlRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . 25-47
Bhm0BehaviorModlRevision_show_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25-47

PLM00026 11.2 Preferences and Environment Variables Reference


Chapter 25: Integration preferences

NX Remote Manager preferences


AIE_overwrite_default_import_item_types

DESCRIPTION
Determines whether users importing non-NX files from a directory can choose from
among all the item types available to the data model service (DMS) or is restricted to
default item type defined by the system administrator.
VALID
VALUES
ON The user can choose from all item types listed in the DMS,
whether selecting new files to be imported or previously
exported files.
OFF The user cannot chose from any item type; the first item type
defined in the data model service is used as the default item
type. Previously exported files revert to their existing item type
and new files are imported using the default item type only.
DEFAULT
VALUES
OFF
DEFAULT
PROTECTION
SCOPE
User preference.

AIE_no_BVR_edit

DESCRIPTION
Determines whether a particular BOM view revision is changed during an NX Remote
Manager import operation from defined CAD system. If any dataset types defined
in this preference appears together with a dataset type registered with NX Remote
Manager (for example, with ACADDWG specifying AutoCAD Manager, or SE Part
specifying Specification Manager), then the BOM view revision is not changed during
the NX Remote Manager import.
VALID
VALUES
Accepts any or all of the dataset types defined by default by the system. This
preference is defined during NX Remote Manager installation.
DEFAULT
VALUES
UGPART
UGMASTER
UGALTREP

PLM00026 11.2 Preferences and Environment Variables Reference 25-1


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

UGSCENARIO
DEFAULT
PROTECTION
SCOPE
Site preference.

AIE_POST_EXPORT_SCRIPT

DESCRIPTION
Determines whether to execute a user-written script or program after exporting
registered datasets via your CAD integration. This allows you to perform custom
actions during the export phase (such as mapping attributes, or running utilities and
applications). On export, the CAD files and other associated files (based on your
configuration) are exported to the connection directory. The script is started after the
NX Remote Manager export with the IXF file name as argument.
The following is an example script run on Windows:
set XFILE_ARG=%1
echo ixf=%XFILE_ARG%
pause

The following is an example script run on UNIX:


#!/bin/ksh
export MY_ARGS=$1
echo $MY_ARGS >> /scratch/log/export_log
echo $PATH >> /scratch/log/export_log

If left unset, the system does not execute the script. If set with a value, the system will
attempt to run the script. The value must be the full path to the script.

Note

In case of access error (for example, the current user does not have the
privilege to execute the script, or the script is not available at the location
specified) or if the script returns a negative number, the errors will be logged.
The already completed export operation will not be undone or rolled back.

VALID
VALUES
Accepts a single string as a value. Must be the full qualified path to the script. The
path cannot contain spaces.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

25-2 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

AIE_PRE_IMPORT_SCRIPT

DESCRIPTION
Determines whether to execute a user-written script or program before importing
registered datasets via your CAD integration. This allows you to perform custom
actions during the import phase (such as mapping attributes, or running utilities and
applications). The CAD files and other associated files (based on your configuration)
are imported from the connection directory.
The following is an example script run on Windows:
set XFILE_ARG=%1
echo ixf=%XFILE_ARG%
pause

The following is an example script run on UNIX:


#!/bin/ksh
import MY_ARGS=$1
echo $MY_ARGS >> /scratch/log/import_log
echo $PATH >> /scratch/log/import_log

If left unset, the system does not execute the script. If set with a value, the system will
attempt to run the script. The value must be the full path to the script.
Note

In case of access error (for example, the current user does not have the
privilege to execute the script, or the script is not available at the location
specified) or if the script returns a negative number the import operation is
cancelled and no files will be imported.

VALID
VALUES
Accepts a single string as a value. Must be the full qualified path to the script. The
path cannot contain spaces.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Teamcenter Integration for AutoCAD preferences


ACAD_COMPONENT_ONLY_MODE

DESCRIPTION
Specifies whether to use component-only mode in open and save operations.

PLM00026 11.2 Preferences and Environment Variables Reference 25-3


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

VALID
VALUES
Accepts a single logical value.
TRUE
Specifies the following:
1. Cross-references are not downloaded in assembly download scenarios.

2. BOM information is ignored during any open or save operation.

FALSE
Specifies the following:
1. Cross-references are downloaded in assembly download scenarios.

2. BOM information is updated during save operations.

DEFAULT
VALUES
FALSE
DEFAULT
PROTECTION
SCOPE
Site preference.

Configuring CAE preferences


CAE_always_remesh

DESCRIPTION
Verifies that the CAE geometry is up-to-date and meshes it regardless of its meshing
status. This is an optional preference.
VALID
VALUES
True
False
DEFAULT
VALUES
False.
DEFAULT
PROTECTION
SCOPE
Site and user preference (optional).

CAE_ancestorMapping_level

DESCRIPTION
This is an optional preference. Specifies the maximum levels of ancestors to include in
an XML node during ancestor mapping in the CAE Manager application.

25-4 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

VALID
VALUES
Any integer starting with 0.
DEFAULT
VALUES
0 No levels are created in the XML node during ancestor mapping.
DEFAULT
PROTECTION
SCOPE
Site preference (optional).

CAE_apply_partial_match

DESCRIPTION
Restores the user choice if a user applies the attributes check for the partial match
criteria during a CAE BOM comparison.
VALID
VALUES
True
False
DEFAULT
VALUE
True
DEFAULT
PROTECTION
SCOPE
User preference.

CAE_Apply_Reuse_Rules_to_SubAssemblies

DESCRIPTION
Determines whether to apply reuse rules to subassemblies or only component level
product structures within a structure.
A reuse rule is a mechanism to reuse item revisions that are already associated with
an input item in an output structure, if it meets specific criteria. Simulation Process
Management applies reuse rules at the subassembly level as well as the component
level.
VALID
VALUES
• TRUE
• FALSE

DEFAULT
VALUE
TRUE
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 25-5


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

CAE_attribute_propagate_summary_dataset_name

DESCRIPTION
Specifies the name of the dataset in which the Attribute Propagate Summary is
saved as a named reference.

The attribute compare feature in CAE Manager is used to compare attribute values
between related instances of a model structure and a product structure and the analyst
can optionally propagate these changes. If an analyst runs an attribute compare and
chooses to propagate the results, these results are available in an HTML dataset. By
default, the name of the HTML dataset starts with Attribute Propagate Summary
depending on how you (as administrator) specify the name.
VALID
VALUES
A nonempty, multicharacter string not greater than 128 characters in length.

Note

This preference cannot have an empty value. If the value is left blank, the
default value is used.

DEFAULT
VALUE
Attribute Propagate Summary
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_batch_meshing_always_create_new

DESCRIPTION
Determines whether a new CAEModel item is created or an existing CAEModel item
is reused. This is an optional preference. If you set this preference to True, the system
performs a reuse check over the existing CAEModel item.
VALID
VALUES
True The system creates a new CAEModel item to contain the batch
meshing output.

False The system performs a reuse check over an existing CAEModel


item. If appropriate, it uses the CAEModel item to contain the
batch meshing output.
DEFAULT
VALUES
False.
DEFAULT
PROTECTION
SCOPE
Site and user preference (optional).

25-6 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

CAE_batch_meshing_attribute

DESCRIPTION
Defines the attribute values for the CAEModel item or item revision. This is an
optional preference.
VALID
VALUES
Accepts multiple string values in the following format:
tool-name::attribute::value
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site and user preference (optional).

CAE_batch_meshing_import_file_extensions

DESCRIPTION
Defines the file extensions for the output files imported in to Teamcenter as named
references for the CAEMesh dataset.

You can enter one or multiple output file extensions to define this preference.
When you enter multiple file extensions, ensure that you enter the file extensions
without spaces and insert a comma between them. For example, fem,sim. For this
preference, it is recommended that you add only one value for each batch meshing
tool. Adding multiple values does not result in an error; however, Teamcenter takes
only one value for the batch meshing feature.
VALID
VALUES
Accepts multiple string values in the following format:
tool-name::extension::dataset-type::reference-type::relation-type
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site and user preference (optional).

CAE_batch_meshing_root_dir

DESCRIPTION
Defines the root directory under which batch meshing is performed. For each batch
meshing job, the batch meshing interface creates a unique working directory under
this root directory. This keeps all files related to a specific batch meshing job separate
and easy to locate.

PLM00026 11.2 Preferences and Environment Variables Reference 25-7


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

VALID
VALUES
Valid directory to which server machine has read/write access.
DEFAULT
VALUES
Value of the TC_TMP_DIR environment variable. If this environment variable is not
set, the default value is C:\Temp on Windows, and /tmp on UNIX.
DEFAULT
PROTECTION
SCOPE
All.

CAE_batch_meshing_tools

DESCRIPTION
Defines the list of available batch meshing tools used with the
CAE-batch-meshing-handler handler to create CAE meshes from the
identified targets of a workflow process. Targets must be UGMASTER datasets.
The system uses the value specified for this preference to locate various components
required to run the tool. The system assumes a setup file exists in the TC_DATA
directory for each meshing tool defined in this preference, that each file name matches
a meshing tool defined, and that the file name ends with the .setup extension.
Each setup file must contain the OS path of the script to be run to execute the tool,
and the file name extension of the meshing results file that the tool creates.
The values defined in this preference determine the valid values of the
CAE_default_batch_meshing_tool preference.
VALID
VALUES
Accepts multiple strings as values; each string must be a valid batch meshing tool.
For example:
CAE_batch_meshing_tools=
a_batch_meshing_tool
another_batch_meshing_tool
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_Config_Rule_Name

DESCRIPTION
Stores the default revision rule names for both product and model views.
VALID
VALUES
• Revision rule for the Product view state.

25-8 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

• Revision rule for the Model view state.

DEFAULT
VALUE
None
DEFAULT
PROTECTION
SCOPE
User preference.

CAE_create_GeneratedByRelationship

DESCRIPTION
This is an optional preference. It allows an administrator to control whether a structure
map relationship is maintained between the root item revision of the created structure
and the defining structure map.

This option activates the creation of a CAE-specific relationship between the


CAEModel item revision (or any of its subtypes) and a referenced StructureMap
item revision where the CAEModel item revision is the primary contributor to the
relationship.

Note

This does not apply to creation of CAE structures using data maps.

VALID
VALUES
0 Structure map relationship is not maintained.
DEFAULT
VALUES
1 Structure map relationship is maintained by default.
DEFAULT
PROTECTION
SCOPE
Site preference (optional).

CAE_datamap_files_location

DESCRIPTION
Specifies the unique ID (UID) of the item revision used to manage the data map
definition files. The administrator must specify this preference for analysts to use data
map or structure map functions.
VALID
VALUES
Accepts one string as value; the string must be a valid Teamcenter object, where the
value is single object string, object is a UID value (for example, 34526).
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 25-9


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_datamap_object_creation_limit

DESCRIPTION
Sets the limit of objects that can be created in memory before committing the objects
to the database.
VALID
VALUES
Any integer.
DEFAULT
VALUE
5000
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_default_batch_meshing_tool

DESCRIPTION
Defines the default batch meshing tool used with the CAE-batch-meshing-handler
handler.
VALID
VALUES
Accepts a single string as a value. Must be a valid batch meshing tool, and defined in
the CAE_batch_meshing_tools preference. For example:
CAE_default_batch_meshing_tool=
a_batch_meshing_tool
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_derivation_log_content_scope

DESCRIPTION
Determines whether the derivation log is a detailed log or a summary log.
VALID
VALUES
Summary
Detailed
DEFAULT
VALUE
Summary

25-10 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

DEFAULT
PROTECTION
SCOPE
User preference.

CAE_derivation_log_dataset

DESCRIPTION
Specifies the name of the dataset in which the derivation log is saved as a named
reference.
VALID
VALUES
A single character string.
DEFAULT
VALUE
CAE Structure Derivation Summary Log
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_derivative_rules_datasets

DESCRIPTION
Contains the UIDs of the dataset with the derivative rule definition. The preference
value consists of the rule name followed by the dataset name.
Contains the list of derivative rule names and their corresponding dataset UIDs pairs
separated by a pipe (|). Pairs are separated by a semicolon (;).
VALID
VALUES
Accepts multiple strings as the value. You must provide strings in the
derivative_rule_name|dataset_name format. For example:
derivative_rule_name1|dataset_name1|derivative_rule_name2|dataset_name2
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_derivative_rules_groupslist

DESCRIPTION
Contains the list of group names for which derivative rules are created.
VALID
VALUES
Accepts multiple strings as the value. You must provide strings in the
derivative_rule_name|dataset_name format. For example:
derivative_rule_name1|dataset_name1|derivative_rule_name2|dataset_name2

PLM00026 11.2 Preferences and Environment Variables Reference 25-11


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Group preference.

CAE_derivative_rules_list

DESCRIPTION
Contains the list of derivative rule names defined at the user (analyst), site, and group
level.
VALID
VALUES
Accepts multiple strings as the value. You must provide strings in the
derivative_rule_name|dataset_name format. For example:
derivative_rule_name1|dataset_name1|derivative_rule_name2|dataset_name2
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
User preference.

CAE_derivative_rules_location

DESCRIPTION
Identifies the item revision used to manage the CAE Derivative Rules definition
dataset.
VALID
VALUES
Accepts a single object string as the value. You must provide a valid Teamcenter
object as the string. The object is a UID value, for example, 24693.
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_derivative_rules_sitelist

DESCRIPTION
Contains the list of derivative rule names defined at the site level.
VALID
VALUES
Accepts multiple strings as the value. You must provide the strings in the
user_name|user_rule_1;user_rule_2 format. For example:

25-12 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

user_name1|user_rule11;user_rule_12|user_name2|user_rule21;user_rule_22
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Group preference.

CAE_enable_AncestorMapping

DESCRIPTION
This is an optional preference. It enables ancestor mapping. This adds the node
XML interpretations of all the BOMline ancestors of BOMlines to structure maps in
the CAE Manager application.
VALID
VALUES
1 Ancestor mapping is enabled.
DEFAULT
VALUES
0 Ancestor mapping is not enabled.
DEFAULT
PROTECTION
SCOPE
Site preference (optional).

CAE_enable_Mark_up_to_date

DESCRIPTION
Enables or disables the Mark-Up-To-Date option for attachment changes to
CAEModel and CAEAnalysis item revisions in CAE Manager to improve performance
of data mapping rules against large structures.
In a complex product development environment, different analysts perform different
tasks of the overall analysis. In such scenarios, it becomes critical to know when
analysis data, possibly with multiple dependencies, is out-of-date. The analyst can
then act on it and ensure that the analysis is built with the correct set of data to
deliver accurate results. In CAE Manager, analysts can check for later revisions of
item revisions attached to CAEModel and CAEAnalysis item revisions. They can also
check for changes to any attachments of item revisions.
VALID
VALUES
• ON
• OFF
DEFAULT
VALUE
OFF
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 25-13


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

CAE_input_geometry

DESCRIPTION
Defines the dataset type that holds the input geometry required for the batch meshing
feature. For this preference, it is recommended that you add only one value for each
batch meshing tool. Adding multiple values does not result in an error; however,
Teamcenter takes only one value for the batch meshing feature. You can define a
primary or an alternate input geometry for each batch meshing tool. If the primary
input geometry is not defined for the dataset type, Teamcenter sequentially searches
for the alternate input geometry.
VALID
VALUES
Accepts multiple string values in the following format:
tool-name::dataset-type::reference-type
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site and user preference (optional).

CAE_Inspector_summary_dataset_name

DESCRIPTION
This is an optional preference. Specifies the name of the dataset in which the
Inspector Summary value will be saved as a named reference.
VALID
VALUES
A non-empty multi-character string not greater in 128 characters in length.
DEFAULT
VALUES
Inspector Summary
DEFAULT
PROTECTION
SCOPE
Site preference (optional).

CAE_meshing_params_criteria_source

DESCRIPTION
Defines the parameter and criteria files for each batch meshing tool. This is an optional
preference. You can add multiple values to this preference for each batch meshing tool.

Note

Teamcenter executes the batch meshing feature even if you leave this
preference undefined. The software uses the default values for the parameter
and criteria files from the batch meshing tool.

25-14 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

VALID
VALUES
Accepts multiple string values in the following format:
tool-name::item-id::revision-id::dataset-name::item-id::revision-id:
:dataset-name::UIDofFirstIR::UIDofSecondIR
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site and user preference (optional).

CAE_my_favorite_simulation_tools

DESCRIPTION
Defines simulation tools that the analyst can configure as favorite tools to appear
under the My Favorite Tools menu in CAE Manager.
VALID
VALUES
Accepts one or more strings as values. The string must correspond to a unique
simulation process. In case of duplicate processes, the analyst must enter the
complete name of the process with the inheritance using :: as a separator.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

CAE_my_simulation_tools_on_toolbar

DESCRIPTION
Defines simulation tools that the analyst can configure to appear in the CAE Manager
main toolbar.
VALID
VALUES
Accepts one or more strings as values. The string must correspond to a unique
simulation process. In case of duplicate processes, the analyst must enter the
complete name of the process with the inheritance using :: as a separator.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 25-15


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

CAE_package_template_site

DESCRIPTION
This is an optional preference. Identifies the item revision used to manage the
site-level CAE package definitions.
VALID
VALUES
None.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
System preference.

CAE_package_template_group

DESCRIPTION
This is an optional preference. Identifies the item revision used to manage the group
level CAE package definitions.
VALID
VALUES
None.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Group preference (optional).

CAE_package_template_user

DESCRIPTION
This is an optional preference. Identifies the item revision used to manage the group
level CAE package definitions.
VALID
VALUES
None.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
User preference (optional).

25-16 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

CAE_packages_create_subfolder

DESCRIPTION
Defines whether or not the output objects created by CAE packages are to be pasted
in a subfolder.
VALID
VALUES
• True

• False

DEFAULT
VALUE
False
DEFAULT
PROTECTION
SCOPE
User preference.

CAE_packages_output_location_folder

DESCRIPTION
Defines the location folder for the output objects created by CAE Packages.
VALID
VALUES
Accepts a single string as value; the string must be a valid Teamcenter folder name.
DEFAULT
VALUE
Newstuff (folder)
DEFAULT
PROTECTION
SCOPE
User preference.

CAE_persist_derivation_log

DESCRIPTION
Provides an option to persist the derivative process log in the database and link it to
the newly generated CAE structure or not persist the process log.
VALID
VALUES
True
False
DEFAULT
VALUE
False
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 25-17


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

CAE_persist_StructureMapLog

DESCRIPTION
Controls whether a log is attached as a dataset to the root item revision of the created
structure in a data map or a structure map.
Note

This is an optional preference.

VALID
VALUES
1 A log is attached as a dataset to the root item revision.
DEFAULT
VALUES
0 No log is attached as a dataset to the root item revision.
DEFAULT
PROTECTION
SCOPE
User.

CAE_pre_processor_additional_output

DESCRIPTION
Specifies a mapping of the preprocessor tool, dataset type, reference type, file
extension, and relation type. It provides values that represent the authoring tool
additional output for the preprocessor tool. You can use this preference to import the
additional output data generated by the preprocessor tool back in to Teamcenter.
VALID
VALUES
Accepts multiple string values in the following format:
tool-name::dataset-type::reference-type::file-extension::relation-type
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_pre_processor_alternate_input

DESCRIPTION
Specifies a mapping of the preprocessor tool, dataset type, and primary reference.
If a primary input is not defined for the preprocessor tools, this preference provides
values to describe the alternate input.
VALID
VALUES
Accepts multiple string values in the following format:
tool-name::alternate-dataset-type::reference-type

25-18 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_pre_processor_primary_input

DESCRIPTION
Specifies a mapping of the preprocessor tool, item type, and primary reference. It
provides values that represent the authoring tool primary input for the preprocessor
tool.
VALID
VALUES
Accepts multiple string values in the following format:
tool-name::item-type::reference-type
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_pre_processor_primary_output

DESCRIPTION
Specifies a mapping of the preprocessor tool, reference type, file extension, and
relation type. It provides values that represent the authoring tool primary output for
the preprocessor tool. You can use this preference to import the primary output data
generated by the preprocessor tool back in to Teamcenter.
VALID
VALUES
Accepts multiple string values in the following format:
tool-name::reference-type::file-extension::relation-type
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_pre_processor_startup_scripts

DESCRIPTION
Specifies a mapping of the preprocessor tool and startup script. It provides the physical
location of a startup script that launches the preprocessor tool.

PLM00026 11.2 Preferences and Environment Variables Reference 25-19


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

VALID
VALUES
Accepts multiple strings as values in the following format:
tool-name::startup-script
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site and user preference.

CAE_pre_processor_tools

DESCRIPTION
Specifies a list of preprocessor tools. Each value in the list represents a preprocessor
tool.
VALID
VALUES
Accepts multiple strings as values.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_post_processor_additional_output

DESCRIPTION
Specifies a mapping of the postprocessor tool, dataset type, reference type, file
extension, and relation type. It provides values that represent the authoring tool
additional output for the postprocessor tool. You can use this preference to import the
additional output data generated by the postprocessor tool back in to Teamcenter.
VALID
VALUES
Accepts multiple string values in the following format:
tool-name::dataset-type::reference-type::file-extension::relation-type
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

25-20 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

CAE_post_processor_primary_input

DESCRIPTION
Specifies a mapping of the postprocessor tool, item type, and primary reference. It
provides values that represent the authoring tool primary input for the postprocessor
tool.
VALID
VALUES
Accepts multiple string values in the following format:
tool-name::item-type::reference-type
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_post_processor_primary_output

DESCRIPTION
Specifies a mapping of the postprocessor tool, reference type, file extension, and
relation type. It provides values that represent the authoring tool primary output for
the postprocessor tool. You can use this preference to import the primary output data
generated by the postprocessor tool back in to Teamcenter.
VALID
VALUES
Accepts multiple string values in the following format:
tool-name::reference-type::file-extension::relation-type
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_post_processor_startup_scripts

DESCRIPTION
Specifies a mapping of the postprocessor tool and startup script. It provides the
physical location of a startup script that launches the postprocessor tool.
VALID
VALUES
Accepts multiple strings as values in the following format:
tool-name::startup-script
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 25-21


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site and user preference.

CAE_post_processor_tools

DESCRIPTION
Specifies a list of postprocessor tools. Each value in the list represents a postprocessor
tool.
VALID
VALUES
Accepts multiple strings as values.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_processlog_content_scope

DESCRIPTION
Persists summary level information or detailed level information in the dataset captured
by the structure map log. The structure map log is captured in a dataset (identified
by the CAE_structuremap_log_dataset_name preference) and attached to the
root item revision of the output structure.
VALID
VALUES
• 0 to persist summary level information in the dataset.
• 1 to persist detailed level information in the dataset.

DEFAULT
VALUE
0
DEFAULT
PROTECTION
SCOPE
User preference.

CAE_Product_Structure_Default_Actions

DESCRIPTION
This is an optional preference. Specifies the default actions for a criteria executed on
the product structure in the CAE Manager Inspector view. The format for the default
value is Criteria::DefaultAction.
VALID
VALUES
The Product With no Model criteria is used determine whether the product BOM line
is not linked to any CAEModel BOM line in the model structure.

25-22 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

The Missing Model Components criteria is used to determine whether the number
of BOM lines for a CAEModel item revision is less than the number of BOM lines of
the linked product item revision.
• Product With no Model::Do Nothing

• Product With no Model::Use New Model

• Product With no Model::Use Model Related to Product Item

• Product With no Model::Use Revised Model

• Missing Model Components::Do Nothing

• Missing Model Components::Use New Model

• Missing Model Components::Use Model Related to Product Item

• Missing Model Components::Use Revised Model

DEFAULT
VALUES
Product With Do nothing.
no Model:: Do
Nothing

Missing Model Do nothing.


Components::Do
nothing
DEFAULT
PROTECTION
SCOPE
Site preference (optional).

CAE_RevisionRule_Persist

DESCRIPTION
Stores the states of persist flags for both Product and Model views.
VALID
VALUES
• True or False for Product view state.

• True or False for Model view state.

DEFAULT
VALUE
False
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 25-23


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

CAE_Root_BOMLineAction

DESCRIPTION
This is an optional preference. Specifies the default actions for a criteria executed on
the root BOM line in the CAE Manager Inspector view.
VALID
VALUES
Update Updates the root BOM line.

Revise Revises the root BOM line.

New Creates a new root BOM line.


DEFAULT
VALUES
Update Updates the root BOM line.
DEFAULT
PROTECTION
SCOPE
Site preference (optional).

CAE_Root_Item_Type

DESCRIPTION
This is an optional preference. Specifies the item type that is created for a new model
action executed on a root BOM line in the CAE Manager Inspector view.
VALID
VALUES
Subtype of CAEModel.
DEFAULT
VALUES
CAEModel Creates a CAEModel item type when a new model action is
executed on a root BOM line in the CAE Manager Inspector
view.
DEFAULT
PROTECTION
SCOPE
Site preference (optional).

CAE_significant_relation_types_for_CAEAnalysis

DESCRIPTION
This is an optional preference. Defines significant relationship types for CAEAnalysis
item revisions and its subtypes. The system considers only those objects attached via
relation types configured in the above preference while performing Check for Later
Revision, Check for Attachment Change and Check for References.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid Teamcenter
relationship.

25-24 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

DEFAULT
VALUES
TC_CAE Target, TC_CAE_Include, TC_CAE_Defining, IMAN_Simulation, and
IMAN_Specification.
DEFAULT
PROTECTION
SCOPE
Site preference (optional).

CAE_significant_relation_types_for_CAEModel

DESCRIPTION
This is an optional preference. Defines significant relationship types for CAEModel
and its subtypes. The system considers only those objects attached via relation types
configured in the above preference while performing Check for Later Revision,
Check for Attachment Change, and Check for References.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid Teamcenter
relationship.
DEFAULT
VALUES
TC_CAE_Target, TC_CAE_Source, TC_CAE_Param, TC_CAE_Criteria,
IMAN_Simulation, or IMAN_specification.
DEFAULT
PROTECTION
SCOPE
Site preference (optional).

CAE_simulation_data_monitor_config

DESCRIPTION
Contains the unique identifier (UID) of the item revision which is configured to store the
simulation data map definition.
VALID
VALUES
Accepts one single object string as the value. You must provide a valid Teamcenter
object as the string. The object is a UID value of the item revision; for example, 34526.
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
User preference.

CAE_Simulation_Structure_Default_Actions

DESCRIPTION
This is an optional preference. Specifies the default actions for a criteria executed on
the simulation structure in the CAE Manager Inspector view.

PLM00026 11.2 Preferences and Environment Variables Reference 25-25


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

VALID
VALUES
This criteria is used to determine if the CAEModel BOM line is linked to a different
revision of the product BOM line.
• Model With Different Product Revision Target::Do Nothing

• Model With Different Product Revision Target::Use New Model

• Model With Different Product Revision Target::Use Model Related To Product


Item

• Model With Different Product Revision Target::Use Model Related to Product


Revision

• Model With Different Product Revision Target::Use Revised Model

• Model With Different Product Revision Target::Replace Relationship

• Model With Different Product Revision Target::Add Relationship

DEFAULT
VALUES
Model With Do nothing.
Different Product
Revision
Target::Do Nothing
Model With No Do nothing.
Product::Do
Nothing
Extra Model Do nothing.
Components::Do
Nothing
DEFAULT
PROTECTION
SCOPE
Site preference (optional).

CAE_simulation_tool_config_dsname

DESCRIPTION
Defines the dataset name where the simulation tool configuration is stored in XML
format as a named reference.
VALID
VALUES
Use the default value unless it violates any customer-defined business rules for dataset
names. Any unique value that meets the business rules for dataset names is valid.
DEFAULT
VALUES
TCCAESimToolConfig102009

25-26 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_solver_additional_output

DESCRIPTION
Specifies a mapping of the solver tool, dataset type, reference type, file extension,
and relation type. It provides values that represent the authoring tool additional output
for the solver tool. You can use this preference to import the additional output data
generated by the solver tool back in to Teamcenter.
VALID
VALUES
Accepts multiple string values in the following format:
tool-name::dataset-type::reference-type::file-extension::relation-type
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_solver_startup_scripts

DESCRIPTION
Specifies a mapping of the solver tool and startup script. It provides the physical
location of a startup script that launches the solver tool.
VALID
VALUES
Accepts multiple strings as values in the following format:
tool-name::startup-script
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site and user preference.

CAE_solver_primary_input

DESCRIPTION
Specifies a mapping of the solver tool, item type, and primary reference. It provides
values that represent the authoring tool primary input for the solver tool.
VALID
VALUES
Accepts multiple string values in the following format:
tool-name::item-type::reference-type

PLM00026 11.2 Preferences and Environment Variables Reference 25-27


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_solver_primary_output

DESCRIPTION
Specifies a mapping of the postprocessor tool, reference type, file extension, and
relation type. It provides values that represent the authoring tool primary output for the
solver tool. You can use this preference to import the primary output data generated
by the solver tool back in to Teamcenter.
VALID
VALUES
Accepts multiple string values in the following format:
tool-name::reference-type::file-extension::relation-type
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_solver_tools

DESCRIPTION
Specifies a list of solver tools. Each value in the list represents a solver tool.
VALID
VALUES
Accepts multiple strings as values.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_startup_scripts

DESCRIPTION
Specifies the location of the startup script for each batch meshing tool. For this
preference, it is recommended that you add only one value for each batch meshing
tool. Adding multiple values does not result in an error; however, Teamcenter takes
only one value for the batch meshing feature.

25-28 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

sample_batchmesher_script.bat, a sample startup script file, is provided in the


TC_DATA folder in your Teamcenter installation directory and is available only after
you install the product.
VALID
VALUES
Accepts multiple string values in the format:
tool-name::script-name
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site and user preference.

CAE_structure_expansion_filter_rules

DESCRIPTION
Defines all types of structure expansion rules that are available for analysts to perform
a CAE BOM comparison.
VALID
VALUES
Array of strings:
All Levels
First Level Only
Leaf Level Only
All Visible Levels
Lowest Visible Level Only

DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CAE_structureMap_log_dataset_name

DESCRIPTION
Specifies the name of the dataset to be created while executing the data map and
structure map to maintain the data map and structure map log file.
VALID
VALUES
Accepts one string as value; the string must be a valid Teamcenter object, where the
value is a single object string and the object is a dataset name.
DEFAULT
VALUES
StructureMap Summary Log

PLM00026 11.2 Preferences and Environment Variables Reference 25-29


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference (optional).

CAE_tool_configuration_root

DESCRIPTION
Contains the UID of item revisions, which are configured to identify the root directory
of simulation tools.
VALID
VALUES
Accepts one string as value; the string must be a valid Teamcenter object, where the
value is a single object string and the object is a dataset name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
System preference.

CAE_tool_configuration_unix_temp_location

DESCRIPTION
Defines the system temporary location used by Simulation Process Management
on UNIX systems.
VALID
VALUES
Accepts one string as value.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
System preference.

CAE_tool_configuration_windows_temp_location

DESCRIPTION
Defines the system temporary location used by Simulation Process Management on
Windows systems.
VALID
VALUES
Accepts one string as value.
DEFAULT
VALUES
None.

25-30 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

DEFAULT
PROTECTION
SCOPE
System preference.

CAE_Validate_StructureMap

DESCRIPTION
Specifies whether to perform an implicit validation of structure map rules.
VALID
VALUES
true or false
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

CAELoadItemRevision Master_viewerprops

DESCRIPTION
Determines how the properties of the CAELoadItemRevision Master form display.
This preference's values determine the order in which form properties display,
and whether the corresponding field displayed in the form is enabled/disabled, and
optional/mandatory.
VALID
VALUES
Accepts multiple line statements, in the following format:
property-name, O|M, E|D where O = Optional, M = Mandatory, E = Enabled, D =
Disabled. Each property-name entry must be a valid Teamcenter property.
DEFAULT
VALUES
CAELoadItemRevision Master_viewerprops=
load_id,O,E
load_desc,O,E
load_type,O,E
geometry,O,E
load_component_type,O,E
load_component_value,O,E
load_rev_id,O,D
load_rev_name,O,D
load_vault_mode,O,D
load_eint_form_type,O,D
load_link_path,O,D

PLM00026 11.2 Preferences and Environment Variables Reference 25-31


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

CAEBCItemRevision Master_viewerprops

DESCRIPTION
Determines how the properties of the CAEBCItemRevision Master form display.
This preference's values determine the order in which form properties display,
and whether the corresponding field displayed in the form is enabled/disabled, and
optional/mandatory.
VALID
VALUES
Accepts multiple line statements, in the following format:
property-name, O|M, E|D where O = Optional, M = Mandatory, E = Enabled, D =
Disabled. Each property-name entry must be a valid Teamcenter property.
DEFAULT
VALUES
CAEBCItemRevision Master_viewerprops=
bc_id,O,E
bc_desc,O,E
bc_type,O,E
geometry,O,E
constaint_type,O,E
coord_type,O,E
components,O,E
magnitude,O,E
bc_rev_id,O,D
bc_rev_name,O,D
bc_vault_mode,O,D
bc_eint_form_type,O,D
bc_link_path,O,D

DEFAULT
PROTECTION
SCOPE
Site preference.

CAEConnItemRevision Master_viewerprops

DESCRIPTION
Determines how the properties of the CAEConnItemRevision Master form display.
This preference's values determine the order in which form properties display,
and whether the corresponding field displayed in the form is enabled/disabled, and
optional/mandatory.
VALID
VALUES
Accepts multiple line statements, in the following format:

25-32 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

property-name, O|M, E|D where O = Optional, M = Mandatory, E = Enabled, D =


Disabled. Each property-name entry must be a valid Teamcenter property.
DEFAULT
VALUES
CAEConnItemRevision Master_viewerprops=
conn_id,O,E
conn_desc,O,E
conn_type,O,E
geometry,O,E
conn_links,O,E
strength,O,E
conn_rev_id,O,D
conn_rev_name,O,D

DEFAULT
PROTECTION
SCOPE
Site preference.

CAEAnalysisRevision Master_viewerprops

DESCRIPTION
Determines how the properties of the CAEAnalysisRevision Master form display.
This preference's values determine the order in which form properties display,
and whether the corresponding field displayed in the form is enabled/disabled, and
optional/mandatory.
VALID
VALUES
Accepts multiple line statements, in the following format:
property-name, O|M, E|D where O = Optional, M = Mandatory, E = Enabled, D =
Disabled. Each property-name entry must be a valid Teamcenter property.
DEFAULT
VALUES
CAEAnalysisRevision Master_viewerprops=
analysis_id,O,E
analysis_desc,O,E
analysis_type,O,E
analysis_rev_id,O,D
analysis_rev_name,O,D

DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 25-33


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

Item_Revision_type_name_CAEBomCompare

DESCRIPTION
Creates an item revision type name and a CAEBomCompare constant string for
each selected item revision type in the CAE BOM Comparison pane. It holds the
attribute names that analysts check for partial match conditions while performing a
CAE BOM comparison.
VALID
VALUES
Any attribute name that is available on the selected item revision type.
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
User, site, or group preference. It depends on the type of user who configures the
partial match conditions for a CAE BOM comparison.

MEMaxOpenViewsSameType

DESCRIPTION
Defines the maximum number of Model views that an analyst can open in CAE
Manager.
VALID
VALUES
Accepts a positive integer value.
DEFAULT
VALUE
10
DEFAULT
PROTECTION
SCOPE
Site preference.

Teamcenter Integration for NX I-deas preferences

IDEAS_manager_library

DESCRIPTION
Specifies the name of the Teamcenter Integration for NX I-deas server-side shared
library.
VALID
VALUES
Accepts a single string as a value. Must be a valid server-side shared library name.
DEFAULT
VALUES
None.

25-34 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

DEFAULT
PROTECTION
SCOPE
Group, role, or user preference.

TC_SHOW_OPEN_IN_IDEAS_BUTTON

DESCRIPTION
Specifies whether the Open in I-deas button is displayed on the Structure Manager
application toolbar.
VALID
VALUES
true Displays the Open in I-deas button is displayed on the Structure
Manager application toolbar.
false Does not display the Open in I-deas button is displayed on the
Structure Manager application toolbar.
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
Group, role, or user preference.

Mentor Graphics Integration preferences

MGCItemRevision_shown_relations

DESCRIPTION
Determines which item relations are shown for the MGCItemRevision type.
VALID
VALUES
PSBOMViewRevision
IMAN_master_form
IMAN_MGC_Design
IMAN_MGC_Component
IMAN_MGC_Viewpoint
Valid Item Relations
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 25-35


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

MGCItemRevision_relations_as_folders

DESCRIPTION
Determines which item relations are shown as folders for the MGCItemRevision type.
VALID
VALUES
PSBOMViewRevision
IMAN_master_form
IMAN_MGC_Design
IMAN_MGC_Component
IMAN_MGC_Viewpoint
Valid Item Relations
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMAN_MGC_Viewpoint_relation_primary

DESCRIPTION
Sets primary object types for the viewpoint 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
One or more strings as values; each string must be a valid Teamcenter object type.
DEFAULT
VALUES
None. The Item Revision setting must be uncommented.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMAN_MGC_Component_relation_primary

DESCRIPTION
Sets primary object types for the component relation.

25-36 Preferences and Environment Variables Reference PLM00026 11.2


Integration 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
One or more strings as values; each string must be a valid Teamcenter object type.
DEFAULT
VALUES
None. The Item Revision setting must be uncommented.
DEFAULT
PROTECTION
SCOPE
Site preference.

IMAN_MGC_Design_relation_primary

DESCRIPTION
Sets primary object types for the design 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
One or more strings as values; each string must be a valid Teamcenter object type.
DEFAULT
VALUES
None. The Item Revision setting must be uncommented.
DEFAULT
PROTECTION
SCOPE
Site preference.

ERP Connect to SAP preferences

TC_ERP_mapping_files

DESCRIPTION
Defines the mapping file used.

PLM00026 11.2 Preferences and Environment Variables Reference 25-37


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

More than one mapping file can be listed. This is especially useful for displaying old
form types. Used in this way the schema should have a different ID to avoid ambiguity
during workflow processes.
Note

If more than one mapping file is listed, the same Form Type cannot be listed
multiple times. This causes silent initialization errors.

VALID
VALUES
$TC_DATA/erp/sample_map_file.txt
DEFAULT
VALUES
DEFAULT
PROTECTION
SCOPE
Site preference.

ENABLE_ERP_integration_configuration

DESCRIPTION
Specifies whether ERP integration is enabled. If ERP integration is enabled, the
system checks/parses the mapping file and reports any error at logon.
If you are not using ERP integration, set the value to NO.
Note

If ENABLE_ERP_integration_configuration is set to YES, run the


generate_client_meta_cache utility usng the generate option. For example:
generate_client_meta_cache —u=infodba —p=infodba generate

VALID
VALUES
YES
NO
DEFAULT
VALUES
YES
DEFAULT
PROTECTION
SCOPE
Site preference.

MEDoNotUseSCTypeForColumns

DESCRIPTION
Specifies item revision business object types that have their own preferences to define
columns in the primary view of a structure context. Other business object types
displayed in the primary view of a structure context use structure context column
preferences.

25-38 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

In other words, when a structure context is opened in a BOM primary view in


Manufacturing Process Planner or Part Planner, a tree table displays the data. The
columns in this tree table are controlled by preferences. The preference names
can be prefixed by the structure context business object type or by the top line item
revision business object type. The default preference is the structure context type,
unless the type of the item revision appears in this preference, in which case, the item
revision preferences are used.
For example, if there is a structure context that is a MySC business object type and
the top line item revision is a MyItemRev business object type, the following occurs:
• If the MyItemRev type appears in the MEDoNotUseSCTypeForColumns
preference, the preferences that are used for the columns in the BOM tree table
are:
MyItemRevColumnsShownPref
MyItemRevDisplayNameColumnsShownPref
MyItemRevShownColumnWidthsPref

• If the MyItemRev type does not appear in the MEDoNotUseSCTypeForColumns


preference, the preferences that are used for the columns in the BOM tree table
are:
MySCColumnsShownPref
MySCDisplayNameColumnsShownPref
MySCShownColumnWidthsPref

VALID
VALUES
Subtypes of the ItemRevision business object.
DEFAULT
VALUES
MEGenericBOPRevision
MEProductBOPRevision
Mfg0MEPlantBOPRevision
Mes0MESTXLibraryRevision

DEFAULT
PROTECTION
SCOPE
Site preference.

TC_ERP_current_schema_name

DESCRIPTION
Defines the schema to be used and is referenced by the workflow handlers, for
example:
Default setting is SAP_R3

PLM00026 11.2 Preferences and Environment Variables Reference 25-39


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

Note

Only one schema can referenced. This is not a site preference; users can
specify a schema that is different from that used for the site. This is helpful
when testing the interface to a new version of the ERP system or possibly
transferring to a different ERP system.

VALID
VALUES
Accepts a single string as a value. Must be a valid schema name.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_SAP_alt_bomview_file

DESCRIPTION
Points to the directory containing the viewtype_mapping.dat file.
VALID
VALUES
Accepts a single string as a value. Must be the full path name of the directory.
DEFAULT
VALUES
$TC_DATA/erp/viewtype_mapping.dat
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_ERP_uom_mapping_file

DESCRIPTION
Points to the directory containing the uom_mapping.dat file.
VALID
VALUES
Accepts a single string as a value. Must be the full path name of the directory.
DEFAULT
VALUES
$TC_DATA/erp/uom_mapping.dat
DEFAULT
PROTECTION
SCOPE
Site preference.

25-40 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

TC_ERP_rellog_file_path

DESCRIPTION
Determines the directory to which the log file is written by the SAP upload program.
This file is imported to Teamcenter as the log file dataset attached to the process,
allowing users to view the file. This directory should be purged regularly.
VALID
VALUES
Accepts a single string as a value. Must be the full path name of the directory.
DEFAULT
VALUES
$TC_TMP_DIR
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_SAP_cad_tables_path

DESCRIPTION
Specifies the location of the SAP CAD table configuration files, as produced in setting
up the SAP CAD dialog interface.
VALID
VALUES
Accepts a single string as a value. Must be the full path name of the directory.
DEFAULT
VALUES
$TC_TMP_DIR
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_SAP_sapcad_dir

DESCRIPTION
Points to a directory containing the caddialog.ini configuration file.

Note

If individual users have their own logon to SAP, the preference points to the
user's home directory or wherever they store their caddialog.ini file.

VALID
VALUES
Accepts a single string as a value. Must be the full path name of the directory.
DEFAULT
VALUES
$TC_DATA/erp

PLM00026 11.2 Preferences and Environment Variables Reference 25-41


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

IMAN_SAP_sideinfo_file

DESCRIPTION
Points to the sideinfo communication file.
VALID
VALUES
Accepts a single string as a value. Must be the full path name and file name of the file.
DEFAULT
VALUES
$TC_DATA/erp/sideinfo
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_ERP_dataset_types_to_transfer

DESCRIPTION
Defines the dataset types to be transferred (using ERP document transfer) and the
associated file format (named reference type).
For example:
TC_ERP_dataset_types_to_transfer=
UGMASTER/Shaded-Image
UGPART/Shaded-Image
Text/TXT
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
UGMASTER/Shaded-Image
UGPART/Shaded-Image
Text/TXT
DEFAULT
PROTECTION
SCOPE
Site preference.

ODBC Driver preferences


TC_ODBC_release_status

DESCRIPTION
This file can be found in the /vobs/src/tc/data/teamcenter_env_wnt.default directory.

25-42 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

This is a file that the tc_preferences.xml preference file links to for a Windows-only
application. Before starting the application, set the option to ALL or LATEST to retrieve
either all the release statuses or the latest release status in the list, respectively.
There is a new preference file in the \vobs\src\tc\data_odbc_exclude_tcbomlist
directory. Before starting the application, move the columns you do not want to see in
the BOM table in this file. The format of the file is as follows:
EXCLUDED_LIST_START
bl_formatted_title
bl_indended_title
#bl_line_name
#bl_config_string
#bl_variant_state

Each line contains the name of a column (a BOM property). Remove the comment
symbol (#) to add the name. Add the query criteria Parent_Item_Rev_Id like xxx
after specifying the Parent_Item_Id criteria, using the standard query interface in
the application.
The WhereUsed table in the table list, has six column attributes for a user to report.
The columns are:
Child_Item_Id
Child_Item_Rev_Id
level_of_search
item_id
item_rev_id
object_name
Add Child_Item_Id criteria and after that, add Child_Item_Rev_Id criteria, using the
standard query interface in the application.
VALID
VALUES
ALL
Outputs all in the release status list.
LATEST
Outputs the latest one in the release status list.
DEFAULT
VALUES
LATEST
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 25-43


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

ClearCase Integration preferences

SCM_ClearCase_Server

DESCRIPTION
Establishes and verifies the connection with the ClearCase server. Populate this
preference during the integration server installation. Add all the ClearCase servers you
want to configure with Teamcenter to this preference.
VALID
VALUES
Accepts multiple string values. Must be the address of the ClearCase server.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

SCM_ClearCase_UNCO_Keep_Version

DESCRIPTION
Determines whether .keep files are preserved in ClearCase when users use the
uncheckout command.
VALID
VALUES
true Any .keep files are preserved in ClearCase when users use the
uncheckout command.
false Any .keep files are not preserved in ClearCase when users
use the uncheckout command.
DEFAULT
VALUES
true
DEFAULT
PROTECTION
SCOPE
User preference.

SCM_CheckIn_Identical_Version

DESCRIPTION
Determines whether Teamcenter invokes the SCM checkin command when the
checkedout version is identical to the previous version of the element.
VALID
VALUES
False Teamcenter does not invoke the SCM checkin command and
instead invokes the SCM command to cancel the checkedout
version.

25-44 Preferences and Environment Variables Reference PLM00026 11.2


Integration preferences

True Teamcenter invokes the SCM checkin command which checks


in the element, provided the SCM environment rules allow
checkin of identical versions. It should be set to true only if there
is no Clearcase trigger set which would stop the operation.
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

Linked Data Framework preferences


LIS_RelatedLinkTabVisible

DESCRIPTION
Specifies if the Related Links tab is visible.
The Related Links tab shows resources from a third-party tool.
VALID
VALUES
TRUE The Related Links tab is visible.
FALSE The Related Links tab is not visible.
DEFAULT
VALUES
TRUE
DEFAULT
PROTECTION
SCOPE
User preference.

TC_LDF_host_url

DESCRIPTION

Note

This preference is not available by default. You must create it during Linked
Data Framework configuration.

Specifies the local Linked Data Framework host, which is the location where lis.war is
deployed. This preference is required for backlink creation.
VALID
VALUES
URL that points to the location where lis.war is deployed, for example,
http://pni6w2072.net.plm.eds.com:7001/lis.
DEFAULT
VALUES
None.

PLM00026 11.2 Preferences and Environment Variables Reference 25-45


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

LDF_FQDN

DESCRIPTION

Note

This preference is not available by default. You must create it during Linked
Data Framework configuration.

Specifies the fully qualified domain name of the machine where Linked Data
Framework is deployed. This preference is used by the Linked Data Framework server
to create Linked Data Framework URLs.
VALID
VALUES
Fully qualified domain name of the machine where Linked Data Framework is
deployed, for example, .net.plm.eds.com.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

Behavior Modeling preferences


Bhm0FilterEntriesForBehaviorModl

DESCRIPTION
Specifies the list of library types displayed in the Behavior Modeling application.
VALID
VALUES
Internal names of library type.
DEFAULT
VALUES
Bhm0BehaviorModel
DEFAULT
PROTECTION
SCOPE
Site preference.

Bhm0AdditionalData_relation_primary

DESCRIPTION
Defines primary relation objects for the additional data relation (Bhm0AdditionalData).

25-46 Preferences and Environment Variables Reference PLM00026 11.2


Integration 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
Teamcenter object types.
DEFAULT
VALUES
Bhm0BehaviorModlRevision
DEFAULT
PROTECTION
SCOPE
Site preference.

Bmh0BehaviorModlRevision_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of a behavior model
revision node.
VALID
VALUES
Properties of an object.
DEFAULT
VALUES
IMAN_master_form_rev
bom_view_tags
IMAN_requirement
IMAN_reference
IMAN_specification
Bhm0AdditionalData
Fnd0StruObjAttrOverride
view
structure_revisions
DEFAULT
PROTECTION
SCOPE
Site preference.

Bhm0BehaviorModlRevision_show_relations

DESCRIPTION
Specifies the relations to display when expanding the node of a behavior model
revision object.

PLM00026 11.2 Preferences and Environment Variables Reference 25-47


Chapter
Chapter 25:25:Integration
Integration preferences
preferences

VALID
VALUES
Valid Teamcenter relation.
DEFAULT
VALUES
PSBOMViewRevision
IMAN_specification
IMAN_requirement
IMAN_reference
Bhm0AdditionalData
structure_revisions
DEFAULT
PROTECTION
SCOPE
Site preference.

25-48 Preferences and Environment Variables Reference PLM00026 11.2


Chapter 26: EDA preferences

EDA_AddSchematicItemToCCABOM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-1
EDA_BOMCompareRevRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-1
EDA_BOMTemplate_pcb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-1
EDA_BOMTemplate_sch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-2
EDA_CCABaseItemTypeDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-2
EDA_CCAItemTypeDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-3
EDA_CCAVariantItemTypeDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-3
EDA_CheckInOptionDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-4
EDA_CheckComponentExistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-4
EDA_CombinedBOMOptionDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-4
EDA_CombinedViewableOptionDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-5
EDA_ComponentItemTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-5
EDA_DefinePWBWith . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-6
EDA_DerivedDataConfigDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-6
EDA_DesignReviseSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-7
EDA_FutureVariantName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-7
EDA_PcbBOMOptionDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-7
EDA_PcbLockingDynamic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-8
EDA_PcbViewableOptionDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-8
EDA_PreferredLocalTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-9
EDA_PWBItemTypeDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-9
EDA_SaveAsFolderDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-10
EDA_SaveIntermediateDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-10
EDA_SchematicBOMOptionDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-10
EDA_SchematicItemTypeDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-11
EDA_SchematicLockingDynamic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-11
EDA_SchematicViewableOptionDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-12
EDA_SimulationLockingDynamic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-12
EDA_ViewType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-13
EDALIB_CheckInOptionDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-13
EDALIB_ClassificationMapping_eda2tc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-13
EDALIB_ClassificationMapping_tc2eda . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-14
EDALIB_FootprintTypeDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-14
EDALIB_ImportExport_MetadataOnly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-14
EDALIB_PadstackTypeDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-15
EDALIB_PartTypeDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-15
EDALIB_SaveAsFolderDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-15
EDALIB_ShowPartsMaxNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-16
EDALIB_SymbolTypeDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-16
EDALIB_Sync_FilterSyncParts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-16
EDALIB_Sync_FindNewParts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26-17

PLM00026 11.2 Preferences and Environment Variables Reference


Chapter 26: EDA preferences

EDA_AddSchematicItemToCCABOM

DESCRIPTION
Controls the addition of a schematic design item to an associated CCA(s) BVR when a
schematic design is created or copied.
VALID
VALUES
True
False
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

EDA_BOMCompareRevRule

DESCRIPTION
Specifies the revision rule to be used by ECAD BOM compare, when expanding the
corresponding Teamcenter CCA item revision first level children of an ECAD design.

Note

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


variable.

VALID
VALUES
Any valid Structure Manager revision rule name.
DEFAULT
VALUES
Any Status; No Working
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_BOMTemplate_pcb

DESCRIPTION
Defines a file to be used as the PCB BOM template.

PLM00026 11.2 Preferences and Environment Variables Reference 26-1


Chapter
Chapter 26:26:EDA EDA preferences
preferences

Note

This preference is created for the user as per requirement.

VALID
VALUES
A string containing a fully qualified path to the PCB BOM template file.
DEFAULT
VALUES
Undefined, which defaults to
%TCEDAECAD_ROOT%/Cadence/pcb/tcedaPcbTemplate.bom.
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_BOMTemplate_sch

DESCRIPTION
Defines a file to be used as a schematic BOM template.
Note

This preference is created for the user as per requirement.

Note

This preference is used only by the EDA Cadence Schematic tool integration.

VALID
VALUES
A string containing a fully qualified path to the schematic BOM template file.
DEFAULT
VALUES
Undefined, which defaults to
%TCEDAECAD_ROOT%/Cadence/sch/tcedaSchTemplate.bom.
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_CCABaseItemTypeDefault

DESCRIPTION
Represents the default UI item type used for CCABase item creation.
Note

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


variable.

VALID
VALUES
String. Teamcenter EDACCABase item type or a valid subtype.

26-2 Preferences and Environment Variables Reference PLM00026 11.2


EDA preferences

DEFAULT
VALUES
EDACCABase
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_CCAItemTypeDefault

DESCRIPTION
Represents the default UI item type used for CCA item creation.

Note

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


variable.

VALID
VALUES
String. Any valid Teamcenter item type.
DEFAULT
VALUES
Item
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_CCAVariantItemTypeDefault

DESCRIPTION
Specifies the default user interface item type that Teamcenter EDA uses for CCA
variant item creation on the EDA Save As Variant Page.

Note

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


variable.

VALID
VALUES
Item or a valid Teamcenter item subtype.
DEFAULT
VALUES
Item
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 26-3


Chapter
Chapter 26:26:EDA EDA preferences
preferences

EDA_CheckInOptionDefault

DESCRIPTION
Defines the default checkin option value. This preference preselects the Check-In
option on the Save As and Save dialogs if set to true.
Note

This preference is created for the user as per requirement.

VALID
VALUES
true
false
DEFAULT
VALUES
false
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_CheckComponentExistence

DESCRIPTION
Defines whether to check for components in Teamcenter before saving a design. Set
to 1 (true) to check if prerequisite components exist on the server. If components
do not exist in Teamcenter, then the save is aborted. If this preference is set to 0
(false), then any components that do not exist in Teamcenter are created as empty
items during the save.
VALID
VALUES
1
0
DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

EDA_CombinedBOMOptionDefault

DESCRIPTION
Specifies the default value for the following combined ECAD design tool actions:
• Check-In

• Save

• Save As

26-4 Preferences and Environment Variables Reference PLM00026 11.2


EDA preferences

Note

This preference replaces all combined ECAD design tool-specific BOM option
preferences.

Note

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


variable.

VALID
VALUES
FromPCB
FromSchematic
WithoutBOM
DEFAULT
VALUES
FromPCB
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_CombinedViewableOptionDefault

DESCRIPTION
Defines the Generate Viewables option value for the ECAD combined design tool.
If set to true, this preference preselects the Generate Viewables check box on the
Save and Save As dialog boxes.
Note

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


variable.

VALID
VALUES
FromPCB
FromSchematic
WithoutViewable
DEFAULT
VALUES
FromPCB
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_ComponentItemTypes

DESCRIPTION
The complete set of all Teamcenter item types that should be supported by EDA as
components.

PLM00026 11.2 Preferences and Environment Variables Reference 26-5


Chapter
Chapter 26:26:EDA EDA preferences
preferences

Note

If EDA library is installed, the default view contains both EDAComp and
EDAComPart.

VALID
VALUES
String. Any valid Teamcenter electrical component type used in ECAD designs.
DEFAULT
VALUES
EDAComp
DEFAULT
PROTECTION
SCOPE
Site preference.

EDA_DefinePWBWith

DESCRIPTION
Specifies that the printed wire board should be defined as part of the schematic or
PCB Save As operation.
VALID
VALUES
Schematic
PCB
DEFAULT
VALUES
Schematic
DEFAULT
PROTECTION
SCOPE
Site preference.

EDA_DerivedDataConfigDefault

DESCRIPTION
Defines a default EDA derived data configuration for use by the Teamcenter EDA
when ECAD designs are saved.
An administrator can create derived data configurations using the Business Modeler
IDE. After a configuration is created, the administrator must set this preference to
the name of the derived data configuration. There may be multiple configurations
created in the Business Modeler IDE, but an administrator can point to only one of
them through this preference.
Note

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


variable.

26-6 Preferences and Environment Variables Reference PLM00026 11.2


EDA preferences

VALID
VALUES
A string containing the name of an EDA derived data configuration created in the
Business Modeler IDE.
DEFAULT
VALUES
edaDefaultConfig
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_DesignReviseSync

DESCRIPTION
Specifies that both CCA items or EDACCABase and EDASchem are to be revised
together during a Save As operation.
VALID
VALUES
True
False
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

EDA_FutureVariantName

DESCRIPTION
Represents the name used for the future variant when a variant design is created and
no variants are defined by the ECAD designs.
VALID
VALUES
String. Any valid EDA CCA variant name.
DEFAULT
VALUES
futureVariant
DEFAULT
PROTECTION
SCOPE
Site preference.

EDA_PcbBOMOptionDefault

DESCRIPTION
Specifies the default value for the following ECAD PCB design tool actions:
• Check-In

PLM00026 11.2 Preferences and Environment Variables Reference 26-7


Chapter
Chapter 26:26:EDA EDA preferences
preferences

• Save

• Save As
Note

This preference replaces all ECAD design tool-specific PCB BOM option
preferences.

Note

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


variable.

VALID
VALUES
WithBOM
WithoutBOM
DEFAULT
VALUES
WithBOM
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_PcbLockingDynamic

DESCRIPTION
Enables dynamic locking of CCA BVR(s) during a PCB design checkout.
VALID
VALUES
True
False
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

EDA_PcbViewableOptionDefault

DESCRIPTION
Specifies the Generate Viewables option value for the ECAD PCB design tool. If set
to true, this preference preselects the Generate Viewables check box on the Save,
and Save As dialog boxes.
Note

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


variable.

26-8 Preferences and Environment Variables Reference PLM00026 11.2


EDA preferences

VALID
VALUES
WithViewable
WithoutViewable
DEFAULT
VALUES
WithViewable
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_PreferredLocalTS

DESCRIPTION
Defines whether the EDA integration should prefer to run the ECAD translation locally
on the same machine as the EDA client.
VALID
VALUES
1 Specifies local translation.

0 Specifies remote translation.


DEFAULT
VALUES
1
DEFAULT
PROTECTION
SCOPE
Site preference.

EDA_PWBItemTypeDefault

DESCRIPTION
Represents the default UI item type used for PWB item creation.

Note

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


variable.

VALID
VALUES
String. A valid Teamcenter item type.
DEFAULT
VALUES
Item
DEFAULT
PROTECTION
SCOPE
User preference.

PLM00026 11.2 Preferences and Environment Variables Reference 26-9


Chapter
Chapter 26:26:EDA EDA preferences
preferences

EDA_SaveAsFolderDefault

DESCRIPTION
Defines the default Teamcenter folder when saving new CCAs, schematics, and PCB
designs.
Note

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


variable.

Note

This preference is created for the user as per requirement.

VALID
VALUES
A valid Teamcenter folder name.
DEFAULT
VALUES
Undefined; no default
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_SaveIntermediateDS

DESCRIPTION
Defines whether to save the schematic or PCB intermediate dataset used by ECAD
translation to generate the XFATF or XSCH neutral viewable files.
VALID
VALUES
1 Indicates the intermediate file is saved.
0 Indicates the intermediate file is not saved.
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

EDA_SchematicBOMOptionDefault

DESCRIPTION
Specifies the default value for the following ECAD schematic design tool actions:
• Check-In

• Save

• Save As

26-10 Preferences and Environment Variables Reference PLM00026 11.2


EDA preferences

Note

This preference replaces all ECAD design tool-specific schematic BOM option
preferences.

Note

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


variable.

VALID
VALUES
WithBOM
WithoutBOM
DEFAULT
VALUES
WithBOM
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_SchematicItemTypeDefault

DESCRIPTION
Represents the default UI item type used for schematic item creation.
Note

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


variable.

VALID
VALUES
String. Teamcenter EDASchem item type or a valid subtype.
DEFAULT
VALUES
EDASchem
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_SchematicLockingDynamic

DESCRIPTION
Enables dynamic locking of CCA BVRs during a schematic design checkout.
VALID
VALUES
True
False

PLM00026 11.2 Preferences and Environment Variables Reference 26-11


Chapter
Chapter 26:26:EDA EDA preferences
preferences

DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

EDA_SchematicViewableOptionDefault

DESCRIPTION
Defines the Generate Viewables option value for the ECAD schematic design tool.
If set to true, this preference preselects the Generate Viewables check box on the
Save, and Save As dialog boxes.
Note

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


variable.

VALID
VALUES
WithViewable
WithoutViewable
DEFAULT
VALUES
WithViewable
DEFAULT
PROTECTION
SCOPE
User preference.

EDA_SimulationLockingDynamic

DESCRIPTION
Enables dynamic locking of CCA BVRs during a simulation design checkout.
VALID
VALUES
True
False
DEFAULT
VALUES
True
DEFAULT
PROTECTION
SCOPE
Site preference.

26-12 Preferences and Environment Variables Reference PLM00026 11.2


EDA preferences

EDA_ViewType

DESCRIPTION
Specifies the BOM view type that Teamcenter EDA uses to read and write product
structure information.
VALID
VALUES
Contains a single string that specifies a valid Teamcenter BOM view type or an empty
string. If an empty string is specified, Teamcenter EDA uses the default product
structure view type.
DEFAULT
VALUES
" " (empty string)
DEFAULT
PROTECTION
SCOPE
Site.

EDALIB_CheckInOptionDefault

DESCRIPTION
Defines whether to checkin the part after saving it in Teamcenter.
VALID
VALUES
True
False
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
All.

EDALIB_ClassificationMapping_eda2tc

DESCRIPTION
Specifies the dataset storing the classification mappings from Teamcenter to the
ECAD library.
VALID
VALUES
String.
DEFAULT
VALUES
Empty.
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 26-13


Chapter
Chapter 26:26:EDA EDA preferences
preferences

EDALIB_ClassificationMapping_tc2eda

DESCRIPTION
Specifies the dataset storing the classification mappings from Teamcenter to the
ECAD library.
VALID
VALUES
String.
DEFAULT
VALUES
Empty.
DEFAULT
PROTECTION
SCOPE
All.

EDALIB_FootprintTypeDefault

DESCRIPTION
Defines the default footprint type to use in the EDA client to save a new footprint
to Teamcenter.
VALID
VALUES
EDA footprint type name.
DEFAULT
VALUES
EDAFootprint
Note

Ensure the specific footprint type is EDAFootprint or its subtype.

DEFAULT
PROTECTION
SCOPE
All.

EDALIB_ImportExport_MetadataOnly

DESCRIPTION
Indicates if the user manages only part metatdata to Teamcenter.
VALID
VALUES
True
False
DEFAULT
VALUES
False
DEFAULT
PROTECTION
SCOPE
Site preference.

26-14 Preferences and Environment Variables Reference PLM00026 11.2


EDA preferences

EDALIB_PadstackTypeDefault

DESCRIPTION
Defines the default padstack type to use in the EDA client to save a new padstack
to Teamcenter.
VALID
VALUES
EDA padstack type name.
DEFAULT
VALUES
EDAPadstack
Note

Ensure the specific padstack type is EDAPadstack or its subtype.

DEFAULT
PROTECTION
SCOPE
All.

EDALIB_PartTypeDefault

DESCRIPTION
Defines the default part type to use in the EDA client to save a new part to Teamcenter.
VALID
VALUES
EDA part type name.
DEFAULT
VALUES
EDAComPart
Note

Ensure the specific part type is EDAComPart or its subtype.

DEFAULT
PROTECTION
SCOPE
All.

EDALIB_SaveAsFolderDefault

DESCRIPTION
Specifies the target folder to place the new creation part in Teamcenter.
VALID
VALUES
Path to the target folder in Teamcenter.
DEFAULT
VALUES
Home/Newstuff

PLM00026 11.2 Preferences and Environment Variables Reference 26-15


Chapter
Chapter 26:26:EDA EDA preferences
preferences

DEFAULT
PROTECTION
SCOPE
All.

EDALIB_ShowPartsMaxNumber

DESCRIPTION
Defines the maximum number for displaying the qualified parts in the EDA client.
VALID
VALUES
Postive number.
DEFAULT
VALUES
30
DEFAULT
PROTECTION
SCOPE
All.

EDALIB_SymbolTypeDefault

DESCRIPTION
Defines the default symbol type to use in the EDA client to save a new symbol to
Teamcenter.
VALID
VALUES
EDA symbol type name.
DEFAULT
VALUES
EDASymbol
Note

Ensure the symbol type is EDASymbol or its subtype.

DEFAULT
PROTECTION
SCOPE
All.

EDALIB_Sync_FilterSyncParts

DESCRIPTION
Defines which saved query to use to filter new/modified parts during synchronization
process.
VALID
VALUES
Saved query name.
DEFAULT
VALUES
Empty.

26-16 Preferences and Environment Variables Reference PLM00026 11.2


EDA preferences

DEFAULT
PROTECTION
SCOPE
All.

EDALIB_Sync_FindNewParts

DESCRIPTION
Defines which saved query to use to find new parts.
VALID
VALUES
Saved query name.
DEFAULT
VALUES
_ _EDALIB_find_newparts
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 26-17


Chapter 27: Quality data preferences

DPVAdmin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-1
DPVClusterGroup Revision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-1
DPVClusterGroup Revision_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-2
DPVClusterGroupContent_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-3
DPV_ccuaservice_url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-4
DPV_logdatapurge_days . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-4
DPV_rawdata_location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27-4

PLM00026 11.2 Preferences and Environment Variables Reference


Chapter 27: Quality data preferences

DPVAdmin

DESCRIPTION
By default, in DPV Measurements, all users can change the activation state of
measurement data events (deactivate or activate them). To protect your data, define
DPVAdmin to hold the names of the groups of users who can change the activation
state. Groups not in DPVAdmin can read the events but they cannot their activation
state. If no preference is defined, all users have the privilege to change the activation
state.
Note

This preference is not included in your Teamcenter installation. You must add it
to the database.

VALID
VALUES
String. Group or groups who can deactivate/activate data. Separate
each group with a comma.
DEFAULT
PROTECTION
SCOPE
Site preference.

DPVClusterGroup Revision_DefaultChildProperties

DESCRIPTION
Specifies whether a specific relationship between two item revisions is listed
when you select the Paste Special command. For DPV, the relationship
DPVCLUSTERGROUPCONTENT is defined between clusters and cluster groups.
Therefore, select this value to have this relationship appear in the Paste Special
command in Teamcenter.
VALID
VALUES
One of the following relationships. To show the DPV cluster/cluster group relationship,
select DPVClusterGroupContent.
IMAN_master_form_rev
TC_Generic_Architecture
structure_revisions
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_UG_udf

PLM00026 11.2 Preferences and Environment Variables Reference 27-1


Chapter
Chapter 27:27:Quality
Quality
data data preferences
preferences

IMAN_UG_altrep
IMAN_UG_scenario
IMAN_Simulation
IMAN_Rendering
IMAN_Motion
IMAN_3D_snap_shot
view
release_status_list
IMAN_external_object_link
TC_WorkContext_Relation
representation_for
IMAN_MEWorkInstruction
TC_ProductManua
BOM_Rollup
TC_Is_Represented_By
TC_Attaches
TCEng_rdv_plmxml_configured
TCEng_rdv_plmxml_unconfigured
TC_sst_record
ProcessSimulate_Details
KinematicsRelation
DPVClusterGroupContent

DEFAULT
VALUES
The values listed under Valid Values.
DEFAULT
PROTECTION
SCOPE
Site preference.

DPVClusterGroup Revision_shown_relations

DESCRIPTION
Specifies whether a specific relationship between two item revisions is listed
when you select the Paste Special command. For DPV, the relationship
DPVCLUSTERGROUPCONTENT is defined between clusters and cluster groups.
Therefore, select this value to have this relationship appear in the Paste Special
command in Teamcenter.
VALID
VALUES
One of the following relationships. To show the DPV cluster/cluster group relationship,
select DPVClusterGroupContent.
PSBOMViewRevision
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_UG_udf

27-2 Preferences and Environment Variables Reference PLM00026 11.2


Quality data preferences

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
ProcessSimulate_Details
IMAN_MEFeature
Site Specific
Corporate Specific
DPVClusterGroupContent

DEFAULT
VALUES
The values listed under Valid Values.
DEFAULT
PROTECTION
SCOPE
Site preference.

DPVClusterGroupContent_relation_primary

DESCRIPTION
Specifies whether a specific relationship between two item revisions is listed
when you select the Paste Special command. For DPV, the relationship
DPVCLUSTERGROUPCONTENT is defined between clusters and cluster groups.
Therefore, select this value to have this relationship appear in the Paste Special
command in Teamcenter.
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
DPVClusterGroup
DPVClusterGroup Revision

PLM00026 11.2 Preferences and Environment Variables Reference 27-3


Chapter
Chapter 27:27:Quality
Quality
data data preferences
preferences

DEFAULT
VALUES
DPVClusterGroup
DPVClusterGroup Revision
DEFAULT
PROTECTION
SCOPE
Site preference.

DPV_ccuaservice_url

DESCRIPTION
Specifies the URL for the Custom Cache Updating Application (CCUA) Service used in
creating triggered reports.
For more information, see Working with triggered reports in the DPV online help.
VALID
VALUES
Set the URL, such as http://pni6w032/CCUATrigger/CCUA.asmx.
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

DPV_logdatapurge_days

DESCRIPTION
Sets the number of days to retain log data.
For more information, see Modify Teamcenter Preferences in the Installing Dimensional
Planning and Validation Solution guide in the DPV help collection.
INTEGER
Specify the number of days to retain the log data. If it is set to x, log data that is more
than x days old is deleted automatically (no other user action is required).
DEFAULT
VALUES
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

DPV_rawdata_location

DESCRIPTION
Specifies where the measurement data is stored, either in Teamcenter or an external
measurement database.

27-4 Preferences and Environment Variables Reference PLM00026 11.2


Quality data preferences

For more information, see Defining measurement databases in the Installing


Dimensional Planning and Validation Solution guide in the DPV help collection.
VALID
VALUES
0 The measurement data is stored within Teamcenter.
1 The measurement data is stored in an external measurement
database.
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 27-5


Chapter 28: ADA License preferences

ADA_enable_subgroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-1
ADA_license_administration_privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-1
ADA_override_on_import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-2
Hide_User_Clearance_Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-2
Hide_User_Privacy_Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-3
TC_multi_site_gov_classification_user_bypass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-3
TC_multi_site_ip_classification_user_bypass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28-4

PLM00026 11.2 Preferences and Environment Variables Reference


Chapter 28: ADA License preferences

ADA_enable_subgroups

DESCRIPTION
Specifies whether or not subgroup members of the top-level groups can be authorized
access to workspace objects with attached licenses when the top-level group is not
authorized access. In Teamcenter versions prior to 8.1L, only top-level groups can
be authorized due to a limit on the length of the string that passes the authorization
information. This allows access to all subgroups of the top-level group in prior versions.
Therefore, if your environment shares license information among sites that are on
versions prior to 8.1L, this must be set to false to prevent data loss.
VALID
VALUES
true Allows subgroups of groups authorized access to objects with
attached licenses to access the objects. If you set the value to
true, all Teamcenter sites that share data in your environment
must be upgraded to Teamcenter 8.1L to prevent data loss.
false Does not allow subgroups of groups to be granted authorized
access to objects with attached licenses from accessing the
objects.
DEFAULT
VALUE
false
DEFAULT
PROTECTION
SCOPE
Site preference.

ADA_license_administration_privilege

DESCRIPTION
Specifies the privilege required to perform actions in the ADA License application,
attach or detach license from workspace objects in My Teamcenter, or view audit logs
of license activity from the ADA License application.
Note

If a user is not authorized access through a group or role membership, the


application opens in read-only mode for that user. Authorization is configured
using the Authorization application.

VALID
VALUES
ITAR_ADMIN Allows users with the ITAR Admin privilege access to the ADA
License application.

PLM00026 11.2 Preferences and Environment Variables Reference 28-1


Chapter
Chapter 28:28:ADA ADA License
License preferences
preferences

IP_ADMIN Allows user with the IP Admin privilege access to the Authorized
Data Access application.
Administer_ADA_ Allows users with the Administer ADA Licenses privilege
Licenses access to the ADA License application.
DEFAULT
VALUE
ITAR_ADMIN
DEFAULT
PROTECTION
SCOPE
Site preference.

ADA_override_on_import

DESCRIPTION
For a Multi-Site configuration, specifies whether or not a remote site mirrors the
license-related properties of the master site for a workspace object. For example,
whether the Authorized Data Access (ADA) license attached to or detached from an
item revision is propagated to the remote site. Setting ADA_override_on_import
to true ensures the following:
• Any ADA license assignments or changes propagate across the multi-site.

• Any changes in IP and government classification values propagate to the remote


sites, either from a lower level to a higher level or the reverse.
Note

This preference is not included in your Teamcenter installation. You must add it
to the database.

DEFAULT
VALUES
false
VALID
VALUES
true Set to true to mirror the license-related properties of the master.
false Set to false to not mirror the license-related properties of the master (the
default).
DEFAULT
PROTECTION
SCOPE
Site preference.

Hide_User_Clearance_Information

DESCRIPTION
Controls the display of the following user properties:
• IP clearance

• Government clearance

28-2 Preferences and Environment Variables Reference PLM00026 11.2


ADA License preferences

• Technology transfer certification (TTC) date


DEFAULT
VALUES
false
VALID
VALUES
true Set to true, the IP clearance, government clearance, and TTC date of a user
is visible to only the user or admin users.
false Set to false, the IP clearance, government clearance, and TTC date of a user
is visible to all users.
DEFAULT
PROTECTION
SCOPE
Site preference.

Hide_User_Privacy_Information

DESCRIPTION
Controls the display of the following user properties:
• Geography

• Nationality

• Citizenship
DEFAULT
VALUES
false
VALID
VALUES
true Set to true, the geography, nationality, and citizenships of a user is visible only
to the user or administrative users.
false Set to false, the geography, nationality, and citizenships of a user is visible
to all users.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_multi_site_gov_classification_user_bypass

DESCRIPTION
Determines whether or not the government classification of replicated workspace
objects is preserved during import, even if the user importing the objects does not
have the necessary permissions to set government classification, which requires the
ITAR_ADMIN or ITAR_Classifier privileges.
DEFAULT
VALUES
true

PLM00026 11.2 Preferences and Environment Variables Reference 28-3


Chapter
Chapter 28:28:ADA ADA License
License preferences
preferences

VALID
VALUES
true Set to true to allow the replication of government classification regardless
of the permissions of user importing the replicated workspace objects (the
default).
false Set to false to not allow the replication of government classification if the
user importing the replicated workspace objects does not have the necessary
privilege.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_multi_site_ip_classification_user_bypass

DESCRIPTION
Determines whether or not the intellectual property (IP) classification of replicated
workspace objects is preserved during import, even if the user importing the objects
does not have the necessary permissions to set IP classification, which requires the
IP_ADMIN or IP_Classifier privileges.
DEFAULT
VALUES
true
VALID
VALUES
true Set to true to allow the replication of IP classification regardless of the
permissions of the user importing the replicated workspace objects (the
default).
true Set to false to not allow the replication of IP classification if the user importing
the replicated workspace objects does not have the necessary privileges.
DEFAULT
PROTECTION
SCOPE
Site preference.

28-4 Preferences and Environment Variables Reference PLM00026 11.2


Chapter 29: 4th Generation Design preferences

4GD_attribute_for_subordinate_update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-1
BOM_MARKUP_ADD_FONT_STYLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-1
BOM_MARKUP_STRIKE_FOREGROUND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-2
BOM_MARKUP_ADD_FOREGROUND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-2
CPD_ContentSearch_SavedQueries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-2
CPDDisplayNameColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-3
CPD_IntroSavedQueryTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-3
CPD_Realization_AssignToPartition_bl_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-4
CPDShownColumnsWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-4
CPD_SearchOptions_TransferOptionSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-4
CPD_SearchOptions_ContextMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-5
DefaultLoadCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-5
DefaultLoadCountIncreaseRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-6
DefaultMaximumLoadSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-6
ItemRealization_skip_type_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-6
MDL_default_attribute_group_load_count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-7
MDL_default_attribute_group_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-7
MDL_Default_RevRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-7
MDL_effectivity_shown_columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-8
MDL_include_attribute_group_inherit_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-8
PTN_Allow_Copy_Paste_Realized_Partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-9
PTN_Allow_To_Add_Realized_Partition_As_Local_Partition . . . . . . . . . . . . . . . . . . . . . . . . 29-9
PTN_Default_Partition_RevRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-9
PTN_IntroSavedQueryTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-10
PTN0_Default_Carryover_Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-10
Ptn0Partition_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-10
Ptn0Partition_DirectModel_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-11
Ptn0Partition_Ptn0PartitionItemRevision _default_relation . . . . . . . . . . . . . . . . . . . . . . . . 29-11
Ptn0PartitionTemplateModel.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-12
Ptn0PartitionTemplateModelCreate.CREATE_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . 29-12
Ptn0PartitionTemplateModel_DefaultChild Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-12
Ptn0PartitionTemplateModel.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-13
PartitionableModelDisplayNameColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-13
PartitionableModelShownColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-13
Ptn0ViewUnpartitionedElementsType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-14
TC_config_rule_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-14
TC_configurator_relationship . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-14
TC_Default_Solve_Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-15
TC_EffectivityConfigurable_MaxCacheSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-16
TC_Fnd0Booleansolve_EffectivityDateRangeFromTo . . . . . . . . . . . . . . . . . . . . . . . . . . . 29-16
TC_Fnd0Booleansolve_EffectivityIntegerRangeFromTo . . . . . . . . . . . . . . . . . . . . . . . . . . 29-17

PLM00026 11.2 Preferences and Environment Variables Reference


Chapter 29: 4th Generation Design preferences

4GD_attribute_for_subordinate_update

DESCRIPTION
Specifies a custom date attribute on design elements that allows users to track
updates of subordinates. When you update a realization of a reuse design element,
some of its subordinates may also be updated if there are changes in the source
item revision (assembly). Such changes update the Last Modified and Saved Date
attributes of the subordinates. However, the same attributes are updated for other
changes to subordinates, for example, if the description is edited. You can define a
custom date attribute on design elements to specifically track realization updates and
set its name as the value to this preference. The system updates this custom attribute
whenever a realization update occurs.
VALID
VALUES
Any valid custom date attribute name.
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

BOM_MARKUP_ADD_FONT_STYLE

DESCRIPTION
Specifies the text font style when a user adds a markup to a BOM line in Structure
Manager or a markup space in 4G Designer.
VALID
VALUES
0 (plain text)
1 (bold text)
2 (italic text)
3 (bold and italic text)
DEFAULT
VALUES
0
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 29-1


Chapter
Chapter 29:29:4th Generation
4th Generation Design
Design preferences
preferences

BOM_MARKUP_STRIKE_FOREGROUND

DESCRIPTION
Specifies the color of the strikethrough marking if a user deletes a BOM line or edits a
property in Structure Manager or removes an object in a markup space in 4G Designer.
VALID
VALUES
Specify three color values in order of precedence in the format N1,N2,N3, where
each value is an integer in the range 0 to 255. Enter color values in red, green, blue
(RGB) code, where, for example, 0, 0, 0 represents the color black and 0, 255, 255
represents the color aqua.
DEFAULT
VALUES
0, 255, 0
DEFAULT
PROTECTION
SCOPE
Site preference.

BOM_MARKUP_ADD_FOREGROUND

DESCRIPTION
Specifies the color of the markup text added to a BOM line by a user in Structure
Manager or in a markup space in 4G Designer.
VALID
VALUES
Specifies three color values in order of precedence in the format N1,N2,N3, where
each value is an integer in the range 0 to 255. Enter color values in red, green, blue
(RGB) code, where, for example, 0, 0, 0 represents the color black and 0, 255, 255
represents the color aqua.
DEFAULT
VALUES
0, 255, 0
DEFAULT
PROTECTION
SCOPE
Site preference.

CPD_ContentSearch_SavedQueries

DESCRIPTION
Lists the names of saved queries that are available in the 4G Designer attribute search.
VALID
VALUES
Any valid saved query name.
DEFAULT
VALUE
DesignElement
Partition

29-2 Preferences and Environment Variables Reference PLM00026 11.2


4th Generation Design preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

CPDDisplayNameColumnsShownPref

DESCRIPTION
Specifies the list of names of the columns displayed in the Content Explorer tree table
in the 4G Designer application.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid property name.
DEFAULT
VALUE
Cpd0DesignElement.object.string
Mdl0PositionedModelElement.mdl0logical_designator
Cpd0DesignModelElement.cpd0category
Cpd0DesignElement.object.type
Mdl0ConditionalElement.mdleffectivity_formula
Cpd0DesignElement.cpd0source_object_name
Cpd0DesignElement.cpd0source_object_type

DEFAULT
PROTECTION
SCOPE
User preference.

CPD_IntroSavedQueryTypeList

DESCRIPTION
Populates the list of available saved queries in a blank Content Explorer.
VALID
VALUES
One or more valid saved query names.
DEFAULT
VALUE
__CollaborativeDesign
__SubsetDefinition
__Workset
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 29-3


Chapter
Chapter 29:29:4th Generation
4th Generation Design
Design preferences
preferences

CPD_Realization_AssignToPartition_bl_attr

DESCRIPTION
Specifies the value of the CPD_Realization_AssignToPartition_bl_attr BOM line
property. Teamcenter uses this property when assigning subordinates to partitions
during realization of an item assembly or its subsequent updating.
VALID
VALUES
An alphanumeric string containing one or partition IDs. Multiple IDs must be separated
by comma characters (,). For example, PTN000001,PTN000002.
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
Site preference.

CPDShownColumnsWidthsPref

DESCRIPTION
Specifies the widths of the columns that are displayed in the Content Explorer tree
table of the 4G Designer application. The displayed columns are specified in the
CPDDisplayNameColumnsShownPref preference.
VALID
VALUES
Accepts one integer value for each column listed in the
CPDDisplayNameColumnsShownPref preference.
DEFAULT
VALUE
25
20
20
20
20
20
20

DEFAULT
PROTECTION
SCOPE
User preference.

CPD_SearchOptions_TransferOptionSet

DESCRIPTION
Contains the name of the transfer option set that loads related objects when you
right-click search results in the Content Search view of the 4G Designer application.

29-4 Preferences and Environment Variables Reference PLM00026 11.2


4th Generation Design preferences

VALID
VALUES
Any valid transfer option set name.
DEFAULT
VALUE
CPD_related_objectsTOS
DEFAULT
PROTECTION
SCOPE
Site preference.
NOTES
This preference contains the name of the transfer option set Teamcenter uses to load
extra objects. The transfer option set must contain one or more search options.

CPD_SearchOptions_ContextMenu

DESCRIPTION
Contains the internal names of the context menu commands displayed when you
right-click search results in the Content Search view of the 4G Designer application.
VALID
VALUES
Any valid option names in the transfer option set defined in the
CPD_SearchOptions_TransferOptionSet preference.
DEFAULT
VALUE
opt_subordinate2reuse
opt_reuse2subordinate
opt_de2df
opt_dce2df
opt_df2dce
CPD_related_objectsTOS
DEFAULT
PROTECTION
SCOPE
User preference.

DefaultLoadCount

DESCRIPTION
Sets the initial number of objects to load in a page of a result set from a 4GD cacheless
search.
VALID
VALUES
Any valid integer. The larger the number, the longer the page takes to load.
DEFAULT
VALUE
200

PLM00026 11.2 Preferences and Environment Variables Reference 29-5


Chapter
Chapter 29:29:4th Generation
4th Generation Design
Design preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

DefaultLoadCountIncreaseRate

DESCRIPTION
Sets the percentage increase of the size of each successive page in a result set from a
4GD cacheless search.
VALID
VALUES
Any valid integer. 100 sets no increase.
DEFAULT
VALUE
150
DEFAULT
PROTECTION
SCOPE
User preference.

DefaultMaximumLoadSize

DESCRIPTION
Sets the maximum page size of a result set from a 4GD cacheless search.
VALID
VALUES
Any valid integer. The larger the number, the longer the page takes to load.
DEFAULT
VALUE
5000
DEFAULT
PROTECTION
SCOPE
User preference.

ItemRealization_skip_type_list

DESCRIPTION
Defines item types that are skipped when an item assembly is realized into a
collaborative design or an existing realization is updated. You must use NX 10.0.1 or
later, or NX may display error messages.
VALID
VALUES
The names of closure rule names that are used during realization. The closure rules
control the item types realized.
DEFAULT
VALUE
None.

29-6 Preferences and Environment Variables Reference PLM00026 11.2


4th Generation Design preferences

DEFAULT
PROTECTION
SCOPE
Site preference.

MDL_default_attribute_group_load_count

DESCRIPTION
Defines the number of model element objects that can be loaded in one server call
when loading attribute groups in the 4G Designer application.
VALID
VALUES
Any integer value.
DEFAULT
VALUE
10000
DEFAULT
PROTECTION
SCOPE
User preference.

MDL_default_attribute_group_types

DESCRIPTION
Specifies the list of managed attribute group types available to a specific user role.
VALID
VALUES
A list of internal type names of attribute groups and managed attribute groups that are
defined in the 4G Designer application. For example:
Cpd9PipingManagedAttrGrp
Cpd9HVacManagedAttrGrp
Cpd9CabinManagedAttrGrp
Cpd9DeckManagedAttrGrp
Mdl9AttributeGroup
DEFAULT
VALUE
None (empty list).
DEFAULT
PROTECTION
SCOPE
Role preference.

MDL_Default_RevRule

DESCRIPTION
Specifies the default revision rule used to configure the contents of the Content
Explorer.
VALID
VALUES
Name of a revision rule that is valid in the application and defined in the database.

PLM00026 11.2 Preferences and Environment Variables Reference 29-7


Chapter
Chapter 29:29:4th Generation
4th Generation Design
Design preferences
preferences

DEFAULT
VALUE
Working(Current User); Any Status
DEFAULT
PROTECTION
SCOPE
Site preference.

MDL_effectivity_shown_columns

DESCRIPTION
Specifies if unit, date, intent, or all columns are shown in the Effectivity view of the
application.
VALID
VALUES
DateOnly The date effectivity columns are shown in the Effectivity view.

UnitOnly The unit number effectivity columns are shown in the Effectivity
view.

Intent The intent column is shown in the Effectivity view.

All The date effectivity and unit number effectivity columns are both
shown in the Effectivity view.
This preference is case insensitive.
DEFAULT
VALUE
UnitOnly
DEFAULT
PROTECTION
SCOPE
Site preference.

MDL_include_attribute_group_inherit_properties

DESCRIPTION
Defines a list of inherited properties available when viewing attribute groups and
managed attribute groups in the Content Explorer. By default, the Content Explorer
displays only the properties directly defined on an attribute group or managed attribute
group. Use this preference to list additional properties from the parent hierarchy of
attribute group or managed attribute group. The defined properties are available in the
Column Management wizard of the Content Explorer, allowing you to add them to
your display.
For example, the object_string property is inherited from the workspace object. To
make object_string available for attribute groups, add the property name to this
preference.
VALID
VALUES
A list of valid property names.

29-8 Preferences and Environment Variables Reference PLM00026 11.2


4th Generation Design preferences

DEFAULT
VALUE
None
DEFAULT
PROTECTION
SCOPE
User preference.

PTN_Allow_Copy_Paste_Realized_Partition

DESCRIPTION
Indicates whether a user has rights to copy and paste realized partitions in a target
model.
VALID
VALUES
true or false
DEFAULT
VALUE
false
DEFAULT
PROTECTION
SCOPE
Site preference.

PTN_Allow_To_Add_Realized_Partition_As_Local_Partition

DESCRIPTION
Indicates whether a realized partition can be added as a local partition in a target
model when copying.
VALID
VALUES
true or false
DEFAULT
VALUE
false.
DEFAULT
PROTECTION
SCOPE
Site preference.

PTN_Default_Partition_RevRule

DESCRIPTION
Specifies the default revision rule for partitions within a model.
VALID
VALUES
The name of any valid Teamcenter revision rule, for example, Any Status, Not
Working.
DEFAULT
VALUE
Working; Any Status

PLM00026 11.2 Preferences and Environment Variables Reference 29-9


Chapter
Chapter 29:29:4th Generation
4th Generation Design
Design preferences
preferences

DEFAULT
PROTECTION
SCOPE
User preference.

PTN_IntroSavedQueryTypeList

DESCRIPTION
Defines the saved query types that Teamcenter uses for the quick search within the
partitionable model Content Explorer introduction panel.
VALID
VALUES
__PartitionTemplate
__ProductArchModel
DEFAULT
VALUE
None
DEFAULT
PROTECTION
SCOPE
Site preference.

PTN0_Default_Carryover_Options

DESCRIPTION
Specifies the default options shown in the Target Model Configuration Options
dialog box of the 4G Designer application when you clone or realize partitions from an
application model (partition template or collaborative design) to another application
model.
VALID
VALUES
One or more of the following values:
Variant The Variant Expressions check box is shown by default.
Expressions
Attribute Groups The Attribute Groups check box is shown by default.
Child Partitions The Child Partitions check box is shown by default.
DEFAULT
VALUE
None.
DEFAULT
PROTECTION
SCOPE
User preference.

Ptn0Partition_DefaultChildProperties

DESCRIPTION
Specifies the list of properties that can be displayed as children of a partition node.

29-10 Preferences and Environment Variables Reference PLM00026 11.2


4th Generation Design preferences

VALID
VALUES
Any children that are properties of a partition node.
DEFAULT
VALUE
mdl0model_object
ptn0source_object
Mdl0AttachAttrGroup
IMAN_specification
release_status_list
IMAN_Rendering
DEFAULT
PROTECTION
SCOPE
Site preference.

Ptn0Partition_DirectModel_default_relation

DESCRIPTION
Defines the default paste relation between Partition and Direct Model dataset objects.
VALID
VALUES
Any valid relation between partition checks.
DEFAULT
VALUE
IMAN_Rendering
DEFAULT
PROTECTION
SCOPE
Site preference.

Ptn0Partition_Ptn0PartitionItemRevision _default_relation

DESCRIPTION
Default paste relation between Partition and ItemRevision.
VALID
VALUES
Any valid relation between partition checks.
DEFAULT
VALUE
ptn0source_object
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00026 11.2 Preferences and Environment Variables Reference 29-11


Chapter
Chapter 29:29:4th Generation
4th Generation Design
Design preferences
preferences

Ptn0PartitionTemplateModel.CREATERENDERING

DESCRIPTION
Specifies the XML rendering dataset used by the 4G Designer application to render
the properties shown in the New Business Object – Partition Template dialog box.
VALID
VALUES
The name of any valid dataset containing rendering XML.
DEFAULT
VALUE
Ptn0PartitionTemplateModelCreate
DEFAULT
PROTECTION
SCOPE
Site preference.

Ptn0PartitionTemplateModelCreate.CREATE_REGISTEREDTO

DESCRIPTION
Specifies the business object type to which the XML rendering stylesheet defined in
the Ptn0PartitionTemplateModel.CREATERENDERING preference is applied.
VALID
VALUES
The name of the business object type corresponding to the dataset defined in the
Ptn0PartitionTemplateModel.CREATERENDERING preference.
DEFAULT
VALUE
Ptn0PartitionTemplateModel
DEFAULT
PROTECTION
SCOPE
Site preference.

Ptn0PartitionTemplateModel_DefaultChild Properties

DESCRIPTION
Specifies the list of properties that can be displayed as children of a partition template
node.
VALID
VALUES
Any children that are properties of partition template nodes.
DEFAULT
VALUE
Mdl0HasConfiguratorContext
IMAN_specification
IMAN_Rendering
DEFAULT
PROTECTION
SCOPE
Site preference.

29-12 Preferences and Environment Variables Reference PLM00026 11.2


4th Generation Design preferences

Ptn0PartitionTemplateModel.SUMMARYRENDERING

DESCRIPTION
Specifies the XML rendering dataset used by the 4G Designer application to render
the entries shown in the Summary tab after you create a partition template.
VALID
VALUES
The name of any valid dataset containing rendering XML.
DEFAULT
VALUE
PartitionTemplateSummary
DEFAULT
PROTECTION
SCOPE
Site preference.

PartitionableModelDisplayNameColumnsShownPref

DESCRIPTION
Specifies the column names displayed in the Content Explorer tree for a partitionable
model (for example, a partition template) and its contents. The columns widths are
specified in the PartitionableModelShownColumnWidthsPref preference.
VALID
VALUES
One or more valid property names.
DEFAULT
VALUE
Mdl0ModelElement.object_string
Mdl0PositionedModelElement.mdl0logical_designator
Mdl0ModelElement.object_type
Mdl0ConditionalElement.mdl0effectivity_formula
Mdl0ConditionalElement.mdl0variant_formula
DEFAULT
PROTECTION
SCOPE
User preference.

PartitionableModelShownColumnWidthsPref

DESCRIPTION
Specifies the widths of the columns displayed in the Content Explorer tree for a
partitionable model (for example, a partition template) and its contents. The columns
displayed are specified in the PartitionableModelDisplayNameColumnsShownPref
preference.
VALID
VALUES
One column width values for each column specified in the
PartitionableModelDisplayNameColumnsShownPref preference.

PLM00026 11.2 Preferences and Environment Variables Reference 29-13


Chapter
Chapter 29:29:4th Generation
4th Generation Design
Design preferences
preferences

DEFAULT
VALUE
25
20
20
20
DEFAULT
PROTECTION
SCOPE
User preference.

Ptn0ViewUnpartitionedElementsType

DESCRIPTION
Defines the business object types of unpartitioned model elements to be searched in
a model.
VALID
VALUES
Any valid relation between partition checks.
DEFAULT
VALUE
Cpd0DesignElement
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_config_rule_name

DESCRIPTION
Specifies the default revision rule used by 4GD structures.
VALID
VALUES
The name of any valid Teamcenter revision rule, for example, Any Status, Not
Working.
DEFAULT
VALUE
Latest Working
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_configurator_relationship

DESCRIPTION
Specifies the relationship used to navigate from an application model (for example, a
collaborative design) to a related item revision. Teamcenter uses this relationship to
derive information about the relevant product name (item ID) and product namespace
(item revision ID) from the item revision. It uses this information to initialize the internal
effectivity configurator.

29-14 Preferences and Environment Variables Reference PLM00026 11.2


4th Generation Design preferences

If you use an external configurator, Teamcenter associates an Effectivity In Model


object with the application model and it is not necessary to set this preference.
VALID
VALUES
The name of any valid Teamcenter relation, for example, DependentOn or
IMAN_CC_Context.
DEFAULT
VALUE
MDL0HasConfiguratorContext
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Default_Solve_Type

DESCRIPTION
Defines the default solve type value that Teamcenter uses when setting effectivity
configurations.
TYPE
Integer.
VALID
VALUES
Any combination of the following values:
1 Mismatch. Conditions that do not match the solve criteria.
2 Explicit. Conditions that explicitly match the solve criteria.
4 Coprime. Conditions that may match the solve criteria. The
term coprime means the condition depends on variant option
families that are not present in the criteria.
8 True. Conditions that always satisfy the solve criteria because
they are equivalent to the Boolean constant TRUE.
16 False. Conditions that never satisfy the solve criteria because
they are equivalent to the Boolean constant FALSE.
32 Condition. Conditions that are nonconstant because they are
not equivalent to the Boolean constants TRUE or FALSE.
64 Error check. Conditions that return an error in the solve process.
Configurations using this mode should never return any data.
128 No condition. No conditions. Finds objects that support
configuration conditions but do not have one.
256 No configuration behavior. Objects that do not support
configuration behavior in the solve process.
512 Invert. Inverts the filter results.
DEFAULT
VALUE
529

PLM00026 11.2 Preferences and Environment Variables Reference 29-15


Chapter
Chapter 29:29:4th Generation
4th Generation Design
Design preferences
preferences

This value represents a partial solve type of mismatch plus false plus invert, that is,
1 + 16 + 512.
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_EffectivityConfigurable_MaxCacheSize

DESCRIPTION
The Teamcenter server caches effectivity data for configurable objects to prevent
repeated frequent database queries for the same set of configurable objects. Use this
preference to limit the size of the cache to optimize the balance between memory
footprint of the tcserver process and the performance impact of an increased database
SQL query count.
The cache is automatically purged on a last-accessed basis. Cached values are
automatically refreshed for loaded and up-to-date objects when a cached value is
accessed and the cached has changed since it was cached.
TYPE
Integer.
VALID
VALUES
Any integer value that specifies the number of configurable objects for which effectivity
data is cached. If the value is equal to or less than zero, or if the preference is not
defined, Teamcenter applies the default value.
DEFAULT
VALUE
50000
DEFAULT
PROTECTION
SCOPE
Site preference.

TC_Fnd0Booleansolve_EffectivityDateRangeFromTo

DESCRIPTION
4th Generation Design can display effectivity date ranges in one of two ways:
• Inclusive date ranges, where the end date is included (a from/to paradigm).
Objects whose effective date range is displayed in a format such as
Date=2011-04-01..2011-04-30 are effective until the end of the last day,
in this case, 2011-04-30. Similarly, if the date range is displayed as
2011-04-01..2011-04-30T17, the objects are effective until the end of hour 17 on
the specified day, Date=2011-04-30. Set this preference to TRUE to use this
display format.

• Half open ranges, where the end date is excluded (an effect in/effect out
paradigm). Objects whose effective date range is displayed in a format such as
Date=2011-04-01..2011-05-01 are not effective for the end date, in this case,
Date=2011-05-01. Set this preference to FALSE to use this display format.

29-16 Preferences and Environment Variables Reference PLM00026 11.2


4th Generation Design preferences

Dates must be formatted to ISO 8601 using the server time zone. For example, a
display value of 2011-04-30T17 means 2011-04-30T15:00:00Z if the Teamcenter
server is located in the MET time zone.
TYPE
Logical.
VALID
VALUES
TRUE or FALSE.
DEFAULT
VALUE
FALSE
DEFAULT
PROTECTION
SCOPE
All.

TC_Fnd0Booleansolve_EffectivityIntegerRangeFromTo

DESCRIPTION
4th Generation Design can display effectivity ranges in one of two ways:
• Inclusive unit ranges, where the end value is included (a from/to paradigm).
Objects whose effective unit range is displayed in a format such as Unit=1..10
are effective for the end unit, in this case, 10. Set this preference to TRUE to
use this display format.

• Half open ranges, where the end value is excluded (an effect in/effect out
paradigm). Objects whose effective unit range is displayed in a format such as
Unit=1..10 are not effective for the end unit. Set this preference to FALSE to
use this display format.

TYPE
Logical.
VALID
VALUES
TRUE or FALSE.
DEFAULT
VALUE
TRUE
DEFAULT
PROTECTION
SCOPE
All.

PLM00026 11.2 Preferences and Environment Variables Reference 29-17


Appendix A: Glossary

PLM00026 11.2 Preferences and Environment Variables Reference


Appendix A: Glossary

access control list (ACL)


Access Manager component that contains a list of accessors and, for each accessor, the privileges
granted, denied, and not set.

Access Manager (AM)


Teamcenter application that enables the system administrator to grant users access to Teamcenter
objects.

accessor
Access Manager component that grants or denies privileges to clusters of users who share certain
common traits (for example, perform the same function or work on the same project).

action handler
Handler used to extend and customize workflow task actions. Action handlers perform such actions
as displaying information, retrieving the results of previous tasks (inherit), notifying users, setting
object protections, and launching applications. See also task handler.

action rule
Business rule that defines the actions required in different time phases (precondition, preaction,
and postaction) for create, save as, and delete operations. Action rules are applied to items, item
revisions, and datasets.

active mode
Management of application files that allows their use by both an application and Teamcenter. There
are two categories of active interaction between Teamcenter and an application: encapsulation
and Integration. Compare with passive mode.

AM
See Access Manager (AM).

AP212
See STEP AP212.

appearance
Sequence of occurrences that describes a unique path through an exploded structure. An
appearance corresponds to a unique instance of the component that is referenced by the leaf node
of the path within the top-level assembly. An appearance may have spatial data associated with
it, allowing spatial searches.

Appearance Configuration
Teamcenter application used to configure the use of appearance:
• Defining the appearance sets for which the site tracks appearances.

PLM00026 11.2 Preferences and Environment Variables Reference A-1


Appendix
Appendix A: A: Glossary
Glossary

• Configuring the mapping of occurrence notes into appearance attributes.

appearances
Cache of configured BOM lines in the context of a specific top-line item. Appearances are created
to allow quick searches of the entire structure.

appearance set
Collection of appearances created for an appearance root and updated each time a part is released
within the root product with the appropriate release status.

approver
User who has a signoff in a workflow process regardless of role and group membership. In Access
Manager, the approver accessor is used to allocate privileges that apply to all signoffs (for example,
read access). See also RIG approver, role approver, and group approver.

architecture breakdown
Structure used to lay out, plan, and control evolution of product structures. An architecture breakdown
displays product information in terms of engineering content and product variability, including variant
options and values and defining variant conditions for occurrences.

architecture element
Element contained within the architecture structure, including occurrences, BOM view revisions, ME
appearance path nodes, and so on.

assembly
Compound object that is assembled from other objects and may add additional information to their
interpretation.
• In the context of an assembly, other assemblies are called subassemblies, while noncompound
objects are called components.

• A single-level compound object that is distinct from a multilevel product structure or bill of
materials, which is a hierarchy of assemblies. Assembly data is stored in a BOM view revision.

assigned FSC
FMS server cache assigned as the volume or cache server for an FMS client cache. Each FMS client
cache requires an assigned FSC to provide it with access to files. An assigned FSC is typically
the FSC nearest to the client host. In small deployments, an assigned FSC can also serve as the
parent FSC.

attribute
Named storage variable that describes an object and is stored with the object. Users can search
the database for objects using object attributes.
In an object, an attribute is a name/value pair; in the database, an attribute is a field.

Audit Manager
Teamcenter application that enables a system administrator to create audit definition objects,
enable/disable audit trail logging, and control audit log access. Audit definition objects create audit
logs that users can view from Teamcenter applications. Users can audit any Teamcenter object and
event type with an audit definition.

A-2 Preferences and Environment Variables Reference PLM00026 11.2


Glossary

Authorization
Teamcenter application that enables access control of administrative applications and utilities.

baseline
Collection of items and the relationships between the items that is established to ensure their
continued existence. It enables their configuration to be reconstructed and audited. Baselines are
often created to preserve the state of a design at a particular checkpoint. You can baseline precise or
imprecise structures.

blobby volume
Alternate volume used to store data while backing up volumes and databases. The blobby volume
provides continuous Teamcenter availability.

BOM
Bill of materials.
• 100% BOM
The as sold product configuration, for example, the configuration of a car to be built and shipped
to the dealer.

• 120% BOM
Partial overlay of selected variant conditions. You cannot build the product from a 120% BOM.

• 150% BOM
Overlays of all possible variant configurations. You cannot build the product from a 150% BOM.

See also design bill of materials and manufacturing bill of materials.

BOM view
Teamcenter object used to manage product structure information for an item.

BOM view revision (BVR)


Workspace object that stores the single-level assembly structure of an item revision. Access can be
controlled on the structure (BOM view revision) independently of other data. BOM view revisions are
meaningful only in the context of the item revisions for which they are created.

Business Modeler IDE


Teamcenter application that enables a customer to define data model objects such as business
objects, classes, attributes, lists of values, and rules.

change
Temporary or permanent change to a configuration, design requirement, or documentation.

change order
Teamcenter object that references the problem, originating change requests, solutions, and related
information. A change order contains sufficient information to incorporate the change.

PLM00026 11.2 Preferences and Environment Variables Reference A-3


Appendix
Appendix A: A: Glossary
Glossary

change request
Teamcenter object that requests a change, reference the problem, proposed solutions, and related
information. A change request contains sufficient information to allow a decision to proceed further
with the change.

change type
Template of a change process. Change types are created by a system administrator using the
Business Modeler IDE.

Change Viewer
Teamcenter application used to manage the process of controlling changes to a product's definition
and configuration. Change Viewer provides an auditable history of the objects used in a process,
making an object's uses traceable. A site can use Change Viewer to propose, incorporate, review,
and approve changes. Change Viewer can also be used to track and report change history and to
notify members of changes to their organization.

class
Set of objects that share the same list of attributes but distinguishable by the value the attributes
acquire for specific objects. For example, the Automobile class can be defined by the brand, color,
and price, but each car associated to the Automobile class has a different brand, color, and price
combination.

Classification
Teamcenter application that utilizes a classification hierarchy to categorize product data.

Classification Admin
Teamcenter application that enables a system administrator to define the groups, classes, subclasses,
and views that form the Classification hierarchy.

classification hierarchy tree


Display of the classification structure—groups, classes, subclasses, and views—in a tree-like
structure to maintain context during use of Classification Admin.

clearance database
Teamcenter database that stores the results of clearance analyses performed on assemblies in the
rich client DesignContext, Structure Manager, and Multi-Structure Manager applications.

clearance database server


Server required to enable users to perform clearance analysis in the rich client DesignContext,
Structure Manager, and Multi-Structure Manager applications. A batch process performs a clearance
analysis on an assembly and Teamcenter stores the results in the clearance database.

Client
Role played by a software component of a system when it requests particular services be performed
on its behalf by another entity, a server. See also server.

client tier
Teamcenter architectural tier that comprises the Teamcenter clients, Teamcenter integrations with
third-party applications, and the third-party applications associated with the integrations.

A-4 Preferences and Environment Variables Reference PLM00026 11.2


Glossary

Closure Rule
Rule that controls the scope of the translation of data imported to and exported from Teamcenter.
Closure rules specify how the data structure is traversed by specifying the relationships of interest
and the actions to occur when these relationships are encountered.

component
• Objects used to build up an assembly or subassembly.

• Part in a product structure defined in Teamcenter. A component is the lowest level part in the
product structure: it cannot be broken down into subparts.

configuration context
In Appearance Configuration, a revision rule used to configure the structure. Configuration context
can contain only release status entries.

Data Integration Services Adapter


Teamcenter software component that integrates Teamcenter lifecycle visualization with both the
thin client and the rich client.

dataset
Teamcenter workspace object used to manage data files created by other software applications.
Each dataset can manage multiple operating system files, and each dataset references a dataset tool
object and a dataset business object.

deep copy rule


Business rule that defines whether relational type objects can be copied as object, copied as
reference, or not copied when the user performs a save-as or revise operation.

delivery unit
Subassembly that is manufactured separately and delivered to the assembly plant as a consumed
part. One of the operations in the assembly process uses the delivery unit as a consumed part. The
components of a delivery unit are not consumed in any of the operations.

design bill of materials


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

DesignContext
Teamcenter application that enables users to quickly focus on a particular work part and any parts
affected within the context of a change to that part. Users can select a product item and configure
revisions of components, configure variants of the assembly, review the set of components, retrieve
the components, and initialize their display in a CAD application or a visualization application.

direct model dataset


Dataset containing a JT (visualization) file.

PLM00026 11.2 Preferences and Environment Variables Reference A-5


Appendix
Appendix A: A: Glossary
Glossary

effectivity
Identification of the valid use of an aspect of product data tracked by unit, date, or intent. You can
specify a start definition, end definition, or both for a particular effectivity. There are three types of
effectivities:
• Unit effectivity specifies the range of item units or serial numbers.

• Date effectivity specifies the range of dates. This is also known as an incorporation point.

• Intent effectivity specifies a purpose, target, or milestone, for example, Production, Prototype,
or Carryover.

effectivity rule
Rule used to set effective dates on released products and processes with a released status.

Embedded Software Solutions


Optional extension to Structure Manager and My Teamcenter that allows you to manage embedded
software binaries as part of the product structure.

encapsulation
Active-mode relationship between an application and Teamcenter in which the application is brought
into the Teamcenter environment. Encapsulation allows you to launch the application using a
Teamcenter dataset object, export data to the application, work in the application, and import data
back into the Teamcenter database during a session. The import and export operations between
Teamcenter and the encapsulated application are executed from within Teamcenter and the actual
transfer of files is transparent to the user. See also active mode and Integration.

environment variables script


Teamcenter script (tc_profilevars) that sets variables for the Teamcenter environment. This script
sets all Teamcenter environment variables except TC_ROOT and TC_DATA.

ERP Connect to SAP


Teamcenter integration that allows the controlled, auditable transfer of product information from
Teamcenter to SAP.

FCC
See FMS client cache (FCC).

FCC configuration file


File that configures an individual FMS client cache (fcc.xml). The FCC configuration file defines such
values as the parent FMS server cache location and the location and size of the client caches. Values
defined in the FCC configuration file can override default values defined in the FSC configuration file.

feature
Physical or geometric object associated with a product, component, or part. Alternatively, a logical
attribute of a product, component, or part. Examples: a weld point, a signal, or a geometric pattern.
A feature may be represented by a generic design element (GDE) in a BOM. See also generic
design element.

A-6 Preferences and Environment Variables Reference PLM00026 11.2


Glossary

File Management System (FMS)


System that manages uploading and downloading file data between clients and volumes in both
two-tier and four-tier architecture deployments.
• FMS provides volume servers for file management, a shared server-level performance cache for
shared data access between multiple users, a client-based private user cache for rich clients,
and a transient datastore mechanism for transporting reports, PLM XML, and other nonvolume
data between the enterprise and client tiers.

• FMS file caching enables placing the data close to the user, while maintaining a central file
volume and database store.

find number
Number that identifies individual occurrences (or groups of occurrences) within a single-level
assembly. Components are ordered by find number within an assembly.

FMS
See File Management System (FMS).

FMS client cache (FCC)


FMS process that runs on a client host, uploading files to an FMS server cache process, requesting
files from an FMS server cache process, and caching files on the client host. The FCC process
manages two caches of whole files: a write cache containing files uploaded to a Teamcenter volume
and a read cache containing files downloaded from a Teamcenter volume. It also manages one
segment file cache for Teamcenter lifecycle visualization. Each Teamcenter rich client host requires a
local FMS client cache.

FMS master configuration file


File that configures FMS (fmsmaster.xml). The FMS master configuration file describes the FMS
network and defines groups of server caches. It can also define default values for server caches and
client caches, such as maximum sizes. Values defined in the server cache configuration file and in the
client cache configuration file can override the default values defined in the master configuration file.

FMS master host


Host that contains the FMS master configuration file (fmsmaster.xml). This file is optionally mounted
at each FSC server.

FMS server cache (FSC)


FMS process that runs on a server host and performs as a volume server (when running on a host
where a volume is located or directly mounted) or a cache server (when running on a host where
a volume is not located or directly mounted) and a configuration server. As a volume or cache
server, the FSC checks all file access requests for a ticket that Teamcenter generates to authorize
file access. As a cache server, it manages two segment file caches, one for downloading files and
one for uploading files. As a configuration server, it provides FMS configuration information to file
client caches and other FSCs. As a transient server, it delivers PLM XML and other transient files to
clients. A minimum of one FSC must be deployed in any Teamcenter installation. Multiple FSCs can
be deployed, with each FSC performing one designated purpose as either a volume, a cache, or a
configuration server.

PLM00026 11.2 Preferences and Environment Variables Reference A-7


Appendix
Appendix A: A: Glossary
Glossary

folder
Graphical representation of an aggregation of objects, such as a group, class, or subclass. For easy
distinction in the class hierarchy, each of these aggregations has a different type of folder icon
associated with it: a group folder icon, a class folder icon, or a subclass folder icon.

form type
Special type of the general POM Form class, which can have its own set of properties (attributes)
associated.

FSC
See FMS server cache (FSC).

FSC configuration file


File that configures an individual FMS server cache (fsc.xml). The FSC configuration file defines
such values as the address of the master FSC, the maximum sizes of the segment file caches, and
the upload time-out value. It can also define default values for FCCs and other FSCs.

FSC group
Group of server caches defined in the FMS master configuration file.

GDE
See generic design element.

generic design element


BOM item that cannot have different revisions. See also feature.

Global Services Foundation


web application that enables your enterprise to access information stored in virtually any type of
electronic data source that manages your enterprise data.
Running on a standard commercial web application server, the server components of Global Services
Foundation enable communication among the data sources and between users and the data sources.
All components of Global Services Foundation use standard web technology: Extensible Markup
Language (XML), Extensible Stylesheet Language (XSL), and the Java programming language.
Users access Global Services Foundation from a commercial web browser using the standard
technologies of web browsers, primarily support for HyperText Markup Language (HTML) forms
and small Java applets.

group
Type of class that does not have a list of attributes associated with it; highest level in the classification
hierarchy.

group administrator
User with special maintenance privileges for a group.

group approver
User who is a signoff in a workflow process with a specific group of users. In Access Manager, the
group approver accessor is used in Workflow ACLs and matches the signoff definition (that is, group)
for the release level associated with the Workflow ACL. The group approver accessor ensures

A-8 Preferences and Environment Variables Reference PLM00026 11.2


Glossary

that only signoffs are given privileges, not a user who matches the group. See also approver, RIG
approver, and role approver.

group preference
Teamcenter preference applying to an entire group.

I-deas
Siemens PLM Software’s integrated CAD/CAM/CAE solution that is used to design, analyze, test,
and manufacture products.

IDSM server
Integrated Distributed Services Manager, a network node that runs a daemon process to handle the
transfer of data objects among sites in a Multi-Site Collaboration network. One IDSM server node
must be designated for each Teamcenter database from which objects are published; each server
node can act for one database only.

incremental change
Engineering change that collects several individual changes to components or attachments in a
structure, allowing them to be released simultaneously. An incremental change is released and
effectivity is applied to it by attaching an appropriate release status.

Integration
Active-mode relationship between an application and Teamcenter in which Teamcenter is brought
into the application. The application drives Teamcenter to provide the functionality, such as implicit
checkout when data is modified, and reading and writing data directly from Teamcenter in a secured
way. Data is exported (pushed) and imported (pulled) as needed.

item
Workspace object generally used to represent a product, part, or component. Items can contain other
workspace objects including other items and object folders.

item relation
Description of an association between a Teamcenter item and a piece of information that describes or
is related to the item.

item revision
Workspace object generally used to manage revisions to items.

item revision relation


Description of an association between a Teamcenter item revision and a piece of information that
describes or is related to the item revision.

JT cache
Data Integration Services Adapter cache of JT files managed by the JT cache service and accessible
to Teamcenter lifecycle visualization users. See also world access cache and limited access cache.

PLM00026 11.2 Preferences and Environment Variables Reference A-9


Appendix
Appendix A: A: Glossary
Glossary

JT cache populator
Stand-alone Data Integration Services Adapter utility that prepopulates the JT cache with JT part and
assembly files.

Lifecycle Visualization
Visualization components available in the rich client, the thin client, and as a stand-alone application.
A scalable solution for the viewing and analysis of 2D and 3D product data, Lifecycle Visualization is
available in a number of configurations to meet the requirements of different organizations.

limited access cache


Data Integration Services Adapter cache of JT files that are accessible only to privileged users. The
limited access cache is managed by the JT cache service. Permission checks are performed when a
user accesses a file from the limited access cache. Compare with world access cache.

manufacturing bill of materials


Defines how the product is manufactured, rather than how it is designed. Compare with design
bill of materials.

master form
Teamcenter workspace object used to display product information (properties) in a predefined
template. Master forms are used to display product information in a standardized format.

master FSC
FMS server cache that reads the master configuration file directly from the FMS master host. An
FSC is configured either to read the master configuration file directly from the master host or to
download it from another FSC with access to it.

Mechatronics
Integration of mechanical engineering with electronics and intelligent computer control in the design
and manufacture of products and processes.

Mentor Graphics Integration


Teamcenter integration that allows users to store and manage Mentor Graphics Design Manager
objects in Teamcenter.

Multi-Site Collaboration
Teamcenter capability that allows the exchange of data objects among several Teamcenter
databases. Transfer of objects among databases is controlled by daemon processes running
on designated servers. Objects are replicated by exporting them from their original database and
importing them into the requesting database. Configuration of Multi-Site Collaboration is optional.

Multi-Structure Manager
Teamcenter application that enables users to view and manipulate data in a specific context.

My Teamcenter
In the Teamcenter rich client and thin client, application that is the main access point for managing
product information. My Teamcenter provides the functionality for creating objects in the Teamcenter

A-10 Preferences and Environment Variables Reference PLM00026 11.2


Glossary

database, querying the database for objects, checking in and checking out objects, and managing
tasks. Users can also open objects, automatically launching the related application.
Each user has a personal My Teamcenter window that displays product information as graphical
objects. Although users share product information across the enterprise, they organize this
information individually in personal workspaces.

named ACL
Named group of access controls. See also access control list (ACL).

named reference
File types that are managed by a dataset. Datasets are the only workspace objects that use named
references.

naming rule
Business rule that defines the naming conventions for the string property value in different type
objects. Naming rules can be attached to the following properties:
• Item ID, item revision ID, and name in item types
• Dataset name, ID, and revision number in dataset types
• Name form types

navigation pane
Rich client framework component that displays buttons of the applications available for use in the rich
client. Clicking the application button launches the application.

NX
Siemens PLM Software's next-generation digital product development system that helps companies
transform the product life cycle. It provides the complete life cycle of development processes in
product design, manufacturing, and simulation.

NX Integration
Integration between Teamcenter and NX. NX Integration users have full access to the Teamcenter
user interface from NX, and they can also access NX from the Teamcenter user interface.
Teamcenter Integration for NX and NX Integration have the identical user interface in NX. The
difference between the two products is the level of Teamcenter functionality available. Teamcenter
Integration for NX excludes certain Teamcenter functionality, such as workflow and product structure
editing.

NX Remote Manager
Teamcenter component for managing the import and export of documents into Teamcenter. NX
Remote Manager is a common component across integrations that include applications in fields
such as CAE and ME.

object chooser
Displays objects appropriate for linking with another Teamcenter product. In determining the objects
to display, the object chooser considers the security rights of the person accessing the Teamcenter
product. See also remote workflow.

PLM00026 11.2 Preferences and Environment Variables Reference A-11


Appendix
Appendix A: A: Glossary
Glossary

object directory services server


Multi-Site Collaboration network node that runs a daemon process to handle publication of data
objects within a Multi-Site Collaboration environment. One ODS server node must be designated
for each object directory services site and each server node can act only for one object directory
services site.

object launcher
Launches another Teamcenter product from a linked object. Each Teamcenter product has an object
launcher. See also remote workflow.

occurrence
Hierarchical structure relationship between the immediate parent assembly and its child component
item or item revision in a precise assembly. Sometimes called relative occurrence.

occurrence effectivity
Method of configuring the occurrences in a structure with effectivity. See also effectivity.

ODBC driver
Teamcenter integration that allows ODBC-compliant applications such as Actuate Report Writer,
Crystal Reports, Microsoft Excel, and Access to extract data from a Teamcenter database for
building reports.

ODS server
See object directory services server.

owner
User that owns an object, initially the user who created it. Ownership can be transferred from the
owner to another user. An object owner usually has privileges that are not granted to other users
(for example, the privilege to delete the object).

owning group
Group that owns an object, usually the group of the user creating the object. Because users
commonly share data with other members of a group, additional privileges may be granted to the
owning group (for example, the privilege to write to the object).

owning site
Multi-Site Collaboration site where the master object resides. The owning site is the only site where
the object can be modified.

passive mode
Management of application files from outside an application. Users do not have access to Teamcenter
while running the application in passive mode. Data must be exported (pushed) from Teamcenter
to the application before it can be worked on and then imported (pulled) into Teamcenter after it
has been modified. Compare with active mode.

persistent object manager (POM)


Interface between Teamcenter objects and the Relational Database Management System (RDBMS).
The persistent object manager provides definition of classes by inheritance from other classes and
definition of attributes, manipulation of in-memory objects and support for their saving and retrieval to
and from the underlying RDBMS, support for applications accessing the same data concurrently,

A-12 Preferences and Environment Variables Reference PLM00026 11.2


Glossary

protection against the deletion of data used by more than one application, and support for the access
control lists attributed to objects.

PLM XML
Siemens PLM Software format for facilitating product life cycle interoperability using XML. PLM XML
is open and based on standard W3C XML schemas. Representing a variety of product data both
explicitly and via references, PLM XML provides a lightweight, extensible, and flexible mechanism for
transporting high-content product data over the Internet.

POM
See persistent object manager (POM).

port
Occurrence of an interface port that represents the access point of a functional module in a given
context, for example, a USB 2.0 port on a computer processor.

preference
Configuration variable stored in a Teamcenter database and read when a Teamcenter session is
initiated. Preferences allow administrators and users to configure many aspects of a session, such as
user logon names and the columns displayed by default in a properties table.

preference protection scope


Hierarchical range for which a Teamcenter preference can be set. The protection scope of a
hierarchical preference can be site, group, role, or user.

privileged team member


Project team member with privileges to assign and remove objects from that project. Compare
with project team member.

process
Automation of a business procedure, describing the individual tasks and task sequences required
to complete a business procedure.

product structure
Hierarchy of assembly parts and component parts with a geometric relationship between them, for
example, a bill of materials (BOM). Variant and revision rules define the generic BOM. This BOM can
then be loaded to display the configured variant.

project
Basis for identifying a group of objects available to multiple organizations, such as project teams,
development teams, suppliers, and customers for a particular piece of work.

project team member


Team member who does not have privileges to assign objects to or remove objects from their
projects. Compare with privileged team member.

properties
Keys and values that specify the configuration settings for an application in the Teamcenter rich client.

PLM00026 11.2 Preferences and Environment Variables Reference A-13


Appendix
Appendix A: A: Glossary
Glossary

RDV
See Repeatable Digital Validation.

relation
Description of an association between a Teamcenter object and a piece of information that describes
or is related to the object.

release status
Status associated with a workspace object when it is released through a workflow process.

remote workflow
Teamcenter component that enables users to create links between Teamcenter objects and objects in
other Teamcenter products, such as Teamcenter portfolio, program and project management. Users
can then launch the linked Teamcenter product from within either the rich client or the thin client.

Repeatable Digital Validation


Combination of software and processes that enables on-demand digital mockups for use throughout
the product development lifecycle. Repeatable Digital Validation services are required for using
QPL-based DesignContext.

revision rule
Parameter set by the user that determines which revision of an item is used to configure product
context.

rich client
Java-based user interface to Teamcenter installed on user workstations. The rich client accesses
Teamcenter databases using a remote or local server. Compare to thin client.

rich client framework


Component of the rich client that integrates and runs various applications from a common platform.
These applications can be off-the-shelf applications such as NX CAD/CAM/CAE, Microsoft Office,
custom applications, and Java plug-ins.

RIG approver
User who is a signoff in a workflow process with a specified role and group. In Access Manager, the
RIG approver accessor is used in Workflow ACLs and matches the signoff definition (that is, role
in group) for the release level associated with the Workflow ACL. This accessor ensures that only
signoffs are given privileges, not a user who matches the role in group. See also approver, group
approver, and role approver.

Role
Object that models the type of work a user is expected to perform in a group.

role approver
User who is a signoff in a workflow process with a specific role. In Access Manager, the role approver
accessor is used in Workflow ACLs and matches the sign-off definition (that is, role in group) for the
release level associated with the Workflow ACL. This accessor ensures that only signoffs are given
privileges, not a user who matches the role. See also approver, group approver, and RIG approver.

A-14 Preferences and Environment Variables Reference PLM00026 11.2


Glossary

role preference
Teamcenter preference applying to an entire role.

rule handler
Handler used to integrate workflow business rules into Enterprise Process Modeling processes at the
task level. Rule handlers attach conditions to an action. See also task handler.

rule tree
Access Manager component the system administrator uses to grant users access to Teamcenter
objects. It is a tree of rules and access permissions that when processed determines the access that
each user has to a specified object.

Security Services
Services that eliminate prompts for logon credentials when users switch Teamcenter products
within a user session. Authentication is performed by an external identity service provider, such as
lightweight directory access protocol (LDAP), instead of the Teamcenter product. At a site that
deploys multiple Teamcenter products and Security Services, users log on once to access all
participating Teamcenter products.

server
System software component that performs a specifically defined set of software services on behalf of
one or more clients. In a typical Teamcenter installation, servers are centralized on dedicated hosts
that support a large number of clients. Clients are distributed on hosts connected to the servers via
various networking techniques. See also Client.

single sign-on
Mechanism that allows a user to log on once to multiple services. Following a single sign-on to
Teamcenter, the user is connected to multiple services without logging on to each service.

site
Individual installation of Teamcenter comprising a single Teamcenter database, all users accessing
that database, and additional resources such as hardware, networking capabilities, and third-party
software applications (tools) required to implement Teamcenter at that site.

site ID
Unique identifier of a Teamcenter site. The site ID is used to generate internal identifiers for
Teamcenter objects that must be unique throughout an enterprise. Once established, site IDs should
not be modified.

site name
Unique name of a Teamcenter site stored in the database as a user-defined character string.

site preference
Teamcenter preference that applies to the entire site.

Solid Edge Manager


Teamcenter integration that enables users to use Teamcenter to manage files from within Solid Edge.

PLM00026 11.2 Preferences and Environment Variables Reference A-15


Appendix
Appendix A: A: Glossary
Glossary

STEP AP212
Standard for the Exchange of Product Model Data (STEP) for the Industrial Automation Systems
and Integration – Product Data Representation and Exchange international standard (ISO 10303).
This standard provides a framework through which industries can exchange and share product
information within and between enterprises. AP212 is an application of this standard and describes
the information necessary to customize electrotechnical products.

STEP Translator
Teamcenter application that enables users to import product information into a Teamcenter database
and to export Teamcenter data via STEP-compliant physical files.

Structure Manager
Teamcenter application that enables creation of generic product structures that can be configured
to show the product structure that is in production, effective on a certain date, used by a particular
customer, and so forth. Structure Manager enables creation and modification of a product structure
and its associated occurrence data, display of a product structure in a multilevel indented format, and
viewing graphics tightly coupled to the structure for easy identification of a component by location in
the structure or in the embedded viewer.

subassembly
Assembly that is built into the assembly structure of another assembly or intended for that use. In a
manufacturing view, either a delivery unit or a workpiece. See also delivery unit and workpiece.

subscription
Combination of a workspace object and an event for which a Teamcenter user requests notification
of occurrence. Teamcenter notifies a subscribed user when the event occurs in association with
the object. Users can subscribe to objects from Teamcenter applications, such as My Teamcenter
and Structure Manager.

Subscription Manager
Tool used to find, delete, and modify active subscriptions.

Subscription Monitor
Teamcenter application that enables a system administrator to query subscriptions created in the
database, to monitor and delete subscription events and actions, and to generate statistical reports in
either text or bar chart format regarding subscriptions, events, and actions.

supersedure
Manually created relation that graphically displays deleted components and the components that
replace them. A supersedure is always created in the context of a parent assembly. Therefore,
a single component can be used in more than one supersedure if it is used in different parent
assemblies. A supersedure can be created for changes of part number or of quantity, but not for
changes in a part revision.

system administrator
Teamcenter user who is a member of the system administration group.

A-16 Preferences and Environment Variables Reference PLM00026 11.2


Glossary

task handler
Small Integration Toolkit program or function. Handlers are the lowest level building blocks in
Enterprise Process Modeling. They are used to extend and customize tasks. There are two kinds of
handlers: action handlers and rule handlers. See also action handler and rule handler.

Teamcenter Application Registry


Independent web-based service that allows a Teamcenter product to look up other available
Teamcenter products for launching a linked object. Administrators can register and unregister
installed instances of a Teamcenter product in the registry.

Teamcenter Integration for NX


NX-based entry-level set of Teamcenter data management functions, such as vaulting, checking in,
checking out, revision management, attribute synchronization, and searching CAD data. Teamcenter
Integration for NX manages NX files and their data without exposing the user to full Teamcenter
functionality. Teamcenter Integration for NX users have only limited access to the Teamcenter user
interface.
Teamcenter Integration for NX and NX Integration have the identical user interface in NX. The
difference between the two products is the level of Teamcenter functionality available. Teamcenter
Integration for NX excludes certain Teamcenter functionality, such as workflow and product structure
editing.

Teamcenter Integration for NX I-deas


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

Teamcenter manufacturing process management


Teamcenter manufacturing process design and management system. Teamcenter manufacturing
process management comprises several user applications, for example, Manufacturing Process
Planner, Part Planner, Report Generator, and Resource Manager.

tessellation
Process that translates a CAD file to a visualization file.

thin client
Teamcenter user interface that provides a streamlined browser-based view of product information
stored in a Teamcenter database. The thin client is configured in the web tier, which creates and
serves its web pages to the client. Compare to rich client.

transient volume
Operating system directory controlled by Teamcenter and used to store temporary data for transport
of reports, PLM XML, and other nonvolume data between the web tier and client tier in a deployment
of the Teamcenter four-tier architecture.

PLM00026 11.2 Preferences and Environment Variables Reference A-17


Appendix
Appendix A: A: Glossary
Glossary

user
Definition that is the mechanism by which Teamcenter identifies and interacts with each user. User
definitions contain a name (derived from the person definition), user ID, operating system name,
and password.

user preference
Teamcenter preference applying to a specific user.

variant condition
• Rules applicable to one component in a product structure.

• Condition set on an occurrence to specify the option values required to configure that occurrence
(for example, Load IF engine = 1200).

variant rule
Collection of option values used in determining the variant of the BOM to be configured (for example,
car type = GLS, engine = 1200, gearbox = manual).

volume
Operating system directory controlled by Teamcenter and used to store the files managed by
Teamcenter. When a user performs an action that causes Teamcenter to create a file, the file is
created in the Teamcenter volume. Users cannot directly access the files in Teamcenter volumes;
they must do so via a Teamcenter session.

Web Browser
Teamcenter application that provides access to Internet Web pages from within the rich client
framework. The Web browser is a rich client window that acts as a Web browser, enabling you to
navigate and view Web pages within the rich client rather than switching to a separate Web browser.
The Web browser also provides the ability to access MIME (Multipurpose Internet Mail Extension)
file types and to view files created in other applications, such as Microsoft Word and Excel, through
the Web browser.

workflow
Automation of the concept that all work flows through one or more business processes to accomplish
an objective. Using workflow, documents, information, and tasks are passed between participants
during the completion of a particular process.

Workflow Designer
Teamcenter application that enables administrators to graphically design workflow process templates,
incorporating company business practices and procedures into the templates. Teamcenter users
initiate workflow processes using these templates.

workpiece
Intermediate state of the product during the manufacturing process. In each step of the manufacturing
process, the workpiece is positioned in the work area and the work instructions are performed. The

A-18 Preferences and Environment Variables Reference PLM00026 11.2


Glossary

resulting workpiece then flows to the next operation in the sequence, where the next operation is
performed.

world
All users regardless of group or role.

world access cache


Data Integration Services Adapter cache of JT files that are accessible to all users. The world access
cache is managed by the JT cache service. No permission checks are performed when a user
accesses a file from the world access cache. Compare with limited access cache.

XML object list


Data Integration Services Adapter file that is formatted in XML and provides a list of the parts and
assemblies to be populated into the JT cache.

PLM00026 11.2 Preferences and Environment Variables Reference A-19


Siemens Industry Software

Headquarters
Europe
Granite Park One
Stephenson House
5800 Granite Parkway
Sir William Siemens Square
Suite 600
Frimley, Camberley
Plano, TX 75024
Surrey, GU16 8QD
USA
+44 (0) 1276 413200
+1 972 987 3000

Asia-Pacific
Americas
Suites 4301-4302, 43/F
Granite Park One
AIA Kowloon Tower, Landmark East
5800 Granite Parkway
100 How Ming Street
Suite 600
Kwun Tong, Kowloon
Plano, TX 75024
Hong Kong
USA
+852 2230 3308
+1 314 264 8499

About Siemens PLM Software

© 2015 Siemens Product Lifecycle Management


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

You might also like