TEAMCENTER

Teamcenter
Installation on
Windows
Teamcenter 14.2
Unpublished work. © 2022 Siemens

This Documentation contains trade secrets or otherwise confidential information owned by Siemens Industry Software Inc. or
its affiliates (collectively, “Siemens”), or its licensors. Access to and use of this Documentation is strictly limited as set forth in
Customer’s applicable agreement(s) with Siemens. This Documentation may not be copied, distributed, or otherwise disclosed
by Customer without the express written permission of Siemens, and may not be used in any way not expressly authorized by
Siemens.

This Documentation is for information and instruction purposes. Siemens reserves the right to make changes in specifications
and other information contained in this Documentation without prior notice, and the reader should, in all cases, consult
Siemens to determine whether any changes have been made.

No representation or other affirmation of fact contained in this Documentation shall be deemed to be a warranty or give rise to
any liability of Siemens whatsoever.

If you have a signed license agreement with Siemens for the product with which this Documentation will be used, your use of
this Documentation is subject to the scope of license and the software protection and security provisions of that agreement. If
you do not have such a signed license agreement, your use is subject to the Siemens Universal Customer Agreement, which
may be viewed at https://www.sw.siemens.com/en-US/sw-terms/base/uca/, as supplemented by the product specific terms
which may be viewed at https://www.sw.siemens.com/en-US/sw-terms/supplements/.

SIEMENS MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS DOCUMENTATION INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT OF
INTELLECTUAL PROPERTY. SIEMENS SHALL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL OR
PUNITIVE DAMAGES, LOST DATA OR PROFITS, EVEN IF SUCH DAMAGES WERE FORESEEABLE, ARISING OUT OF OR RELATED TO
THIS DOCUMENTATION OR THE INFORMATION CONTAINED IN IT, EVEN IF SIEMENS HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

TRADEMARKS: The trademarks, logos, and service marks (collectively, "Marks") used herein are the property of Siemens or other
parties. No one is permitted to use these Marks without the prior written consent of Siemens or the owner of the Marks, as
applicable. The use herein of third party Marks is not an attempt to indicate Siemens as a source of a product, but is intended to
indicate a product from, or associated with, a particular third party. A list of Siemens’ Marks may be viewed at:
www.plm.automation.siemens.com/global/en/legal/trademarks.html. The registered trademark Linux® is used pursuant to a
sublicense from LMI, the exclusive licensee of Linus Torvalds, owner of the mark on a world-wide basis.

About Siemens Digital Industries Software

Siemens Digital Industries Software is a leading global provider of product life cycle management (PLM) software and services
with 7 million licensed seats and 71,000 customers worldwide. Headquartered in Plano, Texas, Siemens Digital Industries
Software works collaboratively with companies to deliver open solutions that help them turn more ideas into successful
products. For more information on Siemens Digital Industries Software products and services, visit www.siemens.com/plm.

Support Center: support.sw.siemens.com

Send Feedback on Documentation: support.sw.siemens.com/doc_feedback_form

 Contents

Installing Teamcenter with Active Workspace 1-1

Part I: Plan the Teamcenter Environment

Where to start
Get documentation ───────────────────────── 2-1
Get Deployment Center ──────────────────────── 2-2
Get software ──────────────────────────── 2-3
Get started ───────────────────────────── 2-5

Teamcenter architecture
The Teamcenter environment ───────────────────── 3-1
Environment and architecture types ────────────────── 3-3

Design the Teamcenter environment

System requirements ───────────────────────── 4-1
How many servers do I need? ───────────────────── 4-4
Planning File Management System installation ───────────── 4-6
Overview of FMS installation ─────────────────────── 4-6
Installing the FMS server cache ────────────────────── 4-7
Installing the FMS client cache ────────────────────── 4-11
Web tier dependencies and application integrations ────────── 4-12

Part II: Build the Teamcenter Environment

Prerequisite software and settings

Create user accounts and directories ────────────────── 5-1
Gather required information ───────────────────── 5-3
Configure language support ───────────────────── 5-4
Teamcenter localizations provided by Siemens Digital Industries Software ──── 5-4
Choose the character set for Teamcenter ────────────────── 5-5
Verify that your locale is supported ───────────────────── 5-7
Configuring a UTF-8 environment for Teamcenter ────────────── 5-7
Configuring a non-UTF-8 environment for Teamcenter ──────────── 5-10

Installing a database server

Install a database server ─────────────────────── 6-1
Install and configure Oracle ────────────────────── 6-1
Preparing the Oracle server ──────────────────────── 6-1
Upgrade an Oracle server and database ─────────────────── 6-2

Teamcenter Installation on Windows, Teamcenter 14.2 3

© 2022 Siemens
 Install Oracle server ─────────────────────────── 6-6
Configure Oracle software ──────────────────────── 6-8
Create an Oracle database ──────────────────────── 6-10
Install and configure Microsoft SQL Server ────────────── 6-15
Install Microsoft SQL Server ─────────────────────── 6-15
Create an SQL Server database ────────────────────── 6-18

Installing Teamcenter Licenses

Obtain a Teamcenter license file ─────────────────── 7-1
Install the License Server ─────────────────────── 7-2

Installing Security Services

Install the Web Application Manager for Security Services ──────── 8-1
Install Security Services web applications ─────────────── 8-3
Installing the Security Services Session Agent ───────────── 8-7
Install the Session Agent ───────────────────────── 8-7
Configure the Session Agent ──────────────────────── 8-9
Enabling digital signature support in the Session Agent ─────────── 8-10
Moving to a new version of Security Services ───────────── 8-12

Part III: Test the Teamcenter Environment

Installing a Teamcenter corporate server

Create a Teamcenter environment using Deployment Center ────── 9-1
Install a Teamcenter corporate server using TEM ─────────── 9-12
Complete the Teamcenter server installation ───────────── 9-20
Start database daemons ───────────────────────── 9-20
Configure heterogeneous operating system environment ────────── 9-21

Installing server-side components

Install the Teamcenter web tier ─────────────────── 10-1
Install the .NET web tier application ──────────────────── 10-1
Install the Java EE web tier application ─────────────────── 10-6
Install the server manager ───────────────────── 10-10
Install a volume server ─────────────────────── 10-13

Installing Teamcenter microservices

Microservices and the microservice framework ──────────── 11-1
Install microservices using TEM ─────────────────── 11-2
Install microservices using TEM ────────────────────── 11-2
Add microservice framework support to a Java EE web tier ────────── 11-7
Add microservice framework support to a .NET web tier ─────────── 11-10
Install microservices using Deployment Center ──────────── 11-12
Install microservices using Deployment Center ─────────────── 11-12
Add microservices and microservice nodes ──────────────── 11-15

4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Contents

Manage microservice instances ─────────────────── 11-15

Finding microservice logs ────────────────────── 11-16
Redirect microservice logs ───────────────────── 11-16
Securing microservices ─────────────────────── 11-18
Configuring HTTPS for microservices traffic ──────────────── 11-18
Configure service dispatcher as an HTTPS server ────────────── 11-19
High availability for microservices ────────────────── 11-25

Installing Active Workspace

Active Workspace components installation overview ────────── 12-1
Active Workspace Server Extensions ───────────────── 12-2
Server Extensions overview ─────────────────────── 12-2
Install Server Extensions features ───────────────────── 12-4
Install database triggers manually ───────────────────── 12-5
Active Workspace client components ───────────────── 12-8
Active Workspace client overview ───────────────────── 12-8
Install Active Workspace microservices ─────────────────── 12-9
Install Active Workspace Gateway ──────────────────── 12-11
Install the Active Workspace client ──────────────────── 12-17
Sign in using the Active Workspace interface ─────────────── 12-19
Indexing ───────────────────────────── 12-21
Prepare to install indexing ─────────────────────── 12-21
Configure Classification Search (optional) ───────────────── 12-22
Install Dispatcher ───────────────────────── 12-22
Visualization Server ──────────────────────── 12-23
Visualization Server overview ────────────────────── 12-23
Should I use client-side or server-side rendering? ────────────── 12-25
Should I use MMV? ─────────────────────────── 12-26
Visualization Server Manager ────────────────────── 12-27
Visualization Server Pool Assigner ──────────────────── 12-39
Visualization Data Server (optional) ─────────────────── 12-45
Install the Active Workspace Launcher ──────────────── 12-56
Install classification libraries ──────────────────── 12-58
Verify Active Workspace installation ───────────────── 12-60

Adding optional solutions

Install the Business Modeler IDE ─────────────────── 13-1
Choose a Business Modeler IDE installation type ─────────────── 13-1
Install the Business Modeler IDE ────────────────────── 13-2
Add the Business Modeler IDE to an existing Eclipse SDK environment ───── 13-6
Allocate memory to the Business Modeler IDE ──────────────── 13-9
Start the Business Modeler IDE ────────────────────── 13-10
Installing custom software ───────────────────── 13-11
Installing a custom solution or third-party template ───────────── 13-11
Install a template using TEM ────────────────────── 13-11
Update a template using TEM ────────────────────── 13-14
Configure Multi-Site Collaboration ───────────────── 13-16

Teamcenter Installation on Windows, Teamcenter 14.2 5

© 2022 Siemens
 Overview of Multi-Site Collaboration configuration ───────────── 13-16
Prepare the Multi-Site Collaboration environment ───────────── 13-16
Install a proxy server ────────────────────────── 13-18
Installing and configuring the Manufacturing Resource Library ──── 13-18
Installation overview and workflow ─────────────────── 13-18
Configure Manufacturing Resource Library users, groups, and roles ────── 13-19
Populating the database ──────────────────────── 13-21
Import part family templates when you use custom item IDs ───────── 13-34
Install localization data for MRL ───────────────────── 13-34
Configure NX Library using the installation wizard ───────────── 13-35
Configure NX Library when using a shared MACH directory ───────── 13-38
Configure the graphics builder for MRL ────────────────── 13-39
Configure MRL Connect ──────────────────────── 13-40
Installing Teamcenter Reporting and Analytics ──────────── 13-42
Before you begin ─────────────────────────── 13-42
Create the Reporting and Analytics database ─────────────── 13-42
Configure the Reporting and Analytics license file ───────────── 13-43
Install Reporting and Analytics ────────────────────── 13-43
Install Remote Reporting and Analytics ────────────────── 13-45
Deploy Reporting and Analytics ───────────────────── 13-46
Complete Reporting and Analytics installation ─────────────── 13-46

Complete the Teamcenter server installation

Start database daemons ─────────────────────── 14-1
Configure heterogeneous operating system environment ─────── 14-2

Part IV: Deploy the Teamcenter Environment

Deploying localized versions of Teamcenter

Deploying rich client localizations ────────────────── 15-1
Deploy rich client localizations ────────────────────── 15-1
Display Siemens Digital Industries Software-provided rich client localizations ── 15-2
Update rich client localized text ────────────────────── 15-2
Configuring client display language ───────────────── 15-3
Choose a display language ──────────────────────── 15-3
Choose a display language for the rich client ──────────────── 15-5
Choose the default language for the Teamcenter server process ──────── 15-6
Add multibyte character support in an English rich client ─────────── 15-6

Creating a custom distribution

Overview of custom distributions ────────────────── 16-1
Create a silent distribution ────────────────────── 16-1
Create a silent installation configuration file ──────────────── 16-1
Launch a silent installation ──────────────────────── 16-2
Modify the silent installation configuration file ─────────────── 16-3
Create a compact distribution ──────────────────── 16-8

6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Contents

Part V: Maintain the Teamcenter Environment

Back up new installations 17-1

Manage environments
Managing environments ────────────────────── 18-1
Creating an environment ────────────────────── 18-2
Create an environment in Deployment Center ──────────────── 18-2
Create a configuration in TEM ────────────────────── 18-2
Register an environment in Deployment Center ─────────────── 18-3
Adding applications and components ───────────────── 18-6
Add applications ──────────────────────────── 18-6
Add components ──────────────────────────── 18-8
Migrate TEM to a different JRE ─────────────────── 18-13

Manage databases
Migrate a non-CDB database to a CDB database ──────────── 19-1
Add an existing Teamcenter database using TEM ─────────── 19-2
Add a new database using TEM ─────────────────── 19-4
Change the Oracle password ───────────────────── 19-5

Part VI: Appendices

Troubleshooting
Troubleshooting Teamcenter server installation ──────────── 20-1
Installation log files ─────────────────────────── 20-1
Problems/error messages ──────────────────────── 20-2
Update Manager FTP errors ──────────────────────── 20-5
Resolving web tier connection problems ────────────────── 20-6
Java exception errors during command-line updates ───────────── 20-7
Web Application Manager needs location of Java file when installing rich client ─
20-7
Troubleshooting microservices ──────────────────── 20-8
Troubleshooting four-tier architecture deployment ────────── 20-8
Troubleshooting the .NET web tier ────────────────── 20-12
Resolving .NET server manager port conflicts ─────────────── 20-12
Troubleshooting Oracle ─────────────────────── 20-13
Finding Oracle errors ────────────────────────── 20-13
View additional information about an Oracle error message ───────── 20-13
Troubleshooting Microsoft SQL Server ──────────────── 20-13
Tuning WebSphere JVM memory consumption ──────────── 20-14
Troubleshooting document rendering ──────────────── 20-16
Troubleshooting Teamcenter Integration for NX ─────────── 20-17
Recovering a corrupted database ────────────────── 20-18
Overview of recovery from a corrupted database ────────────── 20-18
Recovering from a corrupted Oracle database ─────────────── 20-18

Teamcenter Installation on Windows, Teamcenter 14.2 7

© 2022 Siemens
 Recovering from a corrupted Microsoft SQL Server database ───────── 20-18

Uninstalling Teamcenter
Uninstall Teamcenter configurations ───────────────── 21-1
Uninstall TCCS ─────────────────────────── 21-2
Uninstall database software ───────────────────── 21-3

Teamcenter software kits 22-1

Solutions and features reference

Teamcenter solutions ──────────────────────── 23-1
Teamcenter features ──────────────────────── 23-2
Active Workspace Server Extensions features ──────────── 23-19
Active Workspace Client features ────────────────── 23-34
Active Workspace microservices features ────────────── 23-44

Web tier context parameters 24-1

Load balancing Active Workspace components 25-1

Required RPM package managers 26-1

8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 1. Installing Teamcenter with Active
Workspace
Teamcenter is a product lifecycle management (PLM) platform that supports product development from
design through manufacturing. Active Workspace is a web-based Teamcenter client with powerful
collaboration, search, and visualization capabilities.

Installing Teamcenter with Active Workspace is a flexible process that accommodates the set of
applications you choose from its wide selection, the geographic distribution of your users, and other
variables. A Teamcenter administrator performs the installation in phases:

Plan
Download software and documentation, and design your
Teamcenter environment.

Build
Install essential software components like a database
server, license server, and Security Services, creating a
development environment in which to test Teamcenter and
Active Workspace software.

Test
Install Teamcenter and Active Workspace software, connect
applications and machines, configure the Active Workspace
interface, and validate your development environment to
ensure your configuration is successful.

Deploy
Deploy your development environment to your production
environment, making Teamcenter with Active Workspace
available to your users.

Maintain
Perform ongoing maintenance of your Teamcenter
environment, configuring as needed to adjust to your
changing business processes. Also, optimize performance
and update software with the latest patches.

If you do not use Active Workspace, you can alternatively install the Teamcenter rich client, a Java-based
desktop client. Active Workspace requires no initial desktop installation or plug-ins like Java or ActiveX,
runs in a web browser, and provides enhanced functionality compared to the rich client.

Teamcenter Installation on Windows, Teamcenter 14.2 1-1

© 2022 Siemens
 1. Installing Teamcenter with Active Workspace

Where do I go from here?

If your starting point is: And you want to: Begin here:
No existing Teamcenter Install Teamcenter and Active Plan the Teamcenter Environment
environment Workspace
Teamcenter with Active Update Active Workspace Updating Active Workspace and
Workspace microservices
Teamcenter without Active Add Active Workspace Adding Active Workspace and
Workspace microservices
Teamcenter with rich client Update Teamcenter and rich Rich Client Installation on
client Windows

1-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Part I: Plan the Teamcenter Environment
Begin the Plan phase of Teamcenter deployment by
gathering Teamcenter documentation, software, and the
Teamcenter deployment tool, Deployment Center.
Learn the architecture of a Teamcenter environment, and
guidelines for distributing Teamcenter components.
The Teamcenter Deployment Reference Architecture,
available from the Teamcenter Downloads area on Support
Center, is an essential resource for planning a Teamcenter
environment with Active Workspace. It provides information
such as:

• Guidelines for copying a Teamcenter environment for

upgrade testing.

• Detailed examples of Teamcenter and Active Workspace

deployments.

• Sample configurations and scripts to use with

Deployment Center.

Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
Teamcenter Installation on Windows, Teamcenter 14.2
© 2022 Siemens
 2. Where to start
Get documentation

Teamcenter documentation is available from two sources:

• Support Center

Siemens Digital Industries Software's comprehensive support portal, which provides documentation
for all Siemens software products and versions.

The Siemens Secure Documentation Proxy provides secure, easy access to documentation without a
need to log on, through a personalized API key specific to your site.

• Siemens Documentation Server

Locally installed server that can host documentation for all your Siemens Digital Industries Software
products. No Internet access is required. You can configure the server for single-machine or network-
wide access.

The Siemens Secure Documentation Proxy and the Siemens Documentation Server are available on
Support Center under Products→Siemens Documentation Installer→Downloads.

Choose how you want to access documentation, then download and install the required software:

Installing Siemens Secure

Documentation Proxy Installing Siemens Documentation Server

Install the Siemens Secure 1. Install the Siemens Documentation Server.

Documentation Proxy to
access documentation on 2. Install documentation for your software products.
Support Center.
Each documentation kit contains documentation content and an
installation wizard that automatically installs documentation
onto your Documentation Server.

Documentation kits (docs-product-name-and-version-locale.zip)

are available from the Downloads pages for each product on
Support Center.

Complete installation instructions for the Secure Documentation Proxy and the Siemens Documentation
Server are available on Support Center.

For a step-by-step orientation to Support Center, see Siemens Software Support Center videos on
YouTube.

Teamcenter Installation on Windows, Teamcenter 14.2 2-1

© 2022 Siemens
 2. Where to start

Enable rich client access to documentation

When prompted in the Teamcenter installation tools, supply the appropriate documentation URL to the
rich client:

http://domain/en-US/product/282219420/doc/PL20220523331910052.xid1899404/html/
xid1899405

Replace domain with the source from which you access documentation:

• Support Center: docs.sw.siemens.com

• Siemens Documentation Server: doc-server-host:doc-server-port

Enable Active Workspace access to documentation

If you use Active Workspace documentation on Support Center, no further configuration is necessary.
The Active Workspace Help button links to Support Center by default.1

If you install the Siemens Documentation Server on your local network, configure the Help button to
link to Active Workspace documentation on your local server. Perform the following steps after you
install Active Workspace:

1. In Active Workspace, open Command Builder.

2. Find the showHelp action and set its Navigate To property to the URL to Active Workspace
documentation on your local documentation server:

http://host:port/en-US/product/282219420/doc/PL20220523330405661.xid1899337/html/
xid1899339

Replace host and port with the host name and port of your local documentation server.

3. Commit your UI Builder changes to your module to update the Help button link for your users.

Get Deployment Center

Deployment Center is a centralized web application for deploying software to Teamcenter

environments. Using Deployment Center, you can create and manage multiple environments from a
single location. This simplifies the processes of installing and updating software and can automate
deployment.

1 The default URL to Active Workspace documentation on Support Center is http://docs.sw.siemens.com/en-US/product/

282219420/doc/PL20220523330405661.xid1899337/html/xid1899339.

2-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Get software

Download the latest version of Deployment Center from the Teamcenter downloads area on Support
Center. Install Deployment Center as described in the Deployment Center Guide.

Deployment Center is an alternative installation tool to Teamcenter Environment Manager (TEM) for
installing Teamcenter and Active Workspace. TEM is deprecated and will be discontinued in a future
release.

Get software

Installing Teamcenter with Active Workspace requires software for Teamcenter, microservice framework,
and Active Workspace.

Download Teamcenter software

From the Teamcenter downloads page on Support Center, download the Teamcenter 14 and 14.2
software kits for Windows:

Tc14.0.0.0_wntx64.zip
Tc14.2.0.0_wntx64.zip

Teamcenter Installation on Windows, Teamcenter 14.2 2-3

© 2022 Siemens
 2. Where to start

If a patch to Teamcenter 14.2 is available, for example, Teamcenter 14.2.0.1, you can alternatively
substitute that kit for the Teamcenter 14.2 kit. Patch kit files are named
Tc14.2.0_patch_number_wntx64.zip.

Download microservice framework software

From the Teamcenter downloads page, select Additional Downloads→Microservice Framework, and
then download the microservice framework 6.2 software kit for Windows. This kit is required for Active
Workspace installation:

TcMicroserviceFramework6.2.0_wntx64.zip

If a later microservice framework software patch kit is available, for example, version 6.2.1, you can
download that kit instead.

Download Active Workspace software

From the Teamcenter downloads page on Support Center, download the Active Workspace 6.2 software
kit for Teamcenter 14.x for Windows:

Tc14.x.0.0_ActiveWorkspace6.2.0_wntx64.zip

If a later Active Workspace software patch kit is available, for example, version 6.2.1, you can download
that kit instead.

Note:
Active Workspace 6.2 supports multiple versions of Teamcenter. Take care to download the correct
software kit for Teamcenter 14.x.

Stage the software kits

Place the software kits where they can be accessed by your preferred installation tool.

Deployment Center

1. Expand the software kits for Teamcenter, microservice framework, and Active Workspace.
Copy the unzipped directories to the software subdirectory in one of your registered
repository locations.

2. Log on to Deployment Center, and click SOFTWARE REPOSITORIES.

The Software Repositories page opens the Active Media tab of the repository and displays
the Software Media table.

2-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Get started

3. Verify that the added software appears in the list of available software. The list may take up to
five minutes to update.

If the software does not appear in the Software Repositories page, inspect the repository log
files for repository scanning issues or software file problems. The repository log files are in the
webserver\repotool\logs directory on the Deployment Center server.

Teamcenter Environment Manager (TEM)

Expand the software kits for Teamcenter, microservice framework, and Active Workspace to
separate directories that are accessible to the machines on which you plan to install.

Can I place the software in a remote location?

You can place software kits on a non-local drive, with the following considerations.

Deployment Center

Your primary repository in Deployment Center must be a local path. However, you can specify
additional repository locations, and these may be UNC paths or local file system paths. Mapped
drives are not supported for any software repositories in Deployment Center. For more information,
see the Deployment Center Guide.

Teamcenter Environment Manager (TEM)

TEM cannot install software from UNC paths, for example, \\mediaserver\tcmedia. If the software
kits are located on a remote host, map a drive to each software location using the net use
command.

Open an administrator command prompt and type the net use command:

net use drive-letter: UNC-path

For example:

net use z: \\mediaserver\tcmedia

Get started

If you are new to Teamcenter installation, the following resources may help you get started.

If you want to
know more
about: See these resources:
Support Center Support Center is Siemens Digital Industries Software's comprehensive support
portal, providing software, documentation, and a variety of support content:

Teamcenter Installation on Windows, Teamcenter 14.2 2-5

© 2022 Siemens
 2. Where to start

If you want to
know more
about: See these resources:
https://support.sw.siemens.com
For a step-by-step orientation to Support Center, see Siemens Software Support
Center videos on YouTube.
Teamcenter If you are new to Teamcenter, learn about Teamcenter architecture and
components.
Also, see the Teamcenter Deployment Reference Architecture, which provides
detailed examples of Teamcenter deployments. This document is available in the
Teamcenter Downloads area on Support Center.
Active Workspace If you are new to Active Workspace, learn about Active Workspace components in
Teamcenter, and how Active Workspace installation is part of installing a
Teamcenter environment.
Microservice If you are familiar with Active Workspace but have not yet moved to Active
Framework Workspace with microservices2, learn about microservices and the microservice
framework.
Deployment If you are new to Deployment Center, learn how installing and managing a
Center Teamcenter environment is different with Deployment Center.

2 Active Workspace architecture changed in Active Workspace 4.3, replacing the Active Workspace WAR file and .NET client
with a system of microservices and an Active Workspace Gateway. Current versions of Active Workspace require the
microservice framework.

2-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 3. Teamcenter architecture
The Teamcenter environment

Four-tier architecture

The Teamcenter platform is a software architecture that consists of four logical tiers that provide the
major functions:

Client interfaces through which users access Teamcenter.

Secure communication between client machines and
Teamcenter servers over local, wide-area, and global
networks.
Core Teamcenter operations, and retrieval and routing of
Teamcenter data.

Storage and organization of user data files, metadata, and

other forms of Teamcenter data.

Teamcenter environment

Each tier of the architecture hosts Teamcenter components, software modules that provide supporting
resources and services. Components may be installed on physical machines, virtual machines, or
containers.

A Teamcenter environment consists of all client and server machines that share resources of a
Teamcenter resource tier.

This simplified illustration shows groups of components representing the kinds of functionality
performed in each tier.

Teamcenter Installation on Windows, Teamcenter 14.2 3-1

© 2022 Siemens
 3. Teamcenter architecture

Some components are contributed by the Teamcenter platform, some by Microservice Framework, and
some by Active Workspace, as indicated.

This illustration shows names of common components in each group. These components can be
selected for installation in Deployment Center and in TEM:

3-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Environment and architecture types

Components can be installed on a single machine, as in a single box environment, or distributed on

multiple machines, as in a distributed environment.

The Teamcenter Deployment Reference Architecture, available on Support Center, provides detailed
examples of distributions of Teamcenter and Active Workspace components.

Environment and architecture types

You can select environment types and architecture types in the Options task in Deployment Center.

Environment types

The four-tier architecture does not represent physical locations of software components, it is a logical
organization for grouping components and functionality. Teamcenter components can be deployed on a
single machine or multiple machines, in the following two types of environments:

Teamcenter Installation on Windows, Teamcenter 14.2 3-3

© 2022 Siemens
 3. Teamcenter architecture

Single Box All components are installed on one machine, and all tiers operate on that machine.
This type of environment is useful for developing and testing Teamcenter deployment.
Distributed Components are installed on multiple machines, and the functions of the four logical
tiers may be distributed across multiple machines. This type is common for production
environments where software functions can be distributed over a network to optimize
performance with load balancing, failover support, and high availability.

Web architectures

Teamcenter supports two third-party platforms for communication through the web tier between
Teamcenter servers and clients.

Java EE The Java Platform, Enterprise Edition (Java EE) is supported on Windows and Linux
systems. The Teamcenter Java EE web tier is built on the Java EE platform and requires
a supported Java EE web server.
Microsoft .N The Microsoft .NET framework is supported on Windows systems. The
ET Teamcenter .NET web tier is built on this platform and requires Microsoft Internet
Information Server (IIS).

3-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 4. Design the Teamcenter environment
System requirements

For versions of system software and hardware certified for running Teamcenter on your platform, see
the Hardware and Software Certifications knowledge base article on Support Center:

https://support.sw.siemens.com

Some software requirements differ for non-English locales. When viewing certified versions, make sure
you note any exceptions for your locale.

Hardware requirements for a Teamcenter deployment vary depending on considerations such as

whether your deployment contains:

• A single host or multiple hosts

• Rich client, Active Workspace, or both

• Additional components such as Dispatcher Server on separate hosts

The Teamcenter Server Hardware Overview contains hardware recommendations based on these and
other variables. This document is available from the Support White Papers version page in the
Teamcenter downloads area on Support Center.1

Platforms

Determine from the following table which Teamcenter 14.2 components are supported on your
operating system. Check marks (√) indicate components supported on the given operating system.

Business Modeler
Corporate Web Active IDE
Operating system server tier Workspace Rich Client client TCCS
Microsoft Windows √ √ √ √
(desktop platforms)
Microsoft Windows Server √ √ √
SUSE Linux √ √ √ √ √ √
Red Hat Linux √ √ √ √ √ √
CentOS Linux √ √ √ √ √ √

1 The Teamcenter Server Hardware Overview is named Teamcenter_Hardware_Overview-version.pdf. The latest version
of this document may be in an earlier Support White Papers version page.

Teamcenter Installation on Windows, Teamcenter 14.2 4-1

© 2022 Siemens
 4. Design the Teamcenter environment

• On Windows platforms, disable Windows User Account Control (UAC) before you install
Teamcenter. This option is available in the Control Panel→User Accounts dialog box.

Windows UAC can interfere with Teamcenter installation programs. Siemens Digital Industries
Software recommends turning off UAC for administrative users only.

For more information, see Microsoft Windows documentation.

• Disable the Windows TCP scaling feature. Open a command prompt and enter the following
command:

netsh interface tcp set global autotuninglevel=disabled

Siemens Digital Industries Software recommends setting this parameter before installing
Teamcenter because most client network infrastructures use one or more switches or routers. By
default, Windows enables TCP window scaling, but some routers do not support this feature.
This can cause installation failures that are difficult to diagnose and correct.

For more information, see Microsoft Windows documentation.

• If you use a nonnative language operating system version of Windows, you must install and
enable the Multilingual User Interface (MUI) pack to ensure the language font is displayed
properly.

1. Download and install the MUI pack for Windows from Microsoft.

2. Open the Regional and Language Options dialog box in the Windows Control Panel.

3. In the Languages tab, set the required language for the menus and dialogs.

4. In the Advanced tab and the Regional Options tab, set the required language.

Database

Teamcenter requires a relational database management system (RDBMS) for storing Teamcenter data.
Before you install Teamcenter, you must install an Oracle database server or a Microsoft SQL Server
database server.

If your database server is not a supported version, upgrade your database server to a supported version
before you install Teamcenter.

Choose a database management system that suits the platforms of your Teamcenter servers and clients,
and make sure your Teamcenter corporate server host has access to the database server.

4-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 System requirements

If you use Oracle, set system parameters to recommended values to ensure adequate database
performance.

Java Runtime Environment

Teamcenter Environment Manager (TEM) requires a supported 64-bit Java Runtime Environment (JRE). If
a certified JRE is not available on the host, TEM cancels installation.

Before you launch TEM to install Teamcenter:

1. Download and install a certified 64-bit JRE.

For certified JRE versions, see the Hardware and Software Certifications knowledge base article on
Support Center.

2. Set the JRE_HOME environment variable to the location of the supported JRE. After installation is
complete, TEM no longer requires this variable.

Alternatively, you can launch TEM in a command prompt and specify the JRE location using the -jre
argument:

tem -jre JRE-path

For example:

tem -jre c:\apps\jre1.8

Web tier support

Install the required software for the Teamcenter web tier you use:

• Java EE web tier

Java Runtime Environment (JRE)

Install a supported JRE on the host where you build Teamcenter web applications.
Java EE application server

Install a supported application server on the host where you deploy Teamcenter web
applications.

• .NET web tier

Microsoft Internet Information Server (IIS)

Install IIS on your Teamcenter corporate server host and add the required role services.

Teamcenter Installation on Windows, Teamcenter 14.2 4-3

© 2022 Siemens
 4. Design the Teamcenter environment

Microsoft .NET framework

Install the .NET framework on all Teamcenter hosts.

Some web application servers require special configuration for use with Teamcenter.

Web browser

A web browser is required if you use the following:

• Teamcenter online help

• Active Workspace
• Deployment Center

For these products, Teamcenter supports the following web browsers:

• Windows systems: Microsoft Edge, Mozilla Firefox, and Google Chrome

• Linux systems: Mozilla Firefox and Google Chrome

For supported browser versions, see the Hardware and Software Certifications knowledge base article
on Support Center.

How many servers do I need?

A Teamcenter network requires one corporate server configuration. Additional servers are optional, but
can help balance network loads and facilitate heterogeneous networks (networks with hosts running
different operating systems).

If you install the optional servers, Siemens Digital Industries Software recommends installing in the
following order:

1. Install a Teamcenter corporate server.

The corporate server is a network node used as an application file server (from the Teamcenter
application root directory) and database-specific configuration file server (from the Teamcenter
data directory). Run Teamcenter Environment Manager and install the Teamcenter executables and
the directory containing the database-specific configuration files. Teamcenter can also run locally
on this network node.

A Teamcenter corporate server contains the Teamcenter Foundation and FMS Server Cache
features as a minimum.

2. Optionally install additional Teamcenter servers to provide the following capabilities:

4-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 How many servers do I need?

• Run Teamcenter executables and point to the existing data directory on the corporate server
host or another Teamcenter server. This server can contain a Teamcenter application root
directory structure on a network node that may be configured to run Teamcenter in the future.

• Run Teamcenter Environment Manager and point to an existing database. This server can
contain a Teamcenter network node to be used as a database-specific configuration file
(Teamcenter data directory) server when the Teamcenter application root directory is mapped
from a Teamcenter application server. Teamcenter can also be run locally on this system. You are
creating an additional Teamcenter database for use with an existing Teamcenter application root
directory.

Mixed platform considerations

Homogeneous network environment

In a homogeneous environment, all hosts run the same platform, for example, a corporate server,
web tier, and Teamcenter clients all running on Microsoft Windows or all running on SUSE Linux.

When deploying the two-tier architecture, you can install Teamcenter application executable files
on a single application server host, export the Teamcenter application root directory structure from
the Teamcenter application server, and mount it using CIFS on client workstations to run
Teamcenter locally. Typically, the Teamcenter application server is also the Teamcenter data server.
Similarly, you can export the data directory structure and mount it using CIFS to other Teamcenter
clients to provide access to the database-specific information.

Heterogeneous network environment

In a heterogeneous environment, hosts do not all run the same platform, for example, a corporate
server and a web application server may run on Linux hosts, and workstations on Microsoft
Windows.

Installation considerations for a heterogeneous environment are the same as for a homogeneous
environment, except that you must install Teamcenter for each type of workstation on the
network, resulting in a Teamcenter application directory structure for each different type of
workstation. You can configure one Teamcenter application server to serve many Teamcenter
directory structures for different platforms.

Teamcenter volume data must be accessible by all Teamcenter clients in a heterogeneous network.
Configure File Management System for volume access for all clients.

Make sure your Windows and Linux server configurations contain identical sets of Teamcenter
features. For example, if you install features or custom templates on a Linux server, you must
install the same features and templates on your Windows server.

Additional considerations:

Teamcenter Installation on Windows, Teamcenter 14.2 4-5

© 2022 Siemens
 4. Design the Teamcenter environment

• The Teamcenter root directory is platform-specific. The files within it can be shared only
between systems of the same platform type. For heterogeneous Teamcenter environments that
include Windows clients or Windows volume servers, configure File Management System to
allow all clients to communicate with all volume servers.

• The Teamcenter root directory is specific to Windows or Linux systems (endian-specific).

Maintain separate Teamcenter data directories on Windows and Linux systems.

Planning File Management System installation

Overview of FMS installation

File Management System (FMS) downloads and uploads file data for the rich client, embedded viewer,
and Lifecycle Visualization. Multi-Site Collaboration also uses FMS servers to transfer data.

If you install File Management System, the FMS server cache (FSC) and the server manager must run on
the same host server, with the same user ID.

If the FSC does not manage any volumes, that is, if it is purely a cache server, it can run as any user that
is convenient.

FMS provides the following functions:

• Volume server for file management

• Shared server-level performance cache for shared data access between multiple users

• Client-based private user cache for rich clients

• Transient data store mechanism for transporting reports, PLM XML, and other nonvolume data
between the web and client tiers in the four-tier architecture

FMS caching enables placing the data close to the user, while maintaining a central file volume and
database store.

FMS requires the installation of FMS server cache (FSC) and FMS client cache (FCC) components:

• The FSC component provides a server process and file caches for Teamcenter server hosts.

• The FCC component provides a client process and file caches for rich clients on user workstations.

4-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Installing the FMS server cache

Basic File Management System deployment

Installing the FMS server cache

You can configure the FMS server cache (FSC) server to perform any combination of the following
functions:

• Volume server or performance cache server

When running on a host where a volume is located or directly mounted on the computer hosting the
FSC, the FSC acts as a volume server.

When running on a host where a volume is not located or directly mounted, the FSC acts as a
performance cache server.

As a volume or cache server, the FSC checks all file access requests for a ticket that Teamcenter
generates to authorize file access. As a cache server, it manages two segment caches, one for
downloading files and one for uploading files.

• Configuration server

As a configuration server, the FSC provides FMS configuration information to the FMS client caches
and other FSCs.

• Transient server (in a deployment of the four-tier architecture only)

Teamcenter Installation on Windows, Teamcenter 14.2 4-7

© 2022 Siemens
 4. Design the Teamcenter environment

As a transient server, the FSC delivers PLM XML and other transient files to clients.

Any deployment of Teamcenter requires a minimum of one FSC server. You can deploy multiple FSC
servers, each performing multiple roles or each performing a designated purpose as either a volume, a
cache, or a configuration server. When you install multiple volumes on different hosts for the same
database, the multiple FSC servers are linked through a common primary (master) FSC. (You can
manually configure more than one primary FSC.)

You must install an FSC server on:

• Each host running a Teamcenter server manager.

• Each host that will contain a Teamcenter volume.

FSC servers and caches are configured using XML-based files, in a hierarchical structure:

• FMS primary configuration file (fmsmaster_fsc_id.xml)

The primary configuration file describes the File Management System network and defines FSC
groups. It is the highest file in the hierarchy and can define default values for FSCs and FCCs, such as
the maximum sizes of the caches.

Each installation of Teamcenter requires one FMS primary configuration file. At least one FSC server
reads this file and is called the primary FSC. Other FSC servers in the network download FMS
configuration information from the primary FSC server.

If you install only one FSC server in a Teamcenter network, it is the primary server.

• FSC configuration file (fscfsc_id.xml)

The FSC configuration file configures an individual FSC in a network. It specifies the address of the
primary FSC (for downloading FMS network information) and defines such values as the maximum
sizes of the server segment file caches and the upload timeout value.

This file can either inherit values from the primary file or override them. It can also define default
values for FCCs.

• The FCC configuration file defines values for the FCC on client hosts, such as the maximum sizes of
the caches.

It can either inherit values from the FSC configuration file or override them.

When planning your FMS installation, you must be prepared to supply the following information to the
Teamcenter installation tools:

4-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Installing the FMS server cache

Data Description

Read cache directory and size? For FMS to operate correctly, the location you specify must be
on the local host.
If you are installing a volume on the host, FMS does not use the
read cache; Siemens Digital Industries Software recommends
accepting the default cache size (10 megabytes). Do not specify
0; specifying 0 creates a file cache with a default size larger than
10 megabytes.
If you are not installing a volume on this host, FMS acts as a
cache server. In this case, Siemens Digital Industries Software
recommends increasing the value to 1000 megabytes. However,
choose a size that represents the maximum size of the data that
must be processed. If you choose 1000 megabytes, and a user
requests a 3 gigabyte assembly, the request fails.

Write cache and size? This cache is required when the FSC acts as a cache server.
For FMS to operate correctly, the location you specify must be
on the local host.
If you are installing a volume on this host, FMS does not use the
write cache; Siemens Digital Industries Software recommends
accepting the default cache size (10 megabytes). Do not specify
0; specifying 0 creates a file cache with a default size larger than
10 megabytes.
If you are not installing a volume on this host, FMS acts as a
cache server. In this case, Siemens Digital Industries Software
recommends increasing the value to 512 megabytes or more.
However, choose a size that represents the maximum size of the
data that must be processed.

Communication mode between Either HTTP or HTTPS.

FMS components?

Configure proxy servers? Either HTTP proxy server or HTTPS proxy server.
If you choose to configure proxy servers, you must provide:

• The name of the host running the proxy server.

• The number of the port the proxy server listens on.

Is this host an FMS primary If you are installing only one FSC server in the network, it must
(master)? be the primary host. Each Teamcenter network must have at
least one primary configuration file and one FSC designated to
read this file.

Default settings for the FCC? • Location of the cache directory for all Windows systems and
for all Linux systems.

Teamcenter Installation on Windows, Teamcenter 14.2 4-9

© 2022 Siemens
 4. Design the Teamcenter environment

Data Description

• Default maximum size in megabytes of whole files

downloaded from the volume to rich client hosts. Users
cannot download a file whose size exceeds the value you set
for this value. This default setting can be overridden by the
FMS client cache configuration file.

Choose a size large enough to accommodate the largest

whole file that users download from the volume. If the user
requests a 3-gigabyte assembly when the cache size is set to
1000 megabytes, the request fails.

• Default maximum size in megabytes of whole files uploaded

to a volume from rich client hosts. Users cannot upload a file
whose size exceeds the value you set for this value. This
default setting can be overridden by the FMS client cache
configuration file.

Choose a size large enough to accommodate the largest

whole file that users upload to the volume.

• Default maximum size in megabytes of the segment file cache

used by the embedded viewer and the stand-alone application
viewer on rich client hosts.

This default setting can be overridden by the FMS client cache

configuration file.

• If no or few rich client users in the network deploy Lifecycle

Visualization, Siemens Digital Industries Software
recommends setting this cache size to 10 megabytes. Do
not specify 0; specifying 0 creates a file cache with a
default size larger than 10 megabytes.

• If rich client users in the network deploy Lifecycle

Visualization, Siemens Digital Industries Software
recommends setting this cache size in the range of 2000
megabytes to 4000 megabytes.

The cache size is initially small, expanding to the maximum

size only if a user launches Lifecycle Visualization to view a
file of that size. The initial size of the cache is proportional
to the value specify.

Teamcenter installation tools install and initially configure the FSC servers, segment file caches, primary
configuration file, and FSC configuration file or files. For small deployments of Teamcenter, this may be

4-10 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Installing the FMS client cache

the only installation and configuration required. For large deployments, you can take advantage of FMS
flexibility by manually configuring the FMS network.

Installing the FMS client cache

The FMS client cache (FCC) process runs on a client host and performs the following functions:

• Uploads files to an FSC server

• Requests files from an FSC server

• Caches files on the client host

The FCC process manages three file caches:

• A write cache containing whole files uploaded to a Teamcenter volume

• A read cache containing whole files downloaded from a Teamcenter volume

• A segment cache for Teamcenter lifecycle visualization

Installing the FCC supports the rich client and some other Siemens Digital Industries Software products.

• The rich client requires an FCC, and TEM automatically installs an FCC with each rich client.

The rich client uploads files to the Teamcenter volume and downloads files from the Teamcenter
volume using the FCC. If Teamcenter lifecycle visualization 6.0 or later is installed on the workstation
and used with the rich client, it optionally uses the FCC.

When you install the rich client on user workstations, configure the location of the cache on the
workstation and the maximum size of files downloaded from the volume or uploaded to the volume.
Installing the rich client on a workstation simultaneously installs the FCC process and caches. No
additional configuration steps are required.

Configuring the FCC this way may be the only configuration you require, but you can take advantage
of additional configuration options by manually configuring the FCC.

• If you use NX or Teamcenter lifecycle visualization, you can install the FCC and use it to upload files to
and download files from the Teamcenter volume.

Installing the FCC enables users to take advantage of FMS features:

• Improved file transfer performance

FMS is a high-performance file transfer solution that gives client applications direct access to files
over a high-performance network connection.

Teamcenter Installation on Windows, Teamcenter 14.2 4-11

© 2022 Siemens
 4. Design the Teamcenter environment

• File streaming

Teamcenter lifecycle visualization uses proprietary file streaming technology to download

appropriate portions of the JT files over the network as they are needed. FMS supports segment file
transfer to keep network loads down and support this high-performance file streaming technology.

• Built-in caching infrastructure

The FCC is dedicated to a specific user on the client. The FSC server can be shared by groups of
users.

• Deployment flexibility

FMS components support a multitude of deployment configurations. This enables administrators to

geographically locate volumes and shared FSC servers close to client workstations, providing the
ability to tune the system for optimal file transfer performance.

Installing an FCC for use with NX and Teamcenter lifecycle visualization is described in the
Teamcenter client installation guides for Windows and Linux.

Web tier dependencies and application integrations

Install the web tier for four-tier rich client and Active Workspace

If you use the four-tier rich client or Active Workspace, you must install a Teamcenter web tier to provide
communication between clients and the corporate server. Teamcenter provides two web tier types:

Type Framework Installed using Deployed on

.NET web tier Microsoft .NET Teamcenter Environment Manager Microsoft Internet Information
(TEM) or Deployment Center Server (IIS)

Java EE web tier Java EE Web Application Manager or Any supported Java EE web
Deployment Center server

Choose applications and install dependent software

Teamcenter provides many applications you can include in your environment, including integrations to
third-party applications and other Siemens Digital Industries Software products. These are listed in the
Features panel in TEM and in the Applications task in Deployment Center.

If you use Teamcenter integrations to other Siemens Digital Industries Software products or third-party
software, install those products before you install Teamcenter.

Some software products require separate licenses from Siemens Digital Industries Software. Purchase
the required licenses and install them into the Siemens Common Licensing Server.

4-12 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Web tier dependencies and application integrations

If you use any of the following integrations with the rich client, make sure you install these applications
in locations specified by the Teamcenter administrator.

• NX integrations

Installing NX is not a prerequisite for installing or using Teamcenter, but if you intend to integrate NX
with Teamcenter, install the following software before you install Teamcenter:

• NX

Install NX locally on every workstation according to the installation guide distributed with NX. This
is required for NX integrations to function in a rich client environment.

• Teamcenter Integration for NX or NX Integration

Teamcenter Integration for NX and NX Integration provide the same NX user interface and are both
installed with NX, but neither can be used until Teamcenter is configured.

If you include the NX Foundation feature on your Teamcenter corporate server, you must install
the NX Rich Client Integration feature on all servers and all two-tier rich clients in your
environment.

When you upgrade to a new version of NX, uninstall the NX Rich Client Integration feature, then
reinstall it, specifying the path to the new NX installation in the NX Install Location box in the
Teamcenter installation tool (TEM or Deployment Center).

For more information about using Teamcenter with NX, see the installation guides distributed with
NX.

• Teamcenter lifecycle visualization (embedded viewer)

Download the Lifecycle Visualization software kit and install a supported version of Lifecycle
Visualization on your workstation.

When you choose this integration, Teamcenter lifecycle visualization executable files are installed on
the local client host.

Installing this feature requires system administrator privileges on the client workstation, even though
the rich client does not require these privileges.

• Remote workflow

When you choose this option, the rich client is enabled to support the linking of objects between
Teamcenter and other applications such as Teamcenter portfolio, program and project management.
Separate installation of remote workflow components are required.

• SCM Integration - ClearCase

Teamcenter Installation on Windows, Teamcenter 14.2 4-13

© 2022 Siemens
 4. Design the Teamcenter environment

Obtain the IBM Rational ClearCase client software kit and install a supported version on your
workstation.

4-14 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Part II: Build the Teamcenter Environment
Prepare the machines that will host your Teamcenter test
and production environments. This includes installing
database infrastructure, license server, locale support, and
software like Security Services that will support the
Teamcenter and Active Workspace components.
The Teamcenter Deployment Reference Architecture,
available from the Teamcenter Downloads area on Support
Center, provides guidelines and examples for setting up test
and development environments.

Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
Teamcenter Installation on Windows, Teamcenter 14.2
© 2022 Siemens
 5. Prerequisite software and settings
Create user accounts and directories

Create the required user accounts and directories that Teamcenter requires for installation and
maintenance.

Create required user accounts

On the local host where you install Teamcenter software, create the Teamcenter operating system user
account.

All Teamcenter services run as this user account. Make sure this account belongs to the Administrators
group and is granted the Log on as a service right.

Ensure that all Teamcenter directories and files are owned and writable by this operating system user.

• Operating system logon account

Create an operating system logon account for Teamcenter. This account must belong to the
Administrators group and must be granted the Log on as a service right. Teamcenter services run
on the server as this user account.

Log on using this account when you install the Teamcenter environment and when you perform
maintenance. Ensure that all Teamcenter directories and files are owned and writable by this
operating system user.

• Teamcenter administrative user account

Teamcenter provides an administrative user account named infodba. Teamcenter Environment

Manager automatically creates this account when you install Teamcenter on a server host. This
account is used by the Teamcenter administrator to access the Teamcenter system administration
functions to perform setup and maintenance tasks. You create a password for this account during
Teamcenter installation.

Caution:
• The password must not be empty nor contain any whitespace characters such as space, tab,
newline, carriage return, form feed, or vertical tab.
In addition, the password must not contain any of the following characters:

!@$%=&'"^:;._<>(){}

Teamcenter Installation on Windows, Teamcenter 14.2 5-1

© 2022 Siemens
 5. Prerequisite software and settings

• Never use the infodba user to create working data or initiate workflow processes. The
infodba user is to be used only for specific installation tasks described in Teamcenter
installation documentation. Using this account to create data or initiate workflow processes
can cause unexpected and undesirable behaviors.
If you require a user with high-level privileges to create data, create a new user and grant
database administrator privileges to that user.

• Database user

Create a database user to be the owner of Teamcenter-created tables and to perform tasks required
by Teamcenter. You create this database user either by using the templates provided for Oracle
databases, or by using Teamcenter installation tools to populate a database. Teamcenter installation
tools refer to this user as DB user.

Each user and group is identified by an alphanumeric name and an ID number. The ID number is
retained with the file information when a file is exported across a network. If the ID numbers do not
match for a user or group, file access privileges may be unintentionally granted to the wrong user, or
not granted at all, on an NFS/CIFS client.

Create required directories

Teamcenter Choose a parent directory to contain Teamcenter software. This parent directory must
installation exist before installation. The Teamcenter root directory is created within this directory
root during installation. Requirements for this directory:
directory
• The directory must be excluded from real-time virus scanning.

Real-time virus scanning prevents Teamcenter from updating the persistent object
manager (POM) schema during installation, causing installation errors.
• If the directory is on a mapped drive or a UNC path (not on the local host) you must
be logged on as an authenticated domain user to ensure the remote host recognizes
you. Alternatively, you can set the permissions on the remote host to allow an
anonymous user to access it. This is necessary to ensure Teamcenter services such as
the FMS server cache (FSC) and Multi-Site Collaboration services can start.
• The directory must be on an NTFS partition, not a FAT partition. This is necessary to
take advantage of the file security features of NTFS.
Teamcenter Choose a parent directory to contain a Teamcenter volume or volumes.
volume
location This parent directory must exist before installation. The volume directory is created
within this parent directory during installation.

Do not place the volume directory under the Teamcenter application root directory.
Doing so can cause problems when upgrading to a new version of Teamcenter.

5-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Gather required information

Gather required information

Teamcenter installation tools require parameter values from prerequisite third-party and Siemens
software products during Teamcenter installation. When you install the following software products,
record the values specified below and be prepared to supply these values to the Teamcenter installation
tools (Deployment Center and Teamcenter Environment Manager).

When you install

this software Record these values
Database server Record the appropriate values for your database server type:
Microsoft SQL Server

• Name of the database

• Name of a system data source (DSN) to be created by the Teamcenter installer.

Oracle

• Database server machine name and port.

• Service name of the Oracle instance.

Typically, the service name is the same as the SID.

• Connection values according to your database creation option.

During Teamcenter installation, you choose whether to create a new database

user or use an existing database user.
New user Values about the generic Oracle instance:

• Name and password of the database system user

• Absolute path to the tablespace directory on the database
server.
Existing user Database user name and password.

Licensing Server Machine name and port of the licensing server.

and Teamcenter
licenses
Security Services • Security Services application ID
• URL to the Security Services Login Service web application
• URL to the Security Services Identity Service web application

Teamcenter Installation on Windows, Teamcenter 14.2 5-3

© 2022 Siemens
 5. Prerequisite software and settings

Configure language support

Teamcenter localizations provided by Siemens Digital Industries Software

Siemens Digital Industries Software provides localized versions of Teamcenter in the following
languages:

Language Locale code

Chinese (Simplified) zh_CN

Chinese (Traditional) zh_TW

Czech cs_CZ

English en_US

French fr_FR

German de_DE

Italian it_IT

Japanese ja_JP

Korean ko_KR

Polish pl_PL

Portuguese (Brazilian) pt_BR

Russian ru_RU

Spanish es_ES

Use the appropriate locale codes to deploy Teamcenter localizations or launch Teamcenter clients in a
desired locale.

If you provide your own localizations for locales not provided by Siemens Digital Industries Software, use
the appropriate Java standard locale codes similar to the locale codes in the preceding table.1

Localizing Teamcenter in Hebrew

Siemens Digital Industries Software does not provide a Hebrew translation but provides recommended
configuration settings for Hebrew locales. In Hebrew locales, set the locale code to en_US. This allows
data entry in Hebrew, but user interface text is in English.

1 Standard locale codes are composed of a two lowercase character language code from the ISO 639-1 standard, followed
by an underscore, followed by a two uppercase character country code from the ISO 3166-1-alpha-2 standard.

5-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Choose the character set for Teamcenter

Choose the character set for Teamcenter

Choosing the correct character set for Teamcenter and the Teamcenter database is critical. If a
Teamcenter client user enters a character that is not recognized by the Teamcenter database, the
character is misinterpreted or corrupted when the user's data is checked into the Teamcenter database.

Determine the character set your Teamcenter network requires based on the following considerations.

Language support

Determine the languages you need to support, considering both initial needs and future needs. If you
support one language currently but anticipate supporting additional languages in the future, choose a
character set that accommodates those future requirements.

Some character sets support groups of languages. The standard localizations provided with
Teamcenter support the following language groups:

Language group Languages

Western European English

French
German
Italian
Portuguese (Brazilian)
Spanish

Eastern European: Czech

Polish
English

Japanese Japanese
English

Chinese (Simplified) Chinese (Simplified)

English

Chinese (Traditional) Chinese (Traditional)

English

Korean Korean
English

Russian Russian
English

If the languages you plan to support are all in the same language group, you may choose a non-UTF-8
character set for your Teamcenter network. But, if you plan to support languages that are not all within
a single language group, you must choose the UTF-8 character set.

Teamcenter Installation on Windows, Teamcenter 14.2 5-5

© 2022 Siemens
 5. Prerequisite software and settings

For example, if your Teamcenter hosts run in English, French, and German locales, which are all in the
Western European language group, you may choose a non-UTF-8 character set or you may choose
UTF-8. However, if you also need to support hosts in Japanese locales, you must choose UTF-8 because
Japanese is not in the Western European language group.

The UTF-8 character set supports all languages supported by standard Teamcenter.

Choosing UTF-8 or non-UTF-8

Unicode encodings like UTF-8 enable seamless manipulation of all existing characters in all languages.
Teamcenter supports non-Unicode and UTF-8 Unicode encodings.

In a system fully configured for UTF-8 (for example, a server host configured for UTF-8 and a database
encoding of Oracle utf8 or Oracle al32utf8), all characters can be entered in the application.

In a system configured for a non-Unicode encoding, only characters belonging to it can be entered.
ASCII characters are always part of that character list. For example, if you choose Western European
setup (Microsoft cp1252 or ISO iso-88559-1 encodings), you cannot enter Russian, Japanese, Chinese,
Czech, Polish, Taiwanese, or Korean characters. Furthermore, database migration from one encoding to
Unicode can be tedious. It is important, then, to fully consider present and future needs when choosing
encoding.

Character support

Determine what special or extended characters you must support in Teamcenter data, and choose a
character set that supports them. For example:

En dash (–) or em dash (—)

These characters are part of Windows 1252 code page, but not part of the ISO8859_1 character set.
However, the UTF-8 character set supports these characters.
Currency symbols such as the euro (€)
This symbol is in the we8iso8859p15 character set, but not in the we8iso8859p1 character set.

To ensure correct character mapping, make sure the database and the Teamcenter server use the same
encoding.

Platform and database

• Platform

Choose a character set that accommodates the platforms in your Teamcenter network. For example, if
your Teamcenter server is a Linux host but your client hosts are Windows, and you use default
character sets on each, data corruption can result because the default character sets for these
platforms are not compatible. Choose a character set supported on both platforms.

5-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Verify that your locale is supported

The UTF-8 character set accommodates all platforms Teamcenter supports.

• Database

Oracle supports UTF-8 and non-UTF-8 character sets on all platforms.

Microsoft SQL Server does not provide native support for UTF-8. However, you can configure
Teamcenter to use UTF-8 with a Microsoft SQL Server database. The Enable UTF-8 option in
Teamcenter Environment Manager (TEM) enables the Teamcenter server to convert character
encoding to and from UTF-8 when interacting with the database.

Verify that your locale is supported

If you do not use UTF-8, ensure the locale you want to use is supported on your host. Perform the
following steps to set the Windows system locale and install the required language packs:

1. Open the Regional and Language Options dialog box in the Windows Control Panel.

2. In the Languages tab, set the required language for the menus and dialog boxes.

3. In the Region and Language dialog box, click the Administrative tab.

4. Under Language for non-Unicode programs, click Change system locale.

5. In the Region and Language Settings dialog box, verify the correct locale (language and country)
is selected. If not, choose the correct locale.

6. Close all dialog boxes and restart your system to install and configure the required language pack.

Configuring a UTF-8 environment for Teamcenter

Overview of UTF-8 configuration

Teamcenter supports the Unicode UTF-8 character set on Windows and Linux hosts that are configured
to process UTF-8.

Set the required values for your platform, locale, and database type before you begin installing
Teamcenter.

Enable UTF-8 support for Teamcenter servers and clients during Teamcenter installation:

• Teamcenter servers

With UTF-8 support configured on your host, Teamcenter Environment Manager (TEM) can create a
UTF-8-enabled Teamcenter database during Teamcenter installation.

Teamcenter Installation on Windows, Teamcenter 14.2 5-7

© 2022 Siemens
 5. Prerequisite software and settings

If you use Microsoft SQL Server, select the Enable UTF-8 option in the Foundation Database panel in
TEM.

• Two-tier rich client

If the Teamcenter database is configured for the UTF-8 character set, UTF8 is selected by default in
the TcServer Character Encoding Settings panel in TEM.

• Four-tier rich client

When installing the Teamcenter web tier, in the TcServer Character Encoding Settings panel in TEM,
select UTF8.

The four-tier rich client can run on any Windows or Linux platform running any language character
set.

• Web tier

Make sure UTF-8 support is configured on the web tier host.

The web tier can run on any Windows or Linux platform running any language character set. The
Teamcenter web tier converts client character encoding to and from UTF-8 as it passes through the
web tier.

The following example shows a Teamcenter configuration for restricted Unicode UTF-8 character set
support with clients displaying multiple locales. Servers in this configuration run a Unicode UTF-8
character set operating system.

On Windows platforms, if the database is configured for the UTF-8 character set, the Teamcenter server
operates in UTF-8 mode independent of the system locale.

5-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Overview of UTF-8 configuration

Unicode homogeneous server platform configuration

• Teamcenter does not support Unicode Supplementary Characters.2

• If you import translated content in languages that require multibyte characters, such as Russian and
Chinese Simplified, you must configure your Teamcenter installation to support the UTF-8
character set to ensure that titles and other properties display correctly in your environment.

2 Unicode Supplementary Characters are characters in the Unicode Character Standard outside of the Basic Multilingual
Plane (BMP), that is, characters with code point values larger than 0xFFFF.

Teamcenter Installation on Windows, Teamcenter 14.2 5-9

© 2022 Siemens
 5. Prerequisite software and settings

Configure UTF-8 environment settings

If you use UTF-8, select the al32utf8 or utf8 character set when you install your database server.3

For Microsoft SQL Server, no special setting is needed during database server installation. If you select
the Enable UTF-8 option in TEM (in the Foundation Database panel), the Teamcenter server converts
character encoding to and from UTF-8. This allows Teamcenter to use UTF-8 with Microsoft SQL Server's
(non-UTF-8) internal encoding.4

In Hebrew locales, set the following additional variables:

1. In the TC_DATA/tc_profilevars file, set TC_XML_ENCODING to UTF-8.

2. In two-tier environments, set TC_CHARACTER_ENCODING_SET to UTF8 in the following files:

• TC_ROOT/tccs/Start_TcServer1
• TC_ROOT/pool_manager/confs/MYDB/mgrstart

Do not set the TC_XML_ENCODING or TC_CHARACTER_ENCODING_SET environment variables in the

system environment. TEM sets these values in the Teamcenter configuration.

Configuring a non-UTF-8 environment for Teamcenter

To ensure correct display and processing of Teamcenter data, set the required values in your operating
system environment. Use the appropriate values for your locale and platform.

Environment settings on non-UTF-8 systems

Value

Locale Setting Linux Microsoft Windows

Chinese Database character set zhs16cgb231280 or zhs16cgb231280 or zhs16gbk

(Simplified), (Oracle) zhs16gbk
GB2312-80
encoding Database collation N/A chinese_prc_bin
Notes:
1. The database collation you select during Microsoft SQL Server installation determines the database character set.
2. Set LANG and LC_ALL in the system environment variables. These variables must have identical values to function
properly.
3. we8iso8859p15 contains additional characters, including the euro symbol (€).
4. we8mswin1252 contains more characters than ISO-8859-15.
5. No ISO-8859-15 equivalent is available for this locale.
6. Siemens Digital Industries Software does not provide a Hebrew translation. The configuration settings shown allow
data entry in Hebrew, but user interface text is in English.
7. If you migrate to ko16ksc5601 from UTF-8, some data may be truncated. You must modify truncated valued because
Teamcenter does not support modifying the default field size.

3 Oracle recommends al32utf8. UTF8 supports only supports Unicode Version 3.0 and earlier.
4 Microsoft SQL Server does not provide native support for UTF-8 character set encoding.

5-10 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configuring a non-UTF-8 environment for Teamcenter

Value

Locale Setting Linux Microsoft Windows

(MS SQL Server)1

LANG and LC_ALL2 zh_CN N/A

Chinese Database character set zhs16cgb231280 or zhs16cgb231280 or zhs16gbk

(Simplified), GBK (Oracle) zhs16gbk
encoding
Database collation N/A chinese_prc_bin
(MS SQL Server)1

LANG and LC_ALL2 zh_CN.gb18030 N/A

Chinese Database character set zht16big5 or zht16big5 or zht16mswin950

(Traditional) (Oracle) zht16mswin950

Database collation N/A chinese_taiwan_stroke_bin

(MS SQL Server)1

LANG and LC_ALL2 zh_TW N/A

Czech Database character set ee8mswin1250 ee8mswin1250

(Oracle)

Database collation N/A czech_bin

(MS SQL Server)1

LANG and LC_ALL2 cs_CZ N/A

English Database character set we8iso8859p1 or we8iso8859p1 or we8iso8859p153 or

(Oracle) we8iso8859p153 or we8mswin12524
we8mswin12524

Database collation N/A latin1_general_bin

(MS SQL Server)1

LANG and LC_ALL2 en_US or en_US.iso885915 N/A

French Database character set we8iso8859p1 or we8iso8859p1 or we8iso8859p153 or

(Oracle) we8iso8859p153 or we8mswin12524
we8mswin12524

Database collation N/A latin1_general_bin

(MS SQL Server)1

LANG and LC_ALL2 fr_FR5 N/A

Notes:
1. The database collation you select during Microsoft SQL Server installation determines the database character set.
2. Set LANG and LC_ALL in the system environment variables. These variables must have identical values to function
properly.
3. we8iso8859p15 contains additional characters, including the euro symbol (€).
4. we8mswin1252 contains more characters than ISO-8859-15.
5. No ISO-8859-15 equivalent is available for this locale.
6. Siemens Digital Industries Software does not provide a Hebrew translation. The configuration settings shown allow
data entry in Hebrew, but user interface text is in English.
7. If you migrate to ko16ksc5601 from UTF-8, some data may be truncated. You must modify truncated valued because
Teamcenter does not support modifying the default field size.

Teamcenter Installation on Windows, Teamcenter 14.2 5-11

© 2022 Siemens
 5. Prerequisite software and settings

Value

Locale Setting Linux Microsoft Windows

German Database character set we8iso8859p1 or we8iso8859p1 or we8iso8859p153 or

(Oracle) we8iso8859p153 or we8mswin12524
we8mswin12524

Database collation N/A latin1_general_bin

(MS SQL Server)1

LANG and LC_ALL2 de_DE5 N/A

Hebrew6 Database character set iw8iso8859p8 or iw8iso8859p8 or iw8mswin1255

(Oracle) iw8mswin1255

Database collation N/A hebrew_bin

(MS SQL Server)1

LANG and LC_ALL2 iw_IL.utf8 N/A

Italian Database character set we8iso8859p1 or we8iso8859p1 or we8iso8859p153 or

(Oracle) we8iso8859p153 or we8mswin12524
we8mswin12524

Database collation N/A latin1_general_bin

(MS SQL Server)1

LANG and LC_ALL2 it_IT5 N/A

Japanese (EUC) Database character set ja16euc ja16euc

(Oracle)

Database collation N/A N/A

(MS SQL Server)1

LANG and LC_ALL2 ja_JP.eucjp N/A

Japanese (Shift-JIS) Database character set ja16sjis ja16sjis

(Oracle)

Database collation N/A japanese_bin

(MS SQL Server)1

LANG and LC_ALL2 ja_JP.sjis N/A

Korean Database character set ko16ksc56017 ko16ksc56017

(Oracle)

Database collation N/A korean_wansung_bin

Notes:
1. The database collation you select during Microsoft SQL Server installation determines the database character set.
2. Set LANG and LC_ALL in the system environment variables. These variables must have identical values to function
properly.
3. we8iso8859p15 contains additional characters, including the euro symbol (€).
4. we8mswin1252 contains more characters than ISO-8859-15.
5. No ISO-8859-15 equivalent is available for this locale.
6. Siemens Digital Industries Software does not provide a Hebrew translation. The configuration settings shown allow
data entry in Hebrew, but user interface text is in English.
7. If you migrate to ko16ksc5601 from UTF-8, some data may be truncated. You must modify truncated valued because
Teamcenter does not support modifying the default field size.

5-12 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configuring a non-UTF-8 environment for Teamcenter

Value

Locale Setting Linux Microsoft Windows

(MS SQL Server)1

LANG and LC_ALL2 ko_KR.EUC N/A

Polish Database character set ee8mswin1250 ee8mswin1250

(Oracle)

Database collation N/A polish_bin

(MS SQL Server)1

LANG and LC_ALL2 pl_PL.ISO8859-2 N/A

Portuguese Database character set we8iso8859p1 or we8iso8859p1 or we8iso8859p153 or

(Brazilian) (Oracle) we8iso8859p153 or we8mswin12524
we8mswin12524

Database collation N/A latin1_general_bin

(MS SQL Server)1

LANG and LC_ALL2 pt_BR5 N/A

Russian Database character set cl8mswin1251 or cl8mswin1251 or cl8iso8859p5

(Oracle) cl8iso8859p5

Database collation N/A cyrillic_general_bin

(MS SQL Server)1

LANG and LC_ALL2 ru_RU N/A

Spanish Database character set we8iso8859p1 or we8iso8859p1 or we8iso8859p153 or

(Oracle) we8iso8859p153 or we8mswin12524
we8mswin12524

Database collation N/A latin1_general_bin

(MS SQL Server)1

LANG and LC_ALL2 es_ES5 N/A

Notes:
1. The database collation you select during Microsoft SQL Server installation determines the database character set.
2. Set LANG and LC_ALL in the system environment variables. These variables must have identical values to function
properly.
3. we8iso8859p15 contains additional characters, including the euro symbol (€).
4. we8mswin1252 contains more characters than ISO-8859-15.
5. No ISO-8859-15 equivalent is available for this locale.
6. Siemens Digital Industries Software does not provide a Hebrew translation. The configuration settings shown allow
data entry in Hebrew, but user interface text is in English.
7. If you migrate to ko16ksc5601 from UTF-8, some data may be truncated. You must modify truncated valued because
Teamcenter does not support modifying the default field size.

In Hebrew locales, set the following additional variables:

1. In the TC_DATA/tc_profilevars file, set TC_XML_ENCODING to ISO-8859-8.

Teamcenter Installation on Windows, Teamcenter 14.2 5-13

© 2022 Siemens
 5. Prerequisite software and settings

2. In two-tier environments, set TC_CHARACTER_ENCODING_SET to ISO8859_8 in the following

files:

• TC_ROOT/tccs/Start_TcServer1
• TC_ROOT/pool_manager/mgrstartMYDB

Do not set the TC_XML_ENCODING or TC_CHARACTER_ENCODING_SET environment variables in the

system environment. TEM sets these values in the Teamcenter configuration.

5-14 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 6. Installing a database server
Install a database server

Teamcenter requires a supported relational database management system (RDBMS) for storing
Teamcenter data. Before you begin installing Teamcenter, you must install and configure one of the
following supported database systems:

• Oracle

• Microsoft SQL Server

Before proceeding with database server installation, make sure you are correctly licensed through your
database vendor for the database edition you install.

For information about database versions supported for use with Teamcenter, see Support Center.

Because of Teamcenter's high resource demands, Siemens Digital Industries Software recommends a
dedicated database server. At a minimum, there should be a dedicated database instance for
Teamcenter. This allows the instance to be tuned specifically for Teamcenter.

Install and configure Oracle

Preparing the Oracle server

Your Oracle database server must be a version certified for use with Teamcenter 14.2. For information
about certified Oracle versions, Oracle disk space requirements, and operating system and service
patch requirements, see the Hardware and Software Certifications knowledge base article on Support
Center.
You may choose to create a new Oracle database or upgrade existing Oracle databases. Install a
certified version of Oracle Server if a certified version is not installed on the system. For certified Oracle
versions and disk space requirements, see the Hardware and Software Certifications knowledge base
article on Support Center.
Teamcenter 12 and later versions support pluggable databases (PDB) with container databases (CDB) if
you use Oracle 12c or later.

You can install Oracle from either of the following sources:

• Oracle software kit supplied by Siemens Digital Industries Software

• Oracle software kit supplied by Oracle Corporation

Prepare an Oracle database server and configure an Oracle database for Teamcenter:

Teamcenter Installation on Windows, Teamcenter 14.2 6-1

© 2022 Siemens
 6. Installing a database server

1. Choose a name for the Oracle user for the Teamcenter database. Teamcenter uses this account as
the owner of all Teamcenter-created tables. This account is used by the database administrator to
perform tasks required by Teamcenter.

2. If you do not have a certified version of Oracle, install or upgrade Oracle:

• If you do not have an Oracle server installed, install a certified version of Oracle.

• If you have an Oracle server installed, but it is not a version certified for Teamcenter 14.2,
upgrade your Oracle server.

3. Configure Oracle software for Teamcenter.

4. Create a database for Teamcenter.

To ensure correct character mapping, make sure the database and the Teamcenter server use the same
encoding.

Additional database instances

Create a database instance if one does not exist or if an additional database instance is required, for
example, to support testing, training, or Repeatable Digital Validation (RDV).

If you are installing Repeatable Digital Validation (RDV) services, Siemens Digital Industries Software
recommends strongly that you create a new database instance on an Oracle server with database
partitions on a separate drive. RDV requires extensive data warehousing with large uploads and simple
queries. Such a configuration also makes the fine-tuning of the database easier.

A separate RDV database is not required if you use cacheless search.

Upgrade an Oracle server and database

Export an Oracle database

1. Log on to the Oracle server as an administrator user.

2. Export the contents of your Teamcenter Oracle database to the dump file:

ORACLE_HOME\bin\expdp db-user/password full=y dumpfile=file-name.dmp

logfile=export.log

Replace db-user with the Teamcenter database user account name; replace password with the
database user account password; replace file-name with the full path and name of the dump file to
contain the exported data; replace export with the name of the log file to contain export output.

3. Store the dump file in a safe place.

6-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Stop the listener process

If you have multiple databases, repeat this procedure for each database.

Caution:
Siemens Digital Industries Software strongly recommends backing up the dump file on tape or
another disk. If the dump file becomes corrupted or lost, all data from the existing database is lost.

Terminate Oracle sessions

Stop the listener process

1. Log on to the operating system as a user with administrator privileges.

2. Open the Services dialog box in the Windows Control Panel.

3. Select the Oracle TNS listener services (Oraclerelease-IDTNSListener) and click Stop.

Shut down an Oracle database

Shut down Oracle using Windows Control Panel

1. Log on to the operating system as a user with administrator privileges.

2. Open the Services dialog box in the Windows Control Panel.

Windows displays the Services window.

3. Select the OracleServiceSID service.

Replace SID with the system identifier of the database instance.

4. Click Stop.

Shut down Oracle using SQL*Plus

1. Log on to the operating system as a user with administrator privileges.

2. Start the Oracle SQL*Plus utility:

sqlplus sys/password@Oracle-SID as sysdba

Replace password with the password for the sys user account.

Oracle starts the Oracle SQL*Plus utility.

Teamcenter Installation on Windows, Teamcenter 14.2 6-3

© 2022 Siemens
 6. Installing a database server

The sys user must be in the Oracle sysdba group for the Oracle system identifier (SID) used by
Teamcenter. To connect as internal (without a password), the account must be part of the
ORA_DBA local group in Windows.

3. Shut down the database instance by typing the following command:

shutdown

4. Exit SQL*Plus:

exit

Back up an Oracle installation

If you are upgrading to the certified Oracle version, back up the existing Oracle installation.

Back up the following files and directories:

• The Oracle home directory on each installed workstation.

• The directories containing database files for each configured database.

• The Oracle Net listener.ora and tnsnames.ora configuration files.

These are the only Teamcenter directories affected by Oracle installation. If you created other directories
containing data used by Oracle, such as an administration script directory, you should also back up these
directories.

Upgrading an Oracle server

Upgrade the Oracle server

Upgrade your Oracle server by one of the following methods:

• Upgrade using the Oracle installer

• Upgrade by uninstalling/reinstalling Oracle

Upgrade using the Oracle installer

1. Launch the Oracle installer to install a certified version of Oracle server.

2. When the Oracle installer prompts you to upgrade existing databases, enter the required
information about the databases you want to upgrade.

6-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Migrate a non-CDB database to a CDB database

Upgrade by uninstalling/reinstalling Oracle

1. Remove existing Oracle databases.

2. Uninstall all existing Oracle server software.

3. Install a certified version of Oracle server. Then, configure Oracle and create an Oracle
database.

4. After Oracle installation is complete, import your Teamcenter database from the Oracle dump file
into the new Oracle database. Enter the following command on a single line:

ORACLE_HOME\bin\imp db-user/password fromuser=db-user touser=db-user

file=file-name.dmp log=import.log

Replace db-user with the Teamcenter database user account name, password with the database
user account password, file-name with the full path and name of the dump file that contains the
exported data, and import with the name of the log file.

Migrate a non-CDB database to a CDB database

Teamcenter supports Oracle's multitenant database architecture if you use Oracle 12c or later. A
multitenant architecture is deployed as a Container Database (CDB) with one or more Pluggable
Databases (PDB).

A Container Database (CDB) is similar to a conventional (non-CDB) Oracle database, with familiar
concepts like control files, data files, undo, temp files, redo logs, and so on. It also houses the data
dictionary for objects owned by the root container and those that are visible to databases in the
container.

A Pluggable Database (PDB) contains information specific to the database itself, relying on the container
database for its control files, redo logs and so on. The PDB contains data files and temp files for its own
objects, plus its own data dictionary that contains information about objects specific to the PDB. From
Oracle 12.2 onward a PDB can and should have a local undo tablespace.

You can migrate a non-CDB database to a CDB database using Oracle tools. The following example
illustrates the database architectures before and after migration.

Teamcenter Installation on Windows, Teamcenter 14.2 6-5

© 2022 Siemens
 6. Installing a database server

Teamcenter supports CDB and non-CDB databases. Be aware that Oracle has deprecated support for
non-CDB databases and may discontinue support after Oracle 19c.

If you migrate a non-CDB Teamcenter database to a CDB database, you must perform the migration
after you upgrade to Teamcenter 14.2.

Install Oracle server

You can download and install Oracle from Siemens Support Center if you have purchased it from
Siemens Digital Industries Software, or by purchasing it directly from Oracle Corporation.

If you install Oracle from a hard disk, copy the entire contents of the Oracle software kit to the hard disk.

You can install Oracle application files on shared directories. However, Oracle Corporation does not
support Oracle database files on shared directories. To ensure data integrity, create database files on
local disk drives.

1. Log on to the server host as a member of the Administrators group. If you are installing on a
primary domain controller (PDC) or a backup domain controller (BDC), log on as a member of the
Domain Administrator group.

6-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install Oracle server

The operating system user account under which you install the Oracle database server must have
system administrator privileges.

The recommended approach is to create a system user account named oracle to use during Oracle
installation. When you use the oracle account to install Oracle, this account is automatically added
to the Windows ORA_DBA local group, giving it SYSDBA privileges.

2. Record the name of the Oracle database server host. Teamcenter Environment Manager requires
this name during corporate server installation.

3. In the Oracle RDBMS installation media, launch the setup program.

If you install from a DVD, the system displays the Autorun dialog box when you insert the DVD.

4. In the Configure Security Updates dialog box, specify whether and how you want to be informed
about security updates from Oracle, and then click Next.

5. In the Select Installation Option dialog box, select Install database software only, and then click
Next.

6. In the Select Database Installation Option dialog box, select Single instance database
installation, and then click Next.

7. In the Select Database Edition dialog box, select the database edition to install, and then click
Next.

Teamcenter supports Enterprise Edition and Standard Edition.

8. In the Specify Oracle Home User dialog box, specify the system account you created to install
Oracle.

9. In the Specify Installation Location dialog box, specify:

• Oracle Base

Specifies the path in which to install all Oracle software and configuration files.

• Software Location

Specifies the path in which to install Oracle software files. This is the Oracle home directory.

Do not install a later version of Oracle into an existing Oracle home directory that contains an
earlier version.

10. In the Perform Prerequisite Checks dialog box, verify that all the prerequisite checks succeeded
and click Next.

Teamcenter Installation on Windows, Teamcenter 14.2 6-7

© 2022 Siemens
 6. Installing a database server

If a check fails, review the displayed cause of the failure for that check, correct the problem, and
rerun the check.

A check occasionally fails erroneously, for example, when you install a later patch that obsoletes a
listed patch. When you are satisfied that the system meets a requirement, manually verify the
requirement by selecting the check box for the failed check.

11. In the Summary dialog box, review the information to ensure you have sufficient disk space, and
then click Install.

12. In the Install Product dialog box, monitor the success of the installation stages.

13. When the Finish dialog box displays the The installation of Oracle Database was successful
message, click Close to complete the installation.

Configure Oracle software

Configure Oracle Net

Teamcenter uses Oracle Net protocols to communicate with an Oracle database. These protocols require
that you run a listener process (OracleTNSListener) on the Oracle server to listen for remote connect
requests and that all clients can translate the service alias identifying the server and database.

Configure Oracle listener

1. Start Oracle Net Manager. For example, choose Start→All Programs→Oracle - instance-
name→Net Manager, or search for Net Manager.

2. Create the listener.ora file:

a. Expand the Local icon.

b. Select the Listeners folder and choose Edit→Create.

c. Accept the default listener name (LISTENER) and click OK.

d. Click the Add Address button.

e. Specify the port number.

For the first listener, it is recommended you accept the default port number (1521).

6-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configure Oracle listener

Tip:
Record the number of the port used by the Oracle database server listener for entry
during corporate server installation. Teamcenter Environment Manager requires this
port number.

f. In the Local tree, click Profile.

g. In the Naming list (to the right of the Oracle Net Configuration tree), choose General.

h. Click the Advanced tab.

i. In the TNS Time Out Value box, type 10.

This step sets the Oracle server-side SQLNET.EXPIRE_TIME parameter. This value determines
how often the Oracle server checks for aborted client connections. Teamcenter requires that
this parameter be set to a nonzero value, and the recommended value is 10 (10 minutes).

j. Select the Service Naming folder and choose Edit→Create.

k. Type the Net Service Name for your pluggable database and then click Next.

l. Select TCP/IP (Internal Protocol) and then click Next.

m. Enter the host name for your Oracle server and then click Next.

If you chose to not use the default port during database creation, change the Port Number.

3. Type the Service Name and then click Next.

4. Click Test…

5. Change the Login value to the system user name and the Password value to the system password
used during database installation and then click Test.

6. After the connection test is successful, click Close.

7. Click Finish.

8. Save the listener information, choose File→Save Network Configuration.

Oracle Net Manager saves the listener information and creates the network\admin\listener.ora
and network\admin\sqlnet.ora files in the Oracle home directory.

9. Exit Oracle Net Manager, choose File→Exit.

Teamcenter Installation on Windows, Teamcenter 14.2 6-9

© 2022 Siemens
 6. Installing a database server

10. In a command prompt, create and start the listener service:

cd ORACLE_HOME\bin
lsnrctl start LISTENER

Replace ORACLE_HOME with the path to the directory where you installed the Oracle server, for
example, d:\app\tcdba\product\12.2.0\dbhome_1. This command creates and starts the service if
it does not exist. If the service exists, the command starts it.

Create an Oracle database

Create an Oracle database instance with Oracle Database Configuration Assistant (DBCA). Siemens
Digital Industries Software provides two templates for creating the Teamcenter database:

• Teamcenter_Oracle template is used to create a traditional non-CDB database instance with Oracle
user accounts and tablespaces.

• Teamcenter_Oracle_multitenant template is used to create a Container and Pluggable database

instance where the two databases are identified by their Oracle service names. Teamcenter supports
the Oracle 12c multitenant architecture.

The following are key considerations when creating an Oracle Container (CDB) database instance in the
Oracle multitenant architecture with Oracle 12c:

• Teamcenter Oracle database tablespaces and the Teamcenter Oracle user account are always created
in the pluggable database.

• Teamcenter cannot be installed into the container database. TEM detects if a Container database is
specified and does not allow the Teamcenter installation to proceed.

• The Teamcenter tablespaces are not created using the DBCA template, as this is not supported by
Oracle. After you configure the pluggable database, you can manually create a tablespace for the
pluggable database, or allow Teamcenter to create the tablespace automatically.

Using the existing non-CDB template does create tablespaces.

For best performance and reliability, database parameters set by Teamcenter templates should be
customized to suit your installation. This can be performed by your Oracle administrator after
Teamcenter installation is complete.

Teamcenter Environment Manager (TEM) verifies your Oracle version during installation. If your Oracle
server does not meet the minimum required version, TEM does not allow installation to proceed. For
information about supported database servers, see the Hardware and Software Certifications knowledge
base article on Support Center.

1. Make sure you have access to the Teamcenter software kit.

6-10 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Create an Oracle database

2. Log on to the Oracle server host as a user who is a member of the ORA_instance-name_DBA
group. This may be the user who installed Oracle on the server host or one assigned to
ORA_instance-name_DBA by a member of the ORA_instance-name_DBA group.

3. Copy the Siemens Digital Industries Software-supplied Oracle database template files:

a. Access the Teamcenter software kit.

b. Copy all files in the tc\dbscripts\oracle directory on the Teamcenter software kit to the
templates directory of the Oracle installation. For example:

copy e:\tc\db_scripts\oracle\* ORACLE_HOME\assistants\dbca\templates

c. Repeat step b, copying files from the same directory on the Teamcenter 14.2 software kit.

4. Make sure you are logged on as the Oracle user.

5. Start Oracle Database Configuration Assistant (DBCA). For example:

Start→All Programs→Oracle - instance-name→Database Configuration Assistant

Alternatively, search for Database Configuration Assistant.

6. In the Select Database Operation dialog box, select Create a database and click Next.

7. In the Select Database Creation Mode dialog box, select Advanced configuration and click Next.

8. In the Select Database Deployment Type dialog box, in the list of templates, select the
appropriate template:

• If you use a non-container (non-CDB) database, select the Teamcenter_Oracle template.

• If you use a container (CDB) database, select the Teamcenter_Oracle_multitenant template.

If you use a CDB database, the DBCA templates do not create tablespaces. The template no longer
configures tablespaces for pluggable databases.

9. In the Specify Database Identification Details dialog box, enter the appropriate values according
to the type of database you use:

• Container database:

a. Accept the default database name in the Global Database Name box or type a different
name and click Next.

Teamcenter Installation on Windows, Teamcenter 14.2 6-11

© 2022 Siemens
 6. Installing a database server

The SID box is automatically filled in with the name you enter in the Global Database
Name box.

Tip:
Record the SID of the Oracle instance for entry during corporate server installation.
Teamcenter Environment Manager requires this name.

b. Select the Create as Container Database check box.

The Create a Container Database with one or more PDBs radio button is selected by
default. Do not change this setting.

c. In the PDB Name text box, type the name of the pluggable database, and then click Next.

• Traditional (non-container) database:

a. Accept the default database name in the Global Database Name box or type a different
name and click Next.

The SID box is automatically filled in with the name you enter in the Global Database
Name box.

Tip:
Record the SID of the Oracle instance for entry during corporate server installation.
Teamcenter Environment Manager requires this name.

b. In the Database Identification dialog box, either accept the default database name in the
Global Database Name box or type a different name and click Next.

The SID box is automatically filled in with the name you enter in the Global Database
Name box.

Tip:
Record the SID of the Oracle instance for entry during corporate server installation.
Teamcenter Environment Manager requires this name.

10. In the Select Database Storage Option dialog box, select Use template file for database storage
attributes.

11. In the Select Fast Recovery Option dialog box, select the Specify Fast Recovery Area check
box and accept the default values.

6-12 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Create an Oracle database

12. In the Specify Network Configuration Details dialog box, verify the listener you created and
started is running and selected in the Listener Selection tab.

If the listener is not running, start the listener and make sure it is selected before you continue.

13. In the Select Database Options dialog box, click Next.

14. In the Specify Configuration Options dialog box, select Use Automatic Shared Memory
Management, and then click Next.

15. In the Specify Management Options dialog box, accept the default selections, and then click
Next.

16. In the Specify Database User Credentials dialog box, select Use the Same Password for All
Accounts, and then enter and confirm the password.

The password you enter is applied to the SYS, SYSTEM, and PDBADMIN accounts.

17. In the Select Database Creation Option dialog box:

a. Select Create Database check box.

b. Click Next.

18. In the Summary dialog box, verify your selections, and then click Finish to begin creating the
database.

When the database is created, DBCA displays a window containing information about the created
database.

19. In the Progress Page dialog box, click Close to exit DBCA.

After the database is created, check for possible errors in the installation log files. The Oracle DBCA
displays the directory location of the installation log files in the window that contains information about
the created database after the database is created.

If this script did not execute successfully, execute it again using the Oracle SQL*Plus utility. Log on to
SQL*Plus as sysdba.

The first time Oracle Universal Installer runs, it creates the ORACLE_BASE/oraInventory/logs directory,
containing an inventory of installed components and performed actions. The most recent log file is
named installActions.log. Names of previous installation sessions are in the form installActionsdate-
time.log. For example:

installActions2008-07-14_09-00-56-am.log

Teamcenter Installation on Windows, Teamcenter 14.2 6-13

© 2022 Siemens
 6. Installing a database server

You can also view a list of installed components by choosing Installed Products on any Oracle Universal
Installer window. Do not delete or manually alter the Inventory directory or its contents. Doing so can
prevent Oracle Universal Installer from locating products you installed on the system.

Configure the pluggable database

If you use a container (CDB) database, create the Teamcenter Oracle user and set permissions for the
pluggable database:

1. Open SQL*Plus and type the following command to connect to the container database:

connect user/password;

Replace user and password with the Oracle administrator user name and password. For example:

connect system/manager;

2. Type the following command to set the pluggable database so the Teamcenter Oracle user is
created inside the pluggable database.

alter session set container=Tc-Oracle-user;

For example:

connect alter session set container=tcpdb;

If successful, SQL*Plus responds:

Session altered.

3. Set privileges for the Teamcenter Oracle user:

grant connect, create table, create tablespace, create procedure,

create view, create sequence, select_catalog_role, alter user,
alter session to Tc-Oracle-user identified by Tc-Oracle-user;

If successful, SQL*Plus responds:

Grant succeeded.

Create a tablespace for the pluggable database

You can manually create a tablespace for the pluggable database using the following steps. If you do not
perform these steps, Teamcenter automatically creates a tablespace with the default size.

1. Open a command prompt and log on to sqlplus as the Oracle administrator, for example, system.

6-14 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install Microsoft SQL Server

2. Create a new tablespace for the pluggable database:

create tablespace tablespace-name datafile 'dbf-path/dbf-filename' size dbf-sizeM;

Replace tablespace-name with the tablespace name. Replace dbf-path, dbf-file, and dbf-size with
the path, file name, and size of the database file in megabytes. For example:

create tablespace tcpdb datafile 'D:\apps\oracle\oradata\tc\tcpdb.dbf' size 100M;

3. Grant all permissions on the new tablespace to the Teamcenter Oracle user:

a. Enter:

alter user Tc-Oracle-user quota dbf-sizeM on tablespace-name;

For example:

alter user tcdba quota 100M on tcpdb;

b. Enter:

grant unlimited tablespace to Tc-Oracle-user;

4. Log off sqlplus by typing exit.

Install and configure Microsoft SQL Server

Install Microsoft SQL Server

The steps to install Microsoft SQL Server and to configure a database for Teamcenter depend on your
operating system, your edition of SQL Server, and your selections during installation.

To optimize MS SQL Server database performance, consider the following steps:

• To implement a Teamcenter network incrementally at multiple sites, configure each site in a Multi-
Site Collaboration environment with separate hosts for the MS SQL database server (including Multi-
Site Collaboration), the rich client, and volume servers, starting with the first phase. This allows you
to configure and manage the network consistently, as you scale it in each phase. You can add CPUs,
memory, and disks to the appropriate servers or deploy additional servers as required, without
moving or reconfiguring server processes on different hosts or changing operational procedures.

• For large or critical system implementations, implement high-availability systems with mirrored, dual-
ported disk arrays. For the Teamcenter volume, consider a file server with storage attached network
(SAN) or network attached storage (NAS) disk arrays.

Teamcenter Installation on Windows, Teamcenter 14.2 6-15

© 2022 Siemens
 6. Installing a database server

• To minimize system maintenance interruptions, create separate file backup server hosts to process
metadata and volume data backups in real time. While the primary disk sets remain online, you can
take secondary MS SQL Server and volume disk sets offline simultaneously and back them up
together (assuring MS SQL Server and Teamcenter volume synchronization). When the backup is
complete, you can return the secondary disk sets online and resynchronize them with the primary
disk sets. The file backup servers also serve as fail-over machines.

• To ensure correct character mapping, make sure the database and the Teamcenter server use the
same encoding.

For certified versions of MS SQL Server, see the Hardware and Software Certifications knowledge base
article on Support Center. Install the MS SQL Server database server before you begin installing
Teamcenter.

The following steps reflect a typical installation on Microsoft Windows.

1. Log on to an account with system administrator privileges.

2. Launch the Microsoft SQL Server Installation Center application (setup.exe).

3. In the SQL Server Installation Center dialog box, click Installation in the navigation pane on the
left side.

4. Click New SQL Server stand-alone installation or add features to an existing installation.

The SQL Server Installation Center launches the SQL Server Setup wizard.

5. Proceed through the pre-installation tests and other initial setup panes to the Install Setup Files
pane. Click Install to install SQL Server setup support files.

After setup support files are installed, the wizard displays the Install Rules pane. Click Next.

6. In the Feature Selection pane, select Instance Features→Database Engine Services and any
other features you want to include.

Click Next.

7. In the Instance Configuration pane, select an instance type. Teamcenter supports both Default
Instance and Named Instance.1

A default instance in a Microsoft SQL Server installation uses the name MSSQLSERVER.
Teamcenter's persistent object manager (POM) utilities cannot connect to an instance with this

1 If you choose Named Instance, make sure you start the SQL Browser service before connecting to the database. If this
service is not enabled, you can change these settings using the SQL Server Configuration Manager after installation is
complete.

6-16 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install Microsoft SQL Server

name. If you use a default instance, make sure you connect to the instance using a port connection
rather than the name.

If you use a named instance, make sure the instance has a unique name other than
MSSQLSERVER.

8. Enter remaining instance configuration values, and then click Next,

9. Proceed to the Server Configuration pane.

a. Click the Service Accounts tab.

b. Enter account information for starting SQL Server services.

The SQL Server Setup wizard validates user accounts for SQL Server services. Make sure the
accounts you enter exist on the host.

c. Click the Collation tab.

d. On the Collation tab, click Customize.

The wizard displays a customization dialog box for database engine collation.

e. Select Windows Collation designator and sort order.

f. In the Collation designator box, select Latin1_General and then select Binary.

g. Click OK.

h. In the Server Configuration pane, click Next.

10. Proceed to the Database Engine Configuration pane.

a. Click the Server Configuration tab.

b. Under Authentication Mode, select Mixed Mode and define a password for the SQL Server
sa logon account.

c. Specify at least one SQL Server administrator account.

d. Click Next.

11. Proceed to the Ready to Install pane and click Install to install.

Teamcenter requires the TCP/IP protocol to be enabled, but this protocol is disabled by default when you
install Microsoft SQL Server. Before you install Teamcenter, make sure you enable the TCP/IP protocol.

Teamcenter Installation on Windows, Teamcenter 14.2 6-17

© 2022 Siemens
 6. Installing a database server

For information about enabling the TCP/IP protocol in Microsoft SQL Server, see
http://technet.microsoft.com.

Create an SQL Server database

Teamcenter Environment Manager (TEM) can create and populate a SQL Server database when you
install a Teamcenter corporate server.2 If you want TEM to create your Teamcenter database
automatically, skip this topic. Otherwise, create your Teamcenter database using the SQL Server
Management Studio.

1. Make sure you have access to the Teamcenter software kit.

2. Launch Microsoft SQL Server Management Studio:

Start→Programs→Microsoft SQL Server→SQL Server Management Studio

Alternatively, search the start menu for SQL Server Management Studio.

3. In the SQL Server Connect to Server dialog box, log on using the system administrator (sa) logon
name and password.

4. Choose File→Open→File or press Control+O.

5. Browse to the tc\db_scripts\mssql directory in the Teamcenter software kit.

6. Select the create_database.sql.template file and click Open.

If SQL Server Management Studio prompts you to log on, enter the system administrator (sa) logon
name and password.

7. Edit the database template (create_database.sql.template) to replace the necessary values.

The following table describes the database parameters to replace in the template. Within the
template file, there are also comments on values that must be replaced.

Parameter Example value Description

@DB_NAME@ TC Name of the database to create.

@DATA_PATH@ D:\MSSQL_DATA Path to the directory in which to place the data file.

@USER_NAME@ tcdba Database logon name for the Teamcenter database.

@PASSWORD@ tcdbapw Password for the database logon name.

2 In the Database Engine Selection panel, TEM prompts you for database information for the SQL Server database. To
create a new database, enter new values. To connect to an existing database, enter values for the existing database. For
information about installing a corporate server, see Installing a Teamcenter corporate server.

6-18 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Create an SQL Server database

Parameter Example value Description

@COLLATION@ Latin1_General_BIN Collation sequence you want the Teamcenter database to use.
Choose the appropriate collation for your locale. The collation
value must end with _BIN.3.

Collation defines the alphabet or language whose rules are

applied when data is sorted or compared. The collation value
determines the character set used by the database server.

@LANGUAGE@ us_english Database language.

8. Save the newly modified file as filename.sql, removing the _template extension.

9. Open the new file in Microsoft SQL Server Management Studio.

10. In the SQL Editor toolbar, click Execute (or choose Query→Execute to begin creating the
database.

11. When creation of the MS SQL database instance is complete, verify the newly created database. In
the Object Explorer pane, under the MS SQL Server host name, expand the Databases tree. Verify
the new database name is included in the list of databases.

3 Do not use the default collation value that ends with _CI_AS.

Teamcenter Installation on Windows, Teamcenter 14.2 6-19

© 2022 Siemens
 6. Installing a database server

6-20 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 7. Installing Teamcenter Licenses
Obtain a Teamcenter license file

Do I need a new license file?

Determine whether you need to obtain a new Teamcenter license file, based on the process you need to
perform.

New license file

Process Example needed?

Install (No existing version) New Teamcenter 14.2 installation Yes

Upgrade (Change in major version) Teamcenter 13.x → 14.x Yes

Patch (Change in minor version) Teamcenter 14 → 14.2 No

Generate a composite host ID

To obtain a Teamcenter license file, you must provide the composite host ID of your Teamcenter license
server host.

A composite host ID (CID) is a unique identifier used as the host ID on the SERVER line of the license file.
It is distinguished from the default FlexNet host ID by the COMPOSITE keyword. It is the host ID that
associates a permanent license file with a specific server. When the CID is used as the license server host
ID, the SERVER line reads as follows:

SERVER serverA COMPOSITE=37B5ED1AC61D 28000

To obtain a composite host ID for your license server, run the getcid utility on your license server host.
Download this utility:

1. Open the Siemens Digital Industries Software support site:

https://support.sw.siemens.com

2. Click Download and Upload Files.

3. On the Siemens PLM Download Server page, click Siemens PLM Licensing.

4. Choose Product updates→CID, and then choose the platform type of your license server (Wntx64
or Lnx64).

5. Click getcid.exe to download the getcid utility.

Teamcenter Installation on Windows, Teamcenter 14.2 7-1

© 2022 Siemens
 7. Installing Teamcenter Licenses

Run the getcid.exe utility on the target license server (or on all three servers in a redundant
configuration). The utility provides the CID for license server as a 12-digit hexadecimal number. For
example:

$ getcid.exe
The Siemens PLM Software licensing composite hostid is:
”COMPOSITE=37B5ED1AC61D”

After you install the Common Licensing Server, the getcid utility is available in your license server
directory.

Generate a permanent license file

After you obtain the CID, enter it into your customer record to generate a permanent license file. After
your CID is entered into your customer record, you are sent a permanent license file to install on your
license server.

Install the License Server

Before you install Teamcenter, you must install the Siemens Digital Industries Software License Server to
distribute licenses to Teamcenter hosts. If you already installed the License Server, make sure your
version is equal to or higher than the version provided with Teamcenter 14.2.

To verify the license server version supported with Teamcenter 14.2, see the Hardware and Software
Certifications knowledge base article on Support Center.

Teamcenter employs named user licensing, which ties each user in the system to an available license
and ensures the total number of active licenses of each type in the system is always less than or equal to
the number of licenses purchased.

For descriptions of the available license types, see your license agreement documentation.

This procedure assumes you have obtained a Teamcenter license file.

1. Obtain a Teamcenter 14.2 license file from Siemens Digital Industries Software. Save the license
file in a directory accessible to the license server host. This procedure assumes the license file is
named tc.lic, but you may give the license file any name you choose.

If you choose to install Teamcenter using a temporary license file, edit the temporary license file to
reflect your designated Teamcenter corporate server host.

a. Open the license file in a plain text editor and locate the following line in the file:

SERVER YourHostname ANY 28000

7-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the License Server

b. Replace YourHostname with the host name of the designated license server host. Update
your Siemens Digital Industries Software customer service representative with your license
server host information.

c. Save the changes to the license file.

Siemens Digital Industries Software recommends you do not change the license server port from
its default value (280001) unless it is necessary to resolve a port conflict.

Record the host name and port for the license server. Teamcenter Environment Manager (TEM)
prompts you for these values during Teamcenter server installation.

2. Set the SPLM_LICENSE_SERVER environment variable to the following value on the designated
Teamcenter corporate server host:

port@host

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

The value of this variable is designated as the default local license server during corporate server
upgrade. TEM verifies that the specified license server exists and is running a supported version of
the Siemens Digital Industries Software common licensing server. If the configured license server is
not valid, the upgrade is stopped until a valid license server is installed.

3. Set the TCP_NODELAY environment variable to 1 on the licensing server host. This helps optimize
logon time when launching Teamcenter.

4. Download the Siemens Digital Industries Software License Server installation program
(SPLMLicenseServer_version_setup.exe) from Support Center to a temporary directory on your
local hard drive.

5. Launch the License Server installation program:

a. Launch the SPLMLicenseServer_version_setup.exe program.

b. During license server installation, enter the following values:

• Destination location for the license server

• Location of the Teamcenter license file (tc.lic)

1 Port 28000 is registered for the License Server with the Internet Assigned Numbers Authority (IANA). For more
information, see http://www.iana.org/assignments/port-numbers.

Teamcenter Installation on Windows, Teamcenter 14.2 7-3

© 2022 Siemens
 7. Installing Teamcenter Licenses

When the installation is complete, the license server installation program starts the license
daemon (ugslmd).

Caution:
The License Server must be running and two or more seats must be available on that license
server during Teamcenter server installation. Otherwise, database creation fails because the
make_user utility cannot create the required users in the database.

Information about installing the Siemens Digital Industries Software Common License Server is available
in the License Server documentation in the software download page on the Siemens Digital Industries
Software support site. This documentation is available under Siemens PLM Licensing→Product
updates→Documentation.

7-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 8. Installing Security Services
Install the Web Application Manager for Security Services

Locate the Security Services installation package

In the Teamcenter software kit, locate the Security Services installation package:

Windows:

kit-location\additional_applications\sso\TcSecurityServices14.2_date.zip

Linux:

kit-location/additional_applications/sso/TcSecurityServices14.2_date.zip

Expand this package to a local directory on your Security Services machine. This local directory is
referenced as TCSS_ROOT.

Install the Web Application Manager

1. Create a home directory for the Security Services web applications on your Security Services
machine. For example:

Windows: c:\webroot

Linux: /webroot

This directory is referenced as WEB_ROOT.

2. Expand the Web Application Manager files:

Windows:

a. Browse to the TCSS_ROOT\TcSecurity\default directory.

b. Double-click the INSTALL_TCWEB.EXE program icon.

7-Zip displays a self-extractor dialog box.

c. In the Extract to box, type the path to WEB_ROOT, and then click Extract.

After 7-Zip extracts the installation files, close the self-extractor dialog box.

Teamcenter Installation on Windows, Teamcenter 14.2 8-1

© 2022 Siemens
 8. Installing Security Services

Linux:

a. Change to the WEB_ROOT directory.

b. Type the following command to extract Web Application Manager files to your host:

cat TCSS_ROOT/TcSecurity/default/INSTALL_TCWEB.TZ |
uncompress -c | tar xvf -

Note:
On Red Hat Linux systems, use the gzip command instead of uncompress to
extract INSTALL_TCWEB.TZ file:

cat TCSS_ROOT/TcSecurity/default/INSTALL_TCWEB.TZ | gzip

-d | tar xvf -

Expand Security Services ICD files

1. Create a home directory for the Security Services installable component descriptor (ICD) files.1 For
example:

Windows: c:\tcss_icd

Linux: /tcss_icd

This directory is referenced as TCSS_ICD.

2. Expand the Security Services ICD files:

Windows:

a. Browse to the TCSS_ROOT\TcSecurity\default directory.

b. Double-click the INSTALL_SSO.EXE program icon.

7-Zip displays a self-extractor dialog box.

c. In the Extract to box, type the path to TCSS_ICD, and then click Extract.

After 7-Zip extracts the ICD files, close the self-extractor dialog box.

Linux:

1 ICD files provide solution information to the Web Application Manager.

8-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install Security Services web applications

a. Change to the TCSS_ICD directory.

b. Type the following command to extract Security Services ICD files to your host:

cat TCSS_ROOT/default/INSTALL_SSO.TZ | uncompress -c | tar

xvf -

Note:
On Red Hat Linux systems, use the gzip command instead of uncompress to
extract INSTALL_SSO.TZ file:

cat TCSS_ROOT/default/INSTALL_SSO.TZ | gzip -d | tar xvf -

3. If you want to install an additional locale for Security Services, repeat step 2, with the following
changes:

• Replace the default directory under TcSecurity with the directory corresponding to the locale
you want to install:

Chinese (Simplified): zh_cn German: de_de Polish: pl_pl

Chinese (Traditional): zh_tw Italian: it_it Portuguese (Brazilian): pt_br
Czech: cs_cz Japanese: jp_jp Russian: ru_ru
French: fr_fr Korean: ko_ko Spanish: es_es

• Replace INSTALL_SSO.EXE|TZ with INSTALL_SSO_locale.EXE|TZ.

Install Security Services web applications

The Security Services login service and identity service are Java EE web applications that provide the
essential functions of Security Services. Build these applications using the Web Application Manager and
deploy them on a supported Java EE web application server.

The Web Application Manager requires a supported Java Runtime Environment (JRE). For supported web
application servers and Java Runtime Environments, see the Hardware and Software Certifications
knowledge base article on Support Center.

Note:
If you deploy Security Services on JBoss/Wildfly, you must enable Apache JServ Protocol (AJP)
before you configure the SSO gateway. Enable AJP as described in one of the following topics in
the Web Application Deployment guide:

Teamcenter Installation on Windows, Teamcenter 14.2 8-3

© 2022 Siemens
 8. Installing Security Services

• Deploy the Teamcenter web application on JBoss (H-S)

• Deploy on a JBoss application server (H-S)

Build the Login Service web application

1. Launch the Web Application Manager.

Windows: Browse to the WEB_ROOT directory and double-click the insweb.bat program icon.

Linux: Change to the WEB_ROOT directory and type the insweb command.

2. Load Security Services ICD files. This populates the list of solutions available to install.

a. Click Copy ICDs.

b. In the Copy ICD Files dialog box, click Browse.

c. Browse to the TCSS_ICD directory, select the icd directory, and then click Open.

d. In the Copy ICD Files dialog box, click OK to load ICD files.

3. Click Add to begin creating a web application.

The Web Application Manager displays the Add Web Application dialog box.

4. In the Name box, type a name for the application, for example, TcLoginService.

5. In the Staging Location box, enter a path where you want to place the web application files.
Typically, this is a directory under the WEB_ROOT directory. Web Application Manager creates the
directory if it does not exist.

Optionally, in the Description box, type a description of the application.

6. Enter advanced web application options. Click Advanced Web Application Options and enter
values in the Advanced Web Application Options dialog box:

a. In the Deployable File Name box, type a name for the web application WAR file, for example,
TcLoginService.

Leave the Automatically Build Deployable File check box selected.

b. Set the Session Timeout value 600, as 600 minutes is the default session timeout set for the
Identity Service sessionLifetime parameter.

8-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install Security Services web applications

c. Leave the default values for remaining advanced options and click OK to return to the Add
Web Application dialog box.

7. Enter software locations:

a. Clear the Disk Locations for Install Images list by selecting any default paths shown and
clicking Remove.

b. Click Add.

c. In the Add Disk Location dialog box, browse to the path to the Security Services web
application files, and then click OK:

Windows: TCSS_ROOT\TcSecurity\default

Linux: TCSS_ROOT/TcSecurity/default

d. If you want to install an additional locale for Security Services, repeat step c to add the path to
the locale-specific software:

Windows: TCSS_ROOT\TcSecurity\locale

Linux: TCSS_ROOT/TcSecurity/locale

8. Click Solutions.

9. In the Select Solutions dialog box, select solutions to include in the web application:

a. Select Teamcenter Security Services Login Service Web Application.

If you have Teamcenter 13.2 or earlier clients that you are not yet able to update, select the
Teamcenter Security Services Login Service Web Application - COMPATIBLE solution
instead.

b. If you are installing an additional locale for Security Services, select Teamcenter Security
Services Login Service Web Application Localization language).

c. Optionally, select Teamcenter Security Services Java API Documentation. This solution
provides a reference of APIs exposed by the Login Service and Identity Service.

d. Click OK to continue. The Selected Solutions box shows the solutions selected for
installation.

Teamcenter Installation on Windows, Teamcenter 14.2 8-5

© 2022 Siemens
 8. Installing Security Services

Note:
The Solution Type box cannot be changed from its default value, Web Tier.

10. Click OK to begin building the web application.

When the web application creation is complete, click OK to close the Progress dialog box.

Build the Identity Service web application

To build the Security Services Identity Service web application, repeat the steps in Build the Login
Service web application, with the following differences:

• Skip step 2 because ICD files are already loaded.

• For the Name and Deployable File Name values of the web application, enter a name for the Identity
Service, for example, TcIdentityService.

• In the Select Solutions dialog box, select the Teamcenter Security Services Identity Service Web
Application.

If you have Teamcenter 13.2 or earlier clients that you are not yet able to update, select the
Teamcenter Security Services Identity Service Web Application - COMPATIBLE solution instead.

Deploy Security Services web applications

Locate the deployable files generated by the Web Application Manager for the Security Services Login
Service and the Security Services Identity Service. These files are in the deployment directory under the
staging location you specified for each application.

For example:

Windows:

c:\webroot\staging1\deployment\TcLoginService.war

c:\webroot\staging2\deployment\TcIdentityService.war

Linux:

/webroot/staging1/deployment/TcLoginService.war

/webroot/staging2/deployment/TcIdentityService.war

8-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the Session Agent

Deploy the web applications on a supported application server. Deployment procedures for Teamcenter
web applications on supported application servers are described in Web Application Deployment.

Note:
Make sure the Security Services web applications are installed and running before you launch
Deployment Center or TEM to install Teamcenter. These installation tools verify the connection to
Security Services do not allow installation to proceed if the connection fails.

Deploying on an IPv6 network

If your network includes client hosts running on an IPv6 network, you must deploy Security Services web
applications in an application server that supports an IPv6 URL as an external endpoint and uses IPv4
addresses to support all communication with the Teamcenter enterprise tier.

A typical environment for the Security Services web applications is a dual-stack machine that supports
both IPv4 and IPv6 addresses in which the application server accepts HTTP requests from either IPv4 or
IPv6.

Teamcenter server components that communicate within the same network are assumed to be on an
IPv4 network and are not supported on IPv6. IPv6 is supported only with Teamcenter clients or
integrations that use Teamcenter client communication system (TCCS) and Teamcenter components
that communicate with clients on IPv6-enabled networks.

Installing the Security Services Session Agent

Install the Session Agent

The Security Services Session Agent replaces Java applets (session agent, session detector, and status
reporter), making Security Services applet-free. Install the Session Agent on client machines to provide a
single sign-on experience without Java applets.

1. Close all programs before you begin installing the Session Agent.

2. Copy Session Agent installation files to your Teamcenter client host.

Windows:

a. In the Teamcenter software kit, browse to the following location:

kit-location\additional_applications\sso

b. Copy the following files to your Teamcenter client host:

install.exe
TEAMCENTER_SSO_COMMON.zip

Teamcenter Installation on Windows, Teamcenter 14.2 8-7

© 2022 Siemens
 8. Installing Security Services

TEAMCENTER_SSO_SESSIONAGENT.zip

Linux:

a. In the Teamcenter software kit, change to the following location:

kit-location/additional_applications/sso

b. Copy the following files to your Teamcenter client host:

install.bin
TEAMCENTER_SSO_COMMON.zip
TEAMCENTER_SSO_SESSIONAGENT.zip

3. On your Teamcenter client host, launch the Session Agent installation program:

Windows: Right-click the install.exe program icon and choose Run as administrator.

Linux: Enter the install.bin command.

4. Choose a language for the installation wizard, and then click OK.2

5. Proceed to the License Agreement dialog box, and select the check box to accept the terms of the
license agreement.

6. In the Choose Install Folder dialog box, enter a destination folder for the installation.

If you accept the default path, the Session Agent automatically installs in a hidden folder.

On Windows systems, if you select a path in the Program Files folder, the location is available to
any user logging onto the system.

7. Proceed to the Compatibility Settings panel.

If you have Teamcenter client applications released with Teamcenter 13.2 or earlier that you are
not yet updating, select the Install XML-RPC libraries check box. This option ensures Security
Services compatibility with earlier Teamcenter versions.

8. In the Pre-Installation Summary dialog box, verify your selections, and then click Install to install
the Session Agent.

9. If the installation is successful, a dialog window indicates the location where the Session Agent
files were installed. Click Done to close the installation wizard.

2 The list of available languages depends on your operating system locale. If the language you need is not in the list,
change your operating system locale to the correct language and restart the installation wizard.

8-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configure the Session Agent

On Windows systems, you can verify the installation of the Session Agent by locating Teamcenter
Security Services Session Agent in the list of installed programs on the machine.

Installing the Session Agent for an administrator

On Windows systems, if you want to install the Session Agent for all users on the machine, open an
administrator command prompt and enter the following command:

kit-location\wntx64\additional_applications\sso\install -DENABLE_SYS_ENV=true

Perform the rest of the steps above from step 4 on.

Launching the Session Agent installation program this way sets the TCSSO_SESSION_AGENT_PATH
environment variable as a system environment variable.

Configure the Session Agent

To enable use of the Session Agent, update all of your Teamcenter client applications to append /sa to
the end of the Teamcenter Security Services Login Service URL wherever it is configured in the client.
This /sa suffix is used by Security Services-enabled client applications such as the rich client, Active
Workspace, Teamcenter Client for Microsoft Office, NX, and Lifecycle Visualization, to indicate that the
Session Agent is required and must be started.

Note:
Do not use this modified URL anywhere on the server side, such as in load balancers, proxies and
other client-facing server services.

Sharing an instance of the Session Agent

A local administrator can install the Session Agent in a common location, and that instance can be
shared among multiple users. If an administrator has already installed the Session Agent on your client,
then set the TCSSO_SESSION_AGENT_PATH user environment variable to the location of the Session
Agent installation.

Uninstalling the Session Agent

On Windows systems, you can uninstall the Session Agent from the Windows installed programs list. In
the list, it is named Teamcenter Security Services Session Agent.

Special considerations

• Active Workspace

Teamcenter Installation on Windows, Teamcenter 14.2 8-9

© 2022 Siemens
 8. Installing Security Services

Although Active Workspace does not use the /sa suffix directly, it can be necessary if client
applications launched from Active Workspace make use of the Login Service URL configured within
Active Workspace.

• TCCS

The /tccs (browser-less) mode, typically used in Kerberos and PKI authentication, is mutually exclusive
with /sa. In other words, when /tccs is used by a rich client application, /sa cannot be used and vice
versa. With exception to Kerberos and PKI, when TCCS is used by a client application to authenticate
with a form-based authenticating reverse proxy, TCCS must be configured with a Login Service URL
that includes the /sa suffix. In this configuration, TCCS itself becomes an SSO client that employs the
Session Agent to complete authentication using a browser. For example, Teamcenter rich client is
configured in TCCS mode with a Login Service URL (such as, http://sso.host:port/LoginService/tccs),
and TCCS itself is configured with the same Login Service URL, but with an /sa suffix (such as, http://
sso.host:port/LoginService/sa).

Enabling digital signature support in the Session Agent

Previously, digital signature functions in Teamcenter (including digitally signing Teamcenter objects as
well as digital signing for Workflow tasks) were supported through an ActiveX plugin installed on the
client. Because ActiveX is no longer supported, the client-side processing for Teamcenter digital
signatures has been moved to the Security Services Session Agent.

Digital signature enablement and configuration are supported only in Deployment Center, not in
Teamcenter Environment Manager. Digital signature functions are also currently supported only on
Windows clients.

Add the Digital Signature Application

1. In Deployment Center, select your Teamcenter environment.

2. Select the Applications task.

3. Click Add or Remove Selected Applications .

4. In the Available Applications list, under Teamcenter→ Foundation, select Digital Signature.

Note:
The Digital Signature application is different from the Digital Signatures (with an s)
application under Teamcenter→ Active Workspace.

5. Click Update Selected Applications.

8-10 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Enabling digital signature support in the Session Agent

Configure Digital Signature settings in the Corporate Server

The settings required for digital signature support are stored in two places:

1. Server side: In the Teamcenter corporate server environment.

2. Client side: In the Teamcenter Security Services Session Agent environment.

The corresponding settings between these environments must match. Therefore, the settings have a
single configuration point within Deployment Center to avoid a mismatch.

1. In Deployment Center, select the Components task.

2. In the Selected Components list, select Corporate Server.

3. In the Corporate Server component settings, locate Digital Signature Settings.

4. Enter the required configuration parameters for digital signature support:

Parameter Description
Port Specifies the port on which the Session Agent listens for digital signature requests.
HMAC Secret Specifies a string secret that will be used to generate the hash-based message
authentication code (HMAC) that secures digital signature communication with the
Session Agent.

Siemens Digital Industries Software recommends that the HMAC secret be randomly generated.
Once configured, the secret will not need to be remembered by the administrator.

Configure Digital Signature settings in Session Agent

1. In the Components task, in the Selected Components list, select Teamcenter Security Service
Session Agent.

If this component is not in the Selected Components list, click Add component to your
environment , and then add the component.

2. In the Teamcenter Security Service Session Agent component settings, enter the required
configuration parameters for digital signature support:

Parameter Description
Enable Select this check box to configure the Session Agent to enable the digital signature
Digital functions. If enabled, the Session Agent process on the client machine will open an
Signature additional HTTP listener at the port specified in the Corporate Server component. If
Functions this option is disabled, the Session Agent process does not open the additional
listener.

Teamcenter Installation on Windows, Teamcenter 14.2 8-11

© 2022 Siemens
 8. Installing Security Services

Parameter Description

Note:
Some Teamcenter clients in a Teamcenter environment may require support
for digital signature functions while other clients do not. In that case, you can
add multiple Session Agent components to the environment with the Enable
Digital Signature Functions option set appropriately for each set of clients.

CORS Select this check box to define the list of origin URLs that will be returned in the
Whitelist Access-Control-Allow-Origins HTTP Header on responses sent by the digital signature
endpoints in the Session Agent. This must include the Active Workspace Gateway
URL. If this is not set correctly, the browser does not process the responses from the
digital signature endpoints.
Example:

https://MyActiveWorkspaceGatewayHost:3000

Note:
Remember that the Port and HMAC Secret values are not available in the
Session Agent parameters because they are referenced from the settings in
the Corporate Server component.

Generate and Run the Deploy Scripts

After the Corporate Server and Teamcenter Security Service Session Agent components are
configured for digital signature support, you can generate the install scripts.

In production deployments, the Session Agent is typically deployed using the Enable Mass Client
Deploy option. This means that Deployment Center generates an one install script for the server
environment and one for each client machine. If you change the digital signature settings after the
initial deployment, you must regenerate and redeploy the server script and client scripts to keep the
settings synchronized.

Moving to a new version of Security Services

To move to a new version of Security Services, perform the following steps.

1. Record your existing Security Services context parameter settings.3.

2. Remove old Security Services WAR files from your web servers, undeploy Security Services
components, and delete the old installation.

3 You can record settings for the Security Services login service and identity service in the context parameter worksheets
in Security Services Configuration.

8-12 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Moving to a new version of Security Services

3. Install the latest version of Security Services, entering the context parameter settings you recorded
in step 1.

Teamcenter Installation on Windows, Teamcenter 14.2 8-13

© 2022 Siemens
 8. Installing Security Services

8-14 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Part III: Test the Teamcenter Environment
Install Teamcenter and Active Workspace in a test
environment, including the applications and components
you want to use.
Installing a test environment allows to configure
components and identify and resolve and potential issues
before you commit your settings to a production
environment.
The Teamcenter Deployment Reference Architecture,
available from the Teamcenter Downloads area on Support
Center, provides guidelines and examples for setting up test
and development environments. It also provides sample
configurations ready to deploy in Deployment Center as
starter environments for testing.

Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
Teamcenter Installation on Windows, Teamcenter 14.2
© 2022 Siemens
 9. Installing a Teamcenter corporate server
Create a Teamcenter environment using Deployment Center

Create a new Teamcenter environment with a corporate server and common components.

Although you can install Active Workspace and Teamcenter concurrently, this procedure describes
configuration of the Teamcenter platform components only. For information about adding Active
Workspace to your environment, see Installing Active Workspace.1

For more information about using Deployment Center, see the Deployment Center Guide.

Create an environment and choose software

1. Log on to Deployment Center, and click ENVIRONMENTS.

2. On the far right below the command bar, click Add Environment .

The new environment appears highlighted in the All Environments list.

3. To view properties of the new environment, choose Overview.

If you want to edit properties such as Name and Type, click Start Edit . To save changes, click Save
Edits . To cancel changes, click Cancel Edits .

4. Choose Deploy Software to return to the Software task.

5. In the Available Software panel, select Teamcenter Foundation 14.2. Deployment Center
automatically selects the prerequisite major version, Teamcenter Foundation 14.

If you want to include Active Workspace, select Teamcenter Active Workspace 6.2 also.

Click Update Selected Software.

If the software you need is not listed, you must add it to the software repository.

6. Proceed to the Options task.

1 Installing Active Workspace requires installing the microservice framework, also described in Installing Active Workspace.

Teamcenter Installation on Windows, Teamcenter 14.2 9-1

© 2022 Siemens
 9. Installing a Teamcenter corporate server

Choose options

1. In the Options task, choose the Environment Type.

• Choose Single box to install all components on a single machine.

After you define Machine Name, OS, and Teamcenter Installation Path for one of the
components, those values are adopted by the other components.

• Choose Distributed to install components on separate machines. Machine Name, OS, and
Teamcenter Installation Path configuration values are shared only with other components that
are required to be on the same machine.

You can change the value from Distributed to Single box if an install or an update is not in
progress. For configured components that are not yet installed, Machine Name, OS, and
Teamcenter Installation Path are changed to the values specified for the corporate server
component.

2. Choose Architecture Type.

• Choose Java EE to filter component choices to the Java EE architecture.

• Choose .NET to filter component choices to the Windows .NET architecture.

If your environment already has deployed one of the architectures, the type is selected and can't be
changed.

3. When your selections are complete, click Save Environment Options to go to the Applications
task.

Choose applications

In the Applications task, the Selected Applications panel displays applications preselected by default,
based on your selected software in the Software task. If you selected only Teamcenter Foundation,

9-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Create a Teamcenter environment using Deployment Center

the Teamcenter Foundation application is preselected. If you selected additional software, additional
applications may be preselected.

1. Choose applications to include in your environment. In the Applications task, click Edit Selected
Applications to add applications.

The Available Applications panel displays the application choices. The list of available applications
is determined by the software you selected in the Software task.

2. In Available Applications, choose the applications to install. If you choose an application that has
one or more required applications associated with it, the associated applications are automatically
selected. Click Update Selected Applications to add them to the Selected Applications list.

3. If you want to remove an application that is not yet installed, deselect the application in the
Available Applications panel, and then click Update Selected Applications.

When you are satisfied with your Selected Applications list, proceed to the Components task.

Choose and configure components

In the Components task, you configure components for installation. The Selected Components list
displays required components that are automatically added based on the Selected Applications list. If
you are installing only the Teamcenter Foundation application, the following components are selected
by default:

• Corporate Server

• Database Server

• FSC2

• Licensing Server

If you selected additional applications in the Applications task, the Selected Components list may
contain additional components. You can further add more optional components from the Available
Components panel.

2 FMS server cache.

Teamcenter Installation on Windows, Teamcenter 14.2 9-3

© 2022 Siemens
 9. Installing a Teamcenter corporate server

The following steps describe configuration of the default components listed above. If you select
additional components, those components may add configuration parameters that are not described in
these steps.

1. To add optional components to your environment:

a. Click Add component to your environment to display the list of Available Components.

The list of components available for installation is determined by your selections in the
Software and Applications tasks. If a component you want is not listed, modify your
selections in those tasks.

b. In Available Components, select components to install, and then click Update Selected
Components to add them to the Selected Components list.

For information about a component, see its DESCRIPTION in the Available Components
panel.

2. Observe the configuration status of selected components.

The COMPLETE column displays the completion state for each component. The Deploy task is
enabled when the required parameters for all components are 100% complete.

Click a component in the Selected Components panel to view its configuration parameters.
Parameters for a given component can be displayed in two views:

Show all parameters

Required parameters view displays only required parameter information. Click to

expand the view to display both required and optional parameters.
Show only required parameters

All parameters view displays both required and optional parameter information.
Click to collapse the view to required parameters.

9-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Create a Teamcenter environment using Deployment Center

3. Select the Corporate Server component, enter required parameters, and then click Save
Component Settings.

Parameter Description
Machine Name Specifies the name of the machine on which you will deploy the
corporate server component.
OS Specifies the operating system of the corporate server machine.
Teamcenter Specifies the Teamcenter root directory (TC_ROOT) on the corporate
Installation Path server machine.

Teamcenter Installation on Windows, Teamcenter 14.2 9-5

© 2022 Siemens
 9. Installing a Teamcenter corporate server

Parameter Description
Make sure this path meets the requirements for the Teamcenter root
directory.
Teamcenter During a corporate server installation, the user name and password for
Administrative User the Teamcenter Administrative User are read-only. You must change
the password for this account after installation.
Login Account Specifies the user name and password for the operating system account
under which you install Teamcenter.

4. Select the Database Server component and enter required parameters.

a. In the Machine Name and OS boxes, type the machine name and operating system of the
machine on which your database server runs.

b. In Database Creation Settings, choose a database creation option and enter the required
parameters.

Database Creation Option Parameters

Create and populate database. Create Database For Oracle databases,
new data directory. Path this specifies the
No Teamcenter database or data directory location of the
exists and you want Deployment Center to tablespaces for the
create both. Teamcenter database on
the Oracle server. This is
typically ORACLE_HOME
\oradata\Oracle_SID.

For Microsoft SQL Server

databases, this specifies
the directory in which to
create the Teamcenter
database on the SQL
Server server.

Populate database. Create new data No special parameters for this option.
directory.
A database exists but is not populated with
Teamcenter data. You want Deployment
Center to populate the database and create
a new data directory.
Copy Environment using existing In Volume Information, click Add Row , and
populated database. then type the VOLUME NAME and ORIGINAL
HOST of the database you want to copy from,
and a COPIED VOLUME PATH for the new data
directory.

9-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Create a Teamcenter environment using Deployment Center

Database Creation Option Parameters

A database exists and is populated. You
want Deployment Center to use this
database and create a new data directory.

c. Enter remaining Database Settings according to your database type.

Oracle

Parameter Description
Database Select Oracle.
Server
Oracle Specifies a database user name:
Database User
• If you chose the first option under Database Creation Settings,
type the name of the new database user you want to create.
• If you chose the second or third options under Database Creation
Settings, enter the name of the existing database user for the
database you want to use.
Password Specifies the password for the Oracle database user.
Service Specifies the name of the service for the Oracle instance.
The service name was determined when the Oracle server was
installed.
Port Specifies the number of the port on which the Oracle server listens.
The port number was determined when the Oracle server was
installed.
Use database Specifies you want to grant permission to Deployment Center deploy
system user scripts to create database triggers. Select this checkbox if you want to
credentials to grant this permission. Or, clear this checkbox if your database
grant this administrator will grant this permission to the Oracle database user
permission before your run the deploy scripts.
Selecting this checkbox enables the Database System User
Credentials boxes.
This option is displayed only if you chose the second option under
Database Creation Settings.
User Specifies a user name of the Oracle system administrator account. The
default value is system.
Password Specifies the password for the Oracle system administrator account.
The password must not be empty nor contain any whitespace
characters such as space, tab, newline, carriage return, form feed, or
vertical tab.

Teamcenter Installation on Windows, Teamcenter 14.2 9-7

© 2022 Siemens
 9. Installing a Teamcenter corporate server

Parameter Description
!@$%=&'"^:;._<>(){}

Microsoft SQL Server

Parameter Description
Database Select MSSQLServer.
Server
MSSQL Specifies a database user name:
Database
User • If you chose the first option under Database Creation Settings, type
the name of the new database user you want to create.
• If you chose the second or third options under Database Creation
Settings, enter the name of the existing database user for the
database you want to use.
Password Specifies the password for the database user.
Port If you connect to Microsoft SQL Server using a specific port, choose this
option and enter the Database Port number you specified when you
installed MS SQL Server.
Instance If you connect to Microsoft SQL Server using a named instance, choose
this option and enter the Named Instance name you defined when you
installed MS SQL Server.
Database Specifies the name of the MS SQL Server database.
Name
The database name was determined when database was created.
Collation Specifies the collation used by the Teamcenter database on the
Microsoft SQL Server server. Collation defines the alphabet or language
whose rules are applied when data is sorted or compared.
Enable UTF-8 Specifies whether to enable support for UTF-8 encoding in the
Teamcenter database.
Microsoft SQL Server does not provide native support for UTF-8. The
Enable UTF-8 option enables the Teamcenter server to convert
character encoding to and from UTF-8 when interacting with the
database.
For information about configuring your Teamcenter host to support
UTF-8, see the Teamcenter server installation guides for Windows and
Linux.
Specifies the password for the Oracle system administrator account.
The password must not be empty nor contain any whitespace
characters such as space, tab, newline, carriage return, form feed, or
vertical tab.

9-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Create a Teamcenter environment using Deployment Center

Parameter Description
!@$%=&'"^:;._<>(){}
Database These boxes are enabled if you chose the first option under Database
System User Creation Settings:
Credentials
User specifies the user name of the SQL Server system
administrator account. The default value is sa.

Password specifies the password for the SQL Server system

administrator account.

The password must not be empty nor contain any whitespace

characters such as space, tab, newline, carriage return, form feed,
or vertical tab.

!@$%=&'"^:;._<>(){}

d. Click Save Component Settings.

5. Select the FSC component, enter required parameters, and then click Save Component Settings.

Parameter Description
Machine Name Specifies the name of the machine on which you will deploy the FSC
component.
Select a machine from the dropdown list or enter a new machine name. In a
single box environment, this value is the machine name you entered for the
Corporate Server component.
OS Specifies the operating system of the machine.
Teamcenter Specifies the Teamcenter root directory (TC_ROOT) on the component machine.
Installation
Make sure this path meets the requirements for the Teamcenter root
Path
directory.
Login Account Specifies the user account under which the FMS server cache (FSC) service runs.
Choose one of the following options:

• This Account

Specifies you want the FSC service to run under a specific user account. If you
choose this option, type the credentials for the account:
User Specifies user name or the domain and user name for the
account, for example, domain\user.
Password Specifies the password for the designated user account.

Teamcenter Installation on Windows, Teamcenter 14.2 9-9

© 2022 Siemens
 9. Installing a Teamcenter corporate server

Parameter Description
• Local System Account

Specifies you want the FSC service to run under the current local system user
account (the account under which you run the deploy script).
FSC Master A Teamcenter network must have at least one primary (master) FSC. If you want
Settings to designate the current FSC as an FSC primary, select the Is Master? check box.
Otherwise, type the URL to the parent FSC in the FSC Parent URL box.

6. Select the Licensing Server component, enter required parameters, and then click Save
Component Settings.

Parameter Description
Machine Name Specifies the name of the machine on which you installed the Siemens Digital
Industries Software License Server.
OS Specifies the operating system of the license server machine.
Port Specifies the port used by the license server.

7. Enter parameters for remaining selected components. For each component, enter required
parameter values, and then click Save Component Settings.

If you do not have values for all required parameters, you can save your component settings at any
time and return to finish them. However, the Deploy task is not enabled until all components in
the environment show a configuration status of 100%.

8. When all components are fully configured (showing a value of 100% in the COMPLETE column), go
to the Deploy task.

Deploy the environment

In this task, generate deployment scripts for each machine in your environment. These scripts install the
software, applications, and components on to each target machine in your environment.

1. To generate deployment scripts, click Generate Install Scripts.

Deployment Center generates installation scripts, and reports information about the scripts in the
right panel.

9-10 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Create a Teamcenter environment using Deployment Center

The Deploy Instructions contain the following sections:

• Script Generation Date displays the time stamp for the local date and time of script generation.
• Deployment Overview describes the deployment covered by the scripts.
• Software To Be Installed lists the software required to deploy the components.
• Software Needed For Install lists software that is already installed on the machine but is still
needed for this process to deploy other components.
• Deploy Script Directory displays the path to the location of the ZIP files containing the
generated scripts. Go to the ZIP file directory and check for one or more ZIP files corresponding
to the machines in your Teamcenter environment. Look for the Deploy_Instructions.html file,
which contains the same information and instructions that you reviewed in the report.
• Deploy Scripts displays the ZIP files that were generated for each server along with the
associated component names. Each ZIP file contains the installation scripts for a single server.

Teamcenter Installation on Windows, Teamcenter 14.2 9-11

© 2022 Siemens
 9. Installing a Teamcenter corporate server

If all components are to be installed on the same machine, there is only one ZIP file. The ZIP file
name ends with the target machine name where you run the script. For example, if the ZIP file is
named deploy_MyCorp1.zip, it runs on the MyCorp1 machine. Run an installation script only on
its designated machine.

2. Locate deployment scripts, copy each script to its target machine, and run each script on its target
machine.

For more information about running deployment scripts, see the Deployment Center Guide.

if you want to replicate an environment, you can export the configuration of an existing environment
and then reuse its configuration to create another environment using the quick deployment procedure.

Install a Teamcenter corporate server using TEM

A corporate server is the central component in a Teamcenter environment, and typically the first
component installed. A corporate server configuration includes the Teamcenter Foundation and FMS
Server Cache components.

To install a Teamcenter minor release, you must also have the associated Teamcenter major release.
Make sure you have access to the major and minor release software kits, as well as any other
Teamcenter patches you want to apply to your installation.

For example, to install a Teamcenter 14.2 server, make sure you have access to software kits for
Teamcenter 14.2 and Teamcenter 14. Also, make sure you launch Teamcenter Environment Manager
(TEM) from the minor release location.

1. Log on to the operating system with the Teamcenter user account you created for installing and
maintaining the Teamcenter installation.

2. Specify the path to the required Java Runtime Environment (JRE) by setting the JRE64_HOME
environment variable on your host.3

3. Start Teamcenter Environment Manager (TEM):

a. Browse to the root directory of the Teamcenter minor release software kit.

b. Right-click the tem.bat program icon and choose Run as administrator.

TEM starts and displays the Installer Language dialog box.

c. In the Installer Language dialog box, select a language and click OK.

Your language selection applies only to the TEM session, not the Teamcenter installation.

3 Alternatively, you can specify the JRE path when you launch TEM from a command prompt using the -jre JRE-path
argument.

9-12 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install a Teamcenter corporate server using TEM

For information about any TEM panel, click the help button .

4. In the Welcome to Teamcenter, select Teamcenter.

5. Proceed to the Install/Upgrade Options panel. This panel contains the following options:

• Install

Installs a new Teamcenter configuration using a fully configurable installation process.

• Upgrade

Upgrades an existing Teamcenter configuration.

• Updates Manager

Launches the updates manager to apply Teamcenter minor releases and patches.

Click Install to begin installing a corporate server.

Note:
The Install/Upgrade Options panel also provides these installation options:

• Create environment for upgrade testing

TEM can create a copy of an existing Teamcenter environment for upgrade testing only.
The copied environment cannot be used as a production database.

• Create custom distribution

To simplify installations of Teamcenter on multiple hosts, TEM can create a silent
distribution or a compact distribution. Compact distribution is recommended only for
Teamcenter client configurations, not for servers.

6. In the Media Locations panel, specify locations of Teamcenter software kits:

a. In the Original Media Location box, enter the location of the Teamcenter 14 software kit.

b. In the Update Location table, enter the locations of all Teamcenter patches you want to apply
to your installation. The location of the current Teamcenter minor release is automatically
added to the list.

You can specify multiple update locations. Click Browse to add an update location to the list,
or click Remove to remove an update location.

Teamcenter Installation on Windows, Teamcenter 14.2 9-13

© 2022 Siemens
 9. Installing a Teamcenter corporate server

TEM applies updates in the order you specify. If updates contain different versions of the same
software component, the update closest to the bottom of the list takes precedence. To change
the order in which updates are applied, select an update in the list and click Up or Down.

7. In the Configuration panel, type a unique ID and description for the new Teamcenter
configuration.

The configuration ID identifies your Teamcenter configuration when you maintain, upgrade,
uninstall, or add features to the configuration. Installation log files are also named based on the ID
you enter.

8. In the Solutions panel, select the Corporate Server solution.

9. Proceed to the Features panel. This panel shows the corporate server features preselected by the
Corporate Server solution:

Teamcenter Foundation
FMS Server Cache
NX Part Family Classification Integration

10. Select any additional features you want to include in your configuration.

If you select additional features, TEM displays additional panels during installation that are not
described in this procedure.

For help with any panel in TEM, click the help button .

You can add features to the corporate server later using TEM in maintenance mode. You can also
install custom features by installing a custom solution or third-party template.

11. In the Installation Directory box, enter the path to a new directory where you want to install
Teamcenter.

The Installation Directory value is the Teamcenter application root directory (TC_ROOT).

Do not set the TC_ROOT environment variable in the system environment. TEM sets this variable as
required in Teamcenter configuration files. Setting this variable in the operating system can cause
conflicts if you install multiple Teamcenter configurations.

The installation directory must meet the following requirements:

• The directory must not already exist on your system. (TEM creates the directory during
installation.)

• The directory must be in a location excluded from real-time virus scanning.4

9-14 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install a Teamcenter corporate server using TEM

• The path to the installation directory must not exceed 64 characters.

If your Teamcenter installation directory is on a mapped drive or a UNC path (not on the local host)
you must be logged on as an authenticated domain user to ensure the remote host recognizes you.
Alternatively, you can set the permissions on the remote host to allow an anonymous user to
access it. This is necessary to ensure Teamcenter services such as the FMS server cache (FSC) and
Multi-Site Collaboration services can start.

12. In the File System Cache (FSC) panel, type a unique identifier and port for the FMS server cache in
the FSC ID and Port boxes.

A Teamcenter network must have at least one primary (master) FSC. If you want to designate the
current FSC as an FSC primary, select the Enable configuration master check box. Otherwise, type
the URL to the parent FSC in the FSC Parent URL box.

For advanced FSC configuration options, click Advanced.

13. In the Operating System User panel, type the password for the operating system account under
which you install Teamcenter.

14. In the Foundation panel, select how you want to create or designate the Teamcenter database and
Teamcenter data directory (TC_DATA).

Database Database TC_DATA Select this option

exists? populated? exists?

No N/A No Create and populate database, create new

data directory
No Teamcenter database or data directory exists
and you want TEM to create both. This option is
selected by default.

Yes No No Populate database, create new data directory

A database exists but is not populated with
Teamcenter data. You want TEM to populate the
database and create a new data directory.

Yes Yes No Create new data directory using existing

populated database

4 Real-time virus scanning prevents Teamcenter from updating the persistent object manager (POM) schema during
installation, causing installation errors.

Teamcenter Installation on Windows, Teamcenter 14.2 9-15

© 2022 Siemens
 9. Installing a Teamcenter corporate server

Database Database TC_DATA Select this option

exists? populated? exists?

A database exists and is populated. You want

TEM to use this database and create a new data
directory.

Yes Yes Yes Use populated database and existing data

directory
A database exists and is populated, and a data
directory exists. You want TEM to use both of
these.

15. Enter the required values for your Teamcenter database according to your selection in the
Foundation panel.

• Create and populate database, create new data directory:

a. Proceed to the Foundation Database panel.

b. Select the appropriate database server vendor (Oracle or MS SQL Server).

c. Enter the required values for the database server, the database user, and the database
administrator account.

• Populate database, create new data directory:

a. Proceed to the Foundation Database panel.

b. Select the appropriate database server vendor (Oracle or MS SQL Server).

c. Enter the required values for the database server and the database user.

• Create new data directory using existing populated database:

a. Proceed to the Foundation Database panel.

b. Select the appropriate database server vendor (Oracle or MS SQL Server).

c. Enter the required values for the database server and the database user.

• Use populated database and existing data directory:

No database information is required. Proceed to the Data Directory panel.

9-16 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install a Teamcenter corporate server using TEM

The directory you specify in the Database Path box must exist and you must have write permission
to the directory.

Caution:
When you enter the password for the database system user, observe the following
restrictions:

• The password must not be empty nor contain any whitespace characters such as space,
tab, newline, carriage return, form feed, or vertical tab.
• In addition, the password must not contain any of the following characters:

!@$%=&'"^:;._<>(){}

16. In the Data Directory box, enter a location for the Teamcenter data directory.

The Teamcenter data directory is called the TC_DATA directory. TEM stores this location as the
TC_DATA variable in Teamcenter configuration files. TEM creates shared data subdirectories and
files in this location. Each data directory is associated with a single database user within a database
instance.

Do not set TC_DATA as a system environment variable. Setting this variable in the operating system
can cause conflicts if you install more than one configuration.

17. Proceed to the Volume Information panel.

In the Name box, type a name for the Teamcenter volume you want TEM to create.

In the Directory box, type the absolute path to the directory in which to create the volume, or
accept the default location.

Do not define the volume location under the Teamcenter application root directory (TC_ROOT).
Doing so leads to complications when upgrading to a later version of Teamcenter.

18. Proceed to the Foundation Settings panel.

Value Description

Transient Volume Directories Specifies transient volume locations for Windows

hosts, Linux hosts, or both.
A transient volume is an operating system directory
controlled by Teamcenter and used to store
temporary data for transport of reports, PLM XML
data, and other nonvolume data between the
enterprise tier and client tier in a deployed four-tier
architecture. All four-tier clients that access the

Teamcenter Installation on Windows, Teamcenter 14.2 9-17

© 2022 Siemens
 9. Installing a Teamcenter corporate server

Value Description

corporate server you are installing use this transient

volume.

Caution:
Do not define the path as a UNC path, for
example, \\server\shared-transient-folder. You
must use a direct path location.
Some ZIP archive utilities do not accept UNC
paths, resulting in failure of exports to Excel or
Word.

Windows clients Specifies the location for a transient volume for

Windows client hosts.

Linux clients Specifies the location for a transient volume for

Linux client hosts.

Generate server cache Specifies you want to generate a shared server

cache. If you select this option, TEM runs the
generate_client_meta_cache utility at the end of the
install, upgrade, or update action. This option
reduces Teamcenter memory consumption by
moving metadata to shared memory. Types, property
descriptors, and constants are placed in a shared
cache that is shared by all Teamcenter server
instances.
This option is selected by default in a Teamcenter
server installation.

Generate client cache Specifies that you want to generate a cache of data
that rich clients can download once at initial logon
and then reuse on the client host. This option
reduces server demand, reduces startup time, and
improves overall performance. When this option is
selected, TEM generates the client cache at the end
of the install, upgrade, or update action. If you clear
this option, but a client cache already exists, the old
client cache is deleted.
This option is selected by default in a Teamcenter
server installation.

9-18 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install a Teamcenter corporate server using TEM

Value Description

Production Environment Specifies your new environment is to be used as a

live environment where you will store your product
data.

Test Environment Specifies your new environment is to be used for

development, testing, or training. Selecting Test
Environment enables the bulk loader tool to copy
data from another environment (such as a
production environment) into this test environment.
If you designate this environment as a test
environment, the designation cannot be changed.
A test environment cannot participate in Multi-Site
sharing with a production environment.

For advanced Teamcenter Foundation options, click Advanced.

19. If you want to configure Teamcenter online help, click Advanced in the Foundation Settings
panel and perform the following steps:

a. Click the Online Help tab.

b. Select the Enable Online Help check box.

c. In the PLM Document Server URL box, type the Teamcenter online help URL.

20. Proceed to the Flex License Client panel. Enter settings for the Siemens PLM License Server.

The Siemens PLM License Server must be installed before you begin Teamcenter installation.

21. Proceed to the Teamcenter Administrative User panel. During a corporate server installation, the
values in this panel are read-only.

22. Proceed to the Password Security panel. In the Administrative Password Directory box, enter the
directory in which to place Teamcenter password files. TEM locks access to this directory to all users
except the user performing Teamcenter installation.

23. Proceed through any remaining panels, entering the required information for the features you
selected.

For information about these panels, click the help button .

Teamcenter Installation on Windows, Teamcenter 14.2 9-19

© 2022 Siemens
 9. Installing a Teamcenter corporate server

Note:
If your configuration includes the Teamcenter Security Services component, make sure
Security Services is installed and running. TEM verifies the connection to Security Services
and does not allow installation to proceed if the connection fails.

24. Proceed to the Confirmation panel. Verify the information you entered.

If you want to change any values, click Back to return to the panels you want to change.
Otherwise, click Start to begin installing the Teamcenter corporate server.

If an error occurs during installation, follow the instructions in the error message displayed by TEM
or see the available troubleshooting solutions.

25. When installation is complete, close TEM.

After installation, you can find Teamcenter in the list of installed programs in the Windows control
panel. The program name is displayed as Teamcenter 14.2 (x64) (TC_ROOT).

Complete the Teamcenter server installation

Start database daemons

If you select Teamcenter database daemon features during Teamcenter installation, Teamcenter
Environment Manager (TEM) configures the database daemons to start automatically as Windows
services. After installation, you can find these services in the Services dialog box in the Windows
Control Panel:

Teamcenter Action Manager Service

Teamcenter Subscription Manager Service
Teamcenter Revision Configuration Accelerator Service
Teamcenter Task Monitor Service
Teamcenter Tesselation Manager Service
Teamcenter Workflow Remote Inbox Sync Service
Teamcenter Shared Metadata Cache Service

If the services do not start automatically, see the available troubleshooting solutions.

Each service behaves as follows:

1. After the services are started, a program runs in TC_ROOT\bin named tc_server.exe.

Windows displays tc_server.exe in the task manager. If you do not see this process, either your
registry entry for that service is corrupted (specifically the path to the image) or the file is not on
the system.

9-20 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configure heterogeneous operating system environment

2. The tc_server.exe program identifies the service that launched it by examining the service name.
It expects the service name to contain either actionmgrd, subscripmgrd, task_monitor, or
tess_server. The default service names for Teamcenter are tc_actionmgrd, tc_subscripmgrd,
tc_taskmonitor, and tc_tess_server. These services are defined in \HKEY_LOCAL_MACHINE
\SYSTEM\CurrentControlSet\Services.

3. The tc_service.exe program assembles a .bat file name by prefixing the service name with run_
and appending the extension of .bat. For example, the tc_actionmgrd service has the file name
run_tc_actionmgrd.bat.

4. The tc_service.exe program calls the .bat file (created by the setup program during configuration
and placed in the \bin directory of the Teamcenter application root directory).

5. The task manager displays the process, for example, actionmgrd.exe.

If the process is not displayed in the task manager, either the service name is not one of the three
supported names, the .bat file for the process does not exist, or the process executable is missing.

6. The Services dialog box is updated to Started.

Configure heterogeneous operating system environment

If you are adding Windows Teamcenter clients to a Linux Teamcenter environment, you must perform
the following tasks:

1. Install Teamcenter and configure the database (Teamcenter application root and data directories)
on a Windows system that can serve a common mount point for all Windows clients.

This allows the Windows and non-Windows Teamcenter clients to interoperate, particularly in
volume management.

2. Synchronize the following files in the separate Teamcenter data directories:

• POM schema files (TC_DATA\pom_schema_server_sid)

• POM transmit files (\pom_transmit\*.sch)

• Dataset definition files (TC_DATA\gs_info\*.des)

3. Make sure your Windows and Linux server configurations contain identical sets of Teamcenter
features. For example, if you install features or custom templates on a Linux server, you must
install the same features and templates on your Windows server.

4. Configure File Management System (FMS) on Linux and Windows volume servers.

Teamcenter Installation on Windows, Teamcenter 14.2 9-21

© 2022 Siemens
 9. Installing a Teamcenter corporate server

Conversely, if you create a Teamcenter database by running the Teamcenter setup program from a
Windows workstation, you must install Teamcenter on Linux clients you want to connect to the
database.

9-22 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 10. Installing server-side components
Install the Teamcenter web tier

Install the .NET web tier application

Configure Microsoft IIS for the .NET web tier

The Teamcenter .NET web tier is an alternative to the Teamcenter Java EE web tier. It supports four-tier
Teamcenter deployments and does not require a Java EE application server.

The Teamcenter .NET web tier requires a supported Microsoft Windows Server operating system and
also the following Microsoft components:

• Microsoft Internet Information Services (IIS)

• Microsoft .NET Framework

For required versions of these products, see the Hardware and Software Certifications knowledge base
article on Support Center.

Before you install the .NET web tier, configure the required role services in Microsoft IIS on a Windows
Server host. You can perform this from a command line or by using the Windows Server Manager.

Install role services from a command line

Open a Windows command prompt as an administrator and enter the following command in a single
line:

dism.exe /enable-feature /all /online /featureName:IIS-CommonHttpFeatures

/featureName:IIS-DefaultDocument /featureName:IIS-DirectoryBrowsing
/featureName:IIS-HttpErrors /featureName:IIS-StaticContent
/featureName:IIS-HttpRedirect /featureName:IIS-HealthAndDiagnostics
/featureName:IIS-HttpLogging /featureName:IIS-LoggingLibraries
/featureName:IIS-RequestMonitor /featureName:IIS-HttpTracing
/featureName:IIS-Performance /featureName:IIS-HttpCompressionStatic
/featureName:IIS-HttpCompressionDynamic /featureName:IIS-Security
/featureName:IIS-RequestFiltering /featureName:IIS-BasicAuthentication
/featureName:IIS-ClientCertificateMappingAuthentication
/featureName:IIS-DigestAuthentication
/featureName:IIS-IISCertificateMappingAuthentication
/featureName:IIS-IPSecurity /featureName:IIS-URLAuthorization
/featureName:IIS-WindowsAuthentication
/featureName:IIS-ApplicationDevelopment
/featureName:IIS-NetFxExtensibility45 /featureName:IIS-ASP
/featureName:IIS-ASPNET45 /featureName:IIS-CGI
/featureName:IIS-ISAPIExtensions /featureName:IIS-ISAPIFilter
/featureName:IIS-ServerSideIncludes /featureName:IIS-WebServerManagementTools
/featureName:IIS-ManagementConsole

Teamcenter Installation on Windows, Teamcenter 14.2 10-1

© 2022 Siemens
 10. Installing server-side components

Install role services using Windows Server Manager

Open the Windows Server Manager. Verify the Web Server (IIS) role is installed on your host. If this role
is not installed, install it according to your operating system documentation.

In the Windows Server Manager, under the Web Server (IIS) role, install the following role services:

Common HTTP Features

Default Document
Directory Browsing
HTTP Errors
Static Content
HTTP Redirection

Caution:
Do not install the WebDav Publishing role service.

Health and Diagnostics

HTTP Logging
Logging Tools
Request Monitor
Tracing
Performance

Static Content Compression

Dynamic Content Compression
Security

Request Filtering
Basic Authentication
Client Certificate Mapping Authentication
Digest Authentication
IIS Client Certificate Mapping Authentication
IP and Domain Restrictions
URL Authorization
Windows Authentication
Application Development

.NET Extensibility 4.x

ASP
ASP.NET 4. x
CGI
ISAPI Extensions
ISAPI Filters
Server Side Includes

10-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the .NET web tier

Install only the available ASP.NET 4.x role services. Do not install ASP.NET 3.x role services.
Management Tools

IIS Management Console

Install the .NET web tier

Before you install the .NET web tier, make sure you log on using an account with administrative
privileges and that you have access to the Teamcenter software kit. Also, make sure your host has the
required software and is configured for the Teamcenter .NET web tier.

During installation of the .NET web tier, Teamcenter Environment Manager (TEM) verifies that you have
the required software and operating system versions.

1. Launch Teamcenter Environment Manager (TEM).

If you create a new Teamcenter configuration, launch TEM from the Teamcenter software kit. If
you want to add the .NET-based server manager to an existing configuration, launch TEM in
maintenance mode.

For a description of any TEM panel, click the help button in the panel.

2. Launch Teamcenter Environment Manager. In the Windows start menu, click

Programs→Teamcenter 14, and then right-click Environment Manager and select Run as
administrator.

This procedure assumes you are adding the .NET web tier to an existing Teamcenter configuration.
Alternatively, you can create a new configuration and select the Web Tier for .NET feature in the
Features panel.

3. In the Maintenance panel, select Configuration Manager.

4. In the Configuration Maintenance panel, select Perform maintenance on an existing

configuration.

5. In the Old Configuration panel, select the configuration to which you want to add the .NET web
tier.

6. In the Feature Maintenance panel, select Add/Remove Features.

7. In the Features panel, under Server Enhancements→Teamcenter Web Tier, select Web Tier
for .NET.

8. Proceed to the Multiplexing Proxy panel. Accept the default values or type new values for the
Teamcenter multiplexing proxy (MUX).

Teamcenter Installation on Windows, Teamcenter 14.2 10-3

© 2022 Siemens
 10. Installing server-side components

Value Description

Port Specifies the TCP/IP port on which the MUX listens for
web tier requests. This is the Jetty server connector
port.

TECS Admin Port Specifies the port used by the Teamcenter Enterprise
Communication System (TECS).

The MUX listens on a single port for incoming requests from the .NET web tier, forwarding those
requests to an appropriate Teamcenter server using operating system named-pipe communication
protocol, and then streaming the response back to web tier. The MUX runs as an application within
the Teamcenter Enterprise Communication System (TECS). The TECS container is based on the
Teamcenter client communication system (TCCS) container used in the client tier.

9. In the Server Manager Performance Tuning panel, accept the default performance tuning values
or optionally enter your own preferred values.

10. In the TcServer Character Encoding Settings panel, make sure the values reflect the character set
you use for Teamcenter. If you are not sure, accept the default settings.

To ensure correct character mapping, make sure the Teamcenter server and database use the same
encoding.

11. Proceed to the .NET Web Tier panel. Type values for the following required parameters:

Parameter Description

Web Tier Language Specifies the same locale that is specified for Teamcenter
server. This locale is used for localization of messages coming
from web tier. The default web tier language is English.

Server Manager Peers Specifies server manager peer hosts for the .NET web tier.
Enter one or more hosts using the Add button and entering
host and port numbers for each.
At least one server manager must be configured for a working
deployment. The port number each server manager peer must
match the port you specify during the corresponding server
manager installation.

The remaining parameters in the .NET Web Tier panel are optional. Enter values for these
parameters as needed.

TEM examines settings in your Microsoft Internet Information Services (IIS). If any required settings
or roles are missing, you must correct them in IIS before you continue.

10-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the .NET web tier

12. In the Internet Information Services (IIS) Settings panel, accept the default settings, or specify IIS
settings for the .NET web tier:

Parameter Description

Use Existing Web Site Specifies whether to use an existing web site. If you select this
option, select the web site you want to use from the list. The
IIS virtual directory for .NET web tier deployment is created in
the selected web site and the application is hosted on that web
Site.
Alternatively, you can select Create New Web Site, and then
type a name, port, and root path for the new web site.

Use Existing Application Pool Specifies whether to use an existing application pool from the
list provided. An application pool is a set of one or more
applications assigned to an IIS worker process. The
Teamcenter .NET web tier is an ASP.NET application, so the
application pool that hosts it can only host applications based
on the same version of ASP.NET. Keep this in mind if you have
this application pool host other applications. If possible, use a
dedicated (stand-alone) application pool for Teamcenter web
Tier deployment.
The default value is Use Existing Application Pool.
Alternatively, you can create a new application pool.

Virtual Directory Name Specifies the IIS virtual directory name for Teamcenter .NET
web tier deployment. The default value is tc. Web URLs for
Teamcenter four-tier deployments are based on this value. For
example, if you specify the default value as tc, the URLs are of
the form: http://host:port/tc.

For more information about these values, click the help button .

13. In the Confirmation panel, click Start to begin installing the .NET web tier.

14. When installation completes, exit TEM.

After you install the server manager and the .NET web tier, complete the .NET web tier installation:

• Launch the Teamcenter Management Console.

• Install Teamcenter clients.

Teamcenter Installation on Windows, Teamcenter 14.2 10-5

© 2022 Siemens
 10. Installing server-side components

Install the Java EE web tier application

The Teamcenter Java EE web tier application provides communication between Teamcenter clients and
the enterprise tier.

Before you install the Java EE web tier, make sure you install:

• A Teamcenter server and server manager.

• A supported Java EE application server and the Java Runtime Environment (JRE) on the web tier host.1

• Teamcenter Security Services

Install the Web Application Manager

1. Create a home directory for the Teamcenter web tier, for example, c:\tcweb. This directory is
referenced as WEB_ROOT.

2. In the Teamcenter software kit, browse to the Web_tier directory and double-click the
INSTALL_TCWEB.EXE program icon.

7-Zip displays a self-extractor dialog box.

3. In the Unzip To Folder box, type the path to WEB_ROOT, and then click Unzip.

After 7-Zip extracts the installation files, click Close to close the 7-Zip self-extractor dialog box.

4. To launch the Web Application Manager, browse to the WEB_ROOT directory and double-click the
insweb.bat program icon.

Build the Teamcenter web tier application

1. Launch the Web Application Manager (insweb.bat).

2. Copy ICD files from the Teamcenter software kit. This populates the list of solutions available to
install.

a. Click Copy ICDs. In the Copy ICD Files dialog box, click Browse.

b. Browse to the Web_tier directory in the root directory of the Teamcenter software kit and
select the icd directory, and then click Open.

c. In the Copy ICD Files dialog box, click OK to load ICD files.

1 For information about supported application servers and Java versions, see the Hardware and Software Certifications
knowledge base article on Support Center.

10-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the Java EE web tier application

d. Repeat steps a through c to copy ICDs from the Teamcenter 14.2 software kit.

3. Click Add to begin creating a web application.

Web Application Manager displays the Add Web Application dialog box.

4. Create the Teamcenter Web Tier web application:

a. In the Name box, type a name for the application, for example, Teamcenter Web Tier.

b. In the Staging Location box, enter a path where you want to place the web application files.
Typically, this is a directory under the WEB_ROOT directory. Web Application Manager creates
the directory if it does not exist.

c. Optionally, in the Description box, type a description of the application.

d. Enter software locations:

A. Click Add, next to the Disk Locations for Install Images box.

B. In the Add Disk Location dialog box, enter the path to the Web_tier directory on the
Teamcenter software kit:

path\Web_tier

C. Repeat steps A through B to add the path to the Web_tier directory on the Teamcenter
14.2 software kit.

To modify or remove a location in the Disk Locations for Install Images list, click Modify or
Remove.

Do not change the default solution type (Web tier) shown in the Solution Type box.

5. Select the solutions to include in the Teamcenter web tier web application:

a. Click Solutions.

b. In the Select Solutions dialog box, select the required solutions:

Teamcenter - Web Tier Infrastructure

Teamcenter - Web Tier Core Applications

c. If you use the Teamcenter service-oriented architecture (SOA), select the Teamcenter
Services WSDL/SOAP Support solution.

Teamcenter Installation on Windows, Teamcenter 14.2 10-7

© 2022 Siemens
 10. Installing server-side components

The Teamcenter SOA architecture provides the ability to develop task-specific clients, utilities,
and system integrations for the Teamcenter server. The SOA architecture also ships with WS-I
compliant WSDL files for all operations, supporting open industry standards.

6. Click Advanced Web Application Options to select the following advanced options, if applicable:

• If you want the web tier application to submit the client-side session cookie over HTTPS, select
the Secure Cookie check box.

• If you deploy the web tier application in a cluster configuration, select the Distributable
check box. This makes the web tier WAR file distributable.

7. Click OK.

The Web Application Manager displays the Modify Required Context Parameters dialog box.

8. Enter or verify values for the following required context parameters. Default values are acceptable
for most parameters

Local Service Port (when using TCP Enterprise Application Lookup ID

communication protocol)
Deployable File Name
Connection Timeout
IS_SSO_ENABLED
Server_Manager_URIs
SSO_APPLICATION_ID
LogVolumeName
SSO_LOGIN_SERVICE_URL
LogVolumeLocation
SSO_SERVICE_URL
Enterprise Application Registration ID
TcLocale
Max_Capacity

To set a context parameter, double-click the Value box for the given parameter and enter the new
value. To view a description of any context parameter, click the parameter name in the Modify
Required Context Parameters dialog box.

Note:
If your network uses IPv6 (128-bit) addresses, use the hostname in URIs and do not use the
literal addresses, so the domain name system (DNS) can determine which IP address should
be used.

9. Click OK to begin building the web application.

10-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the Java EE web tier application

When the application is complete, click OK to close the Progress dialog box.

10. Click Exit to exit the Web Application Manager.

11. Locate the deployable file (tc.war) generated during installation. This file is in the deployment
directory under the staging location you specified.

12. Deploy the web application on a supported application server.2

Deploying on an IPv6 network

If your network includes client hosts running on an IPv6 network, the Java EE web tier must be deployed
in an application server that supports an IPv6 URL as an external endpoint and uses IPv4 addresses to
support all communication with the Teamcenter enterprise tier, such as communication with the Java EE
server manager.

A typical environment for the Java EE web tier is a dual-stack machine that supports both IPv4 and IPv6
addresses in which the application server accepts HTTP requests from either IPv4 or IPv6.

Teamcenter enterprise tier server components that communicate with other server components in the
same network are assumed to be on an IPv4 network and are not supported on IPv6. Teamcenter IPv6
support is limited to clients or integrations that use Teamcenter client communication system (TCCS)
and Teamcenter components that communicate with clients on IPv6-enabled networks.

Sharing an application server instance for multiple four-tier environments (Optional)

Teamcenter supports deploying more than one instance of the same Teamcenter web tier application
(WAR file) into one application server instance. Multiple WAR files can be configured to run as discrete
applications, each with a unique entry point. This allows you to connect each application to a different
enterprise tier without the need to manage multiple application server instances. The following example
shows a possible scenario with three web applications (WAR files) deployed in a single application server
instance.

Client Resource
tier Web tier Enterprise tier tier

Clients Single application server instance Server managers Databases

Client A ← http://host:port/tc01 ← svrmgr11 ← DB1

→ → →

2 Web Application Deployment provides Teamcenter web tier deployment procedures for several supported application
servers.

Teamcenter Installation on Windows, Teamcenter 14.2 10-9

© 2022 Siemens
 10. Installing server-side components

Client Resource
tier Web tier Enterprise tier tier

Client B ← http://host:port/tc02 ← svrmgr2 ← DB2

→ → →

← http://host:port/tc03 ← svrmgr3 ← DB3

→ → →

To deploy multiple web applications in a single web application server instance, perform the following
tasks:

1. Install multiple server managers with unique server manager cluster configuration settings.

2. Create web applications. Assign each application a unique name.

3. Set the following web tier context parameters to unique values for each web application.

Context parameter Description

DEPLOYABLE-FILE-NAME Name of the deployable file you are creating for the web
tier application.

Enterprise Application Registration Identifier for the web application. If you want to deploy
ID multiple Teamcenter web tier applications in a single
application server instance, each application must be
assigned a unique ID.

Enterprise Application Lookup ID Specifies the ID by which the Teamcenter presentation

tier accesses the application identified by the Enterprise
Application Registration ID parameter. If you deploy
your WAR file with other WAR files in the same
application server instance, these two IDs should be set
to the same value for a given application.

Server_Manager_URIs The server manager URI(s) for the appropriate server

manager.

4. Deploy web application WAR files in the web application server instance.

Multiple WAR file deployment is not supported on JBoss. If you use JBoss as your web application server,
you must deploy each WAR file in a separate application server instance.

Install the server manager

1. Launch your preferred installation tool, Teamcenter Environment Manager or Deployment Center.

10-10 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the server manager

If you use TEM to create a new Teamcenter configuration, launch TEM from the Teamcenter
software kit. To add the server manager to an existing configuration, launch TEM in maintenance
mode.

2. Select the Server Manager component.

In Deployment Center, select Server Manager in the Components task.

In TEM, in the Features panel, select Server Enhancements→Server Manager.

3. Proceed to the Multiplexing Proxy (MUX) panel and specify values for the Teamcenter
multiplexing proxy (MUX).

Value Description

Port Specifies the TCP/IP port on which the MUX listens for web tier requests. This is
the Jetty server connector port.

TECS Admin Specifies the port used by the Teamcenter Enterprise Communication System
Port (TECS).

The MUX listens on a single port for incoming requests from the web tier, forwards those requests
to an appropriate Teamcenter server using operating system named-pipe communication protocol,
and then streams the response back to web tier. The MUX runs as an application within the
Teamcenter Enterprise Communication System (TECS). The TECS container is based on the
Teamcenter client communication system (TCCS) container used in the client tier.

4. Proceed to the Communication Configuration panel and enter the required values.

Parameter Description

Pool ID Type a name for the server pool.

JMX RMI Port Type a port for the server pool.

Assignment Type a port number for the Server Manager Assignment Service.
Service Port
The Server Manager Assignment Service is a service used by the Java EE
web tier for business logic server assignment requests to the server
manager. The assignment request is a POST HTTP request in which the
input and output parameters are transmitted as XML payload.

Teamcenter Installation on Windows, Teamcenter 14.2 10-11

© 2022 Siemens
 10. Installing server-side components

Parameter Description

Server Host Type the logical host name of the server manager host. This value allows
you to control which IP address is used when connecting to Teamcenter
servers.

Startup Mode Select one of the following:

• Service/Daemon

Specifies that you want to run the server manager as a Windows service.
This is the default mode.

• Command Line

Specifies you want to run the server manager manually from a command
line.

5. Proceed to the Server Manager Cluster Configuration panel and enter remaining values as
needed. For more information about fields in this panel, click the help button .

6. Proceed through remaining panels to the Confirmation panel. Click Start to begin installing the
Teamcenter server with the server manager.

7. When installation completes, exit TEM.

8. After you install the server manager, install the Teamcenter Management Console using the
appropriate steps for the Windows platform.

If you experience connection delays during server manager startup, then see the available
troubleshooting solutions.

Java EE configuration files

You can install multiple server manager services on the same host. Each server manager service has its
own configuration directory:

TC_ROOT\pool_manager\confs\config-name

where config-name is the name of the server manager.

The server manager configuration directory contains configuration files, log files, and server manager
scripts. These include the following.

10-12 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install a volume server

File/Directory Description

mgrstart Script that launches the server manager in console mode.

mgrstop Script that stops the server manager when started from a command line.
If you run the server manager as a Windows service, stop the service using the
Windows services manager.
You can also stop the server manager using the Teamcenter Management
Console.

mgr.output If you run the server manager as a Windows service, this file contains all output
from the server manager.
This file is not used if you run the server manager from the command line.

logs Directory that contains all server manager log files.

If you run the server manager as a Windows service, then the starts automatically.

Install a volume server

By default, you can create volumes only on local disks, but if you want to write files to volumes residing
on remote disks (shared across the network), you can create a stand-alone volume server.

1. Log on to the operating system with the user account you want to own the volume.

2. Start Teamcenter Environment Manager (TEM):

a. Browse to the root directory of the Teamcenter software kit.

b. Right-click the tem.bat program icon and choose Run as administrator.

Teamcenter Environment Manager starts and displays the Choose Install Language dialog
box.

c. Select a language for the installation program and click OK.

The language you select is used only for the installation program.

3. In the Welcome to Teamcenter panel, select Teamcenter.

4. Proceed to the Install/Upgrade Options panel. Click Install.

Teamcenter Installation on Windows, Teamcenter 14.2 10-13

© 2022 Siemens
 10. Installing server-side components

5. (Optional) In the Media Locations panel, enter paths to any Teamcenter patches or minor releases
you want to apply during installation.

6. Proceed to the Configuration panel. Enter a unique ID and description for the new Teamcenter
configuration.

7. Proceed to the Solutions panel. Select the Volume Server solution.

For descriptions of solutions, point to the solution in the list or click Help or see the complete list
of features.

8. Proceed to the Features panel. This panel shows the FMS Server Cache feature preselected by the
Volume Server solution.

9. In the Installation Directory box, enter the absolute path to the directory where you want to
install the volume server.

10. Proceed to the Operating System User panel. Type the password for the operating system account
to which you logged on to install the volume server.

11. Proceed to the File System Cache Service (FSC) panel. Enter required values for the FMS server
cache (FSC) service. For information about required values, click the help button .

12. Proceed through the remaining panels, entering required values for the volume server.

13. Proceed to the Confirmation panel. Verify the information you entered. If you want to change any
values, click Back to return to the panels you want to change. Otherwise, click Next to begin
installing the volume server.

14. When installation is complete, close TEM.

This procedure installs a single volume server. To configure multiple volume servers for load balancing,
and other advanced FMS configuration, see System Administration.

10-14 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 11. Installing Teamcenter microservices
Microservices and the microservice framework

Various Teamcenter solutions and applications include microservices as part of their deployment. For
example:

• The Active Workspace client requires DARSI, TcGQL, and File Repository microservices.

The File Repository provides centralized temporary storage for Active Workspace client content
accessed through the Active Workspace Gateway. This storage gives other microservices an
alternative to the File Management System (FMS).

• The Classification and Requirements Manager applications each have their own required
microservices.

• The Product Configurator application can optionally employ its application-specific microservice to
achieve better performance.

The microservice framework enables microservices to run seamlessly across diverse platforms.

To install the microservice framework and the microservices that run on it, you must configure and
deploy a microservice node. If the server hardware has sufficient capacity, you can deploy a microservice
node on the same hardware as a Teamcenter pool manager.

To increase capacity and provide failover, the microservice framework can include multiple nodes. For
Linux deployments, a single node configuration is reused by the Docker swarm or the Kubernetes
cluster. For Windows deployments, you can add and configure worker microservice nodes in addition to
a master microservice node.

All microservice nodes in a Teamcenter environment must be hosted on servers of a single operating
system type. The following table compares the characteristics of microservice nodes hosted on Linux
and Windows.

Linux 64-bit Windows 64-bit

Prerequisite third- On the microservice node: None
party software
• Docker
• Kubernetes (only if deploying into a Kubernetes
environment)

In a location accessible from the microservice

node:

Teamcenter Installation on Windows, Teamcenter 14.2 11-1

© 2022 Siemens
 11. Installing Teamcenter microservices

Linux 64-bit Windows 64-bit

• A container registry
Management of Docker Swarm or Kubernetes starts, stops, restarts, On Windows, each
microservice and scales all Teamcenter microservices running as microservice framework
framework and containers in a way that best utilizes resources. node includes a Teamcenter
application process manager to handle
microservices the microservices on that
node.

Microservice framework constituents

The microservice framework has the following constituents:

Service Registry Maintains a list of running microservice instances across all nodes.
Service Dispatcher Receives microservice requests from a Teamcenter client, queries the service
registry to find an instance of the requested microservice, and then routes
the request to an instance of the microservice.
Microproxy Forwards web tier application requests to the service dispatcher.
Process manager Manages microservices on the node (Windows hosts).
(Windows hosts)
You can use a web-based utility to dynamically adjust the quantity of
microservice instances managed by the process manager.
Microservice Parameter Manages logging levels for microservices.
Store (MPS)
File Repository Manages files for Active Workspace and microservices.

Install microservices using TEM

Install microservices using TEM

Before you install microservices:

• Review Microservices and the microservice framework for a comparison of the microservice
framework requirements in different environments and a list of framework constituents.

• Download the microservice framework software kit (TcMicroserviceFramework6.2.0_platform.zip)

from the Siemens Digital Industries Software download site. Expand the kit to a local directory.

Add the microservice kit to TEM

Add the microservice kit to Teamcenter Environment Manager (TEM).

11-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install microservices using TEM

For this task Perform these steps

Install a new 1. Launch Teamcenter Environment Manager (TEM) with administrative privileges.
Teamcenter In the Teamcenter software kit, right-click the tem.bat program icon and
environment choose Run as administrator.

2. Proceed to the Install/Upgrade Options panel and click Install.

3. Proceed to the Media Locations panel. In the Update Location box, enter the
path to the microservice framework software kit.

If you are installing a minor release of Teamcenter, enter the path to the major
release software kit in the Original Media Location box.

4. In the Configuration panel, enter an ID and description for the Teamcenter

configuration.

5. Proceed to the Features panel, and then install Teamcenter microservices.

Update an 1. Stop all Teamcenter services except FSC services.
existing
Teamcenter 2. Launch TEM from its installed location, with administrative privileges.
environment
Choose Start > Teamcenter version, right-click Environment Manager and
choose Run as administrator.

3. In the Maintenance panel, select Updates Manager.

4. In the Apply Updates panel, enter the required paths:

Update kit Enter the path to the expanded microservice framework
location software kit.
Backup Enter a path in which to create backups of files replaced
directory during the update.
Original Enter the path to the software kit for the installed Teamcenter
Media major version.
Location

5. Proceed to the Confirmation panel and click Start to add microservice features
to TEM.

When the update is complete, close TEM.

6. Launch TEM as specified in step 2.

7. In the Configuration Maintenance panel, select Perform maintenance on an

existing configuration.

Teamcenter Installation on Windows, Teamcenter 14.2 11-3

© 2022 Siemens
 11. Installing Teamcenter microservices

For this task Perform these steps

8. In the Old Configuration panel, select the configuration to update.

9. In the Feature Maintenance panel, select Add/Remove Features.

10. Proceed to the Features panel, and then install Teamcenter microservices.

Install Teamcenter microservices

1. In the Features panel in TEM, under Microservices, select Microservice Framework and the
microservices you want to install.

2. Proceed to the Microservice Framework panel and specify values.

a. Choose the node type to install, either Master Node or Worker Node.

A master microservice node is required in an environment.

b. If you are installing a master microservice node, then enter a Keystore Password to be used
for generating the .p12 files that contain keys for signing and validating authentication
tokens. These tokens identify the logged on Teamcenter user.

Record and securely store the password for potential use in case you want to open and edit
the keys.

c. If you are installing a worker microservice node, then in Keystore ZIP file enter the location
of the keys.zip file that was generated when the master node was installed.

The keystore ZIP file (keys.zip) was copied to the TC_ROOT/jwt_config_tool directory of the
master microservice node host. For your convenience when installing a worker microservice
node, copy that file to a location on the local machine and in Keystore ZIP file point to that
local copy. For security, a best practice is to delete the copy of keys.zip from the local
machine after the worker node installation is complete.

d. Enter parameter values for the service dispatcher and service registry:

Service Dispatcher parameters:

Install On a master microservice node, the service dispatcher is required and

Microservice preselected. On a worker microservice node, you may optionally install the
service dispatcher for failover or scalability.
Dispatcher Type the port for the service dispatcher that will run on this host.
Port

11-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install microservices using TEM

Additional Type the URLs for additional endpoints for accessing the service dispatcher.
URLs This field can be empty or can include URLs for one or more microservice
nodes. Use a comma to separate multiple URLs. For example:

http://masternode_1:9090,http://workernode1:9090,http://
workernode2:9090

If service dispatchers are configured on multiple nodes (Windows hosts) in

an environment, the file service_dispatcher.json on each node must list all
instances.

If service dispatcher instances are added or changed, then edit the file on
each node where a service dispatcher is installed as needed to update the
file. The default location of the file is TC_ROOT\Clients\aw\microservices
\services_config. Similarly, some microservice .json files include an ARGS or
DSP variable. In such cases, update the variable value in each .json file on
each node.

Service Registry (Eureka) parameters:

Install On a master microservice node, the service registry is required and

Microservice preselected. On a worker microservice node, you may optionally install the
service registry for failover or scalability.
Registry Port Type the port for the service registry that will run on this host.
Additional Type the URLs to all other instances of the service registry in the
URLs environment, separated by commas.

The URL pattern for a service registry is:

http://<host>:port/eureka/v2/

where <host> is the hostname, fully qualified domain name, or IP address.

When multiple microservice nodes with service registry instances are

configured in an environment, every .json file for every microservice on
every node must list all instances. If service registry instances are added or
changed, then edit the files as needed to update the list of service registries
(eureka). (For installation via Deployment Center, all instances are
automatically included in the list.)

Example:
eureka definitions when a service registry exists on port 8787 on
servers JPS008601, JPS008602, and JPS008603:

Teamcenter Installation on Windows, Teamcenter 14.2 11-5

© 2022 Siemens
 11. Installing Teamcenter microservices

{
"eureka":{
"image":"eureka_server-1.9.12_1.2.1",
"environment":[
"ARGS=-Deureka.serviceUrl.default=
http://JPS008601:8787/eureka/v2,
http://JPS008602:8787/eureka/v2,
http://JPS008603:8787/eureka/v2"
"JETTY_PORT=8787"
]
}
}

3. If you are installing a master node, proceed to the Microservices panel. Review the instance
quantity for each service that you want to run on this node. Typically, Teamcenter microservices are
multi-threaded, so only one instance of the microservice is needed on a node.

When the environment includes multiple microservice nodes on Windows hosts, you may want to
run only a subset of microservices on a given node. In that case, for microservices that you do not
want to install on the node, set the instance value to 0.

4. Proceed to the File Repository Microservice panel and enter parameter values.

In File Repository Storage Location, enter the path to the shared location for persistent file
storage.

The path must be accessible by all microservice nodes.

5. Proceed through the remaining panels and enter configuration values for your selected
microservices.

6. Review the Confirmation panel and click Start to begin the installation.

The framework and microservices are installed. If you are installing a master node, then signer and
validator keys are generated.

7. When installation is complete, carefully examine any messages to determine what post-installation
steps are necessary.

8. Add microservices support to the Teamcenter web tier, as applicable for Java EE or .NET web tier
architecture.

11-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Add microservice framework support to a Java EE web tier

Add microservice framework support to a Java EE web tier

If you used Teamcenter Environment Manager to install the microservice framework, use the following
procedure to add microservice framework support to a Teamcenter Java EE architecture web tier WAR
file.

This procedure assumes you installed the Web Application Manager and the WEB_ROOT directory as
described in the appropriate Teamcenter installation guide for Windows or Linux.

If you use scripts generated by Deployment Center to install the microservice framework, you do not
need to manually perform this procedure.

1. Install a microservice framework master node.

Locate the keystore ZIP file (keys.zip) in the TC_ROOT/jwt_config_tool directory of the master
microservice node host.

2. Copy the keystore ZIP file (keys.zip) to a location on your local machine and extract the ZIP file
contents.

The keystore ZIP file contains a directory named signer_config.

Caution:
Safeguard the keystore files. A best practice is to remove them from any temporary locations
once you complete this procedure.

3. Locate the following software kits:

• Teamcenter software kit for your installed version of Teamcenter

• Microservices Framework

4. Change to the WEB_ROOT directory and launch the Web Application Manager using the appropriate
command:

• Windows systems: insweb.bat

• Linux systems: insweb.sh

Teamcenter Installation on Windows, Teamcenter 14.2 11-7

© 2022 Siemens
 11. Installing Teamcenter microservices

5. Copy ICD files from the software kits. This populates the list of solutions available to install.

a. Click Copy ICDs.

b. In the Copy ICD Files dialog box, click Browse and browse to the following location:

Teamcenter-kit\Web_tier\icd

c. Click OK to copy ICD files from the kit.

d. Repeat steps a through c, specifying the path to the Microservices Framework ICD files:

Microservices-Framework-kit\Web_tier\icd

6. Click Add to begin creating a new web application.

7. In the Add Web Application dialog box, create the web application:

a. Type a Name and Staging Location for the web application.

b. Enter software locations:

A. Click Add.

B. In the Add Disk Location dialog box, enter software locations:

i. Click Browse, browse to the signer_config directory from the keystore ZIP file you
extracted in step 2, and then click Apply.

11-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Add microservice framework support to a Java EE web tier

ii. Click Browse, browse to the location of the Microservice Framework kit, and then
click Apply.

iii. Click Browse, browse to the location of the Teamcenter software kit, and then click
OK.

c. Select solutions:

A. Click Solutions.

B. In the Select Solutions dialog box, select the following web tier solutions:

• Teamcenter - Web Tier Infrastructure

• Teamcenter - Web Tier Core Applications

• Teamcenter Microservices

8. Verify your selections, and then click OK to continue creating the web application.

9. In the Modify Required Context Parameters dialog box, ensure the following context parameters
have correct values:

MICROSERVICE_ENABLED
Set to true.
MICROSERVICE_ADDRESS

Teamcenter Installation on Windows, Teamcenter 14.2 11-9

© 2022 Siemens
 11. Installing Teamcenter microservices

Specifies a comma-separated list of service dispatcher URLs of the form:

http://host:port

10. Click OK to begin building the WAR file.

When the web application generation is complete, close the Web Application Manager.

11. Locate the WAR file (tc.war) in the deployment directory under the staging location you specified.

12. Deploy the web application on a supported application server, as described in Web Application
Deployment in the Teamcenter help.

Add microservice framework support to a .NET web tier

In the typical case that the Teamcenter .NET architecture web tier machine does not also have a
microservice node installed on it, and installation is through TEM, the following procedure adds
microservice framework support (the microservice proxy).

The procedure is performed automatically if TEM is used to install both a master microservice node and
the .NET web tier on the same host, or if installation is through Deployment Center.

If you use a distributed environment in which your server managers are on hosts separate from your
microservice nodes, make sure that on the local machine that runs IIS, the IIS_IUSRS ID has full control
permissions on the net_webtier_configuration directory. IIS_IUSRS is a local user account created by
IIS.

1. Install a master microservice node on some machine in the Teamcenter environment.

The keystore file signer_keystore.p12 is installed to the TC_ROOT\signer_config directory of the

microservice node host.

11-10 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Add microservice framework support to a .NET web tier

2. On the web tier machine, before starting IIS, copy the private key signer_keystore.p12 from the
microservice node host to C:\windows\System32\inetsrv.

3. From the microservice framework kit, extract the file dotnet_microproxy-1.0.1.zip and then
extract its contents into the IIS bin folder on the web tier machine.

4. On the web tier machine, modify ApplicationConfiguration.xml, which you can find in the
TC_ROOT\net_webtier_Configuration ID\tc\ directory.

• Set microserviceEnabled to true.

<!-- Enable/disable microservice requests. (Value: true/false) -->

<param name="microserviceEnabled" value="true"></param>

• Set microserviceAddress to the location of the microservice dispatcher(s).

<!-- Specify the URL(s) to access backend microservices. This is a

comma-separated list of addresses for service dispatchers.
Each address should include the scheme, host and (optional)
port portions of a URL (e.g., "http://localhost:9090"). An IP
address can be used for the host. If the port is omitted the
service dispatcher must be listening on the default port for the scheme. -->
<param name="microserviceAddress" value="http://localhost:9090"></param>

• Set the microservice keystore.

<!-- Name of the keystore file that stores private key to sign JWT. -->
<param name="microserviceKeyStore" value="signer_keystore.p12"></param>

• Set the microservice keystore password. This is the password that was entered when installing
the microservice framework master node.

<!-- Password to read private key to sign JWT. -->

<param name="microserviceKeyStorePassword" value="password"></param>

• Set the login-manager for microservices.

<!-- Micro Services -->

<injector id="micro"
handler="Framework,Teamcenter.Presentation.Framework.RequestProcessing.RequestInje
ctorImpl">
<!--<pre-trigger
handler="Micro,Teamcenter.WebIntegrations.Micro.MicroPreTrigger"></pre-trigger>-->
<login-manager
handler="Micro,Teamcenter.WebIntegrations.Micro.MicroLoginManager"
login-failure-response-chain="microLoginFailure_response_chain">
</login-manager>
<!-- for urls tc/micro -->
<group-association-path id="micro"></group-association-path>
<config-param name="DEFAULT_LINK" value="microInvoke_link"></config-param>
<error-handler

Teamcenter Installation on Windows, Teamcenter 14.2 11-11

© 2022 Siemens
 11. Installing Teamcenter microservices

response-handler="Micro,Teamcenter.WebIntegrations.Micro.MicroResponseHandler"></
error-handler>
</injector>

5. Start IIS and in the Application Pools > DefaultAppPool or Teamcenter App Pool > Advanced
Settings page, set Load User Profile to True.

Install microservices using Deployment Center

Install microservices using Deployment Center

1. Download a Teamcenter microservice framework kit and place it in a Deployment Center software
repository.

2. In Deployment Center, open or create an environment.

3. On the Software task, add Microservice Framework.

4. On the Applications task, add the applications that you want to install in the environment.

5. On the Components task, specify values for the Microservice Node options.

For this option Do this

Installation Path Enter the path to the Teamcenter installation root folder on the microservice
node host machine.
Machine Name Enter the fully qualified domain name of the microservice node host machine.
This machine name is used to construct the Service Dispatcher URL.
OS Choose wntx64 (Windows).
Check Install Teamcenter Process Manager as a Windows service to
automatically start services when the server reboots.
Microservice Choose one of two node types:
Node Type
Master
The master microservice node in the Teamcenter environment. Exactly
one master microservice node is required in an environment. A master
node must be configured before worker nodes are configured.
Worker
A worker microservice node in the Teamcenter environment.

You can add worker Microservice Node components as needed.

Keystore Enter a password to be used for generating the .p12 files that contain keys for
Password signing and validating authentication tokens. The tokens identify the logged in
and user.

11-12 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install microservices using Deployment Center

For this option Do this

Confirm Record and keep secure the password for potential use should you want to
Password open and edit the keys.
Protocol Choose the protocol to use for moving data between the Teamcenter web tier
and the Service Dispatcher. The default protocol is http. If the Teamcenter
architecture type is Java EE, then you have the option of choosing https.

For this web tier

architecture Do this
.NET Choose http.
Java EE Choose either http or https.
If you choose https, then you need to perform some
additional steps later to Configure service
dispatcher as an HTTPS server.
Port As applicable, enter the port number for communication with the Service
Dispatcher and the Service Registry.
Both the Service Dispatcher and the Service Registry are required on the
master node.
Teamcenter As applicable, Deployment Center supplies these values as you complete the
Microservice URL environment configuration.
and Service
Registry URL

6. Enter microservice parameter values as required. The parameters shown vary, depending on which
applications are selected for the environment.

Example:
Active Workspace uses a file repository microservice. To configure that service for
deployment on a Windows host, in the parameter value for File Repository Storage
Location, enter the path to the shared location for persistent file storage. The path must be
accessible by all microservice nodes.

7. In the Services list, review the quantity of instances for each service.

Typically, Teamcenter microservices are multi-threaded, so only one instance of the microservice is
needed on a server.

When the environment includes multiple microservice nodes, you may want to run only a subset of
microservices on a given node. In that case, for microservices that you do not want to install on the
node, set the instance value to zero.

8. Save the component settings.

Teamcenter Installation on Windows, Teamcenter 14.2 11-13

© 2022 Siemens
 11. Installing Teamcenter microservices

Deployment Center copies the generated service dispatcher URLs to the Active Workspace Gateway
and Web Tier components.

9. If a microservice node does not include a service dispatcher instance, or if you plan to use a load
balancer for ingress to service dispatcher instances, go to the Active Workspace Gateway and Web
Tier component panels, click Show all parameters , and scroll to the Microservice Node
Connection(s) table. Select Override connection and edit the table as needed to correctly specify
the ingress URLs for the service dispatcher(s). To remove a URL row, select the row and then click
Remove connection .

10. Complete configuration of the environment and generate deployment scripts.

11. Run the deployment scripts.

Run the microservice node scripts before you run the web tier deployment script.

12. If your environment uses the .NET architecture, on the web tier server machine where IIS is
running, in Application Pools > DefaultAppPool or Teamcenter App Pool > Advanced Settings,
set Load User Profile to True.

13. If your environment uses the Java EE architecture:

a. Locate the WAR file (tc.war) in the deployment directory under the staging location you
specified.

b. Deploy the WAR file on a supported application server, as described in Web Application
Deployment in the Teamcenter help.

14. If you chose the https protocol for moving data between the Teamcenter web tier and the Service
Dispatcher, then Configure service dispatcher as an HTTPS server.

15. Start the framework and services.

Microservice processes are started by the Teamcenter Process Manager, which can be started as
either a Windows service or from a startup file.

Windows If you selected the Install the Teamcenter Process Manager as a Windows
service service option, then the Teamcenter Process Manager starts automatically with
system startup.

The Teamcenter Process Manager appears in the Windows service list as

Teamcenter Process Manager if POOL_ID is not defined, else Teamcenter
Process Manager <POOL_ID>.
Startup file Run the Teamcenter Process Manager startup file:

TC_ROOT\process_manager\start_manager.bat

11-14 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Add microservices and microservice nodes

Add microservices and microservice nodes

To increase capacity of heavily used microservices deployed on Windows hosts, you can add
microservice nodes and microservice instances via Deployment Center.

1. In Deployment Center, on the Components task for your environment, select an existing
microservice node component or add a new Microservice Node component.

2. Configure the node, including the microservices you want to run on the node, as described in
Install microservices using Deployment Center.

3. Complete your environment configuration and follow the Deployment Center instructions for
deploying the generated zip files onto the target machine(s).

4. Start the framework and services.

Manage microservice instances

If a microservice framework node is running on a Windows host, then you can temporarily change the
number of microservice instances on the node.

This method is simple and quick, but temporary. To add new microservices to a node, or to configure the
number of instances that start when the Teamcenter Process Manager service is restarted, you must
run TEM or Deployment Center.

1. On the Windows microservice framework node host, browse to localhost:8082.

The default logon credentials are "manager" and "manager". The logon credentials can be changed
once logged in to the management interface.

If port 8082 does not work, then check the port setting in the serverPool.properties file. The file is
stored in the TC_ROOT\process_manager\ directory.

2. On the Agent View page, under Administer services, click the link to the microservice page that
you want to manage.

For example, click id=hello_service.

The administration page for the service opens.

3. To change the number of microservice instances, at the bottom of the page in the box next to
Change_Replicas, enter a new value.

4. To apply the new value, click Change_Replicas.

Teamcenter Installation on Windows, Teamcenter 14.2 11-15

© 2022 Siemens
 11. Installing Teamcenter microservices

Note:
If you use the .NET web tier in a distributed environment in which your server managers are on a
separate machines from your microservice nodes, make sure that the IIS_IUSRS ID on the local IIS
host has full control on the net_webtier_configuration directory. IIS_IUSRS is a local user account
created by IIS.

Finding microservice logs

If a microservice framework node is running on a Windows host, then by default, logs of microservice
instances on the node are written to the %TEMP% location. An administrator can redirect log files.

To find the files, search for [%TEMP%]\*-msf.log

Service Log file name Example

Service Dispatcher service_dispatcher<Instance#>@ service_dispatcher1@2184-
<PID>-msf.log msf.log
Service Registry eureka<Instance#>@<PID>- [email protected]
msf.log
Microservices <microservice [email protected]
name><instance#>@<PID>-
msf.log
Microservice Manager TC_ROOT\microservice_manager
\mgr.output
Active Workspace Gateway gateway<Instance#>@<PID>- [email protected]
msf.log

Redirect microservice logs

If a microservice framework node is running on a Windows host, you can specify the location for the
logs of microservice instances on the node. Logs are written to the location specified by a %TEMP% path
variable.

1. Depending on how you run Teamcenter Process Manager, set the value of %TEMP% as desired.

If you run Process

Manager as Do this to set the %TEMP% value
a Windows process Edit the start_manager.bat file.
The file is in the TC_ROOT\microservice_manager folder.
a Windows service Set either a global value or a variable specific to the Teamcenter
Process Manager:

11-16 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Redirect microservice logs

If you run Process

Manager as Do this to set the %TEMP% value
• For a global value, set the system variable %TEMP% path.

• For a variable specific to the Teamcenter Process Manager:

a. At a command prompt, stop and delete the service.

sc stop "Teamcenter Process Manager"

sc delete "Teamcenter Process Manager"

b. In an editor, open the file %TC_ROOT%

\microservice_manager\install_manager.bat and edit
the EXTRA_ENV variable to set the location of TEMP as
desired.

Example:
rem EXTRA_ENV specifies additional
environment variables needed to run as
Windows service.
set EXTRA_ENV=-env MICRO_ROOT=%MICRO_ROOT%
TEMP=C:\mylogs

2. Restart the Process Manager.

To run the Process

Manager as Do this
a Windows process Run start_manager.bat.
a Windows service Run install_manager.bat.

3. If you have implemented log aggregation, do the following:

a. Stop the Teamcenter Log Forwarder Windows service.

b. Edit the file %TC_ROOT%/tc_logging_forwarder/config/sources/msf.conf to reflect the new

path value.

Example:
##################################################################
# Source Input - MSF Log Files (Eureka, Dispatcher, Microservices)
##################################################################
<source>
@type tail

Teamcenter Installation on Windows, Teamcenter 14.2 11-17

© 2022 Siemens
 11. Installing Teamcenter microservices

path C:/mylogs/*@*-msf.log

c. Restart the Teamcenter Log Forwarder Windows service.

Securing microservices

Configuring HTTPS for microservices traffic

Based on an SSL certificate and its keys, an administrator can configure HTTPS for encrypting data traffic
in the microservice framework. Typical authentication is unidirectional. That is, a Teamcenter client
checks that the service dispatcher is authentic and subsequent traffic between the two is encrypted.

Sequence for server authentication

Configuring the microservice framework and microservices for encrypted communication requires the
following:

• Obtain an SSL certificate and keys for the server that will host the service dispatcher.

11-18 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configure service dispatcher as an HTTPS server

A server certificate signed by a certificate authority (CA) can be purchased from a CA, and is
recommended. Alternatively, cryptographic tools such as OpenSSL can be used to create a self-signed
certificate and its keys. In the case of a self-signed certificate, the certificate issuer must be added to
the client machine's trust store.

• When configuring a microservice node, for the Service Dispatcher Setting, choose the HTTPS
protocol.

• After running deployment scripts on the microservice node host(s), configure the service dispatcher
for HTTPS.

• When configuring the Active Workspace Gateway, if you choose to override the default service
dispatcher URL, ensure that you enter the HTTPS protocol for the Service Dispatcher URL.

Configure service dispatcher as an HTTPS server

Depending on the host operating system, details of this procedure vary. These instructions are for a
microservice node on a Windows host. For a microservice node on a Linux host, see Configure service
dispatcher as an HTTPS server in Teamcenter Installation on Linux.

1. Obtain an SSL certificate for the server that will host the service dispatcher.

2. Use the Java keytool to create a Java trust store in PKCS12 format and place the certificate (public
key) in the store.

The trust store contains certificates (public keys) that are either Certificate Authority-signed or self-
signed. While both PKCS12 and JKS trust store file formats are accepted, Siemens Digital Industries
Software recommends the PKCS12 format because it has greater microservice compatibility.

3. Using Deployment Center or TEM, ensure the following:

• The machine name where the service dispatcher is being deployed matches the name in the
certificate.

For example, if the certificate is for sd.example.com, then the service dispatcher host machine
name must be sd.example.com.

• https is the selected protocol for service dispatcher.

Teamcenter Installation on Windows, Teamcenter 14.2 11-19

© 2022 Siemens
 11. Installing Teamcenter microservices

4. Place the trust store in TC_ROOT\microservices\secrets of each microservice node where a service
dispatcher runs.

5. Edit the service dispatcher configuration. Extend the ARGS value for the service dispatcher to
provide values for the following:

For this argument Do this

protocol Choose https.
keystore Specify the location of the key store holding the private key.
kspassword Specify the password for the key store.
keystoreType (if not JKS) Specify PKCS12 if not using JKS.
truststore Specify the location of the trust store holding the certificate (public key).
truststoreType Specify the trust store type (PKCS12 or JKS) .
truststorePassword Specify the password for the trust store (PKCS12 or JKS) holding the
certificate (public key).

Make these configuration file changes

TC_ROOT\microservices\services_config\service_dispatcher.json
Add security properties to the file.
Example:
Original file content, including the ARGS setting:

{
"service_dispatcher":{
"image":"service_dispatcher-1.2.0",
"environment":[

11-20 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configure service dispatcher as an HTTPS server

Make these configuration file changes

"ARGS=-Dport=9090 -Deureka.serviceUrl.default=http://msnode1:8080/eureka/v2"
]
}
}

File content after adding security properties:

{
"service_dispatcher":{
"image":"service_dispatcher-1.2.0",
"environment":[
"ARGS=-Dport=9090 -Dprotocol=https -Dkeystore=path_to_key_store_file
-Dkspassword=trust_store_password -DkeystoreType=pkcs12 -Deureka.serviceUrl.default=
http://msnode1:8080/eureka/v2" -Dtruststore=path_to_trust_store_file
-Dtruststorepassword=trust_store_password -DtruststoreType=pkcs12
-Deureka.serviceUrl.default=
http://msnode1:8080/eureka/v2"

The trust store password is needed in case you are using a PKCS12 certificate. Be sure to use a
forward slash ‘/’ in the file path.

6. Add the certificate to the list of certificates the microservices trust. The procedure for this varies
based on the language in which the microservice is written.

For these
microservices Do this
Declarative a. Edit the file %TC_ROOT%\microservices
Artifact Service \services_config<microservice>.json.

iModel Viewer b. In the file, set the environment variable NODE_EXTRA_CA_CERTS, which
Service points to the location of the certificate. The certificate must be in the
PEM format and must not have been generated using DSA encryption.
Microservice
Parameter Store Add the variable in the environment section.

Teamcenter
Example:
GraphQL Service
ClassificationAI

(Source code
language:
Javascript/
Typescript using
NodeJS)

Teamcenter Installation on Windows, Teamcenter 14.2 11-21

© 2022 Siemens
 11. Installing Teamcenter microservices

For these
microservices Do this

For additional information about this variable, see NodeJS

documentation.

c. Restart the process manager.

ep-app a. Add the certificate authority (CA) to the JVM's list of trusted certificates.

Event Notification Ensure that the following two arguments are passed to the JVM:
Service
-Djavax.net.ssl.trustStorePassword=
FileRepo
-Djavax.net.ssl.trustStore=path_to_truststore_file_in
mfe-vis
_.jks_format
odata_service
The method for doing this for Java-based microservices depends on their
req-compare- implementation. Generally, the .json file has an ARGS variable, to which
service you can append arguments. In lieu of that, you can edit the
microservice's start_service.bat file to add these arguments to the JVM.

Some microservices support editing the TC_ROOT\microservices

\services_config\microservice.json file to alter the JVM arguments.
(Source code
language: Java)
Others require that you modify the corresponding TC_ROOT
\microservices\microservice\start_service.bat script to add the JVM
arguments.

b. Restart the process manager.

Command a. If the trust store file is in .jks format, convert the .jks file to .pk12.
Prediction
For example, to list entries in a keystore file named keystore2.jks, run
Google Online the command:

11-22 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configure service dispatcher as an HTTPS server

For these
microservices Do this
Office Online keytool -list -keystore ./keystore2.jks

Product To convert a keystore file named keystore2.jks to a .pk12 file using the
Configurator key mykey and the password testKeyStorepw, run the command:
Service
keytool -importkeystore -srckeystore [./keystore2.jks]
reqexportservice -destkeystore ./keystore2.p12 -srcstoretype JKS
-deststoretype PKCS12
reqimportservice -srcstorepass testKeyStorepw -deststorepass testKeyStorepw
-srcalias mykey
-destalias mykey -srckeypass testKeyStorepw -destkeypass
testKeyStorepw -noprompt

Xcelerator Share
b. Double-click the .pk12 file to install it as a trusted certificate.

(Source code
language: C#)

Configure the web tier for HTTPS with the service dispatcher

1. Configure the Teamcenter web tier as appropriate for the web tier type.

For this web tier

type Do this
Microsoft .NET a. In ApplicationConfiguration.xml, modify the parameter
microserviceAddress.

Example:

<param name="microserviceAddress" value="http://

service_dispatcher:9090"/>

becomes

<param name="microserviceAddress" value="https://

service_dispatcher.domain.com:9090"/>

b. Restart the web server.

Java EE a. In Teamcenter Web Application Manager (insweb), modify the Context
Parameters:

MICROSERVICE_ADDRESS
MICROSERVICE_TRUSTSTORE
MICROSERVICE_TRUSTSTORE_TYPE
MICROSERVICE_HOST_VERIFY_MODE

Teamcenter Installation on Windows, Teamcenter 14.2 11-23

© 2022 Siemens
 11. Installing Teamcenter microservices

For this web tier

type Do this
Example:

<param-name>MICROSERVICE_ADDRESS</param-name>
<param-value>http://service_dispatcher:9090</param-value>

becomes

<param-name>MICROSERVICE_ADDRESS</param-name>
<param-value>https://service_dispatcher.domain.com:9090</
param-value>

b. Redeploy the tc.war file.

2. Public keys for CA-issued certificates are already available in the web tier. If you are using self-
signed certificates, do the following:

a. Place the certificate (public key) in a trust store for the web tier.

b. If the trust store is not already located as configured, place the trust store in the location that
was configured in the Teamcenter installer web tier Microservice Communications Settings.

Configure Active Workspace Gateway for HTTPS with the service dispatcher

If the Certificate Authority (CA) for the service dispatcher certificate is known to the Active Workspace
Gateway, no further action is required.

11-24 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 High availability for microservices

If the service dispatcher certificate is a self-signed certificate or is from a certificate authority not known
to the Active Workspace Gateway host operating system, do the following on the Active Workspace
Gateway host to point to the required certificate.

Windows
Set the NODE_EXTRA_CA_CERTS environment variable (https://nodejs.org/api/
cli.html#cli_node_extra_ca_certs_file).
Linux
Edit the gateway.yml file to point to the certificate.

For example:

High availability for microservices

In a distributed Teamcenter production environment, ensure high availability by configuring redundant

microservice node servers and service instances. For detailed deployment examples and sample
configurations, see Teamcenter Deployment Reference Architecture, available from the Teamcenter
downloads page on Support Center.

Capacity

With the many variables affecting a Teamcenter environment, no simple formula exists that can
prescribe the precise combination of microservice nodes and microservice instances. As with all server-
side deployments, monitor the consumption of CPU and memory on each microservice node. If you
observe resource contention, you can increase resources for microservice execution by deploying
additional microservice nodes and services running on additional hardware.

Teamcenter Installation on Windows, Teamcenter 14.2 11-25

© 2022 Siemens
 11. Installing Teamcenter microservices

Failover

Windows
Achieving failover capability on Windows requires that a service registry, a service dispatcher, and
instances of all microservices must each be running on at least two nodes. By default, an instance of
the service registry and service dispatcher run on the master node; additional instances can be
running on any worker nodes. When installing microservice nodes through TEM, be sure to list all
instances of the service registry and the service dispatcher.
Docker Swarm
Achieving failover capability with Docker Swarm on Linux requires that an odd number of servers be
joined to the swarm as managers, typically three or five. This helps the Docker swarm effectively
manage the swarm by majority vote. Any number of servers can be joined to the swarm as workers.
Kubernetes

Control Plane Follow the vendor documentation. If using a cloud provider, the provider typically
provides a Control Plane with failover.
Microservice To avoid a single point of failure, in on-site deployments implement at least two
nodes microservice nodes. Ensure that these nodes are allocated on different physical
hardware. Allocate at least two replicas of every component to avoid a single point
of failure. For nodes in cloud deployments, to avoid location-specific outages,
ensure that the nodes are spread across different failure zones (such as AWS
Availability Zones).
The exception to replicating components is the Service Registry. A single Service
Registry is sufficient. This is because in the event that the Service Registry (Eureka)
container goes down, the Eureka Client Cache provides needed information during
the brief period of time that passes while the container manager brings back up
the container.

If possible, test for node failure conditions and validate that client requests are handled using
service load balancing. Ensure desired scale once the nodes are recovered.

For backup options, consult the vendor documentation.

11-26 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 High availability for microservices

Example microservice deployment topologies for high availability

Teamcenter Installation on Windows, Teamcenter 14.2 11-27

© 2022 Siemens
 11. Installing Teamcenter microservices

11-28 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 12. Installing Active Workspace
Active Workspace components installation overview

The primary Active Workspace components are Server Extensions, Client, Indexing, and Visualization
Server. Each of these require their own sequences of installation tasks. In the installation paths shown,
octagons indicate verification tasks where you must ensure all previous steps are complete before you
continue.

Teamcenter Installation on Windows, Teamcenter 14.2 12-1

© 2022 Siemens
 12. Installing Active Workspace

Whether you use TEM or Deployment Center to install Active Workspace components, you may need to
enter or verify the following values from your Teamcenter environment:

Teamcenter four-tier environment configuration

Parameter Your value

Teamcenter machine name and credentials

Teamcenter installation directory (TC_ROOT)

Teamcenter data directory (TC_DATA)

Teamcenter four-tier URL (http://host:port/tc)

Teamcenter FMS machine name and bootstrap

URLs (http://host:4544)

Licensing server machine name and port (28000

by default)

Database system machine and credentials

Operating system credentials for component

servers

Location of security certificates and keys

Microservice node information if already installed

Active Workspace Server Extensions

Server Extensions overview

Install Active Workspace server extensions features on each Teamcenter server where Teamcenter
Foundation is installed. This includes corporate servers, volume servers, and server manager hosts.
Installing these features adds software to the Teamcenter home directory (TC_ROOT) and adds data
model changes to the database and the TC_DATA directory.

Make sure your Teamcenter environment has the following:

12-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Server Extensions overview

• Supported version of Teamcenter

Active Workspace 6.2 supports the latest versions of Teamcenter or Teamcenter Rapid Start, and some
earlier versions. If you do not use the latest version of Teamcenter or Teamcenter Rapid Start, see the
Hardware and Software Certifications knowledge base article on Support Center.

• Corporate server

• Server manager

• Teamcenter web tier (Java EE or .NET)

Installing Server Extensions requires the following values from your Teamcenter environment. Be
prepared to enter these values into the installation tool (TEM or Deployment Center) during Active
Workspace installation.

Values required before installing Server Extensions

Parameter Your value

Teamcenter administrative user password

Database system user login/password

Teamcenter home directory (TC_ROOT)

Teamcenter data directory (TC_DATA)

Indexing Engine user name and password

Search engine URL (Example: http://host:8983/solr)

Teamcenter Installation on Windows, Teamcenter 14.2 12-3

© 2022 Siemens
 12. Installing Active Workspace

Install Server Extensions features

Install Server Extensions on every host that has Teamcenter Foundation installed.

1. Stop all Teamcenter services except FSC services.

2. Launch the installed Teamcenter Environment Manager (TEM) for the corporate server.

3. In the Maintenance panel, select Configuration Manager.

4. In the Configuration Maintenance panel, select Perform maintenance on an existing

configuration.

5. In the Old Configuration panel, select the corporate server configuration.

6. In the Feature Maintenance panel, select Add/Remove Features.

7. In the Features panel, select Active Workspace Server Extensions features:

a. Expand Base Install→Active Workspace→Server Extensions.

b. Select the Active Workspace Server Extensions feature. (This feature is required.)

c. Select any additional Server Extensions features you want to include in your Active
Workspace deployment.

Some features may display additional panels in TEM that are not described in this procedure.
See the help buttons in those panels for information.

Note:
• To search for a feature by name, type the name or a partial name in the search box, and
then click the search icon.

• Some Server Extensions features depend on other Server Extensions features.

8. In the Teamcenter Administrative User panel, type the user’s password.

9. In the Indexing Engine User panel, type the Solr administrator’s user name and password.

The Solr administrator’s user name and password are defined when you install the Indexing Engine
(Solr).

If Indexing Engine is not installed yet, record the Solr administrator user name and password and
make sure to use these credentials when you install Indexing Engine. These credentials must match

12-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install database triggers manually

for Indexing Engine, the Indexer, Server Extensions, and the Active Content Structure Translator (if
used).

10. In the Active Workspace Server Extensions Settings panel, type the Solr search engine URL. The
format is:

http://host:port/solr

host is the machine designated to run Solr. This is the machine on which Indexing Engine is to
be installed.

port is the port value used by Solr. The default is 8983.

If your environment uses multiple Solr search engines for failover, select Use additional search
engine URLs, and then type the URLs in the Search Engine URL List.

11. In the Database User panel, type the password for the Teamcenter database user.

12. In the Database Template Summary panel, review the list of templates to be applied to the
Teamcenter database. The list varies depending on the features selected for installation.

13. In the Confirmation panel, click Start to begin the installation.

The TcFTSIndexer process requires database triggers that enable database access for the Indexer
to detect changes to the database when performing run-time (synchronous) indexing. If TEM
cannot install these indexing triggers automatically, it informs you to install the database triggers
manually.

14. When installation is complete, close TEM.

Install database triggers manually

The TcFTSIndexer process requires database triggers that enable database access for the Indexer to
detect additions, modifications, and deletions to the database when performing run-time (synchronous)
indexing.

In most cases, TEM installs these indexing triggers automatically. However, if you do not provide the
necessary values (logon values for the database user and the system user) to install them during your
TEM session, TEM displays a TODO message about enabling database access to Teamcenter. If this
happens, install the database triggers manually using the appropriate procedure for your database:

Install database triggers in Oracle

1. To grant the create trigger privilege to the Oracle user that owns the Teamcenter database,
perform the following steps:

Teamcenter Installation on Windows, Teamcenter 14.2 12-5

© 2022 Siemens
 12. Installing Active Workspace

a. Open a command prompt.

b. Type:

sqlplus system/password

c. Type:

grant Create trigger to Tc-Oracle-user identified by password;

d. Type:

exit

2. Create the trigger:

a. In the command prompt, type:

sqlplus Tc-Oracle-user/password

b. Type:

@Teamcenter-installation-media\tc\install\sitecons\sitecons_install_triggers_oracle.sql

Install database triggers in Microsoft SQL Server

1. Open Microsoft SQL Server Management Studio.

2. Complete the Connect to Server dialog box:

a. In the Server name box, select the host on which Microsoft SQL Server is installed.

b. In the Authentication box, select SQL Server Authentication.

c. In the Login box, type the database administrative user name.

d. In the Password box, type the database administrative user password.

e. Click Connect.

3. In the Object Explorer panel of the Microsoft SQL Server Management Studio dialog box,
expand the Databases tree and select the Teamcenter database name, for example, tc.

4. From the menu bar, choose File→Open→File.

5. In the Open File dialog box, navigate to the software kit for the Teamcenter major release.

12-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install database triggers manually

In the Tc-software-path\tc\install\sitecons directory, select sitecons_install_triggers_mssql.sql.

Microsoft SQL Server Management Studio opens the selected file.

6. Click Query→Execute.

The query installs the database triggers.

7. Verify that the query completed with no errors.

8. Close the Microsoft SQL Server Management Studio.

Installing database triggers from the command line

If Microsoft SQL Server Management Studio is not installed on your host, you can install the database
triggers from a command line. Type the following command in a Windows command prompt:

sqlcmd -H host -d database -U user -P password -i path

\sitecons_install_tables_and_triggers_mssql.sql

Replace:

• host with the database server host name.

• database with the Teamcenter database name.
• user with the database user name.
• password with the database user password.
• path with the path to the sitecons_install_triggers_mssql.sql file.

For example:

sqlcmd -H myhost -d TcDB -U dbUser -P dbPassword -i

C:\software\tc\install\sitecons\sitecons_install_triggers_mssql.sql

To verify the triggers installed successfully, log into Microsoft SQL Server and type the following
commands in an SQL prompt:

1> Select name,is_disabled from sys.triggers2> Go

If the installation succeeds, Microsoft SQL Server displays a table similar to the following showing that
the database triggers are not disabled:

name is_disabled
-----------------------------------------------------------------
fast_sync_add_trigger 0
fast_sync_delete_trigger 0
(2 rows affected)

Teamcenter Installation on Windows, Teamcenter 14.2 12-7

© 2022 Siemens
 12. Installing Active Workspace

Active Workspace client components

Active Workspace client overview

Active Workspace client functionality is delivered through Active Workspace Gateway, a Node.js
implementation that routes all requests for static content such as HTML, CSS, Javascript, JSON, and other
types, and dynamic content such as API routing to back-end services and microservices for SOA, FMS,
Visualization, GraphQL, and others.

Active Workspace Gateway employs Teamcenter microservices for some request types. For example,
Active Workspace client content is stored in an Active Workspace file repository and managed by the File
Repository microservice.

Deploying the Active Workspace client requires installing the following applications using TEM or
Deployment Center. You must deploy the applications in the order listed. Review each of the procedures
before you begin your installation.

Active Workspace microservices

Active Workspace Gateway

Active Workspace client

Active Workspace client features require the following hardware and software:

• A minimum of 1 GB of free physical RAM (unused by other applications) to avoid paging. Siemens
Digital Industries Software recommends that the machine used have a minimum of 2 GB.

• 64-bit Java development kit (JDK) installed and the JAVA_HOME system environment variable set.

• On Linux hosts, the Active Workspace Gateway requires:

• Node.js.

• Microservice framework.

Microservice framework requires a container manager, namely Docker or Kubernetes. If you install
microservice nodes on a Linux host, make sure Docker is installed on the host.

12-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install Active Workspace microservices

For certified versions of required third-party software, see the Hardware and Software Certifications
knowledge base article on Support Center.

Be prepared to enter the following values from your Teamcenter environment during installation of
Active Workspace client components:

Values required before installing the Active Workspace Gateway

Parameter Your value

Teamcenter web tier URL

FSC Bootstrap URLs (http://host:4544)

For information about configuring security for this client, see Securing Your Teamcenter Environment in
the Active Workspace help collection.

Install Active Workspace microservices

The microservice framework must be installed before you begin these steps. You can add Active
Workspace microservices to an existing microservice node or install the microservices and Microservice
Framework at the same time.

1. Launch your preferred installation tool (TEM or Deployment Center) to begin installing Active
Workspace microservices.

2. Choose the software.

TEM Add the Active Workspace 6.2 software kit and the Microservice Framework
software kit to the Media Locations panel.
Deployment Add the Active Workspace 6.2 software kit and the Microservice Framework
Center software kit to Software Repositories. Whether you are installing or updating an
environment, ensure all applicable software kits are present.

Check the Selected Software list, including the base and minor release versions
of Teamcenter software. You may install microservices as part of an installation or
an upgrade.

In Options, choose the Distributed environment type and the architecture.

3. In TEM, add the following microservices in the Features panel:

• File Repository Service

• Teamcenter GraphQL Service (optional)

Teamcenter Installation on Windows, Teamcenter 14.2 12-9

© 2022 Siemens
 12. Installing Active Workspace

• Declarative Artifact Service (optional)

In Deployment Center, Selected Applications automatically includes these microservices. You can
view them in the Microservice Node component configuration.

4. In TEM, configure the microservices with the required values.

In Deployment Center, configure the Microservice Properties on a Microservice Node

component.

• File Repository Microservice

Value Action

File Repository Storage Location Type a location for the file repository to be used by the
Active Workspace Gateway. The path must exist on the
machine that hosts the microservice node. For
example: c:\tc\file_repository
The file repository stores Active Workspace content.

User ID (Linux only) Type the user ID of the user installing the
File Repository Microservice.

Group ID (Linux only) Type the Group ID of the user installing the
File Repository Microservice.

• GraphQL Microservice

Value Description

Teamcenter Web Tier URL In TEM, type the path to the deployed Teamcenter web
tier, for example:

http://host:port/tc

In Deployment Center, the Microservice Node locates

the URL from the Teamcenter Web Tier component
automatically.

Note:
On Linux systems, microservices Worker Nodes must contain the same installed
microservices as the Master Node.

5. In TEM, start the microservices after you complete the microservices installation, using the
appropriate method for your operating system.

12-10 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install Active Workspace Gateway

In Deployment Center, continue with the Active Workspace Gateway installation.

Install Active Workspace Gateway

Active Workspace Gateway requires the keystore ZIP file (keys.zip) from the microservice master node.
Before you install Active Workspace Gateway, copy the keys.zip file from the jwt_config_tool directory
under TC_ROOT on the microservice master node host to a directory on the Active Workspace Gateway
host.

You can install Active Workspace Gateway in a new or an existing Teamcenter environment. Use the
same installation tool you use to install Active Workspace microservices:

Install the Active Workspace Gateway using TEM

Install the Active Workspace Gateway using Deployment Center

Install the Active Workspace Gateway using TEM

1. If you are installing Active Workspace Gateway in a new configuration (on a machine with no
existing Teamcenter environment), skip to step 2.

If you are adding Active Workspace Gateway to an existing configuration:

a. Add Active Workspace and Microservice Framework to the Teamcenter host.

b. Launch the installed TEM in maintenance mode.

c. Skip to step 7.

2. Make sure you have access to the following software kits:

• Teamcenter 14
• Teamcenter 14.2
• Active Workspace 6.2
• Microservices Framework 6.2

3. Launch TEM from the Teamcenter minor release kit.

On Windows hosts, right click the tem.bat program icon and choose Run as administrator.

4. Proceed to the Install/Upgrade Options panel and then click Install.

5. In the Media Locations panel, enter paths to the software kits.

• In the Original Media Location box, enter the path to the software kit for the major version of
Teamcenter.

Teamcenter Installation on Windows, Teamcenter 14.2 12-11

© 2022 Siemens
 12. Installing Active Workspace

• In the Update Location box, enter the paths to Active Workspace 6.2 and Microservices
Framework software kits.

The path to the Teamcenter minor version software kit is already included in the list of update
locations.

6. In the Configuration panel, enter an ID and a Description for the configuration.

7. In the Features panel, under Base Install>Active Workspace>Client, select Active Workspace
Gateway.

If you are installing a new configuration, enter an installation location in the Installation Directory
box.

8. In the Gateway Settings I panel, enter the required values:

Value Description
Teamcenter Web Enter the URL for the Teamcenter web application, in the following form:
Tier URL
http://host:port/tc
Visualization Enter the URL to the Visualization Server Assigner, in the following form:
Assigner URL
http://host:port
Easy Plan URL Enter the URL to the Easy Plan application, if installed. The URL should be
of the following form:

http://host:port/application-name
NGP URL Enter the URL to the Next Generation Planning (NGP) application, if
installed. The URL should be of the following form:

http://host:port/application-name
Service Dispatcher Enter the URL to the service dispatcher, based on the service dispatcher
URLs host and port you used when you installed the microservice node:

http://host:port

The default port is 9090.

If you installed multiple nodes, you may enter multiple URLs as a comma-
separated list. Use fully-qualified domain names or IP addresses in URLs.
Container Registry Specifies the registry URL to store Docker images.
URL
The value should be in the form of a host name, FQDN, or IP:port. Do not
include protocol, such as http:// or https://. For example:

12-12 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install Active Workspace Gateway

Value Description
registry.example.com

This value should reference a live container registry. TEM attempts to

connect to the registry. If the connection attempt fails, TEM does not
allow you to continue.
Container Repository Specifies the name of the container repository. The default value is
Name teamcenter.
This value must not contain spaces. The repository name must already
exist in the container registry.
Gateway Service Enter the port used by the Active Workspace Gateway. The default value is
Port 3000.
The URL to the Active Workspace client interface is based on this port.
Under FMS Settings, enter the following settings for accessing FMS volumes:
Use as Bootstrap The Active Workspace client uses FMS to download and upload files. You
URLs define the FSC servers that are used by selecting either Use as Bootstrap
URLS or Use Assigned FSC URLs.
To use bootstrap URLs, select this option and fill in the Bootstrap URLs
and Bootstrap Client IP boxes.
On Linux hosts, if you select Use as Bootstrap URLs, you need to ensure
the client map is configured correctly.
Bootstrap Enter a comma-separated list of URLs to one or more existing FMS server
URLs caches (FSCs).
URLs must be of the form:

http://host:port

By default, the IP address from the HTTP connection of the requestor is

used unless a Bootstrap Client IP value is provided. (The client/requestor
is the host on which Active Workspace Gateway is deployed.)
Bootstrap Enter the FMS bootstrap client IP address to be used for the assignment.
Client IP
On Linux hosts, enter the internal IP address of the Active Workspace
Gateway machine.
Use Assigned FSC Specifies whether you want to assign FSC servers. Select this only if you
URLs want explicit control of the FSCs used.
To use assigned FSCs, select this option and fill in the Assigned FSC URLs
box.
Assigned FSC Enter a comma-separated list of one or more assigned FSC URL values.
URLs
The URL values entered are directly used for file operations. This allows
you to declare the FSC servers that should be used.

Teamcenter Installation on Windows, Teamcenter 14.2 12-13

© 2022 Siemens
 12. Installing Active Workspace

For information about other values in the Gateway Settings panel, click the help button .

9. In the Gateway Settings II panel, enter the required values:

Value Description
Xcelerator Values for configuring the Xcelerator Share Collaboration integration to
Teamcenter.
Xcelerator Share Specifies the URL to the Xcelerator Share site.
URL
The default value is https://share.sws.siemens.com.
Client ID Specifies the SAMAuth client ID you obtained through SAM URL.
Client Secret ID Specifies the client secret ID you obtained through SAM URL.

10. In the Gateway Security Settings panel, enter the required values:

Value Description
Keystore Zip File Enter the location of the keystore zip file (keys.zip) generated when you
installed the microservice master node.
The keystore file is generated in the jwt_config_tool directory under
TC_ROOT on the microservice node host. For security, copy the keys.zip
file to a directory on the Active Workspace Gateway host and specify that
location here.
Under Enable TcSS Support, enter values for configuring Security Services.
Enable TcSS Support Select this check box if you want to enable Security Services support in
Active Workspace.
TcSS Application ID Type the Security Services application ID.
TcSS Login URL Type the logon URL for the Security Services application.
For details about configuring Security Services, see Security Services
Installation/Customization in Teamcenter documentation.
When you configure Active Workspace for Security Services, be sure to
only install the language packs for the Security Services that Active
Workspace supports.
If Active Workspace is deployed on a different URL, you must configure
Security Services with multiple application IDs.
Under Security Key Settings, enter security key values for Teamcenter.
Security Certificate Enter the path to the security certificate.
The file must be in .pem format.
Security Key Enter the path to the security key file.
The file must be in .pem format and must be without a password.

12-14 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install Active Workspace Gateway

11. In the Confirmation panel, click Start to begin the installation.

12. When the installation is complete, close TEM.

13. Verify the FMS server cache (FSC) service is running.

14. On Linux hosts, start the Docker swarm, microservices node, and the Gateway service.

The Gateway service should not join the swarm.

Install the Active Workspace Gateway using Deployment Center

You can install Active Workspace Gateway into a new or existing environment:

1. Make sure you have the following software in your repository.

• Teamcenter 14
• Teamcenter 14.2
• Active Workspace 6.2
• Microservices Framework 6.2

Choose your new or existing environment, and create or update the Selected Software list.

2. In Selected Applications, required Active Workspace applications are automatically listed. You
may add other applications you want to deploy that do not use Active Workspace Gateway.

3. In the Selected Components list, choose Active Workspace Gateway.

Enter the machine name and operating system. The installation path to Teamcenter may be
specified automatically if it was entered in another component.

4. Expand the configuration sections to show all parameters, and enter the required values.

Value Description
Port Enter the port for Active Workspace Gateway. The default value is 3000.
The URL to the Active Workspace client interface will use this port.
https If you use HTTPS protocol, choose https and enter the following certificate
settings:
TLS Enter the path to the certificate file. The file must be in .pem
certificate format.
file path
TLS key file Enter the path to the security key file. The file must be
path in .pem format and must be without a password.

Teamcenter Installation on Windows, Teamcenter 14.2 12-15

© 2022 Siemens
 12. Installing Active Workspace

Value Description
http If you use HTTP protocol, choose http.
Use as Bootstrap The Active Workspace client uses FMS to download and upload files. You
URLs define the FSC servers that are used by selecting either Use as Bootstrap
URLS or Use Assigned FSC URLs.
On Linux hosts, you must select Use as Bootstrap URLs to ensure the client
map is configured correctly.
Bootstrap Specifies the FMS bootstrap client IP address to be used for the assignment.
Client IP
On Linux hosts, enter the internal IP address of the Active Workspace
Gateway machine.
Use Assigned FSC Specifies whether you want to assign FSC servers. Select this only if you want
URLs explicit control of the FSCs used.
FSC Connection Specifies a comma-separated list of URLs to one or more existing FMS server
URL caches (FSCs).
The URL must be of the form:

http://host:port

By default, the IP address from the HTTP connection of the requestor is used
unless a Bootstrap Client IP value is provided. (The client/requestor is the
host on which Active Workspace Gateway is deployed.)
Assigned FSC Specifies a comma-separated list of one or more assigned FSC URL values.
URLs
The URL values entered are directly used for file operations. This allows you to
declare the FSC servers that should be used.

Service Dispatcher URLs are obtained from the Microservice Node.

You may choose whether to communicate with Teamcenter through the Teamcenter web tier or
through a load balancer. Specify your settings in the Teamcenter Server Connection Settings
section.

5. If your environment is not a production environment and you want to enable the GraphQL
Playground for testing purposes, select the Enable GraphQL playground check box. Do not enable
GraphQL Playground on your production server.

GraphQL Playground is a GraphQL IDE that runs in a web browser. For more information about
GraphQL playground, see https://www.apollographql.com/docs.

6. Under Xcelerator Share Collaboration, type your Xcelerator Share Collaboration settings:

Value Description
Xcelerator Share URL Specifies the URL to the Xcelerator Share site.

12-16 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the Active Workspace client

Value Description
The default value is https://share.sws.siemens.com.
Client ID Specifies the SAMAuth client ID you obtained through SAM URL.
Client Secret ID Specifies the client secret ID you obtained through SAM URL.

7. You may specify the configuration for other components now or later. Proceed to installing the
Active Workspace client for instructions.

Note:
Verify the FMS server cache (FSC) service is running before you start the Active Workspace
Gateway service.

8. (If Active Workspace Gateway is deployed on a Linux host) Start the Docker swarm, microservices
node, and the Gateway service.

The Gateway service should not join the swarm.

Install the Active Workspace client

Before you install the Active Workspace client using TEM, you must complete the following:

• Install Active Workspace microservices

• Install Active Workspace Gateway

If you are using Deployment Center, you can install the Active Workspace client concurrently with Active
Workspace Gateway.

Install the Active Workspace client configuration using the following software kits:

• Teamcenter 14
• Teamcenter 14.2
• Active Workspace 6.2
• Microservices Framework 6.2

Note:
Teamcenter software kits contain both Teamcenter and Teamcenter Rapid Start.

Install the Active Workspace client using TEM

1. Launch TEM from the Teamcenter 14.2 software kit.

Teamcenter Installation on Windows, Teamcenter 14.2 12-17

© 2022 Siemens
 12. Installing Active Workspace

2. Proceed to the Install/Upgrade Options panel and then click Install.

3. In the Media Locations panel, enter paths to the software kits.

• In the Original Media Location box, enter the path to the software kit for the major version of
Teamcenter or Rapid Start.

• In the Update Location box, enter the paths to Active Workspace 6.2 and Microservices
Framework software kits.

The path to the Teamcenter or Rapid Start minor version software kit is already included in the list
of update locations.

4. In the Configuration panel, enter an ID and a Description for the configuration.

5. In the Features panel, under Base Install→Active Workspace→Client, select Active Workspace
Client.

Select any additional client features you want to include in your Active Workspace environment.
(See Active Workspace Client features.)

Note:
• Some features add additional panels to the installation process that are not described in
this procedure. For information about any TEM panel, click the help button .

• To search for a feature by name, type the name or a partial name in the search box, and
then click the search button .

• Some features depend on other features. Prerequisite features are usually listed earlier
than the features that depend on them.

6. In the Active Workspace Client Settings panel, enter the required values:

Value Description

Publish to Gateway Select this check box to enable automatic publishing of

Active Workspace content to the Gateway.

Note:
The Active Workspace Gateway must be installed and
running before content can be published.

Gateway URL Type the URL to Active Workspace Gateway:

12-18 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Sign in using the Active Workspace interface

Value Description

http://host:port

Replace host with the host on which you installed the

Gateway. Replace port with the port you specified when
you installed the Gateway.

For information about other values in the Active Workspace Client Settings panel, click the help
button .

7. In the Confirmation panel, click Start to begin the installation.

8. When the installation is complete, close TEM.

Install the Active Workspace client using Deployment Center

1. Selecting the Active Workspace software automatically includes its basic applications in the
Selected Applications list. The associated components required to deploy Active Workspace are
listed in the Selected Components.

If you haven't already, you can select additional applications you want to include in your Active
Workspace environment.

2. In the Selected Components list, choose Active Workspace Client.

Enter the machine name and operating system. The installation path to Teamcenter may be
specified automatically if it was entered in another component.

3. If you want to automatically publish Active Workspace content to the Gateway, check Publish
Active Workspace Client Assets.

Note:
The Active Workspace Gateway must be installed and running before content can be
published.

4. When the remaining component configuration is complete, click Go to Deploy and generate your
deployment scripts.

Sign in using the Active Workspace interface

From a client machine in your environment, sign in to the Active Workspace client. This verifies the
environment and the Active Workspace Gateway are running.

1. Sign in to a client machine in your environment.

Teamcenter Installation on Windows, Teamcenter 14.2 12-19

© 2022 Siemens
 12. Installing Active Workspace

2. Open a supported web browser.

3. Open the Active Workspace client URL:

http://gateway-host:gateway-port

Where gateway-host and gateway-port are the host and port of the Active Workspace Gateway.

For example:

http://myhost:3000

4. Type your Teamcenter user name and password and click Sign in. Verify that you can sign in
without errors.

You can further verify status of the Active Workspace Gateway and microservices using the Gateway
ping functionality.

12-20 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Prepare to install indexing

Indexing

Prepare to install indexing

Before proceeding with installation, be sure you understand the indexing components you want to
install.

The Indexing Engine and Indexer provide global search capabilities for the Active Workspace client.

The indexing engine installs the Solr enterprise search platform. The search engine stores indexed
Teamcenter data for global search in Active Workspace. The indexing engine requires a supported 64-bit
operating system and 64-bit Java development kit (JDK) or Java runtime environment (JRE).

The indexer installs a four-tier services oriented architecture (SOA) client that exports Teamcenter data
for merging into the Solr database. The indexer (TcFTSIndexer) manages overall indexing processes. The
TcFTSIndexer manages initial indexing for object data. You can then schedule synchronization to run
periodically for subsequent updates to object data or structure data indexes.

There are two modes for installing the indexer: standalone for object data and Dispatcher1 for Active
Content structures.

You also have the option of installing the Asynchronous File Content Indexer application, which
additionally uses the dispatcher to index file contents asynchronously from object metadata.

To install and configure indexing, perform the following steps as described in Indexing and Search
Deployment and Configuration:

1. Determine your file content indexing strategy.

1 See Introduction to Dispatcher in the Teamcenter documentation.

Teamcenter Installation on Windows, Teamcenter 14.2 12-21

© 2022 Siemens
 12. Installing Active Workspace

2. Install the indexing engine and the indexer.

3. Determine if you require a full index or delta reindex.

Configure Classification Search (optional)

If you are new to classification and want to search for classification data in Active Workspace using
classification standard taxonomy, your first step is to create a classification hierarchy.

If you already use traditional classification and want to search for classification data in Active Workspace
or Teamcenter Manufacturing Access, perform the following steps:

1. Create search index views and specify facetable properties.

2. Update and merge the schema file.

3. Index or reindex your data. If your data is already indexed, it is sufficient to index only the modified
classification data.

These steps are described in Classification and Library Management

Install Dispatcher

The Teamcenter Dispatcher is an asynchronous executor and load balancer of scheduled jobs. If you use
Dispatcher, install the Dispatcher server and client as described in Installing and Configuring Dispatcher
in the Teamcenter help library. Then, install the following Dispatcher translators, which Active
Workspace uses:

• Active Content Structure Translator

Install this translator if you use Dispatcher-based indexing for structure data. This feature must be
installed in the same environment as the Dispatcher server.

• ReqMgmtWordToHtmlTrans (optional)

This translator converts requirements content that has been edited and saved in Microsoft Word from
Teamcenter (stored as a full-text dataset), so that it can be viewed in the rich text editor in Active
Workspace.

• AsyncService (optional)

This translator provides asynchronous reporting and printing.

To set up email notifications this translator uses, set the following preferences:

• MAIL_OSMAIL_ACTIVATED = true

12-22 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Visualization Server overview

• MAIL_INTERNAL_MAIL_ACTIVATED = true

• MAIL_SERVER_CHARSET = ISO-8859-1

• MAIL_SERVER_NAME = mail-server-name

• MAIL_SERVER_PORT = 25

• MAIL_SUBSCRIPTION_NOTIFY_SUB_GROUP_TOO = FALSE

• WEB_DEFAULT_SITE_SERVER = host:port

• WEB_DEFAULT_SITE_DEPLOYED_APP_NAME = Teamcenter-web-tier-application

Visualization Server

Visualization Server overview

The Visualization Server provides dynamic 3D and 2D visualization functionality to the Active Workspace
client. If you do not use the 3D viewer or the 2D part of the universal viewer in Active Workspace, do not
install the Visualization Server.

The Visualization Server comprises three components:

Teamcenter Installation on Windows, Teamcenter 14.2 12-23

© 2022 Siemens
 12. Installing Active Workspace

Visualization Server Manager

The Visualization Server Manager (VSM) starts and stops rendering processes as needed and
streams visualization data to the Active Workspace client.

The Visualization Server Manager is required for any use of the 3D viewer or the 2D viewer part of
the universal viewer in Active Workspace.

Siemens Digital Industries Software recommends that you install the Visualization Server Manager
on a machine that does not have a Teamcenter corporate server.
Visualization Server Pool Assigner
The Visualization Server Pool Assigner (VPA) manages Visualization Server Managers and routes
users to an available VSM to open 3D documents.

Each Visualization Pool Assigner hosts two MXBeans that contain information about its current
state: Assigner and Assigner monitoring. The MXBeans are located in the Administer Assigner
manager folder.

Siemens Digital Industries Software recommends that you install the Visualization Server Manager
on a machine that does not have a Teamcenter corporate server.
Visualization Data Server (optional)
The Visualization Data Server (VDS) improves Visualization performance by caching visualization
data close to the Visualization Server Manager.

The Visualization Data Server is required for using MMV feature in Active Workspace. Additionally,
you need to index structure dataindex structure data for the product configurations that you want to
view using MMV.

For appropriately indexed product configurations, the VDS performs the following to promote faster
rendering and streaming to the Active Workspace client:

• Caches product structure

• Prepopulates JT files in the FCC

• Computes Massive Model Visualization (MMV) spatial hierarchies

• Provides bounding box validation

You can use bounding box validation to suppress display of parts that fall outside a defined
assembly box. This can help avoid assemblies opening zoomed out to accommodate errant parts
located far outside the actual assembly. Bounding box validation can also limit a view to include
only a preferred range of the assembly.

12-24 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Should I use client-side or server-side rendering?

Bounding box validation is described in Customizing Active Workspace in the Active Workspace
help library.

A single Visualization Data Server can support one or more Visualization Server Managers.

A Visualization Server Manager is required on the same host as the Visualization Data Server. A
Visualization Data Server is required for implementation of MMV, but is otherwise optional.

Should I use client-side or server-side rendering?

At a glance: Client-side rendering vs. server-side rendering

Client-side rendering uses WebGL to leverage client-side graphics capabilities via the Active Workspace
client browser. Server-side rendering does not require WebGL and is suited to larger structures. The
following comparison may be useful for determining which option to use.

Client-Side Rendering Server-Side Rendering

Data size Works well for small to medium structures up Works well for large to huge
considerations to 5K BOM lines (2-4K triangles/parts average). structures up to 20-30K BOM lines
Users may note an interactivity drop with (2-4K triangles/parts average).
larger datasets. Users may note an interactivity
drop with larger data.
Data Size Limit Limited by browser memory, transfer time Highest limit as server has
tolerance, and WebGL performance as data substantial CPU, RAM, and GPU
size increases. resources available.
Load Speed All data is streamed to the client. Browser Best speed, localized to the render
caching for client-side rendering is supported. server.
User Experience - Best experience, within the limits of WebGL Good experience, especially with
Interaction performance. All drawing and interactions are low latencies. Better to best
local. Rendering is unaffected by network experience as data sizes increase
traffic, so is more responsive and less latency significantly.
sensitive.
Server Cost Per Lower cost. No server-side graphics card is Higher cost, but, can be more cost
User required, no server GPU is needed. Does not effective than putting a high-end
rely on the processing power of the server. graphics device on every user's
desk.
Offloading rendering to clients means the
system can support more users per server.
However, the triangles of the model must be
loaded onto the client machine before it can
render.
Device Support Devices that support WebGL and an HTML5 Devices that support an HTML5
web browser. web browser. Necessary for
devices that do not support
WebGL.

Teamcenter Installation on Windows, Teamcenter 14.2 12-25

© 2022 Siemens
 12. Installing Active Workspace

Rendering 3D data

The 3D viewer is displayed within the universal viewer area in the Overview tab for objects that have
viewable attachments. The 3D viewer is also displayed in the 3D tab to explore 3D data (JT) associated
with parts and assemblies.

The render location setting applies to both viewer locations.

The Visualization Server is required for visualizing 3D data in Active Workspace with client-side rendering
(CSR). However, to use CSR, you must install the Visualization Server Pool Assigner and Visualization
Server Manager on a server without a graphics card.

Setting client-side rendering

To set the default rendering method for the 3D viewer and the universal viewer, specify the correct value
in the Teamcenter preference AWV0ViewerRenderOption:

CSR (client-side rendering)

SSR (server-side rendering) This is the default value.

You can change the rendering method on the Viewer Options panel.

Ensure that you are not using integrated graphics, and perform the following steps to switch to your
graphics card:

1. Open the Nvidia Control Panel.

2. Click 3D Settings→Manage 3D Settings.

3. Click the Program Settings tab. From the list shown, select the program for which you want to
choose a graphics card.

4. Select the preferred graphics processor in the list.

Alternatively, ensure that the GPU is used when running Google Chrome:

1. Open Windows settings (Window key+I).

2. Search for graphics settings or GPU.

Should I use MMV?

Massive Model Visualization (MMV) is a visualization technology that uses Visibility Guided Rendering
(VGR) to increase performance and scalability for the viewing of extremely large 3D models, such as
cars, airplanes, and ships. Models of this size typically consist of a massive amount of geometry

12-26 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Visualization Server Manager prerequisites

arranged in a relatively compact space with a huge amount of internal geometry hidden behind the
“outer shell” of the product. It can take hours to display such models in their entirety, because every
piece of geometry in the model needs to be retrieved and processed, which far exceeds the capability of
today’s commonly available hardware. MMV technology resolves this problem by leveraging VGR
techniques to load only those parts required to render a given scene; parts that are not visible because
they are occluded by other parts in the foreground are not loaded. As a result, large 3D models become
visible in a fraction of the time previously required.

If a structure has more than 120,000 BOM lines, MMV rendering is required for scalability and
performance. If a structure has more than 30,000 BOM lines, MMV is recommended.

Visualization of MMV data in the Active Workspace client requires an MMV license. If the necessary
license is not present, the full model loads as standard JT data.

A Visualization Data Server is required for implementation of MMV, but is otherwise optional.

To use the Visualization Data Server to compute Massive Model Visualization (MMV) spatial hierarchies
of structures, you must

1. Apply the MMV index structure flag to the product configurations that you want to view using
MMV.

2. Use the bomindex_admin utility to include the configurations in the list of structures to index.

To take advantage of the structure and JT pre-caching feature of the Visualization Data Server for
improved visualization performance of structures that are not indexed for MMV:

1. Apply the VDS indexing flag for product configurations that will be viewed frequently but are not
indexed for MMV.

2. Use the bomindex_admin utility to include the configurations in the list of structures to index.

Visualization Server Manager

Visualization Server Manager prerequisites

Operating systems

The Visualization Server Manager (VSM) supports both large model visualization (LMV) and massive
model visualization (MMV) on supported Microsoft Windows and Linux server platforms.

On a Linux machine without a GPU or without a supported level of OpenGL, client-side rendering is
supported, but server-side rendering is not supported and fails to load.

For supported OS versions, see the Hardware and Software Certifications knowledge base article on
Support Center.

Teamcenter Installation on Windows, Teamcenter 14.2 12-27

© 2022 Siemens
 12. Installing Active Workspace

Server hardware and graphics cards

The following hardware is supported for VSM:

• For server-side rendering:

Server class hardware certified by NVIDIA to support NVIDIA RTX 6000, RTX 8000, T4, A10, A40, GRID
K1, K2, Tesla M60, or P40 graphics cards. Note that any server capable of supporting server-side
rendering also supports client-side rendering.

• For client-side rendering:

GPU hardware requirements for desktop Visualization applications (Lifecycle Visualization) are
sufficient for client-side rendering.

If no server-side rendering is needed, any web server class hardware is sufficient to support client-side
rendering (CSR).

The Visualization Server is required for visualizing 3D data in Active Workspace with client-side
rendering. However, to use client-side rendering, you must install the Visualization Server Pool
Assigner and VSM on a server without a graphics card.

Sizing of hardware should be appropriate to support intended data sizes and usage patterns. See VSM
hardware sizing for more info about hardware sizing.

Windows Server versions supported with the VSM support a maximum of 8 GPUs, with certain
exceptions. For example, on a Windows Server 2012 R2 machine with two NVIDIA GRID K1 cards, the
legacy VGA device makes the fourth GPU on one card unavailable for use.

Active Workspace 6.2 supports virtualized server-side rendering for certain hardware and software
combinations.

NVIDIA usage requires NVIDIA virtual application licenses — one per concurrent user.

For information about server hardware compatible with supported NVIDIA GRID graphics cards, see
www.nvidia.com.

Virtualization

If you use only client-side rendering, the VSM can be virtualized.

If you use server-side rendering, the VSM must be installed on physical hardware, unless you follow a
supported virtualization combination.

Active Workspace visualization supports virtualization for certain combinations of:

12-28 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Visualization Server Manager prerequisites

• Host OS and version

• Virtualization layer

• Guest OS and version

• NVIDIA GPU

For information about supported combinations, see the Graphics Card Certification Matrix in the
Hardware and Software Certifications knowledge base article on Support Center: https://
support.sw.siemens.com

For information about NVIDIA virtual GPU compatibility, see NVIDIA virtual GPU (vGPU) software
documentation at docs.nvidia.com.

VSM hardware sizing

Sizing of VSM hardware should allow for typical and maximum expected usage by considering the
following factors:

• Expected numbers of concurrent Active Workspace visualization users

• Expected product data sizes

• CPU, RAM, VRAM and GPU resources consumed by expected product data

In general, a high end server with:

• A maximum number of CPU cores with processing speeds of 3.0 GHz or faster

• A minimum of 64 GB of RAM

• A minimum of 256 GB of disc space

In addition, a VSM that will support server-side rendering requires an NVIDIA GRID graphics card. For
information about server hardware compatible with supported NVIDIA GRID graphics cards, see
www.nvidia.com.

For additional guidance in sizing of VSM hardware, contact your field services professionals.

Environment information

Make sure you know the following values. These are needed during installation of the VSM.

Visualization These are defined in Install the Visualization Server Pool Assigner.
Server Pool

Teamcenter Installation on Windows, Teamcenter 14.2 12-29

© 2022 Siemens
 12. Installing Active Workspace

Assigner
host and
port
Visualization These are defined in Install the Visualization Data Server.
Data Server
host and
port (if VDS
is to be
installed)
Host and These are defined during Teamcenter installation.
port of FCC
parents

Linux machine configuration

Before you install the VSM on a Linux machine, perform the following steps:

1. Make sure the machine has the required RPM package managers.

2. Configure Xserver on the machine.

• Linux machine with no GPU:

Configure Xserver for offscreen and headless operation for use by the visualization server
processes. After reboot, run the following commands:

- setenv DISPLAY :0
- sudo xhost +

• Linux machine with GPU:

a. Configure Xserver for offscreen and headless operation for use by the VisServer processes.

b. Make sure the XServer is running. One way to verify this is to see if the X or Xorg process is
running by typing the following command:

ps -ef | grep X

c. Set up the NVIDIA GPU on the Linux machine by typing the following command:

setup_xserver.sh default

The default parameter specifies to use the graphics card and bus id discovered by the
script. If you do not specify this parameter, the script prompts you to confirm the card and
bus id, and provides the opportunity to change these values if you want.

12-30 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the Visualization Server Manager

For example:

sudo ./setup_xserver.sh

Or:

sudo ./setup_xserver.sh default

Install the Visualization Server Manager

Install the Visualization Server Manager using Deployment Center

1. Log on to Deployment Center.

2. In the Environments list, select the environment to which you want to add the Visualization Server
Manager (VSM), or click Add Environment to create a new environment.

3. In the Software task, make sure the following software kits are included in your environment:

• Teamcenter 14.2
• Teamcenter 14
• Active Workspace 6.2
• Microservice Framework 6.2

4. Proceed to the Applications task and then click Add or Remove Selected Applications .

5. In the Available Applications list, select Visualization Extension and then click Update Selected
Applications.

This adds the Visualization Server Manager and Visualization Pool Assigner components to the
environment.

6. Proceed to the Components task.

7. In the Selected Components list, select Visualization Server Manager

8. Enter configuration parameters for the VSM:

a. If your environment type (specified in the Options task) is Distributed, type values for the
Machine Name and OS for the machine on which you deploy the VSM.

Also, in the Teamcenter Installation Path box, type the path in which to install Teamcenter
software on the VSM machine.

If your environment type is Single Box, the Machine Name, OS, and Teamcenter
Installation Path boxes are read-only and cannot be changed.

Teamcenter Installation on Windows, Teamcenter 14.2 12-31

© 2022 Siemens
 12. Installing Active Workspace

b. If you want to change the default configuration parameters for the VSM, click Show all
parameters and change values as necessary.

c. Click Save Component Settings.

9. In the Components task, note components whose configuration status is not 100%. Enter or
update configuration parameters until all components show a configuration status of 100%.

10. Proceed to the Deploy task. Click Generate Install Scripts to generate deployment scripts to
update affected machines.

When script generation is complete, note any special instructions in the Deploy Instructions panel.

11. Locate deployment scripts, copy each script to its target machine, and run each script on its target
machine.

For more information about running deployment scripts, see the Deployment Center Guide.

Install the Visualization Server Manager using TEM

You can install the Visualization Server Manager in a new or an existing Teamcenter configuration.

If you are adding the Visualization Server Manager to an existing configuration, proceed as follows:

1. Apply the Active Workspace patch to the host. This adds Active Workspace applications to the
Features panel in TEM.

2. Launch the installed TEM in maintenance mode and skip to step 8 below.

Otherwise, if you are installing the Visualization Server Manager on a host with no existing Teamcenter
environment, proceed with the following steps:

1. Ensure you have access to the following required software kits:

• Latest Teamcenter minor release, for example, Teamcenter 14.2

• Corresponding Teamcenter major release, for example, Teamcenter 14

• Active Workspace 6.2

Make sure you use the appropriate Active Workspace 6.2 software kit that corresponds to your
version of Teamcenter.

2. Launch TEM from the Teamcenter minor release software kit.

12-32 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the Visualization Server Manager

On Windows systems, launch TEM with administrator privileges (right-click→Run as

administrator).

3. In the Welcome to Teamcenter panel, select Teamcenter.

4. In the Install / Upgrade Options panel, click Install.

5. In the Media Locations panel, specify locations of Teamcenter software kits:

a. In the Original Media box, enter the location of the Teamcenter major release software kit.

b. In the Update Location box, add the location of the Active Workspace 6.2 software kit.

Note that the location of the Teamcenter minor release software kit is already included in the
list. Make sure the Teamcenter location is listed before the Active Workspace location.

6. In the Configuration panel, enter values for ID and Description.

7. In the Solutions panel, make no selections.

8. Proceed to the Features panel. Select the Visualization Server Manager feature, under Base
Install→Active Workspace→Visualization Server.

In the Installation Directory box, enter the location in which to install the Visualization Server
Manager.

9. In the File Client Cache (FCC) panel, set the FMS_HOME environment variable.

10. In the FCC Parents panel, define the list of FSC parents to which the Visualization Server Manager
connects. You must provide protocol, host, and port of the FSC parent. To add rows to the table,
click Add.

If you are using a Visualization Data Server, the Visualization Data Server and the Visualization
Server Manager should use the same FSC.

11. In the Configuration section of the Visualization Server Manager panel, provide values for the
Visualization Server Manager.

Local Host Specifies the alias for the local Visualization Server Manager.
Alias
Server Host Specifies the host where the Visualization Server Manager is running. This must
be the local machine name and must be resolvable by the Visualization Pool
Assigner machine (the machine running the Active Workspace Gateway). Do not
use localhost or 127.0.0.1.
Server Port Specifies the port on which the Visualization Server is listening.

Teamcenter Installation on Windows, Teamcenter 14.2 12-33

© 2022 Siemens
 12. Installing Active Workspace

Max Servers Specifies the maximum number of Visualization server processes allowed to run
in Sub-Pool in this pool (for a single-host configuration) or in this subpool (for a multihost
configuration).

For example, on Windows machines, the default value is 30. On Linux machines,
the default value is 200.
Min Warm Specifies the minimum number of Visualization server processes in this pool that
Servers are started but not assigned.

Note:
If necessary to maintain the minimum number of warm servers, while not
exceeding the maximum number of server processes, the server manager
times out servers in use.

12. If you use a Visualization Data Server, provide the values for this server in the Visualization Data
Server Configuration section of the Visualization Server Manager panel.

Add Select this if you are using a Visualization Data Server.

Visualization
Data Server
Host Type the name of the host on which the Visualization Data Server is installed.
Port Type the port value used by the Visualization Data Server.

A Visualization Data Server improves performance by caching product structure and JT parts files.

13. In the Visualization Server Manager Settings panel, define the settings for how the Visualization
Server Manager communicates with the pool assigners.

• Override local node settings

Select to override the host name and port value. Enter the Host and Vis Assigner Port values of
the local machine. In the Gateway Connection Port box, enter the port used by the Active
Workspace Gateway.

• Visualization Server Pool Assigners

Lists the pool assigners that this Visualization Server Manager uses.

• Assigner Host

Host name of the machine where the Visualization Server Pool Assigner runs.

12-34 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Start the Visualization Server Manager

• Assigner Port

Port value of the pool assigner.

14. In the Operating System User panel, type the user’s password.

15. In the Confirmation panel, click Start.

16. When the installation is complete, close TEM.

Start the Visualization Server Manager

Start the Visualization Server Manager on Linux

To start the Visualization Server Manager (VSM) on a Linux machine, type the following command:

TC_ROOT/vispoolmanager/run_servermgr.sh

Optional: Start the VSM as a Linux daemon

Alternatively, you can start the Visualization Server Manager as a daemon by running the
installservice.sh command for each jetty server (run with admin permissions):

installservice.sh unique-service-name port user

If you do not specify parameters, the script will run in interactive mode and prompt you for the
information.

For example, from the TC_ROOT/vispoolmanager/jetty directory, type:

sudo ./installservice.sh MyUniquePoolManager1 8090 MyUser

Uninstalling the Linux daemon:

To uninstall the VSM daemon, run the uninstallservice.sh command for each jetty server (run with
admin permissions):

uninstallservice.sh service-name

For example, from the TC_ROOT/vispoolmanager/jetty directory, type:

sudo ./uninstallservice.sh MyUniquePoolManager1

If you do not know the name of the service, look in the TC_ROOT/vispoolmanager/jetty/ or /etc/
systemd/system directory and find the file named service-name.service. The service-name is the
unique service name you provided to the installservice.sh command.

Teamcenter Installation on Windows, Teamcenter 14.2 12-35

© 2022 Siemens
 12. Installing Active Workspace

Start the Visualization Server Manager on Windows

1. Make sure the FMS_HOME environment variable is set as a system environment variable, not a
user variable. The Visualization Server Manager (VSM) runs as a service only if FMS_HOME is a
system environment variable.

2. Run the following file:

TC_ROOT\vispoolmanager\run_visservermgr.cmd

Note:
If the Visualization Server Pool Assigner is not running, the Visualization Server Manager
displays console messages until it finds the VPA. To avoid this, start the Visualization Server
Pool Assigner before you start the Visualization Server Manager.

When running run_visservermgr.cmd, you can use Windows Remote Desktop Connection to sign in to
the machine on which the Visualization Server Manager is installed if you have an NVIDIA card with a
driver version of 340.66 or later. Other remote access products, such as VNC, also can be used.

After running run_visservermgr.cmd, you can lock the machine, but you must remain logged on. If you
sign out, the Visualization Server Manager is shut down.

The Visualization Server Manager requires access to the graphics card and consequently cannot run as a
Windows service in server-side rendering mode. However, you can start the Visualization Server
Manager as a Windows service when you use client-side rendering exclusively.

Optional: Configure automatic logon and restart on Windows

You can configure Windows to automatically log on and restart the Visualization Server Manager In the
event of a system reboot.

Caution:
Enabling automatic logon bypasses security. When Windows is configured to automatically log on,
anyone with physical access to the machine can restart it and gain entry to the system. Use
automatic logon only if the system is in a secure environment.

1. Open the Windows User Accounts dialog box:

a. Press the Windows key+R to display the Run dialog box.

b. In Open, type netplwiz, and then click OK.

2. In the User Accounts dialog box, select a user account from the list.

12-36 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Start the Visualization Server Manager

3. Clear the Users must enter a user name and password to use this computer check box.

4. Click Apply.

The Automatically sign in dialog box is displayed.

5. In the Password and Confirm Password boxes, type the user's password.

6. Click OK.

The specified user is automatically logged on when Windows starts.

7. Create a script or batch file to launch the Visualization Server Manager. Include the following
command to lock the workstation:

rundll32.exe user32.dll LockWorkStation

8. Create a new task with Windows Task Scheduler to run the script or batch file at log on.

Optional: Start the VSM as a Windows service

You can start the Visualization Server Manager as a Windows service only when you are exclusively
using client-side rendering. Windows services cannot access the graphics card, so this is not a suitable
deployment for server-side rendering.

1. To install the Visualization Server Manager as a Windows service, run the installservice.bat
command:

installservice.bat "%JAVA_HOME%" "VSM-dir" pool-ID port

Replace VSM-dir with the path to the Visualization Server Manager’s jetty directory. Replace pool-
ID and port with the ID and port for the VisPoolManager service. The port must match the
VisPoolProxy.poolUrl port in the jettyservice.properties file.

For example:

installservice.bat "%JAVA_HOME%" "%TC_ROOT%\vispoolmanager\jetty" vispool-A 8090

2. Locate the newly installed service named Teamcenter VisServlet pool-ID in the list of Windows
services.

3. Right-click the service name and choose Properties.

4. On the Log On tab, enter logon credentials for the domain user account under which the service
runs.

Teamcenter Installation on Windows, Teamcenter 14.2 12-37

© 2022 Siemens
 12. Installing Active Workspace

Visualization Server Manager requires an FMS client cache (FCC) to cache files. It is recommended
that you use a dedicated account to run this service, not the Local System account.

Windows attempts to run the service automatically by default. If the service is not already running,
a problem may have occurred.

If you set the service to start manually in its Properties, then you can click the Run button from the
toolbar to start the service, or right-click the service in the Services window, and choose Start.

To stop the service, either click Stop Service on the toolbar, or right-click the service and choose
Stop.

To uninstall the service, type uninstallservice.bat "Teamcenter VisServlet pool-ID".

Test Visualization from the Active Workspace client interface

Before you begin the following procedure, make sure the Visualization Server Manager installation and
the Active Workspace client installation tasks are complete.

You can test the Visualization Server by logging on with the Active Workspace interface and viewing
Visualization data, for example, a JT file.

1. Ensure that the following are running:

• Visualization Server Manager

• Visualization Pool Assigner

• Active Workspace Gateway

• Web application server hosting the Teamcenter web tier application

• Teamcenter server manager

• Teamcenter database

2. Open a supported web browser.

3. Open Active Workspace at the following URL:

http://host:port

host is the machine running the Active Workspace Gateway.

port is the port used by the Active Workspace Gateway.

12-38 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Visualization Server Pool Assigner prerequisites

4. Sign in with a valid user name and password.

5. Search for and open an object that has an attached JT file.

6. Click the 3D tab to display the JT file.

Visualization Server Pool Assigner

Visualization Server Pool Assigner prerequisites

Software

The Visualization Server Pool Assigner requires the following software:

• A supported Microsoft Windows Server operating system or Linux operating system on the
Visualization Server Manager host.

For supported versions, see the Hardware and Software Certifications knowledge base article on
Support Center.

• The Visualization Extension Server Extensions feature on the corporate server and on any server
that has Teamcenter Foundation installed.

Environment information

Make sure you know the following values. These are needed during installation of the Visualization
Server Manager.

Visualization Server Pool Assigner host and port

Teamcenter Installation on Windows, Teamcenter 14.2 12-39

© 2022 Siemens
 12. Installing Active Workspace

Visualization These are defined in Install the Visualization Data Server.

Data Server
host and
port (if VDS
is to be
installed)
Host and These are defined during Teamcenter installation.
port of FCC
parents

Install the Visualization Server Pool Assigner

Install the Visualization Server Pool Assigner using Deployment Center

1. Log on to Deployment Center.

2. In the Environments list, select the environment to which you want to add the Visualization Server
Pool Assigner (VPA), or click Add Environment to create a new environment.

3. In the Software task, make sure the following software kits are included in your environment:

• Teamcenter 14.2
• Teamcenter 14
• Active Workspace 6.2
• Microservice Framework 6.2

4. Proceed to the Applications task and then click Add or Remove Selected Applications .

5. In the Available Applications list, select Visualization Extension and then click Update Selected
Applications.

This adds the Visualization Server Manager and Visualization Pool Assigner components to the
environment.

6. Proceed to the Components task.

7. In the Selected Components list, select Visualization Pool Assigner

8. Enter configuration parameters for the VPA:

a. If your environment type (specified in the Options task) is Distributed, type values for the
Machine Name and OS for the machine on which you deploy the VPA.

Also, in the Teamcenter Installation Path box, type the path in which to install Teamcenter
software on the VPA machine.

12-40 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the Visualization Server Pool Assigner

If your environment type is Single Box, the Machine Name, OS, and Teamcenter
Installation Path boxes are read-only and cannot be changed.

b. Enter the following configuration parameters for the VPA:

Value Description
Vis Assigner Port Specifies the port used by the local Visualization Server Pool
Assigner.
Gateway Connection Port Specifies the port through which the Active Workspace Gateway
connects to the Visualization Server Pool Assigner. The default
value is 8089.
Gateway Vis Assigner URL Specifies the URL through which the Active Workspace Gateway
accesses the VPA. This value is automatically based on the
Machine Name and Gateway Connection Port values. It is
read-only and cannot be directly changed.

c. If you want to change the default configuration parameters for the VSM, click Show all
parameters and change values as necessary.

d. Click Save Component Settings.

9. In the Components task, note components whose configuration status is not 100%. Enter or
update configuration parameters until all components show a configuration status of 100%.

10. Proceed to the Deploy task. Click Generate Install Scripts to generate deployment scripts to
update affected machines.

When script generation is complete, note any special instructions in the Deploy Instructions panel.

11. Locate deployment scripts, copy each script to its target machine, and run each script on its target
machine.

For more information about running deployment scripts, see the Deployment Center Guide.

Install the Visualization Server Pool Assigner using TEM

You can install the Visualization Server Pool Assigner in a new or an existing Teamcenter configuration.

If you are adding the Visualization Server Pool Assigner to an existing configuration, proceed as follows:

1. Apply the Active Workspace patch to the host.

2. Launch the installed TEM in maintenance mode and skip to step 7 below.

Teamcenter Installation on Windows, Teamcenter 14.2 12-41

© 2022 Siemens
 12. Installing Active Workspace

Otherwise, if you are installing the Visualization Server Pool Assigner on a host with no existing
Teamcenter environment, proceed to step 1 below.

1. Ensure you have access to the following required software kits:

• Latest Teamcenter minor release, for example, Teamcenter 14.2

• Corresponding Teamcenter major release, for example, Teamcenter 14

• Active Workspace 6.2

Make sure you use the appropriate Active Workspace 6.2 software kit that corresponds to your
version of Teamcenter.

1. Launch TEM from the Teamcenter minor release software kit.

On Windows systems, launch TEM with administrator privileges (right-click→Run as

administrator).

2. In the Welcome to Teamcenter panel, select Teamcenter.

3. In the Install / Upgrade Options panel, click Install.

4. In the Media Locations panel, specify locations of Teamcenter software kits:

a. In the Original Media box, enter the location of the Teamcenter major release software kit.

b. In the Update Location box, add the location of the Active Workspace 6.2 software kit.

Note that the location of the Teamcenter minor release software kit is already included in the
list. Make sure the Teamcenter location is listed before the Active Workspace location.

5. In the Configuration panel, enter values for ID and Description.

6. In the Solutions panel, make no selections.

7. Proceed to the Features panel. Select the Visualization Server Pool Assigner feature, under Base
Install→Active Workspace→Visualization Server.

In the Installation Directory box, enter the location in which to install the Visualization Server
Manager.

8. In the Visualization Server Pool Assigner Settings panel, enter settings to configure the
Visualization Server Pool Assigner:

12-42 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Start the Visualization Server Pool Assigner

Value Description
Host Specifies the host on which this Visualization Server Pool Assigner runs.
This is the host on which this Visualization Server Pool Assigner is
deployed. You may type the host name or IP address of the host.
Vis Assigner Port Specifies the port used by the local Visualization Server Pool Assigner.
Gateway Connection Specifies the port through which the Active Workspace Gateway
Port connects to the Visualization Server Pool Assigner. The default value is
3000.
Add pool assigner Specifies whether additional Visualization Server Pool Assigners are
used. Select the Add pool assigner check box to add pool assigners.
Peer Assigners The Peer Assigners table lists other Visualization Server Pool Assigners
known to the local Visualization Server Pool Assigners.
Assigner Host Specifies the host on which a peer Visualization Server Pool Assigner is
deployed. This value can be the host name or IP address.
Assigner Port Specifies the port number used by the peer Visualization Server Pool
Assigner.
Server Side 4-tier URL Specifies an alternate four-tier URL for the viewer to connect to
Teamcenter. The Visualization Server uses this in case the primary four-
tier URL is blocked by a firewall, or if a more direct route is needed for
performance.

9. In the Confirmation panel, click Start.

10. When the installation is complete, close TEM.

Start the Visualization Server Pool Assigner

Linux Systems

To start the Visualization Server Pool Assigner (VPA) on a Linux machine, type the following command:

TC_ROOT/visassigner/run_assigner.sh

Alternatively, you can start the Visualization Server Pool Assigner as a daemon by running the
installservice.sh command for each jetty server (run with admin permissions):

installservice.sh unique-service-name port user

If you do not specify parameters, the script will run in interactive mode and prompt you for the
information.

For example, from the TC_ROOT/visassigner/jetty directory, type:

sudo ./installservice.sh MyUniqueAssigner1 7780 MyUser

Teamcenter Installation on Windows, Teamcenter 14.2 12-43

© 2022 Siemens
 12. Installing Active Workspace

Windows Systems

To start the Visualization Server Pool Assigner (VPA) on a Windows machine, run the following file:

TC_ROOT\visassigner\run_visassigner.cmd

After running run_visassigner.cmd, you can lock the machine, but you must remain logged on. If you
sign out, the VPA is shut down.

Alternatively, you can start the Visualization Server Pool Assigner as a Windows service only when you
are exclusively using client-side rendering. Windows services cannot access the graphics card, so this is
not a suitable deployment for server-side rendering.

1. To install the Visualization Server Pool Assigner as a Windows service, run the installservice.bat
command:

installservice.bat "%JAVA_HOME%" "VPA-dir" assigner-ID port

Replace VPA-dir with the path to the Visualization Server Pool Assigner’s jetty directory. Replace
assigner-ID and port with the ID and port used by the Active Workspace Gateway to connect to the
Assigner.

For example:

installservice.bat "%JAVA_HOME%" "%TC_ROOT%\visassigner\jetty" VisAssigner-A 8089

2. Locate the newly installed service named Teamcenter VisServlet assigner-ID in the list of
Windows services.

3. Right-click the service name and choose Properties.

4. On the Log On tab, enter logon credentials for the domain user account under which the service
runs.

Windows attempts to run the service automatically by default. If the service is not already running,
a problem may have occurred.

If you set the service to start manually in its Properties, then you can click the Run button from the
toolbar to start the service, or right-click the service in the Services window, and choose Start.

To stop the service, either click Stop Service on the toolbar, or right-click the service and choose
Stop.

To uninstall the service, type uninstallservice.bat "Teamcenter VisServlet assigner-ID".

12-44 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Visualization Data Server prerequisites

Visualization Data Server (optional)

Visualization Data Server prerequisites

Software

The Visualization Data Server requires the following software:

• A supported Microsoft Windows Server operating system or Linux operating system on the
Visualization Server Manager host.

For supported versions, see the Hardware and Software Certifications knowledge base article on
Support Center.

• The Visualization Extension Server Extensions feature on the corporate server and on any server
that has Teamcenter Foundation installed.

• A Visualization Server Manager installed on the Visualization Data Server host.

• An FMS client cache (FCC) component on the Visualization Data server host.

• Structure indexing configured on the Visualization Data server host.

The Visualization Data Server uses the structure indexing infrastructure of Active Workspace to keep
cached product structure up-to-date.

Hardware

• Graphics card: No requirements.

• Network: You must deploy the Visualization Data Server on a high speed LAN near the Visualization
Server Manager.

• Memory: The Visualization Data Server host should have a minimum of 16 GB of RAM, but may
require more.

Note:
How to determine memory needed:
The amount of RAM needed depends on the number of structures to be indexed and their size.
A rough rule of thumb is to count the number of lines in the unconfigured structure to be indexed
and allow at least 2000 bytes per line. For example, if there are 1 million lines in the unconfigured
product index, then 1 million * 2000 = 2 GB of RAM.

Teamcenter Installation on Windows, Teamcenter 14.2 12-45

© 2022 Siemens
 12. Installing Active Workspace

If you are not sure of the size of the structures, Siemens Digital Industries Software recommends
that you allow approximately 4 GB of RAM for each structure you are planning to cache in the
Visualization Data Server. For example, if 4 structures are to be indexed, 16 GB of RAM is
recommended.

Environment information

You need to know the following values to install the Visualization Data Server:

• FCC parents

• Teamcenter web tier URL

• Host name and port for the Visualization Data Server

Recommendations

Siemens Digital Industries Software recommends that you install the Visualization Data Server on a
machine with the following:

• Multiple processors

The Visualization Data Server is a multithreaded server program and is thus resource intensive;
multiple processors are utilized if they are available. Standard server class machine hardware is
sufficient.

• FSC cache or FSC volume

If you deploy the Visualization Data Server remote (on a WAN) from the FSC volume, you should
deploy an FSC cache on a LAN near or on the Visualization Data Server host machine.

• Visualization Server Manager

For maximum performance, the Visualization Data server should be installed on the same machine as
the Visualization Server Manager and should use the same cache.

A single Visualization Data Server can support one or more Visualization Server Managers.

Install the Visualization Data Server

Install the Visualization Data Server using Deployment Center

1. Log on to Deployment Center.

12-46 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the Visualization Data Server

2. In the Environments list, select the environment to which you want to add the Visualization Data
Server (VDS), or click Add Environment to create a new environment.

3. In the Software task, make sure the following software kits are included in your environment:

• Teamcenter 14.2
• Teamcenter 14
• Active Workspace 6.2
• Microservice Framework 6.2

4. Proceed to the Applications task and then click Add or Remove Selected Applications .

5. In the Available Applications list, select Visualization Extension and then click Update Selected
Applications.

6. Proceed to the Components task.

7. In the Selected Components list, select Visualization Data Server.

8. Enter configuration parameters for the VDS:

a. If your environment type (specified in the Options task) is Distributed, type values for the
Machine Name and OS for the machine on which you deploy the VDS.

Also, in the Teamcenter Installation Path box, type the path in which to install Teamcenter
software on the VDS machine.

If your environment type is Single Box, the Machine Name, OS, and Teamcenter
Installation Path boxes are read-only and cannot be changed.

b. If you want to change the default configuration parameters for the VDS, click Show all
parameters and change values as necessary.

c. Click Save Component Settings.

9. In the Components task, note components whose configuration status is not 100%. Enter or
update configuration parameters until all components show a configuration status of 100%.

10. Proceed to the Deploy task. Click Generate Install Scripts to generate deployment scripts to
update affected machines.

When script generation is complete, note any special instructions in the Deploy Instructions panel.

11. Locate deployment scripts, copy each script to its target machine, and run each script on its target
machine.

Teamcenter Installation on Windows, Teamcenter 14.2 12-47

© 2022 Siemens
 12. Installing Active Workspace

For more information about running deployment scripts, see the Deployment Center Guide.

Install the Visualization Server Pool Assigner using TEM

You can install the Visualization Server Pool Assigner in a new or an existing Teamcenter configuration.

If you are adding the Visualization Server Pool Assigner to an existing configuration, proceed as follows:

1. Apply the Active Workspace patch to the host.

2. Launch the installed TEM in maintenance mode and skip to step 7 below.

Otherwise, if you are installing the Visualization Server Pool Assigner on a host with no existing
Teamcenter environment, proceed to step 1 below.

1. Ensure you have access to the following required software kits:

• Latest Teamcenter minor release, for example, Teamcenter 14.2

• Corresponding Teamcenter major release, for example, Teamcenter 14

• Active Workspace 6.2

Make sure you use the appropriate Active Workspace 6.2 software kit that corresponds to your
version of Teamcenter.

1. Launch TEM from the Teamcenter minor release software kit.

On Windows systems, launch TEM with administrator privileges (right-click→Run as

administrator).

2. In the Welcome to Teamcenter panel, select Teamcenter.

3. In the Install / Upgrade Options panel, click Install.

4. In the Media Locations panel, specify locations of Teamcenter software kits:

a. In the Original Media box, enter the location of the Teamcenter major release software kit.

b. In the Update Location box, add the location of the Active Workspace 6.2 software kit.

Note that the location of the Teamcenter minor release software kit is already included in the
list. Make sure the Teamcenter location is listed before the Active Workspace location.

5. In the Configuration panel, enter values for ID and Description.

12-48 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the Visualization Data Server

6. In the Solutions panel, make no selections.

7. Proceed to the Features panel. Select the Visualization Server Pool Assigner feature, under Base
Install→Active Workspace→Visualization Server.

In the Installation Directory box, enter the location in which to install the Visualization Server
Manager.

8. In the Visualization Server Pool Assigner Settings panel, enter settings to configure the
Visualization Server Pool Assigner:

Value Description
Host Specifies the host on which this Visualization Server Pool Assigner runs.
This is the host on which this Visualization Server Pool Assigner is
deployed. You may type the host name or IP address of the host.
Vis Assigner Port Specifies the port used by the local Visualization Server Pool Assigner.
Gateway Connection Specifies the port through which the Active Workspace Gateway
Port connects to the Visualization Server Pool Assigner. The default value is
3000.
Add pool assigner Specifies whether additional Visualization Server Pool Assigners are
used. Select the Add pool assigner check box to add pool assigners.
Peer Assigners The Peer Assigners table lists other Visualization Server Pool Assigners
known to the local Visualization Server Pool Assigners.
Assigner Host Specifies the host on which a peer Visualization Server Pool Assigner is
deployed. This value can be the host name or IP address.
Assigner Port Specifies the port number used by the peer Visualization Server Pool
Assigner.
Server Side 4-tier URL Specifies an alternate four-tier URL for the viewer to connect to
Teamcenter. The Visualization Server uses this in case the primary four-
tier URL is blocked by a firewall, or if a more direct route is needed for
performance.

9. In the Confirmation panel, click Start.

10. When the installation is complete, close TEM.

Install the Visualization Data Server using TEM

You can install the Visualization Data Server (VDS) in a new or an existing Teamcenter configuration.
Siemens Digital Industries Software recommends that you install the Visualization Data Server on a
machine that does not have a Teamcenter corporate server.

If you are adding the Visualization Data Server to an existing configuration, proceed as follows:

Teamcenter Installation on Windows, Teamcenter 14.2 12-49

© 2022 Siemens
 12. Installing Active Workspace

1. Apply the Active Workspace patch to the host.

2. Launch the installed TEM in maintenance mode and skip to step 8 below.

Otherwise, if you are installing the Visualization Server Manager on a host with no existing Teamcenter
environment, proceed to step 1 below.

1. Ensure you have access to the following required software kits:

• Latest Teamcenter minor release, for example, Teamcenter 14.2

• Corresponding Teamcenter major release, for example, Teamcenter 14.

• Active Workspace 6.2

Note:
• Make sure you use the appropriate Active Workspace 6.2 software kit that corresponds to
your version of Teamcenter.

• Teamcenter software kits contain both Teamcenter and Teamcenter Rapid Start.

2. Launch TEM from the Teamcenter minor release software kit.

3. In the Welcome to Teamcenter panel, select Teamcenter or Teamcenter Rapid Start as

appropriate.

4. In the Install / Upgrade Options panel, click Install.

5. In the Media Locations panel, specify locations of Teamcenter software kits:

a. In the Original Media box, enter the location of the Teamcenter major release software kit.

b. In the Update Location box, add the location of the Active Workspace 6.2 software kit.

Note that the location of the Teamcenter minor release software kit is already included in the
list. Make sure the Teamcenter location is listed before the Active Workspace location.

6. In the Configuration panel, enter values for ID and Description.

7. In the Solutions panel, make no selections.

8. In the Features panel, select the Visualization Data Server feature:

Base Install→Active Workspace→Visualization Server→Visualization Data Server

12-50 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 MMV indexing data

In the Installation Directory box, enter the location in which to install the Visualization Data
Server.

9. In the File Client Cache (FCC) panel, set the FMS_HOME environment variable. The FCC must be
installed on the same machine as the Validation Data Server.

10. In the FCC Parents panel, define the list of FSC parents to which the Visualization Data Server
connects. You must provide protocol, host, and port of the FSC parent. To add rows to the table,
click Add.

To improve performance, the Visualization Data Server and the Visualization Server Manager
should use the same FSC.

11. In the Teamcenter Administrative User panel, enter the user's password.

12. In the Visualization Data Server Configuration panel, enter required values:

• Server Port

This is the port number on which the Visualization Data Server listens.

• Teamcenter 4-tier URL

This is the URL of the Teamcenter web tier application. The format is:

http://host:port/tc-web-app

host is the machine running the web application server on which the Teamcenter web
application is deployed.

port is the port value used by the web application server.

tc-web-app is the name of the Teamcenter web application. The default is tc.

13. In the Confirmation panel, click Start.

14. When the installation is complete, click Close.

MMV indexing data

If you use Massive Model Visualization (MMV), configure MMV indexing.

When structures using MMV rendering are indexed, the last valid indexed data is always retained. So,
you can always see MMV indexed data; however, the data in a structure may be more recent.

Teamcenter Installation on Windows, Teamcenter 14.2 12-51

© 2022 Siemens
 12. Installing Active Workspace

When MMV data is being indexed it may use a backup system. It is recommended that the administrator
retains interim files so when an error occurs, they can be analyzed to determine the issue. These two
Teamcenter preferences can be used to control the output of the generated files:

• MMV_keep_generated_files

Use this preference to preserve the generated files for further examination. You can specify when
generated files are kept by using these values:

1: Keep the generated files when an error occurs.

2: Always keep the generated files.

3: Never keep the generated files.

• MMV_staging_directory

Use this preference to control the working directory to be used for the tcxml2mmp conversion
process on the Teamcenter server. If this is not set, the default temporary directory is used as staging
directory.

Start the Visualization Data Server

To start the Visualization Data Server Manager, enter the following command:

• Windows systems:

TC_ROOT\VisDataServer\Program\VisDataServer.exe

• Linux systems:

TC_ROOT/VisDataServer/bin/VisDataServer

After the Visualization Data Server is started, it automatically detects and caches product configurations
that have been indexed with the MMV flag. These cached product configurations are now ready for fast
visualization with the MMV technology.

A product configuration is ready for MMV visualization after it has been indexed, the Visualization Data
Server has detected, downloaded and cached the structure, and prepopulated the FMS system. If you
attempt to visualize a product configuration that is not yet completely indexed and cached in the
Visualization Data Server, the viewer uses the regular non-MMV mode by default. Changes in the
product configuration need to be re-indexed and re-read by the Visualization Data Server before they
can be displayed by the viewer.

Additional configuration for the Visualization Data Server is available in the etc/
VisDataServer.properties file. This includes detailed logging and fine tuning of other settings. If you
make changes to the properties file, you need to restart the Visualization Data Server.

12-52 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Start the Visualization Data Server

Optional: Start the Visualization Data Server as a Linux daemon

To install these services, run the installservice.sh located in the VisDataServer/bin folder. Run this
command with administrator permissions:

installservice.sh unique-service-name user FMS_HOME

For example, from the VisDataServer/bin/ directory, type:

sudo ./installservice.sh VDS MyUser /VIS/VisServer/FCC

If you do not specify arguments, the script runs in interactive mode and prompts you for the required
values.

To uninstall services, run the uninstallservice.sh script for each Jetty server. Run this command with
administrator permissions.

uninstallservice.sh service-name

For example, from the VisDataServer/bin/ directory, type:

sudo ./uninstallservice.sh VDS

If you do not specify arguments, the script runs in interactive mode and prompts you for the required
values.

If you do not remember the name of the service, find it by the following steps:

1. Change to the VisDataServer/bin/ or /etc/systemd/system directory.

2. Look for a file named name.service. The name in this file name is the unique-service-name you
specified when you installed the service using installservice.sh.

Optional: Start the Visualization Data Server as a Windows service

1. Make sure the FMS_HOME environment variable is set as a system environment variable, not a
user variable. The VDS runs as a service only if FMS_HOME is a system environment variable.

2. Inspect the VisDataServer.properties and make sure all file paths specified in it are full paths, not
relative paths.

3. Open a Teamcenter command prompt and change to the root directory of the Visualization Data
Server.

4. Install the Visualization Data Server as a Windows service by running the VisDataServer.exe
command with the /registerService argument:

Teamcenter Installation on Windows, Teamcenter 14.2 12-53

© 2022 Siemens
 12. Installing Active Workspace

VisDataServer.exe /registerService /displayName=name /startup=option

Replace name with a display name for the service. Replace option with automatic or manual.

For example:

VisDataServer.exe /registerService /displayName=VisDataServer /startup=automatic

Optional additional arguments:

Argument Description Example

description Specifies a description for the service. /description="VDS for Active
Workspace 6.2"
config Specifies a configuration file to load for /config="VDSConfig.txt"
the application.

After the service is successfully installed, Windows displays the following message:

The application has been successfully registered as a service.

5. Configure the VDS service:

a. In the Windows Services dialog box, locate the VDS service by the name you specified in the
displayName attribute.

b. Right-click the service name and choose Properties.

c. In the Log on tab, enable the service logon with the following options:

• Log on as: Select This account, then enter the domain and user name (for example,
myDomain\myName).

• Password: Enter and confirm the password for the user account.

Note:
The VDS requires an FMS client cache (FCC) to cache files. Use a dedicated account to
run this service, not the Local System account.

Windows attempts to run the service automatically by default. If the service is not already running when
you open the Windows Services dialog box, the installation may have failed.

If you set the service to start manually, right-click the service name and choose Start. To stop the
service, right-click the service name and choose Stop.

12-54 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Start the Visualization Data Server

To uninstall the service, run the VisDataServer.exe utility with the /unregisterService argument.

Rebuild VDS repository from scratch

As the VDS repository is updated via deltas containing incremental changes from Teamcenter that occur
as design data evolves, the repository used to support MMV viewing may introduce errors. A good
practice is to periodically regenerate the VDS repository from scratch. The default threshold for this
scratch rebuild is every 500 delta updates, but this value is configurable by an administrator so that a
full regeneration of the VDS repository can be set to occur more or less often, depending on the
observed need.

To change the number of deltas that are processed before a scratch rebuild of the VDS repository, set the
MMV_delta_collection_accumulation_limit Teamcenter preference to a value higher or lower than the
default value of 500. This will change how often the VDS rebuilds its repository from scratch.

Note — To manage the number of delta files that are to be deleted, use the
MMP_PERCENTAGE_OF_DELTA_TO_PURGE preference. Its default value is 100, but based on your
need, you can set it to any value from 10 to 100. Refer to the following table to understand preference
value limits:

If preference value is set to then preference value processed is

<=10 10

10 < value < 100 value

>=100 100

All delta files are deleted when the MMP_PERCENTAGE_OF_DELTA_TO_PURGE preference value is set
to 100.

Example:
Set the MMV_delta_collection_accumulation_limit preference value to 500.
In this case, since the value is set to 500, it becomes the maximum delta limit. After this many
deltas are processed, a completely new mmp file is created.
To delete 100% (all) of the old delta files in the MMV dataset, set the
MMP_PERCENTAGE_OF_DELTA_TO_PURGE preference value to 100. If you want to delete only
10% of the old delta files in the MMV dataset, set the MMP_PERCENTAGE_OF_DELTA_TO_PURGE
preference value to 10.

Visualization Data Server status log settings

Configuration for the Visualization Data Server is available in the etc/VisDataServer.properties file. This
includes detailed logging and fine tuning of other settings. If you make changes to the properties file,
you must restart the Visualization Data Server.

Teamcenter Installation on Windows, Teamcenter 14.2 12-55

© 2022 Siemens
 12. Installing Active Workspace

Log information includes the status of all products hosted by the Visualization Data Server.

#
# Status logger settings. The status logger can be of help showing
the current indexing status
# and also the current and waiting task to be processed.
#
# The interval to generate the status log (see the "Interval"
documentation
for more info).
StatusLogger.StatusInterval=120
# This will output the name of the top level (root) node.
StatusLogger.ShowRootName = true
# Shows the timestamp of the indexed product.
StatusLogger.ShowTimestamp = true
# Shows the available revision rules of indexed product.
StatusLogger.ShowRevRule = true
# Shows the status of the Spatial JTs.
StatusLogger.ShowSpatialJt = true
# If ShowSpatialJt is true, also shows the file path of the Spatial JTs.
StatusLogger.ShowSpatialJtPath = true
# If ShowSpatialJt is true and a Spatial JT is missing, the string will
be added
in from of the path.
# This can be used if a specific string is needed to search for a
missing
file (like using the grep utility).
StatusLogger.MissingSpatialJtMessage = (missing)
# Shows all the versions of a product instead of just the latest one.
StatusLogger.ShowAllVersions= false
# Shows the active tasks being processed.
StatusLogger.ShowActiveTasks=true
# Shows any waiting tasks to be processed.
StatusLogger.ShowWaitingTasks=true

Install the Active Workspace Launcher

The Active Workspace Launcher connects Active Workspace to Microsoft Office applications, opening the
appropriate Office application when you open an attachment in Active Workspace.

To enable this behavior on an Active Workspace client host:

1. Install Microsoft Office.

For supported versions, see the Hardware and Software Certifications knowledge base article on
Support Center.

12-56 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the Active Workspace Launcher

2. Depending on your needs, install Teamcenter Client for Microsoft Office and/or Teamcenter
Extensions for Microsoft Office as described in Rich Client Installation on Windows in the
Teamcenter help.

3. Install Active Workspace Launcher:

a. In the Teamcenter minor release software kit, open the wntx64\additional_applications

\TcClientAppLauncher directory and launch setup.exe.

b. Complete the installation wizard.

4. To enable the editing of requirements in Active Workspace, you must perform additional setup
tasks.

If you want to host Active Workspace within Client for Office, set Active Workspace hosting preferences
as described in Customizing Active Workspace.

Note:
Kerberos authentication is not supported with Client for Office.

Install Active Workspace Launcher silently

Alternatively, you can install the Active Workspace Launcher silently, without user interaction:

1. To generate a silent installation file, type the following command in a command prompt:

setup.exe /r /f1"path\tclauncher.iss"

For example, to generate a silent file in the c:\temp folder, enter the following command:

setup.exe /r /f1"c:\temp\tclauncher.iss"

Do not include a space between the f1 argument and the path that follows it. The path must be
enclosed in double quotation marks (" ") as shown.

2. To install the Active Workspace launcher silently on another system, type the following command:

setup.exe /s /f1"c:\tclauncher.iss"

Troubleshoot the Active Workspace Launcher installation

If Microsoft Office applications fail to launch when opening an attachment, the .awoai file may be
associated with Microsoft Word instead of the Active Workspace Launcher. To resolve this, perform one
of the following tasks:

Teamcenter Installation on Windows, Teamcenter 14.2 12-57

© 2022 Siemens
 12. Installing Active Workspace

• Uninstall and reinstall the Teamcenter Active Workspace Launcher and try again.

• In the HKEY_CLASSES_ROOT\.awoai\shell\Open\command registry entry, ensure the .awoai file

extension is correctly associated with the TcClientApplauncher.exe command.

Install classification libraries

Prerequisites:

• The Classification Library Management feature must be installed and configured on Teamcenter.

• The presentation layer must be created with the clsutility.

• The library data must be created with the lbrmanager utility.

For more information, see how to use Library Management to selectively display the classification
hierarchy in Configuration and Extensibility.

The following displays the interaction of the various components necessary to use Classification in
Active Workspace:

• Server

• To install the server components for classifying objects and searching for classified objects:

Select Active Workspace→Server Extensions→Reuse and Standardization→Classification

Server.

• To install the server components necessary for enabling visual navigation cards:

Select Active Workspace→Server Extensions→Reuse and Standardization→Next Generation

Classification Server.

12-58 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install classification libraries

• To install the server components necessary for searching within classification libraries:

Select Active Workspace→Server Extensions→Reuse and Standardization→Library

Management Server.

Server features
Next Generation
Classification
Library
Functions Classification (Presentation layer) Management
Index classification attributes √ √ √
Index classification classes √ √ √
Index classifying objects (ICOs) √ √
Hierarchical filtering of classes √ √ √
Index catalog data √
Index library elements √
Visual navigation cards (VNC) for √ √
classes
Visual navigation cards (VNC) for √
library nodes
Compatible client feature Classification Library Management client
client

• Client

• To install the user interface elements for classifying objects in Active Workspace:

Select Active Workspace→Client Extensions→Reuse and Standardization→Classification

Client.

• To install the user interface components necessary for using classification libraries:

Select Active Workspace→Client Extensions→Reuse and Standardization→Library

Management Client.

Client features
Functions Client features Library Management
Classification authoring √
Browse classification hierarchy using visual navigation cards √
Browse library hierarchy using visual navigation cards √
Dedicated location for searching and browsing √

Teamcenter Installation on Windows, Teamcenter 14.2 12-59

© 2022 Siemens
 12. Installing Active Workspace

Verify Active Workspace installation

To verify the Active Workspace installation is complete and successful, open the Active Workspace URL in
a web browser:

http://host:port

Replace host and port with the host and port of the Active Workspace Gateway.

For example:

http://myhost:3000

In the Active Workspace logon screen, enter the user name and password for the Teamcenter
administrative account.

If installation is successful, the browser displays the Active Workspace client.

You can also verify the status of Active Workspace Gateway and services using the Active Workspace
gateway ping:

http://myhost:3000/ping

12-60 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 13. Adding optional solutions
Install the Business Modeler IDE

Choose a Business Modeler IDE installation type

Several types of Business Modeler IDE installation are possible. All BMIDE installation types can be used
to create, import, and modify a template project, and can generate a template package which can be
deployed using TEM or Deployment Center.

An important difference among the installation types is whether and how the BMIDE connects to a
Teamcenter site. A Teamcenter site connection is necessary for some tasks:

Perform data exchanges, such as:

• Synchronize the data model in a BMIDE template project with the Teamcenter server database.
• Live update non-schema data, such as lists of values (LOVs), from the BMIDE to a production
server without shutting down the production server.
• Live deploy a template to a test Teamcenter server.
• Incorporate live update changes made to the production environment into a BMIDE standard
template project.
Create certain data model elements, such as:
• Business object display rule
• Dynamic list of values
• Business context rule
• Item revision definition configuration (IRDC)
• System stamp configuration
• Subtype of AppInterface, and many others

Use the following general procedure for choosing a Business Modeler IDE installation type.

1. Ensure that the machine meets prerequisites for a BMIDE.

Caution:
Do not install BMIDE on a production environment corporate server. Doing so could have
unintended consequences, especially during Teamcenter upgrade.

2. Choose the BMIDE installation type that you want to perform.

• Add BMIDE functionality into your existing Eclipse environment. This consists of manually
patching your Eclipse environment with BMIDE jar files.

Advantage: Exists within your custom Eclipse environment.

Teamcenter Installation on Windows, Teamcenter 14.2 13-1

© 2022 Siemens
 13. Adding optional solutions

Limitation: Cannot perform actions that require connection to a Teamcenter site.

• One of three types of BMIDE stand-alone application:

Stand-alone Teamcenter
type connection type Advantage Limitation

2-tier Two-tier Allows live deployments Requires local network

environment via even while a web tier is access.
TCCS. inactive or down for
maintenance.

4-tier Four-tier Allows remote access and Requires an active web

environment via live deployments. tier.
HTTP server.

Standalone None No requirement for or Cannot perform actions

possibility of unintentional that require connection to
interaction with any a Teamcenter site.
Teamcenter site.

Install the Business Modeler IDE

1. Ensure that the proper version of JRE is installed and the JRE_HOME environment variable (32-bit
system) or the JRE64_HOME environment variable (64-bit system) is set.

2. Start Teamcenter Environment Manager (TEM). For example, from the Teamcenter software kit,
run TEM.bat (Windows) or TEM.sh (Linux).

3. Proceed to the Solutions panel. In the Solutions panel, select Business Modeler IDE, and then
click Next.

Caution:
Do not install the Business Modeler IDE on a production environment corporate server. Doing
so could have unintended consequences, especially during Teamcenter upgrade.

4. Perform the following steps in the Features panel:

a. Under Base Install, select one of the following:

• Business Modeler IDE 2-tier

Connects to a Teamcenter site in a two-tier environment via TCCS.

• Business Modeler IDE 4-tier

13-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the Business Modeler IDE

Connects to a Teamcenter site in a four-tier environment via HTTP server.

• Business Modeler IDE Standalone

Does not connect to a Teamcenter site.

When you select one of these options, a server connection profile is added in the Business
Modeler IDE.

b. (Optional) Select Extensions→Mechatronics Process Management→EDA for Business

Modeler IDE.

This installs the EDA Derived Data configuration tool into the Business Modeler IDE. This tool is
used to configure Teamcenter EDA, an application that integrates Teamcenter with electronic
CAD (E-CAD) design applications, such as Cadence and Siemens EDA.

If you install this option, you must ensure that the Extensions→Mechatronics Process
Management→EDA Server Support option is also installed to the server.

In addition, later in the installation process when you select templates to install to the
Business Modeler IDE, you must select the EDA Server Support template
(edaserver_template.xml).

c. In the Installation Directory box, enter the location where you want to install the Business
Modeler IDE. The Business Modeler IDE files are installed to a bmide subdirectory.

d. Click Next.

5. In the Java Development Kit dialog box, click the browse button to locate the JDK installed on
your system. The kit is used for creating services. Click Next.

6. Depending on whether you selected Business Modeler IDE two-tier or four-tier installation, perform
the following steps:

• If you selected the Business Modeler IDE 2-tier option, perform the following steps in the 2-tier
server settings panel:

a. In the Connection Port box, type the server port number. The default is 1572.

b. Click the Edit button to the right of the 2-tier Servers box to change the server connection
profile settings, or click the Add button to add another server to connect to.

c. Click the Advanced button.

A. Click the arrow in the Activation Mode box to select the mode to use when
connecting to the server. The default is NORMAL.

Teamcenter Installation on Windows, Teamcenter 14.2 13-3

© 2022 Siemens
 13. Adding optional solutions

B. Click the ellipsis (...) button to the right of the Configuration Directory box to select
the folder where you want this configuration saved. The default is TC_ROOT\tccs.

C. Click OK.

d. Click Next.

• If you selected the Business Modeler IDE 4-tier option, perform the following steps in the 4-tier
server configurations panel.

a. Leave the Compress (gzip) the responses from the Web application servers check box
selected if you want faster connection performance from the server.

b. Click the Add button to the right of the 4-tier Servers table if you want to add another
server to connect to.

c. Click Next.

• If you have previously installed Teamcenter client communication system (TCCS) on your system,
and you also selected the Business Modeler IDE 4-tier option, the TcCS Settings panel appears.
This panel is used to configure TCCS for use with the Business Modeler IDE. TCCS is used when
you need secure Teamcenter communications through a firewall using a forward proxy.

If you want to use TCCS, you must install it first. To install TCCS, run the installation-source
\additional_applications\tccs_install\tccsinst.exe file. To change the TCCS setup later, run the
tccs-installation-location\tccs\_Teamcenter Communication Service_installation\Change
Teamcenter Communication Service Installation file.

• If you do not want to use TCCS, ensure that the Use TcCS Environments for 4-tier clients
check box is cleared and click Next.

If this check box is cleared, the 4-tier server configurations panel is displayed after you are
finished with the current panel.

• If you want to use TCCS, perform the following steps:

a. Select Do not use proxy if you do not want to use a forward or reverse proxy.

b. Select Use web browser settings to automatically use proxy settings already configured
in a web browser.

c. Select Detect setting from network to automatically use proxy settings from the
network.

d. Select Retrieve settings from URL and type a valid proxy URL to use a proxy
autoconfiguration file.

13-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install the Business Modeler IDE

e. Select Configure settings manually to type valid host and port values for proxy servers.

f. Select the Use TcCS Environments for 4-tier clients check box if you want to use TCCS,
or clear it if you do not. (This check box is automatically selected if TCCS is installed.)

g. If the Use TcCS Environments for 4-tier clients check box is selected, you can use the
Client Filter Text box to specify a filter text on the available TCCS environments to avoid
displaying undesired environments in the rich client logon window. This box is optional
and can hold any string.

h. Click Next.

7. Perform the following steps in the Business Modeler IDE Client panel:

a. Click the Add button to the right of the table to select the templates to install. Templates
contain the data model for Teamcenter solutions. The Teamcenter Foundation template is
installed by default. The Foundation template contains the data model used for core
Teamcenter functions. All customer templates must extend the Foundation template.

Select the same templates that were installed on the server so that you can see the same data
model definitions in the Business Modeler IDE that were installed on the server.

To find the templates installed on the server, look in the TC_DATA\model directory on the
server.

If you installed the EDA option to the Business Modeler IDE, select the EDA Server Support
template (edaserver_template.xml).

b. If you have any templates of your own to install or a template from a third-party, click the
Browse button and browse to the directory where the templates are located.

c. Click Next.

8. Complete the remaining panels to finish the installation in Teamcenter Environment Manager.
When the installation is complete, exit Teamcenter Environment Manager.

9. Verify the installed files in the install-location\bmide directory.

The following data model files are placed into the install-location\bmide\templates folder:

• icons\template-name_icons.zip

Contains the icons used by that template.

• lang\template-name_template_language_locale.xml

Teamcenter Installation on Windows, Teamcenter 14.2 13-5

© 2022 Siemens
 13. Adding optional solutions

Contains the text that is displayed in the Business Modeler IDE user interface for all languages.

• template-name_dependency.xml

Lists the other templates that this template is built on top of, for example, the Foundation
template.

• template-name_template.xml

Contains the data model for this template, including business objects, classes, properties,
attributes, lists of values (LOVs), and so on.

• master.xml

Lists the template XML files included in the data model, for example, the
foundation_template.xml file.

10. Allocate memory so that Business Modeler IDE has enough memory to run.

Add the Business Modeler IDE to an existing Eclipse SDK environment

If you already have an existing Eclipse SDK environment with the version of Eclipse that is certified for
your Teamcenter platform, and Business Modeler IDE plugins have never been installed into the
environment, then you can install the Business Modeler IDE plugins into your existing Eclipse
environment.

Caution:
If your Eclipse environment contains Business Modeler IDE plugins installed from an earlier version
of Business Modeler IDE, then installing a later version of Business Modeler IDE plugins into the
same environment results in version incompatibilities and is not supported.

1. Ensure that your Eclipse SDK environment uses the Eclipse version that is certified for your
Teamcenter platform.

For information about system hardware and software requirements, see the Hardware and
Software Certifications knowledge base article on Support Center.

To check your Eclipse version, start Eclipse and select Help>About Eclipse SDK.

2. In the Teamcenter software kit for your Teamcenter platform, go to the following directory:

additional_applications\bmide_plugins

In that directory, find the file bmide_plugins.zip.

13-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Add the Business Modeler IDE to an existing Eclipse SDK environment

This archive contains the Business Modeler IDE plug-ins within an internal eclipse\plugins
directory.

3. Extract the contents of the eclipse\plugins directory within bmide_plugins.zip to your

ECLIPSE_HOME\eclipse\plugins directory.

4. In the Teamcenter software kit for the major release for your Teamcenter platform, go to the
following directory:

bmide\compressed_files

In that directory, find the file bmide.zip.

5. Extract the bmide.zip content to some temporary local directory (for example C:\bmide).

6. From the plugins directory within this local directory (C:\bmide), copy the following directories and
their contents to your ECLIPSE_HOME\eclipse\plugins directory.

• antlr
• commons_lang
• commons_xmlschema
• httpclient_version
• org.apache.poi.39

7. Create a list of software repository site URLs for the following plugins. Use the Eclipse site to
identify the proper URLs. The examples shown are for Eclipse SDK version 2018-12 (4.1.10.0).

You will use this list in step 9.

For this
plugin Do this

CDT Browse to https://www.eclipse.org/cdt/downloads.php and find the URL for the

CDT software repository for your Eclipse version. The URL looks similar to this:
https://download.eclipse.org/tools/cdt/releases/9.6
Record the URL in your list of plugin software repository sites.

DTP Browse to https://www.eclipse.org/datatools/downloads.php and find the DTP

row for your Eclipse version. Click the update site link.

Teamcenter Installation on Windows, Teamcenter 14.2 13-7

© 2022 Siemens
 13. Adding optional solutions

For this
plugin Do this

The URL of the page that opens looks similar to this: https://
download.eclipse.org/datatools/updates/1.14.103-SNAPSHOT/repository/
Record the URL in your list of plugin software repository sites.

EMF Add http://download.eclipse.org/modeling/emf/updates/releases/ to your list of

plugin software repository sites.
For details about the requirement for Eclipse version and software repository URL
for EMF, browse to https://www.eclipse.org/modeling/emf/updates/

GEF Add http://download.eclipse.org/tools/gef/updates/releases to your list of

plugin software repository sites.
For details about the requirement for Eclipse version and software repository URL
for GEF, browse to https://projects.eclipse.org/projects/tools.gef

WTP Browse to https://download.eclipse.org/webtools/repository/ and then find the

directory for your Eclipse version. Click the directory link.
The URL for the resulting page looks similar to this: https://download.eclipse.org/
webtools/repository/2018-12/
Record the URL in your list of plugin software repository sites.

13-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Allocate memory to the Business Modeler IDE

For this
plugin Do this

8. Launch Eclipse.

9. From the top menu bar, choose Help→Install New Software. Use the Eclipse software installation
feature to add the CDT, DTP, GEF, EMF and WTP plugin software update sites and install all of the
plugins. Refer to the list of plugin software update URLs you created in step 7.

After all the plugins are installed and you have restarted Eclipse, a BMIDE item appears on the top menu
bar. Command buttons to open the BMIDE Advanced and Standard perspectives appear on the toolbar.

Allocate memory to the Business Modeler IDE

Allocate memory to the Business Modeler IDE so that it has enough to launch and run.

If you perform live updates, you must have a minimum of 2 GB of RAM on the system running the
Business Modeler IDE to allow for other processes.

You can allocate memory in the following ways:

Teamcenter Installation on Windows, Teamcenter 14.2 13-9

© 2022 Siemens
 13. Adding optional solutions

• BusinessModelerIDE.ini file

To increase the memory allocated to the Business Modeler IDE, open the install-location\bmide\client
\BusinessModelerIDE.ini file and change the -Xmx1024M value to a higher number to allocate
maximum Java heap size. For example, if you have 2 GB available to dedicate for this purpose, set the
value to -Xmx2048M. Do this only if your machine has the available memory.

The Xms value in this file sets the initial Java heap size, and the Xmx value sets the maximum Java
heap size.

• BMIDE_SCRIPT_ARGS environment variable

To allocate the memory required by scripts during installation, update, or load of templates with large
data models, create a BMIDE_SCRIPT_ARGS environment variable. Set the BMIDE_SCRIPT_ARGS
variable to -Xmx1024M to allocate 1 GB of RAM to the Business Modeler IDE scripts. If your system
has more memory that you can allocate to the Business Modeler IDE, you can set the value higher.

If you are running the Business Modeler IDE in an Eclipse environment, run the following command to
increase virtual memory to 2 GB:

eclipse.exe -vmargs -Xmx2048M

Caution:
Java standards require that no more than 25 percent of total RAM be allocated to virtual memory.
If the amount allocated to the Business Modeler IDE is higher than 25 percent of total RAM, then
memory disk swapping occurs, with possible performance degradation.
If you set the Xmx value to a higher value than the RAM your system has, you may get the
following error when you launch the Business Modeler IDE:

Could not create the Java virtual machine.

Set the Xmx value to a setting that your system supports, in both the BMIDE_SCRIPT_ARGS
environment variable and the BusinessModelerIDE.ini file.

Start the Business Modeler IDE

Start a Business Modeler IDE in one of several ways, depending on the installation type:

Installation type Platform Procedure to start Business Modeler IDE

BMIDE Standalone, 2-tier, Windows Click the Start button and choose All Programs>Teamcenter
or 4-tier [version]>Business Modeler IDE. This runs the bmide.bat file.
Linux Run the bmide.sh file in the install-location/bmide/client
directory.

13-10 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Installing a custom solution or third-party template

Installation type Platform Procedure to start Business Modeler IDE

Eclipse environment to Windows Navigate to the directory where Eclipse is installed and execute
which BMIDE plug-ins the Eclipse.exe command.
have been added
Eclipse.exe -vmargs -Xmx2024M
To ensure that you have enough memory to run Eclipse, run the
command with a virtual memory argument. In the example, the
argument increases virtual memory to 2 GB.
Linux Navigate to the directory where Eclipse is installed and execute
the Eclipse command.
Eclipse -vmargs -Xmx2024M

For BMIDE operations that require connection to the Teamcenter server, users of the BMIDE must be
members of the Teamcenter database administrators (dba) group. To add a user to the dba group, in
the Teamcenter rich client use the Organization perspective.

If a perspective fails to open, it could be that not enough memory is allocated to the Business Modeler
IDE.

Installing custom software

Installing a custom solution or third-party template

Use TEM to install custom templates you package using the Business Modeler IDE.

Install a template using TEM

After you package extensions, install the resulting template to a production environment using
Teamcenter Environment Manager. You can also use this procedure to install a third-party template.

You could also install a template using Deployment Center, or the tem command line utility with its -
install argument.

1. Ensure that you have a good back up of the Teamcenter environment.

2. Copy the template files from the packaging directory on your Business Modeler IDE client to a
directory that is accessible by the server.

By default, packaged template files are located in the Business Modeler IDE workspace directory in
the folder under the project.

On Linux, users must have permissions to the workspace directory.

3. Start Teamcenter Environment Manager (TEM).

Teamcenter Installation on Windows, Teamcenter 14.2 13-11

© 2022 Siemens
 13. Adding optional solutions

4. In the Maintenance panel, choose Configuration Manager and click Next.

5. In the Configuration Maintenance panel, choose Perform maintenance on an existing

configuration and click Next.

6. In the Configuration pane, select the configuration from which the corporate server was installed.
Click Next.

7. In the Feature Maintenance panel, under the Teamcenter section, select Add/Remove Features.
Click Next.

If you already installed a template to the database and want to update the template, under the
Teamcenter Foundation section, select Update the database. This option should not be used to
install a new template but only to update an already installed template.

Use the Add/Update templates for working within the Business Modeler IDE client option
under Business Modeler Templates only if you want to add a dependent template to your
Business Modeler IDE.

8. In the Features panel, click the Browse button beneath the features list on the right side of the
panel.

9. Browse to the directory where you have copied the template files. In the Files of type box, ensure
that Feature Files is selected so that you see only the installable template (feature) file. Select your
template's feature file (feature_template-name.xml in the tem_contributions directory) and click
the Select button.

13-12 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install a template using TEM

The template appears as a new feature under Extensions in the Features panel.

You can change the location of the feature in the Features panel and add a new group to place the
feature under.

10. Select the new template in the Features panel. Click Next.

11. In the Teamcenter Administrative User panel, enter your user name and password to log on to
the server. Click Next.

12. The Database Template Summary panel displays the list of templates that are installed as part of
your template install. Click Next.

13. In the Confirmation panel, click Start. The new template is installed.

Teamcenter Installation on Windows, Teamcenter 14.2 13-13

© 2022 Siemens
 13. Adding optional solutions

Note:
If the installation fails because of invalid data model, perform the following steps:

a. Fix the incorrect data model and repackage the template.

b. Locate the template-name_template.zip in your project's packaging directory and

unzip it to a temporary location. Copy the following files to the server in the TC_ROOT/
install/template-name folder:

template-name_template.xml
template-name_dependency.xml
template-name_tcbaseline.xml (if the file exists)

c. Launch Teamcenter Environment Manager in the maintenance mode and continue with
recovery.

14. To verify the installation of the new template, confirm that the TC_DATA directory on the
Teamcenter server contains the new template files.

Also log on to the server and confirm that you can create instances of your new data model.

Note:
To have libraries read on the user system, the TC_LIBRARY environment variable must be set
to the platform-specific shared library path. This environment variable is set to
LD_LIBRARY_PATH on Linux systems. The platform is detected when the Teamcenter session
is initiated.

Update a template using TEM

If you already installed a template as a new feature and want to update it because you have added more
data model definitions to it, perform the following steps in the Teamcenter Environment Manager
(TEM).

Note:
You can also update a template using the tem command line utility, for example.

tem -update -full -templates=template-name-1,template-name-2 -path=location-of-template-files

-pass=password

1. Ensure that you have a good back up of the Teamcenter environment.

2. Copy the packaged template files from the packaging directory on your Business Modeler IDE
client to a directory that is accessible by the server.

13-14 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Update a template using TEM

By default, packaged template files are located in the Business Modeler IDE workspace directory in
the folder under the project. .

3. Start Teamcenter Environment Manager (TEM).

4. In the Maintenance panel, choose Configuration Manager and click Next.

5. In the Configuration Maintenance panel, choose Perform maintenance on an existing

configuration and click Next.

6. The Configuration panel displays the installed configuration. Click Next.

7. In the Feature Maintenance panel, under the Teamcenter Foundation section, select Update
Database (Full Model - System Downtime Required). Click Next.

Note:
Use the Add/Update Templates for working with the Business Modeler IDE Client option
under Business Modeler only if you want to add or update a dependent template to your
Business Modeler IDE.

8. Click Next

9. In the Teamcenter Administrative User panel, enter your user name and password to log on to
the server. Click Next.

The Update Database panel displays currently installed templates.

10. Click the Browse button to navigate to the directory where the packaged template files are located.
Select the updated feature_template-name.xml file.

Note:
If you are fixing a COTS template (for example, the Foundation template) using a new
template file provided in a patch, you must copy the template's feature_template-name.xml
and the template-name_install.zip files to the same temporary directory containing the new
template-name_template.zip file.

The template displays a refreshed status icon .

Teamcenter Installation on Windows, Teamcenter 14.2 13-15

© 2022 Siemens
 13. Adding optional solutions

11. Click Next.

12. In the Confirmation panel, click Next.

The new template is installed.

13. To verify the installation of the revised template, log on to the server and confirm that you can
create instances of your new data model.

Configure Multi-Site Collaboration

Overview of Multi-Site Collaboration configuration

Multi-Site Collaboration allows the exchange of Teamcenter data objects between databases. Each
database should be easily accessible via TCP/IP, either over the Internet or the company intranet.
Configuration of Multi-Site Collaboration is optional.

Coordinate configuration of Multi-Site Collaboration with the system administrators of the other
Teamcenter databases to be part of the Multi-Site Collaboration environment. Information about all
participating Teamcenter database sites must be stored in each database and in the site preference files.
In addition, you must identify the network nodes to run Multi-Site Collaboration server processes for
these databases and configure those systems to run the processes.

Prepare the Multi-Site Collaboration environment

Perform the following steps to configure Multi-Site Collaboration for a wide area network:

1. Identify all Teamcenter databases to be part of the Multi-Site Collaboration environment.

2. Identify the Teamcenter database to act as the ODS database.

This database stores records about the data objects published by other databases in the Multi-Site
Collaboration environment (that is, made public to the other databases).

13-16 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Prepare the Multi-Site Collaboration environment

This can be one of the databases identified in step 1 or it can be a dedicated database. The
database must be populated with Teamcenter data.

3. For each database identified in step 2, identify a network node local to that database to act as the
ODS server.

The ods service runs on this system to listen for publication queries from other databases.

4. For each database identified at step 1, identify a network node local to that database to act as the
IDSM for that database.

When other databases request an object published from this database, the idsm service is run on
this network node to export the object.

5. For each database identified in step 1, obtain the site name and site ID.

The site ID of the database is generated during installation and cannot be changed. The site name
is customizable but by default is based on the site ID. To obtain the site name and site ID, use the
administration application named Organization in Teamcenter rich client (in the rich client
application manager, click Admin and then click the Organization symbol). Within Organization,
choose the top-level Sites node from the Organization tree. The site details for the local database
are listed first.

6. Using the information obtained in steps 2 through 5, populate each database site table with
information about the other sites using the Organization application in the Teamcenter rich client.

The node for each site is the name of the network node to run the necessary Multi-Site
Collaboration services (idsm and/or ods). If the site is an ODS database, check the ODS site flag. To
publish objects from the ODS database, define the site of the ODS database in the site table and
configure the ODS server as an IDSM server.

7. For each database identified in step 1 and step 2, edit the site preference for the database and
modify the following preferences to reflect the Multi-Site Collaboration environment:

ODS_permitted_sites (ODS database only)

ODS_site (Non-ODS databases)
ODS_searchable_sites
ODS_searchable_sites_excluded
IDSM_permitted_sites
IDSM_permitted_users_from_site_site-name
IDSM_permitted_transfer_sites
IDSM_permitted_transfer_users_from_site_site-name
IDSM_permitted_checkout_sites
IDSM_permitted_checkout_users_from_site_site-name
Fms_BootStrap_Urls
TC_publishable_classes
TC_transfer_area

Teamcenter Installation on Windows, Teamcenter 14.2 13-17

© 2022 Siemens
 13. Adding optional solutions

8. For each database identified in step 1 and step 2, copy all POM transmit schema files for that
database into the POM transmit schema directories for each of the other databases.

This step is required to allow the import of data objects from other databases. Devise a strategy for
regularly synchronizing POM transmit schema directories.

9. For each network node identified at step 3 and step 4, run the Teamcenter setup program on that
node to configure and start the Multi-Site Collaboration daemons.

Install a proxy server

Configure a proxy server to be used with Multi-Site Collaboration.

Installing and configuring the Manufacturing Resource Library

Installation overview and workflow

The Manufacturing Resource Library (MRL) is a collection of data that you can import into the database.
It includes a classification hierarchy for resources such as tools, machines, and fixtures. You use this data
in the Classification and Resource Manager applications. In addition, you can access these resources
from NX CAM. To do this, you must configure NX Library.

To populate the database with sample Teamcenter manufacturing process management data, make sure
that the Teamcenter corporate server is installed on the installation host and the Teamcenter database is
configured or upgraded.

There are general workflows for installing or updating the Manufacturing Resource Library.

Installing for the first time Upgrading from an earlier MRL version

1. Configure the users, groups, and roles in 1. Begin the installation.

the database.
2. Update the class hierarchy.
2. Begin the installation.
3. Import or update rules and preferences.
3. Import the class hierarchy.
4. Import or update seed parts.
4. Import rules and preferences.
5. Import or update part family templates
5. Import seed parts. and template parts.

6. Import part family templates and 6. Import or update sample parts.

template parts.

13-18 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configure Manufacturing Resource Library users, groups, and roles

Installing for the first time Upgrading from an earlier MRL version

7. Import sample parts.

Configure Manufacturing Resource Library users, groups, and roles

If you have already defined your own database user, group, and role settings in the Organization
application, you can use those existing users to populate the Manufacturing Resource Library (MRL). If
not, run the MRL installation setup to populate the following user structure.

Perform the following task before installing the Manufacturing Resource Library.

1. In the Organization application, ensure that a default volume is assigned to the application user
that you specify in this installation procedure.

2. In the resource_management directory, click Setup.exe and proceed to the Setup Type Selection
dialog box.

3. Select Manufacturing Resources - Configure MRL Users and click Next.

Tip:
Press the F1 key to see the help for each page in the installation wizard.

4. Select one or more of the following:

• Create and Configure TC/MRL Users

Creates and configures MRL-specific users:

CAMUser01
Planner01

Teamcenter Installation on Windows, Teamcenter 14.2 13-19

© 2022 Siemens
 13. Adding optional solutions

TOOLAdmin01
MFGAdmin01

• Create Manufacturing Admin User in DBA Group

Creates and configures the MFGAdmin01 user in the dba group.

• Assign Manufacturing Applications to MRL Users

Assigns the created MRL users to Teamcenter applications as follows:

CAMUser01: Part Planner, Resource Manager

Planner01: Classification, Part Planner, Resource Manager

TOOLAdmin01: Classification, Resource Manager

MFGAdmin01: Organization, Classification Admin, Classification, Part Planner, Resource

Manager

5. Click Next.

Teamcenter displays the Choose TC_ROOT Directory dialog box.

6. Select the path to your Teamcenter installation and click Next. The path must point to an existing
installation.

Teamcenter displays the Choose TC_DATA Directory dialog box.

7. Select the path to the directory containing the database-specific data files and click Next.

The path must point to an existing TC_DATA directory.

8. Enter the user name, password, and group of two valid Teamcenter logon accounts.

Teamcenter requires two types of user accounts to configure the ownership of MRL objects
correctly:

• An administrative user account

Used to create the classification hierarchy.

• An application user account

13-20 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Beginning the installation

Used to populate the database MRL data such as sample resources items and part family
templates. This user is the owner of the content including sample data for tools, machines, and
fixtures.

9. Enter the name of a valid Teamcenter volume name.

10. Click Next and complete the user configuration.

Populating the database

Beginning the installation

Before you begin installation, make sure you have the latest available version of the Manufacturing
Resource Library. If a later version is available, download and extract the latest version and browse to
the advanced_installations directory in the location of the extracted files.

For information about later versions, see Support Center.

To populate the Manufacturing Resource Library (MRL) on the Teamcenter server:

1. In the advanced_installations directory in the Teamcenter software kit, locate the

advanced_installations.zip file and unzip it to a local directory.

2. In the resource_management directory, click Setup.exe.

Teamcenter displays the Teamcenter Configuration Setup dialog box.

3. Click Next.

Teamcenter displays a notification that you must check for the most recent version of the resource
library.

4. Click Next.

Teamcenter displays the Setup Type Selection dialog box.

5. Select Manufacturing Resources - Database Population.

6. Click Next.

Teamcenter displays the MRL Database Population - Type Selection dialog box.

7. Select from the following, and then click Next:

• Import Class Hierarchy

Teamcenter Installation on Windows, Teamcenter 14.2 13-21

© 2022 Siemens
 13. Adding optional solutions

Initially populates the Teamcenter database with MRL classification structures for tools,
machines, fixtures, factory resources, machining data library, manufacturing process templates,
vendor catalogs, and measuring devices.

• Update Class Hierarchy

Updates an existing MRL classification structure. Teamcenter analyzes the available MRL class
structures and creates individual update scripts to migrate your class hierarchy to the latest MRL
classes.

• Import Rules and Preferences

Imports and updates rules and preferences required to use the MRL in Resource Manager.

• Import MRL NX Seed Parts

Imports the NX part files that are used by the MRL. This includes template part files to build tool
assemblies, a seed part to import GTC STEP files, and sample drawing templates to generate
resource setup sheets.

• Import 3D Template Parts

Imports the template part files to generate 3D graphics. For tools, the system provides template
part files (TPs); for factory resources, part family templates are provided (PFTs).

• Import MRL Sample Resources

Imports sample data for the individual modules. This includes sample tool assemblies, fixtures,
and factory resources. This option also imports technology data such as feeds and speeds
records for the Machining Data Library. Currently, sample machines are no longer delivered with
the MRL kit. You must import your machines manually.

Click one of the links to proceed in the documentation. The installer continues with three more
common steps.

8. Select the path to your Teamcenter installation in the Choose TC_ROOT Directory dialog box and
click Next. The path must point to an existing installation.

Teamcenter displays the Choose TC_DATA Directory dialog box.

9. Select the path to the directory containing the database-specific data files and click Next. The path
must point to an existing TC_DATA directory.

10. Enter the user name, password, and group of two valid Teamcenter logon accounts.

Teamcenter requires two types of user accounts to configure the ownership of MRL objects
correctly:

13-22 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Import the class hierarchy

• An administrative user account

Used to create the classification hierarchy.

• An application user account

Used to populate the database MRL data such as sample resources items and part family
templates. This user is the owner of the content including sample data for tools, machines, and
fixtures.

Upgrading from an earlier MRL version

In addition to the steps outlined above, it is advised that you:

• update the NX Library files. There may be enhancements to the TCL and DEF files.

• use the MRL graphics builder to copy the latest ics_graphicsbuilder.tcl file.

Import the class hierarchy

Use this procedure to initially populate the Teamcenter database with MRL classification structures for
tools, machines, fixtures, factory resources, machining data library, manufacturing process templates,
and vendor catalogs.

The following procedure assumes you have completed the steps in Beginning the installation. The
installation wizard should currently display the Manufacturing Resource Library - Content Selection
dialog box.

1. Specify which types of data you want to load. The options listed indicate which modules have
already been imported to the database. Depending on the information shown in brackets, you may
have to return to the MRL Database Population - Type Selection dialog box to update the
existing hierarchy for a particular module.

For example, if this is displayed:

You must return to the MRL Database Population - Type Selection dialog box and select Update
hierarchy if you want to import the tool hierarchy, but you can proceed with this dialog to import
the machine hierarchy.

The following modules are available:

• Vendor Catalogs

Teamcenter Installation on Windows, Teamcenter 14.2 13-23

© 2022 Siemens
 13. Adding optional solutions

Imports the empty MRM_Vendor class into which vendor catalogs can be imported.

• Tools (Assemblies and Components)

Imports the groups and classes used to classify tool assemblies and components.

• Machines (New in MRL 6.1)

Imports the groups and classes used to classify machines and devices such as chucks, jaws, or
tool holders.

• Fixtures and Devices (New in MRL 6.0)

Imports the groups and classes used to classify clamping fixtures.

• Measuring Devices

Imports the groups and classes used to gauge, measure, and probe.

• Factory Resources

Imports the groups and classes used to classify resources used in the NX Line Designer such as
conveyors or industrial components.

• Machining Data Library

Imports the groups and classes used to classify technology data such as feeds and speeds or
material tables.

• Manufacturing Process Templates

Imports the groups and classes used to classify manufacturing processes, operations, or
activities.

2. Click Next.

Teamcenter displays the Confirmation dialog box.

3. Confirm that all your selections are correct and then click Next.

Teamcenter installs the specified classification hierarchies.

Update the class hierarchy

When you are upgrading from an earlier Teamcenter version, Teamcenter checks whether you have
previously installed all or parts of the library during the Manufacturing Resource Library (MRL)

13-24 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Update the class hierarchy

installation. If you have done so, you can now choose to update older class hierarchies. Teamcenter
automatically checks whether first installation (database population) or an update is required for an
existing structure.

This procedure assumes you have completed the steps in Beginning the installation. The installation
wizard should currently display the Choose MRL Update Work Directory dialog box.

1. Specify the path for the MRL update files you are creating.

During the course of the update, Teamcenter creates script files for the update and stores them in
this directory.

2. Click Next.

Teamcenter displays the MRL Update Type Selection dialog box, where you must take action in
this sequence:

a. Select Export existing class hierarchy.

This step exports the class hierarchies that you want to update to the update directory you
specified.

A. Click Next.

Teamcenter displays the MRL Update Class Hierarchy for Modules dialog box, which
contains a list of the available hierarchies, with version information. For example:

The hierarchies that need to be updated are already selected.

Teamcenter Installation on Windows, Teamcenter 14.2 13-25

© 2022 Siemens
 13. Adding optional solutions

B. Select the hierarchies you want to update and click Next.

C. Confirm your selections and click Next.

Teamcenter exports the selected hierarchies to an EXPORT directory in the update

directory that you specified at the beginning of this procedure.

The installation wizard returns to the MRL Update Type Selection dialog box.

b. (Optional) Select Modify configuration file in a text editor to specify certain objects that are
not changed during the update process. Selecting this option allows you to modify the
MRL_Update_Configurationfile.xml. Although it is optional, if you choose to do it, you must
do this before moving to the next step. For more information see Configuring the update.

The MRL_Update_Configurationfile.xml is located here: D:\TC_Kits

\TC14.2\wntx64\advanced_installations\resource_management\MRL\conf\"

c. Select Compare your hierarchy to new class hierarchy.

This step compares the exported hierarchies to the corresponding hierarchy in the newest
MRL kit.

A. Click Next.

Teamcenter displays the MRL Update Class Hierarchy for Modules dialog box, which
contains only the hierarchies that you exported.

B. Select the hierarchies that you want to update and click Next.

C. Confirm your selections and click Next.

Teamcenter compares the selected hierarchies to the ones in the EXPORT directory and
creates individual update scripts with detailed information about what has changed in
the hierarchies. The scripts are stored in a new UPDATE directory in the update directory
that you specified.

When complete, the installation wizard returns to the MRL Update Type Selection
dialog box.

d. Select Update to new class hierarchy.

This step updates the hierarchies that you compared to the new hierarchies in the MRL kit.

A. Click Next.

13-26 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configuring the update

Teamcenter displays the MRL Update Class Hierarchy for Modules dialog box, which
contains only the hierarchies that you compared.

B. Select the hierarchies that you want to update and click Next.

C. Confirm that all your selections are correct and then click Next.

Warning:
The update requires an extended period of time. The length of time required
depends on the performance of your hardware.
Upgrading the tool classification hierarchy can take up to 20 hours.

Teamcenter does the following during the update:

• Adds new classes to the hierarchy

• Adds new attributes to classes in the hierarchy

• Updates class images and hierarchy icons

3. If necessary, remove obsolete classes manually.

Configuring the update

You can exclude some objects from the update by modifying the MRL_Update_Configurationfile.xml
configuration file found in the directory where you extracted the installer:

advanced_installations\resource_management\MRL\conf

You can modify this configuration file during the MRL update by selecting Compare your hierarchy to
new class hierarchy and then selecting Modify configuration file in a text editor. You must save
modifications before you execute the comparison because this file will be used during the compare step.

You can add attribute IDs to the section DoNotAddAttributes in the configuration file to only include
the attributes that you need. The DoNotAddAttributes section is empty by default.

<Configurationfile>
<!-- This file is used for the MRL update procedure -->

<!-- The following parameters configure what object types are processed -->
<ProcessDictionaryAttributes value="true"/>
<ProcessKeyLovs value="true"/>
<ProcessAdminClasses value="true"/>
<ProcessAdminViews value="true"/>

<!-- The following parameters configure whether the output files are generated. -->
<!-- Files in the INFO_FILES folder are always created. -->

Teamcenter Installation on Windows, Teamcenter 14.2 13-27

© 2022 Siemens
 13. Adding optional solutions

<WriteOutputTextfiles value="true"/>

<!-- The following parameters configure keylovs that will NOT be updated. -->
<IgnoreKeyLovs>
<KeyLov id="-40922"/> <!-- Tool: Material reference for NX-CAM -->
<KeyLov id="-40928"/> <!-- Tool: Machine Adapter to assign a pocket in
NX-CAM -->
<KeyLov id="-45210"/> <!-- Tool: Status (old) -->
<KeyLov id="-45211"/> <!-- Tool: Plant assignment (old) -->
<KeyLov id="-45212"/> <!-- Tool: Machine Group -->
<KeyLov id="-46001"/> <!-- Resource Status -->
<KeyLov id="-46002"/> <!-- Resource Location -->
<KeyLov id=" ---- Add your ID here ---- "/>
</IgnoreKeyLovs>

<!-- The following attributes will not be added to the classes or views -->
<DoNotAddAttributes>
<Attribute id="-40700"/>
<Attribute id="-40701"/>
<Attribute id="---- Add your ID here ----"/>
</DoNotAddAttributes>

<!-- The following parameters configure whether attribute groupings are updated -->
<Applicability1 update="true"/> <!-- NX-CAM related attributes -->
<Applicability2 update="true"/> <!-- Graphics creation related attributes -->
<Applicability3 update="true"/> <!-- GCS connection attributes -->
<Applicability4 update="false"/> <!-- User configurable attribute set -->
<Applicability5 update="false"/> <!-- User configurable attribute set -->

<!-- The following parameters configure whether the User1 and User2 class properties
are updated -->
<ClassUser1 update="true"/>
<ClassUser2 update="true"/>

<!-- The following parameters configure whether class icons and images are updated
-->
<Icon update="true"/>
<Image update="true"/>
<ICS-ClassImage1 update="true"/>
<ICS-ClassImage2 update="true"/>
<ICS-ClassImage3 update="true"/>
<ICS-ClassImage4 update="true"/>
<ICS-ClassImage5 update="true"/>
<ICS-ClassImage6 update="true"/>
<ICS-ClassImage7 update="true"/>
<ICS-ClassImage8 update="true"/>
<ICS-ClassImage9 update="true"/>
</Configurationfile>

Import or update rules and preferences

The following procedure assumes you have completed the steps in Beginning the installation. The
installation wizard should currently display the MRL Database Population: Import Rules and
Preferences dialog box.

1. Select the data that you want to import or update:

13-28 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Import MRL NX seed parts

• Update Teamcenter preferences for MRL

Installs all preferences required to install the Manufacturing Resource Library and configure its
behavior.

• Guided Component Search rules for tool components

Imports or updates rules that are used by the guided component search in Structure Manager.

• Import tool checking rules

Imports or updates rules used by the tool checker in Resource Manager.

• Import tool catalog vendor mapping

Imports or updates mapping rules required to map tool vendor data from the catalog to the tool
component classes.

2. Confirm that all your selections are correct and then click Next.

Teamcenter installs the specified rules and preferences.

Import MRL NX seed parts

The following procedure assumes you have completed the steps in Beginning the installation. The
installation wizard should currently display the MRL Database Population: Import MRL NX seed parts
dialog box.

1. Select the seed parts that you want to import or update:

• Template parts for Auto-Assembly

Imports the template part file used to build tool assemblies in Resource Manager.

• Template parts for STEP (GTC 3D model Import)

Imports the seed part used to import GTC STEP files for vendor catalog objects.

• Template parts for setup sheet creation

Imports sample drawing templates to generate resource setup sheets.

• Template parts for fixtures graphics creation

Teamcenter Installation on Windows, Teamcenter 14.2 13-29

© 2022 Siemens
 13. Adding optional solutions

Imports the template file used to create fixture graphics with the Tcl graphics method.

• Template parts for temporary tool retrieval

Imports the template required to extract tool holder data and system tracking points.

Caution:
If you have modified any of these objects, for example, created custom setup sheets,
importing or updating these objects overwrites your modifications.

2. Confirm that all your selections are correct and then click Next.

Teamcenter installs the specified seed parts.

Import 3D template parts

The following procedure assumes you have completed the steps in Beginning the installation. The
installation wizard should currently display the MRL Database Population: Import 3D Template Parts
dialog box.

1. Select one or more of the part family templates or template parts to import or update:

• Metric Template Parts (3D templates for Tools)

Imports metric template part files to generate 3D tool component graphics. These template parts
(TPs) are attached to the corresponding MRL tool component classes.

• Inch Template Parts (3D templates for Tools)

Imports inch template part files to generate 3D tool component graphics. These template parts
(TPs) are attached to the corresponding MRL tool component classes.

• Metric Part Family Templates (PFT for Factory Resources)

Imports part family templates (PFTs) and attaches them to the Factory Resources classes.

2. Select the item type with which each of the objects is imported into the database.

The item types you enter must already exist in the database. For a list of existing item types, move
the cursor into the dialog box and press F1. The item types that are requested depend on which
types of templates you elected to import in the previous step.

If you enter an item type, you must be aware of the name of the revision of this item. The name of
the revision consists of the item name appended by the word Revision, for example, MyItem
Revision. These two terms may or may not have a space between them. You must ascertain

13-30 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Import or update MRL sample resources

whether the revision has a space. If so, type “item_name ”. Note the empty space after the item
name, for example "MyItem ". If the item revision contains no spaces, such as ItemRevision, this is
not necessary, and you can simply type Item.

You must specify the internal item type. This name can be different from the displayed item type
name. The following table shows the default item types used by the installation.

Symbols
Internal Item display Typical
item type name usage
(item, item
revision)

Mfg0MENCTool NC Tool Tools (components, ,

assemblies)

Mfg0MEEquipment Equipment Factory resources ,

3. Click Next.

Teamcenter displays the Overwrite Existing Data dialog box.

4. Confirm that all your selections are correct and then click Start.

Teamcenter installs the specified classification hierarchies and data into your database.

Import or update MRL sample resources

This procedure assumes you have completed the steps in Beginning the installation. The installation
wizard should currently display the Load 'Sample Resource' for Module(s) dialog box.

1. Specify which sample data you want to load. You can choose from the following:

• Tools

Imports sample tool assemblies and tool components.

• Machines

Currently, sample machines are no longer delivered with the MRL kit.

Sample machines must be imported manually from the NX directory.

• Fixtures (New in MRL 6.0)

Imports sample fixture components.

Teamcenter Installation on Windows, Teamcenter 14.2 13-31

© 2022 Siemens
 13. Adding optional solutions

• Measuring Devices

Imports sample CMM (Coordinate Measuring Machines) and probing tools.

• Factory Resources

Imports sample records used for the Factory Resources classification.

• Factory Conveyors

Imports sample records used for the Factory Resources classification.

• Factory Robots

Imports sample records used for the Factory Resources classification.

• Factory Weld Guns

Imports sample records used for the Factory Resources classification.

• Machining Data Library

Imports technology data, such as materials and feeds and speeds records, for the Machining
Data Library.

2. Load the sample data for the specified modules by selecting the corresponding item type for each
module. The item types you select here must already exist in the database. For a list of existing
item types, move the cursor into the dialog box and press F1.

You must specify the internal item type. This name can be different from the displayed item type
name. The following table shows the default item types used by the installation.

Item Display Name Item-Type (Internal) Icons

Introduced in Version 8.3.0:

,
NC Tool Mfg0MENCTool

Typical usage: Tools (components and assemblies) used for CAM

Introduced in Version 8.3.0:

,
NC Machine Mfg0MENCMachine

Typical usage: Machines and robots used for CAM and CMM

13-32 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Import or update MRL sample resources

Item Display Name Item-Type (Internal) Icons

Introduced in Version 12.4.0:

,
CMM Probe Assembly PM0CMMProbeAssy

Typical usage: Probing tool assemblies used for CMM inspection

Introduced in Version 12.4.0:

,
CMM Probe Component PM0CMMProbeComp

Typical usage: Probing tool components used for CMM inspection

Introduced in Version 8.3.0:

,
Resource Mfg0MEResource

Typical usage: Fixtures and devices used for CAM

Introduced in Version 8.3.0:

,
Equipment Mfg0MEEquipment

Typical usage: Factory resources

Introduced in Version 10.0.0:

,
Robot Mfg0MERobot

Typical usage: Factory robots

Introduced in Version 10.1.3:

,
Conveyor Resource Mfg0Conveyor

Typical usage: Factory conveyors

Introduced in Version 11.4:

,
Factory Tool Mfg0MEFactoryTool

Typical usage: Factory tools such as Screwdriver and Weld Gun

Teamcenter Installation on Windows, Teamcenter 14.2 13-33

© 2022 Siemens
 13. Adding optional solutions

Item Display Name Item-Type (Internal) Icons

Introduced in Version 11.4:

,
Fixture Unit PM0NCFixture

Typical usage: Factory fixtures to locate an assembly in a station

3. Click Next.

Teamcenter displays the Overwrite Existing Data dialog box.

4. Confirm that all your selections are correct and then click Start.

Teamcenter installs the specified classification hierarchies and data into your database.

Import part family templates when you use custom item IDs

By default, the Manufacturing Resource Library installer creates items that are associated with the part
family template that have the same ID as the name of the part family template. If your company uses
custom IDs, you cannot use the installer to import the part family templates. You must import them
using scripts delivered with the software kit.

1. Locate the scripts in the following directory:

advanced_installations\resource_management\MRL\PartFamilyTemplates

2. Rename the part family templates located in the Parts subdirectory to reflect your custom item IDs.

3. Adjust the PFT_3_Sample_TC101_assign_pfts.bat script to reflect the new IDs.

4. Adjust the PFT_MRL_import_one_pft.bat script and specify the correct user, password, and group.

5. Run the PFT_0_MRL_PartFamily_Templates.bat script to install the part family templates with the
new IDs.

Install localization data for MRL

Use this procedure to populate the Teamcenter database with a translated version of the Manufacturing
Resource Library.

Before you begin installation, make sure you have the latest available version of the Manufacturing
Resource Library. If a later version is available, download and extract the latest version and browse to
the advanced_installations directory in the location of the extracted files.

13-34 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configure NX Library using the installation wizard

For information about later versions, see Support Center.

1. In the advanced_installations directory in the Teamcenter software kit, locate the

advanced_installations.zip file and unzip it to a local directory.

2. In the resource_management directory, click Setup.exe.

Teamcenter displays the Teamcenter Configuration Setup dialog box.

3. Click Next.

Teamcenter displays a notification that you must check for the most recent version of the resource
library.

4. Click Next.

Teamcenter displays the Setup Type Selection dialog box.

5. Select Manufacturing Resources - Localization and click Next.

Teamcenter displays the Choose TC_ROOT Directory dialog box.

6. Select the path to your Teamcenter installation and click Next. The path must point to an existing
installation.

Teamcenter displays the Choose TC_DATA Directory dialog box.

7. Select the path to the directory containing the database-specific data files and click Next. The path
must point to an existing TC_DATA directory.

8. Enter the user name, password, and group of the valid Teamcenter administrative logon account
and click Next.

9. Select the languages for which you want to make the Manufacturing Resource Library available,
and then click Next.

10. Confirm your selections and click Next.

Teamcenter populates the database with localized classification structures for the selected
languages.

Configure NX Library using the installation wizard

When you install the manufacturing tooling data, you must configure NX Library so that the new data
appears in the library selection dialog boxes when searching for classified tools in NX CAM.

Teamcenter Installation on Windows, Teamcenter 14.2 13-35

© 2022 Siemens
 13. Adding optional solutions

You must perform this configuration on the client on which NX is installed. If your environment includes
a shared MACH directory, see Configure NX Library when using a shared MACH directory.

Before you begin installation, make sure you have the latest available version of the Manufacturing
Resource Library. If a later version is available, download and extract the latest version and browse to
the advanced_installations directory in the location of the extracted files.

For information about later versions, see Support Center.

1. In the advanced_installations directory in the Teamcenter software kit, locate the

advanced_installations.zip file and unzip it to a local directory.

2. In the resource_management directory, click Setup.exe.

Teamcenter displays the welcome dialog box for the Manufacturing Resource Library installer.
Proceed to the Setup Type Selection dialog box.

3. Select Configure NX-CAM.

Teamcenter displays the NX CAM Resource Base Directory dialog box.

4. Enter the path to the directory where NX is installed (UGII_BASE_DIR) and click Next.

5. In the operating system explorer window, select the CAM configuration you want to configure for
MRL. The default file is cam_part_planner_mrl.dat.

Teamcenter displays the LANGUAGE Selection dialog box.

6. Select the language in which you want the NX Library selection dialog boxes to appear and click
Next. English and German are supported.

Teamcenter displays the Configure NX Library for Tools dialog box.

7. Select the database to be used by the NX tool library.

This option specifies whether tools are retrieved from the Teamcenter MRL tool database or from
the tool ASCII file. If you select No change, the existing setting for tools in the CAM configuration
file is retained (LIBRARY_TOOL entry).

Teamcenter displays the Configure NX Library for Machines dialog box.

8. Select the database to be used by the NX machine library.

This option specifies whether machines are retrieved from the Teamcenter MRL machines database
or from the machines ASCII file. If you select No change, the existing setting for machines in the
CAM configuration file is retained (LIBRARY_MACHINE entry).

13-36 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configure NX Library using the installation wizard

Teamcenter displays the Configure NX Library for Devices dialog box.

9. Select the database to be used by the NX device library.

This option specifies whether devices are retrieved from the Teamcenter MRL devices database or
from the devices ASCII file. If you select No change, the existing setting for devices in the CAM
configuration file is retained (LIBRARY_DEVICE entry).

Teamcenter displays the Configure NX Library for Machining Data dialog box.

10. Select the database to be used by the NX machining data library.

This option specifies whether machining data is retrieved from the Teamcenter MRL machining
data database or from the machining data ASCII file. If you select No change, the existing setting
for machining data in the CAM configuration file is retained (LIBRARY_MACHINING DATA entry).

Machining data includes the following libraries:

• Feeds_speeds

• Machining_data

• Tool_machining_data

• Part_material

• Tool_material

• Cut_method

Teamcenter displays the Confirmation dialog box.

11. Confirm your selections and click Start.

Teamcenter performs the following actions:

• Copies the definition files to the target directory.

• Copies event handler files to the target directory.

• Copies the images for the NX CAM tool dialogs to the target directory.

12. Select the cam_part_planner_mrl.dat configuration file when working in NX CAM.

When you retrieve a tool from the Teamcenter database in NX CAM, the library selection dialogs
now show the classification structure from the customer assembly hierarchy, including images

Teamcenter Installation on Windows, Teamcenter 14.2 13-37

© 2022 Siemens
 13. Adding optional solutions

corresponding to the new tooling data. You can search for and retrieve your customer-specific tool
assembly data.

Configure NX Library when using a shared MACH directory

If your enterprise installs NX using a shared MACH directory, there are several steps that you must
perform manually. These steps mirror the steps automatically performed by the Configure NX Library
using the installation wizard procedure performed when you use a local MACH directory.

This procedure pertains to the following files:

MACH\resource\configuration\cam_part_planner_mrl.dat

MACH\resource\library\tool\inclass\dbc_mrl_tooling_library_tlas.tcl

MACH\resource\library\tool\inclass\dbc_mrl_tooling_library_tlas_en.def

MACH\resource\ug_library\dbc_mrl_general.tcl

1. Create a copy of your cam_part_planner_library.dat file and rename it to

cam_part_planner_mrl.dat.

2. Change the following line in the cam_part_planner_mrl.dat file:

Old:

LIBRARY_TOOL,${UGII_CAM_LIBRARY_TOOL_INCLASS_DIR}dbc_inclass_tlas.def,
${UGII_CAM_LIBRARY_TOOL_INCLASS_DIR}dbc_inclass_tlas.tcl

New:

LIBRARY_TOOL,${UGII_CAM_LIBRARY_TOOL_INCLASS_DIR}dbc_mrl_tooling_library_tlas_en.def,
${UGII_CAM_LIBRARY_TOOL_INCLASS_DIR}dbc_mrl_tooling_library_tlas.tcl

If you use a customized configuration file at your company, make the change in the customized file
and continue to use this file to initialize NX CAM.

3. Copy the following files to your MACH\resource\library\tool\inclass\ directory.

dbc_mrl_tooling_library_tlas.tcl
dbc_mrl_tooling_library_tlas_en.def

4. Copy dbc_mrl_general.tcl to MACH\resource\ug_library.

5. When you initialize NX CAM, use the modified cam_part_planner_mrl.dat file or the customized
configuration file that you modified in step 2.

13-38 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configure the graphics builder for MRL

Configure the graphics builder for MRL

To use the following features in Teamcenter, you must configure the NX graphics builder:

• Part family member creation

• NX auto assembly

• 3D model import for catalog data

• Check NX CAM tool retrieve in MRL

• Extract Holder Data

Prerequisites:

• The graphics builder must be installed on the Teamcenter server. This is the server that runs the
tcserver process.

• The mrl_retrieve_camsetup_metric or mrl_retrieve_camsetup_inch NX part file item must be

imported using the Template parts for temporary tool retrieval option. You can search for an item
with this ID to check the existence of this file.

• The ...\MACH\resource\configuration\ directory of the NX installation that resides on the Teamcenter

server where the graphics builder is installed must contain the cam_part_planner_mrl.dat file. This
file points to the dbc_mrl_tooling_library_tlas.tcl event handler file required for graphics creation.
The event handler file must be up-to-date. You can copy the most recent file by setting the tool
database to MRL when you complete the Configure NX Library using the installation wizard
procedure.

The following procedure installs the graphic macros on the server where the graphics builder is installed.

1. Obtain the Manufacturing Resource Library software kit.

2. Click Setup.exe.

Teamcenter displays the Setup Type Selection dialog box.

3. Select Configure Fixture TCL Graphic Macros.

4. Click Next.

Teamcenter displays the Choose TC_ROOT Directory dialog box.

5. Select the path to your Teamcenter installation and click Next. The path must point to an existing
installation.

Teamcenter Installation on Windows, Teamcenter 14.2 13-39

© 2022 Siemens
 13. Adding optional solutions

Teamcenter displays the Choose TC_DATA Directory dialog box.

6. Select the path to the directory containing the database-specific data files and click Next. The path
must point to an existing TC_DATA directory.

7. Enter the user name, password, and group of a valid Teamcenter administrative logon account.

The plmxml_import utility uses this logon information to import the data into the Teamcenter
database.

8. Click Next.

Teamcenter displays the Choose MRL Graphic Macros Directory dialog box containing the default
path to store graphic macros.

The installation procedure modifies the NXGraphicsBuilder preference and copies required files
into Teamcenter directories (TC_ROOT\bin\nx_graph\TCL_Create_Graphics).

9. Verify that this path is the correct path or modify it by clicking Browse.

Teamcenter displays the Confirmation dialog box.

10. Click Start.

Teamcenter copies the graphic macros to the database and modifies the NXGraphicsBuilder
preference.

Upgrading from an earlier MRL version

In addition to the steps outlined above, it is advised that you:

• use the MRL graphics builder to copy the latest ics_graphicsbuilder.tcl file.

Configure MRL Connect

MRL Connect allows native NX users to retrieve cutting tool assemblies from the Manufacturing
Resource Library (MRL) in Teamcenter. New tools must be created in the library using Teamcenter.

Prerequisites:

• A Teamcenter four-tier server installation must exist.

• Teamcenter client communication system (TCCS) must be installed on the machine running NX.

• Java Runtime Environment (JRE) must be installed on the machine running NX.

13-40 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configure MRL Connect

• The Manufacturing Resource Library must be populated on the Teamcenter server.

• The manufacturing preferences in NX CAM must point to a configuration file that has been set up for
Resource Manager access, for example, the cam_native_rm_library.dat configuration file provided
with NX.

Before you begin installation, make sure you have the latest available version of the Manufacturing
Resource Library. If a later version is available, download and extract the latest version and browse to
the advanced_installations directory in the location of the extracted files.

For information about later versions, see Support Center.

To configure MRL on the computer running NX:

1. In the advanced_installations directory in the Teamcenter software kit, locate the

advanced_installations.zip file and unzip it to a local directory.

2. In the resource_management directory, click Setup.exe.

Teamcenter displays the Teamcenter Configuration Setup dialog box.

3. Click Next.

Teamcenter displays a notification that you must check for the most recent version of the resource
library.

4. Click Next.

Teamcenter displays the Setup Type Selection dialog box.

5. Select Configure MRL Connect.

6. Select MRL Connect for NX - Configure environment on NX Client.

This option creates the command file start_nx_using_mrl_connect.bat in the location user-profile
\MRLConnect, for example:

C:\Users\login_username\MRLConnect\start_nx_using_mrl_connect.bat

7. Enter the path to the NX base directory.

8. Enter the path to the directory where FMS is locally installed.

9. Enter the path to the Java Runtime Environment.

Teamcenter Installation on Windows, Teamcenter 14.2 13-41

© 2022 Siemens
 13. Adding optional solutions

10. Enter server name and port number of the Teamcenter server.

This information is used to build the NX environment variable on the NX client.

Tip:
Ask your Teamcenter installer for the port number.

11. Check your selections and complete the installation.

MRL Connect supports only the retrieval of tools from MRL into NX CAM.

Machines, devices, feeds and speeds data, machining data, cut methods, part materials, and tool
materials are not supported. Those modules should use ASCII, not MRL, in the configuration file.

Installing Teamcenter Reporting and Analytics

Before you begin

Download the Teamcenter Reporting and Analytics software kit for Windows from the Siemens Digital
Industries 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 kit.

After you complete these steps and install Reporting and Analytics, you can begin using the Reporting
and Analytics integration in Report Builder.

Create the Reporting and Analytics database

Reporting and Analytics requires an Oracle or Microsoft SQL Server database for Reporting and Analytics
metadata. Your database administrator must create this database before you launch Teamcenter
Environment Manager (TEM) to install Reporting and Analytics.

TEM creates the required table structure for Reporting and Analytics, but the database user and
tablespaces must exist before you install Reporting and Analytics. Metadata tables are divided into three
categories based on the number of rows they will hold and the growth potential. These tables can be
stored in the same tablespace or in separate tablespaces for better performance and manageability.
Siemens Digital Industries Software recommends creating the following tablespaces:

13-42 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Configure the Reporting and Analytics license file

Tablespace Description

Small Typical number of rows 1000. Minimum size 50MB Growth is very slow.

Medium Typical number of rows 10000. Minimum size 150MB Growth is Slow.

Large Typically 1000000 rows or more. Minimum size 500MB Growth very rapid
with usage.

Indexes Typically 1000000 rows or more. Minimum 400MB.

For more information about creating the metadata database for Reporting and Analytics, see Planning
for Installation in the Teamcenter Reporting and Analytics Deployment Guide for the current version of
Reporting and Analytics.

Configure the Reporting and Analytics license file

Reporting and Analytics requires an eQube license file (license.dat) on the host where the Reporting
and Analytics license server runs. TEM requires the location of the license file to install the Reporting
and Analytics license server during Reporting and Analytics installation.

The Reporting and Analytics license server uses the host's MAC address to identify the host. You must
supply this information when you request a Reporting and Analytics license file from eQ Technologic.

For information about starting the Reporting and Analytics license server, see the Teamcenter Reporting
and Analytics Deployment Guide in the Reporting and Analytics software kit.

Install Reporting and Analytics

1. Launch TEM.

2. Create a new Teamcenter configuration or select an existing configuration to which you want to
add Reporting and Analytics.

In the Features panel, select the following features:

Teamcenter for Reporting and Analytics

Installs the Teamcenter Reporting and Analytics integration.

Reporting and Analytics is a standalone reporting application that introduces a new folder in
Report Builder called TcRA Reports, which contains reports created with Reporting and
Analytics.

Dashboard

Teamcenter Installation on Windows, Teamcenter 14.2 13-43

© 2022 Siemens
 13. Adding optional solutions

Installs the Reporting and Analytics Dashboard application for the rich client. Dashboard
provides an embedded viewer for Reporting and Analytics reports in the rich client.

3. Proceed to the TcRA Install Options and General Settings panel. Select one or more of the
following options to include in your Reporting and Analytics installation:

Create license server Specifies you want to install a Reporting and Analytics
license server. If you select this option, TEM later prompts
for the location of the eQube license file (license.dat). If
you do not select this option, TEM later prompts for the
location of the Reporting and Analytics license server.

Create WAR file Specifies you want to generate a Reporting and Analytics
WAR file.

Create metadata Specifies you want to populate the metadata database for
Reporting and Analytics. Select this only during the first
installation of Reporting and Analytics. If you are upgrading
from a previous version of Reporting and Analytics or
adding additional hosts, do not select this option.

Secure Connection Specifies you want to connect to the Reporting and

Analytics license server through a secure (HTTPS)
connection.

The remaining sequence of TEM panels varies according to the options you select.

For more information about any TEM panel, click the help button .

4. Enter the required information in TEM for the selected Reporting and Analytics options.

Selected option TEM panel Tasks

Create license TcRA License Server Settings Enter the location of the Reporting and
server Analytics license file (license.dat), the license
authentication time-out in seconds, and
license keystore settings for the Reporting and
Analytics license server.

Create WAR file TcRA WAR Settings Type the web application context, server
name, and port for the Reporting and Analytics
web application.

Create WAR file TcRA WAR SMTP Properties Specify SMTP settings to enable users to
receive e-mail messages generated by
Reporting and Analytics.

Create WAR file TcRA Web Parts and Services Specify whether to enable web services and
integration with SharePoint and Teamcenter

13-44 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Install Remote Reporting and Analytics

Selected option TEM panel Tasks

community collaboration with Reporting and

Analytics.

Create WAR file TcRA Authentication Settings Select the Reporting and Analytics
authentication method (eQube, SSO, or
Windows NTLM) and specify related settings.
Selecting SSO Authentication requires that
you install Teamcenter with Security Services
enabled and configure the LDAP server before
you install Reporting and Analytics.

Create WAR file TcRA License Settings Type the host and port of the Reporting and
Analytics license server.

Create WAR file TcRA WAR and Metadata Type an owner for Reporting and Analytics
Settings metadata and select your web application
Create metadata
server vendor.
or

Create metadata TcRA Metadata Settings Specify metadata settings for the Reporting
and Analytics integration.
The values you type under Oracle Tablespace
Names must match the names of the Oracle
tablespaces you created in Create the
Reporting and Analytics database.

Any option TcRA Database Selection Specify the database engine you use for
Reporting and Analytics (Oracle or Microsoft
SQL Server) and type the required values for
the Reporting and Analytics database you
created in Create the Reporting and Analytics
database.

5. Proceed through the remaining TEM panels and begin installing Reporting and Analytics.

During installation, TEM prompts you for the location of the TCRA2008.zip file.

When installation is complete, close TEM.

Install Remote Reporting and Analytics

Install Remote Reporting and Analytics as described in Deploying Remote Teamcenter Reporting and
Analytics Plugin in the Teamcenter Reporting and Analytics Deployment Guide.

The Teamcenter Reporting and Analytics Deployment Guide is in the Documentation directory in the
Teamcenter Reporting and Analytics software kit.

Teamcenter Installation on Windows, Teamcenter 14.2 13-45

© 2022 Siemens
 13. Adding optional solutions

Deploy Reporting and Analytics

Before you deploy the Reporting and Analytics WAR file, make sure that Remote Reporting and Analytics
is installed and running.

For more information, see Deploying Remote Teamcenter Reporting and Analytics Plugin in the
Teamcenter Reporting and Analytics Deployment Guide.

The Teamcenter Reporting and Analytics Deployment Guide is in the Documentation directory in the
Teamcenter Reporting and Analytics software kit.

Deploy the Reporting and Analytics WAR file as described in the Teamcenter Reporting and Analytics
Deployment Guide in the Reporting and Analytics software kit.

Complete Reporting and Analytics installation

1. Set the TC_RA_server_parameters preference using the rich client. Set the preference with
following values:

Value Description

Host Specifies the host on which you deploy the Reporting

and Analytics WAR file.

Port Specifies the port used by the Reporting and Analytics

web application.

Context Specifies the name of the Reporting and Analytics WAR

file

ServletName Specifies the name of the Reporting and Analytics

servlet, for example, BuildNPlay/
eQTCnectIntegrationController.

This preference must be set to enable Reporting and Analytics to communicate with Teamcenter.

2. Test connections to Reporting and Analytics applications. Log on to Reporting and Analytics at the
following URLs and click Test Connections:

Teamcenter Reporting and Analytics Mapper:

http://host:port/Reporting and Analytics-context/Mapper

Teamcenter Reporting and Analytics BuildNPlay:

http://host:port/Reporting and Analytics-context/BuildNPlay

13-46 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Complete Reporting and Analytics installation

Reporting and Analytics Portal:

http://host:port/Reporting and Analytics-context/Portal

If connections are not successful, you cannot create reports in Reporting and Analytics until
connection problems are resolved.

For more information about Reporting and Analytics Mapper and BuildNPlay, see the Mapper User's
Guide and the BuildNPlay User's Guide in the Reporting and Analytics software kit.

3. Log on to the Reporting and Analytics administrative console using user name ADMIN and
password ADMIN.

Click Manage Instance→Properties, and then set the following values as appropriate:

• SMTP Host

• Authentication required for SMTP (Set to True or False)

• SMTP User ID

• SMTP User Password

4. If Reporting and Analytics is installed with Security Services enabled, set the following values for
the Teamcenter connection (Connection 1):

• Set the user ID and password values to the LDAP user ID and password.

• Under Advanced Properties, set SSO Enabled to yes, and set the SSO Application ID to the
Teamcenter application ID.

Teamcenter Installation on Windows, Teamcenter 14.2 13-47

© 2022 Siemens
 13. Adding optional solutions

13-48 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 14. Complete the Teamcenter server
installation
Start database daemons

If you select Teamcenter database daemon features during Teamcenter installation, Teamcenter
Environment Manager (TEM) configures the database daemons to start automatically as Windows
services. After installation, you can find these services in the Services dialog box in the Windows
Control Panel:

Teamcenter Action Manager Service

Teamcenter Subscription Manager Service
Teamcenter Revision Configuration Accelerator Service
Teamcenter Task Monitor Service
Teamcenter Tesselation Manager Service
Teamcenter Workflow Remote Inbox Sync Service
Teamcenter Shared Metadata Cache Service

If the services do not start automatically, see the available troubleshooting solutions.

Each service behaves as follows:

1. After the services are started, a program runs in TC_ROOT\bin named tc_server.exe.

Windows displays tc_server.exe in the task manager. If you do not see this process, either your
registry entry for that service is corrupted (specifically the path to the image) or the file is not on
the system.

2. The tc_server.exe program identifies the service that launched it by examining the service name.
It expects the service name to contain either actionmgrd, subscripmgrd, task_monitor, or
tess_server. The default service names for Teamcenter are tc_actionmgrd, tc_subscripmgrd,
tc_taskmonitor, and tc_tess_server. These services are defined in \HKEY_LOCAL_MACHINE
\SYSTEM\CurrentControlSet\Services.

3. The tc_service.exe program assembles a .bat file name by prefixing the service name with run_
and appending the extension of .bat. For example, the tc_actionmgrd service has the file name
run_tc_actionmgrd.bat.

4. The tc_service.exe program calls the .bat file (created by the setup program during configuration
and placed in the \bin directory of the Teamcenter application root directory).

5. The task manager displays the process, for example, actionmgrd.exe.

If the process is not displayed in the task manager, either the service name is not one of the three
supported names, the .bat file for the process does not exist, or the process executable is missing.

Teamcenter Installation on Windows, Teamcenter 14.2 14-1

© 2022 Siemens
 14. Complete the Teamcenter server installation

6. The Services dialog box is updated to Started.

Configure heterogeneous operating system environment

If you are adding Windows Teamcenter clients to a Linux Teamcenter environment, you must perform
the following tasks:

1. Install Teamcenter and configure the database (Teamcenter application root and data directories)
on a Windows system that can serve a common mount point for all Windows clients.

This allows the Windows and non-Windows Teamcenter clients to interoperate, particularly in
volume management.

2. Synchronize the following files in the separate Teamcenter data directories:

• POM schema files (TC_DATA\pom_schema_server_sid)

• POM transmit files (\pom_transmit\*.sch)

• Dataset definition files (TC_DATA\gs_info\*.des)

3. Make sure your Windows and Linux server configurations contain identical sets of Teamcenter
features. For example, if you install features or custom templates on a Linux server, you must
install the same features and templates on your Windows server.

4. Configure File Management System (FMS) on Linux and Windows volume servers.

Conversely, if you create a Teamcenter database by running the Teamcenter setup program from a
Windows workstation, you must install Teamcenter on Linux clients you want to connect to the
database.

14-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Part IV: Deploy the Teamcenter
Environment
When you have satisfactorily configured and validated your
Teamcenter test environment, you are ready to deploy to
your environment as a production environment.
When you make your Teamcenter environment with Active
Workspace available to users, you may want to deploy
localized versions of Teamcenter , and also explore options
for large-scale deployment of clients to connect to your
environment.
For information about deploying to a production
environment and other deployment options with
Deployment Center, see the Deployment Center Guide .
Also, see the Teamcenter Deployment Reference
Architecture, available on Support Center, for further
guidance and examples for development, test, and
production environments.

Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
Teamcenter Installation on Windows, Teamcenter 14.2
© 2022 Siemens
 15. Deploying localized versions of
Teamcenter
Deploying rich client localizations

Deploy rich client localizations

If you change the strings of a localized rich client user interface, you must convert the files to Unicode
and regenerate the Java archive (JAR) file.

To identify the localized user interface files you need, look for the language and country identifier added
to the base resource file. For example, for the aif_locale.properties English resource file, which must
remain in English, the equivalent Japanese file is named aif_locale_ja_JP.properties.

Convert native .properties files to Unicode as follows:

1. Copy the base file to a temporary file name, for example, from aif_locale.properties to
aif_locale_temp.properties.

2. Edit the base_locale_temp.properties file, modifying the values to the correct native language.

3. Save the file.

4. Run the native2ascii utility against the temporary properties file to convert it to a Unicode
properties file.

The native2ascii utility is in the \bin directory of Java SDK 1.4.

For more information, access the following URL:

http://download.oracle.com

For example, to convert the properties file from Japanese to Unicode, enter the following
command from the command line:

native2ascii -encoding SJIS aif_locale_temp.properties aif_locale_ja_JP.properties

The final locale-specific properties file or the output of the native2ascii file must have the
base_locale_locale-id_language-id.properties file format.

The rich client finds the value of a key in the following order:

BASE_user.properties
BASE_locale-ID_language-ID.properties

Teamcenter Installation on Windows, Teamcenter 14.2 15-1

© 2022 Siemens
 15. Deploying localized versions of Teamcenter

BASE_locale.properties
BASE.properties

5. Recompile the JAR file.

6. Install fonts if necessary.

For information about fonts, see the Oracle Java web site.

For more information about converting files to Unicode, see the Unicode Consortium web site:

http://www.unicode.org/

Display Siemens Digital Industries Software-provided rich client localizations

To display a Siemens Digital Industries Software-provided localized rich client user interface, set the
locale of the client workstation to one of the Siemens Digital Industries Software-provided locales. No
other steps are required.

In addition to English, Siemens Digital Industries Software provides the Teamcenter rich client user
interface localized for the following languages:

• Chinese (Simplified)
• Chinese (Traditional)
• Czech
• French
• German
• Italian
• Japanese
• Korean
• Polish
• Portuguese (Brazilian)
• Russian
• Spanish

Update rich client localized text

If you change the strings of a localized rich client user interface, you must convert the files to Unicode
and regenerate the Java archive (JAR) file.

To identify the localized user interface files you need, look for the language and country identifier added
to the base resource file. For example, for the aif_locale.properties English resource file, which must
remain in English, the equivalent Japanese file is named aif_locale_ja_JP.properties.

Convert native .properties files to Unicode as follows:

15-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Choose a display language

1. Copy the base file to a temporary file name, for example, from aif_locale.properties to
aif_locale_temp.properties.

2. Edit the base_locale_temp.properties file, modifying the values to the correct native language.

3. Save the file.

4. Run the native2ascii utility against the temporary properties file to convert it to a Unicode
properties file.

The native2ascii utility is in the \bin directory of Java SDK 1.4.

For example, to convert the properties file from Japanese to Unicode, enter the following
command from the command line:

native2ascii -encoding SJIS aif_locale_temp.properties aif_locale_ja_JP.properties

The final locale-specific properties file or the output of the native2ascii file must have the
base_locale_locale-id_language-id.properties file format.

The rich client finds the value of a key in the following order:

BASE_user.properties
BASE_locale-ID_language-ID.properties
BASE_locale.properties
BASE.properties

5. Recompile the JAR file.

6. Install fonts if necessary.

For information about fonts, see the Oracle Java web site.

For more information about converting files to Unicode, see the Unicode Consortium web site:

http://www.unicode.org/

Configuring client display language

Choose a display language

The default language displayed is the one specified by your operating system locale settings. You can
choose to override the default display language if required.

At each logon, you can choose between multiple languages, depending on your company's policy and
installation. There are two ways you can specify the language:

Teamcenter Installation on Windows, Teamcenter 14.2 15-3

© 2022 Siemens
 15. Deploying localized versions of Teamcenter

• Specify the language in the URL. For example:

• To specify French, type http://myhost:7001/tc/webclient?lang=fr in the URL.

• To specify Russian, type http://myhost:7001/tc/webclient?lang=ru in the URL.

When specifying a language in the URL, use standard W3C locale identifiers.

If your network uses IPv6 (128-bit) addresses, use the hostname in URIs and do not use the literal
addresses, so the domain name system (DNS) can determine which IP address should be used.

• Specify the language in your browser preferences. For example, in Microsoft Internet Explorer,
perform the following steps:

1. Choose Tools → Internet options....

2. Click Languages in the Internet Options dialog box.

3. Click Add in the Language Preference dialog box.

4. Click any language in the Add Language dialog box.

5. Click OK in the Add Language dialog box.

6. Click the language you want to see in the user interface in the Language Preference dialog box.

7. Click the Move Up button.

The language you move to the top of the list in the Language Preference dialog box is the
language you see in the user interface.

8. Click OK in the Language Preference dialog box.

9. Click OK in the Internet Options dialog box.

10. Log on and view the user interface in the language you chose.

An error message is displayed if the specified language is unavailable.

Your ability to set the language for the client depends on the character set encoding of the Teamcenter
server host and also the character set encoding of the Teamcenter database.

To prevent mixed-language display after you change the client display language, clear your web browser
cache. This prevents the interface from displaying in mixed languages.

You can also configure language display during Teamcenter installation.

15-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Choose a display language for the rich client

Choose a display language for the rich client

By default, the rich client is displayed in the language specified by the operating system. If you want to
override the default language, you can choose the display language for the rich client.

Your ability to set the language for the rich client depends on the character set encoding of the
Teamcenter server host and also the character set encoding of the Teamcenter database.

If you want to override the default language to launch the rich client in a desired language, add the -nl
argument to the rich client launch command:

TC_ROOT\portal.bat -nl locale-code

Replace TC_ROOT with the Teamcenter home directory, and replace locale-code with the desired locale
code.

For example, to launch the rich client Italian user interface, enter the following from a command
prompt:

D:\tc\rac\portal.bat -nl it_IT

Alternatively, on Windows systems, you can customize the properties for the Teamcenter rich client
desktop shortcut icon to specify a desired language:

1. On your desktop, right-click the Teamcenter rich client shortcut icon .

2. Choose Properties.

A properties dialog box is displayed.

3. Click the Shortcut tab.

4. In the Target box, add an -nl argument to specify the desired language.

The -nl argument accepts a single string as value. The string must be one of the supported locale
codes.

For example, to run the rich client Italian user interface:

D:\tc\rac\portal.bat

becomes:

D:\tc\rac\portal.bat -nl it_IT

Teamcenter Installation on Windows, Teamcenter 14.2 15-5

© 2022 Siemens
 15. Deploying localized versions of Teamcenter

Note:
To prevent mixed-language display the next time you run the rich client after you change the -nl
argument value, or after you change your operating system locale, delete the Teamcenter
directory under your user directory (C:\Documents and Settings\user-name\Teamcenter).

If you find that Asian multibyte characters do not display correctly when you start the rich client, set
your system font to a font that supports Asian multibyte characters. For example, on Windows systems
other than Windows 10, the Arial Unicode MS font can be set to Message Box to correct this problem.

Similarly, if you find that Asian multibyte characters do not display correctly when you start the rich
client using the native language (-nl) option, restart your system in the appropriate locale and set your
system font to a font that supports Asian multibyte characters.

Caution:
If you use the Lifecycle Visualization embedded viewer, do not use the -nl argument when you
launch the rich client.
For the embedded viewer to work properly, the operating system locale and the rich client runtime
locale must match. The -nl argument overrides the Java locale and can cause incorrect behavior in
the embedded viewer.

Choose the default language for the Teamcenter server process

Teamcenter server (TcServer) processes and other Teamcenter processes, and Teamcenter command-
line utilities, start in the language specified in the TC_language_default environment variable. To make
these display in a different preferred locale, set the TC_language_default environment variable to a
supported locale code.

Teamcenter allows users to select a locale on their client hosts, regardless of the locale used by the
Teamcenter server pool manager. Requested locales must be installed on the Teamcenter server (which
may not be true for customized locales) and the server system be configured to accept the locale
encoding.

Add multibyte character support in an English rich client

1. In the rich client \rac\plugins\configuration_config-name directory, create the

customer.properties file, if it does not already exist.

Do not save the customer.properties file in Unicode or UTF-8 format. The customer.properties
file must be in the default format (for example, ANSI) to be read successfully by the rich client.

2. Open the customer.properties in a plain text editor.

3. Add the following line to the file to set the UseDefaultSwingFonts property.

15-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Add multibyte character support in an English rich client

UseDefaultSwingFonts=true

4. Save the file and exit the text editor.

5. Change to the rac\registry directory.

6. Run the genregxml.bat utility to register the change.

When you run Teamcenter in a multibyte environment, make sure the TC_XML_ENCODING
environment variable is set to UTF-8 and the UGII_UTF8_MODE environment variable is set to 1.

Teamcenter Installation on Windows, Teamcenter 14.2 15-7

© 2022 Siemens
 15. Deploying localized versions of Teamcenter

15-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 16. Creating a custom distribution
Overview of custom distributions

Teamcenter supports the following custom distributions to simplify installation of Teamcenter on

multiple hosts.

• Silent distribution

A silent distribution is an XML-based configuration file you can use to install Teamcenter silently
(without user interaction) on another host. Silent installation suppresses most installation prompts
and requires minimal user interaction. As an alternative to installing and configuring Teamcenter on
individual hosts in your network, silent installation provides an efficient way to deploy Teamcenter on
multiple hosts in your network.

The silent installation configuration file records the selections and values you enter during a
Teamcenter installation and enables TEM to perform these steps noninteractively on other hosts. You
can modify a silent configuration file to change certain Teamcenter settings before installation.

Silent distributions are supported for Teamcenter servers, two-tier rich clients, and four-tier rich
clients.

• Compact distribution

A compact distribution is an installable package with a selected subset of Teamcenter client features.
It is much smaller than a full Teamcenter software kit and is more easily distributed to multiple hosts
in an organization.

A compact distribution is an alternative to installing Teamcenter from a full Teamcenter software kit.
A compact deployable package can contain a selected subset of Teamcenter features rather than the
entire set of features in the release. This reduces network loads and simplifies large-scale Teamcenter
deployments by providing an installation package that is smaller and more easily distributed to an
organization. For example, a two-tier rich client installation can be packaged in a deployable media as
small as 580 MB, where a full Teamcenter distribution can require up to 5 GB. A four-tier rich client
compact distribution can be as small as 283 MB, and a Client for Office compact distribution can be
only 93 MB.

Compact distributions are supported for Teamcenter two-tier and four-tier rich clients.

Create a silent distribution

Create a silent installation configuration file

1. Log on to the Teamcenter corporate server host and browse to the root directory of the
Teamcenter software kit.

Teamcenter Installation on Windows, Teamcenter 14.2 16-1

© 2022 Siemens
 16. Creating a custom distribution

2. Start Teamcenter Environment Manager (tem.bat) from the Teamcenter software kit. Right-click
the tem.bat program icon and choose Run as administrator.

3. In the Welcome to Teamcenter panel, select Teamcenter.

4. In the Install/Upgrade Options panel, select the Create custom distribution check box, and
then click Install.

5. In the Custom Distribution Options panel, select Create silent configuration file, and then
specify the path to the silent installation file, for example, C:\silent.xml. The specified path must
be to an existing directory and the file name must end in .xml.

6. Proceed through the remaining panels to complete the Teamcenter installation.

Teamcenter Environment Manager creates the silent installation file you specified in step 5. This
file records your settings and selections during the installation. You can use this file to silently
install Teamcenter on another host with the same settings.

Teamcenter Environment Manager creates a silent installation file (.xml) and a decryption key file
(.dat) with the name you specified in step 5, for example, silent.xml and silent.dat. To reproduce
your installation on another host, copy both of these files to the target machine, then install the
rich client silently.

Caution:
If you install a rich client silently using a compact distribution and your silent configuration file
requires features not included in the compact distribution, the silent installation fails. To avoid
this, make sure your silent configuration requires only features in the compact distribution, or
install using a full Teamcenter software kit.

Launch a silent installation

To launch a silent installation, type the following command:

tem.bat -s file-name.xml

Replace file-name with the name of the silent installation configuration file.

After installation is complete, you can view a log of the installation in the installxxx.log file under the
install directory in the Teamcenter application installation directory.

The rich client can be uninstalled only through the TEM interface. Silent uninstallation is not supported.

16-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Modify the silent installation configuration file

Modify the silent installation configuration file

The silent installation configuration file is XML-based. After creating the file and establishing the file
structure using Teamcenter Environment Manager, you can change the installation by manually
modifying the values of the XML elements described in the following table.

Caution:
Use an XML editor to ensure well-formed XML code. Do not change the XML structure of the file. If
XML file structure is incorrect, or the XML code is not well-formed, installation fails.

Element Description

features Lists all the Teamcenter modules and features to be installed. These are
selected on the Features panel of Teamcenter Environment Manager.

feature Specifies one feature of a Teamcenter module. The code attribute

identifies the feature. To define whether Teamcenter Environment
Manager installs the feature, set the selected attribute to either true or
false.

data Lists all Teamcenter Environment Manager Java classes and values
defining aspects of installation, such as the path to the installation
directory for Teamcenter application files. For additional information, see
the comments in the configuration file. The comments describe the class
and valid values.

Teamcenter Installation on Windows, Teamcenter 14.2 16-3

© 2022 Siemens
 16. Creating a custom distribution

Sample silent installation configuration file

<?xml version="1.0" encoding="UTF-8"?>

<root>
<tem engine="2008.0.0" />
<settings>
<installDir value="C:\\Program Files\\Siemens\\Teamcenter14.2" />
<sourceDir value="D:\\kits\\tc14.2\\win64" />
<application value="tceng" />
<silentMaintenance value="false" />
<installingUser value="osuser" />
<installLanguage value="ENGLISH" />
<aboutFullVersion value="14.2" />
<version value="12000.1.0.20181207" />
</settings>
<sourceLocations>
<coreLocations>
<directory value="D:/kits/tc14.2/win64" />
</coreLocations>
<browsedLocations />
</sourceLocations>
<config name="My Configuration 1" id="config1">
<mode type="install" clone="false">
<checkpoints>
<checkpoint value="featureProperties">
<point value="vcruntimes:vc2005,latest" />
<point value="minMSSQL2005Version:10.50" />
<point value="coreTemplate:foundation_template.xml" />
<point value="feature_id:datamodel,rtserver" />
<point value="vcruntimes:latest" />
<point value="template_file:foundation_template.xml" />
<point value="minDB2Version:9.7.4" />
<point value="minOracleVersion:11.2.0.1" />
<point value="template_name:foundation" />
<point value="typeAnalysis:true" />
</checkpoint>
</checkpoints>
</mode>
<comments />
<data>
<adminUser guid="2E53CFC3AC75665E50FF0F207D1D013B">
<password value="holrvg6fpj40nGt7ZlCM2Q" encrypt="true" />
<user value="tcdba" />
</adminUser>
<director guid="661AA2A766CA975D998EBE61455F3EA3">
<saveStateOnFail value="true" />
<status value="0" />
<script>
<temBase />
<copyFeature name="Microsoft Visual C++ Runtimes"
feature="A0CF69C3A0BC61770EB81BD22667EA52" />
<copyFeature name="Business Modeler IDE"
feature="A9CECD82127A11DB9804B622A1EF5492" />
<copyFeature name="VC 2008 Redistributables"
feature="DPBL8RC6MUS0LCPS10NIPGR85RI7HPHQ" />
<copyFeature name="Teamcenter File Services"
feature="BC76F9D1AB7C93A848D0FE3602F59097" />
<copyFeature name="Flex License Server"

16-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Modify the silent installation configuration file

feature="D1D683A8B2CE1EB821B97CD2EE5D7627" />
<copyFeature name="VC 2005 Redistributables"
feature="UDR4NG0DEZ1TN9XHKG7Z8AFDPVVTZXL2" />
<copyFeature name="VC 2013 Redistributables"
feature="NJCMQH3ZMYTPPPGA8BS4Q1C7OV6IXVXU" />
<copyFeature name="VC 2010 Redistributables"
feature="R08U30BA5KZYSNDFKMGXKKHWEYOOVD7V" />
<copyFeature name="VC 2012 Redistributables"
feature="Z9ICW073V9QXU4H5F8BK6CXG6KFYWBQZ" />
<copyFeature name="Business Modeler Templates"
feature="A909338A1CB411DB8AF6B622A1EF5492" />
<copyFeature name="Digital Dashboard"
feature="A9CECD82127A11DB9804B622A1EF5599" />
<copyFeature name="FMS Server Cache"
feature="90C2A1C96F6A61FAB397AF88ABE4AAC1" />
<copyFeature name="Teamcenter Foundation"
feature="8C061DD51E13E0CB9DC4687B1A3348BE" />
<copyFeature name="NX Part Family Classification Integration"
feature="B176F6B6E9E91D9804EFB0D2
010FD613" />
<copyFeature name="Server Manager" feature="BF0E78AFE4280DCB08594EA2F3671BE8" />
.
.
.
<unpack name="Microsoft Visual C++ Runtimes"
feature="A0CF69C3A0BC61770EB81BD22667EA52" />
<unpack name="FMS Server Cache" feature="90C2A1C96F6A61FAB397AF88ABE4AAC1" />
<unpack name="Teamcenter Foundation"
feature="8C061DD51E13E0CB9DC4687B1A3348BE" />
<unpack name="NX Part Family Classification Integration"
feature="B176F6B6E9E91D9804EFB0D2010FD
613" />
<preInstall name="Microsoft Visual C++ Runtimes"
feature="A0CF69C3A0BC61770EB81BD22667EA52" />
<preInstall name="FMS Server Cache" feature="90C2A1C96F6A61FAB397AF88ABE4AAC1" />
<preInstall name="Teamcenter Foundation"
feature="8C061DD51E13E0CB9DC4687B1A3348BE" />
<preInstall name="NX Part Family Classification Integration"
feature="B176F6B6E9E91D9804EFB0D20
10FD613" />
<install name="Microsoft Visual C++ Runtimes"
feature="A0CF69C3A0BC61770EB81BD22667EA52" />
<install name="FMS Server Cache" feature="90C2A1C96F6A61FAB397AF88ABE4AAC1" />
<install name="Teamcenter Foundation"
feature="8C061DD51E13E0CB9DC4687B1A3348BE" />

<install name="NX Part Family Classification Integration"

feature="B176F6B6E9E91D9804EFB0D2010F
D613" />
<postInstall name="Microsoft Visual C++ Runtimes"
feature="A0CF69C3A0BC61770EB81BD22667EA52" />
<postInstall name="FMS Server Cache"
feature="90C2A1C96F6A61FAB397AF88ABE4AAC1" />
<postInstall name="Teamcenter Foundation"
feature="8C061DD51E13E0CB9DC4687B1A3348BE" />
<postInstall name="NX Part Family Classification Integration"
feature="B176F6B6E9E91D9804EFB0D2
010FD613" />

Teamcenter Installation on Windows, Teamcenter 14.2 16-5

© 2022 Siemens
 16. Creating a custom distribution

<featureInstalled name="Microsoft Visual C++ Runtimes"

feature="A0CF69C3A0BC61770EB81BD22667EA5
2" />
<featureInstalled name="FMS Server Cache"
feature="90C2A1C96F6A61FAB397AF88ABE4AAC1" />
<featureInstalled name="Teamcenter Foundation"
feature="8C061DD51E13E0CB9DC4687B1A3348BE" />
<featureInstalled name="NX Part Family Classification Integration"
feature="B176F6B6E9E91D9804E
FB0D2010FD613" />
</script>
</director>
<FSCService guid="F2FCBCEC03DFF7F9D1E3A11EC9B64BD2">
<fscReadCacheDir value="$HOME\\FSCCache" />
<fscWriteCacheDir value="$HOME\\FSCCache" />
<addToBootstrap value="true" />
<fscReadCacheSize value="10" />
<serverID value="FSC_tchost_osuser" />
<log value="" />
<fscWriteCacheSize value="10" />
</FSCService>
<FSCMasterSettings guid="EBC3422F77C6BF18FE0E3A821EFE1134">
<masterModel value="Simple Model" />
</FSCMasterSettings>
<FscSiteImport guid="630BECF927EC742A748A97486D5868DA">
<remoteSites value="" />
</FscSiteImport>
<tcdata guid="4500621E2BE24BF0DD6ABF31EBA01088">
<serverHostLocation value="tchost" />
<path value="C:\\Program Files\\Siemens\\tcdata" />
<create value="true" />
<shareName value="" />
<dsmKeyPath value="" />
</tcdata>
<FSCServiceFCCDefaults guid="7311DC5E94724BED0DD7419FCDE055CF">
<writeCacheSize value="1000" />
<readCacheSize value="1000" />
<cacheDirUnix value="/tmp/$USER/FCCCache" />
<partialReadCacheSize value="3000" />
<cacheDirWin value="$HOME\\FCCCache" />
</FSCServiceFCCDefaults>
<FccSite guid="35EE6A66B85467D5EDE5B3D91871EACE">
<siteListString value="" />
</FccSite>
<FSCServiceConnections guid="E4BDA0B521CB10A49F0CE123C9F326F1">
<connections value="http,4544,;" />
</FSCServiceConnections>
<OSUser guid="CA769D31FD7E122E5E509A0BBBD7E809">
<password value="+rfq6mTJVSuqaYJixkwntg" encrypt="true" />
<user value="DOMAIN\\osuser" />
</OSUser>
<flexClient guid="7221ECFBC9555CDF997FC3F575022761">
<nX5String value="28000@flexhost" />
<port value="27000" />
<nX4String value="27000@flexhost" />
<nX5Port value="28000" />
<host value="flexhost" />
<nX5Host value="flexhost" />
<nX5CheckBox value="true" />
<envServerString value="28000@flexhost" />

16-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Modify the silent installation configuration file

</flexClient>
<signatureCertificate guid="RRK3WTCSY4020QSZO90QFJWMISFAC2AX">
<replaceCerts value="false" />
<certificates value="" />
</signatureCertificate>
<foundationSettings guid="LHBY67ZYMYHSKED26FHDNDHFJTZD84I7">
<templatesToBeInstalled value="" />
<genClientCache value="generate all" />
<genServCache value="" />
<productionEnvironment value="true" />
<requestMetaCacheRebuild value="true" />
<enableGenServCache value="true" />
<quickClone value="false" />
</foundationSettings>
<transientVolume guid="983980098FF188A8C4BF08E8168A32A8">
<windowsVolume value="C:\\Temp\\transientVolume_tcdbuser" />
<unixVolume value="/tmp/transientVolume_tcdbuser" />
</transientVolume>

<TcOracleSystem guid="1EF0859AC04962CBFA41C4C8C84499A1">
<password value="WsRDrEfD0/4vnLO0/mj2wA" encrypt="true" />
<user value="system" />
<tablespaces
value="tcdbuser_IDATA:90;tcdbuser_ILOG:5;tcdbuser_INDX:5;tcdbuser_TEMP:5;tcdbuser_MM
V:5" />
<tablespacePath value="/db/oradata/tc/tcdbuser" />
</TcOracleSystem>
<security guid="ZUG63OE2YRNFD1VY13KCEZM52XFJP45D">
<adminDirectory value="$TC_ROOT\\security" />
</security>
<volume guid="1F16971107DE44C0C7827F800EE4AEF8">
<port value="4544" />
<fscModel value="Simple Model" />
<location value="C:\\Program Files\\Siemens\\volume" />
<name value="volume" />
<hostName value="tchost" />
<fscId value="FSC_tchost_osuser" />
</volume>
<TcOracleEngine guid="F4F7C0852B27D6E56B8C64BE77FFA14C">
<port value="1521" />
<createUser value="true" />
<host value="dbhost" />
<flush value="false" />
<populate value="true" />
<service value="tc" />
<uTF8Enabled value="true" />
<password value="AdxT7Jmz2/WbYF6O/eqX9g" encrypt="true" />
<user value="tcdbuser" />
<create value="true" />
</TcOracleEngine>
</data>
<features>
<add feature="A0CF69C3A0BC61770EB81BD22667EA52" name="Microsoft Visual C++
Runtimes" />
<add feature="90C2A1C96F6A61FAB397AF88ABE4AAC1" name="FMS Server Cache" />
<add feature="8C061DD51E13E0CB9DC4687B1A3348BE" name="Teamcenter Foundation" />
<add feature="B176F6B6E9E91D9804EFB0D2010FD613" name="NX Part Family
Classification Integration"

Teamcenter Installation on Windows, Teamcenter 14.2 16-7

© 2022 Siemens
 16. Creating a custom distribution

/>
</features>
</config>
<updateManager />
</root>

Create a compact distribution

Creating a compact distribution is supported only in Teamcenter major releases. It is not supported in
minor releases, so the Create compact deployable media check box is disabled in Teamcenter
Environment Manager (TEM).

16-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Part V: Maintain the Teamcenter
Environment
You add components to Teamcenter configurations using
Teamcenter installation tools. Some components require
additional steps to install or configure. See the appropriate
topics for the components you want to install.

Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
Teamcenter Installation on Windows, Teamcenter 14.2
© 2022 Siemens
 17. Back up new installations
Siemens Digital Industries Software strongly recommends backing up new Teamcenter and Oracle
installations before using them.

Terminate Teamcenter sessions

1. Instruct all users to check in all Teamcenter business objects, and then close and log off of
Teamcenter sessions, including tcserver processes.

2. Open a Teamcenter command prompt:

From the Start menu, choose Programs→Teamcenter, and open a command prompt.

Replace version with the Teamcenter version.

3. Use the clearlocks utility to remove locks on the database:

%TC_BIN%\clearlocks -assert_all_dead -u=Tc-Oracle-user

-p=Tc-Oracle-user-password -g=dba

4. Stop all Teamcenter services, including FMS.

Back up existing Teamcenter data

Back up the following directories:

• The Teamcenter application root directory on each installed workstation

• The Teamcenter data directory for each configured database

• The Teamcenter volume directories for each configured database

These are the only directories affected by Teamcenter installation. If you created other directories that
contain data used by your existing Teamcenter installation, such as a separate POM transmit schema
directory, Siemens Digital Industries Software recommends that you back up these directories as a
precautionary measure.

Back up Teamcenter databases

Back up your Oracle server and databases:

1. Export existing Oracle databases.

2. Terminate Teamcenter-Oracle sessions.

Teamcenter Installation on Windows, Teamcenter 14.2 17-1

© 2022 Siemens
 17. Back up new installations

3. Back up the Oracle installation.

17-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 18. Manage environments
Managing environments

The process for managing Teamcenter environments depends on whether you use Deployment Center
or Teamcenter Environment Manager (TEM). The terminology and scope also vary according to the tool
you use:

• Deployment Center

Deployment Center manages environments from a central machine, and generates scripts and
software packages for multiple machines. Deployment Center tracks the software components
installed on each machine.

In Deployment Center, selecting Teamcenter software to install primarily involves selecting

applications, packages of administration data, software modules, and parameters that add specialized
functionality to the Teamcenter environment. When you select applications, Deployment Center
automatically selects the components required to support the selected applications. Components are
the architectural pieces of Teamcenter, such as servers, services, and databases.

You select applications in the Applications task. You select and configure components in the
Components task.

You can designate which machines host each component from a single instance of the Deployment
Center web application. Deployment scripts supply machine information to components that
communicate with each other.

• TEM

TEM is run on individual machines, and the Teamcenter administrator tracks what software
components are installed on each machine.

In TEM, applications and components are called features. Some feature groups like Base Install and
Server Enhancements contain components.

You select features (applications and components) in the Features panel.

TEM refers to a collection of features that share a common Teamcenter data directory as a
configuration. You can install multiple configurations on a single machine that share the same
Teamcenter application root directory.

Run TEM on every machine where you install components. Record information about each machine to
enter in configurations on other machines to enable components to communicate.

Teamcenter Installation on Windows, Teamcenter 14.2 18-1

© 2022 Siemens
 18. Manage environments

Caution:
If you create a desktop shortcut to TEM, make sure the working directory (or Start in location) for
the shortcut is TC_ROOT\install. If the working directory for the shortcut is incorrect, TEM displays
errors during installation or updating of a configuration.

Creating an environment

Create an environment in Deployment Center

You can create an environment for your planned deployment. When you are ready to add software to
your new environment, Deployment Center displays only the versions of Available Software that are
supported in a new environment.

Create an environment

1. Log on to Deployment Center, and click ENVIRONMENTS.

The Environments page lists currently planned and registered environments.

2. On the far right below the command bar, click Add .

3. The new environment appears highlighted in the list. Choose Overview to display its information.

4. You can edit some of the properties, such as Name and Type. On the command bar:

Click Start Edit to edit properties. To save your changes, click Save Edits .

To cancel your changes, click Cancel Edits .

You can also choose to export the configuration of an existing environment. You can reuse its
configuration to create another environment using the quick deployment procedure.

Create a configuration in TEM

When you installed Teamcenter executables using Teamcenter Environment Manager (TEM) from the
software kit, you created the first configuration.

You can modify features in an existing configuration, or create an additional Teamcenter

configuration in your existing TEM instance:

1. Launch Teamcenter Environment Manager (TEM). In the Windows start menu, choose
Programs→Teamcenter 14, and then right-click Environment Manager and choose Run as
administrator.

18-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Register an environment in Deployment Center

Alternatively, you can run the tem.bat file in the install directory in the application root directory
for the Teamcenter installation. Right-click the tem.bat program icon and choose Run as
administrator.

Note:
If you create a desktop shortcut to TEM, make sure the working directory (or Start in
location) for the shortcut is TC_ROOT\install. If the working directory for the shortcut is
incorrect, TEM displays errors during installation or updating of a configuration.

2. In the Maintenance panel, choose Configuration Manager.

3. In the Configuration Maintenance panel, choose Create new configuration.

4. In the Configuration panel, type a description and unique ID for the new configuration.

5. In the Solutions panel, optionally select one or more solutions.

For a description of a solution, point to the solution name in TEM or see the solutions reference.

6. In the Features panel, select features to include in the configuration.

For a description of a feature, point to the feature name in TEM or see the features reference.

7. Proceed through the remaining panels in TEM, entering the required information for the features
you selected.

For information about each panel, click the help button .

8. When TEM displays the Confirmation panel, click Start to begin installation.

Register an environment in Deployment Center

If you created an environment using Teamcenter Environment Manager (TEM) but want to manage it in
Deployment Center, register your environment in Deployment Center.

Register your environments in Deployment Center by running the send_configuration_to_dc utility on

the corporate server that hosts each Teamcenter environment. If the environment is distributed across
multiple servers, you must run the script on each machine that is part of the specific Teamcenter
environment. The script sends configuration information about the applications and components that
are currently installed to Deployment Center.

After the environment is registered, you can view its configuration information and verify the content.
Deployment Center stores information about server machines deployed in your environments.

Teamcenter Installation on Windows, Teamcenter 14.2 18-3

© 2022 Siemens
 18. Manage environments

• View the machines used in deployed Teamcenter environments from the MACHINES tile on the
Deployment Center home page.

• Select a machine from a list of servers when configuring components.

Caution:
Before updating an existing registered Teamcenter environment, be sure that you run the
send_configuration_to_dc script to update the environment information. Configuration changes
performed locally on Teamcenter servers since the last time the send_configuration_to_dc script
ran could be overwritten.

1. On the machine hosting the Teamcenter environment, install the supported version of the JRE and
set JAVA_HOME to the location.

2. If it's not already set, open a command prompt window, and set the TC_ROOT environment
variable to the Teamcenter installation directory

3. From the location where you installed Deployment Center, navigate to additional_tools
\send_configuration_to_dc directory and find send_configuration_to_dc.zip. Copy and then
unzip the file. Place the extracted directory on the machine hosting the Teamcenter environment.

4. In the command prompt window on the Teamcenter server, navigate to the

send_configuration_to_dc directory. Run send_configuration_to_dc.bat (Windows) or
send_configuration_to_dc.sh (Linux) using the following arguments.

-dcurl (required)

Specify the URL for the Deployment Center server you want to use.

-dcusername (required)

Specify the user name for the Deployment Center administrator as defined when installing
Deployment Center.

-dcpassword OR -dcpasswordfile (required)

Specify the password for the Deployment Center administrator. You can specify the password
as text or use an encrypted password or password file. If the password file path contains
spaces, enclose it in quotes.

-environment (required)

Specify a name to identify the environment being scanned. Because an environment is

ordinarily identified by its site ID, this argument allows you to create a readable label that
makes it easier to identify the Teamcenter environment.

18-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Register an environment in Deployment Center

-config (optional)

Specify the ID value for the configuration used when installing the Teamcenter environment.
Specify this argument if multiple configurations are installed in a single TC_ROOT location.

Example:
send_configuration_to_dc.bat -dcusername=dcadmin
-dcpasswordfile="E:\admin passwords\dcadmin.pwf"
-dcurl=http://dc_host:9000/deploymentcenter
-environment=Sandbox

After the scan completes, the script returns the message:

All operations completed successfully.

You can then review the environment in Deployment Center.

Java EE web tier component configuration

Because Web Application Manager (insweb) is a separate tool from Teamcenter Environment Manager,
send_configuration_to_dc is unable to scan Web Application Manager files. As a result, the Teamcenter
Java EE web tier component configuration is not returned with the environment scan. After the scan is
complete, you need to add the Java EE web tier component to the environment.

1. Log on to Deployment Center and go to the Environments page. Select the environment you
scanned from the list.

2. On the Deploy Software tab, navigate to the Components task. Look for the Teamcenter Web
Tier (Java EE). Add it to the Selected Components if it's not already present.

3. In the Selected Components list, choose Teamcenter Web Tier (Java EE) and enter the
configuration settings for the web tier from the original environment. If you are unsure about these
settings, you can find them using either of these methods:

• In the Web Application Manager, select your web application and click Modify. Then review the
web application information in Modify Web Application.

• Review the .dat files in the staging location for your web application. For example, find
WEB_ROOT\staging1 on the machine where you run the Web Application Manager.

4. Save your settings. Review the remaining Selected Components to make sure they are all 100%
complete.

If you experience other problems in registering environments with Deployment Center, see the
Deployment Center Guide..

Teamcenter Installation on Windows, Teamcenter 14.2 18-5

© 2022 Siemens
 18. Manage environments

Adding applications and components

Add applications

Add applications using the tool you use to manage your Teamcenter environment, Deployment Center
or Teamcenter Environment Manager (TEM).

Installing applications requires the following general steps in the given tool:

Step Deployment Center TEM

1. Select applications. Select in the Applications task. Select in the Features panel.
2. Select dependent Selected automatically. Select dependent components to
components. enable features for selection.
3. Enter parameter Enter values in the Components Enter values in the sequence of panels.
values. task.
4. Deploy software. Generate deploy scripts in the Click Start in the Confirmation panel.
Deploy task, and then run scripts on Repeat steps on other affected
affected machines. machines.

See the following detailed steps for installing applications in Deployment Center or TEM.

Deployment Center

Select the Applications task to choose applications. The list of available applications is determined by
the software you selected in the Software task. Some applications are automatically selected based on
your Selected Software. For example, if you choose Active Workspace, the Selected Applications list
includes applications that are required for an Active Workspace installation.

1. In Deployment Center, select your existing environment.

2. In the Applications task, click Add or Remove Selected Applications .

The Available Applications panel displays the available applications.

3. In Available Applications, choose the applications to install. If an application has dependent

applications, Deployment Center automatically selects those additional applications.

4. Click Update Selected Applications to add them to the Selected Applications list.

18-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Add applications

The added applications show Pending Install status in the Selected Applications list.

To remove an application that is not yet installed, deselect the application in the Available
Applications list, and then click Update Selected Applications.

5. When your Selected Applications list is complete, go to the Components task.

6. In the Components task, note any components whose configuration status is not 100%. These are
either dependent components for your selected applications or components with parameters
added by your selected applications.

For each component, enter required parameter values, and then click Save Component Settings.

Enter required parameter values until all components in the environment show a configuration
status of 100%.

7. Go to the Deploy task. Click Generate Install Scripts to generate deployment scripts to update
affected machines. When script generation is complete, note any special instructions in the Deploy
Instructions panel.

8. Locate deployment scripts, copy each script to its target machine, and run each script on its target
machine.

For more information about running deployment scripts, see the Deployment Center Guide.

TEM

1. Launch Teamcenter Environment Manager. In the Windows start menu, click

Programs→Teamcenter 14, and then right-click Environment Manager and choose Run as
administrator.

Alternatively, you can run the tem.bat file in the install directory in the application root directory
for the Teamcenter installation. Right-click the tem.bat program icon and select Run as
administrator.

2. In the Maintenance panel, choose Configuration Manager.

3. In the Configuration Maintenance panel, choose Perform maintenance on an existing

configuration.

4. In the Old Configuration panel, select the configuration you want to modify.

5. In the Feature Maintenance panel, select Add/Remove Features.

Options in the Feature Maintenance panel vary depending on the features in your configuration.

Teamcenter Installation on Windows, Teamcenter 14.2 18-7

© 2022 Siemens
 18. Manage environments

6. In the Features panel, select applications to add to the configuration.

If an application has dependent components, you must first select those components to enable the
application. Hover over the application name in the feature list to display the required components
below the feature list. Find and select the required components to enable the desired application,
and then select the application.

To find an application or component by name, enter a search string in the Search box in the
Features panel, and then click the search button.

For information about an application, see the list of Teamcenter features.

7. Proceed through the remaining panels in TEM, entering the required parameters for the
applications you selected.

For information about each panel, click the help button .

8. When TEM displays the Confirmation panel, click Start to begin installation.

Can I remove an application after it is installed?

In Deployment Center, removing an installed application is not supported.

In TEM, you can attempt to remove an installed application from your configuration by deselecting its
feature in the Features panel, and then proceeding through the remaining panels to update the
configuration.

If you remove a feature that added data model objects to the Teamcenter database, the data model is
not removed when you remove the feature. Relations and objects created using the removed feature
persist in the database.

If no instances of the feature's data model objects were created in the database, you can attempt to
remove the template.

Add components

Add components using the tool you use to manage your Teamcenter environment, Deployment Center
or Teamcenter Environment Manager (TEM).

Installing components requires the following general steps in the given tool:

18-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Add components

Step Deployment Center TEM

1. Select components. Select in the Components task. Select in the Features panel.
2. Enter parameter Enter values in the Components task. Enter values in the sequence of
values. panels.
3. Deploy software. Generate deploy scripts in the Deploy Click Start in the Confirmation panel.
task, and then run scripts on affected Repeat steps on other affected
machines. machines.

See the following detailed steps for installing components in Deployment Center or TEM.

Deployment Center

You select components to install in the Components task in Deployment Center.

Some components are automatically selected based on your selections in the Software and
Applications tasks. The list of components available for installation is also determined by your
selections in the Software and Applications tasks. For example, some components require a
corresponding application to be selected before the component is made available. Some components
are allowed only a single instance within an environment, so if a component is already installed, it may
not be in the list of available components.

Configuration parameters for some components may require server names, user names, passwords,
URLs, and other system information you may have previously entered for other components in your
environment. When you add components, some parameters may be prepopulated with those values
from other components. Some prepopulated values may not be editable. For example, in a single box
environment, Machine Name and OS may not be editable.1

Some parameters may provide dropdown lists of values from which you can choose. For example, in a
distributed environment, the Machine Name field for a component may provide a selection list of
machine names already defined in your environment.

1. In Deployment Center, select your existing environment.

2. In the Components task, click Add component to your environment to add components.

The Available Components panel displays the available optional components.

1 If you selected the Single Box environment type in the Options task, all Teamcenter components must reside on the
same machine.

Teamcenter Installation on Windows, Teamcenter 14.2 18-9

© 2022 Siemens
 18. Manage environments

3. In Available Components, select the components to install. Then click Update Selected
Components to add them to the Selected Components list.

In Selected Components, the COMPLETE column displays the configuration status for each
component. If all required parameters are entered for a component, its completion status is 100%.

4. Click a component in the list to display its parameters in the right panel. This panel initially displays
only required parameters. You must enter values for settings that appear in required parameters
view. You can toggle the view between required parameters and all parameters:

Show all parameters

Required parameters view displays only required parameter information. Click to

expand the view to display both required and optional parameters.

Show only required parameters

All parameters view displays both required and optional parameter information.
Click to collapse the view to required parameters.

18-10 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Add components

5. For each component, enter required parameter values, and then click Save Component Settings.

If you don't have values for all required parameters, you can save your settings at any time and
return to finish them. However, the Deploy task is disabled until all components in the
environment show a configuration status of 100%.

6. When all components are fully configured, go to the Deploy task. Click Generate Install Scripts to
generate deployment scripts to update affected machines. When script generation is complete,
note any special instructions in the Deploy Instructions panel.

7. Locate deployment scripts, copy each script to its target machine, and run each script on its target
machine.

Teamcenter Installation on Windows, Teamcenter 14.2 18-11

© 2022 Siemens
 18. Manage environments

For more information about running deployment scripts, see the Deployment Center Guide.

If you want to remove a component, you can do so, provided that the component is optional and you
have not generated deployment scripts that include the component.

To remove a component from the Selected Components list:

1. Click the component you want to remove.

2. From the command bar, click Remove . (This option is displayed only for components that are
eligible for removal.)

Deployment Center prompts you to confirm deletion of the component and its dependent
components.

Dependent components that were added to the environment with the main component are also
removed for the same machine. Other components of the same type are not removed. For
example, if you have two server pools, removing one server pool removes its dependents but the
other server pool remains.

TEM

In TEM, adding components involves the same steps as adding applications.

1. Launch Teamcenter Environment Manager. In the Windows start menu, click

Programs→Teamcenter 14, and then right-click Environment Manager and choose Run as
administrator.

Alternatively, you can run the tem.bat file in the install directory in the application root directory
for the Teamcenter installation. Right-click the tem.bat program icon and select Run as
administrator.

2. In the Maintenance panel, choose Configuration Manager.

3. In the Configuration Maintenance panel, choose Perform maintenance on an existing

configuration.

4. In the Old Configuration panel, select the configuration you want to modify.

5. In the Feature Maintenance panel, select Add/Remove Features.

Options in the Feature Maintenance panel vary depending on the features in your configuration.

6. In the Features panel, select components to add to the configuration.

18-12 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Migrate TEM to a different JRE

If a component has dependent components, you must first select those components to enable the
desired component. Hover over the component name to display the required components, find and
select the required components, then select the component.

To find a component by name, enter a search string in the Search box in the Features panel, and
then click the search button.

For information about a component, see the list of Teamcenter features.

7. Proceed through the remaining panels in TEM, entering the required parameters for the
components you selected.

For information about each panel, click the help button .

8. When TEM displays the Confirmation panel, click Start to begin installation.

Migrate TEM to a different JRE

The Java Runtime Environment (JRE) used by Teamcenter and Teamcenter Environment Manager (TEM)
is set by TEM during Teamcenter installation. If you upgrade or install a new JRE, you must migrate
Teamcenter to the new JRE using TEM.

Caution:
Do not remove your previous JRE until after you complete migrating Teamcenter to the new JRE. If
you removed your old JRE before performing this procedure, problems or error messages may
occur, and TEM fails to start.

To change the JRE used by Teamcenter and TEM, perform the following steps.

1. If you changed the password for the Teamcenter administrative user after you installed the FMS
server cache (FSC) service, update the logon credentials for the FSC service to specify the current
password.

2. Start Teamcenter Environment Manager (TEM). From the Start menu, choose All
Programs→Teamcenter 14→Environment Manager, then right-click and choose Run as
administrator.

Alternatively, you can run the tem.bat file in the install directory in the application root directory
for the Teamcenter installation.

3. In the Maintenance panel, select Migrate Teamcenter to another JRE and then click Next.

4. The Migrate Teamcenter to another JRE panel lists Teamcenter services that depend on the JRE
and must be shut down before the migration can begin.

Teamcenter Installation on Windows, Teamcenter 14.2 18-13

© 2022 Siemens
 18. Manage environments

After you make sure these services are shut down, select All features from the above list have
been shut down, and then click Next.

5. In the JRE Location panel, enter the path to the JRE you want Teamcenter to use.

Depending on the features in your configuration, TEM may prompt you for the operating system
user password.

Caution:
Make sure you specify a 64-bit JRE.

6. In the Confirmation panel, click Start to migrate Teamcenter to the specified JRE.

If you encounter problems migrating Teamcenter to the new JRE, see the available troubleshooting
solutions.

18-14 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 19. Manage databases
Migrate a non-CDB database to a CDB database

Teamcenter supports Oracle's multitenant database architecture if you use Oracle 12c or later. A
multitenant architecture is deployed as a Container Database (CDB) with one or more Pluggable
Databases (PDB).

A Container Database (CDB) is similar to a conventional (non-CDB) Oracle database, with familiar
concepts like control files, data files, undo, temp files, redo logs, and so on. It also houses the data
dictionary for objects owned by the root container and those that are visible to databases in the
container.

A Pluggable Database (PDB) contains information specific to the database itself, relying on the container
database for its control files, redo logs and so on. The PDB contains data files and temp files for its own
objects, plus its own data dictionary that contains information about objects specific to the PDB. From
Oracle 12.2 onward a PDB can and should have a local undo tablespace.

You can migrate a non-CDB database to a CDB database using Oracle tools. The following example
illustrates the database architectures before and after migration.

Teamcenter Installation on Windows, Teamcenter 14.2 19-1

© 2022 Siemens
 19. Manage databases

Teamcenter supports CDB and non-CDB databases. Be aware that Oracle has deprecated support for
non-CDB databases and may discontinue support after Oracle 19c.

If you migrate a non-CDB Teamcenter database to a CDB database, you must perform the migration
after you upgrade to Teamcenter 14.2.

Add an existing Teamcenter database using TEM

You can add a Teamcenter database to an installation by creating a configuration that references an
existing Teamcenter data directory and its configured database. A data directory is associated with one
(and only one) database instance.

1. Launch Teamcenter Environment Manager. In the Windows start menu, choose

Programs→Teamcenter 14, and then right-click Environment Manager and choose Run as
administrator.

19-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Add an existing Teamcenter database using TEM

Note:
You can also run the tem.bat file in the install directory in the application root directory for
the Teamcenter installation. Right-click the tem.bat program icon and choose Run as
administrator.

2. In the Configuration Maintenance panel, select Add new configuration.

3. In the Configuration panel, enter a description of and unique ID for the configuration you are
creating.

4. Proceed to the Features panel. Select the Teamcenter Foundation feature only and specify an
installation directory for the new configuration the Installation Directory box. The installation
directory must not already exist on your system. (TEM creates the directory.)

5. In the Foundation panel, select Use populated database and existing data directory and enter
the full path to the existing data directory in the Data Directory Location box.

6. In the Data Directory box, enter a location for the Teamcenter data directory. The directory must
exist.

The Teamcenter data directory is called the TC_DATA directory. This value is stored in the TC_DATA
environment variable on your system. TEM creates shared data subdirectories and files in this
location.

Do not set TC_DATA in the system environment. TEM sets this variable as required in various
scripts. Setting this variable in the operating system can cause conflicts if you install more than one
configuration.

7. In the Teamcenter Administrative User panel, enter the password for the Teamcenter
administrator.

Caution:
The password must not be empty nor contain any whitespace characters such as space, tab,
newline, carriage return, form feed, or vertical tab.
In addition, the password must not contain any of the following characters:

!@$%=&'"^:;._<>(){}

8. In the Confirmation panel, review your selections and click Start to add the database.

Teamcenter Installation on Windows, Teamcenter 14.2 19-3

© 2022 Siemens
 19. Manage databases

Add a new database using TEM

You can simultaneously configure a Teamcenter database and add it to an installation by creating a new
configuration. Because you are configuring a database, you must also install and configure File
Management System and create a data directory.

Prerequisites:

• A database server must be installed (Microsoft SQL Server or Oracle).

• A database instance must exist, either a specific instance configured for Teamcenter or a
multipurpose instance to be configured in this procedure.

1. Launch Teamcenter Environment Manager. In the Windows start menu, choose

Programs→Teamcenter 14, and then right-click Environment Manager and choose Run as
administrator.

Note:
Alternatively, you can run the tem.bat file in the install directory in the application root
directory for the Teamcenter installation. Right-click the tem.bat program icon and select
Run as administrator.

2. In the Configuration Maintenance panel, select Add new configuration.

3. In the Configuration panel, enter a description of and unique ID for the configuration you are
creating.

4. Proceed to the Features panel. Select the Teamcenter Foundation feature only and specify an
installation directory for the new configuration the Installation Directory box. The installation
directory must not already exist on your system. (TEM creates the directory.)

5. In the Foundation panel, select Create new data directory using existing populated database.

6. In the Foundation Database panel, enter access information for the existing database.

In the Data Directory box, enter a location for the Teamcenter data directory. The directory must
exist.

The Teamcenter data directory is called the TC_DATA directory. This value is stored in the TC_DATA
environment variable on your system. TEM creates shared data subdirectories and files in this
location.

Do not set TC_DATA in the system environment. TEM sets this variable as required in various
scripts. Setting this variable in the operating system can cause conflicts if you install more than one
configuration.

19-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Change the Oracle password

7. In the Teamcenter Administrative User panel, enter the password for the Teamcenter
administrator.

Caution:
The password must not be empty nor contain any whitespace characters such as space, tab,
newline, carriage return, form feed, or vertical tab.
In addition, the password must not contain any of the following characters:

!@$%=&'"^:;._<>(){}

8. In the Confirmation panel, review your selections and click Start to add the database.

Change the Oracle password

If you use an Oracle database and want to change the password Teamcenter uses to connect to the
database, you can do this two ways using the install utility:

• Encrypt the password file using the -encryptpwf argument.

• Encrypt the database connection string using the -encrypt argument.

Encrypt the password file

To encrypt a password file, you set a temporary environment variable to the password you want to
encrypt, and then generate an encrypted password file using the -encryptpwf argument for the install
utility.

1. Open a Teamcenter command prompt.

2. Create a temporary environment variable and set it to the password you want to encrypt:

set variable-name=password

For example:

set temp_pw=mypassword

For security, choose a unique and obscure name for the environment variable, and delete the
variable promptly after completing this procedure.

3. Type the following command:

install -encryptpwf -e=variable-name -f=password-file

Teamcenter Installation on Windows, Teamcenter 14.2 19-5

© 2022 Siemens
 19. Manage databases

Replace variable-name with the name of the environment variable you created. Replace password-
file with the path and name of the password file to create. For example:

install -encryptpwf -e=temp_pw -f=pwd.txt

This command generates an encrypted password file that can be used for connecting to the
Teamcenter database. The password file can also be used with Teamcenter utilities that use the
password file (-pf) argument.

4. Delete the temporary environment variable you created in step 2.

Caution:
This step is important for security.

Encrypt the database connection string

To encrypt the database connection string, you must temporarily set the TC_DB_CONNECT environment
variable and then re-encrypt the connection string using the -encrypt argument for the install utility.

1. Open a Teamcenter command prompt.

2. Set the TC_DB_CONNECT environment variable:

set TC_DB_CONNECT=”db-user:password@database-ID”

Replace db-user with the database user name (the Oracle user). Replace password with the new
database password. Replace database-ID with the Oracle database name.

3. Type the following command:

install -encrypt

This command generates a new database connection string with the new Oracle password
encrypted. Copy the new database connection string.

4. Open the TC_DATA\tc_profilevars.bat file in a plain text editor.

5. Locate the following line in the file:

set TC_DB_CONNECT=connection-string

6. Replace the existing connection-string with the string generated by the install -encrypt command.

7. Save the changes to the tc_profilevars.bat file.

19-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Part VI: Appendices
Supplemental procedures and references for installing Teamcenter and Active Workspace.

Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
Teamcenter Installation on Windows, Teamcenter 14.2
© 2022 Siemens
 20. Troubleshooting
Troubleshooting Teamcenter server installation

Installation log files

Teamcenter Environment Manager generates files in the install directory under the Teamcenter
application root directory.

• installdate-time_configuration-ID.log

Teamcenter Environment Manager generates a log file for each installation and configuration you
create. The log file contains a record of activities performed by Teamcenter Environment Manager.
Keep these files to maintain a complete history for troubleshooting purposes.

• configuration.xml

This file contains a record of the Teamcenter installation. Teamcenter Environment Manager uses the
configuration file to enable you to maintain the installation, including adding and removing
components, patching installations, and upgrading installations.

Caution:
Do not remove the configuration.xml file. Removing the configuration.xml file results in the
inability to modify the installation using Teamcenter Environment Manager.

• uninstall.xml

This file contains a record of the Teamcenter uninstallation.

In addition, auxiliary programs called by Teamcenter Environment Manager generate files in the logs
directory under the Teamcenter application root directory. Most files have the format:

program-name.syslog
program-name.log

Of these files, the system log (.syslog) files usually contain the most relevant error data.

Teamcenter Installation on Windows, Teamcenter 14.2 20-1

© 2022 Siemens
 20. Troubleshooting

Problems/error messages

See the following information for help resolving errors encountered during Teamcenter installation.

Problem/error message Possible cause Solution

TEM does not start, reports JRE not JRE path is not set in the system Set the JRE_HOME or JRE64_HOME
found. environment. environment variable to specify the path
to the required Java Runtime
Environment (JRE).

For more information, see System

requirements.

JRE path is set incorrectly in the system Make sure the path specified in the
environment. JRE_HOME or JRE64_HOME
environment variable is correct.

For more information, see System

requirements.

The specified JRE has been removed If you installed a new Java Runtime
from the system. Environment (JRE) and removed the
previous JRE after you installed
Teamcenter, TEM cannot find the JRE,
even if JRE_HOME or JRE64_HOME is
set correctly.

To resolve this problem, perform the

following steps.

1. Open the following file in a plain

text editor:

TC_ROOT\install
\tem_init.bat

2. Locate the following line in the

file:

set
TC_JRE_HOME=jre_loc
ation

3. Replace jre_location with the path

to the new JRE.

4. Save and close the file.

5. Perform the steps in Migrate TEM

to a different JRE.

20-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Problems/error messages

Problem/error message Possible cause Solution

To avoid this problem in the future, do

not remove your previous JRE until after
you complete migrating Teamcenter to
the new JRE.

Siemens PLM License Server reports an Make sure the SPLM_LICENSE_SERVER If a path in the CLASSPATH environment
error similar to the following: system environment variable contains variable contains whitespace characters,
the correct port and host name of the those paths must be enclosed in double
Siemens PLM License Server, for quotes ("). For example:
Cannot find license example, 28000@myhost .
file.
"C:\Program Files
\Microsoft\Web
Platform

Installer";D:\TcSE
\apache-ant-1.9.4\bin

An error similar to the following is The CLASSPATH environment variable If a path in the CLASSPATH environment
displayed during a Teamcenter contains an incorrectly formatted path. variable contains whitespace characters,
installation, upgrade, or patch: those paths must be enclosed in double
quotes ("). For example:
Error: Could not
find or load main "C:\Program Files
class files. \Microsoft\Web
Platform

Installer";D:\TcSE
\apache-ant-1.9.4\bin

TEM reports the installation path must The installation drive specified in the Change the Installation Directory to a
not contain spaces. Installation Directory does not path with no spaces, or to a path on a
support short file names (8.3 drive that supports 8.3 file names.
convention). TEM requires this
capability. To determine whether support for the
8.3 file name convention is enabled for a
given drive, type the following
command in a command prompt:

fsutil 8dot3name
query drive-letter

Teamcenter Environment Manager If your Microsoft SQL Server database Make sure the Server Browser service is
(TEM) cannot connect to the Microsoft uses a named instance and the Server running on the database host.
SQL Server database. Browser service is not running on the

Teamcenter Installation on Windows, Teamcenter 14.2 20-3

© 2022 Siemens
 20. Troubleshooting

Problem/error message Possible cause Solution

database host, TEM cannot verify the

connection to the database.

Running Teamcenter in an IPv6 network Some Teamcenter components are Find your IP address using the ping or
environment, the Teamcenter client sensitive to link-local IPv6 nslookup command. Make sure these
does not connect to the server at all or addresses. You must make sure your commands find the a global IPv6
hangs when trying to connect to the hosts have global IPv6 addresses and address, not a link-local IPv6 address.
server. use those when connecting to the
Teamcenter server. Problems can occur If not, or if you are unsure, contact your
if you use local-link IPv6 addresses. network administrator. Make sure your
host name resolves to a global IPv6
address, not a link-local IPv6 address.

You can also view your host’s network

addresses using the ipconfig command
(on Windows systems) or the ipconfig
command (on Linux systems).

During logon using Kerberos The system clock time on the Synchronize the system clock times
authentication, Teamcenter displays the Teamcenter client is significantly between the Teamcenter client and the
following error: different from the system clock time at KDC.
the Kerberos Key Distribution Center
(KDC).
Mechanism level:
Clock skew too great

TEM displays errors like the following If you launched TEM from a shortcut If you create a desktop shortcut to TEM,
during installation of features: with an incorrect working directory, make sure the working directory (or
TEM encounters problems installing or Start in location) for the shortcut is
updating features. TC_ROOT\install.
path
\feature_acadgmo.xml:
Error on line 1 of
document
file: path/
feature_acadgmo.xml:
Premature end of
file.

Database daemon services do not start. If the database daemon services run on If the database daemons run on the
the same host as the database server, same host as the database server,
These can include the following: the database daemons may attempt to perform one of the following steps:
start before the database server is fully
• Teamcenter Task Monitor Service running. If this happens, the daemons
• Manually start the database daemon
• Teamcenter Subscription Manager fail to start.
services after the database server is
Service started.
• Teamcenter Action Manager
Service
• Teamcenter Tesselation Manager • Modify the startup settings for the
Service database daemon services to create a
dependency on the database service.

20-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Update Manager FTP errors

Problem/error message Possible cause Solution

This ensures the daemons do not

start before the database server is
fully running.

During an installation or upgrade, the Another service on the same host was Change the FSC settings to use a
FMS server cache (FSC) reports a running on the same port that the FSC different port.
startup failure with a message similar to is configured to use. This causes a fatal
the following: error to the FSC and the FSC startup log
shows a bind exception on the port.
Installation Some services, such as JBoss, allow the
interrupted FSC to bind to its port, resulting in
due to the failure of the FSC to start, but no errors
in the FSC log.
following reason:

Processing <upgrade>
of feature FMS
Server Cache failed:
FSC service failed to
start with an error 1

However, the FSC startup log shows no

errors and indicates the FSC is left
running.

<<null>>\\<<null>> on This error most likely indicates you Start Teamcenter Environment Manager
host host-name does not attempted to start Teamcenter as a user logged onto the system with
Environment Manager using the Administrator group privileges and the
have administrator Windows runas command or the Run Log on as a service right.
privileges as menu command. Teamcenter
Environment Manager cannot be
started as a user other than the user
logged on to the operating system.

Update Manager FTP errors

The following table describes errors that can occur while connecting to the update server or while
downloading updates.

Error Resolution

Cannot contact server Host or port may be incorrect. Check Host and Port values
and try again.

Cannot log on User name or password may be incorrect. Check User and
Password values and try again.

Teamcenter Installation on Windows, Teamcenter 14.2 20-5

© 2022 Siemens
 20. Troubleshooting

Error Resolution

Incorrect Path Path to the directory on the update server may be incorrect.
Check the path and try again.

Timeout Error The update manager received no response from the update
server. Try connecting later or contact your system
administrator for assistance.

Transfer Error Contact with the update server was interrupted. Try your
operation again or contact your system administrator for
assistance.

Resolving web tier connection problems

Diagnosing web tier connection problems

If the Teamcenter web tier and the corporate server do not reference the same web application name,
the web tier cannot connect to the Teamcenter server.

The web application name specified in the Teamcenter web tier must match the web application name
specified on the corporate server.

During installation of the Teamcenter corporate server, you specify this value in the Web Application
Name box in the Default Site Web Server panel of Teamcenter Environment Manager. The default web
application name is tc.

During installation of the Teamcenter web tier, the Web Application Manager assigns the web
application the default name of tc.

If you specify a web application name other than tc during corporate server installation, you must
change the corresponding value during web tier installation. If the web tier and the corporate server do
not reference the same web application name, the web tier cannot connect to the Teamcenter server.

To ensure the web tier and the corporate server reference the same web application name, perform one
of the following procedures:

Change the deployable file name on the corporate server

Change the deployable file name on the web tier

Change the deployable file name on the corporate server

Using Teamcenter on a two-tier rich client host, set the WEB_default_site_deployed_app_name

preference to reflect the deployable file name specified in Web Application Manager. (Alternatively, you
can set this preference using the preferences_manager utility from a command prompt.)

20-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Change the deployable file name on the web tier

Change the deployable file name on the web tier

1. In Web Application Manager, select your web application and click Modify.

2. In the Modify Web Application dialog box, click Modify Web Application Information.

3. Change the value in the Deployable File Name box to reflect the web application name you
entered during corporate server installation.

4. Click Generate Deployable File to rebuild your web application.

5. Deploy the rebuilt web application on your web application server.

Java exception errors during command-line updates

When making updates in TEM through the command-line interface, such as adding Teamcenter features
or data model update operations, certain Java exception errors may occur.

TEM performs error checking when processing command line parameters and exits quickly if it detects
an error such as an invalid parameter setting. In such cases, a Java exception error similar to the
following may occur:

Data model update

Loading features from path
Type: FULL
Configuration: TEMFLOW1
Verifying password
Unable to locate:
alpha1_template.zip Exception while removing reference:
java.lang.InterruptedException
java.lang.InterruptedException at java.lang.Object.wait(Native Method) at
java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:118) at
java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:134) at
sun.java2d.Disposer.run(Disposer.java:125) at
java.lang.Thread.run(Thread.java:619)

These types of Java exception errors are not a cause for concern because TEM begins shutting down
when a problem is detected, before any data model updates are performed. These errors occur while
threads are closing. In the above example, the java.lang.InterruptedException error occurs because
the main Java thread begins to exit while the Swing (GUI) thread is waiting to close.

Web Application Manager needs location of Java file when installing rich client

Under certain circumstances, the Web Application Manager does not find the Java jakarta-
regexp-1.3.jar file required to install the four-tier rich client.

To resolve this problem, make the jakarta-regexp-1.3.jar file available to the Web Application Manager.

Teamcenter Installation on Windows, Teamcenter 14.2 20-7

© 2022 Siemens
 20. Troubleshooting

1. Locate the bmide\compressed_files directory in the Teamcenter software kit.

2. Expand the bmide.zip file to a temporary directory. (This file contains the jakarta-regexp-1.3.jar
file.)

3. Add the temporary directory to the list of Disk Locations for Install Images in the Web Application
Manager.

4. Build your web application WAR file using the Web Application Manager.

5. Deploy your WAR file.

Troubleshooting microservices

Problem/error
message Possible cause Solution
404 error for a In a deployment with a Create a CUSTOM_REQUEST_BUFFER_SIZE
microservice request load balancer configured, environment variable and set its value higher than
with the Service due to the addition of the default microservice service dispatcher
Dispatcher logging a large cookies by the load request buffer size of 8192 (8 KB), and then
message that the HTTP balancer, some requests restart the service dispatcher.
header is too large. exceed the limit for the
header size.

Troubleshooting four-tier architecture deployment

Identify the problem you encountered in your four-tier rich client architecture and perform the solution
described.

Problem Solution
Out-of-memory error during a call to If you use WebSphere and this occurs when launching NX from
getAttrMappingsForDatasetType the rich client, you must modify the JVM arguments in
WebSphere to increase memory allocation.
Error messages about the server These messages indicate that the pool ID is in use by another
manager pool ID server manager in the cluster. Either place the server managers
in different clusters or configure a distinct pool ID.
Configuration is correct, but run-time Determine from logs whether users are frequently losing a
errors occur server due to the server timing out and are then having a new
server assigned.
Server startup can consume a great amount of CPU. Consider
increasing timeout values and/or the pool size.
CFI_error displays when running AIE When you run AIE Export in batch mode, Teamcenter displays a
export in batch mode CFI error. This error occurs because jt.exe (Microsoft Task
Scheduler) file is missing from the %WINDOWS% directory.

20-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Troubleshooting four-tier architecture deployment

Problem Solution
To resolve this problem, download the Microsoft Task Scheduler
from the Microsoft Developer Network:

https://msdn.microsoft.com
Client-side Java session cookies are Multiple applications deployed in the same WebLogic domain
overwritten by web tier applications can cause client session cookies to overwrite each other. To
deployed in the same domain on a avoid this, deploy your Teamcenter web application in a domain
WebLogic application server. by itself or ensure each application has a separate cookie path.
To set your web application session cookie path:

1. Navigate to the WEB-ROOT/staging-directory/webapp_root/

WEB-INF directory for the application.

WEB_ROOT is the location where you installed the Web

Application Manager (insweb), and staging-directory is
the directory where the specific web application was
generated.

2. Open the weblogic.xml file and add the following

elements:

<session-param>
<param-name>CookiePath</param-name>
<param-value>/deployable-name</param-value>
</session-param>

Replace deployable-name with the deployable file name

set in the Web Application Manager, for example, tc.

3. Launch the Web Application Manager (insweb).

4. Select the web application name and click Modify.

5. In the Modify Web Application dialog box, click Generate

Deployable File.

6. In the Generate Deployable File dialog box, click OK.

The Web Application Manager displays the status of the

installation in the Progress dialog box. When the
installation is complete, click OK to close the Progress
dialog box.

7. Click OK to close the Modify Web Application dialog box.

Teamcenter Installation on Windows, Teamcenter 14.2 20-9

© 2022 Siemens
 20. Troubleshooting

Problem Solution
During peak activity, the web tier The Teamcenter web application is using all available
encounters errors obtaining JCA connections in the connection pool. To avoid this, increase the
connections. number of available connections by increasing the
Max_Capacity context parameter value in the web application
WAR file.
To set your web application maximum connection pool size:

1. Launch the Web Application Manager (insweb).

2. Select the web application name and click Modify.

3. In the Modify Web Application dialog box, click Modify

Context Parameters.

4. In the Modify Context Parameters dialog box, locate

Max_Capacity, double-click the Value column, and type a
larger number.

5. Click OK and click Generate Deployable File.

6. In the Generate Deployable File dialog box, click OK.

The Web Application Manager displays the status of the

installation in the Progress dialog box. When the
installation is complete, click OK to close the Progress
dialog box.

7. Click OK to close the Modify Web Application dialog box.

8. Redeploy the WAR file in your application server.

Chinese characters are displayed as If you use a nonnative language operating system version of
square blocks in the Teamcenter rich Windows, you must install and enable the Multilingual User
client. Interface (MUI) pack to ensure the language font is displayed
properly.

1. Download and install the MUI pack for Windows from

Microsoft.

2. Open the Regional and Language Options dialog box in

the Windows Control Panel.

3. In the Languages tab, set the required language for the

menus and dialogs.

20-10 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Troubleshooting four-tier architecture deployment

Problem Solution
4. In the Advanced tab and the Regional Options tab, set the
required language.
Teamcenter web application fails to The Teamcenter web application takes longer than the default
deploy on JBoss with the following 60 seconds the JBoss deployment scanner allows for
error message: deployments. Add the deployment-timeout attribute to the
deployment-scanner element and set the value to at least 600
Did not receive a response seconds before attempting to deploy the web application.
to the deployment operation
within the allowed timeout
<subsystem
period [60 seconds]. Check
xmlns="urn:jboss:domain:deployment-scanner:1.1">
the server configuration
<deployment-scanner path="deployments"
file and the server logs to
relative-to="jboss.server.base.dir" s
find more about the status
scan-interval="5000"
of the deployment.
deployment-timeout="600"/>
</subsystem>
Long running service request that If a user is performing a time-consuming action such as running
crosses firewalls or proxy servers a large BOM expansion, the server may not respond for 15
results in closed connections. minutes or more. When this happens across a firewall, or other
proxies, the firewall might automatically close the perceived idle
connection. This results in a closed connection in the client
application and loss of data.
To avoid exceeding these idle connection time limits, enable TCP
keepalive functionality in the operating system (OS) of at least
one of the machines on the client or server side of the each of
the HTTP connections between the client applications and the
Teamcenter server.
For example:

• If a client machine connects to web tier machine, enable TCP

keepalive in the OS of the machine where the web tier server
runs. This supports both the HTTP connection between client
applications and the web tier, and the HTTP connection
between the web tier and the Teamcenter server (Server
Manager/MUX).

• If you use a reverse proxy server between a client machine

and the web tier machine, enable TCP keepalive in the OS of
the machine where the reverse proxy runs.

If your network configuration requires you to not enable TCP

keepalive on the TCP endpoint (such as a proxy server), you
must enable keepalive in the OS on each client machine.

On Windows machines, enable TCP keepalive by setting the

appropriate Windows registry keys. On Linux machines, set TCP

Teamcenter Installation on Windows, Teamcenter 14.2 20-11

© 2022 Siemens
 20. Troubleshooting

Problem Solution
keepalive using kernel parameters. See your operating system
documentation for information on how to enable TCP keepalive.

Note:
TCP keepalive is enabled in Teamcenter client and web tier
software by default, and only requires TCP keepalive in the
OS of affected hosts to be enabled.
Alternatively, if you do not want to enable TCP keepalive,
you can increase the timeout setting in the firewall to
allow requests to complete.

Troubleshooting the .NET web tier

Resolving .NET server manager port conflicts

When starting the .NET Server Manager Service, Teamcenter may display a message that no Teamcenter
servers are available. This can be caused by a port conflict.

To diagnose and resolve this problem, perform the following steps.

1. Open the following file in the TC_ROOT\net_servermanager\logs directory:

TcServerManager_timestamp.log

2. Search the log file for errors similar to the following example:

2014-02-12 21:06:33 [6] ERROR Teamcenter.Enterprise.ServerManager.ServerPoolManager

[(null)] - Remoting port configured for Pool ID: TcPoolA, is already in use. Stop
and start server manager on a different port. Message is: Only one usage of each
socket address (protocol/network address/port) is normally permitted

3. If you find an error that states a remoting port is already in use, another process is using the same
port as the .NET server manager.

To resolve this problem, either change the .NET server manager port to different value or stop the other
process that uses the .NET server manager port.

You can use the Windows netstat utility to view all TCP ports currently in use by the system. For
example, typing netstat -a -b or netstat -aon lists the TCP ports currently in use.

20-12 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Finding Oracle errors

Troubleshooting Oracle

Finding Oracle errors

When Oracle detects an error, an error code is displayed in the system console window and written to
the Teamcenter trace and log files. To assist troubleshooting, Oracle embeds object names, numbers,
and character strings in error messages.

The oerr utility provides additional troubleshooting information. Often, the additional information offers
a solution to the problem.

View additional information about an Oracle error message

1. Manually set the Oracle environment by entering the following command:

export ORACLE_HOME=/u01/app/oracle/product/oracle-version

Replace oracle-version with the installed Oracle version, for example, 920.

2. Enter the following command:

$ORACLE_HOME/bin/oerr facility error-number

Replace facility error-number with the Oracle error code, for example ORA 7300. ORA is the facility
and 7300 is the error number.

This command displays cause and action messages that you can use to troubleshoot the problem.

Troubleshooting Microsoft SQL Server

Microsoft SQL Server 2014 performance is poor

If you migrate a database application to Microsoft SQL Server 2014 from a previous version, the
database server may consume excessive CPU resources and cause poor performance.

To correct this problem, change the SQL Server 2014 Compatibility Level setting from SQL Server 2014
(120) to SQL Server 2012 (110).

For more information about this issue, see the following Microsoft support article:

https://msdn.microsoft.com

Teamcenter update fails with ODBC error

When upgrading a Microsoft SQL Server server, an error similar to the following can occur:

Teamcenter Installation on Windows, Teamcenter 14.2 20-13

© 2022 Siemens
 20. Troubleshooting

++++++++++++++++++++++++++++++++++
ODBC error. SQLSTATE: 42000 Native error: 5074
Message: [Microsoft][ODBC SQL Server Driver][SQL Server]The column '***'
is
dependent on column '***'.
ODBC error. SQLSTATE: 42000 Native error: 4922
Message: [Microsoft][ODBC SQL Server Driver][SQL Server]ALTER TABLE
ALTER COLUMN
<name> failed because one or more objects access this column.
++++++++++++++++++++++++++++++++++++

This error occurs when the upgrade process attempts to modify a column that has a dependent column
with an index. Microsoft SQL Server does not allow changes to columns with indexes. Also, local DBA
indexes may exist that don't match the standard OOTB template for indexes, so it was not anticipated.

This problem can happen because columns that have manually-created statistics attached cannot have
their properties modified without first dropping the statistics object. This to ensure the statistics object
accurately reflects the content of the column. Manual creation of statistics objects is important to
ensuring query performance if you set AUTO_CREATE_STATISTICS = OFF.

An auto-created statistics object does not prevent a modify action to a column because auto-created
statistics objects can be removed automatically. But, if the system encounters a manually-created
statistics object, it cannot be removed automatically, and may result in an access error.

To resolve this problem, perform the following steps:

1. Delete the index ***.

2. Delete the dependent column ***.

3. Continue the upgrade.

4. Run the index_verifier utility to re-create standard OOTB indexes:

index_verifier -u=infodba -p= -g=dba -o=DO_IT

Tuning WebSphere JVM memory consumption

If your Teamcenter application requires more memory than what is currently allocated in WebSphere,
out-of-memory errors can occur. For example, if you use the NX Integration and attempt to launch NX
from the rich client, Teamcenter may report an out-of-memory error during a call to
getAttrMappingsForDatasetType.

If errors like this occur, you must modify the JVM arguments in WebSphere to increase memory
allocation. For information about how to modify JVM arguments, see the IBM support article titled
Setting generic JVM arguments in WebSphere Application Server at the following site:

20-14 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Tuning WebSphere JVM memory consumption

http://www-01.ibm.com

Before you tune JVM arguments, use memory profiling tools to analyze your memory issues and
determine which tuning options you need to use. The following table provides some suggestions, but
these may not be suitable in all cases.

JVM options for tuning the WebSphere Application Server memory usage

Typical
default Suggested
JVM option Description value value

-Xms Controls the initial size of the Java heap. 50 MB 512 MB

Properly tuning this parameter reduces the overhead
of garbage collection, improving server response time
and throughput. For some applications, the default
setting for this option may be too low, resulting in a
high number of minor garbage collections.

-Xmx Controls the maximum size of the Java heap. 256 MB 1024 MB
In general, increasing the minimum/maximum heap
size can improve startup, reduce the number of
garbage collection occurrences, and increase the
throughput until the heap no longer resides in physical
memory. After the heap begins swapping to disk, Java
performance suffers drastically. Therefore, The heap
sizes should be set to values such that the maximum
amount of memory the VM uses does not exceed the
amount of available physical RAM.

-XX:PermSize Sets the section of the heap reserved for the Client: 32 128 MB
permanent generation of the reflective data for the MB
JVM. This setting should be increased to optimize the
Server: 64
performance of applications that dynamically load and
MB
unload many classes.
PermSize memory consumption is in addition to the -
Xmx value set by the user on the JVM options. Setting
this to a value of 128 MB eliminates the overhead of
increasing this part of the heap.

- Allows for the JVM to be able to increase the PermSize N/A 256 MB
XX:MaxPermSize setting to the amount specified.
Initially, when a VM is loaded, the MaxPermSize is the
default value, but the VM does not actually use that
amount until it is needed. If you set both PermSize
and MaxPermSize to 256 MB, the overall heap
increases by 256 MB in addition to the -Xmx setting.

Teamcenter Installation on Windows, Teamcenter 14.2 20-15

© 2022 Siemens
 20. Troubleshooting

Typical
default Suggested
JVM option Description value value

If an application needs to load or reload a large

number of classes, the following error may result:

messageOutOfMemoryError: PermGen space

Typically, this means that the JVM started with an

insufficient maximum value for permanent
generation.

Troubleshooting document rendering

If you are not successful rendering document revisions to translate dataset files, your administrator
should review your installation and configuration systematically and verify the following requirements
are met.

• Installation of Teamcenter lifecycle visualization Convert software is required by the previewservice

feature.

• You must select the Convert feature; the Print feature is optional.

• The destination installation directory name must not contain spaces.

• To accommodate high levels of input and output, modify the vvcp.ini file on Windows systems, or
the vvcp.platform.cfg file on Linux systems.

FileCheckWait=600
FileCheckWaitForZero=30

• When the installation is complete, verify the Convert option prepare.exe program exists under the
VVCP installation directory.

• Installation of Ghostscript software required by the previewservice feature.

• Download the Ghostscript installer at the following link:

https://www.ghostscript.com/

• On Linux platforms, after you install Ghostscript, set the PSPath setting in the Convert and Print
configuration file (vvcp.ini) to the location of the Ghostscript application.

For example: *PSPath: /apps/gs854/bin/gs.

20-16 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Troubleshooting Teamcenter Integration for NX

• Set AllowOpenApplication=on to support the use of applications, such as Microsoft Word, that
may already be open when the Convert process begins.

• You must enable the RenderMgtTranslator service and one or both of the following services:

• PreviewService

Configure translation services by enabling and configuring translators using TEM.

• PreviewService

Requires Teamcenter Visualization Convert. Ghostscript and source authoring applications such as
Microsoft Office applications are also required.

• RenderMgtTranslator

Required for either PreviewService, PdfGenerator, or any other service to be added.

• Use Business Modeler IDE to set up and deploy IRDC and dispatcher service configuration objects to
the Teamcenter database.

Troubleshooting Teamcenter Integration for NX

Teamcenter Integration for NX may be unresponsive in a four-tier rich client if you specify an incorrect
value for Web Application Name during installation of the Teamcenter corporate server.

During corporate server installation, TEM prompts for the web application name in the Default Site Web
Server panel. The web application name you enter is used to populate the
WEB_default_site_deployed_app_name preference in the Teamcenter database. When you build the
Teamcenter Integration for NX web application in Web Application Manager, you specify the actual
name of the web application.

If the name of the deployed web application does not match the value specified in TEM, the web
application fails to connect to the Teamcenter server.

If you experience problems starting Teamcenter Integration for NX from the four-tier rich client, inspect
the ugs_router system log for messages that resemble the following example:

INTEROP: Executing: O:\win32\ugnx5.0.0.22\ugii\ugraf.exe -pim=yes -

http_url=http://AcmeCorp:8080/tc/aiws/aiwebservice -soa_url=http://AcmeCorp:8080/tc"-
http_cookie=IMAN=08100000000000madakash45b765e1cd0ea854705e5f8f; path=/;" -
http_vmid=b6e51c5aaaf5b200:-58275229:1104f3e3952:-8000 "-role=ALL" -
portalinfo=localhost:2377:PROCESS_COMMAND_LINE -
invoke=com.teamcenter.rac.commands.objectschanged.ObjectsChangedCommand+-uids=%s+-
src=madakash@4Tier_w__NX :madakash@4Tier_w__NX 4-tier
INTEROP: Waiting for UG/Manager V23.0 1 to start up...

Teamcenter Installation on Windows, Teamcenter 14.2 20-17

© 2022 Siemens
 20. Troubleshooting

This message results from the rich client expecting a web application named tc but being unable to find
it.

To resolve this problem, set the WEB_default_site_deployed_app_name preference to the correct

name of the deployed web application. You can update this preference using the preferences manager
from the command line or from within the rich client.

Recovering a corrupted database

Overview of recovery from a corrupted database

If you attempt to install Teamcenter using a database that is only partially installed, Teamcenter
Environment Manager (TEM) allows you to drop all existing data before beginning a new installation.

If the Teamcenter database is corrupted beyond repair, you can alternatively delete the database and
repeat the installation using an empty database. To do this, perform the appropriate procedure,
depending on your database vendor:

• Recovering from a corrupted Oracle database

• Recovering from a corrupted Microsoft SQL Server database

Recovering from a corrupted Oracle database

1. Delete the database using Oracle Database Configuration Assistant (DBCA).

2. Create a new empty database using the appropriate DBCA template file.

3. Launch TEM and reinstall Teamcenter.

Recovering from a corrupted Microsoft SQL Server database

1. Remove the corrupted database using the Microsoft SQL Server Management Studio. Right-click
the appropriate database in the tree view and choose Delete.

This removes the database and the associated data files.

2. Launch TEM and reinstall Teamcenter.

TEM creates a new database during installation.

20-18 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 21. Uninstalling Teamcenter
Uninstall Teamcenter configurations

You can remove Teamcenter configurations using Teamcenter Environment Manager (TEM). To
completely uninstall a Teamcenter deployment, you must remove all configurations in the deployment.

To remove a single Teamcenter configuration, use the Remove configuration option in the
Configuration Maintenance panel in TEM.

To remove an entire Teamcenter deployment, perform the following steps:

1. Log on to the operating system using the user account under which you installed Teamcenter.

2. Stop all Teamcenter services using the Services dialog box in the Windows Control Panel.

3. Start Teamcenter Environment Manager (TEM):

From the Start menu, choose Programs→Teamcenter 14→Environment Manager, then right-
click and choose Run as administrator.

You can also run the tem.bat file in the install directory in the application root directory for the
Teamcenter installation.

4. In the Configuration Maintenance panel, select Perform maintenance on an existing

configuration.

5. Select the configuration to uninstall from the displayed list.

TEM removes only the configuration you select.

6. Proceed to the Uninstall panel. Select

The Configuration Display panel shows all configurations in the Teamcenter installation. Review
the configuration details, and then click Next.

7. Proceed to the Uninstall panel. Select Yes to confirm that you want to remove the selected
configuration.

8. If the configuration includes Teamcenter Foundation, TEM displays the Uninstall Teamcenter
Foundation panel. Specify whether you want to remove the Teamcenter database, TC_DATA
directory, and volume. You must enter database server credentials to remove the database.

9. Proceed to the Confirmation panel and click Start to begin the uninstallation.

Teamcenter Installation on Windows, Teamcenter 14.2 21-1

© 2022 Siemens
 21. Uninstalling Teamcenter

TEM removes the Teamcenter configuration.

If the uninstallation is not successful, TEM stops processing when it encounters the error and
displays a message indicating the location of the log file containing the error.

10. If you selected the option in TEM to remove the Teamcenter database, the database is moved to
the Oracle recycle bin. To permanently remove the database, launch SQL*Plus and enter the
following command:

PURGE RECYCLEBIN;

11. If you want to remove additional configurations, return to step 5.

TEM does not remove TCCS cache files (cache files generated by the FSC or FCC). After Teamcenter
uninstallation, you can manually delete these cache files.

If you shared the TC_DATA directory, TEM may not completely remove this directory because it may be
locked by sharing. To completely uninstall this directory, you must unshare it before you begin
uninstallation.

Uninstall TCCS

If you installed Teamcenter client communication system (TCCS) as part of an installation of the rich
client or Teamcenter Microsoft Office interfaces, uninstalling those clients automatically uninstalls TCCS
from your system.

If you installed TCCS using the stand-alone installation wizard, perform the following steps to uninstall
TCCS.

1. Stop the FMS client cache (FCC) process:

a. Open a command prompt.

b. Change to the \tccs\bin directory in the TCCS installation directory.

The default TCCS installation directory is C:\Program Files\Siemens\Teamcenterversion\tccs.

c. Type the following command:

fccstat -stop

After stopping the FCC process, the fccstat command reports that the FCC is offline.

d. Close the command prompt.

2. Uninstall TCCS:

21-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Uninstall database software

a. In the Windows Control Panel, open the Add or Remove Programs dialog box.

b. In the list of installed programs, select and remove Teamcenter client communication
system.

c. Restart the system to unset the FMS_HOME environment variable.

Uninstall database software

Uninstall your database software (Oracle or Microsoft SQL Server) according to the vendor
documentation.

Teamcenter Installation on Windows, Teamcenter 14.2 21-3

© 2022 Siemens
 21. Uninstalling Teamcenter

21-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 22. Teamcenter software kits
What is in the Teamcenter software kit?

The Teamcenter software kit contains most Siemens Digital Industries Software required to install a
Teamcenter environment. This includes the installation tools, Deployment Center and Teamcenter
Environment Manager (TEM).

The Teamcenter software kit does not include the following:

• Siemens PLM Licensing Server

• Active Workspace

• Microservice Framework

These products are packaged in separate software kits available for download from Support Center.

The following table describes the most commonly used directories in the Teamcenter software kit.

Directory Contents

additional_applications Applications such as Teamcenter client communication system

(TCCS), Security Services, and others.

advanced_installations Resource Manager application files for Teamcenter

manufacturing process management.

bmide Business Modeler IDE.

cci CCI client.

dc_contributions Files required for installation using Deployment Center.

install Files required for installing Teamcenter. This directory includes

the Deployment Center software kit.

mappingdesigner Mapping manager application.

portal Teamcenter rich client files.

tc Teamcenter software files.

Web_tier Web Application Manager program (insweb) and supporting

files for generating the web tier application WAR files.

Teamcenter Installation on Windows, Teamcenter 14.2 22-1

© 2022 Siemens
 22. Teamcenter software kits

What is a major, minor, or patch release?

Major Minor Patch1

Baseline version of the Updates to the latest major Fixes to the corresponding major or
Teamcenter platform, for release, for example, minor release, for example,
example, Teamcenter 14. Teamcenter 14.2. Teamcenter 14.2.0.1.

When installing or upgrading Teamcenter to a minor release or patch release, you must also have the
corresponding major release software kit.

1 Patch here refers to general patches, which apply to all Teamcenter customers. Customer patches apply to specific
Teamcenter customers and are documented with the respective patch kits.

22-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 23. Solutions and features reference
Teamcenter solutions

Solutions are preselected groups of features that provide starting points for recommended Teamcenter
configurations. You can add features or deselect features in the Features panel in Teamcenter
Environment Manager (TEM). For information about a solution, point to the solution name in the list.
TEM displays a description.

Solution Features
Corporate Server Teamcenter Foundation
FMS Server Cache
NX Part Family Classification Integration
Volume Server FMS Server Cache
Rich Client 2-tier Teamcenter Rich Client 2-tier
Rich Client 4-tier Teamcenter Rich Client 4-tier
Multisite Collaboration Proxy Server Multisite Collaboration IDSM Service
Multisite Collaboration ODS Service
Business Modeler IDE Business Modeler IDE Standalone
Rich Client (2-tier and 4-tier) Teamcenter Rich Client (2-tier and 4-tier)
Dispatcher (Dispatcher Server) Dispatcher Server

Teamcenter Installation on Windows, Teamcenter 14.2 23-1

© 2022 Siemens
 23. Solutions and features reference

Teamcenter features

TEM provides the following features and feature groups in the Features panel. Features are grouped by
related applications. For information about a feature, point to the feature name in the list. TEM displays
a description of the feature.

To search for a feature by name, enter a keyword in the Search box, then click the search button. To see
the next search result, click the search button again.

Some features are disabled because they require other features. To enable a feature, select its
prerequisite features. For information about feature prerequisites, see the feature description. Some
features cannot be installed in the same configuration, so selecting one disables the other.

Feature/Subfeature Description
Base Install Base Teamcenter server and client components.
Teamcenter Foundation Installs the complete Teamcenter application root directory (TC_ROOT),
including the Teamcenter server process (tcserver), and either creates a data
directory for storing database-specific files or configures this installation to
connect to an existing data directory.

If you create a data directory, you also provide information about the database
to use with this installation. If you specify a new database, Teamcenter
Environment Manager populates the database and creates a volume.

Installing Teamcenter Foundation is optional only when you install the

following components: the Multi-Site Collaboration proxy servers, File
Management System, online help, or sample files. When you install these
components, Teamcenter Environment Manager creates an TC_ROOT
directory, but populates it with only the subdirectories necessary for these
components to run.
Business Modeler IDE Standalone Installs only the Business Modeler IDE client without requiring a connection to
a Teamcenter server.
Business Modeler IDE 2-tier Installs the two-tier Business Modeler IDE client. This client connects to the
Teamcenter server using TCCS.
Business Modeler IDE 4-tier Installs the four-tier Business Modeler IDE client. This client connects to a
Teamcenter server in a four-tier environment using HTTP.
Teamcenter Rich Client (2-tier and 4- Installs a rich client that uses the communication infrastructure introduced in
tier) Teamcenter 11.2.

This rich client is configurable for both two-tier and four-tier deployments. It
connects to the Teamcenter server (in a two-tier environment) or web tier (in a
four-tier environment) using Teamcenter client communication system (TCCS).
This differs from the existing two-tier rich client that connects directly to the
Teamcenter server using TCCS, and the existing four-tier rich client that
connects directly to the Teamcenter web tier using HTTP protocol.

The newer TCCS-based rich client architecture provides the ability to stream
responses from the Teamcenter server (tcserver) to the client, an advantage
over the previous two- and four-tier architectures that required server
responses be completely prepared before sending.

This streaming is performed by a multiplexing proxy, or MUX, that is part of

Teamcenter Enterprise Communication System (TECS), a Java component of
the Teamcenter enterprise tier. The MUX supports four-tier communication

23-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Teamcenter features

Feature/Subfeature Description
through its internal Jetty HTTP server, which services requests from the
Teamcenter web tier. The MUX communicates with the tcserver using
Teamcenter Transfer Protocol (TCTP).
Teamcenter Rich Client 2-tier Installs a Teamcenter two-tier rich client that communicates with the
Teamcenter corporate server using TCCS. It supports most Teamcenter
features and does not require a web tier.
Teamcenter Rich Client 4-tier Installs a four-tier rich client that connects directly to the Teamcenter web tier
using HTTP protocol.

This rich client is an alternative to the newer four-tier rich client provided by
the Teamcenter Rich Client (2-tier and 4-tier) feature, which communicates
with the Teamcenter web tier using Teamcenter client communication system
(TCCS).
TcRS Multisite Enablement Select this feature to enable multisite collaboration between Teamcenter Rapid
Start and Teamcenter sites for OOTB objects.

Note:

Multisite collaboration for OOTB objects between Teamcenter Rapid

Start 12.x, and any version of Teamcenter or Teamcenter Rapid Start
prior to 12.x, is not possible.

Teamcenter Rich Client (Lite Edition) Installs a rich client and configures it for use with the NX Manager feature. This
feature requires NX Manager for Rich Client.
Server Enhancements Additional features for Teamcenter servers.
Server Manager Installs the process that manages the pool of Teamcenter server processes.
This option is applicable only when you are deploying the web tier. This
feature requires Teamcenter Foundation and FMS Server Cache features.

For a smaller site, you can install the server manager and Teamcenter servers
on the same host as the web tier application. For deployment options for
larger sites, you can install the server manager on a separate host.
Sample files Installs sample source code for customizing Teamcenter and generating
reports.

This component is optional. You can install the sample files individually; you
need not install any other components.
Teamcenter Management Console Installs Teamcenter Management Console, an SSL-secured console for
managing and monitoring server-side components such as the Java EE server
manager and Java EE web tier. The console's tabbed interface resembles a web
application server console. Teamcenter administrators can use the console to
access multiple Teamcenter management features from a single page.
Teamcenter Security Services Configures Security Services for Teamcenter. These services eliminate prompts
for logon credentials when users switch Teamcenter products within a user
session.

Prerequisite:

Installation and configuration of Security Services.

Required information:

Teamcenter Installation on Windows, Teamcenter 14.2 23-3

© 2022 Siemens
 23. Solutions and features reference

Feature/Subfeature Description
• Application ID for this instance of Teamcenter in the Security Services
application registry.

• Complete URL of the Security Services logon Service web application.

• Complete URL of the Security Services Identity Service web application.

Database Daemons Optional database support services.
Action Manager Service Monitors the database for the creation of action objects and dispatches events
that have a specific execution time and events the Subscription Manager
daemon fails to process.

Installing the Action Manager service is required to enable the rich client
Subscription Administration application.
Subscription Manager Monitors the database event queue for the creation of subscription event
Service objects.

Installing the Subscription Manager service is required to enable the rich client
Subscription Administration application.

To subscribe, right-click an item and choose Subscribe. To modify your

subscription settings, right-click an item and choose Subscription Manager.
Teamcenter Revision Installs the Revision Configuration Accelerator Service service, which improves
Configuration Accelerator revision configuration performance
Service
Teamcenter Task Manager Checks user inboxes for tasks that have passed due dates, notifies the
Service delegated recipients, and marks those tasks as late.

Installing the Task Monitor service is required to enable notification of late

tasks.
Tessellation Manager Tessellates UGMASTER and UGALTREP datasets to the JT (DirectModel)
Service dataset and attaches the JT dataset back to the item revision and UGMASTER
and UGALTREP dataset.

Installing the Tessellation service is required to create the tessellated

representations in Repeatable Digital Validation (RDV) that enable users of the
Design Context application to quickly visualize components in context. The
tessellated representations are created during the workflow release process,
ensuring that JT files of the DirectModel datasets are updated as the NX files
are released.
Workflow Remote Inbox This service syncs the data between two sites to enable working with remote
Service inboxes.
Teamcenter Shared Installs the Shared Metadata Cache Service.
Metadata Cache Service
File Management File management features.
FMS Server Cache Installs the File Management System FSC server and file caches. You must
install an FSC server on each host that runs a server manager and on each host
that is to provide volume services.

You can optionally choose to install the FSC as a configuration server or a

performance cache server.
Hierarchical Storage Adds support for third-party hierarchical storage management software.
Management (HSM)
Teamcenter Web Tier Features to support the Teamcenter .NET web tier.

23-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Teamcenter features

Feature/Subfeature Description
ASP .NET State Service Installs the middle tier processes that communicate with Teamcenter server
processes.
Web Tier for .NET Installs the middle tier processes that communicate with Teamcenter server
processes.
Extensions Extensions to Teamcenter server and client functionality.
4D Planning Installs the 4D Planning feature. 4D Planning is the capability to add a time
component to process planning to simulate and visualize construction over an
extended period of time.
CAD Lite Provides out-of-the-box CAD integrations for CAD users.
APS Configured Search Framework Installs the search framework for Advanced PLM Services.
Campaign Management Integrates campaign management with brand development and program
planning.

Similar to how a program orchestrates projects, a campaign orchestrates ideas

and information about audience and goals. It also includes a high-level
description of planned resources and budget and can identify one or multiple
windows of opportunity that act as a reference for the windows of opportunity
targeted by the ideas. For more information about campaign management,
see Initiative Planning in the Active Workspace documentation.
Composite Part Laminate Definitions Installs support for composite part laminate definitions. This enables
visualization of plies for composite part definition outside of authoring tools,
with particular emphasis on change visualization to intuitively manage part
changes.
Configurable Validation Installs support for creating custom validation applications to manage the
validation results in a Teamcenter database. For more information about this
functionality, see Validation Manager.
Content Migration Manager Installs the Content Migration Manager feature.

For more information about this feature, see the Content Migration Manager
and NX Migration User's Guide provided with the Content Migration Manager
software media.
Embedded Software Management Installs Embedded Software Management support for the Teamcenter server.
Engineering View Installs the Engineering view for the Teamcenter rich client.
Google Viewer Integration Installs the Google Viewer Integration, which enables Google Online features
within Teamcenter, such as viewing and editing Microsoft Office documents
without the need for Microsoft Office applications.
Hazard and Risk Assessment Installs support for hazard and risk analysis of system models and functions.
IP Management Provides product lifecycle management for semiconductor manufacturers to
manage IP data using Teamcenter.
Idea Management Installs idea management, which provides the capability to create, discover
and realize an Idea leading to the creation of project.

Ideas are researched during the capture phase and are used during the
discovery phase to define a product, set goals and objectives, identify trends,
record customer profiles, and make projections. An accepted idea results in the
start of a new project. For more information about idea management, see
Initiative Planning in the Active Workspace documentation.
Order Management Installs Order Management, which manages the lifecycle of an order from
inquiry to sales order. A customer inquires about products, a sales person
responds with the offer containing configurable products. Once the offer is

Teamcenter Installation on Windows, Teamcenter 14.2 23-5

© 2022 Siemens
 23. Solutions and features reference

Feature/Subfeature Description
accepted by the customer, a sales order is created that refers to the
configurable products.
Product Line Planning Installs Product Line Planning.

Product Line Planning facilitates development of a collection of products by

outlining product assortment goals. The purpose of such assortment planning
is to identify an assortment that maximizes sales or gross margin within
constraints such as limited budget, space, vendors, and others.
Program Planning Infrastructure Installs Program Planning support for the rich client.

For more information about this feature, see Active Workspace Installation in
the Active Workspace help.
Sample Document Management Installs the sample template for Document Management.
Symbolica Integration Installs the Teamcenter integration to Symbolica software. Symbolica is a
Siemens Digital Industries Software product that allows you to visually create
and perform complex mathematical equations. The Symbolica integration
enables you to create, save, and revise Symbolica files within Teamcenter.
These files can also be referenced by NX part files stored within Teamcenter.

Symbolica software can be downloaded from Support Center.

Teamcenter Lite Framework Provides a configurable mechanism to hide types, revision rules, and workflow
templates.
Teamcenter Office Online Installs the Teamcenter integration to Microsoft Office Online, which allows
users to edit and view documents within Active Workspace instead of using
Microsoft Office desktop applications.
Teamcenter Integration for Intosite Installs the Teamcenter integration with Siemens Intosite.
Test Manager Installs the application model used to manage assembly tests for virtual
assessment processes in Automotive Edition and Aerospace and Defense.
Weld Management Installs the template that manages NX welding features in Teamcenter.
Xcelerator Share Collaboration Installs support for the Xcelerator Share collaboration in Teamcenter.
Xcelerator Share is a cloud application that allows you to share and collaborate
on project files with your partners, team members, and manufacturers. In this
browser-based collaboration, you can develop new products and designs, then
share your projects with customers for approval or manufacturers for
production. Xcelerator Share controls and secures file access, and maintains
history of file sharing and exchange. For more information about Xcelerator
Share collaboration, see Active Workspace documentation.
Initiative Planning This feature provides capability to create, discover and realize an Idea leading
to the creation of project. It also provides capability to create and manage
campaigns. For more information, see Initiative Planning in the Active
Workspace documentation.
Machine Builder Installs support for the Machine Builder solution, which provides a single-
source data management system focused on the engineering, manufacturing
and product life BOM. This solution is designed to enable industrial machinery
customers to move from CAD data management to engineering process
management, integrating requirements management, project management,
and change management.
Medical Device Foundation Installs server and rich client extensions to support product development
processes for medical device manufacturers. This feature assists in ensuring
compliance with regulatory guidelines, accelerating innovation in
development, and reducing costs.
Object Data Services Adds support for the OData framework for Teamcenter.

23-6 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Teamcenter features

Feature/Subfeature Description
Teamcenter Integration for IP Provides a solution to integrate Teamcenter with external IP management
Management applications. The application helps import IP data and its metadata from
external application into Teamcenter. It also adds the capability to share a bill
of IP from Teamcenter to an external application.
Teamcenter SLM Integration for Adds Service Execution actions for Teamcenter Service Lifecycle Management
Service Execution (SLM).
Dimensional Planning and Validation Installs multifield key functionality in Dimensional Planning and Validation.
Multi Field Key
Initiative Lifecycle Management (ILM) Installs support for Initiative Lifecycle Management (ILM), which unifies
business processes from ideation to production. This includes management of
campaigns, ideas, programs, and projects. ILM leverages program planning
capabilities and combines those with process groups that distribute work to
participants. For more information, see Initiative Lifecycle Management in the
Active Workspace documentation.
Integrated Materials Management for Installs Integrated Material Management (IMM) for Additive Manufacturing
Additive Manufacturing (AM), which manages raw materials and final materials for Additive
Manufacturing. This feature enables NX users to search and assign materials to
parts based on material parameters. It also enables selecting the printer, post-
operation, and available corresponding raw materials. For more information
about Additive Manufacturing and NX, see Manufacturing Process Planner.
Product Configurator Installs Product Configurator, a feature that enables you to formally introduce
and manage variability across your product suite.
Volume Planning Installs volume planning for Teamcenter.

This feature adds the cfp0featureplanning template.

Weight and Balance Management Install support for performing weight and balance rollups for structures.
Functional Hazard Analysis Configures the Teamcenter installation to support Functional Hazard Analysis
of system models and functions. This application requires Systems Engineering
and other additional applications.
Initiative Lifecycle Management - CPG Installs Initiative Lifecycle Management (ILM) with objects and processes
Reference Implementation specific to the Consumer Packaged Goods industry. For more information, see
Initiative Lifecycle Management - Consumer Packaged Goods Reference
Implementation in the Active Workspace documentation.
Initiative Lifecycle Management Supports project planning and idea management for the semiconductor
Overlay for Semiconductor Solution industry.
Medical Device Submissions Provides support for performing end-to-end medical device label authoring,
object-based content management, Unique Device Identifier (UDI) data
management and submissions for medical industry customers.
Product Configurator Feature Planning Adds feature planning support to Product Configurator, a feature that enables
you to formally introduce and manage variability across your product suite.
Product Configurator Support for Provides the ability to use the Product Configurator variants to configure
Structure Manager product structures in Structure Manager.

This feature requires Product Configurator.

Capital Asset Lifecycle Management Installs the core components of Capital Asset Lifecycle Management (CALM)
The CALM solution aggregates plant data authored in various design tools into
Teamcenter to build a digital twin of a capital facility or plant.

For more information about the CALM solution, see the Active Workspace
documentation.

Teamcenter Installation on Windows, Teamcenter 14.2 23-7

© 2022 Siemens
 23. Solutions and features reference

Feature/Subfeature Description
Configurator Partition Interface Installs the Configurator Partition Interface, which provides the Partition
Variability View for Product Configurator.
Partitions for Structure Installs server support for partitions and partition schemes for structures.
Teamcenter Integration for Label Provides integration of Teamcenter with Label Management Systems for
Management Systems Medical Devices.
4th Generation Target Management Installs target management support for 4th Generation Design.
Semiconductor Foundation Provides a product lifecycle management solution for semiconductor
manufacturers to manage semiconductor design and manufacturing data
using Teamcenter.
Automation Designer This feature provides the data model and server functionality for Automation
Designer. For more information, see the Line Designer documentation
available with NX.
Advance PLM Services 4th Generation Design features.
4th Generation Design Installs 4th Generation Design (4GD) functionality for the Teamcenter server.
4GD allows users of NX CAD or Lifecycle Visualization to cooperate in real time
during the design cycle of a product.
MDConnectivity Installs support for multidisciplinary (MD) objects. This enables management
of files from piping and instrumentation diagram/drawing (P&ID) applications
in Teamcenter.
System Modeling Installs the system modeling template for multidisciplinary (MD) objects.
4GD Change Detection Installs the change detection service for 4th Generation Design functionality
Service for Issue Manager. This feature requires Teamcenter Foundation and 4th
Generation Design.
Diagramming Installs the diagramming template for multidisciplinary (MD) objects.
Aerospace and Defense Aerospace and Defense features.
Aerospace and Defense Installs Aerospace and Defense functionality for the Teamcenter server. This
Foundation feature requires Teamcenter Foundation and Vendor Management.
Aerospace and Defense Installs the change management functionality for the Aerospace and Defense
Change Management Foundation feature. This feature requires Teamcenter Foundation and
Aerospace and Defense Foundation.
Aerospace and Defense Installs the Aerospace and Defense Foundation training program for the
Foundation Training Aerospace and Defense Foundation feature. This feature requires
Teamcenter Foundation, Vendor Management, and Aerospace and
Defense Foundation.
Automotive Teamcenter Automotive Edition and additional supporting features.
Teamcenter Automotive Installs the optional Teamcenter Automotive Edition application.
Edition
GM Overlay Installs the Teamcenter Automotive Edition GM Overlay application.

Installing GM Overlay requires that you also install Teamcenter Automotive

Edition.
Configure AutoCAD Configures AutoCAD Integration/AutoCAD Manager to operate in a Teamcenter
Integration for GM Overlay Automotive Edition GM Overlay environment. Choose this option only when
you add GM Overlay to a Teamcenter environment that includes AutoCAD
Integration. If you attempt to include this configuration before installing GM
Overlay and the standard AutoCAD Integration, the install fails. Both GM
Overlay and the base AutoCAD integration must be installed and functioning
before you choose this option. Requires Teamcenter Foundation and GM
Overlay.

23-8 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Teamcenter features

Feature/Subfeature Description
GM Customization for DPV Installs GM-specific LOVs and GRM rules for Dimensional Planning and
Validation (DPV).

For more information, see Deploying Dimensional Planning and Validation in

DPV help.
Wire Harness Configuration Configures wire harness configuration for a Teamcenter Automotive Edition
in GM Overlay GM Overlay environment. Requires Teamcenter Foundation, Wire Harness
Configuration, Teamcenter Automotive Edition, and GM Overlay.
GM PAD/TWP Customization Installs additional GM data types for PAD/TWP Customization. This feature
requires Teamcenter Foundation, GM Overlay, Customization for eM-
Server Integration, and PAD/TWP Customization.
BOM Management Features that support Product Master Management.
Product Master Adds support for product master definition in Teamcenter.
Color BOM Adds support for creating and managing Less Finish, Color Parts, Color
Assemblies, and their usages in a product, and associate color definitions to
enable downstream consumption.
Product Master Manager Product Master Manager features.
(PMM)
Product Installs core capabilities of Product Master Manager.
Master
Manager
CAD-BOM Configures the Teamcenter installation to interact and share visual data with
Alignment Product Master Management. Configuring this feature allows designs
managed by this installation of Teamcenter to be related to parts in use or
parts in products that are managed by Product Master Management.
Color BOM Installs support for managing the color BOM data of an engineering BOM.
for Product
Master
Management
Product Installs support for organizing BOM data into partitions.
Master
Manager
Partition
Management
Integration
CAE Simulation Management Features to support Computer-Aided Engineering (CAE) Simulation
Management in Teamcenter.
Simulation Process Installs Simulation Process and Data Management, a packaged solution that
Management provides unique simulation process and data management capabilities for CAE
engineers and CAE analysts performing analysis work.
Extended Simulation Process Installs extended capabilities of Simulation Process and Data Management.
Management
Product Configurator for Adds Simulation Process and Data Management actions to Product
Simulation Process Configurator.
Management
Product Configurator enables you to formally introduce and manage variability
across your product suite.
Consumer Packaged Goods Features to support Consumer Packaged Goods.
Consumer Products and Installs the Consumer Products and Retail Foundation template, which
Retail Foundation supports datasets that are used to integrate Teamcenter with external graphics
design tools.

Teamcenter Installation on Windows, Teamcenter 14.2 23-9

© 2022 Siemens
 23. Solutions and features reference

Feature/Subfeature Description
Finished Product Installs the Finished Product Management functionality for Consumer
Management Packaged Goods.
Specification Manager Installs the Specification Manager feature.
Brand Management Installs the Brand Management template for Consumer Packaged Goods.
CPG Materials Installs Consumer Packaged Goods objects such as raw materials, formulated
materials, and so on.
Packaging and Artwork Installs packaging and artwork functionality for Consumer Packaged Goods.
Consumer Product Installs consumer product management functionality for Consumer Packaged
Management Goods.
Finished Product Provides a bridge between finished products and Consumer Packaged Goods
Management to CPG materials.
Materials Bridge
Packaging and Artwork to Provides a bridge between Packaging and Artwork and Finished Product
Finished Product Management for Consumer Packaged Goods.
Management Bridge
Content and Document Management Content and document management features.
Acrobat/Reader Plugin Installs the Teamcenter plug-in for Adobe Acrobat and Adobe Acrobat Reader.
This solution is optional.
Content Management Base Installs the data model for Content Management.
Content Management DITA Enables management of documentation for the DITA standard in Content
Management.
Content Management Enables management of documentation for the S1000D standard in Content
S1000D Management.
Content Management Enables management of documentation for the S1000D 4.0 standard in
S1000D 4.0 Content Management.
Engineering Process Management Engineering Process Management features.
Spatial Search Installs Spatial Search capabilities of the cacheless search engine.

This feature requires Dispatcher Server.

Cacheless search is installed with Teamcenter Foundation, but its capabilities

must be enabled through TEM.
Bounding box generation Enables generation of bounding box data from JT files, providing secondary
from JT data for the cacheless search engine.

This feature requires Dispatcher Server. Also, during Teamcenter installation,

you must install the Spatial Search translator (JtToBboxAndTso).

Cacheless search is installed with Teamcenter Foundation, but its capabilities

must be enabled through TEM.
Trueshape generation from Enables generation of Trushape data from JT files, providing secondary data
JT for the cacheless search engine.

This feature requires Dispatcher Server. Also, during Teamcenter installation,

you must install the Spatial Search translator (JtToBboxAndTso).

Cacheless search is installed with Teamcenter Foundation, but its capabilities

must be enabled through TEM.
Bounding Box generation Enables generation of bounding box data when saving NX files, providing
from NX secondary data for the cacheless search engine.

23-10 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Teamcenter features

Feature/Subfeature Description
Cacheless search is installed with Teamcenter Foundation, but its capabilities
must be enabled through TEM.
Enterprise Knowledge Foundation Enterprise Knowledge Foundation features.
Remote Workflow Configures linking between Teamcenter sites for remote workflow operations.
This option is applicable only when you are deploying the four-tier
architecture.

Prerequisites:

• Remote Workflow components must be separately installed and configured.

• The web tier application, including the optional Remote Workflow

parameters, must be installed and configured.

Required information:

• Host name and port number of the Java servlet running the Teamcenter
Application Registry.

• The host name and port number of the host running a web tier application.

• If you are linking to Teamcenter portfolio, program and project

management, the chooser servlet name.
Teamcenter Client for Installs the Teamcenter Client for Microsoft Office.
Microsoft Office
Change Management Provides a flexible change management framework that integrates with other
Teamcenter products.

If you install this feature, you may need to set the HiddenPerspectives
preference in the rich client.
Contract Data Management Installs Contract Data Management, which allows you to manage, initiate
review processes, and monitor correspondence for procurement documents,
such as design information, drawings, status reports, purchase orders, and so
on.
Dispatcher Client for Rich Installs Dispatcher Client for the rich client. This feature requires Teamcenter
Client Rich Client 2-tier or Teamcenter Rich Client 4-tier.
Finish Management Installs Finish Management for Teamcenter. A finish represents a finishing
process on a part. It may be used to improve appearance, adhesion, corrosion
resistance, tarnish resistance, chemical resistance, wear resistance, and
remove burrs and so on.
Stock Material Installs the Stock Material feature for Teamcenter.

Many parts are made from stock materials such as bar stock, tubing stock and
sheet stock. This features enables you to manage stock materials in
Teamcenter, performing actions like creating libraries of stock materials and
assigning stock materials to parts.
Work Package Management Enables management of work packages in Teamcenter.

Work packages or packages are typically collections of CAD files and

documentation that outsourcing partners require to build, test or maintain
components or subassemblies of larger products. Packages serve as revisable
collections of product information that can be used in a variety of contexts.

Teamcenter Installation on Windows, Teamcenter 14.2 23-11

© 2022 Siemens
 23. Solutions and features reference

Feature/Subfeature Description
Issue Management Installs Issue Manager, which allows you to track problems, or issues, with
products by managing the review, approval, and implementation of issues.
Render Document for Rich Provides Render Management capabilities for the rich client. This feature
Client requires Dispatcher Client for Rich Client.
Dispatcher Server Installs the following Dispatcher Server components: scheduler, module and
administration client.
Penetration Request Installs the penetration request management feature.
Management
This feature requires the Change Management and Issue Management
features and also Teamcenter Foundation or a rich client.
Dispatcher Client (4-tier) Installs an integration of the Dispatcher Server and Teamcenter for the four-
tier rich client that enables users to translate Teamcenter data files to various
visualization formats for viewing in Teamcenter. This feature requires
Teamcenter Foundation.
Dispatcher Client (2-tier) Installs an integration of the Dispatcher Server and Teamcenter for the two-tier
rich client that enables users to translate Teamcenter data files to various
visualization formats for viewing in Teamcenter. This feature requires
Teamcenter Foundation.
Lifecycle Visualization Features to support Lifecycle Visualization.
Teamcenter Visualization Installs the embedded viewer for the rich client. This feature requires
(Embedded) for Rich Client Teamcenter Rich Client 2-tier or Teamcenter Rich Client 4-tier.
Teamcenter Visualization Installs stand-alone application viewer for the rich client. This feature requires
(Stand-alone) for Rich Client Teamcenter Rich Client 2-tier or Teamcenter Rich Client 4-tier.
Localization Features that support localization of Teamcenter.
Classification L10N Installs the classification localization template, which enables localization in
the Classification environment.
Service Lifecycle Management Teamcenter service lifecycle management features.
As-Built Management Installs the As-Built template for Teamcenter service lifecycle management.
As-Maintained Management Installs the As-Maintained feature to support the As-Maintained physical
structure management for Service Manager.
Service Planning Installs the Service Planner application that supports service planning
capabilities within Teamcenter. Service Planner requires a separate license and
is installed as an optional overlay to standard Teamcenter.
As-Built and As-Maintained Enables interoperability of data created by the As-Built Management and As-
Alignment Maintained Management features of Service Manager.
Service Event Management Installs Service Event Management to support service process management for
Teamcenter service lifecycle management.
Service Planning and Service Installs the Service Planning functionality for Service Processing.
Processing Alignment
Service Request Processing Installs the Service Planning and Service Processing Alignment module to
support using discrepancies in Service Planner.
Service Scheduler Installs Service Scheduler, which supports scheduling within Teamcenter.
Service Scheduler lets companies define, schedule, and implement services for
their products. Service Scheduler is a separately licensed application that is
installed as an optional overlay on top of standard Teamcenter and Service
Manager.

23-12 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Teamcenter features

Feature/Subfeature Description
Next Generation Service Enables Next Generation Service Planning capabilities. With this feature, the
Planning Service Planner is able to create Service Requirements and the subsequent
capabilities.
SLM Automated Scheduling SLM Automated Scheduling features.
1.0
Service Installs the Service Forecasting plug-in to Service Scheduler.
Forecasting
Service Installs the Service Automated Scheduling plug-in to Service Scheduler.
Automated
Scheduling
Manufacturing Process Management Teamcenter manufacturing process management features.
Advance Planner Installs Advance Planner, which configures Teamcenter installation to scope
and report data during pre-planning activities to determine the plant in which
a vehicle will be built. This feature will assist in determining cost and plant
space needed within Line Designer.
Composites Process Installs Composites Process Planning, which leverages the benefits of
Planning Manufacturing Process Management BOM and BOP to plan and manufacture
composite parts.
Customization for eM-Server Installs additional data types for Tecnomatix server integration customization.
Integration
Logistic Process Planning Installs the logistic process planning feature for Manufacturing Process
Planner.
MTM Data Card Installs the Methods Time Measurement (MTM) data card system for
Manufacturing.
Manufacturing Foundation Installs core functionality of Manufacturing Process Management.
Work Instructions Installs the work instructions feature for Manufacturing Process Planner.
Customization for Process Installs additional data types for Process Simulate Integration Customization.
Simulate Integration
Database Configuration for Installs the database configuration for Dimensional Planning and Validation
DPV (DPV). This feature requires Teamcenter Foundation and Customization for
eM-Server Integration.

For more information, see Deploying Dimensional Planning and Validation in

DPV help.
MES Integration Installs the Manufacturing Execution System Integration (MES Integration),
which collects the bill of process, bill of materials, and any relevant work
instructions into a work package that is released to the MES system.
Manufacturing Installs additional data types for Manufacturing Characteristics Information.
Characteristics Information
eBOP Reports Customization Installs additional data types for eBOP Reports Customization. This feature
requires Teamcenter Foundation and Customization for eM-Server
Integration.
MES Issue Management Installs additional data types required for shop floor issue management when
integrating with a manufacturing execution system. This feature provides Issue
Manager support for the Manufacturing Execution System Integration (MES
Integration).
PAD/TWP Customization Installs additional data types for PAD/TWP Customization. This feature requires
Teamcenter Foundation and Customization for eM-Server Integration.

Teamcenter Installation on Windows, Teamcenter 14.2 23-13

© 2022 Siemens
 23. Solutions and features reference

Feature/Subfeature Description
Manufacturing support for Installs additional data types required to work with 4th Generation Design
4th Generation Design (4GD) objects in Manufacturing Process Planner.
Mechatronics Process Management Features to support Mechatronics Process Management.
EDA for Business Modeler Integrates Teamcenter EDA with the Business Modeler IDE.
IDE
For information about installing EDA, see the EDA help under
Teamcenter→Electronic Design Automation (EDA).
EDA Server Support Installs the dataset types and transfer modes required to support Teamcenter
EDA, the application that integrates ECAD applications with Teamcenter.

For information about installing EDA, see the EDA help under
Teamcenter→Electronic Design Automation (EDA).
EMPS - Foundation Installs electronic design and manufacturing types to support ECAD translation
and PCB design collaboration using Teamcenter embedded viewer.
ESM Base Installs ESS base types and updates preferences. Without these, ESS operations
do not work from any interface (rich client, custom utilities, and other clients).
SCM ClearCase for Installs ClearCase types and sets Teamcenter preferences to enable the
Foundation integration between Teamcenter and the IBM ClearCase software
configuration management (SCM) tool.

For more information about installation, see the Teamcenter ClearCase

Integration.
Calibration and Installs the Calibration and Configuration Data Management (CCDM) feature
Configuration Data for Embedded Software Solutions, which allows you to manage the calibration
Management and configuration-related parameter data of embedded systems. CCDM allows
you to define, create, view, update, and delete parameter data, and to group
related parameter definitions together and associate parameter values to a
project.
ECAD Part Library Installs ECAD part types to support ECAD part library management. This
Management feature requires Teamcenter Foundation, Vendor Management, and EDA
Server Support.
ESM Processor Installs ESS processor types and updates preferences. Without these, ESS
operations do not work from any interface (rich client, custom utilities, and
other clients).
ESM Software Installs ESS software types and updates preferences. Without these, ESS
operations do not work from any interface (rich client, custom utilities, and
other clients).
Electrical and Wire Harness Installs Teamcenter schema support for wire harnesses.
Configuration
Embedded Software Design Installs Embedded Software Design Data Management for Embedded
Data Management Software Solutions.
Multi-Disciplinary Installs multidisciplinary (MD) associations in Teamcenter.
Associations
Multidisciplinary (MD) objects help facilitate collaboration between various
disciplines during the product design phase.
Model Management Features to support the Model Management solution.
Model Management provides a framework for integrating modeling tools like
MATLAB Simulink, AMESim, Modelica, and so on with Teamcenter.
Server Model Management server features.

23-14 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Teamcenter features

Feature/Subfeature Description
LMS System Enables System Synthesis artifacts such as model template and core
Synthesis architecture in Active Workspace. These artifacts are created in Teamcenter by
Modeling System Synthesis, which is a framework for the numerical integration of
heterogeneous behavioral models issued by different authoring platforms,
such as LMS AMEsim or MATLAB/Simulink.
Model-Based Systems Engineering Features that support Model-Based Systems Engineering. For more
information about these features, see Model-Based Systems Engineering in
the Active Workspace help.
Teamcenter Test Installs support for test management in Teamcenter.
Management
Test management (or verification management) is part of verification and
validation, which are similar but distinct processes of Model-Based Systems
Engineering (MBSE). It is used to check that a product or system meets
requirements and specifications established to fulfill its intended purpose.
Physical Verification Installs support for verification request management.
Management
For more information about this feature, see the topics about verifying system
models in Model-Based Systems Engineering in the Active Workspace help.
Part Manufacturing Part Manufacturing features.
Part Manufacturing Installs the Part Manufacturing Shopfloor integration for Part Manufacturing.
Shopfloor Integration
NX Fixed Plane Additive Installs the NX Fixed Plane Additive Manufacturing Integration, which enables
Manufacturing Integration importing of Additive Manufacturing printer files into datasets under fixed
plane Additive Manufacturing activities.
NX Machining Line Planner Installs the Machining Line Planner Integration for NX.
Integration
Platform Extensibility Platform extensibility features.
Global Services Global Services features.
Global Installs preferences for Global Services.
Services
Preferences
Mapping Installs the Mapping Designer, which supports mapping of data, usually field-
Designer by-field, between applications.
Multisite Installs the distributed services manager (IDSM) required to replicate data
Collaboration between multiple Teamcenter sites, enabling the exchange of data objects
IDSM Service with other Teamcenter databases over a wide area network (WAN).
Multisite Installs the object directory service (ODS) required to replicate data between
Collaboration multiple Teamcenter sites, enabling the exchange of data objects with other
ODS Service Teamcenter databases over a wide area network (WAN).
Catia Non Installs the CATIA Non BOM feature.
BOM
ERP Connect Installs the ERP Connect Toolkit interface that integrates Teamcenter with
other Enterprise Resource Planning (ERP)-supported applications, such as
BAAN.
Linked Data Framework Linked Data Framework Services features.
Services
Java EE Based Installs web services that allow other lifecycle tools to use Teamcenter services
Linked Data like change management. This feature builds the OSLC WAR file and installs
Web Services the Linked Data Services (LIS) core service.

Teamcenter Installation on Windows, Teamcenter 14.2 23-15

© 2022 Siemens
 23. Solutions and features reference

Feature/Subfeature Description
LDF Installs the linked data framework for Linked Data Services. This feature
Foundation enables linking external applications to Active Workspace.
LDF Installs the Requirements Management integration module of Linked Data
Requirement Services (LIS).
s
Management
Integration
LDF Installs the Embedded Software Management integration module of Linked
Embedded Data Services (LIS).
Software
Management
Integration
Portfolio, Program and Project Portfolio, Program and Project Management features.
Management
Workflow to Scheduling Allows workflow to send updates to the related tasks in a schedule. This
Integration feature requires a four-tier installation and Dispatcher to be installed/
configured. This feature requires Teamcenter Foundation.

You must create the proxy user account (projproxy) before you install the
Workflow to Scheduling Integration.
Reporting and Analytics Features to support Teamcenter Reporting and Analytics.
Teamcenter for Reporting Installs the Teamcenter Reporting and Analytics (TcRA) integration. TcRA is a
and Analytics standalone reporting application that introduces a new folder in Report Builder
called TcRA Reports, which contains reports created with TcRA.
Dashboard Installs the Teamcenter Reporting and Analytics dashboard interface.
Reuse and Standardization Reuse and Standardization features.
Presentation Layer - Next Installs the Next Generation Classification foundation feature for Library
Generation Classification Management.
Foundation
Classification Standard Installs standard taxonomy support for Classification.
Taxonomy support
Library Management Installs a data model and functionality for Library Management that supports
creating and configuring multiple libraries to meet the reuse needs of business
processes and targeted sets of users. Library Management leverages
Classification and includes a rules-based search capability for enforcing
technical constraints in the context of a design process (known as
Specifications, which is a distinct and separate feature from Specification
Manager used to support the Consumer Packaged Goods industry).

The lbrmanager command line utility is also included with this feature.

Deploying the Library Management feature automatically deploys the

following prerequisite features:

• Advanced PLM Services for Applications

• Advanced PLM Services for Partitioning
• Advanced PLM Services for Realization
• Next Generation Classification foundation
Supplier Relationship Management Supplier Relationship Management features.
SRM Integration Installs the Supplier Relationship Management integration for data exchange.
Vendor Management Installs the optional Vendor Management solution.

23-16 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Teamcenter features

Feature/Subfeature Description
Systems Engineering and Features that support Systems Engineering and Requirements Management.
Requirements Management
Teamcenter Extensions for Installs Teamcenter Extensions for Microsoft Office.
Microsoft Office
Requirements Management Installs the Requirements Management functionality for Systems Engineering
for Rich Client and Requirements Management.
Systems Engineering Installs the Systems Engineering application, which provides capabilities such
as functional modeling and budgets.

This feature requires the Teamcenter Foundation feature and also a rich
client or a two-tier Business Modeler IDE client.
Teamcenter Integration for I-deas Teamcenter Integration for I-deas features.
Teamcenter integration for I- Installs data model for Teamcenter integration for I-deas.
deas - Database Extensions
Teamcenter Integration for NX Teamcenter Integration for NX features.
NX Part Family Classification Installs core functionality of Teamcenter Integration for NX. This feature
Integration requires a local installation of NX.

Teamcenter Integration for NX is a data management tool used with NX. When
you use NX with this integration, Teamcenter runs at the same time as a
separate process, enabling NX and Teamcenter to communicate so you can
create, store, and access your NX data within a Teamcenter database.

For information about using Teamcenter Integration for NX, see Teamcenter
Integration for NX in the NX help.
NX Multi-User Notifications This feature configures the Teamcenter installation to enable multi-user design
notifications microservice for NX. This feature allows users to publish and
receive design activity notifications from the NX desktop application.
NX Foundation Installs default data types and loads template NX data to support Teamcenter
Integration for NX, the Teamcenter integration with Siemens Digital
Industries Software NX.
NX Logical Installs logical data model for Teamcenter Integration for NX.
NX Rich Client Integration Installs Teamcenter Integration for NX for the rich client. This feature requires
Teamcenter Rich Client 2-tier or Teamcenter Rich Client 4-tier.
NX Change Management Installs Change Management support for Teamcenter Integration for NX.
For information about using Teamcenter Integration for NX, see Teamcenter
Integration for NX in the NX help.
NX Staged Models This feature configures the Teamcenter installation to support stage model
application for NX. This feature allows users to publish manufacturing process
steps of a design part to Teamcenter from the NX desktop application.
NX 4th Generation Design Installs 4th Generation Design (4GD) support for Teamcenter Integration for
NX.

4GD allows users of NX CAD or Lifecycle Visualization to cooperate in real time

during the design cycle of a product.
NX Piping and Installs support for managing NX piping and instrumentation diagram/drawing
Instrumentation Diagram (P&ID) files in Teamcenter. Teamcenter supports P&ID files as part of its
(P&ID) Design support for multi-disciplinary (MD) objects.

NX Piping and Instrumentation Diagram (P&ID) Design is not supported with

Teamcenter Rapid Start. This feature is only available in Teamcenter.

Teamcenter Installation on Windows, Teamcenter 14.2 23-17

© 2022 Siemens
 23. Solutions and features reference

Feature/Subfeature Description
Teamcenter Quality platform Features to support Teamcenter Quality functionality.
Quality Base Adds Teamcenter Quality support to Teamcenter.

For more information, see Teamcenter Quality in the Active Workspace help.
Control and Inspection Plan Installs support for control and inspection planning.
Data Model
This feature allows you to manage critical characteristics of Failure Mode Effect
Analysis (FMEA) and create a control plan that generates bill of process (BOP)
elements.
Quality Issue Management Installs Issue Manager capabilities for Teamcenter Quality.
and Problem Solving base
Miscellaneous Additional Teamcenter features.
Color and Visual Appearance This feature provides appearance parameters such as color, gloss, and texture
Management along with a color specification. The combination of color, gloss, and texture
with the color specification is called a visual appearance. Once a visual
appearance is defined, it can be associated with objects such as parts in the
BOM system.

This feature is automatically selected when you select Color BOM for Product
Master Management.
LOGISTICS for Rich Client Installs the logistics feature for the rich client.

23-18 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace Server Extensions features

Active Workspace Server Extensions features

Active Workspace Server Extensions features are available in the Features panel in Teamcenter
Environment Manager (TEM), under Base Install→Active Workspace→Server Extensions.

To search for a feature by name, type the name or a partial name in the search box, and then click the
search button.

Feature Description
Active Workspace Adds binaries to TC_ROOT and data model changes to the database and TC_DATA. It adds the Active
Workspace (aw3_template.xml) template to the database.
Active Collaboration Allows users to communicate between themselves using Active Workspace.

Adds the Active Collaboration (ac0activecollaboration_template.xml) template to the database.

If you are installing this feature, you should also install the Active Collaboration feature (under
Client) when building the Client web application.
Active Content If you plan to index structure data, you must install this feature. It provides functionality and data
Structure model extensions necessary for indexing structure data. It adds the Active Content Structure
(activeworkspacebom_template.xml) template to the database.

If you are installing this feature, you should also install the Active Content feature (under Client)
when building the Client web application.
Active Workspace Installs server support for the Assistant, a guided navigation tool for Active Workspace. It predicts the
Assistant next likely actions a user will perform based on the user's history, group, and role, and presents
suggested actions in the Assistant panel. This feature requires the Command Prediction Service
microservice and a database for the microservice to store data for the Assistant. TEM prompts you
for the necessary database creation values during installation.

To enable client support for the Assistant, install the Active Workspace Assistant client feature.
Active Workspace Adds support for document management in Active Workspace.
Document
Management
Audit Adds Audit Manager capabilities to Active Workspace.

For more information, see Audit Manager in the Teamcenter help collection.
Authorization Active Adds Active Workspace authorization components.
Workspace
Data Exchange Installs an Active Workspace tool that lets you view records of Teamcenter data shared between
Transaction Monitor sites. Transactions monitored include those made using Multi-Site tools (such as data_share,
data_sync, rich client remote export/import, and Active Workspace share/retrieve) and data
exchange tools such as Briefcase import/export. For more information, see Active Workspace
Administration.
Digital Signatures Adds digital signatures functionality to the server. It does not add a database template.
Before selecting this feature, see the additional setup requirements for digital signatures.

If you are installing this feature, you should also install the Digital Signatures feature (under Client)
when building the Client web application.
Google Online Viewer Installs server support for the Google Online Viewer, which enables Google Online features within
Active Workspace, such as viewing and editing Microsoft Office documents without the need for
Microsoft Office applications.

Teamcenter Installation on Windows, Teamcenter 14.2 23-19

© 2022 Siemens
 23. Solutions and features reference

Feature Description
Multisite Integration Adds multisite reporting that enables administrators to identify underlying data issues before
multisite import or export.
Office Online Viewer Installs viewer support for Microsoft Office Online documents.
Order Management Installs Order Management support for Active Workspace. Order Management manages the lifecycle
of an order from inquiry to sales order. A customer inquires about products, a sales person responds
with the offer containing configurable products. Once the offer is accepted by the customer, a sales
order is created that refers to the configurable products.
Program Planning Enables the Program Management capability in Active Workspace. This feature provides the ability to
manage business investments, from planning to execution, in terms of time, reuse, volume, cost
targets, and weight targets.

This feature adds the Program Planning for Active Workspace

(pgp0awprgplanning_template.xml) template to the database.

This feature is not selectable unless the Program Planning Infrastructure feature (under
Extensions) is also selected.

If you are installing this feature, you should also install the Program Planning Client feature (under
Client ) when building the Client web application.
Relationship Viewer Adds the Relationship Viewer (relationshipviewer_template.xml) template to the database.

If you are installing this feature, you should also install the Relationship Browser feature (under
Client) when building the Client web application.
Reporting Provides the ability to view report templates, generate reports based on selected criteria, style
sheets, or both, and view them in HTML, Excel, or raw XML formats. It adds the Reporting for Active
Workspace (rb0reportingaw_template.xml) template to the database.

If you are installing this feature, you should also install the Reporting feature (under Client) when
building the Client web application.

Additionally, to allow for asynchronous report generation, install the AsyncService translator in the
Dispatcher Server.
Schedule Manager Enables Schedule Manager capabilities in Active Workspace.

It adds the Schedule Manager for Active Workspace

(saw1projectmanagementaw_template.xml) template to the database.

If you are installing this feature, you must also install the Schedule Manager feature (under Client)
when building the Client web application.
Shape Search Provides the binaries and data model extensions for the shape search functionality. It adds the
Shape Search for Active Workspace (shapesearch_template.xml) template to the database. To
use shape search, Geolus must be installed and configured.

If you are installing this feature, you should also install the Shape Search feature (under Client)
when building the Client web application.
Stock Material Adds stock material management to Active Workspace.

Many parts are made from stock materials such as bar stock, tubing stock and sheet stock. This
features enables you to manage stock materials in Teamcenter, performing actions like creating
libraries of stock materials and assigning stock materials to parts.

For more information, see Aerospace and Defense Solution in the Teamcenter help collection.
Subscription Allows users to manage subscriptions and notifications. It adds the Subscription
(sub0subscription_template.xml) template to the database.

If you are installing this feature, you must also install the Subscription feature (under Client) when
building the Client web application.

23-20 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace Server Extensions features

Feature Description
Work Package Adds work package management to Active Workspace.
Management
A work package or package is a collection of CAD files and documentation that an outsourcing
partner uses for building, testing, or maintaining a component or subassembly of a larger product.

Teamcenter helps to create and maintain the package as a revisable collection or a container of
product information and to use in a variety of contexts.

For more information, see Aerospace and Defense Solution in the Teamcenter help collection.
Access Manager Adds the capability to manage access rule definitions in Active Workspace.
Active Workspace Adds the BOM management overlay for Active Workspace.
Usage BOM
Concurrent Modeling Adds concurrent modeling support in Active Workspace. Concurrent modeling allows you to manage
models from supported 1D modeling tools in Teamcenter, using the Teamcenter MBSE Integration
Gateway MBSE framework.
Contract Data Installs Contract Data Management, which helps contractors manage the creation, review, and
Management delivery of contracts. A contract is a structured procurement document that lists milestones and
schedule dates.

To enable this feature to work in Active Workspace, select the Contract Data Management feature
under Enterprise Knowledge Foundation.
DPV Active Workspace Installs the database configuration for DPV in Active Workspace. This feature requires corresponding
Teamcenter DPV features.
EDA Server Support Adds support for Electronic Design Automation (EDA) to Active Workspace.
for Active Workspace
For information about installing EDA, see the EDA documentation on Support Center.
IP Management Active Provides a product lifecycle management solution for semiconductor manufacturers to manage IP
Workspace data using Teamcenter.
Initiative Planning This feature provides capability to create, discover and realize an Idea leading to the creation of
Active Workspace project. It also provides capability to create and manage campaigns. For more information, see
Initiative Planning in the Active Workspace documentation.
Material Management Enables Active Workspace users to:

• Associate a material revision with a vendor part or an item revision.

• Associate a substance with a material revision.

• View the Material/Substance Dashboard.

This feature adds the Material Management for Active Workspace

(mtw0materialmgmtaw_template.xml) template to the database.

This feature is not selectable unless the Material Management feature (under
Extensions→Enterprise Knowledge Foundation) and Active Content Structure (under Server
Extensions) are also selected.

If you install this feature, you should also install the Material Management feature (under Client)
when building the Client web application.
Part Manufacturing Adds Part Manufacturing support to Active Workspace.
Active Workspace
Vendor Management Allows Active Workspace users to:

• Associate vendors with vendor parts.

Teamcenter Installation on Windows, Teamcenter 14.2 23-21

© 2022 Siemens
 23. Solutions and features reference

Feature Description
• Associate vendor parts with commercial part revisions.

This feature adds the Vendor Management for Active Workspace

(vm1vendormanagementaw_template.xml) template to the database.

This feature is not selectable unless the Active Content Structure feature and the Vendor
Management feature (under Extensions→Supplier Relationship Management) are selected.

If you are installing this feature, you should also install the Vendor Management feature (under
Client) when building the Client web application.
Visualization This feature is required to launch the Teamcenter lifecycle visualization stand-alone application
Extension viewer from the Client interface.

This feature enables Active Workspace 3D viewer functionality. It adds the Active Workspace
Visualization (awv0activeworkspacevis_template.xml) template to the database.

You must install this feature if you install the Visualization Server Manager feature (under
Visualization Server) when building the Client web application.

The Visualization Extension feature is not selectable unless the Active Content Structure feature is
also selected.
Workflow Workflow does not add a template to the database.

If you are installing this feature, you must also install the Workflow feature when building the Client
web application.

For users to access Inbox components and workflow functionality in the Client interface, Workflow
must be installed on the corporate server and Workflow must be installed in the Client web
application.
Electronic Work Installs the server side of Electronic Work Instructions in your environment.
Instructions
Finish Management Installs Finish Management support for Active Workspace. A finish represents a finishing process on
a part. It may be used to improve appearance, adhesion, corrosion resistance, tarnish resistance,
chemical resistance, wear resistance, and remove burrs and so on.

For more information, see Aerospace and Defense Solution in the Teamcenter help collection.
Product Configurator Adds Product Configurator functionality for Active Workspace. Product Configurator enables you to
formally introduce and manage variability across your product suite.
For more information, see Product Configurator in the Teamcenter help collection.
Requirements Allows users to author a requirement structure in the Content tab of the Client. Adds the Active
Management Workspace Requirements Management (arm0activeworkspacereqmgmt_template.xml)
template to the database.

This feature is not available with Teamcenter Rapid Start.

The Requirements Management feature is not selectable unless the Active Content Structure
feature is also selected.

If you are installing this feature, you must also install:

• Server Extensions→Workflow

• Extensions→Systems Engineering and Requirements Management→Requirements

Management feature on the corporate server.

• Requirements Management feature when building the Client web application.

23-22 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace Server Extensions features

Feature Description
Teamcenter Adds support for Teamcenter Manufacturing Access to Active Workspace.
Manufacturing Access
Teamcenter Manufacturing Access provides solutions for various manufacturing planning tasks and
business processes. It is designed as a cross-industry tool; use it in any environments where Process
Simulate is used.

For more information about Teamcenter Manufacturing Access, see Easy Plan help.
Capital Asset Lifecycle Adds management of plant data to Active Workspace.
Management AW
Easy Plan - Product Adds support for Product Configurator in Easy Plan. Product Configurator allows you to enable
Configurator definitions for variant formulas on operations.
Extension
Please see the Product Configurator (Administrator) documentation for installation details.
To use Product Configurator variants, you must run Teamcenter 11.5 or later. By default, Easy Plan
uses classic variants.
Embedded Software Installs embedded software management capabilities for Active Workspace.
Management for
Active Workspace
Medical Device Installs Active Workspace server extensions to support product development processes for medical
Foundation device manufacturers. This feature assists in ensuring compliance with regulatory guidelines,
accelerating innovation in development, and reducing costs.
Product Configurator Installs capabilities related to solution variants in Active Workspace.
Support for Active
Content Structure
Product Master for Installs product master automation for Active Workspace.
Active Workspace
Requirements Adds Teamcenter Quality functions to Requirements Management.
Management - Quality
Module
Systems Engineering Installs support for the Systems Modeling solution in Active Workspace, which enables users to
for Active Workspace create composition diagrams, interface specifications, and other Systems Modeling items.
4th Generation Design Allows users to view, navigate, and configure collaborative designs and their content in the Client.

It adds the 4th Generation Foundation (fgd0aw4gfoundation_template.xml) and 4th

Generation Design (fgd0aw4gdesign_template.xml) templates to the database.

The 4th Generation Design feature is not selectable unless the Active Content Structure feature
(under Server Extensions) and the 4th Generation Design feature (under Extensions→Advanced
PLM Services) are also selected.

If you are installing this feature, you must also install the 4th Generation Design feature when
building the Client web application.
Color BOM for Active Adds support in Active Workspace for creating and managing Less Finish, Color Parts, Color
Workspace Assemblies, and their usages in a product, and associate color definitions to enable downstream
consumption.
Easy Plan - Process Installs the Process Planning workspace for build-to-order (BTO) or build-to-stock (BTS), or configure-
Planning for to-order (CTO) in your environment.
BTO/BTS/CTO
Adds these templates to the database:

• Manufacturing core for BVR/Data Model (mbc0mfgbvrcore_template.xml)

• Process Planning Change Management/Data Model (epc0mfgbvrmaturity_template.xml)

Teamcenter Installation on Windows, Teamcenter 14.2 23-23

© 2022 Siemens
 23. Solutions and features reference

Feature Description
• Process Planning Line Balancing/Data Model (elb0linebalancing_template.xml)

• Process Planning Time Analysis/Data Model (ept0timeanalysis_template.xml)

Initiative Lifecycle Installs support for Initiative Lifecycle Management (ILM) in Active Workspace. This solution unifies
Management (ILM) business processes from ideation to production. This includes management of campaigns, ideas,
Active Workspace programs, and projects. ILM leverages program planning capabilities and combines those with
process groups that distribute work to participants. For more information, see Initiative Lifecycle
Management in the Active Workspace documentation.
Machine Builder Installs support for the Machine Builder solution in Active Workspace. This solution provides a single-
source data management system focused on the engineering, manufacturing and product life BOM.
This solution is designed to enable industrial machinery customers to move from CAD data
management to engineering process management, integrating requirements management, project
management, and change management.
Manufacturing BOM Adds Multi-BOM Manager support to Active Workspace. Multi-BOM Manager enables you to link and
Manager assign content across representations for different lifecycle stages or uses for a product.

For information about using this feature, see Mutli-BOM Manager in the Teamcenter help library.
Medical Device Provides support for performing end-to-end medical device label authoring, object-based content
Submissions for Active management, Unique Device Identifier (UDI) data management and submissions for medical
Workspace industry customers.
Partitions for Structure The Partitions for Structure feature is required to get the partitions that are in turn required to
organize the contents of a product structure.
Process Planning and Installs support for the Engineering to Order (ETO) workspace in your environment.
Work Instructions
authoring for ETO This feature allows end users to author work instructions at the process station level.

Electronics Process Installs the Easy Plan Electronics Process Planner workspace in your environment.
Planner
Electronics engineers use Production Process Planning for the systems integration of the electronics
process planning tasks of Easy Plan and those of Valor Process Preparation Software. The systems
integration is available as a dedicated, optional feature of Production Process Planning.

Adds these templates to the database:

• Manufacturing core for BVR/Data Model (mbc0mfgbvrcore_template.xml)

• Production Process Planning Change Management/Data Model

(epc0mfgbvrmaturity_template.xml)

• Production Process Planning Line Balancing/Data Model (elb0linebalancing_template.xml)

• Production Process Planning Time Analysis/Data Model (ept0timeanalysis_template.xml)

Initiative Lifecycle Initiative Lifecycle Management (ILM) support for Active Workspace with objects and processes
Management - CPG specific to the Consumer Packaged Goods industry. For more information, seeInitiative Lifecycle
Reference Management - Consumer Packaged Goods Reference Implementation.
Implementation
Initiative Lifecycle Adds support for program planning and idea management for semiconductor manufacturers.
Management Overlay
for Semiconductor
Solution
Manufacturing Enables Manufacturing Resource Library functionality in Active Workspace, allowing users to create,
Resource Manager search, and manage resources needed for Manufacturing processes.
(MRL)

23-24 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace Server Extensions features

Feature Description
For information about using Manufacturing Resource Library, see the Teamcenter help library.
Semiconductor Provides a product lifecycle management solution for semiconductor manufacturers to manage
Foundation Active semiconductor design and manufacturing data using Teamcenter.
Workspace
Component Provides features for component supplier in Teamcenter X that enable you to simplify the user
Manufacturer Active experience for specific user roles, and more easily manage projects and programs. This application
Workspace can help all stakeholders in the engineering process manage engineering data as well as project data
in a simple and synchronized manner.
Next Generation Adds Next Generation Planning (NGP) support to Active Workspace.
Planning Client
Next Generation Planning is the 4G based solution for manufacturing planning. It is suitable for
industries where the product being produced is very large, the number of products being built is
small and the production build starts before final design is complete and continuously changes. It
supports the main business processes like initial/conceptual and detailed manufacturing planning,
and change management.
Active Admin Features to support Active Admin capabilities.
Active Workspace Adds support for user management in Active Workspace.
User Management
Preference Adds server support for preference management in Active Admin. Preference management features
Management in the active admin workspace are added by the corresponding Active Workspace client feature.
Viewer Adds viewer administration to the Active Admin workspace in Active Workspace.
Administration
Active Architect Features to support Active Architect capabilities.
Client Adds client configuration to the Active Admin workspace in Active Workspace.
Configuration
Logical Object Adds logical objectsupport to the Active Admin workspace in Active Workspace.
XRT Editor Adds XRT Editor to the Active Admin workspace in Active Workspace.
Aerospace and Aerospace and Defense features. These allow Active Workspace users to:
Defense
• Create and view parts list: technical documents, parts, drawings, and designs.

• Work with notes: create standard notes and custom notes and attach them to technical
documents, parts, drawings, and designs.

• Work with Aerospace and Defense-related changes: create, edit, and search change requests,
change notices, and deviation requests in alignment with the out-of-the-box Change
Management functionality.
Aerospace and Adds the Aerospace and Defense Foundation Active Workspace
Defense (ads1awadsfoundation_template.xml) template to the database. This feature is not selectable
Foundation unless the following features are also selected:

• Teamcenter Change Management

• Teamcenter Change Management (for Active Workspace)
• Active Workspace Indexing Engine under Active Workspace→Indexing Server
• Active Workspace Indexer under Active Workspace→Indexing Server
• Active Workspace under Active Workspace→Server Extensions
• Active Content Structure under Active Workspace→Server Extensions
• Vendor Management under Active Workspace→Server Extensions
• Aerospace and Defense Foundation under Active Workspace→ Server
Extensions→Aerospace and Defense

Teamcenter Installation on Windows, Teamcenter 14.2 23-25

© 2022 Siemens
 23. Solutions and features reference

Feature Description
• Aerospace and Defense Foundation under Active Workspace→Client
• Active Workspace Client under Active Workspace→Client
• Aerospace and Defense Change Management under Active Workspace→Client
Aerospace and Installs the change management functionality for the Aerospace and Defense Foundation feature.
Defense Change This feature requires corresponding Teamcenter features.
Management
CAE Simulation Features to support management of computer-aided engineering (CAE) data.
Management
Simulation Process Allows Active Workspace users to author Simulation structures in Active Workspace.
Management
It adds the Simulation Process Management Server (cae1caeaws_template.xml ) template to the
database.

The Simulation Process Management feature is not selectable unless the Active Content
Structure feature and the Simulation Process Management feature (under Extensions ) are also
selected.

If you are installing this feature, you must also install the Simulation Process Management Client
feature when building the Client web application.
Extended Add extended Simulation Process and Data Management capabilities to Active Workspace.
Simulation Process
Management
Simulation Process Supports parameter management data model and functionality in Simulation workflows.
Management with
Parameter
Management
Integrated Program Integrated Program Planning and Execution (IPP&E) server extensions features. The IPP&E solution
Planning and allows project planning that integrates cost, schedule, risk and technical requirements in a fully
Execution planned, resourced, and budgeted program. It allows configuration control, not only of products,
but also of the project plan. It also communicates the status of requirements to users.
Organization Adds Organization Breakdown Structure (OBS) support to IPP&E.
Breakdown
Structure
Work Breakdown Adds support for authoring Work Breakdown Structure (WBS) hierarchy in Active Workspace from top
Structure to bottom. For information about defining work breakdowns, see Schedule Manager in the
Teamcenter help library.
IPP&E Foundation Provides essential functionality for Integrated Program Planning and Execution in Active Workspace.
IPP&E Contract Adds Contract Data Management support to IPP&E.
Data Management
Extension
MRO Service Lifecycle Management features for Active Workspace.
Service Work Adds support for work instructions to Service Lifecycle Management in Active Workspace.
Instructions
As-Built for Active Provides searching and BOM extensions necessary to support MRO As-Built capabilities.
Workspace
This feature is not available with Teamcenter Rapid Start.

In addition to the Active Workspace feature, this feature requires:

• Extensions→Maintenance Repair and Overhaul→As-Built Management

Adds these templates to the database:

23-26 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace Server Extensions features

Feature Description
• MRO Core, Active Workspace BOM Interface (smr1mrocoreaw_template.xml)

• As-Built (sab1asbuiltaw_template.xml)
Service Provides service engineering support for Service Lifecycle Management.
Engineering
Service Event Provides searching and BOM extensions necessary to support MRO Service Event Management
capabilities.

This feature is not available with Teamcenter Rapid Start.

In addition to the Active Workspace feature, this feature requires:

• Base Install→Active Workspace→Server Extensions→MRO→As-Maintained

• Extensions→Maintenance Repair and Overhaul→As-Maintained Management

• Extensions→Maintenance Repair and Overhaul→Service Event Management

Adds these templates to the database:

• Transaction Processing, Active Workspace BOM Interface

(stp1transactionprocessingaw_template.xml)

• Service Processing, BOM Interface (spr1serviceprocessingaw_template.xml)

• Service Event (sem1serviceeventmgmtaw_template.xml)

Service Installs service forecasting capability for Service Request Manager.
Forecasting
This feature requires corresponding Teamcenter features.
Service Planning Installs the Service Planning functionality for Service Processing in Active Workspace.
and Service
Processing
Alignment
Reuse and Features to support Reuse and Standardization in Active Workspace.
Standardization
Classification Allows users to access Classification data in the client interface.
Server
Classification AI Installs the Classification artificial intelligence (AI) engine, which provides assistance in navigating to
desired classes.Classification

After being trained on a database, the engine receives object metadata from the Teamcenter server
and returns the probabilities for potential classes. You can specify which classes are displayed in the
user interface based on these probabilities.
Presentation Layer Installs the Next Generation Classification foundation feature. This option installs the presentation
- Next Generation layer for classification standard taxonomy and for library management.
Classification
Server
Library Enables indexing for Library Management business objects. The Library Management Server
Management feature is not selectable unless the Library Management feature (under Extensions→Reuse and
Server Standardization) is also selected.

Teamcenter Installation on Windows, Teamcenter 14.2 23-27

© 2022 Siemens
 23. Solutions and features reference

Feature Description
Teamcenter Features that support the integration of Teamcenter with NX.
Integration for NX
NX Logical for This feature configures the Teamcenter installation to support logical model for the NX diagramming
Active Workspace application in Active Workspace. This feature allows users to view and navigate diagramming sheets
and logical model content in the Active Workspace client.
NX Staged Models This feature adds support to Active Workspace for stage model application for NX. This feature
for Active allows users to publish manufacturing process steps of a design part to Teamcenter from the NX
Workspace desktop application.
NX for Active Enables users to access NX integration functionality from the client interface. It adds the NX for
Workspace Active Workspace (awn0nx_template.xml) template to the database.

This feature is not selectable unless the NX Foundation feature (under Extensions→Teamcenter
Integration for NX) is also selected.

If you are installing this feature, you should also install the NX Integration feature (under Client)
when building the Client web application.
NX MBSE for Active Adds the NX Integration for Model-Based Systems Engineering .
Workspace
NX P & ID Active Exposes NX P & ID in Active Workspace so that users can view, navigate, and configure sheets and
Workspace their content.

This feature adds the NX P & ID Active Workspace (nxp1pidaws_template.xml) template to the
database.

This feature is not selectable unless these features are also selected:

• NX Foundation under Extensions→Teamcenter Integration for NX

• Active Content Structure under Server Extensions

• 4th Generation Design BOM Management under Extensions→BOM Management

• MDConnectivity under Extensions→Advanced PLM Services

• System Modeling under Extensions→Advanced PLM Services

• Diagramming under Extensions→Advanced PLM Services

• NX Piping and Instrument Diagram (P&ID) Design under Extensions→Teamcenter

Integration for NX

• Systems Engineering under Server Extensions

If you are installing this feature, you should also install the NX Integration feature (under Client)
when building the Client web application.
Teamcenter Quality Features to support Teamcenter Quality.
data model
Quality Action Adds support for quality actions to Active Workspace. This feature is mandatory for all Teamcenter
Management data Quality solutions.
model
For more information, see Teamcenter Quality in the Active Workspace help.

23-28 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace Server Extensions features

Feature Description
Escalation Adds support for escalation workflows for quality actions.
Management
Translator These allow responsible users or quality managers to receive alerts or e-mail notifications to remind
them of their quality actions prior to the due date, thereby avoiding unnecessary delays or
escalations. Additionally, escalation workflows can be initiated for quality actions that are not in the
required state by the due date.

To install the Escalation Management Translator, choose Base Install > Active Workspace >
Server Extension >Teamcenter Quality data model > Escalation Management Translator.

Note:

This feature is available in Teamcenter 13.1 and later releases.

To select Escalation Management Translator, ensure that you select Quality Action Management
and Dispatcher features
Quality Manager Adds support for Quality Manager to Active Workspace.
data model
For more information, see Teamcenter Quality in the Active Workspace help.
Control and Adds support for Control Plan to Teamcenter Quality.
Inspection Plan
For more information, see Teamcenter Quality in the Active Workspace help.
Failure Mode Adds support for Failure Mode Effect Analysis (FMEA) to Teamcenter Quality.
Effect Analysis
(FMEA) data model For more information, see Teamcenter Quality in the Active Workspace help.
Training and Adds training and qualification actions to the Teamcenter Quality module, which allows you to
Qualification create and manage qualifications, qualification profiles, qualification records, and related objects.
APQP Program Adds support for Advanced Product Quality Planning (APQP) methodology to Teamcenter Quality.
Management data
model For more information, see Teamcenter Quality in the Active Workspace help.

Quality Issue Adds support for Issue Manager and Problem Solving to Active Workspace.
Management and
Problem Solving For more information, see Teamcenter Quality in the Active Workspace help.
data model
Quality Audit Enables capturing the status of quality actions in audit logs. A Teamcenter administrator logged into
Active Workspace can view these event logs and navigate to specific quality actions.
Quality Issue Adds the ability to search for Problem Solving objects in Active Workspace.
Management and
Problem Solving
search
Quality Provides support for quality management for the Life Sciences industry. This application enables you
Management for to perform Quality Management related operations like nonconformance management and
Life Sciences Corrective and Preventive Actions (CAPA) Management.
Industry
Supplier Quality Provides support for Supplier Quality Management. This application enables you to perform Supplier
Management Quality management operations with applications like Vendor Management, Advance Product
Quality Planning, and Quality Issue Management and Problem Solving. Supplier Quality
Management is used to evaluate vendor performance based on quality issues and problem solving
processes initiated for supplied materials or parts. It can also assess a vendor using a quality
checklist.
Model-Based Systems Features to support Model-Based Systems Engineering in Active Workspace.
Engineering

Teamcenter Installation on Windows, Teamcenter 14.2 23-29

© 2022 Siemens
 23. Solutions and features reference

Feature Description
LMS System Exposes the System Synthesis artifacts, such as model templates and core architecture, in Active
Synthesis Workspace. These artifacts are created in Teamcenter by System Synthesis, a framework for the
Modeling numerical integration of heterogeneous behavioral models issued by different authoring platforms,
such as LMS Amesim or MATLAB/Simulink.
This feature adds the System Synthesis Modeling for Active Workspace
(ssm1systemsynthesismodelingaw_template.xml) template to the database.

This feature is not selectable unless the System Synthesis Modeling feature (under
Extensions→Systems Driven Product Development) is also selected.
Parameter Adds parameter management support to Active Workspace.
Management
Active Workspace
Teamcenter Test Adds test management support to Model-Based Systems Engineering (MBSE).
Management
Physical Adds support for inspections and physical tests.
Verification
Management
Active Workspace
Active Workspace Features to support Linked Data Framework Services in Active Workspace.
Linked Data
Framework Services
LDF Foundation Provides a framework to link Teamcenter business objects with an artifact of a remote linked data
enabled system. It enables rendering the remote system's delegated user interfaces in Active
Workspace.

This feature adds the Linked data Framework for Active Workspace (ldf0ldfaws_template.xml)
template to the database.

This feature is not selectable unless the Linked Data Framework Support Infrastructure feature
(under Extensions→Platform Extensibility→Linked Data Services) is also selected.

If you install this feature, you should also install the Linked Data Framework feature (under Client)
when building the Client web application.
Active Workspace Installs the Requirements Management integration module of Linked Data Services (LIS).
LDF Requirements
Management This feature requires corresponding Teamcenter features.
Integration
LDF Polarion Types Installs Polarion data types for Linked Data Services (LIS) integration in Active Workspace.
Integration
This feature requires corresponding Teamcenter features.
Active Workspace Installs the Embedded Software Management integration module of Linked Data Services (LIS).
LDF Embedded
Software For more information, see Integrating Applications Using Linked Data Framework in the Teamcenter
Management help collection.
Integration
Consumer Packaged Features to support CPG in Active Workspace.
Goods
For more information, see Getting Started with CPG in the Teamcenter help collection.
Brand Installs the Brand Management template for CPG.
Management
For more information, see Getting Started with CPG in the Teamcenter help collection.
Packaging and Installs packaging and artwork functionality for CPG.
Artwork
For more information, see Getting Started with CPG in the Teamcenter help collection.

23-30 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace Server Extensions features

Feature Description
Specification Installs specification management functionality for CPG.
Management
For more information, see Getting Started with CPG in the Teamcenter help collection.
Consumer Product Installs consumer product management functionality for CPG.
Management
Active Workspace For more information, see Getting Started with CPG in the Teamcenter help collection.

Teamcenter Installation on Windows, Teamcenter 14.2 23-31

© 2022 Siemens
 23. Solutions and features reference

Additional Active Workspace server extensions features

The following Active Workspace server extensions features are available under Base
Install→Extensions in the Features panel in TEM.

Feature Description
Teamcenter Simplified Provides a simplified experience of Teamcenter for small- and medium-sized business customers.
User Experience (UX) redundancies and outlying commands are removed. This allows users to
quickly work on designs, documents and parts within their organization without additional
configuration.
Color Appearance Active Provides the ability to define standard color attributes in Active Workspace.
Workspace
Content Management Adds server-side Content Management support to Active Workspace.
Active Workspace
Product Master Provides the capability to generate the design or BOM data from an existing BOM or design data
Automation for Active from Active Workspace. Given a source BOM, a user can generate a target BOM. The source and
Workspace target BOM could be an engineering BOM or design BOM. For more information, see
Administration of Design BOM and Engineering BOM Alignment.
Active Workspace Enables Active Workspace interaction with Weight and Balance Management. This supports
Weight And Balance functionality such as specifying weight and balance attributes for parts or assemblies, and
Management performing their rollup. For more information, see Structure Management Deployment and
Administration.
Teamcenter SLM Adds support in Active Workspace for searching and bill of materials (BOM) extensions necessary
Integration for Service to support the basic Teamcenter Service Engineering integration with the service execution
Execution, Active system. It also adds data model support for the Teamcenter service lifecycle management (SLM)
Workspace BOM model to enable data mapping and seamless data flow with the service execution system.
Interface
Marine Integration Installs support for Marine Integration in Active Workspace. This functionality supports lifecycle
management of electrical equipment and cables that connecting them, provided by various
electrical design tools. The feature enables creation of BOM structures for electrical equipment and
cables.

23-32 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace Server Extensions features

Model Management Features

Active Workspace adds the following Model Management features under Extensions→Model
Management in the Features panel in TEM.

Feature Description
Active Workspace Model Management applications for the Active Workspace interface.
Branch Console Adds support for organizing model revisions using branching.
RAMS Modeling Configures Teamcenter to support and manage analysis for reliability, availability, maintainability,
and safety in Active Workspace. This feature provides Active Workspace facade objects for RAMS
Modeling artifacts and defines XRTs for them.
Open in Tool Enables the Open in Tool command, which allows you to open modeling tools from Active
Workspace.
Client Model Management applications for Teamcenter clients.
Simulink Integration Installs support for Simulink models in Active Workspace.
Gateway for Model Adds support for model management actions such as export, modify, import, and checkout.
Management
System Modeling Installs the capability to support and manage UML and SysML modeling in Teamcenter.
Integration
Support for Concurrent Installs the generic integration that allows you to import and work with models stored in your file
Modeling system into Teamcenter. This also installs the integration for Git.
Software Management Installs the client components to support software management for MBSE.
Client
Server Model Management components for Teamcenter servers.
GTPOWER Integration Configures the integration of the GT Power modeling tool with Teamcenter. The feature allows
engineers to manage the lifecycles of GT Power models in Teamcenter by performing various
lifecycle operations like save, save-as, revise, check-out, and check-in on GT Power models.
Gateway for Model Adds server support for model management actions such as export, modify, import, and
Management checkout.
LMS Amesim Installs the Teamcenter integration with Amesim. AMESim is a modeling tool used for authoring
Integration 2D plant models.
Simulink Integration Installs support for Simulink models in Active Workspace.
Teamcenter Polarion Installs support for managing artifacts created by the Polarion application.
Direct Integration
IBM Rhapsody Installs support for managing artifacts created by the Rhapsody application for UML and SysML
Integration modeling. This includes support for managing the Rhapsody model directly in Teamcenter.
MagicDraw Integration Installs support for managing artifacts created by the MagicDraw application for UML and SysML
modeling. This includes support for managing the MagicDraw model directly in Teamcenter.
Safety Architect Provides configuration of the Safety Architect Integration in Active Workspace. This application
Integration provides Active Workspace.facade objects for Safety Architect Integration artifacts and defines
icons and XRTs for them.
Software Management Enables ALM and build systems like Jenkins to automate publishing of software project build
artifacts such as binaries, configurations, parametrization, reports, and so on, to Teamcenter. It
captures build details and related information to manage and maintain traceability of hardware
and software products in Teamcenter.

Teamcenter Installation on Windows, Teamcenter 14.2 23-33

© 2022 Siemens
 23. Solutions and features reference

Feature Description
Support for Concurrent Installs the integration that allows you to import and work with models stored in your file system
Modeling into Teamcenter. It also installs the integration for Git.
System Synthesis Provides a framework for the numerical integration of heterogeneous behavioral models issued by
Modeling different authoring platforms such as LMS Amesim or MATLAB/Simulink. This integration provides
a set of specific constructs such as model template and simulation architecture for formalizing
modeling processes and securing models.

Using this application, you can map Teamcenter business objects to the artifacts of Simcenter
System Synthesis, using the Simcenter System Synthesis integration definition file.
Capital Marine Installs the Capital Marine integration for MBSE.
Integration
System Modeling Installs support for System Modeling Workbench objects such as Capella Model and SysML Model.
Workbench Integration
MADe Integration Installs support for managing reliability, availability, maintainability, and safety analysis data
created in the MADe tool from PHM Technology.

Active Workspace also adds this application under Extensions→Model-Based Systems Engineering:

Feature Description
Verification and Validation This application installs the verification and validation
Programming Interface programming interface for MBSE.

Active Workspace Client features

Active Workspace client features are available in the Features panel in Teamcenter Environment
Manager (TEM), under Base Install→Active Workspace→Client.

To search for a feature by name, type the name or a partial name in the search box, and then click the
search icon.

Feature Description
Active Workspace Gateway Installs the Active Workspace Gateway, a web application framework that resides between the
Active Workspace client application and your browser. The Gateway communicates with the
Teamcenter server, the File Repository, and the volume server, and routes incoming requests for
static and dynamic content to the appropriate services handling those requests.
Active Workspace Client Selecting this feature builds the Active Workspace client.
3D Visualization Adds 3D visualization to the Active Workspace client.
Access Manager Client Adds support for managing Access Rule definitions in Active Workspace.
Active Collaboration Client Adds workflow capabilities of Active Collaboration to the client interface.

If you are installing this feature in the Client, you must install the Active Collaboration Server
Extensions feature in the corporate server.
Active Workspace Installs client components of the Assistant, a guided navigation tool for Active Workspace. It
Assistant Client predicts the next likely actions a user will perform based on the user's history, group, and role,
and presents suggested actions in the Assistant panel.

This feature requires the Active Workspace Assistant server extension feature on the
Teamcenter server.

23-34 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace Client features

Feature Description
Active Workspace Adds the 2D Viewer to the Universal Viewer in Active Workspace. Requires the Visualization
Visualization 2D Viewer Server.
Audit Client Adds Audit Manager features to the Active Workspace client.

For more information, see Audit Manager in the Teamcenter help collection.
Content Management Adds Content Management support to Active Workspace.
Client
DPV for Active Workspace Adds Dimensional Planning and Validation functionality to the client interface.
Client
Document Management Installs Document Management support for the Active Workspace client.
Client
Electronic Design Adds Electronic Design Automation (EDA) support in the Active Workspace client.
Automation
Google Online Viewer Installs the Google Online Viewer, which enables Google Online features within Active
Client Workspace, such as viewing and editing Microsoft Office documents without the need for
Microsoft Office applications.
Initiative Lifecycle Installs support for Initiative Lifecycle Management (ILM) in the Active Workspace client. This
Management (ILM) Active solution unifies business processes from ideation to production. This includes management of
Workspace Client campaigns, ideas, programs, and projects. ILM leverages program planning capabilities and
combines those with process groups that distribute work to participants. For more information,
see Initiative Lifecycle Management in the Active Workspace documentation.
Initiative Lifecycle Installs Initiative Lifecycle Management (ILM) support for the Active Workspace client, with
Management - CPG objects and processes specific to the Consumer Packaged Goods industry. For more information,
Reference Implementation see Initiative Lifecycle Management - Consumer Packaged Goods Reference Implementation.
Active Workspace Client
Initiative Planning Active This feature provides capability to create, discover and realize an Idea leading to the creation of
Workspace project. It also provides capability to create and manage campaigns. For more information, see
Initiative Planning.
Logical Object Allows users to access logical object data in the client interface.
Marine Integration Installs client-side support for Marine Integration in Active Workspace. This functionality
supports lifecycle management of electrical equipment and cables that connecting them,
provided by various electrical design tools. The feature enables creation of BOM structures for
electrical equipments and cables.
Multisite Integration Enables certain Multi-Site Collaboration capabilities in Active Workspace. Users can publish
objects for access by remote sites, check in and check out objects, and receive and update
objects from remote sites. Administrators can use the Multi-Site Dashboard to monitor the
Multi-Site federation, viewing related issues through charts, graphs, and detailed object reports.
NX Logical for Active This feature configures the Teamcenter installation to support logical model for the NX
Workspace Client diagramming application in Active Workspace. This feature allows users to view and navigate
diagramming sheets and logical model content in the Active Workspace client.
Office Online Viewer Client Installs the Office Online Viewer Client that enables you to Initiative Planningedit Microsoft
Office documents within Active Workspace.

This feature requires Microsoft Office Online to be installed in your environment.

Order Management Installs Order Management support for the Active Workspace client. Order Management
manages the lifecycle of an order from inquiry to sales order. A customer inquires about
products, a sales person responds with the offer containing configurable products. Once the
offer is accepted by the customer, a sales order is created that refers to the configurable
products.
Part Manufacturing Client Adds part manufacturing support in the Active Workspace client.

Teamcenter Installation on Windows, Teamcenter 14.2 23-35

© 2022 Siemens
 23. Solutions and features reference

Feature Description
Product Configurator Adds Product Configurator features to the Active Workspace client. Product Configurator
enables you to formally introduce and manage variability across your product suite.

For more information, see Product Configurator in the Teamcenter help collection.
Program Planning Enables the Program Management capability in Active Workspace. This feature provides the
ability to manage business investments, from planning to execution, in terms of time, reuse,
volume, cost targets, and weight targets.

If you are installing this feature, you should also install the Program Planning feature under
Server Extensions.
Reactive Logging Installs valuable troubleshooting tools that enable you to record a problem in a log file to share
with the Teamcenter administrator.

By default, reactive logging provides the user with the log file location and machine
information. To configure this behavior, set the following preferences:

TC_reactive_logging_notification_list

Notifies administrator regarding log ZIP file.

TC_reactive_logging_file_download

Displays message to the user with a link to the downloaded file in Active Workspace.
Reporting Adds the ability to view report templates, generate reports based on selected criteria, style
sheets, or both, and view them in HTML, Excel, or raw XML formats in the client.

If you are installing this feature in the Client, you must install the Reporting Server Extensions
feature in the corporate server.

Additionally, to allow for asynchronous report generation, install the AsyncService translator in
the Dispatcher Server.
Schedule Manager Enables Schedule Manager capabilities in Active Workspace.

If you are installing this feature, you must also install the Schedule Manager feature under
Server Extensions on the corporate server.
Stock Material Adds stock material management features for the Active Workspace client.

Many parts are made from stock materials such as bar stock, tubing stock and sheet stock. This
features enables you to manage stock materials in Teamcenter, performing actions like creating
libraries of stock materials and assigning stock materials to parts.

For more information, see Aerospace and Defense Solution in the Teamcenter help collection.
Subscription Allows users to manage subscriptions and notifications in the client.

If you are installing this feature in the Client, you must install the Subscription feature under
Server Extensions in the corporate server.
Work Package Installs work package management, which helps designers to create and maintain a work
Management package as a revisable collection of CAD files and documentation.

To install this feature, you must install the Work Package Management feature for both server
and client features for Active Workspace.
Xcelerator Share Installs support for the Xcelerator Share collaboration in the Active Workspace client. Xcelerator
Collaboration Active Share is a cloud application that allows you to share and collaborate on project files with your
Workspace Client partners, team members, and manufacturers. In this browser-based collaboration, you can
develop new products and designs, then share your projects with customers for approval or
manufacturers for production. Xcelerator Share controls and secures file access, and maintains
history of file sharing and exchange. For more information about Xcelerator Share
collaboration, see Xcelerator Share collaboration in Active Workspace.

23-36 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace Client features

Feature Description
Contract Data Installs Contract Data Management, which helps contractors manage the creation, review, and
Management delivery of contracts. A contract is a structured procurement document that lists milestones and
schedule dates.

If you are installing this feature, you must also install the Contract Data Management Server
Extensions feature on the server and the Contract Data Management feature under
Enterprise Knowledge Foundation.
Markup Enables markup capabilities in the client interface.
Relationship Browser If you are installing this feature, you must also install the Relationship Viewer Server
Client Extensions feature on the corporate server.
Workflow For users to access Inbox components and workflow functionality in the Client interface, this
feature must be installed.

If you are installing this feature, you must also install the Workflow feature under Server
Extensions on the corporate server.
Active Content Adds structure search functionality to the client interface.

If you are installing this feature in the Client, you must install the Active Content Structure
Server Extensions feature in the corporate server.
Digital Signatures Adds digital signatures functionality to the client interface.

Before selecting this feature, see the additional setup requirements for digital signatures in
Customizing Active Workspace.

If you are installing this feature in the Client, you must install the Digital Signatures Server
Server Extensions feature in the corporate server.
Easy Plan - Product Adds support for Product Configurator in Easy Plan. Product Configurator allows you to enable
Configurator Client definitions for variant formulas on operations.

Please see the Product Configurator (Administrator) documentation for installation details.

To use Product Configurator variants, you must run Teamcenter 11.5 or later. By default, Easy
Plan uses classic variants.
Linked Data Framework Provides a framework to link a Teamcenter business objects with an artifact of a remote linked
data enabled system. It enables rendering the remote system's delegated UIs in Active
Workspace.

If you are installing this feature, you should also install the Linked Data Framework feature
under Server Extensions.
Viewer Snapshot Tool Installs the viewer snapshot tool for 3D visualization in Active Workspace.
4th Generation Design Allows users to view, navigate, and configure collaborative designs and their content in the
Client.

If you are installing this feature in the Client, you must also install the 4th Generation Design
Server Extensions feature, the Active Content Structure Server Extension feature, and the 4th
Generation Design (under Advanced PLM Services) feature on the corporate server.

In addition to the Active Workspace Client feature, requires the Active Content Client feature.
Briefcase Browser Enables the Briefcase file preview and comparison features in the Active Workspace client.
Briefcase Export and Enables the ability to collaborate with online and offline sites by importing and exporting
Import Teamcenter data packaged in Briefcase files. Other sites can optionally update the Teamcenter
objects and return the data to the originating site.

Also enables the ability to extract data from one Teamcenter environment to copy to another
using bulk loading tools.
Change Management Adds the ability to work with Change Management objects in the client.

Teamcenter Installation on Windows, Teamcenter 14.2 23-37

© 2022 Siemens
 23. Solutions and features reference

Feature Description
If you are installing this feature in the Client, you must install the Extensions→Enterprise
Knowledge Foundation→Change Management feature in the corporate server.
Color BOM for Active Adds support in Active Workspace for creating and managing Less Finish, Color Parts, Color
Workspace client Assemblies, and their usages in a product, and associate color definitions to enable downstream
consumption.
Concurrent Modeling Adds concurrent modeling support in Active Workspace. Concurrent modeling allows you to
manage models from supported 1D modeling tools in Teamcenter, using the Teamcenter MBSE
Integration Gateway MBSE framework.
Easy Plan - Process Installs support for the Process Planning workspace for build-to-order (BTO) or build-to-stock
Planning for BTO/BTS/CTO (BTS), or configure-to-order (CTO) in your environment.
Client
Finish Management Installs Finish Management support for Active Workspace. A finish represents a finishing
process on a part. It may be used to improve appearance, adhesion, corrosion resistance,
tarnish resistance, chemical resistance, wear resistance, and remove burrs and so on.

For more information, see Aerospace and Defense Solution in the Teamcenter help collection.
MCAD Integration In addition to the Active Workspace Client feature, requires the Active Content Client feature.
Material Management Enables Active Workspace users to:

• Associate a material revision with a vendor part or an item revision.

• Associate a substance with a material revision.

• View the material/substance dashboard.

If you install this feature, you should also install the Material Management feature (under
Server Extensions) on the corporate server.
Medical Device Foundation Installs Active Workspace client support for product development processes for medical device
manufacturers. This feature assists in ensuring compliance with regulatory guidelines,
accelerating innovation in development, and reducing costs.
NX Integration Enables users to access NX integration functionality from the client interface.

If you are installing this feature, you should also install the NX for Active Workspace feature
(under Server Extensions) on the corporate server.
PLMXML Export Import Enables the ability to share data with organizations not using Teamcenter or for use with third-
party applications. You can use PLM XML to share Teamcenter objects such as items, datasets,
BOMs, forms, and folders.
Partitions for Structure Installs client support for partitions and partition schemes for structures.
Product Master Installs product master automation for the Active Workspace client.
Automation
Requirements Allows users to author a requirement structure in the Content tab of the client.
Management
In addition to the Active Workspace Client feature, requires the Active Content feature.

If you are installing this feature in the Client, you must install the Requirements Management
and Systems Engineering features under Server Extensions on the corporate server.

Note:

This feature is required to enable the Export to Excel button in Active Workspace.

23-38 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace Client features

Feature Description
Service Engineering Client Provides service engineering support for Service Lifecycle Management in the Active Workspace
client.
Service Manager Allows users to view disposition and utilization history of physical parts in the Client.
Service Planning Client Provides the Active Workspace searching and BOM (Bill of Materials) extensions necessary to
support the SLM Service Planning in an Active Workspace environment.
Solution Variant Support Adds Product Configurator capabilities for Active Content Structure, such as creating and
for Active Workspace managing solution variant structures for configurable generic assemblies.
Teamcenter Simplified Provides a simplified experience of Teamcenter for small- and medium-sized business
Client customers. User Experience (UX) redundancies and outlying commands are removed. This
allows users to quickly work on designs, documents and parts within their organization without
additional configuration.
Vendor Management Allows Active Workspace users to:

• Associate vendors with vendor parts.

• Associate vendor parts with commercial part revisions.

If you are installing this feature, you should also install the Vendor Management feature under
(Server Extensions) on the corporate server.
Active Workspace Weight Enables interaction with Weight and Balance Management in the Active Workspace client. This
And Balance Management supports functionality such as specifying weight and balance attributes for parts or assemblies,
and performing their rollup. For more information, see Structure Management Deployment and
Administration.
Advanced Multi-Schema Adds the capability to create mapping rules to transform data when it is transferred between
Exchanger Teamcenter sites using different schemas. You can create mapping rules for the item types in
your source schema or for subsets of item types in the schema as defined by schema subsets
attached to Briefcase files. See the PLM XML/TC XML Export Import Administration guide for
more information about creating, validating, and attaching mapping rules.
Aerospace and Defense Adds the Aerospace and Defense Foundation feature to the Active Workspace client.
Foundation
This feature is not selectable unless the following features are also selected:

If you are installing this feature in the Client, you must install the Aerospace and Defense
Foundation Server Extension feature in the corporate server and the following Active
Workspace Client features:

• Workflow
• Active Collaboration
• Active Content
• Vendor Management
Capital Asset Lifecycle Adds management of plant data for the Active Workspace client.
Management
Easy Plan - Electronics Installs client support for the Easy Plan Electronics Process Planner workspace in your
Client environment.

Electronics engineers use Production Process Planning for the systems integration of the
electronics process planning tasks of Easy Plan and those of Valor Process Preparation Software.
The systems integration is available as a dedicated, optional feature of Production Process
Planning.
Easy Plan - Excel Round Supports import and export with Microsoft Excel in Easy Plan.
Trip Client

Teamcenter Installation on Windows, Teamcenter 14.2 23-39

© 2022 Siemens
 23. Solutions and features reference

Feature Description
Easy Plan - Process Installs client support for the Engineering to Order (ETO) workspace in your environment.
Planning for ETO Client
This feature allows end users to author work instructions at the process station level.
Embedded Software Adds Embedded Software Solutions functionality, which allows you to represent embedded
Management software artifacts using Active Workspace.
Manufacturing BOM Adds Multi-BOM Manager support to the Active Workspace client. Multi-BOM Manager enables
Manager Client you to link and assign content across representations for different lifecycle stages or uses for a
product.

For information about using this feature, see Mutli-BOM Manager in the Teamcenter help
library.
Next Generation Planning Adds Next Generation Planning (NGP) support to Active Workspace.
Client
Product Master Installs product master support for Product Master Manager in the Active Workspace client.
Unified Supplier Portal Supports unified supplier collaboration in Active Workspace. This application enables
manufacturers to exchange design, sourcing, and program management data with suppliers
Easy Plan – Classification Adds support for Classification data in Easy Plan.
Client
Electronic Work Installs the Electronic Work Instructions Client workspace in your environment.
Instructions Client
Medical Device Provides support for performing end-to-end medical device label authoring, object-based
Submissions for Active content management, Unique Device Identifier (UDI) data management and submissions for
Workspace medical industry customers.
Resource Manager for Adds Manufacturing Resource Library support for the Active Workspace client.
Active Workspace Client
For information about using Manufacturing Resource Library, see the Teamcenter help library.
Service Work Instructions This feature provides the functionality to build and view the Service Lifecycle Management
Client (SLM) Service Work Instructions for Active Workspace. This content represents extensions
necessary to support Service Work Instructions in an Active Workspace environment.
Systems Engineering Enables users to manage Systems Engineering diagrams in Active Workspace. This supports
Client diagramming interactions between different systems.
Teamcenter Enables Teamcenter to access Teamcenter Manufacturing as a hosted application within other
Manufacturing Access applications such as Process Simulate.
Client
Component Manufacturer Provides a specialized user interface in the Active Workspace client for component supplier
Active Workspace customers that simplifies management of projects and programs.
Machine Builder Installs support for the Machine Builder solution in Active Workspace. This solution provides a
single-source data management system focused on the engineering, manufacturing and
product life BOM. This solution is designed to enable industrial machinery customers to move
from CAD data management to engineering process management, integrating requirements
management, project management, and change management.
Active Admin Features to support active admin capabilities.
Preference Adds preference management to the active admin workspace.
Management
CAE Simulation Features to support management of computer-aided engineering (CAE) data.
Management
Simulation Process In addition to the Active Workspace Client feature, requires the Active Content Client feature.
Management
If you are installing this feature, you must also install the Simulation Process Management
Server Extensions feature on the corporate server.

23-40 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace Client features

Feature Description
Extended Extends Simulation Process Management capabilities in Active Workspace.
Simulation Process
Management
Simulation Process Provides support for Parameter Management data model and functionalities in Simulation
Management with workflows.
Parameter
Management
Integrated Program Integrated Program Planning and Execution (IPP&E) client features. The IPP&E solution allows
Planning and Execution project planning that integrates cost, schedule, risk and technical requirements in a fully
planned, resourced, and budgeted program. It allows configuration control, not only of
products, but also of the project plan. It also communicates the status of requirements to users.
IPP&E Contract Data Adds Contract Data Management support to IPP&E.
Management
Extension
Organization Adds Organization Breakdown Structure (OBS) support to IPP&E.
Breakdown
Structure
IPP&E Foundation Provides essential functionality for Integrated Program Planning and Execution in Active
Workspace.
Work Breakdown Adds Work Breakdown Structure (WBS) support to IPP&E.
Structure
Program Planning Program Planning Execution features for the Active Workspace client.
Execution Client
Change Allows interaction between Schedule Manager and Change Management in Active Workspace.
Management It allows Active Workspace users to relate schedules and change objects.
Schedule Manager
Client If you are installing this feature in the Client, you must install the Change Management
Schedule Manager Server Extension feature in the corporate server and the following Active
Workspace Client features:

• Schedule Manager

• Workflow

• Change Management
Program Change Allows interaction between Program Planning Event Change and Change Management in Active
Client Workspace. It allows Active Workspace users to relate programs, projects, and subprojects to
change objects.

If you are installing this feature in the Client, you must install the Program Change Server
Extension feature in the corporate server and select the following Active Workspace Client
features:

• Program Planning

• Workflow

• Change Management
Program Planning If you are installing this feature in the Client, you must install the Program Planning Event
Event Change Change Server Extension feature in the corporate server and select the following Active
Client Workspace Client features:

Teamcenter Installation on Windows, Teamcenter 14.2 23-41

© 2022 Siemens
 23. Solutions and features reference

Feature Description
• Program Planning

• Workflow

• Change Management

• Program Change Client

Program Schedule If you are installing this feature in the Client, you must install the Program Change Server
Manager Client Extension feature in the corporate server and select the following Active Workspace Client
features:

• Program Planning

• Schedule Manager

• Workflow

• Change Management

• Program Change Client

• Program Planning Event Change Client

Reuse and Standardization Features to support Reuse and Standardization in the Active Workspace client.
Classification Client Allows users to access Classification data in the client interface.
Library Installs the client component required to view classification libraries. Classification libraries
Management contain subsets of a classification hierarchy pertinent to a particular role, project, or use case.
Teamcenter Quality Features to support Teamcenter Quality.
Control and Installs support for control and inspection planning in the Active Workspace client.
Inspection Plan
Control and inspection planning allows you to manage critical characteristics of Failure Mode
Effect Analysis (FMEA) and create a control plan that generates bill of process (BOP) elements.
Failure Mode Effect Adds support for Failure Mode Effect Analysis (FMEA) standards to the Active Workspace client.
and Analysis
(FMEA) For more information, see Quality in the Active Workspace help.

Quality Manager Adds Quality Manager to the Active Workspace client.

For more information, see Quality in the Active Workspace help.

Training and Adds client support for training and qualification actions in Active Workspace.
Qualification Client
Quality Action Adds support for quality actions in the Active Workspace client.
Management Client
For more information, see Quality in the Active Workspace help.
Quality Issue Adds Issue Manager and Problem Solving support for the Active Workspace client.
Management and
Problem Solving
APQP Program Adds support for Advanced Product Quality Planning (APQP) methodology in the Active
Management Workspace client.

For more information, see APQP Program Management.

23-42 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace Client features

Feature Description
Quality Audit Adds support for quality auditing in the Active Workspace client.

For more information, see Quality in the Active Workspace help.

Supplier Quality Provides support for Supplier Quality Management in the Active Workspace client. This
Management application enables you to perform Supplier Quality management operations with applications
like Vendor Management, Advance Product Quality Planning, and Quality Issue Management
and Problem Solving. Supplier Quality Management is used to evaluate vendor performance
based on quality issues and problem solving processes initiated for supplied materials or parts.
It can also assess a vendor using a quality checklist.
Model-Based Systems Features to support Model-Based Systems Engineering in the Active Workspace client.
Engineering
LMS System Exposes the System Synthesis artifacts, such as model templates and core architecture, in Active
Synthesis Modeling Workspace. These artifacts are created in Teamcenter by System Synthesis, a framework for the
numerical integration of heterogeneous behavioral models issued by different authoring
platforms, such as LMS Amesim or MATLAB/Simulink.

If you are installing this feature in the Client, you must install the LMS System Synthesis
Modeling Server Extension feature in the corporate server and the following Active Workspace
Client features:

• Workflow

• Active Content
Parameter Adds parameter management to Active Workspace.
Management
Teamcenter Test Adds test management support to Model-Based Systems Engineering (MBSE).
Management
Physical Adds support for inspections and physical tests in the Active Workspace client.
Verification
Management
Active Architect Features to support Active Architect for Active Workspace.
UI Builder Installs UI Builder components of active architect. UI Builder adds new declarative pages to the
global navigation toolbar in Active Workspace, including:

• Command builder

• Panel builder
Consumer Packaged Goods Features to support Consumer Packaged Goods in the Active Workspace client.
Brand Management Installs the Brand Management template for Consumer Packaged Goods.
Packaging and Installs packaging and artwork functionality for Consumer Packaged Goods.
Artwork
Specification Installs Specification Manager functionality for Consumer Packaged Goods.
Management
Consumer Product Installs consumer product management functionality for Consumer Packaged Goods.
Management
Active Workspace

Teamcenter Installation on Windows, Teamcenter 14.2 23-43

© 2022 Siemens
 23. Solutions and features reference

Active Workspace microservices features

Active Workspace client features are available in the Features panel in Teamcenter Environment
Manager (TEM), under Microservices.

These features require installation of Microservice Framework.

Feature Description
Microservices Framework Installs the Microservices Framework.
Advanced Multi-Schema Installs the Advanced Multi-Schema service, which supports creation of mapping rules to
Service transform data when it is transferred between Teamcenter sites using different schemas. This
service is used by the Advanced Multi-Schema Exchanger, which allows you to create mapping
rules for the item types in your source schema or for subsets of item types in the schema as
defined by schema subsets attached to Briefcase files.

See the PLM XML/TC XML Export Import Administration guide for more information about
creating, validating, and attaching mapping rules.
Classification AI Serving Installs the classification AI microservice that connects the Active Workspace Gateway to the
classification AI engine, which provides artificial intelligence (AI) to recommend the class in
which to classify new objects.
Command Prediction Installs the Command Prediction Service, which manages data for the Active Workspace
Service Assistant

and a database for the microservice to store data for the Active Workspace Assistant. TEM
prompts you for the necessary database creation values during installation.
Declarative Artifact Service Installs the microservice that stores your changes to the declarative definitions of Active
Workspace.

The Declarative Artifact Service allows you to easily create new declarative definitions by
automatically creating new files, and also make changes to existing declarative definitions
without changing their original source code.
File Repository Service Installs the File Repository microservice, which facilitates transfer of Active Workspace client
content from the File Repository to Active Workspace client hosts through the Active
Workspace Gateway.
Requirements Management Installs the microservice that provides compare capability for Requirements Manager.
Compare Service
Requirements Management Installs the microservice that provides export capability for Requirements Manager.
Export Service
Requirements Management Installs the microservice that provides import capability for Requirements Manager.
Import Service
Teamcenter GraphQL Installs the Teamcenter GraphQL microservice, which processes client queries passed from the
Service Active Workspace Gateway to the File Repository.
TeamcenterSysmlv2 Installs the microservice that supports management of UML or SysML models in Teamcenter.
Microservice
Xcelerator Share Installs the Xcelerator Share microservice, which enables the Xcelerator Share collaboration in
Microservice Active Workspace. Xcelerator Share is a cloud application that allows you to share and
collaborate on project files with your partners, team members, and manufacturers. In this
browser-based file storage, you can develop new products and designs, then share your
projects with customers for approval or manufacturers for production. Xcelerator Share
controls and secures file access, and maintains history of file sharing and exchange. For more

23-44 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Active Workspace microservices features

Feature Description
information about Xcelerator Share collaboration, see Xcelerator Share collaboration in Active
Workspace.
iModel Viewer Service Provides viewing capability for iModel data.
Teamcenter Google Online Provides interaction between the Google Online Viewer and the Teamcenter server.
Microservice
Teamcenter Office Online Provides the capability to use the Microsoft Office Online Server features that allows users to
Microservice edit and view documents within Active Workspace instead of using the desktop version of the
Microsoft Office applications.
OData Microservice Installs the microservice that supports the Teamcenter OData API Framework.

Teamcenter Installation on Windows, Teamcenter 14.2 23-45

© 2022 Siemens
 23. Solutions and features reference

23-46 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 24. Web tier context parameters
The following tables describe web tier context parameters provided by Teamcenter web tier solutions.

Web tier required parameters

Parameter Description

General parameters

TcLocale Locale of the Teamcenter server for localization of web

tier messages. This locale must match the locale of the
Teamcenter server.
For example, if Teamcenter server is running in the
Russian locale, specify ru_RU for this parameter.

Max_Capacity Specifies the maximum number of concurrent

connections to Teamcenter servers the server pool
maintains.
The default value of 500 connections may be too low to
prevent performance slowdowns when running
Websphere as a middle tier server. To avoid
performance slowdowns and possible connection
errors, increase the number of available connects by
setting max_capacity to a value greater than 500.
This parameter applies to web application deployment
on WebLogic, JBoss, and Oracle Application Server. For
other application servers, the maximum pool size must
be set using the application server console.

Server_Manager_URIs Specifies a list of server manager URIs, separated by

semicolons. For example:

http://hostA:8086/PoolA;http://hostB:8086/PoolB

LogVolumeName Name of the log volume.

LogVolumeLocation Log volume location, the root directory under which log
files are created. The default location logs represent a
child folder beneath the default root directory of the
target application server instance. This location varies
depending on the application server vendor.
If the path you enter contains backslash characters (\)
as path delimiters, use double backslash characters (\\)
to represent single backslash characters.

Teamcenter Installation on Windows, Teamcenter 14.2 24-1

© 2022 Siemens
 24. Web tier context parameters

Parameter Description

DEPLOYABLE-FILE-NAME Name of the deployable file you are creating for the
web tier application. The name is configurable; Web
Application Manager adds the file extension.

Security Services parameters

IS_SSO_ENABLED Specifies whether Security Services is enabled for this

instance of Teamcenter.

SSO_APPLICATION_ID Application ID assigned to this instance of Teamcenter

in the Security Services application registry. This
information is required only when you are configuring
the optional Security Services.
This ID is determined when Security Services is installed
and configured.

SSO_logon_SERVICE_URL Complete URL of the Security Services logon Service

web application. This information is required only when
you configure the optional Security Services.
This URL is determined when Security Services is
installed and configured.

SSO_SERVICE_URL Complete URL of the Security Services Identity Service

web application. This information is required only when
you configure the optional Security Services.
This URL is determined when Security Services is
installed and configured.

24-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 Web tier optional parameters

Parameter Description

General parameters

webmaster E-mail address of the administrator to whom questions

and comments about this application are addressed.

staticResourceClientCache Maximum time in seconds that a client can use a locally

ExpiryTime cached static content (for example, images or JavaScript)
before requesting a fresh copy from the server.
Setting this value too low causes the client to
unnecessarily request content. Setting this value too
high risks stale content. Typical values range from
several hours to one day.
Setting the value to 0 is valid and causes the client to
always ask for static content.
The default value is 28800 seconds (8 hours).

compressResponse Specifies whether a response to the client can be

compressed if the requesting client supports it.
Compressing the response typically yields faster
response time to the client but requires additional
processing in the web container.
Set this parameter value based on trial and error for your
instance of the server, bandwidth, and client access
environment.
The default value is true.

cacheCompressedStatic Specifies whether responses for static resources are

ResourceOnServer cached on the server. This parameter is used only when
the compressResponse parameter is set to true.
If the value is set to true, compressed responses for
static resources are cached on the server, memory
permitting.
If the value is set to false, the compression occurs each
time the client requests a static resource.
The default value is true.

responseCompression Threshold in bytes beyond which the server should

Threshold compress responses sent back to the client.

Teamcenter Installation on Windows, Teamcenter 14.2 24-3

© 2022 Siemens
 24. Web tier context parameters

Parameter Description

Typically compressing smaller responses does not yield

much compression - so all responses equal to or smaller
than this value will be sent to the client uncompressed.
Setting the value to 0 is valid and causes the server to
compress every response sent to the client (assuming
other parameters permit compression).
The default value is 500 bytes. Change this value only if
absolutely required.

calculateResponseTime Specifies whether the group of response time filters are

on (by setting to true) or off (by setting to false).
These filters are used for instrumentation purposes (for
example, the average time spent in processing a request
from a rich client).
The response time filters should remain turned off unless
you are collecting statistics.
The default value is false.

24-4 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 25. Load balancing Active Workspace
components
Load balancing Active Workspace components provides failover support. This allows the system to
continue to operate when hardware or connectivity failures occur, and it allows for maintenance of
hardware without production downtime.

You should deploy the Active Workspace Gateway on at least two different physical machines and use a
commercial third-party load balancer configuration. The load balancer is used to enable the browser
clients to use one and only one URL to access Active Workspace and Teamcenter.

During your installation process, you should configure the Gateway to address at least two microservice
dispatchers on two different physical machines. If you chose to deploy the Teamcenter GraphQL
service1, you may be less concerned about failover and install on only one machine.

The Declarative Artifact Service is only used for user interface development using the UI Builder.
Therefore, you may choose to deploy it only as needed in development environments. The File
Repository service is an essential service and should be deployed on at least two different physical
machines to support failover. The actual file volume for the client assets must be on one and only one
machine.

In all cases, microservices can be deployed on more machines to achieve greater scalability. Any service
that will have heavy usage may warrant having more than two instances.

If you install multiple instances of the File Repository Service microservice, all instances must reference
the same physical storage location. For example, if you install the File Repository Service microservice on
multiple machines, the file repository storage location must be on a shared drive.

1 The Teamcenter GraphQL service is optional.

Teamcenter Installation on Windows, Teamcenter 14.2 25-1

© 2022 Siemens
 25. Load balancing Active Workspace components

25-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens
 26. Required RPM package managers
If you use the visualization server manager (VSM) on a Linux machine, make sure the following required
RPM package managers are available on the machine.

SUSE Linux:

fontconfig-2.11.1-7.1.x86_64
glibc-2.22-15.3.x86_64
glibc-32bit-2.22-15.3.x86_64
libbz2-1-1.0.6-29.2.x86_64
libexpat1-2.1.0-21.3.1.x86_64
libexpat-devel-2.1.0-21.3.1.x86_64
libfreetype6-2.6.3-7.15.1.x86_64
libgcc_s1-8.2.1+r264010-1.3.3.x86_64
libGLU1-9.0.0-18.1.x86_64
libICE6-1.0.8-12.1.x86_64
libjpeg8-8.1.2-31.7.4.x86_64
libpng16-16-1.6.8-14.1.x86_64
libSM6-1.2.2-3.59.x86_64
libstdc++6-8.2.1+r264010-1.3.3.x86_64
libuuid1-2.29.2-7.14.x86_64
libX11-6-1.6.2-12.5.1.x86_64
libXau6-1.0.8-4.58.x86_64
libxcb1-1.10-4.3.1.x86_64
libXext6-1.3.2-4.3.1.x86_64
libXft2-2.3.1-9.32.x86_64
libXm4-2.3.4-4.15.x86_64
libXmu6-1.1.2-3.60.x86_64
libXp6-1.0.2-3.58.x86_64
libXrender1-0.9.8-7.1.x86_64
libXt6-1.1.4-3.59.x86_64
libz1-1.2.11-1.27.x86_64
Mesa-libGL1-18.0.2-6.28.x86_64

Note:
On SUSE Linux, the /usr/lib64/libGLdispatch.so.0 file is not owned by any package.
Also, the /usr/lib64/libGLX.so.0 file is not owned by any package.

RedHat Linux:

bzip2-libs-1.0.6-13.el7.x86_64
expat-2.1.0-10.el7_3.x86_64
expat-devel-2.1.0-10.el7_3.x86_64
fontconfig-2.13.0-4.3.el7.x86_64

Teamcenter Installation on Windows, Teamcenter 14.2 26-1

© 2022 Siemens
 26. Required RPM package managers

freetype-2.8-12.el7.x86_64
glibc-2.17-260.el7.x86_64
libgcc-4.8.5-36.el7.x86_64
libglvnd-1.0.1-0.8.git5baa1e5.el7.x86_64
libglvnd-glx-1.0.1-0.8.git5baa1e5.el7.x86_64
libICE-1.0.9-9.el7.x86_64
libjpeg-turbo-1.2.90-6.el7.x86_64
libpng-1.5.13-7.el7_2.x86_64
libSM-1.2.2-2.el7.x86_64
libstdc++-4.8.5-36.el7.x86_64
libuuid-2.23.2-59.el7.x86_64
libX11-1.6.5-2.el7.x86_64
libXau-1.0.8-2.1.el7.x86_64
libxcb-1.13-1.el7.x86_64
libXext-1.3.3-3.el7.x86_64
libXft-2.3.2-2.el7.x86_64
libXmu-1.1.2-2.el7.x86_64
libXp-1.0.2-2.1.el7.x86_64
libXrender-0.9.10-1.el7.x86_64
libXt-1.1.5-3.el7.x86_64
mesa-libGLU-9.0.0-4.el7.x86_64
motif-2.3.4-14.el7_5.x86_64
zlib-1.2.7-18.el7.x86_64

26-2 Teamcenter Installation on Windows, Teamcenter 14.2

© 2022 Siemens