Deployment

SIEMENS
Active Workspace 3.4
Deployment
AW001 • 3.4
Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
What is Active Workspace? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Active Workspace components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Server Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Indexing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Visualization Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Deployment paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Installation strategies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Parallel versus series installation of Active Workspace components . . . . . . . . . . . . . . . . . 2-1
Teamcenter values needed to install Active Workspace components . . . . . . . . . . . . . . . . 2-2
Active Workspace values needed for parallel installation of components . . . . . . . . . . . . . . 2-3
Order of installation tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Installation overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Server Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Server Extensions overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Server Extensions prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Install the Active Workspace patch on the Teamcenter servers . . . . . . . . . . . . . . . . . . . . 2-8
Install Server Extensions features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Install database triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
Install Geolus (optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
Set preference for Geolus server URL (optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
Client overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
Java EE Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
.NET Client overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-27
Indexing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
Prepare to install indexing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
Dispatcher (optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
Testing TcFTSIndexer connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64
Set up TcFTSIndexer scheduling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-67
Configure Classification Search (optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-68
Visualization Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-73
Visualization Server overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-73
Visualization Server Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-74
Visualization Data Server (optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-88
Active Workspace Launcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-101
Install Client for Office and Active Workspace Launcher . . . . . . . . . . . . . . . . . . . . . . . 2-101
Troubleshoot the Teamcenter Active Workspace Launcher installation . . . . . . . . . . . . . 2-102
AW001 3.4 Deployment 3

Contents
Contents
Install classification libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-102

Install Tool Launcher Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-104
Patching and upgrading Active Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Patch and upgrade deployment paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Patching Active Workspace and Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Patching to Active Workspace 3.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Patch Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Patch to Active Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Upgrade the ACCT_TABLE database table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
Import table column configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Reinstall Active Workspace components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Initiate Solr credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Remerge Solr and Teamcenter schemas and update the index . . . . . . . . . . . . . . . . . . . 3-14
Reindex classification data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15
Install workflow features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20
Install Systems Modeling and Systems Modeler features . . . . . . . . . . . . . . . . . . . . . . . 3-20
Set up a custom template after patching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20
Regenerate and redeploy the Active Workspace WAR file . . . . . . . . . . . . . . . . . . . . . . . 3-21
Upgrading Active Workspace and Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23
Upgrading to Active Workspace 3.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23
Create index for upgrade performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23
Upgrade Active Workspace and Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23
Upgrade the ACCT_TABLE database table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-41
Import table column configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-42
Reinstall Active Workspace components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-42
Install workflow features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-42
Install Systems Modeling and Systems Modeler features . . . . . . . . . . . . . . . . . . . . . . . 3-43
Regenerate and redeploy the Active Workspace WAR file . . . . . . . . . . . . . . . . . . . . . . . 3-43
Active Workspace features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Active Workspace Server Extensions features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Active Workspace Client features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-22
4 Deployment AW001 3.4

Chapter 1: Introduction
What is Active Workspace?

Active Workspace allows you to view and create data in a wide range of browsers on traditional
desktop computers, laptops, tablets, and mobile devices. Your selected browser must support HTML5
and CSS3. The interface is compatible with traditional mouse-driven computers or touch displays
found on Windows, iOS, and Android OS tablets. On end-user devices, Active Workspace requires
minimal installation of software and requires no plug-ins, such as ActiveX or Java.
Administrators may configure the interface for a specific industry, group, role, or individual user. This
ensures users see only the tasks and data most relevant to their needs and interactions. Active
Workspace includes a powerful search that allows you to locate the data you need quickly and
conveniently. Workflows allow you to carry out work assignments and manage changes to your
product. The complexities of how the data is actually managed on the Teamcenter server remain
behind the scene.
AW001 3.4 Deployment 1-1

Chapter
Chapter 1: 1: Introduction
Introduction
Active Workspace components

You deploy Active Workspace on top of the Teamcenter four-tier architecture. The components added
provide client functionality, indexing, and visualization. You can deploy the components on a single
machine or on multiple machines depending on business needs.
1-2 Deployment AW001 3.4

Introduction

Chapter
Introduction
Server Extensions
Installing Active Workspace Server Extensions features adds binaries to TC_ROOT and adds
data model changes to the database and TC_DATA. These additions enable Active Workspace
functionality. Server Extensions features must be installed on each Teamcenter server that has the
Teamcenter Foundation feature installed. This includes corporate servers, volume servers, and
server manager hosts. The Server Extensions are installed using Teamcenter Environment Manager
(TEM).
Client
Client functionality is provided by a user-facing web application that is built using TEM. Users connect
to the Client web application using a web browser. The web application can be either:
• A Java EE-based WAR file (awc.war) deployed on a Java EE web application server such
as JBoss or WebSphere.
• A .NET-based web application (awc.zip) deployed on Microsoft IIS.
Indexing
The Indexing Server provides the basis for full-text search from the Active Workspace client.
The components involved in indexing are:
• Dispatcher (optional)
The Dispatcher is an asynchronous executor and load balancer of scheduled jobs. It allows
you to manage job distribution and execution for tasks such as file translation. With Active
Workspace, it can be used for structure data indexing if Dispatcher-based Indexing mode is
deployed. Dispatcher-based indexing is not available for object data indexing.
• Indexing Engine
This feature installs the Solr database, which is a full-text search engine that stores indexed
Teamcenter data. It is installed by selecting the Indexing Engine feature in TEM.
• Indexer
This feature installs the TcFTSIndexer, which is a four-tier SOA client used to export Teamcenter
data for importing into the Solr database. This service manages overall indexing processes. It is
installed by selecting the Indexer feature in TEM. The TcFTSIndexer is run manually for the initial
indexing and can be scheduled to run periodically for subsequent updates.
Indexing can be deployed in two different modes:
o Standalone Indexing Mode

Indexing operations are run on one machine using a single Java process which connects to
the Teamcenter server manager and the Solr search engine.

Introduction
This mode supports indexing both object data and structure data. It is the only mode that
supports object data. For custom types, this mode can be used if the type associated with
TcFtsIndexer supports Standalone mode.
o Dispatcher-Based Indexing Mode

Indexing operations are initiated using the Dispatcher and run across multiple machines.
This provides load balancing for better performance if indexing steps are CPU or memory
intensive.
The Dispatcher-based mode supports structure data indexing. If you run the TcTFSIndexer
in Dispatcher mode against object data, the indexer will revert to using Standalone mode.
For custom types, this mode can be used if the type associated with TcFtsIndexer supports
Dispatcher mode.
Visualization Server
The Visualization Server provides dynamic 3D visualization functionality to the Active Workspace
client. The Visualization Server is optional. If you do not plan on using Visualization with Active
Workspace, do not install its components.
The Visualization Server comprises:
• Visualization Server Manager
The Visualization Server Manager streams visualization data to the Active Workspace client. It
manages a pool of rendering processes, starting and stopping processes as needed.
• Visualization Data Server (optional)

The Visualization Data Server improves Visualization performance by caching visualization
data close to the Visualization Server Manager. It caches product structure, computes Massive
Model Visualization (MMV) spatial hierarchies, and prepopulates JT files in the FCC for faster
visualization streaming to the Active Workspace client. The Visualization Data Server is part
of the MMV solution for Active Workspace.
The Visualization Data Server is optional. You can use the Visualization Server Manager without
this component. However, if MMV is used, the Visualization Data Server is required. Additionally,
you need to index structure data for the product configurations that you want to view with the
MMV flag.
A single Visualization Data Server can support one or more Visualization Server Managers. A
Visualization Server Manager must be installed on the same host as the Visualization Data Server.

Chapter
Introduction
System requirements
For versions of system software and hardware certified for running Teamcenter and Active Workspace
on your platform, see the hardware and software certifications page on GTAC:
http://www.plm.automation.siemens.com/locale/support/gtac/certifications.shtml
Active Workspace software components require the following system software and hardware:
• Server Extensions
o The corporate server must have a 64-bit operating system and 64-bit JDK.
o The Teamcenter four-tier web application (Java EE or .NET) must be deployed.
• Client
o Java EE Client
The machine on which the WAR file is built must have:
■ A minimum of 16 GB of free physical RAM (unused by other applications) to avoid paging.

Siemens PLM Software recommends that the machine used have a minimum of 24 GB.
■ Windows server operating system.

If you are running Teamcenter in a Linux environment, you can deploy the WAR file on a
Linux server; however, the WAR file must be built on a Windows server machine.
■ 64-bit JDK 1.7 installed and the JAVA_HOME system environment variable must be set.
o .NET Client
■ A minimum of 16 GB of free memory to successfully generate the .NET Client web
application. Siemens PLM Software recommends that the machine used have a
minimum of 24 GB.
■ Windows Server operating system.
■ The .NET Client web application supports deployment on IIS only.
■ JDK 64-bit is installed and the JAVA_HOME system environment variable must be set.
• Indexing
o The Indexing Engine must be installed on a machine with a 64-bit operating system.
o The Indexing Engine must be installed on a machine with 64-bit JDK or JRE.
o In AIX and Solaris environments, Solr must be installed on a machine with a supported
version of Bash.
For supported versions, see the Hardware and Software Certifications page on GTAC.
• Visualization Server
o Visualization Server Manager

Introduction
■ The Visualization Server Manager’s supported hardware and software configurations are:
◊ Windows Server 64-bit 2012 R2 or Windows Server 64-bit 2008 R2.
Some graphics cards are not supported on Windows Server 64-bit 2008 R2.
◊ Server class hardware using the following graphics cards:

• NVIDIA GRID K1, K2, or Tesla M60 as certified by NVIDIA.
M60 is not supported on Windows Server 64-bit 2008 R2.
Note
Windows Server 2012 R2 supports a maximum of 8 GPUs.
Example
When booting Windows Server 2012 R2 with a legacy VGA device
and two or more NVIDIA GRID K1 cards, one of the NVIDIA GPUs is
unavailable for use.
Note
Supported hardware is suitable for a production environment. Other hardware
may work with Active Workspace, but Siemens PLM Software accepts problem
reports only for issues that are reproducible on a supported configuration.
For information about NVIDIA server hardware compatible with the GRID
graphics cards, see www.nvidia.com/buygrid.
■ You can run the Visualization Server Manager on a virtual machine for demonstration
or evaluation purposes. However, the Visualization Server Manager requires hardware
graphics support. For full GPU performance and functionality on a virtual machine, assign
a supported graphics card to the VM through a hypervisor such as Citrix XenServer.
o Visualization Data Server (optional)

You can install the Visualization Data Server (VDS) component to improve visualization
performance. The Visualization Data Server is required for Massive Model Visualization
(MMV).
■ Windows Server 64-bit 2012 R2 or Windows Server 64-bit 2008 R2.
■ The machine hosting the Visualization Data Server should have a minimum of 16 GB
of RAM but may require more. 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, 1 million * 2000 = 2 GB of RAM.

Chapter
Introduction
If you are not sure of the size of the structures, Siemens PLM 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 required.
■ Siemens PLM Software recommends that you install the Visualization Data Server on a
machine with multiple processors.
The Visualization Data Server is a multithreaded server program and is therefore
resource intensive; multiple processors are utilized if they are available. Standard server
class machine hardware is sufficient.
■ Virtual machine deployment is supported.
■ There are no graphics card requirements.
■ You must deploy the Visualization Data Server on a high-speed LAN near the
Visualization Server Manager.
■ Siemens PLM Software recommends that you deploy the Visualization Data Server near
or on a machine hosting an FSC cache or FSC volume. If you deploy the Visualization
Data Server on a remote machine (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.
■ You must deploy an FMS client cache (FCC) component on the machine hosting the
Visualization Data server.
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.
■ Structure indexing must be set up. The Visualization Data Server uses the structure
indexing infrastructure of Active Workspace to keep cached product structure up-to-date.

Introduction
Deployment paths
Active Workspace 3.4 is supported with the latest versions of Teamcenter and Teamcenter Rapid
Start and some earlier versions. If you do not use the latest version of Teamcenter or Teamcenter
Rapid Start, see the Teamcenter Compatibility Matrix to find which earlier versions are supported with
Active Workspace 3.4. On the hardware and software certifications page on GTAC, under Additional
Resources, click the link to Internal Interoperability – Teamcenter Compatibility Matrix.
Installing or updating to Active Workspace 3.4 requires an installation, upgrade, or patch process,
depending on your existing Teamcenter deployment:
• No existing Teamcenter deployment: Install Teamcenter with Active Workspace.
• Existing Teamcenter deployment without Active Workspace: Patch to add Active Workspace.
• Update the major version of Teamcenter: Upgrade Teamcenter while updating Active Workspace.
• Update the minor version of Teamcenter: Patch Teamcenter to the latest minor version while
updating Active Workspace.
• Update the Active Workspace version but not the Teamcenter version: Patch to update Active
Workspace.
Choose the appropriate deployment process in the Process column according to your initial and
target versions.
Initial version Target version Process

Active Workspace 3.4 with
Teamcenter 10.1.5, 10.1.6, or Install
Active Workspace not yet 10.1.7
installed Active Workspace 3.4 with
Teamcenter 11.2.1, 11.2.2, Install
11.2.3, or 11.3
Teamcenter 10.1.5, 10.1.6, or Upgrade
Active Workspace 2.x with 10.1.7
Teamcenter 9.1.x Active Workspace 3.4 with
Teamcenter 11.2.1, 11.2.2, Upgrade
11.2.3, or 11.3
Patch
Active Workspace 2.x with Teamcenter 10.1.6 or 10.1.7
Teamcenter 10.1.1.1 through Active Workspace 3.4 with
Teamcenter 10.1.5 Teamcenter 11.2.1, 11.2.2, Upgrade
11.2.3, or 11.3
Patch
Teamcenter 10.1.6 or 10.1.7
Active Workspace 3.x with
Teamcenter 10.1.6 Active Workspace 3.4 with
11.2.3, or 11.3

Chapter
Introduction

Active Workspace 3.x with Active Workspace 3.4 with
Patch
Teamcenter 11.2.2 Teamcenter 11.2.3 or 11.3

Chapter 2: Installation
Installation strategies
Parallel versus series installation of Active Workspace components

There are two strategies for installing Active Workspace that you should consider. Which strategy you
employ depends on the amount of planning you do.
• Install Active Workspace components in parallel.
If you plan the deployment of your Active Workspace components before beginning
installation, you can install each component concurrently. This is particularly useful when
installing components on separate server machines.
For example, you are installing the Server Extensions on host1, the Client on host2, the
Indexing components on host3, and the Visualization components on host4. Installation on
each of these hosts can begin at the same time.
This requires that, prior to installation, you know certain values (such as host names, URLs)
that will be used by the components. Planning is an essential first task.
Additionally, there are values from your Teamcenter four-tier environment that you need to
know before beginning any installation of the Active Workspace components.
• Install Active Workspace components in series.

If you have not done sufficient planning of your Active Workspace deployment to determine
the values needed for parallel installation of the components, you should install the
components in series.
You must still know the values from your Teamcenter four-tier environment before installing
the components in series.

Chapter
Chapter 2: 2: Installation
Installation
Teamcenter values needed to install Active Workspace components

To install Active Workspace components, you must identify a few values from your Teamcenter
four-tier environment. You cannot begin your Active Workspace installation until you know these
values.
This table is reproduced in the Teamcenter 4-tier tab of the InstallChecklist.xlsx spreadsheet. You
can use this spreadsheet, which is distributed in the Tcversion_ActiveWorkspaceversion_doc.zip
file on GTAC, to record your environment's installation parameters.
Values from the Teamcenter four-tier environment

Parameter Your value
Teamcenter four-tier URL (http://host:port/tc)
FSC bootstrap URLs (http://host:4544)
Database system user login/password
TC_DATA
TC_ROOT
(for Dispatcher-based indexing)
SPLM license server host and port (28000@host)

Installation
Active Workspace values needed for parallel installation of components

The installation of some Active Workspace components requires values that are set when installing
other components. If you plan your environment before beginning its installation, you can install the
separate Active Workspace components concurrently.
This table is reproduced in the Values for parallel install tab of the InstallChecklist.xlsx spreadsheet.
You can use this spreadsheet, which is distributed in the Tcversion_ActiveWorkspaceversion_doc.zip
Values from Active Workspace components

Parameter Where value is defined Your value
Visualization Pool Assigner host
Build the Java EE Client web
and port (http://host:55566)
application
Defined when building the web
Build and deploy the .NET
application file (awc.war for
Client web application
Java or awc.zip for .NET).
Dispatcher Server URL
(rmi://host:2001)
Defined when installing the
Install Dispatcher Server
Dispatcher Server.
(for Dispatcher-based indexing
only)
Dispatcher staging directory
Dispatcher Server. Install Dispatcher Server
(for Dispatcher-based indexing
only)
Indexing Engine URL
Install Indexing Engine (Solr)
(http://host:8983/solr)
Indexing Engine user name and
password
Indexing Engine.
Visualization Data Server host
and port Install the Visualization Data
(only needed if the Visualization Server
Data Server is used)

Chapter
Installation
Order of installation tasks

The Installation overview diagram describes the task order for both parallel and series installation.
Each horizontal grouping represents a taskflow for deploying a specific component. A rectangle in
a grouping represents a task to perform and is associated with a topic in this guide. An octagon
represents a point in the taskflow at which you must wait for the indicated taskflows to be completed
before proceeding.
• For parallel installation of components, you can begin each taskflow concurrently.
• For series installation of components, start with the taskflow at the top of the diagram and work
your way down, one taskflow at a time.

Installation
Installation overview

Chapter
Installation
Server Extensions
Server Extensions overview
Installing Active Workspace Server Extensions features adds binaries to TC_ROOT and adds
data model changes to the database and TC_DATA. These additions enable Active Workspace
functionality. Server Extensions features must be installed on each Teamcenter server that has the
Teamcenter Foundation feature installed. This includes corporate servers, volume servers, and
server manager hosts. Server Extensions are installed using Teamcenter Environment Manager
(TEM).
These tables are reproduced in the Server Extensions tab of the InstallChecklist.xlsx spreadsheet.
You can use this spreadsheet, which is distributed in the Tcversion_ActiveWorkspaceversion_doc.zip
Values required before beginning the Server Extensions taskflow

Indexing Engine user name
and password
Search engine URL
(http://host:8983/solr)
Database system user name
Teamcenter database creation
and password
Values to record during the Server Extensions taskflow execution

Geolus server URL (only if
Install Geolus (optional)
Shape Search is used)

Installation
Server Extensions prerequisites
Prerequisites for installing the Server Extensions:

• 64-bit operating system
• 64-bit JDK
• Supported version of Teamcenter

Active Workspace 3.4 supports the latest versions of Teamcenter or Teamcenter Rapid Start,
and some earlier versions. If you do not use the latest version of Teamcenter or Teamcenter
Rapid Start, see the Teamcenter Compatibility Matrix to find which earlier versions are supported
with Active Workspace 3.4. On the hardware and software certifications page on GTAC, under
Additional Resources, click the link to Internal Interoperability – Teamcenter Compatibility
Matrix.
• The Teamcenter environment must include corporate server, a server manager (Java EE or
.NET), and Teamcenter web tier (Java EE or .NET).
For information about installing and patching Teamcenter, refer to the Teamcenter documentation:
• Windows Server Installation→Additional configuration and maintenance→Installing Teamcenter
patches
• UNIX and Linux Server Installation→Additional configuration and maintenance→Installing

Teamcenter patches
Record the following values from your Teamcenter four-tier environment. You need these values
when you install Active Workspace components.
Values from the Teamcenter four-tier environment

Parameter Your value
Teamcenter four-tier URL (http://host:port/tc)
FSC bootstrap URLs (http://host:4544)
Database system user login/password
TC_DATA
TC_ROOT
SPLM license server host and port (28000@host)

Chapter
Installation
Install the Active Workspace patch on the Teamcenter servers
Before you install any Active Workspace features, you must add the Active Workspace patch to all
Teamcenter servers that have the Teamcenter Foundation feature installed. This makes Active
Workspace features available for installation in TEM.
1. From the GTAC download page, download the Active Workspace 3.4 software kit
(Tcrelease_ActiveWorkspacerel-num_platform.zip).
2. Expand the Active Workspace 3.4 software kit to a local directory.
3. Stop all Teamcenter services except FSC services before proceeding with the patch. For
example, make sure all server manager services are stopped.
4. Launch TEM for the corporate server.
5. In the Maintenance panel, select Updates Manager.
6. Proceed to the Apply Updates panel and enter required paths:

• In the Update kit location box, enter the path to the expanded Active Workspace 3.4
software kit.
• In the Backup directory box, enter a path in which you want TEM to create backups of files
replaced during patching.
• In the Original Media Location box, enter the path to the software kit for the major version
of Teamcenter or Teamcenter Rapid Start.
Note
When you continue from this panel, a status message in TEM reminds you that
Teamcenter services must be stopped to perform the update. Once the update is
completed, these services are restarted. Any current user sessions are closed.
7. Proceed to the Operating System User panel and type the password of the operating system
account used to update Teamcenter.
8. Proceed to the Teamcenter Administrative User panel and type the user’s password.
9. Proceed to the Confirmation panel and click Start to apply the Active Workspace patch.
During the update, a status message may inform you to consult the README file for the Active
Workspace patch for any manual steps required to complete the patch.
10. When the update is complete, close TEM.

Installation
11. In the location of the expanded Active Workspace 3.4 software kit, browse to the tc directory.
Expand the data.zip file from this location to the corporate server’s TC_DATA folder.
Install Server Extensions features
Server Extensions must be installed on every host that has the Teamcenter Foundation feature
installed.
1. Stop all Teamcenter services except FSC services before beginning installation.
2. Launch Teamcenter Environment Manager (TEM) for the corporate server to which Server
Extensions features are to be added.
3. In the Maintenance panel, select Configuration Manager.
4. In the Configuration Maintenance panel, select Perform maintenance on an existing

configuration.
5. In the Old Configuration panel, select the corporate server configuration.
6. In the Feature Maintenance panel, select Add/Remove Features.
7. In the Features panel, select Active Workspace Server Extensions features:

a. Expand Base Install→Active Workspace→Server Extensions.
b. Select the Active Workspace Server Extensions feature. (This feature is required.)
c. Select any additional Server Extensions features you want to include in your Active
Workspace deployment.
Additional features may display additional panels in TEM that are not described in this
procedure. See the help buttons in those panels for information.
Note
• To search for a feature by name, type the name or a partial name in the search
box, and then click the search icon.
• Some Server Extensions features depend on other Server Extensions features. In

these cases, the required feature is listed above the features that depend on it.
• When you continue from this panel, a status message in TEM reminds you to stop
Teamcenter services before proceeding.

Chapter
Installation
8. In the Teamcenter Administrative User panel, type the user’s password.
9. In the Indexing Engine User panel, type the Solr administrator’s user name and password.
The Solr administrator’s user name and password are defined when you install the Indexing
Engine (Solr).
If the indexing engine is not installed yet, record the Solr administrator user name and password
and make sure to use these credentials when you install the indexing engine. These credentials
must match for the Indexing Engine, the Indexer, Server Extensions, and the Active Content
Structure Translator (if used).
10. In the Active Workspace Server Extensions Settings panel, type the Solr search engine
URL. The format is:
http://host:port/solr
host is the machine designated to run Solr. This is the machine on which the Indexing
Engine is installed.
port is the port value used by Solr. The default is 8983.
If your environment uses multiple Solr search engines for failover, select Use additional search
engine URLs, and then type the URLs in the Search Engine URL List.
11. In the Database User panel, type the password for the Teamcenter database user.
12. In the Database Template Summary panel, review the list the templates to be applied to
the Teamcenter database. The templates listed vary depending on the features selected for
installation.
13. In the Confirmation panel, click Start to begin the installation.

The TcFTSIndexer process requires database triggers to detect additions, modifications, and
deletions to the database when performing run-time (synchronous) indexing.
At the end of the installation process, TEM displays a TODO message notifying you to install the
database triggers manually.
InstallSuccessful box of the Install panel and you must install the database triggers manually:
Note
Under certain conditions, TEM may install the database triggers automatically. If the
TODO message is not displayed, you do not need to manually install database triggers.
14. When installation is complete, close TEM.

Installation
Install database triggers
Database triggers
The TcFTSIndexer requires database triggers to detect additions, modifications, and deletions to the
database when performing run-time (synchronous) indexing.
Under certain conditions, TEM may install the database triggers automatically during installation of
Server Extensions. If TEM is not able to do this, TEM displays a TODO message notifying you
to install database triggers manually.
If TEM displayed this TODO message, install the database triggers by the appropriate procedure for
your database:
• Install database triggers in Oracle
• Install database triggers in Microsoft SQL Server
Install database triggers in Oracle

1. Grant create trigger privilege to the Oracle user that owns the Teamcenter database (typically
infodba) by:
a. Open a command prompt.
b. Type:
sqlplus system/password
c. Type:
grant Create trigger to infodba identified by password;
d. Type:
exit
2. Create the trigger:

a. In the command prompt, type:
sqlplus infodba/password
b. Type:
@Teamcenter-installation-media\tc\install\sitecons\sitecons_install_tables_and_triggers.sql
Install database triggers in Microsoft SQL Server

1. Open Microsoft SQL Server Management Studio.

Chapter
Installation
2. Complete the Connect to Server dialog box:

a. In the Server name box, select the host on which Microsoft SQL Server is installed.
b. In the Authentication box, select SQL Server Authentication.
c. In the Login box, type the database administrative user name.
d. In the Password box, type the database administrative user password.
e. Click Connect.
3. In the Object Explorer panel of the Microsoft SQL Server Management Studio dialog box,
expand the Databases tree and select the Teamcenter database name, for example, tc.
4. From the menu bar, choose File→Open→File.
5. In the Open File dialog box, navigate to the software kit for the Teamcenter major release.
In the Tc-software-path\tc\install\sitecons directory, select
sitecons_install_tables_and_triggers_mssql.sql.
Microsoft SQL Server Management Studio opens the selected file.
6. Click Query→Execute.
The query installs the database triggers.
7. Verify that the query completed with no errors.
8. Close the Microsoft SQL Server Management Studio.
Installing database triggers from the command line

If Microsoft SQL Server Management Studio is not installed on your host, you can install the database
triggers from a command line. Type the following command in a Windows command prompt:
sqlcmd -H host -d database -U user -P password -i path\sitecons_install_tables_and_triggers_mssql.sql
Replace:
• host with the database server host name.
• database with the Teamcenter database name.
• user with the database user name.
• password with the database user password.
• path with the path to the sitecons_install_tables_and_triggers_mssql.sql file.
For example:
sqlcmd -H myhost -d TcDB -U dbUser -P dbPassword -i
C:\software\tc\install\sitecons\sitecons_install_tables_and_triggers_mssql.sql
To verify the triggers installed successfully, log into Microsoft SQL Server and type the following
commands in an SQL prompt:

Installation
1> Select name,is_disabled from sys.triggers

2> Go
If the database triggers installed successfully, Microsoft SQL Server displays a response similar
to the following:
name is_disabled
-----------------------------------------------------------------
fast_sync_add_trigger 0
fast_sync_delete_trigger 0
(2 rows affected)
Install Geolus (optional)
The Shape Search feature uses the Geolus shape search engine from Siemens PLM Software. If
you plan on using Shape Search, you must install and configure Geolus. For details, refer to the
Geolus documentation.
Set preference for Geolus server URL (optional)
The Shape Search feature uses the Geolus shape search engine from Siemens PLM Software. You
must define the URL used for communication between Shape Search and Geolus. This is done by
creating the GeolusServer preference.
Note
This step is required only if you installed the Shape Search feature in Install Server
Extensions features.
1. Sign in to the rich client and choose Edit→Options.
2. In the bottom-left of the Options dialog box, click Search.
3. In the upper-left of the Preferences By Search panel, click Create a new preference definition.

Chapter
Installation
4. In the right-hand panel, define the preference:
• Name: Type GeolusServer.
• Category: Set to DecisionApps.ShapeSearch.Preferences.
• Type a useful description in the Description box.
• Value: Type the Geolus server URL. It has the format:

protocol://gServer:gPort/gContext
protocol can be http or https.
gServer is the machine name or IP address of the machine running the Geolus server. It
must be accessible by all Teamcenter clients that need to connect to it.
gPort is the port number that the server uses to handle HTTP or HTTPS requests.
gContext is the context root of the Geolus server.
5. Click Save at the bottom of the right-hand panel.

Installation
6. Close the Options dialog box.
7. Restart the Teamcenter server.

Chapter
Installation
Client
Client overview
to the client web application using a web browser. The web application can be either:
• A Java EE-based WAR file (awc.war) deployed on a Java EE web application server such
as JBoss or WebSphere.
• A .NET-based web application deployed on Microsoft IIS.
Note
The Active Workspace client web application must be installed (built) on a machine running
a supported Windows operating system, but can be deployed on a machine running any
operating system and application server on which the client web application is supported.

Installation
Java EE Client
Java EE Client overview
to the client web application using a web browser. The Java EE-based Client (awc.war) is deployed
on a Java EE web application server such as JBoss or WebSphere.
For information about configuring security for this client, see Security configuration tasks in
Configuration and Extensibility.
Values required before beginning the Client taskflow

Deployment of Teamcenter
Teamcenter four-tier URL
four-tier web application
JDK installation location on
JDK Home the machine used to build the
awc.war file
FSC Bootstrap URLs
Teamcenter installation
(http://host:4544)
Values to record during the Client taskflow execution

Visualization Pool Assigner host Build the Java EE Client web
and port application
Deploy the Java EE Client web
Active Workspace Client URL
application

Chapter
Installation
Prerequisites for the Java EE Client
The machine on which you build the Active Workspace client web application must meet the following
requirements. These requirements apply to the machine on which it is built, not to the machine on
which it is deployed.
• A minimum of 16 GB of free memory to successfully generate the awc.war file. Siemens PLM
Software recommends that the machine used have a minimum of 24 GB.
• Windows Server operating system.

If you are running Teamcenter in a Linux environment, you can deploy the Java EE Active
Workspace client web application on a Linux server, however, the awc.war file must be built on a
Windows Server machine.
• JDK 64-bit is installed and the JAVA_HOME system environment variable must be set.
Install the Active Workspace patch on the Java EE Client build host
To install the Client features, you must install a supported version of Teamcenter or Teamcenter
Rapid Start and the Active Workspace patch. If the Active Workspace patch is not installed, the
Client features are not available in TEM.
The Active Workspace patch can be installed:
• In an existing configuration that is patched to the supported Teamcenter or Teamcenter Rapid
Start version by following the steps in Install the Active Workspace patch on the Teamcenter
servers.
• While installing a new configuration by launching TEM from the Teamcenter or Teamcenter Rapid
Start minor release. You add the locations of the base Teamcenter or Teamcenter Rapid Start
installation media and the Active Workspace patch in a TEM panel.

Installation
Build the Java EE Client web application
Active Workspace Client features can be installed in a new or an existing Teamcenter configuration.
These steps assume you are installing the Client features on a host with no existing configuration.
If you are adding Active Workspace Client features to an existing configuration, launch TEM for that
configuration and proceed to the Features panel (step 7).
1. Make sure you have the following software kits available:
• Teamcenter major release (Teamcenter 10.1 or Teamcenter 11.2)
• Teamcenter minor release (Teamcenter 10.1.x, Teamcenter 11.4, or Teamcenter 11.2. x)
• Active Workspace 3.4
Teamcenter software kits must match the version level of your corporate server, and all software
kits must be 64-bit. You can download software kits from GTAC if necessary.
Note
Teamcenter 11.x software kits contain both Teamcenter and Teamcenter Rapid Start.
2. Launch TEM from the Teamcenter or Teamcenter Rapid Start minor release.
3. Proceed to the Install/Upgrade Options panel (in Teamcenter 11) or the Welcome panel (in
Teamcenter 10). Click Install.
4. In the Media Locations panel, enter paths to the software kits.

• In the Original Media Location box, enter the path to the software kit for the major version of
Teamcenter or Rapid Start.
• In the Update Location box, enter the path to Active Workspace 3.4 software kit.
The path to the Teamcenter or Rapid Start minor version software kit is already included in
the list of update locations.
5. In the Configuration panel, enter an ID and a Description for the configuration.
6. In the Solutions panel, you can do one of the following:

• Select the Active Workspace Client solution.
This preselects the Java EE Client and commonly used client features.
• Make no selections, and add the Java EE Client and other client features in the Features
panel.

Chapter
Installation
7. In the Features panel, select Active Workspace Client features:

a. Expand Base Install→Active Workspace→Client.
b. Select the Active Workspace Client (Java EE) Client feature. (This feature is required.)
This feature provides the Client functionality. Other Client features are disabled unless this
feature is selected.
If you selected the Active Workspace Client solution in the Solutions panel, some
additional commonly used client features are preselected.
c. Select any additional Client features you want to include in your Active Workspace
deployment. (See Active Workspace Client features.)
Some features add additional panels to the installation process that are not described in this
procedure. For information about any TEM panel, click the help button .
Note
box, and then click the search button .
• Some features depend on other features. Prerequisite features are usually listed
earlier than the features that depend on them.
8. In the Prerequisite Checks panel, verify that your host meets the prerequisites to build the Active
Workspace Client web application:
a. Enter a location in which to create log files for the prerequisite checks, and then click Run.
b. Inspect the test results. If the Results column for any test shows a Fail status, you must
correct the issue before proceeding.
c. Repeat tests until all results show a status of Pass or Warning.

To view a summary of all tests, click Review.
The following prerequisites are checked:
• Client Build Free RAM Availability Check determines whether the host has the
recommended minimum of 16 GB of free physical RAM.
• JDK Version Compatibility Check verifies that the JAVA_HOME system environment
variable is set and that a 64-bit Java SE Development Kit (JDK) is installed that meets the
required minimum version.
For the required Java version, see the hardware and software certifications page on GTAC.
9. If any prerequisite checks resulted in warnings, TEM displays the Confirm Warnings panel.
Select the corresponding check boxes to acknowledge each warning to continue.

Installation
10. In the Active Workspace Client Settings panel, enter required values for the Active Workspace
client:
Value Description
Teamcenter 4-tier URL Specifies the URL for the deployed Java EE
Teamcenter Web application. The URL should be of
this form:
protocol://host:port/tc
• protocol can be http or https.
• host is the machine running the web application

server on which the Teamcenter web application
is deployed.
• port is the port used by the web application server.
Caution
Do not change the application name (tc) in
the URL.
JDK Home Specifies the path to the Java SE Development Kit

(JDK). This box is prepopulated with the value of the
JAVA_HOME system environment variable. You can
change this to a different JDK if needed.
For supported JDK versions, see the hardware and
software certifications page on GTAC.
GWT requires the JDK to compile the Active Workspace
.war file.
Use as Bootstrap URLs The Active Workspace client uses FMS to download
and upload files. You define the FSC servers that are
used by selecting either Use as Bootstrap URLS or
Use Assigned FSC URLs.
Selecting Use as Bootstrap URLs allows you to
specify bootstrap URLs to be used by FMS.

Chapter
Installation
Value Description
Bootstrap URLs Specifies a comma-separated list of one or more FMS
bootstrap URLs.
The list of bootstrap URLs must contain known FSCs
that can be consulted for the actual FSC assignment.
The assignment is delegated to the FMS network, which
uses mapping logic and configuration data to determine
which FSCs the requestor uses (refer to the clientmap
configuration in the FMSMaster configuration file). The
client mapping logic uses an IP address to determine
the assignment. By default, the IP address from the
HTTP connection of the requestor is used unless a
Bootstrap Client IP value is provided. The Bootstrap
Client IP value should only be used when there are
proxies that may hide the actual requestor’s IP address
from the FSC servers, or if you want the assignment
to be performed based on a particular IP and not that
of the requestor. (The client/requestor is the host on
which the awc.war file is deployed.)
Bootstrap Client IP Specifies the FMS bootstrap client IP address to be
used for the assignment. This value is optional.
Use Assigned FSC URLs Specifies you want to explicitly assign FSC servers.
Select this only if you want explicit control of the FSCs
used.
Assigned FSC URLs Specifies a comma-separated list of one or more
assigned FSC URL values.
The URL values entered are directly used for file
operations. This allows you to explicitly declare the
FSC servers that should be used.
Enable TcSS Support Values for configuring Security Services.
Enable TcSS Support Select this check box if you want to enable Security
Services support in Active Workspace.
TcSS Application ID Specifies the Security Services application ID.
TcSS Login URL Specifies the logon URL for the Security Services
application.
For details about configuring Security Services, see
Security Services Installation/Customization in the
Teamcenter help collection.
When you configure Active Workspace for Security
Services, be sure to only install the language packs for
the Security Services that Active Workspace supports.
If Active Workspace is deployed on a different URL,
you must configure Security Services with multiple
application IDs. For more information, see the readme
file for your Teamcenter Security Services release.

Installation
If you want to include additional locales in the awc.war file configuration, click Advanced and
select locales in the Additional Client Settings dialog box.
11. If you selected the Visualization Server Pool Assigner feature in the Features panel, TEM
displays the Visualization Pool Assigner Settings panel. Specify these settings if you use
Visualization in the Active Workspace client:
Value Description
Local Assigner Settings Local assigner settings define the local host as a
Visualization Server Pool Assigner. To define your
local host as an assigner, type the host and port values
of the local host.
Host Specifies the host on which this Visualization Server
Pool Assigner runs. This is the host on which the
awc.war file containing this Visualization Server Pool
Assigner is deployed. You may type the host name
or IP address of the host.
The machine building the awc.war file may or may not
be the host on which it is deployed.
Specifies the port used by the local Visualization
Port
Server Pool Assigner.
Add pool assigner Specifies whether additional Visualization Server Pool
Assigners are used. Select this checkbox only if more
than one Visualization Server Pool Assigner is to be
used. If only one Visualization Server Pool Assigner is
used, do not select this option.
Peer Assigners The Peer Assigners table lists other Visualization
Server Pool Assigners known to the local Visualization
Server Pool Assigners.
Assigner Host Specifies the host on which a peer Visualization Server
Pool Assigner is deployed. This value can be the host
name or IP address.
Assigner Port Specifies the port number used by the peer
Visualization Server Pool Assigner.
Teamcenter 4-tier URL Specifies the URL of the Teamcenter web tier
application.
This value is required if Security Services is enabled,
but is optional otherwise.
13. When the installation is complete, close TEM.

The awc.war file is created in the TC_ROOT\aws2\stage\out\ directory on the machine used
to build the awc.war file.

Chapter
Installation
Deploy the Java EE Client web application
In this step, you deploy the Java EE Client WAR file (awc.war) created in Build the Java EE Client
web application. The Java EE Client WAR file hosts static client resources and provides web proxies
to connect to Teamcenter SOA and file services.
The Java EE Client WAR file (awc.war) is created in the TC_ROOT\aws2\stage\out\ directory on
the machine used to build it.
Deploy the Java EE Client WAR file on a supported Java EE web application server such as JBoss
or WebSphere. Typically, this involves copying the Java Client WAR file directly to an auto deploy
directory or deploying it manually into a web application server using either a web-based console or
command line utilities. Deploy the WAR file according to the web application server documentation.
The Java EE Client WAR file is not supported on Microsoft Internet Information Services (IIS). For
supported web application servers, see the hardware and software certifications page on GTAC.
JBoss and Websphere servers require special configuration to support the Active Workspace Java
EE client. Perform one the following procedures if it applies.
Special configuration for JBoss
If you are using a JBoss server, you must edit its configuration file to allow Active Workspace to be
referenced outside of local host environments.
1. Open standalone.xml (the name of your deployment’s configuration file) in an editor.
2. Search for the following line:

<inet-address value="${jboss.bind.address:127.0.0.1}"/>
This line is located in the <interface name=”public”> section of the file.
3. Replace the existing line with the following:

<any-address/>
4. Save and close the configuration file.

Installation
Special configuration for WebSphere
• If you are using a WebSphere server, you must modify the web container to work around a known
issue with WebSphere’s handling of internal HTTP routing (resulting in an SRVE0190E error).
Refer to the following WebSphere documentation for details on this modification:
http://www-01.ibm.com/support/docview.wss?uid=swg21284395
• Following is an example of the additional custom properties for WebSphere:

com.ibm.ws.webcontainer.mapFiltersToAsterisk=true
com.ibm.ws.webcontainer.removetrailingservletpathslash=true
com.ibm.ws.webcontainer.invokeFiltersCompatibility=true
com.ibm.ws.webcontainer.invokefilterscompatibility=true
• If during deployment the administration console either freezes or returns an error that says it is
unable to deploy the WAR file, try changing the Java heap size settings. For example, set the
initial heap size to 4096 MB and the maximum heap size to 6144 MB. Refer to the following
WebSphere documentation for instructions on setting the Java heap size:
http://pic.dhe.ibm.com/infocenter/mdm/v9r0/index.jsp?
topic=%2Fcom.ibm.p8.installingmcs.doc%2Fmcspi010.htm

Chapter
Installation
Sign in using the Active Workspace interface
From a client machine in your environment, sign in using the Active Workspace client. This tests the
environment and the Active Workspace client web application.
1. Sign in to a client machine in your environment.
2. Open a supported web browser.

For supported versions of third-party software, see the hardware and software certifications
page on GTAC.
3. Go to the URL:
http://host:port/web-app-name.
host is the machine running the web application server on which the Active Workspace
client web application is deployed.
port is the port used by the web application server.
web-app-name is the WAR file name, awc.
4. Type a user name and password and click Sign in. Verify that you can sign in without errors.

Installation
.NET Client overview
.NET Client overview
Client functionality is provided by a user-facing web application that is built using TEM. Users
connect to the client web application using a web browser. The .NET-based Client web application is
deployed on Microsoft IIS.
Values required before beginning the Client taskflow

Deployment of Teamcenter
four-tier web application
JDK installation location on
JDK Home the machine used to build the
awc.zip file
FSC Bootstrap URLs
(http://host:4544)
Values to record during the Client taskflow execution

Visualization Pool Assigner host Build and deploy the .NET
and port Client web application
Active Workspace Client URL

Chapter
Installation
Prerequisites for the .NET Client
Installing the Active Workspace .NET Client web application requires:

• A minimum of 16 GB of free memory to successfully generate the .NET Client web application.
Siemens PLM Software recommends that the machine used have a minimum of 24 GB.
• Windows Server operating system.
• The .NET Client web application supports deployment on IIS only.
• JDK 64-bit is installed and the JAVA_HOME system environment variable must be set.
Install the Active Workspace patch on the .NET Client build host
To install the Client features, you must install a supported version of Teamcenter or Teamcenter
Rapid Start and the Active Workspace patch. If the Active Workspace patch is not installed, the
Client features are not available in TEM.
servers.

Installation
Build and deploy the .NET Client web application
Active Workspace Client features can be installed in a new or an existing Teamcenter configuration.
These steps assume you are installing the Client features on a host with no existing configuration.
If you are adding Active Workspace Client features to an existing configuration, launch TEM for that
configuration and proceed to the Features panel (step 7).
1. Make sure you have the following software kits available:
• Teamcenter major release (Teamcenter 10.1 or Teamcenter 11.2)
• Teamcenter minor release (for example, Teamcenter 10.1.x or Teamcenter 11.4)
• Active Workspace 3.4
Teamcenter software kits must match the version level of your corporate server, and all software
kits must be 64-bit. You can download software kits from GTAC if necessary.
Note
Teamcenter 11.x software kits contain both Teamcenter and Teamcenter Rapid Start.
2. Launch TEM from the Teamcenter or Rapid Start minor release.
3. Proceed to the Install/Upgrade Options panel (in Teamcenter 11) or the Welcome panel (in
Teamcenter 10). Click Install.
4. In the Media Locations panel, enter paths to the software kits.

• In the Original Media Location box, enter the path to the software kit for the major version of
Teamcenter or Rapid Start.
• In the Update Location box, enter the path to Active Workspace 3.4 software kit.
The path to the Teamcenter or Rapid Start minor version software kit is already included in
the list of update locations.
5. In the Configuration panel, enter an ID and a Description for the configuration.
6. In the Solutions panel, do not select any solutions. (Do not select the Active Workspace Client
solution, as this preselects Java EE Client feature.)
7. In the Features panel, select Active Workspace Client features:

a. Expand Base Install→Active Workspace→Client.

Chapter
Installation
b. Select the Active Workspace Client (Java EE) Client feature. (This feature is required.)
This feature provides the Client functionality. Other Client features are disabled unless this
feature is selected.
c. Select any additional Client features you want to include in your Active Workspace
deployment. (See Active Workspace Client features.)
Some features add additional panels to the installation process that are not described in this
procedure. For information about any TEM panel, click the help button .
Note
box, and then click the search button .
• Some features depend on other features. Prerequisite features are usually listed
earlier than the features that depend on them.
8. In the Prerequisite Checks panel, verify that your host meets the prerequisites to build the Active
Workspace client web application:
a. Enter a location in which to create log files for the prerequisite checks, and then click Run.
b. Inspect the test results. If the Results column for any test shows a Fail status, you must
correct the issue before proceeding.
c. Repeat tests until all results show a status of Pass or Warning.

To view a summary of all tests, click Review.
The following prerequisites are checked:
• Client Build Free RAM Availability Check determines whether the host has the
recommended minimum of 16 GB of free physical RAM.
• JDK Version Compatibility Check verifies that the JAVA_HOME system environment
variable is set and that a 64-bit Java SE Development Kit (JDK) is installed that meets the
required minimum version.
For the required Java version, see the hardware and software certifications page on GTAC.
9. If any prerequisite checks resulted in warnings, TEM displays the Confirm Warnings panel.
Select the corresponding check boxes to acknowledge each warning to continue.
10. In the Active Workspace Client Settings panel, enter required values for the Active Workspace
client:

Installation
Value Description
Teamcenter 4-tier URL Specifies the URL for the deployed .NET Teamcenter
Web application. The URL should be of this form:
protocol://host:port/tc
• protocol can be http or https.
• host is the machine running the web application

server on which the Teamcenter web application
is deployed.
• port is the port used by the web application server.
Caution
Do not change the application name (tc) in
the URL.
JDK Home Specifies the path to the Java SE Development Kit

(JDK). This box is prepopulated with the value of the
JAVA_HOME system environment variable. You can
change this to a different JDK if needed.
For supported JDK versions, see the hardware and
GWT requires the JDK to compile the Active Workspace
.war file.
Use as Bootstrap URLs The Active Workspace client uses FMS to download
and upload files. You define the FSC servers that are
used by selecting either Use as Bootstrap URLS or
Use Assigned FSC URLs.
Selecting Use as Bootstrap URLs allows you to
specify bootstrap URLs to be used by FMS.
Bootstrap URLs Specifies a comma-separated list of one or more FMS
bootstrap URLs.
The list of bootstrap URLs must contain known FSCs
that can be consulted for the actual FSC assignment.
The assignment is delegated to the FMS network, which
uses mapping logic and configuration data to determine
which FSCs the requestor uses (refer to the clientmap
configuration in the FMSMaster configuration file). The
client mapping logic uses an IP address to determine
the assignment. By default, the IP address from the
HTTP connection of the requestor is used unless a
Bootstrap Client IP value is provided. The Bootstrap
Client IP value should only be used when there are

Chapter
Installation
Value Description
proxies that may hide the actual requestor’s IP address
from the FSC servers, or if you want the assignment
to be performed based on a particular IP and not that
of the requestor. (The client/requestor is the host on
which the awc.war file is deployed.)
Bootstrap Client IP Specifies the FMS bootstrap client IP address to be
used for the assignment. This value is optional.
Use Assigned FSC URLs Specifies you want to explicitly assign FSC servers.
Select this only if you want explicit control of the FSCs
used.
Assigned FSC URLs Specifies a comma-separated list of one or more
assigned FSC URL values.
The URL values entered are directly used for file
operations. This allows you to explicitly declare the
FSC servers that should be used.
Enable TcSS Support Values for configuring Security Services.
Enable TcSS Support Select this check box if you want to enable Security
Services support in Active Workspace.
TcSS Application ID Specifies the Security Services application ID.
Specifies the logon URL for the Security Services
application.
For details about configuring Security Services, see
Security Services Installation/Customization in the
TcSS Login URL When you configure Active Workspace for Security
Services, be sure to only install the language packs for
the Security Services that Active Workspace supports.
If Active Workspace is deployed on a different URL,
you must configure Security Services with multiple
application IDs. For more information, see the readme
file for your Teamcenter Security Services release.
If you want to include additional locales in the awc.war file configuration, click Advanced and
select locales in the Additional Client Settings dialog box.
11. In the Active Workspace Client IIS Settings (.NET) panel, enter values to configure the Active
Workspace client on Microsoft Internet Information Server (IIS):

Installation
Value Description
Deploy to IIS Web Site Specifies whether to automatically deploy the web
application to IIS based on the values entered in this
panel.
If you do not select this check box, TEM creates the
client IIS web application but does not deploy it to
IIS. You can deploy the web application ZIP file in a
separate IIS installation.
IIS Web Site Configuration Contains options for configuring the IIS website.
Use Existing Web Site Specifies you want to use an existing website to host
the Active Workspace application.
If you select this option, select the website you want
to use from the list. The IIS virtual directory for the
.NET web tier deployment is created in the selected
website and the application is hosted on that website.
Create New Web Site Specifies you want to create a new website in which
to host the Active Workspace application.
If you choose this option, type a name, port, and root
path for the new website.
Web Site Name Specifies the name of the new website. The default
value is Teamcenter AWS IIS Web Site.
Web Site Port Specifies the port used by the Active Workspace
application. The default value is 8002.
Web Site Root Path Specifies the path to the Active Workspace application.
The default value is c:\inetpub\wwwroot.
IIS Web Application Pool Contains options for configuring the web application
Configuration pool in IIS.
Use Existing Application Pool Specifies whether to use an existing application pool
from the list provided.
If you use an existing IIS application pool, ensure
that it is a pool created with the version of .NET
that is certified for use with your version of Active
Workspace.
Create New Application Pool Specifies you want to create a new application pool.
Application Pool Name Specifies the name of the new application pool. the
default value is Teamcenter AWS IIS App Pool.
IIS Virtual Directory Configuration Contains options for configuring the virtual directory
for Active Workspace in IIS.

Chapter
Installation
Value Description
Virtual Directory Name Specifies the IIS virtual directory name for the .NET
web application. The default value is awc.
This value is part of the URL used to access the
Active Workspace client. The URL format is:
http://host:port/virtual-dir
host is the machine running IIS.
port is the port used by the IIS website.
virtual-dir is the value you define in the Virtual

Directory Name box.
12. If you selected the Visualization Server Pool Assigner feature in the Features panel, TEM
displays the Visualization Pool Assigner Settings panel. Specify these settings if you use
Visualization in the Active Workspace client:
Value Description
Local Assigner Settings Local assigner settings define the local host as a
Visualization Server Pool Assigner. To define your
local host as an assigner, type the host and port values
of the local host.
Host Specifies the host on which this Visualization Server
Pool Assigner runs as part of the deployed Active
Workspace client web application. You may type the
host name or IP address of the host.
Specifies the port used by the local Visualization
Port
Server Pool Assigner.
Add pool assigner Specifies whether additional Visualization Server Pool
Assigners are used. Select this checkbox only if more
than one Visualization Server Pool Assigner is to be
used. If only one Visualization Server Pool Assigner is
used, do not select this option.
Peer Assigners The Peer Assigners table lists other Visualization
Server Pool Assigners known to the local Visualization
Server Pool Assigners
Assigner Host Specifies the host on which a peer Visualization Server
Pool Assigner is deployed. This value can be the host
name or IP address.
Assigner Port Specifies the port number used by the peer
Visualization Server Pool Assigner.

Installation
Value Description
Teamcenter 4-tier URL Specifies the URL of the Teamcenter web tier
application.
This value is required if TcSS is enabled, but is optional
otherwise.
13. In the Visualization Server Pool Assigner Settings (.NET) panel, type the name of the virtual
directory to be used by the Visualization Pool Assigner.
15. When the installation is complete, close TEM.
Clustered deployment with Microsoft IIS
If you use multiple IIS servers, Active Workspace remains stateless while the Teamcenter web
application maintains its application state through the Microsoft State Server. Configuring Active
Workspace includes setting the Teamcenter four-tier (SOA) URL to that of the cluster entry point at
the Load Balancer, and setting the localServerURL parameter in Active Workspace to the local
Active Workspace deployment host. The following illustration shows an example of a clustered
Active Workspace deployment using IIS.
For more information about Teamcenter clustering in .NET, see .NET web tier advanced settings in
Teamcenter Environment Manager Help in the Teamcenter help collection.

Chapter
Installation

Installation
Sign in using the Active Workspace interface
From a client machine in your environment, sign in using the Active Workspace client. This tests the
environment and the Active Workspace client web application.
1. Sign in to a client machine in your environment.

page on GTAC.
3. Go to the URL:
http://host:port/web-app-name.
host is the machine running the web application server on which the Active Workspace
client web application is deployed.
web-app-name is the virtual directory name, for example, awc.
4. Type a user name and password and click Sign in. Verify that you can sign in without errors.

Chapter
Installation
Indexing
Prepare to install indexing
Before proceeding with installation, be sure you understand the indexing components you want to
install.
• For object data indexing, determine your indexing strategy and then proceed with installing the
Indexing Engine and the Indexer, as described in Active Workspace 3.4 Indexing and Search
Deployment and Configuration.
• For structure data and classification indexing, install Dispatcher.
Dispatcher (optional)
Dispatcher overview
Dispatcher is an asynchronous executor and load balancer of scheduled jobs. It is used only if
Dispatcher-based Indexing Mode is deployed.
These tables are reproduced in the Dispatcher (optional) tab of the InstallChecklist.xlsx
spreadsheet. You can use this spreadsheet, which is distributed in the
Tcversion_ActiveWorkspaceversion_doc.zip file on GTAC, to record your environment's installation
parameters.
Values required before beginning the Dispatcher taskflow

Indexing Engine user name and
password
TC_ROOT Teamcenter installation
TC_DATA Teamcenter installation
SPLM license server port and
SPLM license server installation
host
Teamcenter web tier app
deployment
FSC bootstrap URLs
(http://host:4544)

Installation
Values to record during the Dispatcher taskflow execution

Parameter Where value is defined
Dispatcher root directory Install Dispatcher Server
Dispatcher staging directory Install Dispatcher Server
Dispatcher URL Install Dispatcher Server

Chapter
Installation
Dispatcher prerequisites
Prerequisites for installing the Dispatcher:

• Windows Server operating system (if the Requirements Management PDF translator is used)
• .NET 4.5 (if the Requirements Management PDF translator is used)
Install the Active Workspace patch on the Dispatcher hosts
In order to install the Active Content Structure Translator feature, you must install a supported
version of Teamcenter or Teamcenter Rapid Start and the Active Workspace patch. If the Active
Workspace patch is not installed, this feature is not available in TEM. You must install the Active
Workspace patch on all Dispatcher Server and Dispatcher Client hosts.
servers.

Installation
Install Dispatcher Server
Structure indexing can be run in either Dispatcher-Based Mode or Standalone Mode. If you are going
to use the Dispatcher Mode to run the TcFTSIndexer, you must install the Dispatcher Server feature.
The Dispatcher Server feature can be installed in a new or an existing Teamcenter configuration.
These steps assume you are installing the Dispatcher server on a host with no existing configuration.
If you are installing the Dispatcher Server feature in an existing configuration, launch TEM for that
configuration and proceed to the Features panel which is step 9 in this topic.
For more detailed information on the Dispatcher, see Dispatcher Server Installation in the Teamcenter
documentation.
1. From the GTAC download page, download and unzip:
• The 64-bit software distribution image for your major release version of Teamcenter or
Teamcenter Rapid Start.
Note
Teamcenter 11.x software distribution images contain both Teamcenter and
• The 64-bit software distribution image for the latest minor release for your version of
Teamcenter or Teamcenter Rapid Start.
• The 64-bit software distribution image for Active Workspace 3.4.
Note
If you do not use the latest version of Teamcenter or Teamcenter Rapid Start, see the
Teamcenter Compatibility Matrix to find which earlier versions are supported with
Active Workspace 3.4. On the hardware and software certifications page on GTAC,
under Additional Resources, click the link to Internal Interoperability – Teamcenter
Compatibility Matrix.
3. In the Installer Language window, select a language and click OK.
4. If you are installing Teamcenter/Teamcenter Rapid Start 11.x, the Welcome to Teamcenter
panel prompts you to select Teamcenter or Teamcenter Rapid Start. Select the deployment
option and then click Next.

Chapter
Installation
If you are installing Teamcenter 10.x or Teamcenter Rapid Start 10.x, you do not see this panel.
5. In the Install / Upgrade Options panel, click Install.
Note
In Teamcenter 10.x or Teamcenter Rapid Start 10.x, this panel is titled Welcome to
Teamcenter.

Installation
6. In the Media Locations panel, specify locations of Teamcenter installation media.

The Teamcenter or Teamcenter Rapid Start minor release from which you launched TEM is
listed in the Update Location list.
a. In the Original Media box, add the location of the Teamcenter or Teamcenter Rapid Start
major release software distribution image.
b. In the Update Location box, add the location of the Active Workspace 3.4 software
distribution image.
The Teamcenter or Teamcenter Rapid Start minor release must be listed before the Active
Workspace 3.4 location.
7. In the Configuration panel, enter values for ID and Description. Then click Next.
8. In the Solutions panel, select Dispatcher (Dispatcher Server) and then click Next.

Chapter
Installation
9. In the Features panel, expand Extensions→Enterprise Knowledge Foundation. If you

selected the Dispatcher (Dispatcher Server) solution, note that Dispatcher Server is selected.
If you did not select this solution, or are installing this feature in an existing configuration, select
the feature now.
If you are installing this feature in a new configuration, enter an installation root in the Installation
Directory box.
Click Next.

Installation
10. In the File Client Cache (FCC) panel, define the FMS_HOME environment variable, and click
Next.
11. In the FCC Parents panel, enter the URLs for the FSC servers that the Dispatcher uses as
FCC parents and click Next.

Chapter
Installation
12. In the Operating System User panel, type the password for the operating system account
used to install the Dispatcher and click Next.
13. In the Teamcenter Installation Location panel, provide the TC_ROOT and TC_DATA directories
of the corporate server and click Next.
14. In the Flex License Client panel, provide the port and host of the Teamcenter license server
if it is not already populated and click Next.

Installation
15. In the Teamcenter Administrative User panel, type the user's password.
16. Complete the Dispatcher Components panel.

Chapter
Installation
a. In the Dispatcher Root Directory box, enter the location in which to install the selected
Dispatcher components.
b. Select Install Scheduler (default) and define the Scheduler Port value.
Record the scheduler port value; it is needed later in Active Workspace installation steps.
c. Select Install Module, provide the Staging Directory location, and the Module Port value.
Record the staging directory location, it is needed later in Active Workspace installation steps.
d. Admin Client is not required.
17. In the Dispatcher Settings panel, define settings for logging, installation of Translation Service
documentation, and the method used to start the scheduler and module (Windows service or
command line).

Installation
18. In the Select Translators panel, do not select translators at this time. You install the translators
needed later. Click Next.
19. In the Confirmation panel, click Start.
20. When the installation is complete, click Close.
Install Dispatcher Client (optional)
If you are going to use the ReqMgmtWordToHtmlTrans translator, you must install the
Dispatcher Client feature and create a Dispatcher request rule. (This translator is not required for
Dispatcher-based indexing.)
The Dispatcher Client feature requires the Teamcenter Foundation feature. Therefore, the following
steps assume that the Dispatcher Client feature is being added to an existing corporate server.
1. Launch the TEM from the corporate server to which the Dispatcher Client feature is to be added.
2. In the Maintenance panel, select Configuration Manager and click Next.

configuration and click Next.

Chapter
Installation
4. In the Old Configuration panel, select the configuration to which the Dispatcher Client will
be added and click Next.
5. In the Feature Maintenance panel, select Add/Remove Features and click Next.
6. In the Features panel, expand Extensions→Enterprise Knowledge Foundation, select

Dispatcher Client, and then click Next.
7. The Features window informs you that all Teamcenter service and processes, with the exception
of any FSC services, must be shut down before continuing. Once these are stopped, click
OK in the Features window.
8. In the Teamcenter Administrative User panel, type the user’s password and click Next.
9. Complete the Dispatcher panel.

Installation
a. Select RMI (default).
b. Staging Directory is the location you defined earlier in the Dispatcher Components panel.
c. Type and confirm a password for the dcproxy user. This is a Teamcenter user created to run
the Dispatcher services.
10. In the next Dispatcher panel, specify logging and advanced settings. The defaults are sufficient
for Active Workspace.

Chapter
Installation
Next.

Installation
13. In the Database Template Summary panel, the Translation Service Database Module/Data
Model template is listed. This template is added to the database as part of the Dispatcher
Client feature. Click Next.
16. Sign in to the rich client and open the Access Manager Application.
17. Add a rule under Has Class( POM_application_object ) —> Working with the following setting:
• Set the Condition box to Has Class.
• Set the Value box to DispatcherRequest.
• In the ACL Name box, type DispatcherRequest.
• Type = User
• Accessor = dcproxy
• Write = enabled (blue check mark)
• Delete = enabled (blue check mark)

Chapter
Installation
Install the Active Content Structure Translator
You use the Active Content Structure Translator feature only if you use Dispatcher-based indexing
for structure data. This feature must be installed in the same configuration as the Dispatcher
Server feature.
1. Launch TEM for the Dispatcher Server configuration to which the Active Content Structure
Translator feature is to be added.

4. In the Old Configuration panel, select the corporate server configuration and click Next.
5. In the Feature Maintenance panel, select Add/Remove Features and click Next.
6. In the Features panel, expand Base Install→Active Workspace→Dispatcher→Translators

and select Active Content Structure Translator.
The Active Workspace feature is required. The others are optional and are selectable only if you
select Active Workspace.

Installation
7. In the Indexing Engine User panel, type the Solr administrator’s user name and password,
and click Next. The Solr administrator’s user name and password are defined when installing
the Install Indexing Engine (Solr).
These credentials must match for the Indexing Engine, the Indexer, Server Extensions, and the
Active Content Structure Translator (if used).
8. Complete the TCFTS Indexer Translator panel.

Chapter
Installation
• Teamcenter 4-tier URL

The URL for the Teamcenter web tier application. The format is:
http://host:port/web-app-name
host is the machine running the web application server on which the Teamcenter web
application is deployed.
web-app-name is the name of the Teamcenter web application. The default is tc.
• Teamcenter Retry Count

Specifies the number of tries to connect to the Teamcenter server.
9. In the Active Content Structure Translators Settings panel, define the maximum number of
translations that can run simultaneously and then click Next.
11. When the installation completes, click Close.

Installation
Install ReqMgmtWordToHtmlTrans and AsyncService translators (optional)
You can install the following translators:

• ReqMgmtWordToHtmlTrans
The installation of this translator is optional. It 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
The installation of this translator is optional. This translator provides asynchronous reporting
and printing.
For email notifications, you must set preferences listed at the end of this procedure.
1. Launch TEM for the Teamcenter configuration that contains the Dispatcher Server.

configuration, and then click Next.
4. In the Old configuration panel, select the configuration containing the Dispatcher Server and
then click Next.
5. In the Feature Maintenance panel, select Modify Dispatcher Settings under Dispatcher
Server and then click Next.

Chapter
Installation
6. In the Operating System User panel, type the user's password and click Next.
7. In the Teamcenter Installation Location panel, the TC_ROOT and TC_DATA directories are
populated. Make no changes and click Next.
8. In the Flex License Client panel, the license server information is populated. Make no changes
and click Next.
10. In the Dispatcher Components panel, the values are populated with those defined at installation.
Make no changes and click Next.
11. In the Dispatcher Settings panel, the values are populated with those defined at installation.
Make no changes and click Next.
12. In the Select Translators panel, select translators:

Installation
• If you are going to use Requirements Management, select the ReqMgmtWordToHtmlTrans

translator under Document Management (DocMgt) Translators. It 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.
After installation, there are additional steps to configure prerequisites for requirements.
• To provide asynchronous reporting and printing, select the AsyncService translator under
Asynchronous Service Translator.
Additional configuration for asynchronous services is described in Configuring asynchronous
services in the Teamcenter help collection.
For email notifications, you must set preferences listed at the end of this procedure.
13. In the Translator Settings panel, the User and Password boxes appear only if you selected the
ReqMgmtWordToHtmlTrans translator. This user must be in the dba group.

Chapter
Installation
16. If you installed the AsyncService translator and are setting up email notifications, you must
set these 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
host is the machine on which the web application server is running.
port is the port value used by the web application server.
• WEB_DEFAULT_SITE_DEPLOYED_APP_NAME = tc-web-tier-app
tc-web-tier-app is the name of the Teamcenter web tier application, for example, tc.
17. For asynchronous notification to be sent to users, the TC_MESSAGING_MUX_URL variable in

the TC_DATA\tc_profilevars file must be set on each server in your environment. This variable
defines the address of a MUX in a Teamcenter four-tier environment.
Asynchronous notification sends messages from the business logic server and other server
programs to the MUX, which sends these messages to the web tier. If the business logic server
and other server programs do not have the address of a MUX, they cannot send messages for
asynchronous notification.
In server configurations that have a Teamcenter server manager installed, this variable is set
during installation. But, in server configurations that do not have a Teamcenter server manager,
this variable must be set manually.

Installation
For example, a Dispatcher Module or Subscription Manager daemon installed in a server

configuration that does not have a Teamcenter server manager installed will not have the
TC_MESSAGING_MUX_URL variable set. You must manually set this variable in the
TC_DATA\tc_profilevars file.
The variable format is:
TC_MESSAGING_MUX_URL=protocol://host:mux_port
host is the machine on which the Teamcenter server manager is installed.
mux_port is the value set for the MUX port when installing the Teamcenter server manager.
On Windows servers, add this line to the \tc_profilevars file:

if not defined TC_MESSAGING_MUX_URL set
TC_MESSAGING_MUX_URL=protocol://host:port
On UNIX and Linux servers, add this line to the /tc_profilevars file:
TC_MESSAGING_MUX_URL=${TC_MESSAGING_MUX_URL:=protocol://host:port

Chapter
Installation
Install Axis for ReqMgmtWordToHtmlTrans translator
This step is required only if you are using the ReqMgmtWordtoHtmlTrans translator with Active
Workspace. Before installing Axis, the Dispatcher Server and Dispatcher Client must already
be installed.
1. From the installation media for the base Teamcenter release, navigate to
\additional_applications\dispatcher\axis and locate the axis.zip file.
2. Extract axis.zip to the dispatcher_root\DispatcherClient\lib directory.

The dispatcher_root is the Dispatcher root installation directory, not the TC_ROOT installation
directory.
3. In a plain text editor, open the dispatcher_root\DispatcherClient\conf\DispatcherClient.config

file.
4. Uncomment the following line by removing the # character:

#Axis.Port=8080
5. Ensure that the Axis port is not used by any other application.
6. Save and close the file.
7. Launch the rich client and choose Edit→Options.
8. Search for the SyncDispatcherClientUrl site-level preference.
9. Set the value of the preference to the Axis URL. The format of this URL is:
http://host:port/axis2/services/AxisDispatcherClient.AxisDispatcherClientHttpSoap12Endpoint
host is the machine on which Axis is installed.
port is the port value used by Axis. You defined this by setting the Axis.Port property in
the DispatcherClient.config file.
10. Start the Dispatcher Scheduler, Module, and Client:

a. Run dispatcher_root\Scheduler\bin\runscheduler.bat to start the Dispatcher Scheduler.
b. Run dispatcher_root\Module\bin\runmodule.bat to start the Dispatcher Module.
c. Run dispatcher_root\DispatcherClient\bin\runDispatchClient.bat to start the Dispatcher

Client.
11. Open a web browser and go to the Axis URL:

Installation
http://host:port/axis2/services/AxisDispatcherClient.AxisDispatcherClientHttpSoap12Endpoint
host is the machine on which Axis is installed.
port is the port value used by Axis. You defined this by setting the Axis.Port property in
the DispatcherClient.config file.
12. Verify that Submit is one of the available options.

Chapter
Installation
Testing TcFTSIndexer connectivity
Test TcFTSIndexer connectivity

You need to ensure that the Teamcenter user running the runTcFTSIndexer utility can sign in to the
database and that all the indexing systems are running.
1. The default user that runs the utility is infodba, as defined in the Tc.user setting in the
TC_ROOT/TcFTSIndexer/conf/TcFtsIndexer.properties file.
2. When running in a Security Services protected environment, this user must also be a valid user
that Security Services can authenticate in the LDAP server.
a. If you are using multiple TCCS Security Services application IDs, make sure they are
configured correctly.
You can configure multiple application IDs using the Environment Settings for Client
Communication System panel in Teamcenter Environment Manager (TEM).
b. Ensure that the user defined by the Tc.user setting in the

TC_ROOT\TcFTSIndexer\conf\TcFtsIndexer.properties file is a valid user in the LDAP
server and the Teamcenter database. Create a user in both if needed or select an existing
valid active user to run the runTcFTSIndexer utility.
Note
If you create a new user, create an encrypted password file by setting an
environment variable, within the console, to the password value, for example:
set mytcenv=password
Then run the encryptPass.bat/sh utility with the -tc argument specifying the
environment variable name created, for example:
encryptPass -tc mytcenv
Then run the utility for the LDAP password used by the TcFTSIndexer user.
The encryptPass.bat/sh utility is located in the TC_ROOT\TcFTSIndexer\bin
directory.
After creating the encrypted password file, remove the password variable.
3. Ensure that the following are running:

Installation
• Teamcenter database
• Solr
• Web application server hosting the Teamcenter web tier application
• Web application server hosting the Active Workspace web application
• Server manager
• Dispatcher Scheduler (only if Dispatcher-based indexing is used)

Start the Dispatcher Scheduler by running:
DispatcherRoot\Scheduler\bin\runscheduler.bat
• Dispatcher Module (only if Dispatcher-based indexing is used)

Start the Dispatcher module by running:
DispatcherRoot\Module\bin\runmodule.bat
4. On the machine on which the Indexer feature is installed, open a command prompt.
5. Navigate to the bin directory of the TcFTSIndexer, for example, TC_ROOT\TcFTSIndexer\bin.
6. To test the TcFTSIndexer’s connectivity, run the command:

runTcFTSIndexer -task=objdata:test
7. Verify that there were no errors.
Example: Test Standalone Indexer for structure data

1. For stand-alone indexing, to test structure data connectivity, type the following command:
runTcFTSIndexer -task=structure:test
Following is an example of the successful output:

2015-03-30 12:32:19,668 INFO - Running TcFtsIndexer Type: structure FlowAction: test
2015-03-30 12:32:32,117 INFO - Teamcenter 4 tier server status: OK
OS name is Windows Server 2008 R2
JVM vendor is Oracle Corporation
Data model is 64
2015-03-30 12:32:32,180 INFO - FMS status: OK
2015-03-30 12:32:32,534 INFO - Solr server status: OK
2015-03-30 12:32:34,927 INFO - Downloading 'FTSIndexer Files' Dataset files for 'structure'
indexer...
2015-03-30 12:32:36,455 INFO - Downloading 'FTSIndexer ACE Files' Dataset files for 'structure'
indexer...
2015-03-30 12:32:36,576 INFO - Download transform files: OK
2015-03-30 12:32:36,576 INFO - All tests successful.
2015-03-30 12:32:37,222 INFO - Total time for all Steps 4 sec
2015-03-30 12:32:37,223 INFO - Overall Time 5.181 sec
2015-03-30 12:32:37,224 INFO - Done processing Type: structure FlowAction: test
Following is an example of the output with errors:

Data model is 64

Chapter
Installation
indexer...
indexer...
2014-07-27 18:32:39,138 ERROR - The search engine schema is not correct.
2014-07-27 18:32:39,172 ERROR - U147714b22d47c0a8c2800003 has errors in Step teststructurestep Flow
testflow
2. Verify that there were no errors. If you encounter errors, resolve them.
Example: Test Dispatcher-based Indexer for structure data
1. For Dispatcher-based indexing, to test structure data connectivity, type the following command:
runTcFTSIndexer -dispatcher -task=structure:test
Following is an example of the successful output:

Data model is 64
indexer...
indexer...
2015-03-30 12:41:34,450 INFO -
2015-03-30 12:41:34,451 INFO - Connected to Scheduler on Url rmi://lm6s003:2001
2015-03-30 12:41:35,500 INFO - Dispatcher configuration: OK
2. Verify that there were no errors. If you encounter errors, resolve them.

Installation
Set up TcFTSIndexer scheduling

After running the initial index, you can set up indexing to synchronize at specified intervals.
1. Navigate to the TC_ROOT\TcFTSIndexer\bin directory on the machine where the Active
Workspace Indexer is installed.
2. If you are using multiple types of indexing (for example, object indexing and structure indexing),
the TcFTSIndexer process must be started in service mode as shown in this step. If you are
using object indexing only, skip to the next step.
To start the TcFTSIndexer in service mode, use the -service option. Using the -service option
keeps the TcFTSIndexer process running so that multiple types of indexing operations can run
concurrently. For example:
runTcFTSIndexer -service
3. Enter runTcFTSIndexer -task=objdata:sync -interval=x, where x is the number of seconds

greater than 0 to wait before rerunning the synchronization operation.
For example, to wait 25 seconds, type:
runTcFTSIndexer -task=objdata:sync -interval=25
If the -service option was previously used, the command is sent to the service and the service
runs it. Otherwise, the action runs in the current process.
4. To stop the TcFTSIndexer process, choose one of the following:

• To stop the process after all flows stop running, type runTcFTSIndexer -stop, and then
type runTcFTSIndexer -status.
When these commands return that no flows are running, the process is stopped. You may
need to wait a period and repeat this command to give the process time to stop. The service
is still running.
• To stop the service and then shut it down, type runTcFTSIndexer -shutdown.
After flows are allowed to complete, the service is stopped.
5. You can run the TcFTSIndexer service in a new window. In this example, the -service argument
starts the service.
Start object data synchronization using the desired interval. In the following example, the interval
is 25 seconds.
runTcFTSIndexer -task=objdata:sync -interval=25

Chapter
Installation
Configure Classification Search (optional)
Note
This step is required only if you want to search for classification data in Active Workspace
or Teamcenter Manufacturing Access.
After you configure or reconfigure classification search, you must reindex.
Indexing of standalone classification is supported beginning with Teamcenter 11.2.3.
1. In Teamcenter rich client Classification, verify that classified data is available. Classification
should contain a structure of classes with attributes and classified objects.
For more information see the Teamcenter Classification documentation.
2. Choose one of the following to define the classification properties you want to index.
• To select all classes, attributes, and filters, run the smlutility utility. For example, from a
Teamcenter command window, type:
smlutility -create_indexing_views -u=username -p=password -g=dba
A search index view is created for each class in Classification Admin. All attributes of the
class are assigned to the view. You can only run this command once for a class.
• To define specific classification properties:

a. Set the ICS_searchindex_view_visible preference to TRUE.
b. In the Teamcenter rich client Classification Admin, the Add View operation now
includes the Search Index View option.

Installation
Class attributes for these classes are not yet configured for indexing or filtering.
For a class to be available for indexing and filtering, the class must contain a search
index view, at least one attribute, and at least one classified object.
c. In the Teamcenter rich client Classification Admin, select the search index view for a
class and select the View Attributes tab.
d. Add all attributes that you want included in the indexing to the View Attributes list.
Note
You cannot add linked attributes to search index views, since these attributes
can be directly searched via the object properties they are linked to.
e. Individually, in the View Attributes list: select a attribute, choose Edit Current Instance
(blue key), select the Filter check box, and click Save Current Instance.
The attributes are available to filtering after it is indexed.

Chapter
Installation
3. Enable Classification Search.

a. Open a Business Modeler IDE project that contains the foundation and aws2 templates.
b. Set the following business object constants in Business Modeler IDE:

• Turn on the Classification Search feature by setting the
Awp0SearchClassifySearchEnabled business object type constant to true at the
workspace object level.
• Specify that Classification data is indexed by setting the

Awp0SearchIsClassifyDataIndexed business object type constant to true at the
item and item revision level.
The object type on which it is set is indexed for searching. All subtypes inherit the setting.
• Check that search data is indexed. Be sure that the Awp0SearchIsIndexed business
object type constant is set to true at the item and item revision level.

Installation
Note
Do not set this constant at the workspace level since this causes your
database to no longer be indexable.
Instead set it true for each object that you want to index. For example item
and item revision.
c. Deploy the Business Modeler IDE changes using either a cold deploy or hot deploy. See the
Business Modeler IDE documentation for details and recommendations.
If a hot deploy is used, you must also run the bmide_modeltool. For example, in a
Teamcenter command window type:
bmide_modeltool -u=username -p=password -tool=all -mode=upgrade
-target_dir="%TC_DATA%"
4. Verify the deploy completed correctly.

a. From a Teamcenter command window, type:
gettypeconstantvalue -u=username -p=password -g=dba
-typename=WorkspaceObject -constantname=Awp0SearchClassifySearchEnabled
b. Verify that the tc_solr_schema.xml file in the TC_DATA\ftsi\solr_schema_files folder has

the current date and time.
c. Open the tc_solr_schema.xml file in a text editor search for 0Y0_CLASSIFICATION_0Y0.

You should find several lines containing this string. Close the text editor without saving.
5. Stop the solr and indexer services.
6. Merge the Teamcenter and Solr schemas. For example, run this utility from a Teamcenter
command window:
TcSchemaToSolrSchemaTransform "%TC_DATA%\ftsi\solr_schema_files
Changes to the tc_solr_schema.xml applied to the Solr schema.xml file.
7. Restart the solr service.
8. Verify the schema merge completed correctly.

a. Verify that the schema.xml file in the SOLR_HOME\server\solr\collection1\conf folder has
b. Open the schema.xml file in a text editor search for 0Y0_CLASSIFICATION_0Y0. You
should find several lines containing this string. Close the text editor without saving.
c. Repeat these steps for other collections in the solr folder.
9. Re-index search data. For example, for environments not running dispatcher, a Teamcenter
command window:
runTcftsIndexer -task=objdata:clear

Chapter
Installation
Type 4 and enter Y twice.

runTcftsIndexer -task=objdata:index
If working in an environment running the dispatcher, add the -dispatcher parameter to the
command.
Each time you modify existing classification classes or views, or create new ones on top of them,
you must update your template, merge the schema files, and reindex the search data.
10. Verify that indexing was successful. Indexing follows these steps:
a. Check the log file located in the TC_ROOT\TcFTSIndexer\logs folder.
b. Generate a list of all objects to be indexed including its ID and type. Verify that there is
nothing unexpected in the list that would cause an error.
runTcftsIndexer -task=objdata:index -listIDs=C:\temp\list.txt
c. The TcFTS indexer follows a specific sequence which is displayed in the window running
the indexer. For example:
...
Query found 18 objects in 0.556 seconds ***
Export of 18 objects in (secs): 2.989 ***
Transform time (sec) 0.942 ***
Load time (secs): 0.37 seconds ***
...
• Query — The indexer examines the object types to be indexed and determines what has
changed. Changes include created, modified, or deleted objects.
• Export — The indexer exports the changes to a tcxml_<number>xml file.
• Transform — The indexer transforms the tcxml_<number>xml file into

Solr format creating a solr_<number>xml file. Both files are placed in the
TC_ROOT\TcFTSIndexer\working\TcFtsIndexer_objdata\<number>\result folder.
• Load — The indexer loads the changes into the Solr database. The Solr data can then
be displayed in the filter dialog box in Active Workspace and Teamcenter Manufacturing
Access.
11. Restart scheduled indexer syncing.
Note
Reindexing was required because you changed the schema. For this point forward,
changes to your data are captured by scheduling regular syncing of the database with
the runTcftsIndexer command.

Installation
12. In Teamcenter Environment Manager, update the Active Workspace client settings.
Visualization Server
Visualization Server overview
The Visualization Server provides dynamic 3D visualization functionality to the Active Workspace
client. If you do not intend to use the 3D viewer in Active Workspace, do not install the Visualization
Server.
The Visualization Server comprises two components:
Visualization Server Manager
The Visualization Server Manager (VSM) starts and stops rendering processes as needed and
streams visualization data to the Active Workspace client.
The Visualization Server Manager is required for any use of the 3D viewer in Active Workspace.
Visualization Data Server
For appropriately indexed product configurations, the Visualization Data Server (VDS) does the
following to promote faster rendering and streaming to the Active Workspace client:
• Caches product structure
• Prepopulates JT files in the FCC
• Computes Massive Model Visualization (MMV) spatial hierarchies
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.

Chapter
Installation
Visualization Server Manager
Visualization Server Manager overview
The Visualization Server Manager (VSM) starts and stops rendering process as needed and streams
visualization data to the Active Workspace client.
Note
If you are installing the Visualization Server Manager, you must also install the
Visualization server extensions feature on the corporate server and on any server that
has the Foundation feature installed.
You can use the following tables to record your environment's installation parameters. The tables
are in the Vis Server Manager (optional) sheet of the InstallChecklist.xlsx workbook, which is
distributed by GTAC in the Tcversion_ActiveWorkspaceversion_doc.zip.
Values required before beginning the Visualization Server Manager taskflow

FCC parents Teamcenter installation
Build the Java EE Client web
application
Visualization Pool Assigner
or
host and port
Visualization Data Server
Install the Visualization Data
host and port (if VDS is to be
Server
installed)
Values to record during the Visualization Server taskflow execution

None

Installation
Prerequisites for the Visualization Server Manager
Visualization Server Manager prerequisites:

• Installation of the Visualization server extensions feature on the corporate server and on any
server that has the Foundation feature installed.
• Windows Server 64-bit 2012 R2 or Windows Server 64-bit 2008 R2.

Some graphics cards are not supported on Windows Server 64-bit 2008 R2.
• Server class hardware using the following graphics cards:

o NVIDIA GRID K1, K2, or Tesla M60 as certified by NVIDIA.
M60 is not supported on Windows Server 64-bit 2008 R2.
Note
Windows Server 2012 R2 supports a maximum of 8 GPUs.
Example
When booting Windows Server 2012 R2 with a legacy VGA device and two or more
NVIDIA GRID K1 cards, one of the NVIDIA GPUs is unavailable for use.
For details on supported graphics cards, open the Hardware (Graphics Card) Certifications
document under Additional Resources on the hardware and software certifications page on
GTAC, and refer to the Active Workspace tab.
For information about other NVIDIA server hardware compatible with the GRID graphics cards,
see www.nvidia.com/buygrid.

Chapter
Installation
Warning
Supported hardware is suitable for a production environment. Other hardware may
work with Active Workspace, but Siemens PLM Software accepts problem reports only
for issues that are reproducible on a supported configuration.
Production deployments — Production deployments require the Visualization Server

Manager to run on the full direct (non-virtual) hardware with supported graphics cards.
This is also true for MMV installations.
Demonstration or evaluation installations — You may run the Visualization Server

Manager on a virtual machine for demonstration or evaluation purposes, but only in
cases where MMV data is not being used. An installation on a virtual machine is not a
supported production configuration. If you run a virtual environment, acceptable GPU
performance and functionality requires assigning an NVIDIA GRID graphics card to the
virtual machine using a hypervisor such as the Citrix XenServer or NVIDIA Hypervisor.
When the NVIDIA GRID graphics card is not assigned properly to the virtual machine,
the graphics performance is extremely poor. If you are not experienced in running
virtual machines with NVIDIA GRID graphics cards, we recommend that you do not
attempt to run the Visualization Server Manager in a virtual machine.
Install the Active Workspace patch on the Visualization Server Manager host
In order to install the Visualization Server Manager, you must install a supported version of
Teamcenter or Teamcenter Rapid Start and the Active Workspace patch. If the Active Workspace
patch is not installed, these features are not available in TEM.
servers.
Note
Siemens PLM Software recommends that you install the Visualization Server Manager on
a machine that does not have a Teamcenter corporate server.

Installation
Install the Visualization Server Manager
The Visualization Server Manager can be installed in a new or an existing configuration. Siemens
PLM Software recommends that you install the Visualization Server Manager on a machine that does
not have a Teamcenter corporate server. These steps assume that there is no existing corporate
server configuration.
1. Ensure that the Visualization server extensions feature has been installed on the corporate
server and on any server that has the Foundation feature installed.

Note
• The 64-bit software distribution image for the latest minor release for your version of
Note
Active Workspace 3.4. On the hardware and software certifications page on GTAC
(hardware and software certifications), under Additional Resources, click the link to
Internal Interoperability – Teamcenter Compatibility Matrix.
4. In the Installer Language dialog box, select the installation language and then click OK.

Chapter
Installation
Note
Teamcenter.
7. In the Media Locations panel, specify locations of Teamcenter installation media.

Installation
distribution image.
9. In the Solutions panel, make no selections and click Next.
10. In the Features panel, expand Base Install→Active Workspace→Visualization Server, select
the Visualization Server Manager feature. In the Installation Directory, enter the location in
which to install the Visualization Server Manager.
Click Next.

Chapter
Installation
11. In the File Client Cache (FCC) panel, set the FMS_HOME environment variable.
12. In the FCC Parent panel, define the list of FSC parents to which the Visualization Server
Manager connects. You must provide protocol, host, and port of the FSC parent. To add rows to
the table, click Add.

Installation
If you are using a Visualization Data Server, the Visualization Data Server and the Visualization
Server Manager should use the same FSC.
13. In the top section of the Visualization Server Manager panel, provide values for the Visualization
Server Manager.
• Local Host Alias
Specifies the alias for the local Visualization Server Manager.
• Server Host

Chapter
Installation
Specifies the host where the Visualization Server Manager is running. This must be the local
machine name and must be resolvable by the Visualization Pool Assigner machine (the
machine running the awc.war file). Do not use localhost or 127.0.0.1.
• Server Port
Specifies the port on which the Visualization Server is listening.
• Max Servers in Sub-Pool

Specifies the maximum number of Visualization server processes allowed to run in this pool
(for a single-host configuration) or in this subpool (for a multihost configuration).
• Min Warm Servers

Specifies the minimum number of Visualization server processes in this pool that are started
but not assigned.
Note
If necessary to maintain the minimum number of warm servers, while not
exceeding the maximum number of server processes, the server manager times
out servers in use.
14. If you are using a Visualization Data Server, provide the values for this server in the bottom
section of the Visualization Server Manager panel.
You use a Visualization Data Server to improve performance by caching product structure and JT
parts files.

Installation
• Add Visualization Data Server

Select this if you are using a Visualization Data Server.
• Host
Type the name of the host on which the Visualization Data Server is installed.
• Port
Type the port value used by the Visualization Data Server.
15. In the Visualization Server Manager Setting panel, define the settings for how the Visualization
Server Manager communicates with the pool assigners.

Chapter
Installation
• Override local node settings

Select to override the host name and port value. Enter the Host and Port values of the
local machine.
• Visualization Server Pool Assigners

Lists the pool assigners that this Visualization Server Manager uses.
o Assigner Host
Host name of the machine where the pool assigner is running. This is the machine on
which the Active Workspace web application is deployed.
o Assigner Port
Port value of the pool assigner.
16. In the Operating System User panel, type the user’s password and click Next.

Installation
Start the Visualization Server Manager
To start the Visualization Server Manager, run:

TC_ROOT\vispoolmanager\run_visservermgr.cmd
When running run_visservermgr.cmd, you can use Windows Remote Desktop Connection to sign in
to the machine on which the Visualization Server Manager is installed if you have an NVIDIA card with
a driver version of 340.66 or later. Other remote access products, such as VNC, also can be used.
After running run_visservermgr.cmd, you can lock the machine, but you must remain logged on.
If you sign out, the Visualization Server Manager is shut down. The Visualization Server Manager
requires access to the graphics card and consequently cannot run as a Windows service due to
operating system limitations.
Optional: Configure Windows automatic logon and VSM restart

You can configure Windows to automatically log on and restart the Visualization Server Manager In
the event of a system reboot.
This procedure is applicable for Windows 7, 8, 8.1, and Server 2012 R2.
Caution
Enabling automatic logon is not a good general practice because it 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. Only use automatic logon when the
system is in a secure environment.
1. Press the Windows key+R to display the Run dialog box.
2. In Open, type netplwiz.
3. Click OK.
The User Accounts dialog box is displayed.
4. Select a user account from the list.
5. Clear the Users must enter a user name and password to use this computer check box.
6. Click Apply.
The Automatically sign in dialog box is displayed.
7. In the Password and Confirm Password boxes, type the user's password.

Chapter
Installation
8. Click OK.
Now the specified user is automatically logged on when Windows is started.
9. Create a script or batch file to launch the Visualization Server Manager. Include the following
command to lock the workstation:
rundll32.exe user32.dll LockWorkStation
10. Create a new task with Windows Task Scheduler to run the script or batch file at log on.
Visualization Data Server (if used) and Client tasks must be complete
Before you can proceed to the next task in the Visualization Server taskflow, all tasks in the Client
taskflow must be complete.
Test Visualization from the Active Workspace client interface
You can test the Visualization Server by logging on with the Active Workspace interface and viewing
Visualization data, for example, a JT file.
1. Ensure that the following are running:
• Visualization Server Manager
• Web application server hosting the Active Workspace web application
• Web application server hosting the Teamcenter web tier application
• Server manager
• Teamcenter database

page on GTAC.
3. Go to the URL:

Installation
http://host:port/awc
host is the machine running the web application server on which the awc.war file is deployed.
4. Type a user name and password and click Sign in.
5. Search for and open an object that has an attached JT file.
6. Click the Viewer tab to display the JT file.

Chapter
Installation
Visualization Data Server (optional)
Visualization Data Server overview
For appropriately indexed product configurations, a Visualization Data Server (VDS) does the
following to promote faster rendering and streaming from a Visualization Server Manager (VSM) to
an Active Workspace client:
• Caches product structure
• Prepopulates JT files in the FCC
• Computes Massive Model Visualization (MMV) spatial hierarchies
Note
MMV is a visualization technology that uses Visibility Guided Rendering (VGR) to
increase performance and scalability for the viewing of extremely large 3D models,
such as cars, airplanes, and ships. Models of this size typically consist of a massive
amount of geometry arranged in a relatively compact space with a huge amount of
internal geometry hidden behind the “outer shell” of the product. It can take hours to
display such models in their entirety, because every piece of geometry in the model
needs to be retrieved and processed, which far exceeds the capability of today’s
commonly available hardware. MMV technology resolves this problem by leveraging
VGR techniques to load only those parts required to render a given scene; parts that
are not visible because they are occluded by other parts in the foreground are not
loaded. As a result, large 3D models become visible in a fraction of the time previously
required.
Visualization of MMV data in the Active Workspace client requires an MMV license. If
the necessary license is not present, the full model loads as standard JT data.
A single Visualization Data Server can support one or more Visualization Server Managers.
A Visualization Data Server is required for implementation of MMV, but is otherwise optional.
You can use the following tables to record your environment's installation parameters. The tables are
in the Vis Data Server (optional) sheet of the InstallChecklist.xlsx workbook, which is distributed
by GTAC in Tcversion_ActiveWorkspaceversion_doc.zip.
Values required before beginning the Visualization Server taskflow

FCC parents Teamcenter installation
Teamcenter four-tier URL Teamcenter installation

Installation
Values to record during the Visualization Server taskflow execution

Visualization Data Server host Install the Visualization Data
and port Server
Indexing structures for Visualization Data Server
If a structure has more than 120,000 BOM Lines, MMV rendering is required for scalability and
performance. If a structure has more than 30,000 BOM Lines, MMV is recommended.
To use the Visualization Data Server to compute Massive Model Visualization (MMV) spatial
hierarchies of structures, you must
1. Apply the MMV index structure flag to the product configurations that you want to view using MMV.
2. Use the bomindex_admin utility to include the configurations in the list of structures to index.
To take advantage of the structure and JT pre-caching feature of the Visualization Data Server for
improved visualization performance of structures that are not indexed for MMV, you must
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.

Chapter
Installation
Prerequisites for the Visualization Data Server
Visualization Data Server prerequisites:

• Installation of the Visualization server extensions feature on the corporate server and on any
server that has the Foundation feature installed.
• A Visualization Server Manager installed on the host where you want to install the Visualization
Data Server.
• Windows Server 64-bit 2012 R2 or Windows Server 64-bit 2008 R2.
• The machine hosting the Visualization Data Server should have a minimum of 16 GB of RAM,
but may require more. 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 PLM 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.
• Siemens PLM Software recommends that you install the Visualization Data Server on a machine
with 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.
• Virtual machine deployment is supported.
• There are no graphics card requirements.
• You must deploy the Visualization Data Server on a high speed LAN near the Visualization
Server Manager.
• Siemens PLM Software recommends that you deploy the Visualization Data Server near or on
a machine hosting an FSC cache or FSC volume. If you deploy the Visualization Data Server
remote (on a WAN) from the FSC volume, you should deploy an FSC cache on a LAN near or on
the Visualization Data Server host machine.
• You must deploy an FMS Client Cache (FCC) component on the machine hosting the
Visualization Data server.
For maximum performance, the Visualization Data server should be installed on the same
machine as the Visualization Server, and should use the same cache.

Installation
• Structure indexing must be set up. The Visualization Data Server uses the structure indexing
infrastructure of Active Workspace to keep cached product structure up to date.
Install the Active Workspace patch on the Visualization Data Server host
In order to install the Visualization Data Server, you must install a supported version of Teamcenter
or Teamcenter Rapid Start and the Active Workspace patch. If the Active Workspace patch is not
installed, these features are not available in TEM.
servers.
Note
Siemens PLM Software recommends that you install the Visualization Server Manager on
a machine that does not have a Teamcenter corporate server.
Install the Visualization Data Server
The Visualization Data Server can be installed in a new or an existing configuration. Siemens
PLM Software recommends that you install the Visualization Data Server on a machine that does
not have a Teamcenter corporate server. These steps assume that there is no existing corporate
server configuration.
1. Ensure that the Visualization server extensions feature has been installed on the corporate
server and on any server that has the Foundation feature installed.


Chapter
Installation
Note
• The 64-bit software distribution image for the latest mninor release for your version of
Note
Active Workspace 3.4. On the hardware and software certifications page on GTAC,
under Additional Resources, click the link to Internal Interoperability – Teamcenter
Compatibility Matrix.
4. In the Installer Language dialog box, select the installation language and then click OK.

Installation
Note
Teamcenter.
7. In the Media Locations panel, you specify locations of Teamcenter installation media.

Chapter
Installation
distribution image.
9. In the Solutions panel, make no selections and click Next.
10. In the Features panel, expand Base Install→Active Workspace→Visualization Server, select
the Visualization Data Server feature. In the Installation Directory box, enter the location in
which to install the Visualization Data Server.
Click Next.
11. In the Prerequisite Checks panel, you run checks to ensure that the required RAM needed for
the Visualization Data Server is available. Enter a location in which to create the log files for the
prerequisite check and click Run.

Installation
12. Inspect the test result. If the check result in a status of Fail, you must correct the issues before
proceeding. The Next button is unavailable until the check has a status of Pass or Warning.
Click View for an analysis of a failure or warning. Click Review for a summary of all checks.
Visualization Data Server Free RAM Availability Check verifies that the machine has the
recommended minimum of 16 GBs of free physical RAM. If this recommendation is not met, the
result is a warning and you are not prevented from proceeding.

Chapter
Installation
13. Once the check result is either Pass or Warning, the Next button is available. Click Next.
14. If the prerequisite check resulted in a warning, the Confirm Warnings window displays the
warnings. To continue, click the check box next to the warning and then click OK.

Installation
15. In the File Client Cache (FCC) panel, set the FMS_HOME environment variable. The FCC must
be installed on the same machine as the Validation Data Server.

Chapter
Installation
16. In the FCC Parent panel, define the list of FSC parents to which the Visualization Data Server
connects. You must provide protocol, host, and port of the FSC parent. To add rows to the
table, click Add.
To improve performance, the Visualization Data Server and the Visualization Server Manager
should use the same FSC.
17. In the Teamcenter Administrative User panel, enter the user's password and then click Next.
18. Complete the Visualization Data Server Configuration panel.
• Server Port
This is the port number on which the Visualization Data Server listens.

This is the URL of the Teamcenter web tier application. The format is:
http://host:port/tc-web-app

Installation
tc-web-app is the name of the Teamcenter web application. The default is tc.

Chapter
Installation
Start the Visualization Data Server
To start the Visualization Data Server Manager, run:

TC_ROOT\VisDataServer\Program\VisDataServer.exe
After the Visualization Data Server is started, it automatically detects and caches product
configurations that have been indexed with the MMV flag. These cached product configurations are
now ready for fast visualization with the MMV technology.
A product configuration is ready for MMV visualization after it has been indexed, the Visualization Data
Server has detected, downloaded and cached the structure, and prepopulated the FMS system. If
you attempt to visualize a product configuration that is not yet completely indexed and cached in
the Visualization Data Server, the viewer will default to the regular non-MMV mode. Changes in the
product configuration need to be re-indexed and re-read by the Visualization Data Server before
they can be displayed by the viewer.
Additional configuration for the Visualization Data Server is available in the
etc/VisDataServer.properties file. This includes detailed logging and fine tuning of other settings. If
you make changes to the properties file, you need to restart the Visualization Data Server.

Installation
Active Workspace Launcher

Install Client for Office and Active Workspace Launcher
To work with Microsoft Office documents in the Client interface, you must install Microsoft Office,
Teamcenter Client for Microsoft Office, Teamcenter Extensions for Microsoft Office, and Active
Workspace Launcher on the end-user machine.
Note
Teamcenter Client for Microsoft Office requires .NET 3.5 SP1 (for Teamcenter 10.1.x) or
.NET 4.0 (for Teamcenter 11.2.x). Active Workspace Launcher requires .NET 4.5. The older
.NET version must be installed before the newer .NET version. Follow the steps below in
the order indicated, to ensure that the .NET versions are installed in the correct order.
1. Install Microsoft Office.
2. Install and patch Teamcenter Client for Microsoft Office:

a. Install Teamcenter Client for Microsoft Office using the software distribution image for your
major release version of Teamcenter or Teamcenter Rapid Start.
Refer to Windows Client Installation→Installing Microsoft Office interfaces→Installing
Teamcenter Client for Microsoft Office in the Teamcenter help collection.
b. Patch Teamcenter Client for Microsoft Office using the software distribution image for the
Teamcenter or Teamcenter Rapid Start minor release you use.
Double-click Tcrelease_wntx64\wntx64\additional_applications\OfficeClient\setup.exe.
3. Install and patch Teamcenter Extensions for Microsoft Office:

a. Install Teamcenter Extensions for Microsoft Office using the software distribution image for
your major release version of Teamcenter or Teamcenter Rapid Start.
Refer to Windows Client Installation→Installing Microsoft Office interfaces→Installing
Teamcenter Extensions for Microsoft Office in the Teamcenter documentation.
b. Patch Teamcenter Extensions for Microsoft Office using the software distribution image for
the Teamcenter or Teamcenter Rapid Start minor release you use.
Double-click
Tcrelease_wntx64\wntx64\additional_applications\tc_ext4mso\tc_ext4mso.exe.
4. Install Active Workspace Launcher:

a. In the Teamcenter minor release software location, run
Tcrelease_wntx64\wntx64\additional_applications\TcClientAppLauncher\setup.exe.
b. In the Welcome dialog box, click Next.
c. In the License Agreement dialog box, accept the license terms, then click Next.
d. In the Ready to Install the Program dialog box, click Install.

Chapter
Installation
e. In the InstallShield Wizard Complete dialog box, click Finish.
5. Install .NET 4.5. It is required by the Active Workspace Launcher during runtime.
6. To enable the editing of requirements in the Active Workspace client, 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
2. To install the Active Workspace launcher silently on another system, type the following command:
setup.exe /s /f1 c:\tclauncher.iss
Troubleshoot the Teamcenter Active Workspace Launcher installation

If the appropriate Microsoft Office application fails to launch when opening an attachment, the .awoai
file may be associated to be opened in Microsoft Word directly. To resolve this, try these two tasks:
• Uninstall and reinstall the Teamcenter Active Workspace Launcher and try again.
• Look at the HKEY_CLASSES_ROOT\.awoai\shell\Open\command listing in the registry editor

to verify the .awoai file is correctly associated to the TcClientApplauncher.exe command.
Install classification libraries

Prerequisites:
• The Classification Library Management feature must be installed and configured on Teamcenter.
• The presentation layer must be created with the clsutility.
• The library data must be created with the lbrmanager utility.
For more information, see Classification Admin in the Teamcenter Help collection.
The following displays the interaction of the various components necessary to use Classification
in Active Workspace:

Installation
• Server
o To install the server components for classifying objects and searching for classified objects:
Select Active Workspace→Server Extensions→Reuse and
Standardization→Classification Server.
o To install the server components necessary for enabling visual navigation cards:
Select Active Workspace→Server Extensions→Reuse and Standardization→Next
Generation Classification Server.
o To install the server components necessary for searching within classification libraries:
Select Active Workspace→Server Extensions→Reuse and Standardization→Library
Management Server.
Server features
Next Generation
Classification(Presentation
Functions Classification layer) Library Management
Index classification attributes √ √ √
Index classification classes √ √ √
Index classifying objects (ICOs) √ √
Hierarchical filtering of classes √ √ √
Index catalog data √
Index library elements √
Visual navigation cards (VNC) √
√
for classes
Visual navigation cards (VNC)
√
for library nodes
Compatible client feature Classification client Library Management client
• Client
o To install the user interface elements for classifying objects in Active Workspace:
Select Active Workspace→Client Extensions→Reuse and
Standardization→Classification Client.

Chapter
Installation
o To install the user interface components necessary for using classification libraries:
Select Active Workspace→Client Extensions→Reuse and Standardization→Library
Management Client.
Client features
Functions Classification Library Management
Classification authoring √
Browse classification hierarchy using visual
√
navigation cards
Browse library hierarchy using visual
√
navigation cards
Dedicated location for searching and
√
browsing
Install Tool Launcher Client

In Active Workspace Simulation Process Management, the simulation analyst creates CAE elements
(such as CAEGeometry, CAEModel, and CAEAnalysis) and launches a preconfigured simulation
tool. The tool uploads the simplified geometry, meshing data, or analysis data to the respective
application, runs the application, and then uploads the resulting data to the corresponding element
created by the analyst. To run simulation tools or open external links, you must install the Tool
Launcher Client on the client machine.
• Install using quick setup bat file
• Install using executable
• Install using console mode
Install using quick setup bat file
1. Set JAVA_HOME.
2. Copy the contents of the additional_applications\TTLC_installer folder from the installation

kit and paste it to a local machine in a folder where you want to install TTLC, for example,
D:\workdir\TTLC\11.4.0.1\TTLC_installer.
3. Open a command prompt with administrative privileges and browse to the folder where you want
to install TTLC, for example, D:\workdir\TTLC\11.4.0.1\TTLC_installer.
4. To set up the Tool Launcher Client environment, run the following command:
ttlc_quick_setup.bat -default
You can use the -default option for the Tool Launcher Client script to set http://localhost:7001/tc
as the Teamcenter server URL.
5. To access sample usage help provided by this script, type: ttlc_quick_setup.bat -h in the
command prompt.

Installation
Install using executable
1. Set JAVA_HOME.
2. In the software distribution image for the Teamcenter minor release you use, double-click
wntx64\additional_applications\TTLC_installer\TeamcenterToolLaunchClient.exe.
3. In the Teamcenter Tool Launch Client dialog box, select an installation language and then
click OK.
4. In the Introduction panel, click Next.
5. In the License Agreement panel, accepts the terms of the license agreement and then click Next.
6. In the Choose Installation Folder panel, accept the default location or click Choose to set a
different location. Then click Next.
7. In the Middle Tier Server URL panel, type the URL of the Teamcenter four-tier web application.
The format is:
protocol://host:port/application-name
host is the name of the machine on which the application server is running.
port is the port used by the application server.
application-name is the name of the Teamcenter web application, typically tc.
8. In the Teamcenter server credentials panel, type the user name and password to be used when
logging in to the Teamcenter database and then click Next.
9. In the Pre-Installation Summary panel, click Install.
10. In the Install Complete panel, click Done.
Install using console mode
You can also install the Tool Launcher Client using the console mode.
The command is as follows:
TeamcenterToolLaunchClient -i console -l en -DUSER_INSTALL_DIR=installation_directory
-DTC_SERVER_URL=URL_of_Teamcenter_four_tier_web_application
-DTC_SERVER_LOGIN=user_name_used_for_logging_to_Teamcenter_database
-DTC_SERVER_PWD=password_used_for_logging_to_Teamcenter_database
Example:
TeamcenterToolLaunchClient -i console -l en
-DUSER_INSTALL_DIR="D:\\new2\\TeamcenterToolLaunchClient"
-DTC_SERVER_URL=http://10.134.210.170:7001/awc/tc/ -DTC_SERVER_LOGIN=user_name
-DTC_SERVER_PWD=password

Chapter
Installation
Tip
Type - on the command line and do not copy it from any word processor (including
Microsoft Word). All argument names must be typed in capital letters, for example,
-DUSER_INSTALL_DIR and not -Duser_install_dir.

Chapter 3: Patching and upgrading Active Workspace
Patch and upgrade deployment paths

Rapid Start, see the Teamcenter Compatibility Matrix to find which earlier versions are supported
with Active Workspace 3.4. On the hardware and software certifications on GTAC, under Additional
If you already have Active Workspace 2.x or Active Workspace 3.0 installed, moving to Active
Workspace 3.4 requires a patching process or an upgrade process, depending on your existing
Teamcenter deployment:
• Update the major version of Teamcenter (moving from Teamcenter 10 to Teamcenter 11):
Upgrade Teamcenter while updating Active Workspace.
• Update the minor version of Teamcenter: Patch Teamcenter to the latest minor version while
updating Active Workspace.
• Update the Active Workspace version but not the Teamcenter version: Patch to update Active
Workspace.
The following table provides some examples of upgrade and patch paths.

Teamcenter 10.1.5, 10.1.6, or Upgrade
Active Workspace 2.x with 10.1.7
Teamcenter 9.1.x Active Workspace 3.4 with
11.2.3, or 11.3
Patch
Active Workspace 2.x with Teamcenter 10.1.6 or 10.1.7
Teamcenter 10.1.1.1 through Active Workspace 3.4 with
Teamcenter 10.1.5 Teamcenter 11.2.1, 11.2.2, Upgrade
11.2.3, or 11.3
Patch
Teamcenter 10.1.6 or 10.1.7
11.2.3, or 11.3
Active Workspace 3.1 with Active Workspace 3.4 with
Patch
Teamcenter 11.2.2 Teamcenter 11.2.3 or 11.3

Chapter
Chapter 3: 3: Patching
Patching and upgrading
and upgrading Active
Active Workspace
Workspace
Patching Active Workspace and Teamcenter
Patching to Active Workspace 3.4

If you are moving from Active Workspace 2.x or Active Workspace 3.0 to Active Workspace 3.4 and
are not upgrading to the next major Teamcenter version, you follow a patching process. For example,
if your initial environment is Teamcenter 11.2.3 and your target environment is Teamcenter 11.4, you
follow a patching process.
The following table provides examples of initial and target Active Workspace and Teamcenter
versions for which the patching process is used.

Active Workspace 2.x with Patch
Teamcenter 10.1.6
Teamcenter 10.1.1.1 through
Patch
Teamcenter 10.1.7
Active Workspace 3.0 with Active Workspace 3.4 with
Patch
Teamcenter 10.1.7 Teamcenter 10.1.7
Patch
Active Workspace 3.0 with Teamcenter 11.2.3
Patch
Teamcenter 11.4
Patch Teamcenter
Patch your environment to the supported Teamcenter patch level.
Active Workspace 3.4. On the hardware and software certifications page on GTAC (hardware and
software certifications), under Additional Resources, click the link to Internal Interoperability –
Teamcenter Compatibility Matrix.
Refer to all of the following before adding the Teamcenter patch:
• Readme file for the Teamcenter patch
• Readme file for the Active Workspace patch that you plan on adding
Because Active Workspace is installed in your environment, there may be steps that you must
perform before you can add a new Teamcenter patch. If such steps are required, the readme file
for the Active Workspace patch that you are moving to provides them.

Patching and upgrading Active Workspace
• For information about installing patches on a Teamcenter server, see the appropriate server
installation guide (for Windows or UNIX/Linux).

Chapter
Active Workspace
Workspace
Patch to Active Workspace

If you are patching an AIX or Solaris server in which the Indexing Engine is installed, you must install
a supported version of Bash before beginning the upgrade.
For supported versions, see the Hardware and Software Certifications page on GTAC.
1. From GTAC, download the Active Workspace patch ZIP file:
Tcrelease_ActiveWorkspacerel-num_platform.zip.
2. Unzip Tcrelease_ActiveWorkspacerel-num_platform.zip to a location on the corporate server.
3. If any server managers are running on the corporate server to be patched, shut them down
before proceeding with the patch.
4. Start TEM for the corporate server.
5. In the Maintenance panel, select Updates Manager and click Next.
6. Complete the Apply Updates panel.

a. In the Update kit location box, type or browse to the location to which you unzipped
b. In the Backup directory box, type or browse to the location in which backup files are
to be created.
c. In the Original Media Location box, type or browse to the location of the full Teamcenter
release installation media, for example, Teamcenter 10.1, Teamcenter Rapid Start 10.1,
or Teamcenter 11.2.
d. Click Next.
7. The Status Message popup window informs you that TEM will stop any running Teamcenter
services in order to perform the update. Once the update is complete, these services are
restarted. Any users currently on the system are dropped. Click Close.
8. In the Operating System User panel, type the password of the operating system account used
to update Teamcenter and click Next.
10. If the patch contains enhancements to features in your configuration, TEM displays a panel that
lists the enhancements. If one or more enhancements are required, or if the update introduces
new feature dependencies, the enhancements are required. Otherwise, the enhancements
are optional.
• Optional Configuration Enhancements
Click View Enhancement Info to view information about the enhancements. Note each
feature that has enhancements.

Chapter
Active Workspace
Workspace
If you want to install the optional feature enhancements, select Yes. Otherwise, select No.
Warning
If you select Yes, features containing data model objects may be upgraded. That
is, database model changes may occur. Siemens PLM Software recommends you
back up your database before continuing.
If you select No, features containing data model objects are not updated. If you
want to perform this update at a later time, you must repeat the patch installation
procedures to reinstall the patch, and choose Yes to include the template update.
• Required Configuration Enhancements

If the configuration enhancements are required, select the Accept Data Model Updates
check box to enable the Next button and continue with installation.
Warning
If you accept data model updates, features containing data model objects may be
updated. That is, database model changes may occur. Siemens PLM Software
recommends you back up your database before continuing.
12. In the Indexing Engine User panel, type the Solr administrator’s user name and password,
and click Next. These credentials must match for the Indexing Engine, the Indexer, Server
Extensions, and the TcFTS Indexer Translator (if used).
13. If the server you are patching contains the Indexing Engine, the Indexing Engine Configuration
panel appears.

SOLR schema files location
• If the Indexing Engine and the Server Extensions are installed on the same server, the
SOLR schema files location box is prepopulated with the correct location.
• If the Indexing Engine and the Server Extensions are installed on separate servers and
you have already patched the server on which the Server Extensions are installed, type
or browse to the path to the upgraded Server Extensions server that contains the Solr
schema files, TC_DATA\ftsi\solr_schema_files.
• If the Indexing Engine and the Server Extensions are installed on separate servers and
you have not yet patched the server on which the Server Extensions are installed, leave
the SOLR schema files location box blank. You can patch the Indexing Engine server
now, but the schemas are not automatically merged. You must manually merge them
after upgrading both the Indexing Engine server and the Server Extensions server.
Install indexing engine as a service
Select this to install the Indexing Engine as a service. If this is not selected, you must start
the Indexing Engine manually.
Note
To deploy Solr with Active Workspace in AIX and Solaris environments, you must
use a supported version of Bash. For supported versions, see the Hardware and
Software Certifications page on GTAC.
15. During the update, a Status Message popup window opens. It informs you that you must
manually patch the TC_DATA directory and regenerate the awc.war file after TEM completes
its updates. Click Close.
16. When the update is complete, click Close to close TEM.

Chapter
Active Workspace
Workspace
17. Browse to the location to which you unzipped Tcrelease_ActiveWorkspacerel-num_platform.zip.

Under this location, browse to tc.
18. Unzip the data.zip file to the corporate server’s TC_DATA directory.
Upgrade the ACCT_TABLE database table

If you are performing site consolidation in an environment that uses Active Workspace and your initial
environment (before upgrading or patching) was earlier than Teamcenter 9.1.3.4 or 10.1.4, you must
manually upgrade the ACCT_TABLE database table after upgrading or patching the corporate server.
Both site consolidation unconfigured synchronization and object data indexing use this table. Starting
with Teamcenter 9.1.3.4 and 10.1.4, the table has a new column, app_id. During the corporate server
upgrade or patch, data collisions exist and the new app_id column is not added. After the upgrade or
patch, you must run the tcxml_acct_table_upgrade utility to add the new column to the table.
More information is provided in Site Consolidation in the Teamcenter help collection.

Import table column configuration

If you have configured any custom table columns other than those available by default, perform the
following after upgrading or patching:
1. Update the custom column information in the Awb0ContentTableUiConfigCots.xml file.
2. Run the import_uiconfig utility to import the column configuration.
Reinstall Active Workspace components
Note
Complete the steps in this topic only if your initial Active Workspace version is 2.1. If your
initial Active Workspace version is 2.2 or later, skip this topic.
In Active Workspace 2.2, new indexing and visualization components were introduced. You
uninstalled the Active Workspace 2.1 Visualization Server Manager, Visualization Server Pool
Assigner, and Active Workspace Indexer features and have patched or upgraded to your target
Active Workspace version. Now, you must reinstall these features.
Additionally, since Active Workspace 2.1, the TcFtsInderexTrans translator has been replaced by the
Active Content Structure Translator feature. If you use Dispatcher-based indexing for structure
data, you must install this feature.
These features may be on separate servers or in combinations on servers.
1. On the Client web application build machine, install the Visualization Server Pool Assigner
feature. Perform this task only if Visualization is used with Active Workspace.
Installing this feature rebuilds the awc.war file. Therefore, after installing this feature, you must
redeploy the file.
2. On the Visualization server machine, install the Visualization Server Manager feature. Perform
this task only if Visualization is used with Active Workspace.
3. Starting in Active Workspace 3.0, if you use Dispatcher-based indexing for structure data,
you must install the Active Content Structure Translator feature in the Dispatcher Server
configuration.
4. On the Indexer server machine, install the Active Workspace Indexer feature.
Initiate Solr credentials
Initiate Solr credentials

If your initial Active Workspace environment was 2.1 or 2.2, you need to initiate the credentials for the
Solr administrative user after patching to the target Teamcenter and Active Workspace versions. This
is not necessary if your initial environment was Active Workspace 2.3 or later.
There are four places this needs to be done. The credentials entered in each of these locations
must be identical.

Chapter
Active Workspace
Workspace
• Server Extensions
• Active Content Structure Translator on the Dispatcher Server (if Dispatcher-based indexing
is used for structure data)
• Indexing Engine
• Indexer
Enter Solr credentials for the Server Extensions

1. Start TEM for the corporate server on which the Server Extensions features are installed.
2. In the Maintenance panel, select Configuration Manager, and then click Next.

4. In the Old Configuration panel, select the configuration in which the Server Extension features
are installed, and then click Next.
5. In the Feature Maintenance panel, under Data Model, select Update Indexing Engine user
credentials, and then click Next.

6. In the Indexing Engine User panel, type the Solr administrative user's name and password.
Active Content Structure Translator (if Dispatcher-based indexing is used for structure data).
After typing the user name and password, click Next.
Enter Solr credentials for the Dispatcher Server
1. Start TEM for the Dispatcher Server.

4. In the Old Configuration panel, select the configuration in which the Dispatcher Server is
installed, and then click Next.
5. In the Feature Maintenance panel, under Active Content Structure Translator, select Modify
Active Content Structure translator settings, and then click Next.

Chapter
Active Workspace
Workspace
7. In the TCFTS Indexer Translators panel, click Next.
Enter Solr credentials for the Indexing Engine
1. Start TEM for the Indexing Engine.


4. In the Old Configuration panel, select the configuration in which the Indexing Engine is installed,
and then click Next.
5. In the Feature Maintenance panel, under Active Workspace Indexing Engine, select Update
Indexing Engine user credentials, and then click Next.
Enter Solr credentials for the Indexer
1. Start TEM for the Indexer.

4. In the Old Configuration panel, select the configuration in which the Indexer is installed, and
then click Next.
5. In the Feature Maintenance panel, under Active Workspace Indexer, select Update search
engine user credentials, and then click Next.

Chapter
Active Workspace
Workspace
Remerge Solr and Teamcenter schemas and update the index

After moving to the target Active Workspace and Teamcenter versions, the Teamcenter and Solr
schemas are not synchronized. You can merge the schemas and then choose the method for
updating the index. You must determine your indexing strategy before planning your approach
to updating the index.
Evaluate the delta of object data changes

If your indexing changes are additions, modifications, and deletions for types and properties, you can
perform a delta indexing update rather than a complete reindex.
1. Merge the Teamcenter and Solr schemas.
2. Stop synchronization by the indexer if it's running.

runTcFTSIndexer -stop

3. Determine the scope of the changes between the last indexing schema and the current schema.
Run the awindexerutil utility using -delta -dryrun to get a report of the expected delta of
changes. For example:
awindexerutil -u=adminuser -p=password -g=group -delta -dryrun
The differences are output to the command window as well as to a log file.
4. After you evaluate the report, determine whether you want to use the delta of changes for
reindexing. If so, run awindexerutil -delta to index the changes from the report:
awindexerutil u=infodba -p=infodba -g=dba -delta
5. Test indexer connectivity by running the indexer test flow.

6. Restart the synchronization flow using the runTcFTSIndexer utility:

runTcFTSIndexer -task=objdata:sync -interval=seconds
Reindex your data if needed

Your index may have a high number of changes or other kinds of changes that are outside the scope
of delta changes. If that is the case, reindex your data instead:
1. Merge the Teamcenter and Solr schemas.
2. Test indexer connectivity by running the indexer test flow.

3. Reindex the data.
Reindex classification data

If you use Classification Search, you must re-index classification data after you patch Active
Workspace.
1. In Teamcenter rich client Classification, verify that classified data is available. Classification
should contain a structure of classes with attributes and classified objects.
For more information see the Teamcenter Classification documentation.
2. Choose one of the following to define the classification properties you want to index.
• To select all classes, attributes, and filters, run the smlutility utility. For example, from a
Teamcenter command window, type:
smlutility -create_indexing_views -u=username -p=password -g=dba
A search index view is created for each class in Classification Admin. All attributes of the
class are assigned to the view. You can only run this command once for a class.
• To define specific classification properties:

a. Set the ICS_searchindex_view_visible preference to TRUE.

Chapter
Active Workspace
Workspace
b. In the Teamcenter rich client Classification Admin, the Add View operation now
includes the Search Index View option.
Class attributes for these classes are not yet configured for indexing or filtering.
For a class to be available for indexing and filtering, the class must contain a search
index view, at least one attribute, and at least one classified object.
c. In the Teamcenter rich client Classification Admin, select the search index view for a
class and select the View Attributes tab.
d. Add all attributes that you want included in the indexing to the View Attributes list.
Note
You cannot add linked attributes to search index views, since these attributes
can be directly searched via the object properties they are linked to.
e. Individually, in the View Attributes list: select a attribute, choose Edit Current Instance
(blue key), select the Filter check box, and click Save Current Instance.
The attributes are available to filtering after it is indexed.

3. Enable Classification Search.

a. Open a Business Modeler IDE project that contains the foundation and aws2 templates.
b. Set the following business object constants in Business Modeler IDE:

• Turn on the Classification Search feature by setting the
Awp0SearchClassifySearchEnabled business object type constant to true at the
workspace object level.
• Specify that Classification data is indexed by setting the

Awp0SearchIsClassifyDataIndexed business object type constant to true at the
item and item revision level.
• Check that search data is indexed. Be sure that the Awp0SearchIsIndexed business
object type constant is set to true at the item and item revision level.

Chapter
Active Workspace
Workspace
Note
Do not set this constant at the workspace level since this causes your
database to no longer be indexable.
Instead set it true for each object that you want to index. For example item
and item revision.
c. Deploy the Business Modeler IDE changes using either a cold deploy or hot deploy. See the
Business Modeler IDE documentation for details and recommendations.
If a hot deploy is used, you must also run the bmide_modeltool. For example, in a
Teamcenter command window type:
bmide_modeltool -u=username -p=password -tool=all -mode=upgrade
-target_dir="%TC_DATA%"
4. Verify the deploy completed correctly.

a. From a Teamcenter command window, type:
gettypeconstantvalue -u=username -p=password -g=dba
-typename=WorkspaceObject -constantname=Awp0SearchClassifySearchEnabled
b. Verify that the tc_solr_schema.xml file in the TC_DATA\ftsi\solr_schema_files folder has

c. Open the tc_solr_schema.xml file in a text editor search for 0Y0_CLASSIFICATION_0Y0.

You should find several lines containing this string. Close the text editor without saving.
5. Stop the solr and indexer services.
6. Merge the Teamcenter and Solr schemas. For example, run this utility from a Teamcenter
command window:
TcSchemaToSolrSchemaTransform "%TC_DATA%\ftsi\solr_schema_files
Changes to the tc_solr_schema.xml applied to the Solr schema.xml file.
7. Restart the solr service.
8. Verify the schema merge completed correctly.

a. Verify that the schema.xml file in the SOLR_HOME\server\solr\collection1\conf folder has
b. Open the schema.xml file in a text editor search for 0Y0_CLASSIFICATION_0Y0. You
should find several lines containing this string. Close the text editor without saving.
c. Repeat these steps for other collections in the solr folder.
9. Re-index search data. For example, for environments not running dispatcher, a Teamcenter
command window:
runTcftsIndexer -task=objdata:clear

Type 4 and enter Y twice.

runTcftsIndexer -task=objdata:index
If working in an environment running the dispatcher, add the -dispatcher parameter to the
command.
Each time you modify existing classification classes or views, or create new ones on top of them,
you must update your template, merge the schema files, and reindex the search data.
10. Verify that indexing was successful. Indexing follows these steps:
a. Check the log file located in the TC_ROOT\TcFTSIndexer\logs folder.
b. Generate a list of all objects to be indexed including its ID and type. Verify that there is
nothing unexpected in the list that would cause an error.
runTcftsIndexer -task=objdata:index -listIDs=C:\temp\list.txt
c. The TcFTS indexer follows a specific sequence which is displayed in the window running
the indexer. For example:
...
...
• Query — The indexer examines the object types to be indexed and determines what has
changed. Changes include created, modified, or deleted objects.
• Export — The indexer exports the changes to a tcxml_<number>xml file.
• Transform — The indexer transforms the tcxml_<number>xml file into

Solr format creating a solr_<number>xml file. Both files are placed in the
TC_ROOT\TcFTSIndexer\working\TcFtsIndexer_objdata\<number>\result folder.
• Load — The indexer loads the changes into the Solr database. The Solr data can then
be displayed in the filter dialog box in Active Workspace and Teamcenter Manufacturing
Access.
11. Restart scheduled indexer syncing.
Note
Reindexing was required because you changed the schema. For this point forward,
changes to your data are captured by scheduling regular syncing of the database with
the runTcftsIndexer command.

Chapter
Active Workspace
Workspace
12. In Teamcenter Environment Manager, update the Active Workspace client settings.
Install workflow features

Starting in Active Workspace 3.0, workflow functionality has been modularized. For users to access
Inbox components and workflow functionality in the Client interface, you must:
• Install the Workflow Server Server Extensions feature on the corporate server.
• Install the Workflow Client feature in the Client web application.
Install Systems Modeling and Systems Modeler features

Starting in Active Workspace 3.0, some functionality in the Architecture toolbar of the Client interface
has been modularized. This functionality includes the Start Authoring in the Architecture toolbar.
To restore this functionality after moving to Active Workspace 3.0:
• Install the Systems Modeling Server Extensions feature on the corporate server.
• Install the Systems Modeler Client feature in the Client web application.
Set up a custom template after patching

If you have a custom template that is dependent on the Active Workspace template (aws2) and
other Active Workspace templates, you must follow a special procedure to set up this template after
patching Active Workspace.
1. Add the Active Workspace template (aws2) any other needed Active Workspace templates
to the Business Modeler IDE by selecting Add/Update Templates for working within the
Business Modeler IDE Client in the Feature Maintenance panel of Teamcenter Environment
Manager (TEM).
2. Run TEM and re-patch Active Workspace.

This copies the required Business Modeler IDE .jar files for Active Workspace into the installation.
3. In the Business Modeler IDE, import your custom template. To add the Active Workspace
template (aws2) and the other dependent Active Workspace templates:
a. Right-click your custom template project and choose Properties.
b. In the left pane, choose Teamcenter→BMIDE.
c. In the Dependent Templates pane, select the aws2 template and the other Active
Workspace templates previously added using the Add/Update Templates for working
within the Business Modeler IDE Client option in TEM.
d. Click OK.
The template is now ready to be deployed.

Regenerate and redeploy the Active Workspace WAR file

After patching, upgrading, or adding features to the Client web application, you must regenerate
and redeploy it.
1. To regenerate the Client web application:
a. Start TEM on the Client web application build machine.
b. In the Maintenance panel, select Configuration Manager and click Next.
c. In the Configuration Maintenance panel, select Perform maintenance on an existing

d. In the Old Configuration panel, select the configuration and click Next.
e. In the Feature Maintenance panel, select Update Active Workspace client settings and
click Next.
f. In the Active Workspace Client Setting panel, you can modify parameters as needed, but
no changes are necessary if you are only regenerating the WAR file. Click Next.

Chapter
Active Workspace
Workspace
g. In the Confirmation panel, click Start.
h. When the installation is complete, click Close.
2. Note that, starting with Active Workspace 2.4, the Java EE Client WAR file is created in
TC_ROOT\aws2\stage\out\awc.war. In older versions of Active Workspace, the Java EE Client
WAR file is created in TC_ROOT\aws2\stage\Teamcenter\target\awc.war.
Siemens PLM Software recommends that you delete the directory,
TC_ROOT\aws2\stage\Teamcenter\target, that contains the old WAR file in order to avoid
confusion.
3. Redeploy the Active Workspace WAR file.

When deploying the new WAR file, keep in mind that it is created in
TC_ROOT\aws2\stage\out\awc.war.

Upgrading Active Workspace and Teamcenter
Upgrading to Active Workspace 3.4

If the target Teamcenter version to which you are moving is a later major version than your initial
environment, you follow an upgrade process. For example, if your initial environment is Teamcenter
10.1.5 and your target environment is Teamcenter 11.4, you follow an upgrade process.
The upgrade to the target versions of Teamcenter and Active Workspace must be done in a single
upgrade process. You cannot upgrade to the target Teamcenter version in one process and then
patch to the target Active Workspace version in a separate process; this causes the upgrade to fail.
The following table provides examples of initial and target Active Workspace and Teamcenter
versions for which the patching process is used.

Upgrade
Teamcenter 11.2.3
Active Workspace 3.x with
Teamcenter 10.1.1.1 through Upgrade
Teamcenter 11.3
Teamcenter 10.1.7
Upgrade
Teamcenter 11.4
Create index for upgrade performance

Before you begin upgrade of Teamcenter and Active Workspace, create the following index for
the Teamcenter database:
CREATE UNIQUE INDEX po_ppid_puid_idx ON PPOM_OBJECT(ppid,puid);
Creating this index improves upgrade performance and reduces the overall upgrade time required.
Upgrade Active Workspace and Teamcenter

If the target Teamcenter version to which you are moving is a later major release than your initial
environment, you follow an upgrade process. For example, if your initial environment is Teamcenter
10.1.5 and your target environment is Teamcenter 11.2.3, you follow an upgrade process.
The upgrade to the target versions of Teamcenter and Active Workspace must be done in a single
upgrade process. You cannot upgrade to the target Teamcenter version in one process and then
patch to the target Active Workspace version in a separate process; this causes the upgrade to fail.
Because Active Workspace is installed in your environment, there may be steps that you must
perform before you can upgrade. If such steps are required, the readme file for the Active Workspace
patch that you are moving to provides them.

Chapter
Active Workspace
Workspace
The following steps illustrate an upgrade of a simple environment. Siemens PLM Software
recommends that you refer to the Teamcenter Upgrade in the Teamcenter help collection before
attempting an upgrade.
The panels you see in TEM are dependent on the features that you have installed. You may see
additional panels in your environment.
1. If you are upgrading an AIX or Solaris server in which the Indexing Engine is installed, you must
install a supported version of Bash before beginning the upgrade.
For supported versions, see the hardware and software certifications page on GTAC.
2. From GTAC, download the Active Workspace patch ZIP file:

If your environment uses Teamcenter or Teamcenter Rapid Start 10.1.x, download
Tc10.1.x_ActiveWorkspace3.2_platform.zip. The Tc10.1.x portion of this filename indicates the
minimum Teamcenter 10.1.x version supported by Active Workspace 3.4.
If your environment uses Teamcenter or Teamcenter Rapid Start 11.2.x, download
Tc11.2.x_ActiveWorkspace3.2_platform.zip. The Tc11.2.x portion of this filename indicates the
minimum Teamcenter 11.2.x version supported by Active Workspace 3.4.
4. In the Installer Language window, select a language and click OK.
5. If you are upgrading to Teamcenter/Teamcenter Rapid Start 11.x, the Welcome to Teamcenter

Note
Teamcenter.
7. In the Media Locations panel, you specify locations of Teamcenter and Active Workspace
installation media.
distribution image.
8. In the Old Application Root panel, provide the location of TC_ROOT for the server to be
upgraded and then click Next.
9. In the Old Configuration panel, select the configuration to be upgraded and click Next.
10. In the Configuration panel, provide an ID and a Description and then click Next.
11. In the New Application Root panel:

Chapter
Active Workspace
Workspace
a. Check that no features have a status of WARNING. If any do, click Browse and navigate to
the appropriate feature file.
b. In the New Application Root Directory box, provide the location in which to install the
target TC_ROOT.
12. If you are upgrading a server that contains the Active Workspace Client feature, the Active
Workspace Client Settings panel appears. It is populated with the values provided when it
was installed. Make any necessary changes.

The Teamcenter 4-tier URL box is the URL for the deployed Teamcenter web application.
The format of this URL is:
protocolhost:port/web-app-name
web-app-name is the name of the Teamcenter web application ear file. The default is tc.
13. In the Active Workspace Client Settings panel, the JDK Home box is the installation location of
a supported version of 64-bit JDK. This box is prepopulated with the value of the JAVA_HOME
system environment variable. You can change this to a different JDK as needed.
page on GTAC.

Chapter
Active Workspace
Workspace
14. The Active Workspace client uses FMS to download and upload files. You define the FSC servers
that will be used by choosing one of the following:
• Use as Bootstrap URLS: FSC servers are automatically assigned by the FMS system.
This is the most common scenario.
In the Bootstrap URLs box, enter a comma-separated list of one or more FMS bootstrap
URLs. Optionally, provide the Bootstrap Client IP value to be used for the assignment.
The Bootstrap Client IP value should only be used when there are proxies that might hide
the actual requestor’s IP address from the FSC servers, or if you want the assignment to be
performed based on a particular IP and not that of the requestor. (The client/requestor is
the host on which the awc.war file is deployed.) The list of Bootstrap URLs should contain
well-known FSCs that can be consulted for the actual FSC assignment. The assignment is
delegated to the FMS network, which uses mapping logic and configuration data to determine
the FSCs that should be used by the requestor (refer to the clientmap configuration in the
FMS Master configuration file). The client mapping logic uses an IP address to determine the
assignment. By default, the IP address from the HTTP connection of the requestor will be
used unless a Bootstrap Client IP value is provided.
• Use Assigned FSC URLs: FSC servers are explicitly declared.

This should only be select if you want explicit control of the FSCs used. In the Assigned
FSC URLs box, enter a comma-separated list of one or more FSC URLs. The URL values
entered will be directly used for file operations.

15. Select Enable TcSS Support to enable Teamcenter Security Services. Enter the Teamcenter
Security Services application ID and logon URL.
For details about configuring Teamcenter Security Services, see Security Services
Installation/Customization in the Teamcenter collection.
When configuring Active Workspace for Teamcenter Security Services, be sure to only install the
language packs for the Security Services that Active Workspace supports.
If Active Workspace is deployed on a different URL, you must configure Teamcenter Security
Services with multiple application IDs. For more information, see the readme file for your
Teamcenter Security Services version.

Chapter
Active Workspace
Workspace
16. In the Active Workspace Client Settings panel, click Advanced to open the Additional Client
Settings dialog box. In this dialog box, you can select additional locales to include in the Client
web application.
17. Click OK in the Additional Client Settings dialog box.
18. Click OK in the Active Workspace Client Settings panel.
19. In the Operating System User panel, provide the password of the operating system user that
is running the upgrade and then click Next.
20. In the Teamcenter Administrative User panel, provide the password and then click Next.
21. In the Upgrade Information panel:

a. Verify that the Old TC_DATA Location box has the correct value.
b. Provide a location for the new TC_DATA in the New TC_DATA Location.
c. Enter the database user name and password.
22. If your database platform is Oracle and you are upgrading to Teamcenter 11.2.x, a temporary
tablespace must be created before the database can be upgraded. This tablespace can be
created manually or can be created by TEM.
This step assumes that you are using TEM to create the tablespace. For information about
creating the tablespace manually, refer to Create a new Oracle tablespace in the Teamcenter
help collection.
a. In the Tablespace Name box, type the name to use for the tablespace.

Chapter
Active Workspace
Workspace
b. Select Use administrator user to create tablespace.
c. In the Database System Password box, type the Oracle system account's password.
d. In the Tablespace Directory on Database Server box, enter the path of the directory in
which the database file is to be created.
e. Click Next.
23. In the Confirm window, click Confirm.
24. In the Upgrade Database Features panel, verify that all features have a status of Upgrade
and the Path value is correct. To correct any issues, click Browse and locate the appropriate
feature file.
25. In the Upgrade Options panel, select either:

• Stop database upgrade at first error
This option stops Teamcenter upgrade when the first error occurs. Siemens PLM Software
strongly recommends this option when upgrading production systems.

• Stop database upgrade after accumulating all errors
This option allows the database upgrade to continue when an error is encountered, and report
all errors at the end of the upgrade process. Siemens PLM Software strongly recommends
using this option only when upgrading a test environment. Errors during database upgrade
could render the database unusable.
26. In the Flex License Client panel, enter the license server and license file information
27. In the Password Security panel, select a location and then click Next.
28. If the server you are upgrading contains Active Workspace Server Extension features, the
Indexing Engine, the TcFtsIndexerTrans translator, the Indexing Engine User panel appears.
Type the Solr administrator’s user name and password. This is the user and password defined
when installing the Indexing Engine (Solr). These credentials must match for the Indexing
Engine, the Indexer, Server Extensions, and the TcFtsIndexerTrans translator. After typing the
user name and password, click Next.
29. If the server you are upgrading contains the Indexing Engine, the Indexing Engine
Configuration panel appears.
• SOLR schema files location
o If the Indexing Engine and the Server Extensions are installed on the same server, the
SOLR schema files location box is prepopulated with the correct location.

Chapter
Active Workspace
Workspace
o If the Indexing Engine and the Server Extensions are installed on separate servers and
you have already upgraded the server on which the Server Extensions are installed, type
or browse to the path to the upgraded Server Extensions server that contains the Solr
schema files, TC_DATA\ftsi\solr_schema_files.
o If the Indexing Engine and the Server Extensions are installed on separate servers and
you have not yet upgraded the server on which the Server Extensions are installed,
leave the SOLR schema files location box blank. You can complete the upgrade of
the Indexing Engine server, but the schemas are not automatically merged. You must
manually merge them after upgrading both the Indexing Engine server and the Server
Extensions server.
• Install indexing engine as a service

Select this to install the Indexing Engine as a service. If this is not selected, you must start
the Indexing Engine manually.
Note
To deploy Solr with Active Workspace in AIX and Solaris environments, you must
use a supported version of Bash. For supported versions, see the hardware and
30. If the server you are upgrading contains the Indexer, the Active Workspace Indexer Settings
panel appears. It is populated with the values provided when it was installed. Make any
necessary changes.
a. Choose the indexing method to use:

• Standalone indexing environment:
Indexing operations are run on one machine using a single Java process (TcFTSIndexer
orchestrator), which connects to the Teamcenter server manager and the Solr search
engine. This Java process is an SOA client that tracks the number of TcServer
connections and executes flows based on the configuration.

This mode supports indexing both object data and structure data. It is the only mode that
supports object data. For custom types, this mode can be used if the type associated
with TcFtsIndexer supports Standalone mode.
This indexing method does not use the Dispatcher.
• Dispatcher-based indexing environment:

Indexing operations are initiated using the Dispatcher and run across multiple machines.
This provides load balancing for better performance if indexing steps are CPU or memory
intensive.
The Dispatcher-based mode supports structure data indexing. If you run the
TcTFSIndexer in Dispatcher mode against object data, the indexer will revert to using
Standalone mode. For custom types, this mode can be used if the type associated with
TcFtsIndexer supports Dispatcher mode.
In order to use Dispatcher-based indexing, you must install the Active Content
Structure Translator after upgrading.
b. Enter the following:

The URL for the deployed Teamcenter web application. The format of this URL is:
http://host:port/web-app-name
web-app-name is the name of the Teamcenter web application.
• Dispatcher Server URL

(Dispatcher-based indexing only) This is the URL used by the Dispatcher Schedule. It
was defined in the Dispatcher Components TEM panel when installing the Dispatcher
Server. The format of this URL is:
rmi://host:port
host is the machine on which the Dispatcher Scheduler is running.
port is the port value used by the Dispatcher Scheduler. The default is 2001.
• Staging Directory
(Dispatcher-based indexing only) Type or browse to the dispatcher staging directory. It
was defined in the Dispatcher Components TEM panel when installing the Dispatcher
Server.
31. If the server you are upgrading contains the Indexer, the Active Workspace Indexer Type
Selection panel appears. Select the indexer types to install.

Chapter
Active Workspace
Workspace
• Active Workspace Object Data Indexer

Indexes Teamcenter data. This is the standard search indexer.
• Active Content Structure Indexer

Indexes structure data.
Next.

34. If the server you are upgrading contains the Indexer, the Active Workspace Object Data
Indexer Settings panel appears. Set the extraction start and end times.
• Start Time
All data modified after this date and time is extracted for indexing; data older than this is not
extracted. This value is only used during first-time indexing or re-indexing.
Date
Use the pull-down list to set YEAR, MONTH, and DAY.
Time
Format is HH:mm in 24-hour format.
• No End Time
If selected, all data modified from the start time to the present is indexed.
• End Time

Chapter
Active Workspace
Workspace
If selected, specifies the end date for extracting data. All data modified after this date will not
be extracted for indexing. This value is only used during first-time indexing or re-indexing.
Date
Use the pull-down list to set YEAR, MONTH, and DAY.
Time
Format is HH:mm in 24-hour format.
35. If the server you are updating contains the Visualization Data Server, the Visualization Data
Server Configuration panel appears.
• Server Port
This is the port number on which the Visualization Data Server listens.

This is the URL of the Teamcenter web tier application. The format is:
http://host:port/tc-web-app
tc-web-app is the name of the Teamcenter web application. The default is tc.
36. If you are upgrading a server that contains the Visualization Server Pool Assigner feature,
the Visualization Pool Assigner Settings panel appears. These settings are used only if you
are going to use Visualization in the Active Workspace client.

• Local Assigner Settings section defines the host and port used by the Visualization Server
Pool Assigner.
o Host is the machine on which the Visualization Server Pool Assigner runs as part of the
deployed Active Workspace client web application. The Host value can be either the
machine name or the machine IP address.
o Port is the port value used by this Visualization Server Pool Assigner.
• Add pool assigner should be selected only if more than one Visualization Server Pool
Assigner is to be used. If just one Visualization Server Pool Assigner is used, do not select
this option.
• Peer Assigners table is a list of other Visualization Server Pool Assigners that this
Visualization Server Pool Assigner knows about.
o Assigner Host is the host on which a peer Visualization Server Pool Assigners is
deployed. This can be the machine name or IP address.
o Assigner Port is the port value used by the peer Visualization Server Pool Assigner.
Note
If you are upgrading from Active Workspace 2.4.2 or higher to Active Workspace 3.x,
and you have installed the Visualization Server Pool Assigner feature installed
with Active Workspace Client (.NET), you should first uninstall the Visualization
Server Pool Assigner prior to upgrading. After the upgrade, to regain visualization
functionality, install Visualization Server Pool Assigner (.NET). This step should not
be necessary if you are upgrading from Active Workspace 3.0 to a higher version.

Chapter
Active Workspace
Workspace
37. If the server you are upgrading contains Server Extensions features, the Active Workspace
Server Extensions Settings panel appears. The panel is populated with the search engine URL
provided when the Server Extensions features were installed. Make any necessary changes.
The Solr search engine URL format is:

http://host:port/solr
host is the machine designated to run Solr. This is the machine on which the Indexing
Engine is installed.
port is the port value used by Solr. The default is 8983.
Select Use additional search engine URLs only if your environment uses multiple Solr search
engines for failover. Enter the URLs in the Search Engine URL List box.
38. In the Pre-Upgrade Diagnostics panel, provide a logging directory, click Run, and verify that
all diagnostic tests have a status of Passed.

40. When the upgrade is complete, click Close.
Upgrade the ACCT_TABLE database table

If you are performing site consolidation in an environment that uses Active Workspace and your initial
environment (before upgrading or patching) was earlier than Teamcenter 9.1.3.4 or 10.1.4, you must
manually upgrade the ACCT_TABLE database table after upgrading or patching the corporate server.
Both site consolidation unconfigured synchronization and object data indexing use this table. Starting
with Teamcenter 9.1.3.4 and 10.1.4, the table has a new column, app_id. During the corporate server
upgrade or patch, data collisions exist and the new app_id column is not added. After the upgrade or
patch, you must run the tcxml_acct_table_upgrade utility to add the new column to the table.
More information is provided in Site Consolidation in the Teamcenter help collection.

Chapter
Active Workspace
Workspace
Import table column configuration

If you have configured any custom table columns other than those available by default, perform the
following after upgrading or patching:
1. Update the custom column information in the Awb0ContentTableUiConfigCots.xml file.
2. Run the import_uiconfig utility to import the column configuration.
Reinstall Active Workspace components
Note
Complete the steps in this topic only if your initial Active Workspace version is 2.1. If your
initial Active Workspace version is 2.2 or later, skip this topic.
In Active Workspace 2.2, new indexing and visualization components were introduced. You
uninstalled the Active Workspace 2.1 Visualization Server Manager, Visualization Server Pool
Assigner, and Active Workspace Indexer features and have patched or upgraded to your target
Active Workspace version. Now, you must reinstall these features.
Additionally, since Active Workspace 2.1, the TcFtsInderexTrans translator has been replaced by the
Active Content Structure Translator feature. If you use Dispatcher-based indexing for structure
data, you must install this feature.
These features may be on separate servers or in combinations on servers.
1. On the Client web application build machine, install the Visualization Server Pool Assigner
feature. Perform this task only if Visualization is used with Active Workspace.
Installing this feature rebuilds the awc.war file. Therefore, after installing this feature, you must
redeploy the file.
2. On the Visualization server machine, install the Visualization Server Manager feature. Perform
this task only if Visualization is used with Active Workspace.
3. Starting in Active Workspace 3.0, if you use Dispatcher-based indexing for structure data,
you must install the Active Content Structure Translator feature in the Dispatcher Server
configuration.
4. On the Indexer server machine, install the Active Workspace Indexer feature.
Install workflow features

Starting in Active Workspace 3.0, workflow functionality has been modularized. For users to access
Inbox components and workflow functionality in the Client interface, you must:
• Install the Workflow Server Server Extensions feature on the corporate server.
• Install the Workflow Client feature in the Client web application.

Install Systems Modeling and Systems Modeler features

Starting in Active Workspace 3.0, some functionality in the Architecture toolbar of the Client interface
has been modularized. This functionality includes the Start Authoring in the Architecture toolbar.
To restore this functionality after moving to Active Workspace 3.0:
• Install the Systems Modeling Server Extensions feature on the corporate server.
• Install the Systems Modeler Client feature in the Client web application.
Regenerate and redeploy the Active Workspace WAR file

After patching, upgrading, or adding features to the Client web application, you must regenerate
and redeploy it.
1. To regenerate the Client web application:
a. Start TEM on the Client web application build machine.
b. In the Maintenance panel, select Configuration Manager and click Next.
c. In the Configuration Maintenance panel, select Perform maintenance on an existing

d. In the Old Configuration panel, select the configuration and click Next.
e. In the Feature Maintenance panel, select Update Active Workspace client settings and
click Next.
f. In the Active Workspace Client Setting panel, you can modify parameters as needed, but
no changes are necessary if you are only regenerating the WAR file. Click Next.

Chapter
Active Workspace
Workspace
g. In the Confirmation panel, click Start.
h. When the installation is complete, click Close.
2. Note that, starting with Active Workspace 2.4, the Java EE Client WAR file is created in
TC_ROOT\aws2\stage\out\awc.war. In older versions of Active Workspace, the Java EE Client
WAR file is created in TC_ROOT\aws2\stage\Teamcenter\target\awc.war.
Siemens PLM Software recommends that you delete the directory,
TC_ROOT\aws2\stage\Teamcenter\target, that contains the old WAR file in order to avoid
confusion.
3. Redeploy the Active Workspace WAR file.

When deploying the new WAR file, keep in mind that it is created in
TC_ROOT\aws2\stage\out\awc.war.

Appendix A: Active Workspace features
Active Workspace Server Extensions features

Active Workspace Server Extensions features are available in the Features panel in Teamcenter
Environment Manager (TEM), under Base Install→Active Workspace→Server Extensions.
To search for a feature by name, type the name or a partial name in the search box, and then click
the search button.
Feature Description
Active Workspace (required) Adds binaries to TC_ROOT and data model
changes to the database and TC_DATA. It adds
the Active Workspace (aw3_template.xml)
template to the database.
Authorization Active Workspace Adds Active Workspace authorization
components.
Active Collaboration Allows users to communicate between
themselves using Active Workspace.
Adds the Active Collaboration
(s2clsocial_template.xml) template to
the database.
If you are installing this feature, you should also
install the Active Collaboration feature (under
Client) when building the Client web application.
Active Content Structure If you plan to index structure data, you
must install this feature. It provides
functionality and data model extensions
necessary for indexing structure data.
It adds the Active Content Structure
(activeworkspacebom_template.xml) template
to the database.
install the Active Content feature (under Client)
when building the Client web application.
Active Workspace Document Management Adds support for document management in
Active Workspace.
Active Workspace User Management Adds support for user management in Active
Workspace.
AW001 3.4 Deployment A-1

Appendix
Appendix A: A: Active
Active Workspace
Workspace features
features
Feature Description
Audit Adds Audit Manager capabilities to Active
Workspace.
For more information, see Audit Manager in the
Branching and Versioning Adds support for branching and versioning in
Active Workspace.
Digital Signatures Adds digital signatures functionality to the server.
It does not add a database template.
Before selecting this feature, see the additional
setup requirements for digital signatures.
This feature is not available with Teamcenter
Rapid Start.
install the Digital Signatures feature (under
Finish Management Installs Finish Management support for Active
Workspace. A finish represents a finishing
process on a part. It may be used to improve
appearance, adhesion, corrosion resistance,
tarnish resistance, chemical resistance, wear
resistance, and remove burrs and so on.
For more information, see Aerospace and
Defense Solution in the Teamcenter help
collection.
In-Context Change Adds in-context change support to Active
Workspace.
Logical Object Adds logical object support to Active Workspace.
NX for Active Workspace Enables users to access NX integration
functionality from the client interface. It
adds the NX for Active Workspace
(awn0nx_template.xml) template to the
database.
This feature is not selectable unless
the NX Foundation feature (under
Extensions→Teamcenter Integration
for NX) is also selected.
install the NX Integration feature (under Client)
A-2 Deployment AW001 3.4

Active Workspace features
Feature Description
Program Planning Enables the Program Management capability
in Active Workspace. This feature provides the
ability to manage business investments, from
planning to execution, in terms of time, reuse,
volume, cost targets, and weight targets.
This feature adds the Program
Planning for Active Workspace
(pgp0awprgplanning_template.xml)
This feature is not selectable unless the
Program Planning Infrastructure feature
(under Extensions) is also selected.
install the Program Planning Client feature
(under Client ) when building the Client web
application.
Relationship Viewer Adds the Relationship Viewer
(relationshipviewer_template.xml) template to
the database.
install the Relationship Browser feature (under
Reporting Provides the ability to view report templates,
generate reports based on selected criteria,
style sheets, or both, and view them in
HTML, Excel, or raw XML formats. It adds
the Reporting for Active Workspace
(rb0reportingaw_template.xml) template to the
database.
install the Reporting feature (under Client)
Additionally, to allow for asynchronous report
generation, install the AsyncService translator
in the Dispatcher Server.

Appendix
Active Workspace
Workspace features
features
Feature Description
Schedule Manager Enables Schedule Manager capabilities in Active
Workspace.
It adds the Schedule Manager
for Active Workspace
(saw1projectmanagementaw_template.xml)
If you are installing this feature, you must also
install the Schedule Manager feature (under
10.1.5.
Shape Search Provides the binaries and data model extensions
for the shape search functionality. It adds
the Shape Search for Active Workspace
(shapesearch_template.xml) template to the
database. To use shape search, Geolus must be
installed and configured.
install the Shape Search feature (under Client)
Rapid Start.
Stock Material Adds stock material management to Active
Workspace.
Many parts are made from stock materials such
as bar stock, tubing stock and sheet stock. This
features enables you to manage stock materials
in Teamcenter, performing actions like creating
libraries of stock materials and assigning stock
materials to parts.
collection.
Subscription Allows users to manage subscriptions and
notifications. It adds the Subscription
(sub0subscription_template.xml) template to
the database.
install the Subscription feature (under Client)

Feature Description
Workflow Workflow does not add a template to the
database.
install the Workflow feature when building the
Client web application.
For users to access Inbox components and
workflow functionality in the Client interface,
Workflow must be installed on the corporate
server and Workflow must be installed in the
DPV Active Workspace Installs the database configuration for DPV
in Active Workspace. This feature requires
corresponding Teamcenter DPV features.
Embedded Software Management for Active Installs embedded software management
Workspace capabilities for Active Workspace.
Material Management Enables Active Workspace users to:
• Associate a material revision with a vendor
part or an item revision.
• Associate a substance with a material

revision.
• View the Material/Substance Dashboard.
This feature adds the Material

Management for Active Workspace
(mtw0materialmgmtaw_template.xml)
Material Management feature (under
Extensions→Enterprise Knowledge
Foundation) and Active Content Structure
(under Server Extensions) are also selected.
If you install this feature, you should also install
the Material Management feature (under Client)

Appendix
Active Workspace
Workspace features
features
Feature Description
Requirements Management Allows users to author a requirement structure in
the Content tab of the Client. Adds the Active
Workspace Requirements Management
(arm0activeworkspacereqmgmt_template.xml)
Rapid Start.
The Requirements Management feature is not
selectable unless the Active Content Structure
feature is also selected.
install:
• Server Extensions→Workflow
• Extensions→Systems
Engineering and Requirements
Management→Requirements
Management feature on the corporate
server.
• Requirements Management feature when

building the Client web application.
Simulation Process Management Allows Active Workspace users to author
Simulation structures in Active Workspace.
It adds the Simulation Process Management
Server (cae1caeaws_template.xml) template
to the database.
The Simulation Process Management feature
is not selectable unless the Active Content
Structure feature and the Simulation Process
Management feature (under Extensions) are
also selected.
install the Simulation Process Management
Client feature when building the Client web
application.

Feature Description
Systems Engineering Allows users to manage Systems Engineering
diagrams from the Client. It adds the
Active Workspace Systems Engineering
(ase0activeworkspacesyseng_template.xml)
Rapid Start.
The Systems Engineering feature is not
install:
• Extensions→Systems Engineering and
Requirements Management→Systems
Engineering feature on the corporate server.
• Requirements Management feature when

Vendor Management Allows Active Workspace users to:
• Associate vendors with vendor parts.
• Associate vendor parts with commercial part

revisions.
This feature adds the Vendor

Management for Active Workspace
(vm1vendormanagementaw_template.xml)
Active Content Structure feature and
the Vendor Management feature (under
Extensions→Supplier Relationship
Management) are selected.
install the Vendor Management feature (under

Appendix
Active Workspace
Workspace features
features
Feature Description
Visualization Extension This feature is required to launch the Teamcenter
lifecycle visualization stand-alone application
viewer from the Client interface.
This feature enables Active Workspace
3D viewer functionality. It adds the
Active Workspace Visualization
(awv0activeworkspacevis_template.xml)
You must install this feature if you install the
Visualization Server Manager feature (under
Visualization Server) when building the Client
web application.
The Visualization Extension feature is not
Linked Data Framework Support for Change Installs the Change Management integration
Management Integration module of Linked Data Services (LIS). The
feature requires corresponding Teamcenter
features.
Linked Data Framework Provides a framework to link Teamcenter
business objects with an artifact of a remote
linked data enabled system. It enables rendering
the remote system's delegated user interfaces in
Active Workspace.
This feature adds the Linked data
Framework for Active Workspace
(ldf0ldfaws_template.xml) template to the
database.
This feature is not selectable unless the Linked
Data Framework Support Infrastructure
feature (under Extensions→Platform
Extensibility→Linked Data Services) is also
selected.
the Linked Data Framework feature (under
Product Configurator Adds Product Configurator functionality for
Active Workspace. Product Configurator enables
you to formally introduce and manage variability
across your product suite.
For more information, see Product Configurator
in the Teamcenter help collection.

Feature Description
Substance Compliance Provides Substance Compliance capabilities, for
example:
• Request material substance declaration
(MSD).
• Request conflict mineral declaration (CMD).
• Review supplier declarations.
• Initiate compliance checks.
• Validate and import supplier declarations.
• View the compliance dashboard.
This feature adds the Substance

Compliance for Active Workspace
(scw0subscmplaw_template.xml) template to
the database.
This feature is not selectable unless the following
features are also selected:
• Material Management under
Foundation
• Vendor Management under

Management
• Active Content Structure under Server

Extensions
• Substance Compliance under

Management
• Material Management under Server

Extensions
• Vendor Management under Server

Extensions
• Workflow under Server Extensions
If you are installing this feature, you should

also install the Substance Compliance feature

Appendix
Active Workspace
Workspace features
features
Feature Description
(under Client) when building the Client web
application.
4th Generation Foundation Installs 4th Generation Design (4GD) functionality
for the Teamcenter server. 4GD allows users of
NX CAD or Lifecycle Visualization to cooperate
in real time during the design cycle of a product.
This feature requires corresponding Teamcenter
features.
Linked Data Framework for Embedded Installs the Embedded Software Management
Software Management Integration in Active integration module of Linked Data Services (LIS).
Workspace
For more information, see Integrating
Applications Using Linked Data Framework in
the Teamcenter help collection.
Linked Data Framework for Requirements Installs the Requirements Management
Management Integration integration module of Linked Data Services (LIS).
features.
Linked Data Polarion Types Integration Installs Polarion data types for Linked Data
Services (LIS) integration in Active Workspace.
features.
Substance Compliance IMDS Integration Provides integration with the International
Material Data System (IMDS).
Install this feature if you use IMDS with
Substance Compliance.
Systems Modeling Install this feature so that users can access
functionality in the Architecture toolbar of the
Client interface.
This feature adds the Systems Modeling
(ase1systemsmodeling_template.xml)
To enable the Systems Modeling feature, first
select these features:
• Base Install→Active Workspace→Server
Extensions→Active Workspace
• Extensions→Systems Engineering and
Requirements Management→Systems
Engineering
Extensions→Active Content Structure

Feature Description
Extensions→Systems Engineering
You can then select the Systems Modeling

feature.
Note
Selecting Systems Modeling
automatically selects these features
under Extensions→Systems Driven
Product Development:
• Attribute and Parameter Base
Definitions
• Measurable Attributes and
Targets
4th Generation Design Allows users to view, navigate, and configure

collaborative designs and their content in the
Client.
It adds the 4th Generation Foundation
(fgd0aw4gfoundation_template.xml)
and 4th Generation Design
(fgd0aw4gdesign_template.xml) templates to
the database.
The 4th Generation Design feature is not
feature (under Server Extensions) and
the 4th Generation Design feature (under
Extensions→Advanced PLM Services) are
also selected.
install the 4th Generation Design feature when
10.1.5.
NX Integration for Systems Driven Product Adds the NX Integration for Systems Driven
Development Product Development.

Appendix
Active Workspace
Workspace features
features
Feature Description
4th Generation Product Master Allows users to:
• Relate designs to parts.
• View, navigate, and configure parts and their

uses.
This feature adds the 4th Generation

Product Master for Active Workspace
(fgb0aw4gbom_template.xml) template to the
database.
This feature is not selectable unless these
features are installed:
• Active Content Structure (under Server
Extensions)
• 4th Generation Product Master (under

Extensions→BOM Management)

install the 4th Generation Product Master
feature when building the Client web application.
NX P & ID Active Workspace Exposes NX P & ID in Active Workspace so that
users can view, navigate, and configure sheets
and their content.
This feature adds the NX P & ID Active
Workspace (nxp1pidaws_template.xml)
• NX Foundation under
Extensions→Teamcenter Integration for
NX

Extensions
• 4th Generation Design BOM Management

under Extensions→BOM Management
• MDConnectivity under
Extensions→Advanced PLM Services
• System Modeling under


Feature Description
• Diagramming under
• NX Piping and Instrument Diagram (P&ID)

Design under Extensions→Teamcenter
Integration for NX
• Systems Engineering under Server

Extensions

install the NX Integration feature (under Client)
Aerospace and Defense Aerospace and Defense features. These allow
Active Workspace users to:
• Create and view parts list: technical
documents, parts, drawings, and designs.
• Work with notes: create standard notes and

custom notes and attach them to technical
documents, parts, drawings, and designs.
• Work with Aerospace and Defense-related

changes: create, edit, and search change
requests, change notices, and deviation
requests in alignment with the out-of-the-box
Change Management functionality.
Aerospace and Defense Adds the Aerospace and Defense
Foundation Foundation Active Workspace
(ads1awadsfoundation_template.xml)
template to the database. This feature is not
selectable unless the following features are also
selected:
• Teamcenter Change Management
• Teamcenter Change Management (for
Active Workspace)
• Active Workspace Indexing Engine under
Active Workspace→Indexing Server
• Active Workspace Indexer under Active
Workspace→Indexing Server
• Active Workspace under Active
Workspace→Server Extensions
• Active Content Structure under Active

Appendix
Active Workspace
Workspace features
features
Feature Description
• Vendor Management under Active
• Aerospace and Defense Foundation
under Active Workspace→ Server
Extensions→Aerospace and Defense
• Aerospace and Defense Foundation under
Active Workspace→Client
• Active Workspace Client (Java EE) under
Active Workspace→Client
• Aerospace and Defense Change
Management under Active
Workspace→Client
Aerospace and Defense Change Installs the change management functionality
Management for the Aerospace and Defense Foundation
feature. This feature requires corresponding
Teamcenter features.
MRO Service Lifecycle Management features for
Active Workspace.
MRO Core Provides core Service Lifecycle Management
functionality for Active Workspace.
As-Built for Active Workspace Provides searching and BOM extensions
necessary to support MRO As-Built capabilities.
Rapid Start.
In addition to the Active Workspace feature,
this feature requires:
• Extensions→Maintenance Repair and
Overhaul→As-Built Management
Adds these templates to the database:

• MRO Core, Active Workspace BOM
Interface (smr1mrocoreaw_template.xml)
• As-Built (sab1asbuiltaw_template.xml)

Feature Description
As-Maintained Provides searching and BOM extensions
necessary to support MRO As-Maintained
capabilities.
Rapid Start.
Overhaul→As-Maintained Management

• MRO Core, Active Workspace BOM
Interface (smr1mrocoreaw_template.xml)
• As-Maintained
(sam1asmaintainedaw_template.xml)
Transaction Processing Installs transaction processing functionality for
Service Request Manager.
features.
Service Processing Installs service processing capability for Service
Request Manager.
features.
Service Event Provides searching and BOM extensions
necessary to support MRO Service Event
Management capabilities.
Rapid Start.
Extensions→MRO→As-Maintained

Overhaul→As-Maintained Management

Overhaul→Service Event Management

Appendix
Active Workspace
Workspace features
features
Feature Description
• Transaction Processing, Active

Workspace BOM Interface
(stp1transactionprocessingaw_template.xml)
• Service Processing, BOM Interface

(spr1serviceprocessingaw_template.xml)
• Service Event
(sem1serviceeventmgmtaw_template.xml)
Program Planning Execution Program Planning Execution features for Active
Workspace
Change Management Schedule Allows interaction between Schedule Manager
Manager and Change Management in Active Workspace.
It allows Active Workspace users to relate
schedules and change objects.
This feature adds the Change
Management Schedule Manager
(csi1cmsmawinterface_template.xml)
• Change Management under
Foundation
• Schedule Manager under Server

Extensions

install the Change Management Schedule
Manager feature (under Client→Program
Planning Execution Client) when building the
Program Change Allows interaction between Program Planning
Event Change and Change Management in
Active Workspace. It allows Active Workspace
users to relate programs, projects, and
subprojects to change objects.
This feature adds the Program Change
(pch0pchinterface_template.xml) template to
the database.

Feature Description

Foundation
• Program Planning under Server

Extensions
• Program Planning Infrastructure under

Extensions

install the Program Change Client feature
(under Client→Program Planning Execution
Program Planning Event Change Allows interaction between Program Planning
Schedule Manager and Program Change
Interface in Active Workspace. It allows Active
Workspace users to relate events to change
objects.
This feature adds the Program Planning Event
Change (pec0ppeventchange_template.xml)
Foundation

Extensions

Extensions
• Program Change under Server Extensions
If you are installing this feature, you should

also install the Program Planning Event
Change Client feature (under Client→Program
Planning Execution Client) when building the

Appendix
Active Workspace
Workspace features
features
Feature Description
Program Schedule Manager Allows interaction between Schedule Manager
and Program Planning in Active Workspace. It
allows Active Workspace users to create plan
level items to schedules and supports automatic
generation of schedules within a program.
This features adds the Program Schedule
Manager (psi0ppsminterface_template.xml)
Foundation

Extensions

Extensions
• Schedule Manager under Server

Extensions
• Program Change under Server Extensions
• Program Planning Event Change under

Server Extensions

install the Program Schedule Manager Client
feature (under Client→Program Planning
Execution Client) when building the Client web
application.
Reuse and Standardization Features to support Reuse and Standardization
in Active Workspace.
Classification Server Installs Classification support to Active
Workspace.
features.
Next Generation Classification Installs the Next Generation Classification
Server foundation feature for Library Management.
features.

Feature Description
Library Management Server Enables indexing for Library Management
business objects.
It adds the Library Management Server
(lbr1librarymgmtaw_template.xml) template to
the database.
The Library Management Server feature is
not selectable unless the Library Management
feature (under Extensions→Reuse and
Standardization) is also selected.
install the Library Management feature when
10.1.5.
Systems Driven Product Development Features to support Systems Driven Product
Development in Active Workspace.
LMS System Synthesis Modeling Exposes the System Synthesis artifacts, such
as model templates and core architecture,
in Active Workspace. These artifacts are
created in Teamcenter by System Synthesis,
a framework for the numerical integration of
heterogeneous behavioral models issued by
different authoring platforms, such as LMS
Amesim or MATLAB/Simulink.
This feature adds the System Synthesis
Modeling for Active Workspace
(ssm1systemsynthesismodelingaw_template.xml)
System Synthesis Modeling feature (under
Extensions→Systems Driven Product
Development) is also selected.
Measurable Attributes and Configures Active Workspace to interact with
Targets Measurable Attributes and Targets, providing
functionality such as retrieving the associated
measurable attributes from a parent object or
parent line.
This feature adds the Measurable Attributes
and Targets for Active Workspace
(att1attrtargetmgmtaw_template.xml)

Appendix
Active Workspace
Workspace features
features
Feature Description

Rapid Start.
• Extensions→Systems Driven Product
Development→Verification and Validation
Planning and Reporting
Selecting this feature automatically selects
these features in the same feature group:
Measurable Attributes and Targets

Attribute and Parameter Base
Definitions

Extensions→Systems Engineering

Development→Verification and Validation
Planning and Reporting
Selecting this feature automatically selects
the Measurable Attributes and Targets
feature in the same feature group.

install the Measurable Attributes and Targets
Client feature in the Client web application.
Verification and Validation Allows system engineers and validation
Planning and Reporting engineers to validate key performance
measurements of objects.
This feature adds the
crt1validationcontractaw_template.xml
Extensions
• Systems Engineering under Server

Extensions

Feature Description
• Verification and Validation Planning and

Reporting under Extensions→Systems
Driven Product Development

install the Verification and Validation Planning
and Reporting feature (under Client→Systems
Driven Product Development) when building
the Client web application.
Product Planning Features to support product planning in Active
Workspace.
Product Planning Product Planning (optional)
Exposes the Program Management capabilities
in Active Workspace so that users can associate
Application Models to Program Planning entities.
This feature adds the Product
Planning for Active Workspace
(pgp1awprgplanningapp_template.xml)
• Product Configurator under Extensions

Extensions

Extensions
• Product Planning under Extensions

Extensions
• Configurator Partition Interface under

Extensions
• Measurable Attributes and Targets under

Development
• Measurable Attributes and Targets under

Server Extensions→Systems Driven
Product Development

Appendix
Active Workspace
Workspace features
features
Feature Description

install the Product Planning feature (under
Consumer Product Management Features to support Consumer Product
Management in Active Workspace.
For more information, see Getting Started
with Consumer Product Management in the
Brand Management Installs the Brand Management template for
Consumer Product Management.
Consumer Product Management Installs consumer product management
functionality for Consumer Product Management.
Packaging and Artwork Installs packaging and artwork functionality for
Specification Management Installs specification management functionality
for Consumer Product Management.
Active Workspace Client features

Active Workspace client features are available in the Features panel in Teamcenter Environment
Manager (TEM), under Base Install→Active Workspace→Client.
To search for a feature by name, type the name or a partial name in the search box, and then click
the search icon.

Feature Description
Active Workspace Client (Java EE) (required) Selecting this feature builds the Java EE Client
web application.
This feature is required if you use the Active
Workspace Java EE client.
Active Workspace Client (.NET) (required) Selecting this feature builds the .NET Client
application.
This feature is required if you use the Active
Workspace .NET client.
Active Collaboration Adds workflow functionality to the client interface.
If you are installing this feature in the Client, you
must install the Active Collaboration Server
Extensions feature in the corporate server.
Audit Adds Audit Manager features to the Active
Workspace client.
For more information, see Audit Manager in the
DPV for Active Workspace Client Adds Dimensional Planning and Validation
functionality to the client interface.
Digital Signatures Adds digital signatures functionality to the client
interface.
Before selecting this feature, see the additional
setup requirements for digital signatures in
Configuration and Extensibility.
If you are installing this feature in the Client,
you must install the Digital Signatures Server
Server Extensions feature in the corporate
server.
Finish Management Installs Finish Management support for Active
Workspace. A finish represents a finishing
process on a part. It may be used to improve
appearance, adhesion, corrosion resistance,
tarnish resistance, chemical resistance, wear
resistance, and remove burrs and so on.
collection.
Logical Object Client Allows users to access logical object data in the
client interface.
Markup Enables markup capabilities in the client
interface.

Appendix
Active Workspace
Workspace features
features
Feature Description
Product Configurator Adds Product Configurator features to the Active
Workspace client. Product Configurator enables
you to formally introduce and manage variability
across your product suite.
For more information, see Product Configurator
in the Teamcenter help collection.
Program Planning Enables the Program Management capability
in Active Workspace. This feature provides the
ability to manage business investments, from
planning to execution, in terms of time, reuse,
volume, cost targets, and weight targets.
install the Program Planning feature under
Server Extensions.
Reporting Adds the ability to view report templates,
generate reports based on selected criteria, style
sheets, or both, and view them in HTML, Excel,
or raw XML formats in the client.
must install the Reporting Server Extensions
feature in the corporate server.
Additionally, to allow for asynchronous report
generation, install the AsyncService translator
in the Dispatcher Server.
Schedule Manager Enables Schedule Manager capabilities in Active
Workspace.
install the Schedule Manager feature under
Server Extensions on the corporate server.
10.1.5 or Teamcenter Rapid Start 10.1.5.
Service Manager Allows users to view disposition and utilization
history of physical parts in the Client.
Rapid Start 10.1.5 or Teamcenter Rapid Start
11.2.1.

Feature Description
Shape Search Enables shape search functionality in the client
interface. To use shape search, Geolus must be
installed and configured.
install the Shape Search feature (under Server
Extensions) when installing the corporate
server.
Rapid Start.
Stock Material Adds stock material management features for
the Active Workspace client.
Many parts are made from stock materials such
as bar stock, tubing stock and sheet stock. This
features enables you to manage stock materials
in Teamcenter, performing actions like creating
libraries of stock materials and assigning stock
materials to parts.
collection.
Subscription Allows users to manage subscriptions and
notifications in the client.
you must install the Subscription feature under
Server Extensions in the corporate server.
Relationship Browser If you are installing this feature, you must
also install the Relationship Viewer Server
Extensions feature on the corporate server.
Visualization Server Pool Assigner (.NET) Select this feature if you use the .NET web tier
and you plan to install the Visualization Server
Manager in order to use Visualization in the
Active Workspace Client.
install the Visualization Extension feature
under Server Extensions in the corporate
server.

Appendix
Active Workspace
Workspace features
features
Feature Description
Visualization Server Pool Assigner (Java EE) Select this feature if you use the Java EE web
tier and you plan to install the Visualization
Server Manager in order to use Visualization in
the Active Workspace Client.
install the Visualization Extension feature
under Server Extensions in the corporate
server.
Workflow For users to access Inbox components and
workflow functionality in the Client interface, this
feature must be installed.
install the Workflow feature under Server
Extensions on the corporate server.
Active Content Adds structure search functionality to the client
interface.
you must install the Active Content Structure
Server Extensions feature in the corporate
server.
Change Management Adds the ability to work with Change
Management objects in the client.
must install the Extensions→Enterprise
Knowledge Foundation→Change
Management feature in the corporate
server.
This is not available with Teamcenter Rapid Start
Linked Data Framework Provides a framework to link a Teamcenter
business objects with an artifact of a remote
linked data enabled system. It enables rendering
the remote system's delegated UIs in Active
Workspace.
install the Linked Data Framework feature
under Server Extensions.

Feature Description
4th Generation Design Allows users to view, navigate, and configure
collaborative designs and their content in the
Client.
must also install the 4th Generation Design
Server Extensions feature, the Active Content
Structure Server Extension feature, and the
4th Generation Design (under Advanced PLM
Services) feature on the corporate server.
In addition to the Active Workspace Client
(Java EE) feature, requires the Active Content
Client feature.
10.1.5, Teamcenter Rapid Start 10.1.5, or
Teamcenter Rapid Start 11.2.1.
4th Generation Product Master Allows users to:
• Relate designs to parts.
• View, navigate, and configure parts and their

uses.

must also install the 4th Generation Product
Master Server Extensions feature on the
corporate server.
10.1.5, Teamcenter Rapid Start 10.1.5, or
Teamcenter Rapid Start 11.2.1.
Architecture Modeler In addition to the Active Workspace Client
Client feature.
This is not available with Teamcenter Rapid Start
Branching and Versioning Adds support for branching and versioning in the
Active Workspace client.
MCAD Integration In addition to the Active Workspace Client
Client feature.

Appendix
Active Workspace
Workspace features
features
Feature Description
Material Management Enables Active Workspace users to:
• Associate a material revision with a vendor
part or an item revision.
• Associate a substance with a material

revision.
• View the material/substance dashboard.

the Material Management feature (under Server
Extensions) on the corporate server.
NX Integration Enables users to access NX integration
functionality from the client interface.
install the NX for Active Workspace feature
(under Server Extensions) on the corporate
server.
Requirements Management Allows users to author a requirement structure in
the Content tab of the client.
In addition to the Active Workspace Client
feature.
must install the Requirements Management
and Systems Engineering features under
Note
This feature is required to enable
the Export to Excel button in Active
Workspace.
Simulation Process Management In addition to the Active Workspace Client

Client feature.
install the Simulation Process Management
Server Extensions feature on the corporate
server.

Feature Description
Vendor Management Allows Active Workspace users to:
• Associate vendors with vendor parts.
• Associate vendor parts with commercial part

revisions.

install the Vendor Management feature under
(Server Extensions) on the corporate server.
Aerospace and Defense Foundation Adds the Aerospace and Defense Foundation
feature to the Active Workspace client.
you must install the Aerospace and Defense
Foundation Server Extension feature in the
corporate server and the following Active
Workspace Client features:
• Workflow
• Active Collaboration
• Active Content
• Vendor Management
Substance Compliance Provides Substance Compliance capabilities, for
example:
• Request a material substance declaration
(MSD).
• Request a conflict mineral declaration

(CMD).
• Review supplier declarations.
• Initiate compliance checks.
• Validate and import supplier declarations.
• View the compliance dashboard.
if you are installing this feature, you should also

install the Substance Compliance feature under

Appendix
Active Workspace
Workspace features
features
Feature Description
Systems Modeler Install this feature so that users can access
functionality in the Architecture toolbar of the
Client interface.
you must install the Systems Modeling Server
Extension feature in the corporate server and the
following Active Workspace Client features:
• Workflow
• Active Content
• Architecture Modeler
Substance Compliance IMDS Integration Provides integration with the International
Material Data System (IMDS).
Install this feature if you use IMDS with
Substance Compliance.
Program Planning Execution Client Program Planning Execution features for the
Change Management Schedule Allows interaction between Schedule Manager
Manager Client and Change Management in Active Workspace.
It allows Active Workspace users to relate
schedules and change objects.
you must install the Change Management
Schedule Manager Server Extension feature
in the corporate server and the following Active
• Schedule Manager
• Workflow
• Change Management
Program Change Client Allows interaction between Program Planning
Event Change and Change Management in
Active Workspace. It allows Active Workspace
users to relate programs, projects, and
subprojects to change objects.
you must install the Program Change Server
Extension feature in the corporate server and
select the following Active Workspace Client
features:

Feature Description
• Program Planning
• Workflow
Program Planning Event Change If you are installing this feature in the Client,
Client you must install the Program Planning Event
Change Server Extension feature in the
corporate server and select the following Active
• Workflow
• Program Change Client

Program Schedule Manager If you are installing this feature in the Client,
Client you must install the Program Change Server
Extension feature in the corporate server and
select the following Active Workspace Client
features:
• Schedule Manager
• Workflow
• Program Change Client
• Program Planning Event Change Client

Reuse and Standardization Features to support Reuse and Standardization
in the Active Workspace client.
Classification Client Allows users to access Classification data in the
client interface.

Appendix
Active Workspace
Workspace features
features
Feature Description
Library Management If you are installing this feature, you must also
install the Library Management Server Server
Extension feature and the Library Management
feature (under Extensions→Reuses and
Standardization) feature on the corporate
server.
10.1.x, Teamcenter Rapid Start 10.1.x, or
Teamcenter Rapid Start 11.x.
Systems Driven Product Development Features to support Systems Driven Product
Development in the Active Workspace. client
LMS System Synthesis Modeling Exposes the System Synthesis artifacts, such
as model templates and core architecture,
in Active Workspace. These artifacts are
created in Teamcenter by System Synthesis,
a framework for the numerical integration of
heterogeneous behavioral models issued by
different authoring platforms, such as LMS
Amesim or MATLAB/Simulink.
you must install the LMS System Synthesis
Modeling Server Extension feature in the
corporate server and the following Active
• Workflow
• Active Content
Verification and Validation Allows system engineers and validation
Planning and Reporting engineers to validate key performance
measurements of objects.
you must install the Verification and Validation
Planning and Reporting Server Extension
feature in the corporate server and the following
Active Workspace Client features:
• Workflow
• Active Content
• Architecture Modeler
Product Planning Features to support product planning in the

Feature Description
Product Planning Exposes the Program Management capabilities
in Active Workspace so that users can associate
application models to Program Planning entities.
install the Product Planning feature under
Consumer Product Management Features to support Consumer Product
Management in the Active Workspace client.
Brand Management Installs the Brand Management template for
Consumer Product Management Installs consumer product management
functionality for Consumer Product Management.
Packaging and Artwork Installs packaging and artwork functionality for
Specification Management Installs Specification Manager functionality for

Siemens Industry Software
Headquarters
Europe
Granite Park One
Stephenson House
5800 Granite Parkway
Sir William Siemens Square
Suite 600
Frimley, Camberley
Plano, TX 75024
Surrey, GU16 8QD
USA
+44 (0) 1276 413200
+1 972 987 3000
Asia-Pacific
Americas
Suites 4301-4302, 43/F
Granite Park One
AIA Kowloon Tower, Landmark East
5800 Granite Parkway
100 How Ming Street
Suite 600
Kwun Tong, Kowloon
Plano, TX 75024
Hong Kong
USA
+852 2230 3308
+1 314 264 8499
About Siemens PLM Software
© 2017 Siemens Product Lifecycle Management

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

Deployment

Încărcat de

Informații document

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Deployment

Încărcat de

Drepturi de autor:

Formate disponibile

SIEMENS

Active Workspace 3.4

What is Active Workspace? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Installation strategies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

AW001 3.4 Deployment 3

Install classification libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-102

Patching and upgrading Active Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Active Workspace features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

4 Deployment AW001 3.4

What is Active Workspace?

AW001 3.4 Deployment 1-1

Active Workspace components

1-2 Deployment AW001 3.4

AW001 3.4 Deployment 1-3

• A .NET-based web application (awc.zip) deployed on Microsoft IIS.

o Standalone Indexing Mode

1-4 Deployment AW001 3.4

o Dispatcher-Based Indexing Mode

• Visualization Data Server (optional)

AW001 3.4 Deployment 1-5

o The Teamcenter four-tier web application (Java EE or .NET) must be deployed.

■ A minimum of 16 GB of free physical RAM (unused by other applications) to avoid paging.

■ Windows server operating system.

■ Windows Server operating system.

■ The .NET Client web application supports deployment on IIS only.

1-6 Deployment AW001 3.4

◊ Server class hardware using the following graphics cards:

o Visualization Data Server (optional)

■ Windows Server 64-bit 2012 R2 or Windows Server 64-bit 2008 R2.

AW001 3.4 Deployment 1-7

■ Virtual machine deployment is supported.

■ There are no graphics card requirements.

1-8 Deployment AW001 3.4

Initial version Target version Process

AW001 3.4 Deployment 1-9

Initial version Target version Process

1-10 Deployment AW001 3.4

Parallel versus series installation of Active Workspace components

• Install Active Workspace components in series.

AW001 3.4 Deployment 2-1

Teamcenter values needed to install Active Workspace components

Values from the Teamcenter four-tier environment

2-2 Deployment AW001 3.4

Active Workspace values needed for parallel installation of components

Values from Active Workspace components

AW001 3.4 Deployment 2-3

Order of installation tasks

2-4 Deployment AW001 3.4

AW001 3.4 Deployment 2-5

Server Extensions overview

Values required before beginning the Server Extensions taskflow

Values to record during the Server Extensions taskflow execution

2-6 Deployment AW001 3.4

Server Extensions prerequisites

Prerequisites for installing the Server Extensions:

• Supported version of Teamcenter

• UNIX and Linux Server Installation→Additional configuration and maintenance→Installing

Values from the Teamcenter four-tier environment

AW001 3.4 Deployment 2-7

Install the Active Workspace patch on the Teamcenter servers

2. Expand the Active Workspace 3.4 software kit to a local directory.

4. Launch TEM for the corporate server.

5. In the Maintenance panel, select Updates Manager.

6. Proceed to the Apply Updates panel and enter required paths: