Teamcenter 8.

Preferences and Environment

Variables Reference

Publication Number
PLM00026 D
Proprietary and restricted rights notice

This software and related documentation are proprietary to Siemens Product

Lifecycle Management Software Inc.
© 2009 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
All trademarks belong to their respective holders.

2 Preferences and Environment Variables Reference PLM00026 D

Contents

Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Syntax definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Basic configuration concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Basic configuration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4

Introduction to environment variables . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Environment variable script files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Setting environment variables for logging . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Environment variables listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Introduction to preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Preference interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Managing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Teamcenter Integration for NX preferences . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10

Configuration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Business Modeler IDE preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Data management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
NX Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22
Teamcenter linking preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42
Teamcenter LDAP synchronization preferences . . . . . . . . . . . . . . . . . . . . . . . 5-46
Dispatcher preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-59
Mail gateway preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-84
Password preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-86
Full text search preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-89
Teamcenter services preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-96

Access Manager and Portfolio, Program and Project Management

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

eIntegrator Admin preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

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

Audit Manager preferences . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Archive, restore, and migration preferences . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Action Manager daemon preferences . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 8-8
Subscription Manager preferences . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 8-11
Subscription Monitor preferences . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 8-13
File caching preferences . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 8-22
Log file preferences . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . 8-33

PLM00026 D Preferences and Environment Variables Reference 3

Contents

Interface preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Rich client interface preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Thin client interface preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-116

Workflow preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

Change Viewer preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1

Change Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1

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

Requirements Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1
Schedule Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2

Classification Administration preferences . . . . . . . . . . . . . . . . . . . . . . 14-1

Classification preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1

Data sharing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1

Multi-Site Collaboration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1
Data Exchange preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-50
STEP Translator preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-58

Product structure and Repeatable Digital Validation preferences . . . 17-1

Platform Designer preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1
Appearance Configuration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-2
DesignContext preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-10
Multi-Structure Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-41
Structure Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-45
RDV preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-95
Quick spatial search preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-116

Teamcenter’s manufacturing process management preferences . . . . . 18-1

General manufacturing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1
Cloning preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-24
PERT chart preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-29
Accountability check preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-33
Time management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-35
Publishing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-41
PAD preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-51
Manufacturing search preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-53
Enterprise BOP preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-55
GANTT chart viewer preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-65

Visualization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-1

Solution-specific preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1

Aerospace and Defense preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1
Consumer Packaged Goods preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-4
Teamcenter Automotive Edition preferences . . . . . . . . . . . . . . . . . . . . . . . . . 20-4
Teamcenter’s mechatronics process management preferences . . . . . . . . . . . . 20-23

4 Preferences and Environment Variables Reference PLM00026 D

 Contents

Vendor management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-48

MRO core preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-65
As-Built Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-76
Service Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-79

Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1

Application Integration Environment (AIE) preferences . . . . . . . . .. . . . . . . . 21-1
Application Response Measurement (ARM) integration preferences . . . . . . . . 21-4
Configuring computer aided engineering preferences . . . . . . . . . . .. . . . . . . 21-32
Teamcenter Integration for NX I-deas preferences . . . . . . . . . . . . .. . . . . . . 21-45
Mentor Graphics Integration preferences . . . . . . . . . . . . . . . . . . .. . . . . . . 21-46
ERP Connect to SAP preferences . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 21-48
ODBC Driver preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 21-51
ClearCase Integration preferences . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . 21-52

EDA preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22-1

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

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

PLM00026 D Preferences and Environment Variables Reference 5

Chapter

1 Getting started

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

Syntax definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

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

Configure Teamcenter before deploying to other sites . . . . . . . . . . . . . . . . 1-3
Important configuration variables for your initial Teamcenter
implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
What are environment variables? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
What are preferences? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Basic configuration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4

Manually configuring the Teamcenter environment . . . . . . . . . . . . . . . . . 1-4
Running environment variable script files . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Creating and editing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Determining required preference values . . . . . . . . . . . . . . . . . . . . . . 1-5
Creating and editing preferences from the Options dialog box . . . . . . . 1-6
Creating and editing preferences from preference .XML files . . . . . . . . 1-7
Edit a preference XML file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Specify dual OS values for a single preference . . . . . . . . . . . . . . . . . . 1-8

PLM00026 D Preferences and Environment Variables Reference

Chapter

1 Getting started

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 ( Installation on UNIX and Linux Servers Guide, Installation on UNIX
and Linux Clients Guide, Installation on Windows Servers Guide, or Installation on
Windows Clients Guide).
It is also possible to manually configure the Teamcenter environment.
For more information, see Manually configuring the Teamcenter environment.

Prerequisites
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_ This environment variable is used with Visualization
ERROR_LOG_LOC 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 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:

PLM00026 D Preferences and Environment Variables Reference 1-1

Chapter 1 Getting started

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.
Italic Italic text represents values that you supply.
In the preceding example, you supply values for user name and
log 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

Much of Teamcenter behavior and display can be configured with environment
variables and preferences.
• 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. They are read during Teamcenter application usage. Each application
may have associated preferences. Preferences allow you to 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 display in integrations.
You can set preferences in the Teamcenter interface by choosing Edit→Options
to open the Options dialog box. Use the dialog box to search for preferences, set
preference values, create new preferences, and remove existing preferences.
For information about this dialog box, see Getting Started with Teamcenter.
Preferences can also be manually modified in a copy of the tc_preferences.xml
file. After modifying, use the preferences_manager utility to import the file.

1-2 Preferences and Environment Variables Reference PLM00026 D

 Getting started

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.

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 affect 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 interface preferences.

What are environment variables?

Environment 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. Some examples are:
TC_ROOT indicates the top (root) directory of the Teamcenter directory structure.
TC_LIBRARY sets the platform-specific shared display library path.
For additional information, see Introduction to environment variables.

What are preferences?

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.
Set preferences individually in the Options dialog box accessed from the Edit
menu. Update preferences using scripts, or input batches of preferences in the
tc_preferences.xml preference file.
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.
For additional information, see Introduction to preferences.

PLM00026 D Preferences and Environment Variables Reference 1-3

Chapter 1 Getting started

Basic configuration tasks

Teamcenter installation and basic configuration is performed with Teamcenter
Environment Manager. After Teamcenter is installed, additional configuration
is required. Configuration tasks include 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 configuring 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 login. 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:

1-4 Preferences and Environment Variables Reference PLM00026 D

 Getting started

set TC_ROOT=c:\tc2007
set TC_DATA=c:\tc2007\tcdata
call %TC_DATA%\tc_profilevars

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
names the dollar sign ($); 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. 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.

Creating and editing preferences

The behavior and display of Teamcenter applications can be controlled using
preferences and options. Preferences are configuration variables stored in a
Teamcenter database that are 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.
You can manage preferences either through the rich client interface, or by manually
editing the preference XML file.

Determining required preference values

In this guide, the required settings for each preference is listed in the Valid Values
section of each preference description.
In the Teamcenter interface, the Options dialog box displays descriptions of many
available preferences. Most descriptions include an explanation of valid settings.

PLM00026 D Preferences and Environment Variables Reference 1-5

Chapter 1 Getting started

Note
Logical preferences accept a single value from any logical pair (on or off, true
or false, 0 or 1). Values for logical preferences are not case sensitive.
For example, you can require each dataset type to have its own ID counter
by setting the AE_dataset_id_gen_by_type preference with any of the
following values:
ON
on
true
True

Creating and editing preferences from the Options dialog box

In the interface, the Options dialog box enables you to work with a limited set of
preferences in the form of options, which are presented by category. These are
available from the Options tab of the dialog box.
For more information about specific options, see the Rich Client Interface Guide.
You can also work directly with the entire preference set, available from the Index
tab of the dialog box. From this view, you can search for preferences in the database,
modify preference values, delete preferences, and add preferences to the database.
Many basic preferences are shipped with Teamcenter and set with default
settings. These preferences display in the Index tab of the Options dialog box
after installation. Preferences that do not automatically display in this tab after
installation must first be created. Create desired preferences either through this
dialog box, or by editing the preference XML file.
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 Teamcenter administrator can create new categories or subcategories that are
appropriate for your business practices, and assign new or existing preferences to
them. Searches for preferences can be limited to certain categories to obtain results
more quickly.
For information about this dialog box, see Getting Started with Teamcenter.

1-6 Preferences and Environment Variables Reference PLM00026 D

 Getting started

Note
Preferences which 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.

Creating and editing preferences from preference .XML files

You can manually edit preference XML files with an XML editor. Editing a
preference XML file provides greater control over preference definitions, allowing
you to set the type, array and disabled settings, as well as the preference values.
The type setting 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, 0 or 1).

• Integer
Valid values are any positive integer.

• Double
Valid values are paired sets of positive integers (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.

The array setting determines whether multiple values can be set. Setting array
to true allows multiple values to be set for the preference. Setting array to false
allows only a single value to be set for the preference. The array setting can be
set to true for string, integer and double preferences. For logical preferences, the
array must always be false.
The disabled setting determines whether the preference is enabled or disabled.
This can be set to either true or false.
Alternatively, you can manually edit the preference XML files with an XML editor.
Make a copy of the tc_preferences.xml file, apply your changes, then run the
preferences_manager utility to import the file containing your changes.

PLM00026 D Preferences and Environment Variables Reference 1-7

Chapter 1 Getting started

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. Run the preferences_manager utility to import the file containing your

changes.
For more information about this utility, see the Utilities Reference.

Specify dual OS values for a single preference

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.
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 using
the OVERRIDE option.
For more information about this utility, see the Utilities Reference.

1-8 Preferences and Environment Variables Reference PLM00026 D

Chapter

2 Introduction to environment
variables

Environment variable script files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

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

PLM00026 D Preferences and Environment Variables Reference

Chapter

2 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 additional information, see Manually configuring
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 viewing log files, see the Business Modeler IDE Guide.
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 additional information about working with
log files, see Log file preferences.

PLM00026 D Preferences and Environment Variables Reference 2-1

Chapter 2 Introduction to environment variables

Environment variable name Use

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
TC_SQL_DEBUG 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.
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.
TC_JOURNAL 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.
Set to FULL to enable Teamcenter
API_JOURNAL
Integration for NX journalling.

2-2 Preferences and Environment Variables Reference PLM00026 D

 Introduction to environment variables

Environment variable name Use

Determines whether the POM module
TC_POM_JOURNALLING journals nested calls.
Set to N for full journalling.
Accepts the following values:
Y The system log is not deleted,
even if there are no errors.

TC_KEEP_SYSTEM_LOG N The system log is deleted if there

are no errors.
Note
Set to Y to retain the system log.
Accepts the following values:
ON Writes tracebacks to the system
log file.
OFF Does not write tracebacks to
the system log file.
TC_TRACEBACK
Note
When errors occur, the system
writes tracebacks to the system
log file by default. Use this
environment variable to override
the default behavior.

PLM00026 D Preferences and Environment Variables Reference 2-3

Chapter

3 Environment variables

Environment variables listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

PLM00026 D Preferences and Environment Variables Reference

Chapter

3 Environment variables

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

Environment variables listing

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 use 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.
APB_PROJECT_MAX_NUM
Defines the maximum number of projects that can be returned by the Teamcenter
Integration for NX SQL Optimization query. When the number of projects
associated with the object (such as an item, item revision, BOM view revision

PLM00026 D Preferences and Environment Variables Reference 3-1

Chapter 3 Environment variables

or dataset) exceeds the setting in installed procedures, the following message is

added to the system log file:
APB project array out of range and a fallback procedure has been used.
Please set APB_PROJECT_MAX_NUM to at least x and reload the APB procedures
from the apb_cfm.pml and abp_part.pml files for better performance.

In this message, x is the minimum setting required by the APB procedures.

The maximum setting for this variable is 1999.
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_FILE_CACHE
Determines whether file caching is performed during dataset-to-filename
translations. This caching method requires security levels be set to mode-0
and all other caching methods disabled, such as IMF and APB performance
caching. Setting this environment variable to No disables file caching. This
method creates a session-living cache.
API_JOURNAL
Enables journalling of API files. Set to FULL to log all API modules.
API_NO_CACHING
Determines whether any of the following caching methods are performed during
a system operation, such as loading an assembly. Setting this environment
variable to any value prevents all caching methods.
• Item cache contains an array of items found. Each entry is structured to
provide mapping from the Itemid to the tag.
• Item revision cache contains an array of item revisions found. Each entry
is structured to provide mapping from the Itemid/ItemRevid to the tag.
• Refreshed object cached contains an array of refreshed objects found.

API_SET_BYPASS
Set to true to enable DBA bypass of the ACL tree when using import utilities
such as ug_import and 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.
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.

3-2 Preferences and Environment Variables Reference PLM00026 D

 Environment variables

FSC_HOME
Specifies the path where an FMS server cache (FSC) service can find the
configuration files. Typically, this is set to TC_ROOTfsc. This environment
variable is set through the tc_profilevars property file.
FMS_FCCSTARTUPLOG
Enables logging of FCC data. Set to the location (full path and file name) in
which you want the data stored.
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_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.
JRE_HOME
Specifies the path to the Java Runtime Environment (JRE) location. Typically,
this is set to TC_ROOT/install/install/jre. This environment variable is set
through the tc_profilevars property file.
KNOWLEDGEBASE_EVALUATE
Used for conditions. 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 the Business Modeler
IDE Guide.
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 the

PLM00026 D Preferences and Environment Variables Reference 3-3

Chapter 3 Environment variables

UNIX Environment Settings for Non-English Locales table in the Installation

on UNIX and Linux Servers Guide.
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 the
UNIX Environment Settings for Non-English Locales table in the Installation
on UNIX and Linux Servers Guide.
LD_LIBRARY_PATH
Defines the shared display library path for Sun, SGI, and HP platforms. The
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:
Number of Process
LDR_CNTRL setting additional memory limit
segments 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

3-4 Preferences and Environment Variables Reference PLM00026 D

 Environment variables

Number of Process
LDR_CNTRL setting additional memory limit
segments increase
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.
LIB_PATH
Defines the shared display library path for the IBM platform only. The
tc_profilevars script searches for shared display libraries using LIBMODE,
constructs a path statement, and exports LIB_PATH.
LOG_VOLUME_DIR
Specifies the location of the log volume, where the Log Manager transfers logs.
This environment variable is set through the tc_profilevars property file.
LOG_VOLUME_NAME
Specifies the name of the log volume, where the Log Manager transfers logs.
This environment variable is set through the tc_profilevars property file.
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.
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 for 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.

PLM00026 D Preferences and Environment Variables Reference 3-5

Chapter 3 Environment variables

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 higher) 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_profilevars property file.
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_SERVER
Protected variable. Defines the Oracle server network node. Set during
Teamcenter installation and added to the $TC_DATA/tc_profilevars directory.
ORACLE_SID
Protected variable. Defines the unique name of the Oracle database instance
associated with TC_DATA. Set during Teamcenter installation and added to the
$TC_DATA/tc_profilevars directory.
PATH
Defines the tc_profilevars script appends the operating system PATH
environment variable with the full path of the $TC_ROOT/bin directory.
POM_SCHEMA
Protected variable. Defines the .ull file specification (directory path and file
name) of the POM schema file.
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
where $ORACLE_SERVER is the Oracle server network node and ORACLE_SID
is the unique name of the Oracle database instance.
POM_TRANSMIT_DIR
Protected variable. Full file specification (directory path and file name) of the
POM transmit schema file. A separate POM transmit schema file is required 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.

3-6 Preferences and Environment Variables Reference PLM00026 D

 Environment variables

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\VisProdxxx\123\VVCP_error.log).
This log file records all errors occurring 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
This environment variable is 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
This environment variable is 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
This environment variable is 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
This environment variable is used with Visualization Illustration. Determines
the amount of time (in milliseconds) allotted for each PDF conversion to
complete. The default setting is INFINITE.

PUBLISH_PDF_VVCP_DEBUG
This environment variable is 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
This environment variable is 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

PLM00026 D Preferences and Environment Variables Reference 3-7

Chapter 3 Environment variables

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
This environment variable is used with Visualization Illustration. Determines
the amount of time (in seconds) of the timeout 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 timeout.
ROSE
Defines the directory containing the STEP Translator runtime application
files. Set through the 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 runtime data files. Set
through the 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.
SHLIB_PATH
Defines the shared display library path for the Hewlett-Packard platform
only. The tc_profilevars script searches for shared display libraries using
LIBMODE, constructs a path statement, and exports SHLIB_PATH.
TAO_ROOT
Defines the directory in which the TAO object request broker (ORB) is installed.
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
Protected variable. Defines the directory containing Teamcenter binary
files. 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.

3-8 Preferences and Environment Variables Reference PLM00026 D

 Environment variables

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

TC_DATA
Protected variable. Defines the directory containing Teamcenter data
files. This variable is set during Teamcenter installation and added to the
TC_DATA/tc_profilevars property file.
TC_DATA_MODEL
This environment variable is set through the 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.

TC_DISABLE_FLASH
This environment variable is set through the tc_profilevars property file.
TC_FS_SERVICE
Associated with Teamcenter File Service. This environment variable is set
through the 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
This environment variable is set through the tc_profilevars property file.
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_profilevars property file.
TC_INSTALL_DIR
This environment variable is set through the tc_profilevars property file.

PLM00026 D Preferences and Environment Variables Reference 3-9

Chapter 3 Environment variables

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.
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_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
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 directory that error files, log
files and output files are placed.
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_profilevars property file.
TC_no_obsolete_message
Setting this environment variable to any value suppresses ITK warning
messages.
TC_NX_DEFAULT_PART
Defines the default NX part file. This environment variable is set through the
tc_profilevars property file.
TC_ONLINE_HELP
This environment variable is set through the tc_profilevars property file.
TC_PERFORMANCE_MONITOR
Automatically displays the Performance Monitor dialog box in the rich client
after log on and enables SQL tracking statistics.
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. For
additional information, see Manually configuring the Teamcenter environment.

3-10 Preferences and Environment Variables Reference PLM00026 D

 Environment variables

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_profilevars file.
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
Organization, the password text field and blank password checkbox are disabled.
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 via
the identity provider used with Security Services. This environment variable is
optional, and when available is set through the tc_profilevars file.
This environment variable should be set only if Security Services is enabled via
the TC_SSO_SERVICE environment variable.
TC_SSO_LOGIN_PAGE
Determines the URL to which the thin client redirects the log on by setting the
complete URL for the Security Services log on page. This environment variable
is set through the tc_profilevars file.
This environment variable should be set only if Security Services is enabled via
the TC_SSO_SERVICE environment variable.
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 via
the TC_SSO_SERVICE environment variable.
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_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 via
the TC_SSO_SERVICE environment variable.
TC_TMP_DIR
Specifies where the utilities should create temporary files. This environment
variable is set through the tc_profilevars property file.

PLM00026 D Preferences and Environment Variables Reference 3-11

Chapter 3 Environment variables

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_USE_TEST_ATTR_MAPPINGS
Retrieves the test attribute mappings definition rather than the real mapping
file when set to any value.
TC_USER_LIB
Contains user-defined display libraries. If this variable is set in the
environment, the tc_profilevars property file adds this directory to the
LD_LIBRARY_PATH, LIB_PATH, or SHLIB_PATH settings.
TC_USER_MSG_DIR
Contains XML text and error message files.
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_USER_TOOLS
Protected variable. Contains user-defined software applications. Set through the
tc_profilevars property file.
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_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.
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.
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.
TEMP_FILESEARCHPATH
This environment variable is set through the tc_profilevars property file.

3-12 Preferences and Environment Variables Reference PLM00026 D

 Environment variables

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_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_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.
UGII_APISERVER_PROGRAM
Defines the full file specification (directory path and file name) of the UG Hookup
binary. Set through the tc_profilevars property file.
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.
UIL_INCLUDE
Specifies a semicolon-separated list of directories where .uih files to be included
are located.
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_USERFCN
Defines the directory containing NX user function libraries. Set through the
tc_profilevars property file.
UGS_LICENSE_SERVER
Specifies the location of the license server.
The default setting is:
port@host

PLM00026 D Preferences and Environment Variables Reference 3-13

Chapter 3 Environment variables

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.
XFILESEARCHPATH
Protected variable. Defines the directory containing X-Window System resource
definition files. Set through the tc_profilevars property file. If not set,
X-Window System uses the $HOME directory.

3-14 Preferences and Environment Variables Reference PLM00026 D

Chapter

4 Introduction to preferences

Preference interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Options pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Preferences pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Search Options pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Current values buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Organization pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3

Managing preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

Installation and upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Preference scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
User access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Preference precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Generating preference reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
Create preference reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
Migrate preferences to data model objects . . . . . . . . . . . . . . . . . . . . . . . . 4-8

Teamcenter Integration for NX preferences . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10

PLM00026 D Preferences and Environment Variables Reference

Chapter

4 Introduction to preferences

Preferences are special environment variables stored in the Teamcenter database.

They are read during Teamcenter application usage. Each application may have
associated preferences. Preferences allow you to 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 display in
integrations.

Preference interface
Choose Edit→Options to open the Options dialog box. Use the Options dialog box to
search for preferences, set preference values, create new preferences, and remove
existing preferences. For information about this dialog box, see Getting Started
with Teamcenter.
Preferences can also be manually modified in a copy of the tc_preferences.xml file.
After modifying, use the preferences_manager utility to import the file.

PLM00026 D Preferences and Environment Variables Reference 4-1

Chapter 4 Introduction to preferences

1 Options link Displays the Options pane where you work with a
limited set of preferences in the form of options.
For more information, see Options pane.
2 Index link Displays the Preferences pane where you search for
preferences based on a preference name.
For more information, see Preferences pane.
3 Search link Displays the Search Options pane where you search
for preferences based on keywords.
For more information, see Search Options pane.
4 Organization Displays the Organization pane where you view the
link preferences applicable to group, role, and user.
For more information, see Organization pane.

Options pane
You can work with a limited set of preferences. Use the Options pane of the Options
dialog box to configure preferences.
Option details display when an option is selected from the Options tree. Option
details optionally have tabs of data to separate option configurations.

Preferences pane
The Index link displays the Preferences pane of the Options dialog box. The
Preferences pane enables you to work directly with the entire preference set.

From the Preferences pane, you can:

• Search for preferences in the database.

4-2 Preferences and Environment Variables Reference PLM00026 D

 Introduction to preferences

• Modify preference values.

• Delete preferences.

• Add preferences to the database.

• Create new categories for organizing preferences.

• Import and export preferences.

• Report customized preferences.

Search Options pane

The Search link displays the Search Options pane of the Options dialog box. The
Search Options pane enables you to work directly with the entire preference set.
The Search Options pane operates similar to the Preferences pane, but with
additional search features.
From the Search Options pane, you can
• Search for preferences based on keywords.

• Select search in options of keys, description, and values.

• Select match options for case sensitivity and entire word.

• Specify a wildcard character.

Current values buttons

Remove Remove the selected value from the list.
Up Move the selected value up one position in the list.
Down Move the selected value down one position in the list.
Sort Order the values alphabetically.
Add Add the new value entered in the box to the list.
Modify Update the selected value with the new value entered
in the box.

Organization pane
The Organization link displays the Organization pane of the Options dialog box.
The Organization pane enables you to view preferences based on groups, roles and
users in the organization.

PLM00026 D Preferences and Environment Variables Reference 4-3

Chapter 4 Introduction to preferences

From the Organization pane:

• Users can see the preference applicable to their site, group, role and user scopes,
but they cannot see other users’ preferences.

• Group administrators can see the preferences for the site, the group that they
administrate, and roles and users belonging to the group.

• A system administrator can see all the preferences for the site, groups, roles,
and users.

Managing preferences
When working with preferences, you must take each preference’s scope into
consideration. The scope of a preference determines both user access to the
preference and precedence of its behavior when there are multiple incidences of the
same preference. Preference scope is displayed in the Details view of the Options
dialog box. When an existing preference is selected, its scope displays to the right
of the Name box. For additional information about this dialog box, see the Rich
Client Interface Guide.

4-4 Preferences and Environment Variables Reference PLM00026 D

 Introduction to preferences

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.

Preference scope
The scope of a preference determines user access to the preference. A user’s current
group/role logon determines which existing preferences he can modify, and the scope
assigned to any newly created preference. The scope of the selected preference
displays to the right of the Name box in the Options dialog box.
The scope of a preference also determines its precedence when there are multiple
instances of the same preference in the database. For example, when one instance
of the preference for displaying the NX button in the Teamcenter toolbar is set by
a system administrator as a site preference, and another instance of the same
preference is set by an individual user as a user preference, the preference’s scope
determines which instance is given precedence.

User access
When accessing existing preferences in the Options dialog box, a user’s current
group/role logon determines which preferences can be modified. For example, a
user logged on as Engineering/Designer could modify all Engineering group
preferences and all Designer role preferences. The user could not modify other role
preferences, such as Reviewer, Manager, or Tester. Users belonging to multiple
groups and roles must change their group/role logon to modify preferences affecting
other groups or roles.
• Users logged on with system administrative access can modify all preferences.
• Users logged on with group administrative access can modify preferences with a
scope of Group, Role, or User.
• Users logged on with general user access can modify preferences with a scope
of User.

When a user creates a new preference in the Options dialog box, the current
group/role log determines the type of scope that can be assigned to the preference.
The Create New Preferences boxes differ, depending upon the user’s current logon
settings. For example, site preferences can only be created by users logged on with

PLM00026 D Preferences and Environment Variables Reference 4-5

Chapter 4 Introduction to preferences

administrative access. A user logged on as dba/dba can modify site preferences. A

user logged on as Engineering/Designer cannot.
• Users logged on with system administrative access can choose User, Role,
Group, or Site scope from the Scopes box.
• Users logged on with group administrative access can choose User, Role, or
Group scope from the Scopes box. The Site scope option is unavailable.
• Users logged on with general user access are not shown the Scopes box. Any
preference created is automatically assigned User scope.

Preference precedence
Preferences are stored as XML strings in specific tables in the database. Preference
scope determines in which table a preference is stored. Data from the site table
is loaded during server startup and data from the other table is loaded at user
logon. Only data from the current logon credentials are loaded. Preference scope
also determines the order in which the system searches through the tables for the
preference and its values.
The following list defines how the preferences are searched from the Teamcenter
database:
• User
When scope is User, the system searches through preference data in the
following order: User, Role, Group, Overlay, Site.

• Role
When scope is Role, the system searches through preference data in the
following order: Role, Group, Overlay, Site.
If the user changes group or role settings during a session, the appropriate group
and role preferences are loaded.

• Group
When scope is Group, the system searches through the preference data in the
following order: Group, Overlay, Site.
If the user changes group or role settings during a session, the appropriate group
and role preferences are loaded.

• Site
When scope is Site, the system searches through the preference data in the
following order: Overlay, Site.

• All
When scope is ALL, the system searches through the preference data in the
following order: environment variables, User, Role, Group, Overlay, Site.

Keeping the rules of user access and preference precedence in mind, consider the
following example:
A site administrator uses the search feature in the Options dialog box to search for
the TC_inbox_interval preference and to set it at 20, causing the system to check
inboxes for new tasks every 20 minutes. A user with very few tasks creates another

4-6 Preferences and Environment Variables Reference PLM00026 D

 Introduction to preferences

instance of this preference and sets it at 0, causing the system to check his inbox for
new tasks only once per session, at logon.
The site administrator created the preference while logged on with a group/role
of dba/dba. The user created the preference while logged on with a group/role of
accounting/auditor.
When the auditor logs on, the system automatically checks his user preferences.
Finding an instance of the TC_inbox_interval preference, the system performs
the behavior directed by the preference’s value, and checks the auditor’s inbox for
new tasks only at logon. The system then continues to check the other scopes in
precedence order. When it reaches the overlay preferences, it once again finds an
instance of the TC_inbox_interval preference. Because a user preference setting
takes precedence over an overlay setting, the system continues to perform the
behavior directed by the user’s setting.

Generating preference reports

You can generate reports that list the changes that have been made to site
preferences at your site, and reports that list all the logged-on user’s group, role, and
user preferences in the database. The following reports can be created:
• The Site preference report lists the difference between the off-the-shelf (COTS)
preferences delivered in the tc_preferences.xml file and any new preferences
added to the database. Use this report to determine which custom preferences
have been created at your site.

• The Group preference report lists all preferences stored for your current
logged-on group.

• The Role preference report lists all preferences stored for your current logged-on
role.

• The User preference report lists all preferences stored under your current user
ID.

Create preference reports

Generate reports that list the user, group, role, or customized site preferences in
your database. If desired, you can export the report to a file.
1. Click Report in the Index tab of the Options dialog box.
The Report dialog box appears.

2. Select the scope for which you want a report: User, Role, Group, or Site.
The Report Changes dialog box lists all the preferences of the selected scope
which have been changed, providing the original and current values. Use
the forward and back buttons at the top of the dialog box to view the various
preferences.

3. (Optional). To export the report, type a path and file name in the Export File
Name box (or browse to an existing file) and click Export.
The preference report is exported to the specified file in XML format.

PLM00026 D Preferences and Environment Variables Reference 4-7

Chapter 4 Introduction to preferences

Migrate preferences to data model objects

Some preferences are converted to Business Modeler IDE template data model
objects, such as business object constants. This centralizes data model-dependent
preferences in the Business Modeler IDE. If your database contains any of the
converted preferences, you must migrate them using the Preferences Migration
wizard.
The following preferences are converted:
• ItemRevision-business-object_Maturity_Level
These preferences set the status that an item revision must reach to be
considered mature. These preferences are obsolete and are migrated to values on
the MaturityStatuses business object constant. For example, if your database
had a DocumenRevision_Maturity_Level preference set to the Frozen value,
it is migrated to the Frozen value on the MaturityStatuses business object
constant on the DocumentRevision business object.
For more information about the MaturityStatuses business object constant,
see the Business Modeler IDE Guide.
Note
If you are upgrading from an earlier version of Teamcenter, you should
verify that all of your relation properties are now managed in the
Business Modeler IDE. To verify, look in your preferences for each
<relation_type>_relation_primary preference that you added, and add it
to your custom template in the Business Modeler IDE.

To find any custom preferences that fit the converted preferences, choose
Edit→Options→Index in the My Teamcenter application in the rich client. If you
find that your database contains at least one of the converted preferences, you must
perform the following steps to migrate the preferences:
1. Use the preferences_manager utility to extract site level preferences from
your current database. This is the database currently in use at your site and
not yet upgraded.
Run the command from the Teamcenter command prompt:
preferences_manager –u=user-name –p=password –g=group
–mode=generatexml -context=Teamcenter
–out_file=c:\temp\exported_preferences.xml

This extracts all the site-level preferences to the specified XML file.

2. In the Business Modeler IDE, choose File→New→Other, and in the Select

a wizard dialog box, choose Business Modeler IDE→Preferences Migration
Wizard. Click Next.

3. In the Preferences Migration dialog box, perform the following steps:

a. Click the arrow in the Project box to select the project that the preferences
will be migrated into.

b. Click the Browse button to the right of the Preferences XML File to locate
the output XML file that resulted from running the preferences_manager
utility.

4-8 Preferences and Environment Variables Reference PLM00026 D

 Introduction to preferences

c. Click Finish.
A project/install/cleanup_preferences.txt file is created that contains the
list of preferences to be deleted from the database. Do not delete this file.
This file must be maintained in your source control. This file is packaged
when you run the Package Template Extensions wizard in the Business
Modeler IDE and is used during the database upgrade to remove the
converted preferences from the database.
In addition, a project/output/upgrade/preferences_migration.log file is
created that contains the migration log.

4. To verify the migration, in the Business Modeler IDE, open the new business
objects that are created by the migration process. Ensure that the Business
Object Constants table contains the new business object constants.
Note
Only the custom ItemRevision-business-object_Maturity_Level
preferences are migrated into the project as business object constants.
All the other preferences are ignored. The preferences are migrated to
business objects named ItemRevision-business-object_Maturity_Level,
and the MaturityStatuses business object constant is applied to these
new business objects.

5. To save the changes to the data model, choose File→Save Data Model, or click
the Save Data Model button on the main toolbar. This saves template extension
files that now contain preferences converted to template elements.

6. Update the customer upgrade script to remove the migrated preferences

from the database during upgrade of the customer database. This step
ensures that when the database is upgraded, the obsolete preferences listed in
cleanup_preferences.txt also get deleted from the database.
a. Open the upgrade_template-name_vversion.default file. If this file does not
exist, create one using your old upgrade_template-name_vversion.default
script as an example.

b. Add the following text in the post-non-schema-delete section of the file:

preferences_manager -u=infodba -p=${TC_USER_PASSWD} -g=dba -mode=remove
-scope=SITE
-file=${TC_INSTALL_DIR}/template-name/cleanup_preferences.txt

Replace template-name with the name of your custom template.

7. Update your existing custom preferences data file. You may have a custom
preferences data file that installs custom preferences to your database. If this
file contains any of the preferences just migrated, remove them from this file.
This is to ensure that the preference data file does not continue installing any
of the migrated preferences.

PLM00026 D Preferences and Environment Variables Reference 4-9

Chapter 4 Introduction to preferences

Teamcenter Integration for NX preferences

Teamcenter Integration for NX preferences control how Teamcenter interacts with
NX, such as the way part data is displayed in the rich client, or how changes made in
Teamcenter are reflected in NX assemblies and parts. Preferences controlling this
functionality are listed in the NXManagerUnigraphics category of the Options
dialog box, accessed from the Edit menu. These preferences have preference over
Teamcenter preferences. For information about setting these preferences, see the
Rich Client Interface Guide.

4-10 Preferences and Environment Variables Reference PLM00026 D

Chapter

5 Configuration preferences

Business Modeler IDE preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

AltIdentifier_require_on_create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
ASSIGNED_ITEM_ID_MODIFIABLE . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
ASSIGNED_ITEM_REV_MODIFIABLE . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
BMF_CUSTOM_IMPLEMENTOR_PATH . . . . . . . . . . . . . . . . . . . . . . . . 5-2
BMIDE_ALLOW_DEPLOYMENT_FROM_CLIENT . . . . . . . . . . . . . . . . . 5-3
Bypass_property_rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
IdentifierContextPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
IdentifierLengthPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
ITEM_autogenerate_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
METHOD_CM_execute_before_custom . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
NR_BYPASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
TC_dataset_deep_copy_rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5

Data management preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6

AE_dataset_id_usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
AE_dataset_id_use_rev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7
AE_dataset_id_gen_by_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7
AE_dataset_id_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7
AE_dataset_id_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8
AE_dataset_id_postfix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8
baselineDryRun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8
Baseline_dryrun_always . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8
Baseline_precise_bvr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Baseline_nxmanager_refile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Baseline_refile_not_required_item_types . . . . . . . . . . . . . . . . . . . . . . . . . 5-10
Baseline_refile_required_dstypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10
Baseline_allow_edits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10
Baseline_release_procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11
Baseline_restricted_item_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11
Baseline_allowed_baserev_statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11
USER_baseline_dryrun_validator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
Baseline_create_snapshot_folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
BOB_property_optimizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
IDENTIFIER_idincontext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13
ITEM_baseline_rev_msg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13
TCDefaultKeepLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
SOACAD_checkout_required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
TCDefaultKeepLimitByType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
license_warning_level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
TC_language_default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15
TC_language_data_entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16
TCCheckoutReserveOnly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17

PLM00026 D Preferences and Environment Variables Reference

 CheckoutOnCreatePref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
TC_check_object_before_create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
ItemCreation.NoMasterForm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
TC_session_clearance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19
IP_level_list_ordering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
ADA_enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
ADA_saveas_propagated_license_types . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
TC_multi_site_ada_license_user_bypass . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
ITAR_level_list_ordering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22

NX Integration preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22

Preferences set in the .tc_preferences.xml file . . . . . . . . . . . . . . . . . . . . . 5-23
API_ugpart_attr_titles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
DATASET_saveas_allow_duplicates . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
DATASET_saveas_allow_name_modification . . . . . . . . . . . . . . . . . . . 5-24
DATASET_saveas_always_copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24
DATASET_saveas_force_name_validation . . . . . . . . . . . . . . . . . . . . . 5-25
DATASET_saveas_never_copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-25
DATASET_saveas_owner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
DATASET_saveas_pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
<DATASET TYPE>_saveas_pattern . . . . . . . . . . . . . . . . . . . . . . . . . 5-27
NX_InterOptWithProductViewDataset . . . . . . . . . . . . . . . . . . . . . . . 5-28
TC_default_part_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
TC_NX_allow_attrsync_master_with_item . . . . . . . . . . . . . . . . . . . . 5-28
TC_NX_Allow_Deepcopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29
TC_NX_ATTRIBUTES_FORM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29
TC_NX_Database_Attributes_For_Load . . . . . . . . . . . . . . . . . . . . . . 5-30
TC_NX_DeleteMarkupsOnDrawingSheetImport . . . . . . . . . . . . . . . . 5-31
TC_NX_DrawingSheet_Deletion_Pattern . . . . . . . . . . . . . . . . . . . . . 5-32
TC_NX_Foreign_Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32
TC_ugmaster_name_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33
TC_NX_Navigator_Override_NX_Load_Option . . . . . . . . . . . . . . . . . 5-33
TC_NX_NEW_COPY_REV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33
TC_NX_NEW_NR_FORMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34
TC_NX_nonmaster_additional_forms . . . . . . . . . . . . . . . . . . . . . . . . 5-34
TC_NX_save_precise_on_uprev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
TC_NX_Unit_Of_Measure_As_Geometric_List . . . . . . . . . . . . . . . . . . 5-35
TC_NX_Unit_Of_Measure_Each_List . . . . . . . . . . . . . . . . . . . . . . . . 5-35
TC_NX_UPDATE_ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36
TC_NX_View_Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36
TC_SPSD_FOLDER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
TC_SPSD_FOLDER_PATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
TC_USE_TEST_ATTR_MAPPINGS . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
Preferences set in the .tc_ugman_env file . . . . . . . . . . . . . . . . . . . . . . . . 5-38
UGMAN_InsertItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
UGMAN_PartType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38
UGMAN_ShowPartType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
UGMAN_UGPARTNameWRev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
Preferences set in the ug_english.def file . . . . . . . . . . . . . . . . . . . . . . . . . 5-39
UGhookupStructureUpdateOnSave . . . . . . . . . . . . . . . . . . . . . . . . . 5-40
UGhookupStructureUpdateOnLoad . . . . . . . . . . . . . . . . . . . . . . . . . 5-40
UGhookupPartDisplayPreference . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40
Preferences set in the .ugii_env file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41
TRACE_BACK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41

Preferences and Environment Variables Reference PLM00026 D

 UGII_KEEP_SYSTEM_LOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41
UGII_OPTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-41
UGII_TMP_DIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42

Teamcenter linking preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42

TC_external_local_app_guid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43
TC_external_proxiable_objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43
TC_external_proxiable_objects_props . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43
TC_external_Requirements_proxy_props_internal . . . . . . . . . . . . . . . . . . 5-44
TC_external_Requirements_proxy_props_external . . . . . . . . . . . . . . . . . . 5-44
IMAN_external_appl_reg_url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
TC_external_application_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45
TC_external_application_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45

Teamcenter LDAP synchronization preferences . . . . . . . . . . . . . . . . . . . . . . . 5-46

LDAP connection preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-46
LDAP_service_hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-46
LDAP_port_number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47
LDAP_use_ssl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47
LDAP_cert_db_path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48
LDAP_admin_dn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48
LDAP_admin_pw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48
Synchronization Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49
LDAP_sync_user_flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49
LDAP_sync_group_flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49
LDAP_sync_member_flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50
LDAP_sync_role_flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-51
LDAP_member_list_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-51
LDAP_member_type_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-52
LDAP_object_type_attr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-52
Group Object Mapping Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-52
LDAP_group_base_dn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-52
LDAP_group_query_filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-53
LDAP_group_object_class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-53
LDAP_group_attr_mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-54
Role object mapping preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-54
LDAP_role_query_filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-55
LDAP_role_object_class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-55
LDAP_role_attr_mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-55
User and person object mapping preferences . . . . . . . . . . . . . . . . . . . . . . 5-56
LDAP_attribute_mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-56
LDAP_base_dn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-57
LDAP_ignore_users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-57
LDAP_user_query_filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-58
LDAP_user_object_class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-58
LDAP_person_attr_mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-58

Dispatcher preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-59

DISPATCHER_CLIENT_INSTALLED . . . . . . . . . . . . . . . . . . . . . . . . . . 5-60
ETS.Repeating_UI.<ProviderName>.<ServiceName> . . . . . . . . . . . . . . . . 5-60
ETS_available . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-60
ETS_home . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-61
ETS_trans_rqst_referenced_dataset_types . . . . . . . . . . . . . . . . . . . . . . . 5-61
ETS_update_state_delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-62

PLM00026 D Preferences and Environment Variables Reference

 ETS_released_status_type_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-62
ETS_trans_rqst_user_exit_states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-62
TC_register_internal_service_modules . . . . . . . . . . . . . . . . . . . . . . . . . . 5-63
IDEAS_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-63
IDEAS_import_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . 5-64
IDEAS_translation_dataset_type_names . . . . . . . . . . . . . . . . . . . . . . . . . 5-64
UGSideastojt_IdeasAssembly_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . 5-65
UGSideastojt_IdeasDrawing_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . 5-65
UGSideastojt_IdeasPart_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . 5-65
IDEAS_import_from_tdm_gen_vis_data_display . . . . . . . . . . . . . . . . . . . 5-66
IDEAS_import_from_tdm_default_gen_vis_data_priority . . . . . . . . . . . . . 5-66
IDEAS_import_from_tdm_gen_vis_data_input . . . . . . . . . . . . . . . . . . . . . 5-67
IDEAS_import_from_tdm_options_default_gen_vis_data_priority . . . . . . . 5-67
IDEAS_check_in_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . 5-67
IDEAS_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . 5-68
IMAN_capture_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-69
CATIA_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-69
CATIA_check_in_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . 5-70
CATIA_checkin_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . 5-70
CATIA_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . 5-70
COMMONcatiatojt_CATPart_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . 5-71
COMMONcatiatojt_CATProduct_ets_nr_types . . . . . . . . . . . . . . . . . . . . . 5-71
COMMONcatiatojt_ets_ds_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-72
CATIA_work_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-72
CATIA_V4_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-72
CATIA_V4_check_in_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . 5-73
CATIA_V4_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . 5-73
COMMONcatiatojt_catia_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . 5-74
COMMONcatiatojtV4_ets_ds_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-74
NX_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-75
NX_tocgm_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-75
NX_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . . . 5-76
NX_tocgm_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . 5-76
UGSnxtocgmdirect_UGALTREP_ets_nr_types . . . . . . . . . . . . . . . . . . . . . 5-77
UGSnxtocgmdirect_UGMASTER_ets_nr_types . . . . . . . . . . . . . . . . . . . . 5-77
UGSnxtocgmdirect_UGPART_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . 5-77
UGSnxtocgmdirect_UGSCENARIO_ets_nr_types . . . . . . . . . . . . . . . . . . 5-78
UGSnxtocgmdirect_ets_ds_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-78
UGSnxtopvdirect_UGALTREP_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . 5-79
UGSnxtopvdirect_UGMASTER_ets_nr_types . . . . . . . . . . . . . . . . . . . . . 5-79
UGSnxtopvdirect_UGPART_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . 5-79
UGSnxtopvdirect_ets_ds_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-80
IMAN_Drawing_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-80
UGMASTER_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-81
UGPART_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-81
PROE_translation_service_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-81
PROE_on_demand_generate_vis_data_priority . . . . . . . . . . . . . . . . . . . . 5-82
UGSproetojt_ProPrt_ets_nr_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-83
UGSproetojt_ets_ds_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-83
VIS_simpgen_admin_group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-83

Mail gateway preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-84

Folder_mail_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-84
Mail_server_charset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-84

Preferences and Environment Variables Reference PLM00026 D

 Mail_server_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-84
Mail_server_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-85
Mail_OSMail_activated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-85
TC_use_tc_alias_in_pa8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-85
TC_mail_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-86

Password preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-86

PASSWORD_minimum_characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-87
PASSWORD_special_characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-87
PASSWORD_mixed_case_required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-87
PASSWORD_minimum_special_chars . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-88
PASSWORD_minimum_digits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-88
PASSWORD_minimum_alpha . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-88

Full text search preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-89

TC_fts_engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-89
TC_fts_host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-89
TC_fts_aci_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-90
TC_fts_index_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-90
TC_fts_query_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-91
TC_fts_service_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-91
TC_fts_default_language_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-91
TC_fts_fsf_host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-92
TC_fts_fsf_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-92
TC_fts_database_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-93
TC_fts_indexing_wait_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-93
TC_fts_index_retries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-94
TC_fts_index_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-94
<TypeName>_indexed_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-94
TC_fts_max_results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-95
TC_fts_indexed_types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-95
TC_fts_real_time_indexing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-96

Teamcenter services preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-96

SOA_MaxOperationBracketInactiveTime . . . . . . . . . . . . . . . . . . . . . . . . 5-96
SOA_MaxOperationBracketTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-97

PLM00026 D Preferences and Environment Variables Reference

Chapter

5 Configuration preferences

Configuration preferences modify the underlying behavior of the rich client. These
preferences should be considered and set before deploying Teamcenter throughout
the site.
Preferences are typically set using the Options dialog box, accessed from the
Edit menu. As you create/modify preferences, your current group/role determines
both user access to the preference and the precedence of its behavior when there
are multiple incidences of the same preference. For additional information, see
Preference scope.

Business Modeler IDE preferences

Business rules are fundamental objects used to model business data. They govern
how objects are handled, including how they are named, what actions can be taken
on them, and so on. Creating business rules is also known as business modeling.
Business rules can be exported to and imported from other Teamcenter sites to
create consistent behavior at multiple sites. You use the Business Modeler IDE
application. For additional information, see the Business Modeler IDE Guide.
Use Business Modeler IDE preferences to modify the behavior of the Business
Modeler IDE application.

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.
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-1

Chapter 5 Configuration preferences

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
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
SCOPE
Site preference.

BMF_CUSTOM_IMPLEMENTOR_PATH
DESCRIPTION
Defines the full path to custom libraries where any custom methods for the Business
Modeler IDE framework are maintained.
VALID
VALUES
Accepts a single string as value. Must be a valid file location.

5-2 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

DEFAULT
VALUES
None.
SCOPE
Site preference.

BMIDE_ALLOW_DEPLOYMENT_FROM_CLIENT
DESCRIPTION
Determines whether Business Modeler IDE clients can deploy templates to the
server. Templates contain all the custom defined extensions managed by the
Business Modeler IDE, such as classes, business objects, business rules, LOVs,
change tools, notes, and so on.
Set this preference to False if you are running production servers so the server
cannot be inadvertently updated from a Business Modeler IDE client. Use this
setting to schedule a server down time to update the schema using the Teamcenter
Environment Manager install wizard.
Set this preference to True if you are running test servers 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
SCOPE
Site preference.

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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-3

Chapter 5 Configuration preferences

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
@
SCOPE
User 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
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.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid Teamcenter
item type.
DEFAULT
VALUES
None.
SCOPE
Site preference.

5-4 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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.
SCOPE
Site preference.

NR_BYPASS
DESCRIPTION
Allows you to bypass naming rules, when your group is the System Administrator
group.
VALID
VALUES
On Allows system administrators to bypass naming rules.
Off Prevents system administrators from bypassing naming rules.
DEFAULT
VALUES
Off
SCOPE
All.

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

PLM00026 D Preferences and Environment Variables Reference 5-5

Chapter 5 Configuration preferences

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:
*:*:*
DEFAULT
VALUES
UGMASTER:IMAN_Rendering:DirectModel
UGPART:IMAN_Rendering: DirectModel
UGALTREP:IMAN_Rendering:DirectModel
DirectModel:TC_Derived:NXDerived
SCOPE
Site preference.

Data management preferences

Data management determines how Teamcenter manages the data from general user
applications such as My Teamcenter and Structure Manager.
Use data management preferences to modify the behavior of these applications.

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.
OFF Dataset ID and Revision ID fields are not displayed. Automatic generation
of dataset names is enabled.
DEFAULT
VALUES
OFF
SCOPE
Site preference.

5-6 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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
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.
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
SCOPE
Site 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.
DEFAULT
VALUES
A dash (-).
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-7

Chapter 5 Configuration preferences

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.
SCOPE
User 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.
SCOPE
User preference.

baselineDryRun
DESCRIPTION
Specifies whether or not to perform a dry run of the baseline creation. A dry run
produces a report listing error messages encountered while processing a single item
revision or traversing a structure.
VALID
VALUES
0 Does not perform a dry run of the baseline creation.
1 Performs a dry run of the baseline creation.
DEFAULT
VALUES
0
SCOPE
Site preference.

Baseline_dryrun_always
DESCRIPTION
Specifies whether or not a dry run occur 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.

5-8 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

VALID
VALUES
0 No automatic dry run. However, users can perform a dry run as a separate
action.

1 A dry run always occur before the actual Baseline is created.

DEFAULT
VALUES
1
SCOPE
Site 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 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
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.

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
SCOPE
Site preference or user preference.

PLM00026 D Preferences and Environment Variables Reference 5-9

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

5-10 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

DEFAULT
VALUES
OFF
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. For additional information, see Creating baseline
process templates in Workflow Designer Guide. 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.
DEFAULT
VALUES
None.
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.
VALID
VALUES
Valid Teamcenter item types.
DEFAULT
VALUES
None. The values EngChange and Document are commented out.
SCOPE
Site preference.

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.

PLM00026 D Preferences and Environment Variables Reference 5-11

Chapter 5 Configuration preferences

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.
SCOPE
Site preference.

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.

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.
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
SCOPE
Site preference.

BOB_property_optimizations
DESCRIPTION
Defines the set of BOB property optimizations applied to object property policy.

5-12 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

VALID
VALUES
Accepts one or more of the following strings as valid values:
none
all
grmCaching
compPropQuery
formBatchLoading
DEFAULT
VALUES
all
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
SCOPE
Site preference.

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

PLM00026 D Preferences and Environment Variables Reference 5-13

Chapter 5 Configuration preferences

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.
VALID
VALUES
Accepts a single string as a value. Must be a single, positive integer more than zero.
DEFAULT
VALUES
3
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 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
SCOPE
Site preference.

5-14 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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 logon, the system
automatically removes the oldest sequence when the limit specified with this
preference is reached.
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.
SCOPE
Site preference.

license_warning_level
DESCRIPTION
Specifies the threshold of available Teamcenter feature licenses. Teamcenter
displays a warning message when you create or modify a user if the number equals
the value in this preference.
VALID
VALUES
Accepts a single string as value. Must be a single, positive integer more than zero.
DEFAULT
VALUES
5
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.

PLM00026 D Preferences and Environment Variables Reference 5-15

Chapter 5 Configuration preferences

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:
tw
ru
kr
jp
it
fr
es
en
de
cz
cn
DEFAULT
VALUES
en
SCOPE
Site preference.

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.

• 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 the above situations apply, the requested locale is served.

5-16 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be one of the following country
codes indicating the desired locale:
tw
ru
kr
jp
it
fr
es
en
de
cz
cn
DEFAULT
VALUES
None.
SCOPE
Site 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 cancelled, the business object’s contents
are not restored to their original values. 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.
Note
If any type of item revision is specified with this preference, sequences are
disabled for that item revision type. The Undo Checkout action will not
discard changes made after the item revision was checked out.

VALID
VALUES
Accepts multiple strings as values. Each string must be a business object which can
be checked in and out.
DEFAULT
VALUES
Item
Folder
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-17

Chapter 5 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
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
SCOPE
All.

ItemCreation.NoMasterForm
DESCRIPTION
Determines whether master forms are automatically created when an item is
created. Use this preference to specify the business objects for which you do not
want master forms automatically created. When users create new business objects

5-18 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

of the types specified with this preference, master forms are not created as part of
the business object and the Enter Item Master Form Information and the Enter Rev
Master Form Information steps of the New Item dialog box are unavailable.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid business object.
DEFAULT
VALUES
None.
SCOPE
Site preference.

TC_session_clearance
DESCRIPTION
Used in conjunction with NX runtime 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.

For additional information about configuring logging and blocking for NX, see the
Security Administration Guide.
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.
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-19

Chapter 5 Configuration preferences

IP_level_list_ordering
DESCRIPTION
Defines a list of IP classification values and clearance levels that are assigned to
data objects and users for IP access evaluation. Access Manager compares these
values to determine user access rights to the object. This preference is for use with
classification functionality.
For additional information about IP clearance and classification levels, see the
Security Administration Guide.
VALID
VALUES
Accepts multiple strings as values. Each string must provide valid IP 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. Each entry may be a comma-separated
list of equal-precedence classification levels. Thus, commas cannot occur in the
classification values. For example:
IP_level_list_ordering=
secret, confidential
top-secret
DEFAULT
VALUES
secret
super-secret,top-secret
SCOPE
Site preference.

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). For additional information about ADA, see the Security
Administration Guide.
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 AD features.
DEFAULT
VALUES
False

5-20 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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). For additional
information about ADA, see the Security Administration Guide.
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
SCOPE
Site preference.

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). For additional
information about ADA, see the Security Administration Guide.
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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-21

Chapter 5 Configuration preferences

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) codes 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

Use this preference when implementing security controls with International Traffic
in Arms Regulations (ITAR) functionality. For additional information about ITAR,
see the Security Administration Guide.
VALID
VALUES
Accepts multiple strings as values. Each string must provide valid IP 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. Each entry may be a comma-separated
list of equal-precedence classification levels. Thus, commas cannot occur in the
classification values. For example:
ITAR_level_list_ordering=
secret, confidential
top-secret
DEFAULT
VALUES
secret
super-secret,top-secret
SCOPE
Site preference.

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 Guide,
delivered with NX.

5-22 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

Use NX Integration preferences to modify the behavior and display of this interface.
These preferences are set in the following preference files:
• tc_preferences.xml
• .ugii_env
• .tc_ugman_env
• ug_english.def

Preferences set in the .tc_preferences.xml file

Preferences set in the tc_preferences.xml preference file control the way
Teamcenter displays and stores NX assembly and part data.

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.
DEFAULT
VALUES
TITLE
CREATOR
PART_TYPE
PART_NO MODEL
MATERIAL
ASSEMB_NO
WEIGHT
TASK_NO
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 manual.
Determines whether duplicate dataset names are allowed for the same item revision.

PLM00026 D Preferences and Environment Variables Reference 5-23

Chapter 5 Configuration preferences

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

5-24 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

VALID
VALUES
Valid Teamcenter dataset types.
DEFAULT
VALUES
None.
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
theUSER_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 manual.
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
SCOPE
Site preference.

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

PLM00026 D Preferences and Environment Variables Reference 5-25

Chapter 5 Configuration preferences

DEFAULT
VALUES
None.
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 manual.
Specifies whether the owner of the new non-master 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
SCOPE
Site preference.

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

5-26 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

text. If you are saving item revision 001234/B to item revision 002345/A, and the
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}
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 non-master 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}
For more information about defining naming patterns, see the
DATASET_saveas_pattern preference.
VALID
VALUES
${UserText} Dataset names are copied forward to the new revision unchanged.
DEFAULT
VALUES
None.
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-27

Chapter 5 Configuration preferences

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
SCOPE
Site preference.

TC_default_part_type
DESCRIPTION
Determines the default part type created.
VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter type.
DEFAULT
VALUES
Item
SCOPE
All.

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

5-28 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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
SCOPE
Site preference.

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
SCOPE
Site preference.

TC_NX_ATTRIBUTES_FORM
DESCRIPTION
Specifies the form type used to display of UGPART and UGMASTER attributes.
VALID
VALUES
A single string as a value; the string must be a valid Teamcenter form type.

PLM00026 D Preferences and Environment Variables Reference 5-29

Chapter 5 Configuration preferences

DEFAULT
VALUES
UGPartAttr
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 nonstandard 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 nonstandard attributes are defined using the attribute mapping definitions in
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

5-30 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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”

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

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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-31

Chapter 5 Configuration preferences

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.
SCOPE
Site preference.

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 keywords and their values. The keywords are:
DatasetType
NamedReference
NamedReferenceFormat
NamedReferenceTemplate

The format informs NX precisely which named references of the dataset contain the
CAD data. Values are enclosed in quotation marks.
Valid values for the NamedReferenceFormat keyword are BINARY or TEXT. The
named reference template must be the extension for files of that type. For example:
TC_NX_Foreign_Datasets=
DatasetType=“DirectModel” NamedReference=“JTPART”
NamedReferenceFormat=“BINARY” NamedReferenceTemplate=“jt”
DatasetType=“SE PART” NamedReference=“SE-Part”
NamedReferenceFormat=“BINARY” NamedReferenceTemplate=“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.
SCOPE
All.

5-32 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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

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.

PLM00026 D Preferences and Environment Variables Reference 5-33

Chapter 5 Configuration preferences

DEFAULT
VALUES
NO
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 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
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
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
SCOPE
Site preference.

5-34 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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
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.
DEFAULT
VALUES
None.
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.

PLM00026 D Preferences and Environment Variables Reference 5-35

Chapter 5 Configuration preferences

DEFAULT
VALUES
None. The values each and ea are hard-coded and do not have to be included in
the preference.
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
ASSEMB_NO
WEIGHT
TASK_NO
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 additional information about multiple BOM
views, see Structure Manager Guide.
VALID
VALUES
A single string as a value; the string must be a valid Teamcenter BOM view type.
DEFAULT
VALUES
view

5-36 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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
SCOPE
User preference.

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.
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-37

Chapter 5 Configuration preferences

TC_USE_TEST_ATTR_MAPPINGS
DESCRIPTION
Determines whether Teamcenter references the test attribute mappings rather
than the real mappings.
VALID
VALUES
Any nonzero value.
DEFAULT
VALUES
None.
SCOPE
Site preference.

Preferences set in the .tc_ugman_env file

Preferences set in the .tc_ugman_env file generally control the behavior of
Teamcenter Integration for NX and have no effect during a Teamcenter session.
Refer to Teamcenter Integration for NX Guide for additional information about this
preference file and individual preferences.
Siemens PLM Software recommends using the default settings of the
UGMAN_PartType and UGMAN_ShowPartType preferences. This ensures every
Teamcenter item have an associated UGMASTER in order to support assembly
modeling. For more information, see Teamcenter Integration for NX Guide.

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

5-38 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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.
1 Creates new UGMASTER and UGPART datasets names with a revision.
DEFAULT
VALUES
1

Preferences set in the ug_english.def file

Preferences set in the ug_english.def preference file generally control the way NX
handles changes made in Teamcenter are reflected in NX assemblies and parts. The
following entries provide brief descriptions of some of the preferences set in this
file. It is not intended to be an exhaustive reference to these files. For additional
information, see Teamcenter Integration for NX Guide and the NX documentation.

PLM00026 D Preferences and Environment Variables Reference 5-39

Chapter 5 Configuration preferences

UGhookupStructureUpdateOnSave
DESCRIPTION
Determines whether Teamcenter BOM view revisions are updated to
reflect changes made to NX assemblies. This preference is similar to the
UGhookupStructureUpdateOnLoadpreference, 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.

5-40 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

Preferences set in the .ugii_env file

The .ugii_env preference file is the NX equivalent of Teamcenter’s
tc_preferences.xml preference file. Although .ugii_env stores NX preferences,
several of these preferences may at times affect Teamcenter behavior because both
programs use the same low-level libraries (libsys).
The following entries provide a partial listing of NX preferences in the .ugii_env
file that may affect Teamcenter behavior. For additional information, see the NX
documentation.

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

PLM00026 D Preferences and Environment Variables Reference 5-41

Chapter 5 Configuration preferences

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.
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
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.
SCOPE
Site preference.

Teamcenter linking preferences

Teamcenter Linking enables users to create links between Teamcenter objects and
objects in other Teamcenter products.
Use the following preferences to define the Teamcenter applications to which links
can be created from Teamcenter, and the types of Teamcenter objects that can be
used to create these links.

5-42 Preferences and Environment Variables Reference PLM00026 D

 Configuration 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 Teamcenter Linking installation procedure.
VALID
VALUES
During the Teamcenter Linking 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.
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
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.

PLM00026 D Preferences and Environment Variables Reference 5-43

Chapter 5 Configuration preferences

DEFAULT
VALUES
object_name
object_desc
owning_user
owning_group
obj_icon_url
SCOPE
Site preference.

TC_external_Requirements_proxy_props_internal
DESCRIPTION
Defines the properties of each proxy object imported from Teamcenter’s 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
SCOPE
Site preference.

TC_external_Requirements_proxy_props_external
DESCRIPTION
Defines the properties of each proxy object imported from Teamcenter’s 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.

5-44 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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.
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 additional information, see Installation on UNIX and Linux Servers
Guide or Installation on Windows Servers Guide.
DEFAULT
VALUES
Teamcenter Project
Teamcenter Requirements

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

PLM00026 D Preferences and Environment Variables Reference 5-45

Chapter 5 Configuration preferences

SCOPE
Site preference.

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

• User and person object mapping preferences

LDAP connection preferences

LDAP connection preferences contain information used to connect to LDAP to
begin synchronization.

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.

5-46 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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.
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 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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-47

Chapter 5 Configuration preferences

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.
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.
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.
SCOPE
Site preference.

5-48 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

Synchronization Preferences
Synchronization flags control the overall nature of synchronization.

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.
DEFAULT
VALUES
scdue
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.

PLM00026 D Preferences and Environment Variables Reference 5-49

Chapter 5 Configuration preferences

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
scue
SCOPE
Site preference.

LDAP_sync_member_flags
DESCRIPTION
Defines the group member synchronization setting flags in a chmod-style character
string format.
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
scde
SCOPE
Site preference.

5-50 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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.
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
scue
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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-51

Chapter 5 Configuration preferences

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.
DEFAULT
VALUES
FALSE
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
SCOPE
Site preference.

Group Object Mapping Preferences

Group object mapping preferences indicate which specific LDAP group object
attributes to use for synchronization.

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

5-52 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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
VALID
VALUES
Accepts a set of one or more strings.
DEFAULT
VALUES
None.
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=*)
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.

PLM00026 D Preferences and Environment Variables Reference 5-53

Chapter 5 Configuration preferences

DEFAULT
VALUES
groupOfUniqueNames
SCOPE
Site preference.

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.
SCOPE
Site preference.

Role object mapping preferences

Role object mapping preferences indicate which specific LDAP role object attributes
to use for synchronization.

5-54 Preferences and Environment Variables Reference PLM00026 D

 Configuration 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.
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=*)
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
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

PLM00026 D Preferences and Environment Variables Reference 5-55

Chapter 5 Configuration preferences

%REPLACE_ME%
LDAPLastUpdate
modifyTimestamp
%REPLACE_ME%

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.
SCOPE
Site preference.

User and person object mapping preferences

The user and person object mapping preferences indicate which specific LDAP user
and person object attributes to use for synchronization.

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%

5-56 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

VALID
VALUES
Accepts multiple strings, in pairs, as values. Each pair must contain valid LDAP and
Teamcenter attributes.
DEFAULT
VALUES
None.
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.
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 D Preferences and Environment Variables Reference 5-57

Chapter 5 Configuration preferences

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

5-58 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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.
SCOPE
Site preference.

Dispatcher preferences
Dispatcher is an integration of the Dispatcher Server and Teamcenter. Dispatcher
enables Teamcenter users to translate CAD data files that are managed by
Teamcenter to 3D or 2D file formats.
Use Dispatcher preferences to configure and modify translation behavior.

PLM00026 D Preferences and Environment Variables Reference 5-59

Chapter 5 Configuration 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
SCOPE
Site 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
SCOPE
Site preference.

ETS_available
DESCRIPTION
Specifies whether Dispatcher is fully installed and configured. The system sets this
preference during a Teamcenter Environment Manager installation.
VALID
VALUES
YES Specifies that Dispatcher has been fully configured.
NO Specifies that Dispatcher has been installed.
DEFAULT
VALUES
YES

5-60 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

SCOPE
Site preference.

ETS_home
DESCRIPTION
Defines the Dispatcher installation directory. It is used by Dispatcher to dynamically
construct paths to translation service executable files, configuration files, and the
XML schema. The system sets this preference during a Teamcenter Environment
Manager installation.
VALID
VALUES
Accepts a single string as a value. Must be the full path to the Dispatcher
installation directory.
DEFAULT
VALUES
TC_ROOT/ets
SCOPE
Site preference.

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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-61

Chapter 5 Configuration preferences

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
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.
SCOPE
Site preference.

ETS_trans_rqst_user_exit_states
DESCRIPTION
Specifies which translation request states activate the Dispatcher translation
request state transition user exit.

5-62 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid Dispatcher state.
DEFAULT
VALUES
COMPLETE
SCOPE
Site preference.

TC_register_internal_service_modules
DESCRIPTION
Registers all internal service modules. When Dispatcher is installed during
a Teamcenter Environment Manager installation, the system checks for this
preference. If it exists, the value etsus is added as a value. If it does not exist, the
preference is automatically added to the database, and the value added.
Note
Use only a single instance of this preference in the database.

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid internal service
module.
DEFAULT
VALUES
None.
SCOPE
Site preference.

IDEAS_translation_service_name
DESCRIPTION
Specifies the Dispatcher Server provider and service names of the translator to be
used for logon and on demand I-deas to JT 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: UGS.ideastojt
Note
If this preference is not specified, requests for I-deas to JT translations are
ignored.

PLM00026 D Preferences and Environment Variables Reference 5-63

Chapter 5 Configuration preferences

DEFAULT
VALUES
UGS.ideastojt
SCOPE
Site preference.

IDEAS_import_translation_service_name
DESCRIPTION
Specifies the Dispatcher Server provider and service names of the translator to be
used for I-deas to JT import 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.import service name
For example: UGS.ideastojt_imp
Note
If this preference is not specified, requests for I-deas to JT translations are
ignored.

DEFAULT
VALUES
UGS.ideastojt_imp
SCOPE
Site preference.

IDEAS_translation_dataset_type_names
DESCRIPTION
Specifies which I-deas dataset type names are translated.
VALID
VALUES
Accepts multiple strings as values. Each string must be one of the following values:
IdeasPart
IdeasAssembly
IdeasDrawing
DEFAULT
VALUES
IdeasPart
IdeasAssembly
IdeasDrawing
SCOPE
Site preference.

5-64 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

UGSideastojt_IdeasAssembly_ets_nr_types
DESCRIPTION
Specifies the I-deas assembly 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
IdeasGuids
IdeasPrivateData
IdeasAssembly
SCOPE
Site preference.

UGSideastojt_IdeasDrawing_ets_nr_types
DESCRIPTION
Specifies the I-deas drawing 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
IdeasGuids
IdeasPrivateData
IdeasDrawing
SCOPE
Site preference.

UGSideastojt_IdeasPart_ets_nr_types
DESCRIPTION
Specifies the I-deas part 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.

PLM00026 D Preferences and Environment Variables Reference 5-65

Chapter 5 Configuration preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
IdeasGuids
IdeasPrivateData
IdeasPart
SCOPE
Site preference.

IDEAS_import_from_tdm_gen_vis_data_display
DESCRIPTION
Specifies whether the I-deas Data Sharing Import dialog box displays generate
visualization data information.
VALID
VALUES
YES Allows a data-sharing user to view generate visualization data
information.
NO Does not allow a data-sharing user to view generate
visualization data information.
DEFAULT
VALUES
YES
SCOPE
Site preference.

IDEAS_import_from_tdm_default_gen_vis_data_priority
DESCRIPTION
Specifies the default scheduler priority used for I-deas data sharing import
translations.
VALID
VALUES
0 Generates no visualization data on import.
1 Dispatcher Server scheduler priority for importing
visualization data is low.
2 Dispatcher Server scheduler priority for importing
visualization data is medium.
3 Dispatcher Server scheduler priority for importing
visualization data is high.
DEFAULT
VALUES
2

5-66 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

SCOPE
Site preference.

IDEAS_import_from_tdm_gen_vis_data_input
DESCRIPTION
Determines whether input is allowed in the I-deas Data Sharing Import dialog box.
VALID
VALUES
YES Allows input in the I-deas Data Sharing Import dialog box.
NO Does not allow input in the I-deas Data Sharing Import dialog
box.
DEFAULT
VALUES
NO
SCOPE
Site preference.

IDEAS_import_from_tdm_options_default_gen_vis_data_priority
DESCRIPTION
Specifies the initial I-deas Data Sharing Import Options dialog box scheduler priority.
VALID
VALUES
0 Generates no translation.
1 I-deas Data Sharing Import Options dialog box scheduler
priority is low.
2 I-deas Data Sharing Import Options dialog box scheduler
priority is medium.
3 I-deas Data Sharing Import Options dialog box scheduler
priority is high.
DEFAULT
VALUES
2
SCOPE
Site preference.

IDEAS_check_in_generate_vis_data_priority
DESCRIPTION
Specifies the generate visualization data scheduler priority for checked-in and
modified I-deas parts, assemblies, and drawings.

PLM00026 D Preferences and Environment Variables Reference 5-67

Chapter 5 Configuration preferences

Note
Coordinate the setting of this preference with the setting of NX I-deas create
part and assembly .JT on check in preferences.

VALID
VALUES
0 Generates no translation.
1 Dispatcher Server scheduler priority for checked-in and
modified I-deas parts, assemblies, and drawings is low.
2 Dispatcher Server scheduler priority for checked-in and
modified I-deas parts, assemblies, and drawings is medium.
3 Dispatcher Server scheduler priority for checked-in and
modified I-deas parts, assemblies, and drawings is high.
DEFAULT
VALUES
2
SCOPE
Site preference.

IDEAS_on_demand_generate_vis_data_priority
DESCRIPTION
Determines the generate visualization data scheduler priority for on demand
translations of I-deas parts and assemblies.
VALID
VALUES
A non-zero value is required to display the I-deas to JT command on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on demand
translations of I-deas parts and assemblies is low.
2 Dispatcher Server scheduler priority for on demand
translations of I-deas parts and assemblies is medium.
3 Dispatcher Server scheduler priority for on demand
translations of I-deas parts and assemblies is high.
DEFAULT
VALUES
3
SCOPE
Site preference.

5-68 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

IMAN_capture_relation_primary
DESCRIPTION
Defines primary relation objects for IMAN_capture relations. Must include
IdeasDrawing for Dispatcher to support I-deas drawings.
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 object.
DEFAULT
VALUES
None.
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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-69

Chapter 5 Configuration preferences

CATIA_check_in_generate_vis_data_priority
DESCRIPTION
Determines the generate visualization data scheduler priority for checked-in CATIA
v5 parts and assemblies.
VALID
VALUES
0 Generates no translation.
1 Dispatcher Server scheduler priority for checked-in CATIA v5
parts and assemblies is low.
2 Dispatcher Server scheduler priority for checked-in CATIA v5
parts and assemblies is medium.
3 Dispatcher Server scheduler priority for checked-in CATIA v5
parts and assemblies is high.
DEFAULT
VALUES
2
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.
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
SCOPE
Site preference.

CATIA_on_demand_generate_vis_data_priority
DESCRIPTION
Specifies the generate visualization data scheduler priority for on demand
translations of CATIA v5 parts and assemblies.

5-70 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

VALID
VALUES
A non-zero value is required to display the CATIA to JT command on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on demand
translations of CATIA v5 parts and assemblies is low.
2 Dispatcher Server scheduler priority for on demand
translations of CATIA v5 parts and assemblies is medium.
3 Dispatcher Server scheduler priority for on demand
translations of CATIA v5 parts and assemblies is high.
DEFAULT
VALUES
3
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
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.

PLM00026 D Preferences and Environment Variables Reference 5-71

Chapter 5 Configuration preferences

DEFAULT
VALUES
catproduct
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
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.
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.

5-72 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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: 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
SCOPE
Site preference.

CATIA_V4_check_in_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
SCOPE
Site preference.

CATIA_V4_on_demand_generate_vis_data_priority
DESCRIPTION
Specifies the generate visualization data scheduler priority for on demand
translations of CATIA v4 parts.

PLM00026 D Preferences and Environment Variables Reference 5-73

Chapter 5 Configuration preferences

VALID
VALUES
A non-zero value is required to display the CATIA to JT command on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on demand
translations of CATIA v4 parts is low.
2 Dispatcher Server scheduler priority for on demand
translations of CATIA v4 parts is medium.
3 Dispatcher Server scheduler priority for on demand
translations of CATIA v4 parts is high.
DEFAULT
VALUES
3
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.
DEFAULT
VALUES
catia
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

5-74 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

SCOPE
Site preference.

NX_translation_service_name
DESCRIPTION
Specifies the Dispatcher Server provider and service names of the translator to be
used for check in and on demand translation of NX datasets.
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: UGS.ugtopvdirect
Note
If this preference is not specified, requests for check in and on demand
translation of NX datasets are ignored.

DEFAULT
VALUES
UGS.ugtopvdirect
SCOPE
Site preference.

NX_tocgm_translation_service_name
DESCRIPTION
Specifies the Dispatcher Server provider and service names of the translator to be
used for check in and on demand CGM translations of NX datasets.
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: UGS.ugtocgmdirect
Note
If this preference is not specified, requests for check in and on demand
translation of CGM translations of NX datasets are ignored.

DEFAULT
VALUES
UGS.ugtocgmdirect

PLM00026 D Preferences and Environment Variables Reference 5-75

Chapter 5 Configuration preferences

SCOPE
Site preference.

NX_on_demand_generate_vis_data_priority
DESCRIPTION
Specifies the generate visualization data scheduler priority for on demand
translations of NX parts.
VALID
VALUES
A non-zero value is required to display the UGNX to JT command on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on demand
translations of NX parts is low.
2 Dispatcher Server scheduler priority for on demand
translations of NX parts is medium.
3 Dispatcher Server scheduler priority for on demand
translations of NX parts is high.
DEFAULT
VALUES
3
SCOPE
Site preference.

NX_tocgm_on_demand_generate_vis_data_priority
DESCRIPTION
Specifies the generate visualization data scheduler priority for on demand
translations of NX part drawings.
VALID
VALUES
A non-zero value is required to display the UGNX to CGM command on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on demand
translations of NX part drawings is low.
2 Dispatcher Server scheduler priority for on demand
translations of NX part drawings is medium.
3 Dispatcher Server scheduler priority for on demand
translations of NX part drawings is high.
DEFAULT
VALUES
3

5-76 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

SCOPE
Site preference.

UGSnxtocgmdirect_UGALTREP_ets_nr_types
DESCRIPTION
Specifies the NX UGALTREP 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
None.
SCOPE
Site preference.

UGSnxtocgmdirect_UGMASTER_ets_nr_types
DESCRIPTION
Specifies the NX UGMASTER 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
UGPART
SCOPE
Site preference.

UGSnxtocgmdirect_UGPART_ets_nr_types
DESCRIPTION
Specifies the NX UGPART 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.

PLM00026 D Preferences and Environment Variables Reference 5-77

Chapter 5 Configuration preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be an existing named reference
type.
DEFAULT
VALUES
UGPART
SCOPE
Site preference.

UGSnxtocgmdirect_UGSCENARIO_ets_nr_types
DESCRIPTION
Specifies the NX UGSCENARIO 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
None.
SCOPE
Site preference.

UGSnxtocgmdirect_ets_ds_types
DESCRIPTION
Specifies the dataset type names of the NX datasets which can be translated by
the NX to CGM 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
UGMASTER
UGPART
UGALTREP
UGSCENARIO
SCOPE
Site preference.

5-78 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

UGSnxtopvdirect_UGALTREP_ets_nr_types
DESCRIPTION
Specifies the NX UGALTREP 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
None.
SCOPE
Site preference.

UGSnxtopvdirect_UGMASTER_ets_nr_types
DESCRIPTION
Specifies the NX UGMASTER 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
UGPART
SCOPE
Site preference.

UGSnxtopvdirect_UGPART_ets_nr_types
DESCRIPTION
Specifies the NX UGPART 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 D Preferences and Environment Variables Reference 5-79

Chapter 5 Configuration preferences

DEFAULT
VALUES
UGPART
SCOPE
Site preference.

UGSnxtopvdirect_ets_ds_types
DESCRIPTION
Specifies the dataset type names of the NX datasets which can be translated by
the NX 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
UGMASTER
UGPART
UGALTREP
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.
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 object.
DEFAULT
VALUES
None.
SCOPE
Site preference.

5-80 Preferences and Environment Variables Reference PLM00026 D

 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.
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.
SCOPE
Site preference.

PROE_translation_service_name
DESCRIPTION
Specifies the Dispatcher Server provider and service names of the translator to be
used for check in and on demand Pro/ENGINEER to JT translations.

PLM00026 D Preferences and Environment Variables Reference 5-81

Chapter 5 Configuration preferences

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: UGS.proetojt
Note
If this preference is not specified, requests for check in and on demand ProE to
JT translations will be ignored.

DEFAULT
VALUES
UGS.proetojt
SCOPE
Site preference.

PROE_on_demand_generate_vis_data_priority
DESCRIPTION
Specifies the generate visualization data scheduler priority for on demand
translations of Pro/ENGINEER parts.
VALID
VALUES
A non-zero value is required to display the ProE to JT command on the Translate
menu.
0 Generates no translation.
1 Dispatcher Server scheduler priority for on demand
translations of Pro/ENGINEER parts is low.
2 Dispatcher Server scheduler priority for on demand
translations of Pro/ENGINEER parts is medium.
3 Dispatcher Server scheduler priority for on demand
translations of Pro/ENGINEER parts is high.
DEFAULT
VALUES
3
SCOPE
Site preference.

5-82 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

UGSproetojt_ProPrt_ets_nr_types
DESCRIPTION
Specifies the ProE ProPrt 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
PrtFile
SCOPE
Site preference.

UGSproetojt_ets_ds_types
DESCRIPTION
Specifies the dataset type names of the Pro/ENGINEER datasets which can be
translated by the Pro/ENGINEER to JT translator. If no dataset types are specified,
no dataset 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 ProE dataset
type.
DEFAULT
VALUES
PrtFile
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 D Preferences and Environment Variables Reference 5-83

Chapter 5 Configuration preferences

SCOPE
Site preference.

Mail gateway preferences

These preferences are used to configure and control how Teamcenter mail interfaces
with other common mail gateways.

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

Mail_server_charset
DESCRIPTION
Specifies the Teamcenter mail server character set that is used to send mail.
DEFAULT
VALUES
ISO-8859-1
SCOPE
All.

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.

5-84 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

DEFAULT
VALUES
your mail server machine
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.
DEFAULT
VALUES
25
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
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.

PLM00026 D Preferences and Environment Variables Reference 5-85

Chapter 5 Configuration preferences

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
SCOPE
Site preference.

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
SCOPE
User preference.

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

5-86 Preferences and Environment Variables Reference PLM00026 D

 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
SCOPE
Site preference.

PASSWORD_special_characters
DESCRIPTION
Defines which nonalphanumeric characters are valid in a password.
VALID
VALUES
One or more strings as values. When left unset, any special characters are allowed.
A null string allows no special characters.
DEFAULT
VALUES
None.
SCOPE
Site 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.
false Mixed case is not required in a password.
DEFAULT
VALUES
false
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-87

Chapter 5 Configuration preferences

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
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
SCOPE
Site preference.

PASSWORD_minimum_alpha
DESCRIPTION
Determines the minimum number of alphabetic characters 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
SCOPE
Site preference.

5-88 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

Full text search preferences

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 MS 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.
Alternatively, you can define a different plug-and-play search engine using this
preference.
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

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.
SCOPE
Site preference.

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.

PLM00026 D Preferences and Environment Variables Reference 5-89

Chapter 5 Configuration preferences

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.

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.
SCOPE
Site preference.

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

5-90 Preferences and Environment Variables Reference PLM00026 D

 Configuration 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 9001.
SCOPE
Site preference.

TC_fts_query_port
DESCRIPTION
Specifies the query port number. This port is used to query Autonomy IDOL server
content.
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).
SCOPE
Site preference.

TC_fts_service_port
DESCRIPTION
Specifies the service port number. This port is used to query the Autonomy IDOL
server service.
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 9002.
SCOPE
Site preference.

TC_fts_default_language_type
DESCRIPTION
Specifies the default language type used by Autonomy for indexing and searching.
VALID
VALUES
Accepts a single string as a value. Must be one of the following supported languages:
English

PLM00026 D Preferences and Environment Variables Reference 5-91

Chapter 5 Configuration preferences

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.
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.
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.
SCOPE
Site preference.

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

5-92 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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

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.
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.
VALID
VALUES
Accepts a single string as a value.
DEFAULT
VALUES
None.
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 5-93

Chapter 5 Configuration preferences

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.
VALID
VALUES
Accepts a single string as a value. Must be single positive integer.
DEFAULT
VALUES
2
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.
VALID
VALUES
Accepts a single string as a value. Must be single positive integer.
DEFAULT
VALUES
90000
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.
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.
Form_indexed_properties=
object_name
object_desc

5-94 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

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
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.
VALID
VALUES
A single positive integer.
DEFAULT
VALUES
300
SCOPE
Site preference.

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.

PLM00026 D Preferences and Environment Variables Reference 5-95

Chapter 5 Configuration preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid object type name.
DEFAULT
VALUES
Text
MSWordX
MSExcelX
MSPowerPointX
MSWord
MSExcel
MSPowerPoint

SCOPE
Site preference.

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.
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.
SCOPE
Site preference.

Teamcenter services preferences

The following preferences configure aspects of Teamcenter Services. Teamcenter
Services are built using service-oriented architecture (SOA).
For more information about Teamcenter Services, see Services Guide.

SOA_MaxOperationBracketInactiveTime
DESCRIPTION
Specifies the maximum time in seconds for an operation bracket without active
server requests.
VALID
VALUES
Single positive integer.

5-96 Preferences and Environment Variables Reference PLM00026 D

 Configuration preferences

DEFAULT
VALUES
60
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.
VALID
VALUES
Single positive integer.
DEFAULT
VALUES
600
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.

PLM00026 D Preferences and Environment Variables Reference 5-97

Chapter

6 Access Manager and Portfolio,

Program and Project
Management preferences

AM_PROJECT_MODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
TC_project_validate_conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
TC_Project_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
TC_Project_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
TC_Program_Preferred_Items_relation_primary . . . . . . . . . . . . . . . . . . . . . . 6-3
TC_project_bom_2nd_level_propagate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
TC_multi_site_project_member_bypass . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
TC_set_current_project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5

PLM00026 D Preferences and Environment Variables Reference

Chapter

6 Access Manager and Portfolio,

Program and Project
Management preferences

Access Manager provides data security by controlling user access to data. Use
Access Manager to grant/restrict access to objects in Teamcenter via the Access
Manager (AM) rule tree. The tree is built of rules and access permissions. Using this
application requires administrative privileges.
For additional information, see the Access Manager Guide and the Security
Administration Guide.
Projects allow you to control user access to Teamcenter data. A project is a grouping
of objects that are accessible to users who are designated as members of the project
team. Security rules can be implemented based on projects and roles in projects to
restrict data access. For additional information, see the Project and Program Guide
Use the following preferences to manage the behavior of various rules and
permissions associated with AM and projects.

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.

PLM00026 D Preferences and Environment Variables Reference 6-1

Chapter 6 Access Manager and Portfolio, Program and Project Management
preferences

Note
If this preference is undefined, default behavior is false.

SCOPE
Site preference.

TC_project_validate_conditions
DESCRIPTION
Determines how the ASSIGN_TO_PROJECT and REMOVE_FROM_PROJECT
Access Manager privileges are validated in conjunction with privileged membership
validation. For information about defining privileged membership, see the Project
and Program Guide.
The behavior of this preference is overruled by
TC_multi_site_project_member_bypass preference settings.
Note
This preference is not included in your Teamcenter installation. You must add
it to the database. For more information, see the Rich Client Interface Guide

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 has 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 have the REMOVE_FROM_PROJECT privilege
to remove an object from a project.
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.
DEFAULT
VALUES
0
SCOPE
Site preference.

6-2 Preferences and Environment Variables Reference PLM00026 D

 Access Manager and Portfolio, Program and Project Management preferences

TC_Project_DefaultChildProperties
DESCRIPTION
Specifies a list of properties that may be children of the TC_Project business object
type.
VALID
VALUES
Accepts any valid property name.
DEFAULT
VALUES
TC_Preferred_Items
SCOPE
Site preference.

TC_Project_PseudoFolder
DESCRIPTION
Specifies a list of properties that may be displayed as a pseudofolder under a node of
TC_Project business object type.
VALID
VALUES
Accepts any valid property name.
DEFAULT
VALUES
TC_Preferred_Items
SCOPE
Site preference.

TC_Program_Preferred_Items_relation_primary
DESCRIPTION
Specifies a list of valid primary business object types for the TC_Preferred_Parts
relation.
VALID
VALUES
Accepts any valid business object type name.
DEFAULT
VALUES
TC_Project
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 6-3

Chapter 6 Access Manager and Portfolio, Program and Project Management
preferences

TC_project_bom_2nd_level_propagate
DESCRIPTION

Note
This preference is not included in your Teamcenter installation. You must add
it to the database. For more information, see the Rich Client Interface Guide.

Specifies which relation types are available for level two propagation. By default,
this preference is unset and level-two propagation is not enabled. Set this preference
to enable this functionality.
Level-two propagation processes dependent objects related to the datasets associated
with level one objects. The following data model is supported for level-two
propagation:
Item
Item
revision
Dataset Item revision (associated with the dataset by a
specified relation type)
Dataset Dataset (associated with the dataset by a specified
relation type)
Dataset Item (associated with the dataset by a specified
relation type)

Note
Dependent objects assigned through level-two propagation are explicitly
assigned to the project. Objects that are explicitly assigned to projects must
also be explicitly removed. If the BOM object to which the secondary object is
removed from the project, the dependent object remains.

For detailed information about assigning objects to projects using propagation rules,
and the differences between level-one propagation and level-two propagation, see
Project and Program Guide.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid relation type.
DEFAULT
VALUES
None.
SCOPE
Site preference.

6-4 Preferences and Environment Variables Reference PLM00026 D

 Access Manager and Portfolio, Program and Project Management preferences

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.
Note
This preference is not included in your Teamcenter installation. You must add
it to the database. For more information, see the Rich Client Interface Guide.

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
false
SCOPE
Site preference.

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.

PLM00026 D Preferences and Environment Variables Reference 6-5

Chapter 6 Access Manager and Portfolio, Program and Project Management
preferences

SCOPE
Site preference.

6-6 Preferences and Environment Variables Reference PLM00026 D

Chapter

7 eIntegrator Admin preferences

EINT_adapter_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
EINT_<adapter_name> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
EINT_global_services_datasource_names . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
EINT_global_services_urls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
ATTRSHARING_datasource_connection_details . . . . . . . . . . . . . . . . . . . . . . 7-2
ATTRSHARING_max_rows_expected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
EINT_storage_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
EINT_update_on_save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
EINT_import_selected_rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
EINT_create_new_forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
EINT_form_refresh_pref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
EINT_item_rev_pref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
EINT_copy_to_clipboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
EINT_max_num_rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
EINT_ibi_api_library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6

PLM00026 D Preferences and Environment Variables Reference

Chapter

7 eIntegrator Admin preferences

eIntegrator Admin provides a simple integration mechanism to integrate external

data with Teamcenter. Use eIntegrator Admin to map external data systems into
equivalent objects in its database. The data can then be imported into the database
as forms.
Use the following preferences to define how eIntegrator Admin updates form data
from the external source, and how eIntegrator Admin forms are attached to item
revisions.

EINT_adapter_names
DESCRIPTION
Defines valid adapters.
VALID
VALUES
Names of valid adapters.
DEFAULT
VALUES
EINT_odbc_adapter
EINT_ibi_adapter
EINT_tcintegrator_adapter
SCOPE
Site preference.

EINT_<adapter_name>
DESCRIPTION
Determines the display name of the specified adapter. A single preference is
needed for each eIntegrator Admin 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_odbc_adapter= iMANAdapter
EINT_ibi_adapter= IBIAdapter

PLM00026 D Preferences and Environment Variables Reference 7-1

Chapter 7 eIntegrator Admin preferences

SCOPE
Site preference.

EINT_global_services_datasource_names
DESCRIPTION
Defines the display names for defined data sources used by the Global Services
adapter. Global Services is a Web application that enables your site to access
information stored in virtually any type of electronic data source that manages
your enterprise data. For more information about this functionality, see the Global
Services Configuration Guide.
This preference works in conjunction with the EINT_global_services_urls
preference.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid, defined data source.
DEFAULT
VALUES
None.
SCOPE
Site preference.

EINT_global_services_urls
DESCRIPTION
Defines the data source locations, in universal resource locator (URL) format, for
the data sources defined in the EINT_global_services_datasource_names
preference. Global Services is a Web application that enables your site to access
information stored in virtually any type of electronic data source that manages
your enterprise data. For more information about this functionality, see the Global
Services Configuration Guide.
VALID
VALUES
Accepts multiple strings as values. Each string must be in URL format, pointing to
a defined data source.
DEFAULT
VALUES
None.
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.

7-2 Preferences and Environment Variables Reference PLM00026 D

 eIntegrator Admin preferences

VALID
VALUES
Accepts a single string as a value. Must be a valid data source defined from the
eIntegrator Admin application.
DEFAULT
VALUES
None.
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
SCOPE
Site preference.

EINT_storage_type
DESCRIPTION
Determines storage method of external data within Teamcenter.
VALID
VALUES
0 Stores external data persistently in Teamcenter.
1 Caches external data in Teamcenter.
DEFAULT
VALUES
1
SCOPE
All.

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 an eIntegrator Admin form.

PLM00026 D Preferences and Environment Variables Reference 7-3

Chapter 7 eIntegrator Admin preferences

1 Updates external data when saving an eIntegrator Admin form.

DEFAULT
VALUES
0
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.
DEFAULT
VALUES
1
SCOPE
Site preference.

EINT_create_new_forms
DESCRIPTION
Determines whether or not to create a new form when importing external data. If
left unset, eIntegrator Admin creates a new form for the imported data.
VALID
VALUES
0 Updates the existing form with the imported data if found by the given name.
1 Always creates a new form when importing external data.
DEFAULT
VALUES
1
SCOPE
Site preference.

EINT_form_refresh_pref
DESCRIPTION
Controls whether or not the refresh operation updates the eIntegrator Admin form
data from the external source.
VALID
VALUES
0 The form data is not updated when the refresh operation is run.

7-4 Preferences and Environment Variables Reference PLM00026 D

 eIntegrator Admin preferences

1 A SQL query runs and fetches the external data every time the eIntegrator
Admin form is refreshed.
DEFAULT
VALUES
0
SCOPE
Use as a site preference to implement the setting throughout the site.
Use as a user preference to allow administrators (users with DBA access) to
re-import form data without affecting the refresh behavior for all users at the site.

EINT_item_rev_pref
DESCRIPTION
Defines the behavior for attaching an eIntegrator Admin form to an item revision
when there is no item revision mapping and the latest version of the item revision is
released.
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 eIntegrator Admin forms,
if any, are not copied from the released revision.
DEFAULT
VALUES
0
SCOPE
Use as a site preference to implement the setting throughout the site.
Use as a user preferences to allow administrators (users with DBA access) to
re-import form data without affecting the refresh behavior for all users at the site.

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
SCOPE
Use as a site preference to implement the setting throughout the site.
Use as a user preferences to allow administrators (users with DBA access) to
re-import form data without affecting the refresh behavior for all users at the site.

PLM00026 D Preferences and Environment Variables Reference 7-5

Chapter 7 eIntegrator Admin preferences

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
SCOPE
User preference.

EINT_ibi_api_library
DESCRIPTION
Defines the IBI API library to be loaded dynamically. If a location is not specified,
Teamcenter look for the library in the SHLIB_PATH or LD_LIBRARY_PATH
directories, if on a UNIX or Windows platform, respectively.
VALID
VALUES
Single string as a value.
DEFAULT
VALUES
edaapi
SCOPE
Site preference.

7-6 Preferences and Environment Variables Reference PLM00026 D

Chapter

8 File management and

maintenance preferences

Audit Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

TC_audit_manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
TC_audit_log_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
TC_audit_buffer_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
TC_audit_file_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
TC_audit_delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3

Archive, restore, and migration preferences . . . . . . . . . . . . . . . . . . . . . . . . . 8-3

HSM_integration_enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
HSM_read_thru_supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
HSM_primary_tier_hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5
HSM_secondary_tier_capacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5
Centera_Cluster_IPAddresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6
TC_Store_and_Forward . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6
TC_Store_and_Forward_Transfer_Delay . . . . . . . . . . . . . . . . . . . . . . . . . 8-7
TC_enable_backup_modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7

Action Manager daemon preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8

TC_actionmgrd_sleep_minutes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8
TC_actionmgrd_general_processing_hours . . . . . . . . . . . . . . . . . . . . . . . 8-9
TC_actionmgrd_max_actions_to_dispatch . . . . . . . . . . . . . . . . . . . . . . . . 8-10
TC_actionmgrd_max_subprocess_to_start . . . . . . . . . . . . . . . . . . . . . . . . 8-10
TC_actionmgrd_cloning_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10

Subscription Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11

TC_subscriptionmgrd_sleep_minutes . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11
TC_subscriptionmgrd_processing_hours . . . . . . . . . . . . . . . . . . . . . . . . . 8-11
TC_subscriptionmgrd_max_subscriptions_to_dispatch . . . . . . . . . . . . . . . 8-12
TC_subscriptionmgrd_cloning_interval . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12
TC_notification_msg_ext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-13

Subscription Monitor preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-13

TC_subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-13
TC_refresh_notify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-14
TC_refresh_notify_scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-14
TC_refresh_notify_subscribe_to_types . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-15
<TypeName>_subscribe_to_events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-15
TC_refresh_notify_pull_time_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-16
TC_refresh_notify_list_maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-16
TC_automatic_refresh_waiting_time . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-17

PLM00026 D Preferences and Environment Variables Reference

 TC_automatic_refresh_time_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-17
TC_automatic_refresh_list_maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-17
TC_refresh_notify_timed_out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-18
Mail_subscription_notify_sub_groups_too . . . . . . . . . . . . . . . . . . . . . . . . 8-18
TC_subscription_log_event_and_action_status . . . . . . . . . . . . . . . . . . . . . 8-18
TcSubscriptionColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19
TcSubscriptionColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . 8-19
TcEventColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-20
TcEventColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-20
TcActionColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21
TcActionColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21
SCM_notification_history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22
SCM_notification_WorkspaceObject_props . . . . . . . . . . . . . . . . . . . . . . . 8-22

File caching preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22

Caching modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23
Cache purging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23
syslog file output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23
File caching preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23
TC_Cache_Allowed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23
TC_Cache_Dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-24
TC_Cache_Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-24
TC_Cache_Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-25
TC_<file type>_Cache_Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-25
TC_Cache_Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26
TC_STAGING_AREA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26
TC_System_Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-27
QUOTA_active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-27
QUOTA_logging_level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-28
QUOTA_unload_threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-28
QUOTA_unload_percentage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-28
QUOTA_minimum_lifetime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-29
Ticket_Expiration_Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-29
Multisite_Ticket_Expiration_Interval . . . . . . . . . . . . . . . . . . . . . . . . 8-29
blobbyVolume_NT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-30
blobbyVolume_UNX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-30
Transient_Volume_Installation_Location . . . . . . . . . . . . . . . . . . . . . . 8-30
Transient_Volume_RootDir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-31
Default_Transient_Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-31
Default_Transient_Volume_Id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-32
Fms_BootStrap_Urls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-32
FSC_HOME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-33

Log file preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-33

TC_Administration_Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-33
TC_Security_Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-33
TC_allow_inherited_group_volume_access . . . . . . . . . . . . . . . . . . . . . . . . 8-34
TC_Application_Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-34
TC_Installation_Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-35
TC_Journalling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-35
TC_Journal_Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-35
TC_KEEP_SYSTEM_LOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-36
TC_TMP_DIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-36
RECOVER_TO_UNRELEASED_STATUS . . . . . . . . . . . . . . . . . . . . . . . . 8-36

Preferences and Environment Variables Reference PLM00026 D

 RECOVER_TO_VOLUME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-37
TC_sfr_recovery_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-37
TC_sfr_process_life_time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-37

PLM00026 D Preferences and Environment Variables Reference

Chapter

8 File management and

maintenance preferences

Maintenance preferences modify the way Teamcenter stores, maintains, and audits
your product data.
Preferences are typically set using the Options dialog box, accessed from the
Edit menu. As you create/modify preferences, your current group/role determines
both user access to the preference and the precedence of its behavior when there
are multiple incidences of the same preference. For additional information, see
Preference scope.

Audit Manager preferences

Audit Manager creates audit logs that track selected properties for specified actions
in the database. These properties can include custom properties added by your site.
Use the following preferences to determine Audit Manager behavior.

TC_audit_manager
DESCRIPTION
Determines auditing behavior.
VALID
VALUES
ON Enables the Audit Manager application.
Enables full auditing functionality, providing 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, the user can access this file from the Viewing the Audit Logs dialog
box. For information about using auditing functionality, see the Rich Client
Interface Guide.
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. For information about using this dialog
box, see the Rich Client Interface Guide.

PLM00026 D Preferences and Environment Variables Reference 8-1

Chapter 8 File management and maintenance preferences

DEFAULT
VALUES
OFF
SCOPE
Site preference.

TC_audit_log_dir
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
SCOPE
Group preference.

TC_audit_buffer_size
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
SCOPE
Group preference.

TC_audit_file_format
DESCRIPTION
Specifies the format of external audit files.

8-2 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

VALID
VALUES
0 Text format (.txt).
1 XML format (.xml).
DEFAULT
VALUES
1
SCOPE
Group preference.

TC_audit_delimiter
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
^
SCOPE
Group preference.

Archive, restore, and migration preferences

Archiving migrates objects to primary or secondary storage media in order
to optimize online storage space. Restoration restores objects that have been
archived. You must have read privileges for the object and the object must currently
be archived. Hierarchical storage management moves lower priority files to
third-party storage systems. You can also configure Teamcenter to store files in a
temporary volume then move the files to their final destination volume according to
administer-defined criteria, thus improving performance of upload times from clients.
Use the following preferences to enable and manage archive, restore, and migration
functionality.

PLM00026 D Preferences and Environment Variables Reference 8-3

Chapter 8 File management and maintenance preferences

HSM_integration_enabled
DESCRIPTION
Enables the Volume Management application to work with third-party hierarchical
storage management (HSM) software. For more information about HSM
functionality, see the Volume Management Guide.
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
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
SCOPE
Site preference.

8-4 Preferences and Environment Variables Reference PLM00026 D

 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.
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.
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 8-5

Chapter 8 File management and maintenance preferences

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.
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.
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.
For more information about working with default local volumes, see the System
Administration Guide.
You can view the status of file transfers from the Dispatcher request administration
console.
For more information, see Getting Started with Dispatcher (Translation
Management).
VALID
VALUES
true Enables store and forward functionality.

8-6 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

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

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.
For more information about using this preference with store and forward
functionality, see the System Administration Guide.
VALID
VALUES
Any positive integer.
DEFAULT
VALUES
0
SCOPE
All.

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

PLM00026 D Preferences and Environment Variables Reference 8-7

Chapter 8 File management and maintenance preferences

functionality focuses on the area of backing up metadata and math data, 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.
For more information about using the backup functionality, see the System
Administration Guide.
VALID
VALUES
true Enables backup functionality.
false Disables backup functionality.
DEFAULT
VALUES
false
SCOPE
Site preference.

Action Manager daemon preferences

The action manager daemon dispatches events given a deferred execution time at
the time specified, as well as events intended for immediate dispatch that failed to
dispatch immediately. Information regarding events with a deferred execution time
are stored in the Teamcenter database as action objects. The action object contains
the information necessary to process the event, including event type, execution time,
and the user who generated the event.
At defined intervals, this daemon searches for action objects stored in the Teamcenter
database. It determines which of the objects are due for execution and processes a
defined number of these objects. To avoid memory leak problems, this daemon clones
and then terminates itself on a regular basis.
Define the duration of the action manager daemon’s sleep and wake cycles, the
number of objects processed, and its cloning intervals using the following site
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
SCOPE
Site preference.

8-8 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

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.
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.
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 8-9

Chapter 8 File management and maintenance preferences

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
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.
VALID
VALUES
Positive integer up to 50.
DEFAULT
VALUES
10
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
SCOPE
Site preference.

8-10 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

Subscription Manager preferences

The Subscription Manager daemon searches the Teamcenter database for
subscriptions to the object for a given event type. When a subscription event
occurs (such as when an object is released), an event object is created to capture
that event and stored in a queue in the database. Event types act as the catalyst
for the subscriptionmgrd daemon, causing it to search for subscriptions to the
object for the given event type. For more information about this daemon, see the
System Administration Guide.

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
SCOPE
Site preference.

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:

PLM00026 D Preferences and Environment Variables Reference 8-11

Chapter 8 File management and maintenance preferences

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.
SCOPE
Site preference.

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
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
SCOPE
Site preference.

8-12 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

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
SCOPE
Site preference.

Subscription Monitor preferences

Subscription Monitor is used by system administrators to query subscriptions
created in the database and manage subscription modifications and to monitor and
delete subscription events and actions. Deleting subscription actions does not delete
the actual subscriptions. System administrators can use Subscription Monitor to
delete any active subscription. You can also use Subscription Monitor to generate
statistical reports in either text or bar chart format regarding subscriptions, events
and actions.
Subscription Manager is used by general users to search for, delete, and modify active
subscriptions. Users can search for, delete, and modify subscriptions they create.
System administrators can search for, delete, and modify all active subscriptions.
Use Subscription Monitor preferences to enable Subscription Manager, and to modify
the Subscription Monitor display.

TC_subscription
DESCRIPTION
Enables or suppresses subscription functionality.
VALID
VALUES
ON Enables subscription functionality.

OFF Suppresses subscription functionality.

DEFAULT
VALUES
OFF
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 8-13

Chapter 8 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
the Rich Client Interface Guide.
This preference is used in conjunction with the TC_refresh_notify_scope
preference.
Note
The Subscription Manager daemon must be run to clean up subscriptions and
events that become invalid due to unexpected session terminations. For more
information about this daemon, see the System Administration Guide.

VALID
VALUES
ON Enables refresh notification functionality.
OFF Suppresses refresh notification functionality.
DEFAULT
VALUES
OFF
SCOPE
All.

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

8-14 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

Group Group members can enable/disable this functionality.

Site Site administrators can enable/disable this functionality.
DEFAULT
VALUES
User
SCOPE
Site preference.

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

PLM00026 D Preferences and Environment Variables Reference 8-15

Chapter 8 File management and maintenance preferences

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

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

8-16 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

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

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.

PLM00026 D Preferences and Environment Variables Reference 8-17

Chapter 8 File management and maintenance preferences

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.
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
SCOPE
Site preference.

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

8-18 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

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
SCOPE
Site preference.

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
event_type
handler_parameters
expiration_date
execution_time
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

PLM00026 D Preferences and Environment Variables Reference 8-19

Chapter 8 File management and maintenance preferences

15
SCOPE
All.

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
TcEvent
TcEventType
TcSubscription

DEFAULT
VALUES
objectstr_of_target
target_object_type
event_type
event_initiator
event_time

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

8-20 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

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:
objectstr_of_target
target_object_type_name
eventtype_id
subscriber
event_initiator
event_time
handler_parameters
execution_time
retries_togo
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

PLM00026 D Preferences and Environment Variables Reference 8-21

Chapter 8 File management and maintenance preferences

SCOPE
User preference.

SCM_notification_history
DESCRIPTION
Determines whether the notification history record is enabled or disabled.
VALID
VALUES
ON Enables notification e-mail.
OFF Suppresses notification e-mail.
DEFAULT
VALUES
OFF
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
SCOPE
Site preference.

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.

8-22 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

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

Cache purging
Automatic purging of the cache is not supported; however, the cache can be manually
purged using the purge_file_cache utility. This utility purges the cache based on
the last access date of the files and also checks each file to make sure it still exists
within the Teamcenter volume.

syslog file output

When file caching is enabled, the following information is output to the syslog file:
• The location of the cache, as defined by the IMAN_Cache_Dir preference.
• The maximum size of the cache, as defined by the IMAN_Cache_Size
preference.
• 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

Use file caching preferences to enable file caching, define which file caching mode is
used, and configure caching functionality.

TC_Cache_Allowed
DESCRIPTION
Determines whether local file caching is enabled. This site 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 the Rich Client Interface Guide.

PLM00026 D Preferences and Environment Variables Reference 8-23

Chapter 8 File management and maintenance preferences

VALID
VALUES
ON Enables local file caching.
OFF Disables local file caching.
DEFAULT
VALUES
OFF
SCOPE
Site preference.

TC_Cache_Dir
DESCRIPTION
Defines the directory to which files are cached. The IMAN_Cache_Allowed
preference must be set to ON before defining a cache directory. 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 the Rich Client Interface Guide.
VALID
VALUES
Any directory to which the user has write access.
DEFAULT
VALUES
None.
SCOPE

TC_Cache_Size
DESCRIPTION
Defines the size of the cache in megabytes. Files stop being cached if the size of the
files in the cache directory reach the cache size specified.
The IMAN_Cache_Allowed preference must be set to ON and the
IMAN_Cache_Dir preference must be defined before this preference can be used.
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 the Rich Client Interface Guide.
VALID
VALUES
Any integer greater than zero.
DEFAULT
VALUES
None.

8-24 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

SCOPE

TC_Cache_Mode
DESCRIPTION
Determines which mode of file caching is used. 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 the Rich Client Interface Guide.
VALID
VALUES
ALL All files are cached, regardless of how they are accessed from
the volume.
NONE No new files are cached. Previously cached files can be
accessed.
MOUNTED The Teamcenter volume files are accessed by socket transfer
and the volume is NFS mounted.
NOT_MOUNTED The Teamcenter volume files are accessed by socket transfer,
the volume is not NFS mounted.
DEFAULT
VALUES
NOT_MOUNTED
SCOPE

TC_<file type>_Cache_Mode
DESCRIPTION
Enables file caching for a specific file type. The file extension defined in this
preference overrides the TC_Cache_Mode preference for the given file type. In
the following example, .gif files are cached regardless of whether the Teamcenter
File Services access mode is NFS or Socket, .xls files are not cached at all, and
all other file types are cached only if the Teamcenter File Services transfer mode
is NFS access:
TC_Cache_Mode=
MOUNTED
TC_gif_Cache_Mode=
ALL
TC_xls_Cache_Mode=
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 the Rich Client Interface Guide.
VALID
VALUES
Valid file types.
DEFAULT
VALUES
None.

PLM00026 D Preferences and Environment Variables Reference 8-25

Chapter 8 File management and maintenance preferences

SCOPE

TC_Cache_Protection
DESCRIPTION
Defines the operating system protections applied to files stored in the file cache.
This preference is valid only if the TC_Cache_Allowed, TC_Cache_Dir, and
TC_Cache_Size preferences are set. 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
the Rich Client Interface Guide.
VALID
VALUES
UNIX systems:
USER The caching user has access.
GROUP Members of the caching user’s group have access.
WORLD All users have access.
Windows systems:
USER The caching user has access.
WORLD All users have access.
DEFAULT
VALUES
USER
SCOPE
Site preference.

TC_STAGING_AREA
DESCRIPTION
Defines 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.
DEFAULT
VALUES
None.

8-26 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

SCOPE

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.
VALID
VALUES
ON Enables system logging.
OFF Suppresses system logging.
DEFAULT
VALUES
ON
SCOPE
Site preference.

QUOTA_active
DESCRIPTION
Enables or suppresses the object quota system. This memory reduction system is
tunable, allowing optimization between memory consumption and performance.
The object quota system allows you to:
• Determine logging detail with the QUOTA_logging_level preference
• Determine amount of memory used before garbage collection commences with
the QUOTA_unload_threshold preference
• Determine the number of objects unloaded once the activation threshold is
reached with the QUOTA_unload_percentage preference
• Specify the minimum amount of time an object is loaded before it is eligible to be
unloaded with QUOTA_minimum_lifetime preference

VALID
VALUES
true Enables object quota system.
false Suppresses object quota system.
DEFAULT
VALUES
false
SCOPE
All.

PLM00026 D Preferences and Environment Variables Reference 8-27

Chapter 8 File management and maintenance preferences

QUOTA_logging_level
DESCRIPTION
Determines the level of detail sent to the object quota log file. Level of detail ranges
from 1 (low) to 5 (high). Set at level 5 for full logging mode; this mode records all
events and is intended for debugging. Set at lower levels for basic logging. Basic
logging records only key events and is intended for production usage.
VALID
VALUES
A single positive integer between 1 and 5.
DEFAULT
VALUES
1
SCOPE
All.

QUOTA_unload_threshold
DESCRIPTION
Determines the number of objects contained in the object quota cache required to
trigger unloading the cache. Too low a setting will cause unloading to be triggered
too frequently, resulting in performance decrease.
The percentage of objects unloaded is determined by the
QUOTA_unload_percentage preference.
VALID
VALUES
A single positive integer.
DEFAULT
VALUES
20000
SCOPE
All.

QUOTA_unload_percentage
DESCRIPTION
Determines what percentage of the total object cache is unloaded after the activation
threshold is reached. For example, a value of 1 means 1% of the cache is unloaded.
VALID
VALUES
Single positive integer between 1 and 100.
DEFAULT
VALUES
10
SCOPE
All.

8-28 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

QUOTA_minimum_lifetime
DESCRIPTION
Specifies the minimum amount of time, in seconds, an object is loaded before it is
eligible to be unloaded. Setting this preference guards against potential thrashing.
VALID
VALUES
Single positive integer.
DEFAULT
VALUES
0
SCOPE
All.

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)
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)
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 8-29

Chapter 8 File management and maintenance 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.
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
DEFAULT
VALUES
None.
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.

8-30 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

DEFAULT
VALUES
None.
SCOPE
All.

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. If you must change the value, see the System
Administration Guide.
VALID
VALUES
Accepts multiple values, in order to support a UNIX/Windows heterogeneous site.
For example:
Transient_Volume_RootDir=
C:\temp
/tmp

DEFAULT
VALUES
None.
SCOPE
Site preference.

Default_Transient_Server
DESCRIPTION
Specifies the default transient file server location. Environment variable settings
override this FCC configuration file setting. 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

PLM00026 D Preferences and Environment Variables Reference 8-31

Chapter 8 File management and maintenance preferences

DEFAULT
VALUES
None.
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.
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
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.
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.
SCOPE
Site preference.

8-32 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

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.
SCOPE
Site preference.

Log file preferences

Teamcenter saves information in various log files. Access log files to obtain valuable
troubleshooting information. For more information about viewing log files, see the
Business Modeler IDE Guide.
Use log file preferences to enable and configure log file functionality.

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.
VALID
VALUES
ON Enables administrative logging.
OFF Suppresses administrative logging.
DEFAULT
VALUES
ON
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

PLM00026 D Preferences and Environment Variables Reference 8-33

Chapter 8 File management and maintenance preferences

the existence of this file; if it exists, it checks the value of this preference. If set to
ON, security logging is enabled.
VALID
VALUES
ON Enables security logging.
OFF Suppresses security logging.
DEFAULT
VALUES
ON
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 its subsubgroups) are implicitly
granted access to that volume.
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
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.
VALID
VALUES
ON Enables application logging.
OFF Suppresses application logging.
DEFAULT
VALUES
ON
SCOPE
All.

8-34 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

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.
VALID
VALUES
ON Enables installation logging.
OFF Suppresses installation logging.
DEFAULT
VALUES
ON
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.
VALID
VALUES
ON Enables journalling.
OFF Suppresses journalling.
DEFAULT
VALUES
OFF
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.
DEFAULT
VALUES
None.

PLM00026 D Preferences and Environment Variables Reference 8-35

Chapter 8 File management and maintenance preferences

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

TC_TMP_DIR
DESCRIPTION
Defines 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.
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.
SCOPE
Site preference.

8-36 Preferences and Environment Variables Reference PLM00026 D

 File management and maintenance preferences

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.
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.
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.
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 8-37

Chapter

9 Interface preferences

Rich client interface preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

AE_dataset_default_keep_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
AI_ignore_ic_flag_setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
AI_Incremental_Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
AI_request_no_dependancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
Allow_Copy_As_Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
Attachment_Alias_File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
CCCompositionTypesPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4
CCObject_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4
Change_Search_Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5
copyPasteChunkNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5
Create_<business_object>_default_type . . . . . . . . . . . . . . . . . . . . . . . . . 9-6
Create_WorkspaceObject_mru_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6
Create_WorkspaceObject_mru_max . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-7
dataset_name.FORM_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . 9-7
DATASET_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-7
DATASET_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8
DATASET_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8
DATASET_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-9
<dataset_name>.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10
DATASETTYPE_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . 9-10
DATASETTYPE_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . 9-11
DATASETTYPE_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11
DATASETTYPE_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11
DatasetTypesPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12
Enable_thumbnails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12
FLColumnCatIVFSeparatorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13
FLColumnCatObjSeparatorPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13
FOLDER_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13
FOLDER_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-14
FOLDER_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-14
FOLDER_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-15
FORM_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-15
FORM_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-16
FORM_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-16
FORM_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-17
FormTypesPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-17
GROUP_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-17
GROUP_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-18
GROUP_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-18
GROUP_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-18
HiddenPerspectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-19
IDCAttachmentColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-20

PLM00026 D Preferences and Environment Variables Reference

 IDCAttachmentColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-20
IDCStructureColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-21
IDCStructureColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-21
IdentifierContextTypeDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-22
IdentifierTypeDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-22
IMAN_3D_snap_shot_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . 9-22
IMAN_customization_libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-23
IMAN_FLASH_FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-23
IMANFILE_display_full_path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-23
IMANFILE_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-24
IMANFILE_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-24
IMANFILE_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-25
IMANFILE_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-25
IMANTYPE_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-26
IMANTYPE_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-26
IMANVOLUME_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . 9-26
IMANVOLUME_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . 9-27
IMANVOLUME_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . 9-27
IMANVOLUME_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . 9-28
<Item>.FilterCriteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-28
ITEM_first_rev_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-29
ITEM_id_postfix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-29
ITEM_id_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-30
ITEM_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-30
ITEM_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-31
ITEM_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-31
ITEM_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-32
<Item>.SUMMARYRENDERING2007 . . . . . . . . . . . . . . . . . . . . . . . . . . 9-32
<ItemRevision>.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-33
<ItemRevision1>_<ItemRevision2>_default_relation . . . . . . . . . . . . . . . . 9-33
<ItemRevision>.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . . . 9-33
ItemRevision_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-34
ITEMREVISION_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . 9-35
ITEMREVISION_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . 9-35
ITEMREVISION_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . 9-36
ITEMREVISION_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . 9-36
ItemRevision_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-37
ItemRevision_thumbnail_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-38
ItemRevision_thumbnail_references . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-38
Item_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-38
ITEM_smart_baseline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-39
<Item type>_rev_display_all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-39
<Item type>_rev_display_order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-40
<Item type>_rev_display_rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-40
JTTreeTableColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-41
JTTreeTableShownColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . 9-42
LOV_hide_desc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-42
MECollaborationContext_default_relation . . . . . . . . . . . . . . . . . . . . . . . . 9-43
MEOPRevision_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-43
MEProcessRevision_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-43
MySearchHistory_Limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-44
OpenAfterCreatePref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-44
PERSON_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-44

Preferences and Environment Variables Reference PLM00026 D

 PERSON_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-45
PERSON_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-45
PERSON_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-46
PIE_Extra_Error_Info_to_Xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-47
PIE_IMF_FOR_CAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-47
PIE_<transfer_mode_name>_process_in_chunks . . . . . . . . . . . . . . . . . . . 9-47
PIE_<transfer_mode_name>_unload_objects . . . . . . . . . . . . . . . . . . . . . . 9-48
PLMXML_continue_on_error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-49
PLMXML_sdk_threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-50
PLMXML_export_packed_bom_<transfer-mode-name> . . . . . . . . . . . . . . 9-50
PLMXML_import_default_password . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-50
PLMXML_log_file_content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-51
PLMXML_overwrite_objects_on_import . . . . . . . . . . . . . . . . . . . . . . . . . 9-52
PLMXML_put_objects_in_newstuff_on_import . . . . . . . . . . . . . . . . . . . . 9-52
PLMXML_put_pie_log_in_syslog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-52
PLMXML_use_pre_plm_appname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-53
PSBOMVIEW_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . 9-53
PSBOMVIEW_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-54
PSBOMVIEW_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-54
PSBOMVIEW_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-55
PSBOMVIEWREVISION_object_columns_hidden . . . . . . . . . . . . . . . . . . 9-55
PSBOMVIEWREVISION_object_columns_shown . . . . . . . . . . . . . . . . . . 9-56
PSBOMVIEWREVISION_object_widths_hidden . . . . . . . . . . . . . . . . . . . 9-56
PSBOMVIEWREVISION_object_widths_shown . . . . . . . . . . . . . . . . . . . . 9-57
QRYColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-57
QRY_display_details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-58
QRY_dataset_display_option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-58
QRY_number_of_favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-59
QRY_output_options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-59
QRY_<query_name>_SortKeys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-59
QRY_<query_name>_SortOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-60
QRY_search_classification_hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-60
QRY_search_type_hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-60
ReferencersPane_Shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-61
<relation_type>_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-61
<relation_type>_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-67
ReportDefinition_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-72
ReportDefinition_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . 9-73
ReportGenerationDlg_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . 9-74
ReportGenerationDlg_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . 9-74
RESERVATION_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . 9-75
RESERVATION_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . 9-75
RESERVATION_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . 9-76
RESERVATION_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . 9-76
Selection Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-77
Select IR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-77
Structure_Alias_File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-78
TC_AE_<datasettype>_Default_View_Tool . . . . . . . . . . . . . . . . . . . . . . . 9-78
TC_ALLOW_ADHOC_VALIDATIONS . . . . . . . . . . . . . . . . . . . . . . . . . . 9-79
TC_Auto_Checkout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-79
TC_auto_login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-79
TC_check_out_dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-80
TC_checkout_and_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-80

PLM00026 D Preferences and Environment Variables Reference

 TC_control_wildcard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-81
TC_control_wildcard_exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-81
TC_days_non_login_timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-81
TC_DISABLE_FLASH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-82
TC_display_group_names_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-82
TC_display_real_prop_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-83
TC_Display_thumbnail_in_UI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-83
TC_export_child_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-83
TC_export_parent_groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-84
TC_Graph_Node_Thumbnail_Shown . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-84
TC_GROUP_PFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-84
TC_ignore_case_on_search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-85
TC_inbox_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-85
TC_<datasettype>_Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-86
TC_markup_named_ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-86
TC_max_number_of_retries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-87
TC_name_delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-87
TC_name_sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-88
TC_pattern_match_style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-88
TC_remove_file_on_check_in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-89
TC_retry_time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-89
TC_ROLE_PFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-89
TC_suppress_Edit_Latest_Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-90
WSColumnsShownPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-90
TC_suppress_inactive_group_members . . . . . . . . . . . . . . . . . . . . . . . . . . 9-91
TC_Thumbnail_Tooltip_Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-91
TC_USER_PFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-91
TC_VALIDATION_FILE_TYPES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-92
TC_VALIDATION_MANDATORY_CHECKERS . . . . . . . . . . . . . . . . . . . 9-92
TC_Validation_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-92
TC_VALIDATION_RESULT_ALLOW_REPLICA_OBJECT . . . . . . . . . . . 9-93
TC_VALIDATION_TIMESTAMP_NREFS . . . . . . . . . . . . . . . . . . . . . . . . 9-93
TC_wc_allow_subgroup_default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-94
TC_VALIDATION_USE_PLMXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-94
TC_wc_setting_modifiable_default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-94
TC_wc_show_all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-95
TOOL_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-95
TOOL_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-96
TOOL_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-96
TOOL_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-97
Tracelink_deepcopy_on_Revise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-97
Tracelink_deepcopy_on_SaveAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-98
treeDisplayOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-98
<Type>_PseudoFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-98
<Type_Name>_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . 9-99
<type_name>.FORMRENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-102
<type_name>.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-103
USER_object_columns_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-103
USER_object_columns_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-104
USER_object_widths_hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-104
USER_object_widths_shown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-104
VALIDATION_APPLICATIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-105
ValidationMasterFormColumnPreferences . . . . . . . . . . . . . . . . . . . . . . 9-105

Preferences and Environment Variables Reference PLM00026 D

 ValidationMasterFormColumnWidthPreferences . . . . . . . . . . . . . . . . . . 9-106
WHERE_REFERENCED_RELATIONS_FILTER . . . . . . . . . . . . . . . . . . 9-107
Word_12_installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-107
WORKSPACEOBJECT_object_columns_hidden . . . . . . . . . . . . . . . . . . . 9-108
WORKSPACEOBJECT_object_columns_shown . . . . . . . . . . . . . . . . . . . 9-109
WORKSPACEOBJECT_object_widths_hidden . . . . . . . . . . . . . . . . . . . . 9-109
WORKSPACEOBJECT_object_widths_shown . . . . . . . . . . . . . . . . . . . . 9-110
WS_icon_placement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-110
WSColumnsHiddenPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-110
WSDisplayTypePref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-111
WS_expand_on_paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-111
WSHiddenColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-112
WsoFolderSavePref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-112
WsoInsertNoSelectionsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-113
WSOM_find_editUserList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-113
WsoInsertSelectionsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-113
WSOM_find_list_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-114
WSOM_find_set_search_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-114
WSOM_find_set_total_limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-114
WSOM_only_edit_effectivity_in_ecm . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-115
WSShownColumnWidthsPref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-115

Thin client interface preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-116

General thin client preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-116
appbar_title_contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-116
JT_WEB_UI_PREF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-117
WEB_active_optimizer_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-118
WEB_auto_assign_ds_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-118
WEB_<Class>_default_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-118
WEB_Change_default_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-119
WEB_core_help_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-119
WEB_dataset_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-119
WEB_default_site_deployed_app_name . . . . . . . . . . . . . . . . . . . . . . 9-120
WEB_default_site_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-120
WEB_disable_structure_read_optimizations . . . . . . . . . . . . . . . . . . 9-121
WEB_filter_person . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-121
WEB_help_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-121
WEB_filter_user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-122
WEB_protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-122
WEB_status_icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-123
WEB_dataset_upload_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-124
WEB_column_one_new_window . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-124
WEB_create_<business_object>_exclude_types . . . . . . . . . . . . . . . . 9-124
WEB_menu_entry_new_window . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-125
WEB_menu_entry_suppressions . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-125
WEB_item_default_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-126
WEB_itemrevision_default_relation . . . . . . . . . . . . . . . . . . . . . . . . 9-126
WEB_item_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-126
WEB_itemrevision_shown_relations . . . . . . . . . . . . . . . . . . . . . . . . 9-127
WEB_IWantToDefaultActions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-127
WEB_login_page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-128
WEB_max_search_results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-129
WEB_NX_UseBookmark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-129
WEB_package_multipart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-129

PLM00026 D Preferences and Environment Variables Reference

 WEB_packaging_extension . . . . . . . . . . . . ........... . . . . . . . 9-130
WEB_processes . . . . . . . . . . . . . . . . . . . . . ........... . . . . . . . 9-130
WEB_show_export_nx_assy_menu . . . . . . . ........... . . . . . . . 9-130
WEB_show_summary . . . . . . . . . . . . . . . . ........... . . . . . . . 9-131
WEB_show_unconfigured_revs . . . . . . . . . . ........... . . . . . . . 9-131
WEB_simple_search_queries . . . . . . . . . . . ........... . . . . . . . 9-131
WEB_style_sheet_list . . . . . . . . . . . . . . . . ........... . . . . . . . 9-132
WEB_style_sheet . . . . . . . . . . . . . . . . . . . ........... . . . . . . . 9-132
WEB_style_sheet_list_names . . . . . . . . . . . ........... . . . . . . . 9-132
WEB_title_contents . . . . . . . . . . . . . . . . . . ........... . . . . . . . 9-133
WEB_unpackage_multipart . . . . . . . . . . . . ........... . . . . . . . 9-133
WEB_use_activex_lov . . . . . . . . . . . . . . . . ........... . . . . . . . 9-134
WEB_use_lhn_home_component . . . . . . . . . ........... . . . . . . . 9-134
WEB_use_lhn_inbox_component . . . . . . . . . ........... . . . . . . . 9-135
Thin Client column and property preferences . . ........... . . . . . . . 9-135
WEB_dataset_columns . . . . . . . . . . . . . . . ........... . . . . . . . 9-135
WEB_inbox_columns . . . . . . . . . . . . . . . . . ........... . . . . . . . 9-136
WEB_psm_columns . . . . . . . . . . . . . . . . . . ........... . . . . . . . 9-136
WEB_po_columns . . . . . . . . . . . . . . . . . . . ........... . . . . . . . 9-137
WEB_wso_columns . . . . . . . . . . . . . . . . . . ........... . . . . . . . 9-138
Folder_ColumnPreferences . . . . . . . . . . . . . ........... . . . . . . . 9-138
Thin Client image preferences . . . . . . . . . . . . . ........... . . . . . . . 9-139
WEB_fullsize_image_generate_type . . . . . . ........... . . . . . . . 9-139
WEB_image_size_vert . . . . . . . . . . . . . . . . ........... . . . . . . . 9-139
WEB_image_size_horiz . . . . . . . . . . . . . . . ........... . . . . . . . 9-139
WEB_show_banner . . . . . . . . . . . . . . . . . . ........... . . . . . . . 9-140
WEB_show_thumbnail_image . . . . . . . . . . ........... . . . . . . . 9-140
WEB_thumbnail_image_display_type . . . . . ........... . . . . . . . 9-140
WEB_thumbnail_image_generate_type . . . . ........... . . . . . . . 9-141
Thin client DesignContext preferences . . . . . . . ........... . . . . . . . 9-141
WebDesignContextDefaultSearchDistance . . ........... . . . . . . . 9-141
WebDesignContextMaxMatchingBOMLines ........... . . . . . . . 9-142
WebDesignContextMaxMatchingObjects . . . ........... . . . . . . . 9-142
Thin client Teamcenter’s manufacturing process management
preferences . . . . . . . . . . . . . . . . . . . . . . . . . ........... . . . . . . . 9-142
WEB_ZoneProcess_Reports . . . . . . . . . . . . ........... . . . . . . . 9-143
WEB_StationProcess_Reports . . . . . . . . . . ........... . . . . . . . 9-143
WEB_MEWeldOp_Reports . . . . . . . . . . . . . ........... . . . . . . . 9-145
WEB_MEPrPlantProcess_Reports . . . . . . . ........... . . . . . . . 9-146
WEB_MELocateCompOp_Reports . . . . . . . ........... . . . . . . . 9-146
Class_Resource_WeldGun . . . . . . . . . . . . . ........... . . . . . . . 9-146
Class_Resource_Robot . . . . . . . . . . . . . . . . ........... . . . . . . . 9-147
TC_suppress_report_designs . . . . . . . . . . . ........... . . . . . . . 9-147
TC_TransferMode_XMLReport . . . . . . . . . . ........... . . . . . . . 9-148
TC_Report_Transfer_Area . . . . . . . . . . . . . ........... . . . . . . . 9-148
Batch_Report_Request_File . . . . . . . . . . . . ........... . . . . . . . 9-148
Web_Report_Jars . . . . . . . . . . . . . . . . . . . ........... . . . . . . . 9-149

Preferences and Environment Variables Reference PLM00026 D

Chapter

9 Interface preferences

Interface preferences modify the display and behavior of the various Teamcenter
interfaces.
Preferences are typically set using the Options dialog box, accessed from the
Edit menu. As you create/modify preferences, your current group/role determines
both user access to the preference and the precedence of its behavior when there
are multiple incidences of the same preference. For additional information, see
Preference scope.

Rich client interface preferences

The Teamcenter rich client is a gateway to your company’s product information. The
rich client framework allows you to integrate and run Teamcenter’s product data
management applications along with various other applications, all from a common
platform. These applications can be MS Office applications, custom applications,
Java Plug-ins, or CAD/CAM/CAE applications such as NX.
Use the following preferences to modify and customize the display and behavior of
the rich client framework.

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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 9-1

Chapter 9 Interface preferences

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 Application Interface Web Service (AIWS) functionality.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid AppInterface type.
DEFAULT
VALUES
None.
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 Application Interface Web Service
(AIWS) functionality.
VALID
VALUES
true Only changes to large structures are exported.
false All items are exported.
DEFAULT
VALUES
None.
SCOPE
Site preference.

9-2 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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 Application Interface Web Service (AIWS) functionality.
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
SCOPE
All.

Allow_Copy_As_Revision
DESCRIPTION
Determines behavior of Save As functionality when saving item revisions in
Teamcenter and Teamcenter Integration for NX.
VALID
VALUES
true Allows saving an existing item revision to either a new item or to a new item
revision contained within an existing item.
false Allows saving an existing item revision to a new item, but not to an existing
item.
DEFAULT
VALUES
false
SCOPE
Site preference.

Attachment_Alias_File
DESCRIPTION
Determines the alias file applied to the intermediate data capture object to display
the attachments of a BOM line a tree structure format. Alias files determines what
displays in the IDCWindow. They determine the root of the window, the children
displayed in each line and the properties for each line. The files contains 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.

PLM00026 D Preferences and Environment Variables Reference 9-3

Chapter 9 Interface preferences

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
All shipped alias files are stored in the TC_DATA directory.

VALID
VALUES
Accepts a single string as a value. Must be the complete path to the alias XML file.
DEFAULT
VALUES
TC_DATA/attachment_alias.xml
SCOPE
All.

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. For more information about
compositions, see the Multi-Structure Manager Guide.
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
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.

9-4 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

DEFAULT
VALUES
IMAN_CCContext
SCOPE
Site preference.

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
SCOPE
User 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 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 the Rich Client Interface Guide.
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.
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 9-5

Chapter 9 Interface preferences

Create_<business_object>_default_type
DESCRIPTION
This preference list the business object (type) that has to be preselected in the Types
list of the creation dialog box for a given business object. The <business_object>
variable refers to the business object used to populate the types list in the creation
dialog box. Creation dialog boxes are accessed by menu commands such as
New→Item, New→Part, New→Design, and so on.
VALID
VALUES
Any business object name is a valid value.
DEFAULT
VALUES
Following are the standard preferences defined:
Create_Architecture_default_type=Architecture
Create_Change_default_type=CR
Create_Dataset_default_type=Text
Create_Folder_default_type=Folder
Create_Form_default_type=Item Master
Create_GeneralDesignElementLink_default_type=TC_Link
Create_Interfaces_default_type=Connection_Terminal
Create_Item_default_type=Item
Create_ItemRevision_default_type=Item
Create_PSConnection_default_type=Connection
Create_ProcessVariable_default_type=ProcessVariable

SCOPE
User 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

SCOPE
User preference.

9-6 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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.
DEFAULT
VALUE
5

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 additional information, see
the Rich Client Customization Programmer’s Guide. 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 the Rich Client Interface
Guide.
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.

PLM00026 D Preferences and Environment Variables Reference 9-7

Chapter 9 Interface preferences

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
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
SCOPE
User preference.

DATASET_object_widths_hidden
DESCRIPTION
Specifies the column width for each column defined in the
DATASET_object_columns_hiddenuser preference.

9-8 Preferences and Environment Variables Reference PLM00026 D

 Interface 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 DATASET_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
32
16
16
16
16
16
16
16
16
16
16
16
16
16

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
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 9-9

Chapter 9 Interface preferences

<dataset_name>.REGISTEREDTO
DESCRIPTION
Teamcenter property displays are based on an XML style sheet. The style sheet must
be created and registered by a system administrator; for additional information, see
the Rich Client Customization Programmer’s Guide. The XML file allows users
to define a set of 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 an XML style sheet dataset
is selected for display in the viewer, the dataset 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. Must be the type name defined in the
corresponding type_name.RENDERING 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 the Rich Client Interface
Guide.
SCOPE
Site 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
backup_date
description
SCOPE
User preference.

9-10 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
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
SCOPE
User preference.

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

PLM00026 D Preferences and Environment Variables Reference 9-11

Chapter 9 Interface 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 theDATASETTYPE_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
80
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
SCOPE

Enable_thumbnails
DESCRIPTION
Enables thumbnail datasets for Teamcenter.
VALID
VALUES
TRUE Enables thumbnail datasets.
FALSE Hides thumbnail datasets.
DEFAULT
VALUES
FALSE
SCOPE
Site preference.

9-12 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

FLColumnCatIVFSeparatorPref
DESCRIPTION
Specifies the character used to separate an item ID from an item revision ID in
an object column.
VALID
VALUES
A single ASCII character.
DEFAULT
VALUES
A slash (/).
SCOPE
User preference.

FLColumnCatObjSeparatorPref
DESCRIPTION
Specifies the character used to separate an item ID from an item name in an object
column.
VALID
VALUES
A single ASCII character.
DEFAULT
VALUES
A dash (-).
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.
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

PLM00026 D Preferences and Environment Variables Reference 9-13

Chapter 9 Interface preferences

creation_date
archive_date
last_mod_date
backup_date
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
SCOPE
User preference.

FOLDER_object_widths_hidden
DESCRIPTION
Specifies the column width for each column defined in the
FOLDER_object_columns_hiddenuser 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_hidden user preference, and so on.
DEFAULT
VALUES
32
32
32
32
32
32
32
32
32
32

9-14 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

32
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
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.
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
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 9-15

Chapter 9 Interface preferences

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
SCOPE
User preference.

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

9-16 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
SCOPE
User preference.

FormTypesPref
DESCRIPTION
Specifies the form types listed when users choose the System→New→Form
command. If this preference is left undefined, the Create 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.
SCOPE

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

PLM00026 D Preferences and Environment Variables Reference 9-17

Chapter 9 Interface preferences

volume
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
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
SCOPE
User preference.

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

9-18 Preferences and Environment Variables Reference PLM00026 D

 Interface 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 GROUP_object_columns_shown user preference, and so on.
DEFAULT
VALUES
20
32
SCOPE
User preference.

HiddenPerspectives
DESCRIPTION
Hides specified perspectives in the rich client. The value listed must be the activity
name defined in the org.eclipse.ui.activities extension point within a given
perspective’s plugin.xml file.
VALID
VALUES

AccessManager PlantDesigner
AppearanceConfiguration PartPlanner
AuditManager PlatformDesigner
Authorization PlmXmlExportImportAdministration
CAEManager Project

CAEStructureDesigner QueryBuilder
ChangeManager RegistryEditor
CMViewerClassic ReportBuilder
Classification ReportDesigner
ClassificationAdmin ReportGenerator
CommandSuppression ResourceManager
DatabaseUtilities RequirementsManager
DesignContext RelationBrowser
eIntegrator StructureManager
IssueManager ScheduleManager
LifecycleViewer SetupWizard
ManufacturingProcessPlanner SubscriptionMonitor
MyTeamcenter Validation

PLM00026 D Preferences and Environment Variables Reference 9-19

Chapter 9 Interface preferences

MyTeamcenterLegacy VolumeManagement
Note
The My Teamcenter (2007)
perspective.
Multi-StructureManager WorkflowDesigner
Organization WorkflowViewer

DEFAULT
VALUES
CMViewerClassic for Foundation installations; none for Foundation upgrades, GM
Overlay installations, and GM Overlay upgrades.
ChangeManager
MyTeamcenterLegacy
SCOPE
Site preference.
RESTRICTIONS
You cannot hide the Getting Started, DPV Admin, or Web Browser perspectives.

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.
DEFAULT
VALUES
Me_cl_display_string
Me_cl_object_type
Me_cl_relation

SCOPE
All.

IDCAttachmentColumnWidthsPref
DESCRIPTION
Determines the column width for the list of properties defined in the
IDCAttachmentColumnsShownPref preference.

9-20 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

VALID
VALUES
Accepts multiple strings as values. Each value must be a positive integer, and
align, in order, with a value defined in the IDCAttachmentColumnsShownPref
preference.
DEFAULT
VALUES
15
10
10

SCOPE
All.

IDCStructureColumnsShownPref
DESCRIPTION
Determines the columns displayed in the IDCBOMTreeTable, used to display the
captured structure.
VALID
VALUES
Accepts multiple strings as values. Must be a valid IDCLine property.
DEFAULT
VALUES
Bl_intended_title
Bl_sequence_no
Bl_rev_object_type

SCOPE
All.

IDCStructureColumnWidthsPref
DESCRIPTION
Determines the column width for the list of properties defined in the
IDCStructureColumnsShownPref 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 IDCStructureColumnsShownPref
preference.
DEFAULT
VALUES
15
10
10

PLM00026 D Preferences and Environment Variables Reference 9-21

Chapter 9 Interface preferences

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.
SCOPE
Site preference.

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.
SCOPE
Site preference.

IMAN_3D_snap_shot_relation_primary
DESCRIPTION
Determines the default relation for IMAN_3D_snap_shot types.
VALID
VALUES
Accepts one or more strings as a value; each string must be a valid Teamcenter object.
DEFAULT
VALUES
ItemRevision
SCOPE
Site preference.

9-22 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
VALID
VALUES
Accepts one or more strings as values; each string must be a valid customization file.
DEFAULT
VALUES
None.
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.
SCOPE
User preference.

IMANFILE_display_full_path
DESCRIPTION
Determines whether the full file path in references properties is displayed when you
choose Named References→Properties→Print.
VALID
VALUES
true System displays the full file path in references properties.
false System displays the short file name.

PLM00026 D Preferences and Environment Variables Reference 9-23

Chapter 9 Interface preferences

Note
You must restart the server if you reset this variable.

DEFAULT
VALUES
false
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
backup_date

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.

9-24 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

DEFAULT
VALUES
original_file_name
volume_tag
owning_user
file_name
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
32
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

PLM00026 D Preferences and Environment Variables Reference 9-25

Chapter 9 Interface preferences

16
32
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
SCOPE
User preference.

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

9-26 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
SCOPE
User preference.

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
SCOPE
User preference.

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

PLM00026 D Preferences and Environment Variables Reference 9-27

Chapter 9 Interface 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 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
SCOPE
User preference.

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

9-28 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

DEFAULT
VALUES
Item name or item revision.
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.
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.
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.

PLM00026 D Preferences and Environment Variables Reference 9-29

Chapter 9 Interface preferences

DEFAULT
VALUES
None.
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.
SCOPE
Site preference.

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

9-30 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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

PLM00026 D Preferences and Environment Variables Reference 9-31

Chapter 9 Interface preferences

32
32
32
32
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.
DEFAULT
VALUES
20
20
16
16
32
SCOPE
User preference.

<Item>.SUMMARYRENDERING2007
DESCRIPTION
Registers the summary style sheet of the My Teamcenter 2007 item.
The summary stylesheet 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

9-32 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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.
SCOPE
Site preference.

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

PLM00026 D Preferences and Environment Variables Reference 9-33

Chapter 9 Interface preferences

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
TC_Project • ProjectSummary

• CPGProjectSummary
Schedule ScheduleSummary
CPGFormulaMaterRevision CPGFormulaMaterRevisionSummary
CPGRawMaterialRevision CPGRawMaterialRevisionSummary
CPGIngredientRevision CPGIngredientRevisionSummary
CPGChemicalRevision CPGChemicalRevisionSummary
CPSpecificationRevision CPSpecificationRevisionSummary
CPThemeBoardRevision CPThemeBoardRevisionSummary
CPBrandAssetRevision CPBrandAssetRevisionSummary
CPTradeItemRevision CPTradeItemRevisionSummary

SCOPE
Site preference.

ItemRevision_default_relation
DESCRIPTION
Defines the default relation assigned to an item revision when it is created.
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.

9-34 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

VALID
VALUES
Accepts a single string as a value. Must be a valid relation type.
DEFAULT
VALUES
None.
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.
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
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

PLM00026 D Preferences and Environment Variables Reference 9-35

Chapter 9 Interface preferences

item_revision_id
object_name
owning_user
object_desc
release_status_list
SCOPE
User preference.

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

9-36 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

20
16
32
32
SCOPE
User preference.

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.

SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 9-37

Chapter 9 Interface preferences

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.
VALID
VALUES
Accepts relationship types.
DEFAULT
VALUES
IMAN_specification
IMAN_manifestation
IMAN_Rendering
IMAN_Motion
IMAN_3D_snap_shot
TC_Attaches

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

SCOPE
Site preference.

Item_shown_relations
DESCRIPTION
Determines which relations display within an item.

9-38 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

VALID
VALUES
Accepts one or more strings as a value; each string must be a valid Teamcenter
relation type.
DEFAULT
VALUES
PSBOMView
ItemRevision
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.

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

PLM00026 D Preferences and Environment Variables Reference 9-39

Chapter 9 Interface preferences

VALID
VALUES
TRUE Displays all item revisions.
FALSE Displays only the item revisions meeting the filter criteria.
DEFAULT
VALUES
None.
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.
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=

9-40 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

3:!=:Pre-Released:3
2: : :2

For additional information about setting these rules in the rich client interface, see
the Rich Client Interface Guide.
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.
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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 9-41

Chapter 9 Interface 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
SCOPE
Site preference.

LOV_hide_desc
DESCRIPTION
Determines whether side-by-side LOV value/descriptions display. 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 via 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 additional information about configuring LOV value/descriptions, see the

Business Modeler IDE Guide. For additional information about using the Options
dialog box, see the Rich Client Interface Guide.
VALID
VALUES
Accepts multiple strings as values. Each entry indicates an LOV whose
value/description will 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.
SCOPE
User preference.

9-42 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
SCOPE
Site 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
IMAN_MEOutput
IMAN_METarget
IMAN_MEWorkArea
IMAN_3D_snap_shot
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

PLM00026 D Preferences and Environment Variables Reference 9-43

Chapter 9 Interface preferences

IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEOutput
IMAN_METarget
IMAN_MEWorkArea
IMAN_3D_snap_shot
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
SCOPE
User preference.

OpenAfterCreatePref
DESCRIPTION
Determines whether to open an object immediately after creating it.
VALID
VALUES
0 Opens an object immediately after creating it.

1 Does not open an object immediately after creating it.

DEFAULT
VALUES
0
SCOPE

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.

9-44 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
PA7
PA8
archive_info
owning_group
last_mod_user
owning_user
creation_date
archive_date
last_mod_date
backup_date
PA6
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
SCOPE
User preference.

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

PLM00026 D Preferences and Environment Variables Reference 9-45

Chapter 9 Interface 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 PERSON_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
32
32
32
32
32
32
32
32
32
32
32
32
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
SCOPE
User preference.

9-46 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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 using AIWS.
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
SCOPE
All.

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

PLM00026 D Preferences and Environment Variables Reference 9-47

Chapter 9 Interface preferences

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
DEFAULT
VALUES
None.
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

9-48 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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.
SCOPE
User preference.

PLMXML_continue_on_error
DESCRIPTION
Determines whether import and export operations continue after an error has
occurred.
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
FALSE
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 9-49

Chapter 9 Interface preferences

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

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
SCOPE
User preference.

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.

9-50 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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.
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.
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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 9-51

Chapter 9 Interface preferences

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
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
FALSE
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 Data imported via PLM XML is automatically stored in the Newstuff folder.
FALSE Data imported via PLM XML is not stored in the Newstuff folder. Data is
located using the Search command.
DEFAULT
VALUES
None.
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.

9-52 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
SCOPE
User preference.

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 additional information about using transfer modes, and PLM XML export
functionality, see the PLM XML Export Import Administration Guide.
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.)
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 D Preferences and Environment Variables Reference 9-53

Chapter 9 Interface 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
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
SCOPE
User preference.

PSBOMVIEW_object_widths_hidden
DESCRIPTION
Specifies the column width for each column defined in the
PSBOMVIEW_object_columns_hiddenuser preference.

9-54 Preferences and Environment Variables Reference PLM00026 D

 Interface 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
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
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 D Preferences and Environment Variables Reference 9-55

Chapter 9 Interface 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
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
SCOPE
User preference.

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

9-56 Preferences and Environment Variables Reference PLM00026 D

 Interface 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 PSBOMVIEWREVISION_object_columns_hidden user preference,
and so on.
DEFAULT
VALUES
32
32
32
32
32
32
32
32
32
32
32
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
SCOPE
User preference.

QRYColumnsShownPref
DESCRIPTION
Determines the queries available for selection from the Find menu in both the rich
client and the thin client.

PLM00026 D Preferences and Environment Variables Reference 9-57

Chapter 9 Interface preferences

VALID
VALUES
Valid Teamcenter query classes.
DEFAULT
VALUES
General...
Item...
Item Revision...
Remote...
Checked-Out Dataset...
SCOPE
User preference.

QRY_display_details
DESCRIPTION
Specifies whether the query clauses are displayed in the Query Form panel.
VALID
VALUES
0 Does not display details.
1 Does display details.
DEFAULT
VALUES
0
SCOPE

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.
SCOPE
User preference.

9-58 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

QRY_number_of_favorites
DESCRIPTION
Specifies the limit on the number of entries displayed in the list of favorite queries.
VALID
VALUES
A single positive integer.
DEFAULT
VALUES
6
SCOPE
User preference.

QRY_output_options
DESCRIPTION
Specifies how query results are displayed.
VALID
VALUES
1 Output the query results to the Find folder.
2 Output the query results to the Objects dialog box.
3 Output the remote query results to the Objects dialog box.
DEFAULT
VALUES
1
SCOPE
User 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_SortOrders 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

• return character (\n)

• tab character (\t)

PLM00026 D Preferences and Environment Variables Reference 9-59

Chapter 9 Interface preferences

DEFAULT
VALUES
None.
SCOPE
User preference.

QRY_<query_name>_SortOrder
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.
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
SCOPE
User preference.

QRY_search_type_hierarchy
DESCRIPTION
Determines whether subtypes are included in query results. The system uses type
hierarchy functionality to query types and subtypes.

9-60 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
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
SCOPE
User preference.

<relation_type>_relation_primary
DESCRIPTION
Defines the primary object types for each ImanRelation type. This preference
only creates a relation property for the defined object types. It does not affect the
validity of attaching relations, which is implemented via methods on relation
types. Nor does this preference determine the display of secondary objects; use the
<TypeName>_DefaultChildProperties preference to determine the display of
secondary objects under primary objects in rich client.

PLM00026 D Preferences and Environment Variables Reference 9-61

Chapter 9 Interface preferences

Note
The <relation_type>_relation_primary preference is deprecated, and is
replaced by the relation property. For more information, see the Business
Modeler IDE Guide.

Each relation type requires a separate preference in which relation_type is a valid

Teamcenter relation and the values are one or more Teamcenter types. For example:
IMAN_requirement_relation_primary=
Item
ItemRevision
DMI_markup_relation_primary=
DirectModel
DrawingSheet
Image

Note
PSBOMView and ItemRevision (for items) and PSBOMViewRevision
(for item revisions) are special case relations that are not affected by this
preference. They are always available for all types of ItemRevision.

VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter type.
DEFAULT
VALUES
DMI_markup_relation_primary=
DirectModel
DrawingSheet
Image
IMAN_requirement_relation_primary=
Item
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install
AUTO_Install Revision
IMAN_manifestation_relation_primary=
Item
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision
AUTO_Install
AUTO_Install Revision
IMAN_reference_relation_primary=

9-62 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

Item
ItemRevision
CommercialPart
ManufacturerPart
CommercialPart Revision
ManufacturerPart Revision
AppearanceGroup
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install
AUTO_Install Revision
IMAN_master_form_relation_primary=
Item
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Equipment
AUTO_Install
IMAN_specification_relation_primary=
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision
IMAN_Rendering_relation_primary=
Item
ItemRevision
Dataset
AUTO_Part
AUTO_Part Revision
AUTO_Vehicle
AUTO_Vehicle Revision
AUTO_Product
AUTO_Product Revision
AUTO_Tool
AUTO_Tool Revision
AUTO_Criteria
AUTO_Criteria Revision
AUTO_Proc_Plan
AUTO_Proc_Plan Revision
AUTO_Install
AUTO_Install Revision

PLM00026 D Preferences and Environment Variables Reference 9-63

Chapter 9 Interface preferences

IMAN_classification_relation_primary=
Item
ItemRevision
IMAN_CCContext_relation_primary=
CCObject

IMAN_StructureContent_relation_primary=
StructureContext

EC_addressed_by_rel_relation_primary=
Item
ItemRevision
EC_affected_item_rel_relation_primary=
Item
ItemRevision
EC_problem_item_rel_relation_primary=
Item
ItemRevision
EC_reference_item_rel_relation_primary=
Item
ItemRevision
EC_solution_item_rel_relation_primary=
Item
ItemRevision
IMAN_Motion_relation_primary=
ItemRevision
IMAN_suppliedItem_relation_primary=
ItemRevision
IMAN_UG_udf_relation_primary=
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision
IMAN_UG_altrep_relation_primary=
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision
IMAN_UG_scenario_relation_primary=
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision

9-64 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

AUTO_Proc_Plan Revision
AUTO_Install Revision
IMAN_UG_wave_position_relation_primary=
ItemRevision
UGMASTER
UGALTREP
UGPART
UGSCENARIO
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision
IMAN_UG_wave_geometry_relation_primary=
ItemRevision
UGMASTER
UGALTREP
UGPART
UGSCENARIO
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision
IMAN_UG_wave_part_link_relation_primary=
ItemRevision
UGMASTER
UGALTREP
UGPART
UGSCENARIO
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision

IMAN_UG_expression_relation_primary=
ItemRevision
UGMASTER
UGALTREP
UGPART
UGSCENARIO
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision

PLM00026 D Preferences and Environment Variables Reference 9-65

Chapter 9 Interface preferences

AUTO_Proc_Plan Revision
AUTO_Install Revision

IMAN_UG_promotion_relation_primary=
ItemRevision
UGMASTER
UGALTREP
UGPART
UGSCENARIO
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision
IMAN_RES_checkout_relation_primary=
RevisionAnchor
IMAN_snapshot_relation_primary=
ItemRevision
IMAN_MEMfgModel_relation_primary=
ItemRevision
IMAN_MEOutput_relation_primary=
MEProcessRevision
MEOPRevision
IMAN_MEFolder_relation_primary=
MEProcessRevision
MEOPRevision
IMAN_METarget_relation_primary=
MEProcessRevision
MEOPRevision
IMAN_MEWorkArea_relation_primary=
MEProcessRevision
MEOPRevision
IMAN_3D_snap_shot
IMAN_MEView_relation_primary=
Item
IMAN_MEProductAppearance_relation_primary=
PSOccurrence
IMAN_MEProductLocation_relation_primary=
PSOccurrence
IMAN_MERequiredAppr_relation_primary=
PSOccurrence
IMAN_MEAppearance_relation_primary=
PSOccurrence
CP_Has_Technical_Brief_relation_primary=
CPMarketingBriefRevision
CP_Has_Design_Brief_relation_primary=
CPMarketingBriefRevision
CP_Results_In_Package_Rough_relation_primary=
CPDesignBriefRevision
CPTechnicalBriefRevision
CP_Has_Graphical_Element_relation_primary=

9-66 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

CPPackageRoughRevision
CPThemeBoardRevision
CPDesignBriefRevision
SCOPE
Site preference.

<relation_type>_relation_primary
DESCRIPTION
Defines the primary object types for each ImanRelation type. This preference
only creates a relation property for the defined object types. It does not affect the
validity of attaching relations, which is implemented via methods on relation
types. Nor does this preference determine the display of secondary objects; use the
<TypeName>_DefaultChildProperties preference to determine the display of
secondary objects under primary objects in rich client.
Note
The <relation_type>_relation_primary preference is deprecated, and is
replaced by the relation property. For more information, see the Business
Modeler IDE Guide.

Each relation type requires a separate preference in which relation_type is a valid

Teamcenter relation and the values are one or more Teamcenter types. For example:
IMAN_requirement_relation_primary=
Item
ItemRevision
DMI_markup_relation_primary=
DirectModel
DrawingSheet
Image

Note
PSBOMView and ItemRevision (for items) and PSBOMViewRevision
(for item revisions) are special case relations that are not affected by this
preference. They are always available for all types of ItemRevision.

VALID
VALUES
One or more strings as values; each string must be a valid Teamcenter type.
DEFAULT
VALUES
DMI_markup_relation_primary=
DirectModel
DrawingSheet
Image
IMAN_requirement_relation_primary=
Item
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision

PLM00026 D Preferences and Environment Variables Reference 9-67

Chapter 9 Interface preferences

AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install
AUTO_Install Revision
IMAN_manifestation_relation_primary=
Item
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision
AUTO_Install
AUTO_Install Revision
IMAN_reference_relation_primary=
Item
ItemRevision
CommercialPart
ManufacturerPart
CommercialPart Revision
ManufacturerPart Revision
AppearanceGroup
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install
AUTO_Install Revision
IMAN_master_form_relation_primary=
Item
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Equipment
AUTO_Install
IMAN_specification_relation_primary=
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision

9-68 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

IMAN_Rendering_relation_primary=
Item
ItemRevision
Dataset
AUTO_Part
AUTO_Part Revision
AUTO_Vehicle
AUTO_Vehicle Revision
AUTO_Product
AUTO_Product Revision
AUTO_Tool
AUTO_Tool Revision
AUTO_Criteria
AUTO_Criteria Revision
AUTO_Proc_Plan
AUTO_Proc_Plan Revision
AUTO_Install
AUTO_Install Revision
IMAN_classification_relation_primary=
Item
ItemRevision
IMAN_CCContext_relation_primary=
CCObject

IMAN_StructureContent_relation_primary=
StructureContext

EC_addressed_by_rel_relation_primary=
Item
ItemRevision
EC_affected_item_rel_relation_primary=
Item
ItemRevision
EC_problem_item_rel_relation_primary=
Item
ItemRevision
EC_reference_item_rel_relation_primary=
Item
ItemRevision
EC_solution_item_rel_relation_primary=
Item
ItemRevision
IMAN_Motion_relation_primary=
ItemRevision
IMAN_suppliedItem_relation_primary=
ItemRevision
IMAN_UG_udf_relation_primary=
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision

PLM00026 D Preferences and Environment Variables Reference 9-69

Chapter 9 Interface preferences

AUTO_Proc_Plan Revision
AUTO_Install Revision
IMAN_UG_altrep_relation_primary=
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision
IMAN_UG_scenario_relation_primary=
ItemRevision
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision
IMAN_UG_wave_position_relation_primary=
ItemRevision
UGMASTER
UGALTREP
UGPART
UGSCENARIO
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision
IMAN_UG_wave_geometry_relation_primary=
ItemRevision
UGMASTER
UGALTREP
UGPART
UGSCENARIO
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision
IMAN_UG_wave_part_link_relation_primary=
ItemRevision
UGMASTER
UGALTREP
UGPART
UGSCENARIO
AUTO_Part Revision

9-70 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision

IMAN_UG_expression_relation_primary=
ItemRevision
UGMASTER
UGALTREP
UGPART
UGSCENARIO
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision

IMAN_UG_promotion_relation_primary=
ItemRevision
UGMASTER
UGALTREP
UGPART
UGSCENARIO
AUTO_Part Revision
AUTO_Vehicle Revision
AUTO_Product Revision
AUTO_Tool Revision
AUTO_Criteria Revision
AUTO_Proc_Plan Revision
AUTO_Install Revision
IMAN_RES_checkout_relation_primary=
RevisionAnchor
IMAN_snapshot_relation_primary=
ItemRevision
IMAN_MEMfgModel_relation_primary=
ItemRevision
IMAN_MEOutput_relation_primary=
MEProcessRevision
MEOPRevision
IMAN_MEFolder_relation_primary=
MEProcessRevision
MEOPRevision
IMAN_METarget_relation_primary=
MEProcessRevision
MEOPRevision
IMAN_MEWorkArea_relation_primary=
MEProcessRevision
MEOPRevision
IMAN_3D_snap_shot

PLM00026 D Preferences and Environment Variables Reference 9-71

Chapter 9 Interface preferences

IMAN_MEView_relation_primary=
Item
IMAN_MEProductAppearance_relation_primary=
PSOccurrence
IMAN_MEProductLocation_relation_primary=
PSOccurrence
IMAN_MERequiredAppr_relation_primary=
PSOccurrence
IMAN_MEAppearance_relation_primary=
PSOccurrence
CP_Has_Technical_Brief_relation_primary=
CPMarketingBriefRevision
CP_Has_Design_Brief_relation_primary=
CPMarketingBriefRevision
CP_Results_In_Package_Rough_relation_primary=
CPDesignBriefRevision
CPTechnicalBriefRevision
CP_Has_Graphical_Element_relation_primary=
CPPackageRoughRevision
CPThemeBoardRevision
CPDesignBriefRevision
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.
For information about changing columns from the interface, see Getting Started
with Teamcenter.
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
rd_type
rd_class
rd_state
rd_source
rd_query_source
rd_property_source
owning_group
owning_user
last_mod_date

9-72 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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

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
17
9
9
17
17
17
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 9-73

Chapter 9 Interface preferences

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.
For information about changing columns from the interface, see Getting Started
with Teamcenter.
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

SCOPE
Site preference.

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.

9-74 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

DEFAULT
VALUES
20
20
SCOPE
Site 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.
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
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

PLM00026 D Preferences and Environment Variables Reference 9-75

Chapter 9 Interface preferences

node
path
SCOPE
User preference.

RESERVATION_object_widths_hidden
DESCRIPTION
Specifies the column width for each column defined in the
RESERVATION_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 RESERVATION_object_columns_hidden user preference, and so on.
DEFAULT
VALUES
32
32
32
32
32
32
32
32
32
32
32
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

9-76 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

40
SCOPE
User preference.

Selection Criteria
DESCRIPTION
Determines which attachments are checked in and out with the selected item
revision. Each value is a relation-object set. When this preference is set, only the
specified secondary objects of the item revision, attached to the item revision with
the specified relation, are checked in and out with the item revision.
This same criteria can also be set by users in the interface.
Note
Use either the Selection Criteria preference or the Select IR to allow
checking item revisions in and out.

VALID
VALUES
One or more strings as values. Each value must be a relation-Teamcenter object pair.
DEFAULT
VALUES
Specification UGMASTER
Specification UGPART
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 to allow
checking item revisions in and out.

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
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 9-77

Chapter 9 Interface preferences

Structure_Alias_File
DESCRIPTION
Determines the alias file applied to the intermediate data capture object to display
its BOM structure. Alias files determine what displays in the IDCWindow. They
determine the root of the window, the children displayed in each line and the
properties for each line. These files contains 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
All shipped alias files are stored in the TC_DATA directory.

VALID
VALUES
Accepts a single string as a value. Must be the complete path to the alias XML file.
DEFAULT
VALUES
TC_DATA/structure_alias.xml
SCOPE
All.

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.
SCOPE
Site and user preference.

9-78 Preferences and Environment Variables Reference PLM00026 D

 Interface 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.
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
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.
DEFAULT
VALUES
ON
SCOPE
Site preference.

TC_auto_login
DESCRIPTION
Enables or suppresses the automatic logon feature for the entire site. Auto logon
uses operating system user names and passwords to log on to Teamcenter.
Note
The automatic logon feature is available only in a two-tier Teamcenter
environment.

VALID
VALUES
TRUE Enables automatic logon.

PLM00026 D Preferences and Environment Variables Reference 9-79

Chapter 9 Interface preferences

FALSE Suppresses automatic logon.

DEFAULT
VALUES
TRUE
SCOPE
Site preference.

TC_check_out_dir
DESCRIPTION
Specifies the operating system directory that contains exported dataset files. This
preference is only read if the Export Dataset on Checkout check box is enabled on
the checkout dialog box. If TC_checkout_and_export preference is set to 1, the
Export Dataset on Checkout check box is automatically checked.
VALID
VALUES
Single string as value; each string must be the full operating system path of the
directory or a null value. For example:
zzz empty string zzz

The null value exports the files to the current working operating system directory.
DEFAULT
VALUES
Null value.
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
SCOPE
User preference.

9-80 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
integer entered in a search field before the wildcard character can be entered.
DEFAULT
VALUES
0
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.
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.

PLM00026 D Preferences and Environment Variables Reference 9-81

Chapter 9 Interface preferences

VALID
VALUES
Accepts a single, positive integer as a value. The value represents days.
DEFAULT
VALUES
100
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.
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

9-82 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
SCOPE
User preference.

TC_Display_thumbnail_in_UI
DESCRIPTION
Shows or hides thumbnails in the interface.
VALID
VALUES
TRUE Shows thumbnails.
FALSE Hides thumbnails.
DEFAULT
VALUES
TRUE
SCOPE
Site 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

PLM00026 D Preferences and Environment Variables Reference 9-83

Chapter 9 Interface preferences

SCOPE
Site preference.

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
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.
DEFAULT
VALUES
True
SCOPE
User preference.

TC_GROUP_PFILE
DESCRIPTION
Points to the operating system directory containing group preference files.

9-84 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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.
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
SCOPE
User preference.

TC_inbox_interval
DESCRIPTION
Determines how often, in minutes, Teamcenter checks a user’s inbox for new tasks.
Note
A small interval, less than 20 minutes, could severely impact performance of
a large database with many users.

VALID
VALUES
–1 Disables checking.
0 Checks once during user logon.
>=time Checks after the defined interval.
in
minutes

PLM00026 D Preferences and Environment Variables Reference 9-85

Chapter 9 Interface preferences

DEFAULT
VALUES
–1
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
SCOPE
Site preference.

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

9-86 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

PLT
BMP
CAL
TIFF
Graphics-Interface
JTPART
Sheet
SCOPE
User 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.
VALID
VALUES
A single positive integer.
DEFAULT
VALUES
6
SCOPE
User preference.

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 (,).
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 9-87

Chapter 9 Interface preferences

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 IMAN_name_delimeter preference.
prefix_titles Prefix; for example: Mr., Mrs., Dr.
suffix_titles Suffix; for example: Jr., Ph.D.
DEFAULT
VALUES
last
delimiter
space
first
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
2
SCOPE
User preference.

9-88 Preferences and Environment Variables Reference PLM00026 D

 Interface 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
SCOPE

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.
VALID
VALUES
A single positive integer.
DEFAULT
VALUES
5
SCOPE
User preference.

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.
DEFAULT
VALUES
None.
The Windows default setting %TC_DATA%\rpfiles and the UNIX default setting
$TC_DATA/rpfiles are commented out.

PLM00026 D Preferences and Environment Variables Reference 9-89

Chapter 9 Interface preferences

SCOPE
User preference.

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
SCOPE
Site 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
SCOPE
User preference.

9-90 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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.
VALID
VALUES
0 All group members are displayed.
1 Only active group members are displayed.
DEFAULT
VALUES
5
SCOPE
User preference.

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.
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.
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 9-91

Chapter 9 Interface preferences

TC_VALIDATION_FILE_TYPES
DESCRIPTION
Determines the types of files that can be associated as datasets to validation data or
validation results objects.
VALID
VALUES
Accepts one or more strings as values. Each string must contain three string values:
dataset name, RefName and referencers (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
SCOPE
Site preference.

TC_VALIDATION_MANDATORY_CHECKERS
DESCRIPTION
Determines which mandatory checks must be attempted for a validation check.
VALID
VALUES
Accepts multiple strings as values. Each string must be a valid checker name.
DEFAULT
VALUES
None.
SCOPE
Site or user preference.

TC_Validation_relation_primary
DESCRIPTION
Displays validation results under the specified item revision types.

9-92 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid item revision type.
DEFAULT
VALUES
ItemRevision
ValidationData
ValidationResult
SCOPE
Site preference.

TC_VALIDATION_RESULT_ALLOW_REPLICA_OBJECT
DESCRIPTION
Determines whether validation results can be created at remote sites.
VALID
VALUES
TRUE Allows validation checks to be performed at remote sites on a
replica. Remote validation result objects are lost when deleted
from remote site, they cannot be exported.
FALSE Validation checks cannot be performed at remote sites on a
replica.
DEFAULT
VALUES
FALSE
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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 9-93

Chapter 9 Interface preferences

TC_wc_allow_subgroup_default
DESCRIPTION
Defines the default setting for the Subgroup Members Allowed checkbox in the New
Work Context dialog box. This option determines whether subgroup members of the
selected group are allowed to perform a task.
VALID
VALUES
true By default, the checkbox is checked and subgroup members are allowed to
perform a task.

false By default, the checkbox is not checked and subgroup members are not
allowed to perform a task.
DEFAULT
VALUES
True
SCOPE
Site preference.

TC_VALIDATION_USE_PLMXML
DESCRIPTION
Determines how Teamcenter communicates with a validation utility. Setting this
preference to TRUE generates a single PLM XML file for all of the targets to be
validated. The validation utility must be able to parse this file properly to execute
the validation for each target. Setting this preference to FALSE causes each target
to be treated separately.
VALID
VALUES
TRUE Causes a single PLM XML file to be generated for all targets.

FALSE Causes each target to be treated separately.

DEFAULT
VALUES
FALSE
SCOPE
Site preference.

TC_wc_setting_modifiable_default
DESCRIPTION
Defines the default setting for the User Settings Modifiable checkbox 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.

9-94 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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

PLM00026 D Preferences and Environment Variables Reference 9-95

Chapter 9 Interface preferences

revision_number
date_released
archive_info
owning_group
last_mod_user
owning_user
creation_date
archive_date
last_mod_date
backup_date
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.
DEFAULT
VALUES
object_name
symbol_name
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

9-96 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

32
32
32
32
32
32
32
32
32
32
32
32
SCOPE
User preference.

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

Tracelink_deepcopy_on_Revise
DESCRIPTION
Determines deep copy rules for trace link behavior when an item is revised.
VALID
VALUES
1 Copies links from complying and defining objects.
2 Copies links only from defining object.
3 Copies links only from complying objects.
4 Does not copy forward any links.
DEFAULT
VALUES
1

PLM00026 D Preferences and Environment Variables Reference 9-97

Chapter 9 Interface preferences

SCOPE
Site preference.

Tracelink_deepcopy_on_SaveAs
DESCRIPTION
Determines deep copy rules for trace link behavior when users perform a SaveAs on
an item.
VALID
VALUES
1 Copies links from complying and defining objects.
2 Copies links only from defining object.
3 Copies links only from complying objects.
4 Does not copy forward any links.
DEFAULT
VALUES
1
SCOPE
Site 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.
SCOPE
User 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 additional information, see the
Rich Client Interface Guide. The system creates a preference for each item and item

9-98 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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

PLM00026 D Preferences and Environment Variables Reference 9-99

Chapter 9 Interface preferences

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

9-100 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

tasks_to_perform
tasks_to_review
release_status_list
IMAN_external_object_link
Dataset_DefaultChildProperties=
IMAN_external_object_link
MSWord_DefaultChildProperties=
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_MEMfgModel
IMAN_MEOutput
IMAN_METarget
IMAN_MEWorkArea
IMAN_3D_snap_shot
MEOPRevision_DefaultChildProperties=
IMAN_master_form_rev
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_MEMfgModel
IMAN_MEFeature
IMAN_MEOutput
IMAN_METarget
IMAN_3D_snap_shot
CCObject_DefaultChildProperties=

PLM00026 D Preferences and Environment Variables Reference 9-101

Chapter 9 Interface preferences

IMAN_CCContext
config_context
IMAN_specification
IMAN_requirement
IMAN_manifestation
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
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 additional information, see the
Rich Client Customization Programmer’s Guide. The XML file allows users to define
a set of 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 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.
VALID
VALUES
Accepts a single string as a value. Must be a valid dataset name, which contains
rendering XML.

9-102 Preferences and Environment Variables Reference PLM00026 D

 Interface 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 the Rich Client Interface
Guide.
SCOPE
Site preference.

<type_name>.RENDERING
DESCRIPTION
Teamcenter property displays are based on an XML style sheet. The style sheet
must be created and registered by a system administrator; see the Rich Client
Customization Programmer’s Guide for additional information. The XML file allows
users to define a set of 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 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. 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 the Rich Client Interface
Guide.
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.
DEFAULT
VALUES
None.
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 9-103

Chapter 9 Interface preferences

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
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.
SCOPE
User preference.

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.

9-104 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

DEFAULT
VALUES
20
20
20
20
20
20

SCOPE
User preference.

VALIDATION_APPLICATIONS
DESCRIPTION
Enables or disables validation object functionality.
VALID
VALUES
Accepts one or more strings as values; each string must be the name of a validating
software application, such as NX or I2.
Providing a valid value enables the validation functionality.
DEFAULT
VALUES
NX Check-Mate
SCOPE
Site preference.

ValidationMasterFormColumnPreferences
DESCRIPTION
Defines the list of property names to be displayed as columns in the results data
table.

PLM00026 D Preferences and Environment Variables Reference 9-105

Chapter 9 Interface preferences

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
result_state_flag
validation_application
validation_utility_name
validation_user
validation_date
SCOPE
Site preference.

ValidationMasterFormColumnWidthPreferences
DESCRIPTION
Specifies the widths of columns displayed in the results data table.

9-106 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

VALID
VALUES
10
25
15
10
10
15
10
10
10
15
DEFAULT
VALUES
15
25
10
25
15
15
10
10
15
SCOPE
Site preference.

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

PLM00026 D Preferences and Environment Variables Reference 9-107

Chapter 9 Interface preferences

The Requirements Manager application itself can be used without MS Word 2007.
For additional information about requirement content and using the Requirements
Manager, see the Requirements Manager Guide.
Note
Users who do not have MS Word 2007 installed can edit requirement content
in a separate Word window by choosing the File->Open Text 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
SCOPE
Site preference.

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
SCOPE
User preference.

9-108 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
SCOPE
User preference.

WORKSPACEOBJECT_object_widths_hidden
DESCRIPTION
Specifies the column width for each column defined in the
WORKSPACEOBJECT_object_columns_hiddenuser 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
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 9-109

Chapter 9 Interface preferences

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
SCOPE
User preference.

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

9-110 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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

PLM00026 D Preferences and Environment Variables Reference 9-111

Chapter 9 Interface preferences

1 Expands a folder immediately after an object has been pasted into it.
DEFAULT
VALUES
0
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
SCOPE
User preference.

WsoFolderSavePref
DESCRIPTION
Determines when to save rich client data.
VALID
VALUES
1 Saves each change immediately.
2 Requires manually saving.

9-112 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

3 Prompts user to save changes at exit.

DEFAULT
VALUES
1
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
SCOPE
User 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.
SCOPE
Site preference.

WsoInsertSelectionsPref
DESCRIPTION
Determines the location for new objects in the rich client.
VALID
VALUES
1 All selected folders.
2 First selected folder.

PLM00026 D Preferences and Environment Variables Reference 9-113

Chapter 9 Interface preferences

3 User’s Newstuff folder.

4 Saves the object in the database but does not display it in the rich client.
DEFAULT
VALUES
1
SCOPE
User 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.

VALID
VALUES
Accepts a single string as a valid value.
DEFAULT
VALUES
;
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
SCOPE
User preference.

WSOM_find_set_total_limit
DESCRIPTION
Determines the total number of objects that can be returned in My Teamcenter
for any given search operation. This site-wide preference limits the total return
count, not the per-page count determined by the WSOM_find_set_search_limit
user preference.

9-114 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

VALID
VALUES
0 No limit.
A The total number of objects to be returned to My Teamcenter for any given
single search operation.
positive
integer.
DEFAULT
VALUES
0
SCOPE
Site 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
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

PLM00026 D Preferences and Environment Variables Reference 9-115

Chapter 9 Interface preferences

SCOPE
User preference.

Thin client interface preferences

The thin client provides a streamlined browser-based view of the product information
stored in your Teamcenter database. Most interface display preferences affect both
the rich client and the thin client. The following thin client-specific preferences
modify the display and behavior of only the thin client.
Preferences are typically set using the Options dialog box, accessed from the
Edit menu. As you create/modify preferences, your current group/role determines
both user access to the preference and the precedence of its behavior when there
are multiple incidences of the same preference. For additional information, see
Preference scope.

General thin client preferences

Use these preferences to configure general thin client behavior.

appbar_title_contents
DESCRIPTION
Specifies values to be displayed in the title string of the thin client application bar.
They must be on a line by themselves. 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 logged on user is assigned to.
role Specifies the role of logged on user.
site Specifies the site identifier.
object Name of selected object.
rev_rule Specifies the revision rule in effect.
application Specifies the active application name.
curr_proj Specifies the current project selected.
version Specifies the version of selection.
DEFAULT
VALUES
(
user
(
userid
)
-

9-116 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

group
/
role
-
rev_rule
-
[
site
]
)
SCOPE
User preference.

JT_WEB_UI_PREF
DESCRIPTION
Works only with Teamcenter’s 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.
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’s 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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 9-117

Chapter 9 Interface 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.
SCOPE
Site 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.
DEFAULT
VALUES
1
SCOPE
User preference.

WEB_<Class>_default_type
DESCRIPTION
Defines the default type to be displayed in the New dialog boxes.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter type.
DEFAULT
VALUES
Item
SCOPE
User preference.

9-118 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

WEB_Change_default_type
DESCRIPTION
Defines the default change type to be displayed in the New Change dialog box.
VALID
VALUES
Single string; the string must be a valid Teamcenter change type.
DEFAULT
VALUES
CR
SCOPE
Site preference.

WEB_core_help_server
DESCRIPTION
Set to the URL of your site’s core Teamcenter online help page. If you are running
online help on the thin client server, you can use a relative URL.
VALID
VALUES
Valid Web server address.
DEFAULT
VALUES
/%DEPLOYED_APP_NAME%/help/index.htm
%DEPLOYED_APP_NAME% is substituted at runtime by retrieving the
application name from the server request.
SCOPE
User preference.

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
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 9-119

Chapter 9 Interface preferences

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 URL path is included in Teamcenter mail messages via the CR-notify
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
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 CR-notify 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’s 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.
SCOPE
Site preference.

9-120 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

WEB_disable_structure_read_optimizations
DESCRIPTION
Disables optimization in Structure Manager structure that limits depth of
examination to the one currently displayed in browser.
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
SCOPE
Site preference.

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
SCOPE
User preference.

WEB_help_server
DESCRIPTION
Set to the URL of your site’s thin client online help page. If you are running online
help on the thin client server, you can use a relative URL.
VALID
VALUES
Valid Web server address.
DEFAULT
VALUES
/%DEPLOYED_APP_NAME%/help/thin_client_dhtml/book.html

PLM00026 D Preferences and Environment Variables Reference 9-121

Chapter 9 Interface preferences

%DEPLOYED_APP_NAME% is substituted at runtime by retrieving the

application name from the server request.
SCOPE
User preference.

WEB_filter_user
DESCRIPTION
Determines whether to automatically filter the SA User 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 users contained in
the database. The list box contents may be extensive for large sites, slowing
loading time.
DEFAULT
VALUES
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 additional information about configuring the
Teamcenter Web middle tier, see the basic deployment section
of the Web Application Deployment Guide.
DEFAULT
VALUES
http://
SCOPE
Site preference.

9-122 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

WEB_status_icons
DESCRIPTION
Determines the display of the release status icons in the thin client. You can also
use this preference to configure the display of custom release status icons. List
status names in this preference, then add a corresponding .gif and/or .png file to the
TC_ROOT/web/htdocs/tc/webtier_static/teamcenter/dhtml/icons.
The system retrieves .gif or .png files of the same
name as the values defined in this preference from the
TC_ROOT/web/htdocs/tc/webtier_static/teamcenter/dhtml/icons folder of the
deployed web tier. For example, if the value Approved is set for this preference, the
system looks for Approved.gif and Approved.png. The .gif files are preferred
by Internet Explorer browser, the .png files are preferred by Mozilla. The browser
application first attempts to load the preferred image type, then the non-preferred
type. If neither image is found for the custom status, the ReleaseStatus.gif
or .ReleaseStatus.png is displayed.
Note
Failing to provide the browser’s first choice of images has a performance
impact every time the backup image is loaded. The performance impact can
be significant and should be avoided.

When adding custom release statuses, an icon of the same name (case-sensitive)
must be added to the directory noted above. Then you must regenerate and deploy
using insweb.
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
release name, or one of the following custom release statuses:
external_links
in_process
configured
For each string there must be a corresponding .gif and/or .png file placed in the
TC_ROOT/web/htdocs/tc/webtier_static/teamcenter/dhtml/icons folder. The
.gif and .png file names cannot contain spaces; replace any spaces with underscores.
DEFAULT
VALUES
inprocess
configured
TCM Released
Pending
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 9-123

Chapter 9 Interface preferences

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
SCOPE
Site preference.

WEB_column_one_new_window
DESCRIPTION
Determines whether links in the first column of table-based pages open in a new
window.
VALID
VALUES
0 Does not open a new window.
1 Does open a new window.
DEFAULT
VALUES
1
SCOPE
Site preference.

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

9-124 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
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
Accepts multiple strings as values; each string must be a valid Teamcenter menu
entry.
DEFAULT
VALUES
General...
Item — Simple
System Admin
in-CLASS
Web Collection
General Collection
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 additional information about menu suppression, see the Application
Administration Guide.
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 the Command Suppression Guide.

PLM00026 D Preferences and Environment Variables Reference 9-125

Chapter 9 Interface preferences

VALID
VALUES
Accepts multiple strings as values; each string must be a valid Teamcenter menu
entry key.
DEFAULT
VALUES
None.
SCOPE
Site 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
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
SCOPE
User preference.

WEB_item_shown_relations
DESCRIPTION
Defines the item relation types shown on item pages.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter item relation type.
DEFAULT
VALUES
ItemRevision
IMAN_master_form

9-126 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_Rendering
SCOPE
All.

WEB_itemrevision_shown_relations
DESCRIPTION
Defines the item revision relation types shown on item pages.
VALID
VALUES
One or more strings; each string must be a valid Teamcenter item relation type.
DEFAULT
VALUES
PSBOMViewRevision
IMAN_master_form
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
IMAN_Rendering
SCOPE

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:popupNewItemDialog()
• 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:popupNewItemDialog() string represents the javascript

function to be called when the link is clicked.

PLM00026 D Preferences and Environment Variables Reference 9-127

Chapter 9 Interface preferences

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.

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:popupNewItemDialog()
web_lhn_iwantto_create_dataset:typeicons/
Dataset.png:javascript:popupNewDatasetDialog()
web_lhn_iwantto_create_workflow_process:teamcenter/dhtml/images/
process.png:javascript:initiateProcess()
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

9-128 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

SCOPE

WEB_max_search_results
DESCRIPTION
Defines the default number of objects returned for a search.
VALID
VALUES
A single integer.
DEFAULT
VALUES
30
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.
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.

PLM00026 D Preferences and Environment Variables Reference 9-129

Chapter 9 Interface preferences

SCOPE
Site preference.

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
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.
SCOPE
User 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.
SCOPE
All.

9-130 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
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.
1 Item revisions that have not been configured are displayed.
DEFAULT
VALUES
0
SCOPE
All.

WEB_simple_search_queries
DESCRIPTION
Lists single field saved queries to be exposed in the navigation pane quick search box.
VALID
VALUES
Localized query names.
DEFAULT
VALUES
Item ID
Keyword Search
Item Name
Dataset Name

PLM00026 D Preferences and Environment Variables Reference 9-131

Chapter 9 Interface preferences

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

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

DEFAULT
VALUES
Teamcenter

9-132 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

SCOPE
User preference.

WEB_title_contents
DESCRIPTION
Defines the contents of the thin client title bar.
VALID
VALUES
The following variable values must be on a line by themselves. Any other values are
rendered as literal text with single space separators:
application
object
user
group
role
site
rev_rule
version

DEFAULT
VALUES
The default setting is as follows:
WEB_title_contents=
application
-
object
- [
site
]
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.
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 9-133

Chapter 9 Interface preferences

WEB_use_activex_lov
DESCRIPTION
Determines whether ActiveX or legacy LOVs display in dialog boxes and forms.
VALID
VALUES
yes Enables display of ActiveX LOVs in dialog boxes and forms.
However, ActiveX LOVs display only if supported by the
browser. For example, Internet Explorer security settings
would need to be set to support ActiveX controls. If ActiveX
is not supported by the user’s browser, the following error
displays:
Your current security settings prohibit running ActiveX
controls on this page.
As a result the page may not display correctly

no Displays legacy LOVs in dialog boxes and forms.

DEFAULT
VALUES
yes
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.
0 The Home contents do not appear in the Quick Links section of the thin
client navigation pane by default.
DEFAULT
VALUES
1
SCOPE
User preference.

9-134 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
SCOPE
User preference.

Thin Client column and property preferences

Use column preferences to define which columns are displayed in the thin client
pages. All column headings for these properties are the same as specified for the
rich client.

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
object_type
last_mod_date
checked_out
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 9-135

Chapter 9 Interface preferences

WEB_inbox_columns
DESCRIPTION
Defines which properties are displayed as columns on inbox pages.
Tip
When using this preference as a user preference, set inbox columns using the
Options dialog box. Using this method, all valid choices are presented in the
dialog box, and manual editing of this preference is not required.

VALID
VALUES
Accepts multiple strings as values. Each string must be a valid property of the
EPMTask type.
Note
If using the EPM_comment_attachment property, additional ITK
customization is required before comments will display in the Comments
column. For additional information, see the Integration Toolkit Function
Reference manual.

DEFAULT
VALUES
job_name
parent_name
resp_party
creation_date
SCOPE
All.

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

9-136 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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
bl_quantity
bl_item_uom_tag
bl_all_notes
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

SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 9-137

Chapter 9 Interface preferences

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

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
SCOPE
Site preference.

9-138 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

Thin Client image preferences

Use image preferences to control which types of images are displayed in the thin
client.

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

PLM00026 D Preferences and Environment Variables Reference 9-139

Chapter 9 Interface preferences

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

9-140 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

DEFAULT
VALUES
image/gif
image/jpeg
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:
image/jpeg, image/tiff, image/gif, image/cgm,
x-world/x-vrml
DEFAULT
VALUES
image/gif
SCOPE
Site preference.

Thin client DesignContext preferences

Use thin client DesignContext preferences to define search behavior for context
searches performed using the thin client.

WebDesignContextDefaultSearchDistance
DESCRIPTION
Defines the search distances for default searches defined in the
RDV_context_search call to search the currently active context. 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

PLM00026 D Preferences and Environment Variables Reference 9-141

Chapter 9 Interface preferences

SCOPE
User preference.

WebDesignContextMaxMatchingBOMLines
DESCRIPTION
Sets the maximum number of search matches to load. If the context search returns
more components than the number defined in this preference, an error is returned.
The user need to increase the setting of this preference.
Use this preference to avoid loading extremely large context search returns.
VALID
VALUES
A positive integer.
DEFAULT
VALUES
None.
SCOPE
All.

WebDesignContextMaxMatchingObjects
DESCRIPTION
Sets the maximum number of objects to add to an RDV context. If the context search
returns more components than the number defined in this preference, an error is
returned. The user needs to increase the setting of this preference.
Use this preference to avoid loading extremely large context search returns.
VALID
VALUES
A positive integer.
DEFAULT
VALUES
None.
SCOPE
All.

Thin client Teamcenter’s manufacturing process management

preferences
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 the Getting Started with Manufacturing.

9-142 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

Tip
Be sure to read the section on creating reports in thin client in the Getting
Started with Manufacturing 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 Guide
for information about using these reports via the thin client.

WEB_ZoneProcess_Reports
DESCRIPTION
Used for Teamcenter’s 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 Contains links to files that help in identification of the location
Report 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
SCOPE
Site preference.

WEB_StationProcess_Reports
DESCRIPTION
Used for Teamcenter’s 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 All datums associated with any MELocateCompOp process
Key that is a child of any children of the station display in a table.

PLM00026 D Preferences and Environment Variables Reference 9-143

Chapter 9 Interface preferences

Station Weld All welds associated with any MEWeldOp process that is a
Data Key child of any children of the station display in a table.
Process Flow Displays the image attached to this station process as
Sheet a 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
Sheet a 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 Displays the image attached to this station process as
Application a TMXMisc dataset type, using the following naming
Sheet 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
Sheet a 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.
Induction Cure Displays the image attached to this station process as
Sheet a 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.

9-144 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

Fastener Data Displays the image attached to this station process as

Sheet a 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
SCOPE
Site preference.

WEB_MEWeldOp_Reports
DESCRIPTION
Used for Teamcenter’s manufacturing process management Web reports. Defines
which report formatters (XSL style sheets) can be retrieved when the weld operation
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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 9-145

Chapter 9 Interface preferences

WEB_MEPrPlantProcess_Reports
DESCRIPTION
Used for Teamcenter’s 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
SCOPE
Site preference.

WEB_MELocateCompOp_Reports
DESCRIPTION
Used for Teamcenter’s 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
SCOPE
Site preference.

Class_Resource_WeldGun
DESCRIPTION
Used for Teamcenter’s 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.

9-146 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

SCOPE
User preference.

Class_Resource_Robot
DESCRIPTION
Used for Teamcenter’s 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.
SCOPE
User preference.

TC_suppress_report_designs
DESCRIPTION
Determines whether specified manufacturing report formatters display in the
Teamcenter’s 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.
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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 9-147

Chapter 9 Interface preferences

TC_TransferMode_XMLReport
DESCRIPTION
Used for Teamcenter’s 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
SCOPE
Site preference.

TC_Report_Transfer_Area
DESCRIPTION
Used for Teamcenter’s 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)
/vobs/web_src/htdocs/web_reports/temp (UNIX)
SCOPE
Site preference.

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

9-148 Preferences and Environment Variables Reference PLM00026 D

 Interface preferences

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)
SCOPE
Site preference.

Web_Report_Jars
DESCRIPTION
Used for Teamcenter’s manufacturing process management Web reports. Defines the
absolute path to the report JAR files.
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)
/vobs/web_src/htdocs/web_reports/jar (UNIX)
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 9-149

Chapter

10 Workflow preferences

INVOKE_SYSTEM_HANDLERS_skip_unreadable_objects . . . . . . . . . . . . . . 10-1
SIGNOFF_required_group_and_role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
SIGNOFF_fill_in_reviewers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
CR_allow_alternate_procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
TC_CM_approvers_modifier_roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
EPM_adhoc_signoffs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
SIGNOFF_adhoc_quorum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4
EPM_valid_user_to_apply_assignment_list . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4
EPM_valid_roles_to_assign_responsible_party . . . . . . . . . . . . . . . . . . . . . . . 10-5
EPM_multiple_processes_targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6
EPM_ARG_target_user_group_list_separator . . . . . . . . . . . . . . . . . . . . . . . . 10-6
EPM_resource_pool_recipients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6
Global_transfer_access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
TCVIEWER_default_workflow_view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
WORKFLOW_new_route_task_panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
INBOX_hide_suspended_tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
TASK_MONITOR_SLEEP_TIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9
ORG_UIF_spacing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9
ORG_UIF_user_name_display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9
WORKFLOW_adhoc_process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
WORKFLOW_advanced_paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
TC_external_default_launch_ui . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
EPM_notify_url_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11
RICH_CLIENT_MARKER_ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11

PLM00026 D Preferences and Environment Variables Reference

Chapter

10 Workflow preferences

Workflow automates one or more business processes to accomplish an objective.

Teamcenter workflow applications include Workflow Viewer, Workflow Designer, and
the worklist in My Teamcenter. Users use workflow to pass documents, information,
and tasks among participants during the completion of a particular process.
Workflows can also be used to distribute parts, projects, assignments, documents
and other business process elements throughout your organization based on process
templates that you design in Workflow Designer. The workflows distribute the
objects through worklists displayed in My Teamcenter. For additional information,
see the Workflow Designer Guide.
Use workflow preferences to modify the behavior and display of the workflow
applications.

INVOKE_SYSTEM_HANDLERS_skip_unreadable_objects
DESCRIPTION
Determines whether to provide information about unreadable objects to the XML
file. This preference provides the same functionality as the –skip_unreadable_objs
argument for the invoke-system-action and invoke-system-rule workflow
handlers. The handlers execute an external command such as Perl scripts, shell
scripts or external ITK programs, then continues or halts the workflow process based
on the return code of the external command. These handlers provide increased
control of the workflow process. For example, to synchronize NX attributes and
structure with Teamcenter or to generate JT tessellation from CAD files.
The handlers write process-related information to an XML file. The file is then
passed to the external script/program as –f XML-filename. For more information,
see Workflow Designer Guide.
Business rules at your site may prevent the completion of a process when the
handler encounters objects that do not have read access. The handlers use the
–skip_unreadable_objs argument to bypass this error. This preference performs
the same function as the –skip_unreadable_objs argument. Set this preference to
YES to skip the unreadable objects error for jobs already in process.
Note
Use this preference for processes that were created using the
invoke-system-action or invoke-system-rule handlers before the
–skip_unreadable_objs argument was available in V9. Implement this
preference by adding it to the database setting it to YES.

PLM00026 D Preferences and Environment Variables Reference 10-1

Chapter 10 Workflow preferences

VALID
VALUES
YES Prevents providing information about unreadable objects to the XML file.
NO Provides information about unreadable objects to the XML file.
DEFAULT
VALUES
None.
SCOPE
Site preference.

SIGNOFF_required_group_and_role
DESCRIPTION
Determines whether a user must be logged in to the correct group/role to sign off
an assigned task.
VALID
VALUES
0 User must be a registered member of the group and role required by the
signoff task, but does not have to be logged in as a member of that group or
role to perform the signoff.
1 User must be a registered member of the group and role required by the
signoff task and must be logged in as a member of that group or role to
perform the signoff.
DEFAULT
VALUES
0
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

10-2 Preferences and Environment Variables Reference PLM00026 D

 Workflow preferences

SCOPE
All.

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.
AssignedThe 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
any
SCOPE
User preference.

TC_CM_approvers_modifier_roles
DESCRIPTION
Lists Teamcenter roles that can create, modify and delete Change Viewer approver
lists.
VALID
VALUES
One or more strings as a value; each string must be a valid Teamcenter role.
DEFAULT
VALUES
None.
SCOPE

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.

PLM00026 D Preferences and Environment Variables Reference 10-3

Chapter 10 Workflow preferences

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
SCOPE
User 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
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.
world All users are authorized to use this feature.
privileged Group and site administrators are authorized to use this
feature.

10-4 Preferences and Environment Variables Reference PLM00026 D

 Workflow preferences

Group:role Members of the specified group and role are authorized to

use this feature.
DEFAULT
VALUES
owner
SCOPE
Site preference.

EPM_valid_roles_to_assign_responsible_party
DESCRIPTION
Determines the list of privileged users allowed to reassign the Responsible Party
responsibility of a task.
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.
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
where group is a valid Teamcenter group name and role is a valid
Teamcenter role name.
DEFAULT
VALUES
privileged
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 10-5

Chapter 10 Workflow preferences

EPM_multiple_processes_targets
DESCRIPTION
Determines whether to allow multiple processes for the same objects.
VALID
VALUES
ON Allows multiple processes for the same objects.
OFF Does not allow multiple processes for the same objects.
DEFAULT
VALUES
OFF
SCOPE
Site preference.

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
,
SCOPE
All.

EPM_resource_pool_recipients
DESCRIPTION
Determines task notification e-mail recipients. 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.
DEFAULT
VALUES
subscribed
SCOPE
All.

10-6 Preferences and Environment Variables Reference PLM00026 D

 Workflow preferences

Global_transfer_access
DESCRIPTION
Sets the access to the global-access 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.
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
SCOPE
Site 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
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.

PLM00026 D Preferences and Environment Variables Reference 10-7

Chapter 10 Workflow preferences

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 the
Workflow Designer Guide. For additional information about how Route tasks are
performed by users, see the Rich Client Interface Guide.
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
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 only the task it is performed upon. Does not remove/add a task
from/to a user’s inbox.
1 Affects only 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.
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

10-8 Preferences and Environment Variables Reference PLM00026 D

 Workflow preferences

SCOPE

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

ORG_UIF_spacing
DESCRIPTION
Sets spacing in pixels between nodes in the organizational chart.
VALID
VALUES
Single integer as a value.
DEFAULT
VALUES
15
SCOPE

ORG_UIF_user_name_display
DESCRIPTION
Determines whether user name, person name, or both should be used in the
organizational chart.
VALID
VALUES
1 User name.

2 Person name.

3 Person name (user name).

DEFAULT
VALUES
1

PLM00026 D Preferences and Environment Variables Reference 10-9

Chapter 10 Workflow preferences

SCOPE

WORKFLOW_adhoc_process
DESCRIPTION
Determines which type of user can modify the structure and behavior of a process
while it is being run via Design mode. When allowed access to Design mode, a user
can modify a running process in the same manner that a system administrator
can modify a process template.
VALID
VALUES
0 All users have access.
1 System administrator access.
2 System administrator and group administrator access.
DEFAULT
VALUES
2
SCOPE

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
SCOPE
User 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 additional information about
viewing remote inboxes, see the Rich Client Interface Guide.

10-10 Preferences and Environment Variables Reference PLM00026 D

 Workflow preferences

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
SCOPE
User preference.

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.
none No URL is inserted in the notification e-mail.
DEFAULT
VALUES
rich
dhtml
SCOPE
All.

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

PLM00026 D Preferences and Environment Variables Reference 10-11

Chapter 10 Workflow preferences

SCOPE
All.

10-12 Preferences and Environment Variables Reference PLM00026 D

Chapter

11 Change Viewer preferences

CM_color_of_add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
CM_color_of_cancel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
CM_color_of_common . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
CM_color_of_moved . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3
CM_color_of_notechange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3
CM_color_of_quantity_change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4
CM_color_of_reshaped . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4
CM_color_of_variantchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5
CM_initial_position_of_sliders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5
CM_progression_tree_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5
CM_show_common_parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
ECM_affected_item_relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
ECM_bomchange_formtype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7
ECM_bomchange_tooltip_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7
ECM_change_id_modifiable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-8
ECM_change_name_is_mandatory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-8
ECM_delivered_engine_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-8
ECM_form_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-9
ECM_genealogy_expansion_rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-9
ECM_note_types_to_track . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-9
ECM_notehistory_extra_columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-10
ECM_prev_structure_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-10
ECM_prev_structure_relation_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11
ECM_property_access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11
ECM_property_display_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11
ECM_property_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-12
ECM_pseudofolder_names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-12
ECM_set_genealogy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-13
ECM_supercedure_tooltip_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-13
ECM_track_variant_condition_changes . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-14
ECM_varianthistory_extra_columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-14
Enable_Create_Classic_Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-15
Enable_Show_Classic_Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-15
EngChange Revision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . 11-16
Supercedure_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16
TAE_CM_change_name_is_mandatory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-17
TAE_CM_show_task_viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-17
TC_bomchange_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-18
TC_supercedure_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-18

PLM00026 D Preferences and Environment Variables Reference

Chapter

11 Change Viewer preferences

Change Viewer is 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 various usages traceable. Your 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 your
organization of changes. You configure Change Viewer objects using the Change
Viewer. For additional information, see the Change Viewer Guide.
Use Change Viewer preferences to modify Change Viewer behavior in Structure
Manager and Change Viewer.
Note
Change Viewer is deprecated. If you are using Change Manager, see Change
Manager preferences.

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
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 11-1

Chapter 11 Change Viewer preferences

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.
DEFAULT
VALUES
255,20,47
Red
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
SCOPE
User preference.

11-2 Preferences and Environment Variables Reference PLM00026 D

 Change Viewer preferences

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.
DEFAULT
VALUES
122,183,122
Green
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
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 11-3

Chapter 11 Change Viewer preferences

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.
DEFAULT
VALUES
255,118,0
Orange
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
SCOPE
User preference.

11-4 Preferences and Environment Variables Reference PLM00026 D

 Change Viewer preferences

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.
DEFAULT
VALUES
100,255,50
Sea green
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.
SCOPE
User preference.

CM_progression_tree_relation
DESCRIPTION
Determines which of two possible relationships to use for the revisions in the
Progression tree.

PLM00026 D Preferences and Environment Variables Reference 11-5

Chapter 11 Change Viewer preferences

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
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
SCOPE
User preference.

ECM_affected_item_relations
DESCRIPTION
Sets the list of relations of the affected items of an engineering change. Workflow
handlers attach the objects under the relations as targets of the engineering change
process. Teamcenter uses this reference to add a release status to the process targets.

11-6 Preferences and Environment Variables Reference PLM00026 D

 Change Viewer preferences

The setting of this preference affects the behavior of the ECM_is_affected_rev ITK
call. For additional information, see the Server Customization Programmer’s Guide.
VALID
VALUES
Accepts one or more strings as values; each string must be a valid Teamcenter
relation.
DEFAULT
VALUES
EC_affected_item_rel
EC_solution_item_rel
SCOPE
Site preference.

ECM_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
SCOPE
Site preference.

ECM_bomchange_tooltip_properties
DESCRIPTION
Sets the BOMChange component properties displayed in the Genealogy WatchBox.
Item is the base component for property extraction. It is possible to derive a value
by traversing the properties starting from the item tag. For example, to display
a unit of measure for the item, enter:
UoM=uom_tag.symbol
VALID
VALUES
Accepts one or more strings as values; each string is a paring of the desired display
name and a valid Teamcenter component property.
DEFAULT
VALUES
Item ID=item_id
Item Owner=owning_user
Item Creation Date=creation_date
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 11-7

Chapter 11 Change Viewer preferences

ECM_change_id_modifiable
DESCRIPTION
Allows you to modify the change id and the revision id values that are assigned
by the system.
VALID
VALUES
True
False
DEFAULT
VALUES
False
SCOPE
Site preference.

ECM_change_name_is_mandatory
DESCRIPTION
Determines whether the Change Name box in the Create/Revise Screen dialog box
displays in the Base Attributes tab as a mandatory field, or in the More Attributes
tab as an optional field.
VALID
VALUES
TRUE The Change Name box appears in the Base Attributes tab of the
Create/Revise Screen dialog box as a mandatory field.
FALSE The Change Name box appears in the More Attributes tab of the
Create/Revise Screen dialog box as an optional field.
DEFAULT
VALUES
TRUE
SCOPE
Site preference.

ECM_delivered_engine_status
DESCRIPTION
Sets the status used for delivered engineering changes. BOM changes are considered
delivered engineering changes when the affected revision is assigned a delivered
release status. The genealogy functionality uses this setting to distinguish between
a normal change and a delivered change.
VALID
VALUES
Delivered Assigns a delivered status to the engineering change.
DEFAULT
VALUES
Delivered

11-8 Preferences and Environment Variables Reference PLM00026 D

 Change Viewer preferences

SCOPE
User preference.

ECM_form_relation
DESCRIPTION
Sets the relation by which engineering change forms are attached to the engineering
change.
VALID
VALUES
Accepts one or more strings as values; must be a valid Teamcenter relation.
DEFAULT
VALUES
IMAN_specification
SCOPE
Site preference.

ECM_genealogy_expansion_rule
DESCRIPTION
Sets the expansion rule for the genealogy display.
VALID
VALUES
NEW Supersedures already displayed are ignored.
ALL All supersedures are displayed, irrespective of whether they have already
been displayed or not.
DEFAULT
VALUES
ALL
SCOPE
Site preference.

ECM_note_types_to_track
DESCRIPTION
Specifies which note types can be tracked for a particular change type. If an entry is
not made for a particular change type, the ability to track changes via occurrence
notes is disabled.
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:
ECM_note_types_to_track=
Change-Type1:Note-Type1,Note-Type2
Change-Type2:Note-Type1,Note-Type4

PLM00026 D Preferences and Environment Variables Reference 11-9

Chapter 11 Change Viewer preferences

Note
Do not set this preference with a value of UG ALTREP note type.

DEFAULT
VALUES
None.
SCOPE
Site preference.

ECM_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.
The BOM change form is defined by the ECM_bomchange_formtype preference.
VALID
VALUES
Accepts multiple strings as values; each string must contain a persistent property
of the BOM change form, using the following syntax:
ECM_notehistory_extra_columns=
Form-Field1
Form-Field2
DEFAULT
VALUES
None.
SCOPE
Site preference.

ECM_prev_structure_relation
DESCRIPTION
Sets the relation that defines the problem item as identified in the engineering
change. This reference is used to create genealogy. Only one relation can be specified.
VALID
VALUES
Accepts a single string as a value. Must be a valid Teamcenter relation.
DEFAULT
VALUES
EC_problem_item_rel
SCOPE
Site preference.

11-10 Preferences and Environment Variables Reference PLM00026 D

 Change Viewer preferences

ECM_prev_structure_relation_name
DESCRIPTION
Sets the relation that defines the problem item as identified in the engineering
change. This relation is used to create genealogy. Only one relation can be specified.
VALID
VALUES
DEFAULT
VALUES
problem_items
SCOPE

ECM_property_access
DESCRIPTION
Specifies the access (such as read, write) given to user for engineering change
properties in EC Viewer.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
r-
r-
r-
r-
r-
r-
r-

SCOPE
Site preference.

ECM_property_display_names
DESCRIPTION
Sets the list of property labels displayed in by the viewer table of an engineering
change.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
Change #
Change Type
Owner
Date Created

PLM00026 D Preferences and Environment Variables Reference 11-11

Chapter 11 Change Viewer preferences

Last Modified By
Name
Description
SCOPE
Site preference.

ECM_property_names
DESCRIPTION
Sets the list of properties displayed by the viewer table of an engineering change.
VALID
VALUES
Accepts one or more strings as values.
DEFAULT
VALUES
EngChange.item_id
EngChange Revision Master.ec_type
EngChange Revision.owning_user
EngChange Revision.creation_date
EngChange Revision.last_mod_user
EngChange Revision.object_name
EngChange Revision.object_desc
SCOPE
Site preference.

ECM_pseudofolder_names
DESCRIPTION
Sets the list of relations for the selected engineering change object.
Change Viewer displays relations as pseudofolders. The names of the pseudofolders
can be configured. You can create additional pseudofolders by first creating a relation
type in Business Modeler IDE. The semantics for the relation types are defined by
the other Change Viewer preferences that follow.
Proper display names for the pseudofolder properties can be added by modifying
the property_names.uid file.
Note
Pseudofolder names must also be added to the
ItemRevision_DefaultChildProperties class in order to be displayed
in Teamcenter.

VALID
VALUES
Accepts one or more strings as values; each string must be a paring of a defined
pseudofolder name and a valid Teamcenter relation. For example:
affected_items/EC_affected_item_rel

11-12 Preferences and Environment Variables Reference PLM00026 D

 Change Viewer preferences

DEFAULT
VALUES
affected_items/EC_affected_item_rel
solution_items/EC_solution_item_rel
problem_items/EC_problem_item_rel
reference_items/EC_reference_item_rel
addressed_by/EC_addressed_by_rel

SCOPE
Site preference.

ECM_set_genealogy
DESCRIPTION
Determines the display of Change Management BOM-tracking-related interface
components. Also determines whether BOMChange records are created upon
saving an affected assembly in Structure Manager.
VALID
VALUES
On BOMChange records are created upon saving an affected assembly in
Structure Manager and the supersedure definition dialog box appears. The
following components display:
• Supersedure tab in Structure Manager

• Open Supersedure button in Structure Manager

• BOM Changes tab in Change Viewer

• Open Structure Manager button in Change Viewer

Off BOMChange records are not created upon saving an affected assembly
in Structure Manager and the supersedure definition dialog box does not
display. The components listed above do not display.
DEFAULT
VALUES
On
SCOPE
Site preference.

ECM_supercedure_tooltip_properties
DESCRIPTION
Sets the supersedure component properties displayed in the Genealogy WatchBox.
Supersedure is the base component for property extraction. It is possible to derive
a value by traversing the properties starting from the supersedure tag.

PLM00026 D Preferences and Environment Variables Reference 11-13

Chapter 11 Change Viewer preferences

Note
parent_rev is a special token supported for deriving an ItemRevision tag of
a BVR tag. Similarly, current_effectivity is a special token to display the
effectivity information of an ItemRevision tag.

VALID
VALUES
Accepts one or more strings as values; each string is a paring of the desired display
name and a valid Teamcenter component property.
DEFAULT
VALUES
Affected Assembly=affected_bvr.object_name
Affected IR Effectivity=affected_bvr.parent_rev.current_effectivity
Problem Assembly=problem_bvr.object_name
EC Owner=ec_rev_tag.owning_user
SCOPE
Site preference.

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

ECM_varianthistory_extra_columns
DESCRIPTION
Determines which fields of the BOM change form are included in the Variant
Change Details dialog box. This dialog box is opened from the Change Viewer
application and displays the Problem side and Affected side variant conditions for
the selected occurrence.
The BOM change form is defined by the ECM_bomchange_formtype preference.
VALID
VALUES
Accepts multiple strings as values; each string must contain a persistent property
of the BOM change form, using the following syntax:

11-14 Preferences and Environment Variables Reference PLM00026 D

 Change Viewer preferences

ECM_varianthistory_extra_columns=
Form-Field1
Form-Field2
DEFAULT
VALUES
None.
SCOPE
Site preference.

Enable_Create_Classic_Change
DESCRIPTION
Shows or hides the File→New→Classic Change menu command that allows creation
of a new EngChange type object in both the rich client and thin client.
VALID
VALUES
True Shows the File→New→Classic Change menu command.
False Hides the File→New→Classic Change menu command.
DEFAULT
VALUES
False for Foundation installations and upgrades; True for GM Overlay installations
and upgrades.
SCOPE
Site preference.
NOTES
Set this preference to True to allow the creation of classic change objects.
RESTRICTIONS
None.

Enable_Show_Classic_Change
DESCRIPTION
Shows or hides references to Change Viewer Classic change objects, saved searches,
reports, property finder formatters, preferences, LOVs, item and item revision types,
and relations. It also controls whether the Send To menu command shows CM
Viewer/Change Viewer.
VALID
VALUES
True Shows references to Change Viewer Classic change objects.
False Hides references to Change Viewer Classic change objects.
DEFAULT
VALUES
False for Foundation installations; True for Foundation upgrades, GM Overlay
installations, and GM Overlay upgrades.
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 11-15

Chapter 11 Change Viewer preferences

NOTES
Use this preference to help phase out usage of Change Viewer Classic.
RESTRICTIONS
None.

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
IMAN_reference
affected_items
solution_items
problem_items
reference_items
addressed_by
release_status_list
SCOPE
Site preference.

Supercedure_DefaultChildProperties
DESCRIPTION
Requires the following relation names.
VALID
VALUES
Adds
Cancels

11-16 Preferences and Environment Variables Reference PLM00026 D

 Change Viewer preferences

DEFAULT
VALUES
Adds
Cancels
SCOPE
Site preference.

TAE_CM_change_name_is_mandatory
DESCRIPTION
Determines whether inserting a value into the Change Name field is mandatory.
VALID
VALUES
TRUE User must type a value into the Change Name field before the
system will create or revise an engineering change object.
FALSE User need not type a value into the Change Name field before
the system will create or revise an engineering change object.
DEFAULT
VALUES
None.
SCOPE
User preference.

TAE_CM_show_task_viewer
DESCRIPTION
Determines whether the Task Viewer displays in all panels of the Change Viewer
application.
VALID
VALUES
TRUE The Task Viewer displays in all panels of the Change Viewer
application.
FALSE The Task Viewer does not display in the Change Viewer
application.
DEFAULT
VALUES
None.
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 11-17

Chapter 11 Change Viewer preferences

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

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

11-18 Preferences and Environment Variables Reference PLM00026 D

Chapter

12 Change Manager preferences

ChangeItemRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . . 12-1
ChangeNotice.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-2
ChangeNoticeCreate.CREATE_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . 12-2
ChangeNoticeRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . . 12-2
ChangeNoticeRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3
ChangeNoticeRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3
ChangeNoticeRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . 12-3
ChangeNoticeRevisionSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . . 12-4
ChangeRequest.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4
ChangeRequestCreate.CREATE_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . 12-4
ChangeRequestRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . 12-5
ChangeRequestRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5
ChangeRequestRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-6
ChangeRequestRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . 12-6
ChangeRequestRevisionSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . 12-6
CM_bomchange_formtype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-7
CM_change_derivations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-7
CM_ChangeNoticeRevision_displayed_pseudofolders . . . . . . . . . . . . . . . . . . . 12-7
CM_ChangeRequestRevision_displayed_pseudofolders . . . . . . . . . . . . . . . . . . 12-8
CM_ChangeRequestRevision_Relations_To_Propagate . . . . . . . . . . . . . . . . . . 12-8
CM_Cm0DevRqstRevision_displayed_pseudofolders . . . . . . . . . . . . . . . . . . . 12-9
CM_Cm0DevRqstRevision_Relations_To_Propagate . . . . . . . . . . . . . . . . . . . 12-9
CM_default_displayed_pseudofolders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-9
CM_Effectivity_DefaultColumns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-10
CM_form_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-10
CM_impacted_item_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-11
CM_note_types_to_track . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-11
CM_notehistory_extra_columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-12
CM_ProblemReportRevision_displayed_pseudofolders . . . . . . . . . . . . . . . . . 12-12
CM_ProblemReportRevision_Relations_To_Propagate . . . . . . . . . . . . . . . . . 12-12
CM_pureaddcancel_tooltip_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-13
CM_relation_creation_flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-13
CM_solution_items_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-14
CM_supersedure_tooltip_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-14
CM_track_variant_condition_changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-15
CM_varianthistory_extra_columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-15
CM_work_breakdown_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-15
CMHasImpactedItem_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-16
CMHasProblemItem_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-16
CMHasSolutionItem_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-17
CMHasWorkBreakdown_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . 12-17
CMImplements_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-17
CMReferences_relation_primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-18

PLM00026 D Preferences and Environment Variables Reference

 Cm0DevRqst.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-18
Cm0DevRqstCreate.CREATE_REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . 12-18
Cm0DevRqstRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . . 12-19
Cm0DevRqstRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-19
Cm0DevRqstRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-20
Cm0DevRqstRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . . 12-20
Cm0DevRqstRevisionSummary.SUMMARY_REGISTEREDTO . . . . . . . . . . 12-20
ProblemReport.CREATERENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-21
ProblemReportCreate.CREATE_REGISTEREDTO . . . . . . . . . . . . . . . . . . . 12-21
ProblemReportRevision_DefaultChildProperties . . . . . . . . . . . . . . . . . . . . . 12-21
ProblemReportRevision.REGISTEREDTO . . . . . . . . . . . . . . . . . . . . . . . . . 12-22
ProblemReportRevision.RENDERING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-22
ProblemReportRevision.SUMMARYRENDERING . . . . . . . . . . . . . . . . . . . . 12-22
ProblemReportRevisionSummary.SUMMARY_REGISTEREDTO . . . . . . . . . 12-23
WEB_Enable_Create_Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-23

Preferences and Environment Variables Reference PLM00026 D

Chapter

12 Change Manager preferences

Change Manager helps you track changes to a product throughout its life cycle. You
propose a change to a product and then manage the entire cycle of review, approval,
and implementation of the change.
For more information about Change Manager, see the Change Manager Guide.
Use Change Manager preferences to modify Change Manager behavior.

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
CMImplement
CMImplementedBy
CMImpactedItems
CMProblemItems
CMReferenceItems
CMSolutionItems
CMWorkBreakdown
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 12-1

Chapter 12 Change Manager preferences

ChangeNotice.CREATERENDERING
DESCRIPTION
Registers the create style sheet for change notice objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ChangeNoticeCreate
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
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.
DEFAULT
VALUES
IMAN_master_form_rev
IMAN_specification
IMAN_requirement
IMAN_manifestation
IMAN_reference
release_status_list
TC_Attaches

12-2 Preferences and Environment Variables Reference PLM00026 D

 Change Manager preferences

CMImplement
CMImpactedItems
CMProblemItems
CMReferenceItems
CMSolutionItems
CMWorkBreakdown
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
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
SCOPE
Site preference.

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.

PLM00026 D Preferences and Environment Variables Reference 12-3

Chapter 12 Change Manager preferences

DEFAULT
VALUES
ChangeNoticeRevisionSummary
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
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
SCOPE
Site preference.

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

12-4 Preferences and Environment Variables Reference PLM00026 D

 Change Manager preferences

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
CMImplement
CMImplementedBy
CMImpactedItems
CMProblemItems
CMReferenceItems
CMWorkBreakdown
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.
DEFAULT
VALUES
ChangeRequestRevision
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 12-5

Chapter 12 Change Manager preferences

ChangeRequestRevision.RENDERING
DESCRIPTION
Registers the properties style sheet for change request revision objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ChangeRequestRevisionProperty
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
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
SCOPE
Site preference.

12-6 Preferences and Environment Variables Reference PLM00026 D

 Change Manager preferences

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
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
ProblemReport/ChangeRequest and ChangeRequest/ChangeNotice
SCOPE
Site preference.
RESTRICTIONS
None.

CM_ChangeNoticeRevision_displayed_pseudofolders
DESCRIPTION
Defines the list of pseudofolders and their corresponding relations for the
ChangeNoticeRevision object.
VALID
VALUES
Accepts one or more strings as values; each string must be the pseudofolder name
and corresponding relation, separated by a slash (/).
DEFAULT
VALUES
CMImplement/CMImplements
CMImpactedItems/CMHasImpactedItem

PLM00026 D Preferences and Environment Variables Reference 12-7

Chapter 12 Change Manager preferences

CMProblemItems/CMHasProblemItem
CMReferenceItems/CMReferences
CMSolutionItems/CMHasSolutionItem
CMWorkBreakdown/CMHasWorkBreakdown
SCOPE
Site preference.

CM_ChangeRequestRevision_displayed_pseudofolders
DESCRIPTION
Defines the list of pseudofolders and their corresponding relations for the
ChangeRequestRevision object.
VALID
VALUES
Accepts one or more strings as values; each string must be the pseudofolder name
and corresponding relation, separated by a slash (/).
DEFAULT
VALUES
CMImplement/CMImplements
CMImplementedBy/CMImplements
CMImpactedItems/CMHasImpactedItem
CMProblemItems/CMHasProblemItem
CMReferenceItems/CMReferences
CMWorkBreakdown/CMHasWorkBreakdown
SCOPE
Site 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
CMImpactedItems, CMProblemItems, and CMReferenceItems
SCOPE
Site preference.
RESTRICTIONS
None.

12-8 Preferences and Environment Variables Reference PLM00026 D

 Change Manager preferences

CM_Cm0DevRqstRevision_displayed_pseudofolders
DESCRIPTION
Defines the list of pseudofolders and their corresponding relations for the
Cm0DevRqstRevision object.
VALID
VALUES
Accepts one or more strings as values; each string must be the pseudofolder name
and corresponding relation, separated by a slash (/).
DEFAULT
VALUES
CMImplement/CMImplements
CMImplementedBy/CMImplements
CMImpactedItems/CMHasImpactedItem
CMProblemItems/CMHasProblemItem
CMReferenceItems/CMReferences
CMWorkBreakdown/CMHasWorkBreakdown
SCOPE
Site preference.

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.
DEFAULT
VALUES
CMImpactedItems, CMProblemItems, and CMReferenceItems
SCOPE
Site preference.
RESTRICTIONS
None.

CM_default_displayed_pseudofolders
DESCRIPTION
Defines the default list of pseudofolders and their corresponding relations for the
ChangeItemRevision object.

PLM00026 D Preferences and Environment Variables Reference 12-9

Chapter 12 Change Manager preferences

VALID
VALUES
Accepts one or more strings as values; each string must be the pseudofolder name
and corresponding relation, separated by a slash (/).
DEFAULT
VALUES
CMImplement/CMImplements
CMImplementedBy/CMImplements
CMImpactedItems/CMHasImpactedItem
CMProblemItems/CMHasProblemItem
CMReferenceItems/CMReferences
CMSolutionItems/CMHasSolutionItem
CMWorkBreakdown/CMHasWorkBreakdown
SCOPE
Site 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.
DEFAULT
VALUES
release_status
effectivity_id
range_text
end_item
effectivity_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

12-10 Preferences and Environment Variables Reference PLM00026 D

 Change Manager preferences

SCOPE
Site preference.

CM_impacted_item_relation
DESCRIPTION
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

• CMHasProblemItem

• CMHasWorkBreakdown

DEFAULT
VALUES
CMHasImpactedItem
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 D Preferences and Environment Variables Reference 12-11

Chapter 12 Change Manager preferences

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.
SCOPE
Site preference.

CM_ProblemReportRevision_displayed_pseudofolders
DESCRIPTION
Defines the list of pseudofolders and their corresponding relations for the
ProblemReportRevision object.
VALID
VALUES
Accepts one or more strings as values; each string must be the pseudofolder name
and corresponding relation, separated by a slash (/).
DEFAULT
VALUES
CMImplementedBy/CMImplements
CMProblemItems/CMHasProblemItem
CMReferenceItems/CMReferences
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.

12-12 Preferences and Environment Variables Reference PLM00026 D

 Change Manager preferences

VALID
VALUES
One or more strings representing a valid Change Manager relation.
DEFAULT
VALUES
CMProblemItems and CMReferenceItems
SCOPE
Site preference.
RESTRICTIONS
None.

CM_pureaddcancel_tooltip_properties
DESCRIPTION
Sets the pure add and cancel properties displayed in the genealogy watch box.
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
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 nonchange 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
nonchange item.

PLM00026 D Preferences and Environment Variables Reference 12-13

Chapter 12 Change Manager preferences

NonChangeItems=0 Forces the user to select the existing nonchange item

revision to be related to the new change item.
DEFAULT
VALUES
ChangeItems=1
NonChangeItems=1
SCOPE
Site preference.

CM_solution_items_relation
DESCRIPTION
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
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

12-14 Preferences and Environment Variables Reference PLM00026 D

 Change Manager preferences

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.
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.
SCOPE
Site preference.

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

PLM00026 D Preferences and Environment Variables Reference 12-15

Chapter 12 Change Manager preferences

• CMHasWorkBreakdown

• CMHasImpactedItem

• CMHasSolutionItem

• CMImplements

• CMReferences

• CMHasProblemItem

DEFAULT
VALUES
CMHasWorkBreakdown
SCOPE
Site preference.

CMHasImpactedItem_relation_primary
DESCRIPTION
Specifies the valid primary object types for the CMHasImpactedItem relation.
VALID
VALUES
Accepts one or more strings as values; each string must be a primary Teamcenter
object.
DEFAULT
VALUES
Item
ItemRevision
SCOPE
Site preference.

CMHasProblemItem_relation_primary
DESCRIPTION
Specifies the valid primary object types for the CMHasProblemItem relation.
VALID
VALUES
Accepts one or more strings as values; each string must be a primary Teamcenter
object.
DEFAULT
VALUES
Item
ItemRevision
SCOPE
Site preference.

12-16 Preferences and Environment Variables Reference PLM00026 D

 Change Manager preferences

CMHasSolutionItem_relation_primary
DESCRIPTION
Specifies the valid primary object types for the CMHasSolutionItem relation.
VALID
VALUES
Accepts one or more strings as values; each string must be a primary Teamcenter
object.
DEFAULT
VALUES
Item
ItemRevision
SCOPE
Site preference.

CMHasWorkBreakdown_relation_primary
DESCRIPTION
Specifies the valid primary object types for the CMHasWorkBreakdown relation.
VALID
VALUES
Accepts one or more strings as values; each string must be a primary Teamcenter
object.
DEFAULT
VALUES
Item
ItemRevision
SCOPE
Site preference.

CMImplements_relation_primary
DESCRIPTION
Specifies the valid primary object types for the CMImplements relation.
VALID
VALUES
Accepts one or more strings as values; each string must be a primary Teamcenter
object.
DEFAULT
VALUES
Item
ItemRevision
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 12-17

Chapter 12 Change Manager preferences

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

12-18 Preferences and Environment Variables Reference PLM00026 D

 Change Manager preferences

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
CMImplement
CMImplementedBy
CMProblemItems
CMReferenceItems
CMWorkBreakdown
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
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 12-19

Chapter 12 Change Manager 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
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
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
SCOPE
Site preference.

12-20 Preferences and Environment Variables Reference PLM00026 D

 Change Manager preferences

ProblemReport.CREATERENDERING
DESCRIPTION
Registers the create style sheet for problem report objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ProblemReportCreate
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
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

PLM00026 D Preferences and Environment Variables Reference 12-21

Chapter 12 Change Manager preferences

CMImplementedBy
CMProblemItems
CMReferenceItems
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
SCOPE
Site preference.

ProblemReportRevision.RENDERING
DESCRIPTION
Registers the properties style sheet for problem report revision objects.
VALID
VALUES
Any registered XML rendering style sheet.
DEFAULT
VALUES
ProblemReportRevisionProperty
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

12-22 Preferences and Environment Variables Reference PLM00026 D

 Change Manager preferences

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
SCOPE
Site preference.

WEB_Enable_Create_Change
DESCRIPTION
Determines whether the File→Change→Create, File→Change→Context Create,
and File→Change→Derived Change menu commands are displayed in the thin
client.
VALID
VALUES
true Displays the menu commands.
false Hides the menu commands.
DEFAULT
VALUES
false
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 12-23

Chapter

13 Reports, requirements, and

scheduling preferences

Requirements Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1

REQ_spec_template_folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1
REQ_object_template_folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2

Schedule Manager preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2

DefaultActualToSystemDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2
Default_Base_Calendar_Preference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
SiteTimeZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
scheduling_graph_dataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
scheduling_graph_dataSource_filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4
scheduling_graph_date_format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4
scheduling_graph_date_interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-5
sm_view_critical_path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-5
sm_scheduling_engine_date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-6
sm_criticalpath_color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-6
scheduling_graph_domain_label_vertical . . . . . . . . . . . . . . . . . . . . . . . . 13-6
scheduling_graph_font_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-7
scheduling_graph_font_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-7
scheduling_graph_font_style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-7
scheduling_graph_histogram_single_color . . . . . . . . . . . . . . . . . . . . . . . . 13-8
scheduling_graph_task_legend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-8
scheduling_graph_view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-9
TC_RA_server_parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-9
cost_default_currency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-9

PLM00026 D Preferences and Environment Variables Reference

Chapter

13 Reports, requirements, and

scheduling preferences

PLM XML reports can be formatted using style sheets. Requirements extends
customer involvement to all phases of the product development process. Schedules
allow your users to plan and track activities in Teamcenter. The following
preferences control report, requirements, and scheduling behavior.

Requirements Manager preferences

With Requirements Manager, customers can actively influence the product design
from requirements development and association to product testing and acceptance.
Requirements Manager simplifies requirement development and access and
substantially reduces the learning curve.
Users work with requirement specification structures that contain requirement and
paragraph objects. Requirement content is developed with Microsoft Office Word and
Excel, tools that are readily available in most organizations.
Use Requirements Manager preferences to modify the behavior of this application.

REQ_spec_template_folder
DESCRIPTION
Defines the path for the folder in which all specification templates are stored.
VALID
VALUES
Accepts a single string as a value. The string must be a valid file location.
DEFAULT
VALUES
Home\RequirementManagementTemplates\ExportTemplates\
SpecificationTemplates
SCOPE
Site preference.

PLM00026 D Preferences and Environment Variables Reference 13-1

Chapter 13 Reports, requirements, and scheduling preferences

REQ_object_template_folder
DESCRIPTION
Defines the path for the folder in which all object templates are stored.
VALID
VALUES
Accepts a single string as a value. The string must be a valid file location.
DEFAULT
VALUES
Home\RequirementManagementTemplates\ExportTemplates\
ObjectTemplates
SCOPE
Site preference.

Schedule Manager preferences

Schedule Manager provides coordinated, concurrent access to the schedule, allowing
multiple resources to update information at the same time. This is important when
several people are working on developing or maintaining their individual subsections
of the master schedule.
Use Schedule Manager preferences to modify the behavior of this application.

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

13-2 Preferences and Environment Variables Reference PLM00026 D

 Reports, requirements, and scheduling preferences

Default_Base_Calendar_Preference
DESCRIPTION
Determines the default calendar used when a schedule is created. This preference is
used with Schedule Manager.
VALID
VALUES
Accepts a single string as a value. Must be a defined calendar name.
DEFAULT
VALUES
standard
SCOPE
Site preference.

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
America/Chicago
SCOPE
Site preference.

scheduling_graph_dataSource
DESCRIPTION
Used with Schedule Manager resource graphs. Defines the data sources for resource
graphs.
Warning
This preference must be set to TeamcenterDB in a production environment.

PLM00026 D Preferences and Environment Variables Reference 13-3

Chapter 13 Reports, requirements, and scheduling preferences

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
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
SCOPE
Site preference.

scheduling_graph_date_format
DESCRIPTION
Used with Schedule Manager resource graphs. Determines the date and time
display in resource graphs.
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
SCOPE
Site preference.

13-4 Preferences and Environment Variables Reference PLM00026 D

 Reports, requirements, and scheduling preferences

scheduling_graph_date_interval
DESCRIPTION
Used with Schedule Manager resource graphs. Determines the marked intervals on
the domain axis. You can 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
month
1440
10080
DEFAULT
VALUES
day
SCOPE
Site preference.

sm_view_critical_path
DESCRIPTION
Sets the default display of critical path.
VALID
VALUES
true Critical path is displayed.
false Critical path is not displayed.
DEFAULT
VALUES
False
SCOPE
This is a user preference.
NOTES
This value will be set when user selects the menu option to enable viewing critical
path.
RESTRICTIONS
There are no restrictions.

PLM00026 D Preferences and Environment Variables Reference 13-5

Chapter 13 Reports, requirements, and scheduling preferences

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
Accepts START and FINISH.
DEFAULT
VALUES
START
SCOPE
Site and user preference.
NOTES
This preference determines the default setting for new schedules.

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)
SCOPE
Site and user preference.
NOTES
This value is set when a user selects the color from the color dialog box.
RESTRICTIONS
There are no restrictions.

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.

13-6 Preferences and Environment Variables Reference PLM00026 D

 Reports, requirements, and scheduling preferences

DEFAULT
VALUES
true
SCOPE
Site preference.

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

PLM00026 D Preferences and Environment Variables Reference 13-7

Chapter 13 Reports, requirements, and scheduling preferences

3 Bold and italic font.

DEFAULT
VALUES
0
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.
VALID
VALUES
true A single color bar is used.
false Multiple color bars are used.
DEFAULT
VALUES
true
SCOPE
Site preference.

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 display legends, tool tips do not include schedule
and load information.

VALID
VALUES
true Legends are displayed for stacked bars.
false Legends are not displayed for stacked bars.
DEFAULT
VALUES
false
SCOPE
Site preference.

13-8 Preferences and Environment Variables Reference PLM00026 D

 Reports, requirements, and scheduling preferences

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
SCOPE
Site preference.

TC_RA_server_parameters
DESCRIPTION
Configures the Teamcenter Reporting and Analytics (TcRA) parameters at the site
level: server host, port and application name. Use TcRA , 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
DEFAULT
VALUES
Host:localhost Port:80 Context:eQube ServletName:eQubeServlet
SCOPE
Site preference.

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 one of
the values listed in the CostCurrency LOV.
Note
Siemens PLM Software recommends using only one currency in Teamcenter
because there is no support for currency conversion.

PLM00026 D Preferences and Environment Variables Reference 13-9

Chapter 13 Reports, requirements, and scheduling preferences

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

13-10 Preferences and Environment Variables Reference PLM00026 D

Chapter

14 Classification Administration
preferences

ICS_classification_master_site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1
ICS_available_languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-2
ICS_new_classid_pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-2
ICS_copy_classid_pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-3
ICS_migrate_classid_pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4
ICS_use_view_attributes_when_moving_icos . . . . . . . . . . . . . . . . . . . . . . . . 14-4
ICS_view_selection_order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-5
ICS_share_related . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-5
ICS_allow_remote_parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
ICS_mapping_target_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
ICS_unit_default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
GCS_classify_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
ICS_import_attribute_use_dbindex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-8
ICS_import_attribute_find_free_dbindex . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9
ICS_allow_deprecated_lovs_on_update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9
ICS_allow_deprecated_lovs_on_copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9
ICS_enforce_min_max_constraints_on_update . . . . . . . . . . . . . . . . . . . . . . 14-10
ICS_enforce_min_max_constraints_on_copy . . . . . . . . . . . . . . . . . . . . . . . . 14-10
ICS_allow_min_max_range_override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-11
ICS_attribute_displayable_properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-11

PLM00026 D Preferences and Environment Variables Reference

Chapter

14 Classification Administration
preferences

The Classification Administration application uses a hierarchical classification

structure based on the attribute values of your workspace objects. Classification of
your company’s product data-standard parts, technology data, and manufacturing
equipment saves time by making this component data easier to find and retrieve.
It reduces costs by allowing you to reuse existing parts and consolidate and/or
eliminate duplicate or out-dated parts. Use the application to define the groups,
classes, subclasses, and views that form this classification hierarchy. For additional
information, see the Classification Administration Guide.
Use the following preferences to determine classification behavior, such as defining
the number of attributes loaded by default into the Attribute Dictionary table.

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

PLM00026 D Preferences and Environment Variables Reference 14-1

Chapter 14 Classification Administration preferences

SCOPE
Site 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. For more information regarding creating classes, see
the Classification Administration Guide.
VALID
VALUES
Accepts one or more strings as values. Each string must be a valid language code.
For example:
cn
de
en
es
fr
it
jp
kr
ru
tw

DEFAULT
VALUES
en
SCOPE
Site 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.
${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.

14-2 Preferences and Environment Variables Reference PLM00026 D

 Classification Administration preferences

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}
SCOPE
User preference.

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.
Another example, ${CID}.new generates SourceID.new, where SourceID is the
original class ID, suffixed by .new.
DEFAULT
VALUES
${CID}${NN}
SCOPE
User preference.

PLM00026 D Preferences and Environment Variables Reference 14-3

Chapter 14 Classification Administration 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}
SCOPE
User preference.

ICS_use_view_attributes_when_moving_icos
DESCRIPTION
Determines which attribute values are set when an 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.

14-4 Preferences and Environment Variables Reference PLM00026 D

 Classification Administration preferences

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
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
DEFAULT
VALUES
USER

PROJECT

ROLE

GROUP
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:

PLM00026 D Preferences and Environment Variables Reference 14-5

Chapter 14 Classification Administration preferences

classImage Shares class images.

viewImage Shares view images.
partFamilyTemplates Shares part family templates.
DEFAULT
VALUES
None.
SCOPE
Site preference.

ICS_allow_remote_parent
DESCRIPTION
Determines whether classes and views can be added under classes which are not
locally owned.
VALID
VALUES
true Classes and views can be added under classes which are not
locally owned.
false Classes and views cannot be added under classes which are
not locally owned.
DEFAULT
VALUES
false
SCOPE
Site preference.

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 (a
catalog class) to another (a customer class) when converting Manufacturing Tooling
Library catalog data to classified resources. To make the target object a classified
resource, the target ICO needs to 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.

14-6 Preferences and Environment Variables Reference PLM00026 D

 Classification Administration preferences

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
SCOPE
Site preference.

ICS_unit_default
DESCRIPTION
Specifies the default system of measurement when creating a class in the
Classification Administration application.
VALID
VALUES
0 : metric
1 : non-metric
2 : both (metric and non-metric)
DEFAULT
VALUES
0
SCOPE
User preference.

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 non-classifying classification objects (ICOs), a

new classified object is created to receive the connection points. To make the target

PLM00026 D