0% found this document useful (0 votes)

30 views261 pages

Aw Admin

The document is the administration guide for Teamcenter 2406, detailing the management of Active Workspace, including user access, data sharing, and system settings. It emphasizes the confidentiality of the content, the necessity of a signed license agreement for usage, and outlines various administrative tasks such as configuring email, managing projects, and updating property values in bulk. Additionally, it provides information on Siemens Digital Industries Software and its role in product lifecycle management.

Uploaded by

Ajay Dhanvi

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)

30 views261 pages

Aw Admin

Uploaded by

Ajay Dhanvi

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

TEAMCENTER

Active Workspace
Administration
Teamcenter 2406
Unpublished work. © 2024 Siemens

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

This Documentation is for information and instruction purposes. Siemens reserves the right to make changes in specifications
and other information contained in this Documentation without prior notice, and the reader should, in all cases, consult
Siemens to determine whether any changes have been made.
No representation or other affirmation of fact contained in this Documentation shall be deemed to be a warranty or give rise to
any liability of Siemens whatsoever.
If you have a signed license agreement with Siemens for the product with which this Documentation will be used, your use of
this Documentation is subject to the scope of license and the software protection and security provisions of that agreement.
If you do not have such a signed license agreement, your use is subject to the Siemens Universal Customer Agreement, which
may be viewed at [Link] as supplemented by the product specific terms
which may be viewed at [Link]
SIEMENS MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS DOCUMENTATION INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT OF
INTELLECTUAL PROPERTY. SIEMENS SHALL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL OR
PUNITIVE DAMAGES, LOST DATA OR PROFITS, EVEN IF SUCH DAMAGES WERE FORESEEABLE, ARISING OUT OF OR RELATED
TO THIS DOCUMENTATION OR THE INFORMATION CONTAINED IN IT, EVEN IF SIEMENS HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.

TRADEMARKS: The trademarks, logos, and service marks (collectively, "Marks") used herein are the property of Siemens or other
parties. No one is permitted to use these Marks without the prior written consent of Siemens or the owner of the Marks,
as applicable. The use herein of third party Marks is not an attempt to indicate Siemens as a source of a product, but is
intended to indicate a product from, or associated with, a particular third party. A list of Siemens’ Marks may be viewed at:
[Link]/global/en/legal/[Link]. 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 global leader in the growing field of product lifecycle management (PLM),
manufacturing operations management (MOM), and electronic design automation (EDA) software, hardware, and services.
Siemens works with more than 100,000 customers, leading the digitalization of their planning and manufacturing processes. At
Siemens Digital Industries Software, we blur the boundaries between industry domains by integrating the virtual and physical,
hardware and software, design and manufacturing worlds. With the rapid pace of innovation, digitalization is no longer
tomorrow’s idea. We take what the future promises tomorrow and make it real for our customers today. Where today meets
tomorrow. Our culture encourages creativity, welcomes fresh thinking and focuses on growth, so our people, our business, and
our customers can achieve their full potential.

Support Center: [Link]

Send Feedback on Documentation: [Link]/doc_feedback_form

Contents

Active Admin
The Active Admin workspace ───────────────────── 1-1

Localization configuration
Localization configuration tasks ──────────────────── 2-1
Configuring Active Workspace for other locales ───────────── 2-1
Locale support by Visualization Server Manager ──────────── 2-3

Control data access

Creating the organizational structure ───────────────── 3-1
Managing users, groups, and roles ────────────────── 3-2
What are groups, roles, and users? ───────────────────── 3-2
How to manage groups, roles, and users in Active Workspace ───────── 3-6
Creating groups, roles, and users ────────────────────── 3-7
Managing projects ───────────────────────── 3-15
What are projects? ─────────────────────────── 3-15
Understanding project team roles ───────────────────── 3-16
Manage project teams ────────────────────────── 3-17
Configuring owning program ─────────────────────── 3-19
Configure project-level security ────────────────────── 3-20
Configure project data template folders ────────────────── 3-21
Managing users' access to data using Access Manager ───────── 3-23
Controlling access to data objects ───────────────────── 3-23
Using Access Manager rules ─────────────────────── 3-23
Managing access control lists ─────────────────────── 3-26
Import and export Access Manager rules ────────────────── 3-28

Import, Export, and Report Administration Data

What is administration data? ───────────────────── 4-1
Tools for managing administration data ──────────────── 4-2
Example tasks and processes for managing site behavior ──────── 4-3
Reconcile differences in administration data between Teamcenter sites ── 4-5
Exporting administration data ──────────────────── 4-6
Why would I export administration data? ────────────────── 4-6
Export administration data using the admin_data_export utility ──────── 4-6
Export full administration data using TEM ────────────────── 4-7
Export partial administration data using TEM ──────────────── 4-8
Considerations for partial export of administration data ─────────── 4-10
Importing administration data ──────────────────── 4-14
Why would I import administration data? ────────────────── 4-14
Perform a dry run import of administration data using TEM ────────── 4-14

Active Workspace Administration, Teamcenter 2406 3

© 2024 Siemens
Perform a dry run import of administration data using the admin_data_import utility
───────────────────────────────── 4-16
Import administration data using TEM ─────────────────── 4-16
Import administration data using the admin_data_import utility ────────
4-18
Postprocess imported volume objects ─────────────────── 4-19
Administration data import merge options ───────────────── 4-20
Style sheet import behavior ─────────────────────── 4-21
Modifying an administration data package ───────────────── 4-23
Import a modified administration data package ─────────────── 4-25
Reporting administration data ──────────────────── 4-25
What administration data reports are available? ─────────────── 4-25
Administration Data Documentation report ───────────────── 4-26
Administration Data Comparison report ────────────────── 4-27
Administration Data Import (dry run) report ──────────────── 4-30
Administration Data Import (history) report ──────────────── 4-30

Relations configuration
Relations configuration tasks ───────────────────── 5-1
Creating new views or updating existing views ───────────── 5-4
Example of configuring relations expansion ────────────── 5-5
Localize names that appear in a custom Relations view ───────── 5-5
Relation browser config file syntax ────────────────── 5-6

Data sharing
Configuring and managing data sharing ──────────────── 6-1
Configure report layout settings ──────────────────── 6-3
Configure Briefcase file sharing ──────────────────── 6-3
Configure PLM XML data sharing ─────────────────── 6-4
Configure PDX data sharing ────────────────────── 6-4
Create mapping rules using Advanced Multi-Schema Exchanger ───── 6-7
Using Advanced Multi-Schema Exchanger to create mapping rules ─────── 6-7
Preparing for a mapping project ────────────────────── 6-7
Creating and updating mapping projects ────────────────── 6-7
Mapping object types ─────────────────────────── 6-8
Deploying mapping rules ──────────────────────── 6-10
Manage Multi-Site ───────────────────────── 6-12
Specifying the scope of Multi-Site remote checkouts and checkins ─────── 6-12
Multi-Site Dashboard ────────────────────────── 6-12
Viewing Multi-Site Dashboard issues ──────────────────── 6-13
Configuring Multi-Site Dashboard ───────────────────── 6-14
Resolving Multi-Site issues ──────────────────────── 6-15
Monitor data exchange transactions ───────────────── 6-16
Monitor data exchange transactions ──────────────────── 6-16
Configuring data exchange transaction monitoring ───────────── 6-17
Viewing data exchange transaction records ───────────────── 6-18
Share bulk data ─────────────────────────── 6-19
Bulk loading product data ──────────────────────── 6-19

4 Active Workspace Administration, Teamcenter 2406

Copying product data from your production environment ────────── 6-20

Copying product data into your test environment ────────────── 6-21

Configuring Teamcenter mail and instant messaging

Configuring Teamcenter mail ───────────────────── 7-1
Configuring Teamcenter to use email servers requiring authentication ── 7-2
Configuring instant messaging ──────────────────── 7-3

Configuring Teamcenter email polling

What is Teamcenter email polling? ─────────────────── 8-1
Configure email polling types ───────────────────── 8-2
Create an email polling rule ────────────────────── 8-3
Configure user email account settings ───────────────── 8-5
Configure Dispatcher for email polling ───────────────── 8-7
Start or schedule email polling ──────────────────── 8-8
Teamcenter email polling preferences ───────────────── 8-9

Updating property values in bulk

Process for updating property values in bulk ────────────── 9-1
Using the tc_attribute_bulk_update utility arguments to update property values
in bulk ──────────────────────────── 9-2
Using an XML input file to update property values in bulk ──────── 9-5
Performance statistics ──────────────────────── 9-8
Best practices for updating property values in bulk ─────────── 9-9

Logging
Monitoring your system ─────────────────────── 10-1
Configuring the Audit Logs page ─────────────────── 10-1
Audit Logs page configuration tasks ──────────────────── 10-1
Activate the Audit Log page ─────────────────────── 10-3
Customize audit logs field display ───────────────────── 10-4
Using audit logs ──────────────────────────── 10-5
Customize the audit log display ────────────────────── 10-7
Aggregating microservice logs ──────────────────── 10-9
Microservice log aggregation ─────────────────────── 10-9
Install the microservice log aggregator ────────────────── 10-10
View aggregated logs ───────────────────────── 10-12
Enable TLS for log aggregation ───────────────────── 10-14
Configure user logging ─────────────────────── 10-16

Assistant configuration
Assistant configuration tasks ───────────────────── 11-1
Configuring the Assistant panel ─────────────────── 11-2
Install the Assistant ───────────────────────── 11-3

Active Workspace Administration, Teamcenter 2406 5

© 2024 Siemens
Manually create a database for the Command Prediction Service microservice
──────────────────────────────── 11-4
Migrate the Oracle database for the Command Prediction Service microservice
──────────────────────────────── 11-7
Migrate the MSSQL database for the Command Prediction Service microservice
──────────────────────────────── 11-9
Managing user passwords using the CPS_manage_password utility ─── 11-11
Migrating user data using the CPS_migrate_user_data utility ───── 11-12

Configuring units of measure

Introduction to units of measure ─────────────────── 12-1
Configure available units of measure ───────────────── 12-1
Migrate legacy units of measure to the unified measurement system ── 12-2
Working with the unit of measure definitions file ─────────── 12-5

Subscription configuration
Subscription configuration tasks ─────────────────── 13-1
Configuring notifications ────────────────────── 13-2
Configuring subscribable properties ───────────────── 13-3
Setting subscription notification preferences ───────────── 13-4
Configuring subscription to multiple objects ────────────── 13-6
Configuring My Events ─────────────────────── 13-6
Configuring news feed retention ─────────────────── 13-7
Purging news feed notifications ─────────────────── 13-7

Active Collaboration configuration 14-1

Settings and performance

Manage system settings and performance ────────────── 15-1
Troubleshooting ────────────────────────── 15-1
Retrieving Active Workspace client and server versions ──────────── 15-1
General troubleshooting ───────────────────────── 15-2
View Active Workspace performance data ───────────────── 15-3
Verify the Active Workspace gateway and other microservices ───────── 15-6
Resetting the Active Workspace gateway and microservices ────────── 15-7
Monitoring browser activity ─────────────────────── 15-8
Performance and settings ────────────────────── 15-9
Enabling browser caching ──────────────────────── 15-9
Working with large files in Active Workspace ──────────────── 15-10
Compressing images for loading them quickly ─────────────── 15-10
Configure image resolution ─────────────────────── 15-11
Preferences ──────────────────────────── 15-12
Why do I need preferences? ─────────────────────── 15-12
How do preferences work? ─────────────────────── 15-12
An example of preference hierarchy ─────────────────── 15-16

6 Active Workspace Administration, Teamcenter 2406

What are environment preferences? ─────────────────── 15-20

Working with preferences in Active Workspace ─────────────── 15-20
Displaying items instead of revisions ─────────────────── 15-25
Deleting various object types ────────────────────── 15-26
Controlling notification timeout ───────────────────── 15-27
Defining properties that display in object cells ─────────────── 15-27
Defining the revision rules list ────────────────────── 15-28
Where can I get a list of preferences? ─────────────────── 15-28
Business Modeler IDE constants ─────────────────── 15-29
Global constants ──────────────────────────── 15-29
Business object constants ──────────────────────── 15-30
Property constants ─────────────────────────── 15-34
Utilities ────────────────────────────── 15-44
Using command-line utilities ────────────────────── 15-44
log-level ─────────────────────────────── 15-57

Active Workspace Administration, Teamcenter 2406 7

© 2024 Siemens
8 Active Workspace Administration, Teamcenter 2406
© 2024 Siemens
Administration from Active Workspace
Using Active Workspace, you can perform routine tasks to:

• Monitor your site and keep it running efficiently

• Provide an environment in which your users perform their tasks quickly.

Where do I go from here?

Teamcenter Administrator
Learn about administration tools available in Active Admin workspace
Active Workspace
Control user access to data Manage which data your users see
Share data Share data with external locations
Monitor system logging Configure and view log files
Manage your site's settings and performance Manage system settings and performance
Manage Teamcenter behaviors What is administration data?
Import, Export, and Report Administration
Data
Manage environment and application licenses Configure available units of measure
Update property values in bulk

Active Workspace Administration, Teamcenter 2406 9

© 2024 Siemens
10 Active Workspace Administration, Teamcenter 2406
© 2024 Siemens
1. Active Admin
The Active Admin workspace
What is the Active Admin workspace?

This workspace is an exclusive workspace designed for Active Workspace administrators. Since it is
exclusive, there are a limited set of pages and commands that the administrator is allowed to visit. For
example, there is no access to initiate a workflow, change management, scheduling, or other end-user
functionality.

The workspace provides quick access to the most common administrative functions on the home page
tiles.

How do I enable it?

Use Deployment Center or the Teamcenter Environment Manager to install it.

During installation, the workspace definition file, workspace_TcActiveAdminWorkspace.json, is added

to the STAGE\src\solution directory of your Active Workspace development environment, and the
workspace is mapped to the dba group.

What applications does it contain?

See the workspace definition file for a complete list of available pages and commands. Following are a
few of the applications displayed in the Active Admin workspace home page by default:

• Access Manager

Control user access to data objects by defining rules and defining access control lists (ACLs).

Active Workspace Administration, Teamcenter 2406 1-1

• Preferences

Manage your Teamcenter preferences from within Active Workspace.

• People

Manage your organization. Create and modify groups, roles, and users. Remove roles and users.

Note:
You must use the Teamcenter rich client to remove or delete a group or subgroup from the
parent group, as this capability is not available using the Active Workspace client.

• Workflow Designer

Use a graphical editor to view and design workflows and task templates.

• Assignment Lists

Prepare lists of groups or roles to assist your users when they assign users to workflows.

• Viewer administration

Help troubleshoot your active visualization installation.

• Smelters

Help importing smelters information into Teamcenter for compliance check.

• Delete declaration data

Help deleting the declaration documents or imported declaration records related to compliance check
from Teamcenter.

1-2 Active Workspace Administration, Teamcenter 2406

Localization is the presentation of an application's text in the local language. You can install Active
Workspace to be displayed in many different languages.

Why configure localization?

After installing Active Workspace to run on a localized Teamcenter server, additional setup may be
required to present text in the local language.

What can I configure?

You can configure the following aspects of localization:

• Configure Active Workspace for additional locales.

• Configure locales for visualization servers.

What do I need to do before configuring?

Before you can configure localization, you must ensure that the server-side of Teamcenter is configured
for the locales you want.

Where can I find out more about localization?

See Teamcenter Localization in the Teamcenter help.

Configuring Active Workspace for other locales

You can configure Active Workspace to support various languages in addition to English. Use the
Deployment Center or the Teamcenter Environment Manager to manage your available locales.

Tip:
When creating custom content, the parenthetical value is post-fixed to the JSON file name in the
i18n folder of your custom module.

Active Workspace Administration, Teamcenter 2406 2-1

Deployment Center

The list of available locales is not a required parameter in the Deployment Center, so you must show all
parameters when choosing locales.

Your list of components may differ.

1. Select the Active Workspace Client component.

2. Select Show all parameters.

3. Choose your additional Client Locales.

Teamcenter Environment Manager

The list of available locales is found when you Update Active Workspace client settings.

2-2 Active Workspace Administration, Teamcenter 2406

Locale support by Visualization Server Manager

You can configure the Active Workspace client to display the user interface in any of the supported
Teamcenter locales. However, some visualization data, such as Product and Manufacturing Information
(PMI), requires a Visualization Server Manager (VSM) configured for the same locale as the information.
For visualization data to display correctly in the Active Workspace client, you must have at least one
VSM configured to run in each locale for which you have data. With this system in place, visualization
processes are then routed to the appropriate server based on locale.

VSMs can be configured to support the following languages:

Brazilian Portuguese English Korean

Chinese (Simplified) French Polish

Chinese (Traditional) German Spanish

Czech Italian Russian

French Japanese

You can configure a VSM with any one of these languages. If you want to configure a cluster of VSMs to
support more than one language, you need at least one VSM per language.

Active Workspace Administration, Teamcenter 2406 2-3

To change the language of a VSM, set Windows to the required language, location, and locale. You
can adjust these settings using the Region and Language options found in the Windows Control Panel.
You must adjust the Date and time formats, the Current location, and the Current language for
non-Unicode programs values. After changing your Windows settings, reboot the system. When the
VSM is started again, it inherits the new language configuration of the operating system.

If all VSMs are configured to use the same language, all clients use the available language regardless of
browser preferences.

Note:
If you have a VSM system configured for two or more different languages, then Siemens Digital
Industries Software highly recommends that at least one VSM be configured for English, even
though this may require a minimum of three VSMs.
When the server system is configured with multiple languages, if at least one VSM is configured for
English, then the English locale is a default.
The following table shows the VSM system response to a visualization data request from client
when the client is not in one of the pre-configured languages.

VSM system configured for two or

more languages Client is not in a pre-configured VSM language

VSM for English exists The data request is routed to an English VSM.

No VSM for English The data request is rejected.

2-4 Active Workspace Administration, Teamcenter 2406

© 2024 Siemens
3. Control data access
Creating the organizational structure
By setting up user management you can control the functionality that is available to users who are
mapped to a specific role, thereby controlling the access to restricted data. To do this, you can create
groups for specific projects, and add users, or roles assigned as team members to the projects.

Example:
You want to set up the organizational structure for a project that requires an administrator, a
project manager, two designers, and two analysts. You first create a project and add a group to the
project. You then identify the users or create new users that you require for your project. Next, you
search for existing roles or create new roles required for the project. You then add the roles to the
group, and add users to the respective roles in the group.

Active Workspace Administration, Teamcenter 2406 3-1

Managing users, groups, and roles

What are groups, roles, and users?

Groups
In Active Workspace, the term group refers to a cluster of users who take on a role or multiple
roles in a group. Groups can be created to represent data ownership and to control data access.

3-2 Active Workspace Administration, Teamcenter 2406

Projects are created with specific groups, users, or roles assigned as team members, privileged team
members, and team administrators.

Typically, groups are defined along project lines and not functional lines. However, you can also
create groups of third-party organizations such as suppliers.

A group member can be a member of multiple groups. Groups make up the core of the organization
structure.

As an administrator, you can:

• Create and modify groups.

Note:
You must use the Teamcenter rich client to remove or delete a group or subgroup from the
parent group, as this capability is not available using the Active Workspace client.

Example:
The high_performance group consists of 2 roles, that is, Engineering Manager and
Standards Engineer, and 2 users, namely, rgreen and mread, who are assigned their
respective roles.

• Assign authorized data access privileges to a group.

• Assign default volumes to a group.

A volume is a location where files are stored. A volume corresponds to a directory on the
operating system. Files stored in volumes are created by CAD applications or other third-party
applications. You can assign volumes to groups and define file locations for your organization
structure.

Active Workspace Administration, Teamcenter 2406 3-3

• Manage subgroups within the organization.

A subgroup is a group with another group designated as its parent. A subgroup may also be
designated as a parent group. The position of subgroups within the organizational hierarchy can
be managed by parenting and reparenting groups.

Subgroups can be used to organize users. Subgroups inherit access permissions, volumes, and
preferences from their parent.

Example:
Consider a scenario where you wish to restrict contractors from viewing any content in the
employee group. In this case, you can create subgroups abc and acme within a group such
that users from these subgroups will not have access to the content from any groups other
than their own.

Roles
A role defines the type of work a user is expected to perform in a group. Roles refine the group
definitions of your organization structure.

• A role can be assigned to multiple groups.

• Roles add an additional layer of data access control.

• Roles are created along functional lines.

Tip:
While creating roles, use real-world descriptions, skills, and responsibilities.

As an administrator, you can:

• Create, modify, and delete role definitions.

• Add new or existing roles to groups.

3-4 Active Workspace Administration, Teamcenter 2406

• Assign a default role within a group.

Example:
Robert Green, a user, is assigned the default role of Engineering Manager. In addition to
his responsibilities as engineering manager, Robert must also perform standards-related work.
Therefore, user rgreen is assigned two roles in the high_performance group: Engineering
Manager and Standards Engineer.

Users
Users are individuals who interact with Active Workspace. A user is assigned to a default group and
takes on a role in the group.

As an administrator, you can:

• Create, modify, deactivate user accounts, or delete users from groups.

• Reset user passwords.

• Assign license bundles, and license servers to a user.

When you assign a license bundle to a specific user, the user assigned to the bundle is assured
the availability of all the features in the bundle. You can use license bundling in conjunction with
other licensing schemes. Consider a scenario where a user is assigned a license bundle that does
not include the Systems Engineering module. When the user launches Systems Engineering, the
system confirms if the feature key exists in the license file outside of the license bundle. If the
feature key is found, the application can be used.

A license server is a process dedicated to tracking license usage by users. It runs on a host
machine and port specified by an administrator. An administrator can set up multiple license
servers. Each license server can have a different set of users assigned to it. This allows the load
balancing of license requests so that a single license server is not overused.

Active Workspace Administration, Teamcenter 2406 3-5

Users can be assigned various roles in the organization. A user can also be part of multiple groups in
the organization.

Example:
Robert Green, a user, is assigned the default role of Standards Engineer and belongs to the
default group high_performance.

How to manage groups, roles, and users in Active Workspace

In Active Workspace, you can use the PEOPLE tile to create and modify users, roles, and groups and to
set up authorized access using login credentials for each user.

The PEOPLE tile is visible in both the Active Admin and Default workspaces.

You can create your own workspace mapped to a special group of non-dba group users and add the
PEOPLE tile to it. This allows users to perform admin work because privileges for dba group users are
too broad.

As a database administrator, you can create users and user roles specific to your organization. You can
then add the users and roles to a specific group to grant them authorized access to the application.

By default, your organization's groups, users and roles are listed on the Organization tab in Tree view.

• Click Tree to change to other views.

• Right-click on objects for quick access to actions you can perform.

• Click Selection Mode or Ctrl-click on objects to select more than one object.

3-6 Active Workspace Administration, Teamcenter 2406

Creating groups, roles, and users

Create groups

To create your group at the organization level, first select Organization in the Tree view. To create a
group within a group, first select that group using any view.

1. Perform one of the following steps:

• On the Organization tab, click Add > Add Group .

• On the Organization tab, right-click on Organization (Tree view only) or another parent group
and click Add Group .

• On the Groups tab, click More commands > New > Add .

The Add panel is displayed.

Tip:
To keep the Add panel open so that you can continue to add groups without opening the
panel each time, click Pin Panel .

2. To add an existing group, use the Search tab to search for the group.

Active Workspace Administration, Teamcenter 2406 3-7

To create a new group, use the New tab to specify the following values.

• Name

Specify a name that is not the same as the new group's parent or sibling groups.

• (Optional) Description

• (Optional) Security

• (Optional) To Parent

To create a subgroup for an existing group, select the parent group from the list. By default, the
parent is the group selected at the time the new group is created.

• (Optional) DBA Privilege

• (Optional) Default Volume

• (Optional) Default Local Volume

3. Click Add to add or create the group.

Create and add roles to groups

1. Perform one of the following steps:

• On the Organization tab, select one or more groups and click Add > Add Role .

• On the Organization tab, select one or more groups, right-click and click Add Role .

• On the Groups tab, select a group and click Add Role in the Roles section.

The Add panel is displayed.

2. To add an existing role, use the Search tab to search for the role.

To create a new role, use the New tab to name and describe the role.

3. Click Add.

Create and add users to roles

1. On the Users tab, click More commands > New > Add .

3-8 Active Workspace Administration, Teamcenter 2406

2. In the Add panel, in the New section, enter the following:

• Name

• User ID

• OS Name

• Default Group

• (Optional) Default Volume

• (Optional) Default Local Volume

• Status

To create an active user, set Status = 0.

• License Level

The types of licenses available depends on your license agreement. For descriptions of the
available license levels, see your license agreement documentation.

• (Optional) License Server

• (Optional) License Bundle

• Visualization Licensing Level

0 (Base)

1 (Standard)

2 (Professional)

3 (Mockup)

• (Optional) Geography

• (Optional) Nationality

• (Optional) Citizenships

In the Personal Information section, specify any of the optional fields:

3. Click Add.

Active Workspace Administration, Teamcenter 2406 3-9

Managing users

Edit user information

1. Navigate to the Users tab and search for an existing user. Select the user.

2. Click Edit .

3. Modify the user information and click Save .

Alternately, select the user on the Organization tab and click Edit to update user information and
other properties.

View user activity logs

Audit logs must be enabled for users other than those in the dba group. See Activate the Audit Log
page.

1. In the Roles tab, select the role for which you want to view the user activity logs.

2. Click the Audit Logs tab.

A table that shows the Logged Date, the Event Type Name, and the Login User ID is displayed
under Organization Logs.

Adding the Access tab to view user access rights

What is the Access tab?

The Access tab enables you to view access rights on objects in Active Workspace. As an administrator,
it helps you determine if the correct access privileges have been assigned to the selected user. If a user

3-10 Active Workspace Administration, Teamcenter 2406

is assigned multiple groups and roles, you can determine access for that user by selecting a particular
group/role combination and clicking Show Access Rights.

The Access tab contains three sections:

• User, Group, and Role filters

Filters the user, group, and role for the current user session context.

You can use these filters to select another user, group, and role combination for which you want to
view the associated access rights for the currently selected object. Click Show Access Rights to apply
these changes.

• Access Rights

Lists the operations and privileges granted to the filtered combination of user, group, and role.

• Associated Rules

Lists the rules associated with the given object.

Note:
By default, the Access tab is not available. To add the Access tab, edit the style sheet registered
to the summary view for the object type to which you wish to add the Access tab.

Example:

Ed, a designer in the engineering group, designed the testItem object. His access rights are shown in
the Access Rights section. Ed is granted Read, Write, Delete, and other rights because he is the owning
user.

Active Workspace Administration, Teamcenter 2406 3-11

How do I add an Access tab?

1. Open the style sheet registered to the summary view for the type of object to which you wish to
add the Access tab:

• Item revision

The default summary style sheet is Awp0ItemRevSummary.

• Document revision

The default summary style sheet is Awp0IDocumentRevSummary.

• Requirements revision

The default summary style sheet is Awp0RequirementRevisionSummary.

2. Add the following line to the appropriate style sheet.

<inject type="dataset" src="Aut0ItemRevSummary" />

3-12 Active Workspace Administration, Teamcenter 2406

a. For an item revision, add the line here in the Awp0ItemRevSummary style sheet:

<inject type="dataset" src="Fsh1FinishesSection"/>

b. For a document revision, add the line here in the Awp0IDocumentRevSummary style sheet:

<inject type="dataset" src="Fnd0ClassificationSummary"/>

c. For a requirements revision, add the line here in the Awp0RequirementRevisionSummary

style sheet:

<inject type="dataset" src="WorkflowSummary"/>

Add or change a user password

1. In the Users tab, select the user whose password you want to add or change.

2. Click More commands > Manage > Change Password .

3. In the Change Password panel, specify and confirm the new password.

4. Click Change to change the password.

Deactivate users

You can deactivate a specific user ID by modifying the status of the user. This user is retained in the
database and can be activated for future use.

Example:
Consider a designer who will be going on an extended leave of absence. Instead of deleting the
user from the project group, you can temporarily deactivate the user. Once the user is available,
you can set the status to active.

1. On the Organization tab, search for the user whose status you want to modify and select the user.

2. Click Edit to display the properties and other settings that a can be updated for the user.

Active Workspace Administration, Teamcenter 2406 3-13

3. In the Properties section, set the Status field of the user to 1 Inactive.

4. Click Save .

Delete a user from a group

1. In the Organization tab, using the tree view, search for the group from which you want to delete a
user.

2. Expand the group to show the roles in the group.

3. Expand the role containing the user you wish to remove from the group.

4. Select the user and click Remove from the results panel toolbar.

Alternately, select the user, right-click, and chose Remove from the context menu.

The user is deleted from the role and the group.

Managing roles

Edit a role

1. On the Roles tab, search for the role you which to edit. Click on the role.

2. Click Edit to enable editing of the role's properties.

3. Modify the role name and description and click Save .

Delete a role

Note:
You cannot delete a role that is referenced by another organization object.

1. In the Organization tab, using the tree view, search for the group from which you want to delete a
role.

2. Expand the group to show the roles in the group.

3. Select the role and click Remove from the results panel toolbar.

Alternately, select the role, right-click, and chose Remove from the context menu.

The role is deleted from the group.

3-14 Active Workspace Administration, Teamcenter 2406

Managing projects

What are projects?

In the Teamcenter rich client, the Project application provides a means to group data and users from
different groups, such as Engineering, Supplier, and Customers, and allow configuration of access rules
based on this grouping. This is an easy way to organize your data and implement the access control
based on a business project or program's security requirements.

Using the Active Workspace client, you can use the PROJECTS tile to create projects and programs and
manage your project teams by correlating groups of users, potentially at different physical sites, with
your product data. However, you must use the rich client to delete projects.

Example of a typical project

A project comprises a group of users each having one or more roles. For example, this project consists of
an administrator, a project manager, two designers, and two analysts.

Control access to your project data

There are several measures you can use to control access to your project data:

Active Workspace Administration, Teamcenter 2406 3-15

• When creating a project, you can use the Project Category field, which allows you to restrict a user's
access to objects based on the category of the project. For example, a user assigned to the Supplier
project category would be unable to view proprietary information. The default project categories are
Internal, Partner, and Supplier.

• Designating team members as privileged is one step in the process of granting access to users to
allow them to assign data to and remove data from projects and programs.

Understanding project team roles

In Active Workspace, as Project Administrator or Team Administrator, you use the PROJECTS tile to
manage your project teams. For example, you can add groups, roles, and users to your project by
selecting them from your organization.

Depending on your role, you can perform the following project-related tasks in Active Workspace:

Team role Definition

Project Administrator Teamcenter user with privileges to administer project teams in

Active Workspace.
Users in the Project Administrator role can:

• Modify the properties on the project.

• Add and remove team members to projects in which the

project administrator is also a member.

• Assign Privileged, Non-privileged, and Team

Administrator status to any project team member.

Note:
You can designate multiple team administrators for
each project. This is often necessary to balance resource
management tasks for large projects.

Team Administrator Project team member with privileges to add and remove
project members.
Users in the Team Administrator role can:

3-16 Active Workspace Administration, Teamcenter 2406

Team role Definition

• Add and remove team members to projects in which the

team administrator is also a member.

• Assign Privileged, Non-privileged, and Team

Administrator status to any project team member.

Note:
You can designate multiple team administrators for
each project. This is often necessary to balance resource
management tasks for large projects.

Privileged team members Project team members with privileges can view their projects
and their team members. They can also assign or remove
objects to or from their projects.

Non-privileged team Project team members without privileges can view their
members projects and their team members.

Manage project teams

As an administrator of a project team, you can select a project and view your team members. You can
also add and remove users, roles, and groups.

Select a project and view your team members

1. As Project Administrator or Team Administrator, select a project to display the Team Members
section.

A team member can have one of four types of status:

• Project Administrator

• Team Administrator

• Privileged

• Non-privileged

2. To view your project's team members, expand the roles listed in the Team Members section.

Active Workspace Administration, Teamcenter 2406 3-17

Example:
In this example, when you expand the role, you see the user whose status on the project is
Project Administrator.

Add a user, role, or group to a project

1. From the Team Members section, click Add to open the Organization panel.

2. Use the filters to locate the user, role, or group you wish to add to the project.

3. Select the user, role, or group. Click Add to add the user, role, or group to your project team. The
addition appears in the list of team members.

Remove a user, role, or group from a project

From the Team Members section, click on the user, role, or group. Click Remove .

Note:
You cannot remove a role or a user from within a group in the Team Members section. You can
only remove the group.

Add users, roles, or groups to multiple projects

1. Log on as Project Administrator or Team Administrator.

2. Click Selection Mode to enable multiple selections.

3. Select the projects to which you want to add the user, role, or group.

3-18 Active Workspace Administration, Teamcenter 2406

Click Add Team Members above the project list or click More commands > Manage > Add
Team Members to open the Organization panel.

4. Use the filters to locate the user, role, or group you wish to add to the projects. Click Add.

The user, role, or group is added to each of the selected projects.

5. Click Selection Mode again to disable the mode.

Configuring owning program

You can set or change an owning program on an object to control access to data. Once you configure
owning program, users can set or change owning programs for instances such as:

• No owning program is set on data.

• A user mistakenly assigned data to the wrong program.

• Government policies force data to be tagged with a different owning program.

• Addressing a partner program change request.

To view the Owning program tab, you must set the AWC_Project_showOwningProgramTab preference
to true. Owning program can be set on the object only if the autoAssignToProject extension is enabled
on the object type.

Active Workspace Administration, Teamcenter 2406 3-19

Note:
If you use the Aerospace and Defense template, the autoAssignToProject extension is enabled by
default.

For more information on owning program and the autoAssignToProject extension, refer to Access
Management Using Projects and Programs in the Teamcenter documentation.

Configure project-level security

You can configure project-level security for selected objects at the item level and have it available
to all revisions under the item. When selecting either This Revision or All Revisions, the following
preferences should be set to the default value to ensure security is applied correctly.

• TC_Security_Apply_To_Visible

Activates the visibility of the Apply To project option. When set to true (default), the Apply To project
option is available.

• TC_Security_Apply_To_Item_Revision

Controls the behavior of the Apply To project option. When set to true, security is applied to item
revisions. If set to false (default), security is applied to items.

3-20 Active Workspace Administration, Teamcenter 2406

Also, you can hide the project section from the Add panel for items. To do this, modify your data model
configuration in Teamcenter using the Business Modeler IDE and set the Fnd0EnableAssignProjects
constant to False.

For more information about modifying business object constants, see Configure your business data
model in BMIDE.

Configure project data template folders

Users can view their assigned projects in the Project Data folder in the Explorer location. The Project
Data Templates folder appears for administrators in the Explorer location.

By default, one Project Template is included and is set as the active template. The active template
defines the project information displayed for all projects for all users. As an administrator, you can
configure custom template folders to define the project information that appears for your users. Only
one template at a time can be set as the active template.

Create a project data template

1. Access Explorer by clicking the EXPLORER tile or Explorer in the global navigation bar.

2. Select the Project Data Templates folder.

3. Click Add Project Data Template .

The Add Project Data Template panel opens.

Active Workspace Administration, Teamcenter 2406 3-21

4. In the Add Project Data Template panel, enter a Name for the template. Optionally, you can enter
a Description and choose to select the new template as the active template.

5. Click Add.

The newly created project data template folder appears under the Project Data Templates folder.

6. Select the new template folder.

7. Click Add Active Folder .

8. In the Add Active Folder panel, enter a Name for the folder. Optionally, you can enter a
Description.

9. Click Add.

10. Select the new active folder.

11. On Rules tab, click Edit .

12. Choose one of the following ways to define the project criteria and filters for the folder.

Advanced Enter all applicable values, and then click Search to define the criteria and filters
for the folder.
Project Select a project to use as a reference for the criteria of the folder. You can
Reference apply additional filters to refine the results. Updating filters does not impact the
original reference project. The Project Reference option is a Solr-based query
and is updated with the indexing synchronization flow. If you use this option,
when users add an object to a project, it may take a few minutes until the
synchronization flow is complete, for the added object to be categorized into the
applicable object type folder in the project folder.

You can view the applied criteria and filters in the Overview.

13. Click Save .

14. Add any additional folders to the template as applicable.

If the template is set as the active template, the template criteria and filters are applied to all
projects in the Project Data folder.

15. If there are object types that you do not want included in the project folders, you can add these
object types to the AWC_Exclude_Types_From_More_Project_Data_Collection preference.

3-22 Active Workspace Administration, Teamcenter 2406

Set a project data template as the active template

You can set any template as the active template by clicking Edit and selecting Is Active Template.

Delete a project data template

You can delete any template by clicking More commands > Edit > Delete.

Managing users' access to data using Access Manager

Controlling access to data objects

In addition to licensing and authentication, another way to control information access for users, both
internal and external, is by configuring Access Manager rules. These rules control access by user, group,
role, organization, and workspace.

Access Manager is available only in the Active Admin workspace in Active Workspace for users in the
dba group and DBA role.

Access Manager is also available in the Teamcenter rich client.

Using Access Manager rules

View Access Manager rules

From the Access Manager page, select a rule from the AM rule tree, for example, Has Application to
view the following areas:

Active Workspace Administration, Teamcenter 2406 3-23

• Properties, which includes the condition name (Has Application) and value (Any).

• Named ACL, which displays the access control list (ACL) name (AdminObjectACL).

• Object Access Control List, which displays the ACL that lists the privileges granted to the specified
accessor types. For example, World is granted Read ( ) access, but it is denied Write ( ) and Delete
( ) access.

• Attribute Access Control List, which displays accessors and accessor types for the specified property
groups.

Add an Access Manager rule

1. Select a node from the AM rule tree, such as Has Application.

2. Click Add in the results panel toolbar.

The Add Rule panel is displayed.

3. On the Add Rule panel, select the condition, for example, Has Attribute.

4. Enter a value.

The value is populated based on the selected condition. However, since the Has Attribute
condition does not have a value, you can enter any value. For example, Dataset:object_desc=test.

5. (Optional) Select an ACL Name, for example, AdminObjectACL.

To add additional rules, select Pin Panel .

3-24 Active Workspace Administration, Teamcenter 2406

6. Click Add to add the new rule under the selected parent node.

By default, the new rule appears as the last node under the parent.

Reorder Access Manager rules

From within the AM rule tree, you can reorder your rules and save your changes.

Reorder action Icon Description

Cut Cut a single or multiple rules.
Paste Paste the single or multiple rules you have cut.
Selection Mode Turn on selection mode for making multiple rule selections.
Move Up Move a selected rule up the AM rule tree.
Move Down Move a selected rule down the AM rule tree.
Move to Top Move a selected rule to the top of the AM rule tree.

Example — Move a single AM rule up the AM rule tree

1. From the AM rule tree, select a single rule, for example, In Invisible Program.

2. Click Move Up two times to position the rule directly below In Current Program.

Active Workspace Administration, Teamcenter 2406 3-25

3. Click Save .

Edits to the AM rule tree persist for that session until changes are committed to the database using
the Save command.

Delete an Access Manager rule

Note:
Some rules cannot be deleted.

1. From the AM rule tree, select either a single rule or multiple rules to delete.

2. Click Delete from the work area toolbar.

Managing access control lists

What are access control lists?

Access control lists (ACLs) contain a list of accessors and the privileges granted, denied, or not set for
each accessor. Accessors are collections of users who share certain common traits, such as membership
in the group that owns the object or membership in the project team. Just as rules have a precedence
weighting in the rule tree, accessors have a precedence weighting in the ACL.

3-26 Active Workspace Administration, Teamcenter 2406

Create a new ACL name

1. Click Manage ACL to display the Manage ACL panel.

2. From the Create New ACL section, enter a unique ACL name in the ACL Name field.

3. Click Create.

You can confirm the new ACL name in the ACL section by filtering on the new name.

Edit an ACL

1. Select the condition for the ACL you want to edit, for example, In Project.

2. From the condition information page, click Edit .

You can edit the values in the Properties and Object Access Control List sections.

3. Perform one or more of the following functions on an ACL.

Function Icon Description

Add Add an access control entry.
Remove Remove an access control entry.
Allow All Allow access to all privileges for the selected row.
Deny All Deny access to all privileges for the selected row.

Active Workspace Administration, Teamcenter 2406 3-27

Function Icon Description

Reset Reset the selected row to the last saved values for the
privileges.
Clear All Clear all privileges of the selection.
Selection Mode Turn on selection mode for making multiple accessor
selections.

4. Click Apply to save your ACL updates.

Delete an ACL name

Certain ACL names cannot be deleted. Refer to your Teamcenter system log for additional information.

1. From the results panel toolbar, click Manage ACL to display the Manage ACL panel.

2. From the ACL section select the existing ACL to delete.

3. Click Delete .

Import and export Access Manager rules

Why import and export my Access Manager rules?

Access Manager now allows you to import and export your rule tree in Active Workspace. This helps you
to easily:

• Distribute access rules to other Teamcenter sites.

• Back up your rule tree.

• Restore your local rule tree.

Import an Access Manager rule tree

You can import your Access Manager (AM) rule tree from within Access Manager. Your imported AM rule
tree replaces the current one.

Prerequisites

Before importing a rule tree, you must ensure schema compatibility. To successfully load a new rule tree
from a file, the importing site must have the same types, roles, and groups as those referenced in the
rule tree file. If there is any incompatibility, the import operation ends and an error message appears. To
resolve incompatibility, you can import your organization data and then load your rule tree.

3-28 Active Workspace Administration, Teamcenter 2406

Procedure

1. From the results panel toolbar, click Import to display the Import dialog box.

This command is only enabled in non-edit mode.

2. Click Choose File to select the XML rule tree file that you want to import.

3. Click Import.

A progress indicator is displayed during import.

Export an Access Manager rule tree

You can export your Access Manager (AM) rule tree in XML format from within Access Manager.

Procedure

1. From the results panel toolbar, click Export to display the Export dialog box.

This command is only enabled in non-edit mode.

2. By default, the rule tree is given a named based on the date. You can change the file name to one
that fits your organization's file naming convention.

3. Click Export.

Active Workspace Administration, Teamcenter 2406 3-29

The file is downloaded based on your default browser settings, for example, to your Downloads
folder.

3-30 Active Workspace Administration, Teamcenter 2406

Administration data is data within the Teamcenter site database that defines:

• The behavior of the site.

• Who has access to information in the database.

Administration data in the following categories is maintained using a client such as the rich client or
Active Workspace. This data is not contained in Business Modeler IDE projects, nor in solution templates:

Access Manager Preferences Saved queries Units of Measure

Logical Objects Project Stylesheets Workflow
Organization Revision Rules Subscriptions

You can use administration data reporting capabilities to generate interactive reports of these
categories of administration data, which you can use to analyze and troubleshoot a site, and to compare
differences in data between environments.

You can use administration data export and administration data import to copy and paste
administration data across Teamcenter environments.

Active Workspace Administration, Teamcenter 2406 4-1

To safeguard functionality and data integrity in a production environment, separate environments are
often created for purposes of development, training, patch testing, and troubleshooting. The ability to
report and analyze administration data, and the ability to export and import administration data across
environments, helps in maintaining these environments.

Administration data reporting capabilities have analogous data model element reporting capabilities
accessible from within the Business Modeler IDE.

Tools for managing administration data

You can invoke tools for managing administration data from the command line and, to a lesser extent, in
the Teamcenter Environment Manager (TEM).

Tool function Command Line tool TEM tool

Export administration data from the admin_data_export Manage
current site into an export package file. Administration Data
panel export options.
Import administration data from an admin_data_import Manage
administration data export package into the Administration Data
current Teamcenter site. panel import options.
Generate an interactive report of generate_admin_data_report None.
administration data contained in a site or

4-2 Active Workspace Administration, Teamcenter 2406

Tool function Command Line tool TEM tool

in an administration data export package
file.
Generate an interactive report of generate_admin_data_ None.
differences between the administration compare_report
data in an administration data export
package file and either the current site or
another package file.

Example tasks and processes for managing site behavior

The following task examples illustrate how you can use interactive administration data reports along
with administration data export/import utilities to manage your Teamcenter sites.

Task General process

Analyze how a site is Generate an interactive report of administration data at the site and
configured and troubleshoot review the report in any web browser.
configuration issues.
Ensure that one site is Export all administration data from one site and import it to another.
configured the same as
This capability is useful when you must ensure certain administration
another.
data at one site exists at another site, such as a test site and a training
site or during site consolidation.

Active Workspace Administration, Teamcenter 2406 4-3

Task General process

Spread workload for a Set up several isolated sites for work group teams to work on particular
project, such as adding parts of a development project. A team can make changes in its site
or modifying multiple and then export the changed (partial) administration data. You can
workflows, among teams. then consolidate the changes by importing the administration data
from the multiple partial export packages into one site, such as a
sandbox site for final testing.

Determine the cause Generate a report that compares the administration data from a
of differences in site source site with the administration data in a target site. Then analyze
behavior and troubleshoot the report of differences in administration data to determine the cause
configuration issues. of differences in site behavior.
You can also use the report to provide information to an administrator
at a different site.

Determine when a particular Review a site's administration data import history report to track
change was introduced to a impacts of importing administration data over time. This report is
site. automatically updated upon each successful administration data import
to the site.

4-4 Active Workspace Administration, Teamcenter 2406

Reconcile differences in administration data between Teamcenter

sites
You may need to determine why two sites behave differently, or may want to ensure that the
administration data is the same at both sites to allow consolidation of data. Use the following process to
reconcile administration data between two sites.

1. Export the administration data from both sites.

2. Generate an administration data comparison report.

The report shows the areas that differ between the sites for each type of administration data.

3. View the comparison report and analyze the differences.

4. After you determine the administration data that requires modification at a target site, import the
data from the source administration data package. Set the appropriate merge options during the
import to ensure you get the only the desired data modification.

Caution:
When you export and import administration data between sites, it is important that the schemas
for the administration data and any related objects involved in the transfer are the same at both
sites.

Example:
Given a situation where:

• A custom business object type exists in the schema at an exporting (source) site, but not at the
importing (target) site.

• A revision rule included in the administration data export refers to an instance of the custom
business object.

Then:

Active Workspace Administration, Teamcenter 2406 4-5

• The administration data import succeeds, but errors occur during activities involving the
revision rule due to the nonexistent custom business object.

Exporting administration data

Why would I export administration data?

Export administration data from a site into an administration data export package, which you can use
when you want to:

• Configure a target site the same as the source site.

• Export administration data from a test site, so you can import it to a production site.

• Collect information on a site, so you can compare it to another site.

• Export partial administration data from multiple developers into a source code management (SCM)
system for compilation into a comprehensive set of administration data.

You can use either the admin_data_export command line utility or the Teamcenter Environment
Manager (TEM) to export administration data into an administration data package. Procedures in the
TEM vary for partial export and full export.

Note:
It is important to be aware of the considerations for partial export of administration data.

Export administration data using the admin_data_export utility

Note:
It is important to be aware of the considerations for partial export of administration data.

Export administration data using the admin_data_export utility

At a Teamcenter command prompt, run the admin_data_export utility.

4-6 Active Workspace Administration, Teamcenter 2406

Tip:
When the export completes, you may want to use the generate_admin_data_report utility to
generate a report of the site administration data contained in the package.

Export full administration data using TEM

You can select the categories of data to export by using the Full export option in Teamcenter
Environment Manager (TEM).

1. Start TEM.

a. In the Maintenance panel, select Configuration Manager and click Next.

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

configuration and click Next.

2. Select the configuration for the site where you want to export the administration data file and click
Next.

3. In the Feature Maintenance panel, under Teamcenter Foundation, select the Manage
Administration Data option and click Next.

4. In the Manage Administration Data panel, select the Full export option and click Next.

5. In the Full Administration Data Export panel, select the administration data package and the
categories to export and click Next.

a. Click the ... button to the right of the Administration Data Package box to browse to the
location where you want to place the administration data package.

b. Select the administration data categories to export and click Next.

6. In the Teamcenter Administrative User panel, enter the logon information for the Teamcenter
administrative user account and click Next.

7. In the Confirmation panel, review the choices and click Start.

Active Workspace Administration, Teamcenter 2406 4-7

On successful export, TEM packages the exported administration data to the specified packaging
directory. The export package contains the administration data in TC XML files that are used later for
importing into another Teamcenter environment.

Tip:
When the export completes, you may want to use the generate_admin_data_report utility to
generate a report of the site administration data contained in the package.

Export partial administration data using TEM

Note:
It is important to be aware of Considerations for partial export of administration data.

You can export specific administration data components using the Partial export option in TEM. You
select the specific instances of administration data by category, class, and specific attribute/value criteria.

However, each administrative data type supports only specific elements in partial export, but not all. For
example, Access Manager supports only Named ACL and Privilege elements to be exported partially,
but not rule trees.

Export partial administration data using TEM

1. Start TEM.

2. In the Maintenance panel, select Configuration Manager and click Next.

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

configuration and click Next.

4. Select the configuration for the site where you want to export the administration data file and click
Next.

5. In the Feature Maintenance panel, under Teamcenter Foundation select Manage

Administration Data and click Next.

6. In the Manage Administration Data panel, select Partial export and click Next.

7. Use the Partial Administration Data Export panel to specify the administration data to export.

4-8 Active Workspace Administration, Teamcenter 2406

a. Next to the Administration Data Package box click the ... button and browse to the location
where you want to place the administration data package.

b. From the Category Name list, select the administration data category to export.

c. From the Export list, select the administration data class to export.

d. Edit the table contents to refine the administration data that is exported.

A. Type the Attribute and Value pair.

Depending on what you select from the Export list, the system may supply an entry for
the Attribute.

B. To add rows for additional attribute/value pairs, click Add and select the Boolean
Operator to define how the attributes are added.

To delete an attribute/value pair, select a row from the table and click the Remove
button.

C. Click Next.

8. In the Teamcenter Administrative User panel, enter the logon information for the Teamcenter
administrative user account.

9. In the Confirmation panel, review the choices and select Start.

On successful export, TEM packages the exported administration data to the specified packaging
directory. The export package contains the administration data in TC XML files used later for importing
into another Teamcenter environment.

Tip:
When the export completes, you may want to use the generate_admin_data_report utility to
generate a report of the site administration data contained in the package.

Examples of partial export attributes and values using TEM

Following are some example attributes and values for partial administration data export using
Teamcenter Environment Manager. Depending on your selection from the Export list, the system may
supply an entry for Attribute. These are examples only. The attributes and values listed here may not
match what you have in your system.

Active Workspace Administration, Teamcenter 2406 4-9

Category name Export Attribute (example) Value (example)

Access Manager Named ACL ACL_Name System
Privilege Privilege_Name READ
Organization Discipline discipline_name *
Group name Engineering
License Server fnd0name *
Person user_name *
Role role_name Designer
Site name *
Volume user_name *
Discipline volume_name volume
Preferences Preferences by Category Category Name (supplied) Change Management
Preferences by Group Group Name (supplied) Engineering
Preferences by Preference Preference Name (supplied) HiddenPerspectives
Name
Preferences by Role Role Name (supplied) Designer
Preferences by User User Name (supplied) user0001
Project Project project_id *
Revision Rules Revision Rule object_name *
Saved Queries Saved Query query_name *
Stylesheets Stylesheets by Preference Name (supplied) *SUMMARYRENDERING
Name
Stylesheets by Stylesheet Name (supplied) Item*
Name
Subscriptions Subscription subscriber *
Workflow Named ACL ACL_Name Vault
Privilege Privilege_Name PROMOTE
Workflow Templates by Name (supplied) Quick Release
Name

Considerations for partial export of administration data

General considerations

• To export only part of an administration data category, you must specify input criteria that identify the
data you want to export. Prepare your criteria before beginning the export.

4-10 Active Workspace Administration, Teamcenter 2406

• By default, partial exports do not include referenced user information. To understand some
implications of not including referenced user information, read and understand the description for
the -session_options argument option opt_traverse_ref in admin_data_export before performing
the administration data transfer.

• With any partial export, the Access Manager privileges are always exported in order to maintain the
data integrity.

• Partial export of an Organization tree is supported bottom-up and not top-down. For example, if you
have the following tree and you are exporting the group1 group partially, the complete tree may not
be exported. But if you export the user1 user partially, the complete tree is exported.

group1
- role1
- user1

Input criteria for a partial export: class name{attribute=value}

To export partial administration data, you must specify input criteria that identify the data you want to
export. The specification includes:

• Administration data class name.

Note:
If you are specifying a partial export using TEM, the class name is understood by the system
when you select an option from the Export list.

• The real name (not the display name) for an attribute of the named class.

Note:
If you are specifying a partial export using TEM, depending on your selection from the Export
list, the system may supply the attribute name, in which case the display name is shown.

• The value of the named attribute.

What are the classes associated with administration data?

Not all categories of administration data are associated with classes, but many are. The following table
lists associated classes for commonly partially-exported categories of administration data.

Active Workspace Administration, Teamcenter 2406 4-11

Administration data type Associated class

Access Manager AM_ACL
Organization
Discipline Discipline
Group Group
License Server Fnd0LicenseServer0
Person Person
Role Role
Site POM_site_config
User User
Volume ImanVolume
Project TC_Project
Revision Rules RevisionRule
Saved Queries SavedQueryCriteria
Subscriptions ImanSubscription

How can I find the real names of attributes?

Following are some tools you can use to look up the real names of attributes:

• Query Builder

Allows you to build queries on classes and their attributes.

For example, following is a query on the Access Manager class (ACM_ACL) showing its attributes:

• Business Modeler IDE

Displays the Teamcenter classes and their attributes in the Classes view of the Advanced perspective.
You can also see the corresponding business objects and their properties in the Business Objects
view.

4-12 Active Workspace Administration, Teamcenter 2406

Following is a display of the Access Manager class (ACM_ACL) in the Classes view:

• taxonomy utility

Lists the classes in the Teamcenter system and their attributes. To output the list to a file, run the
following from a Teamcenter command prompt:

taxonomy -f=classes_and_attributes.txt

Following is an excerpt of the output for the Access Manager class (ACM_ACL):

[ 1]<-->[AM_ACL] app [AM]

Class is NOT exportable.

POM class definition for: AM_ACL

application name: AM
Number of super classes: 1
Super class : POM_object
Number of Attributes: 5

Attribute 1 Name : ACE_Ids

Type : POM_untyped_reference
...
Attribute 2 Name : ACE_Ids_togo
Type : POM_untyped_reference
...
Attribute 3 Name : ACL_Flag
Type : POM_string
...
Attribute 4 Name : ACL_Name
Type : POM_string
...
Attribute 5 Name : acl_loaded
Type : POM_logical
...
Number of indexes : 0
Class size in bytes: 171

Active Workspace Administration, Teamcenter 2406 4-13

How can I find attribute values?

Generate an administration data document report. Review the report to see all the administration
data attributes and their values.

Note:
The report shows attribute display names, but not attribute real names.

Importing administration data

Why would I import administration data?

Import administration data previously exported from a source site into a target site when you want to:

• Configure the target site the same as the source site.

• Move administration data configured on a test environment into a production environment.

When importing administration data, you can use merge options to control whether the source or target
takes precedence.

Before actually importing data, you can perform a dry run import, and then review the dry run report to
analyze the potential impact and resolve any conflicts.

You can perform the dry run import, and perform the actual import, using either the
admin_data_import utility or using Teamcenter Environment Manager (TEM).

Perform a dry run import of administration data using TEM

Using an administration data package file that is the output of exporting administration data from a
source site, you can perform a dry run import to a target site to see the impact before actually importing
data. You can perform the dry run import using the admin_data_import utility or using TEM.

Perform the dry run data import using Teamcenter Environment Manager

1. Start TEM.

a. In the Maintenance panel, select Configuration Manager and click Next.

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

configuration and click Next.

2. Select the configuration for the site where you want to import the administration data file and click
Next.

4-14 Active Workspace Administration, Teamcenter 2406

3. In the Feature Maintenance panel, select the Manage Administration Data option under
Teamcenter Foundation and click Next.

4. In the Manage Administration Data panel, select the Dry run import option and click Next.

5. In the Dry Run Import Administration Data panel, click the ... button in the Administration Data
Package box and select the administration data package. Click Next.

6. In the Import Merge Options panel, select the merge option for each category and click Next.

7. In the Teamcenter Administrative User panel, enter the logon information for the Teamcenter
administrative user account and click Next.

8. In the Confirmation panel, review the choices and click Start.

9. In the Install panel, monitor the Overall Progress or select Show Details to see the install status.

View the Administration Data Import (dry run) report

To view a dry run report, after the run completes, browse to the following location:

TC_ROOT\logs\admin_data_import_history\Import_date-and-time\[Link]

The following image shows the summary page of an example partial administration data import dry run
report. In an actual report, you can click links to navigate through the report.

Active Workspace Administration, Teamcenter 2406 4-15

Perform a dry run import of administration data using the

admin_data_import utility

Perform the dry run data import using the admin_data_import utility

At a Teamcenter command prompt, run the admin_data_import command line utility with the -dryrun
argument.

Note:
Use the -mergeOption argument to specify the merge options to set for each data type.

View the Administration Data Import (dry run) report

To view the dry run report, after the run completes, browse to the following location:

TC_ROOT\logs\admin_data_import_history\Import_date-and-time\[Link]

The following image shows the summary page of an example partial administration data import dry run
report. In an actual report, you can click links to navigate through the report.

Import administration data using TEM

Using an administration data package file that is the output of exporting administration data from a
source site, you can import administration data to a target site. You can perform the import using the
admin_data_import utility or using TEM.

4-16 Active Workspace Administration, Teamcenter 2406

The type of administration data that you can import is determined by what the import package contains.
If multiple categories of data are in the file, you can select the categories that you want to import.

1. Start Teamcenter Environment Manager (TEM).

a. In the Maintenance panel, select Configuration Manager and click Next.

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

configuration and click Next.

2. Select the configuration for the site where you want to import the administration data file and click
Next.

3. In the Feature Maintenance panel, select the Manage Administration Data option under
Teamcenter Foundation and click Next.

4. In the Manage Administration Data panel, select the Import option and click Next.

5. In the Import Administration Data panel, click the ... button to the right of the Administration
Data Package box to select the administration data package to import. Click Next.

6. In the Import Merge Options panel, select the merge option for each category and click Next.

7. In the Teamcenter Administrative User panel, enter the logon information for the Teamcenter
administrative user account and click Next.

8. In the Confirmation panel, review the choices and select Start.

9. In the Install panel, monitor the Overall Progress or select Show Details to watch the install
status.

10. After the import, access the results from the following location:

TC_ROOT\logs\admin_data_import_history\Import_date-and-time\[Link]

Note:
If your imported administrative package contains volume objects, you must postprocess the
imported volume objects for them to work properly.

Following is an example import report.

Active Workspace Administration, Teamcenter 2406 4-17

Import administration data using the admin_data_import utility

The type of administration data that you can import is determined by what the import package contains.
You can specify the administration data categories that you want to import.

Note:
If the administration data contains volume objects, you must postprocess the imported volume
objects for them to work properly.

1. To see the potential impact before actually importing data, perform a dry run import using either
using the admin_data_import utility or using TEM. Review the dry run import report and resolve
any conflicts.

2. At a Teamcenter command prompt, run the admin_data_import command line utility.

Use the -mergeOption argument to specify the merge options for each data type.

3. After the import, access the results from the following location:

TC_ROOT\logs\admin_data_import_history\Import_date-and-time\[Link]

4-18 Active Workspace Administration, Teamcenter 2406

Note:
If your imported administrative package contains volume objects, you must postprocess the
imported volume objects for them to work properly.

Following is an example import report.

Postprocess imported volume objects

If your imported administrative package contains volume objects, the volume's host and FMS
configuration must be updated with the importing site data.

1. Extract the [Link] file from the export package.

2. Open the file and update the host name and host path with the importing site's host name and
path.

3. Run the tc_attribute_bulk_update utility with the updated [Link] file

as the -inputfile argument value, for example:

tc_attribute_bulk_update -u=admin -p=password -g=dba

-inputfile=[Link] -import

4. Run the update_fms_configuration utility to update the FSC configuration, for example:

update_fms_configuration -u=admin -p=password -g=dba

-volumes=volume-names-in-comma-separated-list -fsc_id=fsc-id

Active Workspace Administration, Teamcenter 2406 4-19

Administration data import merge options

When you import administration data, for each category of administration data you must specify how to
handle data conflicts between the target (importing) site administration data and the source (exporting)
site data in the input package.

Following are the available merge options:

Override With Source

Overrides target objects with source objects. If an object exists in both environments, the attributes
on the object are taken from the source environment and updated on the object in the target
environment during the import. If an object in the source environment does not exist in the target
environment, it is imported to the target environment.

To avoid unexpected behavior that could result from mixing the rule tree contents, this is the only
option available for Access Manager administration data.
Keep Target
Keeps the target site’s administration data for all conflicts. If an object exists in both environments,
the object in the target environment is kept as-is. If an object in the source environment does not
exist in the target environment, it is imported to the target environment.
Choose Latest
Chooses objects that were last saved (based on the Last Saved Date property value). If an object
exists in both environments and the one in the source environment was saved last, the attributes on
the object in the source environment are used to update the attributes of the object in the target
environment during the import. If the object in the target environment was saved last, the attributes
on the object in the source environment are not imported. If an object in the source environment
does not exist in the target environment, it is imported to the target environment.
Choose Source for Unresolvable Conflicts
Chooses objects from the source environment if they were edited in the source environment and
not in the target environment since the last import. If an object exists in both environments, the
attributes on the object in the source environment are used to update the attributes on the object
in the target environment during the import. If an object was edited only in the target environment
and not the source environment since the last import, the object is left as-is at the time of import. If
an object in the source environment does not exist in the target environment, it is imported to the
target environment.

This option is not available for workflow administration data.

Choose Target for Unresolvable Conflicts
Chooses objects from the target environment if they were edited in the target environment and
not in the source environment since the last import. If an object was edited only in the target
environment and not the source environment since the last import, the object is left as-is at the
time of import. If an object in the source environment does not exist in the target environment, it is
imported to the target environment.

4-20 Active Workspace Administration, Teamcenter 2406

This option is not available for workflow administration data.

How you set import merge options depends on which method you use to perform the import, either
with the admin_data_import utility or with the Teamcenter Environment Manager (TEM):

• admin_data_import utility

Use the -MergeOptions argument to specify the merge option to use with each administration data
category.

• Import Merge Options panel in TEM

When you perform a dry run import or a regular import of administration data, the Import Merge
Options panel is displayed. Select the merge option you want to use with each data category.

Tip:
The default values on this panel are the actions that Siemens Digital Industries Software
recommends you use in most cases to avoid unintentional changes.

Style sheet import behavior

By default, each style sheet has two preferences set. For example, the summary style sheet has the
following:

[Link]=dataset-name
dataset-name.SUMMARY_REGISTEREDTO=type-name

If no preferences or only one preference is defined on a style sheet, then the style sheet is not in use.
During import, when the target database is missing one or both preferences for a style sheet, the import
is processed as if both preferences are defined in the target database.

The following tables show details of the import actions taken for the two preferences depending on
whether the preferences exist. The last column shows the target action when you select the import
option Choose Source or Choose Source For Unresolved Conflicts.

Preference import actions for Item dataset cases

Source preferences Target preferences Action Target preferences after Target action
import with source
option1
Item. SUMMARYRENDERING First time import, dataset Added at Item. SUMMARYRENDERING Add at target
does not exist. source site. site using import
package data.

1 When you select either the Choose Source option or Choose Source for Unresolved Conflicts option.

Active Workspace Administration, Teamcenter 2406 4-21

Source preferences Target preferences Action Target preferences after Target action
import with source
option2
ItemSummary. ItemSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO
Dataset does not exist Item. SUMMARYRENDERING Added at target No change. None.
site.
ItemSummary.
SUMMARY_REGISTEREDTO
Item. SUMMARYRENDERING Item. SUMMARYRENDERING First time Item. SUMMARYRENDERING Update using
created at source package.
ItemSummary. ItemSummary. source. ItemSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO
First time
created at
target not by
importing.
Item. SUMMARYRENDERING Item. SUMMARYRENDERING Change XML Item. SUMMARYRENDERING Update.
file content at
ItemSummary. ItemSummary. source. ItemSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO
Item. SUMMARYRENDERING Item. SUMMARYRENDERING Change XML Item. SUMMARYRENDERING Update using
file content at source package.
ItemSummary. ItemSummary. source. ItemSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO
Change XML
file content at
target.
Item. SUMMARYRENDERING Item. SUMMARYRENDERING Change XML Item. SUMMARYRENDERING Add using
file content at source package.
ItemSummary. ItemSummary. source. ItemSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO
Delete at
target.
Item. SUMMARYRENDERING Delete at None.
source.
ItemSummary.
SUMMARY_REGISTEREDTO
Item. SUMMARYRENDERING Delete at None.
target.
ItemSummary.
SUMMARY_REGISTEREDTO
Item. SUMMARYRENDERING Item. SUMMARYRENDERING Delete at Item. SUMMARYRENDERING None.
source.
ItemSummary. ItemSummary. ItemSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO Delete at SUMMARY_REGISTEREDTO
target.
Item. SUMMARYRENDERING Item. SUMMARYRENDERING Delete at Depends on SyncDelete SyncDelete
source. option.
ItemSummary. ItemSummary. ON: Delete
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO Change at
target. OFF: Keep
target.
Item. SUMMARYRENDERING Item. SUMMARYRENDERING Delete at Depends on SyncDelete SyncDelete
source. option. ON: Delete

2 When you select either the Choose Source option or Choose Source for Unresolved Conflicts option.

4-22 Active Workspace Administration, Teamcenter 2406

Source preferences Target preferences Action Target preferences after Target action
import with source
option3
ItemSummary. ItemSummary. OFF: Keep
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO target.
Item. SUMMARYRENDERING Item. SUMMARYRENDERING Added at Item. SUMMARYRENDERING Add using
source from source 2.
ItemSummary. ItemSummary. source 2. ItemSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO
Imported at
target from
source 1.
Item. SUMMARYRENDERING Item. SUMMARYRENDERING Change at -override_
target. with_ source
ItemSummary. ItemSummary. option, update
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO using source
package.

-choose_
source_ for_
unresolved_
conflicts option,
keep target.
Item. SUMMARYRENDERING Item. SUMMARYRENDERING Delete at Item. SUMMARYRENDERING Add using
target. source package.
ItemSummary. ItemSummary. ItemSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO

Preference import actions for Item Revision and Document Revision datasets cases
Source preferences Target preferences Action Target preferences after Target action with a
import source option4
ItemRevision. ItemRevision. Add at ItemRevision. Add at target site
SUMMARYRENDERING SUMMARYRENDERING source. SUMMARYRENDERING using import package
data.
ItemRevisionSummary. ItemRevisionSummary. Add at ItemRevisionSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO target. SUMMARY_REGISTEREDTO DocumentRevision
has it own stylesheet.
DocumentRevision. (DocumentRevision inherits DocumentRevision.
SUMMARYRENDERING ItemRevision’s summary SUMMARYRENDERING
style sheet.)
DocumentRevisionSummary. DocumentRevisionSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO

Modifying an administration data package

Normally, you do not need to alter the content of the administration data TC XML file. However, after
you export an administration data file, you can carefully modify the TC XML content of the file to provide
changes for specific sites or groups of sites.

3 When you select either the Choose Source option or Choose Source for Unresolved Conflicts option.
4 Choose Source option or Choose Source for Unresolved Conflicts option.

Active Workspace Administration, Teamcenter 2406 4-23

Note:
Because mistakes in the TC XML file can cause corruption and possibly data loss during import,
import of a modified file requires an authorization key. After passing the Manage Administration
Data self-paced course available from Learning Advantage, you can file a support case on Support
Center to obtain a key. The course provides the information necessary to avoid potential problems
when editing the TC XML content of an administration data file.

Following are rules for editing an administration data TC XML file:

• Ensure the uniqueness of elemId attributes across the TC XML file.

• Ensure the value of Boolean type attributes are Y (true) or N (false).

• Ensure the value of reference type attributes are formatted as:

#<elemId-of-the-GSIdentity-of-the-referenced-object>

• Ensure the value of date type attributes are in GMT format:

year-month-dayThour:minute:SecondZ

For example, for 09 September 2014 at [Link] AM (GMT), 2014-09-23T[Link]Z.

• Ensure the timestamp value is present.

• Ensure L10N attributes are list of values formatted as:

locale:M/S:M/A/P/R/I:sequence:[aA-zZ]^32:translation

A locale in the format of en_US: M/S is a master or secondary language.

M/A/P/R/I is the translation status.

The sequence number is 4 digits for multiple value attributes.

There are 32 characters reserved.

The rest is the translation, for example:

de_DE:S:A:0000::Proxy-Link,
en_US:S:A:0000::Proxy Link,
es_ES:S:A:0000::Enlace proxy,
fr_FR:S:A:0000::Lien proxy,
it_IT:S:A:0000::Collegamento proxy,
pt_BR:S:A:0000::Link de proxy

4-24 Active Workspace Administration, Teamcenter 2406

• When editing the attributes that are part of the candidate key, the GSIdentity label of the object, and
the label of the objects that reference the object, must be updated accordingly.

• Ensure all required attributes for the administration object have values.

• For out-of-the-box administration objects, a user's home, mailbox_folder, and newstuff_folder

attributes must not be added. Also, a dataset rev_chain_anchor attribute must not be added. This is
true even though these are required attributes.

• After editing the file, validate the complete file content against [Link] file (low-level TC XML
schema) located in the TC_DATA directory to ensure the XML is valid.

Import a modified administration data package

Because mistakes in the TC XML file can cause corruption and possibly data loss during import, import of
a modified file requires an authorization key. You can obtain the key from Support Center after passing
the Manage Administration Data self-paced course available from Learning Advantage. The course
provides the information necessary to avoid potential problems when editing the TC XML content of an
administration data file.

1. In your Teamcenter environment, set the BULK_LOADER_AUTH_KEY environment variable to the

value of the authorization key.

This enables the bulk load capabilities that are used to import the modified package. If you do not
set this variable to a valid value, TEM returns an error message when you attempt to import the
modified package.

2. When importing the modified package in Teamcenter Environment Manager (TEM), navigate to the
Manage Administration Data page and select the Ignore package validation check box.

This enables bulk load functionality that bypasses certain validation checks.

Reporting administration data

What administration data reports are available?

Documentation, Comparison, Import (dry run), and Import (history) administration data reports show
detailed Teamcenter administration data for the data categories that are specified when the report is
generated. If an object is referenced by other objects, reports include a where-used table that indicates
the categories and objects that have references to the object. You can use any web browser to view and
interactively navigate through the reports.

Administration data report types

Documentation

Active Workspace Administration, Teamcenter 2406 4-25

Reports administration data for the current Teamcenter environment or for an administration data
export package.

For use in effectively administering your environment, generate a documentation report of your
environment administration data.

Example Teamcenter [version] Administration Data Documentation reports of a default installation

of Teamcenter foundation are available on Siemens PLM Support Center under the Programming
and Customization category. These example reports provide a reference without having to first
install Teamcenter. However, they do not contain an accurate representation of your individual
environment.
Comparison
Reports differences between administration data in two Teamcenter environments.
Import (dry run)
Reports changes in administration data that will occur due to importing an administration data
package to the current Teamcenter environment. Use a dry run import report to assess the effects of
importing administration data without changing the existing data.
Import (history)
Reports the administration data that was impacted by an import to the current Teamcenter
environment at a particular point in time. A separate report is generated for each import. The
report file contains the site name and a timestamp. You can use these reports to determine exactly
what and when changes occurred that may be affecting behavior in the environment.

Administration Data Documentation report

You can use interactive Administration Data Documentation reports to:

• Troubleshoot issues with configuration.

• Periodically review a production environment to ensure it complies with business objectives.
• Capture a snapshot of the configuration at a point in time for archiving or audit reviews.
• Train administrators.

Generate an Administration Data Report

Use the generate_admin_data_report utility to generate a report of site administration data.

• You can run the report for the current site or for an exported administration data package.
• You can report all Administration Data categories or only selected categories.

View an Administration Data Report

To view a generated report, browse to the output location and open the [Link] file.

4-26 Active Workspace Administration, Teamcenter 2406

The following image shows the summary page of an example report. In an actual report, you can click
links to navigate through the report to find summaries and details of administration data.

Administration Data Comparison report

You can use Administration Data Comparison reports to:

• Troubleshoot differences in business logic behavior by reviewing configuration differences between

two environments.
• Determine whether a new environment is configured the same as a reference environment.
• Prepare for site consolidation by comparing environments to see what is common and what is
different.
• Identify differences between a customer environment and an out-of-the-box Teamcenter
environment.
• Compare a baseline export of an environment to a later export of the same environment.

Generate an Administration Data Comparison report

To make the comparison, the utility requires an administration data export package from one
environment as a source, and either the local environment or another administration data export
package as a target. The report highlights differences between the source data and the target data.

Active Workspace Administration, Teamcenter 2406 4-27

If an object is referenced by other objects, the report includes a where-used table that indicates the
categories and objects that have references to a selected object in both source and target environments.

The report summary page shows all the administration data types included in the comparison and the
number of differences for each element present within the category. The report includes a glossary of
administration data categories and the elements available in each of the categories.

Use the generate_admin_data_compare_report utility to generate a report comparing a source

environment administration data export package file to either:

• The current environment

• Another administration data export package file.

View an Administration Data Comparison report

To view a generated report, browse to the output location and open the [Link] file.

The following image shows the summary page of an example comparison report. Differences are
highlighted in yellow. In a real report, you can click links to navigate through the report to find
summaries and details of administration data.

4-28 Active Workspace Administration, Teamcenter 2406

Example:
As you navigate to details of the report, you can easily identify even very small differences.
Permission difference in Access Manager.

Label difference in a Style Sheet.

Active Workspace Administration, Teamcenter 2406 4-29

Administration Data Import (dry run) report

You can perform a dry run import to a target site in order to generate a report of the potential impact
before performing the actual import.

Generate an Administration Data Import (dry run) report

Perform a dry run import using either

• The admin_data_import utility with the -dryrun argument

• Or the Dry run import option in Teamcenter Environment Manager (TEM).

View an Administration Data Import (dry run) report

To view a dry run report, after the run completes, browse to the following location:

TC_ROOT\logs\admin_data_import_history\Import_date-and-time\[Link]

The following image shows the summary page of an example partial administration data import dry run
report. In a real report, you can click links to navigate through the report to find summaries and details
of administration data.

Administration Data Import (history) report

You can use the interactive Administration Data Import (history) report for a site to:

• Track impacts of importing administration data.

• Determine when a particular change was introduced to a site.

4-30 Active Workspace Administration, Teamcenter 2406

Generate an Administration Data Import (history) report

An Administration Data Import (history) report is automatically generated after each successful import
of administration data. Imports can be performed using the admin_data_import command line utility
or Teamcenter Environment Manager (TEM).

View an Administration Data Import (history) report

To view an Administration Data Import (history) report, browse to:

TC_ROOT\logs\admin_data_import_history\[Link]

The following image shows the summary page for an import report selected from the three available
historic reports. For this import, the only imported administration data category was Organization.
Impacts are highlighted in blue. In a real report, you can click links to navigate through the report to find
summaries and details of administration data.

Active Workspace Administration, Teamcenter 2406 4-31

4-32 Active Workspace Administration, Teamcenter 2406

Relations are the associations between two Teamcenter objects. The Relations tab in Active Workspace
allows you to see all the relationships for a selected object.

Why configure relations?

You may want to change how relations are displayed to end users or change which relations are
displayed.

What do relations look like?

Following is an example of the Relations tab in Active Workspace.

How can I make changes?

You can configure aspects of relations' appearance and behavior using configuration files. These are
stored in the Teamcenter database as datasets, which are located using the following preferences:

• RV1_DARB_UI_configuration_file_name

Active Workspace Administration, Teamcenter 2406 5-1

• RV1_DARB_GraphStyle_file_name

• RV1_DARB_PresentationRule_file_name

1. Find the name of the dataset by getting the value of the config file preference.

2. Find the dataset by name using the advanced search functionality.

3. Make the necessary edits to the configuration file.

4. Save the changes.

Example:
In this example, the RV1_DARB_UI_configuration_file_name preference value is
RelationBrowserConf.

The RelationBrowserConf dataset is located using the Dataset Name query.

5-2 Active Workspace Administration, Teamcenter 2406

How can I edit the configuration files?

To edit the configuration files, you can:

• Download the file, edit it in a text editor, and then upload it back into Active Workspace.

• Edit them in place using the universal viewer.

OOTB, the universal viewer may not recognize the relation configuration file dataset type (Rv1XML) as
an editable file type and it will only show the generic dataset type icon in the PREVIEW section.

To tell the universal viewer how to open this file type, add Rv1XML.Awp0CodeViewer=Rv1XMLFile to
the preference.

This is because the Relations Configuration File dataset type's database name is Rv1XML and the
named reference for the XML file is Rv1XMLFile.

Active Workspace Administration, Teamcenter 2406 5-3

Now the universal viewer knows to open the configuration files with its code viewer.

What other preferences control the relation browser?

There are many preferences that can help you configure relations for your users. Their names begin with
Rv1_ to make them easy to find. Inspect each of these preferences and update their content if necessary.

Creating new views or updating existing views

A view is a group of objects and relations in the Legend panel.

5-4 Active Workspace Administration, Teamcenter 2406

The RV1_DARB_RelationBrowserViews.Relations preference lists the available views. You can update
this preference to add new views or update existing views.

The first view on this list is the default view. This preference is overridden by any other preference with
an object type name appended.

If you append the name of an object type to the preference, the list of available views changes for that
class of objects and all of its children. You can create as many of these preferences as you need. For
example, the RV1_DARB_RelationBrowserViews.[Link] preference controls
the list of views (and the default) for change revisions.

Example of configuring relations expansion

You can configure how the system expands the relations forward and backward, and also how many
levels. For example, when users open an object in the Relations tab, the system may automatically
expand the relations forward one level. If your users are not interested in confirming the data
attached by outgoing relations but rather confirming incoming relations, you can set the expansion
to automatically expand backward. Set the expansion of relations with the following preferences.

• RV1_DARB_Expand_All_1_Level_Command_Visible

• RV1_DARB_Expand_Incoming_Levels

• RV1_DARB_Expand_Outcoming_Levels

• RV1_DARB_Expand_Selected_1_Level_Command_Visible

Localize names that appear in a custom Relations view

No additional action is required to localize the names that appear in a custom relations view. If
you localize the Active Workspace client in the declarative definition ([Link] file) and the
Teamcenter TextServer, names in the Relations view are localized.

The file name for relation browser keys in the TextServer is relationshipviewer_text_locale.xml.
Relation browser uses a k_relations_keyword_ prefix to help promote unique keys throughout the
product.

Active Workspace Administration, Teamcenter 2406 5-5

Relation browser config file syntax

Appearance configuration limitations

The appearance configurations are limited to the color and the edge style (relation), the style of the
nodes is not configurable.

RV1_DARB_GraphStyle_file_name

The configuration file value stored in this preference uses the following options:

• PresentationRule

Defines rules for one type of object. It the object satisfies the conditions specified by the rule, the style
will be applied to the object.

This element has the following subelements:

• type

Specifies the type of object: node for object and edge for relation.

Note:
Styling is not supported for type node. For the node option, set the color from the
configuration defined in RV1_DARB_UI_configuration_file_name section as shown in this
topic.

• port

Specifies the port for relation.

• styleID

Specifies what style to apply. styleID must be the same as defined in the GraphStyle XML file. (The
name of the GraphStyle XML file is defined in the RV1_DARB_GraphStyle_file_name preference).

• Conditions

Specifies a condition value that must be satisfied before the style is applied to the object. The
condition value is a logical operator.

This element has the following subelements:

■ Property

5-6 Active Workspace Administration, Teamcenter 2406

Only used when the PresentationRule type is edge. Name specifies the relation type. Value
specifies the relation name.

For Property elements, only the equalTo operator is supported.

■ Type

Only used when PresentationRule type is node. Value specifies the name of the object.

Note:
Styling is not supported for type node. For the node option, set the color from the
configuration defined in RV1_DARB_UI_configuration_file_name section as shown in this
topic.

■ Conditions Operator

Specifies what conditions must be must before the style is applied. Valid operators are: and (all
rules must be met) and or (at least one of the rules must be met).

Valid operators for Type are equalTo and isTypeOf. When property is edge, only the equalTo
operator is valid.

RV1_DARB_UI_configuration_file_name

The configuration file value stored in this preference uses the following options:

• view name

Specifies the name of the view, for example, General.

• ruleName

Specifies the name of the dataset that implements the traversal logic of the view. The GenericRule
dataset is the default rule file.

• group name

Specifies if this is a list containing objects or relations. These lists are presented in the Relation
Controls section of the Relations browser.

The order of the objects filters is important. Your object is displayed using the first filter on the list
that successfully matches. The last filter in the objects section, Other, matches all objects because it
is associated with WorkspaceObject. It is there to ensure all objects receive some formatting. Do not
place any filters after the Other filter.

Active Workspace Administration, Teamcenter 2406 5-7

• filter name

Specifies the name of the relation or object name.

For example:

<filter name="Attach" parameterSet="Attach" color="(64,100,142)"/>

• parameterSet

Specifies the name of the parameterSet element in this configuration file. The parameterSet element
defines the Teamcenter objects and relations that map to the filter name.

• color

Specifies the display color of the object or relation.

5-8 Active Workspace Administration, Teamcenter 2406

© 2024 Siemens
6. Data sharing
Configuring and managing data sharing
Active Workspace offers users and administrators several ways to share Teamcenter data. Each of these
methods of sharing data has capabilities an administrator can manage.

• Briefcase lets users share Teamcenter data with connected and unconnected sites using TC XML and
Briefcase files.

• Multi-Site Collaboration lets users share and synchronize data in near real-time between Teamcenter
sites across the entire enterprise.

• PLM XML lets users share Teamcenter data with third-party applications using the open PLM XML
format.

• Bulk data migration tools let administrators exchange large volumes of data when populating test
environments.

• Advanced Multi-Schema Exchanger lets user with Active Architect privileges create mapping rules that
transform data when it is shared between Teamcenter sites that use different schemas.

Briefcase

Briefcase (on Windows or Linux), TC XML Import and Export, and Teamcenter Dispatcher Server (on
Windows or Linux) must be installed to access Briefcase features using Active Workspace

Each site that is importing or exporting Teamcenter data must have a Briefcase license. Each site using
the following optional import and export features must each also have an Advanced Multi-Schema
Exchanger license:

• Briefcase export and import dry run and validation capabilities

• Briefcase preview and compare capabilities

• Advanced Multi-Schema Exchanger

Contact your Siemens Digital Industries Software customer service representative for more information
on Briefcase licenses.

See Configure Briefcase file sharing to configure Briefcase capabilities.

Active Workspace Administration, Teamcenter 2406 6-1

Multi-Site Collaboration

Multi-Site Integration (on Windows or Linux) must be installed to access Multi-Site Collaboration
features using Active Workspace. Collaborating sites also need to be licensed to use Multi-Site
Collaboration.

Configure and monitor Multi-Site Collaboration status.

• Control the scope of remote Multi-Site Collaboration objects checked out and checked in by
users.

• Configure and use Multi-Site Dashboard to monitor the status of your Multi-Site federation.

PLM XML

PLMXML Export Import (on Windows or Linux), TC XML Import and Export, and Teamcenter Dispatcher
Server (on Windows or Linux) must be installed to access PLM XML features using Active Workspace.

See Configure PLM XML data sharing to specify the list of PLM XML object types that can be exported
and imported at your site.

PDX

The following features must be installed to configure and access PDX export features using Active
Workspace:

• PDX Export (on Windows or Linux)

• Teamcenter Dispatcher Server (on Windows or Linux)

• TC XML Import and Export

• Vendor Management. This feature provides the TIEPDXOptionSetDefault that is required to export
PDX files.

See Configure PDX data sharing to configure the PDX exporting capabilities.

Bulk data migration tools

Briefcase (on Windows or Linux), TC XML Import and Export, and Teamcenter Dispatcher Server (on
Windows or Linux) must be installed to access the Active Workspace bulk data migration tools.

See Bulk loading product data to extract data from one Teamcenter environment to copy to another.

6-2 Active Workspace Administration, Teamcenter 2406

Advanced Multi-Schema Exchanger

Teamcenter Dispatcher Server (on Windows or Linux), Advanced Multi-Schema Exchanger, and the
Advanced Multi-Schema Exchanger Service microservice must be installed to access Advanced Multi-
Schema Exchanger using Active Workspace.

To open and use Advanced Multi-Schema Exchanger with Active Workspace, the user must be logged on
to Teamcenter with privileges to use the Active Architect workspace.

General data sharing

See Configure report layout settings to configure the readability of data sharing export, import, and
validation reports.

Configure report layout settings

Data sharing export, import, and validation reports are formatted for readability with a
monospaced typeface. This layout is controlled by including the following settings in the
AWC_defaultViewerConfig.VIEWERCONFIG preference value:

Text.Awp0TextViewer=Text
XMLRenderingStylesheet.Awp0TextViewer=XMLRendering

Ensure the following values, which improve rendering of code, are not included in the
AWC_defaultViewerConfig.VIEWERCONFIG preference value:

Text.Awp0CodeViewer=Text
XMLRenderingStylesheet.Awp0CodeViewer=XMLRendering

Configure Briefcase file sharing

Ensure the following preferences are set to your organization's needs for exchanging objects using
Briefcase files.

Briefcase_checkout_supported_types
The list of types supported for Briefcase checkout.
Briefcase_configured_export_supported_types
The list of types supported for Briefcase configured export.
Briefcase_export_supported_types
The list of types supported for Briefcase export.
Briefcase_ownership_transfer_supported_types
The list of types supported for Briefcase site ownership transfer.

Active Workspace Administration, Teamcenter 2406 6-3

Briefcase_pkg_file_name
The default file name format for exported Briefcase files.
Briefcase_tcmail_notification
Specifies whether an email notification is sent when a Briefcase is created.

Configure PLM XML data sharing

Import and export objects of any type supported by the PLM XML schemas. Set the
AWC_PLMXML_export_supported_types preference to the list of PLM XML types that can be exported
and imported at your site. By default, AWC_PLMXML_export_supported_types is set to a list of
common PLM XML object types.

Configure PDX data sharing

Use the following procedures to configure PDX export using Active Workspace.

Prerequisites

• PDX export must be installed and licensed as described in Configuring and managing data sharing

• If you are upgrading from a version earlier than Teamcenter 2312, attach the customized [Link]
style sheet to the default PDX TIEPDXExportDefault transfer mode using the following steps.

Beginning with Teamcenter 2312, new Teamcenter installations have this style sheet attached to the
transfer mode by default.

1. In a Teamcenter command shell, use the plmxml_tm_edit_xsl utility to attach the style sheet to
the transfer mode, for example:

plmxml_tm_edit_xsl -u=tc-admin-user -p=password

-transfermode=TIEPDXExportDefault
-xsl_file=C:\TC\tcdata\data\[Link]
-action=attach

2. Use the utility to verify the style sheet is attached correctly, for example:

plmxml_tm_edit_xsl -u=tc-admin-user -p=password

-transfermode=TIEPDXExportDefault -action=list

The utility’s output should be similar to the following:

Original File Name is <[Link]>

6-4 Active Workspace Administration, Teamcenter 2406

Map objects and attributes

When you export Teamcenter data to PDX, the Teamcenter data is first exported as TcXML and then
transformed to PDX using XSLT.

Map your Teamcenter objects and their attributes to PDX objects and their attributes. Teamcenter
provides a default mapping of standard Teamcenter objects to PDX objects and a default style sheet for
transforming standard objects to PDX objects.

1. Identify any custom subtypes or data model changes.

2. If the default PDX transfer option set and transfer mode are not appropriate for scoping your
Teamcenter data for export to PDX, define an appropriate transfer option set and transfer mode.

a. Copy the default PDX TIEPDXExportDefault transfer mode file and rename the copy based on
your business processes.

b. Update the transfer mode to reference the information that must be exported in a PDX
package. For details on how to change the closure rule, filter rule, property set, and revision
rule, see Tc XML and PLM XML Configuration for Data Import and Export.

c. Set the opt_pdx_export option in the transfer option set used to export data to PDX to a value
of True. Only those option sets with this option set to True are displayed in the PDX Export
dialog box. (Transfer option sets delivered with Teamcenter have this option set to True by
default.)

3. Create a custom style sheet to transform the custom subtypes or data model differences.

a. Copy the standard PDX style sheet ([Link] file) located in the TC_DATA\data directory of
your Teamcenter installation.

Siemens Digital Industries Software recommends renaming the style sheet, for example,
[Link].

b. Change the style sheet to transform the information required in your exported PDX package.

c. If a style sheet with the same name as your updated style sheet is currently attached to the
transfer mode, detach it.

From a Teamcenter command window, enter the following command to determine the name
of any rules file attached to the transfer mode.

plmxml_tm_edit_xsl -u=user-id -p=password -g=group

-action=list -transfermode=transfer_mode_name

Where transfer_mode_name is the name of the transfer mode you are inspecting. Any rules
files attached to the specified transfer mode are listed.

Active Workspace Administration, Teamcenter 2406 6-5

If a rules file with the same name as your rules file is attached to the transfer mode, enter the
following command to detach the rules file.

plmxml_tm_edit_xsl -u=user-id -p=password -g=group

-action=detach -transfermode=transfer_mode_name
-xsl_file=rule_file_name

Where rule_file_name is the name of the rule file identified in the first step of this procedure.

d. Attach the new style sheet to the transfer mode, for example:

plmxml_tm_edit_xsl -u=user-id -p=password -g=group

-action=attach -transfermode=transfer_mode_name
-xsl_file=rule_file_name

Configure the PDX package details

Set the PDX_pkg_file_name preference at the exporting site. The following keywords are the only
keywords supported by PDX_pkg_file_name. The keywords are case sensitive and other values are
treated as constants.

PDX-string PDX-string is a string constant prefixed to the package file name of each exported
package. You can use this to identify the package as desired, such as by the originating
site.
ItemId Includes the item ID of the exported object as part of the package file name.
ItemName Includes the item name of the exported object as part of the package file name.
RevId Includes the revision ID of the exported object as part of the package file name.
TimeStamp Includes the time stamp information at the time the object is exported as part of the
package file name.

Deploy the transfer option set

Provide your users with the transfer option set name they must select when they are exporting a PDX
package, and verify your Teamcenter data exports to PDX as expected.

Modify exportable object types (Optional)

The values of the AWC_PDX_export_supported_types preference define the object types that can be
exported to PDX at your site. By default, AWC_PDX_export_supported_types is set to a list of common
object types. Update the values defined with that preference as necessary for your site.

6-6 Active Workspace Administration, Teamcenter 2406

Enable vendor filtering (Optional)

By default, users export vendor information (such as vendor contact and manufacturer parts
information) in PDX files. To allow the users to limit or exclude vendor information when exporting,
set the transfer option set's opt_vendor_select option to a value of True. When this option is set as
True, users can select specific (or no) vendors for which vendor information is exported.

Create mapping rules using Advanced Multi-Schema Exchanger

Using Advanced Multi-Schema Exchanger to create mapping rules

Use Advanced Multi-Schema Exchanger to create mapping rules to transform data when it is transferred
between Teamcenter sites using different schemas. You can create mapping rules for Item types in your
source schema. Create and deploy maps using the following process:

1. Acquire the source and target schemas describing the data being exchanged.

2. Create a mapping project in Active Workspace.

3. Create rules that map items and their attributes in the source schema to items and attributes
in the target schema.

4. Deploy the mapping rules by attaching them to the transfer modes used when transferring
the data.

Preparing for a mapping project

The following items are required for creating mapping rules using Advanced Multi-Schema Exchanger:

Source schema
The source schema describing the data being exchanged. This is a full JSON schema covering all
possible items and attributes. See Creating a JSON schema file to create a JSON schema file from
your Teamcenter database.
Target schema
The target JSON schema describing the data in the target database.

Creating and updating mapping projects

A collection of Advanced Multi-Schema Exchanger schema mapping rules is called a project. Create a
mapping project for defining the set of mapping rules required for exchanging data between two sites.

Active Workspace Administration, Teamcenter 2406 6-7

Start Advanced Multi-Schema Exchanger

To open and use Advanced Multi-Schema Exchanger with Active Workspace, you must be logged on to
Teamcenter as a user with privileges to use the Active Architect workspace.

• On the Active Architect workspace, click the Advanced Multi-Schema Exchanger tile. Advanced
Multi-Schema Exchanger opens with the most recent projects listed.

Create a mapping project

1. Click Add above the project list to create a project.

The Add Schema Map panel opens.

2. Specify a name for the project, select your source and target schema files, and click Add to save the
project.

Update a mapping project

Update a mapping project when your source or target schemas change or when you wish to rename the
project.

1. On the Active Architect workspace, click the Advanced Multi-Schema Exchanger tile. Advanced
Multi-Schema Exchanger opens with the most recent projects listed.

2. Select the project you want to update.

The project's properties are displayed.

3. Under Properties, click Edit .

4. Update the name of the project or the schema files as necessary and click Save Edits .

Mapping object types

With your project open in Advanced Multi-Schema Exchanger, click the Mapping tab to show the
Item Mapping category of the source schema. For example:

6-8 Active Workspace Administration, Teamcenter 2406

Object type mapping

1. Click the Mapping tab to show the categories containing the object types that can be mapped.

2. Click Item Mapping. A summary of the currently mapped object types and their attributes is
displayed in the Items and Attributes pane. (A new project has no types mapped.)

3. Select an object type for mapping.

• To create a new object type mapping, click Add in the Items and Attributes pane.

The Add Mapping panel opens.

• To edit an existing object type mapping, select the object type in the summary list and click Edit
.

The Edit Mapping panel opens.

4. In the From list, select an object in the source schema.

5. In the To list, select the target object. (Only valid target objects are listed.)

The source and target objects, and their attributes with default mappings appear in the panel.
By default, attributes in the source object are mapped to attributes in the target object when the
objects have the same name, length, and type.

For example:

Active Workspace Administration, Teamcenter 2406 6-9

6. Map (or remap) a source attribute by selecting it and then selecting the target attribute to which it
is to be mapped.

To avoid item ID conflicts, consider adding prefixes and suffixes to the target attributes as part of
the mapping. After mapping an attribute, set Function to "Prefix" or "Suffix", and specify a value, for
example:

7. After mapping an attribute, click Save (or Add for new mappings) to save the change.

Tip:
Click Pin Panel to keep the panel open as you map several attributes.

To remove the mapping for an object, select the item in the summary list and click Remove Mapping
.

Deploying mapping rules

Deploying mapping rules attaches the rules to the transfer modes used for transferring the data. Use the
following steps to deploy your mapping rules.

6-10 Active Workspace Administration, Teamcenter 2406

To deploy mapping rules, you must be logged on to as a Teamcenter administrator with DBA privileges.

1. Ensure that you have mapping rules for all object types.

2. Select the project in the Advance Multi-Schema Exchanger list of projects. Click Deploy in the
Deployment section.

3. Select the transfer mode set you are using to transfer the data.

4. Click Deploy.

You receive a report alert when the deployment is complete. Click on the alert to review the
details of the deployment. All recent alerts are available from the Subscription tile. Check the
SCHEMA_MAPPING message type to see all deployment reports.

Once deployed, the mapping rules are attached to the transfer mode. You can now use the transfer
mode to share data.

Detach rules from a transfer mode

Detach rules from a transfer mode as follows:

1. From a Teamcenter command window, enter the following command to determine the name of
the rule file attached to the transfer mode:

plmxml_tm_edit_xsl -u=Tc-admin-user -p=password

-g=group -action=list -transfermode=transfer_mode_name

Where:

Tc-admin-user, password, group

Logon credentials of a Teamcenter administrator with DBA privileges
transfer_mode_name
The name of the transfer mode with the attached rules

2. Use the following command to detach the rule file from the transfer mode:

plmxml_tm_edit_xsl -u=Tc-admin-user -p=password

-g=group -action=detach -transfermode=transfer_mode_name
-xsl_file=rule_file_name

Where:

transfer_mode_name

Active Workspace Administration, Teamcenter 2406 6-11

The name of the transfer mode with the attached rules

rule_file_name
The rule name identified in the first step

Manage Multi-Site

Specifying the scope of Multi-Site remote checkouts and checkins

Use the MultiSiteCICORule closure rule to control the scope of objects checked out and checked in
by users when they check out and check in remote objects managed by Multi-Site Collaboration. The
closure rule defines primary objects and the related secondary objects to be checked out or checked in as
well.

Update the closure rule definition to add other related objects to check out and check in automatically
with objects. For example, to automatically check out related item revision datasets, add a line to the
closure rule definition with the following values:

Clause Item Value

Primary Object Class Type CLASS
Primary Object ItemRevision
Secondary Object Class Type CLASS
Secondary Object Dataset
Relation Type RELATIONP2S
Related Property or Object IMAN_specification
Action Type PROCESS
Conditional Clause
Predicate

Multi-Site Dashboard

Multi-Site Dashboard provides a way to view the issues in your Multi-Site federation through charts,
graphs, and detailed object reports. Analyze and resolve these issues to reduce the number of errors and
time spent by users in attempting to transfer data or to perform other business tasks.

The data reported in Multi-Site Dashboard is gathered when running the data_report utility. The
dashboard identifies the following issues for the entire federation and for individual sites in the
federation.

• ID issues such as:

• Duplicate Item IDs, Item Revision IDs, or Keys (including multi-field keys)

6-12 Active Workspace Administration, Teamcenter 2406

• Item IDs, ItemRevision IDs, or keys that are not synchronized with the owning site.

• Item ownership issues such as:

• Items with multiple owning sites

• Items with no owning site

• Replicas with an owning site different than the primary item

• Object ownership issues such as:

• Objects with ownership different than the item

• Items and item revisions with inconsistent ownership

• Objects with ownership inconsistent with their parent

See Resolving Multi-Site issues for recommendations on resolving these Multi-Site Collaboration data
issues.

Viewing Multi-Site Dashboard issues

When you log on as a Teamcenter administrator, the Multi-Site Dashboard tile is available on the Active
Admin workspace home page.

Use the following guidelines for viewing Multi-Site Dashboard issues.

Viewing issues

When first opening Multi-Site Dashboard, the status from the most recently run report is displayed,
summarizing all issues across your entire Multi-Site federation. Hover over a chart to view the number of
issues of each type.

The lower half of Multi-Site Dashboard breaks down the different types of issues across the federation.
Change the value of Chart by to toggle between viewing issues by type or by site.

Return to the overall summary of issues across your Multi-Site federation at any time by clearing the
selection for all sites in the left pane.

Viewing objects with issues

Click a site name in the left pane to see a breakdown of the types of issues found at that site. To see a
further breakdown of an issue type, along with a listing of all objects with that issue, click one of the
charts.

Active Workspace Administration, Teamcenter 2406 6-13

Viewing report history

Click History to see the federation or selected site trends for each error type over previous runs of the
data_report utility. Select a different value for Runs to change the number of runs displayed. Hover over
charted data points for summaries from each run.

Configuring Multi-Site Dashboard

Multi-Site Dashboard presents the status for specified sites in your Multi-Site federation based on data
gathered when running the data_report utility. Configure and gather Multi-Site Dashboard data as
follows.

Define sites from which Multi-Site data is gathered

The Multi-Site sites from which data is gathered and reported must be specified with the
MS_dashboard_Supported_Sites option.

On the site from which reports are generated, add MS_Dashboard_Supported_Sites to the list of
Teamcenter site names for which you want data reported by Multi-Site Dashboard. This is also the list of
sites that are used with the data_report utility.

Run data reports

From a command line, use the data_report utility to gather and generate reports presented with
Multi-Site Dashboard. You can run this report manually or use your operating system to schedule it to
run at regular intervals.

• Run data_report on a site with access to the Teamcenter object database.

• Log on with administrator credentials when running data_report.

Following are some examples of using the data_report utility (not including required logon
information). See data_report for additional details.

To gather data and generate reports for all sites and the overall federation (as defined with
MS_Dashboard_Supported_Sites):

data_report

To gather data for a specific site:

data_report -site=site01 -f=collect_data

To generate reports for all sites and the Multi-Site federation using data previously collected:

data_report -f=generate_reports

6-14 Active Workspace Administration, Teamcenter 2406

Resolving Multi-Site issues

Following are guidelines for resolving issues identified by Multi-Site Dashboard.

Item ownership

Problem Solution

Item with multiple owning sites Decide which site is to be the owning site. To determine this,
run the item_report utility to compare the items on the different
sites.
Convert the appropriate item from a primary item to a replica
using ensure_site_consistency with the -f=recovery option.
Using -f=recovery will recover the SST dataset if the dataset
exists. If -f=recovery fails to convert the item to a replica, retry
the command using -f=offline_recovery in place of -f=recovery.

• If you do not have a TC XML meta file, use the form:

ensure_site_consistency -f=recovery
-mode=auto -real_owning_site=master_site

• If you have a TC XML meta file, use the option -mode=min or

-mode=full with -dir=meta_file_directory.

Item with no owning site Decide which site is to be the owning site. To determine this,
run the item_report utility to compare the items on the different
sites.
Convert the appropriate item from a replica to a primary item
using ensure_site_consistency with the -f=recovery option.
Using -f=recovery will recover the SST dataset if the dataset
exists. If -f=recovery fails to convert the item to a primary
item, retry the command using -f=offline_recovery in place of
-f=recovery.

• If you do not have a TC XML meta file, use the form:

ensure_site_consistency -f=recovery
-mode=auto -remote_site=replica_site

• If you have a TC XML meta file, use the option -mode=min or

-mode=full with -dir=meta_file_directory.

Inconsistent ownership replica From the owning site, run data_share to resend the data.

Active Workspace Administration, Teamcenter 2406 6-15

Duplicate IDs

Problem Solution

Duplicate Item ID or Key Avoid the ID conflict during import by using the item_rename
utility to rename the target site item.

Duplicate ItemRevision ID or Key Avoid the ID conflict during import by using the item_rename
utility to rename the target site item.

Inconsistent Item ID or Key From the owning site, run data_share to resend the data.

Inconsistent ItemRevision ID or Key From the owning site, run data_share to resend the data.

Object ownership

Problem Solution

Object ownership error Add the problem object UID to a UID list file named [Link] and
run the tcxml_ownership_recovery utility with the following
form:

tcxml_ownership_recovery
-inputuidfile=[Link] -action=flip
-targetsite=owning_site_id

Monitor data exchange transactions

You can use Data Exchange Transactions to view and analyze your organization's history of Multi-Site
and Briefcase transactions. Filter transactions based on completion status, exchange type, source and
target sites involved, and other factors. With these transaction records, you can:

• Drill down through charts and graphs to quickly diagnose data exchange failures

• Use the broad view of your data exchange activities to better identify patterns of failure across
multiple sites

• Analyze patterns and trends in data exchange usage to inform ongoing process improvements

The following types of transactions are recorded and reported.

Multi-Site
• Data shared and retrieved between sites

6-16 Active Workspace Administration, Teamcenter 2406

• Remote export and import operations made using the rich client

• Exports and imports made using the data_share command

• Transactions made using the data_sync command

Briefcase
All Briefcase import and export transactions involving the site as a source or a target are recorded
and reported, whether they are run from the Teamcenter rich client, Active Workspace. or the
command line.

Bulk data exchanges and PLM XML transactions are not recorded.

Configuring data exchange transaction monitoring

Configure the following aspects of gathering and displaying your organization's data exchange
transaction records.

Specify transactions to monitor

You can configure your site to record Multi-Site, Briefcase, or both types of data exchange transactions
originating at a site. Use the TXN_Supported_Application_Types preference to specify which data
sharing transactions are recorded and reported. Set the preference to a value of Briefcase, Multisite, or
both values depending on the types of data sharing transactions you want to record.

Specify a central site for monitoring transactions

By default, all transactions started from a site are recorded and can be viewed only when logged onto
that site. Alternatively, several sites can send their transaction records to a common site for consolidated
viewing of the organization's data exchange transactions at that common site.

To use a common site to view transaction records, on each of the remote sites set the TXN_Central_Site
preference to the Site Name value of the common site.

Change the period of reported transaction records

By default, a site's transaction records for the previous 30 days are reported. Change the default number
of days to report by updating the value of the TXN_history_range preference.

Clear data from the transaction history

Transaction records remain in a site's history until they are manually removed. To delete records from a
site's history, log onto the site, open a command window, and run the transaction_monitor utility. (See
transaction_monitor for more details on the utility.) For example:

Delete records in a date range

Active Workspace Administration, Teamcenter 2406 6-17

Use a command of the following form to delete all transaction records up to a certain date:

transaction_monitor -u=youruserid -p=yourpw -f=delete -from="2010-01-01

[Link]" -to="2021-09-30 [Link]"
Delete records of successful transactions in a date range
Use a command of the following form to delete all successful transaction records that occurred in a
certain time period:

transaction_monitor -u=youruserid -p=yourpw -f=delete

-final_status=Success -from="2021-09-30 [Link]"-to="2021-10-15
[Link]"

Viewing data exchange transaction records

When you log on as a Teamcenter administrator, the Data Exchange Transactions tile is available on
the Active Admin workspace home page.

By default, records for only those data transactions originating at your site are displayed. Your site may
be configured to view transactions originating at other sites, too.

View transaction records

Click the Multi-Site or Briefcase tab to view transaction records for your site's recorded transactions.
(Depending on your site's configuration, the tabs available may vary.)

Several graphs summarizing data exchanges originating at your site are displayed. Summaries are
organized by status, type, and involved sites.

Below the graphs, the transaction records for the site are listed. Open any of the records in the list to
view additional details about the record, such as the source and target sites, transaction type, objects
involved in the transaction, any reported errors, date and time of the transaction, and locations of
related log files.

Click one or more bar graphs or chart segments to refine the list of transaction records to those
selections. Remove filters at any time by closing the selected filter.

6-18 Active Workspace Administration, Teamcenter 2406

Filter transaction records by date range

Specify a different date range from which to view transaction records by entering From and To values
and clicking Apply Filters. The record list is updated to show transactions from the new date range.

By default, the transaction records for the previous 30 days are reported.

Filter transaction records by ID

Enter a value in the Filter field and click Apply Filters to refine the reported records to only those objects
with IDs containing the value and to records with Briefcase file names containing the value.

Share bulk data

Bulk loading product data

Active Workspace provides tools to extract data from one Teamcenter environment to copy to another.
You would typically use these tools when testing Teamcenter upgrades and customizations in test
environments.

When creating a test environment, you may need to duplicate large amounts of data from a production
environment in the test environment. Doing so delivers a test environment with an applicable, broad set
of data with which to test customizations and updated software.

Active Workspace Administration, Teamcenter 2406 6-19

Requirements

You must be logged on as a user with administration privileges to use the bulk extract and copy tools.

To bulk copy product data into a site, the site must be designated as a test site. You can designate a
site as a test site when installing it. You can also use the install utility with the -mark_as_test_env
argument to convert a site created as a production environment to a test environment.

Copying product data from your production environment

Use the following steps to copy data from a production environment to a Briefcase file that can be
loaded into a test environment.

1. Log on with Teamcenter administrative privileges and select one or more items, assemblies, or
folders as root objects to copy.

2. Click More commands > Share > Bulk Extract to display the Bulk Extract panel.

3. Select the transfer option set to use when copying the objects. (Only unconfigured transfer option
sets are available.)

4. Accept the default file Briefcase file name or update it as necessary.

5. Click Override Options and review the default settings for extracting the data. Update the options
as necessary and click Override.

6. Click Extract to begin copying the objects to the Briefcase file. You receive an alert when it is
complete.

Review the report and transfer the Briefcase file

You receive a report alert when the Briefcase file is created. Click on the alert to view the report. Access
all recent alerts from the Subscription tile.

• The Properties section of the report includes details such as a list of the user extracting the data and
the transfer option set used. Under Related Objects, click on the export log entry to view additional
details, including a complete list of the objects extracted.

• The Target Object section of the report contains a link to the Briefcase file containing the extracted
objects. Select the Briefcase file and click View > Load Briefcase to review the contents of the file.

Download the file and save it to a location accessible by the test site.

6-20 Active Workspace Administration, Teamcenter 2406

Copying product data into your test environment

Use the following steps to load data copied from a Teamcenter production environment into a test
environment.

1. Log on with Teamcenter administrative privileges and select the folder into which the root objects
will be copied.

2. Click More commands > New > Bulk Copy to display the Bulk Copy panel.

3. Use Choose File to locate the Briefcase file containing the data to copy.

4. Select the transfer option set to use when importing the file. Override any options as necessary.

5. Click Bulk Copy to import the objects in the Briefcase file. You receive an alert when the import run
is complete.

6. Review the selected folder for the imported objects.

Note:
If you are using Active Workspace with a version of Teamcenter earlier than 13.2 when
copying the data from the Teamcenter production environment or to the test environment,
the root objects will not be copied to the selected folder. You must search the Teamcenter
database for the copied data.

Review the import report

You receive a report alert when the copying completes. Click on the alert to view the report. (Access all
recent alerts from the Subscription tile.)

The folder into which you copied the data is listed under Related Objects in the Properties section of
the report. Under Target Object, download the import log, which includes details such as a list of the
objects copied and the transfer option set used.

Active Workspace Administration, Teamcenter 2406 6-21

6-22 Active Workspace Administration, Teamcenter 2406

© 2024 Siemens
7. Configuring Teamcenter mail and instant
messaging
Configuring Teamcenter mail
Administrators can configure Teamcenter mail to:

• Specify the mail gateway server, port, and character set used to send mail.

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

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

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

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

• Work with external e-mail for subscription notices.

• Receive email notifications when there is a new discussion activity within Teamcenter.

Change email server authentication settings

Email server authentication settings are initially configured using Teamcenter Environment Manager
manager.

1. Run Teamcenter Environment Manager from your Teamcenter home directory.

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

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

Configure external e-mail for subscription and workflow notification

To use external (operating system) e-mail for subscription and workflow notification, you must:

• Set mail gateway preferences:

• TC_subscription=ON to enable display and use of the Tools→Subscribe menu command.

• Mail_server_name=a_valid_SMTP_mail_server

Active Workspace Administration, Teamcenter 2406 7-1

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

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

TC_audit_manager_version=3, and SCM_notification_history=true.

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

• Start the subscriptionmgrd subscription monitor process daemon.

Configure email notifications for discussion activities

To receive email notifications for discussion activities, you must:

• Set the email preferences at your site.

• Set Ac0EnableEmailDiscussionNotifications to true. This preference is set to false by default.

• Ensure that your users have their email IDs specified.

Configuring Teamcenter to use email servers requiring

authentication
You can use TEM to configure Teamcenter to access an email server that requires authentication.
The following preferences get set based on the values supplied in TEM, and can be updated if your email
server requirements change.

Mail_server_authentication_activated
Set to true to connect to a server requiring authentication.
Mail_server_authentication_id
The e-mail ID or the user ID to use for e-mail authentication.
Mail_server_authentication_passwd_location
The full path and file name of the encrypted password to use for e-mail authentication.
Mail_server_connection_security
The type of secure connection to establish when connecting to the mail server.

None (The default value.) No security connection protocol is used when connecting with
the mail server.
SSL/TLS Establish an SSL/TLS connection when connecting to the mail server.
STARTTLS Establish an initial insecure connection and later convert to a TLS connection with
the mail server.

7-2 Active Workspace Administration, Teamcenter 2406

Mail_server_ssl_protocol
The protocol and version to use when connecting with the mail server.

TLSv1 (The default value.) Transport Layer Security version 1.

TLSv1_1 Transport Layer Security version 1.1.
TLSv1_2 Transport Layer Security version 1.2.
SSLv2 Secure Sockets Layer version 2.
SSLv23 Secure Sockets Layer version 2.3.
SSLv3 Secure Sockets Layer version 3.

Configuring instant messaging

Note:
Teamcenter rich client instant messaging with Microsoft Office Communicator should continue to
work. However, Siemens Digital Industries Software no longer has an environment in which to
validate the instant messaging functionality.

Teamcenter users can view the current status of the owning and last modified users, and, from within a
Teamcenter application, can initiate communication using Microsoft Office Communicator.

This capability:

• Is supported only on Windows systems with Microsoft Office Communicator.

• Lets you access all available Microsoft Office Communicator features.

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

• The OCS_use_presence_display preference specifies whether the functionality is integrated with

Teamcenter.

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

• The OCS_company_email_domain preference value specifies a domain name if the

OCS_use_email_property preference value is false.

• For the rich client, integration is implemented in:

• My Teamcenter Summary view

Active Workspace Administration, Teamcenter 2406 7-3

• My Teamcenter Viewer view

• Workflow perform-signoffs panes

• Systems Engineering

• Structure Manager

• Schedule Manager

Note:
Microsoft Office Communicator must be installed and running on your computer to use the
Teamcenter integration with Microsoft Office Communicator.

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

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

7-4 Active Workspace Administration, Teamcenter 2406

© 2024 Siemens
8. Configuring Teamcenter email polling
What is Teamcenter email polling?
Teamcenter email polling is functionality that checks an email account for unread messages that match
criteria specified in a polling rule. For messages that meet the polling criteria, Teamcenter performs a
specified type of response.

You can use email polling to bring email content from third parties into Teamcenter. You can also extend
email polling to perform additional actions on email messages and attachments.

Actions performed during an email polling cycle include the following:

1. The business user defines an email polling rule and then starts or schedules email polling.

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

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

4. If an unread message matches the specified criteria, then Teamcenter performs actions according
to the response type specified in the rule. The default response type performs the following
actions:

• Downloads the message body and attachments to a specified folder on the Teamcenter server.

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

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

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

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

Teamcenter does this with the file

For this decision (default action)

Approve No further action.

Reject Purges the downloaded file.

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

Active Workspace Administration, Teamcenter 2406 8-1

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

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

Configure email polling types

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

Prerequisites

• Teamcenter is installed and configured to work correctly.

• BMIDE is installed and is working property.

• The system administrator or customizer performing the configuration:

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

• has write access to all Teamcenter installation folders.

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

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

Configuration steps

1. In BMIDE, for the e-mail polling type that you want to configure:

a. Create or open a template project.

b. In the classic LOV list Fnd0EmailResponseTypes, create a list value to identify the polling type
that you want to define.

Only the value parameter of the list value is used for polling; its description and condition
parameters are not used.

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

Add your custom actions to your new object subtype.

d. Save and deploy the template.

8-2 Active Workspace Administration, Teamcenter 2406

2. In the rich client:

a. Log on using an account with dba privileges.

b. Choose Edit→Options.

c. Find the preference Email_polling_download_dir, and set the preference value to the desired
location for downloaded attachments in the server's file system. This location is used by all
email polling types.

The specified location must exist in the server's file system; the polling functionality does not
create the folder.

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

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

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

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

Create an email polling rule

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

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

Active Workspace Administration, Teamcenter 2406 8-3

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

Field Description

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

Name A name for the email polling rule.

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

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

8-4 Active Workspace Administration, Teamcenter 2406

Field Description

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

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

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

Rule ID The ID for the newly created rule.

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

3. Click Finish.

Configure user email account settings

To enable Teamcenter polling functionality to communicate with an email server, user email account
information must be specified before starting or scheduling email polling.

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

Active Workspace Administration, Teamcenter 2406 8-5

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

Field Description

Address of the email The address of the email server for your email account.
server being polled
Example:
[Link]

Polling user email ID Your email account address.

Example:
[Link]@[Link]

Polling user password The password for your email account.

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

Example:
993

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

Example:
465

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

Example:
[Link]

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

3. Click OK.

8-6 Active Workspace Administration, Teamcenter 2406

Configure Dispatcher for email polling

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

1. To activate the EmailPollingService service, set the isactive attribute to true in the
DISP_ROOT\Module\conf\[Link] file.

<EmailPollingService provider="SIEMENS" service="emailpolling" isactive="true">

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

2. In the DISP_ROOT\Module\Translators\emailpolling\[Link] file, set the following

variables to your installation locations:

• TC_ROOT

• TC_DATA

• JRE_HOME

3. In the TC_DATA\[Link] file, remove the comments before these settings:

• EmailPolling_JAVA_XMS=16m

• EmailPolling_JAVA_XMX=128m

4. Run the [Link] utility.

• Open a Teamcenter command prompt and type the following command:

TC_ROOT\portal\registry\[Link]

5. For each Teamcenter user who performs email polling actions, set the E-Mail Address property.

a. Using an account with dba privileges, log on to the rich client and open the Organization
application.

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

c. Set the E-Mail Address property.

Active Workspace Administration, Teamcenter 2406 8-7

Start or schedule email polling

Prerequisites

• User email account information is configured

• Dispatcher is configured for email polling

Procedure

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

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

Field Description

Start now! Select one of these choices.

Schedule
• Start now! runs a single on-demand poll.

• Schedule enables scheduling periodic polling.

Start Time The date and time to start scheduled polling.

End Time The date and time to end scheduled polling.

Interval The interval of time to repeat the poll.

Rules ID The ID of the email polling rule to use.

3. Click OK.

8-8 Active Workspace Administration, Teamcenter 2406

You can administer scheduled polling requests using the .

Teamcenter email polling preferences

For basic email polling functionality, you do not need to change default values for the following
preferences.

EMLPOLLING_default_polling_config_id
Defines the identifier for email polling configuration to be used in the email polling operation.
Default value: def_polling_config_id
[Link]
Defines the Java class to render the property panel of a form with type Review Email Polling
Revision Form.
Default value:
[Link]
Fnd0_review_email_attachments_workflow
Defines the create workflow for email polling functionality.
Default value: Review Mail Attachments

Active Workspace Administration, Teamcenter 2406 8-9

8-10 Active Workspace Administration, Teamcenter 2406

© 2024 Siemens
9. Updating property values in bulk
Process for updating property values in bulk
You can update the values of object properties in your Teamcenter database in bulk using the
tc_attribute_bulk_update utility. This utility replaces the previous method for updating property values
in bulk, which entailed using the attribute_export utility to export the property values and the
tcxml_import utility to import the updated property values into the database.

Tip:
You can also use live updates to update property values.

Use the tc_attribute_bulk_update utility to:

• Query for the objects that satisfy the conditions specified through condition property name/property
value pairs.

• Provide new values for the properties to be updated on the found objects.

• Export the data to a TC XML file.

• Import the data from the TC XML file into the database.

The scope of your bulk updates can range from changing a few values on a few properties (simple)
to changing many values on all properties throughout the database (complex). The scope of your
planned update determines which format to use to provide query criteria and replacement values to the
tc_attribute_bulk_update utility.

• Simple updates

Use this method when updating a few values on a small number of properties for a few object types.

Example:
The designers at Manufacturing, Inc. create two new colors for their spinning widgets
and discontinued another color. Accordingly, their Teamcenter administrator must add the
slide_green and twisting_turquoise values to the color property on the widget_spin object
and remove the boring_brown value.

Specify the condition property name/property value pairs and update property name/property value
pairs for the utility. Optionally, you can also specify an operator for condition property name/property
value pairs.

-cond_prop

Active Workspace Administration, Teamcenter 2406 9-1

-cond_value
-update_prop
-update_value
-cond_operator

• Complex updates

Use this method when changes to your business practices require sweeping changes to existing
property values throughout the database.

Example:
At Acme Company, every workspace object includes Division as a required property. Valid
Division values are the different business divisions of Acme. A reorganization changes the
list of existing business divisions significantly and creates new subsectors. Acme’s Teamcenter
administrator must update the Division values on every workspace object in the database.

Create an XML input file to specify property name/property value pairs to query for the objects to be
updated, and then specify property name/property value pairs to update the found objects.

Using the tc_attribute_bulk_update utility arguments to update

property values in bulk
When performing a simple update using the tc_attribute_bulk_update utility (updating a few values
on a small number of properties on a few different object types), use the command line arguments to
provide the query/update information.

You must use a combination of the -type argument and condition property name/property value pairs,
along with update property name/property value pairs to:

• Query for the objects that satisfy the conditions specified through condition property name/property
value pairs.

• Provide new values for the properties to be updated on the found objects.

• Export the data to a TC XML file.

• Query arguments

These arguments are the equivalent of the WHERE clause in an SQL phrase. They identify the property
type, property names, and property values to be queried.

-type
-cond_prop
-cond_value
-cond_operator (optional)

9-2 Active Workspace Administration, Teamcenter 2406

The two condition property name/property value arguments must always be used in conjunction with
the update property name/property value arguments.

• The -type argument specifies the object type to be updated, such as item, dataset, or
StructureContext.

This argument accepts only a single value. You can use multiple instances of this argument to
specify multiple object types. Each instance must be paired with the -cond_prop and -cond_value
arguments.

• The -cond_prop argument specifies the internal name of the property to be queried for, as opposed
to the display name.

This argument accepts multiple values in a comma-separated list. Each value must be a valid
property on a Teamcenter object. For example:

-cond_prop=object_name,last_mod_date

You can use multiple instances of this argument, but it must always be paired with the
-cond_value argument.

• The -cond_value argument specifies the current value of the property specified by the -cond_prop
argument.

This argument accepts multiple values in a comma-separated list. Each value must be a valid
property on a Teamcenter object. For example:

-cond_value=TextData_es_ES,"01-DEC-2011 00:00"

You can use multiple instances of this argument, but it must always be paired with the -cond_prop
argument.

• You can use the -cond_operator argument to specify an operator to be used with the -cond_prop
and -cond_value arguments.

This argument must be placed after the -cond_prop and -cond_value arguments and accepts the
following values:
EQ Equal
NE Not equal
GT Greater than
GE Greater than and equal
LT Lesser than
LE Lesser than and equal

Active Workspace Administration, Teamcenter 2406 9-3

For example:

-cond_prop=object_name -cond_value="My obj #1"

-cond_prop="last_mod_date"
-cond_value="01-DEC-2011 00:00" -cond_operator="LE"
-cond_prop="last_mod_date"
-cond_value="01-DEC-2010 00:00" -cond_operator="GE"

• Update arguments

These arguments are the equivalent of the UPDATE clause in an SQL phrase. They identify the
property names and values to be updated.

-update_prop
-update_value

Update property name/property value pairs must always be used in conjunction with the condition
property name/property value pairs.

• The -update_prop argument specifies the internal name of the property to be updated (as opposed
to the display name), for example, object_desc, char VLA, and so on.

This argument accepts multiple values in a comma-separated list. Each value must be a valid
property on a Teamcenter object. For example:

-update_prop=object_name,object_desc

You can use multiple instances of this argument. Each instance of this argument should be paired
with the -update_value argument.

• The -update_value argument specifies the new value for the property specified by the
-update_prop argument.

This argument accepts multiple values in a comma-separate list. For example:

-update_value=folder,"Home folder"

You can use multiple instances of this argument. Pair each instance of this argument with the
-update_prop argument.

The following examples illustrate the use of the condition property name/property value pairs and
update property name/property value pairs with the tc_attribute_bulk_update utility:

• To update prop3 to value3 and prop4 to value4 for type1 objects (when prop1 equals value1 and
prop2 is greater than value2) in batches of 400, enter a command with the following form on a
single line:

9-4 Active Workspace Administration, Teamcenter 2406

tc_attribute_bulk_update -u=tc-admin-user -pf=d:\[Link] -g=group

-type=type1 -cond_prop=prop1 -cond_value="value1"
-cond_prop=prop2 -cond_value="value2" -cond_operator="GT"
-update_prop=prop3 -update_value="value3"
-update_prop=prop4 -update_value="value4"
-batchsize=400

• To update an object description to blue Desc and the int_VLA to 10,3,0,99 for all datasets where the
object_name property is TextData_es_ES and the last_mod_date property is 01-DEC-2011 00:00 or
greater, enter the following command on a single line:

tc_attribute_bulk_update -u=tc-admin-user -p=password -g=group

-type=Dataset -update_prop=object_desc -update_value="blue Desc"
-update_prop="int_VLA" -update_value="10,3,0,99"
-cond_prop=object_name -cond_value="TextData_es_ES"
-cond_prop="last_mod_date" -cond_value="01-DEC-2011 00:00"
-cond_operator="GE"

Using an XML input file to update property values in bulk

When performing a complex update using the tc_attribute_bulk_update utility (updating many values
on many properties throughout the database), use an XML input file to provide the query/update
information with the -inputfileargument. The input file is a more efficient format for listing lengthy
update instructions than using the command line arguments.

You must use a combination of condition property name/property value pairs and update property
name/property value pairs to:

• Query for the objects that satisfy the conditions specified through condition property name/property
value pairs.

• Provide new values for the properties to be updated on the found objects.

Structure the file as a series of UpdateSets entries. Each update set must contain type, condition,
and update components. The following sample XML file illustrates the required sequence of the XML
components, first type, then where, and then update.

<?xml version="1.0" encoding="utf-8"?>

<BulkUpdate>
<UpdateSets>
<UpdateSet>
<type name = "item" />
<where>
<cond_prop attrName = "int_single" attrValue = "50" cond_operator = "<=" />
<cond_prop attrName = "string attr" attrValue = "Wed, Mon, Sat, Tue" />
<cond_prop attrName = "last_mod_date" cond_operator = ">" attrValue = "01-
DEC-2011 00:00"/>

Active Workspace Administration, Teamcenter 2406 9-5

</where>
<update>
<update_prop attryName = "object_desc" attrValue = "red Desc"/>
<update_prop attryName = "intVLA" attrValue = "10,20,0,9,7"/>
<update_prop attryName = "some_VLA_property" attrValue =
"value1,value2,value3"/>
</update>
</UpdateSet>
</UpdateSets>
</BulkUpdate>

Note:
There is no required sequence within the cond_prop component for the attrName, attrValue,
and cond_operator components.

• Type component

This component specifies the object type to be updated, such as item, dataset, or StructureContext.

This component accepts only a single value.

• Condition components

These components are placed in the <where> section of the update set. They identify the property
names and values to be queried.

cond_prop
cond_value
cond_operator (optional)

• The cond_prop component specifies the internal name of the property to be queried for, as
opposed to the display name.

This component accepts multiple values in a comma-separated list. Each value must be a valid
property on a Teamcenter object. For example:

cond_prop=object_name,last_mod_date

You can use multiple instances of this component, but it must always be paired with the
cond_value component.

• The cond_value component specifies the current value of the property specified by the cond_prop
component.

This component accepts multiple values in a comma-separated list. Each value must be a valid
property on a Teamcenter object. For example:

cond_value=TextData_es_ES,"01-DEC-2011 00:00"

9-6 Active Workspace Administration, Teamcenter 2406

You can use multiple instances of this component, but it must always be paired with the
cond_prop component.

• You can use the cond_operator component to specify an operator to be used with the cond_prop
and cond_value components.

This component accepts the following values:

= Equal
!= Not equal
> Greater than
>= Greater than and equal
< Lesser than
<= Lesser than and equal

For example:

<where>
<cond_prop attrName =
"int_single" attrValue = "50" cond_operator = "<=" />
<cond_prop attrName = "string_attr" attrValue = "Wed, Mon, Sat,
Tue" />
<cond_prop attrName =
"last_mod_date" cond_operator = ">" attrValue = "01-
DEC-2011" />
</where>

• Update components

These components identify the property names and values to be updated.

update_prop
update_value

• The update_prop component specifies the internal name of the property to be updated (as
opposed to the display name), for example, object_desc, char VLA, and so on.

This component accepts multiple values in a comma-separated list. Each value must be a valid
property on a Teamcenter object. For example:

update_prop=object_name,object_desc

You can use multiple instances of this component. Each instance of this component should be
paired with the update_value component.

Active Workspace Administration, Teamcenter 2406 9-7

• The update_value component specifies the new value for the property specified by the
update_prop component.

This argument accepts multiple values in a comma-separate list. For example:

update_value=folder,"Home folder"

You can use multiple instances of this component. Each instance of this component should be
paired with the update_prop component.

The input file supports the following persistent properties:

• Single-value properties

• Array properties

• Fixed length array

• Variable length array (VLA)

Performance statistics
You can estimate the duration of your bulk update gathered on the following performance statistics,
based on custom ADSPart objects.

Custom attribute_expor tcxml_import in Total time

ADSParts t in seconds seconds in seconds

169 11.261 13.115 24.376

602 28.001 27.569 55.57

1,356 52.338 73.519 125.857

9,570 318.393 687.489 1,005.882

29,241 954.282 1,522.68 2,476.962

The statistics are based on the following setup:

• Oracle database running on machineA.

• Teamcenter server running on machineB.

9-8 Active Workspace Administration, Teamcenter 2406

• CPU speed: 3 GHz

• CPU type: Intel Pentium 4 CPU 3.00GHz

• Memory: 2 GB

• Both machineA and machineB are on a LAN network.

• The UGII_CHECKING_LEVEL environment variable is set to 0.

Best practices for updating property values in bulk

Siemens Digital Industries Software recommends observing the following best practices:

• Do not perform this operation when users are accessing Teamcenter data. If objects specified for
update are locked by other processes, the update process is impacted.

• To determine all the current values of attributes you plan to update, with the
tc_attribute_bulk_update utility, use the -untransformed switch with either the -inputfile argument
containing only condition property/value entries (no update entries) or the -cond_prop and
-cond_value arguments.

• To validate the schema of the XML input file, use the -performSchemaValidation switch.

If the schema is invalid, the following information is added to the log file:

Error: attributeUpdateSchemaValidator: XML Exception

during schema file validation.

If the schema is not found, the following information is added to the log file:

Error: AttributeUpdateSchemaValidator: Unable to find schema

file for validation.

• To confirm the updates were made as expected, specify an output directory with the -outdir argument
so that you can review the output log.

• Because extensive updates are time-consuming, Siemens Digital Industries Software recommends you
determine the following before performing a complex bulk update of property values:

• Affected targets

Run the tc_attribute_bulk_update utility with the -queryonly switch to determine the number of
target objects affected by the proposed update. When you specify this switch, the utility does not
perform the update, it merely reports the number of affected objects.

Active Workspace Administration, Teamcenter 2406 9-9

This switch outputs the number of target objects affected by the specified update parameters to a
log file. If the number of objects is less than 100, the object UIDs are included in the log file.

Use this switch in conjunction with either the input file or the condition and update arguments
to determine how many objects are affected by the specified update operation. You can use the
resulting information to determine batch size and to estimate the duration of the update operation.

• Duration

To estimate the duration of various update operations, see the performance tables. If the estimated
time is considerable, there are three methods for managing the operation duration.

■ Run the tc_attribute_bulk_update utility with the -batchsize argument to specify the number
of objects to update in each batch operation per TC XML file.

The default batch size is 500. This is also the maximum batch size.

■ Run the tc_attribute_bulk_update utility with the -islandsize argument to specify the number
of islands to update in each operation. Islands tie logically related objects together. The data in
low-level TC XML is grouped into an island by closure rules.

The default size is 100.

■ Manage the number of objects processed per update by running multiple updates constrained by
dates. The updates can be run in parallel. For example:

◊ First update

-cond_prop="last_mod_date" -cond_value="01-DEC-2010 00:00"

-cond_operator="LT"

◊ Second update

-cond_prop="last_mod_date" -cond_value="01-DEC-2011 00:00"

-cond_operator="LE"
-cond_prop="last_mod_date" -cond_value="01-DEC-2010 00:00"
-cond_operator="GE"

◊ Third update

-cond_prop="last_mod_date" -cond_value="01-DEC-2011 00:00"

-cond_operator="GT"

9-10 Active Workspace Administration, Teamcenter 2406

© 2024 Siemens
10. Logging
Monitoring your system
You can use several types of logging to monitor the activities of Teamcenter processes and objects.

Audit logs

Audit logs track the activities performed on selected data model objects. This provides a tracking
mechanism for any changes made to those objects for historical record. To use audit logs, they must be
enabled and configured.

Core Teamcenter logs

These process log files contain diagnostic information for the core foundation of Teamcenter which is
described in the Teamcenter System Administration topic Teamcenter Logging.

Microservice logs

These process log files contain diagnostic information for the logs from the microservices. If your
microservices are distributed, consider installing the Log Aggregator.

Configuring the Audit Logs page

Audit Logs page configuration tasks

What are audit log types?

In Teamcenter, the following audit log types hold audit records based on logical groupings of object type
and event type combinations:

• General logs

• License export logs

• Organization logs

• Security logs

• Schedule logs

• Structure logs

Active Workspace Administration, Teamcenter 2406 10-1

• Workflow logs

What is an audit log dataset?

An audit log dataset is a stylesheet configuration representing applicable audit log types for a context
object. The Audit Logs tab in Active Workspace provides a segregated view of audit logs in different
sections. As a system administrator, you can create and configure audit log datasets.

What do audit logs look like?

As a DBA user, you can view audit logs using the Audit Logs tab in Active Workspace.

What must I install to enable the audit log feature?

To enable the audit log feature, you must install the Audit feature during your Active Workspace
installation using Teamcenter Environment Manager (TEM).

What can I configure?

You can configure the following aspects of audit logs:

• Activate the Audit Log page.

10-2 Active Workspace Administration, Teamcenter 2406

• Customize which audit log fields appear to users.

• Customize which audit logs appear to users.

Where can I find out more about audit logs?

See Audit Logs Management in the Teamcenter documentation.

Activate the Audit Log page

Set the AWC_show_audit_logs preference to activate the Audit Log tab in Active Workspace. By
default, the value is true for the dba group. As a DBA user, you can set the preference for specific
groups, roles, and users from:

• Active Workspace using the PREFERENCES tile.

• The rich client Options dialog box Preferences By Organization pane.

• The preferences_manager utility.

Active Workspace Administration, Teamcenter 2406 10-3

For more information, see the Teamcenter Utilities in the Teamcenter documentation.

Customize audit logs field display

You can customize which fields are displayed in each audit log. For example, by default the General
Logs audit log displays the following fields:

• Logged Date

• Event Type Name

• User ID

• Change ID

• Reason

• Group Name

• Role Name

• Secondary Object Display Name

• Secondary Object Type

To remove a field from the display:

• In Active Workspace, you can use the Arrange panel to reorder, hide, or display columns.

• In Teamcenter, perform the following:

1. In the rich client, search for the audit log file you want to edit. For example, select the
GeneralAuditLogs file to remove a field name in the General Logs audit log.

10-4 Active Workspace Administration, Teamcenter 2406

2. Delete the line associated with the field you want to remove. For example, delete the following
line to remove the Secondary Object Type field:

3. Save the GeneralAuditLogs file.

4. Using Active Workspace, verify the Secondary Object Type field was successfully removed.

Using audit logs

System administrators use Audit Manager to create audit logs. Audit logs track what information has
changed and who has changed the information.

Note:
Your administrator must enable the Audit Logs page for Active Workspace. Also, you must have
administrative privileges or you must be granted privileges to view audit logs.

In the Active Workspace, you can view the following audit logs:

Active Workspace Administration, Teamcenter 2406 10-5

• Audit - General Report

• Audit - General Sponsored Authentication Report

• Audit - File Access Read-Write Report

• Audit - File Access Report

• Audit - File Access Sponsored Authentication Report

• Audit - Security Report

• Audit - Schedule Report

• Audit - Organization Report

• Audit - Digital Signature Report

• Audit - License Change Report

• Audit - License Export Report

• Audit - License Export Sponsored Authentication Report

• Audit - License Change Sponsored Authentication Report

• Audit - Organization Sponsored Authentication Report

• Audit - Structure Sponsored Authentication Report

• Audit - Workflow Detailed Report

• Audit - Workflow Summary Report

• Audit - Workflow Attachment Report

• Audit - Workflow Signoff Report

You can view audit logs using the Audit Logs tab.

10-6 Active Workspace Administration, Teamcenter 2406

Customize the audit log display

By default, the following four audit logs are viewable in Active Workspace for Item, ItemRevision, and
its subtype:

• Workflow Logs

• General Logs

• License Export Logs

• Structure Logs

Active Workspace Administration, Teamcenter 2406 10-7

You can customize which audit logs are displayed to users by adding or removing audit logs to customize
your XRT pages.

Following is a table that shows the audit dataset for the associated object type.

Object type Audit dataset

Item/ItemRev and its subtype AuditLogForItemRev

Workspace object AuditLogAllForWSO

BOMLine AuditLogForBOM

Form/Folder/WSO AuditLogGNForWSO

Dataset AuditLogForDataset

User/Group/Project AuditLogForUserContext

GroupMember/Person/ AuditLogForOrg
Role/Site/Volume/
TCCalendar

Schedule, ScheduleTask AuditLogForSchedule

SchDeliverable/SchTaskDeliverable/ AuditLogForScheduleMgmt
ScheduleMember

EPMJob/EPMTask/ AuditLogForWorkflow
PerformSignoffTask

Scp0Regulation/ AuditLogForSubscmpl
Scp0SubstanceCmplResult/
Scp0Exemption/
Mat1Substance

To customize which audit logs can be viewed:

1. Open the XRT page that you want to modify, for example, Awp0DocumentRevSummary, and add
the audit log to your custom XRT page by inserting an inject statement for the audit log you want
to add.

10-8 Active Workspace Administration, Teamcenter 2406

2. Save the file with a new name.

Note:
Siemens Digital Industries Software recommends you rename your edited file before saving
changes to retain the default file.

Aggregating microservice logs

Microservice log aggregation

In a typical deployment, Teamcenter microservices are distributed across multiple machines. For a
particular transaction or operation, microservices across the deployment could be involved, including
separate instances of a given microservice on multiple machines. If a failure occurs, part of the
investigation may require reviewing multiple microservice logs to find the root cause of the issue.

Log aggregation eliminates the need to manually fetch and inspect each log on each machine in the
deployment. A log forwarder on each microservice node forwards logs to a log aggregator for collection
in a single location, either in a consolidated file or preferably an Elasticsearch endpoint. In this single
location, administrators can search for messages of certain error levels or for messages with a matching
correlation ID.

Active Workspace Administration, Teamcenter 2406 10-9

General Teamcenter logging is described in the Teamcenter System Administration topic Teamcenter
Logging.

Install the microservice log aggregator

Use Deployment Center to install the microservice log aggregator. The log aggregator cannot be
installed using Teamcenter Environment Manager (TEM).

1. Download the Teamcenter install kit and place it in the Deployment Center repository.

2. In Deployment Center, open the environment in which you want to install the log aggregator.

3. On the Applications panel, add the Teamcenter Microservice Framework and Aggregated
Logging applications.

4. On the Components panel, configure the Log Aggregator component.

For this
property Do this
Installation Enter the location on the host machine where the Log Aggregator must be
Path installed.
Machine Name Enter the name of the machine where the Log Aggregator must be installed.
Include the domain in the name.
Note that on Linux hosts, a Docker placement constraint is set so that the
aggregator continues running on that exact node in the swarm.
OS Choose the operating system that is installed on the host, either Windows or
Linux.
Type and To ensure high availability of log aggregation, you can add multiple Log
Aggregator Aggregator component instances. Each instance is installed on the node
Port (for identified in its Machine Name parameter.
Windows hosts)
One instance of the Log Aggregator component must be set to Type=active.
Other instances must be set to backup.
Set Aggregator Port to the port number you want to use for this instance of the
log aggregator. You can specify any open port number.
Output Logs to: Choose the destination for the aggregated logs, either ElasticSearch or File.
ElasticSearch
Copies the log files to your Elasticsearch endpoint (Elasticsearch version 7.x
is recommended). If you choose ElasticSearch, enter the settings for your
Elasticsearch endpoint:

Protocol - The transfer protocol, either http or https.

10-10 Active Workspace Administration, Teamcenter 2406

For this
property Do this
CA Certificate file path - The location of the certificate authority
certificate.
Host - The server where Elasticsearch is deployed.
Port - The port for Elasticsearch traffic on the server where
Elasticsearch is deployed.

If Elasticsearch traffic requires authentication, select the Requires

Authentication checkbox and enter the authorized Username and
Password.
File
Collects all logs in a single file with the naming pattern
tc_aggregated_logs*. A new log file is started daily. All aggregators in the
deployment must be able to write to the same physical disk, which can be a
network share or mount point.

When the destination file is on a Linux host, a mount point is created in

the Docker stack for writing logs into the machine's file system. To enable
writing the logs, enter the User ID and Group values for the user account
under which the aggregator container will run. To obtain these values, log
on to the aggregator host machine using that account and issue the id -u
and id -g commands.

On Windows hosts, in Aggregated Log Path, enter the location for the
aggregated log.

5. Configure the Microservice Node as described for the host operating system, either Linux or
Windows.

6. Generate deployment scripts as you would for any Deployment Center install procedure, and install
the log aggregator on the target host machine.

Once the Deployment Center scripts have been deployed, perform the following platform-specific steps
on the target host machine.

Note:
If authentication is required for Elasticsearch traffic, the credentials are stored unencrypted in a
Fluentd configuration file. This is a limitation of the Fluentd plugin. To secure the password, set
appropriate file system access controls on the file or control access to the machine. On Windows,
the file is [TC_ROOT]\tc_logging_aggregator\config \[Link]. On Linux, the file is [MSF
INSTALL]/container/logging_configuration/fluent_aggregator.conf .

Windows

Active Workspace Administration, Teamcenter 2406 10-11

No additional steps are needed. By default, log aggregation services start automatically. The services
are named Teamcenter Logging Aggregator (if deployed on the node) and Teamcenter Logging
Forwarder (all nodes).
Linux
1. On the master node, launch a command prompt.

2. Change the directory to \containers and run the following commands:

docker stack deploy -c [Link] mystack

docker stack deploy -c service_dispatcher.yml mystack
docker stack deploy -c tc_logging_aggregator.yml mystack
docker stack deploy -c tc_logging_forwarder.yml mystack

3. To verify that all services are running, run the command docker service ls.

The output of the command should show all the services running.

View aggregated logs

Depending on how the log aggregator was defined in Deployment Center, you can view the aggregated
logs either in one file or from an Elasticsearch database.

File-based aggregated logs

Logs are periodically collected in a single file with the naming pattern file tc_aggregated_logs*. A new
log file is started daily. You can view the logs with any text file viewer.

For nodes on Linux, a mount point is created in the log aggregation container on the machine where the
log aggregator is installed, and the logs are written there.

For nodes on Windows, the logs are located in the Aggregated Log Path location defined in
Deployment Center.

Elasticsearch aggregated logs

Logs are copied to an Elasticsearch endpoint. Typically, this endpoint is part of an Elastic (ELK) Stack,
and the logs can be searched using Kibana. Following is an example of how logs might be viewed. The
example briefly shows how things work. It is not a tutorial on how to use Kibana.

1. Navigate to the Kibana installation.

10-12 Active Workspace Administration, Teamcenter 2406

2. Click Discover.

3. Change the time range.

a. In the toolbar, click the time range section.

b. Click Quick and choose Last 15 minutes or the range you prefer.

4. View your logs for the time range. The following example shows a parsed log line.

Active Workspace Administration, Teamcenter 2406 10-13

Enable TLS for log aggregation

You can enable Transport Layer Security (TLS) for the log aggregation solution. Log aggregation makes
use of Fluentd and Fluentd plugins. Detailed configuration steps for enabling TLS are described in the
Fluentd documentation. The Fluentd documentation is available at [Link]

Configure TLS between the log aggregator and the log forwarder

1. Generate a self-signed certificate, following the Fluentd documentation for how to enable TLS
encryption for the forward input plugin.

Keep track of the password. You will use it later during configuration.

2. Save the certificate to a location that can be referenced by the log aggregation configuration.

Example:
C:\TR\tc_logging_aggregator\certs\[Link]

3. On microservice framework nodes where the log aggregator runs, enable TLS mutual
authentication by modifying the log aggregator configuration file as described in the Fluentd
documentation for the forward input plugin.

The location and name of the aggregator configuration file depends on the node operating system:

Node OS Location and name of aggregator configuration file

Linux /container/logging_configuration/fluentd_aggregator.conf

Windows <installation>\tc_logging_aggregator\config\aggregator.c
onf

Example:
<source>
@type forward
port 24224
bind "vc6s004"
<transport tls>
cert_path C:\TR\tc_logging_aggregator\certs\[Link]
private_key_path C:\TR\tc_logging_aggregator\certs\[Link]
private_key_passphrase MyPassword12345
</transport>
</source>

4. Restart the log aggregator.

10-14 Active Workspace Administration, Teamcenter 2406

Linux
Stop and restart the logging container.

a. To identify the log aggregator service in the running stack, run the command:

docker service ls

The aggregator service will include the name "fluentd_aggregator".

TC_MS_STACK_fluentd_aggregator

b. To remove the aggregator service from the stack, run the command:

docker service rm <log_aggregator_service>

c. To restart the log aggregator service with the new config file, run the command:

docker stack deploy -c tc_logging_aggregator.yml <stack_name>

Windows
On Windows nodes where you modified the aggregator configuration file, in the Windows
services application, stop and restart the Teamcenter_Log_Aggregator service.

5. On all nodes, to connect to a TLS SSL-enabled server, modify the forwarder configuration file as
described in the Fluentd documentation for the forward input plugin.

The location and name of the forwarder configuration file depends on the node operating system:

Node OS Aggregator configuration file

Windows <installation>\tc_logging_forwarder\config\[Link]
f

Linux /container/logging_configuration/fluentd_forwarder.conf

Example:
<match **>
@type forward
send_timeout 60s
recover_wait 10s
hard_timeout 60s
transport tls
tls_cert_path C:\TR\tc_logging_aggregator\certs\[Link]
tls_verify_hostname false

Active Workspace Administration, Teamcenter 2406 10-15

# The below include defines all the aggregator

# servers.
#
@include ./servers/*.conf
</match>

6. Restart the log forwarder.

Linux
Stop and restart the forwarder container.

a. To identify the log forwarder service in the running stack, issue the command:

docker service ls

The forwarder service will include the name "fluentd_forwarder".

TC_MS_STACK_fluentd_forwarder

b. To remove the forwarder service from the stack, issue the command:

docker service rm <log_forwarder_service>

c. To restart the log forwarder service with the new config file, issue the command:

docker stack deploy -c tc_logging_forwarder.yml <stack_name>

Windows
On Windows nodes where you modified the aggregator configuration file, in the Windows
services application, stop and restart the Teamcenter_Log_Forwarder service.

Configure HTTPS/TLS from the aggregator to an Elasticsearch server

To configure HTTPS/TLS from the aggregator to your Elasticsearch server, refer to the Fluentd
documentation for the output plugin elasticsearch. The elasticsearch plugin is included with the
microservice framework kit.

Configure user logging

Users can enable logging when experiencing performance, memory, or other issues. You can configure
the following aspects of this logging.

10-16 Active Workspace Administration, Teamcenter 2406

Configure client log notifications

Specify the email addresses to be notified when log files are created using the
TC_reactive_logging_notification_list preference.

Allow users to download log files

Allow the logging user to download log files by setting TC_reactive_logging_file_download to true.
(The default value is false.)

Active Workspace Administration, Teamcenter 2406 10-17

10-18 Active Workspace Administration, Teamcenter 2406

The Assistant suggests the next possible actions to perform and provides the relevant data required to
perform them. These suggestions are based on the context, history, and usage frequency of actions
performed by other previous users belonging to the same role and group.

What can I configure?

You can configure the Assistant panel using the provided site and user preferences.

What do I need to do before configuring?

Before you can configure the Assistant panel, you must install the features and the microservice.
Install the following from the Features panel of Teamcenter Environment Manager (TEM):

• Assistant (server)

Installs the server-side definitions for the Assistant.

Select the Active Workspace→Server→Active Workspace Assistant feature in the corporate server.

• Assistant (client)

Installs the user interface elements for the Assistant.

Select Active Workspace→Client→Active Workspace Assistant.

• Command Prediction Services (microservice)

Installs the microservice for the Assistant.

Select Microservices→Command Prediction Services.

Where can I find out more about the Assistant?

See The Teamcenter Assistant in the help.

What does the Assistant panel look like?

Following is an example of the Assistant panel in Active Workspace.

Active Workspace Administration, Teamcenter 2406 11-1

Configuring the Assistant panel

You can manage the settings for the Assistant panel using the provided site and user preferences.
The availability of options such as Like, Dislike, Show, or Tutor Mode can also be configured using
preferences.

Find the list and description of these preferences in the Active Workspace Assistant product area.

11-2 Active Workspace Administration, Teamcenter 2406

Where can I get a list of preferences?

Install the Assistant

The Assistant uses the Command Prediction Service microservice, which stores data in a dedicated
database that you configure during installation.

This procedure assumes that Teamcenter and Active Workspace, including the microservice framework,
are installed.

1. Ensure your environment includes the Teamcenter Foundation, Active Workspace, and Teamcenter
Microservice Framework software.

• Deployment Center

• In the Software step, select the software kits.

• TEM

• In the Media Locations panel, specify locations of the software kits. If you use a minor release
version of Teamcenter, make sure you include the major and minor release software kits.

2. Add the Assistant to your environment:

Active Workspace Administration, Teamcenter 2406 11-3

• Deployment Center

• In the Applications step, select the Active Workspace Assistant application.

• In the Components step, select the Command Prediction Service Configuration

component.

• TEM

• In your server and client configurations, add the corresponding server and client Active
Workspace Assistant feature.

• In your microservice framework configuration, add the Command Prediction Service

microservice.

For information about the TEM panels, in TEM, see the Help button

3. Complete the installation as appropriate for your installation tool.

Note:
• When you configure the database for the Command Prediction Service microservice, make
sure you have the database system user credentials, and make sure you do not use the same
tablespace as the Teamcenter database. The PredictiveUI user,database, and tablespace must be
different from the Teamcenter and Server Manager database.
If you choose to use an existing database for the Command Prediction Service microservice,
make sure that you manually create the database before the installation.

• Due to the architectural changes in the Active Workspace client in Active Workspace 6.2 release,
the command usage data required for the Teamcenter Assistant is not available and it has to
be retrained. Active Workspace users will not be able to leverage the data that was created in
releases prior to Active Workspace 6.2.

Manually create a database for the Command Prediction Service

microservice
If you choose to use an existing database for the Command Prediction Service microservice, you must
create the database using template scripts prior to install.

These scripts can be modified to create the database user, the tablespace, and the schema that includes
the tables and indexes. Apart from changing tokens to appropriate values, and minor syntax changes, no
other changes to the scripts are advisable.

11-4 Active Workspace Administration, Teamcenter 2406

Manually create an Oracle database for the Command Prediction Service microservice

1. Copy the template scripts from

<OS>\tc\microservices\commandprediction_service.zip\tc\db_scripts\<database>.

2. Rename them as .sql files.

Following SQL scripts must be used for on-premise Oracle database:

• oracle_create_predui.[Link] - Use this script to create the base schema

database.

• oracle_update_predui.[Link] - Use this script to update the base schema

database.

Following SQL scripts must be used for cloud hosted Oracle database:

• oracle_rds_create_predui.[Link] - Use this script to create the base schema

database.

• oracle_update_predui.[Link] - Use this script to update the base schema

database.

3. Replace the tokens to appropriate values.

The following table describes the database parameters to be replaced in the template. Additionally,
the comments in the template file also indicate the values that must be replaced.

Parameter Example value Description

@TABLESPACE_NAME@ predictivedb Name of the tablespace.
@DB_PATH@ D:\oracle\data Path to the directory in which the data file will reside.
@DB_USER@ predictivedbuser Database log in name for the Teamcenter database.
@DB_PWD@ predictivedbpw The password for the database user.

4. Save the modifications to the scripts and execute them.

If syntax errors occur while executing the database scripts, the following additional changes are
required:

• On the last line in the SQL script, delete one semicolon after END statement.

• Make sure that the last line of the SQL script ends with the / character. If not, you must insert
the / character on a new line after the last line of the script

Active Workspace Administration, Teamcenter 2406 11-5

The last two lines of the SQL script must appear as shown below:

;END;

Note:
For a complete database setup, it is necessary to execute both the create and update scripts
after they are modified.

Manually create an MSSQL database for the Command Prediction Service microservice

1. Copy the appropriate template scripts from

<OS>\tc\microservices\commandprediction_service.zip\tc\db_scripts\<database>.

2. Rename them as .sql files.

The following SQL scripts must be used for the SQL Server database:

• mssql_create_predui.[Link] - Use this script to create the base schema for the
SQL Server database.

• mssql_update_predui.[Link] - Use this script to update the base schema

database.

3. Replace the tokens to appropriate values.

For more information, see Create an SQL Server database (Windows) or Create an SQL Server
database (Linux).

4. Save the modifications to the scripts and execute them.

• To execute the script on the command line, enter the following:

> sqlcmd -i mssql_create_predui.sql

> sqlcmd -i mssql_update_predui.sql

For detailed information and help about the sqlcmd utility and its arguments, run the utility as
follows:

sqlcmd -h

• To execute the scripts using the SQL Server Management Studio, do the following:

11-6 Active Workspace Administration, Teamcenter 2406

a. Open the mssql_create_predui.sql file in Microsoft SQL Server Management Studio.

b. In the SQL Editor toolbar, click Execute, or choose Query→Execute to start creating the
database.

c. Open the mssql_update_predui.sql file in Microsoft SQL Server Management Studio.

d. In the SQL Editor toolbar, click Execute, or choose Query→Execute to start updating the
base schema database.

Note:
For a complete database setup, it is necessary to execute both the create and update scripts
after they are modified.

Migrate the Oracle database for the Command Prediction Service

microservice
When you upgrade from Teamcenter 13.x / 14.x to Teamcenter 2406, you must run scripts to migrate
the existing data, so that the Teamcenter Assistant can store the history of clicks performed by users and
predict the next command successfully.

Note:
These migration scripts migrate the command data for Teamcenter Assistant. The scripts do not
migrate the actual commands.

Prerequisites

• You must migrate the commands and then run the migration scripts.

• Changes required for custom commands in updated UI should be completed

• Create the following lists of custom group commands that you want to migrate:

• A list of custom group commands that will be visible when you click … or More in the work area
toolbar or primary toolbar.

• A list of custom group commands that will be visible directly on the work area toolbar or primary
toolbar.

Procedure

1. Copy the template scripts from

<OS>\tc\microservices\commandprediction_service.zip\tc\db_scripts\tc2312_migration\oracle.

Active Workspace Administration, Teamcenter 2406 11-7

2. To migrate the data generated for commands that are included with the default Teamcenter
installation, run the assistant_tc2312_migration_script_oracle.sql script as follows:

sqlplus -s username/password@database
@assistant_tc2312_migration_script_oracle.sql

3. To migrate the data generated for custom group commands created by the user that were originally
present on the primary toolbar on the right, do the following:

a. Modify the tokens in the assistant_tc2312_custom_migration_script_oracle.sql as follows:

Token Example value Description

@@LIST_OF_ANCHORS_FOR_WORKAREA_TOOLBAR_MORE@@ ‘Group1’,’Group2’, List of
‘Group3’ custom
command
groups that
will be
migrated to
“More”
group in
workarea
toolbar.
@@LIST_OF_ANCHORS_FOR_WORKAREA_TOOLBAR_MORE@@ ‘Group1’,’Group2’, List of
‘Group3’ custom
command
groups that
will be
migrated to
group in
workarea
toolbar.

Note:
You do not need to run this script for custom commands, this script is needed only for
the custom group commands.

b. Save the modifications and run the script use the following command:

sqlplus -s username/password@database
@assistant_tc2312_custom_migration_script_oracle.sql

11-8 Active Workspace Administration, Teamcenter 2406

Migrate the MSSQL database for the Command Prediction Service

Note:
These migration scripts migrate the command data for Teamcenter Assistant. The scripts do not
migrate the actual commands.

Prerequisites

• You must migrate the commands and then run the migration scripts.

• Changes required for custom commands in updated UI should be completed

• Create the following lists of custom group commands that you want to migrate:

• A list of custom group commands that will be visible when you click … or More in the work area
toolbar or primary toolbar.

• A list of custom group commands that will be visible directly on the work area toolbar or primary
toolbar.

Procedure

1. Copy the template scripts from

<OS>\tc\microservices\commandprediction_service.zip\tc\db_scripts\tc2312_migration\mssql.

2. To migrate the data generated for commands that are included with the default Teamcenter
installation, run the assistant_tc2312_migration_script_mssql.sql script using one of the following
methods:

• To run the script on the command line, use the following command:

sqlcmd -S database –U user -P password -i

assistant_tc2312_migration_script_mssql.sql

• To run the script using the SQL Server Management Studio, open the
assistant_tc2312_migration_script_mssql.sql file in Microsoft SQL Server Management Studio,
and in the SQL Editor toolbar, click Query → Execute.

Active Workspace Administration, Teamcenter 2406 11-9

3. To migrate the data generated for custom group commands created by the user that were originally
present on the primary toolbar on the right, do the following:

a. Modify the tokens in the assistant_tc2312_custom_migration_script_oracle.sql as follows:

Token Example value Description

@@LIST_OF_ANCHORS_FOR_WORKAREA_TOOLBAR_MORE@@ ‘Group1’,’Group2’, List of
‘Group3’ custom
command
groups that
will be
migrated to
the More
group in
work area
toolbar.
@@LIST_OF_ANCHORS_FOR_WORKAREA_TOOLBAR_MORE@@ ‘Group1’,’Group2’, List of
‘Group3’ custom
command
groups that
will be
migrated to
a group in
work area
toolbar.

Note:
You do not need to run this script for custom commands, this script is needed only for
the custom group commands.

b. Save the modifications and run the script using one of the following methods:

• To run the script on the command line, use the following command:

sqlcmd -S database –U user -P password -i

assistant_tc2312_custom_migration_script_mssql.sql

• To run the script using the SQL Server Management Studio, open the
assistant_tc2312_custom_migration_script_mssql.sql file in Microsoft SQL Server
Management Studio, and in the SQL Editor toolbar, click Query → Execute.

11-10 Active Workspace Administration, Teamcenter 2406

Managing user passwords using the CPS_manage_password utility

The CPS_manage_password password management utility is used for generating an encoded database
user password for the Command Prediction Service database. Changing the database user password for
Command Prediction Microservice database requires updating the same in the microservice to be able
to connect to the database. Failure to update the password results in database connection failure. This
utility encodes the given input string, which can be replaced in the [Link] file.

The Command Prediction Microservice reads the database user password from the [Link] file for
connecting to the Command Prediction Service database.

CPS_manage_password

The following options are available:

• -h | - -help - Displays help for the utility.

• -encode - Encodes input string.

• -input= - Input string.

Manage user passwords using the CPS_manage_password utility on Windows

1. Traverse to the location <microservice_root>\commandprediction-<service_version> and execute

the following command:

CPS_manage_password -encode -input=<input_string>

2. Copy the generated string with the above command and update the [Link] file to replace the
existing string with newly generated string.

3. Restart the Teamcenter Process Manager to enable the microservice to read the updated
password from the file.

Manage user passwords using the CPS_manage_password utility on Linux

1. Get the container ID of the running container for the Command Prediction Service.

docker container ls

2. Generate a new encoded password string by executing the utility inside the container.

docker exec -it <container_id> /app/CPS_manage_password -encode

-input=<input_password_string_to_encode>

Retain the generated string for further updates in [Link].

Active Workspace Administration, Teamcenter 2406 11-11

3. Stop the running container.

docker stop <container_id>

4. Get the Command Prediction Service ID.

docker service ls

5. Remove the Command Prediction Service.

docker service rm <service_id>

6. Get the secret ID for [Link].

docker secret ls

7. Remove the secret ID for [Link].

docker secret rm <secret_id>

8. Update the newly generated password string in [Link] located at

<microservice_container_root>/secrets.

9. Go to the location <microservice_container_root> and execute the following command to update

and redeploy the service.

docker stack deploy -c [Link] <stack_name>

Ensure that the new docker secret is created.

Migrating user data using the CPS_migrate_user_data utility

The CPS_migrate_user_data utility migrates MD5 hashed data for users, groups, and roles to SHA256
hashed data in the Command Prediction Service database. Before running this utility, you must use the
admin_data_export utility export the Teamcenter user, role, and group data to a file.

CPS_migrate_user_data [OPTION]

The following options are available:

-dbplat - Database platform used for Command Prediction Services such as MSSQL, ORACLE, or
POSTGRESQL.

-username - Database username.

11-12 Active Workspace Administration, Teamcenter 2406

-password - Database password.

-hostname - Database hostname.

-port - Database port.

-namedinstance - For MSSQL platform, connect with named instance instead of database port.

-instance - Command Prediction Service database instance name. In the case of the Oracle
database, the instance is SID, while in the case of POSTGRESQL and MSSQL databases, the instance
is the name of the database

-inputfile - Full file path of the [Link] file generated using the Teamcenter
admin_data_export utility.

-batchsize - Number of user profiles to be updated during the user data migration run. If not
provided, the utility migrates the data of all the users.

Migrate user data using the CPS_migrate_user_data utility

1. Run the admin_data_export utility to export Teamcenter user, group and role data.

For Windows
a. Open the Teamcenter command prompt.

b. Run the following command:

admin_data_export -u=<tc_user> -p=<password> -g=dba

-adminDataTypes=Organization -outputPackage=<export_file.zip>
For Linux
a. Open the terminal at <TC_ROOT>/bin.

b. Set TC_ROOT, TC_DATA and run <TC_DATA>/tc_profilevars for the terminal.

c. Run the following command:

/admin_data_export.sh -u=<tc_user> -p=<password> -g=dba

-adminDataTypes=Organization -outputPackage=<export_file.zip>

2. Extract the newly created ZIP file and locate the [Link] file in the
<extracted_folder>\ADMINISTRATION_DATA\Organization folder.

3. Run the CPS_migrate_user_data utility to migrate the data.

For Windows

Active Workspace Administration, Teamcenter 2406 11-13

a. Open the Command prompt at the <Microservice_Root>\CommandPrediction-<version>

folder.

b. Run the following command:

CPS_migrate_user_data -dbplat=<db_platform>
-hostname=<db_hostname> -username=<db_user>
-password=<db_password> -port=<db_port>
-instance=<db_instance> -inputfile=<path_to_organization_xml>

The log file is created in the <Microservice_Root>\CommandPrediction-

<version>\Logs\UserDataMigration folder.
For Linux
a. Get the running container ID for the Command Prediction Service.

docker container ls

b. Copy the [Link] file into the container.

docker cp <path_to_oraganization_XML_on_host>
<command_prediction_container_id>:/app/

c. Run the following command:

ocker exec -it <command_prediction_container_id> ./

CPS_migrate_user_data -dbplat=<db_platform>
-hostname=<db_hostname> -username=<db_user>
-password=<db_password> -port=<db_port>
-instance=<db_instance> -inputfile=/app/[Link]

The log file is created in a docker container in the /tmp/Logs/UserDataMigration folder.

11-14 Active Workspace Administration, Teamcenter 2406

© 2024 Siemens
12. Configuring units of measure
Introduction to units of measure
A unit of measure is a quantifiable measurement category such as length, volume, mass, angle,
pressure, and so on. A unit of measure may be needed to define an accurate bill of materials (BOM).

If unit of measure is not specified for a part, the unit each is implied, meaning the quantity parameter
value specifies the number of discrete component parts.

When adding or modifying a part, a user can choose from a list of predefined values for the Unit of
Measure parameter. An installer or system administrator defines units of measure so that parts can be
expressed in standardized units across an entire Teamcenter site. A unit of measure can be a compound
such as microjoule per kilogram kelvin.

Once a unit of measure and a quantity are specified for a part, if a user sets a preferred unit of measure
for a category, in the Parameters application the unit and value are displayed in the preferred unit of
measure.

As of Teamcenter 2406, available unit of measure values are defined using the Unit Management
System. For more information, see Configure units of measure.

Configure available units of measure

Administrators can configure the units of measure that are available across Teamcenter. This unit
management system (UMS) based on classified units is first available in Teamcenter version 2406.
A list of nearly 1400 units of measure is provided in the Teamcenter installation kit. Out of the box, only
a subset of the units are installed, depending on the applications installed. Installers and administrators
can configure the units to add, and can add new units.

1. In the Teamcenter kit or in the TC_ROOT\TD folder, find and open unit_definitions.csv.

Application columns begin with column Q (BASE). Unit rows for which an application column has
the value 1 will be considered by the ums_import_unit_definitions utility.

Note:
During initial installation, if an application is installed in the environment, unit rows for which
the application column has the value 1 are imported to the database.

2. Edit the file to ensure that the unit definitions you want to administer have the value 1 for an
application.

In the event that no class definition exists for a unit you want in your environment, create a new
row.

Active Workspace Administration, Teamcenter 2406 12-1

3. Using the edited unit_definitions.csv, run the ums_import_unit_definitions utility.

Migrate legacy units of measure to the unified measurement

system
As of version 2406, Teamcenter has an updated units of measure capability. Following upgrade of a
Teamcenter installation from a version prior to 2406, an administrator can migrate legacy BMIDE units
of measure to the new unit management system (UMS) using the ums_mapping utility. The utility links
legacy units to unit definitions in the UMS. If necessary, the linking and mapping can later be reverted.

Configure units of measure relationships

Use the following steps to create a mapping configuration file that identifies the relationship between
legacy units of measure and unit definitions in the unified measurement system.

1. In a Teamcenter command window, run the ums_mapping utility with the -analyze -report_file
option. For example,

ums_mapping -u=username -p=password -analyze

-report_file=c:\temp\mapping_config.csv

The utility examines the Teamcenter database for existing UMS unit definitions. The utility then
creates mappings between the legacy units of measure to existing unit of measure definitions in
the UMS. These mappings are created based on unit names and symbols. The utility generates the
mapping_config.csv file showing these mappings along with units for which it could not create
mappings between the systems. The file contains the following information for each unit.

Column Definition
Is Approved Remove the # character in this column to process this unit when using
-map, -unMap, or -createMap.
UOM Name The name of the unit in the legacy system.
UOM Symbol The symbol of the unit in the legacy system.
In Use A value of Yes indicates that this unit is used by an object in the legacy
system.
Action The utility action performed to create the file.
Status The unit's mapping state at the time the file was created.
Details A description of the unit's state and any recommended actions.
Unit Definition ID The ID of the unit in the UMS.
Unit Definition The name of the unit in the UMS.
Name
Unit Definition The symbol of the unit in the UMS.
Symbol

12-2 Active Workspace Administration, Teamcenter 2406

In the command window, the utility also summarizes the unit mappings between units in the
legacy and unified measurement systems.

2. Using an ASCII editor or Microsoft Excel, review the mappings in mapping_config.csv. Approve
proposed matches by removing the "#" symbol from the first column of that line of the file. Units
have the following mapping states.

Existing- Units with this state already exist in the UMS. No further action is needed for
mapped these.
Candidate- The utility proposes a mapping for the unit of measure. Legacy units with this
match status completely or partially match unit definitions in the UMS.
Multiple- The legacy unit of measure is a candidate to match more than one unit definition
match in the UMS. Determine which definition is the correct mapping for the unit and
update the .csv file accordingly.

A legacy unit of measure can map to only one unit definition in the UMS. Multiple
legacy units of measure can map to a single unit definition in the UMS.
Non- The utility could not determine a candidate mapping for the unit of measure or
matching the UMS unit definition.

If there is no matching UMS unit for a unit of measure, manually review the UMS
unit definitions in the .csv file for an appropriate definition. Update the column
information to map the unit of measure to this unit definition. If you cannot find a
match, use the ums_import_unit_definitions utility to create an appropriate unit
definition in the UMS and re-run this process to approve the mapping of the unit
of measure to this new unit definition in the UMS.

If there is no matching unit for a UMS unit definition, follow the steps in Create
units of measure later in this topic.
NA This unit of measure is specific to Classification and is not mapped. No further
action is needed for these.

3. Once you have reviewed, revised, and approved the units of measure mappings, perform a dry run
of linking the approved units of measure to unit definitions in the UMS. Use a command of the
following form

ums_mapping -u=username -p=password -analyze

-import_file=c:\temp\mapping_config.csv

The utility generates a .csv report file that shows the results that would have occurred in and actual
linking of the units approved in the mapping configuration file. Review these results to ensure the
linking will occur as you expect. Address any failures or other issues by updating the configuration
file and performing additional dry runs.

Active Workspace Administration, Teamcenter 2406 12-3

Add the unit of measure relationships to the Teamcenter database

Once you have confirmed the units of measure are mapped properly in the mapping configuration
file, you are ready to add the relationships to the Teamcenter database. Do so using a command of
the following form. (You must be a Teamcenter administrator who is a member of a group with DBA
privileges to run this command.)

ums_mapping -map -input_file=c:\temp\mapping_config.csv

-report_file=c:\temp\mapping_report.csv

This example updates the Teamcenter database with the relationships defined in mapping_config.csv.
Approved unit relationships in the file (lines with no "#" symbol in the first column) are added to the
Teamcenter database. The utility generates the report mapping_report.csv listing the updates and their
completion status.

Remove unit of measure relationships from the Teamcenter database

If you want to remove one or more relationships from the Teamcenter database, you can do so using the
ums_mapping utility. You must be a Teamcenter administrator who is a member of a group with DBA
privileges to remove these relationships.

1. To remove a limited number of mapping relationships, update the mapping configuration file
(mapping_config.csv in the earlier example) by removing the "#" symbol from the first column of
each unit for which you want to remove the mapping relationship.

2. In a Teamcenter command window, run the ums_mapping utility with the -unmap option. For
example,

ums_mapping -u=admin-username -p=admin-password

-g=dba -unmap -input_file=c:\temp\mapping_config.csv
-report_file=c:\temp\mapping_report.csv

The utility generates the report mapping_report.csv listing the removed unit relationships.

In cases where you want to remove several existing units of measure relationships from the Teamcenter
database, consider using the ums_mapping utility with the -all option. Doing so removes all existing
units of measure relationships from the Teamcenter database. After removing all relationships, restart
migrating legacy units of measure as described earlier.

To remove all existing units of measure relationships from the Teamcenter database, use a command of
the following form.

ums_mapping -u=admin-username -p=admin-password -g=dba -all

-report_file=c:\temp\mapping_report.csv

The utility generates the report mapping_report.csv listing the removed unit relationships.

12-4 Active Workspace Administration, Teamcenter 2406

Create units of measure

If the UMS contains definitions with no related unit of measure, create units of measure for the
definitions using the ums_mapping utility with the -create_uom option. Doing so creates new units
of measure with relationships to the unit definitions previously with no related definitions. These
relationships are automatically added to the Teamcenter database.

In a Teamcenter command window, enter a command of the following form:

ums_mapping -u=admin-username -p=admin-password -g=dba -create_uom

-report_file=c:\temp\unit_report.csv

The utility analyzes the UMS, creates new units for definitions without related units, and generates the
report unit_report.csv listing the created units.

Working with the unit of measure definitions file

The unit of measure definitions file specifies the attributes of each unit of measure in the Teamcenter
unit management system (UMS), combining aspects of Teamcenter units of measure and the
Classification unit management system. During Teamcenter installation and upgrade, the definitions
in this file are used to create the units of measure in the UMS. Teamcenter administrators can also use
this file with the ums_import_unit_definitions utility to manage units of measure.

The unit of measure definitions file supplied with Teamcenter is <TC_DATA>\unit_definitions.csv. Each
line in the file defines a particular unit of measure. Columns define the attributes for each unit of
measure.

Warning:
When editing the unit_definitions.csv, ensure that you do not change existing Conversion
multiplication factor and Conversion addition factor values or enter inaccurate values for these
attributes when creating new unit definitions. Inaccurate values for these attributes will cause
compromised data when converting between measurement systems.
Make sure you back up your .csv file before making any changes to the file.

As an authoring aid, an annotated .xls version of this .csv file is also available in the <TC_DATA>
directory. Instead of directly editing unit_definitions.csv, consider editing unit_definitions.xls. When
your edits are complete, save unit_definitions.xls as a comma-delimited .csv file, remove the first line
(the topmost header row) of the new .csv file, and resave the file. You can then use this .csv file to create
and manage the units of measure.

Following is a description of the unit_definitions.csv file contents.

Classification Properties
Classification properties define the attributes of a unit of measure and how it relates to other units of
measure of the same type.

Active Workspace Administration, Teamcenter 2406 12-5

ID
A unique identifier for the unit of measure. ID is referred to as the "Object ID" attribute in
Classification.
Master
A unit of measure can be associated with only one UMS object (a Classification unit definition).
When multiple units have the same dimensionality (see Dimensionality later in this topic), only
one of these units can be designated as the unit associated with the UMS object. Designate this
unit with a value of Y in this column. Set this column value for the other units using the same
dimensionality to N.
Quantity
The type of measurement, for example, length, mass, temperature, and so on. Quantity is
referred to as the "Measure" attribute in Classification.
Unit name
The name of the unit as displayed in Teamcenter.
Symbol
The scientific symbol representing the unit of measure. Symbols must be unique and used only
once in the file. Symbol is referred to as the "Unit display name" attribute in Classification.
System of Measurement
The measurement system the unit belongs to. If the unit of measure is a metric unit, identify it
as such with a value of m. Identify all other units with a value of nm (non-metric).
Base unit
The unit of measure within a quantity that is used to calculate the values of other units of
measure in that quantity. Identify the base unit of measure with a value of Y. Identify all other
units of measure in the same quantity with a value of N.
Conversion multiplication factor
The value by which the quantity's base unit must be multiplied to derive this unit of measure's
value.

12-6 Active Workspace Administration, Teamcenter 2406

Warning:
Ensure that you do not change existing Conversion multiplication factor and
Conversion addition factor values or enter inaccurate values for these attributes
when creating new unit definitions. Inaccurate values for these attributes will cause
compromised data when converting between measurement systems.

Conversion addition factor

Any value that must be added after applying the conversion multiplication factor. Conversion
addition factors typically apply only to temperature units of measure.

Ignore for Optimization

Specifies whether this unit of measure should not have its value optimized in Classification. Set
this value to Y to exclude this unit of measure from optimization. Set this value to N to include
this unit of measure for optimization.
Number of Decimal Places
The number of digits displayed to the right of the decimal when using the Classification
application.
NX Unit ID
The ID value for this unit of measure in NX.
NX Display
Specifies that the unit is part of the list of units shown in NX when creating a part.
ECLASS IRDI
The ECLASS International Registration Data Identifier (IRDI) value for this unit of measure.
Display Set
Identifies units as members of specific display set (on the MBSE Parameters tab). Set this value to Y
to include this unit a particular display set. Set this value to N to exclude this unit from a particular
display set. When multiple units have the same dimensionality, only 1 of the units can be included in
a particular display set.

Active Workspace Administration, Teamcenter 2406 12-7

The following display sets are provided with Teamcenter. You can edit these sets and create new
display sets.

Metric Display Set

Metric(SI) Display Set

Non-Metric Display Set

Base install and application specific units
When installing Teamcenter, certain basic units and units related to specific detected applications are
installed. These units are identified with a value of 1 in their respective columns. The default units
identified for installation are a balance between necessity and volume of units. Enabling all units
may be overwhelming to users in their everyday work. Edit these values as necessary for your site
during installation.

12-8 Active Workspace Administration, Teamcenter 2406

Quantity grouping
Dimensionality is a comma-separated list of values representing the physical properties of the unit.

A dimension is a property that you can measure. A unit is a way to assign a value to the dimension.
For example, length is a dimension, but you measure it in units of feet or meters. You can measure
each property with a variety of units, such as meter and inch, but each property can have only one
dimension, such as length.

The International System of Units (SI) defines the following seven base properties.

Base Property Metric Unit English Unit

Length Meter (m) Inch (in)
Mass Kilogram (kg) Pound (lb)
Time Secind (s) Second (s)
Electric Current Ampere (A) Ampere (A)
Temperature Kelvin (K) Degree Fahrenheit (°F)
Luminous Intensity Candela (cd) Candela (cd)
Amount of Substance Mole (mol) Mole (mol)

Using Dimensionality, you can express most of the physical properties as a combination of the
base properties. For example, you can express Force as a combination of mass, length, and time as
follows:

Force = Mass x Length / Time2

Therefore, the dimensionality of Force is ML/T2.

Active Workspace Administration, Teamcenter 2406 12-9

In the Dimensionality column, the dimensionality is represented by nine integers, each

representing the exponent of one of the following basic properties:

Length

Time

Temperature

Electric charge

Angle

Delta temperature

Luminous intensity

Amount of substance

For example, the dimensionality of Force is represented as 1,1,-2,0,0,0,0,0,0.

12-10 Active Workspace Administration, Teamcenter 2406

ums_import_unit_definitions
Creates, updates, and configures the display of Teamcenter units of measure.
ums_import_unit_definitions runs automatically during Teamcenter installation and can subsequently
be run by a Teamcenter administrator to manage units of measure. Siemens Digital Industries Software
strongly recommends backing up any current unit definitions file before modifying the file.

Units of measure are created and managed based on unit of measure definitions specified in a
comma-deliminated .csv file. The initial unit of measure definitions file supplied with Teamcenter is
<TC_DATA>\unit_definitions.csv. See Working with the unit definitions file for a description of this file.

After running ums_import_unit_definitions, ensure users log out of Teamcenter start new sessions to
use the updated units of measure.

Use the ums_mapping utility to map and add legacy units of measure to the Unit Management System.

SYNTAX

ums_import_unit_definitions
[-u=user-id {-p=password | -pf=password-file} -g=group]
-file=unit_def_file
-applications={app_name1,app_name_2,... | all}
[-allowOverwrite]
[[-createUOM] [-updateUOM]] | [-hideUOM] | [-showUOM]
[-dryRun]
[-h]

ARGUMENTS

-u
Specifies the user ID. The user must have Teamcenter administration privileges and be a member of
a group with DBA privileges.

Note:
If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are
authenticated externally through SSO rather than being authenticated against the Teamcenter
database. If you do not supply these arguments, the utility attempts to join an existing SSO
session. If no session is found, you are prompted to enter a user ID and password.

-p
Specifies the password.

This argument is mutually exclusive with the -pf argument.

-pf

Active Workspace Administration, Teamcenter 2406 12-11

Specifies the password file.

For more information about managing password files, see Manage password files.

This argument is mutually exclusive with the -p argument.

-g
Specifies the group associated with the user. This group must have DBA privileges.

If used without a value, the user's default group is assumed.

-file
The comma-delimited .csv file (unit_def_file) containing unit of measure definitions.
-allowOverwrite
Optional. Overwrite existing units of measure based on the definitions in unit_def_file.
-applications
Restrict updates to one or more applications (as named in unit_def_file) containing unit of
measure definitions. app_name is the string following Application: in unit_def_file For example,
set app_name to NX for the column Application:NX.

Separate multiple application names with commas. Set -applications to all to process all
applications defined in unit_def_file.
-createUOM
Optional. Create the units of measure defined in unit_def_file. If -allowOverwrite is not specified,
only new units of measure are created. If -allowOverwrite is specified, existing units of measure
are overwritten based on the definitions in unit_def_file as well. -createUOM cannot be used with
-hideUOM or -showUOM.

If -createUOM, -updateUOM, -hideUOM, or -showUOM are not specified, -createUOM is assumed.

-updateUOM
Optional. Update existing units of measure with the definitions in unit_def_file. Units of measure
defined in unit_def_file that do not currently exist will not be created. -updateUOM cannot be used
with -hideUOM or -showUOM.
-hideUOM
Optional. Suppress existing units of measure defined in unit_def_file from appearing in Teamcenter
and application lists of values. These units of measure are not removed from Teamcenter. -hideUOM
cannot be used with -createUOM, -updateUOM, or -showUOM.

-showUOM
Optional. Show units of measure defined in unit_def_file that have previously been hidden using
-hideUOM. -showUOM cannot be used with -createUOM, -updateUOM, or -hideUOM

12-12 Active Workspace Administration, Teamcenter 2406

-dryRun
Optional. Run ums_import_unit_definitions with the specified parameters without actually making
changes to the units of measure. The results of running the utility are displayed in the command
window, but no units of measure changes are made.

Siemens Digital Industries Software strongly recommends using -dryRun to validate changes before
actually creating or updating your UMS definitions.
-h
Displays help for this utility.

ENVIRONMENT

As specified in Manually configure the Teamcenter environment.

FILES

As specified in Log files produced by Teamcenter.

RESTRICTIONS

None.

EXAMPLES

• Create units of measure for all units of measure defined in a .csv file. All existing units of measure are
updated with any updated definitions.

ums_import_unit_definitions -file=c:\temp\unit_defs.csv
-applications=all

• For units of measure that are members of the Base application, update existing units of measure with
changed definitions.

ums_import_unit_definitions -file=c:\temp\unit_defs.csv
-applications=Base -allowOverwrite -updateUOM

• Suppress units of measure in the Base application from appearing in lists of values.

ums_import_unit_definitions -file=c:\temp\unit_defs.csv
-applications=Base -hideUOM

• Display units of measure in the Base application in lists of values.

ums_import_unit_definitions -file=unit_definitions.csv
-applications=Base -showUOM

Active Workspace Administration, Teamcenter 2406 12-13

ums_mapping
As of version 2406, Teamcenter employs an updated unit management system (UMS). Following an
upgrade of a Teamcenter installation from a version prior to 2406, use this utility to map legacy BMIDE
units of measure to definitions in the UMS.

SYNTAX

ums_mapping [-u=user-id {-p=password | -pf=password-file} -g=group]

[-analyze {-report_file= | -input_file=}config_file] |
[-map -input_file=config_file -report_file=map_report_file] |
[-unmap {-input_file=config_file | -all} -report_file=unmap_report_file]
[-create_uom -report_file=create_uom_report_file]
[-h]

ARGUMENTS

-u
Specifies the user ID.

To use the -map, -unmap, and -create_uom arguments, this is a user with Teamcenter
administration privileges.

-p
Specifies the password.

This argument is mutually exclusive with the -pf argument.

-pf
Specifies the password file.

For more information about managing password files, see

For more information about managing password files, see Manage password files.

This argument is mutually exclusive with the -p argument.

-g

12-14 Active Workspace Administration, Teamcenter 2406

Specifies the group associated with the user.

To use the -map, -unmap, and -create_uom arguments, this is a user who is a member of a group
with DBA privileges.

If used without a value, the user's default group is assumed.

-analyze
Evaluates the legacy existing units of measurement system.

Use -analyze with -report_file to examine the Teamcenter database for existing units of measure
and their definitions. The utility attempts to map legacy units of measure to units of measure in the
UMS. This mapping is performed based on unit names and symbols.

The utility generates the .csv file specified by -report_file=config_file showing these mappings along
with units that could not be mapped between the systems. Confirm and update the mappings in this
file as described in Migrate legacy units of measure.

The .csv file contains the following mapping information:

Column Definition
Is Approved Remove the # character in this column to process this unit when using
-map, -unMap, or -createMap.
UOM Name The name of the unit in the legacy system.
UOM Symbol The symbol of the unit in the legacy system.
In Use A value of Yes indicates that this unit is used by an object in the legacy
system.
Action The utility action performed to create the file.
Status The unit's mapping state at the time the file was created.
Details A description of the unit's state and any recommended actions.
Unit Definition ID The ID of the unit in the UMS.
Unit Definition Name The name of the unit in the UMS.
Unit Definition The symbol of the unit in the UMS.
Symbol

After confirming and completing the mappings in the .csv file, use -analyze with -input_file to
generate a dry-run report showing what the results will be if you use the .csv file to map the
approved mappings.
-map
Updates the Teamcenter database references between the legacy unit of measure line items with
the UMS line items defined in the configuration file specified with -input_file.

Active Workspace Administration, Teamcenter 2406 12-15

Approved units in the file (units with no "#" symbol in the first column) are updated in the
Teamcenter database. The utility generates the report specified with -report_file listing the updates
and their completion status.
-unmap
Removes Teamcenter database relationships between legacy units of measure and the UMS.

Using -input_file with -unmap removes specific unit of measure relationships. Relationships for
approved units in the file (units with no "#" symbol in the first column) are removed from the
Teamcenter database.

Using -all with -unmap removes all existing units of measure relationships from the Teamcenter
database. You could then restart migrating legacy units of measure as described in Migrate legacy
units of measure to the unit management system.

The results of either removal is detailed in the file specified by -report_file.

-create_uom
Analyzes the UMS and creates new units for definitions without related units. Results are listed in the
report specified by -report_file.
-h
Displays help for this utility.

ENVIRONMENT

As specified in Manually configure the Teamcenter environment.

FILES

As specified in Log files produced by Teamcenter.

RESTRICTIONS

None.

EXAMPLES

• Analyze the Teamcenter database for existing UMS unit definitions. Create a mapping configuration
file containing mappings between the legacy units of measure to existing unit of measure definitions
in the UMS.

ums_mapping -u=username -p=password -analyze

-report_file=c:\temp\mapping_config.csv

• Perform a dry run of linking approved units of measure to unit definitions in the UMS.

12-16 Active Workspace Administration, Teamcenter 2406

ums_mapping -u=username -p=password -analyze

-report_file=c:\temp\mapping_config.csv

• Add unit of measure relationships to the Teamcenter database.

ums_mapping -u=admin-username -p=admin-password

-g=dba -map -input_file=c:\temp\mapping_config.csv
-report_file=c:\temp\mapping_report.csv

The utility generates the report mapping_report.csv listing the updates and their completion status.

• Remove unit of measure relationships from the Teamcenter database

ums_mapping -u=admin-username -p=admin-password

-g=dba -unmap -input_file=c:\temp\mapping_config.csv
-report_file=c:\temp\mapping_report.csv

The utility generates the report mapping_report.csv listing the removed unit relationships.

• Create new units of measure and add the new units to the Teamcenter database.

ums_mapping -u=admin-username -p=admin-password -g=dba -create_uom

-report_file=c:\temp\unit_report.csv

The utility generates the report unit_report.csv listing the created units.

Active Workspace Administration, Teamcenter 2406 12-17

12-18 Active Workspace Administration, Teamcenter 2406

Subscriptions are objects being followed using the Follow command. When objects are changed in
Active Workspace, a number appears to the right of the Alert button indicating when subscription
notifications are received. Users click the Alert button to view their notifications.

What can I configure?

You can configure the following aspects of subscriptions:

• Notifications for a two-tier environment.

• Subscribable properties.

• Email and news feed notifications.

• Number of objects to which a user subscribes.

• Number of events to which a user follows.

• Number of days news feed notifications are retained.

• Purge of old news feed notifications.

What do I need to do before configuring?

Before you can configure subscriptions, you must install the features. Install the following from the
Features panel of Teamcenter Environment Manager (TEM):

• Subscription (client)

Installs the user interface elements for viewing subscription notifications in Active Workspace.

Select Active Workspace→Client→Subscription.

• Subscription (server)

Installs the server-side definitions for subscriptions.

Select Active Workspace→Server Extensions→Subscription.

Active Workspace Administration, Teamcenter 2406 13-1

Tip:
After installing new features, you must rebuild the Active Workspace application.

Where can I find out more about subscriptions?

See Subscription Administration in the Teamcenter documentation.

What do subscription notifications look like?

The following is an example of notifications.

Configuring notifications
Configuring notifications for a two-tier environment

To use the notification functionality in a two-tier environment, you must manually configure the
TC_MESSAGING_MUX_URL environment variable. Otherwise, alert information about new or changed
messages is not sent from the server program to the user. This environment variable is configured
correctly for four-tier environments. However, in stand-alone two-tier environments and dedicated hosts
used for servers, such as the Subscription Manager daemon or the Dispatcher module, this environment
variable must be configured manually:

TC_MESSAGING_MUX_URL=protocol://host:mux_port

13-2 Active Workspace Administration, Teamcenter 2406

host is the address of the host on which a server manager is installed, and mux_port is the value of the
mux port set when the server manager was installed.

The following are examples of the configuration:

• On Microsoft Windows machines, add the following line to the tc_profilevars.bat file:

set TC_MESSAGING_MUX_URL=[Link]

• On Linux machines, add the following line to the tc_profilevars file:

TC_MESSAGING_MUX_URL=${TC_MESSAGING_MUX_URL:=[Link]

Configuring notifications for a four-tier environment

If you have multiple server managers in a four-tier deployment, the value of the
TC_MESSAGING_MUX_URL environment variable must depend on whether your environment uses a
shared TC_DATA directory or unique TC_DATA directories:

TC_MESSAGING MUX_URL=protocol://host:mux_port

If the four-tier deployment shares the same TC_DATA directory for all server managers in the
environment, the TC_MESSAGING_MUX_URL host must be set to localhost.

If the four-tier deployment does not share the same TC_DATA directory (this is, each server manager
has its own TC_DATA), the TC_MESSAGING_MUX_URL host must be set to the host on which the server
manager is installed.

Configuring subscribable properties

If you want users to only subscribe to certain properties on subscribable objects, such as an Item or
ItemRevision, use the Subscription Properties tab in Subscription Administration in Teamcenter to
configure the properties on which users can subscribe.

For example, using the Subscription Properties tab, you can configure several ItemRevision properties
to make them available to users.

When configuring subscribable properties, consider the following:

• If no configuration is defined on a subscribable object, all properties are available to Active Workspace
users for defining subscription criteria.

• A subtype inherits the configuration of the parent type unless it has its own configuration.

• If a property is turned off from subscription, but existing subscriptions utilize that property, then
these subscriptions continue to have the property in the criteria until the subscriber manually

Active Workspace Administration, Teamcenter 2406 13-3

removes it. Though existing criteria continue to apply, the Active Workspace user cannot define a
new subscription using that property.

Setting subscription notification preferences

Setting email and news feed preferences

Set the following preferences to control notification behavior in Active Workspace:

• SCM_notification_mode

Specifies whether you want notifications to be delivered by email or news feed or both.

ValueDescription
1 Deliver notifications by email.
2 Deliver notifications by news feed.
3 Deliver notifications by both email and news feed.

• AWS_Notifications_Polling_Interval

13-4 Active Workspace Administration, Teamcenter 2406

Specifies (in minutes) how frequently the system is polled for notifications, site-wide. The default
setting is 5. If this preference is set to 0, the Alert navigation button is disabled.

The number of notifications appears next to the Alert when:

• Print notifications are received.

• News feeds to which you have subscribed are received.

• There are existing unread notifications.

Setting periodic digest preferences

In addition to receiving notification by email or news feed, users can also select to receive daily
and weekly digests that contain subscription notifications by selecting Set Daily and Weekly Digests
(Collate all notifications) from the profile page.

The periodic digest collates all the daily notifications into a single email and it collates all notifications
from the week into a weekly digest that is sent as a single email.

Set the following preferences to control periodic digest notification:

• SCM_notification_digest

Specified whether notifications are delivered as a digest. If this preference is set to 1 (default), digest
notifications are disabled at the site level.

• Active Workspace

Once the user enables the digest from the profile page, the digest is enabled for that user.

• Rich client

The user can create a User preference to override the value to set it to 2 to enable the periodic
digest.

• SCM_notification_digest_file_size_limit

Active Workspace Administration, Teamcenter 2406 13-5

Specifies the digest notification file size limit in megabytes (MB). The default value is 1 MB.

When the size of the collated digest notification exceeds the specified size limit, the digest is sent in
multiple parts.

This applies to both email and news feed notification methods.

• SCM_execution_day

Specifies the day the weekly digest is triggered. The default is Sunday.

• SCM_execution_time

Specifies the time the digest is triggered. The default is 15:00.

• WEB_default_site_server

When set, the digest contains the link for the subscription.

• Active Workspace

Use the format localhost:7001; for example, [Link]

• Rich client

Use the format WEB_SERVER_HOST:PORT; for example, [Link]:7001.

Configuring subscription to multiple objects

Since users can subscribe to multiple objects, you can use the AWC_followMultiObject_max preference
to control the number of objects to which a user subscribes at a time. By default, this preference is set to
5.

Configuring My Events
Users can use My Events to follow multiple events on an object. Because it is important to control the
number of events to which a user follows at a time to prevent users from creating many subscriptions,
use the following site preferences:

• AWC_followMultiEventConfig_max

Controls the maximum number of events a user can select on an object to follow. By default, this
preference is set to 5.

• AWC_followMultiEventConfiguredEventTypes

13-6 Active Workspace Administration, Teamcenter 2406

Controls default configured event types for multiple events. Valid values are
__Attained_Release_Status, __Attach, and __Item_Rev_Create.

Configuring news feed retention

Use the SCM_newsfeed_purge_threshold site preference to configure the number of days user news
feed notifications are retained before being purged. The default setting is 0 days, which retains the news
feed messages always. If you remove the preference value, the Retain News Feed (In Days) field still
displays on the Profile page.

Users can view their news feed retention time by going to the SUBSCRIPTIONS area of their Profile
page. From there, they can configure their threshold value. Otherwise, the purge is based on the site
configuration.

Purging news feed notifications

You can purge old news feed notifications using the clear_old_newsfeed_messages command-line
utility. To process only read messages, enter the following:

clear_old_newsfeed_messages -u=Tc-admin-user -p=password -g=group

-process_only_read_messages

This utility purges messages based on the purge threshold that you set using the
SCM_newsfeed_purge_threshold preference.

Active Workspace Administration, Teamcenter 2406 13-7

13-8 Active Workspace Administration, Teamcenter 2406

Active Collaboration, accessed using the DISCUSSIONS tile on the home page, or the Discuss button on
the navigation bar, is an internal collaboration application in the web client that allows:

• Discussions on one or more objects, such as items, parts, and documents.

• Threaded discussions, consisting of both public and private messages, with multiple users discussing
any given workspace object.

• Comments with embedded images (GIF, JPEG, JPG, and PNG).

• Product snapshots (3D data associated with a product), which requires Teamcenter lifecycle
visualization.

• Following and unfollowing capabilities on a single discussion or all discussions on an object.

• Receiving notifications via the Alerts button.

• Filtering and editing of existing discussions.

• Tracking discussions with an assigned status (Open, In Progress, and Closed) and priority (Low,
Medium, and High).

• Receiving automated messages that show changes to a discussion or action, such as a status change,
the addition or removal of participants, and changes to privacy.

• Assigning role-based permissions to specific users to delete discussions that are no longer needed.

Active Workspace Administration, Teamcenter 2406 14-1

What do I need to do to install Active Collaboration?

Install Active Collaboration from either Teamcenter Environment Manager (TEM) or Deployment
Center.

From the Applications panel of Deployment

From the Features panel of TEM: Center:
• Active Collaboration Client • Active Collaboration

Select Active Workspace→Client→Active Select Teamcenter→Teamcenter→Active

Collaboration Client to install the user interface Collaboration to install the Active
elements for viewing communication in the web Collaboration feature in the web client.
client.
• Microservice Node
• Microservices
Confirm that the Microservice Node
Select Teamcenter GraphQL Service. component is configured.

• Active Collaboration (server)

Select Active Workspace→Server

Extensions→Active Collaboration to install the
server-side definitions for communication in the
web client.

14-2 Active Workspace Administration, Teamcenter 2406

© 2024 Siemens
Note:
If you have existing questions, replies, and comments from Active Collaboration 5.0 or earlier or
Active Collaboration for Retail 6.0 or earlier, you may optionally perform a one-time migration of
these questions, replies, and comments to Discussions using the ac0_migrate_s2cldata utility.

What can I configure?

You can configure the following preferences.

Preference Definition
Ac0AutoMessagesEnabled Specifies whether automated messages are enabled. When
set to true, automated messages are generated on the
Active Collaboration Discussion panel whenever:

• A participant is added to or removed from the discussion.

• A tracked discussion's status is changed.

• There are changes to privacy.

• A snapshot is removed from the discussion (no longer

shared in the discussion).

The default value is true.

Ac0DeleteDiscussionGroupRole Grants permission to users of specified groups and roles to
delete discussions that are no longer needed. Valid values
are in the format group_id/role_id.
You can have multiple combinations, for example:

The default is dba/DBA.

Ac0EnableEmailDiscussionNotifications Grants users the ability to enable the email
notification setting in their user profile. You must
specify the Mail_server_name, Mail_server_port, and
Mail_OS_from_address preferences before setting the
value of this preference to true. You may also set additional
email preferences for your site.

Active Workspace Administration, Teamcenter 2406 14-3

Preference Definition
When set to true, users can select Notify me by email for
discussion activity on their user profile page. The default
value is false.
Ac0EnableTrackedDiscussions Specifies whether Tracked discussions are enabled. When
set to true, a discussion can be set to tracked by selecting
the Tracked check box. This enables the Status and Priority
fields.
The default value is false.
Ac0SnapshotDiscussionsEnabled Specifies whether 3D snapshots can be shared in
discussions.
When set to false, users cannot create a discussion
containing a 3D snapshot.
When set to true, users can create discussions using:

• Previously captured product snapshots.

• The Capture Snapshot icon when creating a new

discussion from the 3D tab on an assembly where
visualization is installed.

The default value is true.

Enable users to use snapshots shared in discussions

To enable your users to use snapshots shared in discussions, you must configure two access
control lists (ACLs) in either the rich client or the web client. Use Access Manager to create
a SnapshotDiscussionAccessor rule and a PrivateVisSessionDiscussionACL rule. These enforce
participant checks and give permissions to those participants to view a snapshot shared in a discussion.

Add the SnapshotDiscussionAccessor rule in the following location:

14-4 Active Workspace Administration, Teamcenter 2406

© 2024 Siemens
In the following location, remove the existing PrivateAppSessionACL rule. Then, add the
PrivateVisSessionDiscussionACL rule.

Active Workspace Administration, Teamcenter 2406 14-5

14-6 Active Workspace Administration, Teamcenter 2406

© 2024 Siemens
15. Settings and performance
Manage system settings and performance
There are many utilities and settings that help you maintain the health and performance of your site.

Troubleshooting

Perform many basic tasks including retrieving software release versions, resetting your gateway server,
monitoring the browser activity, and so on.

Client performance

Discover settings and concepts that may help improve client performance.

Preferences

Learn about how Teamcenter and Active Workspace store various settings as preferences.

Data model settings

Learn about various constant types that are part of the data model.

Server-side utilities

Gain an overview of certain Teamcenter server command-line utilities to help monitor and manage your
site.

Troubleshooting

Retrieving Active Workspace client and server versions

Information about the running Active Workspace client and server, as well as the Teamcenter server
version, site ID, and database ID to which they are connected is available when you are logged in.

To retrieve version information, click Help > About.

Your results will vary, but following is an example of the results.

active-workspace@5.0.0 (Active Workspace Client (Staging Environment))

afx@4.1.0-361 (Siemens Web Framework)
Client Build: Wed May 06 2020 [Link]
Server Build: aw5.0.0.13x.2020050601;...

Active Workspace Administration, Teamcenter 2406 15-1

Server Version: P.13.0.0.20200429.00

Site: IMC--1821067151 (-1821067151)
Database: tc
User Session Logfile: [Link]

General troubleshooting

Note:
If the Active Workspace client exhibits unexpected behavior, it is always good practice to clear
the browser cache, and try the operation again. This is particularly important when server-side
changes are made, such as updating to a new version of Active Workspace.

Issue Possible resolution

No server Tune the tcserver pool size using the PROCESS_WARM parameter. For details, see
available error System Administration in the Teamcenter collection.
Intermittent Perform one of the following:
image loading
issues • On the server, configure the web application server to exclude the problematic
cipher. For example, if you have a jetty server:

1. In a text editor, open the jetty\etc\[Link] file and add the following
lines after the <Set name="TrustStorePassword"xxx</Set> line:

<!-- avoid IE TLSv1 issue by excluding the problematic cipher

-->
<Set name="ExcludeCipherSuites">
<Array type="[Link]">
<Item>TLS_RSA_WITH_AES_128_CBC_SHA</Item>
</Array>
</Set>

2. Save the file.

3. Restart the Jetty server.

The steps for other servers will vary.

• On the client, configure the browser to not use TLS 1.0.

Upload file size The Active Workspace gateway sets a default maximum file size of 128Mb.
exceeded max
limit error during maxUploadFileSizeLimit: 134217728
file uploads
To upload larger files, Siemens Digital Industries Software recommends that you use
Data Share Manager.

15-2 Active Workspace Administration, Teamcenter 2406

Issue Possible resolution

Otherwise, if you only need a small Increase in file size, you can modify the
maxUploadFileSizeLimit setting in the gateway's config file.

AW ROOT/microservices/gateway-nnn/[Link]

When increasing this size, you must consider the capabilities of your hardware and
other software. Test any new values thoroughly before changing your production
environment.
After making any changes to this file, you must restart the gateway to implement
the changes.
Users working The Active Workspace administrator should verify that the tcSOAURL parameter is
with Active set correctly in the [Link] file.
Workspace
experience 403 1. Open the [Link] file in a text editor. The [Link] file located in the web
errors when application file ([Link] for Java or [Link] for .NET).
accessing
thumbnails, files, 2. Search for the following:
or the viewer.
(The 403 error
<filter-name>TCLoginVerifier</filter-name>
may only be
visible in the
network page of 3. If necessary, update the value of the tcSOAURL parameter so that it is the same
the browser’s as the value used for the ProxyServlet redirectURL parameter, which is also
developer tools.) specified in the [Link] file.

4. Save the file and close the text editor.

5. Redeploy the application.

Active Workspace Ensure the following:
does not display
the same 1. Set the operating system of the computer running Active Workspace to the
language (locale) correct locale.
as the
Teamcenter 2. Set the browser running Active Workspace to the correct locale.
server.
3. Ensure that the web application file is set to the correct locale.

View Active Workspace performance data

Use the Performance Monitor command to view performance and optional telemetry data.

When you use the Performance Monitor, it opens a panel and reports to the browser console about
memory usage, overhead times, DOM node count, and so on. Additional information may be available

Active Workspace Administration, Teamcenter 2406 15-3

depending on which components you have installed in your Teamcenter environment. Close the panel
to stop tracking the statistics.

Select the Performance Monitor command.

15-4 Active Workspace Administration, Teamcenter 2406

Additionally, you can run the Speed Test to see your bandwidth and latency to the server.

Active Workspace Administration, Teamcenter 2406 15-5

What else should I know?

In the detailed view provided in the console output, all values that are preceded by an asterisk will be
reported to Siemens Digital Industries Software, if analytics is enabled.

Example:
*ScriptingTime: "[Link]"

Verify the Active Workspace gateway and other microservices

Use the ping functionality to check the various components of the Active Workspace gateway
architecture, and verify connectivity.

[Link]

You can disable this functionality by changing the pingEnabled setting to false in the gateway
[Link] file.

AW ROOT/microservices/gateway-x.x.x/[Link]

15-6 Active Workspace Administration, Teamcenter 2406

"pingEnabled": false

Tip:
You must restart the gateway to apply the change.

Resetting the Active Workspace gateway and microservices

When you make changes to the configuration files for the Active Workspace gateway and
microservices, you must restart them for your changes to be recognized.

Make sure the FMS server cache (FSC) service is running before you start the Active Workspace gateway.

Windows

On Windows, all of the gateway and microservices on a given machine are managed by a single
multi-threaded Windows service. To implement your configuration changes, restart the service using the
Services control panel:

Or from the command line:

net stop "Teamcenter Process Manager" && net start "Teamcenter Process
Manager"

Caution:
You must use Microsoft Services to start the service. Do not run the service script directly.

Linux

On Linux, the gateway and microservices are manged by Docker. Remove and recreate the gateway
services and config. The other services will restart in turn.

• Locate the gateway service and remove it.

Active Workspace Administration, Teamcenter 2406 15-7

TC_ROOT/container> docker service ls | grep gateway

wfvrc598nkbz config1_MS_STACK_gateway
replicated 1/1 localhost:5000/teamcenter/afx-gateway:1.9.0
TC_ROOT/container> docker service rm wfvrc598nkbz
wfvrc598nkbz
TC_ROOT/container>

• Locate the [Link] config and remove it.

TC_ROOT/container> docker config ls | grep [Link]

e9ldu5xqhhwsya7t4i22skr9u config1_MS_STACK_config.json
TC_ROOT/container> docker config rm e9ldu5xqhhwsya7t4i22skr9u
e9ldu5xqhhwsya7t4i22skr9u
TC_ROOT/container>

• Deploy the [Link] Compose file.

TC_ROOT/container> docker stack deploy -c [Link] config1_MS_STACK

Creating config config1_MS_STACK_config.json
Creating service config1_MS_STACK_gateway
TC_ROOT/container>

Start up race conditions

It is recommended to start the gateway after any graphQL services have had a chance to stabilize. The
gateway will make several attempts before giving up, but in some cases this will not be enough. You can
adjust the number of attempts made in the gateway's [Link] file. Each attempt is 15 seconds.

"graphql": {
"endpoints": [
"darsi",
"tcgql"
],
"attempts": 5
},

This problem is more prevalent on Linux and Docker and especially if all of your gateway services are
installed on the same machine.

Monitoring browser activity

When you press the F12 key, a window displays the developer tools provided with your web browser.
You can use these tools to monitor browser activity when using Active Workspace.

15-8 Active Workspace Administration, Teamcenter 2406

Note:
These tools are not provided by the Active Workspace client. See your web browser documentation
for complete information about how to use the tools accessed with the F12 key.

Performance and settings

Enabling browser caching

When thumbnail images are displayed in Active Workspace, the image is loaded from the FMS system
server using a file read ticket. Each time you display the same thumbnail, a new ticket is created. You
can, however, enable browser caching so that the first time an image is loaded it is saved in the cache.
This improves performance if the image is loaded again within a specified time period in the same
session.

Enable browser caching

In Teamcenter, set the Ticket_Expiration_Resolution preference to the maximum number of seconds

an image could be saved in the cache.

Essentially, the preference value defines the expiration time resolution of the file read ticket. For
example, if you load a thumbnail image at 1:00 p.m., a file read ticket is created. If the value of the
preference is set to 7200, the image remains in the browser cache for 7200 seconds (2 hours) after 1:00

Active Workspace Administration, Teamcenter 2406 15-9

p.m. So, any time that image is loaded within the next 2 hours, the same ticket is used. If the image is
loaded again after 2 hours, a new ticket is created.

The current default value for this preference is 7200 seconds. Previous versions of Teamcenter used a
default value of 1 second.

Working with large files in Active Workspace

During normal use, the Teamcenter web tier maintains a user's Teamcenter session because the Active
Workspace gateway is sending regular user requests. But during a file upload, there is no explicit
communication from the gateway to the web tier. When transferring very large files, it is possible that it
takes more time than the Teamcenter session timeout setting, and the web tier will time out during the
operation.

To avoid this issue, increase the web tier's timeout setting to the time it typically takes to transfer files of
that size.

One thing to note is that even without any user activity, the Active Workspace gateway still sends a
keep=alive ping to the web tier every 2 hours. Because of this, even if you need more than two hours for
file transfers, you can set your web tier timeout to just over 2 hours and the automatic gateway ping will
keep the session alive indefinitely.

Using Deployment Center, navigate to your environment's components and select the web tier. Click
Show all parameters to display the values for the web tier's timeout setting.

After making any changes, you must redeploy and run the updated scripts on the appropriate systems.

Compressing images for loading them quickly

Image files are used in Active Workspace for tiles, preview images, thumbnails, breadcrumbs, and so
on. Image resolution is the clarity with which you can view the image with distinct boundaries. The
resolution of the image depends on the number of pixels; more pixels correspond to more clarity, but
also increases the size of the image. Large images take a lot of time for rendering and viewing.

To render images not only quickly but also with high clarity in Active Workspace, you can compress them
and reduce their sizes without distorting the quality. You can manage the quality, sharpness, color, and
accuracy of the images with lower resolutions. You can generate low, medium, and high resolutions of
the original uploaded image while maintaining their aspect ratio. You can also define custom resolutions
for the images.

15-10 Active Workspace Administration, Teamcenter 2406

Configure image resolution

You can compress images in Active Workspace used for tiles, preview images, thumbnails, breadcrumbs,
and so on. This reduces their size without distorting the quality. Following are the prerequisites for
configuring image resolution in Active Workspace:

• Teamcenter Visualization with Mockup and Convert & Print features.

• Dispatcher Server and Dispatcher Client components under Teamcenter Enterprise Knowledge
Foundation are installed using Teamcenter Environment Manager.

• Image translator installed using the Teamcenter Environment Manager.

To compress images:

1. Enable the image compression feature using the TC__image_compression_enabled preference in

Teamcenter rich client. The default value for this feature is set to false.

2. Configure the resolution values in the TC_image_compression_types preference in Teamcenter

rich client.

The out-of-the-box (OOTB) values are:

• 64px::Low

• 300px::Medium

• 600px::High

You can also define custom values for images, such as 1200px::LARGE or 2800px::EXTRALARGE.

These values are for the height of the translated image, and the appropriate width is automatically
adjusted by the image translator based on the aspect ratio of the original image.

3. To specify the default image to be used for scaling across Active Workspace application, set the
value for the AWC_default_image_resolution preference. The default OOTB value is Medium.

4. To customize the image for the Overview tab:

In the tc_xrt_Preview tag, specify the value for the default image:

<section titleKey="tc_xrt_Preview">
<section titleKey="tc_xrt_Preview">
<image resolution=”<user_input>” source="thumbnail"/>
</section>

• If no image resolution is defined, the system resolves to a high resolution image.

Active Workspace Administration, Teamcenter 2406 15-11

• If the resolution preference value is Medium, the system resolves to medium resolution.

• If image resolution is an undefined or invalid resolution type, the system resolves to high
resolution.

• If the image resolution is a custom value as defined in the TC_image_compression_types

preference, it resolves to the specified custom resolution value. For example, if you specify
2800px::EXTRALARGE as the image resolution, the image resolves to the custom value
EXTRALARGE.

Note:
The values for image resolution are not case sensitive.

Preferences

Why do I need preferences?

You can use Teamcenter preferences to control various aspects of Teamcenter's behavior and
appearance.
Following are only a few examples of what preferences control:

• Whether or not live updates are allowed.

• Password requirements when not using LDAP.

• Which XML rendering template (XRT) to use.

• Which query to use as the default quick access query.

Siemens Digital Industries Software recommends browsing through the list of preferences to see which
ones might be useful to you. Each preference's definition will document its use.

How do preferences work?

At their core, preferences are simply a way to store information. They are similar to environment
variables, except that they operate with several layers of permissions.

Overview

Each preference consists of two major components, a definition and instances.

15-12 Active Workspace Administration, Teamcenter 2406

A preference definition along with all of its preference instances are together considered to be a
preference.

The preference definition is like a blueprint. It defines the nature of the preference and
is used to create the instances at the various locations. Even though it may define a
Definition default value, the definition itself is never retrieved or read as a preference. If there are
no instances of this preference, there is no value.
A preference instance created at the site location applies to everyone logged in to
Site
Teamcenter unless overridden.
There can be only one site instance.
Any preference instances created at the group location apply only to users who are
Group
currently logged in as that group, and they supersede site preferences.
There can be one group instance created for each group.
Any preference instances created at the role location apply only to users who are
Role
currently logged in as that role (regardless of group), and they supersede site and
group preferences.
There can be one role instance created for each role.
Any preference instances created at the user location apply only to that user, and they
User
supersede site, group, and role preferences.
There can be one user instance created for each user.

Active Workspace Administration, Teamcenter 2406 15-13

Preference definition

You use the preference definition to create the overall limits and restrictions on the preference as well as
setting the default value. Think of this as an abstract template from which the preference itself will be
instantiated. Following are the fields used to define a preference definition:

Name The name of the preference. Naming patterns help organize the preferences and give
an idea of what they do even before you read the description. See the list of existing
preferences for examples.
Protection Determines where and by whom it can be instantiated.
Scope
Type Specify the preference value type.
Multiple Specify if this preference can hold multiple values.
Description Explain the use of the preference. What does it control? What format is expected for
the values? Etc.
Value Specify the default value that an instance will contain when initially created.
Environment Retrieve the value from an OS environment variable of the same name.
Category Organize related preferences based on their category. There are many existing
categories you can use, or you can create your own.

Preference instance

You create a preference instance from its definition. When you create a new instance of a preference it
must belong to a location. This location specifies when it is active and its priority in the hierarchy. You
cannot create a preference instance if the protection scope does not allow it.

When referring to preference instances, it is common to shorten the phrase. For example, the
preference instance in the Engineering group location is commonly referred to as the Engineering group
preference.

When you create a new preference, you specify two things:

Location Locations are where the preference instances reside. You can create preference
instances at the following locations:

• User
• Role
• Group
• Site / System
Value You can keep the default value from the definition or specify a new one.

15-14 Active Workspace Administration, Teamcenter 2406

Preference locations

• User

This assigns the instance to a specific user. These are commonly the preferences that Teamcenter uses
to track things like column widths in the rich client, or most recently searched text, for example.

Although you can control your active preferences like style sheet registration down to the user level, it
is normally recommended that you keep those kinds of settings to the Group level or higher. It makes
things easier when people move in and out of groups and roles.

• Role

You can control the behavior based on a user's role. This is handy for things such as style sheets.
Keep the consumer's page simple while being able to provide the information the author or approver
needs.

• Group

Similar to the Role location, you can control the behavior at the next step up, at the group level.

• Site / System

Preferences created at these locations apply to everyone. This is typically where you instantiate
preferences that control system-wide behavior or default behavior that can be overridden at the
group, role, or user level.

Site preferences only allow a single instance, but a dba can change the protection scope of a site
preference to something else.

System preferences do not allow their protection scope to be changed, even by a dba. In all other
ways, they behave like a site preference.

Caution:
An existing non-system preference may be changed into a system preference by a dba, but once
it has been changed, it cannot be changed back. If you want to change it, it must be deleted
and re-created.

Customer-facing preferences

You control an aspect of the UI or behavior directly by making changes to the preference. Examples
of these preferences are configuring default paste relations, which style sheets are used in a given
situation, or how the Dispatcher handles certain file types.

Active Workspace Administration, Teamcenter 2406 15-15

Internal preferences

Teamcenter uses preferences extensively to remember application parameters, like column width. Even
though you can see and possibly modify the values of these preferences, it is not advised to do so.

An example of preference hierarchy

Everything in this example is based on a single preference, one which registers a style sheet to a
business object for the summary view. It could be any preference as all preferences behave the same
way. Since this preference definition's protection scope is User, you can create instances at the Site,
Group, Role, and User location. This means you can control its value based on your users' current
group, role, or even user name.

Example: I want the summary view's property layout for item revisions to depend on my
users' login information

Following are the details of this example.

• You have three groups: Engineering, Manufacturing, and Testing.

Each group has three roles: Manager, Designer, and Viewer.

• You want a default style sheet that everyone will use unless otherwise specified.

• Your technical users need an extended set of properties.

• Your managers need a page of workflow information.

• Your designers need classification information.

• You have users that just need a simplified layout for viewing.

• You have Conner. Conner is a power-user.

Conner needs a special layout regardless of which group or role he's in.

Style sheet datasets

Five style sheet datasets are considered.

ItemRevSummary
Configured to be the default style sheet for the Item Revision summary page. This applies to
everyone unless overridden.
IRSumTech
Configured to provides the extra properties for the Engineering and Manufacturing groups, but not
for any other groups.

15-16 Active Workspace Administration, Teamcenter 2406

IRSumMgr
Configured to display workflow information for the Manager role, regardless of group.
IRSumDes
Configured to show the classification trace for the Designer role, regardless of group.
ConnersIRSum
Configured for Conner. Conner has his own requirements

Preference instances

Assign the style sheets to the various groups and roles, and even users if desired, by creating each
preference instance with the value pointing to the respective style sheet. In this example, there are 6
preference instances created.

User Conner: ConnersIRSum

preferences
Role Manager: IRSumMgr
preferences
Designer: IRSumDes
Group Engineering: IRSumTech
preferences
Manufacturing: IRSumTech
Site value: ItemRevSum
preference

The Viewer role and the Tester group have no preference instances created for their location.

How does Teamcenter choose which preference to use?

In this example, Alice selects a DocumentRevision business object and uses the Summary tab. When
she does this, Teamcenter performs a few steps to determine which style sheet to use.

Active Workspace Administration, Teamcenter 2406 15-17

1. Based on the object type and the view location, the system knows the name of the preference
instances to retrieve.

In this example, [Link].

There are two instances: one at the Site location, and one at the Manager Role location.

2. Based on the user's current session information, Teamcenter chooses the appropriate preference
instance.

Less specific locations are overridden by more specific locations.

3. The value of the chosen preference instance is read, providing the name of the style sheet to
retrieve.

4. Teamcenter uses the style sheet to render the view.

15-18 Active Workspace Administration, Teamcenter 2406

Result

Your users see a different set of information based on what group or role they are in because the client
uses different style sheets.

User - Group / Role Preference instance build-up Resulting style sheet

Alice — Engineering / Manager Alice: none IRSumMgr
Manager: IRSumMgr
Engineering: IRSumTech
Site: ItemRevSum
Ted — Manufacturing / Manager Ted: none IRSumMgr
Manager: IRSumMgr
Manufacturing: IRSumTech
Site: ItemRevSum
Sue — Testing / Manager Sue: none IRSumMgr
Manager: IRSumMgr
Testing: none
Site: ItemRevSum
Bob — Engineering / Designer Bob: none IRSumDes
Designer: IRSumDes
Engineering: IRSumTech
Site: ItemRevSum
Carol — Engineering / Viewer Carol: none IRSumTech
Viewer: none
Engineering: IRSumTech
Site: ItemRevSum
Pat — Testing / Viewer Pat: none ItemRevSum
Viewer: none
Testing: none
Site: ItemRevSum
Conner — Engineering / Manager Conner: ConnersIRSum ConnersIRSum
Manager: IRSumMgr
Engineering: IRSumTech
Site: ItemRevSum
Conner — Testing / Viewer Conner: ConnersIRSum ConnersIRSum
Viewer: none
Testing: none
Site: ItemRevSum

• Alice sees the style sheet for Managers because she does not have a user preference set to supersede
it. The site preference is overridden by the Engineering group preference, which is overridden by the
Manager role preference. Ted has the same result; the Manufacturing group preference is overridden
by the Manager preference. Sue doesn't have a group preference, but she still gets the Manager role
preference.

• Bob sees the style sheet for Designers because of his role, similar to the preceding example.

Active Workspace Administration, Teamcenter 2406 15-19

• Carol sees the tech style sheet because there is no role preference for Viewers.

• Pat's group and role do not have preferences associated with them, and neither does she have a user
preference, so she gets the default style sheet defined by the site preference.

• Conner gets Conner's style sheet regardless of which group or role he's in, since a user preference
supersedes all others.

What are environment preferences?

You can define a preference to retrieve its value from an environment variable in the operating system.

If you want to pass multiple values from the environment to the preference, you must configure the
following:

• Set the preference's Multiple setting to multiple.

• Use the appropriate separator in the environment variable. The environment variable is read from the
operating system on which the tcserver process is running.
Windows Semicolon — For example, MyEnvPref=Value1;Value1;Value3
Linux Comma — For example, MyEnvPref=Value1,Value1,Value3

The environment variable is only read by the tcserver process when the value is first requested, so any
changes made to the environment variable after that will not be reflected in the Teamcenter preference
until after the next time the tcserver process is started.

Remember, the environment variable is read from the environment where the tcserver process is
running, which is not necessarily the environment where the client is running.

Working with preferences in Active Workspace

You can work with all Teamcenter preferences from within the Active Workspace client using the
Preferences page.

Preference Management is part of the Active Admin installation option for Teamcenter. Once
installed, you can get to this page by either:

• Using the PREFERENCES tile from your home page.

By default, this tile appears in the home page of the TcActiveAdminWorkspace workspace.

15-20 Active Workspace Administration, Teamcenter 2406

• Navigate directly to the page with the host:port/awc/#/showPreferences URL.

This option is only available if your current workspace allows it.

What can I do with the preferences location?

Your ability to work with preferences is determined by whether you are currently logged in to a group
with administrator privileges.

Administrator? Permissions.
Administrator Search and modify preferences
Create and override site, system, group, role, and user preference
instances
Delete preference instances and definitions
Group Administrator Search and modify preferences
Create and override group, role, and user preference instances within
your group
User Search existing preferences
Create and override your own user preference instances

The organization panel

Use the Organization panel to select in which session context you wish to work.

Active Workspace Administration, Teamcenter 2406 15-21

If you do not have a choice of working in other session contexts, (you have no administration privileges),
then you will not see the Organization panel, and you can only work in your current session context.

1. (optional) Filter the organization list.

If you simply use text, the system will match within group, role, user name, or user id. If you use
quotation marks, it will search for exact matches, if you don't it will append a wildcard to the end of
your text. If you want to include spaces or commas in your search, you must use quotes.

You can narrow down the search by using the following prefixes:

• group:
• role:
• username:
• userid:

You can specify more than one of these by putting a space between them.

15-22 Active Workspace Administration, Teamcenter 2406

Example:
To search for the word, design, put design in the field.
To search for the specific user id, ed, put userid:"ed" in the field.
To search for all users with user ids beginning with ed, put userid:ed in the field.
To search for the specific user named Smith, Bob in roles beginning with design, put
username:"Smith, Bob" role:design in the field.

2. Select which session context in which you wish to work.

If you select the site, you can only work with site locations.

If you select a group, you can work with that group's location overrides.

If you select a role, you can work with location overrides for that role and its group.

If you select a user, you can work with location overrides for that user, role, and group.

The preference list will be populated with all valid preference locations for the session context that you
have selected, and you are able to:

• Modify the values of existing preference locations in the session context.

• Create new preference locations for the session context.

• Override preferences for this session context, if the preference scope allows it.

Active Workspace Administration, Teamcenter 2406 15-23

The preference list

Select your working context in the Organization panel, if available.

1. (optional) Filter the preference list by category.

2. (optional) Filter listed preferences.

3. Select a preference.

4. View preference information.

5. (optional) Edit the value at this preference location.

If you do not have permission, you will not see this button.

Override a preference

To override a preference, you must create a new instance of the preference at a higher-precedence
location. Each preference defines its own scope, which is the highest precedence location allowed.

For example, If a preference's scope is Site, then it cannot be overridden, but if its scope is User then it
can be overridden at every level.

If a preference instance's location is Site, it will be overridden by any other location instance but if its
location is User then it overrides any other location for that specific user.

15-24 Active Workspace Administration, Teamcenter 2406

Tip:
If a preference in the list has a location of None, then that means it is the preference definition
and there are no current location instances.

Following are the levels of precedence for locations.

scope location
User Can override at any location. Overrides all other location
values.
Role Can override at group and role Will override Site and Group
locations. location values.
Group Can only override at group Will override Site location values.
locations.
Site Can not override. Is overridden by any other
location

1. (optional) Filter the preference list.

2. Select the preference you want to override.

3. Open the New command stack , and then choose Override.

4. In the Add Override panel, choose the location for the override (if allowed), set the new value, and
then choose Add.

Displaying items instead of revisions

Caution:
This is a non-standard configuration and requires careful planning. Work with your Siemens Digital
Industries Software representative if you need this functionality.

Active Workspace is designed for the user to work almost exclusively with objects of the ItemRevision
type (and its children).

Active Workspace Administration, Teamcenter 2406 15-25

If you have a special use case and you need to display item types, then you need to configure the
following:

• Allow the user to create an Item.

Modify the AWC_DefaultCreateTypes preference to include an item type. That item type and all
subtypes will be considered creatable.

• Change the Fnd0ItemRevPasteOnTargetUponCreate business object constant for the new type. This
will automatically paste the item type into the user's folder when it is created.

• Configure indexing to work with Items instead of revisions.

In addition, you should also suppress the ItemRevision type from the UI.

Caution:
Siemens Digital Industries Software does not recommend that you present both items and
revisions to your users.

Deleting various object types

By default, the Delete command does not appear for every object type your users can see. If you want to
add additional object types to the list, then you must change the following preference:

AWS_allowedTypesForDelete
This is a multiple-value preference that accepts a list of business object types for which the Delete
command appears in the Active Workspace interface.

Caution:
Even when the Delete command is visible, there are still two conditions that must be met for your
users to delete an object:

• They must have the delete permission for the object.

• The object must not be referenced by other objects.

Special behavior for folders

You can control what happens when your users attempt to delete an object with folder references by
changing the following preference:

TC_auto_delete_folder_references

15-26 Active Workspace Administration, Teamcenter 2406

• true (default)

The default value is true, which ignores folder references when checking for references to other
objects, and if no other references are found, then the folder references are automatically removed,
and then the object is deleted without complaint.

• false

Changing this to false prevents the object from being deleted from the database and presents an
error message if it has any references to any other objects, including folders.

This preference applies when deleting a folder that contains objects, and when an object is contained in
a folder.

Controlling notification timeout

You can control the notification panel timeout using a preference.

AWC_notification_timeout
The value is the number of seconds to wait before closing the notification. If the value is negative,
the window will not close automatically.

Defining properties that display in object cells

To define the properties that display on the cells for objects in Active Workspace list view, use the
[Link] preference. The first two properties in the list of properties in the
preference are displayed without labels and are formatted as a primary title and subtitle. The remaining
properties are displayed in the cell as name:value.

The default values vary by object type. For example, following are the default values of the
[Link] preference:

object_name
item_id
item_revision_id

The values in this example appear as follows in Active Workspace.

Active Workspace Administration, Teamcenter 2406 15-27

Defining the revision rules list

Revision rules determine the state of objects you view in the user interface. Users click the revision rule
to display the list of all available revision rules. To set a different revision rule, a user selects another
revision rule from the list.

By default, the list of available revision rules is obtained from Teamcenter. However, as an administrator,
you may want to provide different revision rules for Active Workspace than are used in the rich client. For
example, you may want to have Active Workspace default to Latest Released whereas you want the rich
client to still default to Latest Working.

To set a different list of revision rules for Active Workspace, add revision rules to the AWC_Rev_Rule_List
preference. Whenever a custom revision rule is created, you must add it to this preference for it to
appear in the revision rules list. By default, the preference is empty, meaning that the revision rules list
in Active Workspace defaults to the revision rules from the rich client.

To set the revision rule that is selected by default, add it to the AWC_Rev_Rule_Selected preference.
The revision rule in this preference must match a revision rule in the AWC_Rev_Rule_List preference.

If the revision rule in the AWC_Rev_Rule_Selected preference is removed from the AWC_Rev_Rule_List
preference, you must change the revision rule in the AWC_Rev_Rule_Selected preference to one in the
AWC_Rev_Rule_List preference.

By default, the AWC_Rev_Rule_Selected preference is empty, meaning that the first revision rule in the
AWC_Rev_Rule_List preference is the one that is selected by default in the user interface.

Where can I get a list of preferences?

There are several sources from which to retrieve a list of preferences and their definitions.

Administration data report

You can find the Administration Data Report in the References for Administrators and
Customizers in the Teamcenter documentation area in Support Center. In this report, you will find
a complete list of all preferences shipped with Teamcenter. When you install additional features, like

15-28 Active Workspace Administration, Teamcenter 2406

Dispatcher, NX Integration, 4th Generation Design, and so on, additional preferences will be added
to your site. To get the most accurate and up-to-date listing of preferences contained in your site,
you must create your own Administration Data Documentation report.
Rich client
You can use the various tabs of the rich client's Edit→Options menu to interact directly with
preferences, including a report of which preferences have changed since installation.
Raw XML export
You can produce an XML file containing preference information using the preferences_manager
utility.
Active Workspace client
You can interact directly with preferences using the showPreferences location.

Business Modeler IDE constants

Global constants

Following are the global constants unique to Active Workspace:

• Awb0SupportsStructure

Specifies the business objects that can have a structure under it. If you want to display a custom
business object in the Content tab, add the custom business object to this constant. This constant is
added by the Active Content Structure template (activeworkspacebom).

• Awp0FilterCategoryDisplayCount

Specifies the default number of search filter categories to display in the Search Filters panel.

• Awp0FilterValueDisplayCount

Specifies the default number of search filter values to display within a search filter category. If
additional values are available for filtering in any category, a More button appears to display the
remaining values within each category. The default value is 5.

The threshold to display the box to search filter values is twice the value of
Awp0FilterValueDisplayCount.

• Awp0IndexableFileTypes

Specifies the list of file types that are allowed for text content extraction during search indexing. By
changing the value of this constant, you can specify the file types you want to index. (This global
constant is used if no value is set for the AW_Indexable_File_Extensions preference.)

Active Workspace Administration, Teamcenter 2406 15-29

The following values are supported:

.as .dotm .msg .various .xltm

.aw .dotx .ods .vdx .xltx
.csv .eml .pdf .wo .xlw
.dat .epub .ppt .wpd .xlsx
.dc .fff .pptx .xml .zip
.dif .htm .rtf .xla .7z
.doc .html .stc .xlam
.docm .ip .sxc .xls
.docx .mdb .tar .xlsm
.dot .mif .txt .xlt

For example, to enable indexing on compressed files, add any combination of .zip, .7z, or .tar to the
list.

Read permission is required for indexing a file. If any file is password protected, the file will be skipped
and no warning will be generated.

• Awp0StoreDatasetContent

Global search results can display the location of search terms inside file content attached to items.
Search results that match content from attached dataset files display as snippets of text matching the
search terms. The Indexing Engine (Solr) requires that you set this global constant In Business Modeler
IDE to true to ensure that dataset fields are stored in the Solr schema. You must also configure the
preferences to enable snippets, merge the schemas, and reindex your data, including datasets.

Business object constants

Following are the business object constants unique to Active Workspace:

• Awb0AvailableFor

Lists the business object types for which a feature should be made available. The values are comma
separated. This constant honors type hierarchy.

When this constant is used with the Ase0ArchitectureFeature business object, the constant controls
visibility of the Architecture tab for business object types. The Architecture tab is made visible for
all listed business object types and their all subtypes. The types should be those that represent the
top line in structures. This constant supports comma-delimited values of business object types, for
example:

15-30 Active Workspace Administration, Teamcenter 2406

Functionality
Fnd0LogicalBlock
RequirementSpec
Requirement
Paragraph
Fnd0SystemModel

Note:
The Architecture tab is not visible for custom business objects. Determine the business object
types that require the Architecture tab. From these types, determine those that are the top
line in structures. Add only those types to the value of the Awb0AvailableFor business object
constant on the Ase0ArchitectureFeature business object.
You can edit the display name configured for the Ase0ArchitectureFeature business object in
Business Modeler IDE to suit your business processes. By default, the display name of the tab is
Architecture.

• Awb0BOMArchetypeToOccurrence

Determines the instance of which particular subtype of the Awb0Element business object is created.
This business object constant is a comma-separated list of item revision or GDE subtypes. Using such a
list avoids the need to create a separate Awb0Element business object for each item revision type.

• Awp0SearchIsIndexed

Indicates that the business object will be indexed for searching when this constant is set to true.
This information is propagated through the business object hierarchy. For example, if ItemRevision
is selected for indexing, all business objects under ItemRevision (such as Part Revision and
DocumentRevision) are also indexed.

Note:
Do not set this constant to true for the WorkspaceObject business object. This results in
indexing errors.

• Awp0SearchIsIndexedExt

Indicates that external business objects are indexed for searching. By default, the value of this
constant is false, meaning that external objects are not indexed. The scope for this constant is the
Awp0AWCExternalSystemObject business object, which designates objects originating in systems
external to Teamcenter.

To change the value to true, open the Awp0AWCExternalSystemObject business object and select
the Awp0SearchIsIndexedExt business object constant on the Business Object Constants tab. Then
click Edit and select the Value check box.

• Awp0SearchClassifySearchEnabled

Active Workspace Administration, Teamcenter 2406 15-31

Enables the searching and filtering of classification data.

• Awp0SearchIsClassifyDataIndexed

For the specified business object type and below, specifies that classification data be indexed for
searching and filtering.

• Awp0SearchDatasetIndexingBehavior

Defines the behavior of inline indexing for dataset file contents. The scope for this constant is
WorkspaceObject types and their subtypes. Specify one of the following:
Inline Dataset content is indexed inline with the parent business object. When
a search matches dataset content, the search results returns the parent
business object instead of the dataset. The datasets are defined using
Awp0DatasetTypeToBeIndexedInline.
Relation Dataset content is indexed as part of the dataset but it maintains the reference
to the parent business object. When a search matches dataset content, the search
results return the dataset as well as the parent business object.

The default value is Inline except for DocumentRevision, where the default is Relation.

• Awp0DatasetTypeToBeIndexedInline

Identifies the datasets to be indexed along with the business object. The scope for this constant is
WorkspaceObject types and their subtypes.

Set this property only for types that are also marked for indexing and
Awp0SearchDatasetIndexingBehavior is set to Inline.

The format is:

<INHERIT | NO_INHERIT>:RelationName:DatasetTypes

The keyword specifies the behavior to apply to the rule:

INHERIT Applies the rule to the specified type and all its subtypes. For example, index PDX
dataset content related to TC_Attaches for ItemRevision and its subtypes:

INHERIT:TC_Attaches:PDF
NO_INHERIT Applies the rule only to the type where the rule is defined. A rule applied to a
parent is not inherited by child types. Specifying NO_INHERIT can help improve
performance.

NO_INHERIT:IMAN_Specification:Text

You can specify one to many relationships between RelationName and DatasetTypes.

15-32 Active Workspace Administration, Teamcenter 2406

RelationNam is a relation name or the wildcard character *. Specify one or more clauses separated
e by commas.

INHERIT: TC_Attaches: PDF, INHERIT: IMAN_Specifiation: Text

INHERIT: *: PDF
DatasetTypes is a dataset type. Specify one or more values separated by a tilde ~.

INHERIT:TC_Attaches: PDF~MSWordX

Specifying only wildcards is not valid (for example, do not specify INHERIT: *: * ).

No default value is specified with the exception that SpecElementRevision is set to INHERIT: *:
FullText.

As a best practice, do not specify all relations (*) for inline indexing and then subsequently try to limit
inheritance by setting a subtype clause to index only a specific relation to a specific type. You can avoid
inheritance by:

• Using NO_INHERIT to limit the scope of indexing for a specific type.

For example, if all ItemRevision PDFs for any relation are being indexed inline, do not write a
qualifying INHERIT rule for a subtype. For example:

If an INHERIT rule for ItemRevision is defined as INHERIT:*:PDF,

And, an INHERIT rule for an ItemRevision subtype indexes only PDFs associated with the
TC_Attaches relation,

Then the indexing behavior at the subtype level might not behave as expected, because you
already specified all ItemRevision subtypes to index all PDFs,

• Configuring the subtype to override the parent. For example, to index PDX content for all the relations
of the subtype, set INHERIT: *: PDX .

• Setting Awp0DatasetTypeToBeIndexedInline to an empty string for the subtype avoids all

inheritance from the parent type.

• Setting Awp0SearchIsIndexed to false to turn off indexing for the type.

By default, the indexing of FullText datasets is not enabled because they are indexed inline for
SpecElementRevision and its subtypes. If you choose to enable indexing of FullText datasets, users
see FullText and SpecElementRevision objects in search results.

Active Workspace Administration, Teamcenter 2406 15-33

Property constants

The following property constants are unique to Active Workspace:

• Awp0FilterPropFromRefType

Applicable only when the property to be indexed is a reference type or a compound property whose
source property is a form data file property.

You can use the awp0MasterFormStorageClass compound property, available by default on all
Master forms for ItemRevision and its subtypes, to index and filter the properties of the form.

Specify a comma-separated list of properties that are a subset of the properties listed in the
Awp0SearchPropFromRefType property constant. For example, you can set the following constants
for the property constant reference type you want to filter:
Awp0SearchIsIndexed
Set the Boolean value to true to search on the property.
Awp0SearchCanFilter
Set the Boolean value to true to filter on the property.
Awp0SearchPropFromRefType
Enter the list of properties to index.
Awp0FilterPropFromRefType
Enter the list of properties to filter.
Awp0SearchRefTypesNames
Enter the referenced object type names.

• Awp0InboxCanFilter

Indicates that tasks shown in the inbox can be filtered on a specific property of a workflow business
object (EPMTask and its subtypes). The following example shows tasks found when selecting the
Team tab.

15-34 Active Workspace Administration, Teamcenter 2406

By default, the following properties are shown as filters for workflow business objects in the inbox:

• object_type – The type of object.

• due_date – The date the object is due.

• fnd0Assignee – The user to whom the task is assigned.

• fnd0Priority – The priority of the task.

• fnd0WorkflowInitiator – The user who initiated the workflow on the task.

• Awp0InboxFilterPriority

Sets the priority of the property of a workflow business object (EPMTask and its subtypes). It
determines the property’s order in the list of filters displayed in the inbox. The lower the value, the
higher its priority and, therefore, the higher its position in the list of filters.

Siemens Digital Industries Software recommends that you assign values from a range to
accommodate additional properties in the future. For example, assign priorities such as 100, 200,
and 300, instead of 1, 2, and 3.

• Awp0SearchCanFilter

Indicates that the search results can be filtered on the specific property. It assumes that the property
was marked for indexing using the Awp0SearchIsIndexed property constant. For the filters to show
up correctly in the user interface, this property constant should be set for the property on its source
business object.

In a Multi-Site Collaboration environment, apply Awp0SearchCanFilter to published record objects so

that they can be indexed using the POM_owning_site property.

Active Workspace Administration, Teamcenter 2406 15-35

• Awp0SearchFilterPriority

Sets the priority of the property that determines its order in the list of filters displayed in the client—
the lower the value, the higher the priority. This means that the filter is positioned higher in the list
of filters shown in the filters panel. Siemens Digital Industries Software recommends that you assign
values from a range in order to accommodate additional properties in the future. For example, assign
priorities such as 100, 200, and 300, instead of 1, 2, and 3.

For the filters to show up correctly in the user interface, this property constant should be set for the
property on its source business object.

When a Table type property is marked for filtering, all valid properties of the referenced TableRow
type are available as filters. All the table row properties get the same filter priority, so they are
displayed together, vertically listed in the filter pane.

• Awp0SearchIsIndexed

Indicates that the property on the business object will be indexed for searching by the indexing
engine. This information is propagated through the business object hierarchy. For example, if
object_type on ItemRevision is marked for indexing, all business objects under ItemRevision
(such as Part Revision and DocumentRevision) also have their object_type property indexed. The
following constraints apply when indexing properties:

• Only attribute, compound, table, reference, and publication record properties can be indexed.
Indexing of runtime and relation properties is not supported.

• For multi-site searching the POM_owning_site property can be indexed out of the box. Apply the
Awp0SearchIsIndexed to published objects to enable indexing.

• To index compound properties, they must reference attribute properties from the source object.

Note:
If the compound property value comes from a form, the compound property must use the
form storage class in the property definition rather than the form itself, or indexing fails.

• To index reference properties, the Awp0SearchRefTypeNames and

Awp0SearchPropFromRefType property constants must contain valid values.

• Table type property indexing is only supported for properties that reference Fnd0TableRow and its
subtypes. Indexing is not supported for Fnd0NameValue and its subtypes.

When a table type property is marked for indexing, all the valid properties of the referenced table
row type are indexed. You do not need to mark individual table row properties.

Incorrect values are omitted from indexing; no message appears.

15-36 Active Workspace Administration, Teamcenter 2406

• Awp0SearchPropFromRefType

Applicable when the property to be indexed is a reference type or a compound property whose source
property is a form data file property.

You can use the awp0MasterFormStorageClass compound property, available by default on all
Master forms for ItemRevision and subtypes, to index and filter the properties of the form.

Specify a comma-separated list of properties that are on the business objects specified in
the Awp0SearchRefTypeNames property constant. For example, on the owning_user reference
property on ItemRevision, specify a value of user_id,user_name.

The following rules apply:

• You can only specify attribute and compound properties.

Note:
If the compound property value comes from a form, the compound property must use the
form storage class in the property definition rather than the form itself, or indexing fails.

• Each property in the list specified for Awp0SearchPropFromRefType is matched against each
business object in the list specified for the Awp0SearchRefTypeNames property constant. Only
properties that are valid and applicable on a business object are considered for indexing. In
addition, if filtering is enabled on the reference property, only the first property from the list is
used.

• The first property in the list must be a string property.

Incorrect values are omitted from indexing; no message appears.

• Awp0SearchRefTypeNames

Applicable only when the property to be indexed is a reference type or a compound property whose
source property is a form data file property. Specify a comma-separated list of business object names
that the reference property can contain. For example, on the owning_user reference property on
ItemRevision, specify a value of User. The following rules apply:

• If no value is specified on typed reference properties, the business object that is specified as the
referenced type is used as the type. For example, release_status_list results in ReleaseStatus.

• On untyped reference properties, if no value is specified, the POM_object is used as the type.

Incorrect values are omitted from indexing; no message appears.

• Cm1ChangeCanFilter

Active Workspace Administration, Teamcenter 2406 15-37

Indicates that the changes in the Changes page can be filtered on a specific property of the change
business object (ChangeItemRevision and its subtypes). The following example shows the changes
found when clicking the Submitted tab.

The default properties of a change object that can be filtered are:

• creation_date – The date the change was created.

• CMMaturity – The degree of completion of the overall change process (its Maturity).

• object_type – The type of change.

• cm0Analyst – The user assigned as the analyst.

• cm0ChangeSpecialist1 – The user assigned as the change specialist.

• cm0Requestor – The user who created the change.

• Cm1ChangeFilterPriority

Sets the priority of the property of the change object (ChangeItemRevision and its subtypes). It
determines the property’s order in the list of filters displayed in the Changes page. The lower the
value, the higher its priority and, therefore, the higher its position in the list of filters.

15-38 Active Workspace Administration, Teamcenter 2406

Note:
Compound properties presume that the security level of the source property of the source object
is read access. This is because the compound property belongs to the target object related to the
source object through the compound property.
For example, Object B has a compound property that is related to its source property on Object
A. When Object B and its compound property are indexed, the indexer presumes that Object A
has a security level of read access to everyone. That means that anyone with read access to the
compound property of Object B could also find the source property on Object A, regardless of its
security level.

Enabling searching and filtering on referenced objects or forms

Enable searching and filtering for a referenced object using a property value defined on the referenced
object. You need to add or update the property constants for the property of the referenced object.

In the first example, an ItemRevision object has a referenced Item object, where the description
contains the value Example Text.

In the Business Modeler IDE, find the template containing your object definitions, and find the
ItemRevision object. On the property that references the Item object, add or update the following
property constants:

Awp0SearchIsIndexed
Set the Boolean value to true to index this property.
Awp0SearchRefTypesNames
Set the referenced object type name, Item in this example.
Awp0SearchPropFromRefType
Set the list of properties on the referenced object type specified in Awp0SearchRefTypesNames. In
this example, the property is description.

To filter the search results by the preceding property values, add or update the following property
constants:

Awp0SearchCanFilter
Set the Boolean value to true to filter on the property.
Awp0FilterPropFromRefType
Set the list of properties on the referenced object. In the example, the property is description.
Awp0SearchFilterPriority
This property constant is optional. You can set a numeric value for priority. The lower the value, the
higher the priority.

Active Workspace Administration, Teamcenter 2406 15-39

Example: Search properties of a related Master or custom form

Enable searching and filtering using the properties of a related Master or custom form. You need
to add or update the property constants for the property of the related form. By default, the
awp0MasterFormStorageClass compound property is configured for ItemRevision. The compound
property references the data file on the Master form for ItemRevision.

1. An ItemRevision has a subtype Awp0TestItemRevision with a Master form

Awp0TestItemRevisionMaster:

2. The Master form has two properties:

3. Awp0TestItemRevMasterS is the storage class name for the form.

15-40 Active Workspace Administration, Teamcenter 2406

4. awp0MasterFormStorageClass is a compound property that references the data file of the Master
form.

Active Workspace Administration, Teamcenter 2406 15-41

5. Configure the Master form storage class property awp0MasterFormStorageClass with the
property constants that enable indexing, searching, and filtering.

15-42 Active Workspace Administration, Teamcenter 2406

Example: Search properties of an Item Master form

Enable searching and filtering of an Item Master form using a compound property. You need to create a
compound property on a persistent attribute of the Item Master data_file storage class. The compound
property references the data file for the Master form of the Item. You need to create a compound
property for every attribute you want to search.

In the example, the compound property a2ItemMasterAttr1 is created on user_data1, which is a

persistent attribute on the Item Master data_file storage class.

Active Workspace Administration, Teamcenter 2406 15-43

Be sure to set the index, search and filter property constants on the new compound property.

Utilities

Using command-line utilities

In order to perform some administrative activities, you must run command-line utilities. Even if it's not
the only option, sometimes using command-line utilities can also make some administrative tasks easier.

To run command-line utilities, you must have access to the Teamcenter platform command-line
environment.

For information about working with command-line utilities, refer to the Teamcenter Utilities in the
Teamcenter documentation.

15-44 Active Workspace Administration, Teamcenter 2406

ac0_migrate_s2cldata

Migrates previous Active Collaboration questions and comments (S2clSocial objects) to the new Active
Collaboration discussions feature that uses Ac0ActiveCollaboration objects.

Siemens Digital Industries Software recommends that you first run this utility with the -dryrun argument
before performing an actual migration.

Note:
If you have used Active Collaboration for Retail or Active Collaboration prior to Active Workspace
5.1, you can perform a one-time migration using this utility to migrate your existing questions and
comments to the new Active Collaboration discussions feature.

Caution:
Perform this migration only once to prevent duplication of data.

SYNTAX

ac0_migrate_s2cldata -u=admin-user-id {[-p=password | -pf=password-file]} [-g=group]

-report=report-file-path
[-dryrun]
[-h]

ARGUMENTS

-u
Specifies the user ID.

A user with administration privileges is used as the value name for the user ID. If -u is used without a
value, the operating system user name is automatically applied.

-p
Specifies the password.

If used without a value, the system assumes a null value. If this argument is not used, the system
assumes the user-ID value to be the password.

Active Workspace Administration, Teamcenter 2406 15-45

This argument is mutually exclusive with the -pf argument.

-pf
Specifies the password file.
-g
Specifies the group associated with the user, which must be dba.
-report
Specifies the path where the migration report file is stored.
-dryrun
Simulates a run of the ac0_migrate_s2cldata utility without actually migrating the data. The results
of the simulated migration are logged in the file specified by -report. Review the report for any
potential issues before actually migrating the data.
-h
Displays help for this utility.

EXAMPLE

Migrate the existing S2clSocial objects to Ac0ActiveCollaboration objects:

ac0_migrate_s2cldata -u=admin -p=pwd -g=dba

-report=C:\temp\admin_data\active_collaboration_objects.xml

15-46 Active Workspace Administration, Teamcenter 2406

bomindex_admin

Adds structured content to the search index.

SYNTAX

bomindex_admin [-u=user-id {-p=password | -pf=password-file} -g=group] -logfile=location_of_logfile

-function=[create | delete | list | upgrade] -inputfile=location_of_inputfile

ARGUMENTS

-u
Specifies the user ID. This is a user with administration privileges.

Note:
If Security Services single sign-on (SSO) is enabled for your server, the user and password
arguments are authenticated externally through SSO rather than being authenticated against
the Teamcenter database. If you do not supply these arguments, the utility attempts to join an
existing SSO session. If no session is found, you are prompted to enter a user ID and password.

-pf
Specifies the password file that holds the cleartext or encrypted password. For enhanced
security, use a password file instead of the password. If the -pf argument is not used, the system
uses the given password.
-p
Specifies the password.

This argument is mutually exclusive with the -pf argument.

-g
Specifies the group associated with the user.

If used without a value, the user's default group is assumed.

-logfile
Specifies the location of the log file written by the utilities. You can specify a different location for
each utility.
-function=function-name
Performs the following functions:

create Creates the BOMIndexAdminData objects based on the input file.

Active Workspace Administration, Teamcenter 2406 15-47

delete Finds the BOMIndexAdminData objects in the input file and marks them as
deleted.
list Creates the input file for update or delete operations for existing
BOMIndexAdminData business objects. The generated file also reports
BOMIndexAdminData properties such as window-uid.
upgrade Upgrades the definition of BOM index tables when the property set is modified.

-inputfile
Specifies the location of a file containing the list of structure objects to index. The input file line
format is as follows:

item-query-string | item-revision-ID | base-revision-rule | effectivity-unit |

effectivity-end-item-query-string | effectivity-date (dd-mmm-yyyy hh:mm:ss) |
variant-rules | subscribers | closure-rules

An example of an input file (bomindex_admin_input.txt):

item_id=HDD-0527 | B | Any Status; Working | 5 | item_id=HDD-0527 |

31-May-2013 [Link] | vrule1:item_id=OwnItem1:B,vrule2:,vrule3:item_id=OwnItem3:A |
MMV | closurerule1

• effectivity-unit

If you have multiple effectivity units, their numbers must be comma-separated. Also, you must
repeat the effectivity end item query string for each effectivity unit, for example:

| 5,10,12 | item_id=HDD-0527,item_id=HDD-0527,item_id=HDD-0527 |

The maximum number of effectivity units you can specify is 960.

• variant-rules

The variant rules (also known as saved variant rules) are comma-delimited, and follow this
format:

SVR-name:owning-item-query-string:owning-itemrevision-ID

The topline item revision is the default owner.

The maximum number of saved variant rules you can specify is 960.

• subscribers

(Optional) You may specify:

• VDS

15-48 Active Workspace Administration, Teamcenter 2406

Specifies that this product configuration is indexed for viewing using the Visualization Data
Server. This makes the structure available faster in visualization. VDS requires deployment of
the Visualization Data Server.

• closure-rules

(Optional) If a closure rule is applied for a configuration, content in the structure (excluded by the
closure rule) does not appear in where used query results for top-level contexts.

• structure-type

(Defunct) The type of structure that the product represents. OCC is the only valid value.

• owning-user

(Optional) If Visualization for MMV is enabled for the product, specify the user who owns the
MMV delta collection dataset.

• MMVIdxAccessControllers

(Optional) Specify the users that control access to MMV index files.

HOW TO SPECIFY OWNING USER AND MMVIDXACCESSCONTROLLERS

Each VDS site can be configured to run as a different user. BOMIndexAdminData table entries are
returned according to the permission specified for the configured VDS user. This helps you implement
export compliance using these attributes.

Example:
Site owners configured for each VDS site:

• USA is VDSadmin

• Mexico is mex_VDSadmin

• Canada is can_VDSadmin

• China is chi_VDSadmin

BOMIndexAdminData (BIAD) entries are defined as follows:

Active Workspace Administration, Teamcenter 2406 15-49

MMV
Revision Structure Owning MMV Access
BIAD Product Rule Type User Users
Biad1 Ship Latest BVR VDSadmin mex_VDSadmin
Working
can_VDSadmin
Biad2 Truck Latest BVR VDSadmin mex_VDSadmin
Working
can_VDSadmin
chi_VDSadmin
Biad3 Car Latest BVR VDSadmin chi_VDSadmin
Working

To summarize the access for each VDS site:

• USA site user VDSadmin

Access to Biad1, Biad2, and Biad3 because it is specified as the MMV owning user.

• Mexico site user mex_VDSadmin

Access to Biad1 and Biad2 only. No access to Biad3.

• Canada site user can_VDSadmin user

Access to Biad1 and Biad2 only. No access to Biad3.

• China site user chi_VDSadmin user

Access to Biad2 and Biad3 only. No access to Biad1.

EXAMPLE

The following command creates a search index of structures:

bomindex_admin -u=username -p=password -g=dba

-logfile=C:\Scratch\log\[Link]
-function=create -inputfile=C:\Scratch\log\bomindex_admin_input.txt

OVERRIDING EFFECTIVITY

When you want to specify override effectivity, do not specify it in the input file containing the product
configurations to index. The override effectivity in the input file is ignored during index generation,
causing a discrepancy between the indexed BOM and the BOM in use.

To set override effectivity during index generation, add the effectivity data to a Revision Rule.

For example, the Revision Rule might contain:

15-50 Active Workspace Administration, Teamcenter 2406

Z_ACE_DateOverride_Rule23_10Jan2020

which includes entries for the effective date 10-Jan-2020 [Link].

The corresponding input file entry for bomindex_admin would have this corresponding effectivity
override entry:

Active Workspace Administration, Teamcenter 2406 15-51

data_report

Gathers data from participating Multi-Site sites in the federation and generates reports on data
inconsistencies. Reports are generated for individual sites and for the overall Multi-Site federation. This
data is presented in the Active Workspace Multi-Site Assistant. (When working with the data_report
utility, sites in the federation are the sites defined by MS_Dashboard_Supported_Sites.)

SYNTAX

data_report -u=user-ID {-p=password | -pf=password-file} -g=group

[-site=site-name]
[-dir=report-directory]
[-format=report-format]
[-sql_file=sql-file-name]
[-include=included-report-categories]
[-exclude=excluded-report-categories]
[-date_format=date-filter-type [-from=start-date] [-to=end-date]]
[-object_type=type]
[-f={collect_data | generate_report}]
[-h]

ARGUMENTS

-u
Specifies the user ID. The user must have administrative privileges.

If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are
authenticated externally through SSO rather than being authenticated against the Teamcenter
database. If you do not supply these arguments, the utility attempts to join an existing SSO session.
If no session is found, you are prompted to enter a user ID and password.
-p
Specifies the user's password. This argument is mutually exclusive with the -pf argument.
-pf
Specifies the password file. This argument is mutually exclusive with the -p argument.
-g
Specifies the group associated with the user.
-site
Specifies the name of a specific site for which data is gathered and a report is generated. If no site
is specified, reports are generated for all sites and the overall Multi-Site federation (as defined by
MS_Dashboard_Supported_Sites).
-dir=

15-52 Active Workspace Administration, Teamcenter 2406

Specifies directory in which reports are saved. By default, reports are saved in the location specified
by TC_TMP_DIR.
-format
Specifies the format for reports. Valid values are csv (the default) and json.
-sql_file
Specifies a JSON file containing custom SQL data queries or predefined filters.
-include
Specifies the categories of issues to include in reports. Valid values are itemOwnershipReports,
duplicateIDReports, and objectOwnershipReports. By default, all listed categories are included.
Multiple values must be separated by commas.

The objectOwnershipReports analysis uses the external closure rules defined in

MSA_ObjectOwnershipCR. As the objectOwnershipReports analysis may take significant time,
consider first running data_report excluding objectOwnershipReports, and then later running only
the objectOwnershipReports.
-exclude
Specifies the categories of issues to be excluded from reports. Valid values are
itemOwnershipReports, duplicateIDReports, and objectOwnershipReports. Multiple values must
be separated by commas.
-date_format
When specifying a reporting date range, -date_format specifies the date type. Valid values are
creation (the date the object was created) and last_modified (the date the object was last
modified).
-from
Used with -date_format to specify, inclusively, the start date and time for reporting. The format
of the date is “YYYY-MM-DD HH:MM:SS” and must be inside the double quotes due to the space
between the year and the hour.
-to
(Optional) Used with -date_format to specify, inclusively, the end date and time for reporting. The
format of the date is “YYYY-MM-DD HH:MM:SS” and must be inside the double quotes due to the
space between the year and the hour. If not given, the current date and time is used.
-object_type
Specifies an object type to be included in the report. All item and item subtypes are included.
-f
Specifies the function that data_report should perform. Valid values are collect_data (gather
updated data from sites) and generate_report (generate reports based on gathered data). By
default, data_report performs both actions.
-h

Active Workspace Administration, Teamcenter 2406 15-53

Displays help for this utility.

EXAMPLES

Required log-in information is omitted from the following examples.

• Gather data and generate reports for all sites defined by MS_Dashboard_Supported_Sites:

data_report

• Gather data for a specific site:

data_report -site=site01 -f=collect_data

• Generate reports for all sites and the Multi-Site federation using data previously collected:

data_report -f=generate_reports

• Generate reports for all sites and the Multi-Site federation for only specific categories of issues:

data_report -include=itemOwnershipReports,duplicateIDReports

• Gather data and generate reports for a specific site for a specific time period:

data_report -site=site01 -date_format=creation -from="2020-06-01 [Link]"

-to="2020-06-30 [Link]"

• Gather data and generate reports for all sites and the Multi-Site federation using custom SQL data
queries:

data_report -dir=d:\reports -sql_file=d\reports\[Link]

15-54 Active Workspace Administration, Teamcenter 2406

generate_admin_data_report

Generates a report showing the specified administration data for the site where you run the utility or for
an export package. The export package can be from a remote site.

The report contains HTML pages for the administration data objects, showing their properties with
hyperlinks to referenced objects. If an object is referenced by other objects, its HTML page contains a
where-used table that indicates the categories and objects that have references to the current object.

The report has a summary showing all the administration data types included in the report and the
instances of each element present within the category. The report also has a glossary page with
descriptions of the administration data categories and the elements available in each of the categories.

SYNTAX

generate_admin_data_report -u=user-ID {-p=password | -pf=password-file}

-g=group
-adminDataTypes=Admin-data1,Admin-data2,…,Admin-dataX | all
[-inputPackage=input-package-path]
-outputDir=path-to-directory-for-report-files
[-listTypes]
[-h]

ARGUMENTS

-u
Specifies the user ID. The user must have administrative privileges.

This argument is mutually exclusive with the -pf argument.

-pf
Specifies the password file.

For more information about managing password files, see Teamcenter Utilities in Teamcenter help.

This argument is mutually exclusive with the -p argument.

-g

Active Workspace Administration, Teamcenter 2406 15-55

Specifies the group associated with the user.

-adminDataTypes
Specifies the types of administrate data to include in the compare report. You provide the data types
as a comma-separated list (no spaces). You may also specify the all value to include all data types
defined in the local system or the specified input package.

Tip:
Use the -listTypes argument to get a list of available administration data types.

If the report contains multiple data types, it includes a where used table showing where each object
is referenced.
-inputPackage
Specifies the full path, including the file name, of the export administration data package from the
site for which the report is generated. If you do not specify this argument, the utility generates a
report for the local site.
-outputDir=
Specifies the path to directory where you want the report saved. You must specify this argument.
-listTypes
Displays a list of the available administration data types that you can include in the report.
-h
Displays help for this utility.

ENVIRONMENT

As specified in Manually configure the Teamcenter environment in Teamcenter Utilities in Teamcenter

help.

This is a Java utility that, by default, has the maximum Java heap size set to 1024M. For reports
that contain a large number of objects, you may need to increase maximum Java heap size to avoid
out-of-memory errors or poor performance. If possible, set the maximum heap to at least to 4096M for
large reports. You can set this value using the BMIDE_SCRIPT_ARGS environment variable, for example:

set BMIDE_SCRIPT_ARGS=-Xmx4096M

Note:
Java standards require that no more than 25 percent of total RAM be allocated to virtual
memory (VM). If the amount allocated to the Java VM exceeds this percentage, degradation of
performance can occur.

15-56 Active Workspace Administration, Teamcenter 2406

FILES

As specified in Log files produced by Teamcenter in Teamcenter Utilities in the Teamcenter help.

EXAMPLES

• Generate a list of the administration data types that you can export:

generate_admin_data_report -u=admin-username -p=admin-password -g=dba

-listTypes

• Generate a report containing the preferences and their values at the local site:

generate_admin_data_report -u=admin-username -p=admin-password -g=dba

-adminDataTypes=Preferences
-outputDir=C:\temp\admin_data\siteA\preferences_report

• Generate a report containing the Access Manager and Organization administration data from an
export package of a remote site:

generate_admin_data_report -u=admin-username -p=admin-password -g=dba

-adminDataTypes=AccessManager,Organization
-inputPackage=C:\temp\admin_data\siteB\[Link]
-outputDir=C:\temp\admin_data\siteB\am_and_organization_report

log-level

Changes the log level of Teamcenter microservice framework components and compliant microservices.
Among these are the service dispatcher and the microservices configurator, filerepo, and MPS.
Administrators can change logging levels without having to stop and restart the services.

Syntax

Host operating
system Syntax
Linux ./log-level operation [argument]
On Linux hosts, it is necessary to set permissions on the [Link] file. To do so,
enter the command

chmod +x [Link]
Windows log-level operation [argument]

Active Workspace Administration, Teamcenter 2406 15-57

Arguments

get
Gets the current log level of a microservice.

log-level get MICROSERVICE_NAME

Available log levels depend on the microservice. See Server manager logging levels in the
Teamcenter help for a description of log levels.
getall
Gets the current log level of all running microservices.

log-level getall

set
Changes the log level of a microservice. Possible values are INFO, ERROR, DEBUG, WARN, and TRACE.

log-level set MICROSERVICE_NAME LOG_LEVEL

reset
Changes the current log level back to the default log level for a microservice.

log-level reset MICROSERVICE_NAME

15-58 Active Workspace Administration, Teamcenter 2406

help
Prints the instructions for using the log level command line interface.

log-level help

Environment

The utility works on the master microservice framework node for a Teamcenter environment,
irrespective of whether the host is running a Linux or Windows operating system.

The utility is located in the TC_ROOT/microservices/bin folder and must be run from this location.

Active Workspace Administration, Teamcenter 2406 15-59

req_word_html_converter

As an administrator, you can selectively convert requirement content in HTML format to Microsoft Word
format (or the reverse, depending on the option selected). You can perform a selective conversion
by providing a criteria file or a comma separated file containing fullText UIDs or directory containing
multiple such Fulltext UID files. In non-permanent selective conversion from rich text to Microsoft
Word, the converted requirements have the necessary named reference attachments as MSWordXPart;
however, the content type remains rich text. Similarly, in non-permanent conversions from Microsoft
Word to rich text, the converted requirements have the named references attachments as Arm0HTML
and Arm0HTMLIMG, but the content type is still rich text.

Note:
Before you run this utility, ensure that the Active Workspace Requirements Management feature is
installed. Several files are created in the transient volume folder when you run the utility:

• failed_ID.txt contains failed UIDs separated by commas

• [Link] contains invalid UIDs

• [Link] contains valid UIDs

• [Link] if you use the dumpLogs option

• The utility performs conversion for the following objects only: SpecElementRevision,
SpecElement, or SpecificationRevision.

SYNTAX

req_word_html_converter [-u=user-id -p=password | password-file -g=group]

] [-path=full file path of [Link]
] [-dumpLogs] [-forceUpdate] [-h][-htmlToWord] [-wordToHtml]
[-processObjectList=full path of the text file containing FullTextUIDs -in=full file path of criteria file
][-permanentConvert] [-dryRun]

ARGUMENTS

-u=user_id
Specifies the user ID to be used for the upgrade.

This is a user with Teamcenter administration privileges.

-p=password
Specifies the password for the specified user ID.
-g=group_name

15-60 Active Workspace Administration, Teamcenter 2406

Specifies the group associated with the user.

-path=full file path of [Link] (including the .exe extension)
Specifies the full path to the [Link] utility, including the filename
[Link].
-dumpLogs
(Optional) Dumps a detailed debug log with more information about the point in the code the utility
is failing or which full-text dataset is causing the error.
-forceUpdate
(Optional) Forces the update and repair of all requirements in database even if they were previously
converted.
-h
Displays help for this utility.
-htmlToWord
Converts requirements from HTML format to Microsoft Word.
-wordToHtml
Converts requirements from Microsoft Word format to HTML.
-processObjectList=<full file path of the process object list text file>
Specifies the full path of the text file containing FullText UIDs. The text files must contain FullText IDs
separated only by commas; no spaces allowed.
-in=<full file path of the criteria file>
Performs a selective conversion of an entire requirement specification structure to html. The input is
a criteria file that defines this structure.

The schema for the file is as follows:

KEYWORD_SEPARATOR=KWS

KEY_VALUE_SEPARATOR=KVS

RULE_SEPARATOR=RS

keys KWS key1=value1 KVS keyN=valueN RS rev_rule KWS revision-rule RS topline_rev KWS topline
rev

keys KWS key1=value1 KVS keyN=valueN RS rev_rule KWS revision-rule RS

keys KWS key1=value1

Note the following conditions:

Active Workspace Administration, Teamcenter 2406 15-61

• The KEYWORD_SEPARATOR, KEY_VALUE_SEPARATOR, and RULE_SEPARATOR entries are

required and you must enter in the order indicated. These entries define the separators that
segregate the key-value pairs and keywords from corresponding values. You cannot use the equal
sign (=) as the value for these entries. For example, the entry RULE_SEPARATOR= = is invalid.

• Separate all entries with the new-line character (\n).

• Starting in the fourth row, define the entries as follows:

• Segment 1 (Required)

Consists of multi-field key-value (MFK) pairs. Multifield keys are IDs assigned to each object to
ensure their uniqueness in the database. Based on the MFK, specifications/requirements are
retrieved, and then further configuration is applied based on Segment 2 and Segment 3. This
segment is required to uniquely identify the top object in the database.

Syntax

keys KWS key1=value1 KVS key2=value2 KVS keyN=valueN

Example

keys : item_id=REQ-000002 , object_type=Requirement

• Segment 2 (Optional unless Segment 3 is defined)

Denotes the revision rule to apply to the revision retrieved based on the MFK pairs in Segment
1.

If you do not define this segment, then the defined revision rule as read from preference
TC_config_rule_name is applied.

Syntax

rev_rule KWS revision_rule_name

Example

rev_rule : Latest Working

• Segment 3 (Optional)

Defines the revision of the item retrieved on the basis of the MFK pairs defined in Segment
1. You can use this segment to determine the structure of interest. If you do not define this
segment, then the latest revision is considered for configuring structure. If this segment is
defined then you must define Segment 2 also.

15-62 Active Workspace Administration, Teamcenter 2406

For example, if the MFK pairs in Segment 1 return a particular item such as
item_id=REQ-000002, then there can be different structures for different revisions of this item.
Revision A as a top line might contain 6 children items; revision B might contain 12 children
items.

Syntax

topline_rev KWS topline_revision

Example

topline_rev : A

• Example: valid input criteria file

KEYWORD_SEPARATOR=:

KEY_VALUE_SEPARATOR=,

RULE_SEPARATOR=|

keys: item_id=REQ-000001

keys: item_id=REQ-000001 , object_type=Requirement | rev_rule:Latest Working

keys: item_id=REQ-000001 | rev_rule:Precise Only

keys: item_id=REQ-000001 | rev_rule:Any Status; Working | topline_rev:A

• Example: invalid input criteria file

KEYWORD_SEPARATOR= = (invalid because the equals sign (=) is not a valid separator)

KEY_VALUE_SEPARTOR=, (invalid because KEY_VALUE_SEPARATOR is misspelled)

RULE_SEPARATOR| (invalid because the equals sign (=) is missing)

keys: item_id=REQ-000001 | rev_rule: | topline_rev:A (invalid because the revision rule name is
not provided)

rev_rule:Latest Working | keys: item_id=REQ-000002 , object_type=Requirement (Invalid

because Segment 1, Segment 2, and Segment 3 must be defined in that order: Segment 1 is
the MFK, Segment 2 is the revision rule, and Segment 3 is the topline revision )

keys: item_id=REQ-000003 | topline_rev:A (Invalid because Segment2 is skipped and directly

Segment3 is defined)

Active Workspace Administration, Teamcenter 2406 15-63

-permanentConvert
(Optional) Permanently converts requirements to one of the following formats:

• If you include the -wordToHtml switch, converts to HTML format, which is editable in the CK
Editor in the Documentation tab.

• If you include the -htmlToWord switch, converts to Word format, which is not editable in the CK
Editor in the Documentation tab.
-dryRun
These files are created: failed_ID.txt with failed UIDs separated by comma, [Link] with the
invalid UIDs, and [Link] with the valid. The conversion does not take place.

The files are described below:

1. [Link]: any UID not present in the database or has a blank content_type property.

2. failed_ID.txt : any UID having corrupted data, cannot be opened in Word, the user does not
have write access on it, or is checked out by another user or a replica object.

3. [Link] : All UIDs are valid.

4. [Link] : UIDs that are already HTML for wordTOHtml conversion case or
already Word for HtmlToWord conversion, is contained in this file.

EXAMPLES

req_word_html_converter -u=user_id -p=password -g=group -path=full file path of

[Link] -forceUpdate -htmlToWord

req_word_html_converter -u=user_id -p=password -g=group -path=full file path of

[Link] -dryrun -htmlToWord

req_word_html_converter -u=user_id -p=password -g=group -path=full file path of

[Link] -dumpLogs -htmlToWord

req_word_html_converter -u=user_id -p=password -g=group -path=full file path of

[Link] -in=full path of the criteria file for selective conversion -wordToHtml

req_word_html_converter -u=user_id -p=password -g=group -path=full file path of

[Link] -processObjectList=full path of the process uidst text file -wordToHtml

req_word_html_converter -u=user_id -p=password -g=group -path=full file path of

[Link] -dir=full path of the folder that contains text files with process uids
-htmlToWord

15-64 Active Workspace Administration, Teamcenter 2406

req_word_html_converter -u=user_id -p=password -g=group -path=full file path of

[Link] -permanentConvert -htmlToWord

Caution:
The following conditions are not supported:

• Creating a requirement in Teamcenter Rich Client and modifying it in Active Workspace (and
vice-versa).

• Creating a requirement in Teamcenter Rich Client and creating a sibling in Active Workspace and
exporting to Word. The sibling cannot be edited.

• Creating a requirement in Teamcenter Rich Client and exporting it using microservices.

To create a specification that can be edited in Active Workspace, use IMPORT SPECIFICATION with
the Enable Editing checkbox selected, or use the microservice-based import.

Active Workspace Administration, Teamcenter 2406 15-65

Active Workspace Fundamentals
No ratings yet
Active Workspace Fundamentals
232 pages
Active Workspace Fundamentals
No ratings yet
Active Workspace Fundamentals
222 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
Aw Admin
100% (1)
Aw Admin
163 pages
Basic Class Deploy
No ratings yet
Basic Class Deploy
310 pages
Configuration and Extensibility
No ratings yet
Configuration and Extensibility
456 pages
Access Manager
No ratings yet
Access Manager
225 pages
TC 2406 Manufacturing1
No ratings yet
TC 2406 Manufacturing1
20 pages
Client For Ms Office
No ratings yet
Client For Ms Office
148 pages
Installing TC DC
No ratings yet
Installing TC DC
296 pages
Clearancedb Admin Guide
No ratings yet
Clearancedb Admin Guide
275 pages
Classification Admin
No ratings yet
Classification Admin
211 pages
Server Customization
No ratings yet
Server Customization
379 pages
4HANA - Whats New
No ratings yet
4HANA - Whats New
5 pages
Server Win
No ratings yet
Server Win
388 pages
Class Aw
No ratings yet
Class Aw
239 pages
Simulation Process MGMT
No ratings yet
Simulation Process MGMT
274 pages
installingTcDc (2412)
No ratings yet
installingTcDc (2412)
310 pages
Program Planning
No ratings yet
Program Planning
160 pages
Teamcenter Gateway For Enterprise Applications - Connectivity Guide
No ratings yet
Teamcenter Gateway For Enterprise Applications - Connectivity Guide
85 pages
TC Security Services Install
No ratings yet
TC Security Services Install
162 pages
Class Aw Usage
No ratings yet
Class Aw Usage
63 pages
Classification
No ratings yet
Classification
90 pages
Classification
No ratings yet
Classification
90 pages
Report Builder
No ratings yet
Report Builder
83 pages
4HANA - Migration Guide
No ratings yet
4HANA - Migration Guide
27 pages
Partner Connect Admin 2
No ratings yet
Partner Connect Admin 2
46 pages
4HANA - Installation Guide
No ratings yet
4HANA - Installation Guide
125 pages
Query Builder
No ratings yet
Query Builder
58 pages
Simulation Process MGMT Install Config
No ratings yet
Simulation Process MGMT Install Config
307 pages
Partner Connect Using 2
No ratings yet
Partner Connect Using 2
42 pages
Working With 2d Images
No ratings yet
Working With 2d Images
98 pages
Control Plan 1
No ratings yet
Control Plan 1
112 pages
Installation
No ratings yet
Installation
172 pages
Vendor Management 2
No ratings yet
Vendor Management 2
39 pages
Getting Started With Customization
No ratings yet
Getting Started With Customization
14 pages
Easy Plan
No ratings yet
Easy Plan
470 pages
Report Generator
No ratings yet
Report Generator
15 pages
Workflow Designer
No ratings yet
Workflow Designer
709 pages
Activity Index
No ratings yet
Activity Index
75 pages
AS400 Server Performance Tools
100% (1)
AS400 Server Performance Tools
555 pages
Query Builder
No ratings yet
Query Builder
56 pages
Design Bom Alignment Admin
No ratings yet
Design Bom Alignment Admin
92 pages
Questa Sim Ref
No ratings yet
Questa Sim Ref
1,166 pages
NX 2312 Release Notes
No ratings yet
NX 2312 Release Notes
146 pages
DriveTechnologyCommissioner DOC en
No ratings yet
DriveTechnologyCommissioner DOC en
46 pages
Tecnomatix 2420 Release Notes
No ratings yet
Tecnomatix 2420 Release Notes
45 pages
NX 2506 Release Notes
No ratings yet
NX 2506 Release Notes
176 pages
4HANA - Configuration Guide
No ratings yet
4HANA - Configuration Guide
63 pages
Report Builder
No ratings yet
Report Builder
75 pages
Vendor MGMT Admin 2
No ratings yet
Vendor MGMT Admin 2
36 pages
Teamcenter Deployment Guidemap 12.2
No ratings yet
Teamcenter Deployment Guidemap 12.2
16 pages
System - Admin TC
100% (1)
System - Admin TC
630 pages
AW Configuration
No ratings yet
AW Configuration
253 pages
Users Guide
No ratings yet
Users Guide
945 pages
Data2Unified Add-In Manual V1.3.0.0
No ratings yet
Data2Unified Add-In Manual V1.3.0.0
23 pages
Excel HMI Object Export in WinCC
No ratings yet
Excel HMI Object Export in WinCC
26 pages
Installing and Configuring Dispatcher
No ratings yet
Installing and Configuring Dispatcher
129 pages
Supplier Connect Supplier 2
No ratings yet
Supplier Connect Supplier 2
39 pages
Deployment Center
No ratings yet
Deployment Center
104 pages
Fusion 360 Exercises
90% (10)
Fusion 360 Exercises
38 pages
Teamcenter 13.1 Teamcenter Basics
100% (2)
Teamcenter 13.1 Teamcenter Basics
386 pages
Teamcenter Basics
100% (4)
Teamcenter Basics
444 pages
Basic Teamcenter: Bill of Material Concept
No ratings yet
Basic Teamcenter: Bill of Material Concept
8 pages
Bmide Handbook
No ratings yet
Bmide Handbook
16 pages
Team Center
100% (1)
Team Center
406 pages
Server Customization Programmers Guide
No ratings yet
Server Customization Programmers Guide
336 pages
Teamcenter Installation Document
0% (2)
Teamcenter Installation Document
530 pages
Technical Drawings Summary
100% (2)
Technical Drawings Summary
16 pages
Teamcenter SOA Framework Guide
No ratings yet
Teamcenter SOA Framework Guide
9 pages
Teamcenter Options and Variants
No ratings yet
Teamcenter Options and Variants
7 pages
Aerospace and Defense Install Config
No ratings yet
Aerospace and Defense Install Config
26 pages
Solidworks Exercise Book PDF
70% (20)
Solidworks Exercise Book PDF
38 pages
Teamcenter Client Customization Programmers Guide
0% (1)
Teamcenter Client Customization Programmers Guide
464 pages
Teamcenter Admin
100% (1)
Teamcenter Admin
658 pages
Teamcenter Manufacturing. Teamcenter Active Workspace. Teamcenter UA. Teamcenter Visualization. Teamcenter MRO. Teamcenter Product Costing.
No ratings yet
Teamcenter Manufacturing. Teamcenter Active Workspace. Teamcenter UA. Teamcenter Visualization. Teamcenter MRO. Teamcenter Product Costing.
32 pages
csv2tcxml:TCXML Data Migration in TC11.2.x
No ratings yet
csv2tcxml:TCXML Data Migration in TC11.2.x
1 page
Teamcenter Training Manual Overview
No ratings yet
Teamcenter Training Manual Overview
63 pages
Getting Started Teamcenter
No ratings yet
Getting Started Teamcenter
28 pages
NX Environment Variables Overview
No ratings yet
NX Environment Variables Overview
6 pages
TC Dispatcher Install and Debug With Async and NX
100% (3)
TC Dispatcher Install and Debug With Async and NX
20 pages
NX WAVE Control Structure Tutorial
100% (1)
NX WAVE Control Structure Tutorial
31 pages
Fusion 360 Training
100% (8)
Fusion 360 Training
195 pages
Teamcenter For Project and Program
No ratings yet
Teamcenter For Project and Program
1 page
Environment Manager
No ratings yet
Environment Manager
234 pages
In VPF Enrollment Guide APR2020 en
No ratings yet
In VPF Enrollment Guide APR2020 en
1 page
Dispatcher Install and Configure
No ratings yet
Dispatcher Install and Configure
127 pages
Audit Manager
No ratings yet
Audit Manager
57 pages
Chi Gura
No ratings yet
Chi Gura
1 page
Invoice-Ajay Durga Rath-2024-08-26 12 03 42
No ratings yet
Invoice-Ajay Durga Rath-2024-08-26 12 03 42
1 page
Gautami R Pyati - Resume
No ratings yet
Gautami R Pyati - Resume
2 pages
Solr Sync SLA BabyStyle Manual
No ratings yet
Solr Sync SLA BabyStyle Manual
2 pages
Ajay Durga Rath
No ratings yet
Ajay Durga Rath
1 page
081-2490-G-1 FY22 Agile SSO Implementation - TS
No ratings yet
081-2490-G-1 FY22 Agile SSO Implementation - TS
29 pages
ManojKumar Resume
No ratings yet
ManojKumar Resume
2 pages
Mowa Science
No ratings yet
Mowa Science
1 page
Solr Indexing Sla
No ratings yet
Solr Indexing Sla
2 pages
Mohamed Azharudeen Devops Engg Updtd
No ratings yet
Mohamed Azharudeen Devops Engg Updtd
3 pages
Tax Invoice
No ratings yet
Tax Invoice
2 pages
Cfs Azure Devops
No ratings yet
Cfs Azure Devops
1,079 pages
Devops - Sre All in One Go
No ratings yet
Devops - Sre All in One Go
9 pages
Wa0049.
No ratings yet
Wa0049.
1 page
Devops
No ratings yet
Devops
4 pages
Wa0043.
No ratings yet
Wa0043.
1 page
Wa0079
No ratings yet
Wa0079
1 page
Wa0078
No ratings yet
Wa0078
1 page
Youth Function
No ratings yet
Youth Function
2 pages
Vyshu Final Protocol - v3
No ratings yet
Vyshu Final Protocol - v3
17 pages
Poverty
No ratings yet
Poverty
2 pages
Impact of Social Media On Human Relationships
No ratings yet
Impact of Social Media On Human Relationships
2 pages
Manideep2025 PDF
No ratings yet
Manideep2025 PDF
2 pages
17250/CCT TPTY EXP Third Ac (3A)
No ratings yet
17250/CCT TPTY EXP Third Ac (3A)
3 pages
Bhargav Chilla Resume
No ratings yet
Bhargav Chilla Resume
2 pages
Abhibus AX5675109576
No ratings yet
Abhibus AX5675109576
2 pages
Grade 4 Term 1 Math Assignment 2024
No ratings yet
Grade 4 Term 1 Math Assignment 2024
4 pages
Research Report Lesson Plan for Grade 7
No ratings yet
Research Report Lesson Plan for Grade 7
3 pages
FN Viii Ime CQ
No ratings yet
FN Viii Ime CQ
2 pages
Language and Nationality Quiz
No ratings yet
Language and Nationality Quiz
7 pages
Math 9 Quadratic & Variation Quiz
No ratings yet
Math 9 Quadratic & Variation Quiz
5 pages
Rizal
No ratings yet
Rizal
53 pages
Articulation Points in Graphs
No ratings yet
Articulation Points in Graphs
3 pages
Designing Texts
No ratings yet
Designing Texts
9 pages
Passing Arrays To Functions
No ratings yet
Passing Arrays To Functions
9 pages
Rainbow Robotics - UI Script Manual
No ratings yet
Rainbow Robotics - UI Script Manual
88 pages
Turn-Taking and Interrupting
No ratings yet
Turn-Taking and Interrupting
11 pages
2 Daddy-Daughter, Hitler-Jews in Sylvia Plath's Poetry
No ratings yet
2 Daddy-Daughter, Hitler-Jews in Sylvia Plath's Poetry
11 pages
Office Automation Tools
No ratings yet
Office Automation Tools
38 pages
The Simscript Programming Language: P. Kivict. R. Villanueva Ant, H. M. Markowitz
No ratings yet
The Simscript Programming Language: P. Kivict. R. Villanueva Ant, H. M. Markowitz
394 pages
HSC Grammar
No ratings yet
HSC Grammar
17 pages
(ROOT) Super Leaky Bros. Presents Sprint Galaxy Note 7 Root Method. - XDA Forums
No ratings yet
(ROOT) Super Leaky Bros. Presents Sprint Galaxy Note 7 Root Method. - XDA Forums
13 pages
NOUNS Singular - Plural Chart
No ratings yet
NOUNS Singular - Plural Chart
1 page
8.SINIF İNG 1.DÖNEM 2.YAZILI 2025-26 (Senaryo 1) PDF
No ratings yet
8.SINIF İNG 1.DÖNEM 2.YAZILI 2025-26 (Senaryo 1) PDF
5 pages
50 Days of Python
No ratings yet
50 Days of Python
147 pages
Cambridge Global English Level 5 Progress 1
No ratings yet
Cambridge Global English Level 5 Progress 1
12 pages
Burger Point Menu: Computer Assignment by Aaditya Joshi
No ratings yet
Burger Point Menu: Computer Assignment by Aaditya Joshi
3 pages
12th Class ICT Project File Guide
No ratings yet
12th Class ICT Project File Guide
3 pages
HOW TO INSTALL DROZER IN KALI LINUX 2021.4 - HackMD
No ratings yet
HOW TO INSTALL DROZER IN KALI LINUX 2021.4 - HackMD
1 page
ME EngRW 11 Q3 0203 PS Writing A Topic Outline
No ratings yet
ME EngRW 11 Q3 0203 PS Writing A Topic Outline
41 pages
Classroom Activities: Lynne Debenedette William J. Comer Alla Smyslova
No ratings yet
Classroom Activities: Lynne Debenedette William J. Comer Alla Smyslova
260 pages
Unearthing An Industrial Past in Kodumanal Tamil Nadu
100% (1)
Unearthing An Industrial Past in Kodumanal Tamil Nadu
5 pages
Phrasal Verbs Prepositions TEST6
No ratings yet
Phrasal Verbs Prepositions TEST6
4 pages
Nick Adams' Heartbreak in Hemingway's Stories
No ratings yet
Nick Adams' Heartbreak in Hemingway's Stories
3 pages
Image Segmentation Techniques Explained
No ratings yet
Image Segmentation Techniques Explained
71 pages
Department of Education: Republic of The Philippines
100% (7)
Department of Education: Republic of The Philippines
3 pages