0% found this document useful (0 votes)

43 views172 pages

Installation

Active Workspace 6.0 is a web-based client for Teamcenter, a product lifecycle management platform, and its installation involves several phases including planning, building, testing, deploying, and maintaining the environment. The document outlines the installation process, software requirements, and provides guidance on accessing documentation and software downloads. It emphasizes the need for proper configuration and ongoing updates to ensure optimal performance and compliance with Siemens' licensing agreements.

Uploaded by

Juan Pereira

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

43 views172 pages

Installation

Uploaded by

Juan Pereira

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

Active Workspace 6.

Active Workspace
Installation
Active Workspace 6.0
AW001 - 6.0
Unpublished work. © 2021 Siemens

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

This document is for information and instruction purposes only. Siemens reserves the right to make changes in specifications
and other information contained in this publication without prior notice, and the reader should, in all cases, consult Siemens to
determine whether any changes have been made. Representations about products, features or functionality in this document
constitute technical information, not a warranty or guarantee, and shall not give rise to any liability of Siemens whatsoever.
Siemens disclaims all warranties including, without limitation, the implied warranties of merchantability and fitness for a
particular purpose. In particular, Siemens does not warrant that the operation of the products will be uninterrupted or error
free.
The terms and conditions governing the sale and licensing of Siemens products are set forth in written agreements between
Siemens and its customers. Siemens' End User License Agreement and Universal Contract Agreement may be viewed at: https://
www.sw.siemens.com/en-US/sw-terms/
TRADEMARKS: The trademarks, logos, and service marks ("Marks") used herein are the property of Siemens or other parties. No
one is permitted to use these Marks without the prior written consent of Siemens or the owner of the Marks, as applicable. The
use herein of third party Marks is not an attempt to indicate Siemens as a source of a product, but is intended to indicate a
product from, or associated with, a particular third party. A list of Siemens' trademarks may be viewed at:
www.plm.automation.siemens.com/global/en/legal/trademarks.html. The registered trademark Linux® is used pursuant to a
sublicense from LMI, the exclusive licensee of Linus Torvalds, owner of the mark on a world-wide basis.

About Siemens Digital Industries Software

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

Support Center: support.sw.siemens.com

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

Contents

Installing Teamcenter with Active Workspace 1-1

Where to start
Get documentation ──────────────────────────────────── 2-1
Get software ──────────────────────────────────────── 2-2
Get started ───────────────────────────────────────── 2-4

Installing Teamcenter microservices

Microservices and the microservice framework ────────────────── 3-1
Deploy Docker for microservices on Linux hosts ────────────────── 3-2
Deploy a Docker container registry ────────────────────────── 3-5
Install microservices using TEM ──────────────────────────── 3-7
Install microservices using TEM - Linux host (Docker swarm) ────────────── 3-7
Install microservices using TEM - Windows host ───────────────────── 3-11
Add microservice framework support to a Java EE web tier ────────────── 3-15
Add microservice framework support to a .NET web tier ──────────────── 3-19
Install microservices using Deployment Center ────────────────── 3-20
Install microservices on a Linux host using Deployment Center ──────────── 3-20
Install microservices on a Windows host using Deployment Center ────────── 3-23
Add microservice instances for a Linux host ──────────────────────── 3-25
Add microservices and microservice nodes on a Windows host ──────────── 3-26
Start microservices in Docker Swarm ──────────────────────── 3-26
Join a server to a Docker Swarm ─────────────────────────── 3-27
Start microservices in Kubernetes ────────────────────────── 3-28
Manage microservice instances on Windows hosts ─────────────── 3-29
Finding microservice logs on Windows hosts ─────────────────── 3-30
Redirect microservice logs on Windows hosts ─────────────────── 3-31
Securing microservices ───────────────────────────────── 3-32
Configuring microservices for HTTPS ──────────────────────────── 3-32
Configure service dispatcher as an HTTPS server ───────────────────── 3-33
PKI key requirements for microservices ────────────────────────── 3-42
High availability for microservices ────────────────────────── 3-43
Troubleshooting microservices ──────────────────────────── 3-47

Installing Active Workspace

Active Workspace components installation overview ─────────────── 4-1
Active Workspace Server Extensions ───────────────────────── 4-2
Server Extensions overview ────────────────────────────────── 4-2
Install Server Extensions features ─────────────────────────────── 4-4
Install database triggers manually ────────────────────────────── 4-5
Active Workspace client components ───────────────────────── 4-8

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3

© 2021 Siemens
Active Workspace client overview ────────────────────────────── 4-8
Install Active Workspace microservices ─────────────────────────── 4-9
Install Active Workspace Gateway ────────────────────────────── 4-11
Install the Active Workspace client ───────────────────────────── 4-18
Sign in using the Active Workspace interface ─────────────────────── 4-20
Indexing ────────────────────────────────────────── 4-22
Prepare to install indexing ────────────────────────────────── 4-22
Configure Classification Search (optional) ───────────────────────── 4-23
Install Dispatcher ───────────────────────────────────── 4-23
Visualization Server ─────────────────────────────────── 4-24
Visualization Server overview ──────────────────────────────── 4-24
Should I use client-side or server-side rendering? ──────────────────── 4-28
Should I use MMV? ─────────────────────────────────────── 4-29
Visualization Server Manager ──────────────────────────────── 4-30
Visualization Server Pool Assigner ───────────────────────────── 4-40
Visualization Data Server (optional) ──────────────────────────── 4-44
Install the Active Workspace Launcher ─────────────────────── 4-53
Install classification libraries ───────────────────────────── 4-55
Verify Active Workspace installation ──────────────────────── 4-56

Updating Active Workspace and microservices

Patch Active Workspace 4.3 or later ────────────────────────── 5-1
Patch Active Workspace 4.2 or earlier ───────────────────────── 5-2
Complete the Active Workspace update ─────────────────────── 5-4
Remerge Solr and Teamcenter schemas and update the index ───────────── 5-4
Additional postupdate steps ────────────────────────────────── 5-5
Publishing changes to the Active Workspace file repository ────────── 5-7

Active Workspace features reference

Active Workspace Server Extensions features ─────────────────── A-1
Active Workspace Client features ────────────────────────── A-24
Active Workspace microservices features ───────────────────── A-36

Load balancing Active Workspace components B-1

Required RPM package managers C-1

4 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

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

A Teamcenter administrator performs the Teamcenter/Active Workspace installation in phases:

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

Build
Install essential software components like a database server
and license server. Then, install Teamcenter and Active
Workspace software in a development environment in
which you connect and test applications and components,
and configure the Active Workspace interface.

Test
Validate your development environment to ensure your
configuration is successful.

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

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

This cycle begins again when you upgrade to a new major version of Teamcenter, starting with planning
the upgrade, and then continuing the other phases.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 1-1

A Teamcenter environment with Active Workspace requires software for the Teamcenter platform,
microservice framework, and Active Workspace.

Installing Active Workspace 6.0 requires installing or updating each of these products. The process you
follow depends on the Teamcenter and Active Workspace software you currently have installed.

To install Teamcenter with Active Workspace, find the row below that describes your current
environment, then follow the corresponding process to install or update to Active Workspace 6.0. Solid
boxes indicate installed software, hollow boxes indicate software to be installed.

1-2 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Follow this process If your starting point is And you want to

Install a new environment No existing Teamcenter Install Teamcenter
environment and Active
Workspace

Add Active Workspace to a Teamcenter Teamcenter without Active Add Active

environment Workspace Workspace

Move to Active Workspace with microservices Teamcenter and Active Update to Active
Workspace without Workspace 6.0
microservices
(Active Workspace 4.2 or
earlier)

Update a current Teamcenter/Active Workspace Current Teamcenter with Update to Active

environment Active Workspace Workspace 6.0
(Active Workspace 4.3 or
later)

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 1-3

1-4 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

• Support Center
Siemens Digital Industries Software's comprehensive support portal, which provides documentation
for all Siemens software products and versions.
The Siemens Secure Documentation Proxy provides secure, easy access to documentation without a
need to log on, through a personalized API key specific to your site.

• Siemens Documentation Server

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

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

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

Installing Siemens Secure

Documentation Proxy Installing Siemens Documentation Server

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

Documentation Proxy to access
documentation on Support 2. Install documentation for your software products.
Center. Each documentation kit contains documentation content and
an installation wizard that automatically installs documentation
onto your Documentation Server.
Documentation kits (docs-product-name-and-version-
locale.zip) are available from the Downloads pages for each
product on Support Center.

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

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

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 2-1

Enable Active Workspace access to documentation

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

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

1. In Active Workspace, open Command Builder.

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

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

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

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

Get software
Installing or updating Active Workspace requires software for microservice framework and Active
Workspace.

Download microservice framework software

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

TcMicroserviceFramework6.0.0_wntx64.zip

TcMicroserviceFramework6.0.0_lnx64.zip

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

Download Active Workspace software

From the Teamcenter downloads page on Support Center, download the Active Workspace 6.0 software
kit for your version of Teamcenter and for your platform type:

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

282219420/doc/PL20210421143110249.xid1899337/html/xid1899339.

2-2 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Windows:

Tcversion_ActiveWorkspace6.0.0_wntx64.zip

Linux:

Tcversion_ActiveWorkspace6.0.0_lnx64.zip

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

Note:
Active Workspace 6.0 supports multiple versions of Teamcenter. Take care to download the correct
software kit for your version of Teamcenter.

Stage the software kits

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

Deployment Center

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

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

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

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

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

Teamcenter Environment Manager (TEM)

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

Can I place the software in a remote location?

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

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 2-3

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

Teamcenter Environment Manager (TEM)

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

net use drive-letter: UNC-path

For example:

net use z: \\mediaserver\tcmedia

If you mount software kits on a remote NFS server, you must launch Teamcenter Environment
Manager on the local server node.

Get started
A Teamcenter environment with Active Workspace requires software for the Teamcenter platform,
microservice framework, and Active Workspace.

Installing Active Workspace 6.0 requires installing or updating each of these products. The process you
follow depends on the Teamcenter and Active Workspace software you currently have installed.

Find the image below that describes your current environment, then follow the corresponding process
to install or update to Active Workspace 6.0. Solid boxes indicate installed software, outlined boxes
indicate software to be installed.

Install a new Add Active Workspace Move to Active Update a current

environment Workspace with Teamcenter/Active
microservices1

1 Use this process if your current Active Workspace version is 4.2 or earlier.

2-4 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Workspace
environment3

Install a new environment

If you have no existing Teamcenter environment, you install the Teamcenter platform,
then add the microservice framework, then add Active Workspace:

1. Install the Teamcenter platform as described in the appropriate Teamcenter server

installation guide for Windows or Linux.
Make sure you install a Teamcenter version supported for Active Workspace 6.0.
For supported combinations of Teamcenter with Active Workspace, see the
Hardware and Software Certifications knowledge base article on Support Center.

2. Install and configure the microservice framework. This includes:

• Installing the microservice framework.

• Installing the microservice proxy (microservice support for the web tier).
• Starting the microservice node and any additional configuration for your
platform type.

3. Install Active Workspace. This includes:

• Active Workspace server extensions

• Active Workspace client
• Indexing
• Visualization Server
• Other components, according to your business needs

Add Active Workspace to a Teamcenter environment

If you are adding Active Workspace to an existing Teamcenter environment, you must
install the microservice framework before you install Active Workspace:

1. Update your Teamcenter environment (patch or upgrade) to a version supported

for Active Workspace 6.0.

3 Use this process if your current Active Workspace version is 4.3 or later.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 2-5

Make sure you update every server in your environment.

For supported combinations of Teamcenter or Teamcenter Rapid Start with Active
Workspace, see the Hardware and Software Certifications knowledge base article
on Support Center.

2. Install and configure the microservice framework. This includes:

• Installing the microservice framework.

• Installing the microservice proxy (microservice support for the web tier).
• Starting the microservice node and any additional configuration for your
platform type.

3. Install Active Workspace. This includes:

• Active Workspace server extensions

• Active Workspace client
• Indexing
• Visualization Server
• Other components, according to your business needs

Move to Active Workspace with microservices

Active Workspace architecture changed in Active Workspace 4.3, replacing the Active
Workspace WAR file and .NET client with a system of microservices and an Active
Workspace Gateway.
If you are running Active Workspace 4.2 or earlier, you must install microservice
framework before you update to Active Workspace 6.0.

1. Update your Teamcenter environment (patch or upgrade) to a version supported

for Active Workspace 6.0.
Make sure you update every server in your environment.

2. Install and configure the microservice framework. This includes:

• Installing the microservice framework.

• Installing the microservice proxy (microservice support for the web tier).

• Starting the microservice node and any additional configuration for your
platform type.

3. Update Active Workspace:

a. Update the Active Workspace environment.

2-6 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

b. Publish changes to the file repository.

Update a current Active Workspace environment

If you are running Active Workspace 4.3 or later, your environment includes the
microservice framework. To update to Active Workspace 6.0, you update the
microservice framework and Active Workspace:

1. Update your Teamcenter environment (patch or upgrade) to a version supported

for Active Workspace 6.0.
Make sure you update every server in your environment.

2. Patch microservice framework.

Make sure you patch every server in your environment.
On Linux microservice nodes, to ensure new Docker images are used, redeploy
them using the updated .yml files.

3. Update Active Workspace:

a. Patch Active Workspace.

Make sure you patch every server in your environment.

b. Update the Active Workspace environment.

c. Publish changes to the file repository.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 2-7

2-8 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

© 2021 Siemens
3. Installing Teamcenter microservices
Microservices and the microservice framework
Various Teamcenter solutions and applications include microservices as part of their deployment. For
example:

• The Active Workspace client requires DARSI, TcGQL, and File Repository microservices.
The File Repository provides centralized temporary storage for Active Workspace client content
accessed through the Active Workspace Gateway. This storage gives other microservices an
alternative to the File Management System (FMS).

• The Classification and Requirements Manager applications each have their own required
microservices.

• The Product Configurator application can optionally employ its application-specific microservice to
achieve better performance.

The microservice framework enables microservices to run seamlessly across diverse platforms.

To install the microservice framework and the microservices that run on it, you must configure and
deploy a microservice node. If the server hardware has sufficient capacity, you can deploy a microservice
node on the same hardware as a Teamcenter pool manager.

To increase capacity and provide failover, the microservice framework can include multiple nodes. For
Linux deployments, a single node configuration is reused by the Docker swarm or the Kubernetes
cluster. For Windows deployments, you can add and configure worker microservice nodes in addition to
a master microservice node.

Note:
Support for deploying microservices into a Kubernetes environment is not yet certified.
Certification of deployment into Kubernetes is planned for a later release.

All microservice nodes in a Teamcenter environment must be hosted on servers of a single operating
system type. The following table compares the characteristics of microservice nodes hosted on Linux
and Windows.

Linux 64-bit Windows 64-bit

Prerequisite third- On the microservice node: None
party software
• Docker
• Kubernetes (only if deploying into a Kubernetes
environment)

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-1

Linux 64-bit Windows 64-bit

In a location accessible from the microservice
node:

• A container registry
Management of Docker Swarm or Kubernetes starts, stops, restarts, On Windows, each
microservice and scales all Teamcenter microservices running as microservice framework
framework and containers in a way that best utilizes resources. node includes a Teamcenter
application process manager to handle
microservices the microservices on that
node.

Microservice framework constituents

The microservice framework has the following constituents:

Service Registry Maintains a list of running microservice instances across all nodes.
Service Dispatcher Receives microservice requests from a Teamcenter client, queries the service
registry to find an instance of the requested microservice, and then routes
the request to an instance of the microservice.
Microproxy Forwards web tier application requests to the service dispatcher.
Process manager Manages microservices on the node (Windows hosts).
(Windows hosts)
You can use a web-based utility to dynamically adjust the quantity of
microservice instances managed by the process manager.
Microservice Parameter Manages logging levels for microservices.
Service (MPS)
File Repository Manages files for Active Workspace and microservices.

Deploy Docker for microservices on Linux hosts

On Linux hosts, the microservice framework uses Docker. Before microservice nodes can be deployed on
Linux hosts, you must first deploy a container registry and install Docker on the hosts.

• Install and configure Docker

• Configure IPv4 forwarding on the Docker host machine
• Working with Docker containers
• Docker troubleshooting

Install and configure Docker

For certified versions of Linux and Docker software, refer to the Hardware and Software Certifications
knowledge base article on Support Center.

3-2 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Deploy the Docker swarm based on the installation instructions at https://docs.docker.com.

Deployment requires the following steps at a minimum:

1. Install Docker.

2. Configure Docker to restart on system boot.

Configure IPv4 forwarding on the Docker host machine

Docker requires that IP forwarding be enabled on the host machine for successful communication
between Docker containers and the host machine. Docker installation alters the Linux iptables to allow
forwarding of packets between the host and bridge networks when such forwarding is enabled. See
Docker documentation for information on how to partially restrict forwarding (based on IP addresses)
for tighter security.

IP forwarding is controlled by Linux kernel parameters such as net.ipv4.ip_forward and

net.ipv4.conf.all.forwarding, depending on the distribution and version of Linux. To check the current
setting, you can use the command sysctl net.ipv4.ip_forward (sudo or root access is required). The
value 0 disables forwarding; the value 1 enables forwarding.

1. To temporarily enable IP forwarding for testing, run the following command:

sysctl -w net.ipv4.ip_forward=1

2. To restart docker, run the following command:

systemctl restart docker

3. To preserve this setting across a machine reboot, edit the file /etc/sysctl.conf and set
net.ipv4.ip_forward to 1.

Working with Docker containers

Use common Docker commands to control the environment and monitor the status. Additionally, many
open source tools, such as Portainer, are available to help manage a Docker swarm.

Commonly used Docker commands

To do this Run this command

List the Docker container stacks. docker stack ls
List the services currently running. docker service ls
Display the last five lines that were output docker service logs -f --no-task-ids --tail 5 service_id
by a particular service.
A service_id has the form stackname_servicename.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-3

To do this Run this command

List the nodes in a swarm. docker node ls
List the images registered in the container docker image ls
registry on a node.

Managing containers with Portainer

Portainer https://portainer.io/ is an open source product that provides a web-based UI to easily
manage Docker swarms, services, and containers. You can use Portainer to do the following:

• View Docker container log files.

• View the Docker applications (stacks) that have been started.

• View the status and location of running services.

• Manage the nodes in a swarm and temporarily adjust scaling of services across the swarm.

Docker troubleshooting

What do I do when I receive the error Cannot connect to the Docker daemon ?
1. To check whether dockerd is running, run

ps -eaf | grep dockerd

2. Perform remedial steps depending on the result from Step 1.

If dockerd is Then do this

Not running Restart Docker, and configure dockerd to restart on the next boot:

sudo systemct1 start docker

sudo systemct1 enable docker
Running The user is likely not a member of the Docker Linux group.
Add the user to the group. Ignore any error output from groupadd.

sudo groupadd docker

sudo usermod -aG docker $USER

For more debugging information, refer to configuring the Docker daemon in the documentation at
https://docs.docker.com.
What do I do if a Docker command does not behave as expected?
If the Docker command does not behave as expected, add the -debug option, run the command
again, and review the log for issues.

3-4 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Example:
You run the command docker deploy -f mystack.yml mystack and it does not behave as
expected.
To enable logging, insert -debug after docker:
docker -debug deploy -f mystack.yml mystack.

How do I view logs from the Docker daemon?

To view logs from the Docker daemon, open a new shell and enter the following:

sudo journalctl -fu docker.service

This tails the log files and keeps outputting new log commands until the command prompt is closed
or you enter Ctrl-C.
Where can I get help with more complicated environments?
For help with more complicated environments and networking when microservice nodes are on
Linux hosts, see the Docker engine swarm mode documentation at https://docs.docker.com/.

Deploy a Docker container registry

For deployments of the microservice framework and microservices on Linux hosts, microservice
container images are stored in a container registry. If you do not already have a container registry in
your infrastructure, you can use the following procedure to deploy a Docker container registry.

For detailed documentation on Docker Registry, see https://docs.docker.com/registry/.

Prerequisites
• Docker must be installed on both the machine that is used to initially fetch the Docker registry
container image and on the machine that will host the Docker registry. For instructions on
installing Docker, refer to Install and configure Docker.

• If the microservice framework is to be deployed on a Kubernetes cluster, Kubernetes must be

installed on the container registry machine in addition to Docker.

• For a secure production environment, a PKI certificate and keys generated for the Docker
container registry server must be available. It is a good practice to obtain certificates from a
Certificate Authority.

1. Prepare to fetch the Docker registry container image. On a machine with internet access and with
Docker installed, extract the microservice framework Linux kit.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-5

This machine is not necessarily the intended Docker registry server. In such a case, its host
operating system can be either Linux or Windows. In any case, Docker must be installed in order to
run the command to fetch the Docker registry image.

2. Browse to the extracted kit subdirectory \additional_applications\docker_registry.

3. Depending on the machine operating system, run the script to fetch the tested version of the
Docker registry container image.

Linux getDockerRegistry.sh
Windows getDockerRegistry.bat

4. As needed, move the fetched .tar file to the machine that will run the Docker registry service. Load
the image.

docker image load -l tar_file_name

5. Deploy the registry for the planned microservice framework type, either a Docker swarm or a
Kubernetes cluster.

a. Create the following directories:

/scratch/docker_registry/data

/scratch/docker_registry/certs

/scratch/docker_registry/auth

3-6 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

If you use different paths, update the YML or YAML configuration files in the corresponding
subdirectories of the microservice framework kit:

kit\additional_applications\docker_registry\deploy\swarm or kubernetes

b. Add your certificate files to /scratch/docker_registry/certs.

See https://docs.docker.com/registry/deploying/#run-an-externally-accessible-registry

c. Restrict access.

See https://docs.docker.com/registry/deploying/#restricting-access

d. Deploy the registry to a new stack. This new stack is unrelated to Teamcenter, Active
Workspace, and the microservice framework.

For this environment Issue these commands

Docker swarm docker stack deploy -c path/docker_registry.yml tcregistry

Kubernetes cluster kubectl create namespace tcreg

kubectl apply -f path/docker_registy.yaml -n tcregistry

Caution:
Deploy to a unique cluster or stack separate from Teamcenter microservices. This
protects the running registry if you delete the Teamcenter microservices Docker swarm
stack or Kubernetes cluster.

Validate functionality of Docker Registry

After you deploy the registry, check to see that it is running.

1. Run the following command to list the registry contents.

curl --cacert /scratch/docker_registry/certs/domain.crt https://vcl6006:5000/v2/_catalog

The valid response shows an empty repository, as nothing has been pushed to it yet:

{"repositories":[""]}

Install microservices using TEM

Install microservices using TEM - Linux host (Docker swarm)

As an administrator, you can use the following procedure to create a microservice node for a Docker
swarm deployment of microservices on a Linux host. This procedure cannot be used to install a

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-7

microservice node for a Kubernetes cluster deployment of microservices. A Kubernetes deployment

must be accomplished using Deployment Center.

Only one microservice node must be installed for a Docker swarm deployment. Additional servers can be
joined to the swarm once the microservices stack is started on this node. For failover, additional nodes
can be installed.

Before you install microservices:

• Review Microservices and the microservice framework for a comparison of the microservice
framework requirements in different environments and a list of framework constituents.

• Deploy a Docker container registry.

• Install a certified version of Docker on the host.

For certified versions of Linux and Docker software, see the Hardware and Software Certifications
knowledge base article on Support Center.

• Download the microservice framework software kit (TcMicroserviceFramework6.0.0_platform.zip)

from the Siemens Digital Industries Software download site. Expand the kit to a local directory.

Add the microservice kit to TEM

Add the microservice kit to Teamcenter Environment Manager (TEM).

For this task Perform these steps

Install a new 1. Launch TEM (tem.sh) from the Teamcenter software kit.
Teamcenter
environment 2. Proceed to the Install/Upgrade Options panel and click Install.

3. Proceed to the Media Locations panel. In the Update Location box, enter the
path to the microservice framework software kit.
If you are installing a minor release of Teamcenter, enter the path to the major
release software kit in the Original Media Location box.

4. In the Configuration panel, enter an ID and description for the Teamcenter

configuration.

5. Proceed to the Features panel, and then install Teamcenter microservices.

Update an 1. Stop all Teamcenter services except FSC services.
existing
Teamcenter 2. Launch TEM from its installed location (TC_ROOT/install).
environment
3. In the Maintenance panel, select Updates Manager.

3-8 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

For this task Perform these steps

4. In the Apply Updates panel, enter the required paths:
Update kit Enter the path to the expanded microservice framework
location software kit.
Backup Enter a path in which to create backups of files replaced
directory during the update.
Original Enter the path to the software kit for the installed Teamcenter
Media major version.
Location

5. Proceed to the Confirmation panel and click Start to add microservice features
to TEM.
When the update is complete, close TEM.

6. Launch TEM as specified in step 2.

7. In the Configuration Maintenance panel, select Perform maintenance on an

existing configuration.

8. In the Old Configuration panel, select the configuration to update.

9. In the Feature Maintenance panel, select Add/Remove Features.

10. Proceed to the Features panel, and then install Teamcenter microservices.

Install Teamcenter microservices

1. In the Features panel in TEM, under Microservices, select Microservice Framework and the
microservices you want to install.

2. Proceed to the Microservice Framework panel and specify values.

a. Enter the Container Registry URL consisting of a host name or a fully qualified domain name
and an optional port. Do not include a protocol in the URL. Additionally, enter the Container
Repository Name where the microservice images will be stored. The repository name must
already be defined in the container registry.

b. Enter a Keystore Password to be used for generating the .p12 files that contain keys for
signing and validating authentication tokens. These tokens identify the logged on Teamcenter
user.

Record and securely store the password for potential use in case you want to open and edit
the keys.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-9

c. In Dispatcher Port, type the port for the service dispatcher.

On Linux hosts, the microservice framework service registry is handled internally. If only one
node and service registry is configured in the environment, then no additional service registry
URL value is needed in .yml files.

When multiple service registry services are set up for failover support, edit
tc_microservice_framework.yml to list additional service registry services. Modify
microservice .yml files to list the additional Eureka service registry URL.

Example:
{
"eureka1":{
"image":"eureka_server-1.9.12_1.2.1",
"environment":[
"ARGS=-Deureka.serviceUrl.default=
http://eureka1:8787/eureka/v2,
http://eureka2:8787/eureka/v2,
http://eureka3:8787/eureka/v2"
"JETTY_PORT=8787"
]
}
}
{
"eureka2":{
"image":"eureka_server-1.9.12_1.2.1",
"environment":[
"ARGS=-Deureka.serviceUrl.default=
http://eureka1:8787/eureka/v2,
http://eureka2:8787/eureka/v2,
http://eureka3:8787/eureka/v2"
"JETTY_PORT=8787"
]
}
}
{
"eureka3":{
"image":"eureka_server-1.9.12_1.2.1",
"environment":[
"ARGS=-Deureka.serviceUrl.default=
http://eureka1:8787/eureka/v2,
http://eureka2:8787/eureka/v2,
http://eureka3:8787/eureka/v2"
"JETTY_PORT=8787"
]
}
}

3. Proceed to the Microservices panel. Review the instance quantity for each service that you want to
be available in the Docker swarm. Increase the instance quantity as needed to handle system load.

4. Proceed to the File Repository Microservice panel and enter parameter values.

3-10 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

File Repository Storage Location is the path to the location for temporary file storage as needed
by microservices and Active Workspace client content accessed through the Active Workspace
Gateway.

5. Proceed through the remaining panels and enter configuration values for your selected
microservices.

6. Review the Confirmation panel and click Start to begin the installation.

The framework and microservices are installed, and signer and validator keys are generated.

7. When installation is complete, carefully examine any messages to determine what post-installation
steps are necessary.

8. Add microservices support to the Teamcenter web tier, as applicable for Java EE or .NET web tier
architecture.

9. Start the Docker swarm and the microservice stack.

Install microservices using TEM - Windows host

Before you install microservices:

• Review Microservices and the microservice framework for a comparison of the microservice
framework requirements in different environments and a list of framework constituents.

• Download the microservice framework software kit (TcMicroserviceFramework6.0.0_platform.zip)

from the Siemens Digital Industries Software download site. Expand the kit to a local directory.

Add the microservice kit to TEM

Add the microservice kit to Teamcenter Environment Manager (TEM).

For this task Perform these steps

Install a new 1. Launch Teamcenter Environment Manager (TEM) with administrative privileges.
Teamcenter In the Teamcenter software kit, right-click the tem.bat program icon and
environment choose Run as administrator.

2. Proceed to the Install/Upgrade Options panel and click Install.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-11

For this task Perform these steps

4. In the Configuration panel, enter an ID and description for the Teamcenter
configuration.

5. Proceed to the Features panel, and then install Teamcenter microservices.

Update an 1. Stop all Teamcenter services except FSC services.
existing
Teamcenter 2. Launch TEM from its installed location, with administrative privileges.
environment Choose Start > Teamcenter version, right-click Environment Manager and
choose Run as administrator.

3. In the Maintenance panel, select Updates Manager.

4. In the Apply Updates panel, enter the required paths:

Update kit Enter the path to the expanded microservice framework
location software kit.
Backup Enter a path in which to create backups of files replaced
directory during the update.
Original Enter the path to the software kit for the installed Teamcenter
Media major version.
Location

5. Proceed to the Confirmation panel and click Start to add microservice features
to TEM.
When the update is complete, close TEM.

6. Launch TEM as specified in step 2.

7. In the Configuration Maintenance panel, select Perform maintenance on an

existing configuration.

8. In the Old Configuration panel, select the configuration to update.

9. In the Feature Maintenance panel, select Add/Remove Features.

10. Proceed to the Features panel, and then install Teamcenter microservices.

Install Teamcenter microservices

1. In the Features panel in TEM, under Microservices, select Microservice Framework and the
microservices you want to install.

2. Proceed to the Microservice Framework panel and specify values.

3-12 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

a. Choose the node type to install, either Master Node or Worker Node.

A master microservice node is required in an environment.

b. If you are installing a master microservice node, then enter a Keystore Password to be used
for generating the .p12 files that contain keys for signing and validating authentication
tokens. These tokens identify the logged on Teamcenter user.

Record and securely store the password for potential use in case you want to open and edit
the keys.

c. If you are installing a worker microservice node, then in Keystore ZIP file enter the location
of the keys.zip file that was generated when the master node was installed.

The keystore ZIP file (keys.zip) was copied to the TC_ROOT/jwt_config_tool directory of the
master microservice node host. For your convenience when installing a worker microservice
node, copy that file to a location on the local machine and in Keystore ZIP file point to that
local copy. For security, a best practice is to delete the copy of keys.zip from the local
machine after the worker node installation is complete.

d. Enter parameter values for the service dispatcher and service registry:

Service Dispatcher parameters:

Install On a master microservice node, the service dispatcher is required and

Microservice preselected. On a worker microservice node, you may optionally install the
service dispatcher for failover or scalability.
Dispatcher Type the port for the service dispatcher that will run on this host.
Port
Additional Type the URLs for additional endpoints for accessing the service dispatcher.
URLs This field can be empty or can include URLs for one or more microservice
nodes. Use a comma to separate multiple URLs. For example:

http://masternode_1:9090,http://workernode1:9090,http://
workernode2:9090

If service dispatchers are configured on multiple nodes (Windows hosts) in

an environment, the file service_dispatcher.json on each node must list all
instances.

If service dispatcher instances are added or changed, then edit the file on
each node where a service dispatcher is installed as needed to update the
file. The default location of the file is TC_ROOT\Clients\aw\microservices
\services_config. Similarly, some microservice .json files include an ARGS or
DSP variable. In such cases, update the variable value in each .json file on
each node.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-13

Service Registry (Eureka) parameters:

Install On a master microservice node, the service registry is required and

Microservice preselected. On a worker microservice node, you may optionally install the
service registry for failover or scalability.
Registry Port Type the port for the service registry that will run on this host.
Additional Type the URLs to all other instances of the service registry in the
URLs environment, separated by commas.

The URL pattern for a service registry is:

http://<host>:port/eureka/v2/

where <host> is the hostname, fully qualified domain name, or IP address.

When multiple microservice nodes with service registry instances are

configured in an environment, every .json file for every microservice on
every node must list all instances. If service registry instances are added or
changed, then edit the files as needed to update the list of service registries
(eureka). (For installation via Deployment Center, all instances are
automatically included in the list.)

Example:
eureka definitions when a service registry exists on port 8787 on
servers JPS008601, JPS008602, and JPS008603:

{
"eureka":{
"image":"eureka_server-1.9.12_1.2.1",
"environment":[
"ARGS=-Deureka.serviceUrl.default=
http://JPS008601:8787/eureka/v2,
http://JPS008602:8787/eureka/v2,
http://JPS008603:8787/eureka/v2"
"JETTY_PORT=8787"
]
}
}

3. If you are installing a master node, proceed to the Microservices panel. Review the instance
quantity for each service that you want to run on this node. Typically, Teamcenter microservices are
multi-threaded, so only one instance of the microservice is needed on a node.

3-14 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

When the environment includes multiple microservice nodes on Windows hosts, you may want to
run only a subset of microservices on a given node. In that case, for microservices that you do not
want to install on the node, set the instance value to 0.

4. Proceed to the File Repository Microservice panel and enter parameter values.

File Repository Storage Location is the path to the location for temporary file storage as needed
by microservices and Active Workspace client content accessed through the Active Workspace
Gateway.

5. Proceed through the remaining panels and enter configuration values for your selected
microservices.

6. Review the Confirmation panel and click Start to begin the installation.

The framework and microservices are installed. If you are installing a master node, then signer and
validator keys are generated.

7. When installation is complete, carefully examine any messages to determine what post-installation
steps are necessary.

8. Add microservices support to the Teamcenter web tier, as applicable for Java EE or .NET web tier
architecture.

Add microservice framework support to a Java EE web tier

If you used Teamcenter Environment Manager to install the microservice framework, use the following
procedure to add microservice framework support to a Teamcenter Java EE architecture web tier WAR
file.

This procedure assumes you installed the Web Application Manager and the WEB_ROOT directory as
described in the appropriate Teamcenter installation guide for Windows or Linux.

If you use scripts generated by Deployment Center to install the microservice framework, you do not
need to manually perform this procedure.

1. Install a microservice framework master node.

Locate the keystore ZIP file (keys.zip) in the TC_ROOT/jwt_config_tool directory of the master
microservice node host.

2. Copy the keystore ZIP file (keys.zip) to a location on your local machine and extract the ZIP file
contents.

The keystore ZIP file contains a directory named signer_config.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-15

Caution:
Safeguard the keystore files. A best practice is to remove them from any temporary locations
once you complete this procedure.

3. Locate the following software kits:

• Teamcenter software kit for your installed version of Teamcenter

• Microservices Framework

4. Change to the WEB_ROOT directory and launch the Web Application Manager using the appropriate
command:

• Windows systems: insweb.bat

• Linux systems: insweb.sh

5. Copy ICD files from the software kits. This populates the list of solutions available to install.

a. Click Copy ICDs.

b. In the Copy ICD Files dialog box, click Browse and browse to the following location:

Teamcenter-kit\Web_tier\icd

c. Click OK to copy ICD files from the kit.

d. Repeat steps a through c, specifying the path to the Microservices Framework ICD files:

3-16 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Microservices-Framework-kit\Web_tier\icd

6. Click Add to begin creating a new web application.

7. In the Add Web Application dialog box, create the web application:

a. Type a Name and Staging Location for the web application.

b. Enter software locations:

A. Click Add.

B. In the Add Disk Location dialog box, enter software locations:

i. Click Browse, browse to the signer_config directory from the keystore ZIP file you
extracted in step 2, and then click Apply.

ii. Click Browse, browse to the location of the Microservice Framework kit, and then
click Apply.

iii. Click Browse, browse to the location of the Teamcenter software kit, and then click
OK.

c. Select solutions:

A. Click Solutions.

B. In the Select Solutions dialog box, select the following web tier solutions:

• Teamcenter - Web Tier Infrastructure

• Teamcenter - Web Tier Core Applications

• Teamcenter Microservices

8. Verify your selections, and then click OK to continue creating the web application.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-17

9. In the Modify Required Context Parameters dialog box, ensure the following context parameters
have correct values:

MICROSERVICE_ENABLED
Set to true.
MICROSERVICE_ADDRESS
Specifies a comma-separated list of service dispatcher URLs of the form:

http://host:port

3-18 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

10. Click OK to begin building the WAR file.

When the web application generation is complete, close the Web Application Manager.

11. Locate the WAR file (tc.war) in the deployment directory under the staging location you specified.

12. Deploy the web application on a supported application server, as described in Web Application
Deployment in the Teamcenter help.

Add microservice framework support to a .NET web tier

In the typical case that the Teamcenter .NET architecture web tier machine does not also have a
microservice node installed on it, and installation is through TEM, the following procedure adds
microservice framework support (the microservice proxy).

The procedure is performed automatically if TEM is used to install both a master microservice node and
the .NET web tier on the same host, or if installation is through Deployment Center.

If you use a distributed environment in which your server managers are on hosts separate from your
microservice nodes, make sure that on the local machine that runs IIS, the IIS_IUSRS ID has full control
permissions on the net_webtier_configuration directory. IIS_IUSRS is a local user account created by
IIS.

1. Install a master microservice node on some machine in the Teamcenter environment.

The keystore file signer_keystore.p12 is installed to the TC_ROOT\signer_config directory of the

microservice node host.

2. On the web tier machine, before starting IIS, copy the private key signer_keystore.p12 from the
microservice node host to C:\windows\System32\inetsrv.

3. From the microservice framework kit, extract the file dotnet_microproxy-1.0.1.zip and then
extract its contents into the IIS bin folder on the web tier machine.

4. On the web tier machine, modify ApplicationConfiguration.xml, which you can find in the
TC_ROOT\net_webtier_Configuration ID\tc\ directory.

• Set microserviceEnabled to true.

• Set microserviceAddress to the location of the microservice dispatcher(s).

<!-- Specify the URL(s) to access backend microservices. This is a

comma-separated list of addresses for service dispatchers.
Each address should include the scheme, host and (optional)

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-19

port portions of a URL (e.g., "http://localhost:9090"). An IP

address can be used for the host. If the port is omitted the
service dispatcher must be listening on the default port for the scheme. -->
<param name="microserviceAddress" value="http://localhost:9090"></param>

• Set the microservice keystore.

<param name="microserviceKeyStore" value="signer_keystore.p12"></param>

• Set the microservice keystore password. This is the password that was entered when installing
the microservice framework master node.

• Set the login-manager for microservices.

5. Start IIS and in the Application Pools > DefaultAppPool > Advanced Properties page, set Load
User Profile to True.

Install microservices using Deployment Center

Install microservices on a Linux host using Deployment Center

1. Download a compatible Teamcenter microservice framework kit and place it in the Deployment
Center software repository.

2. In Deployment Center, open or create an environment.

3. On the Software task, add Microservice Framework.

3-20 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

4. On the Applications task, add the applications that you want to install in the environment.

5. On the Components task, specify values for the Microservice Node options.

For this option Do this

Installation Path Enter the path to the Teamcenter installation root folder on the microservice
node host machine.
Machine Name Enter the fully qualified domain name of the microservice node host machine.
This machine name is used to construct the service dispatcher URL.
OS Choose lnx64 (Linux).
Instances Enter the number of service dispatcher instances to run on the node.
Protocol Choose the protocol to use for moving data between the Teamcenter web tier
and the service dispatcher.
If you choose https (recommended), you must perform additional steps after
running deployment scripts to configure service dispatcher as an HTTPS
server.
Port Enter the port number for communication with the service dispatcher.
For Kubernetes, the valid port range is from 30000 to 32767.
Additional If additional cluster or swarm members will host a service dispatcher, click
Service Add URL and enter the URLs, including port values, to those service
Dispatcher URLs dispatchers. An example is http://machine2:9090.
Port and protocol values in the additional URLs must be the same as those
specified in Protocol and Port.
Keystore Enter a password to be used for generating the .p12 files that contain keys for
Password signing and validating authentication tokens. The tokens identify the logged-
and on user.
Confirm
Record and store the password securely for potential use, should you want to
Password
open and edit the keys.
File Repository Enter the path to the location for temporary file storage.
Storage Location
The path must be valid on all swarm or cluster members that will run the file
repository microservice.
Deploying User Follow the instructions in Deployment Center to obtain and enter the UID and
UID and GID of the user who will deploy the file repository microservice.
Deploying User
Values entered must be valid on all swarm or cluster members that will run
GID
the file repository microservice.
For Kubernetes, the user cannot be root.

6. Enter additional microservice parameter values as required. The parameters shown vary depending
on which applications are selected for the environment.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-21

7. In the Services list, review the quantity of instances for each service.

To increase capacity, increase the number of instances.

8. Save the component settings.

9. In the Container Configuration component, specify option values. The component appears only if
Microservice Node OS is set to lnx64.

For this option Do this

Container Enter the machine name or IP address and port of the container registry. Do not
Registry URL enter a protocol.
Container Enter the name of the repository for Teamcenter microservices.
Repository
A repository is a logical grouping of container images within the registry. The
Name
repository name must exist in the container registry before you run the scripts
generated by Deployment Center. The recommended name is teamcenter.
Container Choose one of two container manager types, Docker Swarm or Kubernetes.
Manager
For Kubernetes, specify the Namespace. A namespace is the unique name that
identifies the group of Teamcenter resources interacting with each other in a
Kubernetes cluster. The value you enter replaces placeholders in
microservice .yml files. This is the same namespace described in the procedure
Start microservices in Kubernetes.

10. Complete the configuration of the environment and generate deployment scripts.

11. Ensure that Docker is installed on the microservice node host before you run its deployment script.
Refer to Deploy Docker for microservices on Linux hosts.

12. Log on to the container registry before starting actual deployment.

docker login -u "user" -p "password" container_registry_URL

13. Run the deployment scripts.

Run the microservice node scripts before you run the web tier deployment script.

14. If your environment uses the .NET architecture, on the web tier server machine where IIS is
running, in the Application Pools > DefaultAppPool > Advanced Properties settings, set Load
User Profile to True.

15. If you chose the https protocol for moving data between the Teamcenter web tier and the service
dispatcher, configure the service dispatcher as an HTTPS server.

3-22 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

16. Depending on the container manager, follow the appropriate instructions to complete the
installation and start the microservices:

Docker Start microservices in Docker Swarm.

Swarm
Kubernetes Start microservices in Kubernetes.

Install microservices on a Windows host using Deployment Center

1. Download a Teamcenter microservice framework kit and place it in a Deployment Center software
repository.

2. In Deployment Center, open or create an environment.

3. On the Software task, add Microservice Framework.

4. On the Applications task, add the applications that you want to install in the environment.

5. On the Components task, specify values for the Microservice Node options.

For this option Do this

You can add worker Microservice Node components as needed.

Keystore Enter a password to be used for generating the .p12 files that contain keys for
Password signing and validating authentication tokens. The tokens identify the logged in
and user.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-23

For this option Do this

Confirm Record and keep secure the password for potential use should you want to
Password open and edit the keys.
Protocol Choose the protocol to use for moving data between the Teamcenter web tier
and the Service Dispatcher. The default protocol is http. If the Teamcenter
architecture type is Java EE, then you have the option of choosing https.

For this web tier

architecture Do this
.NET Choose http.
Java EE Choose either http or https.
If you choose https, then you need to perform some
additional steps later to Configure service
dispatcher as an HTTPS server.
Port As applicable, enter the port number for communication with the Service
Dispatcher and the Service Registry.
Both the Service Dispatcher and the Service Registry are required on the
master node.
Teamcenter As applicable, Deployment Center supplies these values as you complete the
Microservice URL environment configuration.
and Service
Registry URL

6. Enter microservice parameter values as required. The parameters shown vary, depending on which
applications are selected for the environment.

Example:
Active Workspace uses a file repository microservice. To configure that service for
deployment on a Windows host, a parameter value for File Repository Storage Location is
required.

7. In the Services list, review the quantity of instances for each service.

Typically, Teamcenter microservices are multi-threaded, so only one instance of the microservice is
needed on a server.

When the environment includes multiple microservice nodes, you may want to run only a subset of
microservices on a given node. In that case, for microservices that you do not want to install on the
node, set the instance value to zero.

8. Save the component settings.

3-24 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

9. Complete configuration of the environment and generate deployment scripts.

10. Run the deployment scripts.

Run the microservice node scripts before you run the web tier deployment script.

11. If your environment uses the .NET architecture, then on the web tier server machine where IIS is
running, in the Application Pools > DefaultAppPool > Advanced Properties, set Load User Profile to
True.

12. If you chose the https protocol for moving data between the Teamcenter web tier and the Service
Dispatcher, then Configure service dispatcher as an HTTPS server.

13. Start the framework and services.

Microservice processes are started by the Teamcenter Process Manager, which can be started as
either a Windows service or from a startup file.

Windows If you selected the Install the Teamcenter Process Manager as a Windows
service service option, then the Teamcenter Process Manager starts automatically with
system startup.

The Teamcenter Process Manager appears in the Windows service list as

Teamcenter Process Manager if POOL_ID is not defined, else Teamcenter
Process Manager <POOL_ID>.
Startup file Run the Teamcenter Process Manager startup file:

TC_ROOT\process_manager\start_manager.bat

Add microservice instances for a Linux host

To increase the capacity of heavily used microservices deployed to Linux hosts, you can add microservice
instances via Deployment Center.

Add microservice instances

1. In Deployment Center, on the Components task for your environment, open the Microservice
Node.

2. In the list of microservices, change values for the instances as desired.

3. Complete your environment configuration and follow the Deployment Center instructions for
deploying the generated ZIP files onto the target machines.

4. Start the Docker swarm, the framework container, and the services.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-25

Add microservices and microservice nodes on a Windows host

To increase capacity of heavily used microservices deployed on Windows hosts, you can add
microservice nodes and microservice instances via Deployment Center.

1. In Deployment Center, on the Components task for your environment, select an existing
microservice node component or add a new Microservice Node component.

2. Configure the node, including the microservices you want to run on the node, as described in
Install microservices on a Windows host using Deployment Center.

3. Complete your environment configuration and follow the Deployment Center instructions for
deploying the generated zip files onto the target machine(s).

4. Start the framework and services.

Start microservices in Docker Swarm

When your microservice framework is deployed for Docker Swarm, use the following procedure to start
Docker and then start microservices.

Start Docker

To start Docker on a microservice framework node, run the following command:

docker swarm init

The output of the command is similar to the following:

Swarm initialized: current node (lccilqci5tpvy6xmsjlu8gap3) is now a manager.

To add a worker to this swarm, run the following command:

docker swarm join --token SWMTKN-1-26h1be2gk2kozzecvgkw93smho5ueb7azn8uw1j2079

isc8b25-dfc8r1f6qhh50ev250tb4st9r 192.168.0.8:237

Tip:
If this is the master node and you intend to later join other servers to this swarm as workers, save
the output command string for later use.

Once you have started Docker on a node, you can join the node to a running swarm.

Deploy the microservice stack

During the installation of microservice nodes, one node must be configured. Microservice .yml files are
copied to this node. These files define the microservice container parameters and are used to deploy the

3-26 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

microservice containers. Once the stack of containers is deployed on this node, Docker manages the
stack across the swarm, automatically deploying containers as needed on other servers that join the
swarm.

1. Change to the Docker installation-path/container directory.

2. Run the following command to deploy a stack for the microservice framework service
tc_microservice_framework.yml:

docker stack deploy -c tc_microservice_framework.yml myStackName

3. Using the same command pattern and the same stack name, deploy all other .yml files in the
directory.

Join a server to a Docker Swarm

Once a microservice node has started a Docker Swarm, you can join additional servers to the swarm as
either workers or managers. Any number of servers can be added as workers. If the swarm includes
multiple manager nodes, the manager nodes vote to determine which node is the controlling node. To
ensure a decisive vote, the swarm must have an odd number of manager nodes.

1. Start Docker on the server.

2. Use the appropriate procedure to join the server to the swarm as a worker or as a manager.

For this
join
mode Do this
Worker Run the Docker command that you saved from the output when the swarm was started.

docker swarm join --token

SWMTKN-1-26h1be2gk2kozzecvgkw93smho5ueb7azn8uw1j2079isc8b25-dfc8r1f6qhh50ev250
tb4st9r 192.168.0.8:237

If a saved join token is not available, on the original node run the following command to
request a token:

docker swarm join-token

Manager a. Ensure that in Teamcenter Web Application Manager (insweb) you configure the
Teamcenter WAR file to include the node host's URL in the Context Parameters value
list for MICROSERVICE_ADDRESS.

b. On the original node, run the following command to request a manager token:

$ docker swarm join-token manager

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-27

For this
join
mode Do this
The output of the command is similar to the following:

To add a manager to this swarm, run the following command:

docker swarm join --token

SWMTKN-1-26h1be2gk2kozzecvgkw93smho5ueb7azn8uw1j2079isc8b25-ct7cb2rwewvmff
mi69c7gt1zn 192.168.0.8:2377

c. Copy the command output and paste it to a command line on the machine you want
to join to the swarm.

docker swarm join --token

SWMTKN-1-26h1be2gk2kozzecvgkw93smho5ueb7azn8uw1j2079isc8b25-ct7cb2rwewvmff
mi69c7gt1zn 192.168.0.8:2377

The output of the command is similar to the following:

This node joined a swarm as a manager

Start microservices in Kubernetes

If the microservice framework is deployed into a Kubernetes environment, use the following procedure
to configure and start microservices.

1. Establish the namespace.

a. Create a custom namespace.

kubectl create namespace custom_namespace

The namespace value should match the namespace value entered in the Container
Configuration component for the environment in Deployment Center.

b. Check your namespace.

kubectl get namespace

c. Change the context to the namespace.

kubectl config set-context --current --namespace=custom_namespace

2. Create secrets and ConfigMaps.

a. Traverse to the Kubernetes scripts directory.

3-28 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

cd $TCROOT/container/kubernetes/setup/scripts

b. Run all scripts in the scripts directory.

Caution:
Address any errors before proceeding to the next step.

3. Deploy the microservice framework and microservices in a Kubernetes cluster.

a. Change to the Kubernetes setup directory.

cd $TCROOT/container/kubernetes/setup

b. Run all the setup files (network policies, volumes, persistent volume claims, and persistent
volume).

kubectl create -f .

c. Change to the Kubernetes deployment directory.

cd $TCROOT/container/kubernetes/deployment

d. Create all the deployments (deploying microservices).

kubectl create -f .

Validate the microservice framework and microservices in a Kubernetes cluster

Validation step Example command

Check the list of pods. kubectl get pods -n custom_namespace
Check the list of services along with the kubectl get svc -n custom_namespace
exposed port.
Check logs of the pods. kubectl logs pod_name
Check environment variables of the pod. kubectl exec pod_name env
Test microservice (in a web browser). IP_address:service_dispatcher_port/mps/health/
checkhealth

Manage microservice instances on Windows hosts

If a microservice framework node is running on a Windows host, then you can temporarily change the
number of microservice instances on the node.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-29

This method is simple and quick, but temporary. To add new microservices to a node, or to configure the
number of instances that start when the Teamcenter Process Manager service is restarted, you must
run TEM or Deployment Center.

1. On the Windows microservice framework node host, browse to localhost:8082.

The default logon credentials are "manager" and "manager". The logon credentials can be changed
once logged in to the management interface.

If port 8082 does not work, then check the port setting in the serverPool.properties file. The file is
stored in the TC_ROOT\process_manager\ directory.

2. On the Agent View page, under Administer services, click the link to the microservice page that
you want to manage.

For example, click id=hello_service.

The administration page for the service opens.

3. To change the number of microservice instances, at the bottom of the page in the box next to
Change_Replicas, enter a new value.

4. To apply the new value, click Change_Replicas.

Note:
If you use the .NET web tier in a distributed environment in which your server managers are on a
separate machines from your microservice nodes, make sure that the IIS_IUSRS ID on the local IIS
host has full control on the net_webtier_configuration directory. IIS_IUSRS is a local user account
created by IIS.

Finding microservice logs on Windows hosts

If a microservice framework node is running on a Windows host, then by default, logs of microservice
instances on the node are written to the %TEMP% location. An administrator can redirect log files.

To find the files, search for [%TEMP%]\*-msf.log

Service Log file name Example

Service Dispatcher service_dispatcher<Instance#>@ service_dispatcher1@2184-
<PID>-msf.log msf.log
Service Registry eureka<Instance#>@<PID>- [email protected]
msf.log

3-30 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Service Log file name Example

Microservices <microservice [email protected]
name><instance#>@<PID>-
msf.log
Microservice Manager TC_ROOT\microservice_manager
\mgr.output
Active Workspace Gateway gateway<Instance#>@<PID>- [email protected]
msf.log

Redirect microservice logs on Windows hosts

If a microservice framework node is running on a Windows host, you can specify the location for the
logs of microservice instances on the node. Logs are written to the location specified by a %TEMP% path
variable.

1. Depending on how you run Teamcenter Process Manager, set the value of %TEMP% as desired.

If you run Process

Manager as Do this to set the %TEMP% value
a Windows process Edit the start_manager.bat file.
The file is in the TC_ROOT\microservice_manager folder.
a Windows service Set either a global value or a variable specific to the Teamcenter
Process Manager:

• For a global value, set the system variable %TEMP% path.

• For a variable specific to the Teamcenter Process Manager:

a. At a command prompt, stop and delete the service.

sc stop "Teamcenter Process Manager"

sc delete "Teamcenter Process Manager"

b. In an editor, open the file %TC_ROOT%

\microservice_manager\install_manager.bat and edit
the EXTRA_ENV variable to set the location of TEMP as
desired.

Example:
rem EXTRA_ENV specifies additional
environment variables needed to run as
Windows service.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-31

If you run Process

Manager as Do this to set the %TEMP% value
set EXTRA_ENV=-env MICRO_ROOT=%MICRO_ROOT%
TEMP=C:\mylogs

2. Restart the Process Manager.

To run the Process

Manager as Do this
a Windows process Run start_manager.bat.
a Windows service Run install_manager.bat.

3. If you have implemented log aggregation, do the following:

a. Stop the Teamcenter Log Forwarder Windows service.

b. Edit the file %TC_ROOT%/tc_logging_forwarder/config/sources/msf.conf to reflect the new

path value.

Example:
##################################################################
# Source Input - MSF Log Files (Eureka, Dispatcher, Microservices)
##################################################################
<source>
@type tail
path C:/mylogs/*@*-msf.log

c. Restart the Teamcenter Log Forwarder Windows service.

Securing microservices

Configuring microservices for HTTPS

Configuring the microservice framework and microservices for completely encrypted communication
requires the following:

• When configuring a microservice node, for the Service Dispatcher Setting, choose the HTTPS
protocol.

• After running deployment scripts on the microservice node host(s), configure the Teamcenter web
tier for HTTPS with the service dispatcher.

3-32 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

• When deploying the container registry, for example Docker Registry, ensure that the container
registry uses the HTTPS encryption protocol.

• Obtain and deploy a PKI certificate and keys.

• When configuring the Active Workspace Gateway, if you choose to override the default service
dispatcher URL, ensure that you enter the HTTPS protocol for the Service Dispatcher URL.

Configure service dispatcher as an HTTPS server

1. To support HTTPS communication from microservices to the service dispatcher, obtain PKI
certificates and keys suitable for your installed microservices.

2. Use the Java keytool to create a Java trust store in .pk12 format and place the private certificate in
that store.

The trust store holds the private (server-side) key for SSL. It can contain certificate keys that are
either CA-signed or self-signed.

While both .pk12 and .jks trust store file formats are accepted, Siemens Digital Industries Software
recommends the .pk12 format because it has greater microservice compatibility.

3. Using Deployment Center or TEM, ensure the following:

• The machine name where the service dispatcher is being deployed matches the name in the
signed certificate.
For example, if the certificate is for sd.example.com, then the service dispatcher host machine
name must be sd.example.com.

• https is the selected protocol for service dispatcher.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-33

4. Place the trust store in the proper directory according to the node host operating system.

Host OS Trust store location

Windows TC_ROOT\microservices\secrets of each microservice node where a service dispatcher
runs.
Linux TC_ROOT/container/secrets of each configured microservice node (not every server
that is joined to a Docker swarm).

5. Depending on the microservice node host OS, edit the service dispatcher configuration. Extend the
ARGS value for the service dispatcher to provide values for the following:

For this argument Do this

protocol Choose https.
keystore Specify the location of the trust store (pkcs12 or jks) holding the private
server-side key (certificate).
kspassword Specify the password for the trust store.
keystoreType (if not jks) Specify PKCS12 if not using JKS.

Host OS Make these configuration file changes

Windows TC_ROOT\microservices\services_config\service_dispatcher.json
Add security properties to the file.
Example:
Original file content, including the ARGS setting:

{
"service_dispatcher":{

3-34 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Host OS Make these configuration file changes

"image":"service_dispatcher-1.2.0",
"environment":[
"ARGS=-Dport=9090 -Deureka.serviceUrl.default=http://
msnode1:8080/eureka/v2"
]
}
}

File content after adding security properties:

{
"service_dispatcher":{
"image":"service_dispatcher-1.2.0",
"environment":[
"ARGS=-Dport=9090 -Dprotocol=https -Dkeystore=path_to_trust_store_file
-Dkspassword=trust_store_password -DkeystoreType=pkcs12
-Deureka.serviceUrl.default=
http://msnode1:8080/eureka/v2"

Linux - In the Service Dispatcher (Eureka) Docker container, TC_ROOT/container/

Docker tc_microservice_framework.yml.
swarm
Add security properties to the file. You must also add the keystore file as a secret.
Example:
File content before adding security properties and keystore file:

service_dispatcher:
image: siemens/teamcenter/service_dispatcher:1.2.0
deploy:
replicas: 1
environment:
- ARGS=-Dport=9090 -Deureka.serviceUrl.default=http://eureka:8080/
eureka/v2/
ports:
- 9090
depends_on:
- eureka

File content after adding security properties:

service_dispatcher:
image: siemens/teamcenter/service_dispatcher:1.2.0
deploy:
replicas: 1
environment:
- ARGS=-Dport=9090 -Dprotocol=https -Dkeystore=my_trust_store_file
-Dkspassword=trust_store_password -DkeystoreType=pkcs12
-Deureka.serviceUrl.default=
http://eureka:8080/eureka/v2/
ports:
- 9090
depends_on:
- eureka
secrets:
- <keystore_file>

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-35

Host OS Make these configuration file changes

secrets:
<keystore_file>:
file: ./secrets/my_trust_store_file

Linux - a. Create a secret containing the keystore file in Kubernetes.

Kubernetes
kubectl create secret generic mykeystore
--namespace=custom_namespace --from-file=./secrets/
my_key_store_file

Example file name: IdentityKeystore.p12

b. Update the file

TC_ROOT/container/kubernetes/deployment/
tc_microservice_framework.yaml
Example:
File content before adding security properties:

volumeMounts:
- name: signertcmicrosecurity
mountPath: "/run/secrets/
signer_tc_micro_security.properties"
subPath: signer_tc_micro_security.properties
readOnly: true
- name: signerkeystore
mountPath: "/run/secrets/signer_keystore.p12"
subPath: signer_keystore.p12
readOnly: true
volumes:
- name: signertcmicrosecurity
secret:
secretName: signertcmicrosec
- name: signerkeystore

3-36 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Host OS Make these configuration file changes

secret:
secretName: signerkey

File content after adding security properties:

...
containers:
- image: localhost:5000/teamcenter/service_dispatcher:6.0.0
name: service-dispatcher
securityContext:
runAsNonRoot: true
allowPrivilegeEscalation: false
resources:
requests:
cpu: 10m
memory: 200Mi
env:
- name: ARGS
value: "-Deureka.serviceUrl.default=http://
eureka:8080/eureka/v2/ -Dprotocol=https -Dkeystore=/run/secrets/mykeystore.p12
-Dkspassword=secret -DkeystoreType=pkcs12"
envFrom:
- configMapRef:
name: msf-env
- configMapRef:
name: sd-env
volumeMounts:
- name: signertcmicrosecurity
mountPath: "/run/secrets/
signer_tc_micro_security.properties"
subPath: signer_tc_micro_security.properties
readOnly: true
- name: signerkeystore
mountPath: "/run/secrets/signer_keystore.p12"
subPath: signer_keystore.p12
readOnly: true
- name: mykeystore
mountPath: "/run/secrets/mykeystore.p12"
subPath: IdentityKeystore.p12
readOnly: true
volumes:
- name: signertcmicrosecurity
secret:
secretName: signertcmicrosec
- name: signerkeystore
secret:
secretName: signerkey
- name: mykeystore
secret:
secretName: mykeystore

6. On Linux deployments, update all *.yml or *.yaml microservice configuration files to use the
HTTPS protocol. In the following examples, service_dispatcher, host1, and host2 are placeholders
for what is signed in the certificate, which is typically the fully qualified domain name.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-37

a. Update all *.yml or *.yaml files that point to the service dispatcher URL. Note that not all
configuration files have references to the dispatcher.
Example:

ENDPOINT_SERVICE_DISPATCHER=http://host1:9090,http://host2:9090

becomes

ENDPOINT_SERVICE_DISPATCHER=https://
host1.domain.com:9090,https://host2.domain.com:9090

b. To deploy the changes, redeploy the files to the stack.

7. On Windows deployments, add the certificate to the list of certificates the microservices trust. The
procedure for this varies based on the language in which the microservice is written.

For these
microservices Do this
Declarative a. Edit the file %TC_ROOT%\microservices
Artifact Service \services_config<microservice>.json.

iModel Viewer b. In the file, set the environment variable NODE_EXTRA_CA_CERTS, which
Service points to the location of the signed certificate. The certificate must be in
the PEM format and must not have been generated using DSA
Microservice encryption.
Parameter Store Add the variable in the environment section.
Example:
Teamcenter
GraphQL Service
ClassificationAI

(Source code
language:
Javascript/
Typescript using
NodeJS)

For additional information about this variable, see NodeJS

documentation.

3-38 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

For these
microservices Do this
c. Restart the process manager.
ep-app a. Add the certificate authority (CA) to the JVM's list of trusted certificates.
Ensure that the following two arguments are passed to the JVM:
Event Notification
Service -Djavax.net.ssl.trustStorePassword=

FileRepo -Djavax.net.ssl.trustStore=path_to_truststore_file_in
_.jks_format
mfe-vis
The method for doing this for Java-based microservices depends on their
odata_service
implementation. Generally, the .json file has an ARGS variable, to which
you can append arguments. In lieu of that, you can edit the
req-compare-
microservice's start_service.bat file to add these arguments to the JVM.
service
Some microservices support editing the TC_ROOT\microservices
\services_config\microservice.json file to alter the JVM arguments.
Others require that you modify the corresponding TC_ROOT
\microservices\microservice\start_service.bat script to add the JVM
(Source code arguments.
language: Java)
b. Restart the process manager.
Command a. If the trust store file is in .jks format, convert the .jks file to .pk12.
Prediction For example, to list entries in a keystore file named keystore2.jks, run
the command:
Google Online
keytool -list -keystore ./keystore2.jks
Office Online
To convert a keystore file named keystore2.jks to a .pk12 file using the
Product key mykey and the password testKeyStorepw, run the command:
Configurator
Service keytool -importkeystore -srckeystore [./keystore2.jks]
-destkeystore ./keystore2.p12 -srcstoretype JKS
reqexportservice -deststoretype PKCS12
-srcstorepass testKeyStorepw -deststorepass testKeyStorepw
-srcalias mykey
reqimportservice -destalias mykey -srckeypass testKeyStorepw -destkeypass
testKeyStorepw -noprompt

Xcelerator Share b. Double-click the .pk12 file to install it as a trusted certificate.

(Source code
language: C#)

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-39

Configure the web tier for HTTPS with the service dispatcher

1. Configure the Teamcenter web tier as appropriate for the web tier type.

For this web tier

type Do this
Microsoft .NET a. In ApplicationConfiguration.xml, modify the parameter
microserviceAddress.
Example:

<param name="microserviceAddress" value="http://

service_dispatcher:9090"/>

becomes

<param name="microserviceAddress" value="https://

service_dispatcher.domain.com:9090"/>

b. Restart the web server.

Java EE a. In Teamcenter Web Application Manager (insweb), modify the Context
Parameters:

MICROSERVICE_ADDRESS
MICROSERVICE_TRUSTSTORE
MICROSERVICE_TRUSTSTORE_TYPE
MICROSERVICE_HOST_VERIFY_MODE

Example:

<param-name>MICROSERVICE_ADDRESS</param-name>
<param-value>http://service_dispatcher:9090</param-value>

becomes

<param-name>MICROSERVICE_ADDRESS</param-name>
<param-value>https://service_dispatcher.domain.com:9090</
param-value>

b. Redeploy the tc.war file.

2. Public keys for CA-issued certificates are already available in the web tier. If you are using self-
signed certificates, do the following:

a. Place the certificate public key in a trust store for the web tier.

b. If the trust store is not already located as configured, place the trust store in the location that
was configured in the Teamcenter installer web tier Microservice Communications Settings.

3-40 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Configure Active Workspace Gateway for HTTPS with the service dispatcher

If the Certificate Authority (CA) for the service dispatcher certificate is known to the Active Workspace
Gateway, no further action is required.

If the service dispatcher certificate is a self-signed certificate or is from a certificate authority not known
to the Active Workspace Gateway host operating system, do the following on the Active Workspace
Gateway host to point to the required certificate.

Windows
Set the NODE_EXTRA_CA_CERTS environment variable (https://nodejs.org/api/
cli.html#cli_node_extra_ca_certs_file).
Linux
Edit the gateway.yml file to point to the certificate.

For example:

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-41

PKI key requirements for microservices

If you want to use HTTPS protocol for sending data in the microservice framework, a certificate and
matched pair of encryption keys is required:

public key
A cryptographic key that can be obtained and used by anyone to encrypt messages intended for a
particular recipient. The encrypted messages can be deciphered only by using a second key (the
private key) that is known only to the recipient.

A client uses the public key when establishing a secure connection to a server. When the client
initiates a request to the server, the server responds with its certificate, which contains the public
key, and which is signed either by a certificate authority (CA), or is a self-signed certificate
generated by some tool, rather than purchased from a CA.

For the client to trust the certificate sent by the server, and consequently the server, the certificate
must be signed by an authority (signer) that the client trusts. CA signatures are generally trusted.
For the client to trust a self-signed certificate, its signature must be from a signer included in the
client's trust store.
private key
A cryptographic key that is used by a server to decrypt the data it receives from the client, which
encrypted the data using the corresponding public key. A private key is also known as a secret key.
The private key should be kept secret and shared only with the key’s generator, thereby making it
secure.

Standard authentication is unidirectional. For example, a request from a microservice to the service
dispatcher can eventually result in encryption of data traveling to the service dispatcher. If

3-42 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

authentication of communication initiated by the service dispatcher to a microservice is desired, the

microservice must be configured to serve its own certificate, and the service dispatcher must include the
certificate signer in its trust store.

A single certificate and its public/private keys can be used by all microservices. A server certificate signed
by a certificate authority (CA) can be purchased from a CA, and is recommended. Alternatively,
cryptographic tools such as OpenSSL can be used to create a self-signed certificate and its keys.

Note that microservices developed in Typescript language are incompatible with certificates generated
using DSA encryption.

Sequence for one-way SSL handshake

High availability for microservices

In a distributed Teamcenter production environment, ensure high availability by configuring redundant
microservice node servers and service instances. For detailed deployment examples and sample

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-43

configurations, see Teamcenter Deployment Reference Architecture, available from the Teamcenter
downloads page on Support Center.

Capacity

With the many variables affecting a Teamcenter environment, no simple formula exists that can
prescribe the precise combination of microservice nodes and microservice instances. As with all server-
side deployments, monitor the consumption of CPU and memory on each microservice node. If you
observe resource contention, you can increase resources for microservice execution by deploying
additional microservice nodes and services running on additional hardware.

Failover

Windows
Achieving failover capability on Windows requires that a service registry, a service dispatcher, and
instances of all microservices must each be running on at least two nodes. By default, an instance of
the service registry and service dispatcher run on the master node; additional instances can be
running on any worker nodes. When installing microservice nodes through TEM, be sure to list all
instances of the service registry and the service dispatcher.
Docker Swarm
Achieving failover capability with Docker Swarm on Linux requires that an odd number of servers be
joined to the swarm as managers, typically three or five. This helps the Docker swarm effectively
manage the swarm by majority vote. Any number of servers can be joined to the swarm as workers.
Kubernetes

Control Plane Follow the vendor documentation. If using a cloud provider, the provider typically
provides a Control Plane with failover.
Microservice To avoid a single point of failure, in on-site deployments implement at least two
nodes microservice nodes. Ensure that these nodes are allocated on different physical
hardware. Allocate at least two replicas of every component to avoid a single point
of failure. For nodes in cloud deployments, to avoid location-specific outages,
ensure that the nodes are spread across different failure zones (such as AWS
Availability Zones).
The exception to replicating components is the Service Registry. A single Service
Registry is sufficient. This is because in the event that the Service Registry (Eureka)
container goes down, the Eureka Client Cache provides needed information during
the brief period of time that passes while the container manager brings back up
the container.

If possible, test for node failure conditions and validate that client requests are handled using
service load balancing. Ensure desired scale once the nodes are recovered.

For backup options, consult the vendor documentation.

3-44 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Example microservice deployment topologies for high availability

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-45

3-46 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Troubleshooting microservices

Problem/error
message Possible cause Solution
404 error for a In a deployment with a Create a CUSTOM_REQUEST_BUFFER_SIZE
microservice request load balancer configured, environment variable and set its value higher than
with the Service due to the addition of the default microservice service dispatcher
Dispatcher logging a large cookies by the load request buffer size of 8192 (8 KB), and then
message that the HTTP balancer, some requests restart the service dispatcher.
header is too large. exceed the limit for the
header size.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 3-47

3-48 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

© 2021 Siemens
4. Installing Active Workspace
Active Workspace components installation overview
The primary Active Workspace components are Server Extensions, Client, Indexing, and Visualization
Server. Each of these require their own sequences of installation tasks. In the installation paths shown,
octagons indicate verification tasks where you must ensure all previous steps are complete before you
continue.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-1

Whether you use TEM or Deployment Center to install Active Workspace components, you may need to
enter or verify the following values from your Teamcenter environment:

Teamcenter four-tier environment configuration

Parameter Your value

Teamcenter machine name and credentials

Teamcenter installation directory (TC_ROOT)

Teamcenter data directory (TC_DATA)

Teamcenter four-tier URL (http://host:port/tc)

Teamcenter FMS machine name and bootstrap

URLs (http://host:4544)

Licensing server machine name and port (28000

by default)

Database system machine and credentials

Operating system credentials for component

servers

Location of security certificates and keys

Microservice node information if already installed

Active Workspace Server Extensions

Server Extensions overview

Install Active Workspace server extensions features on each Teamcenter server where Teamcenter
Foundation is installed. This includes corporate servers, volume servers, and server manager hosts.
Installing these features adds software to the Teamcenter home directory (TC_ROOT) and adds data
model changes to the database and the TC_DATA directory.

4-2 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Make sure your Teamcenter environment has the following:

• Supported version of Teamcenter

Active Workspace 6.0 supports the latest versions of Teamcenter or Teamcenter Rapid Start, and some
earlier versions. If you do not use the latest version of Teamcenter or Teamcenter Rapid Start, see the
Hardware and Software Certifications knowledge base article on Support Center.

• Corporate server

• Server manager

• Teamcenter web tier (Java EE or .NET)

Installing Server Extensions requires the following values from your Teamcenter environment. Be
prepared to enter these values into the installation tool (TEM or Deployment Center) during Active
Workspace installation.

Values required before installing Server Extensions

Parameter Your value

Teamcenter administrative user password

Database system user login/password

Teamcenter home directory (TC_ROOT)

Teamcenter data directory (TC_DATA)

Indexing Engine user name and password

Search engine URL (Example: http://host:8983/solr)

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-3

Install Server Extensions features

Install Server Extensions on every host that has Teamcenter Foundation installed.

1. Stop all Teamcenter services except FSC services.

2. Launch the installed Teamcenter Environment Manager (TEM) for the corporate server.

3. In the Maintenance panel, select Configuration Manager.

4. In the Configuration Maintenance panel, select Perform maintenance on an existing

configuration.

5. In the Old Configuration panel, select the corporate server configuration.

6. In the Feature Maintenance panel, select Add/Remove Features.

7. In the Features panel, select Active Workspace Server Extensions features:

a. Expand Base Install→Active Workspace→Server Extensions.

b. Select the Active Workspace Server Extensions feature. (This feature is required.)

c. Select any additional Server Extensions features you want to include in your Active
Workspace deployment.

Some features may display additional panels in TEM that are not described in this procedure.
See the help buttons in those panels for information.

Note:
• To search for a feature by name, type the name or a partial name in the search box, and
then click the search icon.

• Some Server Extensions features depend on other Server Extensions features.

8. In the Teamcenter Administrative User panel, type the user’s password.

9. In the Indexing Engine User panel, type the Solr administrator’s user name and password.

The Solr administrator’s user name and password are defined when you install the Indexing Engine
(Solr).

If Indexing Engine is not installed yet, record the Solr administrator user name and password and
make sure to use these credentials when you install Indexing Engine. These credentials must match

4-4 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

for Indexing Engine, the Indexer, Server Extensions, and the Active Content Structure Translator (if
used).

10. In the Active Workspace Server Extensions Settings panel, type the Solr search engine URL. The
format is:

http://host:port/solr

host is the machine designated to run Solr. This is the machine on which Indexing Engine is to
be installed.

port is the port value used by Solr. The default is 8983.

If your environment uses multiple Solr search engines for failover, select Use additional search
engine URLs, and then type the URLs in the Search Engine URL List.

11. In the Database User panel, type the password for the Teamcenter database user.

12. In the Database Template Summary panel, review the list of templates to be applied to the
Teamcenter database. The list varies depending on the features selected for installation.

13. In the Confirmation panel, click Start to begin the installation.

The TcFTSIndexer process requires database triggers that enable database access for the Indexer
to detect changes to the database when performing run-time (synchronous) indexing. If TEM
cannot install these indexing triggers automatically, it informs you to install the database triggers
manually.

14. When installation is complete, close TEM.

Install database triggers manually

The TcFTSIndexer process requires database triggers that enable database access for the Indexer to
detect additions, modifications, and deletions to the database when performing run-time (synchronous)
indexing.

In most cases, TEM installs these indexing triggers automatically. However, if you do not provide the
necessary values (logon values for the database user and the system user) to install them during your
TEM session, TEM displays a TODO message about enabling database access to Teamcenter. If this
happens, install the database triggers manually using the appropriate procedure for your database:

Install database triggers in Oracle

1. To grant the create trigger privilege to the Oracle user that owns the Teamcenter database,
perform the following steps:

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-5

a. Open a command prompt.

b. Type:

sqlplus system/password

c. Type:

grant Create trigger to Tc-Oracle-user identified by password;

d. Type:

exit

2. Create the trigger:

a. In the command prompt, type:

sqlplus Tc-Oracle-user/password

b. Type:

@Teamcenter-installation-media\tc\install\sitecons\sitecons_install_triggers_oracle.sql

Install database triggers in Microsoft SQL Server

1. Open Microsoft SQL Server Management Studio.

2. Complete the Connect to Server dialog box:

a. In the Server name box, select the host on which Microsoft SQL Server is installed.

b. In the Authentication box, select SQL Server Authentication.

c. In the Login box, type the database administrative user name.

d. In the Password box, type the database administrative user password.

e. Click Connect.

3. In the Object Explorer panel of the Microsoft SQL Server Management Studio dialog box,
expand the Databases tree and select the Teamcenter database name, for example, tc.

4. From the menu bar, choose File→Open→File.

5. In the Open File dialog box, navigate to the software kit for the Teamcenter major release.

4-6 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

In the Tc-software-path\tc\install\sitecons directory, select sitecons_install_triggers_mssql.sql.

Microsoft SQL Server Management Studio opens the selected file.

6. Click Query→Execute.

The query installs the database triggers.

7. Verify that the query completed with no errors.

8. Close the Microsoft SQL Server Management Studio.

Installing database triggers from the command line

If Microsoft SQL Server Management Studio is not installed on your host, you can install the database
triggers from a command line. Type the following command in a Windows command prompt:

sqlcmd -H host -d database -U user -P password -i path

\sitecons_install_tables_and_triggers_mssql.sql

Replace:

• host with the database server host name.

• database with the Teamcenter database name.
• user with the database user name.
• password with the database user password.
• path with the path to the sitecons_install_triggers_mssql.sql file.

For example:

sqlcmd -H myhost -d TcDB -U dbUser -P dbPassword -i

C:\software\tc\install\sitecons\sitecons_install_triggers_mssql.sql

To verify the triggers installed successfully, log into Microsoft SQL Server and type the following
commands in an SQL prompt:

1> Select name,is_disabled from sys.triggers2> Go

If the installation succeeds, Microsoft SQL Server displays a table similar to the following showing that
the database triggers are not disabled:

name is_disabled
-----------------------------------------------------------------
fast_sync_add_trigger 0
fast_sync_delete_trigger 0
(2 rows affected)

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-7

Active Workspace client components

Active Workspace client overview

Active Workspace client functionality is delivered through Active Workspace Gateway, a Node.js
implementation that routes all requests for static content such as HTML, CSS, Javascript, JSON, and other
types, and dynamic content such as API routing to back-end services and microservices for SOA, FMS,
Visualization, GraphQL, and others.

Active Workspace Gateway employs Teamcenter microservices for some request types. For example,
Active Workspace client content is stored in an Active Workspace file repository and managed by the File
Repository microservice.

Deploying the Active Workspace client requires installing the following applications using TEM or
Deployment Center. You must deploy the applications in the order listed. Review each of the procedures
before you begin your installation.

Active Workspace microservices

Active Workspace Gateway

Active Workspace client

Active Workspace client features require the following hardware and software:

• A minimum of 1 GB of free physical RAM (unused by other applications) to avoid paging. Siemens
Digital Industries Software recommends that the machine used have a minimum of 2 GB.

• 64-bit Java development kit (JDK) installed and the JAVA_HOME system environment variable set.

• On Linux hosts, the Active Workspace Gateway requires:

• Node.js.

• Microservice framework.
Microservice framework requires a container manager, namely Docker or Kubernetes. If you
install microservice nodes on a Linux host, make sure Docker is installed on the host.

4-8 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

For certified versions of required third-party software, see the Hardware and Software Certifications
knowledge base article on Support Center.

Be prepared to enter the following values from your Teamcenter environment during installation of
Active Workspace client components:

Values required before installing the Active Workspace Gateway

Parameter Your value

Teamcenter web tier URL

FSC Bootstrap URLs (http://host:4544)

For information about configuring security for this client, see Security configuration tasks in the Active
Workspace help collection.

Install Active Workspace microservices

The microservice framework must be installed before you begin these steps. You can add Active
Workspace microservices to an existing microservice node or install the microservices and Microservice
Framework at the same time.

1. Launch your preferred installation tool (TEM or Deployment Center) to begin installing Active
Workspace microservices.

2. Choose the software.

TEM Add the Active Workspace 6.0 software kit and the Microservice Framework
software kit to the Media Locations panel.
Deployment Add the Active Workspace 6.0 software kit and the Microservice Framework
Center software kit to Software Repositories. Whether you are installing or updating an
environment, ensure all applicable software kits are present.

Check the Selected Software list, including the base and minor release versions
of Teamcenter software. You may install microservices as part of an installation or
an upgrade.

In Options, choose the Distributed environment type and the architecture.

3. In TEM, add the following microservices in the Features panel:

• File Repository Service

• Teamcenter GraphQL Service (optional)

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-9

• Declarative Artifact Service (optional)

In Deployment Center, Selected Applications automatically includes these microservices. You can
view them in the Microservice Node component configuration.

4. In TEM, configure the microservices with the required values.

In Deployment Center, configure the Microservice Properties on a Microservice Node

component.

• File Repository Microservice

Value Action

File Repository Storage Location Type a location for the file repository to be used by the
Active Workspace Gateway. The path must exist on the
machine that hosts the microservice node. For
example: c:\tc\file_repository
The file repository stores Active Workspace content.

User ID (Linux only) Type the user ID of the user installing the
File Repository Microservice.

Group ID (Linux only) Type the Group ID of the user installing the
File Repository Microservice.

• GraphQL Microservice

Value Description

Teamcenter Web Tier URL In TEM, type the path to the deployed Teamcenter web
tier, for example:

http://host:port/tc

In Deployment Center, the Microservice Node locates

the URL from the Teamcenter Web Tier component
automatically.

Note:
On Linux systems, microservices Worker Nodes must contain the same installed
microservices as the Master Node.

5. In TEM, start the microservices after you complete the microservices installation, using the
appropriate method for your operating system.

4-10 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

In Deployment Center, continue with the Active Workspace Gateway installation.

Install Active Workspace Gateway

Active Workspace Gateway requires the keystore ZIP file (keys.zip) from the microservice master node.
Before you install Active Workspace Gateway, copy the keys.zip file from the jwt_config_tool directory
under TC_ROOT on the microservice master node host to a directory on the Active Workspace Gateway
host.

You can install Active Workspace Gateway in a new or an existing Teamcenter environment. Use the
same installation tool you use to install Active Workspace microservices:

Install the Active Workspace Gateway using TEM

Install the Active Workspace Gateway using Deployment Center

Depending on your network configuration, you may choose to restrict access to the JMX interface that
Active Workspace Gateway uses.

Install the Active Workspace Gateway using TEM

1. If you are installing Active Workspace Gateway in a new configuration (on a machine with no
existing Teamcenter environment), skip to step 2.

If you are adding Active Workspace Gateway to an existing configuration:

a. Add Active Workspace and Microservice Framework to the Teamcenter host.

b. Launch the installed TEM in maintenance mode.

c. Skip to step 7.

2. Make sure you have access to the following software kits:

• Teamcenter major release

• Teamcenter minor release
• Active Workspace 6.0
• Microservices Framework

3. Launch TEM from the Teamcenter minor release kit.

On Windows hosts, right click the tem.bat program icon and choose Run as administrator.

4. Proceed to the Install/Upgrade Options panel and then click Install.

5. In the Media Locations panel, enter paths to the software kits.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-11

• In the Original Media Location box, enter the path to the software kit for the major version of
Teamcenter.

• In the Update Location box, enter the paths to Active Workspace 6.0 and Microservices
Framework software kits.

The path to the Teamcenter minor version software kit is already included in the list of update
locations.

6. In the Configuration panel, enter an ID and a Description for the configuration.

7. In the Features panel, under Base Install→Active Workspace→Client, select Active Workspace
Gateway.

If you are installing a new configuration, enter an installation location in the Installation Directory
box.

8. In the Gateway Settings I panel, enter the required values:

Value Description

Teamcenter Web Tier URL Enter the URL for the Teamcenter web application, in the
following form:

http://host:port/tc

Visualization Assigner URL Enter the URL to the Visualization Server Assigner, in the
following form:

http://host:port

Easy Plan URL Enter the URL to the Easy Plan application, if installed. The
URL should be of the following form:

http://host:port/application-name

NGP URL Enter the URL to the Next Generation Planning (NGP)
application, if installed. The URL should be of the
following form:

http://host:port/application-name

Service Dispatcher URLs Enter the URL to the service dispatcher, based on the
service dispatcher host and port you used when you
installed the microservice node:

http://host:port

4-12 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Value Description

The default port is 9090.

If you installed multiple nodes, you may enter multiple
URLs as a comma-separated list. Use fully-qualified
domain names or IP addresses in URLs.

Container Registry URL Specifies the registry URL to store Docker images.
The value should be in the form of a host name, FQDN, or
IP:port. Do not include protocol, such as http:// or https://.
For example:

registry.example.com

This value should reference a live container registry. TEM

attempts to connect to the registry. If the connection
attempt fails, TEM does not allow you to continue.

Container Repository Name Specifies the name of the container repository. The
default value is teamcenter.
This value must not contain spaces. The repository name
must already exist in the container registry.

Gateway Service Port Enter the port used by the Active Workspace Gateway.
The default value is 3000.
The URL to the Active Workspace client interface is based
on this port.

Under FMS Settings, enter the following settings for accessing FMS volumes:

Use as Bootstrap 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.
To use bootstrap URLs, select this option and fill in the
Bootstrap URLs and Bootstrap Client IP boxes.
On Linux hosts, if you select Use as Bootstrap URLs, you
need to ensure the client map is configured correctly.

Bootstrap URLs Enter a comma-separated list of URLs to one or more

existing FMS server caches (FSCs).
URLs must be of the form:

http://host:port

By default, the IP address from the HTTP connection of

the requestor is used unless a Bootstrap Client IP value is

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-13

Value Description

provided. (The client/requestor is the host on which

Active Workspace Gateway is deployed.)

Bootstrap Client IP Enter the FMS bootstrap client IP address to be used for
the assignment.
On Linux hosts, enter the internal IP address of the Active
Workspace Gateway machine.

Use Assigned FSC URLs Specifies whether you want to assign FSC servers. Select
this only if you want explicit control of the FSCs used.
To use assigned FSCs, select this option and fill in the
Assigned FSC URLs box.

Assigned FSC URLs Enter 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 declare the FSC servers that
should be used.

For information about other values in the Gateway Settings panel, click the help button .

9. In the Gateway Settings II panel, enter the required values:

Value Description
Xcelerator Values for configuring the Xcelerator Share Collaboration integration to
Teamcenter.
Xcelerator Share Specifies the URL to the Xcelerator Share site.
URL
The default value is https://share.sws.siemens.com.
Client ID Specifies the SAMAuth client ID you obtained through SAM URL.
Client Secret ID Specifies the client secret ID you obtained through SAM URL.

10. In the Gateway Security Settings panel, enter the required values:

Value Description

Keystore Zip File Enter the location of the keystore zip file (keys.zip) generated when
you installed the microservice master node.
The keystore file is generated in the jwt_config_tool directory under
TC_ROOT on the microservice node host. For security, copy the keys.zip

4-14 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Value Description

file to a directory on the Active Workspace Gateway host and specify

that location here.

Under Enable TcSS Support, enter values for configuring Security Services.

Enable TcSS Support Select this check box if you want to enable Security Services support in
Active Workspace.

TcSS Application ID Type the Security Services application ID.

TcSS Login URL Type the logon URL for the Security Services application.
For details about configuring Security Services, see Security Services
Installation/Customization in Teamcenter documentation.
When you configure Active Workspace for Security Services, be sure to
only install the language packs for the Security Services that Active
Workspace supports.
If Active Workspace is deployed on a different URL, you must configure
Security Services with multiple application IDs.

Under Security Key Settings, enter security key values for Teamcenter.

Security Certificate Enter the path to the security certificate.

Security Key Enter the path to the security key file.

11. In the Confirmation panel, click Start to begin the installation.

12. When the installation is complete, close TEM.

13. On Linux hosts, start the Docker swarm, microservices node, and the Gateway service.

The Gateway service should not join the swarm.

Install the Active Workspace Gateway using Deployment Center

You can install Active Workspace Gateway into a new or existing environment:

1. Make sure you have the following software in your repository.

• Teamcenter major release

• Teamcenter minor release
• Active Workspace 6.0
• Microservices Framework

Choose your new or existing environment, and create or update the Selected Software list.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-15

2. In Selected Applications, required Active Workspace applications are automatically listed. You
may add other applications you want to deploy that do not use Active Workspace Gateway.

3. In the Selected Components list, choose Active Workspace Gateway.

Enter the machine name and operating system. The installation path to Teamcenter may be
specified automatically if it was entered in another component.

4. Expand the configuration sections to show all parameters, and enter the required values.

Value Description

Port Enter the port for Active Workspace Gateway. The default value is 3000.
The URL to the Active Workspace client interface will use this port.

https If you use HTTPS protocol, choose https and enter the following
certificate settings:
TLS Enter the path to the certificate file.
certificate
file path
TLS key file Enter the path to the keystore ZIP file (keys.zip) on the
path Active Workspace Gateway host.

The file must be copied from the microservice

framework master node to the Active Workspace
Gateway host.

http If you use HTTP protocol, choose http.

Use as Bootstrap The Active Workspace client uses FMS to download and upload files. You
URLs define the FSC servers that are used by selecting either Use as
Bootstrap URLS or Use Assigned FSC URLs.
On Linux hosts, you must select Use as Bootstrap URLs to ensure the
client map is configured correctly.

Bootstrap Client Specifies the FMS bootstrap client IP address to be used for the
IP assignment.
On Linux hosts, enter the internal IP address of the Active Workspace
Gateway machine.

Use Assigned FSC Specifies whether you want to assign FSC servers. Select this only if you
URLs want explicit control of the FSCs used.

FSC Connection Specifies a comma-separated list of URLs to one or more existing FMS
URL server caches (FSCs).
The URL must be of the form:

4-16 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Value Description

http://host:port

By default, the IP address from the HTTP connection of the requestor is

used unless a Bootstrap Client IP value is provided. (The client/
requestor is the host on which Active Workspace Gateway is deployed.)

Assigned FSC Specifies a comma-separated list of one or more assigned FSC URL
URLs values.
The URL values entered are directly used for file operations. This allows
you to declare the FSC servers that should be used.

Service Dispatcher URLs are obtained from the Microservice Node.

You may choose whether to communicate with Teamcenter through the Teamcenter web tier or
through a load balancer. Specify your settings in the Teamcenter Server Connection Settings
section.

5. If your environment is not a production environment and you want to enable the GraphQL
Playground for testing purposes, select the Enable GraphQL playground check box. Do not enable
GraphQL Playground on your production server.

GraphQL Playground is a GraphQL IDE that runs in a web browser. For more information about
GraphQL playground, see https://www.apollographql.com/docs.

6. Under Xcelerator Share Collaboration, type your Xcelerator Share Collaboration settings:

Value Description
Xcelerator Share URL Specifies the URL to the Xcelerator Share site.
The default value is https://share.sws.siemens.com.
Client ID Specifies the SAMAuth client ID you obtained through SAM URL.
Client Secret ID Specifies the client secret ID you obtained through SAM URL.

7. You may specify the configuration for other components now or later. Proceed to installing the
Active Workspace client for instructions.

8. (If Active Workspace Gateway is deployed on a Linux host) Start the Docker swarm, microservices
node, and the Gateway service.

The Gateway service should not join the swarm.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-17

Restricting access to the JMX interface

The Active Workspace Gateway's microservice manager contains a Java Management Extensions (JMX)
interface that allows administrators to dynamically change microservice manager configuration values
such as instance count for the processes it controls. This could potentially allow non-administrator users
to view microservice manager controls. Changing settings of the JMX interface requires a username and
password, but non-administrator users may be able to see or connect to the web tier machine on which
the Active Workspace Gateway is running.

If you want to prevent access to the JMX interface, locate the following line in the
serverPool.properties file:

JMX_HTTP_ADAPTOR_PORT=8082

To disable access to the JMX interface, set this property to a value of 0, or comment out the line.

Install the Active Workspace client

Before you install the Active Workspace client using TEM, you must complete the following:

• Install Active Workspace microservices

• Install Active Workspace Gateway

If you are using Deployment Center, you can install the Active Workspace client concurrently with Active
Workspace Gateway.

Install the Active Workspace client configuration using the following software kits:

• Teamcenter major release

• Teamcenter minor release
• Active Workspace 6.0
• Microservices Framework

Note:
Teamcenter software kits contain both Teamcenter and Teamcenter Rapid Start.

Install the Active Workspace client using TEM

1. Launch TEM from the Teamcenter minor release kit.

2. Proceed to the Install/Upgrade Options panel and then click Install.

3. In the Media Locations panel, enter paths to the software kits.

4-18 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

• In the Original Media Location box, enter the path to the software kit for the major version of
Teamcenter or Rapid Start.

• In the Update Location box, enter the paths to Active Workspace 6.0 and Microservices
Framework software kits.

The path to the Teamcenter or Rapid Start minor version software kit is already included in the list
of update locations.

4. In the Configuration panel, enter an ID and a Description for the configuration.

5. In the Features panel, under Base Install→Active Workspace→Client, select Active Workspace
Client.

Select any additional client features you want to include in your Active Workspace environment.
(See Active Workspace Client features.)

Note:
• Some features add additional panels to the installation process that are not described in
this procedure. For information about any TEM panel, click the help button .

• To search for a feature by name, type the name or a partial name in the search box, and
then click the search button .

• Some features depend on other features. Prerequisite features are usually listed earlier
than the features that depend on them.

6. In the Active Workspace Client Settings panel, enter the required values:

Value Description

Publish to Gateway Select this check box to enable automatic publishing of

Active Workspace content to the Gateway.

Note:
The Active Workspace Gateway must be installed and
running before content can be published.

Gateway URL Type the URL to Active Workspace Gateway:

http://host:port

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-19

Value Description

Replace host with the host on which you installed the

Gateway. Replace port with the port you specified when
you installed the Gateway.

For information about other values in the Active Workspace Client Settings panel, click the help
button .

7. In the Confirmation panel, click Start to begin the installation.

8. When the installation is complete, close TEM.

Install the Active Workspace client using Deployment Center

1. Selecting the Active Workspace software automatically includes its basic applications in the
Selected Applications list. The associated components required to deploy Active Workspace are
listed in the Selected Components.

If you haven't already, you can select additional applications you want to include in your Active
Workspace environment.

2. In the Selected Components list, choose Active Workspace Client.

Enter the machine name and operating system. The installation path to Teamcenter may be
specified automatically if it was entered in another component.

3. If you want to automatically publish Active Workspace content to the Gateway, check Publish
Active Workspace Client Assets.

Note:
The Active Workspace Gateway must be installed and running before content can be
published.

4. When the remaining component configuration is complete, click Go to Deploy and generate your
deployment scripts.

Sign in using the Active Workspace interface

From a client machine in your environment, sign in to the Active Workspace client. This verifies the
environment and the Active Workspace Gateway are running.

1. Sign in to a client machine in your environment.

4-20 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

2. Open a supported web browser.

3. Open the Active Workspace client URL:

http://gateway-host:gateway-port

Where gateway-host and gateway-port are the host and port of the Active Workspace Gateway.

For example:

http://myhost:3000

4. Type your Teamcenter user name and password and click Sign in. Verify that you can sign in
without errors.

You can further verify status of the Active Workspace Gateway and microservices using the Gateway
ping functionality.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-21

Indexing

Prepare to install indexing

Before proceeding with installation, be sure you understand the indexing components you want to
install.

The Indexing Engine and Indexer provide global search capabilities for the Active Workspace client.

The indexing engine installs the Solr enterprise search platform. The search engine stores indexed
Teamcenter data for global search in Active Workspace. The indexing engine requires a supported 64-bit
operating system and 64-bit Java development kit (JDK) or Java runtime environment (JRE).

The indexer installs a four-tier services oriented architecture (SOA) client that exports Teamcenter data
for merging into the Solr database. The indexer (TcFTSIndexer) manages overall indexing processes. The
TcFTSIndexer manages initial indexing for object data. You can then schedule synchronization to run
periodically for subsequent updates to object data or structure data indexes.

There are two modes for installing the indexer: standalone for object data and Dispatcher1 for Active
Content structures.

You also have the option of installing the Asynchronous File Content Indexer application, which
additionally uses the dispatcher to index file contents asynchronously from object metadata.

To install and configure indexing, perform the following steps as described in Indexing and Search
Deployment and Configuration:

1. Determine your file content indexing strategy.

1 See Introduction to Dispatcher in the Teamcenter documentation.

4-22 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

2. Install the indexing engine and the indexer.

3. Determine if you require a full index or delta reindex.

Configure Classification Search (optional)

If you are new to classification and want to search for classification data in Active Workspace using
classification standard taxonomy, your first step is to create a classification hierarchy.

If you already use traditional classification and want to search for classification data in Active Workspace
or Teamcenter Manufacturing Access, perform the following steps:

1. Create search index views and specify facetable properties.

2. Update and merge the schema file.

3. Index or reindex your data. If your data is already indexed, it is sufficient to index only the modified
classification data.

These steps are described in Classification and Library Management

Install Dispatcher
The Teamcenter Dispatcher is an asynchronous executor and load balancer of scheduled jobs. If you use
Dispatcher, install the Dispatcher server and client as described in Installing and Configuring Dispatcher
in the Teamcenter help library. Then, install the following Dispatcher translators, which Active
Workspace uses:

• Active Content Structure Translator

Install this translator if you use Dispatcher-based indexing for structure data. This feature must be
installed in the same environment as the Dispatcher server.

• ReqMgmtWordToHtmlTrans (optional)
This translator converts requirements content that has been edited and saved in Microsoft Word from
Teamcenter (stored as a full-text dataset), so that it can be viewed in the rich text editor in Active
Workspace.

• AsyncService (optional)
This translator provides asynchronous reporting and printing.
To set up email notifications this translator uses, set the following preferences:

• MAIL_OSMAIL_ACTIVATED = true

• MAIL_INTERNAL_MAIL_ACTIVATED = true

• MAIL_SERVER_CHARSET = ISO-8859-1

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-23

• MAIL_SERVER_NAME = mail-server-name

• MAIL_SERVER_PORT = 25

• MAIL_SUBSCRIPTION_NOTIFY_SUB_GROUP_TOO = FALSE

• WEB_DEFAULT_SITE_SERVER = host:port

• WEB_DEFAULT_SITE_DEPLOYED_APP_NAME = Teamcenter-web-tier-application

Visualization Server

Visualization Server overview

The Visualization Server provides dynamic 3D and 2D visualization functionality to the Active Workspace
client. If you do not use the 3D viewer or the 2D part of the universal viewer in Active Workspace, do not
install the Visualization Server.

The Visualization Server components are:

• 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 File Client Cache (FCC) for
faster visualization streaming to the Active Workspace client. You can use the Visualization Server
Manager without this component.

4-24 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

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.
The Visualization Data Server is required for using MMV feature in Active Workspace. Additionally, you
need to index structure dataindex structure data for the product configurations that you want to view
using MMV.
The Visualization Data Server requires the following hardware and software:

• Supported Microsoft Windows server platform or supported Linux server platform. For supported
versions, see the Hardware and Software Certifications knowledge base article on Support Center.

• 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.
If you are not sure of the size of the structures, Siemens Digital Industries Software recommends
that you allow approximately 4 GB of RAM for each structure you are planning to cache in the
Visualization Data Server. For example, if 4 structures are to be indexed, 16 GB of RAM is required.

• Siemens Digital Industries 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.

• There are no graphics card requirements.

• You must deploy the Visualization Data Server on a high-speed LAN near the Visualization Server
Manager.

• Siemens Digital Industries 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.

The Visualization Server comprises three 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.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-25

The Visualization Server Manager is required for any use of the 3D viewer or the 2D viewer part of
the universal viewer in Active Workspace.

Siemens Digital Industries Software recommends that you install the Visualization Server Manager
on a machine that does not have a Teamcenter corporate server.

The Visualization Server Manager requires the following software and hardware:

• Operating system
Supported Microsoft Windows server or Linux server platform. For supported versions, see the
Hardware and Software Certifications knowledge base article on Support Center.

• Graphics cards
Server class hardware using NVIDIA GRID K1, K2, Tesla M60, P40, T4, RTX 6000, RTX 8000, A10,
or A40 graphics cards as certified by NVIDIA.

• GPU
Windows Server 2012 R2 supports a maximum of 8 GPUs.
For information about NVIDIA server hardware compatible with the GRID graphics cards, see
www.nvidia.com.
Supported hardware is suitable for a production environment. Other hardware may work with
Active Workspace, but Siemens Digital Industries Software accepts problem reports only for issues
that are reproducible on a supported configuration.
For 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.
Visualization Server Pool Assigner
The Visualization Server Pool Assigner (VPA) manages Visualization Server Managers and routes
users to an available VSM to open 3D documents.

Each Visualization Pool Assigner hosts two MXBeans that contain information about its current
state: Assigner and Assigner monitoring. The MXBeans are located in the Administer Assigner
manager folder.

Siemens Digital Industries Software recommends that you install the Visualization Server Manager
on a machine that does not have a Teamcenter corporate server.
Visualization Data Server
The Visualization Data Server (VDS) improves Visualization performance by caching visualization
data close to the Visualization Server Manager.

The Visualization Data Server is required for using MMV feature in Active Workspace. Additionally,
you need to index structure dataindex structure data for the product configurations that you want to
view using MMV.

4-26 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

For appropriately indexed product configurations, the 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

• Provides bounding box validation

You can use bounding box validation to suppress display of parts that fall outside a defined
assembly box. This can help avoid assemblies opening zoomed out to accommodate errant parts
located far outside the actual assembly. Bounding box validation can also limit a view to include
only a preferred range of the assembly.
Bounding box validation is described in Configuration and Extensibility in the Active Workspace
help library.

A single Visualization Data Server can support one or more Visualization Server Managers.

A Visualization Server Manager is required on the same host as the Visualization Data Server. A
Visualization Data Server is required for implementation of MMV, but is otherwise optional.

The Visualization Data Server requires the following hardware and software:

• Supported Microsoft Windows server platform or supported Linux server platform. For supported
versions, see the Hardware and Software Certifications knowledge base article on Support Center.

• A minimum of 16 GB of RAM on the machine that hosts the Visualization Data Server. 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.
If you are not sure of the size of the structures, Siemens Digital Industries Software recommends
that you allow approximately 4 GB of RAM for each structure you are planning to cache in the
Visualization Data Server. For example, if 4 structures are to be indexed, 16 GB of RAM is
required.

The VDS has no graphics card requirements.

Further guidelines for deploying the VDS:

• You must deploy the Visualization Data Server on a high-speed LAN near the Visualization Server
Manager.

• You must deploy an FMS client cache (FCC) component on the machine hosting the Visualization
Data server.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-27

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.

• Siemens Digital Industries Software recommends:

• 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 used if they are available. Standard server class machine
hardware is sufficient.

• 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.

Should I use client-side or server-side rendering?

Rendering 3D data

The 3D viewer is displayed within the universal viewer area in the Overview tab for objects that have
viewable attachments. The 3D viewer is also displayed in the 3D tab to explore 3D data (JT) associated
with parts and assemblies.

The render location setting applies to both viewer locations.

Client-side rendering

Client-side rendering uses WebGL to leverage client-side graphics capabilities via the Active Workspace
client browser.

Note:
The Visualization Server is still required for visualizing 3D data in Active Workspace with client-side
rendering. However, no graphics card is required on the Visualization Server.

Note:
When using Firefox, client-side rendering requires Firefox version 75 and later.

Client-side rendering provides these benefits:

• A server-side graphics card is not required.

• Rendering does not rely on the processing power of the server.

4-28 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

• Rendering is unaffected by network traffic and is more responsive and less latency sensitive. However,
the triangles of the model must be loaded onto the client machine before it can render.

Server-side rendering may still be more suitable for larger data sizes due to its typically faster load speed
and a higher data size limit. Server-side rendering is necessary for client devices that do not support
Web GL.

Set client-side rendering

To set the default rendering method for the 3D viewer and the universal viewer, specify the correct value
in the Teamcenter preference AWV0ViewerRenderOption:

CSR (client-side rendering)

SSR (server-side rendering) This is the default value.

The user can change the rendering method on the Viewer Options panel.

Should I use MMV?

Massive Model Visualization (MMV) is a visualization technology that uses Visibility Guided Rendering
(VGR) to increase performance and scalability for the viewing of extremely large 3D models, such as
cars, airplanes, and ships. Models of this size typically consist of a massive amount of geometry
arranged in a relatively compact space with a huge amount of internal geometry hidden behind the
“outer shell” of the product. It can take hours to display such models in their entirety, because every
piece of geometry in the model needs to be retrieved and processed, which far exceeds the capability of
today’s commonly available hardware. MMV technology resolves this problem by leveraging VGR
techniques to load only those parts required to render a given scene; parts that are not visible because
they are occluded by other parts in the foreground are not loaded. As a result, large 3D models become
visible in a fraction of the time previously required.

If a structure has more than 120,000 BOM lines, MMV rendering is required for scalability and
performance. If a structure has more than 30,000 BOM lines, MMV is recommended.

Visualization of MMV data in the Active Workspace client requires an MMV license. If the necessary
license is not present, the full model loads as standard JT data.

A Visualization Data Server is required for implementation of MMV, but is otherwise optional.

To use the Visualization Data Server to compute Massive Model Visualization (MMV) spatial hierarchies
of structures, you must

1. Apply the MMV index structure flag to the product configurations that you want to view using
MMV.

2. Use the bomindex_admin utility to include the configurations in the list of structures to index.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-29

To take advantage of the structure and JT pre-caching feature of the Visualization Data Server for
improved visualization performance of structures that are not indexed for MMV:

1. Apply the VDS indexing flag for product configurations that will be viewed frequently but are not
indexed for MMV.

2. Use the bomindex_admin utility to include the configurations in the list of structures to index.

Visualization Server Manager

Visualization Server Manager prerequisites

Operating systems

The Visualization Server Manager (VSM) supports both large model visualization (LMV) and massive
model visualization (MMV) on supported Microsoft Windows and Linux server platforms.

On a Linux machine without a GPU or without a supported level of OpenGL, client side rendering is
supported, but server side rendering is not supported and fails to load.

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

Server hardware and graphics cards

The following hardware is supported for the Visualization Server Manager.

• For server side rendering:

Server class hardware certified by NVIDIA to support NVIDIA GRID K1, K2, Tesla M60, P40, T4, RTX
6000, RTX 8000, A10, or A40 graphics cards. Note that any server capable of supporting Server Side
Rendering also supports client side rendering.

• For client side rendering:

If no server side rendering is needed, any web server class hardware is sufficient to support client side
rendering.

Sizing of hardware should be appropriate to support intended data sizes and usage patterns. See VSM
hardware sizing for more info about hardware sizing.

Windows Server versions supported with the Visualization Server Manager support a maximum of 8
GPUs, with certain exceptions. For example, on a Windows Server 2012 R2 machine with two NVIDIA
GRID K1 cards, the legacy VGA device makes the fourth GPU on one card unavailable for use.

Active Workspace 6.0 supports virtualized server-side rendering for certain hardware and software
combinations.

4-30 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

For information about server hardware compatible with supported NVIDIA GRID graphics cards, see
www.nvidia.com.

Virtualization

If you use only client-side rendering, the VSM can be virtualized.

If you use server-side rendering, the VSM must be installed on physical hardware, unless you follow a
supported virtualization combination.

Active Workspace visualization supports virtualization for certain combinations of:

• Host OS and version

• Virtualization layer

• Guest OS and version

• NVIDIA GPU

For information about supported combinations, see the Graphics Card Certification Matrix in the
Hardware and Software Certifications knowledge base article on Support Center: https://
support.sw.siemens.com

For information about NVIDIA virtual GPU compatibility, see NVIDIA virtual GPU (vGPU) software
documentation at docs.nvidia.com.

VSM hardware sizing

Sizing of VSM hardware should allow for typical and maximum expected usage by considering the
following factors:

• Expected numbers of concurrent Active Workspace visualization users

• Expected product data sizes

• CPU, RAM, VRAM and GPU resources consumed by expected product data

In general, a high end server with:

• A maximum number of CPU cores with processing speeds of 3.0 GHz or faster

• A minimum of 64 GB of RAM

• A minimum of 256 GB of disc space

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-31

In addition, a VSM that will support Server Side Rendering requires an NVIDIA GRID graphics card. For
information about server hardware compatible with supported NVIDIA GRID graphics cards, see
www.nvidia.com.

For additional guidance in sizing of VSM hardware, contact your field services professionals.

Environment information

Make sure you know the following values. These are needed during installation of the Visualization
Server Manager.

Visualization These are defined in Install the Visualization Server Pool Assigner.
Server Pool
Assigner
host and
port
Visualization These are defined in Install the Visualization Data Server.
Data Server
host and
port (if VDS
is to be
installed)
Host and These are defined during Teamcenter installation.
port of FCC
parents

Linux machine configuration

Before you install the VSM on a Linux machine, perform the following steps:

1. Make sure the machine has the required RPM package managers.

2. Configure Xserver on the machine.

• Linux machine with no GPU:

Configure Xserver for offscreen and headless operation for use by the visualization server
processes. After reboot, run the following commands:

- setenv DISPLAY :0
- sudo xhost +

• Linux machine with GPU:

a. Configure Xserver for offscreen and headless operation for use by the VisServer processes.

4-32 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

b. Make sure the XServer is running. One way to verify this is to see if the X or Xorg process is
running by typing the following command:

ps -ef | grep X

c. Set up the NVidia GPU on the Linux machine by typing the following command:

setup_xserver.sh default

The default parameter specifies to use the graphics card and bus id discovered by the
script. If you do not specify this parameter, the script prompts you to confirm the card and
bus id, and provides the opportunity to change these values if you want.

For example:

sudo ./setup_xserver.sh

Or:

sudo ./setup_xserver.sh default

Install the Visualization Server Manager

You can install the Visualization Server Manager in a new or an existing Teamcenter configuration.

If you are adding the Visualization Server Manager to an existing configuration, proceed as follows:

1. Apply the Active Workspace patch to the host.

2. Launch the installed TEM in maintenance mode and skip to step 7 below.

Otherwise, if you are installing the Visualization Server Manager on a host with no existing Teamcenter
environment, proceed to step 1 below.

1. Ensure you have access to the following required software kits:

• Latest Teamcenter minor release, for example, Teamcenter 14.0

• Corresponding Teamcenter major release, for example, Teamcenter 14

• Active Workspace 6.0

Make sure you use the appropriate Active Workspace 6.0 software kit that corresponds to your
version of Teamcenter.

1. Launch TEM from the Teamcenter minor release software kit.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-33

On Windows systems, launch TEM with administrator privileges (right-click→Run as

administrator).

2. In the Welcome to Teamcenter panel, select Teamcenter.

3. In the Install / Upgrade Options panel, click Install.

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

a. In the Original Media box, enter the location of the Teamcenter major release software kit.

b. In the Update Location box, add the location of the Active Workspace 6.0 software kit.

Note that the location of the Teamcenter minor release software kit is already included in the
list. Make sure the Teamcenter location is listed before the Active Workspace location.

5. In the Configuration panel, enter values for ID and Description.

6. In the Solutions panel, make no selections.

7. Proceed to the Features panel. Select the Visualization Server Manager feature, under Base
Install→Active Workspace→Visualization Server.

In the Installation Directory box, enter the location in which to install the Visualization Server
Manager.

8. In the File Client Cache (FCC) panel, set the FMS_HOME environment variable.

9. In the FCC Parents panel, define the list of FSC parents to which the Visualization Server Manager
connects. You must provide protocol, host, and port of the FSC parent. To add rows to the table,
click Add.

If you are using a Visualization Data Server, the Visualization Data Server and the Visualization
Server Manager should use the same FSC.

10. In the Configuration section of the Visualization Server Manager panel, provide values for the
Visualization Server Manager.

Local Host Specifies the alias for the local Visualization Server Manager.
Alias
Server Host Specifies the host where the Visualization Server Manager is running. This must
be the local machine name and must be resolvable by the Visualization Pool
Assigner machine (the machine running the Active Workspace Gateway). Do not
use localhost or 127.0.0.1.
Server Port Specifies the port on which the Visualization Server is listening.

4-34 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

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

For example, on Windows machines, the default value is 30. On Linux machines,
the default value is 200.
Min Warm Specifies the minimum number of Visualization server processes in this pool that
Servers are started but not assigned.

Note:
If necessary to maintain the minimum number of warm servers, while not
exceeding the maximum number of server processes, the server manager
times out servers in use.

11. If you use a Visualization Data Server, provide the values for this server in the Visualization Data
Server Configuration section of the Visualization Server Manager panel.

Add Select this if you are using a Visualization Data Server.

Visualization
Data Server
Host Type the name of the host on which the Visualization Data Server is installed.
Port Type the port value used by the Visualization Data Server.

A Visualization Data Server improves performance by caching product structure and JT parts files.

12. In the Visualization Server Manager Settings panel, define the settings for how the Visualization
Server Manager communicates with the pool assigners.

• Override local node settings

Select to override the host name and port value. Enter the Host and Vis Assigner Port values of
the local machine. In the Gateway Connection Port box, enter the port used by the Active
Workspace Gateway.

• Visualization Server Pool Assigners

Lists the pool assigners that this Visualization Server Manager uses.

• Assigner Host
Host name of the machine where the Visualization Server Pool Assigner runs.

• Assigner Port
Port value of the pool assigner.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-35

13. In the Operating System User panel, type the user’s password.

14. In the Confirmation panel, click Start.

15. When the installation is complete, close TEM.

Start the Visualization Server Manager

Start the Visualization Server Manager on Linux

To start the Visualization Server Manager (VSM) on a Linux machine, type the following command:

TC_ROOT/vispoolmanager/run_servermgr.sh

Optional: Start the VSM as a Linux daemon

Alternatively, you can start the Visualization Server Manager as a daemon by running the
installservice.sh command for each jetty server (run with admin permissions):

installservice.sh unique-service-name port user

If you do not specify parameters, the script will run in interactive mode and prompt you for the
information.

For example, from the TC_ROOT/vispoolmanager/jetty directory, type:

sudo ./installservice.sh MyUniquePoolManager1 8090 MyUser

Uninstalling the Linux daemon:

To uninstall the VSM daemon, run the uninstallservice.sh command for each jetty server (run with
admin permissions):

uninstallservice.sh service-name

For example, from the TC_ROOT/vispoolmanager/jetty directory, type:

sudo ./uninstallservice.sh MyUniquePoolManager1

If you do not know the name of the service, look in the TC_ROOT/vispoolmanager/jetty/ or /etc/
systemd/system directory and find the file named service-name.service. The service-name is the
unique service name you provided to the installservice.sh command.

4-36 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Start the Visualization Server Manager on Windows

1. Make sure the FMS_HOME environment variable is set as a system environment variable, not a
user variable. The Visualization Server Manager (VSM) runs as a service only if FMS_HOME is a
system environment variable.

2. Run the following file:

TC_ROOT\vispoolmanager\run_visservermgr.cmd

Note:
If the Visualization Server Pool Assigner is not running, the Visualization Server Manager
displays console messages until it finds the VPA. To avoid this, start the Visualization Server
Pool Assigner before you start the Visualization Server Manager.

When running run_visservermgr.cmd, you can use Windows Remote Desktop Connection to sign in to
the machine on which the Visualization Server Manager is installed if you have an NVIDIA card with a
driver version of 340.66 or later. Other remote access products, such as VNC, also can be used.

After running run_visservermgr.cmd, you can lock the machine, but you must remain logged on. If you
sign out, the Visualization Server Manager is shut down.

The Visualization Server Manager requires access to the graphics card and consequently cannot run as a
Windows service in server-side rendering mode. However, you can start the Visualization Server
Manager as a Windows service when you use client-side rendering exclusively.

Optional: Configure automatic logon and restart on Windows

You can configure Windows to automatically log on and restart the Visualization Server Manager In the
event of a system reboot.

Caution:
Enabling automatic logon bypasses security. When Windows is configured to automatically log on,
anyone with physical access to the machine can restart it and gain entry to the system. Use
automatic logon only if the system is in a secure environment.

1. Open the Windows User Accounts dialog box:

a. Press the Windows key+R to display the Run dialog box.

b. In Open, type netplwiz, and then click OK.

2. In the User Accounts dialog box, select a user account from the list.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-37

3. Clear the Users must enter a user name and password to use this computer check box.

4. Click Apply.

The Automatically sign in dialog box is displayed.

5. In the Password and Confirm Password boxes, type the user's password.

6. Click OK.

The specified user is automatically logged on when Windows starts.

7. Create a script or batch file to launch the Visualization Server Manager. Include the following
command to lock the workstation:

rundll32.exe user32.dll LockWorkStation

8. Create a new task with Windows Task Scheduler to run the script or batch file at log on.

Optional: Start the VSM as a Windows service

You can start the Visualization Server Manager as a Windows service only when you are exclusively
using client-side rendering. Windows services cannot access the graphics card, so this is not a suitable
deployment for server-side rendering.

1. To install the Visualization Server Manager as a Windows service, run the installservice.bat
command:

installservice.bat "%JAVA_HOME%" "VSM-dir" pool-ID port

Replace VSM-dir with the path to the Visualization Server Manager’s jetty directory. Replace pool-
ID and port with the ID and port for the VisPoolManager service. The port must match the
VisPoolProxy.poolUrl port in the jettyservice.properties file.

For example:

installservice.bat "%JAVA_HOME%" "%TC_ROOT%\vispoolmanager\jetty" vispool-A 8090

2. Locate the newly installed service named Teamcenter VisServlet pool-ID in the list of Windows
services.

3. Right-click the service name and choose Properties.

4. On the Log On tab, enter logon credentials for the domain user account under which the service
runs.

4-38 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Visualization Server Manager requires an FMS client cache (FCC) to cache files. It is recommended
that you use a dedicated account to run this service, not the Local System account.

Windows attempts to run the service automatically by default. If the service is not already running,
a problem may have occurred.

If you set the service to start manually in its Properties, then you can click the Run button from the
toolbar to start the service, or right-click the service in the Services window, and choose Start.

To stop the service, either click Stop Service on the toolbar, or right-click the service and choose
Stop.

To uninstall the service, type uninstallservice.bat "Teamcenter VisServlet pool-ID".

Test Visualization from the Active Workspace client interface

Before you begin the following procedure, make sure the Visualization Server Manager installation and
the Active Workspace client installation tasks are complete.

You can test the Visualization Server by logging on with the Active Workspace interface and viewing
Visualization data, for example, a JT file.

1. Ensure that the following are running:

• Visualization Server Manager

• Visualization Pool Assigner

• Active Workspace Gateway

• Web application server hosting the Teamcenter web tier application

• Teamcenter server manager

• Teamcenter database

2. Open a supported web browser.

3. Open Active Workspace at the following URL:

http://host:port

host is the machine running the Active Workspace Gateway.

port is the port used by the Active Workspace Gateway.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-39

4. Sign in with a valid user name and password.

5. Search for and open an object that has an attached JT file.

6. Click the 3D tab to display the JT file.

Visualization Server Pool Assigner

Visualization Server Pool Assigner prerequisites

Software

The Visualization Server Pool Assigner requires the following software:

• A supported Microsoft Windows Server operating system or Linux operating system on the
Visualization Server Manager host.
For supported versions, see the Hardware and Software Certifications knowledge base article on
Support Center.

• The Visualization Extension Server Extensions feature on the corporate server and on any server
that has Teamcenter Foundation installed.

Environment information

Make sure you know the following values. These are needed during installation of the Visualization
Server Manager.

Visualization Server Pool Assigner host and port

4-40 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Visualization These are defined in Install the Visualization Data Server.

Data Server
host and
port (if VDS
is to be
installed)
Host and These are defined during Teamcenter installation.
port of FCC
parents

Install the Visualization Server Pool Assigner

You can install the Visualization Server Pool Assigner in a new or an existing Teamcenter configuration.

If you are adding the Visualization Server Pool Assigner to an existing configuration, proceed as follows:

1. Apply the Active Workspace patch to the host.

2. Launch the installed TEM in maintenance mode and skip to step 7 below.

Otherwise, if you are installing the Visualization Server Pool Assigner on a host with no existing
Teamcenter environment, proceed to step 1 below.

1. Ensure you have access to the following required software kits:

• Latest Teamcenter minor release, for example, Teamcenter 14.0

• Corresponding Teamcenter major release, for example, Teamcenter 14

• Active Workspace 6.0

Make sure you use the appropriate Active Workspace 6.0 software kit that corresponds to your
version of Teamcenter.

1. Launch TEM from the Teamcenter minor release software kit.

On Windows systems, launch TEM with administrator privileges (right-click→Run as

administrator).

2. In the Welcome to Teamcenter panel, select Teamcenter.

3. In the Install / Upgrade Options panel, click Install.

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

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-41

a. In the Original Media box, enter the location of the Teamcenter major release software kit.

b. In the Update Location box, add the location of the Active Workspace 6.0 software kit.

Note that the location of the Teamcenter minor release software kit is already included in the
list. Make sure the Teamcenter location is listed before the Active Workspace location.

5. In the Configuration panel, enter values for ID and Description.

6. In the Solutions panel, make no selections.

7. Proceed to the Features panel. Select the Visualization Server Pool Assigner feature, under Base
Install→Active Workspace→Visualization Server.

In the Installation Directory box, enter the location in which to install the Visualization Server
Manager.

8. In the Visualization Server Pool Assigner Settings panel, enter settings to configure the
Visualization Server Pool Assigner:

Value Description

Host Specifies the host on which this Visualization Server

Pool Assigner runs. This is the host on which this
Visualization Server Pool Assigner is deployed. You may
type the host name or IP address of the host.

Vis Assigner Port Specifies the port used by the local Visualization Server
Pool Assigner.

Gateway Connection Port Specifies the port through which the Active Workspace
Gateway connects to the Visualization Server Pool
Assigner. The default value is 3000.

Add pool assigner Specifies whether additional Visualization Server Pool

Assigners are used. Select the Add pool assigner check
box to add pool assigners.

Peer Assigners The Peer Assigners table lists other Visualization Server
Pool Assigners known to the local Visualization Server
Pool Assigners.

Assigner Host Specifies the host on which a peer Visualization Server

Pool Assigner is deployed. This value can be the host
name or IP address.

4-42 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Value Description

Assigner Port Specifies the port number used by the peer

Visualization Server Pool Assigner.

Server Side 4-tier URL Specifies an alternate four-tier URL for the viewer to
connect to Teamcenter. The Visualization Server uses
this in case the primary four-tier URL is blocked by a
firewall, or if a more direct route is needed for
performance.

9. In the Confirmation panel, click Start.

10. When the installation is complete, close TEM.

Start the Visualization Server Pool Assigner

Linux Systems

To start the Visualization Server Pool Assigner (VPA) on a Linux machine, type the following command:

TC_ROOT/visassigner/run_assigner.sh

Alternatively, you can start the Visualization Server Pool Assigner as a daemon by running the
installservice.sh command for each jetty server (run with admin permissions):

installservice.sh unique-service-name port user

If you do not specify parameters, the script will run in interactive mode and prompt you for the
information.

For example, from the TC_ROOT/visassigner/jetty directory, type:

sudo ./installservice.sh MyUniqueAssigner1 7780 MyUser

Windows Systems

To start the Visualization Server Pool Assigner (VPA) on a Windows machine, run the following file:

TC_ROOT\visassigner\run_visassigner.cmd

After running run_visassigner.cmd, you can lock the machine, but you must remain logged on. If you
sign out, the VPA is shut down.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-43

Alternatively, you can start the Visualization Server Pool Assigner as a Windows service only when you
are exclusively using client-side rendering. Windows services cannot access the graphics card, so this is
not a suitable deployment for server-side rendering.

1. To install the Visualization Server Pool Assigner as a Windows service, run the installservice.bat
command:

installservice.bat "%JAVA_HOME%" "VPA-dir" assigner-ID port

Replace VPA-dir with the path to the Visualization Server Pool Assigner’s jetty directory. Replace
assigner-ID and port with the ID and port used by the Active Workspace Gateway to connect to the
Assigner.

For example:

installservice.bat "%JAVA_HOME%" "%TC_ROOT%\visassigner\jetty" VisAssigner-A 8089

2. Locate the newly installed service named Teamcenter VisServlet assigner-ID in the list of
Windows services.

3. Right-click the service name and choose Properties.

4. On the Log On tab, enter logon credentials for the domain user account under which the service
runs.

Windows attempts to run the service automatically by default. If the service is not already running,
a problem may have occurred.

To stop the service, either click Stop Service on the toolbar, or right-click the service and choose
Stop.

To uninstall the service, type uninstallservice.bat "Teamcenter VisServlet assigner-ID".

Visualization Data Server (optional)

Visualization Data Server prerequisites

Software

The Visualization Data Server requires the following software:

• Microsoft Windows Server operating system on the Visualization Data Server host.

4-44 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

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

• The Visualization Extension Server Extensions feature on the corporate server and on any server
that has Teamcenter Foundation installed.

• A Visualization Server Manager installed on the Visualization Data Server host.

• An FMS client cache (FCC) component on the Visualization Data server host.

• Structure indexing configured on the Visualization Data server host.

The Visualization Data Server uses the structure indexing infrastructure of Active Workspace to keep
cached product structure up-to-date.

Hardware

• Graphics card: No requirements.

• Network: You must deploy the Visualization Data Server on a high speed LAN near the Visualization
Server Manager.

• Memory: The Visualization Data Server host should have a minimum of 16 GB of RAM, but may
require more.

Note:
How to determine memory needed:
The amount of RAM needed depends on the number of structures to be indexed and their size.
A rough rule of thumb is to count the number of lines in the unconfigured structure to be indexed
and allow at least 2000 bytes per line. For example, if there are 1 million lines in the unconfigured
product index, then 1 million * 2000 = 2 GB of RAM.
If you are not sure of the size of the structures, Siemens Digital Industries Software recommends
that you allow approximately 4 GB of RAM for each structure you are planning to cache in the
Visualization Data Server. For example, if 4 structures are to be indexed, 16 GB of RAM is
recommended.

Environment information

Installing the Visualization Data Server requires the following values from your Teamcenter
environment:

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-45

Values required before beginning the Visualization Server taskflow

Parameter Where value is defined Your value

FCC parents Teamcenter installation

Teamcenter four-tier URL Teamcenter installation

Values to record during the Visualization Server taskflow execution

Parameter Where value is defined Your value

Visualization Data Server host Install the Visualization Data

and port Server

Recommendations

Siemens Digital Industries Software recommends that you install the Visualization Data Server on a
machine with the following:

• Multiple processors
The Visualization Data Server is a multithreaded server program and is thus resource intensive;
multiple processors are utilized if they are available. Standard server class machine hardware is
sufficient.

• FSC cache or FSC volume

If you deploy the Visualization Data Server remote (on a WAN) from the FSC volume, you should
deploy an FSC cache on a LAN near or on the Visualization Data Server host machine.

• Visualization Server Manager

For maximum performance, the Visualization Data server should be installed on the same machine as
the Visualization Server Manager and should use the same cache.
A single Visualization Data Server can support one or more Visualization Server Managers.

Install the Visualization Data Server

You can install the Visualization Data Server (VDS) in a new or an existing Teamcenter configuration.
Siemens Digital Industries Software recommends that you install the Visualization Data Server on a
machine that does not have a Teamcenter corporate server.

If you are adding the Visualization Data Server to an existing configuration, proceed as follows:

1. Apply the Active Workspace patch to the host.

2. Launch the installed TEM in maintenance mode and skip to step 8 below.

4-46 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Otherwise, if you are installing the Visualization Server Manager on a host with no existing Teamcenter
environment, proceed to step 1 below.

1. Ensure you have access to the following required software kits:

• Latest Teamcenter minor release, for example, Teamcenter 14.0

• Corresponding Teamcenter major release, for example, Teamcenter 14.

• Active Workspace 6.0

Note:
• Make sure you use the appropriate Active Workspace 6.0 software kit that corresponds to
your version of Teamcenter.

• Teamcenter software kits contain both Teamcenter and Teamcenter Rapid Start.

2. Launch TEM from the Teamcenter minor release software kit.

3. In the Welcome to Teamcenter panel, select Teamcenter or Teamcenter Rapid Start as

appropriate.

4. In the Install / Upgrade Options panel, click Install.

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

a. In the Original Media box, enter the location of the Teamcenter major release software kit.

b. In the Update Location box, add the location of the Active Workspace 6.0 software kit.

Note that the location of the Teamcenter minor release software kit is already included in the
list. Make sure the Teamcenter location is listed before the Active Workspace location.

6. In the Configuration panel, enter values for ID and Description.

7. In the Solutions panel, make no selections.

8. In the Features panel, select the Visualization Data Server feature:

Base Install→Active Workspace→Visualization Server→Visualization Data Server

In the Installation Directory box, enter the location in which to install the Visualization Data
Server.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-47

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

10. In the FCC Parents panel, define the list of FSC parents to which the Visualization Data Server
connects. You must provide protocol, host, and port of the FSC parent. To add rows to the table,
click Add.

To improve performance, the Visualization Data Server and the Visualization Server Manager
should use the same FSC.

11. In the Teamcenter Administrative User panel, enter the user's password.

12. In the Visualization Data Server Configuration panel, enter required values:

• Server Port
This is the port number on which the Visualization Data Server listens.

• Teamcenter 4-tier URL

This is the URL of the Teamcenter web tier application. The format is:

http://host:port/tc-web-app

host is the machine running the web application server on which the Teamcenter web
application is deployed.

port is the port value used by the web application server.

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

13. In the Confirmation panel, click Start.

14. When the installation is complete, click Close.

MMV indexing data

If you use Massive Model Visualization (MMV), configure MMV indexing.

When structures using MMV rendering are indexed, the last valid indexed data is always retained. So,
you can always see MMV indexed data; however, the data in a structure may be more recent.

When MMV data is being indexed it may use a backup system. It is recommended that the administrator
retains interim files so when an error occurs, they can be analyzed to determine the issue. These two
Teamcenter preferences can be used to control the output of the generated files:

• MMV_keep_generated_files

4-48 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Use this preference to preserve the generated files for further examination. You can specify when
generated files are kept by using these values:

1: Keep the generated files when an error occurs.

2: Always keep the generated files.

3: Never keep the generated files.

• MMV_staging_directory
Use this preference to control the working directory to be used for the tcxml2mmp conversion
process on the Teamcenter server. If this is not set, the default temporary directory is used as staging
directory.

Start the Visualization Data Server

To start the Visualization Data Server Manager, enter the following command:

• Windows systems:

TC_ROOT\VisDataServer\Program\VisDataServer.exe

• Linux systems:

TC_ROOT/VisDataServer/bin/VisDataServer

After the Visualization Data Server is started, it automatically detects and caches product configurations
that have been indexed with the MMV flag. These cached product configurations are now ready for fast
visualization with the MMV technology.

A product configuration is ready for MMV visualization after it has been indexed, the Visualization Data
Server has detected, downloaded and cached the structure, and prepopulated the FMS system. If you
attempt to visualize a product configuration that is not yet completely indexed and cached in the
Visualization Data Server, the viewer uses the regular non-MMV mode by default. Changes in the
product configuration need to be re-indexed and re-read by the Visualization Data Server before they
can be displayed by the viewer.

Additional configuration for the Visualization Data Server is available in the etc/
VisDataServer.properties file. This includes detailed logging and fine tuning of other settings. If you
make changes to the properties file, you need to restart the Visualization Data Server.

Optional: Start the Visualization Data Server as a Linux daemon

To install these services, run the installservice.sh located in the VisDataServer/bin folder. Run this
command with administrator permissions:

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-49

installservice.sh unique-service-name user FMS_HOME

For example, from the VisDataServer/bin/ directory, type:

sudo ./installservice.sh VDS MyUser /VIS/VisServer/FCC

If you do not specify arguments, the script runs in interactive mode and prompts you for the required
values.

To uninstall services, run the uninstallservice.sh script for each Jetty server. Run this command with
administrator permissions.

uninstallservice.sh service-name

For example, from the VisDataServer/bin/ directory, type:

sudo ./uninstallservice.sh VDS

If you do not specify arguments, the script runs in interactive mode and prompts you for the required
values.

If you do not remember the name of the service, find it by the following steps:

1. Change to the VisDataServer/bin/ or /etc/systemd/system directory.

2. Look for a file named name.service. The name in this file name is the unique-service-name you
specified when you installed the service using installservice.sh.

Optional: Start the Visualization Data Server as a Windows service

1. Make sure the FMS_HOME environment variable is set as a system environment variable, not a
user variable. The VDS runs as a service only if FMS_HOME is a system environment variable.

2. Inspect the VisDataServer.properties and make sure all file paths specified in it are full paths, not
relative paths.

3. Open a Teamcenter command prompt and change to the root directory of the Visualization Data
Server.

4. Install the Visualization Data Server as a Windows service by running the VisDataServer.exe
command with the /registerService argument:

VisDataServer.exe /registerService /displayName=name /startup=option

Replace name with a display name for the service. Replace option with automatic or manual.

4-50 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

For example:

VisDataServer.exe /registerService /displayName=VisDataServer /startup=automatic

Optional additional arguments:

Argument Description Example

description Specifies a description for the service. /description="VDS for Active
Workspace 6.0"
config Specifies a configuration file to load for /config="VDSConfig.txt"
the application.

After the service is successfully installed, Windows displays the following message:

The application has been successfully registered as a service.

5. Configure the VDS service:

a. In the Windows Services dialog box, locate the VDS service by the name you specified in the
displayName attribute.

b. Right-click the service name and choose Properties.

c. In the Log on tab, enable the service logon with the following options:

• Log on as: Select This account, then enter the domain and user name (for example,
myDomain\myName).

• Password: Enter and confirm the password for the user account.

Note:
The VDS requires an FMS client cache (FCC) to cache files. Use a dedicated account to
run this service, not the Local System account.

Windows attempts to run the service automatically by default. If the service is not already running when
you open the Windows Services dialog box, the installation may have failed.

If you set the service to start manually, right-click the service name and choose Start. To stop the
service, right-click the service name and choose Stop.

To uninstall the service, run the VisDataServer.exe utility with the /unregisterService argument.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-51

Rebuild VDS repository from scratch

As the VDS repository is updated via deltas containing incremental changes from Teamcenter that occur
as design data evolves, the repository used to support MMV viewing may introduce errors. A good
practice is to periodically regenerate the VDS repository from scratch. The default threshold for this
scratch rebuild is every 500 delta updates, but this value is configurable by an administrator so that a
full regeneration of the VDS repository can be set to occur more or less often, depending on the
observed need.

To change the number of deltas that are processed before a scratch rebuild of the VDS repository, set the
MMV_delta_collection_accumulation_limit Teamcenter preference to a value higher or lower than the
default value of 500. This will change how often the VDS rebuilds its repository from scratch.

Note — To manage the number of delta files that are to be deleted, use the
MMP_PERCENTAGE_OF_DELTA_TO_PURGE preference. Its default value is 100, but based on your
need, you can set it to any value from 10 to 100. Refer to the following table to understand preference
value limits:

If preference value is set to then preference value processed is

<=10 10

10 < value < 100 value

>=100 100

All delta files are deleted when the MMP_PERCENTAGE_OF_DELTA_TO_PURGE preference value is set
to 100.

Example:
Set the MMV_delta_collection_accumulation_limit preference value to 500.
In this case, since the value is set to 500, it becomes the maximum delta limit. After this many
deltas are processed, a completely new mmp file is created.
To delete 100% (all) of the old delta files in the MMV dataset, set the
MMP_PERCENTAGE_OF_DELTA_TO_PURGE preference value to 100. If you want to delete only
10% of the old delta files in the MMV dataset, set the MMP_PERCENTAGE_OF_DELTA_TO_PURGE
preference value to 10.

Visualization Data Server status log settings

Configuration for the Visualization Data Server is available in the etc/VisDataServer.properties file. This
includes detailed logging and fine tuning of other settings. If you make changes to the properties file,
you must restart the Visualization Data Server.

Log information includes the status of all products hosted by the Visualization Data Server.

4-52 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

#
# Status logger settings. The status logger can be of help showing
the current indexing status
# and also the current and waiting task to be processed.
#
# The interval to generate the status log (see the "Interval"
documentation
for more info).
StatusLogger.StatusInterval=120
# This will output the name of the top level (root) node.
StatusLogger.ShowRootName = true
# Shows the timestamp of the indexed product.
StatusLogger.ShowTimestamp = true
# Shows the available revision rules of indexed product.
StatusLogger.ShowRevRule = true
# Shows the status of the Spatial JTs.
StatusLogger.ShowSpatialJt = true
# If ShowSpatialJt is true, also shows the file path of the Spatial JTs.
StatusLogger.ShowSpatialJtPath = true
# If ShowSpatialJt is true and a Spatial JT is missing, the string will
be added
in from of the path.
# This can be used if a specific string is needed to search for a
missing
file (like using the grep utility).
StatusLogger.MissingSpatialJtMessage = (missing)
# Shows all the versions of a product instead of just the latest one.
StatusLogger.ShowAllVersions= false
# Shows the active tasks being processed.
StatusLogger.ShowActiveTasks=true
# Shows any waiting tasks to be processed.
StatusLogger.ShowWaitingTasks=true

Install the Active Workspace Launcher

The Active Workspace Launcher connects Active Workspace to Microsoft Office applications, opening the
appropriate Office application when you open an attachment in Active Workspace.

To enable this behavior on an Active Workspace client host:

1. Install Microsoft Office.

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

2. Depending on your needs, install Teamcenter Client for Microsoft Office and/or Teamcenter
Extensions for Microsoft Office as described in Teamcenter Rich Client Installation on Windows in
the Teamcenter help.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-53

3. Install Active Workspace Launcher:

a. In the Teamcenter minor release software kit, open the wntx64\additional_applications

\TcClientAppLauncher directory and launch setup.exe.

b. Complete the installation wizard.

4. To enable the editing of requirements in Active Workspace, you must perform additional setup
tasks.

If you want to host Active Workspace within Client for Office, set Active Workspace hosting preferences
as described in Configuration and Extensibility.

Note:
Kerberos authentication is not supported with Client for Office.

Install Active Workspace Launcher silently

Alternatively, you can install the Active Workspace Launcher silently, without user interaction:

1. To generate a silent installation file, type the following command in a command prompt:

setup.exe /r /f1"path\tclauncher.iss"

For example, to generate a silent file in the c:\temp folder, enter the following command:

setup.exe /r /f1"c:\temp\tclauncher.iss"

Do not include a space between the f1 argument and the path that follows it. The path must be
enclosed in double quotation marks (" ") as shown.

2. To install the Active Workspace launcher silently on another system, type the following command:

setup.exe /s /f1"c:\tclauncher.iss"

Troubleshoot the Active Workspace Launcher installation

If Microsoft Office applications fail to launch when opening an attachment, the .awoai file may be
associated with Microsoft Word instead of the Active Workspace Launcher. To resolve this, perform one
of the following tasks:

• Uninstall and reinstall the Teamcenter Active Workspace Launcher and try again.

• In the HKEY_CLASSES_ROOT\.awoai\shell\Open\command registry entry, ensure the .awoai file

extension is correctly associated with the TcClientApplauncher.exe command.

4-54 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Install classification libraries

Prerequisites:

• The Classification Library Management feature must be installed and configured on Teamcenter.

• The presentation layer must be created with the clsutility.

• The library data must be created with the lbrmanager utility.

For more information, see how to use Library Management to selectively display the classification
hierarchy in Configuration and Extensibility.

The following displays the interaction of the various components necessary to use Classification in
Active Workspace:

• Server

• To install the server components for classifying objects and searching for classified objects:
Select Active Workspace→Server Extensions→Reuse and Standardization→Classification
Server.

• To install the server components necessary for enabling visual navigation cards:
Select Active Workspace→Server Extensions→Reuse and Standardization→Next Generation
Classification Server.

• To install the server components necessary for searching within classification libraries:
Select Active Workspace→Server Extensions→Reuse and Standardization→Library
Management Server.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-55

Server features
Next Generation
Classification
Library
Functions Classification (Presentation layer) Management
Index classification attributes √ √ √
Index classification classes √ √ √
Index classifying objects (ICOs) √ √
Hierarchical filtering of classes √ √ √
Index catalog data √
Index library elements √
Visual navigation cards (VNC) for √ √
classes
Visual navigation cards (VNC) for √
library nodes
Compatible client feature Classification Library Management client
client

• Client

• To install the user interface elements for classifying objects in Active Workspace:
Select Active Workspace→Client Extensions→Reuse and Standardization→Classification
Client.

• To install the user interface components necessary for using classification libraries:
Select Active Workspace→Client Extensions→Reuse and Standardization→Library
Management Client.

Client features
Functions Client features Library Management
Classification authoring √
Browse classification hierarchy using visual navigation cards √
Browse library hierarchy using visual navigation cards √
Dedicated location for searching and browsing √

Verify Active Workspace installation

To verify the Active Workspace installation is complete and successful, open the Active Workspace URL in
a web browser:

4-56 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

http://host:port

Replace host and port with the host and port of the Active Workspace Gateway.

For example:

http://myhost:3000

In the Active Workspace logon screen, enter the user name and password for the Teamcenter
administrative account.

If installation is successful, the browser displays the Active Workspace client.

You can also verify the status of Active Workspace Gateway and services using the Active Workspace
gateway ping:

http://myhost:3000/ping

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 4-57

4-58 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

© 2021 Siemens
5. Updating Active Workspace and
microservices
Patch Active Workspace 4.3 or later
Apply the microservice framework and Active Workspace patches on all Teamcenter hosts that have
Teamcenter Foundation installed.

1. Make sure you have the correct Active Workspace and microservice framework software kits.

2. Stop all Teamcenter services except FSC services. Make sure all server manager services are
stopped.

3. Launch TEM in maintenance mode for the configuration you are updating.

On Windows systems, launch TEM with administrative privileges (right-click the tem.bat icon→Run
as administrator).

4. In the Maintenance panel, select Updates Manager.

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

• In the Update kit location box, enter the path to the expanded microservice framework
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.

6. Proceed to the Operating System User panel and type the password of the operating system
account used to update Teamcenter.

7. Proceed to the Teamcenter Administrative User panel and type the user’s password.

8. Proceed to the Confirmation panel and click Start to apply the patch that adds Active Workspace to
your environment.

9. When the update is complete, close TEM.

10. Repeat steps 3 through 9 to apply the Active Workspace 6.0 patch.

11. On hosts with Teamcenter Foundation installed, update the TC_DATA directory:

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 5-1

a. In the location of the expanded Active Workspace 6.0 software kit, browse to the tc directory.

b. Expand the data.zip file from this location to the TC_DATA folder.

If you want to add additional Active Workspace applications and components to your environment,
restart TEM in maintenance mode and select additional Active Workspace Server Extensions, client
features, or microservices in the Features panel.

Continue updating Active Workspace by updating the Active Workspace environment, and then
publishing changes to the file repository.

Patch Active Workspace 4.2 or earlier

Make sure you install and configure the microservice framework before you perform the following
steps.

Apply the Active Workspace patch on all Teamcenter hosts that have Teamcenter Foundation installed.

1. Make sure you have the correct Active Workspace software kit.

2. If any server managers are running on the corporate server, shut them down before proceeding
with the patch.

3. Remove your previous Active Workspace web application. Perform the appropriate step for the
architecture you use:

• Java EE: Remove the awc.war file and the awc directory under the webapps directory.

• .NET: Stop the Teamcenter Active Workspace web site in Internet Information Server (IIS). Then,
remove the Active Workspace web site.

Note:
The Active Workspace web application is not used in the current Active Workspace
architecture.

4. Launch TEM in maintenance mode for the server you are updating.

5. In the Maintenance panel, select Updates Manager.

6. Complete the Apply Updates panel:

a. In the Update kit location box, enter the location of the Active Workspace 6.0 software kit.

b. In the Backup directory box, enter the location in which you want backup files to be created.

5-2 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

c. In the Original Media Location box, enter the location of the Teamcenter major release
software kit, for example, Teamcenter 14.

7. In the Operating System User panel, type the required password.

8. In the Teamcenter Administrative User panel, type the required password.

9. If the patch contains enhancements to installed features in your configuration, TEM lists the
enhancements in the Required Configuration Enhancements panel.

Features containing data model objects may be updated, meaning database model changes may
occur. Siemens Digital Industries Software recommends you back up your database before
continuing.

Select the Accept Data Model Updates check box to continue with installation.

10. If the server you are patching contains the Indexing Engine, TEM displays the Indexing Engine
Configuration panel.

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, enter 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.

11. In the Publish to Gateway panel, deselect the Publish to Gateway check box.

Publishing to Active Workspace Gateway cannot be enabled until after Active Workspace
microservices are installed and running.

12. In the Database User panel, enter the database administrator password.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 5-3

13. In the Diagnostics panel, enter a directory for storing log files and verify that all pre-patching tests
are successful.

14. In the Confirmation panel, click Start.

15. During the update, a Status Message popup window opens. It informs you that you must
manually patch the TC_DATA directory after TEM completes its updates.

16. When the update is complete, close TEM.

17. In the location of the expanded Active Workspace 6.0 software kit, browse to the tc directory.

18. Expand the data.zip file from this location to the TC_DATA folder on the patched host.

Continue updating Active Workspace by updating the Active Workspace environment, and then
publishing changes to the file repository.

Complete the Active Workspace update

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 if you need a full index or delta reindex of your data before planning
your index update.

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:

5-4 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

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 to index the changes from the report:

awindexerutil u=adminuser -p=password -g=group -delta

5. Test indexer connectivity by running the indexer test flow.

runTcFTSIndexer -task=objdata:test

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.

runTcFTSIndexer -task=objdata:test

3. Reindex the data.

Additional postupdate steps

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.

Reindex classification data

If you are new to classification and want to search for classification data in Active Workspace using
classification standard taxonomy, your first step is to create a classification hierarchy.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 5-5

If you already use traditional classification and want to search for classification data in Active Workspace
or Teamcenter Manufacturing Access, perform the following steps:

1. Create search index views and specify facetable properties.

2. Update and merge the schema file.

3. Index or reindex your data. If your data is already indexed, it is sufficient to index only the modified
classification data.

These steps are described in Classification and Library Management

Install 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 Active Workspace client.

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 6.0:

• Install the Systems Modeling Server Extensions feature on the corporate server.

• Install the Systems Modeler Client feature in the Active Workspace client.

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.

5-6 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

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.

Restart Teamcenter Process Manager

After completing updates to Active Workspace, restart the Teamcenter Process Manager service in the
Services dialog of the Windows Control Panel. This allows the updates made to the Teamcenter
GraphQL Service to take effect.

Some Active Workspace features such as Discussions (Active Collaboration) and Reports rely on updates
to the Teamcenter GraphQL Service in order to function properly.

Publishing changes to the Active Workspace file repository

After patching, upgrading, or adding features to the Active Workspace client, publish changes to the
Active Workspace file repository.

1. Start TEM on the Active Workspace Gateway host.

2. In the Maintenance panel, select Configuration Manager.

3. In the Configuration Maintenance panel, select Perform maintenance on an existing

configuration.

4. In the Old Configuration panel, select the configuration.

5. In the Feature Maintenance panel, select Update Active Workspace client settings.

6. In the Active Workspace Client Settings panel, type the URL to the Active Workspace Gateway and
enable publishing of client content to the Gateway.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 5-7

Value Description

Publish to Gateway Select this check box to enable automatic publishing of

Active Workspace content to the Gateway.

Gateway URL Type the URL to Active Workspace Gateway:

http://host:port

Replace host with the host on which you installed the

Gateway. Replace port with the port used by the
Gateway. The default port is 3000.

7. In the Confirmation panel, click Start.

8. When the installation is complete, close TEM.

5-8 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

© 2021 Siemens
A. Active Workspace features reference
Active Workspace Server Extensions features
Active Workspace Server Extensions features are available in the Features panel in Teamcenter
Environment Manager (TEM), under Base Install→Active Workspace→Server Extensions.

To search for a feature by name, type the name or a partial name in the search box, and then click the
search button.

Feature Description

Active Workspace Adds binaries to TC_ROOT and data model changes to the database and
TC_DATA. It adds the Active Workspace (aw3_template.xml) template to the
database.

Active Architect Installs core capabilities of Active Architect.

Core

Active Collaboration Allows users to communicate between themselves using Active Workspace.
Adds the Active Collaboration (ac0activecollaboration_template.xml)
template to the database.
If you are installing this feature, you should also install the Active
Collaboration feature (under Client) when building the Client web
application.

Active Collaboration Installs server support for Active Collaboration for Retail Footwear and Apparel
for Retail Solution users.

Active Content If you plan to index structure data, you must install this feature. It provides
Structure functionality and data model extensions necessary for indexing structure data.
It adds the Active Content Structure (activeworkspacebom_template.xml)
template to the database.
If you are installing this feature, you should also install the Active Content
feature (under Client) when building the Client web application.

Advanced PLM Adds Advanced PLM Services capabilities to 4th Generation Design in Active
Services Core Workspace.

Active Workspace Installs server support for the Assistant, a guided navigation tool for Active
Assistant Workspace. It predicts the next likely actions a user will perform based on the
user's history, group, and role, and presents suggested actions in the
Assistant panel. This feature requires the Command Prediction Service
microservice and a database for the microservice to store data for the
Assistant. TEM prompts you for the necessary database creation values during
installation.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-1

Feature Description

To enable client support for the Assistant, install the Active Workspace
Assistant client feature.

Active Workspace Adds support for document management in Active Workspace.

Document
Management

Audit Adds Audit Manager capabilities to Active Workspace.

For more information, see Audit Manager in the Teamcenter help collection.

Authorization Active Adds Active Workspace authorization components.

Workspace

Data Exchange Installs an Active Workspace tool that lets you view records of Teamcenter
Transaction Monitor data shared between sites. Transactions monitored include those made using
Multi-Site tools (such as data_share, data_sync, rich client remote export/
import, and Active Workspace share/retrieve) and data exchange tools such as
Briefcase import/export. For more information, see Active Workspace
Administration.

Digital Signatures Adds digital signatures functionality to the server. It does not add a database
template.
Before selecting this feature, see the additional setup requirements for digital
signatures.
If you are installing this feature, you should also install the Digital Signatures
feature (under Client) when building the Client web application.

Google Online Installs server support for the Google Online Viewer, which enables Google
Viewer Online features within Active Workspace, such as viewing and editing
Microsoft Office documents without the need for Microsoft Office
applications.

In-Context Change Adds in-context change support to Active Workspace.

Multisite Integration Adds multisite reporting that enables administrators to identify underlying
data issues before multisite import or export.

Office Online Viewer Installs viewer support for Microsoft Office Online documents.

Program Planning Enables the Program Management capability in Active Workspace. This feature
provides the ability to manage business investments, from planning to
execution, in terms of time, reuse, volume, cost targets, and weight targets.
This feature adds the Program Planning for Active Workspace
(pgp0awprgplanning_template.xml) template to the database.
This feature is not selectable unless the Program Planning Infrastructure
feature (under Extensions) is also selected.

A-2 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

If you are installing this feature, you should also install the Program Planning
Client feature (under Client ) when building the Client web application.

Order Management Installs Order Management support for Active Workspace. Order Management
manages the lifecycle of an order from inquiry to sales order. A customer
inquires about products, a sales person responds with the offer containing
configurable products. Once the offer is accepted by the customer, a sales
order is created that refers to the configurable products.

Relationship Viewer Adds the Relationship Viewer (relationshipviewer_template.xml) template

to the database.
If you are installing this feature, you should also install the Relationship
Browser feature (under Client) when building the Client web application.

Reporting Provides the ability to view report templates, generate reports based on
selected criteria, style sheets, or both, and view them in HTML, Excel, or raw
XML formats. It adds the Reporting for Active Workspace
(rb0reportingaw_template.xml) template to the database.
If you are installing this feature, you should also install the Reporting feature
(under Client) when building the Client web application.
Additionally, to allow for asynchronous report generation, install the
AsyncService translator in the Dispatcher Server.

Schedule Manager Enables Schedule Manager capabilities in Active Workspace.

It adds the Schedule Manager for Active Workspace
(saw1projectmanagementaw_template.xml) template to the database.
If you are installing this feature, you must also install the Schedule Manager
feature (under Client) when building the Client web application.

Shape Search Provides the binaries and data model extensions for the shape search
functionality. It adds the Shape Search for Active Workspace
(shapesearch_template.xml) template to the database. To use shape search,
Geolus must be installed and configured.
If you are installing this feature, you should also install the Shape Search
feature (under Client) when building the Client web application.

Stock Material Adds stock material management to Active Workspace.

Many parts are made from stock materials such as bar stock, tubing stock and
sheet stock. This features enables you to manage stock materials in
Teamcenter, performing actions like creating libraries of stock materials and
assigning stock materials to parts.
For more information, see Aerospace and Defense Solution in the Teamcenter
help collection.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-3

Feature Description

Subscription Allows users to manage subscriptions and notifications. It adds the

Subscription (sub0subscription_template.xml) template to the database.
If you are installing this feature, you must also install the Subscription feature
(under Client) when building the Client web application.

Work Package Adds work package management to Active Workspace.

Management
A work package or package is a collection of CAD files and documentation that
an outsourcing partner uses for building, testing, or maintaining a component
or subassembly of a larger product.
Teamcenter helps to create and maintain the package as a revisable collection
or a container of product information and to use in a variety of contexts.
For more information, see Aerospace and Defense Solution in the Teamcenter
help collection.

Xcelerator Share Installs support for the Xcelerator Share collaboration in Active Workspace.
Collaboration Active Xcelerator Share is a cloud application that allows you to share and collaborate
Workspace on project files with your partners, team members, and manufacturers. In this
browser-based collaboration, you can develop new products and designs, then
share your projects with customers for approval or manufacturers for
production. Xcelerator Share controls and secures file access, and maintains
history of file sharing and exchange. For more information about Xcelerator
Share collaboration, see Xcelerator Share collaboration in Active Workspace.

Active Workspace Adds support for Requirements and Systems Engineering to Active Workspace.
Requirements and
Systems
Engineering

Active Workspace Adds the BOM management overlay for Active Workspace.
Usage BOM

Concurrent Adds concurrent modeling support in Active Workspace. Concurrent modeling

Modeling allows you to manage models from supported 1D modeling tools in
Teamcenter, using the Teamcenter MBSE Integration Gateway MBSE
framework.

Contract Data Installs Contract Data Management, which helps contractors manage the
Management creation, review, and delivery of contracts. A contract is a structured
procurement document that lists milestones and schedule dates.
To enable this feature to work in Active Workspace, select the Contract Data
Management feature under Enterprise Knowledge Foundation.

Core Services for Installs the manufacturing core for the BOM view revisions (BVR) data model
Manufacturing on and adds the mbc0mfgbvrcore_template.xml template.
BVR

A-4 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

DPV Active Installs the database configuration for DPV in Active Workspace. This feature
Workspace requires corresponding Teamcenter DPV features.

EDA Server Support Adds support for Electronic Design Automation (EDA) to Active Workspace.
for Active
For information about installing EDA, see the EDA documentation on Support
Workspace
Center.

Initiative Planning This feature provides capability to create, discover and realize an Idea leading
for Active to the creation of project. It also provides capability to create and manage
Workspace campaigns. For more information, see Initiative Planning in the Active
Workspace documentation.

Manufacturing Adds Manufacturing Resource Library support for Active Workspace.

Resource Manager
For information about using Manufacturing Resource Library, see the
(MRL)
Teamcenter help library.

Material Enables Active Workspace users to:

Management
• Associate a material revision with a vendor part or an item revision.

• Associate a substance with a material revision.

• View the Material/Substance Dashboard.

This feature adds the Material Management for Active Workspace

(mtw0materialmgmtaw_template.xml) template to the database.
This feature is not selectable unless the Material Management feature
(under Extensions→Enterprise Knowledge Foundation) and Active
Content Structure (under Server Extensions) are also selected.
If you install this feature, you should also install the Material Management
feature (under Client) when building the Client web application.

Part Manufacturing Adds Part Manufacturing support to Active Workspace.

Active Workspace

Vendor Allows Active Workspace users to:

Management
• Associate vendors with vendor parts.

• Associate vendor parts with commercial part revisions.

This feature adds the Vendor Management for Active Workspace

(vm1vendormanagementaw_template.xml) template to the database.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-5

Feature Description

This feature is not selectable unless the Active Content Structure feature and
the Vendor Management feature (under Extensions→Supplier Relationship
Management) are selected.
If you are installing this feature, you should also install the Vendor
Management feature (under Client) when building the Client web
application.

Visualization This feature is required to launch the Teamcenter lifecycle visualization stand-
Extension alone application viewer from the Client interface.
This feature enables Active Workspace 3D viewer functionality. It adds the
Active Workspace Visualization (awv0activeworkspacevis_template.xml)
template to the database.
You must install this feature if you install the Visualization Server Manager
feature (under Visualization Server) when building the Client web
application.
The Visualization Extension feature is not selectable unless the Active
Content Structure feature is also selected.

Workflow Workflow does not add a template to the database.

If you are installing this feature, you must also install the Workflow feature
when building the Client web application.
For users to access Inbox components and workflow functionality in the Client
interface, Workflow must be installed on the corporate server and Workflow
must be installed in the Client web application.

Easy Plan Graphics Adds support for graphics capabilities used in the Work Instructions Authoring
workspace.
This feature is automatically selected when you select the Easy Plan Work
Instructions Authoring option in the Features panel.

Electronic Work Installs the server side of Electronic Work Instructions in your environment.
Instructions

Finish Management Installs Finish Management support for Active Workspace. A finish represents
a finishing process on a part. It may be used to improve appearance, adhesion,
corrosion resistance, tarnish resistance, chemical resistance, wear resistance,
and remove burrs and so on.
For more information, see Aerospace and Defense Solution in the Teamcenter
help collection.

Product Adds Product Configurator functionality for Active Workspace. Product

Configurator Configurator enables you to formally introduce and manage variability across
your product suite.

A-6 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

For more information, see Product Configurator in the Teamcenter help

collection.

Requirements Allows users to author a requirement structure in the Content tab of the
Management Client. Adds the Active Workspace Requirements Management
(arm0activeworkspacereqmgmt_template.xml) template to the database.
This feature is not available with Teamcenter Rapid Start.
The Requirements Management feature is not selectable unless the Active
Content Structure feature is also selected.
If you are installing this feature, you must also install:

• Server Extensions→Workflow

• Extensions→Systems Engineering and Requirements

Management→Requirements Management feature on the corporate
server.

• Requirements Management feature when building the Client web

application.

Systems Allows users to manage Systems Engineering diagrams from the Client. It adds
Engineering the Active Workspace Systems Engineering
(ase0activeworkspacesyseng_template.xml) template to the database.
This feature is not available with Teamcenter Rapid Start.
The Systems Engineering feature is not selectable unless the Active Content
Structure feature is also selected.
If you are installing this feature, you must also install:

• Extensions→Systems Engineering and Requirements

Management→Systems Engineering feature on the corporate server.

• Requirements Management feature when building the Client web

application.

Teamcenter Adds support for Teamcenter Manufacturing Access to Active Workspace.

Manufacturing
Teamcenter Manufacturing Access provides solutions for various
Access
manufacturing planning tasks and business processes. It is designed as a
cross-industry tool; use it in any environments where Process Simulate is used.
For more information about Teamcenter Manufacturing Access, see Easy Plan
help.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-7

Feature Description

4th Generation Installs 4th Generation Design (4GD) functionality for the Teamcenter server.
Foundation 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.

Easy Plan - Process Installs the Process Planning workspace for build-to-order (BTO) or build-to-
Planning for stock (BTS), or configure-to-order (CTO) in your environment.
BTO/BTS/CTO
Adds these templates to the database:

• Manufacturing core for BVR/Data Model (mbc0mfgbvrcore_template.xml)

• Process Planning Change Management/Data Model

(epc0mfgbvrmaturity_template.xml)

• Process Planning Line Balancing/Data Model

(elb0linebalancing_template.xml)

• Process Planning Time Analysis/Data Model

(ept0timeanalysis_template.xml)

Easy Plan - Product Adds support for Product Configurator in Easy Plan. Product Configurator
Configurator allows you to enable definitions for variant formulas on operations.
Extension
Please see the Product Configurator (Administrator) documentation for
installation details.
To use Product Configurator variants, you must run Teamcenter 11.5 or later.
By default, Easy Plan uses classic variants.

Embedded Software Installs embedded software management capabilities for Active Workspace.
Management for
Active Workspace

Manufacturing 4G Installs the interface between Next Generation Planning (NGP) and
Core Teamcenter, and adds the mac0mfgapscore_template.xml template.

Medical Device Installs Active Workspace server extensions to support product development
Foundation processes for medical device manufacturers. This feature assists in ensuring
compliance with regulatory guidelines, accelerating innovation in
development, and reducing costs.

Product Installs capabilities related to solution variants in Active Workspace.

Configurator
Support for Active
Content Structure

Product Master for Installs product master automation for Active Workspace.
Active Workspace

A-8 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

Requirements Adds Teamcenter Quality functions to Requirements Management.

Management -
Quality Module

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) template to the database.
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
• Base Install→Active Workspace→Server Extensions→Active Content
Structure
• Base Install→Active Workspace→Server Extensions→Systems
Engineering

You can then select the Systems Modeling feature.

Note:
Selecting Systems Modeling automatically selects these features under
Extensions→Model-Based Systems Engineering:

• Attribute and Parameter Base Definitions

• Measurable Attributes and Targets

4th Generation Allows users to view, navigate, and configure collaborative designs and their
Design content in the Client.
It adds the 4th Generation Foundation
(fgd0aw4gfoundation_template.xml) and 4th Generation Design
(fgd0aw4gdesign_template.xml) templates to the database.
The 4th Generation Design feature is not selectable unless the Active
Content Structure feature (under Server Extensions) and the 4th
Generation Design feature (under Extensions→Advanced PLM Services)
are also selected.
If you are installing this feature, you must also install the 4th Generation
Design feature when building the Client web application.

4th Generation Adds Advanced PLM Services capabilities to 4th Generation Design in Active
Process Planning Workspace.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-9

Feature Description

Electronics Process Installs the Easy Plan Electronics Process Planner workspace in your
Planner environment.
Electronics engineers use Production Process Planning for the systems
integration of the electronics process planning tasks of Easy Plan and those of
Valor Process Preparation Software. The systems integration is available as a
dedicated, optional feature of Production Process Planning.
Adds these templates to the database:

• Manufacturing core for BVR/Data Model (mbc0mfgbvrcore_template.xml)

• Production Process Planning Change Management/Data Model

(epc0mfgbvrmaturity_template.xml)

• Production Process Planning Line Balancing/Data Model

(elb0linebalancing_template.xml)

• Production Process Planning Time Analysis/Data Model

(ept0timeanalysis_template.xml)

Industrial Machinery Installs support for the Industrial Machinery solution in Active Workspace. This
solution provides a single-source data management system focused on the
engineering, manufacturing and product life BOM. This solution is designed to
enable industrial machinery customers to move from CAD data management
to engineering process management, integrating requirements management,
project management, and change management.

Initiative Lifecycle Installs support for Initiative Lifecycle Management (ILM) in Active Workspace.
Management (ILM) This solution unifies business processes from ideation to production. This
Active Workspace includes management of campaigns, ideas, programs, and projects. ILM
leverages program planning capabilities and combines those with process
groups that distribute work to participants. For more information, see
Initiative Lifecycle Management in the Active Workspace documentation.

Manufacturing BOM Adds Multi-BOM Manager support to Active Workspace. Multi-BOM Manager
Manager enables you to link and assign content across representations for different
lifecycle stages or uses for a product.
For information about using this feature, see Mutli-BOM Manager in the
Teamcenter help library.

Partitions for The Partitions for Structure feature is required to get the partitions that are
Structure in turn required to organize the contents of a product structure.

Process Planning Installs support for the Engineering to Order (ETO) workspace in your
and Work environment.
Instructions
authoring for ETO

A-10 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

This feature allows end users to author work instructions at the process station
level.

Initiative Lifecycle Initiative Lifecycle Management (ILM) support for Active Workspace with
Management - CPG objects and processes specific to the Consumer Packaged Goods industry. For
Reference more information, see Initiative Lifecycle Management - Consumer Packaged
Implementation Goods Reference Implementation.

Manufacturing Adds Change Management capabilities to Manufacturing Process

Change Management.
Management

Capital Asset Adds management of plant data to Active Workspace.

Lifecycle
Management AW

Change Adds support for Change Management in Active Workspace. This feature
Management requires corresponding Teamcenter Change Management features.

Active Admin Features to support Active Admin capabilities.

Active Admin Installs essential support for the active admin workspace.
Core

Active Adds support for user management in Active Workspace.

Workspace User
Management

Preference Adds server support for preference management in Active Admin. Preference
Management management features in the active admin workspace are added by the
corresponding Active Workspace client feature.

Viewer Adds viewer administration to the Active Admin workspace in Active

Administration Workspace.

Active Architect Features to support Active Architect capabilities.

Client Adds client configuration to the Active Admin workspace in Active Workspace.
Configuration

Logical Object Adds logical objectsupport to the Active Admin workspace in Active
Workspace.

XRT Editor Adds XRT Editor to the Active Admin workspace in Active Workspace.

Aerospace and Aerospace and Defense features. These allow Active Workspace users to:
Defense
• Create and view parts list: technical documents, parts, drawings, and
designs.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-11

Feature Description

• Work with notes: create standard notes and custom notes and attach them
to technical documents, parts, drawings, and designs.

• Work with Aerospace and Defense-related changes: create, edit, and search
change requests, change notices, and deviation requests in alignment with
the out-of-the-box Change Management functionality.

Aerospace and Adds the Aerospace and Defense Foundation Active Workspace
Defense (ads1awadsfoundation_template.xml) template to the database. This
Foundation 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 Workspace→Server Extensions
• Vendor Management under Active Workspace→Server Extensions
• Aerospace and Defense Foundation under Active Workspace→ Server
Extensions→Aerospace and Defense
• Aerospace and Defense Foundation under Active Workspace→Client
• Active Workspace Client under Active Workspace→Client
• Aerospace and Defense Change Management under Active
Workspace→Client

Aerospace and Installs the change management functionality for the Aerospace and
Defense Change Defense Foundation feature. This feature requires corresponding Teamcenter
Management features.

CAE Simulation Features to support management of computer-aided engineering (CAE) data.

Management

Simulation Allows Active Workspace users to author Simulation structures in Active

Process Workspace.
Management
It adds the Simulation Process Management Server
(cae1caeaws_template.xml ) template to the database.
The Simulation Process Management feature is not selectable unless the
Active Content Structure feature and the Simulation Process Management
feature (under Extensions ) are also selected.
If you are installing this feature, you must also install the Simulation Process
Management Client feature when building the Client web application.

Extended Add extended Simulation Process and Data Management capabilities to Active
Simulation Workspace.

A-12 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

Process
Management

Integrated Program Integrated Program Planning and Execution (IPP&E) server extensions
Planning and features. The IPP&E solution allows project planning that integrates cost,
Execution schedule, risk and technical requirements in a fully planned, resourced, and
budgeted program. It allows configuration control, not only of products, but
also of the project plan. It also communicates the status of requirements to
users.

Organization Adds Organization Breakdown Structure (OBS) support to IPP&E.

Breakdown
Structure

Work Breakdown Adds support for authoring Work Breakdown Structure (WBS) hierarchy in
Structure Active Workspace from top to bottom. For information about defining work
breakdowns, see Schedule Manager in the Teamcenter help library.

IPP&E Provides essential functionality for Integrated Program Planning and Execution
Foundation in Active Workspace.

IPP&E Contract Adds Contract Data Management support to IPP&E.

Data
Management
Extension

MRO Service Lifecycle Management features for Active Workspace.

MRO Core Provides core Service Lifecycle Management functionality for Active
Workspace.

Service Work Adds support for work instructions to Service Lifecycle Management in Active
Instructions Workspace.

As-Built for Provides searching and BOM extensions necessary to support MRO As-Built
Active capabilities.
Workspace
This feature is not available with Teamcenter Rapid Start.
In addition to the Active Workspace feature, this feature requires:

• Extensions→Maintenance Repair and Overhaul→As-Built Management

Adds these templates to the database:

• MRO Core, Active Workspace BOM Interface

(smr1mrocoreaw_template.xml)

• As-Built (sab1asbuiltaw_template.xml)

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-13

Feature Description

As-Maintained Provides searching and BOM extensions necessary to support MRO As-
Maintained capabilities.
This feature is not available with Teamcenter Rapid Start.
In addition to the Active Workspace feature, this feature requires:

• Extensions→Maintenance Repair and Overhaul→As-Maintained

Management

Adds these templates to the database:

• MRO Core, Active Workspace BOM Interface

(smr1mrocoreaw_template.xml)

• As-Maintained (sam1asmaintainedaw_template.xml)

Service Provides service engineering support for Service Lifecycle Management.

Engineering

Service Planning This feature provides the Active Workspace search and BOM (Bill of Materials)
in Active extensions necessary to support the MRO (Maintenance, Repair, and
Workspace Overhaul) Service Planning and Service Processing Alignment capabilities in
Active Workspace.

Transaction Installs transaction processing functionality for Service Request Manager.

Processing
This feature requires corresponding Teamcenter features.

Service Installs service processing capability for Service Request Manager.

Processing
This feature requires corresponding Teamcenter features.

Service Event Provides searching and BOM extensions necessary to support MRO Service
Event Management capabilities.
This feature is not available with Teamcenter Rapid Start.
In addition to the Active Workspace feature, this feature requires:

• Base Install→Active Workspace→Server Extensions→MRO→As-

Maintained

• Extensions→Maintenance Repair and Overhaul→As-Maintained

Management

• Extensions→Maintenance Repair and Overhaul→Service Event

Management

Adds these templates to the database:

A-14 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

• Transaction Processing, Active Workspace BOM Interface

(stp1transactionprocessingaw_template.xml)

• Service Processing, BOM Interface

(spr1serviceprocessingaw_template.xml)

• Service Event (sem1serviceeventmgmtaw_template.xml)

Service Installs service forecasting capability for Service Request Manager.

Forecasting
This feature requires corresponding Teamcenter features.

Service Planning Installs the Service Planning functionality for Service Processing in Active
and Service Workspace.
Processing
Alignment

Program Planning Program Planning Execution features for Active Workspace

Execution

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.
This feature is not selectable unless these features are also selected:

• Change Management under Extensions→Enterprise Knowledge

Foundation

• Program Planning under Server Extensions

• Program Planning Infrastructure under Extensions

If you are installing this feature, you should also install the Program Change
Client feature (under Client→Program Planning Execution Client) when
building the Client web application.

Program Allows interaction between Program Planning Schedule Manager and Program
Planning Event Change Interface in Active Workspace. It allows Active Workspace users to
Change relate events to change objects.
This feature adds the Program Planning Event Change
(pec0ppeventchange_template.xml) template to the database.
This feature is not selectable unless these features are also selected:

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-15

Feature Description

• Change Management under Extensions→Enterprise Knowledge

Foundation

• Program Planning Infrastructure under Extensions

• Program Planning under Server 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 Client web application.

Program Allows interaction between Schedule Manager and Program Planning in Active
Schedule Workspace. It allows Active Workspace users to create plan level items to
Manager schedules and supports automatic generation of schedules within a program.
This features adds the Program Schedule Manager
(psi0ppsminterface_template.xml) template to the database.
This feature is not selectable unless these features are also selected:

• Change Management under Extensions→Enterprise Knowledge

Foundation

• Program Planning Infrastructure under Extensions

• Program Planning under Server Extensions

• Schedule Manager under Server Extensions

• Program Change under Server Extensions

• Program Planning Event Change under Server Extensions

If you are installing this feature, you should also install the Program Schedule
Manager Client feature (under Client→Program Planning Execution Client)
when building the Client web application.

Change Allows interaction between Schedule Manager and Change Management in

Management Active Workspace. It allows Active Workspace users to relate schedules and
Schedule change objects.
Manager
This feature adds the Change Management Schedule Manager
(csi1cmsmawinterface_template.xml) template to the database.
This feature is not selectable unless these features are also selected:

A-16 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

• Change Management under Extensions→Enterprise Knowledge

Foundation

• Schedule Manager under Server Extensions

If you are installing this feature, you should also install the Change
Management Schedule Manager feature (under Client→Program Planning
Execution Client) when building the Client web application.

Reuse and Features to support Reuse and Standardization in Active Workspace.

Standardization

Classification Allows users to access Classification data in the client interface.

Server

Classification AI Installs the Classification artificial intelligence (AI) engine, which provides
assistance in navigating to desired classes.Configuring classification artificial
intelligence
After being trained on a database, the engine receives object metadata from
the Teamcenter server and returns the probabilities for potential classes. You
can specify which classes are displayed in the user interface based on these
probabilities.

Presentation Installs the Next Generation Classification foundation feature. This option
Layer - Next installs the presentation layer for classification standard taxonomy and for
Generation library management.
Classification
Server

Library Enables indexing for Library Management business objects. The Library
Management Management Server feature is not selectable unless the Library
Server Management feature (under Extensions→Reuse and Standardization) is
also selected.

Teamcenter Features that support the integration of Teamcenter with NX.

Integration for NX

NX Logical for This feature configures the Teamcenter installation to support logical model
Active for the NX diagramming application in Active Workspace. This feature allows
Workspace users to view and navigate diagramming sheets and logical model content in
the Active Workspace client.

NX Staged This feature adds support to Active Workspace for stage model application for
Models for NX. This feature allows users to publish manufacturing process steps of a
Active design part to Teamcenter from the NX desktop application.
Workspace

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-17

Feature Description

NX for Active Enables users to access NX integration functionality from the client interface.
Workspace 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.
If you are installing this feature, you should also install the NX Integration
feature (under Client) when building the Client web application.

NX MBSE for Adds the NX Integration for Model-Based Systems Engineering.

Active
Workspace

NX P & ID Active Exposes NX P & ID in Active Workspace so that users can view, navigate, and
Workspace configure sheets and their content.
This feature adds the NX P & ID Active Workspace
(nxp1pidaws_template.xml) template to the database.
This feature is not selectable unless these features are also selected:

• NX Foundation under Extensions→Teamcenter Integration for NX

• Active Content Structure under Server Extensions

• 4th Generation Design BOM Management under Extensions→BOM

Management

• MDConnectivity under Extensions→Advanced PLM Services

• System Modeling under Extensions→Advanced PLM Services

• Diagramming under Extensions→Advanced PLM Services

• NX Piping and Instrument Diagram (P&ID) Design under

Extensions→Teamcenter Integration for NX

• Systems Engineering under Server Extensions

If you are installing this feature, you should also install the NX Integration
feature (under Client) when building the Client web application.

Teamcenter Quality Features to support Teamcenter Quality.

data model

A-18 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

Quality Action Adds support for quality actions to Active Workspace. This feature is
Management mandatory for all Teamcenter Quality solutions.
data model
For more information, see Teamcenter Quality in the Active Workspace help.

Quality Manager Adds support for Quality Manager to Active Workspace.

data model
For more information, see Teamcenter Quality in the Active Workspace help.

Control and Adds support for Control Plan to Teamcenter Quality.

Inspection Plan
For more information, see Teamcenter Quality in the Active Workspace help.

Escalation Adds support for escalation workflows for quality actions.

Management
These allow responsible users or quality managers to receive alerts or e-mail
Translator
notifications to remind them of their quality actions prior to the due date,
thereby avoiding unnecessary delays or escalations. Additionally, escalation
workflows can be initiated for quality actions that are not in the required state
by the due date.
To install the Escalation Management Translator, choose Base Install >
Active Workspace > Server Extension >Teamcenter Quality data model >
Escalation Management Translator.

Note:
This feature is available in Teamcenter 13.1 and later releases.

To select Escalation Management Translator, ensure that you select Quality

Action Management and Dispatcher features

Failure Mode Adds support for Failure Mode Effect Analysis (FMEA) to Teamcenter Quality.
Effect Analysis
For more information, see Teamcenter Quality in the Active Workspace help.
(FMEA) data
model

Quality Issue Adds support for Issue Manager and Problem Solving to Active Workspace.
Management
For more information, see Teamcenter Quality in the Active Workspace help.
and Problem
Solving data
model

Training and Adds training and qualification actions to the Teamcenter Quality module,
Qualification which allows you to create and manage qualifications, qualification profiles,
qualification records, and related objects.

Quality Issue Adds the ability to search for Problem Solving objects in Active Workspace.
Management
and Problem
Solving search

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-19

Feature Description

APQP Program Adds support for Advanced Product Quality Planning (APQP) methodology to
Management Teamcenter Quality.
For more information, see Teamcenter Quality in the Active Workspace help.

Quality Audit Enables capturing the status of quality actions in audit logs. A Teamcenter
administrator logged into Active Workspace can view these event logs and
navigate to specific quality actions.

Model-Based Features to support Model-Based Systems Engineering in Active Workspace.

Systems
Engineering

Measurable Configures Active Workspace to interact with Measurable Attributes and

Attributes and Targets, providing functionality such as retrieving the associated measurable
Targets attributes from a parent object or parent line.
This feature adds the Measurable Attributes and Targets for Active
Workspace (att1attrtargetmgmtaw_template.xml) template to the
database.
This feature is not available with Teamcenter Rapid Start.
In addition to the Active Workspace feature, this feature requires:

• Extensions→Model-Based Systems Engineering→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

• Base Install→Active Workspace→Server Extensions→Systems

Engineering

• Base Install→Active Workspace→Server Extensions→Model-Based

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

If you are installing this feature, you must also install the Measurable
Attributes and Targets Client feature in the Client web application.

Physical Adds support for verification management in Active Workspace.

Verification
Management
Active

A-20 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

Workspace
Extension

LMS System Exposes the System Synthesis artifacts, such as model templates and core
Synthesis architecture, in Active Workspace. These artifacts are created in Teamcenter
Modeling 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) template to the
database.
This feature is not selectable unless the System Synthesis Modeling feature
(under Extensions→Systems Driven Product Development) is also selected.

Parameter Adds parameter management support to Active Workspace.

Management
Active
Workspace

Teamcenter Test Adds test management support to Model-Based Systems Engineering (MBSE).
Management

Physical Adds support for inspections and physical tests.

Verification
Management

Active Workspace Features to support Linked Data Framework Services in Active Workspace.
Linked Data
Framework Services

LDF Foundation Provides a framework to link Teamcenter business objects with an artifact of a
remote linked data enabled system. It enables rendering the remote system's
delegated user interfaces in Active Workspace.
This feature adds the Linked data Framework for Active Workspace
(ldf0ldfaws_template.xml) template to the database.
This feature is not selectable unless the Linked Data Framework Support
Infrastructure feature (under Extensions→Platform Extensibility→Linked
Data Services) is also selected.
If you install this feature, you should also install the Linked Data Framework
feature (under Client) when building the Client web application.

Active Installs the Change Management integration module of Linked Data Services
Workspace LDF (LIS). The feature requires corresponding Teamcenter features.
Change
Management
Integration

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-21

Feature Description

Active Installs the Requirements Management integration module of Linked Data

Workspace LDF Services (LIS).
Requirements
This feature requires corresponding Teamcenter features.
Management
Integration

LDF Polarion Installs Polarion data types for Linked Data Services (LIS) integration in Active
Types Workspace.
Integration
This feature requires corresponding Teamcenter features.

Active Installs the Embedded Software Management integration module of Linked

Workspace LDF Data Services (LIS).
Embedded
For more information, see Integrating Applications Using Linked Data
Software
Framework in the Teamcenter help collection.
Management
Integration

Consumer Packaged Features to support CPG in Active Workspace.

Goods
For more information, see Getting Started with CPG in the Teamcenter help
collection.

Brand Installs the Brand Management template for CPG.

Management
For more information, see Getting Started with CPG in the Teamcenter help
collection.

Packaging and Installs packaging and artwork functionality for CPG.

Artwork
For more information, see Getting Started with CPG in the Teamcenter help
collection.

Specification Installs specification management functionality for CPG.

Management
For more information, see Getting Started with CPG in the Teamcenter help
collection.

Consumer Installs consumer product management functionality for CPG.

Product
For more information, see Getting Started with CPG in the Teamcenter help
Management
collection.
Active
Workspace

Additional Active Workspace server extensions features

The following Active Workspace server extensions features are available under Base
Install→Extensions in the Features panel in TEM.

A-22 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

Teamcenter Simplified Provides a simplified experience of Teamcenter for small-

and medium-sized business customers. User Experience
(UX) redundancies and outlying commands are removed.
This allows users to quickly work on designs, documents and
parts within their organization without additional
configuration.

Color Appearance Active Workspace Provides the ability to define standard color attributes in
Active Workspace.

Content Management Active Adds server-side Content Management support to Active

Workspace Workspace.

Engineering Views Active Workspace Adds engineering views to Active Workspace.

Product Master Automation for Active Provides the capability to generate the design or BOM data
Workspace from an existing BOM or design data from Active
Workspace. Given a source BOM, a user can generate a
target BOM. The source and target BOM could be an
engineering BOM or design BOM. For more information, see
Administration of Design BOM and Engineering BOM
Alignment.

Active Workspace Weight And Enables Active Workspace interaction with Weight and
Balance Management Balance Management. This supports functionality such as
specifying weight and balance attributes for parts or
assemblies, and performing their rollup. For more
information, see Structure Management Setup and
Administration.

Teamcenter SLM Integration for Adds support in Active Workspace for searching and bill of
Service Execution, Active Workspace materials (BOM) extensions necessary to support the basic
BOM Interface Teamcenter Service Engineering integration with the service
execution system. It also adds data model support for the
Teamcenter service lifecycle management (SLM) model to
enable data mapping and seamless data flow with the
service execution system.

Marine Integration Installs support for Marine Integration in Active Workspace.

This functionality supports lifecycle management of
electrical equipment and cables that connecting them,
provided by various electrical design tools. The feature
enables creation of BOM structures for electrical equipments
and cables.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-23

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 Installs the Active Workspace Gateway, a web application framework that
Gateway resides between the Active Workspace client application and your browser.
The Gateway communicates with the Teamcenter server, the File Repository,
and the volume server, and routes incoming requests for static and dynamic
content to the appropriate services handling those requests.

Active Workspace Selecting this feature builds the Active Workspace client.
Client

3D Visualization Adds 3D visualization to the Active Workspace client.

Active Collaboration Adds workflow capabilities of Active Collaboration to the client interface.
Client
If you are installing this feature in the Client, you must install the Active
Collaboration Server Extensions feature in the corporate server.

Active Collaboration Installs Active Collaboration for Retail Footwear and Apparel users.
for Retail Solution
Client

Active Workspace Installs client components of the Assistant, a guided navigation tool for
Assistant Client Active Workspace. It predicts the next likely actions a user will perform
based on the user's history, group, and role, and presents suggested actions
in the Assistant panel.
This feature requires the Active Workspace Assistant server extension
feature on the Teamcenter server.

Active Workspace Adds the 2D Viewer to the Universal Viewer in Active Workspace. Requires
Visualization 2D the Visualization Server.
Viewer

Audit Client Adds Audit Manager features to the Active Workspace client.
For more information, see Audit Manager in the Teamcenter help collection.

Content Management Adds Content Management support to Active Workspace.

Client

DPV for Active Adds Dimensional Planning and Validation functionality to the client
Workspace Client interface.

A-24 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

Document Installs Document Management support for the Active Workspace client.
Management Client

Electronic Design Adds Electronic Design Automation (EDA) support in the Active Workspace
Automation client.

Google Online Viewer Installs the Google Online Viewer, which enables Google Online features
Client within Active Workspace, such as viewing and editing Microsoft Office
documents without the need for Microsoft Office applications.

Initiative Lifecycle Installs support for Initiative Lifecycle Management (ILM) in the Active
Management (ILM) Workspace client. This solution unifies business processes from ideation to
Active Workspace production. This includes management of campaigns, ideas, programs, and
Client projects. ILM leverages program planning capabilities and combines those
with process groups that distribute work to participants. For more
information, see Initiative Lifecycle Management in the Active Workspace
documentation.

Initiative Lifecycle Installs Initiative Lifecycle Management (ILM) support for the Active
Management - CPG Workspace client, with objects and processes specific to the Consumer
Reference Packaged Goods industry. For more information, see Initiative Lifecycle
Implementation Management - Consumer Packaged Goods Reference Implementation.
Active Workspace
Client

Initiative Planning This feature provides capability to create, discover and realize an Idea
Active Workspace leading to the creation of project. It also provides capability to create and
Client manage campaigns. For more information, see Initiative Planning.

Logical Object Allows users to access logical object data in the client interface.

Marine Integration Installs client-side support for Marine Integration in Active Workspace. This
functionality supports lifecycle management of electrical equipment and
cables that connecting them, provided by various electrical design tools. The
feature enables creation of BOM structures for electrical equipments and
cables.

Multisite Integration Enables certain Multi-Site Collaboration capabilities in Active Workspace.

Users can publish objects for access by remote sites, check in and check out
objects, and receive and update objects from remote sites. Administrators
can use the Multi-Site Dashboard to monitor the Multi-Site federation,
viewing related issues through charts, graphs, and detailed object reports.

NX Logical for Active This feature configures the Teamcenter installation to support logical model
Workspace Client for the NX diagramming application in Active Workspace. This feature allows
users to view and navigate diagramming sheets and logical model content
in the Active Workspace client.

Office Online Viewer Installs the Office Online Viewer Client that enables you to edit Microsoft
Client Office documents within Active Workspace.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-25

Feature Description

This feature requires Microsoft Office Online to be installed in your

environment.

Order Management Installs Order Management support for the Active Workspace client. Order
Management manages the lifecycle of an order from inquiry to sales order. A
customer inquires about products, a sales person responds with the offer
containing configurable products. Once the offer is accepted by the
customer, a sales order is created that refers to the configurable products.

Part Manufacturing Adds part manufacturing support in the Active Workspace client.
Client

Product Configurator Adds Product Configurator features to the Active Workspace client. Product
Configurator enables you to formally introduce and manage variability
across your product suite.
For more information, see Product Configurator in the Teamcenter help
collection.

Program Planning Enables the Program Management capability in Active Workspace. This
feature provides the ability to manage business investments, from planning
to execution, in terms of time, reuse, volume, cost targets, and weight
targets.
If you are installing this feature, you should also install the Program
Planning feature under Server Extensions.

Reactive Logging Installs valuable troubleshooting tools that enable you to record a problem
in a log file to share with the Teamcenter administrator.
By default, reactive logging provides the user with the log file location and
machine information. To configure this behavior, set the following
preferences:
TC_reactive_logging_notification_list
Notifies administrator regarding log ZIP file.
TC_reactive_logging_file_download
Displays message to the user with a link to the downloaded file in Active
Workspace.

Reporting Adds the ability to view report templates, generate reports based on
selected criteria, style sheets, or both, and view them in HTML, Excel, or raw
XML formats in the client.
If you are installing this feature in the Client, you must install the Reporting
Server Extensions feature in the corporate server.
Additionally, to allow for asynchronous report generation, install the
AsyncService translator in the Dispatcher Server.

A-26 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

Schedule Manager Enables Schedule Manager capabilities in Active Workspace.

If you are installing this feature, you must also install the Schedule
Manager feature under Server Extensions on the corporate server.

Stock Material Adds stock material management features for the Active Workspace client.
Many parts are made from stock materials such as bar stock, tubing stock
and sheet stock. This features enables you to manage stock materials in
Teamcenter, performing actions like creating libraries of stock materials and
assigning stock materials to parts.
For more information, see Aerospace and Defense Solution in the
Teamcenter help collection.

Subscription Allows users to manage subscriptions and notifications in the client.

If you are installing this feature in the Client, you must install the
Subscription feature under Server Extensions in the corporate server.

Work Package Installs work package management, which helps designers to create and
Management maintain a work package as a revisable collection of CAD files and
documentation.
To install this feature, you must install the Work Package Management
feature for both server and client features for Active Workspace.

Xcelerator Share Installs support for the Xcelerator Share collaboration in the Active
Collaboration Active Workspace client. Xcelerator Share is a cloud application that allows you to
Workspace Client share and collaborate on project files with your partners, team members,
and manufacturers. In this browser-based collaboration, you can develop
new products and designs, then share your projects with customers for
approval or manufacturers for production. Xcelerator Share controls and
secures file access, and maintains history of file sharing and exchange. For
more information about Xcelerator Share collaboration, see Xcelerator
Share collaboration in Active Workspace.

Contract Data Installs Contract Data Management, which helps contractors manage the
Management creation, review, and delivery of contracts. A contract is a structured
procurement document that lists milestones and schedule dates.
If you are installing this feature, you must also install the Contract Data
Management Server Extensions feature on the server and the Contract
Data Management feature under Enterprise Knowledge Foundation.

Markup Enables markup capabilities in the client interface.

Relationship Browser If you are installing this feature, you must also install the Relationship
Client Viewer Server Extensions feature on the corporate server.

Teamcenter Simplified Provides a simplified experience of Teamcenter for small- and medium-sized
Client business customers. User Experience (UX) redundancies and outlying

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-27

Feature Description

commands are removed. This allows users to quickly work on designs,

documents and parts within their organization without additional
configuration.

Workflow For users to access Inbox components and workflow functionality in the
Client interface, this feature must be installed.
If you are installing this feature, you must also install the Workflow feature
under Server Extensions on the corporate server.

Active Content Adds structure search functionality to the client interface.

If you are installing this feature in the Client, you must install the Active
Content Structure Server Extensions feature in the corporate server.

Digital Signatures Adds digital signatures functionality to the client interface.

Before selecting this feature, see the additional setup requirements for
digital signatures in 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.

Linked Data Provides a framework to link a Teamcenter business objects with an artifact
Framework of a remote linked data enabled system. It enables rendering the remote
system's delegated UIs in Active Workspace.
If you are installing this feature, you should also install the Linked Data
Framework feature under Server Extensions.

Viewer Snapshot Tool Installs the viewer snapshot tool for 3D visualization in Active Workspace.

4th Generation Design Allows users to view, navigate, and configure collaborative designs and their
content in the Client.
If you are installing this feature in the Client, you must also install the 4th
Generation Design Server Extensions feature, the Active Content
Structure Server Extension feature, and the 4th Generation Design (under
Advanced PLM Services) feature on the corporate server.
In addition to the Active Workspace Client feature, requires the Active
Content Client feature.

Architecture Modeler In addition to the Active Workspace Client feature, requires the Active
Content Client feature.

Briefcase Browser Enables the Briefcase file preview and comparison features in the Active
Workspace client.

Briefcase Export and Enables the ability to collaborate with online and offline sites by importing
Import and exporting Teamcenter data packaged in Briefcase files. Other sites can
optionally update the Teamcenter objects and return the data to the
originating site.

A-28 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

Also enables the ability to extract data from one Teamcenter environment to
copy to another using bulk loading tools.

Change Management Adds the ability to work with Change Management objects in the client.
If you are installing this feature in the Client, you must install the
Extensions→Enterprise Knowledge Foundation→Change Management
feature in the corporate server.

Concurrent Modeling Adds concurrent modeling support in Active Workspace. Concurrent

modeling allows you to manage models from supported 1D modeling tools
in Teamcenter, using the Teamcenter MBSE Integration Gateway MBSE
framework.

Engineering Views Adds support for engineering views in Active Workspace.

Finish Management Installs Finish Management support for Active Workspace. A finish
represents a finishing process on a part. It may be used to improve
appearance, adhesion, corrosion resistance, tarnish resistance, chemical
resistance, wear resistance, and remove burrs and so on.
For more information, see Aerospace and Defense Solution in the
Teamcenter help collection.

MCAD Integration In addition to the Active Workspace Client feature, requires the Active
Content Client feature.

Material Management Enables Active Workspace users to:

• Associate a material revision with a vendor part or an item revision.

• Associate a substance with a material revision.

• View the material/substance dashboard.

If you install this feature, you should also install the Material Management
feature (under Server Extensions) on the corporate server.

Medical Device Installs Active Workspace client support for product development processes
Foundation for medical device manufacturers. This feature assists in ensuring
compliance with regulatory guidelines, accelerating innovation in
development, and reducing costs.

NX Integration Enables users to access NX integration functionality from the client

interface.
If you are installing this feature, you should also install the NX for Active
Workspace feature (under Server Extensions) on the corporate server.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-29

Feature Description

PLMXML Export Enables the ability to share data with organizations not using Teamcenter or
Import for use with third-party applications. You can use PLM XML to share
Teamcenter objects such as items, datasets, BOMs, forms, and folders.

Partitions for Installs client support for partitions and partition schemes for structures.
Structure

Product Master Installs product master automation for the Active Workspace client.
Automation

Requirements Allows users to author a requirement structure in the Content tab of the
Management client.
In addition to the Active Workspace Client feature, requires the Active
Content feature.
If you are installing this feature in the Client, you must install the
Requirements Management and Systems Engineering features under
Server Extensions on the corporate server.

Note:
This feature is required to enable the Export to Excel button in Active
Workspace.

Resource Manager for Adds Manufacturing Resource Library support for the Active Workspace
Active Workspace client.
Client
For information about using Manufacturing Resource Library, see the
Teamcenter help library.

Service Manager Allows users to view disposition and utilization history of physical parts in
the Client.

Service Work This feature provides the functionality to build and view the Service Lifecycle
Instructions Client Management (SLM) Service Work Instructions for Active Workspace. This
content represents extensions necessary to support Service Work
Instructions in an Active Workspace environment.

Vendor Management Allows Active Workspace users to:

• Associate vendors with vendor parts.

• Associate vendor parts with commercial part revisions.

If you are installing this feature, you should also install the Vendor
Management feature under (Server Extensions) on the corporate server.

A-30 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

Aerospace and Adds the Aerospace and Defense Foundation feature to the Active
Defense Foundation Workspace client.
This feature is not selectable unless the following features are also selected:
If you are installing this feature in the Client, you must install the Aerospace
and Defense Foundation Server Extension feature in the corporate server
and the following Active Workspace Client features:

• Workflow
• Active Collaboration
• Active Content
• Vendor Management

Capital Asset Lifecycle Adds management of plant data for the Active Workspace client.
Management

Easy Plan - Product Adds support for Product Configurator in Easy Plan. Product Configurator
Configurator Client allows you to enable definitions for variant formulas on operations.
Please see the Product Configurator (Administrator) documentation for
installation details.
To use Product Configurator variants, you must run Teamcenter 11.5 or
later. By default, Easy Plan uses classic variants.

Embedded Software Adds Embedded Software Solutions functionality, which allows you to
Management represent embedded software artifacts using Active Workspace.

Next Generation Adds Next Generation Planning (NGP) support to Active Workspace.
Planning Client

Product Master Installs product master support for Product Master Manager in the Active
Workspace client.

Service Engineering Provides service engineering support for Service Lifecycle Management in
Client the Active Workspace client.

Easy Plan - Process Installs client support for the Process Planning workspace for build-to-order
Planning for (BTO) or build-to-stock (BTS), or configure-to-order (CTO) in your
BTO/BTS/CTO Client environment.

Easy Plan - Process Installs client support for the Engineering to Order (ETO) workspace in your
Planning for ETO environment.
Client
This feature allows end users to author work instructions at the process
station level.

Electronic Work Installs the Electronic Work Instructions Client workspace in your
Instructions Client environment.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-31

Feature Description

Manufacturing BOM Adds Multi-BOM Manager support to the Active Workspace client. Multi-BOM
Manager Client Manager enables you to link and assign content across representations for
different lifecycle stages or uses for a product.
For information about using this feature, see Mutli-BOM Manager in the
Teamcenter help library.

System Modeler Install this feature so that users can access functionality in the Architecture
toolbar of the Client interface.
If you are installing this feature in the Client, 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

Easy Plan - Electronics Installs client support for the Easy Plan Electronics Process Planner
Client workspace in your environment.
Electronics engineers use Production Process Planning for the systems
integration of the electronics process planning tasks of Easy Plan and those
of Valor Process Preparation Software. The systems integration is available
as a dedicated, optional feature of Production Process Planning.

Industrial Machinery Installs support for the Industrial Machinery solution in Active Workspace.
This solution provides a single-source data management system focused on
the engineering, manufacturing and product life BOM. This solution is
designed to enable industrial machinery customers to move from CAD data
management to engineering process management, integrating
requirements management, project management, and change
management.

Active Admin Features to support active admin capabilities.

Preference Adds preference management to the active admin workspace.

Management

CAE Simulation Features to support management of computer-aided engineering (CAE)

Management data.

Simulation In addition to the Active Workspace Client feature, requires the Active
Process Content Client feature.
Management
If you are installing this feature, you must also install the Simulation
Process Management Server Extensions feature on the corporate server.

A-32 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

Extended Extends Simulation Process Management capabilities in Active Workspace.

Simulation
Process
Management

Integrated Program Integrated Program Planning and Execution (IPP&E) client features. The
Planning and IPP&E solution allows project planning that integrates cost, schedule, risk
Execution and technical requirements in a fully planned, resourced, and budgeted
program. It allows configuration control, not only of products, but also of
the project plan. It also communicates the status of requirements to users.

IPP&E Contract Adds Contract Data Management support to IPP&E.

Data
Management
Extension

Organization Adds Organization Breakdown Structure (OBS) support to IPP&E.

Breakdown
Structure

IPP&E Provides essential functionality for Integrated Program Planning and

Foundation Execution in Active Workspace.

Work Breakdown Adds Work Breakdown Structure (WBS) support to IPP&E.

Structure

Program Planning Program Planning Execution features for the Active Workspace client.
Execution Client

Change Allows interaction between Schedule Manager and Change Management in

Management Active Workspace. It allows Active Workspace users to relate schedules and
Schedule change objects.
Manager Client
If you are installing this feature in the Client, you must install the Change
Management Schedule Manager Server Extension feature in the corporate
server and the following Active Workspace Client features:

• Schedule Manager

• Workflow

• Change Management

Program Change Allows interaction between Program Planning Event Change and Change
Client Management in Active Workspace. It allows Active Workspace users to relate
programs, projects, and subprojects to change objects.
If you are installing this feature in the Client, you must install the Program
Change Server Extension feature in the corporate server and select the
following Active Workspace Client features:

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-33

Feature Description

• Program Planning

• Workflow

• Change Management

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

• Program Planning

• Workflow

• Change Management

• Program Change Client

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

• Program Planning

• Schedule Manager

• Workflow

• Change Management

• Program Change Client

• Program Planning Event Change Client

Reuse and Features to support Reuse and Standardization in the Active Workspace
Standardization client.

Classification Allows users to access Classification data in the client interface.

Client

Library Installs the client component required to view classification libraries.

Management Classification libraries contain subsets of a classification hierarchy pertinent
to a particular role, project, or use case.

Teamcenter Quality Features to support Teamcenter Quality.

A-34 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

Control and Installs support for control and inspection planning in the Active Workspace
Inspection Plan client.
Control and inspection planning allows you to manage critical characteristics
of Failure Mode Effect Analysis (FMEA) and create a control plan that
generates bill of process (BOP) elements.

Failure Mode Adds support for Failure Mode Effect Analysis (FMEA) standards to the
Effect and Active Workspace client.
Analysis (FMEA)
For more information, see Quality in the Active Workspace help.

Quality Action Adds support for quality actions in the Active Workspace client.
Management
For more information, see Quality in the Active Workspace help.

Quality Manager Adds Quality Manager to the Active Workspace client.

For more information, see Quality in the Active Workspace help.

Training and Adds client support for training and qualification actions in Active
Qualification Workspace.

Quality Issue Adds Issue Manager and Problem Solving support for the Active Workspace
Management client.
and Problem
Solving

APQP Program Adds support for Advanced Product Quality Planning (APQP) methodology in
Management the Active Workspace client.
For more information, see APQP Program Management.

Quality Audit Adds support for quality auditing in the Active Workspace client.
For more information, see Quality in the Active Workspace help.

Model-Based Systems Features to support Model-Based Systems Engineering in the Active

Engineering Workspace client.

LMS System Exposes the System Synthesis artifacts, such as model templates and core
Synthesis architecture, in Active Workspace. These artifacts are created in Teamcenter
Modeling by System Synthesis, a framework for the numerical integration of
heterogeneous behavioral models issued by different authoring platforms,
such as LMS Amesim or MATLAB/Simulink.
If you are installing this feature in the Client, you must install the LMS
System Synthesis Modeling Server Extension feature in the corporate
server and the following Active Workspace Client features:

• Workflow

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-35

Feature Description

• Active Content

Parameter Adds parameter management to Active Workspace.

Management

Teamcenter Test Adds test management support to Model-Based Systems Engineering

Management (MBSE).

Physical Adds support for inspections and physical tests in the Active Workspace
Verification client.
Management

Active Architect Features to support Active Architect for Active Workspace.

UI Builder Installs UI Builder components of active architect. UI Builder adds new

declarative pages to the global navigation toolbar in Active Workspace,
including:

• Command builder

• Panel builder

Consumer Packaged Features to support Consumer Packaged Goods in the Active Workspace
Goods client.

Brand Installs the Brand Management template for Consumer Packaged Goods.
Management

Packaging and Installs packaging and artwork functionality for Consumer Packaged Goods.
Artwork

Specification Installs Specification Manager functionality for Consumer Packaged Goods.

Management

Consumer Installs consumer product management functionality for Consumer

Product Packaged Goods.
Management
Active
Workspace

Active Workspace microservices features

Active Workspace client features are available in the Features panel in Teamcenter Environment
Manager (TEM), under Microservices.

These features require installation of Microservice Framework.

A-36 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Feature Description

Microservices Installs the Microservices Framework.

Framework

Classification AI Installs the classification AI microservice that connects the Active Workspace
Serving Gateway to the classification AI engine, which provides artificial intelligence
(AI) to recommend the class in which to classify new objects.

Command Prediction Installs the Command Prediction Service, which manages data for the Active
Service Workspace Assistant
and a database for the microservice to store data for the Active Workspace
Assistant. TEM prompts you for the necessary database creation values during
installation.

Declarative Artifact Installs the microservice that stores your changes to the declarative
Service definitions of Active Workspace.
The Declarative Artifact Service allows you to easily create new declarative
definitions by automatically creating new files, and also make changes to
existing declarative definitions without changing their original source code.

File Repository Installs the File Repository microservice, which facilitates transfer of Active
Service Workspace client content from the File Repository to Active Workspace client
hosts through the Active Workspace Gateway.

Requirements Installs the microservice that provides compare capability for Requirements
Management Manager.
Compare Service

Requirements Installs the microservice that provides export capability for Requirements
Management Export Manager.
Service

Requirements Installs the microservice that provides import capability for Requirements
Management Import Manager.
Service

Teamcenter GraphQL Installs the Teamcenter GraphQL microservice, which processes client queries
Service passed from the Active Workspace Gateway to the File Repository.

Xcelerator Share Installs the Xcelerator Share microservice, which enables the Xcelerator Share
Microservice collaboration in Active Workspace. Xcelerator Share is a cloud application that
allows you to share and collaborate on project files with your partners, team
members, and manufacturers. In this browser-based file storage, you can
develop new products and designs, then share your projects with customers
for approval or manufacturers for production. Xcelerator Share controls and
secures file access, and maintains history of file sharing and exchange. For
more information about Xcelerator Share collaboration, see Xcelerator Share
collaboration in Active Workspace.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 A-37

Feature Description

iModel Viewer Provides viewing capability for iModel data.

Service

Teamcenter Google Provides interaction between the Google Online Viewer and the Teamcenter
Online Microservice server.

Teamcenter Office Provides the capability to use the Microsoft Office Online Server features that
Online Microservice allows users to edit and view documents within Active Workspace instead of
using the desktop version of the Microsoft Office applications.

OData Microservice Installs the microservice that supports the Teamcenter OData API Framework.

A-38 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Load balancing Active Workspace components provides failover support. This allows the system to
continue to operate when hardware or connectivity failures occur, and it allows for maintenance of
hardware without production downtime.

You should deploy the Active Workspace Gateway on at least two different physical machines and use a
commercial third-party load balancer configuration. The load balancer is used to enable the browser
clients to use one and only one URL to access Active Workspace and Teamcenter.

During your installation process, you should configure the Gateway to address at least two microservice
dispatchers on two different physical machines. If you chose to deploy the Teamcenter GraphQL
service1, you may be less concerned about failover and install on only one machine.

The Declarative Artifact Service is only used for user interface development using the UI Builder.
Therefore, you may choose to deploy it only as needed in development environments. The File
Repository service is an essential service and should be deployed on at least two different physical
machines to support failover. The actual file volume for the client assets must be on one and only one
machine.

In all cases, microservices can be deployed on more machines to achieve greater scalability. Any service
that will have heavy usage may warrant having more than two instances.

1 The Teamcenter GraphQL service is optional.

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 B-1

If you install the File Repository Service microservice on multiple machines, the file repository it has to
be on a shared drive.

If you install multiple instances of the File Repository Service microservice, all instances must reference
the same physical storage location. For example, if you install the File Repository Service microservice on
multiple machines, the file repository storage location must be on a shared drive.

B-2 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

© 2021 Siemens
C. Required RPM package managers
If you use the visualization server manager (VSM) on a Linux machine, make sure the following required
RPM package managers are available on the machine.

SUSE Linux:

fontconfig-2.11.1-7.1.x86_64
glibc-2.22-15.3.x86_64
glibc-32bit-2.22-15.3.x86_64
libbz2-1-1.0.6-29.2.x86_64
libexpat1-2.1.0-21.3.1.x86_64
libexpat-devel-2.1.0-21.3.1.x86_64
libfreetype6-2.6.3-7.15.1.x86_64
libgcc_s1-8.2.1+r264010-1.3.3.x86_64
libGLU1-9.0.0-18.1.x86_64
libICE6-1.0.8-12.1.x86_64
libjpeg8-8.1.2-31.7.4.x86_64
libpng16-16-1.6.8-14.1.x86_64
libSM6-1.2.2-3.59.x86_64
libstdc++6-8.2.1+r264010-1.3.3.x86_64
libuuid1-2.29.2-7.14.x86_64
libX11-6-1.6.2-12.5.1.x86_64
libXau6-1.0.8-4.58.x86_64
libxcb1-1.10-4.3.1.x86_64
libXext6-1.3.2-4.3.1.x86_64
libXft2-2.3.1-9.32.x86_64
libXm4-2.3.4-4.15.x86_64
libXmu6-1.1.2-3.60.x86_64
libXp6-1.0.2-3.58.x86_64
libXrender1-0.9.8-7.1.x86_64
libXt6-1.1.4-3.59.x86_64
libz1-1.2.11-1.27.x86_64
Mesa-libGL1-18.0.2-6.28.x86_64

Note:
On SUSE Linux, the /usr/lib64/libGLdispatch.so.0 file is not owned by any package.
Also, the /usr/lib64/libGLX.so.0 file is not owned by any package.

RedHat Linux:

bzip2-libs-1.0.6-13.el7.x86_64
expat-2.1.0-10.el7_3.x86_64
expat-devel-2.1.0-10.el7_3.x86_64
fontconfig-2.13.0-4.3.el7.x86_64

Active Workspace Installation, Active Workspace 6.0 AW001 6.0 C-1

freetype-2.8-12.el7.x86_64
glibc-2.17-260.el7.x86_64
libgcc-4.8.5-36.el7.x86_64
libglvnd-1.0.1-0.8.git5baa1e5.el7.x86_64
libglvnd-glx-1.0.1-0.8.git5baa1e5.el7.x86_64
libICE-1.0.9-9.el7.x86_64
libjpeg-turbo-1.2.90-6.el7.x86_64
libpng-1.5.13-7.el7_2.x86_64
libSM-1.2.2-2.el7.x86_64
libstdc++-4.8.5-36.el7.x86_64
libuuid-2.23.2-59.el7.x86_64
libX11-1.6.5-2.el7.x86_64
libXau-1.0.8-2.1.el7.x86_64
libxcb-1.13-1.el7.x86_64
libXext-1.3.3-3.el7.x86_64
libXft-2.3.2-2.el7.x86_64
libXmu-1.1.2-2.el7.x86_64
libXp-1.0.2-2.1.el7.x86_64
libXrender-0.9.10-1.el7.x86_64
libXt-1.1.5-3.el7.x86_64
mesa-libGLU-9.0.0-4.el7.x86_64
motif-2.3.4-14.el7_5.x86_64
zlib-1.2.7-18.el7.x86_64

C-2 AW001 6.0 Active Workspace Installation, Active Workspace 6.0

Aw Admin
100% (1)
Aw Admin
163 pages
Configuration and Extensibility
No ratings yet
Configuration and Extensibility
456 pages
Active Workspace Fundamentals
No ratings yet
Active Workspace Fundamentals
222 pages
Active Workspace Fundamentals
No ratings yet
Active Workspace Fundamentals
232 pages
Installation Server Windows EN
No ratings yet
Installation Server Windows EN
258 pages
AW Configuration
No ratings yet
AW Configuration
253 pages
Teamcenter Gateway For Enterprise Applications - Active Workspace Add-Ons Installation and Setup Guide
No ratings yet
Teamcenter Gateway For Enterprise Applications - Active Workspace Add-Ons Installation and Setup Guide
141 pages
Server Win
No ratings yet
Server Win
388 pages
Installing TC DC
No ratings yet
Installing TC DC
296 pages
Deployment
No ratings yet
Deployment
198 pages
Aw Installation
No ratings yet
Aw Installation
188 pages
Siemens TC14.3 Installation Guide
No ratings yet
Siemens TC14.3 Installation Guide
338 pages
installingTcDc (2412)
No ratings yet
installingTcDc (2412)
310 pages
System - Admin TC
100% (1)
System - Admin TC
630 pages
Workflow Designer
No ratings yet
Workflow Designer
709 pages
4HANA - Installation Guide
No ratings yet
4HANA - Installation Guide
125 pages
Teamcenter Installation: Siemens Siemens Siemens
No ratings yet
Teamcenter Installation: Siemens Siemens Siemens
528 pages
Program Planning
No ratings yet
Program Planning
160 pages
Teamcenter 10 Utilities Reference
No ratings yet
Teamcenter 10 Utilities Reference
970 pages
AWS WorkSpaces Bundle Management Guide
No ratings yet
AWS WorkSpaces Bundle Management Guide
26 pages
Teamcenter 10.1. Installation On Windows Servers Guide. Publication Number PLM00013 J
No ratings yet
Teamcenter 10.1. Installation On Windows Servers Guide. Publication Number PLM00013 J
398 pages
TC 2406 Manufacturing1
No ratings yet
TC 2406 Manufacturing1
20 pages
Teamcenter - Installation On UNIX and Linux Servers Guide - PLM00011 J
No ratings yet
Teamcenter - Installation On UNIX and Linux Servers Guide - PLM00011 J
388 pages
Ibm Utl Tcsuite 9.63 Anyos Noarch User Guide PDF
No ratings yet
Ibm Utl Tcsuite 9.63 Anyos Noarch User Guide PDF
142 pages
TC12.2 Installation Server Windows PDF
100% (1)
TC12.2 Installation Server Windows PDF
298 pages
Installation Server Windows
No ratings yet
Installation Server Windows
294 pages
Asm Guide 114
No ratings yet
Asm Guide 114
278 pages
Class Aw
No ratings yet
Class Aw
239 pages
MDM 103HF1 UpgradingFromVersion10x en PDF
No ratings yet
MDM 103HF1 UpgradingFromVersion10x en PDF
168 pages
Matlab Distributed Computing Server Documentation
No ratings yet
Matlab Distributed Computing Server Documentation
174 pages
Deployment Center
No ratings yet
Deployment Center
104 pages
Sco Admin Guide
No ratings yet
Sco Admin Guide
1,160 pages
Installation Server Unix
No ratings yet
Installation Server Unix
363 pages
Customer Experiences Using Linux On Ibm Z Systems and Linuxone
No ratings yet
Customer Experiences Using Linux On Ibm Z Systems and Linuxone
53 pages
DIH 10.5 Installation Guide
No ratings yet
DIH 10.5 Installation Guide
133 pages
IBM Blade Center, Linux, and Open Source Blueprint For E-Business On Demand
No ratings yet
IBM Blade Center, Linux, and Open Source Blueprint For E-Business On Demand
258 pages
Teamcenter Gateway For Enterprise Applications - Connectivity Guide
No ratings yet
Teamcenter Gateway For Enterprise Applications - Connectivity Guide
85 pages
Tc9.1 ReleaseBulletin
No ratings yet
Tc9.1 ReleaseBulletin
550 pages
Users Guide Vxworks
No ratings yet
Users Guide Vxworks
470 pages
DX 1053 HighAvailabilityInstallationGuide en
No ratings yet
DX 1053 HighAvailabilityInstallationGuide en
85 pages
PC 811 WebServicesProviderGuide
No ratings yet
PC 811 WebServicesProviderGuide
136 pages
In 1040 InstallationForPowerCenterAndDataQuality en
No ratings yet
In 1040 InstallationForPowerCenterAndDataQuality en
287 pages
IN 1040 ReleaseGuide en PDF
No ratings yet
IN 1040 ReleaseGuide en PDF
369 pages
Cause
No ratings yet
Cause
341 pages
PlantPAx 4.5 Virtualization User Manual 9528-Um001 - En-P PDF
No ratings yet
PlantPAx 4.5 Virtualization User Manual 9528-Um001 - En-P PDF
264 pages
MDM 103 InstallationGuideFor (SQL) ServerWith (JBoss) en
No ratings yet
MDM 103 InstallationGuideFor (SQL) ServerWith (JBoss) en
103 pages
TC Security Services Install
No ratings yet
TC Security Services Install
162 pages
TC 10 1 Release Bulletin PDF
No ratings yet
TC 10 1 Release Bulletin PDF
500 pages
WPS70 DeploymentEnvironment Cluster Oracle11g
No ratings yet
WPS70 DeploymentEnvironment Cluster Oracle11g
305 pages
Rapid Start Installation Windows
No ratings yet
Rapid Start Installation Windows
150 pages
Getting Started Teamcenter
No ratings yet
Getting Started Teamcenter
28 pages
Server Customization
No ratings yet
Server Customization
379 pages
Teamcenter 11.2 Windows Server Installation: Siemens Siemens Siemens
No ratings yet
Teamcenter 11.2 Windows Server Installation: Siemens Siemens Siemens
390 pages
DataPrivacyManagment en
No ratings yet
DataPrivacyManagment en
238 pages
Query Builder
No ratings yet
Query Builder
56 pages
Utilities Reference
No ratings yet
Utilities Reference
1,000 pages
Installation Client Windows
No ratings yet
Installation Client Windows
112 pages
OneHourNo SewBabyTurtle
100% (4)
OneHourNo SewBabyTurtle
8 pages
Improving Functional Outcomes in Physical Rehabilitation 2nd Edition, (Ebook PDF) Instant Download
No ratings yet
Improving Functional Outcomes in Physical Rehabilitation 2nd Edition, (Ebook PDF) Instant Download
46 pages
Inventory ERP Issues: Pending Processes Remarks
No ratings yet
Inventory ERP Issues: Pending Processes Remarks
6 pages
q1 2025 Cmo Journal
No ratings yet
q1 2025 Cmo Journal
66 pages
Prenatal Development & Heredity
No ratings yet
Prenatal Development & Heredity
56 pages
12 Days To A Millionaire Mind Arlin Moore
No ratings yet
12 Days To A Millionaire Mind Arlin Moore
18 pages
CQI全球高质量期刊目录 2025版（试行）
No ratings yet
CQI全球高质量期刊目录 2025版（试行）
198 pages
Chorea
No ratings yet
Chorea
4 pages
Moxa Eds 308 Series Datasheet v1.3
No ratings yet
Moxa Eds 308 Series Datasheet v1.3
5 pages
Avinash
No ratings yet
Avinash
17 pages
Valuable United States Coins Online! See Entire: Image Coin Worth
No ratings yet
Valuable United States Coins Online! See Entire: Image Coin Worth
9 pages
Adobe ONYX Summa Cutting Workflows 2016 v1.0
No ratings yet
Adobe ONYX Summa Cutting Workflows 2016 v1.0
13 pages
Lesson Plan English Maam Hillary 8
100% (5)
Lesson Plan English Maam Hillary 8
5 pages
Spring Boot Reference PDF
No ratings yet
Spring Boot Reference PDF
225 pages
Benefits of Small-Sided Games
No ratings yet
Benefits of Small-Sided Games
13 pages
Digital Transformation & IoT Guide
No ratings yet
Digital Transformation & IoT Guide
17 pages
HSC 12th Standard Maths Model Paper 3
No ratings yet
HSC 12th Standard Maths Model Paper 3
5 pages
Induction Machine Winding Analysis
No ratings yet
Induction Machine Winding Analysis
8 pages
Urban Land Access Challenges in Ethiopia
No ratings yet
Urban Land Access Challenges in Ethiopia
46 pages
Marvel Heroic RPG - Civil War - X-Men
100% (3)
Marvel Heroic RPG - Civil War - X-Men
134 pages
Infpack
No ratings yet
Infpack
4 pages
Google Play Supported Devices - Sheet 1
No ratings yet
Google Play Supported Devices - Sheet 1
272 pages
Monograph COBIOGUM I Rev00
No ratings yet
Monograph COBIOGUM I Rev00
1 page
School Payment Voucher Template
No ratings yet
School Payment Voucher Template
1 page
QEP 2024 - Theme - Gender Issues - theIAShub - PPT 2 PDF
No ratings yet
QEP 2024 - Theme - Gender Issues - theIAShub - PPT 2 PDF
6 pages
Environmental Awareness for Rural Women
No ratings yet
Environmental Awareness for Rural Women
15 pages
Target Audience UBL Mukammal Current Account
No ratings yet
Target Audience UBL Mukammal Current Account
3 pages
Triangle Similarity Theorems Overview
No ratings yet
Triangle Similarity Theorems Overview
31 pages
Probability and Random Variables Guide
No ratings yet
Probability and Random Variables Guide
39 pages
SSC CGL Pre 2024 Marks, and Rank Calculator by Answer Key URL - RankMitra
No ratings yet
SSC CGL Pre 2024 Marks, and Rank Calculator by Answer Key URL - RankMitra
34 pages