Managing Preferences
Managing Preferences
Managing
Preferences
Teamcenter 14.3
Unpublished work. © 2023 Siemens
This Documentation contains trade secrets or otherwise confidential information owned by Siemens Industry Software Inc. or
its affiliates (collectively, “Siemens”), or its licensors. Access to and use of this Documentation is strictly limited as set forth in
Customer’s applicable agreement(s) with Siemens. This Documentation may not be copied, distributed, or otherwise disclosed
by Customer without the express written permission of Siemens, and may not be used in any way not expressly authorized by
Siemens.
This Documentation is for information and instruction purposes. Siemens reserves the right to make changes in specifications
and other information contained in this Documentation without prior notice, and the reader should, in all cases, consult
Siemens to determine whether any changes have been made.
No representation or other affirmation of fact contained in this Documentation shall be deemed to be a warranty or give rise to
any liability of Siemens whatsoever.
If you have a signed license agreement with Siemens for the product with which this Documentation will be used, your use of
this Documentation is subject to the scope of license and the software protection and security provisions of that agreement.
If you do not have such a signed license agreement, your use is subject to the Siemens Universal Customer Agreement, which
may be viewed at https://www.sw.siemens.com/en-US/sw-terms/base/uca/, as supplemented by the product specific terms
which may be viewed at https://www.sw.siemens.com/en-US/sw-terms/supplements/.
SIEMENS MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS DOCUMENTATION INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT OF
INTELLECTUAL PROPERTY. SIEMENS SHALL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL OR
PUNITIVE DAMAGES, LOST DATA OR PROFITS, EVEN IF SUCH DAMAGES WERE FORESEEABLE, ARISING OUT OF OR RELATED
TO THIS DOCUMENTATION OR THE INFORMATION CONTAINED IN IT, EVEN IF SIEMENS HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.
TRADEMARKS: The trademarks, logos, and service marks (collectively, "Marks") used herein are the property of Siemens or other
parties. No one is permitted to use these Marks without the prior written consent of Siemens or the owner of the Marks,
as applicable. The use herein of third party Marks is not an attempt to indicate Siemens as a source of a product, but is
intended to indicate a product from, or associated with, a particular third party. A list of Siemens’ Marks may be viewed at:
www.plm.automation.siemens.com/global/en/legal/trademarks.html. The registered trademark Linux® is used pursuant to a
sublicense from LMI, the exclusive licensee of Linus Torvalds, owner of the mark on a world-wide basis.
Siemens Digital Industries Software recommends browsing through the list of preferences to see which
ones might be useful to you. Each preference's definition will document its use.
Overview
A preference definition along with all of its preference instances are together considered to be a
preference.
The preference definition is like a blueprint. It defines the nature of the preference and
is used to create the instances at the various locations. Even though it may define a
Definition default value, the definition itself is never retrieved or read as a preference. If there are
no instances of this preference, there is no value.
A preference instance created at the site location applies to everyone logged in to
Site
Teamcenter unless overridden.
There can be only one site instance.
Any preference instances created at the group location apply only to users who are
Group
currently logged in as that group, and they supersede site preferences.
There can be one group instance created for each group.
Any preference instances created at the role location apply only to users who are
Role
currently logged in as that role (regardless of group), and they supersede site and
group preferences.
There can be one role instance created for each role.
Any preference instances created at the user location apply only to that user, and they
User
supersede site, group, and role preferences.
There can be one user instance created for each user.
Preference definition
You use the preference definition to create the overall limits and restrictions on the preference as well as
setting the default value. Think of this as an abstract template from which the preference itself will be
instantiated. Following are the fields used to define a preference definition:
Name The name of the preference. Naming patterns help organize the preferences and give
an idea of what they do even before you read the description. See the list of existing
preferences for examples.
Protection Determines where and by whom it can be instantiated.
Scope
Type Specify the preference value type.
Multiple Specify if this preference can hold multiple values.
Description Explain the use of the preference. What does it control? What format is expected for
the values? Etc.
Value Specify the default value that an instance will contain when initially created.
Environment Retrieve the value from an OS environment variable of the same name.
Category Organize related preferences based on their category. There are many existing
categories you can use, or you can create your own.
Preference instance
You create a preference instance from its definition. When you create a new instance of a preference it
must belong to a location. This location specifies when it is active and its priority in the hierarchy. You
cannot create a preference instance if the protection scope does not allow it.
When referring to preference instances, it is common to shorten the phrase. For example, the
preference instance in the Engineering group location is commonly referred to as the Engineering group
preference.
Location Locations are where the preference instances reside. You can create preference
instances at the following locations:
• User
• Role
• Group
• Site / System
Value You can keep the default value from the definition or specify a new one.
Preference locations
• User
This assigns the instance to a specific user. These are commonly the preferences that Teamcenter
uses to track things like column widths in the rich client, or most recently searched text, for example.
Although you can control your active preferences like style sheet registration down to the user level, it
is normally recommended that you keep those kinds of settings to the Group level or higher. It makes
things easier when people move in and out of groups and roles.
• Role
You can control the behavior based on a user's role. This is handy for things such as style sheets.
Keep the consumer's page simple while being able to provide the information the author or approver
needs.
• Group
Similar to the Role location, you can control the behavior at the next step up, at the group level.
• Site / System
Preferences created at these locations apply to everyone. This is typically where you instantiate
preferences that control system-wide behavior or default behavior that can be overridden at the
group, role, or user level.
Site preferences only allow a single instance, but a dba can change the protection scope of a site
preference to something else.
System preferences do not allow their protection scope to be changed, even by a dba. In all other
ways, they behave like a site preference.
Caution:
An existing non-system preference may be changed into a system preference by a dba, but once
it has been changed, it cannot be changed back. If you want to change it, it must be deleted
and re-created.
Customer-facing preferences
You control an aspect of the UI or behavior directly by making changes to the preference. Examples
of these preferences are configuring default paste relations, which style sheets are used in a given
situation, or how the Dispatcher handles certain file types.
Internal preferences
Teamcenter uses preferences extensively to remember application parameters, like column width. Even
though you can see and possibly modify the values of these preferences, it is not advised to do so.
When a preference value is requested, Teamcenter performs the following steps to return a value:
1. If the preference is an Environment preference, tcserver checks the value of the OS environment
variable of the same name.
If the environment variable exists, the value returned and cached for future requests.
Protection scope
Use the preference's protection scope to control the level at which the preference can be created or
modified. The protection scope allows anyone at that level or higher to make changes to the preference
value. The priority is as follows:
Group
Any user Administrator dba
User
Role
Group
Site / System
Any user
Can create, modify, and delete their own User preference instances.
Group Administrator
Can create, modify, and delete the User preference instances of members of their group, as well as
Group preference instances for their group and Role instances for any role in their group.
dba
Can create, modify, and delete all preferences at all locations.
Examples
• The TC_PREFS_TO_HIDE definition has a protection scope of System, and only allows a site instance
to be created. However, unlike a preference with a site protection scope, this preference's protection
scope cannot be changed.
If you want to pass multiple values from the environment to the preference, you must configure the
following:
• Use the appropriate separator in the environment variable. The environment variable is read from the
operating system on which the tcserver process is running.
Windows Semicolon — For example, MyEnvPref=Value1;Value1;Value3
Linux Comma — For example, MyEnvPref=Value1,Value1,Value3
The environment variable is only read by the tcserver process when the value is first requested, so any
changes made to the environment variable after that will not be reflected in the Teamcenter preference
until after the next time the tcserver process is started.
Remember, the environment variable is read from the environment where the tcserver process is
running, which is not necessarily the environment where the client is running.
Example: I want the summary view's property layout for item revisions to depend on my
users' login information
• You want a default style sheet that everyone will use unless otherwise specified.
• You have users that just need a simplified layout for viewing.
ItemRevSummary
Configured to be the default style sheet for the Item Revision summary page. This applies to
everyone unless overridden.
IRSumTech
Configured to provides the extra properties for the Engineering and Manufacturing groups, but not
for any other groups.
IRSumMgr
Configured to display workflow information for the Manager role, regardless of group.
IRSumDes
Configured to show the classification trace for the Designer role, regardless of group.
ConnersIRSum
Configured for Conner. Conner has his own requirements
Preference instances
Assign the style sheets to the various groups and roles, and even users if desired, by creating each
preference instance with the value pointing to the respective style sheet. In this example, there are 6
preference instances created.
The Viewer role and the Tester group have no preference instances created for their location.
In this example, Alice selects a DocumentRevision business object and uses the Summary tab. When
she does this, Teamcenter performs a few steps to determine which style sheet to use.
1. Based on the object type and the view location, the system knows the name of the preference
instances to retrieve.
There are two instances: one at the Site location, and one at the Manager Role location.
2. Based on the user's current session information, Teamcenter chooses the appropriate preference
instance.
3. The value of the chosen preference instance is read, providing the name of the style sheet to
retrieve.
Result
Your users see a different set of information based on what group or role they are in because the client
uses different style sheets.
• Alice sees the style sheet for Managers because she does not have a user preference set to supersede
it. The site preference is overridden by the Engineering group preference, which is overridden by the
Manager role preference. Ted has the same result; the Manufacturing group preference is overridden
by the Manager preference. Sue doesn't have a group preference, but she still gets the Manager role
preference.
• Bob sees the style sheet for Designers because of his role, similar to the preceding example.
• Carol sees the tech style sheet because there is no role preference for Viewers.
• Pat's group and role do not have preferences associated with them, and neither does she have a user
preference, so she gets the default style sheet defined by the site preference.
• Conner gets Conner's style sheet regardless of which group or role he's in, since a user preference
supersedes all others.
1. Make a copy of the preference XML file, for example, the tc_preferences.xml file.
3. Import the changes using the preferences_manager utility or the rich client Options dialog box.
For more information about a preferences_manager utility, see the Utilities Reference.
The Options page lets you interactively specify a wide range of behaviors by checking check boxes and
entering values into fields. Each option in this page represents a preference. When you make changes,
Teamcenter either changes the associated existing user preference, or creates it if it doesn't already
exist.
To see the information about the associated preference, hover your mouse cursor over the option.
This information is available even when the behavior is not available for editing. In this example, the
Search→Favorites selection allows us to change the QRYColumnsShownPref preference. This controls
which queries are shown in the advanced search list.
Preferences that affect display order may reorder values automatically when you create a user
preference.
After you make your changes, click OK to save your changes and finish, or click Apply to save your
changes and continue editing.
Use the Filters or Search pages to access group, role, and site preference instances, as well as user
preference instances that are not available in the Options page's UI.
Optionally, use the Filter by location drop-down list to further filter the instances by location. The list is
based on your current session information.
Preferences that define columns and column widths cannot be modified from the Options dialog
box. These are interdependent preferences. When a column preference is modified, the corresponding
column width preference must also be modified to ensure the table displays properly in Teamcenter.
Interdependent preferences are most easily modified by right-clicking the Properties table in
Teamcenter and choosing the Insert columns or Remove this column command.
Alternatively, you can modify these preferences using the preferences_manager utility or editing the
preferences XML file.
Depending on your dba or group administrator status, you will either see the entire organization or just
a portion of it. Either way, use the organization chart to navigate to an available group, role, or user
location to view or modify that location's existing preference instances or to create new ones.
dba A dba can work with the entire organization structure for group, role, and user
preferences.
Group A non-dba Group Administrator (GA) can only work with preference instances for
administrato their Group and any Roles it contains.
r
regular Any non-dba, non-GA user will see their user context options (groups and roles) and
users work with their own preferences instances.
Tip:
The Organization window is interactive. When you select any node in the organization tree,
preferences from all scopes are shown unless you manually selects a particular scope from the list.
You may wish to use refresh to force the window to update based on your selection.
Example
You are the Engineering group administrator. You want to modify a specific user's default UI panel
when they open Edit→Options to show the favorite search listing.
2. Optionally, select the drop-down value to filter preference instances to only show their user
preferences.
Example
You are the Engineering group administrator. You want to create a group preference for your users'
default UI panel when they open Edit→Options to show the favorite search listing.
2. Select the drop-down value to filter preference instances to only show site preferences.
4. With the site preference highlighted, click the Create new preference instance button to
create a new instance at the highlighted location.
The replacement is all lowercase if the original is lowercase, but uppercase if either or both of the ug
characters are uppercase.
This automatic conversion of ug occurs when any of the following criteria are met:
• When both preceded and followed by a special character in the middle of the preference name.
Special Characters
• _ (underscore)
• , (comma)
• (space)
• . (period)
• ; (semicolon)
• + (plus)
• - (minus)
Note:
If you define both Linux and Windows values for a preference, the value returned is based on the
server operating system.
3. Define platform values for both Linux (UNX) and Windows (WNT). For example:
4. Import the XML file to the database with the preferences_manager utility using the OVERRIDE
option.
Name
When entering the name of the preference, avoid the following characters:
, comma
. period
; semicolon
+ plus
- hyphen/minus
_ underscore
Type
• String
• Logical
Valid value is one of any logical pair (on or off, true or false, yes or no, 0 or 1).
Note:
Logical preferences may have more than one valid value. For example, 0, No, Off, and False
may all be equivalent valid values of the same preference that achieve the same result. The
value shown in the Options pane of the Options dialog box may differ from the possible values
listed for a preference, but both values are valid settings.
• Integer
• Double
• 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 Teamcenter, Siemens Digital Industries Software
recommends users set values from the Options dialog box, rather than through the XML file.
Value
When referring to business objects, do not enter their localized name. Instead, use their database (real)
name. For example, the Import_Template_EXCLUDETYPES preference refers to Fnd0VisioTmpl instead
of Visio Template.