SIEMENS

Teamcenter 12.2

Application
Administration
PLM00100 • 12.2
Contents

Administration tasks and application-specific documentation . . . . . . . . . . . . . . . . . . . . . 1-1

Configure rich client web browser home page and window . . . . . . . . . . . . . . . . . . . . . . . 2-1

Configuring external management of passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Configuring Security Services for Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Configuring the rich client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Configuring other Teamcenter clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Configuring load balancer timeouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4

Hiding commands in Rich Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Controlling command visibility . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 4-1
Command Suppression interface . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 4-3
Suppress menu bar commands . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 4-5
Suppress context menu commands . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 4-5
Inheritance of group command suppression . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 4-6
Manually create preferences to suppress commands in the rich client . . . . . . . . . . . . . . . . . . 4-7
Enable Command Suppression for a custom application . . . . . . . . .. . . . . . . . . . . . . . . . . . 4-9

Configuring forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Configure edit and view for forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Master forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Configuring access to administrative applications and utilities . . . . . . . . . . . . . . . . . . . . 6-1

Using Authorization to control access to applications and utilities . . . . . . . . . . . . . . . . . . . . . . 6-1
Authorization interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
How Authorization works with group hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Default authorization rules and Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Where can I limit access using Authorization? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Create Authorization rules for applications and utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Configure access to utilities by group or by role in group . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Sharing authorization rules with other Teamcenter sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Importing and exporting Authorization rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Export authorization rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Import authorization rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5

Configuring Teamcenter searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Teamcenter search methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Implementing quick search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
What is quick search? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Quick search preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

PLM00100 12.2 Application Administration 3

 Contents
Contents

Implementing simple search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5

What is simple search? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Simple search preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Implementing advanced search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
What is advanced search? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Configuring Advanced Search preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Creating queries for Advanced Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Implementing full-text search for rich client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Search engines for rich client and Active Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Install and configure IDOL search engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Configuring search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10
Indexing using IDOL search engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
Configuring IDOL (Autonomy) 10.1 upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-27

Defining queries and reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Creating queries and reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Defining queries and reports tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Configuring Teamcenter mail and instant messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Configuring Teamcenter mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Configuring Teamcenter to use email servers requiring authentication . . . . . . . . . . . . . . . . . . 9-2
Configuring instant messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2

Configuring Teamcenter email polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

What is Teamcenter email polling? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Configure email polling types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Create an email polling rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
Configure user email account settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4
Configure dispatcher for email polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6
Start or schedule email polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
Teamcenter email polling preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8

Configuring Teamcenter notes and parametric requirements . . . . . . . . . . . . . . . . . . . . . 11-1

Configuring standard notes and custom notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
Configure standard note creation authority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1
Set the delimiter that separates parameters in standard note text . . . . . . . . . . . . . . . . . . . . 11-1
Enable attachment of multiple revisions of a parametric requirement . . . . . . . . . . . . . . . . . . 11-2
Configure the behavior of custom notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2

Edit a Teamcenter registry file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1

What is Registry Editor? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
Registry Editor interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1
Registry files in Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-2
Open a Teamcenter registry file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4
Modify a registry file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5

Configuring Lifecycle Visualization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1

4 Application Administration PLM00100 12.2

 Contents

Configuring Lifecycle Visualization overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1

Modifying Lifecycle Visualization configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1
Specify visualization licensing options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1
Rich client embedded viewer compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2
Customizing the Viewer view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2
Viewing data from multiple Teamcenter servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3
Multiple File Management System (FMS) client caches (FCCs) . . . . . . . . . . . . . . . . . . . . . . 13-4
Installing a PostScript printer on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-5
Visualization preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-6
Search schemas for the Lifecycle Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-7
Creating text and watermark stamps using an MDS file . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-8
Overview of adding text and watermark stamps with an MDS file . . . . . . . . . . . . . . . . . . 13-8
Create text and watermark stamps using an MDS file . . . . . . . . . . . . . . . . . . . . . . . . . . 13-9
MDS text and watermark examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-12
Set the beginning cursor position for stamps with MDS files . . . . . . . . . . . . . . . . . . . . 13-13
Specify the orientation of text stamps with MDS files . . . . . . . . . . . . . . . . . . . . . . . . . 13-14
Add uniform watermark stamps when exporting files . . . . . . . . . . . . . . . . . . . . . . . . . 13-15
Specify new types of visualization datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-19
Specify dataset types with multiple named references . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-20
Configure automatic markups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-20
Configure the Image Preview view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-21
Configure the JT Preview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-22
Configure image preview in Relation Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-23
Configure image preview in the Summary view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-24

Configuring Teamcenter Integration for NX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1

What is Teamcenter Integration for NX? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1
Configure NX launch application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1
Configuring attribute mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-2
Mapping Teamcenter attributes to NX part attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-2
Determine valid paths of objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-2
Additional definition for attributes when mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-3
Default mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4
Mapping Classification attributes to NX part attributes . . . . . . . . . . . . . . . . . . . . . . . . . 14-4
Attribute synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4
Extending attribute mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
Syntax for mapping attributes with Teamcenter Integration for NX . . . . . . . . . . . . . . . . . . . . 14-7
Mapping syntax for Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
Comments and contexts symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-10
Mapping examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-11
Mapping syntax for Classification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-12
Automatically classifying items and item revisions while creating parts . . . . . . . . . . . . . 14-14
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-14

PLM00100 12.2 Application Administration 5

Chapter 1: Administration tasks and application-specific
documentation

The following table lists Teamcenter administrative tasks that are performed within particular
applications, and provides links to documentation for those applications.

Application-specific
Adminstration tasks documentation
Control user access to data objects stored in Teamcenter by defining Access Manager
and maintaining rules and access control lists.
Administer authorized data access licenses. Security Administration
Configure audit logs that track actions that take place on specified Audit Manager
objects in the database.
Create data model objects, such as business objects, properties, Configure your business
lists of values, and naming rules. data model in BMIDE
Create and manage the classification hierarchy and attribute Classification Admin
dictionary.
Set up authoring and publishing tools, including creating and Content Management
maintaining topic types, publication types, style sheets, and style
types.
View components, select objects, navigate hierarchies, work with Teamcenter Basics
summaries, details, impact analysis, and related information.
Define your company's virtual organization, manage storage Organization
volumes, and define calendars.
Create transfer mode objects that help users import and export PLM XML/TC XML Export
Teamcenter objects and system data. Import Administration
Set up projects, including assigning users and implementing access Project and Program
control based on project membership.
Define customized searches for objects in local and remote Query Builder
Teamcenter databases.
Create and manage report definitions. Report Builder
Configure Subscription Administration process daemons, manage Subscription Administration
subscription tables, and create and manage subscription reports.
Configure validation processes that provide a decision mechanism Validation Manager
by which users ensure that item revisions meet compliance before
they are released.
Configure Teamcenter systems engineering and requirements Systems Engineering
management, including Microsoft Office import and export templates.
Design workflow process templates that incorporate your company's Workflow Designer
business practices and procedures.

PLM00100 12.2 Application Administration 1-1

Chapter 2: Configure rich client web browser home
page and window

The rich client Web Browser view lets users browse the Web in a view within the rich client, using the
browser defined by the client’s operating system, rather than switching to a separate Web browser
window. The Web Browser view also allows users to access MIME (Multipurpose Internet Mail
Extension) file types and view files created in other applications, such as Microsoft Word and Excel.

Users access the view by choosing Window→Show View→Web Browser.

To change the Web Browser home page, use the TC_Web_Browser_Home_URL preference. By
default, the URL is specified as http://www.plm.automation.siemens.com.
To specify whether Web link content from the rich client is displayed in the internal browser or in an
external browser window, use the browserWindowMode preference.

PLM00100 12.2 Application Administration 2-1

Chapter 3: Configuring external management of passwords

Configuring Security Services for Teamcenter

When Security Services is enabled, passwords are managed by the external identity service provider,
rather than by Teamcenter. All other user administration tasks remain within Teamcenter.
Security Services is optional. The Security Services services must be installed and an external
identity service provider must be configured.

Configuring the rich client

After Security Services is installed and the external identity service provider configured, configure
Security Services or Teamcenter by manually entering the Security Services environment variables in
the tc_profilevars properties file and the rich client properties in the site_specific.properties file.
Enable Security Services for the rich client by setting the TC_SSO_SERVICE and
TC_SSO_LOGIN_URL environment variables.

Note
In the rich client and ITK, the ability to set or change a password in the Teamcenter
database is disabled when the TC_SSO_SERVICE environment variable is set. The
Change Password command remains available from the Actions menu. In the
Organization application, the password text box and blank password check box are
disabled.

For administrative purposes, the administrator can choose not to set the TC_SSO_LOGIN_URL
environment variable. The following table lists the logon scenarios for users logging on to the
Teamcenter rich client, before logging on to any other Teamcenter product:

Environment variables set Logon scenario

No Security Services environment variables are Security Services is not enabled. User
set. authentication is performed by Teamcenter:
• The rich client displays its standard logon
dialog box; users enter the user IDs and
passwords defined in Teamcenter.

• To access other Teamcenter products, the

rich client user must log on again.

PLM00100 12.2 Application Administration 3-1

 Chapter
Chapter 3: 3: Configuring
Configuring external
external management
management of passwords
of passwords

Environment variables set Logon scenario

TC_SSO_SERVICE is set in the tc_profilevars Security Services is enabled for the rich client
properties file. and server. User authentication is performed by
external identity service provider:
TC_SSO_LOGIN_URL is set in the
client_specific.properties file (two-tier • Security Services displays a browser logon
installation). For a four-tier installation, it is in the page and starts a Security Services user
site_specific.properties file. session. Users enter user IDs defined in
the Teamcenter database, but passwords
are defined in the external identity service
provider.
If applet-free mode is configured, the sign-on
process is performed without a Web browser
and session applet. This mode requires
HTTP 401-based authentication.
If zero sign-on is configured using Kerberos
authentication, no Teamcenter logon
challenges appear. Zero sign-on in applet
free mode requires HTTP 401-negotiate
authentication.
For information about configuring Kerberos
authentication, see Security Services
Installation/Customization.
For information about the results of different
logon configurations, see Getting Started
with Teamcenter.

• The logon uses default values for

Teamcenter group and database. Users
can change the group default using the
User Settings dialog box; the default
database can be changed using the
IIOP_SERVER_n.HOST property or the
HTTP_SERVER_n.URI property in the rich
client site_specific.properties file.

• Users can access other Teamcenter

products that implement Security Services
without logging on again during a Security
Services user session.

3-2 Application Administration PLM00100 12.2

 Configuring external management of passwords

Environment variables set Logon scenario

TC_SSO_SERVICE is set in the tc_profilevars Security Services is enabled for the rich client
properties file. server only. User authentication is performed by
the external identity service provider:
• Security Services does not start a user
Security Services session; the rich client
displays its standard logon dialog box,
but users enter passwords defined in the
external identity service provider.

• To access other Teamcenter products, user

must log on again.
A Security Services session is essential
for logging on to other products using
authentication by the external identity
service provider.

This configuration is for the following special

uses:
• Administrators can start multiple sessions as
different user IDs to act on behalf of several
users.

• Users can log on using a group or database

other than the default values.

When one external identity provider serves multiple Teamcenter sites, and each site authorizes a
different set of users, the administrator must set the TC_SSO_APP_ID environment variable to
identify the site. This site ID must match a site ID registered with the Security Services service. This
environment variable is optional; when used, it must be set in both the tc_profilevars file for the
server and the site_specific.properties file for the rich client.
When Security Services is installed and enabled, the rich client user logon defaults to
the Teamcenter database, behaving as if users had entered user IDs and passwords in
its standard logon dialog box but left the database blank. The default database is the
database defined by either the IIOP_SERVER_n.HOST property (for two-tier rich client server
configurations) or the HTTP_SERVER_n.URI property (for four-tier rich client configurations) in the
client_specific.properties file. These properties are set using Teamcenter Environment Manager:
the IIOP-based protocol is implemented for a two-tier configuration, the HTTP-based protocol enables
SOAP-based HTTP communication and is implemented for a four-tier configuration. To specify a
different default database for Security Services logons, you must manually modify the appropriate
property in the rich client site_specific.properties file.

PLM00100 12.2 Application Administration 3-3

 Chapter
Chapter 3: 3: Configuring
Configuring external
external management
management of passwords
of passwords

Configuring other Teamcenter clients

To enable Security Services for all other Teamcenter clients, such as command line utilities, and
ODBC Driver, only the TC_SSO_SERVICE environment variable must be set. When this environment
variable is set, user authentication is performed by the external identity service provider (the user
must enter the password defined in the external identity service provider); otherwise, the logon is
unchanged.

Configuring load balancer timeouts

If you use a third-party load balancer, ensure its timeout setting values are equal to or greater than
the timeout settings for Teamcenter as entered in the Web Application Manager Session Timeout
box. This indicates how many minutes of inactivity are permitted before the web server terminates
the session on the web server. From the Modify Web Application dialog box, click Modify Web
Application Information. The Web Application Manager displays the Modify Web Application
Information dialog box for the Session Timeout box.
The Teamcenter web tier and Teamcenter Security Services Login Service maintain client session
information. When deployed behind a load balancer, it is important that all requests from a given
client are routed to the same back-end web tier or Login Service instance. Ensure that you set the
load balancer's session timeout interval to a value equal to or greater than the Teamcenter session
timeout values. Also, load balancers typically have a stickiness or affinity setting, and this must be set
as well in the load balancer configuration for these Teamcenter web applications. Otherwise, the
load balancer timeout eclipses the Teamcenter timeout and can lead to apparently random and
unexpected behavior as the load balancer switches between active web application instances.

3-4 Application Administration PLM00100 12.2

Chapter 4: Hiding commands in Rich Client

Controlling command visibility

As an administrator, you can limit the Teamcenter application commands that appear in the rich client
for members of specific groups or roles. Control of command visibility in other clients, such as Active
Workspace, is described in documentation for those clients.
Suppressing commands for specific groups or roles provides at least two benefits:
• Suppressed commands are not available to unauthorized group or role members; you control
access.

• Members of the group or role are not distracted by commands that they do not want or need.

You have three methods to limit commands that appear in the rich client:

Method Effect Comments

Manually create a command In the specified application You can use a manually
suppression preference. or perspective, for the created preference to suppress
specified group(s) or role(s), a command for a role in all
the commands for specified groups where the role appears.
command IDs are suppressed
from drop-down menus,
toolbars, and context menus.
Use the Suppress Commands In the selected perspective, for You can choose to apply the
view in the Command the selected group or role within suppression to either
Suppression application a group, the selected command
to automatically create is suppressed from drop-down • all perspectives in the
a command suppression menus, toolbars, and context application to which the
preference. menus. selected perspective
belongs (default mode)

Note • only the selected

It is possible that perspective.
a context menu
command may have You can use a role preference
the same name to show on menus and toolbars
as a command the commands that are
that appears on a hidden by a group preference.
drop-down menu or Commands hidden for a group
toolbar, but actually are always hidden on context
refer to a different menus for all the group's roles.
command ID. In that

PLM00100 12.2 Application Administration 4-1

 Chapter
Chapter 4: 4: Hiding
Hiding commands
commands in Rich
in Rich ClientClient

Method Effect Comments

case, it would not be
suppressed.

Use the Suppress Context In the selected perspective, for You can choose to apply the
Menus view in the Command the selected group or role within suppression to the context
Suppression application to a group, the selected command menu for an object selected in
suppress commands on context is suppressed from context either
menus. menus that appear for objects.
• all views in the selected
Suppressions defined by perspective
this means are in addition
to suppressions that • only a selected view
apply because of settings
defined using the Suppress and to either
Commands view.
• all object types

• only a selected object type.

Example
If a group does not use Multi-Site Collaboration, then for the My Teamcenter perspective,
for all members of the group, you may want to suppress the Multi-Site Synchronization
commands.
If a business process expects only managers in the logistics group to be able to import and
export data, then for all member roles in the Logistics group except the Manager role,
you could suppress the Import and Export commands.
If a perspective is intended for focusing on a particular application task, then you might
suppress the Open command in the Manufacturing – Work Instructions perspective,
while the Open command is available in the Manufacturing – BOM Reconciliation
perspective

Limits to command suppression

You cannot limit visibility of commands that are:

• Contributed statically in the code (for example, Window menu), with the exception of
savePerspective, resetPerspective, and closePerspective in the Window menu.

• Contributed using Eclipse actions.

• Contributed dynamically. If there are static and dynamic commands within the same parent
group, suppressing the parent group also suppresses any contained static commands. It does
not suppress the dynamic commands, and the parent group still appears.

To determine whether a command is dynamic, use the DumpCMSConfigInfo utility.

4-2 Application Administration PLM00100 12.2

 Hiding commands in Rich Client

Tip
To hide an entire perspective in the rich client, find the perspective's row in the
DumpCMSConfigInfo output activityxxx.csv file and add the value in the ID column to the
Teamcenter preference HiddenPerspectives.

Command Suppression interface

1 Applications view Displays a list of application perspectives. Select a perspective in the

list to display its application's commands in the Suppress Commands
and Suppress Context Menus views.
2 Organization view Displays a tree of the groups and roles that you can select when
suppressing commands.
3 Suppress Displays a tree of the menus, submenus, and commands for the
Commands view application of the selected perspective.
To expand a tree node and display its submenus and commands, click
the plus symbol next to the node.
In the example above, View is a menu, Audit is a sub-menu, and View
Audit Logs is a command.

PLM00100 12.2 Application Administration 4-3

 Chapter
Chapter 4: 4: Hiding
Hiding commands
commands in Rich
in Rich ClientClient

4 Suppress Context Displays a set of controls for suppressing application commands that
Menus view might be found on context menus for objects shown in a perspective
view. The list of available application commands depends on the
perspective selected in the Applications view.
The View and Object Type values can be used to limit command
suppression to a certain view within the perspective, and to a certain
type of object.
5 Perspective Mode The Perspective Mode button is displayed and applicable when the
button Suppress Commands view is active. The button can be set to one of
two states, Off (default) or On . The active mode at the time a
command is hidden determines whether the command is hidden for all
of the application's perspectives (Off), or only the selected perspective
of the application (On).
6 Hide and Show The Hide and Show buttons are displayed when the Suppress
buttons Commands view is active.
You can click a button to set the respective status for the menu or
command that is currently selected.

4-4 Application Administration PLM00100 12.2

 Hiding commands in Rich Client

Suppress menu bar commands

1. In the rich client, open the Command Suppression perspective.

2. Click the Suppress Commands view to make it active.

3. In the Applications view, select the perspective containing the commands that you want to
suppress.
Many applications have only one perspective. Some have multiple perspectives. For example,
Manufacturing – BOM Reconciliation and Manufacturing – Process Sequencing are
perspectives of the Manufacturing Process Planner application. By default, new command
suppression settings apply to all perspectives of an application; but, if Perspective Mode is on,
then new command suppression settings apply only to the selected perspective.

4. Select a group, subgroup, or role from the Organization tree.

For information about how command suppression for group and role interact, see Manually
create preferences to suppress commands in the rich client.

5. If you want to limit new command suppression settings to only the selected perspective, then
turn Perspective Mode on.

This is the default mode. In this mode, when you hide menus and commands, they
Off are suppressed for all perspectives of the application to which the perspective
selected in the Applications view belongs.
Menus and commands hidden while in this mode are struck through with a red line
and annotated with [Hidden by Application].
In this mode, when you hide menus and commands, they are suppressed only in
On the selected perspective.
Menus and commands hidden while in this mode are struck through with a red line
and annotated with [Hidden by Perspective].

6. In the Suppress Commands view, select a menu, submenu, or command from the tree.

7. Click Hide.
The menu, submenu, or command name nodes selected for suppression are struck through with
a red line and an annotation identifying the suppression as perspective- or application-based
is added.
To remove the suppression, click Show.

8. Choose File→Save.

Suppress context menu commands

Preferences that hide commands on drop-down menus and toolbars also hide commands on context
menus, if the command ID is the same. You can use the following procedure to hide commands on
context menus in addition to those hidden by preferences.

PLM00100 12.2 Application Administration 4-5

 Chapter
Chapter 4: 4: Hiding
Hiding commands
commands in Rich
in Rich ClientClient

Suppressions defined using the following procedure do not hide commands on drop-down menus
and toolbars.

1. In the rich client, open the Command Suppression perspective.

2. Click the Suppress Context Menus view to make it active.

3. In the Applications view, select the perspective in which you want to suppress context menu
commands.

4. Select a group, subgroup, or role from the Organization tree.

For information about how command suppression for group and role interact, see Manually
create preferences to suppress commands in the rich client.

5. If you want to limit command suppression to a particular view in the perspective, then from
the View list, select a view.
If no view is selected, command suppression applies to all views in the perspective.

6. If you want to limit command suppression to a particular item type, then from the Object Type
list, select an object type.
If no object type is selected, the command suppression applies to all object types.
By default, only children of the item object type are included in the Object Type list. If you
want to select an object type other than one based on the item type, then clear the Show Item
Types Only check box.

7. If you want to filter the list of available commands, then enter a filter pattern in the box above
the list of commands.
The list of commands available for a perspective is often very long. Entering a few characters of
the command name can make it much easier to find and select the command you are interested in.

8. In the Available Commands list, select a command from the list and click to move it to
the Suppressed Commands list.

Note
Inherited suppressions are not shown in the list.

9. Choose File→Save.

Inheritance of group command suppression

The potential for command suppression inheritance differs, depending on whether a command
suppression preference has been defined for the role, and on the command location in the user
interface.

4-6 Application Administration PLM00100 12.2

 Hiding commands in Rich Client

Command suppression
preference Then group
For these UI locations for the role exists? command suppressions
drop-down menus and toolbars No Do apply
drop-down menus and toolbars Yes Do not apply
context menus either No or Yes Do apply

Note that even if the command suppression preference defined for a role does not contain any
values, the command suppression preference for the role must be deleted in order to restore the
role's inheritance of group command suppression on drop-down menus and toolbars.
Suppressions defined using the Suppress Context Menus view in the Command Suppression
application do not affect drop-down menus and toolbars.

Example interactions of group and role suppressions on command display

Consider the commands Aaaa, Bbbb, and Cccc. The following table shows the interaction of a
command suppression preference defined for Group and a command suppression preference
defined for Role A within Group. In this example, no additional context menu command suppression
has been defined.

Commands Commands Commands

Command Command shown on menus shown on shown on menus
suppression suppression and toolbars context menus and toolbars
preference preference when logged in when logged in when logged in
values values as as as
Group Role A Group / Role A Group / Role A Group / Role B
No preference Bbbb Bbbb Bbbb
Aaaa
defined Cccc Cccc Cccc
Aaaa Bbbb
Aaaa Cccc Cccc
Bbbb Cccc
Aaaa Aaaa
Cccc Bbbb Bbbb
Cccc Bbbb
Aaaa
No preference Bbbb Bbbb
Aaaa Bbbb
defined Cccc Cccc
Cccc
Bbbb Aaaa
Bbbb Aaaa Cccc
Cccc Cccc
Preference exists, Aaaa
Aaaa Aaaa
Bbbb but no value Bbbb
Cccc Cccc
defined Cccc

Manually create preferences to suppress commands in the rich client

While the Command Suppression application provides an easy way to hide a command for all
members of a group, or for a role within a group, you may want to suppress an application command

PLM00100 12.2 Application Administration 4-7

 Chapter
Chapter 4: 4: Hiding
Hiding commands
commands in Rich
in Rich ClientClient

for a member role in all the groups where the role appears. You can manually create a preference to
accomplish this general role-based suppression.
Many examples of such command suppression preferences can be found in an Administration Data
Documentation Report of Teamcenter preferences.

Note
You cannot suppress a command for all groups and all roles.

The following example procedure shows how to suppress commands in the Navigator (My
Teamcenter) perspective for a role in all groups.
1. In My Teamcenter, choose Edit→Options.

2. Click Filters.

3. Click Create new preference definition .

4. In the Create new preference panel, type the following statement in the Name box:
com.teamcenter.rac.ui.perspectives.navigatorPerspective\\*\\[role]\\HIDDEN_COMMANDS

Replace [role] with the name of the role for which you want to suppress commands.

5. In the Create new preference panel, in the Values box, type a comma-separated list of
command IDs for the commands that you want to suppress.

6. Click Create.

Example
Following are three examples of using a preference to suppress commands.
To suppress the Cut, Copy, and Paste commands for the My Teamcenter perspective for
all groups and the DBA role only:
com.teamcenter.rac.ui.perspectives.navigatorPerspective\\*\\DBA\\HIDDEN_COMMANDS

Values: cutAction,copyAction,pasteAction
Note that these command names are unusually simple. See command IDs for examples of
typical Teamcenter application commands.
To suppress the Cut, Copy, and Paste actions for the My Teamcenter perspective for the
dba group only and all roles defined in the group:
com.teamcenter.rac.ui.perspectives.navigatorPerspective\\dba\\*\\HIDDEN_COMMANDS

Values: cutAction,copyAction,pasteAction
To suppress the Cut action for the Structure Manager application for all groups and the
DBA role only:
com.teamcenter.rac.pse.PSEApplication\\*\\DBA\\HIDDEN_COMMANDS

Values: cutAction

4-8 Application Administration PLM00100 12.2

 Hiding commands in Rich Client

Enable Command Suppression for a custom application

You can make custom Teamcenter application perspectives available in the Command Suppression
application.
1. Copy the TC_CS.APPLICATIONS key and its value from the portal.properties file to the
portal_user.properties file.

2. Append the path name of the new application to the value.

PLM00100 12.2 Application Administration 4-9

Chapter 5: Configuring forms

Configure edit and view for forms

For form objects, the Form_double_click preference value can be set to either View or Edit to cause
the double-click action on a form to open that form in either edit or view mode.

Note
To ensure consistent behavior on forms in both edit and view mode, set the
Configuration_shown_on_reservation_dialogs value to true, and set the following
preferences as required:
• Confirm_cancel_checkout_suppressed
Set this preference to true to proceed without user input on the cancel checkout
confirmation dialog box.

• Confirm_checkin_suppressed
Set this preference to true to proceed without user input on the checkin confirmation
dialog box.

• Confirm_checkout_suppressed
Set this preference to true to proceed without user input on the checkout confirmation
dialog box.

Master forms
Master forms are created and deleted when an item or item revision is created or deleted.
• Master forms display specific product information to the rest of the enterprise in a standardized
format.

• When a new item is created, an Item Master form object is created automatically. Similarly,
when a new item revision object is created, an ItemRevision Master form object is created
automatically.

You can enter data in the item master and item revision master forms when you create an item or by
opening an Item Master or ItemRevision Master form object.

PLM00100 12.2 Application Administration 5-1

 Chapter
Chapter 5: 5: Configuring
Configuring
formsforms

Note
• Master forms inherit access privileges from the parent item or item revision, so if you
change access privileges to an item or item revision you affect the privileges on the
master form.
You can use the TC_MASTERFORM_DELEGATE environment variable to change
this default behavior.

• An item can have only one Item Master form.

• An item revision can have only one ItemRevision Master form.

5-2 Application Administration PLM00100 12.2

Chapter 6: Configuring access to administrative
applications and utilities

Using Authorization to control access to applications and utilities

The Authorization application enables you to control access to Teamcenter administrative applications
and utilities based on users' group membership or their role in a group.
For example, you can:
• Grant all members of the DBA Lite group access to the Organization application, regardless of
their role within the group.

• Grant users who occupy the importer role in the DBA Lite group access to the PLM XML/TC
XML Export Import Administration application.

The Authorization application works in conjunction with other Teamcenter applications to control
access to product features and data, as follows:
• Access to product features is controlled using the Command Suppression application.

• Access to operations on objects, such as delete, copy, and change ownership, is controlled by
configuring rules in Access Manager.

Authorization interface

PLM00100 12.2 Application Administration 6-1

 Chapter
Chapter 6: 6: Configuring
Configuring access
access to administrative
to administrative applications
applications and utilities
and utilities

1 Quick Links Click either the Applications link or Utilities link to set
access level.
2 Organization tree Displays the groups and roles in your organization. From
the Organization tree, you can choose a group or for
a selected role.
3 Applications with Read Only For the selected group or role in group, the Applications
Access with Read Only Access list contains the administrative
utilities or applications that are shown in the interface with
read only access to the functionality.
4 Applications with Full Access For the selected group or role in group, the Applications
with Full Access list contains the administrative utilities
or applications that are shown in the interface with full
access to the functionality.

How Authorization works with group hierarchies

Groups within the organization tree can be configured into one or more hierarchies. Each group has
exactly one parent group (unless it is at the root of the hierarchy, when it has no parent group), and
each group can have one or more child groups (subgroups).
Authorization rules are inherited within the group hierarchy, as follows:
• Rules defined for a parent group are inherited by all subgroups of the parent group.

• Rules defined at the subgroup level apply only to that subgroup.

Note
In the event that two subgroups of different parentage share the same name, rules defined
for one parent group are not inherited by the same-name subgroup of the other parent
group. For example, if both the Manufacturing group and the Design group have a
Validation subgroup, authorization rules defined for the Manufacturing group apply only
to the Validation subgroup that is directly related to the Manufacturing group. Likewise,
authorization rules defined for the Design group apply only to the Validation subgroup
that is directly related to the Design group.

Default authorization rules and Authorization

System-level authorization rules are those rules delivered as part of your standard Teamcenter
installation that govern access to administrative applications and utilities. By default, Teamcenter
supplies two groups for administrative purposes, the Project Administration group and the dba
group.
Project Administration group members only have access to the Project application, which allows
them to create, delete, modify, and add users to or remove users from projects. dba group members
are granted access to all Teamcenter administrative applications and utilities.

6-2 Application Administration PLM00100 12.2

 Configuring access to administrative applications and utilities

Often, administrative tasks are assigned at a functional level corresponding to your business
practices. For example, responsibility for administering user data such as personal and organization
information may be assigned to one group, while a different group may be responsible for designing
workflow processes. In such cases, dba group privileges are more broad and powerful than is
necessary or desirable. Authorization enables you to create authorization rules to model access to
administrative tools to your business processes.

Where can I limit access using Authorization?

The following applications are supported for access configuration using Authorization:

Access Manager Organization

ADA License PLM XML/TC XML Export Import Administration
Audit Manager Project
Authorization Setup Wizard
Business Modeler IDE Subscription Administration
Classification Admin Workflow Designer

You can configure access to these applications by group or by role in group.

You can also set the TC_authorization_mode preference to specify whether to evaluate all the
group memberships of users and their role in those groups when authorizing access to an application
or to evaluate their current group logon and role in that group.

Example
To access the Organization application, a user must have dba privileges (be a member of
dba with the role of DBA). If the user is a member of both the dba and the Engineering
groups and logs on under the Engineering group, the user may or may not have access to
the Organization application depending on how TC_authorization_mode is set:
• If set to on (evaluate all group memberships and the roles in the groups), the user has
administration privileges based on membership in the dba group, even though the user
is not currently logged on under that group. The user can access the Organization
application.

• If set to off (evaluate only the current logon group and the role in that group), the user
does not have administration privileges through the Engineering group. Therefore, the
user cannot access the Organization application.

The following utilities are supported for access configuration using Authorization:

data_share dsa_util purge_invalid_subscriptions

data_sync export_recovery update_project_data
database_verify fscadmin

You can configure access to these utilities by group or by role in group.

PLM00100 12.2 Application Administration 6-3

 Chapter
Chapter 6: 6: Configuring
Configuring access
access to administrative
to administrative applications
applications and utilities
and utilities

Create Authorization rules for applications and utilities

1. Click the Applications link in the Quick Links section of the navigation pane.

2. Expand the Organization tree and click the group or role to whom you want to grant
or deny application access.

3. Select the application from the Applications with Read Only Access list to grant access to the
group or role in group. Click the right-arrow button to move the application to the Applications
with Full Access list.

Tip
If the Applications with Read Only Access list is empty, click any group or role
symbol in the Organization tree to refresh the list.

4. Click Save.

Configure access to utilities by group or by role in group

1. Click the Utilities link in the Quick Links section of the navigation pane.

2. In the Authorization application pane, expand the Organization tree and click the group or
role to whom you want to grant or deny utility access.

3. Select the utility from the Applications with Read Only Access list to grant access to the
group or role in group. Click the right-arrow button to move the utility to the Applications with
Full Access list.

Tip
If the Applications with Read Only Access list is empty, click any group or role
symbol in the Organization tree to refresh the list.

4. Click Save.

Sharing authorization rules with other Teamcenter sites

Importing and exporting Authorization rules
Authorization rules can be exported to an operating system directory as an XML file that can then
be imported at another Teamcenter site, allowing you to synchronize authorization rules between
sites that share data.

Export authorization rules

1. In the Authorization application pane, click the exportRule button.

6-4 Application Administration PLM00100 12.2

 Configuring access to administrative applications and utilities

2. In the exportRule dialog box, navigate to the directory location where you want to save the
rule file.

3. Type a name for the file in the File name box.

Note
The file is output in XML format; therefore, the file name must end in .xml.

4. Click the exportRule button.

The authorization rule file is saved in the operating system directory that you specified in step 2.

Import authorization rules

1. In the Authorization application pane, click the importRule button.

2. In the importRule dialog box, navigate to the directory containing the authorization rule file that
you want to import.

Note
Rule files are XML files.

3. Select the authorization rule file.

4. Click the importRule button.

The authorization rule file is imported in to Teamcenter.

PLM00100 12.2 Application Administration 6-5

Chapter 7: Configuring Teamcenter searches

Teamcenter search methods

Teamcenter provides three search methods enabled by default. You can modify the behavior of each
mechanism. Configuration is required to make full use of Advanced Search.

Quick Search

Quick Search Description

features
Display style Displays a single-field search form, providing a quick input method for users
to search the Teamcenter database.
Search behavior Generates searches based on a single criteria (such as item ID, keyword,
item name, or dataset name) selected from a shortcut menu. Administrators
can set preferences to determine which criteria display in the menu.
Use Provides quick searching of items and datasets. It requires users to know the
item ID, item name, or the dataset name.
Quick searches are limited to a single user. They cannot be stored by the
user, nor shared with other users.
Availability This search mechanism is available by default in the rich client. No
configuration is required to use this search with its default search queries.
However, you can add custom queries.
Configuration These techniques are used to implement and configure Quick Search.
• Configure which objects appear in the selection list (Item ID, Keyword
Search, and so on).

• Implement keyword search functionality by configuring full text search.

• Create custom queries.

PLM00100 12.2 Application Administration 7-1

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

Advanced Search

Advanced Search Description

features
Display style Displays preconfigured search forms allowing users to specify multiple search
criteria relevant to the type of information or object being sought.
Search behavior Generates searches based on preconfigured search forms. The search forms
are derived from search queries. Hundreds of search queries are shipped
with Teamcenter: You can create additional search queries (also called saved
searches) using Query Builder.
Use Distributes in-depth, customized search forms throughout the site and/or
throughout a global enterprise.
You can also incorporate full-text search capability into the search forms,
allowing users to search for datasets by attribute value and search dataset
files by keyword.
Building query definitions requires knowledge of the Teamcenter POM
(persistent object manager) schema, which is a hierarchical arrangement of
classes, subclasses, and attributes, particularly when including reference
attributes in the query.
Availability Advance searches are available by default in the rich client. No configuration
is required for this search functionality to appear. However, making full use of
this search method requires creating search queries in Query Builder, and
installing and configuring the full-text search engine.
Configuration These techniques implement and configure Advanced Search.
• Configure full text search

• Configure indexing

• Create custom queries

7-2 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

Simple Search

Simple Search Description

features
Display style Displays the available properties for the selected business object, allowing
users to create searches without an in-depth knowledge of the Teamcenter
POM schema. Only the relevant properties for the selected object display.
Users do not need to understand the placement of attributes within the POM
schema.
Search behavior Generates searches based on one or more property values of selected
business objects.
Users select an object type, and then build a search form by selecting
properties and specifying criteria.
Use Provides a tool for users to create their own customized searches to search
the local Teamcenter database, without a strong knowledge of the POM
schema.
These searches are limited to a single user. They cannot be stored by the
user, nor shared with other users.
Availability Simple searches are available in the rich client only. It appears by default. No
configuration is required for this search functionality, although you can set
preferences to modify its behavior.
Configuration These techniques are used to implement and configure Simple Search.
• Modify default display settings.

• Filter the business object types available for search.

PLM00100 12.2 Application Administration 7-3

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

Implementing quick search

What is quick search?

Quick Search is available by default in the rich client. No configuration is required to use this search
with its default search queries.
You can add custom search items to the Quick Search menu by:
1. Building the query.

2. Updating the two Quick Search preferences with the name and attribute of the custom query.

Quick search preferences

You must update the following preferences when adding custom queries to the Quick Search menu:
• Quick_Access_Queries
Specifies which queries appear in the Quick search menu. Valid values are query names defined
in the qry_text_locale.xml locale file.
By default, the following queries are defined:

o General

o Item

o Item Revision

o Remote

o Checked-Out Dataset

• Quick_Access_Queries_Attribute
Specifies the criteria attribute displayed for a query in the Quick Search menu using the following
format:
internal-query-name_SearchAttribute=L10N-key
The internal query name is specified in the qry_text_locale.xml locale file. The L10N key is the
User Entry L10N Key value specified for the given query.
In the following example, a custom query named Find PDFs is created. The value of the L10N
key is set to datasettype_name.

• Default_Quick_Access_Query

7-4 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

Specifies the default quick search name, for example, Item ID.

Implementing simple search

What is simple search?

Simple Search is available by default in the rich client. This powerful search tool does not require an
in-depth knowledge of the Teamcenter POM schema. Users can create business object searches
based on one or more property values, with only the following limitations:
• Only WorkspaceObjects can be specified for this type of search.
To allows users to search for other POM objects, you must build queries containing these objects
using Query Builder. Such queries are accessed from Advanced Search.

• Only attribute properties and typed referenced properties can be specified for this type of search.
Simple Search and Query Builder do not support run-time properties and compound properties.

• Scope is limited to the users local Teamcenter database.

To allow users to search remote Teamcenter databases, use the Remote saved query, or build a
custom query using Query Builder. Such queries are accessed from Advanced Search.

• Ad hoc and classification searches are not supported.

• Search results display in the Search Results view. Users can refresh, compare, save, and
assign these search results. However, the search criteria cannot be saved or shared.

No configuration is required before users can begin using this search mechanism. However you can
modify its behavior by setting Simple search preferences.

Simple search preferences

You can use the following preferences to modify the behavior of Simple Search:
• Default_Business_Object_To_Search
Specifies which business object displays when the Simple Search view is opened.

• Favorite_Business_Objects_To_Search
Specifies which business object types appear in the:
Business Object Type list
Business Object Type button

PLM00100 12.2 Application Administration 7-5

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

• Searchable_Business_Objects
Filters the business object types that display in the Business Object Type list, limiting the list to
the business objects specified by this preference. Limit the list to only those business objects
used at your site, allowing users to locate business object types quickly.
This preference can be set as a site preference by an administrator and as a group or role
preference by a group administrator.

Implementing advanced search

What is advanced search?

Advanced Search is available by default in the rich client. No configuration is required to use this
far-reaching search with its default search queries.
• Display hundreds of saved queries available by default. Users access the saved queries as
search forms in which they can type search criteria.

• Create additional, custom saved queries.

• Distribute saved queries throughout your local site or throughout a global enterprise.

• Implement full-text search with Advanced Search, allowing users to search for datasets by
attribute value and search dataset files by keyword.

To make full use of the Advanced Search:

• Create custom saved queries.

• Install the Autonomy full-text search engine.

• Configure the Autonomy full-text search engine.

Configuring Advanced Search preferences

You can use the following preferences to modify the behavior of Advanced Search:
• Change_Search_Default
Determines which saved query displays in the search panel by default.
This preference accepts a single string as a value. The value must be a valid saved query.

• QRY_dataset_display_option
Determines whether the latest version or all versions of a dataset object are displayed when
query results are returned.
Set this preference to 1 to display all versions of a dataset object. Set to 2 to display only the
latest version of the dataset object.

• QRY_query-name_SortKeys

7-6 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

Determines the class attributes used to sort the query results. This preference must be used in
conjunction with the QRY_query-name_SortOrder preference, which determines sort order.
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 must be
replaced with the underscore (_) character:

o Space character

o Return character (\n)

o Tab character (\t)

• QRY_query-name_SortOrder

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.
Set this preference to 1 to sort query results in ascending order. Set to 2 to sort query results
in descending order.

• QRY_search_type_hierarchy

Determines whether subtypes are included in query results. The system uses type hierarchy
functionality to query types and subtypes.
Administrators can add this as a site 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,
as a user preference, to true from the search interface:
In the rich client, choose Edit→Options to display the Options dialog box. Select the Search
folder from the tree on the left. Select the Query Options tab. Then select the Enable
Hierarchical Type Search check box. Checking this check box automatically adds this
preference to the database, and sets it to true.

Creating queries for Advanced Search

Query Builder enables you to create complex queries based on the Teamcenter data schema, a
hierarchical arrangement of types, subtypes, and properties. Query Builder provides hints to assist
you in navigating the schema. The hints present a relationship as a starting point, for example, the
relationship between an item and its item revision, and then provide you with the steps to build that
relationship into your search definition.

Queries created in Query Builder display in the Saved Queries tree. Saved queries can be used
for searches and to generate reports.

In the context of Advanced Search, these queries also appear in the System Defined Searches
tree, accessed by clicking the Select a Search button on the Advanced Search view to display
the Change Search dialog box.

The following graphic illustrates a few of the saved searches available by default.

PLM00100 12.2 Application Administration 7-7

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

Implementing full-text search for rich client

Search engines for rich client and Active Workspace

Full-text search engines for Teamcenter clients differ. Documentation of the use, deployment, and
configuration of full-text search is primarily contained in the help collections of the applicable clients.

Client Full text search engine Where documented

Rich client IDOL (formerly Autonomy) Teamcenter help collection
Active Workspace Indexing Engine (Solr) Active Workspace help collection

Install and configure IDOL search engine

Installing the IDOL FTS Engine

The IDOL full-text search engine enables users to retrieve objects from the Teamcenter database
based on search criteria. It allows users to specify searches on metadata values, as well as full-text
retrieval searches on both metadata and common forms of text data.
Install the full-text search engine. The IDOL full-text search system requires that two servers are
installed, configured, and active:
• IDOL server

7-8 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

The Intelligent Data Operating Layer (IDOL) server includes the content server, community server,
category server, Agentstore server, and the IndexTasks component. AutonomyIDOLServer.cfg
is the IDOL server configuration file. AutonomyIDOLServer.exe is the IDOL server executable.
During installation, you can display the IDOL server version by going to the IDOL installation
directory and running the IDOL executable with the -version flag:
autonomy/idol/idol.exe –version

After installation and configuration, you can use a web browser to display IDOL server version
information at:
http://host:aciport/action=getversion

o host is the IP address of the machine on which IDOL resides.

o aciport is the ACI port of IDOL specified by the Port parameter in the IDOL configuration
file's [Server] section.

The search engine configuration file, typically IDOL.cfg, is located in a default installation in the
autonomy/IDOL directory under the location where the software is installed. After installation
on Windows, go to Control Panel→Services and double-click the idol service. This displays a
dialog box that shows the location of the executable file and the configuration file.
You can display IDOL server help by entering the following command from your web browser:
http://host:port/action=Help

o host is the IP address of the machine on which IDOL resides.

o port is the ACI port of IDOL specified by the Port parameter in the IDOL configuration file
[Server] section.

You can also view help without starting IDOL server. In the IDOL server installation directory,
open the help directory and click index.html.

• File System Fetch server

The installation directory contains file system connector folders and files for connecting to
Teamcenter.
During installation, you can display the File System Fetch (FSF) server version by going to the
IDOL installation directory and running the fsf.exe executable file with the version flag:
autonomy/fsf/fsf.exe -version

You can determine the version of the Intelligent Data Operating Layer (IDOL) server and the
File System Fetch server being installed. Prior to configuration, in the installation directory,
run system_path/autonomy/IDOL/idol.exe –version to display a dialog box with the version
information.

Start and stop IDOL servers

Start servers
Start the IDOL server by doing one of the following:

PLM00100 12.2 Application Administration 7-9

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

• Use the Start.sh start script (UNIX). The script is supplied in the IDOL server installer.

• Double-click the InstallationIDOLServer.exe file in your installation directory (Windows).

• Start the IDOL Service from a system dialog box (Windows).

Stop servers

Stop the IDOL server by doing one of the following:

• To stop the Autonomy servers on Windows systems, use the Control Panel→Services dialog
box to select and stop the services.

• To stop the IDOL servers on UNIX/Linux systems, use the stop script (Stop.sh) provided in the
appropriate directories to stop the servers.

• To stop the IDOL servers from the service port, open the following in a browser:
http://host:servicePort/action=stop

o host is the IP address of the machine on which IDOL resides.

o servicePort is the ACI port of IDOL specified by the Port parameter in the IDOL configuration
file [Server] section.

Supported IDOL file types

The IDOL search engine supports many data formats in addition to the file types supported by default
in Teamcenter using the following preferences:
TC_fts_indexed_types
This preference specifies the types of objects that can be indexed. The default values for this
preference are Text, MSWord, MSWordX, HTML, MSExcel, MSExcelX, MSPowerPoint,
MSPowerPointX, and PDF.
TC_fts_supported_files
This preference specifies file type extensions that can be indexed. For example, the compressed
format .zip file extension must be added to the TC_fts_supported_files preference if you want
to index text-based .zip files.

You can set up IDOL for full-text search. Then build keyword indexes for the IDOL search engine
using the build_fts_index utility.

Configuring search

Configure full-text search

When the IDOL search engine is installed and configured at your site, you can perform full-text
searches. Full-text searches can be combined with searches for metadata, allowing you to search
datasets by property value as well as search dataset files by keyword. For example, you can
search for all documents containing the keyword cat that belong to owning user jsmith and have
been modified after December 1, 2015.

7-10 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

Enable and configure full-text search

Set up full-text search following this process:
1. Install the IDOL full-text search engine using the appropriate server installation (Windows
or UNIX/Linux).

2. Configure IDOL preferences to enable the IDOL search engine.

3. To enable exact match queries for keywords, set AdvancedSearch to true in the [Server]
section of the IDOL Server configuration file before you index content.
The exact match criteria is submitted by enclosing the search keyword inside quotes, for
example, "cat".

4. To enable case-sensitive exact match queries for keywords, set AdvancedCaseSearch to true
in the [Server] section of the IDOL Server configuration file before you index content.
The case-sensitive exact match criteria is submitted by prefixing the keyword with a tilde (~) and
enclosing it in quotes, for example, "~Cat".

Caution
Be aware that searching for case-sensitive matches can degrade searching
performance.

5. Use the TC_fts_enforce_master_language preference to specify the language used to index

unlocalized properties in cases where the site master language should not be used.

6. Set up IDOL and create the index to build keyword indexes.

The build_fts_index utility builds keyword indexes on an object-by-object basis for the properties
of dataset objects and the contents of dataset files.

7. You can enable real time indexing to update the full-text search index automatically whenever
objects or their named references are saved, modified, or deleted.

You can use the UnstemmedMinDocOccs parameter in the [Server] section of the configuration
file to specify the number of documents in which a term must occur for it to be considered in a
wildcard search.
You cannot use wildcards to search for numeric characters if the SplitNumbers configuration setting
is set to true in the [Server] section of the configuration file.

Optional preferences for full-text search

Several preferences can refine the full-text search process:
• TC_fts_any_language
Enables searches to return documents in any language for your query rather than only in the
query's language.

• TC_fts_default_AND_operator

PLM00100 12.2 Application Administration 7-11

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

Specifies the default logical operator for keyword search.

true Uses the AND operator in search criteria. Entering dog cat queries for
dog AND cat. Results must contain both search terms.
false Uses the OR operator in search criteria. Entering dog cat queries for dog
OR cat. Results must contain at least one of the search terms.

• TC_fts_result_latest_ItemRevision
Specifies whether keyword searches return only the latest item revisions.

• TC_fts_max_results
Specifies the number of query results returned by the full text search engine. Use this preference
to avoid potential performance overhead on the IDOL server.
Accepts a single string as a value. Must be single positive integer.

Teamcenter provides full-text keyword search queries for users by default.

Troubleshooting
To help you investigate problems with full-text search, you can check:
• Log files created in the IDOL installation directory structure.

• Teamcenter log files generated by your session.

• The output from running the build_fts_index utility using the report argument.

• (If running IDOL on a Linux server for a large database and the IDOL log says "insufficient free
file handles") Increase the number of open file handles in the /etc/security/limits.conf file.

Example
Increase the open file handles from the default value (1024) to 4000.

Preferences to configure IDOL

Control the behavior of full-text search in the IDOL search engine using preferences.

Required full-text search preferences for running the IDOL search engine
• TC_fts_aci_port
Specifies the Autonomy Content Infrastructure (ACI) action port number. This port is used to
send action query commands to the IDOL server.
This preference accepts a single string as a value. The value must be the number of the port
used by the ACI. This setting should be the same as the Port setting in the IDOL server's
configuration file.

• TC_fts_database_name
Specifies the name of the database in which Teamcenter database objects are indexed.

7-12 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

This preference accepts a single string value. The value must be the valid database name in
which the Teamcenter database objects are indexed.

• TC_fts_engine
Specifies the search engine used by Teamcenter's full text search (FTS) framework.
The search engine is used for searching within text documents such as MS Word documents,
PDF files, and HTML files. Currently Teamcenter supports only IDOL as the FTS search engine.
This preference value must be Autonomy.

• TC_fts_host
Specifies the IP address of the host machine running the IDOL server.
If the Teamcenter server and the IDOL 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 IDOL 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 IDOL server reads the files for indexing.

Note
The TC_TMP_DIR environment variable is located in the tc_profilevars.bat file in the
TC_DATA directory, or in the start_TcServer1.bat file in the TC_ROOT directory.

This preference accepts a single string as a value. The value must be the valid IP address of
the host machine running the IDOL server.

• TC_fts_index_port
Specifies the index port number. This port is used to index documents for the IDOL server.
This preference accepts a single string as a value. The value must be the number of the IDOL
server's index port. This preference setting should be the same as the IndexPort setting in
the IDOL server’s configuration file.

• TC_fts_fsf_host
Specifies the IP address or the name of the host machine on which 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.
This preference accepts a single string as a value. The value must be a valid IP address
or host name.

• TC_fts_fsf_port
Specifies the port number on which 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.
This preference accepts a single string as a value. The value must be a positive integer.

PLM00100 12.2 Application Administration 7-13

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

• TC_fts_query_port
Specifies the query port number used to query IDOL server content.
This preference accepts a single string as a value. Teamcenter installation provides an
opportunity to install the IDOL search engine. If you choose this option, this preference is
automatically set to 9000.

• TC_fts_service_port
Specifies the service port number used to query the IDOL server service.
This preference accepts a single string as a value. Teamcenter installation provides an
opportunity to install the IDOL search engine. If you choose this option, this preference is
automatically set to 9002.

Set the following full-text search preferences when the Teamcenter server and the IDOL server
are installed on different machines.
Preferences for a distributed installation
• TC_fts_use_shared_tmp_dir
Specifies whether the IDOL server uses a network-shared folder as a temporary work directory.
If the Teamcenter server and the IDOL server are installed on different machines this preference
must be set to true.

• TC_fts_windows_autonomy_server
Specifies whether the IDOL server is installed on a Windows platform.

• TC_fts_shared_tmp_dir_unix
Specifies the temporary exchange directory for the UNIX machine where the Teamcenter server
or IDOL server are running.
If the Teamcenter server and the IDOL server are installed on different machines, you must set
either this preference (UNIX) or the TC_fts_shared_tmp_dir_wnt preference (Windows).
The separator used in this preference value must be the forward slash /, for example,
/mynetwork/mysite/myfolder.
This preference is defined in a new installation, but has no default value and no instance created.

Note
Settings for the -workdir and -db arguments of the build_fts_index utility override
this preference.

• TC_fts_shared_tmp_dir_wnt
Specifies the temporary exchange directory for the Windows host where the Teamcenter server
or IDOL server is running.
If the Teamcenter server and the IDOL server are installed on different machines, you must set
either this preference (Windows) or the TC_fts_shared_tmp_dir_unix preference (UNIX).

7-14 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

The separator used in the preference value must be the back slash \, for example,
\\mynetwork\mysite\myfolder.
This preference is defined in a new installation but has no default value and no instance created.

Note
The user account used to start the IDOL server must have write privileges to this
directory.

• TC_fts_shared_tmp_dir_autonomy_path
Specifies the temporary exchange directory path for the machine where the IDOL server is
running.
This preference is defined in a new installation but has no default value and no instance created.
A valid value can be a UNC path or a local path, using forward slash / as a separator, such
as //myserver/shared, F:/shared, and /tmp.

Note
The user account used to start the IDOL server must have write privileges to this
directory.
A value specified in this preference overrides values defined by the
TC_fts_shared_tmp_dir_wnt and TC_fts_shared_tmp_dir_unix preferences.

Default FTS queries

After the IDOL search engine is installed and configured at your site, you can perform full-text
searches on dataset files. Full text search queries are shipped with Teamcenter:
• Dataset Keyword Search
A dataset keyword search queries for indexed metadata and the contents of dataset files using
only the full-text search engine index.

• Keyword Search
A keyword search queries for indexed types for properties and indexed type content.

• Dataset Search
A dataset search queries for dataset metadata from the Teamcenter database and dataset
content from the full-text search engine index.

Additionally, you can also create custom saved queries.

Access these full text search queries, along with all saved searches shipped with Teamcenter, by
clicking the Select a Search button on the Advanced Search view to display the Change Search
dialog box.

PLM00100 12.2 Application Administration 7-15

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

Implementing synonym search

Administrators enable synonym search to broaden searches.
• Enable synonym search by setting the TC_fts_synonym_search site preference.

• Create a synonym search text file.

• Configure the full text search engine IDOL server.

You must configure IDOL server to use the synonym file before you index the data to search.

Configuring synonym search

1. Set the TC_fts_synonym_search site preference to true.

2. Create and populate a synonym search text file.

a. Create a text file in the IDOL server IDOL/content directory.
The file name is later specified in the IDOL server configuration file [SynonymType] section.

b. Create sections for each language defined in IDOL server configuration file. For example:
[EnglishASCII]
[GermanUTF8]

c. In each section, create a line for each word that gets synonyms. For example:
[EnglishASCII]
cat
dog
[GermanUTF8]
Katze
Hund

7-16 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

d. List synonym strings next to each word and save the file.
• Use commas to separate words.

• Do not put spaces before or after a comma.

• Individual terms can contain spaces, but cannot contain punctuation.

Example
[EnglishASCII]
cat,feline,grimalkin,moggy,mouser,puss,pussy,tabby
dog,bitch,cur,hound,mans best friend,mongrel,mutt,pooch,puppy
[GermanUTF8]
Katze,Mietze,Mietzekatze,Mietzekater,Kater,Mulle,Kätzchen
Hund,Wau Wau,Hündin,Töle,Kläffer,Hündchen,Welpe

e. Save and close the file.

3. Configure the full text search engine IDOL server to use a synonym file.
a. Open the IDOL server configuration file, IDOL.cfg, in a text editor.

b. In the IDOL server configuration file [FieldProcessing] section, set up a synonym process
so the IDOL server can determine when to apply synonym settings. For example:
[FieldProcessing]
0=SynonymMatch

c. Create a property for the synonym process, and then identify the fields that you want to
associate with the process. For example:
[SynonymMatch]
Property=ApplySynonymMatch
PropertyFieldCSVs=*/DRETITLE,*/DRECONTENT
• Synonym properties must point to a defined synonym job.

• In the example, the IDOL server returns only documents for synonym queries when the
DRETITLE or DRECONTENT field values match the query.

Caution
The property you create must not have the same name as the process.
When you identify fields, use the /FieldName format to match root-level fields,
*/FieldName to match all fields except root-level, or /Path/FieldName to match
fields pointed to by the specified path.

d. List the property that you have created in a [Properties] section. For example:
[Properties]
0=ApplySynonymMatch

PLM00100 12.2 Application Administration 7-17

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

e. Create a section for the property in which you set the SynonymType parameter to the
name of the synonym job that specifies the settings IDOL server should apply to synonym
queries. For example:
ApplySynonymMatch]
SynonymType=Synonym_job

f. In the IDOL server configuration file's [Synonym] section, list the synonym job whose
settings you want to apply when a synonym query is sent to IDOL server. For example:
[Synonym]
0=Synonym_job
You can set up multiple jobs, but normally only one is needed.

g. Define a section for your synonym job using the same name as the synonym job already
specified, and then add settings to apply to synonym queries. For example:
[Synonym_job]
File=animals.txt
MaxExpandLevel=1

h. Save the configuration file and restart IDOL server.

Indexing using IDOL search engine

Indexing overview
If indexing is configured, then keyword searches are available from Quick Search and Advanced
Search. A keyword search queries the search engine on an object-by-object basis for the properties
of dataset objects and the contents of dataset files.

Prerequisites for creating an index

• Full-text search is installed using the server installation guides (for Windows or UNIX/Linux).

• Settings for full-text search preferences:

TC_fts_index_port
Specifies the index port number used to index documents for the IDOL server.

TC_fts_index_retries
Specifies the number of times a connection with the IDOL server is attempted before exiting.

TC_fts_index_timeout
Specifies how long, in milliseconds, the client waits for data from the server before closing
the connection.

TC_fts_indexed_types
Specifies which object types are indexed. The search engine supports many data formats.

TC_fts_indexing_wait_timeout

7-18 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

Specifies the amount of time, in seconds, the FTS search engine is allowed to index one
object.

Create the index

Create an index using one of the following methods:
• Batch indexing
Use the build_fts_index utility to create and administer indexing.

• Manually indexing search objects

Choose Tools→Check Index Status and use the Check Index Status dialog box to view the
current status of the selected object. You can also use this dialog box to enable and disable
indexing on the selected object.

Preferences to configure indexing

• TC_fts_enforce_master_language
Specifies the language used to index unlocalized properties in cases where the
SiteMasterLanguage global constant value should not be used.
This preference accepts a single string as a value. The value must be one of the following:
czechUTF8, germanUTF8, englishUTF8, spanishUTF8, frenchUTF8 italianUTF8,
japaneseUTF8, koreanUTF8, polishUTF8, portugueseUTF8, russianUTF8, or chineseUTF8.

• TC_fts_hierarchical_index_delete
Specifies whether full-text search index and delete operations are hierarchical.

• TC_fts_index_retries
Specifies the number of times a connection with the IDOL server is attempted before exiting.
When the number of attempts is exceeded, the system displays an error.
Accepts a single string as a value. Must be single positive integer.

• TC_fts_index_timeout
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 an error.
Accepts a single string as a value. Must be single positive integer.

• TC_fts_indexing_wait_timeout
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.
Accepts a single string as a value.

• TC_fts_real_time_indexing
Specifies whether object indices are created or updated into the FTS index database in real time,
when the objects are created, modified, or deleted.

PLM00100 12.2 Application Administration 7-19

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

• TC_fts_realtime_delete_cache_size
Specifies the cache size (number of objects) for real-time, full-text search delete actions.
Valid values are any positive integer. The default value is 10.

• TC_fts_realtime_index_dt_cache_size
Specifies the cache size (number of objects) for real-time, full-text search dataset index actions.
Valid values are any positive integer. The default value is 10.
Increase the value to cause fewer IDOL calls to generate indexing and potentially remove
duplicated objects.

Caution
To avoid a user performance issue when importing a large amount of data listed in the
TC_fts_indexed_types preference, do not set this preference to a value less than 10.

• TC_fts_realtime_index_item_cache_size
Specifies the cache size (number of objects) for real-time, full-text search item index actions.
Valid values are any positive integer. The default value is 10.
Increase the value to cause fewer IDOL calls to generate indexing and potentially remove
duplicated objects.

Caution
To avoid a user performance issue when importing a large amount of data listed in the
TC_fts_indexed_types preference, do not set this preference to a value less than 10.

• TC_fts_supported_files
Specifies types of files that can be indexed.
Valid values are file extensions, for example, .txt.
Default values are .as, .aw, .csv, .dat, .dc, .dif, .doc, .docm, .docx, .dot, .dotm, .dotx, .eml,
.epub, .fff, .htm, .ip, .mdb, .mif, .msg, .ods, .pdf, .ppt, .pptx, .rtf, .stc, .sxc, .txt, .various,
.vdx, .wo, .wpd, .xml, .xla, .xlam, .xls, .xlsm, .xlsx, .xlt, .xltm, .xltx, and .xlw.

• TC_fts_indexed_types
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.
Accepts multiple strings as values. Each string must be a valid object type name.
The IDOL search engine supports numerous data formats.

• type-name_indexed_properties

7-20 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

Specifies the properties to be indexed to the IDOL database for a particular object type. This
preference supports type (hierarchy) inheritance.
Accepts multiple strings as values. Each string must be a combination of a valid type name and
one or more valid property names.

Batch indexing
An administrator can use the build_fts_index utility to create keyword indexes for the IDOL search
engine on an object-by-object basis. These indexes become part of the full-text keyword search
functionality and can index both the properties of dataset objects and the contents of dataset files. If a
dataset file is not of a document type supported by IDOL, the utility will ignore it.
Use the utility to manage all aspects of the index, including:
• Types of objects to index

• Queries to be indexed

• Number of files indexed in a given batch

• Logging

• Reports

Note the following:

• The build_fts_index utility is documented in the Utilities Reference.

• The -filter option is not used. It is replaced by the tc_fts_indexed_types and

tc_fts_supported_files preferences.

• For the -entry and -value arguments, -entry is the criteria name on a search form and -value
is the input for the criteria.

• For searches using the Modified after criteria, the value must be later than installation date.

Check the indexing status of objects and manually update the search index
Available if full-text search is implemented at your site.

Check indexing status

1. Select the objects in the tree.

2. Choose Tools→Check Index Status.

The Check Index Status dialog box appears showing the current indexing status for the selected
objects. The indexing status may be:

• Updated
Indicates the index for the object is current.

• Not Updated

PLM00100 12.2 Application Administration 7-21

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

Indicates the object is not indexed.

• Type Not Supported

Indicates the object is not specified by the TC_fts_indexed_types preference and is not
supported for indexing.

3. In the Check Index Status dialog box, select the objects you want to index.
Hold the Shift key for adjacent values and the Ctrl key for nonadjacent values.

4. Click Reindex to run the indexing process for the selected objects.
The system displays indexing errors, if any, and updates the status in the dialog box.
If the full-text search capability is not installed, the system displays the message: The FTS
engine could not be found.

5. Click Close to close the dialog box.

Manually indexing search objects

1. In My Teamcenter, select the dataset(s) to be indexed.

2. Choose Tools→Check Index Status.

The Check Index Status dialog box appears showing the current indexing status for the selected
objects. The indexing status may be:

• Updated
Indicates the index for the object is current.

• Not Updated
Indicates the object is not indexed.

• Type Not Supported

Indicates the object is not specified by the TC_fts_indexed_types preference and is not
supported for indexing.

3. In the Check Index Status dialog box, select the objects you want to index.
Hold the Shift key for adjacent values and the Ctrl key for nonadjacent values.

4. Click Reindex to run the indexing process for the selected objects.
The system displays indexing errors, if any, and updates the status in the dialog box.
If the full-text search capability is not installed, the system displays the message: The FTS
engine could not be found.

5. Click Close to close the dialog box.

7-22 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

Secure indexed data

Any user can view indexed data using a Web browser on the host upon which TcServer is installed,
regardless of a user’s permissions.
To ensure security of Teamcenter data, run the Teamcenter client and TcServer on separate hosts
and perform the following steps:
1. Authorize a specific machine as an IDOL and TcServer host in the idol.cfg server section by:
• Setting AdminClients to localhost,127.0.0.1.

• Setting QueryClients to localhost,127.0.0.1.

2. Create a temp directory on the host machine.

3. Share the temp directory, using a UNC path and full permissions.

4. Set the TC_TMP_DIR environment variable to \\host-machine\temp.

This allows the file attached to the dataset to be indexed.

5. (Optional) If necessary, you can install TcServer on additional hosts. If so, add the additional
host names to AdminClients and QueryClients.

Add new types for indexing

To add new types for indexing, you must first add the new type to the list of types to be indexed in the
TC_fts_indexed_types preference, and then create a new indexed properties preference for the type.
1. Choose Edit→Options to open the Options dialog box and select the Index tab to display
the preference index.

2. Select Configuration.Full Text Search to filter the preference index to full-text search
preferences.

3. Click the TC_fts_indexed_types preference from the preference list.

4. Add the new type to be indexed to the Current Values box. For example, add Part Revision.

5. Click Modify.
The new type is added to the preference.

6. Select the New tab at the bottom of the dialog box and create a new dataset_indexed_types
preference for the new type.
In this example, create a new Part Revision_indexed_types preference.

7. Select Site for the scope.

8. Select True for Multiple Values.

9. In the Values box, add the properties you want to index. For example, add object_name and
object_desc.

PLM00100 12.2 Application Administration 7-23

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

10. Click Create.

11. To see your changes, close the rich client session and restart the Teamcenter server.

12. Manually index the new type.

Reducing index disk consumption and indexing time

When using IDOL full-text search with a large database, the IDOL index database files can become
very large. If a large index database size is undesirable, either because of absolute database size or
because the time consumed to index is too large, then you can perform the following configuration
steps to turn off storing content in the index database node table.
Effects of turning off NodeTableStoreContent include the following:
Benefits • Disk space consumed by the index database is reduced.

• Time required to index is reduced.

Drawbacks • Time required to return search results may increase.

• Export/Import cannot be used to reimport existing index data into another

database.

1. Ensure the following:

• No data has been indexed with NodeTableStoreContent=true.

• Clear the index database. You can use either of the following methods to clear the index
database:
o Use the web interface to send DREINITIAL.

o Directly delete the DB folders in the IDOL/content folder.

2. Open the IDOL server configuration file, typically AutonomyIDOLServer.cfg, in a text editor.

3. Add the NodeTableStoreContent parameter in the IDOL configuration file.

NodeTableStoreContent=false

4. Add the following line above NodeTableStoreContent to avoid indexing unnecessary file
properties like author, title, modified and date.
MustHaveFieldCSVs=<required_fields>

where <required_fields> is:

*/DRECONTENT,*/Zs*,*/Zd*,*/DREREFERENCE,*/CurDbName,*/SeResultClass,*/TcLanguageType

5. In the IDOL server configuration file, locate the [FieldProcessing] section.

6. Make the following changes to the [FieldProcessing] section to add SetStoredFields.

a. Below [FieldProcessing], increment the Number parameter value by 1 to the next higher
value. For example, increment Number=24 to Number=25.

7-24 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

From:
[FieldProcessing]
Number=24

To:

[FieldProcessing]
Number=25

Note
Your Number parameter value may be different.

b. At the end of the [FieldProcessing] section, add SetStoredFields using the next higher
value. For example:
25=SetStoredFields

c. Create a [SetStoredFields] section. For example:

[SetStoredFields]
Property=StoredFields
PropertyFieldCSVs=*/Zs*,*/Zd*,*/DREREFERENCE,*/CurDbName,*/SeResultClass

7. In the [Properties] section, make the following changes.

a. Add StoredFields to the end of the [Properties] section using the next higher value. For
example:
25=StoredFields

Note
Your Number parameter value may be different.

b. Create a [StoredFields] section. For example:

[StoredFields]
StoredType=true

8. Save and close the IDOL server configuration file.

9. Delete these data folders located below the content folder:

• dynterm
• main
• nodetable
• numeric
• refindex
• status
• tagindex

PLM00100 12.2 Application Administration 7-25

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

Note
These folders are located in a default installation in the content directory under the
location where the software is installed.

10. Restart the IDOL server by doing one of the following:

• To restart the IDOL servers on Windows systems, use the Control Panel→Services dialog
box.

• To restart the IDOL servers on UNIX/Linux systems, use the scripts provided in the
appropriate directories.

11. Make sure the following error is not in the content engine’s application log file:
70-Error: Error - nodetable was initially created with "NodeTableStoreContent=TRUE".
This setting cannot be changed without initialising. Using original setting.

If you find this error, run DREINITIAL and restart IDOL server again.

Note
The DREINITIAL command deletes the data contained in the IDOL server data index
and resets the IDOL server to the installation state. The configuration file is not reset.

Indexing legacy data

You can export indexed data from a previous database by exporting all indexed data from the old
database to a series of compressed files named output-0.idx.gz, output-1.idx.gz, and so on. These
files are placed in the export path on the IDOL server host.

Real-time indexing

Real-time indexing updates the full-text search index automatically, whenever objects or their named
references are created, saved, modified, or deleted. Set the TC_fts_real_time_indexing preference
to true to enable real-time indexing on the types of objects specified by the TC_fts_indexed_types
preference.

Tip
Because this functionality indexes each object configured as an indexed type at the time it
is created, disable real-time indexing before creating large amounts of data (more than one
hundred objects) to improve performance.
After the data is created, use the build_fts_index utility to index the data. After indexing,
enable real-time indexing if desired.

7-26 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

Configuring IDOL (Autonomy) 10.1 upgrade

IDOL (Autonomy) 10.1 upgrade overview

When patching Teamcenter 12 to Teamcenter 12.2 and later, Teamcenter Environment Manager
(TEM) does not perform the upgrade to IDOL (Autonomy) 10.1. Instead, a manual installation must
be performed.
Perform the upgrade when:
• Autonomy 7.6 full-text search engine is already installed, configured, and has index data.

• Teamcenter 12 has been patched to Teamcenter 12.2 and later.

Perform these tasks:

1. Prepare to install IDOL (Autonomy) 10.1

2. Perform the appropriate upgrade.

• Upgrade IDOL on a Windows system
• Upgrade IDOL on a UNIX system

3. Update IDOL configuration files

4. Re-index the Teamcenter data

This process upgrades IDOL with these latest versions:

• IDOL V10.11.0
• CFS V10.11.0
• Content V10.11.0.1252972

A new installation of IDOL (Autonomy) 10.1 can be performed using Teamcenter Environment
Manager (TEM) when no index data exists.

Prepare to install IDOL (Autonomy) 10.1

Before you begin the IDOL (Autonomy) 10.1 installation and configuration, perform these tasks:
1. Download the upgrade file from GTAC.
a. In the Download section, select Teamcenter and Teamcenter Rapid Start from the list of
products.

b. Choose Product updates→Patch→General→Integration and Solutions→Autonomy.

c. Download the Autonomy_10.1_operating-system.zip file.

Optionally, download the support documents in the same folder.

2. Back up configuration files of the original Autonomy installation especially if there are changes to
these files. The backup file configurations can be put in place after the upgraded installation.
• idol.cfg
• fsf.cfg

PLM00100 12.2 Application Administration 7-27

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

The Autonomy_10.1_operating-system.zip file does not include these configuration file templates.
These configuration file templates are not required because the original Autonomy installation contains
the template files. A new full release of Teamcenter contains the configuration file templates with the
Autonomy 10.1 installation image in autonomy.zip file. The configuration file templates include:
• idol.cfg.template

• fsf.cfg.template

Upgrade IDOL on a Windows system

1. Log on as a user with administrator privileges to the system where IDOL is installed.

2. Locate the IDOL services, which may differ from these names.
Open the Services dialog box.

Service name Example installed directory and service

FSF D:\autonomy\fsf\FSF.exe
IDOL D:\autonomy\idol\IDOL.exe

Note
In the steps that follow, use your installed IDOL service names.

3. Stop the IDOL services.

4. Make sure the IDOL service applications are stopped in Windows Task Manager. Open the task
manager by right-clicking the taskbar, and then clicking Start Task Manager.

5. From the Process tab in the Windows task manager dialog box, make sure there is no
content.exe file listed.

6. Open a command prompt to delete FSF and IDOL services.

Type the following commands:

sc delete <IDOL-service-name>
sc delete <FSF-service-name>

7. Rename the original autonomy folder to autonomy_backup.

8. Copy the new IDOL package to the same installed directory location.

Note
Unzip the Autonomy_10.1_operating-system.zip file to get the new autonomy folder.

9. Rename the new Autonomy folder to be the same name as the original folder (as needed).

7-28 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

10. Copy the corresponding configuration files from autonomy_backup into the new Autonomy
folders, respectively.
• idol.cfg
• fsf.cfg

Note
Use the Autonomy 10.1 configuration template files with an upgrade from Autonomy 5.
The Autonomy 5 configuration files are not compatible with Autonomy 10.1.

11. If you are using the synonym capability, copy the synonym file into the content folder.

12. In their corresponding folders, rename the FSF.exe and IDOL.exe files to the same name as
the original service names.
This ensures the service names are the same as your original service names when the service is
installed in the next step.

13. Install services from the new Autonomy package directories.

a. Open the Windows command prompt.

b. Change the directory to the Autonomy installation location.

c. For each service, change the directory to the FSF and IDOL folder and type the commands
to install the services.

FSF.exe –install
IDOL.exe –install

Note
The FSF and IDOL executables must be the name in the Autonomy folder.

14. Verify the services (FSF and IDOL) are started in the Services dialog box.

15. Verify the content.exe service is also running in the Process tab in the Windows task manager
dialog box.

16. Check the versions to verify that the upgrade

Open a browser to check that upgrade was successful.
Open the following URL in a browser:
http://localhost:aciport/action=getversion

Open the following URL in a browser:

http://localhost:fsfport/action=getversion

If the versions returned are correct, the upgrade was successful and the services are started.

PLM00100 12.2 Application Administration 7-29

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

Upgrade IDOL on a UNIX system

1. Log on as a user with administrator privileges to the system where IDOL is installed.

2. Locate the IDOL services.

Type this command:
ps -ef | grep autonomy

Note
In the steps that follow, use your installed Autonomy service names.

3. Stop the Content, FSF, and IDOL services.

4. Rename the original autonomy folder to autonomy_backup.

5. Copy the new package to the same Autonomy installed directory location.
Unzip the Autonomy_10.1_operating-system.zip file to get the new autonomy folder.

6. Rename the new Autonomy folder to be the same name as the original folder (as needed).

7. Copy the corresponding configuration files from autonomy_backup into the new Autonomy
folders, respectively.
• idol.cfg
• fsf.cfg

Note
Use the Autonomy 10.1 configuration template files with an upgrade from Autonomy 5.
The Autonomy 5 configuration files are not compatible with Autonomy 10.1.

8. Copy the start script from autonomy_backup into the new Autonomy folder.

9. If you are using the synonym capability, copy the synonym file into the content folder.

10. In their corresponding folders, rename the FSF.exe and IDOL.exe files the same name as the
original service names.

11. Start the FSF and IDOL services from the new Autonomy directories.
Type these commands from the corresponding directory:

FSF.exe –install
IDOL.exe –install

12. Start the Content service.

13. Verify the Content, FSF, and IDOL services are started.

7-30 Application Administration PLM00100 12.2

 Configuring Teamcenter searches

14. Check the versions to verify that the upgrade

Open a browser to check that upgrade was successful.
Open the following URL in a browser:
http://localhost:aciport/action=getversion

Open the following URL in a browser:

http://localhost:fsfport/action=getversion

If the versions returned are correct, the upgrade was successful and the services are started.

Update IDOL configuration files

After the manual upgrade to IDOL (Autonomy) 10.1, update the configuration files.
1. Make the following changes to the idol.cfg file:
a. Correct the spelling of the following setting.
From:
SetItaliLanguageFields

To:

SetItalianLanguageFields

b. Remove the comment before this setting.

SentenceBreaking=japanesebreaking

c. Keep only the UTF8 settings in all the language definitions. For example:
[japanese]
Encodings=UTF8:japaneseUTF8

Remove all other encoding and language settings.

d. Do not define a + symbol in TangibleCharacters.

2. Make the following changes to the fsf.cfg file:

a. Add the following setting:
ImportEmptyFiles=false

b. Remove the comment before the QueryPort setting, and assign the correct port number
(9000 by default).
QueryPort=9000

c. Remove the comment before the IndexPort setting, and assign the correct port number
(9001 by default).
IndexPort=9001

PLM00100 12.2 Application Administration 7-31

 Chapter
Chapter 7: 7: Configuring
Configuring Teamcenter
Teamcenter searches
searches

Re-index the Teamcenter data

After your new IDOL installation is running, re-index all the Teamcenter data using the
build_fts_index utility.

Reusing an existing index

When you upgrade to a version of Teamcenter that supports a higher version of IDOL server,
Siemens PLM Software recommends re-indexing your data. However, if you have a large amount
of data to index, re-indexing could take days or even weeks. Instead of re-indexing, you can reuse
existing data to avoid this delay if the following conditions apply:
• The old and new IDOL versions are compatible. (IDOL 7.6 through IDOL 10.1 are compatible.)

• You use the same index schema in your upgraded system as in your previous system. (That is,
you make no changes in the IDOL configuration file.)

• You use the same index database name in the upgraded system.

7-32 Application Administration PLM00100 12.2

Chapter 8: Defining queries and reports

Creating queries and reports

Teamcenter administrators and other privileged users create customized queries for administrative
and general use. These queries can be presented as forms in the search tool or they can be used as
the basis for more structured reports created using Report Builder. In addition, you can export saved
queries to XML files that you can share with other Teamcenter sites.
Query Builder enables you to write complex queries based on the Teamcenter data schema, which is
an hierarchical arrangement of classes, subclasses, and attributes. Query Builder provides hints
to assist you in navigating the schema. The hints present a relationship as a starting point, for
example, the relationship between an item and its item revision, and then provide you with the steps
to build that relationship into your search definition.
Report Builder enables you to create and manage report definition templates using HTML, Excel,
or XML style sheets.
You can use Report Builder to manage reports that were created with Teamcenter reporting and
analytics (TcRA). TcRA is a third-party product that extends Teamcenter reporting capabilities. To
use TcRA:
Download the Teamcenter reporting and analytics software distribution image for your platform from
the Siemens PLM Software FTP site.
Reporting and Analytics requires additional preinstallation steps.
For information about steps to perform before you install Reporting and Analytics, see the current
version of the Teamcenter Reporting and Analytics Deployment Guide in the Documentation
directory in the Reporting and Analytics software distribution image.
After you complete these steps and install Reporting and Analytics, you can begin using the Reporting
and Analytics integration in Report Builder.
Teamcenter includes Report Generator, a reporting application. Use this application to create reports
from Manufacturing Process Planner and Part Planner data.

Defining queries and reports tasks

Typical administrative tasks related to building queries and formatting reports include:
• Defining the requirements for your queries.

• Navigating the schema and defining search clauses to create queries that match your
requirements.

• Creating property finder formatter (PFF) objects that allow you to gather and report data related
to the objects returned by a query.

PLM00100 12.2 Application Administration 8-1

 Chapter
Chapter 8: 8: Defining
Defining queries
queries and reports
and reports

• Maintaining the XML file containing the hints used to navigate the schema in Query Builder.

• Importing and exporting search definitions.

• Defining and managing report definition templates.

8-2 Application Administration PLM00100 12.2

Chapter 9: Configuring Teamcenter mail and instant messaging

Configuring Teamcenter mail

Administrators can configure Teamcenter mail to:
• Specify the mail gateway server, port, and character set used to send mail.

• Allow e-mail addresses to exceed 32 characters in length.

• Notify users of important schedule dates, milestones, and task completion.

• Enable and disable the capability to send operating system e-mail from within Teamcenter.

• Specify the interval at which Teamcenter checks for new mail.

• Work with external e-mail for subscription notices.

Change email server authentication settings

Email server authentication settings are initially configured using Teamcenter Environment Manager
manager.
1. Run Teamcenter Environment Manager from your Teamcenter home directory.

2. Select Configuration Manager and choose to perform maintenance on your existing Teamcenter
Foundation configuration.

3. On the Foundation Settings panel, choose the Email server settings tab and specify a new
password and change related security settings.

Configure external e-mail for subscription and workflow notification

To use external (operating system) e-mail for subscription and workflow notification, you must:
• Set mail gateway preferences:
o TC_subscription=ON to enable display and use of the Tools→Subscribe menu command.

o Mail_server_name=a_valid_SMTP_mail_server

o Mail_OSMail_activated=true to enable operating system email from Teamcenter.

To view notification e-mail sending records, set TC_audit_manager=ON,

TC_audit_manager_version=3, and SCM_notification_history=true.

• For the person objects associated to users to be notified, ensure the E_Mail address fields are
set correctly in the Organization application.

• Start the subscriptionmgrd subscription monitor process daemon.

PLM00100 12.2 Application Administration 9-1

 Chapter
Chapter 9: 9: Configuring
Configuring Teamcenter
Teamcenter mail instant
mail and and instant messaging
messaging

Configuring Teamcenter to use email servers requiring authentication

You can use TEM to configure Teamcenter to access an email server that requires authentication.
The following preferences get set based on the values supplied in TEM, and can be updated if your
email server requirements change.
Mail_server_authentication_activated
Set to true to connect to a server requiring authentication.
Mail_server_authentication_id
The e-mail ID or the user ID to use for e-mail authentication.
Mail_server_authentication_passwd_location
The full path and file name of the encrypted password to use for e-mail authentication.
Mail_server_connection_security
The type of secure connection to establish when connecting to the mail server.
None (The default value.) No security connection protocol is used when
connecting with the mail server.
SSL/TLS Establish an SSL/TLS connection when connecting to the mail server.
STARTTLS Establish an initial insecure connection and later convert to a TLS
connection with the mail server.
Mail_server_ssl_protocol
The protocol and version to use when connecting with the mail server.
TLSv1 (The default value.) Transport Layer Security version 1.
TLSv1_1 Transport Layer Security version 1.1.
TLSv1_2 Transport Layer Security version 1.2.
SSLv2 Secure Sockets Layer version 2.
SSLv23 Secure Sockets Layer version 2.3.
SSLv3 Secure Sockets Layer version 3.

Configuring instant messaging

Teamcenter rich client users use Microsoft Office Communicator to see when other users are
available for instant messaging.
Teamcenter users can view the current status of the owning and last modified users, and, from within
a Teamcenter application, can initiate communication using Microsoft Office Communicator.
This capability:
• Is supported only on Windows systems with Microsoft Office Communicator.

• Lets you access all available Microsoft Office Communicator features.

• Is available in Teamcenter and is enabled and controlled by preference settings.

9-2 Application Administration PLM00100 12.2

 Configuring Teamcenter mail and instant messaging

o The OCS_use_presence_display preference specifies whether the functionality is

integrated withTeamcenter.

o The OCS_use_email_property preference specifies whether to use the e-mail ID from the
e-mail ID field of the user Person object.

o The OCS_company_email_domain preference value specifies a domain name if the

OCS_use_email_property preference value is false.

• For the rich client, integration is implemented in:

o My Teamcenter Summary view

o My Teamcenter Viewer view

o Workflow perform-signoffs panes

o Systems Engineering

o Structure Manager

o Schedule Manager

Note
Microsoft Office Communicator must be installed and running on your computer to use the
Teamcenter integration with Microsoft Office Communicator.
• If you try to use this feature when Microsoft Office Communicator is not installed and
running on your computer, Teamcenter displays the symbol color corresponding to the
Microsoft Office Communicator Presence Unknown status.

• If you try to use the Teamcenter integration with Microsoft Office Communicator to
contact a user for whom the system cannot find an e-mail ID, the system displays a
message listing possible reasons for the inability to continue the communication.

PLM00100 12.2 Application Administration 9-3

Chapter 10: Configuring Teamcenter email polling

What is Teamcenter email polling?

Teamcenter email polling is functionality that checks an email account for unread messages that
match criteria specified in a polling rule. For messages that meet the polling criteria, Teamcenter
performs a specified type of response.
You can use email polling to bring email content from third parties into Teamcenter. You can also
extend email polling to perform additional actions on email messages and attachments.
Actions performed during an email polling cycle include the following:
1. The business user defines an email polling rule and then starts or schedules email polling.

2. Teamcenter logs in to the user's e-mail account and checks the Inbox folder for unread messages.

3. Teamcenter tests unread messages for matches to criteria (subject and token files) specified in
the business user's rules.

4. If an unread message matches the specified criteria, then Teamcenter performs actions
according to the response type specified in the rule. The default response type performs the
following actions:
• Downloads the message body and attachments to a specified folder on the Teamcenter
server.

• Moves the message to a specified archive folder in the mail system.

• Starts a review workflow of the downloaded message in Teamcenter.

An administrator or developer can create a subtype of the basic email-polling business object and
define additional actions for a response. For example, attachments could be scanned for viruses.

5. From the review workflow task, the business user reviews the message and attachment files and
chooses whether to approve or reject the message and attachments.

Teamcenter does this with the file

For this decision (default action)
Approve No further action.
Reject Purges the downloaded file.

Email polling can be started or scheduled either of these ways:

• By the business user from within the rich client, if standard Teamcenter dispatcher services have
been configured. Multiple rules can be scheduled to run.

• By an administrator at the command line or in a chron job using the email_polling utility.

PLM00100 12.2 Application Administration 10-1

 Chapter
Chapter 10:10:Configuring
Configuring Teamcenter
Teamcenter emailemail polling
polling

Configure email polling types

System administrators/customizers configure email polling types and can customize the actions
performed by a type. The types are referenced by email polling rules.

Prerequisites
• Teamcenter is installed and configured to work correctly.

• BMIDE is installed and is working property.

• The system administrator/customizer performing the configuration:

o has sufficient privileges (dba) to create and install templates or make changes to the
Teamcenter database.

o has write access to all Teamcenter installation folders.

• If scheduled polling using Teamcenter Dispatcher is to be used, when installing or updating

Dispatcher, in the Select Translators panel, Email Polling→Email Polling is selected.

Configuration steps
1. In BMIDE, for the e-mail polling type that you want to configure:
a. Create or open a template project.

b. In the classic LOV list Fnd0EmailResponseTypes, create a list value to identify the polling
type that you want to define.
Only the value parameter of the list value is used for polling; its description and condition
parameters are not used.

c. If in your application you want to persist more data than just e-mail body text and
attachments, or to impart additional behavior, then create a subtype of the object
Fnd0EmailResponseRecord.
Add your custom actions to your new object subtype.

d. Save and deploy the template.

2. In the rich client

a. Log on using an account with dba rights.

b. Choose Edit→Options.

c. Find the preference Email_polling_download_dir, and set the preference value to the
desired location for downloaded attachments in the server's file system. This location is used
by all email polling types.
The specified location must exist in the server's file system; the polling functionality does
not create the folder.

d. For each value that you added to the classic LOV list Fnd0EmailResponseTypes, do the
following:

10-2 Application Administration PLM00100 12.2

 Configuring Teamcenter email polling

A. Create a new preference named <LOV value>_Response_Record_Object.

B. Set the preference value to Fnd0EmailResponseRecord or, if you created a subtype of

the object Fnd0EmailResponseRecord and you want to associate the LOV value with
that object subtype, then set the preference value to the name of the object subtype.

Create an email polling rule

Business users create email polling rules to configure checks for incoming email messages and
attachments, and to specify the polling type to apply to qualified messages. Multiple rules can use
the same polling type.

1. In My Teamcenter, choose File→New→Other→Email Polling Rule.

2. In the Email Polling Rule dialog box, enter the following information.

PLM00100 12.2 Application Administration 10-3

 Chapter
Chapter 10:10:Configuring
Configuring Teamcenter
Teamcenter emailemail polling
polling

Field Description

Description A brief description of the email polling rule and its usage.

Name A name for the email polling rule.

Polling The destination user email folder for archived email messages. The folder
Archive folder must exist. The polling functionality does not create the folder.

Polling Inbox The email user folder containing the messages to test.
folder

Polling The words at the beginning of the email message subject that qualify it
Subject for action by the rule.

Polling Token The names of files provided to responders for required attachment to
File Names response emails.
Required attachments may include digitally signed
request-identification-documents or pre-encrypted binary files.
Token files are a means of enhancing security.
Leave blank if token files are not used.

Response The type of email response to which this rule applies. This is a
Type value contained in the application template classic LOV (list of
values) Fnd0EmailResponseTypes as configured by the system
administrator/customizer.

Rule ID The ID for the newly created rule.

The ID is used to identify the rule when starting email polling.

3. Click Finish.

Configure user email account settings

To enable Teamcenter polling functionality to communicate with an email server, user email account
information must be specified before starting or scheduling email polling.
1. In My Teamcenter, choose Tools→Email Polling→Configure Email Polling.

10-4 Application Administration PLM00100 12.2

 Configuring Teamcenter email polling

2. In the Configure Email Polling dialog box, enter the following information:

Field Description
Address of the email The address of the email server for your email account.
server being polled
Example
mycasa001.net.acme.com

Polling user email ID Your email account address.

Example
[email protected]

Polling user password The password for your email account.

Server port number The email server port number for messages sent to your account
(incoming).

Example
993

SMTP port number The email server port number for uploading messages that you
want to send from your account (outgoing).

Example
465

PLM00100 12.2 Application Administration 10-5

 Chapter
Chapter 10:10:Configuring
Configuring Teamcenter
Teamcenter emailemail polling
polling

Field Description
SMTP server address The host name of the SMTP (Simple Mail Transfer Protocol)
server for outgoing mail.

Example
smtp.acme.com

Polling protocol for the The protocol for connecting with the email server, either POP3 or
server IMAP.

3. Click OK.

Configure dispatcher for email polling

Note
Dispatcher settings for email polling may have been set by Teamcenter Environment
Manager (TEM). In that case, confirm the following configuration.

1. To activate the EmailPollingService service, set the isactive attribute to true in the
DISP_ROOT\Module\conf\translator.xml file.
<EmailPollingService provider="SIEMENS" service="emailpolling" isactive="true">

Note
DISP_ROOT is the dispatcher root directory provided in Teamcenter Environment
Manager (TEM).

2. In the DISP_ROOT\Module\Translators\emailpolling\emailpolling.bat file, set the following

variables to your installation locations:
• TC_ROOT

• TC_DATA

• JRE_HOME

3. In the TC_DATA\EmailPolling.conf file, remove the comments before these settings:

• EmailPolling_JAVA_XMS=16m

• EmailPolling_JAVA_XMX=128m

4. Run the genregxml.bat utility.

• Open a Teamcenter command prompt and type the following command:
TC_ROOT\portal\registry\genregxml.bat

10-6 Application Administration PLM00100 12.2

 Configuring Teamcenter email polling

5. For each Teamcenter user who performs email polling actions, set the E-Mail Address property.
a. Using an account with dba privileges, log on to the rich client and open the Organization
application.

b. Expand the Persons node and select the person who performs email polling actions.

c. Set the E-Mail Address property.

Start or schedule email polling

Prerequisites

• User email account information is configured.

• Dispatcher is configured for email polling.

Procedure

1. In My Teamcenter, choose Tools→Email Polling→Start Email Polling.

2. In the Start Email Polling dialog box, enter the following information:

Field Description
Start now! Select one of these choices.
Schedule • Start now! runs a single on-demand poll.

• Schedule enables scheduling periodic polling.

Start Time The date and time to start scheduled polling.
End Time The date and time to end scheduled polling.
Interval The interval of time to repeat the poll.
Rules ID The ID of the email polling rule to use.

PLM00100 12.2 Application Administration 10-7

 Chapter
Chapter 10:10:Configuring
Configuring Teamcenter
Teamcenter emailemail polling
polling

3. Click OK.

Tip
You can administer scheduled polling requests using the Dispatcher request administration
console.

Teamcenter email polling preferences

For basic email polling functionality, you do not need to change default values for the following
preferences.
EMLPOLLING_default_polling_config_id
Defines the identifier for email polling configuration to be used in the email polling operation.
Default value: def_polling_config_id
Fnd0EMLPollingRevFrm.JAVARENDERING
Defines the Java class to render the property panel of a form with type Review Email Polling
Revision Form.
Default value:
com.teamcenter.rac.emailpolling.commands.rendering.EmailPollingRevisionForm
Fnd0_review_email_attachments_workflow
Defines the create workflow for email polling functionality.
Default value: Review Mail Attachments

10-8 Application Administration PLM00100 12.2

Chapter 11: Configuring Teamcenter notes and
parametric requirements

Configuring standard notes and custom notes

Standard note or parametric requirement objects are used to provide information about parts and
documents that is based on the established practices of a design program. The following aspects of
standard note and parametric requirement behavior can be configured by a Teamcenter administrator:

• Creation privileges

Users must fill a role specified in the Ads0CreateStandardNoteAuthority list of values or have
DBA privileges with bypass set to be able to create a standard note or parametric requirement.

• Delimiter between parameters in note text

• Ability to attach multiple revisions of a standard note or parametric requirement to an item

or item revision

Configure standard note creation authority

Standard notes and parametric requirements can only be created by privileged users. You can
specify the roles that are allowed to create notes and requirements and then specify access privileges
based on these roles.

To specify the roles that are allowed to create standard notes and parametric requirements, add the
roles to the Ads0CreateStandardNoteAuthority list of values. You can then grant access privileges
based on those roles.

Set the delimiter that separates parameters in standard note text

A standard note or parametric requirement contains:

• Text

• A parameter and applicable values, using the following syntax:

text [parameter name: parametric value1 delimiter parametric
value2 delimiter ..... parametric value n]

The default delimiter separating the parameters in the note is a comma (,). To change the delimiter
separating the parameters in the note, set the Fnd0ParamReqDelimiter global constant.

PLM00100 12.2 Application Administration 11-1

 Chapter
Chapter 11:11:Configuring
Configuring Teamcenter
Teamcenter notesnotes and parametric
and parametric requirements
requirements

Enable attachment of multiple revisions of a parametric requirement

Standard notes and parametric requirements can be attached to an item or item revision. By default,
only one revision of a standard note or parametric can be attached to an item or item revision. You
cannot attach multiple revisions of the same note or requirement to a single item or item revision.
However, you can enable multiple revisions of the same standard note or parametric requirement
to be attached to an item or item revision by setting the AllowMultipleRevisionsofStdNotes
global constant.

Configure the behavior of custom notes

Custom notes provide unique information about an individual part or document, and they can be
attached to an item or item revision. The following behavior can be configured for custom notes:
• By default, a custom note item can be attached to a single item or multiple revisions of the same
item. A custom note item cannot be attached to multiple items or to revisions of multiple items.
To enable a custom note item to be attached to multiple items or revisions of multiple items, set
the Fnd0AttachCustomNoteToMultiItems business constant to true.

• By default, multiple revisions of a custom note cannot be attached to an item or item revision.
To enable multiple revisions of a custom note to be attached to an item or item revision, set the
Fnd0AllowMultipleRevofCustomNote global constant to true.

11-2 Application Administration PLM00100 12.2

Chapter 12: Edit a Teamcenter registry file

What is Registry Editor?

Registry Editor is a rich client application for editing registry files of applications registered in the
Teamcenter framework. Such registry files may need modification for purposes of internationalization,
dynamic class invocation, or configuration. While administrators can use any standard text editor to
edit a registry file, Registry Editor simplifies the tasks of editing the registry files.
When a property in a registry file must be modified for a site, a system administrator locates the file in
the rich client and opens the file using Registry Editor. The system administrator navigates to the
desired key name and changes the value. If a new property is required, the administrator inserts a
blank line and enters the new key name and key value.
Registry Editor does not need to be enabled before use, but the feature must be selected during
Teamcenter installation.

Registry Editor interface

PLM00100 12.2 Application Administration 12-1

 Chapter
Chapter 12:12:Edit aEdit a Teamcenter
Teamcenter registry
registry file file

1 Properties tab The Properties pane displays a two-column table populated

with key names and key values contained in the currently
open .properties file.
You can edit key names and values in this pane.
2 Editor tab The Editor pane displays the full text within the currently
open .properties file, including comments. You can directly
edit the text.
You may want to use the Editor pane so that you can add
your own comments about any changes you make.
3 Find box Field for entering a Key name search string.
4 Find Starts the search operation.
If the registry file contains a Key whose name exactly matches
the string entered in the Find box, then clicking Find (or
pressing Enter while focus is on the Find box) highlights the
row containing the key. If the row is not already visible, the
dialog box scrolls to display the row.
5 Create Adds a row to the properties table for a new key/value pair.
6 Remove Deletes the selected row.

All Registry Editor menus are standard Teamcenter rich client menus.

Registry files in Teamcenter

Each application that is registered in Teamcenter has a registry file named with the extension
.properties. A registry file contains user-defined configuration settings (keys/values) that influence
how the application appears and performs in the interface. Property files are located in various .jar
files.
• A key is a field in a record that contains unique data and identifies the record in the file or
database. Each key value must be unique in each record.

• A value is the content of a field or variable. It can refer to alphabetic, numeric, or alphanumeric
data.

• Properties are the keys and values in a registry file that specify the configuration settings for
an application.

The following figures contain examples of registry files, as viewed in the Registry Editor Editor pane.
These files are contained in the com.teamcenter.rac.aifrcp_1.0.0.jar file.

12-2 Application Administration PLM00100 12.2

 Edit a Teamcenter registry file

import=com.teamcenter.rac.aif.aif
com.teamcenter.rac.aif.registryeditor.RegistryEditorApplication.
PANEL=com.teamcenter.rac.aif.registryeditor.RegistryEditorApplicationPanel
com.teamcenter.rac.aif.registryeditor.RegistryEditorApplication.
MENUBAR=com.teamcenter.rac.aif.registryeditor.RegistryEditorApplicationMenuBar
com.teamcenter.rac.aif.registryeditor.RegistryEditorApplication.
TOOLBAR=com.teamcenter.rac.aif.registryeditor.RegistryEditorApplicationToolBar
### helpPage address ###
helpPage=/registry_editor/WebHelp/WHStart.htm
# New Key
# ------------------------------
newKey.ICON=images/add_16.png
# Remove a Key
# ------------------------------
removeKey.ICON=images/remove_16.png

registryeditor.properties file

PLM00100 12.2 Application Administration 12-3

 Chapter
Chapter 12:12:Edit aEdit a Teamcenter
Teamcenter registry
registry file file

# Find in Display Keys

# ------------------------------
findInDisplay.TIP=Find In Display
# Read-Only Text
# ------------------------------
readOnly=(Read-Only)
# New Key
# ------------------------------
newKey.TIP=Create a New Key
# Remove a Key
# ------------------------------
removeKey.TIP=Remove a Key
# File Type description key.
# ------------------------------
RegistryFiles=AIF Registry Files
# Unable to Save keys.
# ------------------------------
UnableToSave.MESSAGE=Unable to Save...File is Read Only!
UnableToSave.TITLE=Unable to Save
# No File Open
# ------------------------------
NoFileOpen.MESSAGE=Can't Save...No file open!
NoFileOpen.TITLE=Can't Save
# Overwrite File
# ------------------------------
Overwrite.TITLE=File Already Exists
Overwrite.MESSAGE=Overwrite the existing file?
# About Dialog keys
# ------------------------
application.TITLE=Registry Editor
application.DESCRIPTION=Registry Editor is used to edit
Portal Registry files. This application is used\only
for editing Registry files that are used for internationalization,
dynamic\nclass invocation, and configuration in the Portal.
# Title for the Save-As dialog
# -------------------------------
saveAs.TITLE=Save-As
open.TITLE=Open
untitled.FILE=Untitled
saveModified.TITLE=Save Modified File
saveModified.MESSAGE=Should the changes be saved before closing?
saveModified.TIP=Save modified file.
openFile.TIP=Open registry file.

registryeditor_locale.properties file

Open a Teamcenter registry file

1. In the rich client, open the Registry Editor application.

2. Choose File→Open.

3. Browse to and select a registry file, and then click Open.

12-4 Application Administration PLM00100 12.2

 Edit a Teamcenter registry file

Modify a registry file

1. Open the registry file.

2. In the Properties pane, modify the file:

To perform this Do this

action
Change an existing Double-click the value to change and update the value.
value
Add a new key and Click Create Key and enter a new key/value pair.
value
Remove a key and Click the key/value pair in the row that you want to remove and click
value Remove Key .

Alternatively, you can click the Editor tab and directly edit the registry file text in the Editor
pane. You may want to use the Editor pane so that you can add your own comments about any
changes you make.

3. Choose either File→Save or File→Save-As.

If you choose File→Save-As, Teamcenter appends the .properties extension to the file name.

PLM00100 12.2 Application Administration 12-5

Chapter 13: Configuring Lifecycle Visualization

Configuring Lifecycle Visualization overview

Teamcenter offers multiple software options to support your product visualization requirements,
including the stand-alone viewer, the Lifecycle Viewer, and the embedded viewers located within
Teamcenter applications such as My Teamcenter and the Structure Manager. Use the configuration
options described in the following topics to customize Lifecycle Visualization for your organization.

Modifying Lifecycle Visualization configuration files

Because the files used to configure Teamcenter are cached, if you update client_specific.properties
or tcviewer.properties, your changes may not take effect in the viewers because the rich client is still
referencing the cached files. If your changes do not appear, do the following:
• To clear the cache, add the –clean argument to the command line in the shortcut you use to start
the rich client. Once your changes appear, you can remove the argument from the command line.

• If you update a JAR file in the ../rac/plugins directory, make sure to replace the original JAR file
with the updated version. Do not leave the original version of the JAR file in the directory.

Specify visualization licensing options

To work with Visualization in Teamcenter you must have the appropriate license, and you specify the
licensing for the Lifecycle Viewer and the Teamcenter embedded viewers. The Visualization service
level license is specified in the Teamcenter Organization application. Licensing for additional optional
applications is specified in the client_specific.properties file.

Caution
These settings must match the licensing configuration available from your Teamcenter
license server. They are set automatically during the client installation and in most cases
should not be modified.

Set the Visualization service level license

When you create or modify a user in Organization, for the Visualization Licensing Level, choose
the appropriate license for the user: Base, Standard, Professional, or Mockup.

Set optional application licenses

1. Open the client_specific.properties file in a text editor. The file is located in the
..rac\plugins\configuration_8000.0.0 directory on client machines.

PLM00100 12.2 Application Administration 13-1

 Chapter
Chapter 13:13:Configuring
Configuring Lifecycle
Lifecycle Visualization
Visualization

2. If necessary, add the following line to the file:

This line Requires this information

The names of functionality options not included
in the default product configurations. Type the
values, separated by commas, listed below
that match any additional visualization licenses
you have purchased:
• ECAD
PortalViewer_Optional_Licenses
• Analysis

• Path_Planning

• Concept_Desktop

• Collaboration

Rich client embedded viewer compatibility

The Teamcenter rich client and the Lifecycle Visualization embedded viewer must share the same
major and minor release. For minor releases and patches, the viewer must be the same version
as the rich client, or newer.
When using a version of the viewer that is newer than your rich client, new viewer features
may not be available if they require rich client or server support. In addition, if a newer
version of the viewer is installed, you must copy the SingleEmbeddedViewer.jar file from the
<viewer_install_location>\Program folder to the <rac_install_location>\rac\plugins folder,
overwriting the older version of the file.

Customizing the Viewer view

The framework for the Viewer view in the rich client uses preferences to configure the Viewer view
to traverse the data model and present a viewer for the selected business object type. When
an object is selected in the rich client, the preference configuration is read, and the correct target
viewer is presented.
Administrators can use four preferences to configure the Viewer view:
• defaultViewerConfig.VIEWERCONFIG
Use this preference to specify the default Viewer view configuration by defining which Generic
Relationship Management (GRM) rules to expand and the viewer to use for each type of object
specified in the preference.

o To use an alternate configuration, define it using the <viewer-config-ID>.VIEWERCONFIG

preference.

o For default values, see the defaultViewerConfig.VIEWERCONFIG preference description.

13-2 Application Administration PLM00100 12.2

 Configuring Lifecycle Visualization

• <viewer-config-ID>.VIEWERCONFIG
Use this preference to specify an alternate Viewer view configuration instead of the
defaultViewerConfig.VIEWERCONFIG preference. This preference defines which Generic
Relationship Management (GRM) rules to expand, and the viewer to use for each type of object
specified in the preference.

o You can create your own preference using the <viewer-config-id>.VIEWERCONFIG format
for the name. The name must end with .VIEWERCONFIG.

o To use this preference instead of the default viewer configuration preference, you must
specify this preference name in the Viewer.VIEWERCONFIGTOLOAD preference.

Note
There is no default value for the <viewer-config-ID>.VIEWERCONFIG preference.
Enter values for your own configuration.
For an example of values, see the defaultViewerConfig_VIEWERCONFIG
preference.

• Viewer.VIEWERCONFIGTOLOAD
Use this preference to specify the Viewer view configuration to load. This preference must
point to a .VIEWERCONFIG preference name.
By default, this preference points to the defaultViewerConfig.VIEWERCONFIG preference. To
point to an alternate preference, enter a <viewer_config_id>.VIEWERCONFIG preference name.

Viewing data from multiple Teamcenter servers

If you plan to view data from multiple Teamcenter servers such as Teamcenter, Teamcenter
engineering process management, and Teamcenter Enterprise, the various databases may not be
coordinated with the viewer. You can only connect to one server at a time with only one FMS.
You must install either the rich clients for these servers or the FCC. Contact your Teamcenter
administrator to obtain these client products. You must also modify the fcc.xml file by doing the
following:
1. Contact your Teamcenter administrator for the following information about each server for each
Teamcenter product you want to view visualization data from:
• The site id number

• The parentfsc address

2. Open a command window on your machine and navigate to

teamcenter-product-installation-directory\tccs\bin.

Example
d:\tc\10\tccs\bin

PLM00100 12.2 Application Administration 13-3

 Chapter
Chapter 13:13:Configuring
Configuring Lifecycle
Lifecycle Visualization
Visualization

3. At the command prompt, type:fccstat –stop –kill.

4. Navigate to teamcenter-product-installation-directory\tccs.

5. Open the fcc.xml file in a text editor.

6. Search in the file for the following string: external site access definition.

7. After the line containing this string, add the following lines:

<site id=”site number” overridable=”true”>

<parentfsc address=”URL” priority=”1”/>
</site>

Example
<site id=”101010101” overridable=”true”>
<parentfsc address=”http://tcentserver:4444/” priority=”1”/>
</site>

8. (If you have multiple Teamcenter product servers and you want to view visualization data from all
of them) Repeat the previous step for each server.

Note
• For each additional <site> entry you add to the fcc.xml file, in the <parentfsc>
tag, increment the value of the priority attribute, so that each entry has a different
priority.

• You can connect to only one server at a time.

9. Save the fcc.xml file.

10. At the command prompt, type: fccstat –start

Multiple File Management System (FMS) client caches (FCCs)

If you plan to view data from multiple Teamcenter products, such as Teamcenter, Teamcenter
engineering process management, and Teamcenter Enterprise, you may have installed multiple File
Management System (FMS) client caches (FCCs). If your machine has multiple FCCs and you want
to view visualization data from a particular product, your machine's FMS_HOME environment variable
must point to the location of the product's FMS.

To check or change the value of the FMS_HOME environment variable, do the following:

13-4 Application Administration PLM00100 12.2

 Configuring Lifecycle Visualization

Note
A TCCS/FCC stop is required before changing FMS_HOME.

Windows
1. Right-click My Computer and select Properties.

2. In the System Properties dialog box, click the Advanced tab.

3. On the Advanced page, click Environment Variables.

4. On the Environment Variables page, in the User variables section, find FMS_HOME and
verify that its path refers to the installation path of the product from which you want to load
visualization data.

5. If necessary, change the path as needed.

Example
d:\tc\12.2\tccs

Linux
1. In the shell window from which the software product was launched, type echo $FMS_HOME.
A path to the installation of that product is displayed.

2. Check the path to verify that the FMS_HOME environment variable is pointing to the right product.

3. If necessary, change the path as needed.

Example
.../tc/12.2/tccs

Installing a PostScript printer on Windows

Note
You must have administrative permission to perform this task.

After installing Lifecycle Visualization, check for the existence of a PostScript Printer entry in
the Printers section of the Control Panel. If a PostScript Printer entry does not exist, run the
InstallPrinter.bat file from the following location:
install-path\Visualization\VVCP\Driver

PLM00100 12.2 Application Administration 13-5

 Chapter
Chapter 13:13:Configuring
Configuring Lifecycle
Lifecycle Visualization
Visualization

This batch file assumes the c:\temp directory exists. If this directory does not exist, create the
directory before running the batch file, or modify the PORTNAME value near the top of the batch file
to place the psout.ps file in a directory writable by all potential users of the Lifecycle Visualization
installation. The modified PORTNAME value must be less than 40 characters in length.
If the Windows can't verify the publisher of this driver software message is displayed, click
Install this driver software anyway.

Note
For information about installing a PostScript printer on Windows 8 or Windows Server, see
the stand-alone Lifecycle Visualization Installation Guide.

Visualization preferences
The Teamcenter visualization preferences control how the Lifecycle Viewer and the stand-alone
viewers interact with Teamcenter clients. In the rich client, you can adjust the settings for these
preferences by choosing Edit→Options.
You can modify the following visualization preferences:

Use this preference To specify this

The dataset types that you can mark up with the
3DMarkup_relation_primary
3D markup tools.
The dataset types that you can mark up with the
DMI_markup_relation_primary
2D markup tools.
The mapping of Structure Manager BOM line
attributes to Lifecycle Visualization attributes.
INTEROP_ExtraPLMXMLInstance Attributes
This preference is applicable only for PLM XML
generated by the BOMWriter.
The default list of Teamcenter attributes to display
Interop_Vis_Attributes
in the viewer.
The list of allowable Teamcenter attributes that
Interop_Vis_Attributes_Admin_Filter the user can choose to have displayed in the
viewer.
Specifies the relation that has to be created when
ItemRevision_DirectModel3DMarkup
a DirectModel3DMarkup dataset is pasted under
_default_relation
an ItemRevision.
Specifies the relation that has to be created
ItemRevision_Vis_Session_default_relation when a Vis_Session dataset is pasted under an
ItemRevision.
Specifies the Item ID of the Item Revision that
MetaDataStamp_template provides the MetaDataStamp Template dataset
used to create text and watermark stamps.
The Teamcenter Occurrence Note (BOMLine
attribute key/name) used to identify an
PLM_End_Item_Key
Occurrence as an End Item for clearance
analysis.

13-6 Application Administration PLM00100 12.2

 Configuring Lifecycle Visualization

Use this preference To specify this

The list of non-VMU dataset types that can
contain VMU datasets. VMU datasets are
SecondaryVMUDatasets datasets that can be directly launched from
the rich client into the Lifecycle Viewer or a
stand-alone viewer
Reference names of 2D file types that are
TC_DIS_2D_named_ref
capable of 2D markups.
Reference names of 3D file types capable of 3D
TC_DIS_3D_named_ref
markups.
Search schemas to be used when performing a
TC_DIS_Search
search from within the viewer
Whether Lifecycle Visualization is used in
TC_Schematic_BOMView_Types
schematic mode or 3D mode.
Whether to display the Start/Open in TcVis
TC_show_open_in_vmu_button
button in the rich client.
Visualization datasets that can contain multiple
VIS_multi_file_datasettypes named references. Users can select the
reference to view in the embedded viewer.
Indicates the valid primary object type for the
VisMarkup_relation_primary
relation Visualization 3DMarkup.
Indicates the valid primary object type for the
VisSession_relation_primary
relation Visualization Session.
Datasets that can be directly launched from
VMU_Datasets the rich client into the Lifecycle Viewer or a
stand-alone viewer.
The order that reference names are used to
VMU_FileSearchOrder
search for files in ambiguous conditions.
Relations searched between visualization
VMU_RelationSearchOrder
datasets and items or item revisions.

Search schemas for the Lifecycle Viewer

By default, the following system-defined search schemas are used when searches are performed
from the file dialogs within the stand-alone viewers and the Lifecycle Viewer:
• Dataset

• Item

• Item revision

• Part

To add additional system-defined search schemas, modify the TC_DIS_Search preference.

PLM00100 12.2 Application Administration 13-7

 Chapter
Chapter 13:13:Configuring
Configuring Lifecycle
Lifecycle Visualization
Visualization

Creating text and watermark stamps using an MDS file

Overview of adding text and watermark stamps with an MDS file

As an administrator you can create an MDS stamp file to add a watermark and stamp text to all
printed images. You can specify a background color to the watermark, add headers and footers, and
modify the stamp further by using additional MDS commands.

Note
You use the MetaDataStamp Template to control the formatting styles used in text
and watermark stamps. The default MDS_default_styles_template.mds template file
is located in the TC_DATA directory in the RAC; it is imported to the database as a
dataset called MDS_default_styles_template. For information on importing a custom
MDS_default_styles_template.mds template file, see the MetaDataStamp_template
preference.

Caution
When you enable the MetaDataStamp_template preference, end-user watermark
preferences become unavailable.

The watermark MDS command operates differently from other MDS stamp commands.

• Only one \Watermark command is supported in an MDS file. However, you can enter several
other basic MDS commands that create useful watermark stamps.

• The beginning position of the watermark text always defaults to the center of the page. However,
you can modify the beginning position of the watermark by using the \Pos option.

Note
• Type each MDS command on a separate line.

• Basic text and watermarks stamps support the following replacement strings:
o %Date – date only

o %Time – time only

o %User – the user name

o %File – a file name; stamp.mds

o %FilePath – a path and file name; c:\etc\stamp.mds

o %Page – page number; 1 of 2

13-8 Application Administration PLM00100 12.2

 Configuring Lifecycle Visualization

• Invalid or non-supported MDS commands are ignored.

Create text and watermark stamps using an MDS file

1. Open a text editor and type in options from the following list:
Type this option To do this
Set the background color for text lines, including Watermarks.

Example
\BackgroundColor(Red)
\BackgroundColor(255,0,0)

Note
• Control the background color value in one of these ways:
o Enter a standard RGB value.

o Enter the exact name of one of the following

supported colors:
■ white

■ yellow

\BackgroundColor
■ cornsilk
(Color or RGB value)
■ green

■ cyan

■ sky blue

■ blue

■ midnight blue

■ purple

■ magenta

■ red

■ orange

■ salmon

PLM00100 12.2 Application Administration 13-9

 Chapter
Chapter 13:13:Configuring
Configuring Lifecycle
Lifecycle Visualization
Visualization

Type this option To do this

■ gray80

■ slate

■ gray

■ black

• For text without a background color use

\BackgroundColor(None).

Set the font size for text.

\Char(size) Example
\Char(12)

Set the color for text.

\Color(color) Example
\Color(Red)

\Date Display the system date and time.

\File Display the document path and file name.
Set the font.

\Font(name) Example
\Font(Courier)

Enter text that is displayed at the bottom of the page.

\FooterLeft
Example
\FooterCenter
\FooterRight \FooterCenter
Confidential

Set the halftone to opaque (a value of 1.0) or to transparent (a value

of 0.5).

\Halftone(1.0 or 0.5)
Example
\Halftone(0.5)

13-10 Application Administration PLM00100 12.2

 Configuring Lifecycle Visualization

Type this option To do this

Enter text that is displayed at the top of the page.

\HeaderLeft
Example
\HeaderCenter
\HeaderRight \HeaderCenter
Confidential

\Pos(x,y) Set the beginning cursor position. The default cursor position is (36,36).
Set the rotation angle of your text.

Example
\Rotate(angle)
\Rotate(45)
\Rotate(-45)

\User Display the current user ID.

Specify the watermark command on one line in the MDS file. The next
line of text includes your watermark message.

Note
• The Orientation parameter supports the following values
o (LL2UR) – lower left to upper right

o (UL2LR) – upper left to lower right

o (HORIZ) – horizontal
\Watermark
If you do not specify a value, the default, HORIZ, is used.

• You can use the value AUTO to set watermark text to be

as large as possible. If AUTO is not specified, text size
is determined by the last value in \Char, or to the default
value, \Char(12).

Example
\Watermark(HORIZ,AUTO)
Sample Text

All printed images will now contain the watermark defined by the MDS file.
MDS Watermark examples

PLM00100 12.2 Application Administration 13-11

 Chapter
Chapter 13:13:Configuring
Configuring Lifecycle
Lifecycle Visualization
Visualization

MDS text and watermark examples

An example using the \Halftone MDS command

\Color(Black)
\Font(Arial)
\Char(16)
\Pos(20,20)
\Halftone(0.5)
\BackgroundColor(Red)
Sample Text
\BackgroundColor(None)
Line of sample text.
\BackgroundColor(Purple)
\Char(36)
\Watermark(HORIZ)
6.0 Demo

An example without using the \Halftone MDS command

\Color(Black)
\Font(Arial)
\Char(16)
\Pos(-20,20)
\BackgroundColor(Red)
Sample Text
\BackgroundColor(None)
Line of sample text.
\BackgroundColor(Purple)
\Char(36)
\Watermark(HORIZ)
6.0 Demo

13-12 Application Administration PLM00100 12.2

 Configuring Lifecycle Visualization

Set the beginning cursor position for stamps with MDS files
If you create additional detailed stamps for your files by using MDS stamps, use the MDS command
/Pos(x,y) to specify the beginning cursor position of the stamp. The numeric values, x and y are
measured in point-size, where one point is equal to 1/72 of an inch.
The default starting position for all MDS text entries is the upper-left corner of the page, or a position
equal to /Pos(36,36). This means the cursor begins at a point that is 1/2 inch from the top of the
page and 1/2 inch from the left edge of the page.
You can use these additional cursor position options, as needed:

Use this
To do this
option
Position the stamp outside the stamped image and into the margin. This position
= indicator is only available for HPGL-based stamping and cannot be used with the !
position indicator. This may only be used for the vertical position.
Measure the position in point sizes (1/72 of an inch or approximately 0.35
! millimeters). Without the symbol (!), the current operating coordinate system
determines the units of measure.
Begin the cursor at the lower right-hand corner of the image. Without the symbol (–),
–
the position is measured from the upper left-hand corner.

Note
Allow enough space for the character size in the y direction to avoid truncating (cropping)
the stamp.

PLM00100 12.2 Application Administration 13-13

 Chapter
Chapter 13:13:Configuring
Configuring Lifecycle
Lifecycle Visualization
Visualization

Example
This example shows how to position the cursor 3 inches up from the bottom and 2 inches
from the right-hand edge of the page.
\pos(!-144,!-216)

Specify the orientation of text stamps with MDS files

1. Use the MDS Rotate command to specify how your stamp displayed on the page.

2. Use positive rotation values to rotate text counter-clockwise. The zero angle (or start) is the point
of intersection on the right side of a horizontal line crossing through the center of rotation. The
center of rotation is the midpoint of the height and the midpoint of the width before rotation.

Example

Type this To do this

Rotate the text 45 degrees counter-clockwise.
\Rotate(45) The text flows from the starting position on a lower left corner to
the upper right corner angle.
Rotate the text 90 degrees counter-clockwise.
\Rotate(90) The text flows from the starting position straight up the page on a
perpendicular angle.

13-14 Application Administration PLM00100 12.2

 Configuring Lifecycle Visualization

Rotate the text 90 degrees clockwise.

\Rotate(-90) The text flows from the starting position straight down the page
on a perpendicular angle.

Tip
• The angle value must be an integer.

• To prevent truncated or cropped text, be mindful of your text starting point, font size,
and rotation angle.

Add uniform watermark stamps when exporting files

As an administrator you can create an MDS stamp file to add a watermark and stamp text to all 2D
images created using Export Image. You write a text file that includes your MDS stamp information
and name it export.mds. Save this file in the \etc folder within the installation directory.You can
also set a background color to the watermark and modify the stamp further by using additional
MDS commands.

Caution
When you create and save the export.mds file, end-user watermark preferences become
unavailable.

Note
• Type each MDS command on a separate line.

• Invalid or non-supported MDS commands are ignored.

• Only one \watermark command is supported in an MDX file.

• The beginning position of the watermark text always defaults to the center of the page.
However, you can modify the beginning position of the watermark by using the \Pos
option.

• Watermark stamps support the following replacement strings:

o %Date – date only

o %Time – time only

o %User – the user name

o %File – a file name; stamp.mds

o %FilePath – a path and file name; c:\etc\stamp.mds

PLM00100 12.2 Application Administration 13-15

 Chapter
Chapter 13:13:Configuring
Configuring Lifecycle
Lifecycle Visualization
Visualization

o %Page – page number; 1 of 2

1. Open a new file in a text editor.

2. Select from the following:

Type this option To do this
Set the background color for text lines, including Watermarks.

Example
\BackgroundColor(Red)
\BackgroundColor(255,0,0)

Note
• Control the background color value in one of these
ways:
o Enter a standard RGB value.

o Enter the exact name of one of the following

supported colors:
■ white

\BackgroundColor (Color or ■ yellow

RGB value)
■ cornsilk

■ green

■ cyan

■ sky blue

■ blue

■ midnight blue

■ purple

■ magenta

■ red

■ orange

13-16 Application Administration PLM00100 12.2

 Configuring Lifecycle Visualization

Type this option To do this

■ salmon

■ gray80

■ slate

■ gray

■ black

• For text without a background color use

\BackgroundColor(None).

Set the font size for text.

\Char(size) Example
\Char(12)

Set the color for text.

\Color(color) Example
\Color(Red)

\Date Display the system date and time.

\File Display the document path and file name.
Set the font.

\Font(name) Example
\Font(Courier)

Set the halftone to opaque (a value of 1.0) or to transparent (a

value of 0.5).

\Halftone(1.0 or 0.5)
Example
\Halftone(0.5)

Set the beginning cursor position. The default cursor position is

\Pos(x,y)
(36,36).

PLM00100 12.2 Application Administration 13-17

 Chapter
Chapter 13:13:Configuring
Configuring Lifecycle
Lifecycle Visualization
Visualization

Type this option To do this

Set the rotation angle of your text.

Example
\Rotate(angle)
\Rotate(45)
\Rotate(-45)

\User Display the current user ID.

Specify the watermark command on one line in the MDS file. The
next line of text includes your watermark message.

Note
• The Orientation parameter supports the following
values
o (LL2UR) – lower left to upper right

o (UL2LR) – upper left to lower right

o (HORIZ) – horizontal
\Watermark
If you do not specify a value, the default, HORIZ,
is used.

• You can use the value AUTO to set watermark text

to be as large as possible. If AUTO is not specified,
text size is determined by the last value in \Char, or
to the default value, \Char(12).

Example
\Watermark(HORIZ,AUTO)
Sample Text

3. Name the file, export.mds, and save it to the etc folder within your installation directory.
All images saved using Export Image are saved with the uniform watermark stamp.

13-18 Application Administration PLM00100 12.2

 Configuring Lifecycle Visualization

Example
This example shows the text of a watermark stamp that is embedded on all images saved
by Export Image.
\Color(0,255,0)
\Font(Arial)
\Char(18)
\BackgroundColor(white)
\Watermark(UL2LR)
%File: Restricted Document %Time

Specify new types of visualization datasets

For visualization file types defined as dataset business objects by the Business Modeler IDEBusiness
Modeler IDE, but not associated by default with the Lifecycle Viewer and the My Teamcenter viewer,
you must configure each dataset type for display.

Note
New dataset types require unique names for each dataset type and named reference.

1. Add the names of the custom dataset types to the VMU_Datasets preference.

2. Add the names of the custom references to the VMU_FileSearchOrder preference.

3. If 2D markup layers are valid for these file types, add the names of the custom references
TC_DIS_2D_named_ref preference.

4. If 3D markup layers are valid for these file types, add the names of the custom references
TC_DIS_3D_named_ref preference.

5. (For the Lifecycle Viewer) Create entries for each dataset type in the TcViewer_properties.txt
file.

Note
The TcViewer_properties.txt file is installed to the [installation
directory]\Visualization\etc\PLMIntegration directory on client machines containing
stand-alone viewer installations. This file contains examples of properly constructed
dataset type definitions as well as comments that describe each of the necessary
parameters.

6. (For My Teamcenter) Create entries for each dataset type using the
defaultViewerConfig.VIEWERCONFIG preference.

PLM00100 12.2 Application Administration 13-19

 Chapter
Chapter 13:13:Configuring
Configuring Lifecycle
Lifecycle Visualization
Visualization

Example
To enable the viewing of NX .prt files in the My Teamcenter viewer, add the following
values to the defaultViewerConfig.VIEWERCONFIG preference:
UGMASTER.DirectModelViewer=UGPART
UGPART.DirectModelViewer=UGPART
UGALTREP.DirectModelViewer=UGPART

Specify dataset types with multiple named references

You must specify the visualization dataset types that can contain more than one named reference.
Users can view the selected named reference in the My Teamcenter embedded viewer.
• Add the names of the dataset types to the VIS_multi_file_datasettypes preference.

Configure automatic markups

Automatic markup functionality allows users to markup 2D and 3D datasets directly. Nonstandard
dataset types can also be marked up. Complete the following configuration steps to enable this
functionality within the Lifecycle Viewer and the embedded viewers that are located within Teamcenter
applications such as My Teamcenter and the Structure Manager:
1. In the Business Modeler IDE application, create a new dataset type (for example DJ_Dwg);
define the dataset type as follows:
a. In the Tools section, add the PV tool to the List of Selected Tools field.

b. Click the References button.

c. In the References dialog box, enter the name of the dataset type in the Reference box,
for example, dj_drawing.

d. Enter File in the File/Object box.

e. Enter .jpg in the File box.

f. Enter BINARY in the format box.

g. Click Create to create the new dataset type.

2. In the \com\teamcenter\rac\common\tcviewer\tcviewer.properties file, make the following

modifications:

Note
The tcviewer.properties is located in the
%IPR%\plugins\com.teamcenter.rac.common_teamcenter-version-number.jar file.

13-20 Application Administration PLM00100 12.2

 Configuring Lifecycle Visualization

a. Add the name of the newly created dataset type to the DatasetViewer.TYPES property, for
example, add DJ_Dwg.

b. Add the named reference to the DatasetViewer.VIEWSEARCHORDER property, for

example, add dj_drawing.

c. Add the VIEWPANEL for the new dataset type, for example, add Dj_Dwgcom.VIEWPANEL=
com.teamcenter.rac.common.tcviewer.TCTwoDViewer.

3. In the \com\teamcenter\rac\explorer\explorer.properties file, add the name of the new dataset

type to the explorer.CONTAINERDATASETTYPES list.

Note
The explorer.properties is located in the
%IPR%\plugins\com.teamcenter.rac.tcapps_teamcenter-version-number.jar file.

4. (For 2D markups) In the Preferences tab of the Options dialog box, accessed from the Edit
menu, modify the following preferences:
a. Add the name of the new dataset type to the TC_DIS_2D_named_ref preference.

b. Add the name of the new dataset type to the DMI_markup_relation_primary preference.

c. Add the name of the new dataset type to the VMU_Datasets preference.

d. Add the name of the new named reference (for example dj_drawing) to the
VMU_FileSearchOrder preference.

5. (For 3D markups) In the Preferences tab of the Options dialog box, accessed from the Edit
menu, modify the following preferences:
a. Add the name of the new dataset type to the TC_DIS_3D_named_ref preference.

b. Add the name of the new dataset type to the 3DMarkup_relation_primary preference.

c. Add the name of the new dataset type to the VMU_Datasets preference.

d. Add the name of the new named reference (for example dj_drawing) to the
VMU_FileSearchOrder preference.

6. In the Preferences tab of the Options dialog box, accessed from the Edit menu, create the new
dataset_type_DefaultChildProperties preference, where the dataset type is the name of the
new dataset type name, for example: DJ_Dwg_DefaultChildProperties.

Configure the Image Preview view

Use the Image Preview view to obtain quick previews of 2D raster images. Administrators
can configure 2D dataset types, reference types, and the relation search order by editing the
tcgrb.properties file.

PLM00100 12.2 Application Administration 13-21

 Chapter
Chapter 13:13:Configuring
Configuring Lifecycle
Lifecycle Visualization
Visualization

1. Open the tcgrb.properties file, which is located in the com.teamcenter.rac.tcgrb_8000.0.0

plug-in.

2. Do any of the following:

To Do this
Specify the 2D datasets to display Add 2D dataset types, separated by commas, to the
Thumbnail2DViewer.TYPES property.
Specify the named reference Add named reference types, separated by commas, to the
types to be searched within a Thumbnail2DViewer.VIEWSEARCHORDER property.
dataset for an image to display.
Only named references listed here
are valid candidates for thumbnail
display.
Specify the order in which Add relation types, separated by commas, to the
datasets are chosen when there Thumbnail2DViewer.RELATIONSEARCHORDER
are datasets attached in different property.
relations to an item revision.
Note
Images are displayed according to the order
specified here, even if there are valid 2D datasets
attached in other relations to an item revision.

Example
Thumbnail2DViewer.TYPES=Image
Thumbnail2DViewer.VIEWSEARCHORDER=Image
Thumbnail2DViewer.RELATIONSEARCHORDER=IMAN_reference,
IMAN_manifestation,IMAN_Rendering,IMAN_specification

3. Save the file, and then update the plug-in.

Configure the JT Preview

Use the JT Preview to obtain quick previews of JT parts. Administrators can configure 3D dataset
types, reference types, and the relation search order by editing the tctdv.properties file.
1. Open the tctdv.properties file, which is located in the com.teamcenter.rac.tctdv_8000.0.0
plug-in.

2. Do any of the following:

To Do this
Specify the 3D datasets to display Add 3D dataset types, separated by commas, to the
Thumbnail3DViewer.TYPES property.

13-22 Application Administration PLM00100 12.2

 Configuring Lifecycle Visualization

Specify the named reference Add named reference types, separated by commas, to the
types to be searched within a Thumbnail3DViewer.VIEWSEARCHORDER property.
dataset for a part to display. Only
named references listed here are
valid candidates for thumbnail
display.
Specify the order in which Add relation types, separated by commas, to the
datasets are chosen when there Thumbnail3DViewer.RELATIONSEARCHORDER
are datasets attached in different property.
relations to an item revision.
Note
Images are displayed according to the order
specified here, even if there are valid 3D datasets
attached in other relations to an item revision.

Example
Thumbnail3DViewer.TYPES=DirectModel,DirectModelMotion
Thumbnail3DViewer.VIEWSEARCHORDER=JTPART
Thumbnail3DViewer.RELATIONSEARCHORDER=IMAN_manifestation,
IMAN_Rendering,IMAN_specification,IMAN_Motion,IMAN_3D_snap_shot,
TC_Attaches

3. Save the file, and then update the plug-in.

Configure image preview in Relation Browser

Administrators can configure the image preview in Relation Browser by specifying the relation search
order and the view search order in the tcgrb.properties file.

1. Open the tcgrb.properties file, which is located in the com.teamcenter.rac.tcgrb_xxxx.x.x

plug-in.

2. Do any of the following.

To Do this
Specify the order in which Add relation types, separated by commas, to the
datasets are chosen when there DatasetViewer.RELATIONSEARCHORDER property.
are datasets attached in different
relations to an item revision. Note
Images are displayed according to the order
specified here, even if there are valid datasets
attached in other relations to an item revision.

PLM00100 12.2 Application Administration 13-23

 Chapter
Chapter 13:13:Configuring
Configuring Lifecycle
Lifecycle Visualization
Visualization

Specify the named reference Add named reference types, separated by commas, to the
types to be searched within a ImagePreview.VIEWSEARCHORDER property.
dataset for an image to display.
Only named references listed here
are valid candidates for image
preview display.

Example
DatasetViewer.RELATIONSEARCHORDER=IMAN_manifestation,
IMAN_Rendering,IMAN_specification,IMAN_Motion,IMAN_3D_snap_shot
ImagePreview.VIEWSEARCHORDER=UG-QuickAccess-Binary,
Graphics-Interface,Markup,Image,JPEG,BMP,Shaded-image

Note
If the first dataset found does not contain an image file, Relation Browser searches
until an image file is found.

3. Save the file, and then update the plug-in.

Configure image preview in the Summary view

Administrators can configure the image preview in the Summary view by specifying the relation
search order and the view search order in the tcviewer.properties file.
1. Open the tcviewer.properties file, which is located in the
com.teamcenter.rac.common.tcviewer plug-in.

2. Do any of the following:

To Do this
Specify the order in which Add relation types, separated by commas, to the
datasets are chosen when there DatasetViewer.RELATIONSEARCHORDER property.
are datasets attached in different
relations to an item revision. Note
Images are displayed according to the order
specified here, even if there are valid datasets
attached in other relations to an item revision.

13-24 Application Administration PLM00100 12.2

 Configuring Lifecycle Visualization

Specify the named reference Add named reference types, separated by commas, to the
types to be searched within a ImagePreview.VIEWSEARCHORDER property.
dataset for an image to display.
Only named references listed here
are valid candidates for image
preview display.

Example
DatasetViewer.RELATIONSEARCHORDER=IMAN_manifestation,
IMAN_Rendering,IMAN_specification,IMAN_Motion,IMAN_3D_snap_shot
ImagePreview.VIEWSEARCHORDER=UG-QuickAccess-Binary,
Graphics-Interface,Markup,Image,JPEG,BMP,Shaded-image

Note
If the first dataset found does not contain an image file, the system does not continue
searching the datasets until an image file is found.

3. Save the file, and then update the plug-in.

PLM00100 12.2 Application Administration 13-25

Chapter 14: Configuring Teamcenter Integration for NX

What is Teamcenter Integration for NX?

NX is an interactive Computer-Aided Design, Computer-Aided Manufacturing, and Computer-Aided
Engineering (CAD/CAM/CAE) system. The CAD functions automate the normal engineering, design,
and drafting capabilities found in today's manufacturing companies. The CAM functions provide NC
programming for modern machine tools using the NX design model to describe the finished part.
The CAE functions provide a number of product, assembly, and part performance simulation abilities
across a broad range of engineering disciplines.
Teamcenter Integration for NX is a data management tool used in conjunction with NX. When NX is
used in Teamcenter Integration for NX mode, Teamcenter is running at the same time as a separate
process. Because the two programs communicate, you can create, store, and access your data
within a Teamcenter database. It 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.

Configure NX launch application

You can configure the NX application that is launched by the Open in NX command in the rich
client and Active Workspace.

Choose an NX launch application for a rich client session

1. In the rich client, open the User Settings dialog box in one of these ways:
• Choose Edit > User Setting.

• In the application header, click the user information link.

2. From the Client Application list, choose one of the available applications.

Note
The list of available applications is controlled by the TC_NX_Application preference.

3. Click OK.

Adding NX applications to the Client Application list

The list of available applications that appears in the Client Application list on the Session tab of the
User Settings dialog box is controlled by the TC_NX_Applications preference.
By default, the TC_NX_Applications preference contains only the NX value. You can add additional
NX applications to the Client Application list by adding values to the TC_NX_Applications
preference.

PLM00100 12.2 Application Administration 14-1

 Chapter
Chapter 14:14:Configuring
Configuring Teamcenter
Teamcenter Integration
Integration for NX
for NX

Valid values include the following.

NX
NX Viewer
Simcenter 3D
Solid Edge CAM Pro
Mechatronics Concept Designer
CAM Express
CAM Single Machine Environment
NX layout
NX Learning Edition

Configuring attribute mapping

Using mapping definition files, NX part attributes can be stored in the Teamcenter database and
displayed and modified both in NX and Teamcenter. These attributes can also be opened by NX
GRIP and UG/Open, and they can be manipulated using ITK programs.

Mapping Teamcenter attributes to NX part attributes

Determine valid paths of objects

To write a mapping file, you must know how to determine valid paths from one object to the next. This
can include determining the following:
• The properties of the object.
• Which generic relationship types exist for the object.
• What named reference types exist for the object.
• What roles exist for the object.
• What release levels exist for the object and which roles are associated with each.

This information can be determined for each object from the Business Modeler IDE.
Database attributes do not have to be properties of the datasets corresponding to an NX part file.
Database attributes can also be any of the following, as specified in the mapping definition file:
• Properties of other Teamcenter objects
The mapping definition specifies how to find the object beginning with the original dataset or
related item or item revision and traversing a path from one Teamcenter object to another. The
final step in the path produces a value, which can be an integer, a double, a string, a date, or an
object. Each step may be a property, named reference, generic relationship, job, or signoff.

Note
You cannot define the attribute to be a property of an arbitrary Teamcenter object. The
object must be accessible from the original dataset, item, or item revision by a series of
steps, as described above. Examples include a user name or release date.

14-2 Application Administration PLM00100 12.2

 Configuring Teamcenter Integration for NX

• Teamcenter preference values

The mapping definition indicates the scope and name of the preference.

• Constants
The mapping definition indicates the constant value. An example of a constant is a copyright
notice.

The set of mappings that apply to a particular dataset can be dependent on the dataset type and/or
the related item type. (Teamcenter Integration for NX assumes that the dataset is attached to an item
revision for which there is always a related item.)
The mappings are stored permanently in the Teamcenter database and are available when NX is
running in Teamcenter Integration for NX mode. These mappings are not available in native NX
sessions.
Mappings can be either real mappings or test mappings. Real mappings are those that the user
can view within the application. Test mappings are used to verify the accuracy of the mapping file
before implementation.
Each mapping definition has a title and description that are used when displaying the attribute value
in NX. There are also optional qualifiers that affect the behavior of the mapping, such as which
application has write control and whether a default value is created for an NX part file attribute if
none exists in Teamcenter.
For more information about implementing attribute synchronization from Teamcenter Integration for
NX, see the Teamcenter Integration for NX documentation in the NX Help.

Additional definition for attributes when mapping

Some attributes may require a more specific attribute mapping definition. Starting in Teamcenter
Integration for NX 6.0.3, attribute mappings are resolved at startup without the objects to which
they apply.
If you have mappings that are not working, check the syslog for messages that are similar to the
following:
Attribute (%s) is not unique. You must supply optional parameters in
the mapping definition (%s) to resolve without an object.

In these cases, you need to provide a more specific mapping definition. For example, the following
mapping definition may no longer be valid:
Last_Modifying_User : last_mod_user /description=”Last Modifying User”

To resolve this mapping problem, append last_mod_user with user_id and user_name as follows to
specifically identify the attribute that is being mapped:
Last_Mod_User_ID : last_mod_user.user_id /description=”Last Mod User ID”
Last_Mod_User_Name : last_mod_user.user_name /description=”Last Mod User Name”

PLM00100 12.2 Application Administration 14-3

 Chapter
Chapter 14:14:Configuring
Configuring Teamcenter
Teamcenter Integration
Integration for NX
for NX

Note
If the properties of a Teamcenter attribute are modified, for example by adding a list of
values (LOV) to the Item name attribute of a child business object of the item business
object, then the attribute has a new definition and is no longer inherited, and neither is its
mapping inherited. In order for the newly defined attribute to map, it must be added to the
mapping file. This is true even for properties for which there are default mappings.

Default mappings
The default hard-wired mappings between Teamcenter and NX part attributes are described in the
following table. Default hard-wired attribute mappings cannot be deleted.

UG part
attribute Description Corresponding Teamcenter attribute

DB_PART_NO Part number Item ID

DB_PART_REV Part revisions Item revision ID

DB_PART_TYPE Part type Item type

DB_UNITS Part unit of Item unit of measure

measure

Note
If the properties of a Teamcenter attribute are modified, for example by adding a list of
values (LOV) to the Item name attribute of a child business object of the item business
object, then the attribute has a new definition and is no longer inherited, and neither is its
mapping inherited. In order for the newly defined attribute to map, it must be added to the
mapping file. This is true even for properties for which there are default mappings.

Mapping Classification attributes to NX part attributes

Synchronization of NX part file attributes between Classification and Teamcenter Integration for NX
uses the attribute mapping syntax described in Mapping syntax for Classification and Mapping syntax
for Teamcenter. Classification attribute synchronization supports all types of Classification attributes,
including: integer, real, double, string, date, variable length array (VLA), and key LOV.

Attribute synchronization

How attribute synchronization works

Synchronization allows an attribute in one application to be updated automatically when a modification
is made to the corresponding attribute in another application. The synchronization of attributes

14-4 Application Administration PLM00100 12.2

 Configuring Teamcenter Integration for NX

between Teamcenter Integration for NX, Teamcenter, and Classification occurs when a part file is
imported or exported from Teamcenter Integration for NX. The Teamcenter and Classification attribute
values are updated immediately; however, the NX part attribute values are not updated until the
part is opened.
Before implementing attribute synchronization, read and understand the required attribute mapping
syntax described in Mapping syntax for Teamcenter.
The Sync Part Attributes option initiates attribute synchronization. You can suppress the display
of this option by setting the showUGSynAttrChecckbox preference to False. This preference is
located in the userpreferences.properties file, which can be accessed by unzipping the portal.jar
file located in the com.teamcenter.rac.tc.commands.userpreferences directory.
Mapping to any master form for any item objects (the Item Master form) results in one-way
synchronization from Teamcenter to NX.

Monodirectional and bidirectional synchronization

Synchronization can be monodirectional or bidirectional. Siemens PLM Software strongly

recommends you do not use both methods in parallel on the same database.
To define the synchronization as being monodirectional, set the UGII_UGMGR_ATTR_SYNC
Teamcenter Integration for NX environment variable, located in the .ugii_env file, to Old.
Bidirectional synchronization includes the following behavior:
• Mapping to any master form for any item object (the Item Master form) for customer-defined
object types (such as ENDITEM) results in a one-way mapping from Teamcenter to NX. Siemens
PLM Software recommends avoiding mapping to the Item Master form and mapping only in cases
where the values do not require modification in NX.

• Using the qualifier iman always prevents bidirectional synchronization. Use the qualifier both, or
no qualifier at all, to create bidirectional synchronization.

By default, attributes mapped to the properties of the Item or any form attached to items (not item
revisions) are synchronized from Teamcenter to Teamcenter Integration for NX; but not in the reverse
direction. These attributes are read-only in Teamcenter Integration for NX.
Set the TC_NX_allow_attrsync_master_with_item preference to Yes to permit mapping in the
reverse direction (Teamcenter Integration for NX to Teamcenter). Use this setting to synchronize
properties that are common to items but not to item revisions.
However, synchronizing properties on the item level may lead to loss of data. When multiple item
revisions exist (Rev/A, Rev/B, Rev/C, and so on) and an item-level attribute is modified, the last item
revision that is saved overwrites any attribute values that previously existed at the item level. For
example, if a user working on Rev/A sets Item-Level-attribute-user_data_1 to 32 and saves the
part, the form stored at the item level for user_data_1 displays 32. If a user working with Rev/C
changes Item-Level-attribute-user_data_1 to 45 and saves the part, attribute synchronization
overwrites the existing 32 with 45. When any user re-opens Rev/A or reloads the database attributes,
the value displayed is 45, not the value previously stored with Rev/A (32).

PLM00100 12.2 Application Administration 14-5

 Chapter
Chapter 14:14:Configuring
Configuring Teamcenter
Teamcenter Integration
Integration for NX
for NX

Caution
Attributes mapped to the properties of the Item or any form attached to items and
synchronized from Teamcenter Integration for NX to Teamcenter allows multiple item
revision objects (Rev/A, Rev/B, Rev/C, and so on) to overwrite the values stored on the
Item or any form at the item level. Only synchronize properties that are common to items
but not to item revisions.

NULL value synchronization

By default, Teamcenter Integration for NX and Teamcenter prevent synchronization of null values.
Thus, overwriting an existing value with a null value is not supported by default. This restriction
is independent of synchronization direction (Teamcenter Integration for NX to Teamcenter, or
Teamcenter to Teamcenter Integration for NX). It is also independent of the synchronization master
settings stored in the synchronization mapping file.
This default restriction provides safety for your data.
Null values can be synchronized by setting the attribute mapping qualifier to allow_null_value. Use
this synchronization method with care.

Example
An NX part has an attribute that contains a value. The part has not been synchronized to
the database.
You create a mapping definition to synchronize the attribute to a master form and include
allow_null_value in the definition. Mapping to any master form for any item objects (the
Item Master form) results in one-way synchronization from Teamcenter to Teamcenter
Integration for NX.
When the part is synchronized, then the value for the attribute in this part file is removed,
replaced by the null value in the database, which did not yet have an actual value for the
attribute.

Extending attribute mappings

Mappings of NX part attributes to Teamcenter and Classification are stored in the Teamcenter
database and are extended by importing a modified mapping definition file into the database. The
existing file is overwritten each time a new file is imported.

Note
Siemens PLM Software recommends that this task be performed when all users are logged
off of Teamcenter Integration for NX. If this is not possible, any users who were logged
on to Teamcenter Integration for NX at the time the new mapping file was imported must
log off and log on again.
For more information, see the Teamcenter Integration for NX documentation in the NX Help.

14-6 Application Administration PLM00100 12.2

 Configuring Teamcenter Integration for NX

1. Export the existing mapping to a text file, using the export_attr_mappings utility.

2. Edit the file to add, remove, or modify mappings according to the syntax described in Mapping
syntax for Classification and Mapping syntax for Teamcenter.

3. Import the mapping file as a test file, using the import_attr_mappings utility. This allows you to
verify the attribute mappings without affecting the existing mapping.

4. Verify the test mappings.

Set TC_USE_TEST_ATTR_MAPPINGS to any value. This causes Teamcenter to access the
test mappings rather than the real mappings.
When running with test mappings, Teamcenter provides extra information in the syslog log file to
aid you in repairing invalid mappings, as shown in the following example:
Ifail 60003 meaning "Unresolvable mapping definition "%1$s"":
failed to resolve mapping "DB_UNITS" :
"Item.uom_tag.symbol" for rev0 00000f02 of dataset 00000f05

While such information does not necessarily indicate an invalid mapping (in this example, the
mapping failed simply because the item had no unit of measure), it can aid you in determining
the validity of a file.

For more information about implementing attribute synchronization from Teamcenter Integration for
NX, see the Teamcenter Integration for NX documentation, delivered with NX.

Syntax for mapping attributes with Teamcenter Integration for NX

Mapping syntax for Teamcenter

There are three syntactical forms for the specification of a Teamcenter attribute mapping, as follows:
Part-Attr-Name : Path Teamcenter–Property [Qualifier*]
Part-Attr-Name : Abbreviated-Path Teamcenter–Property [Qualifier*]
Part-Attr-Name : Constant [Qualifier*]

The syntax definitions are as follows:

Part-Attr-Name
Specifies the name of a NX part attribute.
Path
Specifies a series of Teamcenter objects denoting a traversal path starting from the dataset object
that represents the corresponding NX part file. Notice that the dataset object does not appear
explicitly in the mapping; rather, it implicitly precedes the path.
It is further defined as Path = [Teamcenter-Step . ]* where Teamcenter-Step is one of the following:

PLM00100 12.2 Application Administration 14-7

 Chapter
Chapter 14:14:Configuring
Configuring Teamcenter
Teamcenter Integration
Integration for NX
for NX

GRM ( relationship-type [, Specifies a GRM relation whose type is relation-type, whose

object-type]) primary object is the current object, and whose secondary
object gives the next object. Although the second argument
object-type is optional, setting object-type is recommended to
avoid potential mapping errors.

In the case that more than one relation of the given type is
associated with the current object, the optional second argument
object-type is used to identify the type of the referenced object.

NR ( named-reference-type [, Specifies a named reference of the current object. The particular

form-type]) reference is identified by the type of the referenced object
named-reference-type (not the name of the reference).

SIGNOFF ([ level, ] role) Specifies a completed signoff whose group members’ roles have
the name role. If the same role has been specified for assignees
in more than one level of the process definition, the optional
argument level further identifies a specific level.

Item revision Specifies the item revision object that owns the current object.
That is, the item revision to which the current object is associated
via a GRM link.

Item Specifies the item object corresponding to the current owning

item revision object.

Job Specifies the job in which the current object is included; or, if
there is no current job, then the most recent job that the object
was in (assuming the job has not been deleted).

Property
Specifies the name of a Teamcenter property, representing a named property of the current
object in the object path.

Teamcenter-Property
Specifies the name of the Teamcenter property to be synchronized with the NX part attribute.

Qualifier
Specifies various controls or conditions for the particular attribute synchronization and can be any
one of the following:

/master=cad Allows Teamcenter to change the value and save the change, but when
opened in NX the change made in Teamcenter is ignored and the previous
value stored in NX is used.

/master=iman Prevents NX from trying to change the value (this is equivalent to none).

/master=both Allows NX to change the value and save the change. When reading the
value, if the values in NX and Teamcenter differ, the Teamcenter value
takes precedence unless it is empty.

/master=none Prevents NX from changing the value.

14-8 Application Administration PLM00100 12.2

 Configuring Teamcenter Integration for NX

/required Forces NX users to supply a value for the attribute. The NX attribute
pane displays a red asterisk next to the input field to signify that the
attribute is required. If the attribute does not contain a value, NX displays
a warning when the File→Save option is used. The part is not saved to
the database until all attributes in the mapping file identified as required
have been specified.
/description= note Enables NX to display the content of note, which is a character string
enclosed in single or double quotation marks, to show the user the
significance of the attribute.
/freezable Directs NX to ignore the Teamcenter attribute value, as stored in the
Teamcenter database, but to use the value stored in the part file if the
related Teamcenter object is frozen.
/allow_null_value Allows overwriting an existing value with a null value. This restriction is
independent of synchronization direction (NX to Teamcenter or Teamcenter
to NX).

Example
An NX part has an attribute that contains a value. The part has
not been synchronized to the database.
You create a mapping definition to synchronize the attribute
to a master form and include allow_null_value in the
definition. Mapping to any master form for any item objects
(the Item Master form) results in one-way synchronization from
Teamcenter to Teamcenter Integration for NX.
When the part is synchronized, then the value for the attribute
in this part file is removed, replaced by the null value in the
database, which did not yet have an actual value for the
attribute.

Abbreviated-Path
Represents an abbreviation for a specific object traversal path in Teamcenter. These
abbreviations apply only to the shipped Item item type, and its associated Item Revision.
These shorthand notations do not function for any custom item types. There are two possible
abbreviations:
IM This is an abbreviation for Item.GRM(IMAN_master_form, Item Master).
IRM This is an abbreviation for Item Revision.GRM(IMAN_master_form, Item
Master).

Note
Abbreviated paths can not be used when referencing custom types.

PLM00100 12.2 Application Administration 14-9

 Chapter
Chapter 14:14:Configuring
Configuring Teamcenter
Teamcenter Integration
Integration for NX
for NX

Constant
Represents a constant value specification that the NX part attribute assume. Its specification is
CONST value where value is a character string enclosed in single or double quotation marks.
PREF ( [scope :] value )
Produces the given preference value, optionally, within the given preference scope. The scope
can be one of the following:
• ENV
• USER
• ROLE
• GROUP
• SITE

For more information about implementing attribute synchronization from Teamcenter Integration for
NX, see the Teamcenter Integration for NX documentation in the NX Help.

Comments and contexts symbols

Comments are introduced by the pound sign (#). Anything on the line after this symbol is not part of
the mapping definition and is ignored.
Contexts begin with the left bracket ({) followed by a context specifier which states the context for the
following mappings, either dataset type or item type context, as follows:
Dataset type = dataset-type

or
Item type = item-type

Contexts end with the right bracket (}).

Contexts can be nested. For example, you can define an item type-based context within a dataset
type-based context. The mappings defined within this nested context are then only applied to
datasets of the specified type that are associated with items of the specified type.
Mappings that are not defined in a specific context apply to the global context and thus apply to
any dataset type and/or item type.
In any given context, you cannot define two mappings with the same title; however, you can do this in
different contexts and the context-specific mapping overrides the less specific mapping.
For example:
CHECK_DATE : ItemRevision.Job.SIGNOFF(Checker).decision_date
/master=iman
/description=”Check Date”
APPROVAL_DATE : ItemRevision.Job.SIGNOFF(Approver).decision_date
/master=iman
/description=”Approval Date”
COPYRIGHT_CLAUSE : CONST(“Copyright Unigraphics Solutions Ltd 2001”)
OWNER_ID : owning_user.user_id /description=”Owning user id”
PROJECT_ID : IM.project_id /master=iman /description=”Project Identifier”
{Dataset type=UGMASTER
REV_NAME : ItemRevision.object_name /description=”Revision Name”
{Item type=Item

14-10 Application Administration PLM00100 12.2

 Configuring Teamcenter Integration for NX

REV_DESCRIPTION : ItemRevision.object_desc
/description=”Revision Description”
}
}

Mapping examples
The following examples illustrate how to map attributes for both custom and shipped item types. The
examples are based on the syntax described in Mapping syntax for Teamcenter. It is important
to note that when working with custom types, only the full path syntax method can be used. The
abbreviated path does not support custom types. Using the abbreviated path syntax for a custom
type always fails to synchronize the value. The system does not display an error message upon
running the import_attr_mappings utility. No message regarding this condition displays upon
opening the part or listing the attributes in NX or Teamcenter.
By default, attributes mapped to the properties of the Item or any form attached to items (not item
revisions) are synchronized from Teamcenter to Teamcenter Integration for NX; but not in the reverse
direction. These attributes are read-only in Teamcenter Integration for NX.
Set the TC_NX_allow_attrsync_master_with_item preference to Yes to permit mapping in the
reverse direction (Teamcenter Integration for NX to Teamcenter). Use this setting to synchronize
properties that are common to items but not to item revisions.
However, understand that synchronizing properties on the item level may lead to loss of data. When
multiple item revisions exist (Rev/A, Rev/B, Rev/C) and an item-level attribute is modified, the last
item revision that is saved overwrites any attribute values that previously existed at the item level.
For example, if a user working on Rev/A sets Item-Level-attribute-user_data_1 to 32 and saves
the part, the form stored at the item level for user_data_1 displays 32. If a user working with Rev/C
changes Item-Level-attribute-user_data_1 to 45 and saves the part, attribute synchronization
overwrites the existing 32 with 45. When any user re-opens Rev/A or reloads the database attributes,
the value displayed is 45, not the value previously stored with Rev/A (32).

Caution
Attributes mapped to the properties of the Item or any form attached to items and
synchronized from Teamcenter Integration for NX to Teamcenter allows multiple item
revision objects (Rev/A, Rev/B, Rev/C, and so on) to overwrite the values stored on the
Item or any form at the item level. Only synchronize properties that are common to items
but not to item revisions.

Example 1
In the following example, user_data_1 is mapped as SUPPLIER_GRM to the ItemMaster form using
the full path name. The attribute user_data_2 is mapped as supplier_grm2 to the ItemMaster form,
also using the full path name. Custom item type definitions (and their associated attributes) must
be nested with the owning dataset.
{ Dataset type="UGMASTER"
{ Item type="Basket_Part"
SUPPLIER_GRM : Item.GRM(TC_master_form,Basket_PartMaster).
user_data_1 /master=cad/allow_null_value/description="Supplier GRM"
SUPPLIER_GRM2 : Item.GRM(TC_master_form,Basket_Part Master).

PLM00100 12.2 Application Administration 14-11

 Chapter
Chapter 14:14:Configuring
Configuring Teamcenter
Teamcenter Integration
Integration for NX
for NX

user_data_2 /master=cad/both /allow_null_value /description=”supplier_grm2”

}
}

Example 2
To map standard item types along with custom item types, use the following syntax. The syntax in
the example below states that UGMASTER owns the Item item type, which owns the user_data_3
attribute. Item also owns the Basket_Part item type, which owns the user_data_2 and user_data_1
attributes.
{ Dataset type="UGMASTER"
Item type=Item
Supplier_grm3 : IRM.user_data_3 /master=both /description=“supplier_grm3”
{ Item type="Basket_Part"
supplier_grm2 : Item.GRM(TC_master_form,Basket_Part Master).
user_data_2 /master=cad /description="supplier_grm2"
SUPPLIER_GRM : Item.GRM(TC_master_form,Basket_Part Master).
user_data_1 /master=cad /description="Supplier GRM"
}
}

Example 3
To see values synchronized from a UGPART specification onto a form, map the UGPART
attributes to the Named References, UGPART-ATTR form. The system finds the form using the
Named References, UGPART-ATTR reference, which points to the UGPART type using the
IMAN_specification relation. (This relation is defined automatically when the UGPART is created in
either Teamcenter or NX.)
DATASET_MATERIAL : NR( UGPART-ATTR ). material/master=
both/allow_null_value/description=”Material in a Dataset Form”

In this example, the attribute named material is an attribute shipped with Teamcenter and already
associated with the UGPART-ATTR properties form. To view the other attributes shipped with
Teamcenter and automatically associated with this form, go to the Business Modeler IDE application,
expand the Form node in the Types tree, and select UGPartAttr. The attributes associated with this
form display in the Name column. Alternatively, view the attributes in the Business Modeler IDE
application under the POM class UGPartAttrStorage.

Mapping syntax for Classification

The syntax for the specification of an Classification attribute mapping is as follows:
Part-Attr-Name : Path Target.ICS (Classification-Attr-ID[:VLA-POS]) [Qualifier *]
The syntax definitions are as follows:
Part-Attr-Name
Name of an NX part attribute.

14-12 Application Administration PLM00100 12.2

 Configuring Teamcenter Integration for NX

Path
Specifies a series of Teamcenter engineering process management objects denoting a traversal
path starting from the dataset object that represents the corresponding NX part file. Notice that
the dataset object does not appear explicitly in the mapping; rather, it implicitly precedes the path.
It is further defined as Path = [Teamcenter-Engineering Process Management-Step .]* where
Teamcenter-Engineering Process Management-Step is one of the following:
Qualifier
Specifies various controls or conditions for the particular attribute synchronization and can be any
one of the following:
/master=cad Only NX is allowed to modify the attribute value.
/master=iman Only Teamcenter engineering process management is allowed to modify
the value for the attribute.
/master=both Both Teamcenter Integration for NX and Teamcenter engineering process
management can modify the attribute value.
/master=none Neither Teamcenter Integration for NX or Teamcenter engineering process
management can modify the attribute value.
/description= note NX displays the content of note, which is a character string enclosed in
single or double quotation marks, to show the user the significance of
the attribute.
/freezable Directs NX to ignore the Teamcenter engineering process management
attribute value, as stored in the Teamcenter engineering process
management database, but to use the value stored in the part file if the
related Teamcenter engineering process management object is frozen.
/allow_null_value Allows overwriting an existing value with a null value. For example, say
there is an NX part with an attribute containing a value (4); this value
is important to NX users. The part has not been synchronized to the
database. You create a mapping definition to synchronize the attribute. If
null values were synchronized, the value for the attribute in this part file
would be removed; replaced by the null value in the database, which did
not yet have an actual value for the attribute.
This restriction is independent of synchronization direction (NX to
Teamcenter engineering process management, or Teamcenter engineering
process management to NX).
Target
Defines the target object to be classified by Classification. The target can only be either an item
or an item revision.
(Classification-Attr-ID)
Defines the attribute ID of the Classification attribute to be synchronized. The ID must be an
integer with a value either greater than 999 or less than –999.
[:VLA-POS]
(Optional) Maps multiple NX attributes to a single Classification attribute that contains multiple
fields (VLA attribute).

PLM00100 12.2 Application Administration 14-13

 Chapter
Chapter 14:14:Configuring
Configuring Teamcenter
Teamcenter Integration
Integration for NX
for NX

The syntax for the Classification attribute specification is basically an extension from the Teamcenter
engineering process management attribute mapping syntax, as follows:
Part-Attr-Name : Path Teamcenter–Engineering Process Management-Property [Qualifier*]

For example:
AREA : ItemRevision.ICS(6128) /description=”Area” /master=cad
base_length : ItemRevision.ICS(5898) /description=”V-Block Base Length”
Vblock_name : Item.ICS(1306) /description=”V-Block Name” /master=iman
Project_id : Item.ICS(-1234) /master=iman /description=”Project Identifier”

For more information about implementing attribute synchronization from Teamcenter Integration for
NX, see the Teamcenter Integration for NX documentation in the NX Help.

Automatically classifying items and item revisions while creating parts

You can use the attribute mapping of the ICS_CREATE type to automatically classify the item or item
revision of a newly created part. The value of this attribute in NX is the Classification class ID (or
class ID::subclass ID in the case of a Classification subclass) of where you want the classification
object created. The syntax for the DEFINITION argument is:
attribute name in NX : Item.ICS_CREATE(number)
or
attribute name in NX : ItemRevision.ICS_CREATE(number)
You can choose any attribute name for NX. You must use ICS_CREATE(1) for the first context object
created, ICS_CREATE(2) for the second, and so on. For example:
ICO_Number_1 : Item.ICS_CREATE(1)
In NX, you see the part attribute ICO_Number_1 where you can assign the appropriate classification
class ID. In Teamcenter, a new classification object classifying the item containing the NX part
appears in the specified class.

Troubleshooting
The following table lists common issues that may arise when mapping attributes and using attribute
synchronization:

Symptom Probable cause Action

The following message is in the NX interprets that attribute Upgrade the Teamcenter
syslog log file: mapping is enabled and database.
+++Failed to get Teamcenter does not.
global mapping at startup.

The following message is in the A user without system Change the setting of the
syslog log file: administration privilege TC_USE_TEST_ATTR_MAPPINGS
+++Failed to get attempted to use the test preference, or run Teamcenter
global mapping at startup.
Contents of the error store:- mappings. Integration for NX from
ERROR 60011 Only SAs may use
the test mappings
an account with system
+++Failed to load mappings
from database
administration privileges.

14-14 Application Administration PLM00100 12.2

 Configuring Teamcenter Integration for NX

Symptom Probable cause Action

A form attribute always displays The system is attempting to use Determine whether the relevant
in NX as No Value Set, even a file-based form. form type is file-based or
after you have attempted to set class-based.
it.
Forms are class based if there is
a name in the Form Definition
Class box of the Form Type
dialog box.
Convert the form type, if
necessary.
The attribute always displays An invalid mapping file Verify the mapping file, as
in NX as No-value-set, even component. described in Determine valid
after an apparently successful paths of objects.
save. If the mapping is a test
mapping, running in test mode
generates unexpected and
consistent messages in the
syslog log file about failure to
resolve the mapping.
An attribute is not modifiable in By default, Teamcenter restricts A modifiable attribute must be
NX though you think it should the attributes that are potentially one of the following:
be. modifiable in NX and the
mapping file is unable to • A property of a dataset
override this restriction. • A property of any form that
is a named reference of
Change the default behavior by the specific dataset, and no
setting the other dataset
TC_NX_allow_attrsync_
master_with_item site Additionally, if the dataset is a
preference to Yes. This master dataset, a modifiable
allows attributes mapped to attribute must be:
the properties of the Item
or any form to synchronize • A property of the related
bidirectionally between item revision
Teamcenter Integration for • A property of the related
NX and Teamcenter. item revision master form

where a master dataset is one

that has type UGMASTER and
is attached to an item revision
via a specification relationship.
Alternatively, the attribute may
not be modifiable due to access
controls.
An attribute is not modifiable in The /master=value qualifier Modify the mapping definition
NX though you think it should may be missing in the mapping file.
not be. definition.

PLM00100 12.2 Application Administration 14-15

Siemens Industry Software

Headquarters
Europe
Granite Park One
Stephenson House
5800 Granite Parkway
Sir William Siemens Square
Suite 600
Frimley, Camberley
Plano, TX 75024
Surrey, GU16 8QD
USA
+44 (0) 1276 413200
+1 972 987 3000

Asia-Pacific
Americas
Suites 4301-4302, 43/F
Granite Park One
AIA Kowloon Tower, Landmark East
5800 Granite Parkway
100 How Ming Street
Suite 600
Kwun Tong, Kowloon
Plano, TX 75024
Hong Kong
USA
+852 2230 3308
+1 314 264 8499

About Siemens PLM Software

© 2019 Siemens Product Lifecycle Management

Siemens PLM Software, a business unit of the Siemens
Software Inc. Siemens and the Siemens logo are
Industry Automation Division, is a leading global provider
registered trademarks of Siemens AG. D-Cubed,
of product lifecycle management (PLM) software and
Femap, Geolus, GO PLM, I-deas, Insight, JT, NX,
services with 7 million licensed seats and 71,000 customers
Parasolid, Solid Edge, Teamcenter, Tecnomatix and
worldwide. Headquartered in Plano, Texas, Siemens
Velocity Series are trademarks or registered trademarks
PLM Software works collaboratively with companies
of Siemens Product Lifecycle Management Software
to deliver open solutions that help them turn more
Inc. or its subsidiaries in the United States and in other
ideas into successful products. For more information
countries. All other trademarks, registered trademarks
on Siemens PLM Software products and services, visit
or service marks belong to their respective holders.
www.siemens.com/plm.