installingTcDc
installingTcDc
Teamcenter
Installation Using
Deployment Center
Teamcenter 2406
Unpublished work. © 2024 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.
Where to start
Get documentation ───────────────────────── 2-1
Get software ──────────────────────────── 2-4
Get Deployment Center ──────────────────────── 2-4
Get started ───────────────────────────── 2-5
System requirements ───────────────────────── 2-6
Manage environments
Creating environments ─────────────────────── 20-1
Create an environment in Deployment Center ──────────────── 20-1
Register an environment in Deployment Center ─────────────── 20-1
Adding applications and components ───────────────── 20-9
Add applications ──────────────────────────── 20-9
Add components ─────────────────────────── 20-10
Adding Active Workspace to a Teamcenter environment ──────── 20-13
Part V: Appendices
Troubleshooting
Troubleshooting Teamcenter server installation ──────────── 22-1
Installation log files ─────────────────────────── 22-1
Problems/error messages ───────────────────────── 22-2
Update Manager FTP errors ──────────────────────── 22-4
Troubleshooting microservices ──────────────────── 22-5
Troubleshooting four-tier architecture deployment ─────────── 22-5
Troubleshooting the .NET web tier ────────────────── 22-8
Resolving .NET server manager port conflicts ──────────────── 22-8
Troubleshooting Oracle ─────────────────────── 22-9
Finding Oracle errors ────────────────────────── 22-9
View additional information about an Oracle error message ────────── 22-9
Troubleshooting Microsoft SQL Server ──────────────── 22-9
Troubleshooting Lifecycle Visualization ─────────────── 22-10
Tuning WebSphere JVM memory consumption ──────────── 22-11
Troubleshooting document rendering ──────────────── 22-12
Uninstalling Teamcenter
Uninstall TCCS ─────────────────────────── 23-1
Uninstall database software ───────────────────── 23-2
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:
If you do not use Active Workspace, you can alternatively install the Teamcenter rich client, a Java-based
desktop client available for Windows and Linux systems. 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.
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 Upgrade Teamcenter with Active
Workspace Workspace
Teamcenter without Active Add Active Workspace Adding Active Workspace to a
Workspace Teamcenter environment
Teamcenter with rich client Update Teamcenter and rich Teamcenter Rich Client Installation on
client Windows
If your starting point is: And you want to: Begin here:
Teamcenter Rich Client Installation on
Linux
Begin the Plan phase of Teamcenter installation 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 test environments and development environments and how to copy a Teamcenter
environment for upgrade testing.
When planning your distribution of Teamcenter components, see the Connection and Communication
Table (Teamcenter_Deployment_Connection_and_Communication_Table.xlsx) in the Teamcenter
Deployment Reference Architecture package. This document contains helpful guidelines for planning
communication between Teamcenter components.
Prepare the machines that will host your Teamcenter test and production environments. This includes
installing database infrastructure, the license server, locale support, and software like Security Services
that will support the Teamcenter and Active Workspace components.
This is Siemens Digital Industries Software's comprehensive support portal, which provides
documentation for all Siemens software products and versions.
You require a Webkey account to access Support Center. However, you can avoid this requirement
by installing the Siemens Documentation Proxy, which provides secure documentation access using
a personalized API key, with no need to log on. Teamcenter clients can be configured to access help
through the Documentation Proxy.
This is a 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 use
or network-wide access with no Webkey or API key required.
Teamcenter clients can be configured to access the help on the Siemens Documentation Server.
For an orientation to Support Center, see Siemens Software Support Center videos on YouTube.
Log on to Support Center and open the Siemens Documentation Server Downloads page:
Choose how you want to access documentation, and then install the Documentation Proxy or the
Documentation Server.
Note the machine and port on which you configured the Documentation Proxy or Documentation Server.
These are required to configure help access from Teamcenter clients.
Teamcenter documentation is delivered in documentation kits. Each kit contains documentation content
and an installation wizard that automatically installs documentation onto your Documentation Server.
Products→Teamcenter→Downloads
2. Under Select a Version, choose Teamcenter 2406, and then click the Teamcenter 2406 tile.
For more information about installing documentation kits and managing the Documentation Server, see
the Siemens Documentation Server Installation Guide for Windows or Linux.
https://docs.sw.siemens.com/en-US/doc/282219420/PL20231129261301184.tc_doc_home
http://doc-proxy-host:doc-proxy-port/en-US/doc/282219420/
PL20231129261301184.tc_doc_home
http://doc-server-host:doc-server-port/en-US/doc/282219420/
PL20231129261301184.tc_doc_home
If you use the rich client, configure the Help button in the client to open Teamcenter help from
your preferred source.
During installation:
When prompted in Deployment Center, enter your preferred documentation URL in the
Documentation server URL box.
After installation:
Configure help access in the rich client as described in the appropriate rich client installation
guide for Windows or Linux.
If you use Active Workspace, configure the Help button in the client to open Teamcenter help from
your preferred source.
During installation:
The Active Workspace Help button links to Support Center by default and cannot be changed
during installation. Accessing help directly on Support Center requires a Webkey account.
After installation:
If you use the Documentation Proxy or the Documentation Server, configure the Help button
to link to Active Workspace documentation to your preferred help URL. Perform the following
steps after you install Active Workspace:
2. Find the showHelp action and set its Navigate To property to your preferred help URL.
3. Commit your UI Builder changes to your module to update the Help button link for your
users.
Get software
Installing Teamcenter requires the Teamcenter software kit, which includes microservice framework and
Active Workspace software.
Products→Teamcenter→Downloads
2. Under Select a Version, choose Teamcenter 2406, and then click the Teamcenter 2406 tile.
• Windows: Tc2406_wntx64.zip
• Linux: Tc2406_lnx64.zip
If an update (patch) to Teamcenter 2406 is available, for example, Teamcenter 2406.0001, you can
additionally download the update, and apply it during the Teamcenter installation.
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 Deployment
Center ─ Usage.
1. In the Teamcenter software kit, locate the Deployment Center software kit
(deployment_center.zip) in the install\DeploymentCenter directory (on Windows systems) or
install/DeploymentCenter directory (on Linux systems).
2. Expand the Deployment Center software kit on your Deployment Center machine.
Get started
If you are new to Teamcenter installation, the following resources may help you get started.
1 Deployment Center is an alternative installation tool to Teamcenter Environment Manager (TEM) for installing
Teamcenter. TEM is deprecated and will be discontinued in a future release.
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:
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, with sample deploy scripts and
other resources. This package 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 Active Workspace requires the microservice framework. Learn about microservices
Framework 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.
System requirements
1. Log on to Support Center and open the Support White Papers Certifications page:
a. Open Products→Teamcenter→Downloads.
Teamcenter 2406 supports upgrades from Teamcenter 13.x or later. If your current Teamcenter
environment is earlier than this, you must upgrade to version 13.x or later before you upgrade
to Teamcenter 2406.
The Teamcenter Interoperability Matrix also correlates versions of Deployment Center with
compatible versions of Teamcenter, and shows supported paths for upgrading Deployment
Center. For information about upgrading Deployment Center, see Deployment Center ─
Usage.
The following sections describe third-party software required to deploy Teamcenter. Make sure you
install versions of the required software that are listed in the Software Certifications Matrix.
Platforms
Determine from the following table which Teamcenter 2406 components are supported on your
operating system. Check marks (√) indicate components supported on the given operating system.
Microsoft Windows
• 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.
• Disable the Windows TCP scaling feature. Open a command prompt and enter the following
command:
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.
• If you use a non-English 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.
Linux
• Linux hosts must have graphics capabilities to run Teamcenter installation tools.
For operating system requirements, see the Hardware and Software Certifications knowledge
base article on Support Center.
• Linux hosts must have the nslookup utility available to ensure operation of the license server.
• Make sure Linux host names do not exceed 31 characters in length. Host names longer than
31 characters cause Teamcenter corporate server installation to fail during saving of the POM
schema file in the TC_DATA directory.
Teamcenter installation tools do not require fully qualified domain names for host names. If your
fully qualified domain name exceeds 31 characters, use the server short host name instead.
For more information, see the solutions document 002-7004480 on Support Center.
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.
If you use Oracle, set system parameters to recommended values to ensure adequate database
performance.
Install the required software for the Teamcenter web tier you use:
Install a supported JRE on the host where you build Teamcenter web applications.
Install a supported application server on the host where you deploy Teamcenter web
applications.
Install IIS on your Teamcenter corporate server host and add the required role services.
If you use the Teamcenter Java EE web tier, install the following software:
Install a supported JRE on the host where you build Teamcenter web applications.
Install a supported Java EE application server on the host where you deploy Teamcenter web
applications.
Some web application servers require special configuration for use with Teamcenter.
Web browser
For supported browser versions, see the Software Certifications Matrix on the Support White Papers
Certifications page on Support Center.
The Teamcenter platform is a software architecture that consists of four logical tiers that provide the
major functions:
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.
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:
The Teamcenter Deployment Reference Architecture, available on Support Center, provides detailed
examples of distributions of Teamcenter and Active Workspace components.
You can select environment types and architecture types in the Options task in Deployment Center.
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 The Microsoft .NET framework is supported on Windows systems. The Teamcenter .NET
.NET web tier is built on this platform and requires Microsoft Internet Information Server
(IIS).
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:
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.
Infrastructure types
The infrastructure type defines whether the current environment will host Teamcenter components that
can be shared to multiple environments (a Global infrastructure) or can import components from other
environments (a Local infrastructure).
Local Server and client components connect to the current environment. Also, client
components shared from a Global infrastructure can be imported into a Local
infrastructure. This is the default selection in a new environment.
Global Components can be shared to multiple environments, and with those environments'
databases. A Global infrastructure is used to define client components that can be
shared to multiple environments managed in Deployment Center.
Only components that can be shared to other environments, for example, the rich
client, are supported in a global infrastructure.
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:
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.
• 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.
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 NFS (on Linux systems) or CIFS (on Windows
systems) 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 NFSCIFS to other Teamcenter clients to provide access to the database-specific
information.
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:
• 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.
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.
• Shared server-level performance cache for shared data access between multiple users
• 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.
You can configure the FMS server cache (FSC) server to perform any combination of the following
functions:
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.
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.)
FSC servers and caches are configured using XML-based files, in a hierarchical structure:
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.
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:
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.
Data Description
Configure proxy servers? Either HTTP proxy server or HTTPS proxy server.
If you choose to configure proxy servers, you must provide:
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.
Symmetric or asymmetric keys for By default, FMS uses symmetric keys for ticket validation. You
ticket validation? can use Deployment Center to configure your site to use more
secure public-private (asymmetric) key pairs.
Default settings for the FCC? • Location of the cache directory for all Windows systems and
for all Linux systems.
Data Description
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
the only installation and configuration required. For large deployments, you can take advantage of FMS
flexibility by manually configuring the FMS network.
The FMS client cache (FCC) process runs on a client host and performs the following functions:
Installing the FCC supports the rich client and some other Siemens Digital Industries Software products.
• The rich client requires an FCC, and Deployment Center 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.
FMS is a high-performance file transfer solution that gives client applications direct access to files
over a high-performance network connection.
• File streaming
The FCC is dedicated to a specific user on the client. The FSC server can be shared by groups of
users.
• Deployment flexibility
Installing an FCC for use with NX and Teamcenter lifecycle visualization is described in the Teamcenter
client installation guides for Windows and Linux.
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:
.NET web tier Microsoft .NET Deployment Center Microsoft Internet Information Server (IIS)
Java EE web tier Java EE Deployment Center Any supported Java EE web server
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
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 License Server.
If you use integrations with the rich client, make sure you install those applications in locations specified
by the Teamcenter administrator. Some of these integrations include:
• 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 and NX Integration provide the same NX user interface and are both
installed with NX, but neither can be used until Teamcenter is configured.
When you install Teamcenter Integration for NX, allow the installation to modify system files
so that it can create an installed_programs.dat file under the ugs directory. You can use this
installed_programs.dat file as a sample on other Linux workstations of the same type to access NX
and Teamcenter Integration for NX. NX can be installed on a mount point.
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
Deployment Center.
For more information about using Teamcenter with NX, see the installation guides distributed with
NX.
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.
Siemens Digital Industries Software provides localized versions of Teamcenter in the following
languages:
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
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.
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:
Japanese Japanese
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.
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.
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:
To ensure correct character mapping, make sure the database and the Teamcenter server use the same
encoding.
• 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.
• Database
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 Mode? parameter
in the Database Server component in Deployment Center enables the Teamcenter server to convert
character encoding to and from UTF-8 when interacting with the database.
On Windows systems, 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.
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.
On Linux systems, to verify that the desired locales are supported on your host, type the following
command:
locale -a
This command returns a list of all locales the host supports. If a locale you need is not included in the
list, contact your system administrator to install the required language pack.
Keep in mind that some Linux platform GUIs may allow you to set a locale that is not in the list of
supported locales on the host. Make sure the locale you set is supported on the host.
To verify that a desired character set is available on your host, type the following command, which lists
character sets supported on the host:
locale charmap
Teamcenter supports the Unicode UTF-8 character set on Windows and Linux hosts that are configured
to process UTF-8.
To configure your Teamcenter host to use Unicode UTF-8, perform the following steps before you install
Teamcenter:
2. Install a database server and enable Unicode UTF-8 character set support during installation.
To configure your Teamcenter host to use the UTF-8 character set, install a database server and enable
UTF-8 character set support during installation.
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, the deploy script from Deployment Center can create a
UTF-8-enabled Teamcenter database during Teamcenter installation.
If you use Microsoft SQL Server, select the Enable UTF-8 Mode? option in the Database Server
component in Deployment Center.
You can select UTF8 encoding in the Character Encoding Settings parameter in the Database
Server component in Deployment Center.
• Web tier
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.
• Your Linux platform administrator must configure the host to run the Unicode UTF-8 character
set operating system by default. This enables all software running on in the operating system
environment to recognize the default character set is UTF-8.
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.
• 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.
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 Mode? option in the Database Server component in Deployment Center,
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 addition, on Linux systems, set the LANG and LC_ALL system environment variables to the
appropriate values for your locale and platform. These variables must have identical values to function
properly.
Locale Value
Chinese (Simplified) zh_CN.utf8
Chinese (Traditional) zh_TW.utf8
Czech cs_CZ.utf8
English en_US.utf8
French fr_FR.utf8
German de_DE.utf8
Hebrew he_IL.utf8
Italian it_IT.utf8
Japanese ja_JP.utf8
Korean ko_KR.utf8
Polish pl_PL.utf8
Portuguese (Brazilian) pt_BR.utf8
Russian ru_RU.utf8
Spanish es_ES.utf8
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.
• TC_ROOT/tccs/Start_TcServer1
• TC_ROOT/pool_manager/confs/MYDB/mgrstart
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.
Value
Locale Setting Linux Microsoft Windows
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
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
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.
Value
Locale Setting Linux Microsoft Windows
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
(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.
• TC_ROOT/tccs/Start_TcServer1
• TC_ROOT/pool_manager/mgrstartMYDB
For non-English locales on Linux systems, you must specify the system locale when logging on to the
system using KDE.
You must have the same locale installed on your Teamcenter host as you use to communicate with your
database server, and the database server must support this locale as well.
On Linux systems, Teamcenter installation tools, verify that the required character set is loaded by
running the locale -a command in a shell. If the output does not list the required character set, you must
add this character set before you install Teamcenter.
1. Set or export the LC_ALL environment variable by typing LC_ALL=character-set or the equivalent
command for your platform.
2. Verify the setting using the echo command or equivalent. Make sure the correct value for LC_ALL is
displayed.
3. Run the locale command and make sure the LANG variable and all the LC_x variables are set the
same as LC_ALL.
4. If LANG is still set to C, manually export LANG to be the same value as LC_ALL.
Alternatively, your system administrator may modify the date file (named TIMEZONE in the etc
directory), which can preset this environment, so every time you log on and launch a shell, the
environment is preset.
The recommended method, however, is to log on to the system using the Common Desktop
Environment (CDE) with the minimum required locale by choosing Option→Language→character-set
during logon.
If the required character set is not loaded on your machine, contact your system administrator to have it
installed before you install the GM Overlay.
This requirement is necessary because current Teamcenter versions use XML files rather than .dat files
and associated scripts. Because of this, GM Overlay data is transformed from .dat files into XML files.
To read and parse the XML files correctly, the system must be able to process non-English (non-ASCII)
locale characters. To facilitate this, the system must be first loaded with the fonts for that locale.
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 codea 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.
• Oracle
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.
Your Oracle database server must be a version certified for use with Teamcenter 2406. 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 supports pluggable databases (PDB) with container databases (CDB) if you use Oracle 12c or
later.
• Choose as an Oracle database server a host that is directly accessible by the Teamcenter server host. A
database server host is usually a dedicated high-capacity server, specifically tuned for Oracle.
• Install Oracle on each database server or NFS-mount Oracle to each database server.
Prepare an Oracle database server and configure an Oracle database for Teamcenter:
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. On Linux systems, set shell limits and parameters on the Oracle server host..
• 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 2406,
upgrade your Oracle server.
To ensure correct character mapping, make sure the database and the Teamcenter server use the same
encoding.
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.
Oracle RDBMS uses extensive Linux resources such as shared memory, swap memory, and semaphore
for interprocess communication. Inadequate parameter settings cause problems during installation and
startup. Increasing the volume of data stored in memory reduces disk I/O activity and improves database
performance.
The Oracle RDBMS installation program displays warnings if kernel parameters are not adequate.
To avoid warnings and errors during or after installation, make sure kernel parameters meet the
recommended settings for typical environments described in the following topics.
Before you install Oracle RDBMS, set initial parameters as described in Oracle documentation, and then
adjust parameters according to available system memory. Set the ulimit parameter to unlimited.1 Then,
set the kernel parameters to recommended Teamcenter values for your operating system.
If you previously tuned kernel parameters for other installed applications to levels that meet or exceed
the values recommended for Teamcenter, keep those existing values.
The parameter settings recommended herein are minimum values. For production database systems,
Oracle recommends you tune values to optimize system performance. For information about
performance tuning, see:
1. Increase shell limits for the oracle user to the minimum values listed in the following table by
adding the following lines to the /etc/security/limits.conf file:
Do not change the shell limit values if they were set for another program and the values are greater
than the levels Oracle requires.
Minimum hard
SUSE Linux shell limit Item in limits.conf limit
• For the Bourne, Bash, or Korn shell, add the following lines to the /etc/profile.local file:
• For the C shell (csh or tcsh), add the following lines to the /etc/csh.login.local file:
Windows systems:
2. Export the contents of your Teamcenter Oracle database to the dump file:
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.
Linux systems:
1. Either log on to the Oracle server as oracle or switch the user to oracle:
su - oracle
2. Set the PATH environment variable to include the Oracle bin directory:
export PATH=$PATH:ORACLE_HOME/bin
export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${ORACLE_HOME}/lib
4. Export the contents of the Teamcenter Oracle database to the dump file:
Replace db-user with the Teamcenter database user account name; replace password with the
database user account password; replace file-name with the name of the dump file to contain the
exported data; replace export with the name of the log file to contain export output.
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.
3. Select the Oracle TNS listener services (Oraclerelease-IDTNSListener) and click Stop.
4. Click Stop.
Replace password with the password for the sys user account.
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.
shutdown
4. Exit SQL*Plus:
exit
Before installing a new version of Oracle, you must terminate all Oracle sessions and Oracle processes.
1. Either log on to the Oracle server as oracle or switch the user to oracle as follows:
su - oracle
2. Set the ORACLE_HOME environment variable to point to the location of the Oracle files. For
example:
export ORACLE_HOME=/u01/app/oracle/product/oracle-version
Replace the path with the system path to the Oracle files.
export PATH=${PATH}:${ORACLE_HOME}/bin
export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${ORACLE_HOME}/lib
6. Shut down all Oracle database instances using the dbshut utility. Shut down database instances
listed in the oratab file:
$ORACLE_HOME/bin/dbshut
If you are upgrading to the certified Oracle version, back up the existing Oracle installation.
Backing up your Oracle installation before upgrading is strongly recommended. Failure to back up
existing data could result in loss of data if problems occur during the upgrade process.
• The Oracle Net listener.ora and tnsnames.ora configuration filesin the /etc directory.
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.
2. When the Oracle installer prompts you to upgrade existing databases, enter the required
information about the databases you want to upgrade.
Installing an Oracle server is described in the Teamcenter installation guides for Windows and Linux.
Installation of an Oracle server is described in the Teamcenter installation guides for Windows or
Linux.
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:
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.
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 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 2406.
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 (on Windows systems) or NFS file systems
(on Linux systems). However, Oracle Corporation does not support Oracle database files on shared
directories or NFS file systemsan NFS-mounted file system. To ensure data integrity, create database files
on local disk drives.
If you install Oracle from an NFS-mounted directory from a remote NFS server, you must execute the
installation program on the local server node.
Caution:
• Do not run Oracle Universal Installer as the root user.
• Oracle Universal Installer automatically installs the Oracle-supplied version of Java Runtime
Environment (JRE). This version is required to run Oracle Universal Installer and several Oracle
assistants. Do not modify the JRE except by using a patch provided by Oracle Support Services.
Windows systems:
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.
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.
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.
8. In the Specify Oracle Home User dialog box, specify the system account you created to install
Oracle.
• 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.
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.
Linux systems:
2. Record the name of the Oracle database server host. Teamcenter Environment Manager requires
this name during corporate server installation.
3. If Oracle was previously installed on the host, search for the following Oracle Net configuration
files in the etc and var/opt/oracle directories and either remove them or relocate them to the
corresponding network/admin directory in the Oracle home directory:
listener.ora
tnsnames.ora
sqlnet.ora
This step is required for compliance with the standard of storing Oracle Net configuration files in
the network/admin directory.
5. If the /tmp directory does not have at least 400 MB of free space, set the TEMP and TMPDIR
environment variables to a directory that meets this requirement:
$ export TEMP=directory-path
$ export TMPDIR=directory-path
Replace directory-path with the path to the directory with sufficient space, for example, disk/tmp
6. Start Oracle Universal Installer from the Oracle software kit directory as the oracle user:
$ umask 022
$ unset TNS_ADMIN
$ unset ORACLE_HOME
$ export ORACLE_BASE=/disk1/oracle
$ cd $HOME
$ /mount-directory/runInstaller
Replace mount-directory with the Oracle software kit directory. This example sets the
ORACLE_BASE variable to the top level of the Oracle installation.
8. If Oracle Universal Installer displays the Specify Inventory Directory and Credentials window,
enter the directory where you want to install inventory files and the operating system group name
for the group that owns the inventory directory; click Next.
Note:
Siemens Digital Industries Software recommends:
• Use the default of the group the oracle account belongs to (dba).
9. If Oracle Universal Installer prompts you to run the orainstRoot.sh script, run it in a separate
terminal window as the root user and then click Continue:
$ORACLE_BASE/oraInventory/orainstRoot.sh
10. 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.
11. In the Select Installation Option dialog box, select Install database software only, and then click
Next.
12. In the Select Database Installation Option dialog box, select Single instance database
installation, and then click Next.
13. In the Select Database Edition dialog box, select Enterprise Edition and click Next.
• 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 Oracle home directory that contains earlier Oracle
software.
15. In the Privileged Operating System Groups dialog box, specify user groups for the database
administrator, operator, and other roles.
16. In the Perform Prerequisite Checks dialog box, verify that all the prerequisite checks succeeded
and click Next.
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.
17. In the Summary dialog box, review the information to ensure you have sufficient disk space and
click Install.
If you encounter errors, see the Oracle documentation for troubleshooting information.
18. In the Install Product dialog box, monitor the success of the installation stages.
When the installer displays the Execute Configuration scripts dialog box, follow the instructions in
the dialog box to run the root.sh script in the Oracle home directory. Running this script requires
logging on as root.
The root.sh script sets the necessary file permissions for Oracle products and performs other
root-related configuration activities.
19. After the root.sh script completes successfully, click OK in the Execute Configuration scripts
dialog box.
20. In the Finish dialog box, click Close to close Oracle Universal Installer.
Make sure a link exists to the Open Database Connectivity (ODBC) library.
ln -s libodbc.so.2 libodbc.so
ln -s libodbc.so.2 libodbc.so
Teamcenter uses Oracle Net protocols to communicate with an Oracle database. These protocols require
that you run a listener process ( on Linux systems or OracleTNSListener on Windows systems) on the
Oracle server to listen for remote connect requests and that all clients can translate the service alias
identifying the server and database.
On Linux systems, if your site uses Oracle Net Assistant for other databases, Siemens Digital Industries
Software recommends that you copy the listener.ora and tnsnames.ora files containing entries for your
designated Teamcenter database and install these copies on the Oracle server. Reload or restart the
listener process so that it listens for connect requests to the new database.
On Linux systems, Teamcenter Environment Manager copies the tnsnames.ora file and stores it in the
Teamcenter data directory. Teamcenter uses the Oracle TNS_ADMIN environment variable to locate the
tnsnames.ora file. However, if the system uses the TNS_ADMIN variable to locate configuration files
created by Oracle Net Assistant, this setting overrides Teamcenter settings. In this case, you must use
Oracle Net Assistant to add entries for Teamcenter databases to existing Oracle Net configuration files.
Linux systems:
In the window in which you started Oracle Universal Installer, start Oracle Net Manager:
export ORACLE_HOME=/disk1/oracle/OraHome_1
$ORACLE_HOME/bin/netmgr
Windows systems:
Start Oracle Net Manager. For example, choose Start→All Programs→Oracle - instance-
name→Net Manager, or search for Net Manager.
For the first listener, it is recommended you accept the default port number (1521).
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.
g. In the Naming list (to the right of the Oracle Net Configuration tree), choose General.
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).
k. Type the Net Service Name for your pluggable database 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.
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.
7. Click Finish.
Oracle Net Manager saves the listener information and creates the network/
admin/listener.oranetwork\admin\listener.ora and network\admin\sqlnet.oranetwork/admin/
sqlnet.ora files in the Oracle home directory.
Linux systems:
In the same window in which you started Oracle Net Manager, start the listener service:
Windows systems:
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.
Deployment Center allows you to install the corporate server and the server manager using a TCPS-
enabled Oracle database. However, you need to configure the Oracle database for TCPS prior to
deployment.
Teamcenter supports the TCPS configuration that uses the Diffie-Hellman anonymous authentication.
With Diffie-Hellman anonymous authentication, neither the server nor the client is authenticated
through SSL. Authentication must be completed using another method, for example, a user name and
password.
In the Oracle database configuration, do not enter a specific cipher suite as this is not supported by
Deployment Center.
Note:
To configure TCPS in Deployment Center, your Oracle server and your Teamcenter corporate server
must be installed on Linux machines.
1. In the listener.ora section of the Oracle listener machine, set the SSL_CLIENT_AUTHENTICATION
parameter to FALSE as the supported TCPS configuration only covers encryption and data integrity.
2. Verify that the Oracle wallet is stored on the same Teamcenter machine on which the corporate
server and server manager are to be installed or upgraded.
When you configure the Database Server component In Deployment Center, select Enable TCPS and
enter the Wallet Location (location of the Oracle wallet on the Teamcenter machine) and TLS Version
(SSL_VERSION specified in the Oracle database).
If you use Quick Deployment, Deployment Center exports these TCPS parameters to the following
properties in the configuration file:
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.
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. Attempting to install to a Container
database will result in errors during deployment.
• 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.
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.
The deploy script verifies your Oracle version during installation. If your Oracle server does not meet the
minimum required version, the installation does not proceed. For information about supported database
servers, see the Hardware and Software Certifications knowledge base article on Support Center.
3. Copy the Siemens Digital Industries Software-supplied Oracle database template files:
b. Copy files from tc/dbscripts/oracle to the templates directory of the Oracle server:
cp /cdrom/tc/db_scripts/oracle/* ORACLE_HOME/assistants/dbca/templates
4. Open a shell window and set the ORACLE_BASE environment variable. For example:
export ORACLE_BASE=/disk1/oracle
By default, Oracle creates database files in the oradata directory in the directory pointed to by
the ORACLE_BASE environment variable. Before running Oracle Database Configuration Assistant
(DBCA), you can set the ORACLE_BASE environment variable to the directory where you want
database files to reside.
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. 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.
4. Copy the Siemens Digital Industries Software-supplied Oracle database template files:
b. Copy files from tc\dbscripts\oracle to the templates directory of the Oracle server:
c. Repeat step b, copying files from the same directory on the Teamcenter 2406 software kit.
Linux systems:
ORACLE_HOME/bin/dbca
Windows systems:
3. In the Select Database Operation dialog box, select Create a database and click Next.
4. In the Select Database Creation Mode dialog box, select Advanced configuration and click Next.
5. In the Select Database Deployment Type dialog box, in the list of templates, select the
appropriate template:
If you use a CDB database, the DBCA templates do not create tablespaces. The template no longer
configures tablespaces for pluggable databases.
6. 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.
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.
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.
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.
7. In the Select Database Storage Option dialog box, select Use template file for database storage
attributes.
8. In the Select Fast Recovery Option dialog box, select the Specify Fast Recovery Area check
box and accept the default values.
9. 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.
11. In the Specify Configuration Options dialog box, select Use Automatic Shared Memory
Management, and then click Next.
12. In the Specify Management Options dialog box, accept the default selections, and then click
Next.
13. 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.
b. Click Next.
15. 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.
16. In the Progress Page dialog box, click Close to exit DBCA.
17. After the database is created, check for possible errors in the installation log files:
Linux systems:
The log files are in the admin/SID/create directory in the Oracle base directory or, if you did
not define the ORACLE_BASE environment variable, in the Oracle home directory.
Windows systems:
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
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.
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.
For example:
Session altered.
Grant succeeded.
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.
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:
3. Grant all permissions on the new tablespace to the Teamcenter Oracle user:
a. Enter:
For example:
b. Enter:
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 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.
• 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.
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.
For information about enabling the TCP/IP protocol in Microsoft SQL Server, see
http://technet.microsoft.com.
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.3
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
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.
The SQL Server Setup wizard validates user accounts for SQL Server services. Make sure the
accounts you enter exist on the host.
The wizard displays a customization dialog box for database engine collation.
f. In the Collation designator box, select Latin1_General and then select Binary.
g. Click OK.
b. Under Authentication Mode, select Mixed Mode and define a password for the SQL Server
sa logon account.
d. Click Next.
3 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.
11. Proceed to the Ready to Install pane and click Install to install.
For information about installing Microsoft SQL Server on Linux, see Microsoft documentation:
https://docs.microsoft.com/
2. Configure Microsoft SQL Server using Microsoft SQL Server Management Studio.
Note that the bulkAdmin server role is not supported in SQL Server on Linux.
3. After you install Microsoft SQL Server, install the Microsoft Open Database Connectivity (ODBC)
driver for Linux as described in Microsoft documentation.
4. During installation of the Microsoft ODBC driver, the driver installer prompts you to install the
dependent UNIX ODBC driver manager (unixODBC). This is a third-party library that you can
download from Microsoft. Make sure you install this driver manager.
5. Verify the ODBC driver. After you install the Microsoft ODBC driver and the unixODBC driver
manager, verify the installation by executing the following command:
odbcinst -j
This command provides helpful information about the ODBC driver manager configuration. For
example:
myhost:~> odbcinst -j
unixODBC 2.3.7
DRIVERS............: /etc/unixODBC/odbcinst.ini
SYSTEM DATA SOURCES: /etc/unixODBC/odbc.ini -ILE DATA
SOURCES..: /etc/unixODBC/ODBCDataSources JSER DATA SOURCES..: /users/
nvhlwa/.odbc.ini
SQLULEN Size.......: 8
SOLLEN Size .......: 8
SQLSETPOSIROW Size.: 8
6. Configure the ODBC driver. Open the odbcinst.ini file from the location shown in the output of the
odbcinst -j command. (In the preceding example, this is in the /etc/unixodbc directory.) Verify that
this file contains a section with the heading [SQL Server].
If the section does not exist in the file, create the [SQL Server] heading and copy the contents
of the [ODBC Driver 17 for SQL Server] section into it. For example:
7. After you complete the installation of Microsoft SQL Server, the Microsoft ODBC driver, and the
UNIX ODBC driver manager, you can create a Teamcenter database in Microsoft SQL Server. Create
the database during Teamcenter installation through Deployment Center or using the Teamcenter
database template in Microsoft SQL Server Management Studio.
Deployment Center deploy scripts can create and populate a SQL Server database when you install
a Teamcenter corporate server.4 If you want the deploy script to create your Teamcenter database
automatically, skip this topic. Otherwise, create your Teamcenter database using the 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.
If SQL Server Management Studio prompts you to log on, enter the system administrator (sa) logon
name and password.
4 In the Database Server component, you can enter 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 Create a Teamcenter environment using Deployment Center.
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.
@DATA_PATH@ D:\MSSQL_DATA (Windows Path to the directory in which to place the data file.
systems) or /mssql_data
(Linux systems)
@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.5.
8. Save the newly modified file as filename.sql, removing the _template extension.
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.
5 Do not use the default collation value that ends with _CI_AS.
For the version of the Siemens License Server certified with Teamcenter 2406, see the Hardware and
Software Certifications knowledge base article on Support Center.
https://support.sw.siemens.com
Caution:
Make sure you download Siemens License Server, not Siemens PLM Licensing.1
3. In the Siemens License Server product center, click Downloads, and then download the certified
version of the Siemens License Server.
4. Install the License Server according to the Siemens Digital Industries Software License Server
Installation Instructions available from the Siemens License Server downloads page.
5. On your designated Teamcenter corporate server host, set the following system environment
variables:
SPLM_LICENSE_SERVER
Set to the location of the Siemens License Server:
port@host
Replace port with the port number and host with the machine name of the License Server, for
example, 29000@tchost.
TCP_NODELAY
Set to a value of 1 on the License Server host. This helps optimize logon time when launching
Teamcenter.
1 Siemens PLM Licensing is no longer supported by Teamcenter. The Siemens License Server is the currently supported
license server.
6. Install Teamcenter licenses on the License Server according to the information provided to you by
Siemens Digital Industries Software support.
The Siemens License Server downloads page contains additional links to documentation, Knowledge
Base articles, and videos about installing and maintaining the License Server.
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.
Create a Teamcenter environment. Install a corporate server, the central component of the
Teamcenter environment. Distribute Teamcenter software components across your network to optimize
performance and security. Add optional applications that provide the specialized capabilities and
integrations to your users.
Install Teamcenter and Active Workspace in a test environment, including the applications and
components you want to use.
Installing a test environment allows you to configure components and identify and resolve and
potential issues before you deploy your settings to a production environment.
This procedure is not required, but if you want to include optional or custom units of measure in your
Teamcenter environment, you can add them before you begin installation.
A list of nearly 1400 units of measure is provided in the Teamcenter installation kit. Out of the box, only
a subset of the units are installed, depending on the applications installed. Installers and administrators
can configure the units to add, and can add new units.
1. In the Teamcenter kit or in the TC_ROOT\TD folder, find and open unit_definitions.csv.
Application columns begin with column Q (BASE). Unit rows for which an application column has
the value 1 will be considered by the ums_import_unit_definitions utility.
Note:
During initial installation, if an application is installed in the environment, unit rows for which
the application column has the value 1 are imported to the database.
2. Edit the file to ensure that the unit definitions you want to administer have the value 1 for an
application.
In the event that no class definition exists for a unit you want in your environment, create a new
row.
On the local host where you install Teamcenter software, create the Teamcenter operating system user
account.
All Teamcenter services run as this user account. On Windows systems, 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.
Create an operating system logon account for Teamcenter. On Windows systems, 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.
The following are some services that may run under this user account:
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:
!@$%=&'"^:;._<>(){}
• 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.
On Linux systems, if Oracle and Teamcenter applications or files are shared using NFS/CIFS, you must
standardize the user and group IDs of the Teamcenter and Oracle accounts to give them the same
access privileges on all systems.
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.
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
Windows systems:
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
Linux systems:
• If the directory is in an automounted NFS directory, but you must supply the
automount link name for the Teamcenter application root directory. Do not supply
the automounted directory (for example, /tmp/mnt/node-name).
• If you install File Management System file caches and/or Multi-Site Collaboration
services, the directory must be on a local disk.
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.
1. Expand the Teamcenter 2406 software kit. Copy the unzipped contents to the software
subdirectory in one of your registered repository locations.
The Software Repositories page opens the Active Media tab of the repository and displays the
Software Media table.
3. Verify that the added software appears in the list of available software. The list may take a few
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.
2. On the far right below the command bar, click Add Environment .
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 .
5. In the Available Software panel, select Teamcenter Foundation 2406, and then click Update
Selected Software.
If the software you need is not listed, you must add it to the software repository.
Choose options
This environment type is useful for developing and testing Teamcenter deployment.
After you define Machine Name, OS, and Teamcenter Installation Path parameters for one
component in the environment, those values are inherited by the other components. Changing
these parameters for any component changes them for all components.
Machine Name, OS, and Teamcenter Installation Path configuration values are shared only
with other components that are required to be on the same machine. When configuring a new
component, you can select a Machine Name from the dropdown list or enter a new machine
name.
You can change the value from Distributed to Single Box if an installation 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.
If you have already deployed your environment with one of these architectures, the architecture
type is set and cannot be changed.
• Choose Local to specify an environment in which server and client components connect to the
current environment. Also, mass client components shared from a Global infrastructure can be
imported into a Local infrastructure. This is the default selection in a new environment.
4. When your selections are complete, click Save Environment Options to proceed to the
Applications task.
Choose applications
In the Applications task, the Selected Applications panel displays applications preselected by default.
The list of available applications and the default selections are based on the software you selected in
the Software task. Because you selected Teamcenter software, the Teamcenter application group is
selected, which contains Teamcenter Foundation and essential Active Workspace applications.
To continue with default Teamcenter applications only, proceed to Choose components. Otherwise, to
modify the selected applications, perform the following steps:
Select or deselect an application group to add or remove all applications in that group. For
example, if you do not want to include Active Workspace in your environment, remove the
Active Workspace Base application.
Select and then deselect the top-level Teamcenter application group. This removes all default
applications and any selections you made.
Expand or collapse application groups to simplify navigation. To search for an application by name,
use your web browser search.
Some application names have changed since previous releases. See Application names changed in
Deployment Center for more information about application names.
You can further add applications to your environment after you complete creating and deploying
your environment.
3. Click Update Selected Applications to save your changes to the Selected Applications list.
When you are satisfied with your Selected Applications list, proceed to the Components task.
Choose components
In the Components task, you configure components for installation. The Selected Components list
displays components that are automatically added by the applications in the Selected Applications list.
The default Teamcenter components in a Single Box type environment with Java EE architecture and
Local infrastructure type are the following:
Product Components
Teamcenter Corporate Server
Database Server
FSC1
FSC Group
To continue with default components only, proceed to Configure components. Otherwise, to add
components, perform the following steps:
1. Click Add component to your environment to display the list of Available Components.
Available components are determined by your selected software and applications. If a component
you want is not listed, modify your selections in those tasks. To search for a component, use your
web browser search. Expand or collapse component groups to simplify navigation.
2. 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.
The COMPLETE column displays the completion state for each component. At this time in the
process, the Deploy task is disabled because selected components have not been fully configured.
The Deploy task is enabled when the required parameters for all components are 100% complete.
When you are satisfied with the selected components, proceed to Configure components.
Configure components
Click a component in the Selected Components panel to view its configuration parameters. Parameters
for a given component can be displayed in two views:
All parameters view displays both required and optional parameter information. Click to
collapse the view to required parameters.
Select each component in your Teamcenter environment in turn, configure required parameters, and
then click Save Component Settings. Repeat these steps for each component until all components are
fully configured, showing a value of 100% in the COMPLETE column.
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 will remain disabled until all components
are 100% configured.
As you configure components, you may observe some components display a status of 100% even
though you have not selected them.
After a component displays a status of 100%, you can still select that component to review or change
parameter settings, or set additional optional parameters.
In Single Box environments, the Machine Name, OS, and Teamcenter Installation Path parameters
are automatically copied from the first component you configure, and any changes to these
parameters are copied to other components. An exception is the Database Server component, which
assumes a separate machine with a preexisting database server. For other components, Deployment
Center ensures that Single Box components specify the same machine.
Configure the required parameters for each of the following default components in your Teamcenter
environment. Select each component in turn, enter values for the required parameters, and then click
Save Component Settings. Repeat these steps for each component until all components are fully
configured, showing a value of 100% in the COMPLETE column.
Value Description
Publish Active Workspace Client Assets Specifies you want to automatically publish Active
Workspace content to the Gateway.
For more information about installing the Active Workspace client installation, see Install the Active
Workspace client.
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
certificate in .pem 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.
protocol://machine:port
For example:
https://myCorp:3000
Enable Product Select this check box if you want to participate in the Siemens Product
Excellence Excellence Program.
Program
For a full description of Active Workspace Gateway installation, see Install Active Workspace
Gateway.
For a full description of microservice deployment, see Microservices and the microservice
framework.
Corporate Server
If you create a Single Box environment, set the Machine Name, OS, and Teamcenter Installation
Path on a core component such as the Corporate Server. The Teamcenter Installation Path
specifies the Teamcenter root directory (TC_ROOT) on each given component machine. This path
must meet the requirements for the Teamcenter root directory.
Parameter Description
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.
Read Expression Specifies the time in seconds for the Read Expression Manager service to
Manager Sleep Time wait until a new update task is performed. The default is 10 seconds.
Login Account Specifies the user name and password for the operating system account
under which you install Teamcenter.
Database Server
Parameter Description
Database Creation Options for creating the Teamcenter database.
Settings
Create and Choose this option if no Teamcenter database or data directory exists
populate database. and you want Deployment Center to create both.
Create new data
Specify the Database Path.
directory.
For Oracle databases, this specifies the location of the tablespaces
for the Teamcenter database on the Oracle server. This is
typicallyORACLE_HOME \oradata\Oracle_SID (on Windows systems) or
ORACLE_HOME/oradata/Oracle_SID (on Linux systems).
For Microsoft SQL Server databases, this specifies the directory in which
to create the Teamcenter database on the SQL Server server.
Populate database. Choose this option if a database exists but is not populated with
Create new data Teamcenter data. You want Deployment Center to populate the
directory. database and create a new data directory.
Copy Environment Choose this option if a database exists and is populated. You want
using existing Deployment Center to use this database and create a new data
populated directory.
database.
In Volume Information, click Add Row , and 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.
Database Settings Settings for the Teamcenter database. Enter settings according to your
database type.
Oracle databases
Database Server Select Oracle.
Oracle Database Specifies a database user name:
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. Type the password
again in Confirm Password.
Service Specifies the name of the service for the Oracle instance. The default
name is tc.
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
default value is 1521.
The port number was determined when the Oracle server was installed.
Note:
To configure TCPS in Deployment Center, your Oracle server and
your Teamcenter corporate server must be installed on Linux
machines.
TLS Version Specifies the version of Transport Layer Security (TLS) configured on the
Oracle server. This is equal to SSL_VERSION value specified on Oracle
database machine.
Microsoft SQL Server databases
Database Server Select MSSQLServer.
User Specifies a database user name:
• 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.
Specifies the password for the database user. Type the password again
in Confirm Password.
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 Name Specifies the name of the MS SQL Server database. The default name is
tc.
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 Mode? Specifies whether to enable support for UTF-8 encoding in the
Teamcenter database.
Parameter Description
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.
To use UTF-8, you must configure your machine to support UTF-8
before you install Teamcenter host to support UTF-8.
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. In addition, the password must not contain any of the
following characters:
!@$%=&'"^:;._<>(){}
Database System User Database system credentials. These parameters are enabled if you
Credentials chose the first option under Database Creation Settings:
User Specifies the user name of the database system administrator account.
For Oracle databases, the default value is system, for Microsoft SQL
Server databases, the default value is sa.
Password Specifies the password for the database 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. In addition, the password must not contain any of the
following characters:
!@$%=&'"^:;._<>(){}
FSC
Parameter Description
Login Specifies the user account under which the FMS server cache (FSC) service runs.
Account 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.
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.
For an introduction to File Management System (FMS) components, see Overview of FMS
installation.
FSC Group
Parameter Description
Instance Specifies an instance name for the FSC group.
FSC Group Name Specified the name of the FSC group. An FSC (FMS server cache) group is a
group of server caches defined in the File Management System (FMS) master
configuration file.
For an introduction to File Management System (FMS) components, see Overview of FMS
installation.
FSC Keys
Parameter Description
Generate New Keys Specifies you want to generate new keys
Key Store Password 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 Is
Master? check box. Otherwise, type the URL to the parent FSC in the
box.
Use Symmetric Keys Specifies you want to use symmetric keys instead of asymmetric keys.
Configure Key Alias? Specifies you want to use a key alias. Enter the key alias under which
you want to store the FMS key in the Key Alias box.
Parameter Description
Configure Key Alias Specifies you want to use a key alias password. Enter and confirm the
Password? Key Alias Password.
Sync FSC Key for Specifies you want to use a symmetric key for Multi-Site. Enter and
Multi-Site? confirm your Multi-Site symmetric key.
Use Asymmetric Keys Specifies you want to use asymmetric keys instead of symmetric keys.
(advanced)
For detailed information about configuring FMS ticket signing keys, see System Administration.
Indexer
Parameter Description
Install Database Select the Install Database Triggers for Indexing check box if you
Triggers for Indexing want to install database triggers.
Maximum Teamcenter Specifies the maximum number of connection between the Teamcenter
Connections server and the indexer to be open at a given time. This value should be
less than the number of warmed up Teamcenter servers available in the
server manager. The default value is 3. The minimum value allowed is 1.
Staging Directory (For Dispatcher-based indexing only)
Specifies is Dispatcher staging directory. This directory is defined in the
Dispatcher Components panel when you install the Dispatcher server.
Specifies the staging directory used by the indexer. In standalone
indexing mode, this directory is in the location where the standalone
indexer is installed. In Dispatcher-based indexing mode, this is usually
the same as the Dispatcher server staging directory.
Install Indexer as a Select the Install Indexer as a Service check box if you want to
Service? install the objdata synchronization flow and the suggestion builder
synchronization flow of the indexer as services.
Service Name The Service Name fields populate with suggested names for the
services, and can be edited.
Sync interval The Sync Interval fields populate with suggested intervals for the
synchronization flows and can be edited.
Start Service Select the Start Service check box to automatically start the service.
Service Name Specifies the display name for the Suggestion Builder Service.
Sync interval Specifies the sync interval for the Suggestion Builder Service.
Start Service Select the Start Service check box to automatically start the
Suggestion Builder Service.
For a full description of indexer installation, see Install Indexing Engine (Solr).
Licensing server
Parameter Description
Teamcenter Licensing Port Specifies the port used by the license server.
Microservice Node
Parameter Description
Windows machines
Install Process Select this check box if you want to install the Teamcenter Process
Manager as a Manager as a service.
Windows
service If you clear this check box, you must start the Teamcenter Process Manager
manually after deployment on the Microservice Node machine.
Windows Specifies a name for the service. This name will be displayed in the Services
Service Name panel in the Windows Control Panel.
Linux machines
Instances Enter the number of service dispatcher instances to run on the node.
Service Enter the ingress URL for the service dispatcher.
Dispatcher
Endpoint URL
Keystore Enter a password to be used for generating the .p12 files that contain keys
Password for signing and validating authentication tokens. The tokens identify the
and logged-on user.
Confirm
Record and store the password securely for potential use, should you want
Keystore
to open and edit the keys.
Password
File Repository Specifies the path to the storage location for the file repository to be used by
Storage Location the Active Workspace Gateway, for example, c:\tc\file_repository.
Parameter Description
On Linux machines, the path to the storage location must exist on the
current host. On Windows hosts, Deployment Center creates the directory if
it does not exist.
If you install multiple instances of the File Repository microservice, all
instances must reference the same physical storage location.
Active Workspace uses a file repository microservice. To configure that
service for deployment on a Linux host, parameter values Deploying User
UID, Deploying User GID, and File Repository Storage Location values are
required. Values entered for the master microservice node must be valid on
all worker nodes.
Services 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.
For a full description of microservice deployment, see Microservices and the microservice
framework.
Search Engine
Parameter Description
Indexing Engine Specifies the user account under which the FMS server cache (FSC) service
Settings runs. Choose one of the following options:
User Type the user name for the Solr administrator. These credentials must
match the Indexer and the Active Content Structure Translator (if used).
Password Type the password for the Solr administrator account. These credentials
must match the Indexer and the Active Content Structure Translator (if
used).
Indexing Engine Settings for the Indexing Engine Service.
Service Settings
Install Indexing Select this check box if you want to install the Indexing Engine as a
Engine as a service.
Service?
If you clear this check box, you must start the Indexing Engine manually
after deployment on the Indexing Engine machine.
User Type the operating system user name and password on the Indexing Engine
machine.
For a full description of indexing engine installation, see Install Indexing Engine (Solr).
Server Manager
Parameter Description
Server Pool ID Specifies a name for the server pool.
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.
For a complete description of server manager installation, see Install the server manager.
Parameter Description
Server Manager Type a name for the server manager cluster.
Cluster ID
To balance the sessions load among multiple server managers,
each server manager must have the same Cluster ID (that
is, use the same server manager database). The Cluster ID
value is stored in the MANAGER_CLUSTER_ID property in the
TC_ROOT\pool_manager\serverPooldatabase-name.properties file.
Server Manager
Database
Creation
Settings
Parameter Description
Create new Choose this option to create a new database user and database for the server
database for manager. In the Database Path box, type the directory in which to create the
the Server Teamcenter database on the database server.
Manager
Be prepared to enter database system credentials for the new database.
Cluster
Use an Choose this option if you want to use an existing database user and database
existing for the server manager. Your database administrator must create the database
database for user and database before you proceed.
the Server
Manager
Cluster
Server Manager
Database
Settings
Oracle databases
Database Select Oracle.
Server
Port Specifies the number of the port on which the Oracle server listens. The port
number was determined when the Oracle server was installed.
Service Specifies the name of the service for the Oracle instance. The service name
was determined when the Oracle server was installed.
User Specifies the database user name.
Password Specifies the database password.
Microsoft SQL Server databases
Port If you connect to Microsoft SQL Server using a specific port, select this option
and enter the port number you specified when you installed MS SQL Server.
Instance If you connect to Microsoft SQL Server using a named instance, select this
option and enter the instance name you defined when you installed MS SQL
Server.
Database Specifies the name of the MS SQL Server database. The database name was
Name 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.
User Specifies the database user name.
Password Specifies the password for the database user.
Database Database system credentials. These parameters are enabled if you chose the
System User first option under Server Manager Database Creation Settings:
Credentials
For a complete description of server manager installation, see Install the server manager.
Value Description
Protocol Specifies the protocol to use to connect to the web tier (http or https).
Port Specifies the port to use to connect to the web tier.
Teamcenter 4-tier Specifies the URL to the Teamcenter web tier application. This value is
URL constructed from other parameters and is not directly editable. It has the
following form:
protocol://machine:port/application-name
For example:
https://myCorp:7001/tc
Teamcenter Specifies a name for the Teamcenter web tier web application. The default
Application Name value is tc.
Web App Server Specifies the name of the machine that runs the Java EE web application
Machine Name server. This the machine on which you deploy the Java EE web tier WAR file
(typically tc.war).
JMX RMI Port Specifies the JMX RMI port number for the web server. For example, type
8088 for the default server manager port or 8089 for the default web tier
port.
Teamcenter Specifies a name for the web tier connection.
Connection Name
Tag Specifies a tag for the environment that can be used to filter the list of TCCS
environments during logon.
For a complete description of .Java EE web tier installation, see Install the Java EE web tier.
Value Description
Protocol Specifies the protocol to use to connect to the web tier (http or https).
Teamcenter 4-tier Specifies the URL to the Teamcenter web tier application. This value is
URL constructed from other parameters and is not directly editable. It has the
following form:
protocol://machine:port/application-name
For example:
https://myCorp:7001/tc
Virtual Directory Specifies the IIS virtual directory name for Teamcenter .NET web tier
Name deployment. The default value is tc.
Teamcenter Specifies a name for the web tier connection.
Connection Name
Tag Specifies a tag for the environment that can be used to filter the list of TCCS
environments during logon.
For a complete description of .NET web tier installation, see Install the .NET web tier.
When all components are fully configured (showing a value of 100% in the COMPLETE column), proceed
to the Deploy task.
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.
Deployment Center generates installation scripts, and reports information about the scripts in the
right panel.
• 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.
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 Deployment Center ─ Usage.
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.
On Linux systems, if you installed the corporate server without root privileges, a user with root privileges
must run the root postinstallation tasks scripts. These scripts register daemons and perform other
installation actions that require root privileges.
Run all scripts in the TC_ROOT/install directory that have names of the following form:
root_post_tasksid.ksh
If you select the Database Daemon component during Teamcenter installation, Deployment Center
configures the database daemons to start automatically as Windows services on Windows machines.
After installation, you can find these services in the Services dialog box in the Windows Control Panel:
If the services do not start automatically, see the available troubleshooting solutions.
1. After the services are started, a program runs in TC_ROOT\bin named tc_service.exe.
Windows displays tc_service.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_service.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).
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.
You can start Teamcenter database daemons manually by executing the following startup files.
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.
1. To grant the create trigger privilege to the Oracle user that owns the Teamcenter database,
perform the following steps:
b. Type:
sqlplus system/password
c. Type:
d. Type:
exit
sqlplus Tc-Oracle-user/password
b. Type:
@Teamcenter-installation-media\tc\install\sitecons\sitecons_install_triggers_oracle.sql
a. In the Server name box, select the host on which Microsoft SQL Server is installed.
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.
5. In the Open File dialog box, navigate to the software kit for the Teamcenter release.
6. Click Query→Execute.
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:
Replace:
For example:
To verify the triggers installed successfully, log into Microsoft SQL Server and type the following
commands in an SQL prompt:
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)
3. Enter values for the machine on which you install the server manager:
• Single box
If your environment is a single box environment, the Machine Name, OS, and Teamcenter
Installation Path values are inherited from the first component you configured in your
environment. Changing these values will change them for other components in your
environment.
• Distributed
If your environment is a distributed environment, type the Machine Name, OS, and
Teamcenter Installation Path for the machine on which you install the server manager.
If you want to specify additional settings for the Indexing Engine, click Show all parameters .
5. Proceed to configuring the Server Manager Cluster Configuration component, which Deployment
Center automatically selects for configuring next.
As with the Server Manager component, enter values for Machine Name, OS, and Teamcenter
Installation Path as appropriate for your environment type (single box or distributed).
Choose this option if you want to use an existing database user and database
for the server manager. Your database administrator must create the database
user and database before you proceed.
Server Select the database vendor (Oracle or MSSQL Server), then enter the appropriate
Manager database configuration values:
Database
Settings Table 3-3. Oracle database server values
Value Description
Port Specifies the number of the port on which the Oracle server listens.
The port number was determined when the Oracle server was
installed.
Service Specifies the name of the service for the Oracle instance. The service
name was determined when the Oracle server was installed.
User Specifies the database user name.
Password Specifies the database password.
Value Description
Instance If you connect to Microsoft SQL Server using a named instance,
select this option and enter the instance name you defined when
you installed MS SQL Server.
Port If you connect to Microsoft SQL Server using a specific port, select
this option and enter the port number you specified when you
installed MS SQL Server.
Value Description
Database Specifies the name of the MS SQL Server database. The database
Name 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.
User Specifies the database user name.
Password Specifies the password for the database user.
Database In the System User box, type the user name of the database server system
System User administrator account. For Oracle databases, the default value is system. For
Credentials Microsoft SQL Server databases, the default value is sa.
In the Password box, type the password for the database server system
administrator account.
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:
!@$%=&'"^:;._<>(){}
7. Click Save Component Settings to submit the server manager cluster configuration values.
9. 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.
10. 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 ─ Usage.
If you experience connection delays during server manager startup, see the available troubleshooting
solutions.
You can install multiple server manager services (on Windows systems) or daemons (on Linux systems)
on the same machine. Each server manager service has its own configuration directory:
Windows: TC_ROOT\pool_manager\confs\config-name
Linux: TC_ROOT/pool_manager/confs/config-name
The server manager configuration directory contains configuration files, log files, and server manager
scripts. These include the following.
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.
On Linux systems, if you run the server manager as a daemon, stop the service using
the rc.tc.mgr_config script.
On Windows systems, 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 service (on Windows systems) or a daemon (on Linux
systems), 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 or a Linux daemon, the server manager starts
automatically.
Various Teamcenter solutions and applications include microservices as part of their deployment. For
example:
The File Repository provides centralized temporary storage for web client content accessed through
the web client 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.
• A container registry
Management Docker Swarm or Kubernetes starts, stops, restarts, On Windows, each
of microservice and scales all Teamcenter microservices running as microservice framework
framework and containers in a way that best utilizes resources. node includes a
application Teamcenter process
microservices manager to handle the
microservices on that
node.
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)
Mirantis Container Runtime (MCR, formerly Docker Engine - Enterprise) is a prerequisite for microservice
nodes on Linux hosts. For certified versions of Linux and MCR (Docker) software, refer to the Hardware
and Software Certifications knowledge base article on Support Center.
1. Ensure the following ports are open to traffic to and from each microservice node host:
2. Install MCR.
IP forwarding must be enabled for successful communication between Docker containers and the
host machine. MCR installation alters the Linux iptables to allow forwarding of packets between the
host and bridge networks when such forwarding is enabled. See MCR (Docker) documentation for
information on how to partially restrict forwarding (based on IP addresses) for tighter security.
sysctl -w net.ipv4.ip_forward=1
c. To preserve this setting across a machine reboot, edit the file /etc/sysctl.conf and set
net.ipv4.ip_forward to 1.
Use common Docker commands to control the Docker Swarm environment and monitor container
status. Additionally, many open source tools, such as Portainer, are available to help manage a Docker
Swarm.
• Manage the nodes in a swarm and temporarily adjust scaling of services across the swarm.
Docker troubleshooting
What do I do when I receive the error Cannot connect to the Docker daemon ?
1. To check whether dockerd is running, run
For more debugging information, refer to configuring the Docker daemon in the documentation at
https://docs.docker.com.
What do I do if a Docker command does not behave as expected?
If the Docker command does not behave as expected, add the -debug option, run the command
again, and review the log for issues.
Example:
You run the command docker deploy -f mystack.yml mystack and it does not behave as
expected.
To enable logging, insert -debug after docker:
docker -debug deploy -f mystack.yml mystack.
This tails the log files and keeps outputting new log commands until the command prompt is closed
or you enter Ctrl-C.
Where can I get help with more complicated environments?
For help with more complicated environments and networking when microservice nodes are on
Linux hosts, see the Docker engine swarm mode documentation at https://docs.docker.com/.
For deployments of the microservice framework and microservices on Linux hosts, microservice
container images are stored in a container registry. If you do not already have a container registry
in your infrastructure, you can use the following procedure to deploy a Docker container registry.
Prerequisites
• Mirantis Container Runtime (formerly Docker Engine - Enterprise, hereafter referred to as MCR)
must be installed on both the machine that is used to initially fetch the Docker Registry container
image and on the machine that will host the Docker Registry. For instructions on installing MRC,
refer to Deploy MCR (Docker) on microservice node hosts.
• For a secure production environment, a PKI certificate and keys generated for the server hosting
the Docker Registry must be available. It is a good practice to obtain certificates from a Certificate
Authority.
1. Prepare to fetch the Docker Registry container image. On a machine with internet access and with
MCR installed, extract the microservice framework Linux kit.
If the machine is not the intended Docker Registry server, its host operating system can be either
Linux or Windows.
3. Depending on the machine operating system, run the script to fetch the tested version of the
Docker Registry container image.
Linux getDockerRegistry.sh
Windows getDockerRegistry.bat
4. As needed, move the fetched .tar file to the machine that will run the Docker Registry service. Load
the image.
5. Deploy the registry for the planned microservice framework container manager type, either Docker
Swarm or a Kubernetes cluster.
/scratch/docker_registry/data
/scratch/docker_registry/certs
/scratch/docker_registry/auth
If you use different paths, update the YML or YAML configuration files in the corresponding
subdirectories of the microservice framework kit:
kit\additional_applications\docker_registry\deploy\swarm or kubernetes
See https://docs.docker.com/registry/deploying/#run-an-externally-accessible-registry
c. Restrict access.
See https://docs.docker.com/registry/deploying/#restricting-access
d. Deploy the registry to a new stack. This new stack is unrelated to Teamcenter, Active
Workspace, and the microservice framework.
Caution:
Deploy to a unique cluster or stack separate from Teamcenter microservices. This
protects the running registry if you delete the Teamcenter microservices Docker Swarm
stack or Kubernetes cluster.
The valid response shows an empty repository, as nothing has been pushed to it yet:
{"repositories":[""]}
Microservices can be installed on a Linux host that is either a member of a Docker swarm or managed by
Kubernetes.
For installation in a Kubernetes environment, two prerequisites must be in place before configuring
a microservice node and its microservices. These prerequisites are common tasks when setting up a
Kubernetes environment. Resulting values are needed during configuration.
Prerequisite
for Kubernetes
environment Description
Ingress controller Set up an ingress controller of your choosing. Configure rules for two routes:
The ingress controller must also be configured to allow for attaching payloads
of sufficient size in Active Workspace. The setting for this may vary depending
upon which ingress controller is in use. Please refer to the documentation for your
ingress controller.
Prerequisite
for Kubernetes
environment Description
Example:
For an nginx ingress controller, the solution is to define the following setting
(highlighted in yellow) in the nginx config map:
1. Download a compatible Teamcenter kit and place it in the Deployment Center software repository.
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.
6. Enter additional microservice parameter values as required. The parameters shown vary depending
on which applications are selected for the environment.
7. In the Services list, review the quantity of instances for each service.
Deployment Center copies the service dispatcher URLs to the Active Workspace Gateway and Web
Tier components.
9. 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).
10. In the Container Configuration component, specify option values. The component appears only if
Microservice Node OS is set to lnx64.
11. Complete the configuration of the environment and generate deployment scripts.
12. Ensure that Docker is installed on the microservice node host before you run its deployment script.
Refer to Deploy MCR (Docker) on microservice node hosts.
Run the microservice node scripts before you run the web tier deployment script.
15. If you chose the https protocol for moving data between the Teamcenter web tier and the service
dispatcher, configure the service dispatcher as an HTTPS server.
16. Depending on the container manager, follow the appropriate instructions to complete the
installation and start the microservices:
To increase the capacity of heavily used microservices deployed to Linux hosts, you can add microservice
instances via Deployment Center.
1. In Deployment Center, on the Components task for your environment, open the Microservice
Node.
3. Complete your environment configuration and follow the Deployment Center instructions for
deploying the generated ZIP files onto the target machines.
When your microservice framework is deployed for Docker Swarm, use the following procedure to start
Docker and then start microservices.
Start Docker
Tip:
If this is the master node and you intend to later join other servers to this swarm as workers, save
the output command string for later use.
Once you have started Docker on a node, you can join the node to a running swarm.
During the installation of microservice nodes, one node must be configured. Microservice .yml files are
copied to this node. These files define the microservice container parameters and are used to deploy
the microservice containers. Once the stack of containers is deployed on this node, Docker manages
the stack across the swarm, automatically deploying containers as needed on other servers that join the
swarm.
2. Run the following commands to deploy a stack for the microservice framework service:
3. Using the same command pattern and the same stack name, deploy all other .yml files in the
directory.
Once a microservice node has started a Docker Swarm, you can join additional servers to the swarm
as either workers or managers. Any number of servers can be added as workers. If the swarm includes
multiple manager nodes, the manager nodes vote to determine which node is the controlling node. To
ensure a decisive vote, the swarm must have an odd number of manager nodes.
2. Use the appropriate procedure to join the server to the swarm as a worker or as a manager.
For this
join
mode Do this
Worker Run the Docker command that you saved from the output when the swarm was started.
If a saved join token is not available, on the original node run the following command to
request a token:
For this
join
mode Do this
b. On the original node, run the following command to request a manager token:
c. Copy the command output and paste it to a command line on the machine you want
to join to the swarm.
If deploying the microservice framework into a Kubernetes environment, then after using Deployment
Center to perform initial microservices configuration and installation, use either the following
automated or manual procedure to finalize configuration and start microservices. A short list of
commands useful for validating the microservice environment in Kubernetes follows the procedures.
Deploy automatically
Deploy manually
Validate the microservice framework and microservices in a Kubernetes cluster
Note:
By default, support is provided for Project Calico network policies. If your network policy solution
is other than Project Calico, review the generated network security policy files (*_np.yml) and
create versions compatible with your network policy solution.
Deploy automatically
The Deployment Center scripts deposit relevant shell scripts in the TC_ROOT/bin folder on the
microservice node machine.
deploy_microservices.sh
redeploy_microservices.sh
undeploy_microservices.sh
./deploy_microservices.sh
The scripts are also present in the microservice framework kit within
additional_applications\microservice_management.
Deploy manually
The namespace value should match the namespace value entered in the Container
Configuration component for the environment in Deployment Center.
cd TC_ROOT/container/kubernetes/setup/scripts
Caution:
Address any errors before proceeding to the next step.
cd TC_ROOT/container/kubernetes/setup
b. Run all the setup files (network policies, volumes, persistent volume claims, and persistent
volume).
kubectl create -f .
cd TC_ROOT/container/kubernetes/deployment
kubectl create -f .
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.
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.
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 .
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.
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 for HTTPS.
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.
TC_ROOT\process_manager\start_manager.bat
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 on a Windows machine.
3. Complete your environment configuration and follow the Deployment Center instructions for
deploying the generated zip files onto the target machine(s).
Securing microservices
An administrator can configure the microservice framework to encrypt data traffic based on an SSL
certificate.
Note:
For a Kubernetes container manager on Linux, encryption can be configured for the ingress
controller and service mesh. Refer to the documentation for the specific ingress controller or
service mesh. Example service mesh implementations are Istio and Linkerd.
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.
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.
• When configuring the web client gateway, if you choose to override the default service dispatcher
URL, ensure that you enter the HTTPS protocol for the Service Dispatcher URL.
• When deploying the container registry on Linux, for example, Docker Registry, ensure that the
container registry uses the HTTPS encryption protocol.
• After running deployment scripts on the microservice node host(s), configure the service dispatcher
for HTTPS.
To encrypt traffic on the microservice framework on Windows or using Docker swarm on Linux, an
administrator must configure the service dispatcher for HTTPS.
Note:
To enable encryption using Kubernetes on Linux, deploy a service mesh such as Istio or Linkerd. Do
not configure service dispatcher for HTTPS.
1. Obtain an SSL certificate for the server that will host the service dispatcher.
The name of the server where the service dispatcher is deployed must match the name in the
certificate. For example, if the service dispatcher host server name is sd.example.com, then
the certificate must be for sd.example.com. A certificate from either a certificate authority or a
self-signed certificate can be used. If a self-signed certificate is used, the additional procedure
Configure microservices for self-signed certificates is required. Make sure that the certificate and
key are presented in the .pem format.
2. Use the Java keytool to create a Java trust store in PKCS12 format and place the certificate (public
key) in the store.
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.
4. Go to the Components tab, and then select the Microservice Node component to display its
parameters.
8. In the Selected Components list, note any remaining components whose configuration status is
not 100%. Select each incomplete component, enter required parameters, and save component
settings until all components in the environment show a configuration status of 100%.
When all components are fully configured, the Deploy tab is enabled.
9. Go to the Deploy tab. Click Generate Install Scripts to generate deployment scripts you will use to
update affected machines.
When script generation is complete, note any special instructions in the Deploy Instructions panel.
10. Locate deployment scripts, copy each script to its target machine, and then run each script on its
target machine.
For more information about running deployment scripts, see Deployment Center ─ Usage.
11. Continue with Configure the web tier for HTTPS with the service dispatcher.
Configure the web tier for HTTPS with the service dispatcher
1. Configure the Teamcenter web tier as appropriate for the web tier type.
Example:
becomes
MICROSERVICE_ADDRESS
MICROSERVICE_TRUSTSTORE
MICROSERVICE_TRUSTSTORE_TYPE
MICROSERVICE_HOST_VERIFY_MODE
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>
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.
If the service dispatcher is configured for HTTPS and the TLS certificate used is self-signed, each
microservice on a node must be configured to trust the self-signed certificate. The following instructions
apply to microservices that communicate with a server using a self-signed certificate. These steps
describe how to configure the microservices with the Certificate Authority.
For these
microservices Do this
Declarative Artifact Prerequisite: The certificate must be in the PEM format and must not have been
Service generated using DSA encryption.
Teamcenter
Example:
GraphQL Service
ClassificationAI
(Source code
language:
Javascript/
For these
microservices Do this
Typescript using
NodeJS)
For most microservices, the .json file has an ARGS variable, to which you
can append arguments.
(Source code
language: Java)
• Some microservices, notably odata_service, require that you modify
the corresponding TC_ROOT\microservices\microservice\start_service.bat
script to add the JVM arguments.
Office Online
For these
microservices Do this
keytool -importkeystore -srckeystore [./keystore2.jks]
Product -destkeystore ./keystore2.p12 -srcstoretype JKS -deststoretype
PKCS12
Configurator -srcstorepass testKeyStorepw -deststorepass testKeyStorepw
Service -srcalias mykey
-destalias mykey -srckeypass testKeyStorepw -destkeypass
reqexportservice testKeyStorepw -noprompt
Teamcenter Share
(Source code
language: C#)
For these
microservices Do this
Declarative Prerequisite: The certificate must be in the PEM format and must not have been
Artifact Service generated using DSA encryption.
For these
microservices Do this
fluentd-address: 0.0.0.0:24223
fluentd-async-connect: 'true'
tag: 'msf.{{.Name}}.{{.ID}}'
depends_on:
- eureka
secrets:
- validator_keystore.pem
- cert_file_name.pem
secrets:
validator_keystore.pem:
file: ./secrets/validator_keystore.pem
cert_file_name.pem:
file: ./secrets/cert_file_name.pem
req-compare- -Djavax.net.ssl.trustStore=path_to_truststore_file
service
Example:
version: "3.3"
services:
(Source code filerepo:
language: Java) hostname: filerepo
image: vcl6005:5000/teamcenter/file-repo:6.3.0
user: 0:0
deploy:
mode: replicated
replicas: 1
For these
microservices Do this
volumes:
- /scratch/msf/filerepo:/fms/fsc/volume
#@#logging:
#@# driver: fluentd
#@# options:
#@# fluentd-address: 0.0.0.0:24223
#@# fluentd-async-connect: 'true'
#@# tag: 'javamld.{{.Name}}.{{.ID}}'
environment:
- ARGS=-Deureka.serviceUrl.default=http://
eureka:8080/eureka/v2/
-Dsecrets_path=../../run/secrets/
-DdispatcherUrls=https://
vcl6005.net.plm.eds.com:9090/
-Djavax.net.ssl.trustStorePassword=private
-Djavax.net.ssl.trustStore=/run/secrets/
trust_store_file_name.p12
-Djavax.net.ssl.trustStoreType=pkcs12
secrets:
- tc_micro_security.properties
- validator_keystore.p12
- signer_tc_micro_security.properties
- signer_keystore.p12
- trust_store_file_name.p12
depends_on:
- eureka
secrets:
tc_micro_security.properties:
file: ./secrets/tc_micro_security.properties
validator_keystore.p12:
file: ./secrets/validator_keystore.p12
signer_tc_micro_security.properties:
file: ./secrets/
signer_tc_micro_security.properties
signer_keystore.p12:
file: ./secrets/signer_keystore.p12
trust_store_file_name.p12:
file: ./secrets/trust_store_file_name.p12
For these
microservices Do this
Google Online For this operating system Use this location
Teamcenter Share 3. To verify that the certificate is installed, run the command trust list and check
that your certificate is in the list.
(Source code
language: C#)
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.
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 Deployment Center, 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.
In a high availability configuration, where there is more than one File Repository microservice deployed,
with the File Repository storage shared between the multiple instances of File Repository, the Active
Workspace publish operation needs to be performed only once, from one of the nodes (preferably the
primary node). This updates the shared storage of the File Repository microservice, so the publish does
not need to be repeated from another node. Any new publish will overwrite the previous publish in the
shared storage. Additionally, the publish should always be done from the same node (for example, the
primary node) as used for the previous publish. It is not recommended to publish from a different node
in a subsequent publish, as this may cause errors.
Install microservices
The microservice framework must be installed before you begin these steps. You can add microservices
to an existing microservice node or install the microservices and Microservice Framework at the same
time.
2. In the Software task, make sure the Selected Software list includes the Teamcenter 2406
software.
4. Proceed to the Components task. Select the Microservice Node component and enter required
values for the following microservices:
Value Description
File Repository Type a location for the file repository to be used by the web client gateway.
Storage Location The path must exist on the machine that hosts the microservice node. For
example: c:\tc\file_repository
The file repository stores web client 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.
Value Description
Teamcenter Web Tier URL 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.
Teamcenter Security Services (TcSS) provides integrated login, authentication and single sign-on (SSO)
services for Teamcenter and its application suite.
The Security Services Login Service and Identity Service are Java EE web applications (WAR files) that
provide the essential functions of Security Services. Deployment Center builds these applications, which
you then deploy on a supported Java EE web application server.
For information about supported application servers and Java versions, see the Hardware and Software
Certifications knowledge base article on Support Center.
This procedure assumes you have an existing Teamcenter environment. Make sure the required
Teamcenter software kits have been added to your software repository in Deployment Center.
Log on to Deployment Center and select your Teamcenter environment, then begin installing TcSS.
If you build the TcSS Login and Identity Services using Deployment Center and you have an LDAP server
set up and want to configure LDAP settings in the Identity Service, you must configure the TcSS LDAP
component.
If you build the TcSS Login and Identity Services using the Web Application Manager (insweb), skip
these steps and proceed to Configure Teamcenter Security Services.
1. In the Components task in Deployment Center, click Add component to your environment to
display the Available Components panel.
4. Enter Machine Name and OS values for the machine on which you install Security Services:
• Single box
If your environment is a single box environment, the Machine Name and OS values are
inherited from the first component you configured in your environment. Changing these values
will change them for other components in your environment.
• Distributed
If your environment is a distributed environment, select a machine name from the dropdown
list or enter a new machine name. Then, enter the OS for the machine on which you install
Security Services.
Parameter Description
LDAP Ordinal Specifies the search order for the LDAP server. The server with the lowest
number (for example, 1) indicates the primary LDAP server.
Other numbers indicate the order in which secondary LDAP servers are
searched, from lowest to highest.
LDAP Protocol Specifies the protocol to use when connecting to LDAP servers.
Selecting tls specifies non-SSL LDAP connections, but then uses startTLS
protocol to promote the connection to TLS.
Parameter Description
A value of -1 means connect to the servers serially, and 0 means initiate
parallel connections to all servers at once.
LDAP Connection Specifies the interval in seconds to wait before abandoning an LDAP request,
Timeout which can include connection, search, and bind attempts. If LDAP Connection
Setup Delay is greater than 0, this value should be greater in order to allow
multiple connection attempts.
A value of 0 means unlimited.
For a complete mapping of Security Services context parameters from the Web Application
Manager (insweb) to Security Services properties in Deployment Center, see Security Services
properties in Deployment Center.
For more information about configuring LDAP servers, see Security Services Configuration.
1. In the Components task in Deployment Center, click Add component to your environment to
display the Available Components panel.
2. Select Teamcenter Security Services (TcSS), and then click Update Selected Components.
4. Specify the Machine Name and OS values as appropriate for your environment type.
5. Under TcSS Settings, enter credentials for the Teamcenter Administrative User in TcSS LDAP:
Tip:
To locate a specific parameter, use your web browser's search function.
6. Select the Use Deployment Center to build the Login Service and Identity Service WAR files
check box.
Note:
Alternatively, you can build the Security Services login service and identity service using the
Web Application Manager as described in the Teamcenter installation guides for TEM (for
Windows or Linux). This will require additional parameter settings in Deployment Center to
use the Security Services WAR files generated by the Web Application Manager.
7. In the Staging Location parameter, type the path in which to place the generated WAR files, for
example, c:\staging.
When you generate deployment scripts, Deployment Center places TcSS WAR files in a deployment
subdirectory beneath the staging location you specify.
Value Description
Common WAR File Settings to configure the properties password for Security Services.
Settings
Properties Specifies the password that will be used to decrypt encrypted property
Password values stored in properties files (for example, federation.properties).
Retype the password in the Confirm Properties Password box.
TcSS Login URL Settings to configure the Security Services Login Service.
Settings
Login Service's Specifies the name of the machine on which you deploy the Security
Web App Server Services Login Service WAR file.
Machine Name
Protocol Specifies the protocol to use to connect to the web tier (http or https).
Port Specifies the port through which the Login Service connects. The default
value is 7001.
Login Service Specifies the name of the Login Service, for example, tcssols.
Application Name
Login Service URL Specifies the URL to the Login Service. This parameter is not directly
editable, but is constructed from the protocol, port, machine name,
and application name of the Login Service, for example, http://
myHost:7001/tcssols
Identity Service Type a password for connecting to the TcSS Identity Service. Retype the
Password password in the Confirm Identity Server Password box.
TcSS Identity Service Settings to configure the Security Services Identity Service.
URL Settings
Value Description
Login Service's Specifies the name of the machine on which you deploy the Security
Web App Server Services Identity Service WAR file.
Machine Name
Protocol Specifies the protocol to use to connect to the web tier (http or https).
Port Specifies the port through which the Identity Service connects. The
default value is 7001.
Login Service Specifies the name of the Login Service, for example, tcssoservice.
Application Name
Login Service URL Specifies the URL to the Login Service. This parameter is not directly
editable, but is constructed from the protocol, port, machine name,
and application name of the Login Service, for example, http://
myHost:7001/tcssoservice
Mediator Password Specifies a password shared between the Identity Service and a
mediating application. Retype the password in the Confirm Mediator
Password box.
This password is used to encrypt tokens passed to the mediator for later
distribution to applications participating in trust relationships.
For a complete mapping of Security Services context parameters from the Web Application
Manager (insweb) to Security Services properties in Deployment Center, see Security Services
properties in Deployment Center.
If you want to specify additional settings for Security Services, click Show all parameters .
When you are finished configuring TcSS parameters, click Save Component Settings.
10. 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.
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 ─ Usage.
12. In the deployment directory under your specified staging location on the target machine, find the
Login Service and Identity Service WAR files.
For more information about configuring Security Services to meet your security requirements, see
Security Services Configuration.
To see how Security Services context parameters from the Web Application Manager (insweb) map to
Security Services properties in Deployment Center, see Security Services properties in Deployment
Center.
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.
Note:
Install Active Workspace Gateway using the same tool with which you install Active Workspace
microservices. For example, if you install microservices using Deployment Center, install Gateway
using Deployment Center. Or, use TEM for both installations.
When entering URLs, ensure you use URLs with fully qualified domain names or IP addresses.
1. Make sure you have the Teamcenter 2406 software in your repository.
Choose your new or existing environment, and create or update the Selected Software list.
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.
1 Web Application Deployment provides Teamcenter web tier deployment procedures for several supported application
servers.
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.
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. The Service Dispatcher URLs
must include fully qualified domain names or IP addresses.
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. Under Teamcenter Share Collaboration, type your Teamcenter Share Collaboration settings:
Value Description
Teamcenter Share Specifies the URL to the Teamcenter 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 Specifies the client secret ID you obtained through SAM URL. Enter this value
again in the Confirm Client Secret box to confirm.
6. 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.
7. (If Active Workspace Gateway is deployed on a Linux host) Start the Docker swarm, microservices
node, and the Gateway service.
Before you install the Active Workspace client using Deployment Center, you must complete the
following:
• Install microservices
You can install the Active Workspace client concurrently with Active Workspace Gateway.
Install the Active Workspace client configuration using the Teamcenter 2406 software kit.
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.
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.
The Indexing Engine and the Indexer provide global search capabilities for Active Workspace. Install
these components using Deployment Center:
• Indexing Engine
Installs the Solr enterprise search platform. The search engine stores indexed Teamcenter data for
global search in Active Workspace.
Selected product data is indexed in Solr, an open source search platform from Apache. The master
product data is not stored in Solr. It is always loaded from Teamcenter.
• Indexer
Installs a four-tier SOA client that exports Teamcenter data for merging into Solr. The indexer manages
overall indexing processes. TcFTSIndexer manages the initial indexing for object data. You can then
schedule synchronization to run periodically for subsequent updates to object data or structure data
indexes.
TcFTSIndexer indexes external and Teamcenter objects into Solr. It connects to the server manager to
query and extract Teamcenter data to be indexed into Solr.
There are two modes for installing the Indexer: Standalone for object data and Dispatcher-based for
Active content structures.
Installs an optional feature that allows you to index file contents asynchronously from object
metadata. Dispatcher is used to manage file content requests.
Installs an optional feature that allows you to ask natural language questions and receive summarized
answers with source material.
For information about indexing components and planning your indexing deployment, see the Indexing
Data and Configuring Search in the Active Workspace documentation.
During installation of indexing components, you may need to enter or verify the following information:
You can install the Indexing Engine (Solr) in a new or existing environment.
Prerequisites
This procedure assumes you have an existing Teamcenter environment with Active Workspace.
Make sure all the required software kits have been added to your software repository in Deployment
Center
Procedure
2. In the Software tab, make sure the Selected Software list includes Teamcenter 2406.
3. If you want to install the Indexing Engine with SolrCloud, in the Options tab:
• Select the High Availability check box, which installs a high availability SolrCloud
configuration.
If the Selected Components list does not include Indexing Engine, add this component:
a. Click Add component to your environment to display the Available Components panel.
If you selected a distributed environment with a high availability SolrCloud configuration, you
must configure both the Indexing Engine and Indexing Engine (HA) components for different
machines.
6. In the Indexing Engine panel(s), enter values for the following configuration parameters:
Parameter Description
Machine Name Specifies the name of the machine on which the Indexing Engine is
installed.
OS Specifies the operating system on which the Indexing Engine is installed.
Teamcenter Specifies the installation path for the machine on which in the Indexing
Installation Path Engine is installed.
Indexing Engine Type the user name and password for the Solr administrator. These
User credentials must match the Indexer and the Active Content Structure
Translator (if used).
Install Indexing Select the Install Indexing Engine as a Service check box if you want to
Engine as a Service install the Indexing Engine as a service.
If you clear this check box, you must start the Indexing Engine manually
after deployment on the Indexing Engine machine.
Operating System Type the operating system user name and password on the Indexing Engine
User machine.
If the Indexing Engine machine is a Windows machine, include the domain
name (domain\user).
If you want to specify additional settings for the Indexing Engine, including configuring Solr for
HTTPS, click Show all parameters .
7. If you selected a distributed environment with a high availability SolrCloud configuration, you must
configure all three Zookeeper (HA) components. In each Zookeeper (HA) panel, enter values for
the following configuration parameters:
Parameter Description
Machine Name Specifies the name of the machine on which Zookeeper is installed.
OS Specifies the operating system on which Zookeeper is installed.
Teamcenter Installation Specifies the installation path for the machine on which Zookeeper is
Path installed.
Zookeeper ID Specifies the unique identifier assigned to the Zookeeper component.
Zookeeper Port Specifies the location where the Zookeeper process runs.
8. When you finish entering values for all components, click Save Component Settings.
9. In the Selected Components list, note any remaining components whose configuration status is
not 100%. Select each incomplete component, enter required parameters, and save component
settings until all components in the environment show a configuration status of 100%.
When all components are fully configured, the Deploy tab is enabled.
10. Go to the Deploy tab. Click Generate Install Scripts to generate deployment scripts you will use 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 Deployment Center ─ Usage.
13. Configure indexing and search after completing the Indexing Engine installation.
Prerequisites
This procedure assumes you have an existing Teamcenter environment with Active Workspace.
Make sure all the required software kits have been added to your software repository in Deployment
Center.
Procedure
2. In the Software tab, make sure the Selected Software list includes Teamcenter 2406.
If the Selected Components list does not include Indexer, add this component:
a. Click Add component to your environment to display the Available Components panel.
5. In the Indexer panel, enter values for the following configuration parameters:
Parameter Description
Machine Name Specifies the name of the machine on which the Indexer is installed.
OS Specifies the operating system on which the Indexer is installed.
Teamcenter Specifies the installation path for the machine on which in the Indexer is
Installation Path installed.
Install Database Select the Install Database Triggers for Indexing check box if you want
Triggers for to install database triggers.
Indexing
Maximum Specifies the maximum number of connection between the Teamcenter
Teamcenter server and the indexer that can be open at a given time.
Connections
This number should not exceed the number of warm TcServers available
in Teamcenter server manager pool, and controls the performance of the
indexing process using parallel steps. The default value is 3. The minimum
value is 2.
Initially, consider the number of warm servers available in this environment
and the percentage of them that are available for indexing only.
Install Indexer as a Select the Install Indexer as a Service check box if you want
Service to install the objdata synchronization flow and the suggestion builder
synchronization flow of the indexer as services.
The Service Name fields populate with suggested names for the services,
and can be edited.
The Sync Interval fields populate with suggested intervals for the
synchronization flows and can be edited.
Select the Start Service check box to automatically start the service.
Parameter Description
Operating System Type the operating system user name and password on the Indexer
User machine.
If the Indexer machine is a Windows machine, include the domain name
(domain\user).
Indexer Select the Set Indexer Administrative User Info check box if you want
Administrative User to specify an administrative indexer user.
Type the administrator user name and password on the Indexer machine.
If you want to specify additional settings for the Indexing Engine, click Show all parameters .
6. When you finish entering values for the Indexer component, click Save Component Settings.
7. In the Selected Components list, note any remaining components whose configuration status is
not 100%. Select each incomplete component, enter required parameters, and save component
settings until all components in the environment show a configuration status of 100%.
When all components are fully configured, the Deploy tab is enabled.
8. Go to the Deploy tab. Click Generate Install Scripts to generate deployment scripts you will use to
update affected machines.
When script generation is complete, note any special instructions in the Deploy Instructions panel.
9. Locate deployment scripts, copy each script to its target machine, and then run each script on its
target machine.
For more information about running deployment scripts, see Deployment Center ─ Usage.
10. Configure indexing and search after completing the Indexer installation.
You can install the shape search feature on a new or existing environment to search for objects of a
similar shape or size.
Prerequisites
• This procedure assumes you have an existing Teamcenter environment with Active Workspace.
• Install, configure, and complete indexing for Geolus. See the Geolus documentation.
1. Log on to Support Center and open the Support White Papers Certifications page:
a. Open Products→Teamcenter→Downloads.
Teamcenter 2406 supports upgrades from Teamcenter 13.x or later. If your current
Teamcenter environment is using an earlier version than 13.x, you must upgrade to version
13.x or later before you upgrade to Teamcenter 2406.
The Teamcenter Interoperability Matrix also correlates versions of Deployment Center with
compatible versions of Teamcenter, and shows supported paths for upgrading Deployment
Center. For information about upgrading Deployment Center, see Deployment Center ─
Usage.
Procedure
• gServer is the machine name or IP address of the machine running the Geolus server. It must be
accessible to all Teamcenter clients that need to connect to it.
• gPort is the port number that the server uses to handle HTTP or HTTPS requests.
4. Configure shape search in NX so JT files are read in Teamcenter and shape search results are
displayed in Active Workspace. For more information, see NX documentation.
a. In NX, choose File > Utilities > Customer Defaults > Gateway > JT Files > Export, and select
Save JT Data.
b. In NX, choose File > Preferences > Teamcenter Integration > Active Workspace, and select
Display Shape Search Results in Active Workspace.
The asynchronous file content indexing feature can be installed in a new or an existing Teamcenter
environment using Deployment Center. Ensure that you have installed Teamcenter.
Considerations
If you are installing the asynchronous file content indexing feature in an existing environment, consider
the following:
• You must perform a full index of your existing data after installing asynchronous file content indexing
for the first time.
Perform the following steps to install asynchronous file content indexing through Deployment Center.
1. In the Software tab, ensure that Teamcenter 2406 is selected in the Available Software list.
2. In the Applications tab, click Add or Remove Selected Applications to add an application.
3. From the list of Available Applications, select Asynchronous File Content Indexer and click
Update Selected Applications.
In the list of Selected Applications under Active Workspace, Asynchronous File Content
Indexer is now marked as (Pending Install).
4. Click Go to Components.
In the list of Selected Components, the following are now marked for install or update:
• Corporate Server
• Dispatcher Client
• Dispatcher Module
• Indexer
• Indexing Engine
In the Translators section, Async File Content Indexing Translator is selected automatically.
6. In the Translators Settings section, select options to enable the translators required for your
system.
The provided NX or Solid Edge extractors let you index the contents extracted from NX or Solid
Edge CAD files. Enable and specify the location of the extractors you need for your system.
For indexing standard files, such as Microsoft Office files, PDF files, and text files, no additional
configuration is needed.
Extractor Location
NX The extractor is shipped with NX.
Extractor location: NX-installation-path\NXBIN
Solid Download the file from Support Center > Solid Edge > Downloads > Solid Edge Year
Edge Add-ons > Teamcenter Feature Package > SEEC_Administrator_Year_MP5_Tc14.zip
and unzip to a temporary directory.
Extractor location:
temp_dir\SEEC_Administrator_Year_MP5_Tc14\Deep_CAD_Search_SE_Extractor
Tip:
Initially, consider the number of warm servers available in this environment
and the percentage of them that are available for indexing only.
If you want to specify additional settings for the Indexing Engine, click Show all parameters
and enter these optional parameters:
Teamcenter This specifies the number of attempts the system allows to connect to the
Retry Count Teamcenter server. The minimum value is 1.
Object data Start Time
indexing
start and All data modified after this date and time are extracted for indexing; data
end times older than this date is not extracted. This value is only used during first-time
indexing or re-indexing.
End Time
If selected, it specifies the end date for extracting data. Data modified after
this date will not be extracted for indexing. This value is only used during
first-time indexing or re-indexing.
If no end time is specified, all data modified from the start time to the
present is indexed.
Maximum Specifies the maximum span of a Teamcenter query in minutes. The maximum
Query value is 50000; the minimum value is 5000; the default value is 20000.
Timespan
Export Batch Specifies the maximum number of Teamcenter objects handled in one thread. The
Size maximum value is 20000; the minimum value is 1; the default value is 1000.
12. When all components are fully configured, go to the Deploy tab. 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.
13. 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 ─ Usage.
14. After installing the Indexer, you must optimize instances of TcFTSIndexer by adjusting the
maximum Teamcenter connections value, maximum query timespan, and export batch size as
necessary.
Add the separately licensed Teamcenter Artificial Intelligence (AI) Chat application to your existing
Teamcenter environment. Installation of Teamcenter AI Chat enables Teamcenter to connect with your
third-party vector database and models. This allows you to identify, structure, and summarize your files
and information stored in Teamcenter. Siemens Digital Industries Software support is provided only for
this interface connection.
Prerequisites
• Obtain a subscription to either Amazon Web Services (AWS) or Microsoft Azure as a third-party
provider for the required vector database and models. Install and configure all the necessary services
for either AWS or Microsoft Azure. For information on compatibility, refer to the Interoperability
Matrix, which available from the Downloads section of Support Center.
• AWS
Required
Installation and Deployment
Required Services Definition Configuration Center Settings
Amazon Serves as the vector See the Amazon OpenSearch Endpoint
OpenSearch database for storing and Service Developer Guide in
Serverless (aoss) querying large amounts AWS Documentation.
of data efficiently.
AWS Bedrock Provides managed API- See the Amazon Bedrock Endpoint
level access to various User Guide in AWS
Embedding model
large language models Documentation.
(LLMs), including Anthropic model
embedding models.
AWS Identity Manages access to AWS See the AWS Identity Authentication and
and Access services and resources and Access Management user information
Management securely. User Guide in AWS
(IAM) Documentation.
• Microsoft Azure
• Review all AWS or Microsoft Azure security practices relating to AI, LLMs, and API keys.
Procedure
1. Log on to Deployment Center and select the environment to which you want to add Teamcenter AI
Chat.
3. In the Available Applications panel, use the web browser search to find the Teamcenter AI Chat
application. Select the application, and then click Update Selected Applications.
5. In the Selected Components list, select the Teamcenter AI Chat and Microservice Node
components.
6. In the Teamcenter AI Chat panel, enter values for the following configuration parameters:
Parameter Description
Machine Name Specifies the name of the machine on which the application is installed.
OS Specifies the operating system on which the application is installed.
Teamcenter Specifies the installation path for the machine on which in the application is
Installation Path installed.
Teamcenter Data Source ID specifies the unique name of your organization data.
Question
Answering
Settings
Parameter Description
Teamcenter The Chunk Size field is populated with a suggested unit size of data that can be
Vector embedded at one time. This parameter may be changed from the default value.
Embedding
The Chunk Overlap field is populated with a suggested number of overlapping
Service
characters between chunks. This parameter may be changed from the default
value.
Vector DB Type specifies the type of vector database.
Selection
Deployment Flavor specifies where your vector database is running.
Endpoint specifies the location where your vector database can receive
requests.
Index Name specifies the unique name of your index in the vector database.
You must also add authentication and user information for your database.
Model Selection Provider specifies the embedding model provider.
Endpoint specifies the location of your embedding model.
Model specifies the name of your embedding model.
You must also add authentication and user information for your embedding
model.
Teamcenter Maximum documents to use while generating the answer (Breadth) is
Inference populated with the suggested maximum number of documents used to provide
Service an answer. This parameter may be changed from the default value.
Island expansion radius (Depth) is populated with the suggested search
expansion within a document to provide an answer. This parameter may be
changed from the default value.
Similarity score threshold is populated with the suggested percentage
correlation between the question and the answer. This parameter may be
changed from the default value.
Model Selection Provider specifies the language model provider.
Endpoint specifies the location of your language model.
Model specifies the name of your language model.
You must also add authentication and user information for your language
model.
7. In the Microservice Node panel, verify that the following two microservices are selected:
8. When you finish entering values for the Teamcenter AI Chat component, click Save Component
Settings.
9. In the Selected Components list, note any remaining components whose configuration status
is not 100%. Select each incomplete component, enter the required parameters, and save the
component settings until all components in the environment show a configuration status of 100%.
When all components are fully configured, the Deploy tab is enabled.
10. Go to the Deploy tab. Click Generate Install Scripts to generate the deployment scripts that you
will use 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 the target machine, and then run each script on the
target machine.
For more information about running deployment scripts, see Deployment Center ─ Usage.
Postrequisites
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 Dispatcher ─ Deployment and
Administration. Then, install the following Dispatcher translators, which Active Workspace uses:
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)
To set up email notifications this translator uses, set the following preferences:
• MAIL_OSMAIL_ACTIVATED = true
• 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
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 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:
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.
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.
Client-side rendering (CSR) uses WebGL to leverage client-side graphics capabilities using the Active
Workspace browser. Server-side rendering (SSR) does not require WebGL and is suited to larger
structures. The following comparison may help you decide which option to use.
Reserve slots on SSR servers for SSR users unless all CSR capacity is consumed
To optimize resource utilization, the Visualization Server Pool Assigner directs SSR users to SSR-capable
servers, while diverting CSR users to servers that can support CSR users only. However, since SSR servers
can also support CSR users, when all CSR servers are busy and the SSR servers still have capacity, you can
use SSR servers to support CSR users. This provides flexibility within the enterprise while reserving SSR
servers for users who need that resource.
To adjust or disable this behavior, you can contact Siemens Digital Industries Software support.
Rendering 3D data
In Active Workspace, the 3D viewer is displayed within the universal viewer area of the Overview tab for
objects that have viewable attachments. The 3D viewer is also displayed in the 3D tab, where you can
explore 3D data (JT) associated with parts and assemblies. The render location setting applies to both
viewer locations.
Visualization Server is required for visualizing 3D data in Active Workspace with CSR. However, the
Visualization Server Manager can be installed on a server without a graphics card.
For better user experience and certain functionality to work, ensure the following:
• The client machine for CSR must have a valid graphics card.
• For SSR, even the server must have a valid graphics card.
To set the default rendering method for the 3D viewer and the universal viewer, set the value of the
AWV0ViewerRenderOption Teamcenter preference to either of the following:
End users can change the rendering method on the Viewer Options panel in Active Workspace.
Ensure that you are not using integrated graphics, and perform the following steps to switch to your
graphics card:
4. From the list shown, select the program for which you want to choose a graphics card.
Alternatively, ensure that the GPU is used when running Google Chrome:
Massive Model Visualization (MMV) is a visualization technology that uses Visibility Guided Rendering
(VGR) to increase performance and scalability when viewing extremely large 3D models, such as cars,
airplanes, and ships. Models of this size typically consist of a massive amount of geometry 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, far exceeding the typical capability most hardware.
MMV technology resolves this problem by leveraging VGR techniques to load only those parts that are
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.
Note:
If a structure has more than 30,000 BOM lines, MMV is recommended. If a structure has more
than 120,000 BOM lines, MMV rendering is required for scalability and performance.
Visualization of MMV data in the Active Workspace 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 implementing MMV but is otherwise optional.
To use the Visualization Data Server to compute Massive Model Visualization (MMV) spatial hierarchies
of structures, you must do the following actions:
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.
The Visualization Data Server has a structure and JT pre-caching feature that can help improve
visualization performance for structures not indexed for MMV. To use this feature:
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.
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.
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.
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 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 server-side rendering, the VSM must be installed on physical hardware, unless you follow a
supported virtualization combination.
• Virtualization layer
• 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.
Sizing of VSM hardware should allow for typical and maximum expected usage by considering the
following factors:
• CPU, RAM, VRAM and GPU resources consumed by expected product data
• A maximum number of CPU cores with processing speeds of 3.0 GHz or faster
• A minimum of 64 GB of RAM
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.
Before you run the VSM on a Linux machine, perform the following steps:
1. Make sure the machine has the required RPM package managers.
3. Make sure that Xserver is installed and running on DISPLAY :0. One way to verify this is to type the
following command to determine whether the X or Xorg process is running:
The exact output from the grep command may vary depending on the configuration of your Linux
environment, but the output must contain /user/bin/Xorg :0 or/user/bin/X :0 where shown above.
This indicates that the Xserver is running on DISPLAY :0 and that your environment is supported.
Note:
The Xserver allows graphical user interfaces on a Linux system. When you install Linux, if you
installed a minimal text-only environment, you must install Xserver according to your Linux
Xserver installation and setup guide.
If you installed a graphical environment, Xserver and Xorg should already be installed. The
Xserver manages the display hardware to provide a graphical interface. To use X applications,
install the Xorg X11 apps package.
For information about configuring Xserver, see your Linux system configuration
documentation.
4. After you verify that Xserver is running on DISPLAY :0, configure Xserver for offscreen and headless
operation for use by the visualization server processes.
After you verify that Xserver is running on DISPLAY :0, run the following commands:
setenv DISPLAY :0
xhost +
>setenv DISPLAY :0
>xhost +
access control disabled, clients can connect from any host
Set up the NVIDIA GPU on the Linux machine by running the setup_xserver.sh script provided in
the Visualization Server Manager installation.
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.
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 Teamcenter 2406 software kit is included in your environment.
4. Proceed to the Applications task and then click Add or Remove Selected Applications .
This selection adds the Visualization Server Manager and Visualization Pool Assigner
components to the environment.
6. Select 3D Visualization or Active workspace Visualization 2D Viewer if you wish to add the
Viewer Administration application, which provides an interface for monitoring Visualization
Server components in Active Workspace.
a. If your environment type, which is specified in the Options task, is Distributed, type the
values for the Machine Name and OS for the machine deploying the VSM.
Also, in the Teamcenter Installation Path box, type the path for the location where you will
install Teamcenter software on the VSM machine.
Note:
If your environment type is Single Box, then 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 VSM, click Show all
parameters and change values as necessary.
11. In the Components task, note any components which do not have a configuration status of 100%.
Enter or update configuration parameters until all components show a configuration status of
100%.
12. Proceed to the Deploy task. Click Generate Install Scripts to generate deployment scripts to
update affected machines.
When the script generation is complete, note any special instructions in the Deploy Instructions
panel.
13. Locate the 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 Deployment Center ─ Usage.
To start the Visualization Server Manager (VSM) on a Linux machine, type the following command:
TC_ROOT/vispoolmanager/run_servermgr.sh
Alternatively, you can start Visualization Server Manager as a daemon by running the installservice.sh
command for each jetty server with admin permissions:
If you do not specify parameters, the script will run in interactive mode and prompt you for the
information.
To uninstall the VSM daemon, run the uninstallservice.sh command for each jetty server with admin
permissions:
uninstallservice.sh service-name
If you do not know the name of the service, search the TC_ROOT/vispoolmanager/jetty/ directory or
the /etc/systemd/system directory for a file named service-name.service. The service-name is the unique
service name you provided to the installservice.sh command.
1. Make sure the FMS_HOME environment variable is set as a system environment variable and not
a user variable. Visualization Server Manager runs as a service only if FMS_HOME is a system
environment variable.
TC_ROOT\vispoolmanager\run_visservermgr.cmd
Note:
If Visualization Server Pool Assigner (VPA) is not running, Visualization Server Manager
displays console messages until it finds the VPA. To avoid this, start Visualization Server
Pool Assigner before you start Visualization Server Manager.
When running run_visservermgr.cmd, you can use Windows remote desktop connection to sign on to
the machine on which 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, can also be used.
After running run_visservermgr.cmd, you can lock the machine, but you must remain logged on. If you
sign out, Visualization Server Manager is shut down.
Visualization Server Manager requires access to the graphics card. Therefore, it cannot run as a Windows
service in server-side rendering mode. However, you can start Visualization Server Manager as a
Windows service when you use client-side rendering exclusively.
You can configure Windows to automatically log on and restart 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.
2. In the User Accounts dialog box, select a user account from the list.
3. Clear the Users must enter a user name and password to use this computer check box.
4. Click Apply.
5. In the Password and Confirm Password boxes, type the user's password.
6. Click OK.
7. Create a script or batch file to launch the Visualization Server Manager. Include the following
command to lock the workstation:
8. Create a new task with Windows Task Scheduler to run the script or batch file at log on.
You can start 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 Visualization Server Manager as a Windows service, run the installservice.bat command:
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:
2. Locate the newly installed service named Teamcenter VisServlet pool-ID in the list of Windows
services.
4. On the Log On tab, enter logon credentials for the domain user account under which the service
runs.
Visualization Server Manager 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,
a problem may have occurred.
If you set the service to start manually in its Properties, then you can click Run 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.
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.
• Teamcenter database
http://host:port
You can configure the Active Workspace client to display the user interface in any of the supported
Teamcenter locales. However, some visualization data, such as Product and Manufacturing Information
(PMI), requires Visualization Server Manager (VSM) configured for the same locale as the information.
For visualization data to display correctly in Active Workspace, you must have at least one VSM
configured to run in each locale that you support. With a VSM in place to support each localization
being used, visualization processes are then routed to the appropriate server based on locale.
French Japanese
You can configure a VSM with any one of these languages. If you want to configure a cluster of VSMs to
support more than one language, you need at least one VSM per language.
To change the language of a VSM, set the operating system (Windows or Linux) to the required
language, location, and locale:
1. Adjust the required language, location, and locale using the Region and Language options found
in the Windows Control Panel.
2. Adjust the Date and time formats, the Current location, and the Current language for non-
Unicode programs values.
When the VSM is started again, it inherits the new language configuration of the operating system.
1. Run the following command to list all languages currently available on the machine: locale -a.
2. To configure the VSM to support a particular language, set the environment variables LANG or
LC_ALL in the jettyservice.properties file.
Example:
To set the VSM to run using the German UTF8 locale, set these values in the
jettyservice.properties file:
• VisPoolProxy.envset.LANG = de_DE.utf8
• VisPoolProxy.envset.LC_ALL = de_DE.utf8
Note:
Some Asian locales may require a restart of the Visualization Server to force the necessary
fonts for the desired language to load correctly.
If all VSMs are configured to use the same language, all clients use the available language regardless of
browser preferences.
Note that if you have a VSM system configured for two or more different languages, then Siemens
Digital Industries Software highly recommends that at least one VSM be configured for English, even
though this may require a minimum of three VSMs. When the server system is configured with multiple
languages, if at least one VSM is configured for English, then the English locale is a default.
The following table shows the VSM system response to a visualization data request from a client when
the client is not in one of the preconfigured languages.
VSM system configured for two or more languages Client is not in a preconfigured VSM language
VSM for English exists. The data request is routed to an English VSM.
No VSM for English. The data request is rejected.
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.
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 Teamcenter 2406 software kit is included in your environment.
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.
8. Enter the configuration parameters for the Visualization Pool Assigner (VPA):
a. If your environment type, which is 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.
Note:
If your environment type is Single Box, the Machine Name, OS, and Teamcenter
Installation Path boxes are read-only and cannot be changed.
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
Value Description
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.
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 the script generation is complete, note any special instructions in the Deploy Instructions
panel.
11. Locate the 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 Deployment Center ─ Usage.
Linux systems
To start Visualization Server Pool Assigner (VPA) on a Linux machine, type the following command:
TC_ROOT/visassigner/run_assigner.sh
Alternatively, you can start the VPA as a daemon by running the installservice.sh command for
each jetty server with admin permissions:
If you do not specify parameters, the script runs in interactive mode and prompts you for the
information.
Windows systems
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 VPA 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.
Replace VPA-dir with the path to the VPA’s jetty directory. Replace assigner-ID and port with
the ID and port used by Active Workspace Gateway to connect to the Assigner.
For example:
2. Locate the newly installed service named Teamcenter VisServlet assigner-ID in the list of
Windows services.
4. On the Log On tab, enter the 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 Run 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.
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.
• An FMS client cache (FCC) component 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
• 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.
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
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.
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.
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.
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 Teamcenter 2406 software kit is included in your environment.
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.
a. If your environment type, which is specified in the Options task, is Distributed, then type the
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.
Note:
If your environment type is Single Box, then 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 the values as necessary.
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 Deployment Center ─ Usage.
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.
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:
• 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.
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 ready for fast
visualization with the MMV technology.
For a product configuration is ready for MMV visualization, the following criteria must be met:
• Visualization Data Server has detected, downloaded, and cached the structure.
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 reread 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 for other settings. If you
make changes to the properties file, you need to restart Visualization Data Server.
To install these services, run the installservice.sh located in the VisDataServer/bin folder. Run this
command with administrator permissions:
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
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 using the following steps:
2. Search 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.
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 file 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:
Replace name with a display name for the service. Replace option with automatic or manual.
For example:
After the service is successfully installed, Windows displays the following message:
a. In the Windows Services dialog box, locate the VDS service by the name you specified in the
displayName attribute.
c. In the Log on tab, enable the service logon with the following options:
• Log on as: Select This account, and 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.
To uninstall the service, run the VisDataServer.exe utility with the /unregisterService argument.
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.
To reduce 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. 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:
<=10 10
>=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 500 deltas are
processed, a completely new mmp file is created.
To delete 100% 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.
Configuration for the Visualization Data Server is available in the etc/VisDataServer.properties file. This
includes detailed logging and fine tuning for other settings. If you make changes to the properties file,
you must restart the Visualization Data Server.
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
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:
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.
Open a Windows command prompt as an administrator and enter the following command in a single
line:
/featureName:IIS-ServerSideIncludes /featureName:IIS-WebServerManagementTools
/featureName:IIS-ManagementConsole
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:
Default Document
Directory Browsing
HTTP Errors
Static Content
HTTP Redirection
Caution:
Do not install the WebDav Publishing role service.
HTTP Logging
Logging Tools
Request Monitor
Tracing
Performance
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
ISAPI Extensions
ISAPI Filters
Server Side Includes
Install only the available ASP.NET 4.x role services. Do not install ASP.NET 3.x role services.
Management Tools
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.
This procedure assumes you have an existing Teamcenter environment. Make sure all the required
Teamcenter software kits have been added to your software repository in Deployment Center
2. In the Options task, make sure your selected Architecture Type is .NET.
If the Selected Components list does not include Teamcenter Web Tier (.Net), add this
component:
a. Click Add component to your environment to display the Available Components panel.
b. Select Teamcenter Web Tier (.Net), and then click Update Selected Components.
5. Enter values for the machine on which you install the .NET web tier:
• Single box
If your environment is a single box environment, the Machine Name, OS, and Teamcenter
Installation Path values are inherited from the first component you configured in your
environment. Changing these values will change them for other components in your
environment.
• Distributed
If your environment is a distributed environment, type the Machine Name, OS, and
Teamcenter Installation Path for the machine on which you install the .NET web tier.
Value Description
Protocol Specifies the protocol to use to connect to the web tier (http or https).
Virtual Directory Specifies the IIS virtual directory name for Teamcenter .NET web tier
Name deployment. The default value is tc.
Teamcenter Specifies a name for the web tier connection.
Connection Name
Tag Specifies a tag for the environment that can be used to filter the list of TCCS
environments during logon.
The Teamcenter 4-tier URL value is not directly editable, but is composed from the protocol,
port, machine name, and port specified in other parameters for the Teamcenter Web Tier (.Net)
component, for example, http://myHost:80/tc
If you want to specify additional settings for the Indexing Engine, click Show all parameters .
9. 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.
10. 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 Deployment Center ─ Usage.
After you install the server manager and the .NET web tier, complete the .NET web tier installation by
launching the Teamcenter Management Console.
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 supported Java EE application server and the Java Runtime Environment (JRE) on the web tier host.2
This procedure assumes you have an existing Teamcenter environment. Make sure all the required
Teamcenter software kits have been added to your software repository in Deployment Center
2. In the Options task, make sure your selected Architecture Type is Java EE.
If the Selected Components list does not include Teamcenter Web Tier (Java EE), add this
component:
a. Click Add component to your environment to display the Available Components panel.
b. Select Teamcenter Web Tier (Java EE), and then click Update Selected Components.
4. In the Selected Components list, select Teamcenter Web Tier (Java EE).
5. Enter values for the machine on which you install the Java EE web tier:
• Single box
If your environment is a single box environment, the Machine Name, OS, and Teamcenter
Installation Path values are inherited from the first component you configured in your
environment. Changing these values will change them for other components in your
environment.
• Distributed
If your environment is a distributed environment, type the Machine Name, OS, and
Teamcenter Installation Path for the machine on which you install the Java EE web tier.
Value Description
Protocol Specifies the protocol to use to connect to the web tier (http or https).
Teamcenter Specifies a name for the Teamcenter web tier web application. The default
Application Name value is tc.
Teamcenter Specifies a name for the web tier connection.
Connection Name
2 For information about supported application servers and Java versions, see the Hardware and Software Certifications
knowledge base article on Support Center.
Value Description
Web App Server Specifies the name of the machine that runs the Java EE web application
Machine Name server. This the machine on which you deploy the Java EE web tier WAR file
(typically tc.war).
JMX RMI Port Specifies the JMX RMI port number for the web server. For example, type
8088 for the default server manager port or 8089 for the default web tier
port.
Tag Specifies a tag for the environment that can be used to filter the list of TCCS
environments during logon.
The Teamcenter 4-tier URL value is not directly editable, but is composed from the protocol,
port, and machine name specified in other parameters for the Teamcenter Web Tier (Java EE)
component, for example, http://myHost:7001/tc
If you want to specify additional settings for the Indexing Engine, click Show all parameters .
9. 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.
10. 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 Deployment Center ─ Usage.
11. Locate the Java EE web tier WAR file (typically tc.war) generated with the deploy scripts.
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 Deployment Center and choose the environment to which you want to add a volume
server.
3 Web Application Deployment provides Teamcenter web tier deployment procedures for several supported application
servers.
3. Click Add component to your environment to display the Available Components panel.
6. In the Volume panel, enter the required values to configure the volume:
Value Description
Instance Specifies a name for the volume instance.
Volume ID Specifies the ID of the FMS server cache (FSC) for the volume.
Path Specifies the path to the volume directory.
Name Specifies the name of the volume directory.
Host Specifies the host name of the host on which the FSC resides.
Assign to FSC Denotes that the volume is assigned to an FSC server. The FSC Server ID is
Server based on the machine name of the FSC Master and is not directly editable.
Assign to File Store Denotes that the volume is assigned to the file store group.
Group
9. 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.
10. 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 Deployment Center ─ Usage.
This procedure installs a single volume server. To configure multiple volume servers for load balancing,
and other advanced FMS configuration, see System Administration.
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:
Use the following general procedure for choosing a Business Modeler IDE installation type.
Caution:
Do not install BMIDE on a production environment corporate server. Doing so could have
unintended consequences, especially during Teamcenter upgrade.
Installation Teamcenter
type connection type Advantage Limitation
2-tier Two-tier environment Allows live deployments even Requires local network
via TCCS. while a web tier is inactive or access.
down for maintenance.
4-tier Four-tier Allows remote access and live Requires an active web
environment via deployments. tier.
HTTP server.
Standalone None No requirement for or possibility Cannot perform
of unintentional interaction with actions that require
any Teamcenter site. connection to a
Teamcenter site.
You may alternatively choose to add BMIDE functionality into your existing Eclipse environment.
This consists of manually patching your Eclipse environment with BMIDE jar files. Doing so offers
the advantage of allowing you to work on BMIDE templates within your existing custom Eclipse
environment. However, adding BMIDE functionality into your existing Eclipse environment does not
offer BMIDE functionality to perform actions that require connection to a Teamcenter site.
Before you install the Business Modeler IDE, make sure you log on using an account with administrative
privileges and that you have access to the Teamcenter software kit.
This procedure assumes you have an existing Teamcenter environment. Make sure all the required
Teamcenter software kits have been added to your software repository in Deployment Center
If the Selected Components list does not include Business Modeler IDE component type you
want to install, add the component:
a. Click Add component to your environment to display the Available Components panel.
b. Select the Business Modeler IDE component type you want to install (2 Tier or 4 Tier), and
then click Update Selected Components.
3. In the Selected Components list, select Business Modeler IDE installation type.
Value Description
Enable Mass Client Generates a deploy script that can be run on multiple machines.
Deploy? (2-Tier and 4-Tier)
Machine Name Identifies the target deployment machine. The name is used in
naming the deploy script.
• Single box
• Distributed
By default, some parameters are not displayed because they generally do need to be changed from
the default values. They can be displayed by clicking Show all parameters .
7. 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.
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 Deployment Center ─ Usage.
Before you install the Business Modeler IDE, make sure you log on using an account with administrative
privileges and that you have access to the Teamcenter software kit.
3. In the Options task, accept the defaults (Java EE architecture, Single Box environment, Local
architecture).
5. In the Available Applications list, select and then deselect the Teamcenter application group (this
performs a select all/deselect all action), then click Update Selected Applications.
8. In the Selected Components panel, click Business Modeler IDE Standalone to view the
parameters.
9. Enter parameters for the standalone Business Modeler IDE and then click Save Component
Settings.
Value Description
Machine Name Identifies the target deployment machine. The name is used in
naming the deploy script.
OS Identifies the operating system on the target machine.
Teamcenter Path on the target machine for the installation.
Installation Path
Java Development Kit Path on the target machine to the Java development kit.
Path
Value Description
By default, this parameter is not displayed. It can be displayed by
clicking Show all parameters .
Templates and Select the applications and clients whose templates you want to
Clients copy to the target machine for use in customization. The Teamcenter
foundation template is included by default.
For more information about running deployment scripts, see Deployment Center ─ Usage.
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.
• 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.
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:
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:
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 a Business Modeler IDE in one of several ways, depending on the installation type:
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.
Users can generate a Business Modeler IDE template package in Teamcenter 11.3 or later that can be
deployed to Teamcenter environments using either Deployment Center or Teamcenter Environment
Manager (TEM). This consolidated output directory contains templates, libraries, and deployment
configuration files.
To deploy a Business Modeler IDE template package, obtain the directory of the template package output
generated by the Business Modeler IDE. Place the Business Modeler IDE output directory in the software
subdirectory of the Deployment Center repository.
template-internal-name_OS_template-version_build-version_YYYY_MM_DD_HH-MM-SS
An optional template version may be assigned by the Business Modeler IDE user to track the versions
of a template package. If the Business Modeler IDE user assigns a build number, the template is in
development. The build version tracks iterative testing before the template is ready for production.
Template versions and build versions are expressed as integers separated by periods, up to four
places.
• artifacts subdirectory
• dc_contributions subdirectory
Contains the template bundle information (called packages) for deployment by Deployment Center. If
you use TEM, this directory is ignored.
• tem_contributions subdirectory
Contains the template bundle information for deployment by TEM. If you use Deployment Center, this
directory is ignored.
• media_teamcenter_template-package-name.xml file
Provides the application names to both TEM and Deployment Center for deployment.
The Deployment Center repository displays Dependencies as specified within Business Modeler IDE
packages using package IDs.
For information on creating and updating Business Modeler IDE packages, refer to the Business Modeler
IDE documentation included with Teamcenter.
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 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 Deployment Center ─ Usage.
Also, see the Teamcenter Deployment Reference Architecture, available on Support Center, for further
guidance and examples for development, test, and production environments.
The Teamcenter Security Service Session Agent provides authentication and single sign-on capability
for Teamcenter desktop based clients and integrations.
This procedure assumes you have an existing Teamcenter environment with the required Teamcenter
software kits in your software repository in Deployment Center.
2. Proceed to the Components task and click Add component to your environment to display the
Available Components panel.
3. Select Teamcenter Security Service Session Agent, and then click Update Selected
Components.
4. In the Selected Components list, select Teamcenter Security Service Session Agent and then
enter parameters for this component:
a. If you configured the Session Agent in a Global infrastructure environment, you can import
that component into your Local infrastructure environment.
If you have no Global infrastructure environments, skip this step and proceed to step b.
If you want to import a Teamcenter Security Services Session Agent configuration, perform
the following steps:
A. Select the Do you want to import 'Teamcenter Security Service Session Agent' from
other environments? check box.
B. Select the environment from the list that contains the Session Agent component you
want to import. Then, click Save Component Settings.
The Teamcenter Security Service Session Agent component is fully configured (100%
complete).
C. Proceed to step 5.
• Single box
• Distributed
Parameter Description
Enable Mass Specifies you want to generate a deployment script that can be run
Client Deploy? on multiple client machines. If you select this check box, enter an
identifier for the mass client instance in the Instance Name box.
Machine Name Enter the name of the machine on which you want to install the rich
client.
This box is displayed if Enable Mass Client Deploy? is not selected.
OS Specifies the operating system of the machine on which you install the
rich client.
Teamcenter Specifies the path in which to install the rich client on the target
Installation Path machine. Accept the default path shown, or type a different path.
Install XML-RPC If you have Teamcenter client applications released with Teamcenter
libraries 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.
c. Click Save Component Settings to submit the Session Agent configuration values.
5. 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.
6. 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 Deployment Center ─ Usage.
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.
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.
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.
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.
The settings required for digital signature support are stored in two places:
The corresponding settings between these environments must match. Therefore, the settings have a
single configuration point within Deployment Center to avoid a mismatch.
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.
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.
Functions If this option is disabled, the Session Agent process does not open the additional
listener.
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.
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 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.
Note:
Kerberos authentication is not supported with Client for Office.
Prerequisites
For supported versions, see the Software Certifications Matrix on Support Center.
2. Depending on your needs, install Teamcenter Client for Microsoft Office and/or Teamcenter
Extensions for Microsoft Office as described in Microsoft Office Integration With Teamcenter in
the Teamcenter documentation.
3. If you want to host Active Workspace within Client for Office, set Active Workspace hosting
preferences as described in Active Workspace Customization.
Procedure
2. Right-click the setup.exe program icon and choose Run as administrator to launch the Active
Workspace Launcher installation wizard.
3. Proceed to the Ready to Install the Program dialog box, and then click Install to install the Active
Workspace Launcher.
4. When the installation is complete, click Finish to close the installation wizard.
5. To enable the editing of requirements in Active Workspace, you must perform additional setup
tasks.
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"
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:
• Uninstall and reinstall the Teamcenter Active Workspace Launcher and try again.
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.
You can also verify the status of Active Workspace Gateway and services using the Active Workspace
gateway ping:
http://myhost:3000/ping
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.
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.
Back up your environment after initial installation, and periodically for added security. Add applications
and components to Teamcenter environments. Perform database maintenance.
• You are reinstalling or upgrading Teamcenter executables by overwriting an existing Teamcenter data
directory. The Teamcenter installation procedure cannot overwrite files when they are in use.
1. Instruct all users to check in all Teamcenter business objects, and then close and log off of
Teamcenter sessions, including tcserver processes.
Windows systems:
From the Start menu, choose Programs→Teamcenter, and open a command prompt.
Linux systems:
Sourcing the tc_cshvars file creates a csh subshell in which Teamcenter environment
variables are set.
On operating systems that do not support sourcing, such as CentOS, enter the following
commands to set Teamcenter environment variables:
#!/bin/bash
export TC_ROOT=/usr/Siemens/Teamcenterversion/tc_root
export TC_DATA=/usr/Siemens/Teamcenterversion/tc_data
bash --init-file $TC_DATA/tc_profilevars
3. Use the clearlocks utility to check for nodes connected to the database and remove locks on the
database:
Windows systems:
Linux systems:
$TC_ROOT/bin/clearlocks -node_names
4. On Linux systems, note the node names returned, and then type the following command for each
node name returned:
Caution:
Back up the database, Teamcenter data directory, and all Teamcenter volume directories to an
external backup device before performing an upgrade. This provides a safeguard against data loss
in case problems occur during the upgrade.
At each logon, you can choose between multiple languages, depending on your company's policy and
installation. Choose a language in the logon dialog when you log on to Teamcenter.
Alternatively, you can specify the language in your browser preferences. For example, in Microsoft Edge,
choose Settings→Languages to add languages or modify language preferences.
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 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
2. On the far right below the command bar, click Add Environment .
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 .
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.
If you created an environment using Teamcenter Environment Manager (TEM), you can import it into in
Deployment Center using the following registration and validation process:
Note:
The registration utility (send_configuration_to_dc) scans only configurations from TEM.
Components supported by Deployment Center that were installed by other installers, such as
Web Application Manager (insweb), must be added manually after scanning the environment.
For information about features supported in the current software, generate a software
configuration report.
Register an environment
The utility sends TEM configuration information for installed features to Deployment Center.
Windows systems:
DC-installation\webserver\additional_tools\send_configuration_to_dc.zip
Linux systems:
DC-installation/webserver/additional_tools/send_configuration_to_dc.zip
a. Copy the send_configuration_to_dc.zip package to a local directory and unzip the package.
d. Change to the send_configuration_to_dc directory in the path where you unzipped the
registration utility.
e. Set the JAVA_HOME and JRE_HOME environment variables to the location of the JRE.
f. Set the TC_ROOT environment variable to the Teamcenter installation directory on the given
host.
3. Beginning with the corporate server machine, type the send_configuration_to_dc.bat command
(on Windows systems) or the send_configuration_to_dc.sh command (on Linux systems) with
the following arguments to register the local Teamcenter configuration from TEM into Deployment
Center:
-dcurl (required)
-dcusername (required)
Specifies 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)
-config (optional)
Specifies the ID of the Teamcenter configuration you want to scan. Specify this argument if
you installed multiple configurations in a single TC_ROOT location.
Example:
send_configuration_to_dc.bat -dcusername=dcadmin
-dcpasswordfile="E:\admin passwords\dcadmin.pwf"
-dcurl=http://dc_host:8080/deploymentcenter
-environment=tc_scanned
5. After you scan all machines in the environment, review and validate the environment in
Deployment Center.
2. In the Environments page, select the name of the scanned environment in the
environments list. You specified this name in the -environment argument when you ran the
send_configuration_to_dc utility.
3. In the Software tab, note the status of the selected software is In Review .
If problems were encountered when scanning the environment, Deployment Center displays a
warning icon above the Selected Software list.
4. In the command bar on the far right, click Validate and Generate Environment Report:
Deployment Center generates an environment validation report that contains feature mappings,
information about scanned TEM environments, and actions to perform to complete the configuration
of the scanned environment. The report is placed in the following location:
Windows systems:
Deployment Center-repository\report\EnvironmentValidationReport_environment-name.html
Linux systems:
Deployment Center-repository/report/EnvironmentValidationReport_environment-name.html
Deployment Center automatically downloads the report, so you can open it through the web browser
Downloads feature or from the location above.
Alternatively, you can generate a validation report from the command line by running the
send_configuration_to_dc utility with the -gvr (generate validation report) argument:
Open the environment validation report and review all information about the scanned environment.
Describes total numbers and types of actions required to complete the configuration of the scanned
environment.
• Mapping of Scanned TEM Environment Information for This Deployment Center Environment
Maps TEM features and GUIDs to Deployment Center applications and components. It maps TEM
configuration properties to Deployment Center properties and highlights items that require attention.
1. In each table in the report, note values in the Scanned Status and Error/Warning columns.
In the Scanned Status column, a check mark (✔) indicates a valid item, an X (❌) indicates an item
that requires corrective action:
Note:
Some items in the report may show a check mark (✔) with a warning. These items are not
critical to validation but changes are recommended either during validation or soon after.
2. For each item that error or warning, click the message in the Error/Warning column to view the
specific required actions, for example:
4. When you have performed all actions, generate a new report by clicking Validate and Generate
Environment Report in the command bar on the far right.
5. If the Summary of Required Actions and Informational Warnings section in the new report still
lists required actions, perform the required actions and generate a new report again.
6. When the environment validation report prescribes no further required actions, the environment is
ready to be marked complete. Click Complete Registration in the command bar on the far right:
In the Software tab, note the status of the selected software is changed to Installed .
Alternatively, you can complete the environment registration from the command line by running the
send_configuration_to_dc utility with the -rc (complete registration) argument:
To view properties of machines in your scanned environment, go to the Deployment Center home page
and click the MACHINES tile. From the resulting page, you can view all machines used in deployed
Teamcenter environments.
Caution:
If you use TEM to update a configuration that has been scanned as part of an environment
in Deployment Center, make sure that you run the send_configuration_to_dc utility to update
the environment information. Otherwise, configuration changes performed locally on Teamcenter
servers since the last time the send_configuration_to_dc script ran could be overwritten.
Web Application Manager (insweb) is a separate tool from TEM, and the registration utility
(send_configuration_to_dc) can only process TEM configuration files. As a result, the Teamcenter Web
Tier (Java EE) component is not included in a scanned environment. After you scan your environment
from TEM, you must add the Java EE web tier component to the environment.
If you use Security Services, you must also add the Teamcenter Security Services (TcSS) component.
1. Log on to Deployment Center and go to the Environments page. Select the environment you
scanned from the list.
2. In the Components tab, click Add component to your environment . Add the Teamcenter
Web Tier (Java EE) component to the environment. And, if you use Security Services, add the
Teamcenter Security Services (TcSS) component.
3. In the Selected Components list, select Teamcenter Web Tier (Java EE) and enter the
configuration parameters for the web tier from the original environment. If you are unsure of
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.
Repeat this step for the Teamcenter Security Services (TcSS) component, if applicable.
5. Review the remaining Selected Components to make sure they are all 100% configured.
If you experience other problems in registering environments with Deployment Center, see Deployment
Center ─ Usage..
Add applications
Applications contain administration data, software modules, and parameters that add specialized
functionality to the Teamcenter environment.
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.
4. Click Update Selected Applications to add them to the Selected Applications list.
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.
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 Deployment Center ─ Usage.
Caution:
If you installed an application using Deployment Center, do not attempt to uninstall it using TEM.
Deployment Center does not populate the uninstall information required by TEM. Uninstalling an
application using TEM may not remove it in Deployment Center, or may cause inconsistencies in
the environment in Deployment Center.
Add components
Components are the architectural pieces of Teamcenter, such as servers, services, and databases.
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.
2. In the Components task, click Add component to your environment to add components.
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:
All parameters view displays both required and optional parameter information.
Click to collapse the view to required parameters.
1 If you selected the Single Box environment type in the Options task, all Teamcenter components must reside on the
same machine.
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.
For more information about running deployment scripts, see Deployment Center ─ Usage.
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.
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.
If you have an existing Teamcenter environment without Active Workspace components, you can add
Active Workspace by installing the following Active Workspace and Microservice Framework components
in your environment:
After you install components, deploy the Teamcenter environment to complete the installation of
Active Workspace in your environment.
The Active Workspace Base application adds components and parameters that add core Active
Workspace functionality to your environment.
1. In Deployment Center, select the environment to which you want to add Active Workspace.
3. In Available Applications, choose Active Workspace Base, and then click Update Selected
Applications.
Optionally, you can select these applications to add them to your Active Workspace deployment.
5. 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 the 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%.
6. 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.
For more information about running deployment scripts, see the Deployment Center ─ Usage.
Deployment Center adds Active Workspace client components and parameters when you select the
Active Workspace Base application. Make sure all Active Workspace client components are configured
to 100%, and then generate and deploy scripts as usual.
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 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 2406.
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:
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.
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.
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:
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.
Caution:
This step is important for security.
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.
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.
install -encrypt
This command generates a new database connection string with the new Oracle password
encrypted. Copy the new database connection string.
set TC_DB_CONNECT=connection-string
6. Replace the existing connection-string with the string generated by the install -encrypt command.
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
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.
Problems/error messages
See the following information for help resolving errors encountered during Teamcenter installation.
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).
JRE path is set incorrectly in the system Make sure the path specified in
environment. the JRE_HOME or JRE64_HOME
environment variable is correct.
Siemens License Server reports an error Make sure the SPLM_LICENSE_SERVER If a path in the CLASSPATH environment
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 License Server, for example, quotes ("). For example:
Cannot find license 29000@myhost .
file.
"C:\Program
Files\Microsoft\Web
Platform
Installer";D:\TcSE\ap
ache-ant-1.9.4\bin
An error similar to the following The CLASSPATH environment variable If a path in the CLASSPATH environment
is 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
class files. Files\Microsoft\Web
Platform
Installer";D:\TcSE\ap
ache-ant-1.9.4\bin
Running Teamcenter in an IPv6 network Some Teamcenter components Find your IP address using the ping
environment, the Teamcenter client are sensitive to link-local IPv6 or nslookup command. Make sure
does not connect to the server at all addresses. You must make sure your these commands find the a global IPv6
or 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
if you use local-link IPv6 addresses. your network administrator. Make sure
your host name resolves to a global IPv6
address, not a link-local IPv6 address.
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 KDC.
at the Kerberos Key Distribution Center
(KDC).
Mechanism level:
Clock skew too great
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.
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
Client credential too This problem can occur on SUSE Linux Restart the remote procedure call (RPC)
weak 11 when executing the following ODS portmapper service (rpcbind) with the
startup command: following options:
The command shell displays the Alternatively, you can set the rpcbind
following error: startup scripts to always run with the
-i option. The /etc/sysconfig/rpcbind file
controls this on SUSE Linux. This may
Cannot register vary on other Linux variants.
service:
RPC: Authentication
error;
why = Client
credential too weak
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.
Incorrect Path Path to the directory on the update server may be incorrect.
Check the path and try again.
Transfer Error Contact with the update server was interrupted. Try your
operation again or contact your system administrator for
assistance.
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
with the Service due to the addition of than 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.
Identify the problem you encountered in your four-tier rich client architecture and perform the solution
described.
Problem Solution
Cleaning FIFO entries in /tmp/tctp On Linux hosts, if the server manager is running when the /tmp
disables server manager, MUX, and directory is cleaned up by deleting its entries, Teamcenter
TcServer processes. Transfer Protocol (TCTP) is disabled. Running TcServers cannot
accept new requests. The server manager no longer accepts
server ready health notifications, so new servers are not
published, and new user sessions will get a "no servers available"
error.
In some customer environments and some operating systems,
including Redhat Linux, the /tmp directory may be automatically
cleaned up periodically at a time other than boot time,
Problem Solution
particularly files that have not been used recently. Also, the /tmp
directory may be mapped to memory, and need to be cleaned up
often. See the tmpwatch command, which is often run as a cron
job.
To configure the location of the TCTP FIFO entries to a directory
not monitored by tmpwatch, set the TC_PIPE_NAME_PREFIX
environment variable to the location of the FIFO entries, to avoid
locations that are automatically cleaned.
Out-of-memory error If you use WebSphere and this occurs when launching NX
during a call to from the rich client, you must modify the JVM arguments in
getAttrMappingsForDatasetType 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- Determine from logs whether users are frequently losing a server
time errors occur 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
export in batch mode a CFI error. This error occurs because jt.exe (Microsoft Task
Scheduler) file is missing from the %WINDOWS% directory.
To resolve this problem, download the Microsoft Task Scheduler
from the Microsoft Developer Network:
https://msdn.microsoft.com
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.
4. In the Advanced tab and the Regional Options tab, set the
required language.
Problem Solution
Teamcenter web application fails to The Teamcenter web application takes longer than the default
deploy on JBoss (WildFly) with the 60 seconds the JBoss (WildFly) deployment scanner allows for
following 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 xmlns="urn:jboss:domain:deployment-
period [60 seconds]. Check
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:
Problem Solution
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.
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.
TcServerManager_timestamp.log
2. Search the log file for errors similar to the following example:
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.
Troubleshooting Oracle
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.
export ORACLE_HOME=/u01/app/oracle/product/oracle-version
Replace oracle-version with the installed Oracle version, for example, 920.
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.
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
When upgrading a Microsoft SQL Server server, an error similar to the following can occur:
++++++++++++++++++++++++++++++++++
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.
Certain software libraries are required to run Lifecycle Visualization on SUSE Linux platforms. If the
required libraries are not installed on your system, Lifecycle Visualization may display an error that
contains the following text:
To display a list of the required RPM packages for Lifecycle Visualization on SUSE Linux, type the
following command:
From the resulting output, identify the missing libraries and install them on your system.
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:
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
-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
Typical
default Suggested
JVM option Description value value
-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.
-XX:MaxPermSiz Allows for the JVM to be able to increase the PermSize N/A 256 MB
e 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.
If an application needs to load or reload a large
number of classes, the following error may result:
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.
• You must select the Convert feature; the Print feature is optional.
• 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.
• You must enable the RenderMgtTranslator service and one or both of the following services:
• PreviewService
Configure translation services by enabling and configuring translators using Deployment Center.
• PreviewService
Requires Teamcenter Visualization Convert. Source authoring applications such as Microsoft Office
applications are also required.
• RenderMgtTranslator
• Use Business Modeler IDE to set up and deploy IRDC and dispatcher service configuration objects to
the Teamcenter database.
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.
fccstat -stop
After stopping the FCC process, the fccstat command reports that the FCC is offline.
2. Uninstall TCCS:
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.
fccstat -stop
uninstaller.bin
This launches the TCCS uninstallation wizard. Follow the instructions in the wizard to uninstall
TCCS.
4. Log off and log back on to the system to unset the FMS_HOME environment variable.
Uninstall your database software (Oracle or Microsoft SQL Server) according to the vendor
documentation.
Note that package IDs and template names have not changed, so the changed display names have no
impact on Quick Deploy scripts.
If you previously installed Security Services and built the Login Service and Identity Service web
applications using the Web Application Manager (insweb), you set these context parameters in that
tool.
You can alternatively build the Login Service and Identity Service web applications using Deployment
Center. Security Services context parameters in the Web Application Manager map to Security Services
properties In Deployment Center.
Web Application Manager Deployment Center Property Deployment Deployment Center Property
Property Internal Name Center Property Description
Display Name
webmaster fnd0_tcSSEmailAddress Web Master The email address of
the administrator to whom
questions and comments
about this application should
be addressed.
tcsso.login_service.appid fnd0_tcSSOApplicationId Login Service The Teamcenter ID of the
Application ID Security Services Login Service
Web Application. This should
match the corresponding entry
in the Application Registry
Table of the Identity Service.
tcsso.login_service.rp_ fnd0_tcSSOCookieNamePattern Cookie Name A pattern or set of patterns
cookieNamePattern Pattern describing the names of
cookies used by Reverse Proxy
Servers protecting Teamcenter
applications
tcsso.login_service.proxyURL fnd0_tcSSOLoginProxyURL Login Service Proxy The protocol://host:port URL
URL for the Teamcenter Security
Services Login Service when
used with load balancing or
Commercial SSO proxies.
tcsso.login_service.sso_ fnd0_tcSSServiceURL Identity Service Identity Service URL
service_url URL
identityServicePassword fnd0_identity_service_password Identity Service Specifies a password that the
Password Identity Service hashes to form
keys for signing and encrypting
security information to prevent
it from being forged or viewed.
Security improves with the
length and randomness of the
Web Application Manager Deployment Center Property Deployment Deployment Center Property
Property Internal Name Center Property Description
Display Name
password. This is used for auto-
login and commercial SSO
and MUST match the same
parameter in the TcSS Login
Service. The value for this
parameter will be encrypted.
tcsso.behind_sso_gateway fnd0_tcSSOGateway Is the Login Service This flag indicates the presence
behind a Gateway of a third-party single sign-on
(Gateway mode)? solution
tcsso.gateway.field.type fnd0_tcSSOGatewayfieldType Gateway Field Type This string indicates
how the gateway will
transmit credential information
(Teamcenter User ID) in the
HTTP request to the Login
Service.
tcsso.gateway.field.name fnd0_tcSSOGatewayfieldName Gateway Field A string value that
Name is the name of the
tcsso.gateway.field.type field
in the settings file.
Allowed values are:
"Header", "Cookie","Principal",
"Remote_User",
"Client_Certificate" and
"Filter_Class". This value
is ignored if
tcsso.behind_sso_gateway is
false.
tcsso.gateway.logout_url fnd0_tcSSOGatewayLogoutURL Gateway logout If set, the TcSS LoginService
URL will redirect to this URL to
logout of the gateway session.
tcsso.username.filter.class fnd0_tcSSOGatewayfilterUserName Gateway Filter User This value will
Name only be used when
tcsso.gateway.field.type
value is filter_class.
tcsso.client.enable.notice. fnd0_tcSSOLogonBanner Notice and A boolean value that
consent.logon.banner Consent Log-on represents if notice and
Banner consent log-on banner should
be displayed to user.
tcsso.forgotten.password.URL fnd0_tcSSOForgottenPasswordURL URL to reset the If it is non-empty and is a valid
forgotten password URL, it is the value associated
with the Forgot password
hypertext link, which will then
appear on the login page. If
empty, the Forgot password
link will not appear. It is
assumed the URL references
a page where the user can
request a new password or
that their old password be
sent.
tcsso.online_help.enable fnd0_tcSSOOnlineHelp Online Help Enable This flag enables/disables
Security Services online help.
Web Application Manager Deployment Center Property Deployment Deployment Center Property
Property Internal Name Center Property Description
Display Name
tcsso.samauth.token_endpoint fnd0_tcsso.samauth.token_endpoint SAM Authorization SAM Authorization token
token Endpoint Endpoint
tcsso.samauth.jwks_endpoint fnd0_tcsso.samauth.jwks_endpoint SAM Authorization SAM Authorization jwks
jwks Endpoint Endpoint
tcsso.samauth.userid_claim fnd0_tcSSSamAuthUserId SAM Authorization SAM Authorization Claim User
Claim User ID ID
tcsso.saml.issuer_id fnd0_tcsso.saml.issuer_id SAML Issuer ID SAML Issuer ID
tcsso.saml.idp_public_key_file fnd0_tcsso.saml.idp_public_key_file SAML IDP Public SAML IDP Public Key File
Key File
tcsso.saml.decryption_ fnd0_tcsso.saml.decryption_private_ Decryption private Decryption private JKS File
private_jks_file jks_file JKS File Name Name
tcsso.saml.decryption_ fnd0_tcsso.saml.decryption_private_ Decryption private Decryption private JKS File
private_jks_file_pwd jks_file_pwd JKS File Password Password
tcsso.saml.decryption_ fnd0_tcsso.saml.decryption_private_ Decryption private Decryption private key Name
private_key_name key_name key Name
tcsso.saml.decryption_ fnd0_tcsso.saml.decryption_private_ Decryption private Decryption private key
private_key_pwd key_pwd key Password Password
tcsso.saml.signing_ fnd0_tcsso.saml.signing_private_ Signing private JKS Signing private JKS File Name
private_jks_file jks_file File Name
tcsso.saml.signing_ fnd0_tcsso.saml.signing_private_ Signing private JKS Signing private JKS File
private_jks_file_pwd jks_file_pwd File Password Password
tcsso.saml.signing_ fnd0_tcsso.saml.signing_private_ Signing private key Signing private key Name
private_key_name key_name Name
tcsso.saml.signing_ fnd0_tcsso.saml.signing_private_ Signing private key Signing private key Password
private_key_pwd key_pwd Password
tcsso.oidc.client_id fnd0_tcsso.oidc.client_id OIDC Authorization OIDC Authorization client ID
client ID
tcsso.oidc.client_secret fnd0_tcsso.oidc.client_secret OIDC Authorization OIDC Authorization client
client Secret Secret
tcsso.oidc.auth_endpoint fnd0_tcsso.oidc.auth_endpoint OIDC Authorization OIDC Authorization Endpoint
Endpoint
tcsso.oidc.token_endpoint fnd0_tcsso.oidc.token_endpoint OIDC Authorization OIDC Authorization token
token Endpoint Endpoint
tcsso.oidc.jwks_endpoint fnd0_tcsso.oidc.jwks_endpoint OIDC Authorization OIDC Authorization jwks
jwks Endpoint Endpoint
tcsso.oidc.userid_claim fnd0_tcSSoidcUserId OIDC Authorization OIDC Authorization User ID
User ID
tcsso.oidc.signing_jks_file fnd0_tcsso.oidc.signing_jks_file OIDC Signing File OIDC Signing File Name
Name
tcsso.oidc.signing_jks_file_pwd fnd0_tcsso.oidc.signing_jks_file_ OIDC Signing file OIDC Signing file Password
pwd Password
tcsso.oidc.signing_private_ fnd0_tcsso.oidc.signing_private_ OIDC Signing OIDC Signing private key Name
key_name key_name private key Name
Web Application Manager Deployment Center Property Deployment Deployment Center Property
Property Internal Name Center Property Description
Display Name
propertiesPassword fnd0_tcSSPropertiesPassword propertiesPassword fnd0_tcSSPropertiesPassword
DEBUG Deprecated in Web Application DEBUG Deprecated in Web Application
Manager, no property in Deployment Manager, no property in
Center Deployment Center
tcsso.loginInputDef_name_*, fnd0_loginInputDefinitions Login Input Login Input Definition Table
Definition Table
tcsso.loginInputDef_where_*,
tcsso.loginInputDef_required_*,
tcsso.loginInputDef_idpkey_*
tcsso.loginInputDef_name_1 fnd0_loginInputDefinitions
tcsso.loginInputDef_name_2 fnd0_loginInputDefinitions
tcsso.loginInputDef_name_3 fnd0_loginInputDefinitions
tcsso.loginInputDef_name_4 fnd0_loginInputDefinitions
tcsso.loginInputDef_name_5 fnd0_loginInputDefinitions
tcsso.loginInputDef_where_1 fnd0_loginInputDefinitions
tcsso.loginInputDef_where_2
tcsso.loginInputDef_where_3
tcsso.loginInputDef_where_4
tcsso.loginInputDef_where_5
tcsso.loginInputDef_required_1 fnd0_loginInputDefinitions
tcsso.loginInputDef_required_2
tcsso.loginInputDef_required_3 fnd0_loginInputDefinitions
tcsso.loginInputDef_required_4
tcsso.loginInputDef_required_5
tcsso.loginInputDef_idpkey_1 fnd0_loginInputDefinitions
tcsso.loginInputDef_idpkey_2 fnd0_loginInputDefinitions
tcsso.loginInputDef_idpkey_3 fnd0_loginInputDefinitions
tcsso.loginInputDef_idpkey_4 fnd0_loginInputDefinitions
tcsso.loginInputDef_idpkey_5 fnd0_loginInputDefinitions
session-timeout fnd0_tcSSSessionTimeout Session Timeout
tcsso.samauth.scope fnd0_tcsso.samauth.scope SAM Authorization SAM Authorization Scope
Scope
tcsso.saml.validate.response. fnd0_tcsso.saml.validate.response. SAML Signature SAML Signature
signature signature
tcsso.saml.want.assertion. fnd0_tcsso.saml.want.assertion. SAML Assertion SAML Assertion Encryption
encrypted encrypted Encryption
tcsso.saml.sign_authn_ fnd0_tcsso.saml.sign_authn_request SAML SAML Authentication Request
request Authentication
Request
tcsso.saml.userid_attribute_ fnd0_tcsso.saml.userid_attribute_ SAML User ID SAML User ID
stored in properties
files (for example,
federation.properties).
The value for this
parameter will be
encrypted.
tcsso.DomainMap_UserDomain_1 fnd0_tcss_ldapDomainMap LDAP Domain LDAP Domain MAP Table
MAP Table
tcsso.DomainMap_LDAPDomain_1 fnd0_tcss_ldapDomainMap
LDAPConfiguration_LDAPOrdinal_1 fnd0_tcss_ldapOrdinal LDAP
Configuration
Table
LDAPConfiguration_LDAPHost_1 fnd0_TcSS_LDAP.dc0_machine_
name
LDAPConfiguration_LDAPPortNo_1 fnd0_tcss_ldapPort
LDAPConfiguration_LDAPPortNo fnd0_tcss_ldapPortOverride
Override_1
LDAPConfiguration_LDAPConnectType_1 fnd0_tcss_ldapProtocol
LDAPConfiguration_MaxLDAP fnd0_tcss_ldap_max_connections
Connections_1
LDAPConfiguration_QueryDN_1 fnd0_tcss_ldapAdministratorDN
LDAPConfiguration_QueryDNPassword_1 fnd0_tcss_ldapAdministrator
Password
LDAPConfiguration_LDAPBaseDN_1 fnd0_tcss_ldap_base_dn
LDAPConfiguration_UserObjectClass_1 fnd0_tcss_ldapUserObjectClass
LDAPConfiguration_MapUserAttribute_1 fnd0_fallBack_userAttr
LDAPConfiguration_UserAttribute_1 fnd0_tcss_ldapUserAttribute
LDAPConfiguration_LDAPConnection fnd0_tcss_ldap_connection_
SetupDelay_1 setupDelay
LDAPConfiguration_LDAPConnect fnd0_tcss_ldap_connection_
Timeout_1 timeout
tcsso.applicationRegistry_ApplicationID_1 fnd0_tcss_appRegistry Application
Registry Table
tcsso.applicationRegistry_Trusted_2
tcsso.applicationRegistry_Trusted_3
tcsso.applicationRegistry_Trusted_4
tcsso.applicationRegistry_Trusted_5
tcsso.applicationRegistry_Trusted_6
tcsso.applicationRegistry_Trusted_7
tcsso.applicationRegistry_Trusted_8
tcsso.applicationRegistry_Trusted_9
tcsso.applicationRegistry_Trusted_10
tcsso.applicationRegistry_Trusted_11
tcsso.applicationRegistry_Trusted_12
tcsso.applicationRegistry_Trusted_13
tcsso.applicationRegistry_StripDomain_1 fnd0_tcss_appRegistry
tcsso.applicationRegistry_StripDomain_2
tcsso.applicationRegistry_StripDomain_3
tcsso.applicationRegistry_StripDomain_4
tcsso.applicationRegistry_StripDomain_5
tcsso.applicationRegistry_StripDomain_6
tcsso.applicationRegistry_StripDomain_7
tcsso.applicationRegistry_StripDomain_8
tcsso.applicationRegistry_StripDomain_9
tcsso.applicationRegistry_StripDomain_10
tcsso.applicationRegistry_StripDomain_11
tcsso.applicationRegistry_StripDomain_12
tcsso.applicationRegistry_StripDomain_13
SUSE Linux:
fontconfig-2.11.1-7.1.x86_64
glibc-2.31-150300.46.1.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
libstdc++6-12.2.1+git416-150000.1.7.1.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
freetype-2.8-12.el7.x86_64
glibc-2.28-225.el8.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
libstdc++-8.5.0-18.el8.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