ACTIVE INTEGRATION GATEWAY

Teamcenter Gateway
for Enterprise
Applications - Active
Workspace Add-ons
Installation and Setup
Guide
Software Version 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 publication shall be deemed to be a warranty or give rise to any liability of
Siemens whatsoever.

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

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

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

About Siemens Digital Industries Software

Siemens Digital Industries Software is a 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: https://support.sw.siemens.com

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

ii Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Table of Contents
Preface................................................................................................................. v

Introduction...................................................................................................... 1-1

Installation and Setup of the WebDV................................................................2-1

Prerequisites..................................................................................................................2-1
Overview....................................................................................................................... 2-1
Installation and Deployment.........................................................................................2-2
Configure the Active Workspace Gateway.................................................................... 2-3
Declare BOM Target Types.............................................................................................2-6
Direct Teamcenter Preferences to XRTs.........................................................................2-7
Create and Modify XRTs................................................................................................ 2-8
Find the XRTs to Derive from............................................................................................... 2-8
Modify the XRTs..................................................................................................................2-9
Configure the Control Panel.............................................................................................. 2-15
Import the XRTs into Teamcenter...................................................................................... 2-17
Validate Results........................................................................................................... 2-20
Verify That Your XRT Changes Are Effective........................................................................2-20
Verify That the HTML Panel Gets Displayed........................................................................ 2-21
Tweak URL with WebDV in Own Browser Tab..................................................................... 2-22
Application Server Peculiarities.................................................................................. 2-24
Channel Messaging to the Rescue..................................................................................... 2-24
Microsoft Internet Information Services (IIS)..................................................................... 2-24
Active Workspace Versions..........................................................................................2-27
Active Workspace 6.2 and Above.......................................................................................2-27
Operating Systems...................................................................................................... 2-28
Linux................................................................................................................................2-28
Enabling Channel Messaging...................................................................................... 2-29
Installation and Deployment............................................................................................. 2-29
XML Rendering Templates for Channel Messaging............................................................. 2-30
Advanced WebDV Configuration................................................................................. 2-32
Use Browser Developer Tools to Find Property Names........................................................ 2-32
Use the Teamcenter User Name for the EA Logon.............................................................. 2-37
Active Content Structures With the WebDV........................................................................2-39
Known Issues...............................................................................................................2-40
Theme Switching..............................................................................................................2-40
Preservation of Widget State............................................................................................. 2-40
Troubleshooting the WebDV........................................................................................2-41
WebDV not Showing Up or No Changes Visible..................................................................2-41
Errors During Setup.......................................................................................................... 2-42
Solve Configuration Issues with Log Messages...................................................................2-43

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide iii
Unpublished work. © 2024 Siemens Software Version 2406
 WebDV Compared to RAC Dataview..................................................................3-1
Dataview Mark-Up Only Rendered in the RAC Dataview...............................................3-1
RAC Dataview Mark-Up Only Rendered in the WebDV.................................................. 3-1
Error Messages.............................................................................................................. 3-1

Installation of the Basic Active Workspace Add-Ons........................................ 4-1

Installation and Setup of the EA Connection Overview................................... 5-1

Overview....................................................................................................................... 5-1
Installation of the EA Connection Overview................................................................. 5-5
Configuration of the EA Connection Overview............................................................. 5-6

Installation and Setup of the Logon Task Support............................................6-1

Installation of the EA Logon Task Support.................................................................... 6-1
Adaption of the Active Workspace module................................................................... 6-1
Trying out the Logon Task Support............................................................................... 6-2
Advanced EA Logon Task Configuration........................................................................6-3
Use Browser Developer Tools to Find Property Names in Task Objects...................................6-3
Use the Teamcenter User Name for the EA Logon Task.........................................................6-4

Installation and Setup of the External Query Support..................................... 7-1

Overview....................................................................................................................... 7-1
Create External Queries for the Active Workspace....................................................... 7-3
Installation of the External Query Support................................................................... 7-4
Define Icons for the Search Result.................................................................................7-4
XML Rendering Templates.............................................................................................7-6
Customization of the Advanced Search Table View...................................................... 7-9

Teamcenter Preference Examples.................................................................... A-1

T4EA Preferences.......................................................................................................... A-1

XML Rendering Template Examples................................................................. A-1

WebDV_T4S_Demo_XRT Dataset...................................................................................A-1
WebDV_T4S_Dataset_Demo_XRT Dataset.................................................................... A-2
WebDV_T4S_Resource_Demo_XRT Dataset.................................................................. A-2
WebDV_T4S_Vendor_Demo_XRT Dataset..................................................................... A-3
WebDV_T4O_Demo_XRT Dataset.................................................................................. A-3
WebDV_T4EA_Demo_XRT Dataset................................................................................ A-4

Active Workspace SVG Images......................................................................... A-1

Glossary............................................................................................................xxx

iv Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Preface
This documentation cannot be used as a substitute for consulting advice, because it can never consider
the individual business processes and configuration. Despite our best efforts it is probable that some
information about functionality and coherence may be incomplete.

Issue: July 2024

Legal notice:

All rights reserved. No part of this documentation may be copied by any means or made available to
entities or persons other than employees of the licensee of the Active Integration Gateway or those that
have a legitimate right to use this documentation as part of their assignment on behalf of the licensee to
enable or support usage of the software for use within the boundaries of the license agreement.

© 2002-2024 Siemens Industry Software Inc.

Trademark notice:

Siemens, the Siemens logo and Opcenter are registered trademarks of Siemens AG.

Camstar and Teamcenter are trademarks or registered trademarks of Siemens Industry Software Inc. or its
subsidiaries in the United States and in other countries.

Oracle is a registered trademark of Oracle Corporation.

SAP, R/3, SAP S/4HANA®, SAP Business Suite® and mySAP are trademarks or registered trademarks of SAP
or its affiliates in Germany and other countries.

TESIS is a registered trademark of TESIS GmbH.

InfluxDB® is a trademark registered by InfluxData, which is not affiliated with, and does not endorse, this
product.

Telegraf™ is a trademark owned by InfluxData, which is not affiliated with, and does not endorse, this
product.

The Grafana® Word Mark and Grafana Logo are either registered trademarks/service marks or trademarks/
service marks of Coding Instinct AB, in the United States and other countries and are used with Coding
Instinct’s permission. We are not affiliated with, endorsed or sponsored by Coding Instinct, or the Grafana
community.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide v
Unpublished work. © 2024 Siemens Software Version 2406
 Nagios®, the Nagios logo, and Nagios graphics are the servicemarks, trademarks, or registered trademarks
owned by Nagios Enterprises, which is not affiliated with, and does not endorse, this product.

All other trademarks, registered trademarks or service marks belong to their respective holders.

Acknowledgements

This product includes numerous open source components. For more information, please refer to the
readme on OSS in the download section. In particular we like to point out:

Contains portions or was derived from the RSA Data Security, Inc. MD5 Message-Digest Algorithm.

This product includes software developed by the OpenSSL Project for use in the OpenSSL
Toolkit. (http://www.openssl.org/) This product includes cryptographic software written by Eric Young
([email protected]).

vi Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
1. Introduction
This manual explains the installation and configuration of the Active Integration Gateway add-ons for
Teamcenter Active Workspace that are part of AIG version 2406.

The T4EA Preferences appendix contains examples for Teamcenter preference files and

XML Rendering Template Examples for XML Rendering Templates (XRTs) used to configure the add-ons.
Note that they do not cover all products for which the add-ons are available. Example files are also shipped
with the products. The Active Workspace SVG Images appendix provides an overview of the icons that
are delivered with the Teamcenter Active Workspace (AW) and might help you to find icons to represent
the results of your external queries. Terms are explained in the Glossary.

The Teamcenter Gateway for Enterprise Applications adds the following features to the Teamcenter Active
Workspace (AW):

• EA Connection Overview
The EA Connection Overview allows users to view and manage connections to external enterprise
application systems. Users can list the connections, view them and change their states, i. e. log in to or
out from external systems.
• Logon Task Support
The Logon workflow task allows users to authenticate themselves against external enterprise application
systems in the context of Teamcenter workflows. A form asking for credentials will be presented to
users who select a Logon task from their Active Workspace inbox. The form is displayed under Action or
Actions in the secondary work area.
Note that each product comes with its own variation of the Logon task. They are called SAP Logon Task,
EBS Logon Task or EA Logon Task respectively.
The Logon task support is available for T4S, T4S4, T4O and T4EA.
• External Query Support
External queries allow users to perform search queries in external Enterprise Application systems such as
SAP and view the found objects in the Active Workspace. The external object that the user selected can
be imported into Teamcenter or explored in the Dataview for Web. The External Query Support shipped
with AIG 2406 utilizes the Advanced Search funtionality of the Active Workspace.
The external query has no log-on dialog to pop up in case the query has no valid connection to the EA
system. An EA connection has to be established and activated before the query is run.
• Dataview for Web (WebDV)
The Dataview for Web, or WebDV for short, brings the capabilities of the already available AIG Dataview
to web based applications like the Teamcenter Active Workspace. It provides users a view into enterprise
applications that are connected to Teamcenter using AIG.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 1-1
Unpublished work. © 2024 Siemens Software Version 2406
 Caution
• Checkout the Active Workspace 6.2 and Above chapter for additional information specific to
particular versions of the Active Workspace.
• This document assumes a Windows operating system. Checkout the Linux chapter for additional
information specific to other operating systems such as Linux.
• The WebDV is a very simple web application that can be served by most web application servers like
Tomcan, JBoss, or Microsoft IIS. Although it comes as a JAR file it does neither require JEE services nor
Java beyond what Teamcenter already provides with the tc.war application. If we get to know of web
application servers that require special considerations, we will document them in the Application
Server Peculiarities section.
• As of AIG 2412 there is a new way to configure the Dataview that does not require XRTs to be
modified. It uses conditions formulated in the AIG mapping configuration. A Dataview configured this
way is displayed in a command panel.
• For the sake of readability long lines have been split into multiple parts at positions marked with ↩.
Re-join them when using the examples in your configuration.
• File system paths or code example may contain placeholders like the following:
<<TC_ROOT>>
The installation folder of Teamcenter and the contents of the TC_ROOT environment variable.
<<TC_DATA>>
The location where all data related to Teamcenter is stored and the contents of the TC_DATA
environment variable.

1-2 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Prerequisites

2. Installation and Setup of the WebDV

Prerequisites

• Before starting the WebDV setup it is recommended to have a running AIG environment (see
Teamcenter Gateway for Enterprise Applications - Installation Guide for details)
• The WebDV requires a Teamcenter four-tier installation, including the AIG extensions. It does not have
to be installed on every machine where an AIG four-tier client is used, but only once for the whole
environment, i.e. on any machine which is reachable in the network by all the four-tier clients.

Overview
The setup of the WebDV comprises the following steps:

1. Installation and Deployment

2. Declare BOM Target Types (optional)
3. Direct Teamcenter Preferences to XRTs
4. Create and Modify XRTs
5. Configure the Active Workspace Gateway
6. Specific actions for your AW version
7. Installation and Deployment (optional)

Note
Setting up channel messaging used to be required in cases where the Active Workspace runs in
hosted mode, i.e. is made available in applications like NX or the Rich Client. The communication
method, which is based on channel messaging, is therefore sometimes referred to as hosted mode
support. Today, depending on the version of the embedded browser and the Active Workspace,
the WebDV might be able to function in a hosted Active Workspace without channel messaging.
However the hosted mode support is still useful in cases where the HTTP session cannot be shared
between the Active Workspace and the WebDV for some other reason.

8. Validate result

The following chapters will explain these steps in more detail.

Note
• If you have chosen to install any of the AIG demo templates as described in the installation guides
for the AIG products, you will get a set of Teamcenter preferences and XRTs to start from. Most
examples in this document are based on the demo templates however assuming that none of them

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-1
Unpublished work. © 2024 Siemens Software Version 2406
Installation and Deployment

was installed. So if you have installed a demo template you may not have to create preferences or
XRTs but just modify them.
• The examples in this document are minimized to focus on the crucial points.
• They build upon each other and rely on the mapping delivered with AIG 2406
• An example set of preferences and XRT modifications of the AIG demo templates can be found in the
appendices at the end of this document.

Installation and Deployment

The following features need to be installed using the Teamcenter Environment Manager or Deployment
Center:

• ai0activeintegration - Active Integration

This feature contains implementations of SOA services to mediate remote function calls from the
add-ons such as the WebDV or the EA logon task support between the Teamcenter server and the
Gateway Service.
• webdv4awsource (optional, for channel messaging only) - Active Integration for Active Workspace
(Hosted Mode)
It contains an Active Workspace module that mediates function calls between the WebDV and
the Active Workspace using HTML 5 channel messaging. The Teamcenter Environment Manager or
Deployment Center will install it into the aws2/stage/src/solution/webdv-glue folder inside
your Teamcenter installation.

Caution
Please read the chapter Installation and Deployment before you install that template.

The WebDV comes as a file named webdv.war. Get it from the installation directory of a Gateway Service
under var\template\webdv.

Copy that file into the application server’s deployment directory alongside the tc.war file. For the Tomcat
application server this would be webapps, for example.

Caution
• The XRTs will reference the WebDV through a URL that is relative to that of the Active Workspace. The
browser will complement it into an absolute URL which will point to the Active Workspace Gateway.
The latter will route it to the web server on which the WebDV has been deployed. If you rename
the war file or change the web server to serve the WebDV at a different URL, you need to update
the configuration of the Active Workspace Gateway. This is described in more detail in Configure the
Active Workspace Gateway.

2-2 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Configure the Active Workspace Gateway

• If the WebDV is not configured to use channel messaging as described under Installation and
Deployment, the WebDV needs to be able to join the HTTP session of the AW. This means that
you need to configure your application server to share HTTP sessions between web applications.
• See also chapter Channel Messaging to the Rescue.

Verify that you successfully installed the WebDV by calling its URL in a browser. You should see the intro
page as shown below where the URL might differ depending on your web server setup:

You will have to remember the URL for the configuration explained in Configure the Active Workspace
Gateway.

Configure the Active Workspace Gateway

Caution
Be careful about the syntax of the JSON files. In particular:

• Do not add comments.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-3
Unpublished work. © 2024 Siemens Software Version 2406
Configure the Active Workspace Gateway

• Separate the items of lists with commas.

• Avoid trailing commas at the end of lists.

The WebDV is a simple web application that can be deployed on most web servers including Java EE
or Microsoft Internet Information servers. You would normally deploy it alongside the Teamcenter web
application (tc.war) which is a Java EE or .Net web application.

The Active Workspace Gateway is a NodeJS-based web server that provides HTTP(S) access to the Active
Workspace. It also acts as a proxy server to provide a single entry point for various services or web
applications including the Active Workspace itself. It is configured by the config.json file that you find in
the folder whose path matches <<TC_ROOT>>/microservices/gateway-*.*.*. In order to make the
WebDV accessible through the Active Workspace Gateway you need to add the following pieces to this file:

Routes

For security reasons the WebDV must be reachable at the same host and port as the Active Workspace.
Moreover absolute URLs in the XRTs are hard to maintain and should be avoided. In order to make the
WebDV reachable through a relative URL at the same host and port as the Active Workspace add a route to
the Active Workspace Gateway.

Add the route to the config.json file like so:

[...]
"routes": {
"tc": {
"path": "/tc",
"target": "http://dev19:8080/tc"
},
"vis": {
"path": "/VisProxyServlet",
"target": "/VisProxyServlet"
},
"webdv": {
"path": "/webdv",
"target": "http://localhost:8080/webdv"
}
},
[...]

Note
• If you encounter issues with the configuration of the Active Workspace Gateway, check its log file.
Consult Solve Configuration Issues with Log Messages for the location of the log file and for
troubleshooting tips. Note that a faulty configuration file may cause the Active Workspace Gateway to
not even start.
• Prior to AIG 23.1 the routes configuration of the WebDV used to be three routes, namely
webdv.root, webdv.root.eatslash and webdv.soaclient. They existed to provide a smooth

2-4 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Configure the Active Workspace Gateway

transition from the ICT to the SOA communication method and to allow the WebDV to be referenced
as /webdv, without appending index.html. SOA has become the default communication method
anyway and the shorthand URL is now handled inside the WebDV. Although the WebDV will still work
with the routes triple we strongly recommend to replace it with the single route shown above.

CsurfExclusions

For the WebDV the Active Workspace Gateway acts as a proxy routing all requests to the web server that
hosts the WebDV. The WebDV shipped with AIG 2406 does not participate in the communication scheme
established by the csurf component. This results in an error message complaining about an invalid csrf
token. There are two options to prevent this error from showing up:

1. Extend the CsurfExclusions property in the configuration of the Active Workspace Gateway like
shown below.
2. Use channel messaging as described in Installation and Deployment

To extend the CsurfExclusions property modify theconfig.json file that you find in the folder whose
path matches <<TC_ROOT>>/microservices/gateway-*.*.*. Specify the exclusion for the request
issued by the WebDV as an element to be added to the csurfExclusions attribute like so:

[...]
"security": {
[...]
"csurfExclusions": [
"/AWSSOLogin",
"/graphql",
"/.*/Gateway-.*-GenericService/"
],
[...]
}
[...]

The elements in the csurfExclusions array are regular expressions where .* matches an
arbitrary number of characters. There is an implicit .* at the end of the expression so it is
actually matched against some prefix of the path. At the time of this writing the full path of the
request is /tc/JsonRestServices/Gateway-2015-10-GenericService/stringFromSCmdMArg.
By using a regular expression the configuration is more likely to work with future versions of AIG.

Make changes effective

After saving the file you need to restart the microservice manager. On Windows open the task manager,
change to the services tab and restart the Teamcenter Process Manager service. Consult the Resetting
the Active Workspace gateway and microservices section in the Active Workspace documentation for more
information. Verify the routes configuration by trying to access the WebDV's intro page through the Active
Workspace Gateway:

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-5
Unpublished work. © 2024 Siemens Software Version 2406
Declare BOM Target Types

Channel Messaging to the Rescue

The SOA communication method relies on HTTP session sharing so the server requests from the WebDV
use the same Teamcenter session as those from the Active Workspace. If that is not given or you
experience the User does not have a valid session error message for other reasons, you can still use
the channel messaging. It uses the GLUE communication method as described under Installation and
Deployment.

Note that the SOA as well as the GLUE communication methods require the ai0activeintegration template
being installed. Find more information under Installation and Deployment.

Declare BOM Target Types

AIG handles bill-of-material kind of target types in special ways. The question is how the server gets aware
that an object is to be treated as a BOM. In the Teamcenter Rich Client users can select BOM lines in the

2-6 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Direct Teamcenter Preferences to XRTs

structure manager or BOM view revision objects in My Teamcenter. The RAC Dataview sends their IDs to
the server. The AIG extension uses APIs provided by Teamcenter to determine the types of the objects.

In the Active Workspace neither BOM lines nor BOM view revision objects are represented as selectable
elements, so the server cannot tell from the selected object whether to treat an object as a BOM or not.

The solution is to declare target types to be of BOM kind using Teamcenter preferences. The names of
these preferences are formatted as follows:

Product_TargetTypeIsBOM

Product is one of T4S, T4S4, T4ST, T4O or T4EA. TargetType is the long name of the target type, e.g.
BillOfMaterial. An example of a preference name would be T4S_BillOfMaterialIsBOM. The
preference is of logical type and the value can be true or false. Not creating or deleting such a preference is
the same as setting it to false.

More examples for IsBOM preferences can be found in the T4EA Preferences appendix.

Direct Teamcenter Preferences to XRTs

The user interfaces of the Active Workspace as well as of the Rich Client change their appearance
depending on the type of the selected object. Teamcenter preferences are used to control which XRT
will be used to render the information for a particular type of object. The names of the preferences do
always contain the names of the type and the type of view that is rendered by the XRT. They can contain
the location or even sublocation of the rendered area within in the Active Workspace. Their values are the
names of the datasets holding the XRTs. Types given in the preference names include their subtypes unless
covered by preferences explicitly referring to the subtype.

For the WebDV only the preferences that refer to Item Revision types, their subtypes or Dataset types and
summary views are relevant.

Following are some of the relevant preferences you will find in an out-of-the-box Teamcenter installation.

• AWC_ItemRevision.showObjectLocation.SUMMARYRENDERING pointing to the

Awb0ItemRevSummaryForShowObjectLocation dataset.
• AWC_ItemRevision.showObjectLocation.OccurrenceManagementSubLocation.SUMMARYR
ENDERING pointing to the Awp0ItemRevSummary dataset.
• AWC_VendorRevision.SUMMARYRENDERING pointing to the Vm1VendorRevSummary dataset.
• AWC_Dataset.SUMMARYRENDERING pointing to the Awp0DatasetSummary dataset.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-7
Unpublished work. © 2024 Siemens Software Version 2406
Create and Modify XRTs

Caution
• Siemens PLM Software discourages the modification of their out-of-the-box XRTs. Instead
administrators are encouraged to create their own XRTs as modified copies of the out-of-the-box
XRTs. They should then create or modify preferences to point to their new XRTs.
• Be sure not to share XRTs between the Rich Client and the Active Workspace because there are
elements that can only be used in either of them and will cause errors in the other, e.g. htmlPanel is
only valid in the Active Workspace.
• You need to log out from the Active Workspace and log in again to make your preference changes
effective.

Example: Create a preference to point to an XRT Dataset

Create the AWC_SAP2_T4S_Item Revision.showObjectLocation.SUMMARYRENDERING

preference of type String and give it the value WebDV_T4S_Demo_ForShowObjectLocation_XRT.

Note the name of the SAP2_T4S_Item Revision type appearing in the preference name.

If the user now selects an object of SAP2_T4S_Item Revision type or an of its subtypes, the
WebDV_T4S_Demo_XRT dataset will be used to render the data related to that object.

The Create and Modify XRTs section will show how to create an XRT dataset.

Create and Modify XRTs

Up to now the preferences covered in the previous section point to nowhere. In this section you will learn
how to create the XRT datasets that get the WebDV into the Active Workspace.

Find the XRTs to Derive from

At first, search for the preferences that point to the out-of-the-box XRTs (see previous section). Use their
values to perform searches for the dataset names. Open the named references dialogs and download the
named references into files.

Rename the files so they correspond to the values of the

preferences defined in the previous section, e.g. Awp0ItemRevSummary
toWebDV_T4S_Demo_XRT.xml or Awb0ItemRevSummaryForShowObjectLocation
toWebDV_T4S_Demo_ForShowObjectLocation_XRT.

2-8 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Modify the XRTs

Note
You can also use the plmxml_export command line utility to export all XRTs from Teamcenter like so:

plmxml_export -u=infodba -p=infodba↩

-transfermode=ConfiguredDataFilesExportDefault↩
-type=XMLRenderingStylesheet↩
-xml_file=XRTs.xml

For the sake of readability the above example is formatted into multiple lines where the ↩ indicate that
the line has to be continued when you type it in. You would find the XRTs in the XRTs sub-folder and a
PLMXML document describing the Datasets in the XRTs.xml file.

Modify the XRTs

Edit the XRT files using an XML-aware editor.

Note
With appropriate permissions you could edit XRTs directly in the Viewer tab. However this is not
recommended as it neither provides syntax highlighting nor syntax validation nor content assistance.

Better edit XRTs in XML-aware editors with syntax highlighting and copy&paste the file contents into the
Viewer tab using the keyboard shortcuts Ctrl-A, Ctrl-C and Ctrl-V. Ideally the editor should also check for
the well-formedness of the XRT.

You can also save the changes to a file and import that file into Teamcenter using the import_file
command line utility like so:

import_file -de=r -u=<username> -p=<password>↩

-f=WebDV_T4S_Demo_XRT.xml↩
-type=XMLRenderingStylesheet↩
-ref=XMLRendering↩
-d=WebDV_T4S_Demo_XRT↩

For the sake of readability the above example is formatted into multiple lines where the ↩ indicate
that the line has to be continued when you type it in. The WebDV_T4S_Demo_XRT.xml is the name of
the file and WebDV_T4S_Demo_XRT the name of the Dataset. Note that you need to omit the filename
extension for the latter.

You could also use the XRT Editor which you find in the Active Workspace but make sure to read below
caution notes.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-9
Unpublished work. © 2024 Siemens Software Version 2406
Modify the XRTs

Caution
When using the XRT Editor inside Active Workspace to edit an XRT that you do not own, a copy of the
XRT dataset is created with a name that has your user name appended. The preference that points to the
XRT is modified accordingly.

The WebDV is represented through HTML panels. They are a general means to embed external resources,
i.e. content from other sites or web applications into the Active Workspace. In XRTs HTML panels appear
as htmlPanel elements. Their src attributes reference external resources using <iframe src="…" />
elements.

You can start by adding this simple page to the XRT:

[...]
</page>
<page title="WebDV Intro">
<htmlPanel
enableresize="true"
src="/webdv" />
</page>
<inject type="dataset" [...]

You will again see the intro page, this time inside the Active Workspace:

2-10 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Modify the XRTs

You can have multiple HTML panels per XRT. They can be placed into pages, sections or columns.

You need to add enableresize="true" to the htmlPanel element to allow for more than 150 pixels
height.

Caution
• Note that the Active Workspace does only support one HTML panel with enableresize="true" per
page. Multiple HTML panels would be displayed 150 pixels high, too little for a Dataview.
• Prior to Active Workspace 6.2 it was possible to write the htmlPanel with opening and closing
tags to include a CDATA section with HTML elements. As of Active Workspace 6.2 this is no longer
supported.
• When channel messaging is needed, some modifications have to be applied to the XRT. Read
Installation and Deployment to learn whether or not you need channel messaging, how to enable it
and how to modify the XRTs if you need it.
• Be careful when copying examples from the documentation. It may display line breaks that must not
appear in the XRT files. XML attributes must not contain line breaks.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-11
Unpublished work. © 2024 Siemens Software Version 2406
Modify the XRTs

Now adjust the page title and extend the URL in the src attribute as follows:

src="/webdv?tcobj={{selected.uid}};<Parameter1>;<Parameter2>;…"

Note
• If you managed to embed the WebDV into the Active Workspace, you can open just the WebDV in
a new browser tab and tweak its URL directly. This is described in more detail in Tweak URL with
WebDV in Own Browser Tab.
• Note that the parameters in the URL are not evaluated by any server-side component. Only the WebDV
uses them to adapt itself accordingly.
• Notes regarding the syntax of the URLs used to call the WebDV:
The character used to separate the parameters from each other is the semicolon ; in contrast to the
ampersand & often used in the world wide web for this purpose. This is to avoid having to escape the
ampersand characters with the &amp; entity in XRTs.

The src attribute contains all the information required to display the WebDV inside the Active Workspace.
Let’s look at its parts a bit closer:

/webdv is a relative path that tells the Active Workspace to display the WebDV. It must correspond
to the path specified in the configuration of the Active Workspace Gateway. See Configure the Active
Workspace Gateway for the details.
? The question mark separates the path from the parameters
tcobj={{selected.uid}} is always needed to connect the WebDV to the selected
Teamcenter object. If the selected object is an Awb0Element or one of its subtypes use the
{{selected.props.awb0UnderlyingObject.dbValues[0]}} placeholder. See an example
below and learn more about this in Active Content Structures With the WebDV.
; The semicolon separates parameters from each other
<Parameter1>;<Parameter2>;… is a semicolon-separated list of parameters. Each parameter is of
the form <Name>=<Value>.
The following parameters can be used to configure the WebDV:
product=<Value> is mandatory. It defines the product that is part of the AIG product suite to be
supported by the WebDV. Examples are T4S, T4ST, T4O or T4EA.

Note
Note that for the T4S4 product you need to set the product parameter to T4S.

eaobjtype=<LongValue> and eaobjtypeshort=<ShortValue> tell the WebDV which target type

to query. The latter provides the short form of the target type’s name. For the following set of target
types you only need to provide either one or the other because the WebDV can translate between them:
◦ T4S, T4S4:

2-12 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Modify the XRTs

◊ MaterialMaster (short MM)

◊ DocumentInfoRecord (short DIR)
◊ BillOfMaterial (short BOM)
◊ ChangeMaster (short ECM)
◊ EquipmentMaster (short EQUI)
◊ FunctionalLocation (short FUNCLOC)
◊ Vendor (short VENDOR)
◦ T4ST:
◊ ProductVersion (short PV)
◊ StructureVersion (short SV)
◊ DocumentVersion (short DV)
◊ ChangeObject (short CO)
◦ T4O:
◊ Item (short ITEM)
◊ BillOfMaterial (short BOM)
◊ ChangeOrder (short ECO)
For target type names that are not listed above and whose long and short names equal it is sufficient to
either provide the long or the short name.
eaot=<ShortValue> is an alias for eaobjtypeshort=<ShortValue>.
Note that the target type must be specified in either of the above forms.
eacon=<Value> specifies the connection over which to retrieve the data from the external system.
If you repeat this parameter, the user can choose among the connections given as values. If this
parameter is omitted, the WebDV tries to connect to the EA system using the preferred (also called
active) connection.
ealang=<Value> is used for T4S, T4S4, T4ST and T4EA to provide the possible values for the language
chooser of the login dialog. It can be repeated as well.
locale=<Value> tells the WebDV which locale to use to display its control elements and messages.
The possible values are cs_CZ, de, en, es, fr, it, ja_JP, ko_KR, pl_PL, pt_BR, ru_RU, zh_CN and
zh_TW. The default is derived from the browser's language.
controlpanel=on tells the WebDV to show the control panel in the upper right corner of its visible
area. If this parameter is omitted, the control panel will not be shown. Read more about the control
panel in Configure the Control Panel.
com=<Method> specifies how the WebDV communicates with the Teamcenter AIG server. These values
are accepted:
SOA

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-13
Unpublished work. © 2024 Siemens Software Version 2406
Modify the XRTs

Server-side operations are invoked by directly sending HTTP(S) requests to the tc web tier application
server, which in turn calls the AIG SOA Gateway service that has been added to the Teamcenter
server. Such requests can be observed using the browser's development tools (hit F12). Their paths
start with /tc/JsonRestServices/Gateway-2015-10-GenericService. Note that SOA is the
default so it will normally not appear in the URL.
GLUE
Server-side operations are formulated as message objects sent to the webdv-glue component through
message channels. The webdv-glue component has to be added to the Active Workspace. It turns the
messages into HTTP(S) requests that now appear as if they originated in the Active Workspace. See
Enabling Relayed Communication based on Channel Messaging for the details.

Following an example of a WebDV HTML panel embedded in a page (continue line at ↩):

[...]
</page>
<page title="SAP Material Master">
<htmlPanel enableresize="true"
src="/webdv?tcobj={{selected.uid}};product=T4S;eaot=MM" />
</page>
<page titleKey="tc_xrt_viewer" [...]

If you need to enable a page or other elements of the XRT based on the type of the selected object or
other conditions you can use the visibleWhen attribute on <page> or <content> elements like shown
in below examples (adjust the line breaks to get valid XML):
• Only show the SAP Bill of Material page if the selected object holds a structure:

<page title="SAP Bill of Material"

visibleWhen="structure_revisions!=null">
<htmlPanel enableresize="true"
src="/webdv?tcobj={{selected.uid}};product=T4S;eaot=BOM" />
</page>

• Use different placeholders to resolve to the object for which to retrieve external data:

<content
visibleWhen=
"ActiveWorkspace:SubLocation !=
com.siemens.splm.client.occmgmt:OccurrenceManagementSubLocation"
>
<page title="SAP Material Master">
<htmlPanel enableresize="true"
src="/webdv?tcobj={{selected.uid}};product=T4S;eaot=MM"
/>
</page>
<page title="SAP Change Master">
<htmlPanel enableresize="true"
src="/webdv?tcobj={{selected.uid}};product=T4S;eaot=ECM"
/>
</page>

2-14 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Configure the Control Panel

</content>
<content
visibleWhen="ActiveWorkspace:SubLocation ==
com.siemens.splm.client.occmgmt:OccurrenceManagementSubLocation"
>
<page title="SAP Material Master">
<htmlPanel enableresize="true"
src="/webdv?
tcobj={{selected.props.awb0UnderlyingObject.dbValues[0]}};product=T4S;eaot
=MM"
/>
</page>
<page title="SAP Change Master">
<htmlPanel enableresize="true"
src="/webdv?
tcobj={{selected.props.awb0UnderlyingObject.dbValues[0]}};product=T4S;eaot
=ECM"
/>
</page>
</content>

In order to identify the XRT used to render the current view the XRT Editor can be of help. It displays
the name of the respective dataset. However sometimes it is more than a single XRT that contributes to
what you see. The <label> element can be used to display the name of the XRT and some other useful
information. A condition that evaluates a preference can be used to hide the label when not needed. The
following page definition would be added to the WebDV_T4S_Dataset_Demo_XRT XRT:

<page title="AIG Info" visibleWhen="{pref:T4S.AW.XRTInfo}==true">

<label text="Rendered according to WebDV_T4S_Dataset_Demo_XRT" />
<label text="Shows the SAP DIR target type" />
</page>

Find more examples in the XML Rendering Template Examples appendix.

Configure the Control Panel

The RAC Dataview has a control panel as shown below:

It consists of the following elements from left to right:

1. The EA connection chooser as a drop-down box. It allows the user to change the connection to the EA
system.
2. The target type chooser as a drop-down box. It allows the user to select the target type for which to
query data from the EA system.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-15
Unpublished work. © 2024 Siemens Software Version 2406
Configure the Control Panel

3. The last refreshed date shows the last point in time at which the Dataview has received data from the
EA system
4. The status indicator shows whether the Dataview is currently fetching data from the server, has
successfully fetched data from the server or has received an error.
5. The refresh button allows the user to refresh the Dataview. It is also needed to submit changes made
by the user in the Dataview if the input elements are not configured to initiate the submit operations
on their own.

By default the control panel of the WebDV is disabled. Use the controlpanel parameter in the URL to
enable and configure it (see Modify the XRTs). If enabled with controlpanel=on, it has three parts as
shown below:

Like the RAC Dataview it has

1. the EA connection chooser

2. the status indicator
3. the refresh button

With the WebDV each HTML panel is bound to a single target type through URL parameters so a target type
chooser is not required.

A WebDV HTML panel can be bound to one or more EA connections. In the case of one connection the EA
connection can be used to display its name. For multiple connections the chooser allows the user to select
one to connect to.

A status indicator might be useful if fetching data from the EA system is expected to take a while.

The refresh button is useful while adapting the mapping to the customer’s needs. Alternatively admins can
also right click into the WebDV and instruct the browser to reload the frame.

The refresh button is required users want to edit multiple widgets without submitting each change to the
server. When they made their edits they can use the refresh button to submit their changes to the server.
Instructing the browser to reload the frame does not perform the submit operation.

Using the controlpanel parameter with other values than just "on" allows changing the appearance of the
control panel. You can combine the following keywords with the plus or minus sign to enable resp. disable
elements of the control panel:

eaconn The EA connection chooser

state The status indicator

2-16 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Import the XRTs into Teamcenter

refresh The refresh button

on All of the above
date The last refreshed date
url An icon that allows to open the Dataview in a separate browser tab
all all of the above

The following list gives some useful examples

• controlpanel=on-eaconn shows the status indicator (which in this case indicates successful
completion of the Dataview operation) and the refresh button:

• controlpanel=refresh+state shows the same but in reverse order

• controlpanel=refresh+state+url adds the URL icon to the above. This is useful while playing with the URL
parameters as it saves you from having to go through the edit XRT, save XRT, refresh AW cycle (See the
Modify the XRTs section):

Import the XRTs into Teamcenter

We recommend that you create a folder for the XRTs within your Home folder. Drag&drop the new XRT files
into the folder. You will see a dialog asking you for the names of the files and datasets. Be sure to remove
the .xml extension from the dataset names.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-17
Unpublished work. © 2024 Siemens Software Version 2406
Import the XRTs into Teamcenter

Note that you can also edit the XRTs in the Rich Client after they have been imported into Teamcenter
using the Viewer tab. You need sufficient permissions to do so.

Note
Editing XRTs directly in the Viewer tab is discouraged as it neither provides syntax highlighting nor
syntax validation nor content assistance.

Instead use the XRT Editor which you find in the Active Workspace.

Alternatively edit XRTs in XML-aware editors with syntax highlighting and copy&paste the file contents
into the Viewer tab using the keyboard shortcuts Ctrl-A, Ctrl-C and Ctrl-V. Ideally the editor should also
check for the well-formedness of the XRT.

You can also save the changes to a file and import that file into Teamcenter using the import_file
command line utility like so:

import_file -de=r -u=<username> -p=<password>↩

-f=WebDV_T4S_Demo_XRT.xml↩
-d=WebDV_T4S_Demo_XRT↩
-type=XMLRenderingStylesheet↩
-ref=XMLRendering

If you want to update an existing Dataset, you might have to delete it first.

For the sake of readability the above example is formatted into multiple lines where the ↩ indicate
that the line has to be continued when you type it in. The WebDV_T4S_Demo_XRT.xml is the name of
the file and WebDV_T4S_Demo_XRT the name of the Dataset. Note that you need to omit the filename
extension for the latter.

Click Apply or type Ctrl-S to save your changes.

Note
When you are viewing the results in a browser refresh the browser window in order to see your changes.
This is normally done by typing the F5 key.

2-18 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Import the XRTs into Teamcenter

You can also open the XRTs in the Active Workspace and use Edit → Replace to update them:

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-19
Unpublished work. © 2024 Siemens Software Version 2406
Validate Results

Validate Results

Verify That Your XRT Changes Are Effective

Log into the Active Workspace and navigate to the Item Revision or Dataset object for which you created
the stylesheet.

Refresh the browser window using the F5 key whenever you have added or changed an XRT.

You should see a picture similar to this:

Note the new page header that results from the changes of the XRT.

If your changes to the XRT do not show up in the Active Workspace, log out and in again to make
preference changes becoming effective and check the names and values of the preferences that are
supposed to point to your XRT.

2-20 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Verify That the HTML Panel Gets Displayed

Verify That the HTML Panel Gets Displayed

Open the page that is supposed to contain the WebDV.

You should see a picture similar to this:

After you logged into the EA system or if you have configured automatic login you should this is about
what you should see:

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-21
Unpublished work. © 2024 Siemens Software Version 2406
Tweak URL with WebDV in Own Browser Tab

Tweak URL with WebDV in Own Browser Tab

If you are in the process of tweaking the URL of the WebDV, you can avoid the modify XRT - refresh
browser round trip by opening only the WebDV in a separate browser tab outside of the Active Workspace.
When you are done just merge your changes back into the XRT. There are multiple ways to do so:

If supported by your browser, right click into the WebDV and choose This Frame → Open Frame in New
Tab.

Alternatively open the browser's development tools hitting F12. Reload the frame or the entire browser tab
and in the development tools under Network find the request that loads the WebDV. Right-click on it and
select Open in New Tab like shown below:

If neither of the above work for you, add the url option to the controlpanel parameter as described
in Configure the Control Panel. After refreshing the WebDV you will notice the icon in the upper right
corner of the WebDV like shown below:

2-22 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Tweak URL with WebDV in Own Browser Tab

Click it and the WebDV will open in a separate browser tab outside of the Active Workspace.

You can now play with the parameters in the URL without having to change the XRT and refresh the entire
Active Workspace for every change. Just load the WebDV with your variations of the URL and eventually
update the XRT with your changes.

The figure below shows the WebDV in its own browser tab:

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-23
Unpublished work. © 2024 Siemens Software Version 2406
Application Server Peculiarities

Application Server Peculiarities

Channel Messaging to the Rescue

If you got here, you may be facing issues with connecting the WebDV to the AIG server. Possible reasons
are that services cannot be reached at the URLs assumed by the WebDV or HTTP session sharing not being
available.

Whatever the reason consider enabling channel messaging described in chapter Installation and
Deployment

Microsoft Internet Information Services (IIS)

In order to deploy the WebDV to the Microsoft Internet Information Services (IIS) rename the webdv.war
file to webdv.zip and import that file into the IIS as a web deployment package:

1. Open Servermanager > Tools > Internet Information Services (IIS) Manager.

2. Check and copy the path of the tc website.

2-24 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Microsoft Internet Information Services (IIS)

3. Create a new directory /webdv within the parent directory of /tc. Unzip the content of the
webdv.war into that directory.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-25
Unpublished work. © 2024 Siemens Software Version 2406
Microsoft Internet Information Services (IIS)

4. Now create a new website webdv and enter the full path of newly created /webdv directory. Click on
"Connect as..." and "Specific user" and enter the credentials of the same user as used for "tc" website.

5. Adapt the file run_netservermanagerservice.bat to load the T4x environment if that file is not
already loaded in the tc_profilevars.bat. Example:

call C:\Siemens\AIG\gs\etc\t4x_env.bat

2-26 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Active Workspace Versions

For more information please consult the Microsoft documentation.

Active Workspace Versions

Active Workspace 6.2 and Above

Caution
To make the syntax described here work, you must have at least Active Workspace 6.2.1.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-27
Unpublished work. © 2024 Siemens Software Version 2406
Operating Systems

As of Active Workspace 6.2 the AngularJS framework has been replaced with React and as a consequence
CDATA sections are no longer allowed in XML Rendering Templates (XRTs). For this reason the hosted mode
support (see Installation and Deployment) requires different syntaxes in XRTs for Active Workspace 6.2
and above.

Before Active Workspace 6.2 you could use the following snippet of XRT:

<htmlPanel enableresize="true" module="js/webdv/glue">

<![CDATA[
<div class="webdv">
<aw-frame
url="/webdv?tcobj={{selected.uid}};product=T4S;eaot=MM;↩
eacon=ET1@800;ealang=EN;com=glue"
/>
</div>
]]>
</htmlPanel>

For Active Workspace 6.2 and above this has to be converted to the following:

<htmlPanel declarativeKey="Ai0WebDvGlue" />

<htmlPanel enableresize="true"
src="/webdv?tcobj={{selected.uid}};product=T4S;eaot=MM;↩
eacon=ET1@800;ealang=EN;com=glue" />

So for the hosted mode support you need to use two <htmlPanel> elements inside a container, e.g. a
<column>, one with a declarativeKey and one with a src attribute. The declarativeKey attribute
references a file with JavaScript code that sets up the communication between the WebDV and the Active
Workspace. The src attribute references and configures the WebDV. This is the same as without hosted
mode support except that you need to add com=glue to the URL.

Note that the syntax that uses the <inject> element in conjunction with an HTML dataset is no longer
supported.

Operating Systems

Linux

In the Configure the Active Workspace Gateway section we describe how to change the configuration
of the Active Workspace Gateway (not to be confused with the AIG Gateway Service, GS). In particular
a number of routes need to be added to the config.json file. Under Linux some extra steps may be
required to make those changes effective.

2-28 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Enabling Channel Messaging

If the additional routes are not effective, you will get a 404 http status error with an error message that
reads

Problem accessing /filerepo/fileio/v1/file/site/aig.dv.web/index.html.

Reason:
Problem%20accessing%20site%2faig.dv.web%2findex.html%20File%2fResource%20Not
%20Found

In the instructions below <<TC_ROOT>> stands for the Teamcenter installation folder, <<VERSION>> is a
placeholder for some version numbers and mystack the name of your docker swarm instance. Follow the
instructions to make the changes you appplied to the config.json file effective:

1. Make sure you use fully qualified domain names (FQDN) in the routes part of the config.json file.
2. Copy the <<TC_ROOT>>/container/gateway.yml file into the <<TC_ROOT>>/microservices/
gateway-<<VERSION>> folder if it is not already in there.
3. Remove the gateway service with the following command:

docker service rm mystack_gateway

4. Remove the corresponding gateway config with the following command:

docker config rm mystack_config.json

5. Install the updated gateway service with the following command:

docker stack deploy -c gateway.yml mystack

6. Restart the system.

For more about docker configs see Store configuration data using Docker Configs.

Enabling Channel Messaging

Installation and Deployment

Note
Setting up channel messaging used to be required in cases where the Active Workspace runs in hosted
mode, i.e. is made available in applications like NX or the Rich Client. The communication method,
which is based on channel messaging, is therefore sometimes referred to as hosted mode support.
Today, depending on the version of the embedded browser and the Active Workspace, the WebDV
might be able to function in a hosted Active Workspace without channel messaging. However channel

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-29
Unpublished work. © 2024 Siemens Software Version 2406
XML Rendering Templates for Channel Messaging

messaging is still useful in cases where direct communication to the web tier application server is not an
option like the following:
• The HTTP session cannot be shared between the Active Workspace and the WebDV due to some
uncommon browser configuration or server architecture.
• You do not want to extend the CsurfExclusions as described in Configure the Active Workspace
Gateway
Note that while channel messaging can help to work around communication issues it comes at the cost
of a more complicated communication scheme. This involves a handshaking procedure to set up the
message channel between the WebDV and the Active Workspace as well as the transformation between
request/response pairs and the messages to be sent from the WebDV to the Active Workspace and vice
versa.

In order to enable channel messaging the following additional features need to be installed using the
Teamcenter Environment Manager or Deployment Center:

• ai0activeintegration - Active Integration

This feature contains implementations of SOA services to mediate remote function calls from the
add-ons such as the WebDV or the EA logon task support between the Teamcenter server and the
Gateway Service.
• webdv4awsource - Active Integration for Active Workspace (Hosted Mode)
It contains an Active Workspace module that mediates function calls between the WebDV and
the Active Workspace using HTML 5 channel messaging. The Teamcenter Environment Manager or
Deployment Center will install it into the aws2/stage/src/solution/webdv-glue folder inside
your Teamcenter installation.

Follow these steps to install and deploy these features:

1. Install the aforementioned features using the Teamcenter Environment Manager or Deployment
Center. You will find them in the Active Integration Gateway (AIG) installation package under tc/
features/ai0activeintegration and tc/features/webdv4awsource respectively. Within
these folders further navigate to tem_contributions when using the Teamcenter Environment
Manager or dc_contributions for the Deployment Center.
2. Open the aws2/stage folder inside your Teamcenter installation.and execute the awbuild
command. It rebuilds the Active Workspace including the modules and deploys it to the Active
Workspace Gateway.

XML Rendering Templates for Channel Messaging

Caution
For Active Workspace 6.2 and above the XML rendering stylesheets will look differently from what is
shown here. Please consult Active Workspace 6.2 and Above.

2-30 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 XML Rendering Templates for Channel Messaging

In order to enable channel messaging you need to adapt the XML rendering stylesheets containing
references to the WebDV. The Active Workspace framework has to be instructed to load the WebDV glue
component from the webdv4awsource feature. It comes as an Active Workspace module being referred to
as js/webdv/glue. There are two methods each of which has its pros and cons:

Inline HTML panel

You write the HTML that embeds the WebDV into the Active Workspace right into the XRT. The HTML
needs to be put into CDATA sections so it does not get interpreted as XML. The down-side is that CDATA
sections cannot be syntax highlighted by XML or HTML-aware editors. Because the HTML for the WebDV
is small and simple we still recommend this method. It avoids additional HTML datasets.
Inject Element
You use the <inject> element that points to an HTML file stored in a dataset and a JavaScript file. This
way XML and HTML pieces are separate so they can be edited by specialized editors. However this comes
at the cost of having to maintain additional HTML datasets.

Please mind the following when writing the HTML code for either method:

• The WebDV will be embedded into the Active Workspace by using an <aw-frame> element.
• The <aw-frame> must be contained in a <div> element with the id attribute set to webdv
• You need to append com=glue to the URL pointing to the WebDV.

Caution
The value of the src or url attributes is always a continuous character string without space or newline
characters although this document may display it on multiple lines.

At this point we are assuming that you have already created the XRT snippets that bring the WebDV to
your Active Workspace or installed the AIG demo feature. The follwing sections provide examples for both
methods. They are based on the following XRT example:

<htmlPanel enableresize="true"
src="/webdv?
tcobj={{selected.uid}};product=T4S;eaot=MM;eacon=ET1@800;ealang=EN"
/>

Inline HTML panel

<htmlPanel enableresize="true" module="js/webdv/glue">

<![CDATA[
<div class="webdv">
<aw-frame
url="/webdv?tcobj={{selected.uid}};product=T4S;eaot=MM;↩
eacon=ET1@800;ealang=EN;com=glue"
/>
</div>

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-31
Unpublished work. © 2024 Siemens Software Version 2406
Advanced WebDV Configuration

]]>
</htmlPanel>

Inject Element

<inject type="dataset" src="WebDV_T4S_Demo_HTML"

module="js/webdv/glue" />

The <htmlPanel> element is replaced with the <inject> element. You need to add an HTML file to
Teamcenter as a dataset and provide the name of the dataset in the src attribute. Make sure you choose
unique names for the datasets.

The HTML file would have to look like this:

<div class="webdv">
<aw-frame
url="/webdv?tcobj={{selected.uid}};product=T4S;eaot=MM;↩
eacon=ET1@800;ealang=EN;com=glue"
/>
</div>

Advanced WebDV Configuration

Use Browser Developer Tools to Find Property Names

Most web browsers, like Google Chrome, Mozilla Firefox or Microsoft Edge, provide so called developer
tools or dev tools. When you have opened a web page or web application in the browser use the F12 key
or the Ctrl-Shift-i key combination to activate them. They are almost the same in all types of browsers.
When you are updating a web application you typically will want to go to the Network tab and check the
Disable Cache box.

Here we want to look at another use case for the developer tools: The XML Rendering Templates (XRTs)
to include the WebDV need to contain placeholders to access properties of the objects managed by the
Active Workspace, the UID of the currently selected object at a minimum. Such objects are represented in
the browser as hierarchies of JavaScript objects and the developer tools allow you to inspect them.

Note
The recommended browsers for the task at hand are Google Chrome or Microsoft Edge. They share
the same underlying technology. For this document Chrome has been used but you will notice little
differences when going with Edge.

2-32 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Use Browser Developer Tools to Find Property Names

As an example let's find out how to identify the name of the currently logged in Teamcenter user. The
result will be

session.current_user_session.properties.user_id.dbValue

as the placeholder to be used inside a pair of {{ and }}. Here are the steps to figure that out:

1. Rebuild the Active Workspace with source mapping enabled.

2. Open the Active Workspace in the browser and select the object of interest.
3. Activate the developer tools.
4. Open a JavaScript file and set a breakpoint.
5. Let browser run to the breakpoint and inspect variables.

Caution
After this point you may not be able to continue with Mozilla Firefox as it lacks the required
operations to be applied to the local object. At least this was the case with the version used at the
time of this writing. You can still inspect the variables.

6. A: Copy object into a file to be inspected with your editor.

7. B: Use JavaScript to analyze the object.

Note that you might find more than one occurrence of a value in the inspected object. Good candidates
end with dbValue. Also favor dbValue keys over displayValue or uiValue, try to avoid array indexes and
prefer keys that sound like referring to business elements rather than internal objects.

The sections below will detail out these steps based on the example mentioned above:

Rebuild the Active Workspace with source mapping enabled

The JavaScript and other types of files that make up the Active Workspace are not directly loaded by the
browser. Instead they are translated into a form that helps them to be loaded faster by the browser with
reduced footprint. This translation happens in the course of running the awbuild script among a few
other conversions and processing steps to support the declarative approach. In order to be able to identify
pieces of JavaScript code by the names of the JavaScript source files source mapping needs to be enabled.

These are the steps to enable the source mapping:

1. Start a command shell and navigate to the stage folder (<<TC_ROOT>>\aws2\stage).

2. Take a look at the awbuild.cmd script and find the line that contains GENERATE_SOURCEMAP.
3. Set the GENERATE_SOURCEMAP environment variable in the command shell or modify the
awbuild.cmd script to do so.
4. Run the awbuild.cmd script to rebuild the Active Workspace.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-33
Unpublished work. © 2024 Siemens Software Version 2406
Use Browser Developer Tools to Find Property Names

Open the Active Workspace in the browser and select the object of interest

For the example an Item Revision kind of object is selected in the Active Workspace in the SAP Material
Master page as shown below:

Activate the developer tools

As described above use the F12 key or the Ctrl-Shift-i key combination to open the developer tools of your
browser.

Open a JavaScript file and set a breakpoint

1. In the developer tools open the Sources or Debugger → Sources (Firefox) tab and type
Ctrl-P to pick a source file. Choose the AwWalkerHtmlPanelService.js (aw-walker-
htmlpanel.controller.js for Active Workspace versions before 6.2).
2. Search (Ctrl-F) for the htmlPanelDataCtx variable. All search hits are in the same function. Set the
breakpoint after the last statement that modifies the variable. Click on the first line number which is
not grayed out.

Let browser run to the breakpoint and inspect variables

Just refresh the browser by hitting the F5 key. The source file might disappear during the refresh but
eventually the browser will stop at the specified breakpoint.

If you are using Firefox, make sure that also variable names are mapped: In the header of the Scopes
section check the Map box. You will find it in the sidepanel on the right side of the Debugger tab:

2-34 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Use Browser Developer Tools to Find Property Names

Now you can see all variables in the sidepanel on the right side in the Scopes section. Select the Local or
Function Body scope for the htmlPanelDataCtx variable. You can expand variables and their members
in a recursive fashion:

You might already be able to spot the variable you are looking for. If not, searching the entire
htmlPanelDataCtx variable could be useful. Read on to learn how to do so. There are two ways:

A: Copy object into a file to be inspected with your editor

1. Create an empty file with the json file name extension and open it with an editor of your choice
preferably one that can format, highlight and navigate the JSON format.
2. In the browser under Scopes right click the htmlPanelDataCtx variable and select Copy object.
Go to the editor and paste the clipboard contents into the file. If that worked, you can start expecting
the file.

Note
A JavaScript object can contain circular references in which case it cannot be serialized into a JSON
string and the Copy object will not work. The JSON string representation can also become rather
large and therefore difficult to handle. See below for a solution that takes circular references into
account.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-35
Unpublished work. © 2024 Siemens Software Version 2406
Use Browser Developer Tools to Find Property Names

3. You can now use the tools of your editor to search for the keys or values of variables. In this case we
know that "testuser" is the name of the user who has logged in into Teamcenter so search for that
character string including the quotes. You need to figure out which keys lead to the found value. If
you want to automate that, you might want to try out the following alternative.

B: Use JavaScript to analyze the object

The developer tools provide a console under the Console tab. It is also available at the bottom of the
Sources tab. It not only displays messages produced by JavaScript code but can also be used interactively
to run JavaScript code.

As a preliminary exercise here is how you can use the console to achieve the same result as the Copy
object operation from above:

1. In the browser under Scopes right click the htmlPanelDataCtx variable and select Store object as
global variable. The console will tell you the name of the global variable, for example temp1.
2. Use the following JavaScript command in the console, assuming the global variable was named
temp1:

copy(JSON.stringify(temp1, null, 4))

This will serialize the object into a JSON string in a pretty-printed format with an indentation depth of
4 characters and copy the result to the clipboard.

Note
A JavaScript object can contain circular references in which case it cannot be serialized into a JSON
string as shown above. A replacer function would have to be passed to the stringify call as the
second argument to replace the circular references with some primitive value. See below for a
solution that takes circular references into account.

3. Paste the clipboard contents into an editor as mentioned above.

Now let's use some JavaScript to assist in analyzing the object:

The console allows adding functions to the browser's global scope. Global scope in the browser actually
means the single top level window object. The following example defines and uses the searchObject
function to print out the sequence of keys that lead to a value of "testuser", the name of the logged in user:

window.searchObject = function(obj, searchString, maxDepth) {

// Helper function to traverse the object recursively
function traverseObject(obj, path, visited, depth) {
// Mark the current object as visited
visited.add(obj);

for (let key in obj) {

if (typeof obj[key] === 'object' && obj[key] !== null) {
// Check if the object has been visited before

2-36 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Use the Teamcenter User Name for the EA Logon

if (visited.has(obj[key])) {
console.warn('Circular reference detected. Key path:',
path.concat(key).join('.'));
continue; // Skip further traversal of the circular reference
}

if (depth < maxDepth) {

// If the depth is within the limit, recursively traverse the
// object
traverseObject(obj[key], path.concat(key), visited, depth + 1);
}
} else {
// If the value matches the search string, print the path
if (obj[key] === searchString) {
console.log(path.concat(key).join('.'));
}
}
}
// Remove the current object from the visited set after traversal
visited.delete(obj);
}

// Start the recursive traversal with an empty path, an empty visited

// set, and depth 0
traverseObject(obj, [], new Set(), 0);
};

Copy & paste that function definition into the console. Then use the function to print all the key paths that
lead to the user name like shown below after replacing the arguments with your names:

// Use the searchObject function to print the path that leads to the
// "testuser" user name.
searchObject(temp1, "testuser", 7)

When called like this the function recursively searches the JavaScript object for the value "teamcenter"
down to a depth of 7. It detects circular references to avoid infinitly recursing into the object.

Use the Teamcenter User Name for the EA Logon

If you are using the same user names for the login into Teamcenter and into the external system, you can
instruct the WebDV to prefill the user name in the EA Logon dialog like shown below:

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-37
Unpublished work. © 2024 Siemens Software Version 2406
Use the Teamcenter User Name for the EA Logon

All you need to do is to modify the XRT to look like so:

[…]
</page>
<page title="SAP Material Master">
<htmlPanel enableresize="true"
src="/webdv?tcobj={{selected.uid}};product=T4S;↩
eauser={{session.current_user_session.properties.user_id.dbValue}};↩
eaot=MM;eacon=ET1@800;eacon=ET2@800;ealang=EN;ealang=DE" />
</page>
<page titleKey="tc_xrt_viewer" […]

Notice the new eauser={{session.current_user_session.properties.user_id.dbValue}}

parameter. Its value is interpreted as a template that can contain
placeholders. {{session.current_user_session.properties.user_id.dbValue}} is the
placeholder that evaluates to the Teamcenter user. There can be multiple
placeholders and they can be mixed with normal text. For example putting
eauser={{session.current_user_session.properties.user_id.dbValue}}@company.com
into the URL would initialize the User field in the screenshot above with [email protected].
Remember to add semicolons to the URL to separate the parameters from each other.

Consult Use Browser Developer Tools to Find Property Names to learn how to determine the
placeholders.

2-38 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Active Content Structures With the WebDV

Active Content Structures With the WebDV

If you have set up your Active Workspace to show product structures using Active Content, the objects
that represent BOM lines or occurrences are runtime objects of Awb0Element type. It is abstract so the
concrete types of the objects will be some subtype of Awb0Element, e.g. Awb0PartElement:

To enable displaying external data for such an object the ID of the related Item Revision
needs to be passed to the WebDV. You need to change the tcobj parameter in the XRT

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-39
Unpublished work. © 2024 Siemens Software Version 2406
Known Issues

that is used to render the sublocation of the selected object. Replace selected.uid with
selected.props.awb0UnderlyingObject.dbValues[0] like so:

[…]
</page>
<page title="SAP Material Master">
<htmlPanel enableresize="true"
src="/webdv?↩
tcobj={{selected.props.awb0UnderlyingObject.dbValues[0]}};product=T4S;↩
eaot=MM;eacon=ET1@800;eacon=ET2@800;ealang=EN;ealang=DE"
/>
</page>
<page titleKey="tc_xrt_viewer" […]

Consult Use Browser Developer Tools to Find Property Names to learn how you could find out the path
to the JSON value on your own.

Known Issues

Theme Switching

The user interface of the Active Workspace allows users to switch between a light and a dark theme.

A change of the Active Workspace’s theme does not affect the WebDV as there is no mechanism that would
allow notifying the WebDV of the change.

Moreover we currently do not provide a dark theme for the WebDV. You may however adapt the CSS files
of the WebDV to your liking.

Preservation of Widget State

When the WebDV gets refreshed it re-renders the Dataview mark-up it receives as an XML document from
the AIG server. It destroys all previously rendered widgets and builds them up again. The states of the
widgets get lost when they are destroyed returning the user to the initial layout of the Dataview. For
example a user who had selected a page from a set of pages will be returned to the first page of the set or
a chooser will be displayed in its initial state.

The RAC Dataview does preserve the states of its widget in its internal memory. This feature is not yet
available for the WebDV.

Regarding the input widgets there is a simple work-around: Just explicitly instruct the input widget to show
the values of the previous refresh operation or default values. These can be found in the Tcl variables
whose values are derived from the Parameters argument.

2-40 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Troubleshooting the WebDV

The following example demonstrates this with the var/mmap/t4s_prop_mapping_template.sd file

as it is shipped with T4S. There you find the following line:

create […] chooser […] -parameter plant -submitOn DEFAULT_EVENT

It creates a drop-down box allowing the user to select a plant out of a list of plants given in the lPlants
(first letter is a lowercase L) list variable. ([…] stands for code we have omitted for the sake of shortness.)

Turn that into

create […] chooser […] -parameter plant -submitOn DEFAULT_EVENT -value

$Plant

i.e. add the -value attribute with the value of the Tcl variable holding the current state of the widget to
the command.

This work-around is compatible with the RAC Dataview so you do not have to take further measures if you
prepare the Dataview for both types of clients.

Troubleshooting the WebDV

WebDV not Showing Up or No Changes Visible

If the WebDV does not show up in the Active Workspace or you cannot see your changes, the following
checklist may help you to get behind the problem. Note that the names of the UI elements in your browser
might slightly differ from those used in the instructions below.

1. Type F12 in your browser to open its development tools. Go to the Network tab and check the
Disable Cache checkbox. Leave the development tools open until you managed to get around the
issue. Refresh the browser with the F5 key. This way you can be sure that your browser shows the
latest state of your setup.
2. With the F12 development tools open refresh the browser with the F5 key. Check the Network and
Console tabs for error messages. For example you might find 404 HTTP status errors indicating that
the browser was not able to load a file.
3. Double check the config.json file defining the behavior of the Active Workspace Gateway for
syntax errors. It must not contain comments or trailing commas.
4. Don't forget to restart the Teamcenter Process Manager to pick up your changes. Under Linux
you might have to do some extra steps. See the Linux section. If you are unsure whether your
changes are actually becoming effective, temporarily remove the tc route. This should prevent the
Active Workspace from working. If it is still working, figure out why your changes are not becoming
effective.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-41
Unpublished work. © 2024 Siemens Software Version 2406
Errors During Setup

5. Try using fully qualified domain names or IP addresses for the targets in the routes you added to the
config.json that configures the Active Workspace Gateway.
6. If you upgraded AIG from an older version, verify that the latest webdv.war file has been deployed to
the web server. You can find it in the installation folder of the GS under var\template\webdv
or the AIG package inside the nested AIG\artifacts\gs_t4s_win64.zip file under
var\template\webdv.
7. Test if the WebDV is reachable. Type the URL of the WebDV into the address bar of your browser e.g.
http://localhost:8080/webdv. It should respond with an intro page.
8. Verify that the web server is serving the latest version of the WebDV. If in doubt, restart the web
server.
9. Check out the Active Workspace 6.2 and Above and Linux sections and verify that you have taken
the measures specific for your Active Workspace version and operating system.

Errors During Setup

The following sections list a few error messages which the WebDV may show while you are setting it up
and how you can get past them:

User does not have a valid session

This error indicates that the WebDV cannot use the session information stored in the browser to
communicate with the Teamcenter server. If that occurs after the user successfully logged in into the
Active Workspace, it means that the WebDV cannot reuse that information from the Active Workspace.
Please consult Installation and Deployment to learn how to get around this error.

Note that if you opened the WebDV in a separate browser tab or window outside of the Active Workspace
and the session of the latter has expired you will also get this error.

The given string / tag ...

This section may help you if the WebDV gives you any of these messages:

• The given string is invalid.

• The given tag (...) does not exist in the database or is not a persistent object tag.

These errors mean that a string that is supposed to identify a Teamcenter object cannot be resolved into
such, either because the string does not look like an object ID or if there is no object assigned to what
looks like an object ID. The likely cause for this error is a wrong placeholder in the XML Rendering Template
(XRT). Consult Use Browser Developer Tools to Find Property Names to learn how to find the right
placeholder.

2-42 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Solve Configuration Issues with Log Messages

Note that if such an error occurs after you have successfully setup the WebDV the cause of the error may
differ. For example the Teamcenter object may have been concurrently deleted or is a runtime object with
a limited and meanwhile expired lifespan such as the result of a search query.

Solve Configuration Issues with Log Messages

Caution
If you enable logging options to solve configuration issues, remember to revert your logging settings so
the logging does not impact system performance and no sensitive data is revealed through the log files!

Note
If you are trying to understand a problem using log files, note down the point in time when you initiate
some action like entering the tab with the WebDV. That will help you to identify the log files that
correspond to your action.

If you ran into the problem, log messages can help you finding its cause There are a quite a few places to
look for them and to configure logging options:

Browser Console

Hitting the F12 key in the browser window opens the browser's development tools. Web applications write
log messages to the console in the Console tab. Also the Network tab can be quite useful to nail down
problems.

Log messages from the console or entries from the network tab provide information about how the WebDV
is addressed by the browser, which of its resources are loaded into the browser, which requests it sends
to the server and errors that may have occurred. The next section shows how the granularity of the log
messages from the WebDV can be specified.

When looking at requests from the WebDV or the other add-ons those which are named
stringFromSCmdMArg are of particular interest because these are the ones used to communicate to
the AIG server. In their bodies you can find two attributes:

command This is the name of the actual operation to be performed on the server, e.g.
T4X.CustomData.getDataViewContainer is the one to get the rendering information
for the WebDV.
arguments This is an array of character strings used to parameterize the command. Its shape differs
between commands.

The WebDV's Logging Features

You can add two parameters to the URL to control what the WebDV logs to where:

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-43
Unpublished work. © 2024 Siemens Software Version 2406
Solve Configuration Issues with Log Messages

loghandlers
The value of this parameter is a comma-separated list with two possible values:
ConsoleLogHandler
The log messages will be written to the browser's console.
PopupLogHandler
The log messages will be displayed in a popup window. This log handler is intended to step in if no
console is available.
loglevel
The value of this parameter is an all upper-case value out of a set of available log level names. Some
of them have a three letter alias. The possible log levels are OFF, SEVERE (ERR), WARNING (WRN), INFO
(INF), CONFIG (CFG), FINE (FNE), FINER (FNR), FINEST (FNT), ALL. That list represents a range from
showing no message to showing increasingly detailed messages to showing all messages. Consider
starting with ALL and then filter out too detailed messages by choosing a value closer to the beginning
of that list.
Note that also the browser's console and network tabs have filtering mechanisms that might prevent you
from seeing all information.

Log messages from the WebDV provide information about the URL it was called with, the parameters it
tries to parse from the URL, the requests it sends to the server including their responses and details about
the rendering process.

The Active Workspace Gateway Log File

The Active Workspace Gateway writes log messages about its routes like the following:

[2023-07-13T15:30:22.826Z] info/gateway: + http://localhost:8080/webdv to

be used for /webdv

They go to log files whose location has changed from version to version. Here are some glob patterns
helping to find them on a Windows platform:

C:\Users\*\Siemens\logs\TcMSF\gateway*@*-msf.log
C:\Windows\Temp\gateway*@*-msf.log"
<<TC_ROOT>>\microservices\gateway-*\gateway.log"

The tcserver Log File

The Teamcenter server instances write log files on the computer on which they are running. Consult the
Teamcenter System Administration documentation for the location of the log files. Search for "Enterprise
tier logs".

2-44 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Solve Configuration Issues with Log Messages

The <<TC_DATA>>\logger.properties configures what you will see in these log files. If you are
interested in the SOA request coming from the Active Workspace and targeted to the AIG server, add the
following line:

logging.logger.Ai0.SoaGateway=DEBUG

You need to restart the pool manager or individual tcserver processes to make these changes effective.

The tcserver log files inform you about loaded DLLs and, with the above configuration option, the SOA
requests received from the WebDV as well as the other add-ons. In particular it should show messages like
the following:

Successfully loaded dynamic module C:\Siemens\tc14\bin\libai0soagateway.dll

Successfully loaded dynamic module C:\Siemens\gs\bin64\libt4s.dll

If you don't see them, check if you installed and configured the AIG correctly. Did you install the
activeintegration4aw feature, is the environment of the AIG Gateway Service loaded and are its libraries
registered via the TC_customization_libraries preference?

The AIG Session Log File

Go to the Admin UI of the BGS and select Log files → Session or refresh the list of log files. Select the right
one based on the point in time of your action. Navigate to the right area of the log file based on the time
stamps. Search for the following string:

T4X_GenericService_stringFromSCmdMArg()

This is the name of the function that receives all the SOA request from the WebDV or the other add-ons.
If the message starts with -->, this is where the function gets called. In this case the next line reveals the
name of the actual command e.g. T4X.CustomData.getDataViewContainer. You can now follow
the call chain in the session log file to figure out what is going wrong.

Caution
Note that the session log can become quite big even so that you will not be able to see the beginning in
the Admin UI. It is therefore recommended to download the file as ASCII or HTML and open it in a text
editor or browser respectively.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 2-45
Unpublished work. © 2024 Siemens Software Version 2406
Solve Configuration Issues with Log Messages

2-46 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Dataview Mark-Up Only Rendered in the RAC Dataview

3. WebDV Compared to RAC Dataview

Dataview Mark-Up Only Rendered in the RAC Dataview
The WebDV strives to maintain compatibility with existing mappings. At the same time it has to adopt the
style of the Active Workspace to provide the user with a seamless user experience. For this or for technical
reasons some features are only available in the RAC Dataview as shown in the following list:

• Indentation: Placing widgets with a horizontal offset

• Spacing: Placing widgets with a vertical offset
• Colors
• Fonts
• Images
• Borders around widgets
• Controlling whether widgets expand to the available width
• Placing the names of properties above their values
• Chooser styles except the CUSTOM one which is only available for the WebDV

If we get asked for features that are available in the RAC Dataview but not in the WebDV, we might
consider adding them to the WebDV.

RAC Dataview Mark-Up Only Rendered in the WebDV

Customers may demand features for the WebDV which they do not or not yet need for the RAC Dataview.
Such features are first and maybe only implemented in the WebDV and listed below:

• Date, Time and DateTime widgets

• The CUSTOM chooser style

Error Messages
In the AIG RAC extension error messages are displayed using pop-up windows or if they are related to the
Dataview in an area at the top of the Dataview as shown below:

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 3-1
Unpublished work. © 2024 Siemens Software Version 2406
Error Messages

Following the Active Workspace style the WebDV shows all error messages in a panel that rolls up from the
bottom of the visible area as shown below:

The error message disappears if the user clicks somewhere outside of the message roll-up. If user
interaction may solve the problem, e.g. in case of a log-in error, the WebDV remains active, e.g. reopens
the log-in dialog.

In other cases the user needs to reload the WebDV after fixing the problem. This can be done by typing F5
or right clicking into the WebDV and instructing the browser to refresh the frame.

3-2 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
4. Installation of the Basic Active Workspace
Add-Ons
The AIG add-ons for the Active Workspace include the following functionalities beside the Dataview for
Web (WebDV):

• Connection Overview
• Logon Task Support
• External Query Support

In order to enable any of those the following features need to be installed using the Teamcenter
Environment Manager or Deployment Center :

• ai0activeintegration - Active Integration

This feature contains implementations of SOA services to mediate remote function calls from the
add-ons such as the WebDV or the external query support between the Teamcenter server and the
Gateway Service.
It also defines the Ai0AIGExternalSystemObject data type to represent the search result items.
• activeintegration4awsource - Active Integration for Active Workspace
The feature contains an Active Workspace module named activeintegration4aw. It provides the import
button and the client-side logic behind it.
Also contained in the feature is the aig-custom-icons module. It defines the icons to be shown in the
search result.

Follow these steps to install and deploy these features:

1. Install the aforementioned features Active Integration (ai0activeintegration) and Active Integration
for Active Workspace (activeintegration4awsource) using the Teamcenter Environment Manager or
Deployment Center.
2. Open the aws2/stage folder inside your Teamcenter installation and execute the awbuild
command. It rebuilds the Active Workspace including the modules and deploys it to the Active
Workspace Gateway.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 4-1
Unpublished work. © 2024 Siemens Software Version 2406
4-2 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Overview

5. Installation and Setup of the EA Connection

Overview
Overview

The External Systems Button and Command Panel

After installing the EA Connection Overview the External Systems command button can be found in the
Active Workspace. The user has to navigate away from the Active Workspace's home location, for example
to Inbox or Folders. Then the button will become available and clicking on it will open a panel on the right
side inside the Active Workspace. The button can be found in the vertical panel on the very right when
using Active Workspace 6. With version 7 users can find it in the work area toolbar inside the Manage
group. Below figure shows it in version 6 on the left and version 7 of the Active Workspace on the right
side:

Fig. 1: External Systems Button in Active Workspace 6 + 7

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 5-1
Unpublished work. © 2024 Siemens Software Version 2406
Overview

Fig. 2: The Command Panel in Docked State

Clicking on the External Systems button ((1) in figure 2) opens a so-called command panel on the right of
the work area (2). A second click closes the panel.

The vertical ruler (3) on the panel's left edge becomes a slider when hovering the mouse pointer over it.
You can move it to change the percentage of horizontal space used by the command panel. The buttons
on the top right of the panel (4) can be used to undock the panel from its default position or close
it altogether. An undocked panel can be resized, freely moved around within the borders of the Active
Workspace, returned into its docked position or closed.

5-2 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Overview

Viewing and Managing EA Connections

The command panel provides the tools for viewing and managing all the external connections of the GS.
The connections are listed in tables, one for every product that has been configured to contribute to the
overview. Every table is shown on its own tab folder (or tab for short) so the user can switch between the
products and their connections by clicking on the tab's titles.

Note that closing and opening the command panel or switching between the tabs causes the connections
being updated from the server.

Each table row displays a single connection. Connections can be in any of the following three states:

1. Disconnected
2. Restricted (a.k.a. partially connected)
3. Connected

One out of the connections for a single product can be selected to act as the so called preferred (a.k.a.
active) connection. Operations performed through AIG which require a connection to an external system
but do not provide a user interface to select one use the preferred connection.

The table shows three columns:

1. The first one displays radio buttons where the checked one marks the preferred connection.
2. The second one displays the name of the connection.
3. The third one displays icons out of a set of three different icons each of which representing one of the
states of a connection. Hovering the mouse pointer over the icon pops up an explanatory tooltip text.
For the restricted connection it explains the use cases supported by this connection.

A click on one of the radio buttons changes the connection supposed to act as the preferred one. While
processing the request, all radio buttons are disabled and displayed in grey color.

The figure below shows three connections in different states while hovering the mouse over the restricted
and preferred one:

Fig. 3: EA Connections in Different States, None Selected

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 5-3
Unpublished work. © 2024 Siemens Software Version 2406
Overview

The Details Section and Logon Panel

A click on a table row, avoiding the radio button, selects a connection, clicking it while holding down the
Ctrl key toggles the selection state. Detailed information about the selected connection is displayed in a
section below the table. The section is labelled SYSTEM DETAILS and can be collapsed to free some space
for the table.

The details section repeats the name of the connection and its status as text. The latter equals what you
see when hovering the mouse pointer over the status icons in the table.

If a connection is in Disconnected or Restricted state the details section shows the Logon Panel which
allows users to enter their credentials. It resembles what users see when they log in through the EA Logon
workflow task. As soon as the user filled in the required fields a button to perform the log-in is shown. In
case of T4O the panel shows two different forms, the first one to enter the credentials and the second one
to choose the language and responsibility.

The figure below shows three connections in different states, one of it selected and the Logon Panel with
the required fields filled in:

Fig. 4: EA Connections in Different States, One Selected, Credentials Entered

After a user attempted to login or change the preferred connection the table is refreshed from the data on
the server. Error messages are shown in a message roll up.

5-4 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Installation of the EA Connection Overview

Logon Task vs. Logon Panel

AIG comes with preconfigured workflow processes and tasks. There are Logon Tasks for all the products
and types of external systems they support, for example the SAP Logon Task. A workflow containing that
type of task will stop at the task unless the requested connection has already been established at the point
in time when the task got executed. Assigned users have to select the task in their Inbox and complete
it hitting the Login button after they have entered their credentials. When users have opened their Inbox
they can open the External Systems overview and select the same connection in both the Logon Task and
the Logon Panel as shown in the figure below, this time with the overview panel in the undocked state:

Fig. 5: Logon Task and Logon Panel

Both can be used to perform the login, however only the Login button of the Logon Task will complete
the task and let it disappear from the Inbox. Upon successfully logging in the status in the connection
overview will be updated, regardless of which form the user has chosen to do the authentication.

Installation of the EA Connection Overview

In order to make the EA Connection Overview available follow the instructions outlined in Installation of
the Basic Active Workspace Add-Ons.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 5-5
Unpublished work. © 2024 Siemens Software Version 2406
Configuration of the EA Connection Overview

Configuration of the EA Connection Overview

In order for a product tab to appear in the connection overview it has to be configured in the mapping
config file for the product. The default mapping config files we deliver already contain the respective
command.

In the simplest case it is enough to write the following into the mapping config file:

Make Product Tab Appear In EA Connection Overview

::PL4X::UI::AW::configureEaConnectionOverviewTab <PRODUCT>

Replace <PRODUCT> with the key of the product you want to be represented in the connection overview,
for example T4S, T4O, T4EA.

You can configure a product tab but state that it should not appear in the connection overview by setting
its display property to false as shown in the following example:

Configure Product Tab To Not Appear In The EA Connection Overview

::PL4X::UI::AW::configureEaConnectionOverviewTab <PRODUCT> display false

For the simple case the order in which the tabs appear in the connection overview is defined by the order
by which the above commands are called by the respective mapping config files. This in turn depends on
the order in which the product mapping files are source'd by the main mapping config file.

To avoid having to change the main mapping config file just to alter the order of the tabs use the keywords
before and/or after with the names of other products. They serve as anchors to position your product
tab. Products used as anchors but are not configured for the connection overview have their display
property set to false. The before and after keywords can be used multiple times.

The following command configures the tab for T4EA to appear before the ones for T4S or T4O:

Configure T4EA Tab To Appear Before The T4S or T4O Ones

::PL4X::UI::AW::configureEaConnectionOverviewTab T4EA before T4S before

T4O

Note that the above does not make a statement about the order of the T4S tab in relation to the T4O one.

Circular relationships between product tabs will cause warnings in the system log.

5-6 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Configuration of the EA Connection Overview

The titles of the tabs name the types of external systems managed through the respective products, SAP
for T4S as well as T4ST and EBS for T4O. For T4EA the label used to represent the external system is
EA. The names of the external systems can be changed by specifying the eaShortName property. The
following example specifies Oracle as the external system to refer to in the tab's title for T4EA:

Alter The Name Of The System Type For T4EA

::PL4X::UI::AW::configureEaConnectionOverviewTab T4EA eaShortName Oracle

It is also possible to specify the title of the product tab altogether using the tabTitle property. The
following example specifies a tab title that places emphasis on the functional areas of the connections:

Alter The Tab Title For T4EA

::PL4X::UI::AW::configureEaConnectionOverviewTab T4EA tabTitle "Shop

Floor"

To support providing user interfaces for users of various nationalities it is possible to specify the tab title
in various languages based on the language the user has chosen when logging into the Active Workspace.
The following example extends the previous one with a translation for German using the -i18n option:

Provide Internationalization (i18n) For The Tab Title

::PL4X::UI::AW::configureEaConnectionOverviewTab T4EA \
-i18n true tabTitle {en_US "Shop Floor" de "Fertigung"}

Notice the minus sign in -i18n. This option has to precede the properties to internationalize. The
character strings to show as the tab titles are provided as Tcl dicts where the keys are so-called locale
codes. These are derived from the language chosen by the user when logging into Active Workspace. A
list of the codes as well as the names of the languages can be found in the aws2\stage\src\repo\tc-
aw-framework\src\assets\i18n\LoginLocale.json file inside the Teamcenter installation folder.
It lists the following codes: cs_CZ, de, en_US, es, fr, it, ja_JP, ko_KR, pl_PL, pt_BR, ru_RU, zh_CN, zh_TW.
Note that some of them do not contain a region code.

The figure below results from combing some of the settings explained above and logging into the Active
Workspace using German localization:

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 5-7
Unpublished work. © 2024 Siemens Software Version 2406
Configuration of the EA Connection Overview

Customized EA Connection Overview

It was created by the following configuration:

Customization Example

::PL4X::UI::AW::configureEaConnectionOverviewTab T4S \
eaShortName "SAP S/4HANA"
::PL4X::UI::AW::configureEaConnectionOverviewTab T4O display off
::PL4X::UI::AW::configureEaConnectionOverviewTab T4EA before T4S \
-i18n true tabTitle {en_US "Shop Floor" de "Fertigung"}

Note that the above commands might be spread over multiple files. It is also possible to use multiple
commands to configure a single tab so the following will yield the same result as the above:

Split Command Example

::PL4X::UI::AW::configureEaConnectionOverviewTab T4S \
eaShortName "SAP S/4HANA"
::PL4X::UI::AW::configureEaConnectionOverviewTab T4O display off
::PL4X::UI::AW::configureEaConnectionOverviewTab T4EA before T4S
::PL4X::UI::AW::configureEaConnectionOverviewTab T4EA \
-i18n true tabTitle {en_US "Shop Floor" de "Fertigung"}

The configureEaConnectionOverviewTab command accumulates the settings for a particular tab.

In order to clear the settings for a tab use -clear true. With -delete true a tab will be deleted
altogether from the connection overview and its configuration from the settings unless followed by
another command that recreates it.

5-8 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Configuration of the EA Connection Overview

Caution
Configuration changes that you deploy to the Active Workspace may not be picked up by the worker
threads processing the requests from the client so you might have to restart the Active Workspace to
make sure your changes become effective.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 5-9
Unpublished work. © 2024 Siemens Software Version 2406
Configuration of the EA Connection Overview

5-10 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Installation of the EA Logon Task Support

6. Installation and Setup of the Logon Task

Support
Installation of the EA Logon Task Support
In order to make the EA logon task support available follow the instructions outlined in Installation of the
Basic Active Workspace Add-Ons.

Adaption of the Active Workspace module

General workflow

1. Open the module folder in a file manager or in a text editor. Navigate to <<TC_ROOT>>/aws2/
stage/src/solution/activeintegration4aw.
2. Make backup copies of the files or the entire folder now and whenever you want to preserve some
state you may want to return to. Alternatively put the folder under version control, e.g. with Git.
3. Apply your changes to the files according to the sections below.
4. Open the aws2/stage folder inside your Teamcenter installation.and execute the awbuild
command. It rebuilds the Active Workspace including the modules and deploys it to the Active
Workspace Gateway.

Caution
Be careful about the syntax of the JSON files. In particular:

• Do not add comments.

• Avoid trailing commas at the end of lists.
• Separate the items of lists with commas.

Specify the Appearance or Types of the Logon Tasks

The Logon Task Support provides forms into which users can enter their credentials. Such a form is
displayed when the user selects a logon task object from the user's Inbox.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 6-1
Unpublished work. © 2024 Siemens Software Version 2406
Trying out the Logon Task Support

In the performTaskPanelConfiguration.json file look at the secondaryAreaContribution

member. It contains properties that represent the types of the supported logon tasks. For example for the
EBS2LogonTaskPerform task, which comes with T4O, such a property looks like shown below:

"EBS2LogonTaskPerform": {
"id": "EBS2LogonTaskPerform",
"priority": 2,
"performPanelId": "EBS2LogonTaskPerform",
"condition": "modelObject.type === 'EBS2LogonTask'"
}

The properties correspond to html files that define the appearance of the forms. They can be found in the
html directory, for example EBS2LogonTaskPerformView.html. You may want to adapt them to your
liking.

If you need other task types to be supported, you can adapt the condition property. You may replace the
name of the type or add more conditional terms using the || operator. In order to obtain the names of the
task types navigate to the task objects in the Rich Client. You will find them under your worklist. Type Alt-P
or select Properties from the context menu. Get the name of the type from the Task Type property.

The aliasRegistry.json file specifies by which icons the task objects are represented. You may
want to add your own type here, change the icon or add another type-to-icon mapping. More complex
mappings from objects to icons can be specified in the typeIconsRegistry.json file. The principles here are
the same as described in Define Icons for the Search Result.

Trying out the Logon Task Support

To try out the Logon task support follow these steps:

1. In the RAC or the Active Workspace create a workflow process containing the Logon workflow task for
an item revision. The types of the object and the process must correspond to the product under test.
The preferred connection must not be configured for automatic logon so the workflow stops at the
logon task.
2. Open or refresh the Active Workspace and navigate to the Inbox.
3. Select the logon task object. Notice the form that appears under ACTION.
4. Select a connection and enter your credentials into the form. As soon as you provide a username and
a password the Login button appears at the bottom of the form as shown in the figure below.
5. Click on the Login button. Upon successful login the form as well as the task object will disappear. If
the login failed, you will see an error message and the form remains open to receive your corrections.

The figure below shows the SAP LOGIN form after filling in the user's credentials:

6-2 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Advanced EA Logon Task Configuration

Advanced EA Logon Task Configuration

Use Browser Developer Tools to Find Property Names in Task Objects

Use Browser Developer Tools to Find Property Names depicts how to get the names of properties out
of JavaScript objects to be shown in the WebDV. The same principles apply to workflow task objects in the
Inbox, only the breakpoint and the JavaScript object differ.

Following a short description of what to do. Consult Use Browser Developer Tools to Find Property
Names for the details.

1. Select the task object of interest in the Inbox.

2. Open the Awp0PerformWorkflow.js file in the developer tools and set the breakpoint on the first
return statement of the populateSecondaryPanel function .
3. Re-select the object or select another equal one.
4. When the browser has stopped at the breakpoint inspect the data→ctx object and perform the
analysis as described for the WebDV.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 6-3
Unpublished work. © 2024 Siemens Software Version 2406
Use the Teamcenter User Name for the EA Logon Task

This is how that looks like in the browser:

Use the Teamcenter User Name for the EA Logon Task

If you are using the same user names for the login into Teamcenter and into the external system, you can
instruct the EA Logon Task support to prefill the user name in the EA Logon Task dialog like shown below:

6-4 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Use the Teamcenter User Name for the EA Logon Task

This is configured using Teamcenter preferences. If you have multiple AIG products installed and want the
same behavior for all of them, create the T4X.AW.EaLogonTask.User single string preference. For a
single product name it <Product>.AW.EaLogonTask.User where <Product> is one of T4S, T4S4, T4ST,
T4O or T4EA. The product specific one takes precedence over the general one.

The value of the preference is interpreted as a template that can contain placeholders
like in XRTs. To initialize the user field with the Teamcenter user set the preference
to {{ctx.userSession.props.user_id.dbValue}}. There can be multiple placeholders
and they can be mixed with normal text. For example setting the preference to
{{ctx.userSession.props.user_id.dbValue}}@company.com would initialize the User field in
the screenshot above with [email protected].

Consult Use Browser Developer Tools to Find Property Names in Task Objects to learn how to
determine the placeholders. Start them with the ctx. prefix in the task context.

Caution
Note that whatever preferences are used here their names must be added to the
AWC_StartupPreferences preference.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 6-5
Unpublished work. © 2024 Siemens Software Version 2406
Use the Teamcenter User Name for the EA Logon Task

Preference Example

The following example specifies that the user fields in the Logon tasks should be prepopulated with the
Teamcenter user name for all products except T4O where it should be "manufacturing":

<?xml version="1.0" encoding="UTF-8"?>

<preferences version="10.0">
<category name="Gateway Foundation">
<category_description></category_description>
<preference name="T4X.AW.EaLogonTask.User" type="String"
array="false" disabled="false" protectionScope="Site"
envEnabled="false">
<preference_description>This preference specifies the default of
the template of an initial value for the user name to be used
in the EA Logon tasks of T4S, T4O and T4EA.
</preference_description>
<context name="Teamcenter">
<value>{{ctx.userSession.props.user_id.dbValue}}</value>
</context>
</preference>
<preference name="T4O.AW.EaLogonTask.User" type="String"
array="false" disabled="false" protectionScope="Site"
envEnabled="false">
<preference_description>This preference specifies the template of
an initial value for the user name to be used in the EBS Logon
task.
</preference_description>
<context name="Teamcenter">
<value>manufacturing</value>
</context>
</preference>
</category>
</preferences>

Caution
• Note that the new preferences need to be added to the AWC_StartupPreferences preference.
• If you use the preferences_manager command to change the preference, be sure to use the
MERGE action.

The new preferences need to be added to the AWC_StartupPreferences preference:

<?xml version="1.0" encoding="UTF-8"?>

<preferences version="10.0">
<category name="Active Workspace">
<category_description>No description available for this
category.</category_description>
<preference
name="AWC_StartupPreferences" type="String"
array="true" disabled="false" protectionScope="Site"

6-6 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Use the Teamcenter User Name for the EA Logon Task

envEnabled="false">
<preference_description>Defines the list of preferences to
be retrieved at startup by the Active Workspace client
from the Teamcenter server. Each entry in the list is a
valid Teamcenter preference name.
</preference_description>
<context name="Teamcenter">
<value>T4X.AW.EaLogonTask.User</value>
<value>T4O.AW.EaLogonTask.User</value>
</context>
</preference>
</category>
</preferences>

The above preference file can be used with the preferences_manager command like so:

preferences_manager -mode=import -action=MERGE -scope=SITE

-context=Teamcenter [...]

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 6-7
Unpublished work. © 2024 Siemens Software Version 2406
Use the Teamcenter User Name for the EA Logon Task

6-8 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Overview

7. Installation and Setup of the External Query

Support
Overview
The pictures below show the result of setting up the external query support, the first for Active Workspace
6, the second for version 7:

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 7-1
Unpublished work. © 2024 Siemens Software Version 2406
Overview

These are the visual elements of the external query suppport and the tasks to make them available:

1. A user who navigates to the Advanced Search in the Active Workspace can select a predefined
search query like AW_Find_MaterialMaster_in_SAP in the picture above. It displays attributes that
are defined with the query and can be used to refine the search. In the above example the user has
entered P-11* to limit the search result to objects whose SAP ID matches that pattern.
In order to enable the predefined query a query definition has to be installed in Teamcenter. Create
External Queries for the Active Workspace covers this in more detail.
2. The result of the search is displayed as a list of objects whose type is
Ai0AIGExternalSystemObject or derived from it. Each object is displayed with the value of
a property that is used as its primary title plus some optional properties. The second property is
displayed as a subtitle. Additional properties are displayed with their names and values.
The Ai0AIGExternalSystemObject.CellProperties preference is used to define which
properties are displayed for each object in the search result list. If you derive your own type from
Ai0AIGExternalSystemObject, you need to have a CellProperties preference for your type.
3. Icons are assigned to the objects in the search result list.
The Active Workspace module named aig-custom-icons contributes the icons to the search result list.
You will have to modify the module and rebuild the Active Workspace to change the icon. The module
is contained in the activeintegration4awsource feature. Define Icons for the Search Result covers
this in more detail.
4. The Dataview for Web is displayed to the right of the search result list.
For this to work the WebDV has to be installed and one or more XML Rendering Templates (XRTs)
to be defined and referenced through preferences. Navigate to XML Rendering Templates for the
details.

7-2 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Create External Queries for the Active Workspace

5. On the primary toolbar you find a button to initiate an import operation for the selected object.
The Active Workspace module named activeintegration4aw contributes the button to the toolbar as
well as the logic to control its visibility and to send a request to the server. For regular use cases there
is no need to modify this module or rebuild the Active Workspace. To enable or disable the button
the ai0ImportPossible property can be set in a mapping function like shown in the External
Queries in the Active Workspace section of the Teamcenter Gateway for Enterprise Applications - Basic
Configuration Guide On the server side the ai0activeintegration feature needs to be installed.

In addition to the tasks listed above a few mapping functions need to be adapted or created. This is
covered in the External Queries in the Active Workspace section of the Teamcenter Gateway for Enterprise
Applications - Basic Configuration Guide.

Create External Queries for the Active Workspace

External queries for the Active Workspace differ from those for the RAC in the following aspects:

1. The tc_set_query_where_run command is called with -run=query as opposed to -run=user.

2. If the Active Workspace and the RAC are used side-by-side, the queries must have different names
indicating the type of client from which they are executed. The user will have to choose the right
query for the respective client. This is because the AIG has no chance to distinguish between both
types of clients but still needs to serve them in different ways. By convention the names of queries for
the Active Workspace start with AW_.

See External Queries in the Active Workspace section of the Teamcenter Gateway for Enterprise
Applications - Basic Configuration Guide on how to create queries and how to connect them to the AIG
using Teamcenter preferences.

Use the query builder to get an overview over your existing queries.

If you already have queries for the RAC and want to make them available to the Active Workspace, you can
use the import and export functionality of the query builder to create copies of your queries with different
names.

If you have stored your query in a file, you can create a copy of it, change the name and import it into
Teamcenter using the plmxml_import utility like shown below:

plmxml_import -u=<user name> -p=<password> -xml_file=<path to query file>

Whichever method you have chosen to create a copy of your query you need to flag it as a user query
using the following command:

tc_set_query_where_run -u=<user name> -p=<password> -query=<query name>

-run=query

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 7-3
Unpublished work. © 2024 Siemens Software Version 2406
Installation of the External Query Support

Installation of the External Query Support

In order to make the External Query Support available follow the instructions outlined in Installation of
the Basic Active Workspace Add-Ons.

Define Icons for the Search Result

When you have installed the activeintegration4awsource feature you will find the aig-custom-icons module
in the aws2\stage\src\solution\aig-custom-icons folder inside the Teamcenter installation
folder.

If you want to customize the icons of the external query, open a command shell in the aws2\stage
folder. In order to test your changes you need to run the awbuild command in that folder and refresh the
browser.

Navigate to the module folder to modify its contents.

The following sections explain how to change the icons for the external query support starting with the
simplest case and evolving to more complex cases:

Use a Different Type Icon to Represent the Search Results

If you want to select a different icon out of the collection of icons available in the Active Workspace, edit
the aliasRegistry.json file.

For example change its contents from

{
"typePartUsage": [
"Awp0AdvancedQueryCriteria",
"Awp0AWCExternalSystemObject"
]
}

to

{
"typeRemotePart": [
"Awp0AdvancedQueryCriteria",
"Awp0AWCExternalSystemObject"
]
}

7-4 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Define Icons for the Search Result

in order to change the icon to typeRemotePart48.svg.

A rich collection of icons can be found under aws2\stage\src\image inside the Teamcenter installation
folder. See Active Workspace SVG Images for a decent overview of the available icons.

Note that only icons whose names start with type can be referenced in the aliasRegistry.json file.
The names of the icon files reflect the dimensons of the SVG viewBox by a number such as 48. You need to
omit that number when referencing the icon in the aliasRegistry.json file. If you want to use an SVG
file whose name does not start with type, copy it to a new icon file and name it appropriately. Continue
reading to learn how to deal with new icon files.

Use Your Own Icon

If you come with your own icon or copied one of those that come with the Active Workspace,
give it a name starting with type and place it in the aws2\stage\src\image folder. As of Active
Workspace 6.2 this is the only place for additional icons. Prior to that version src\image inside the
aws2\stage\src\solution\aig-custom-icons folder used to be another option.

Search the Active Workspace documentation for aliasRegistry to learn more about mapping types to
icon names.

Show Different Icons Based On Property Values

In order to be able to choose icons based on properties of the search result object you need to
formulate conditions like shown in the typeIconsRegistry-example.json file which you find under
aws2\stage\src\solution\aig-custom-icons. As a starting point copy that file to one named
typeIconsRegistry.json. Its content is shown below:

[
{
"type": {
"names": [
"Awp0AdvancedQueryCriteria",
"Awp0AWCExternalSystemObject"
],
"prop": {
"names": [
"ai0ExternalObjectIcon"
],
"iconFileName": "typeThumbsUp",
"conditions": {
"ai0ExternalObjectIcon": {
"$eq": "thumbsUp"
}
}
}
}
},
{

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 7-5
Unpublished work. © 2024 Siemens Software Version 2406
XML Rendering Templates

"type": {
"names": [
"Awp0AdvancedQueryCriteria",
"Awp0AWCExternalSystemObject"
],
"prop": {
"names": [
"ai0ExternalObjectIcon"
],
"iconFileName": "typeThumbsDown",
"conditions": {
"ai0ExternalObjectIcon": {
"$eq": "thumbsDown"
}
}
}
}
}
]

What you see is an array of JSON objects, each of which controls the inclusion of a single icon. The names
of the icons are given in the iconFileName attribute. The conditions use the eq operator to compare
the ai0ExternalObjectIcon property against string literals like "thumbsUp" or "thumbsDown" to
decide whether to show the typeThumbsUp or the typeThumbsDown icon. Their files are included in the
aig-custom-icons module as examples under src\image. The value of the ai0ExternalObjectIcon
property has to be computed in the query mapping. The condition can be more complex and may
use other operators or properties but in general we recommend to formulate complex conditions in
the query mapping and only use the properties to transport the results of their evaluation to the
Active Workspace. The External Queries in the Active Workspace section in the Teamcenter Gateway
for Enterprise Applications - Basic Configuration Guide shows an example of a query mapping and a
customized typeIconsRegistry.json file.

Search the Active Workspace documentation for typeIconsRegistry to learn more about the
conditional assignment of icons.

XML Rendering Templates

The result of executing an external query is a list of objects of the Ai0AIGExternalSystemObject
type unless you derive your own type from that. Two preferences point to the
XML rendering template (XRT) to be used to render the work area of the Active
Workspace: Ai0AIGExternalSystemObject.SUMMARYRENDERING for the secondary and
Ai0AIGExternalSystemObject.showObjectLocation.SUMMARYRENDERING for the main work
area. They both point to the Ai0AIGExternalSystemObjectSummary.xml dataset. It is shared among
all product and its contents is shown below:

<?xml version="1.0" encoding="UTF-8"?>

<!--
// @<COPYRIGHT>@

7-6 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 XML Rendering Templates

// ==================================================
// Copyright 2021.
// Siemens Product Lifecycle Management Software Inc.
// All Rights Reserved.
// ==================================================
// @<COPYRIGHT>@
-->
<rendering>
<header>
<property name="ai0ExternalObjectId" />
<property name="ai0ExternalObjectName" />
</header>
<content visibleWhen="ai0AigProduct==T4S">
<inject type="dataset" src="WebDV_T4S_Demo_Query_XRT" />
</content>
<content visibleWhen="ai0AigProduct==T4O">
<inject type="dataset" src="WebDV_T4O_Demo_Query_XRT" />
</content>
<content visibleWhen="ai0AigProduct==T4EA">
<inject type="dataset" src="WebDV_T4EA_Demo_Query_XRT" />
</content>
<page titleKey="tc_xrt_Summary">
<section titleKey="tc_xrt_Preview">
<image source="thumbnail" />
</section>
<section title="Properties of Ai0AIG ESO">
<property name="ai0QueryName" />
<property name="ai0QueryNameBase16" />
<property name="ai0ExternalSystemObjectType" />
<property name="ai0ExternalSystemObjectUid" />
<property name="ai0ExternalObjectType" />
<property name="ai0ExternalObjectId" />
<property name="ai0ExternalObjectName" />
<property name="ai0ExternalObjectIcon" />
<property name="ai0ImportPossible" />
<property name="ai0AigProduct" />
<property name="ai0ExternalSystemRealm" />
<property name="ai0UserData1" />
<property name="ai0UserData2" />
<property name="ai0UserData3" />
<break />
</section>
<section title="Properties of Awp0AWC ESO">
<property name="object_string" />
<property name="object_type" />
<property name="awp0ExternalSysObjClassName" />
<property name="awp0ExternalSystemName" />
<property name="awp0ExternalSystemURI" />
<break />
</section>
</page>
</rendering>

This XRT defines a header that shows two properties in the secondary work area which are by default the
same used for the primary title and subtitle of the objects in the search result list.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 7-7
Unpublished work. © 2024 Siemens Software Version 2406
XML Rendering Templates

There is a <content> element for each supported product. Which one is visible is determined by the
ai0AigProduct property. Each <content> element contains an <inject> element that points to
another XRT that is specific for the respective product, e.g. WebDV_T4S_Demo_Query_XRT for T4S. All
those XRTs show a page with the Dataview for Web for their product.

A summary page lists all the properties of the object selected in the search result list.

Note
The summary page shows all the properties of the Ai0AIGExternalSystemObject object. Use it for testing
and debugging while setting up the external query. In a productive system you may not show that page
or only a subset of the properties.

Create and Modify XRTs explains how to deal with XRTs that call the WebDV for objects stored in
Teamcenter. The XRT for T4S from which the Dataview for the external query is rendered is shown below
(↩ divide lines into smaller sections for the sake of readability. They need to be re-joined when typed in):

<?xml version="1.0" encoding="UTF-8"?>

<!--
// @<COPYRIGHT>@
// ==================================================
// Copyright 2021.
// Siemens Product Lifecycle Management Software Inc.
// All Rights Reserved.
// ==================================================
// @<COPYRIGHT>@
-->
<subRendering>
<page title="SAP Material Master">
<htmlPanel enableresize="true"
src="/webdv?
tcqname~16={{selected.properties.ai0QueryNameBase16.dbValue}};↩
eaobj={{selected.properties.ai0ExternalObjectId.dbValue}};product=T4S;↩
eacon=ET1@800;eacon=ET2@800;ealang=EN;ealang=DE">
<property name="ai0QueryNameBase16" />
<property name="ai0ExternalObjectId" />
</htmlPanel>
</page>
</subRendering>

It is similar to the XRTs that call the WebDV for objects stored in Teamcenter as described in Create and
Modify XRTs but differs in the following aspects:

• The root element is <subRendering> in contrast to <rendering> as the XRT is included in another
one.
• For the external query the WebDV needs to be called with other parameters than for internal objects to
identify the selected object:

7-8 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Customization of the Advanced Search Table View

tcqname~16 is the base16 (hex) encoded name of the query. It is taken from the
ai0QueryNameBase16 property.
eaobj is the ID of the external object in the external system, for example the SAP material
number. It is taken from the ai0ExternalObjectId property.

• The properties used in the src attribute of the HTML panel have to be referenced in <property>
elements between <htmlPanel> and </htmlPanel>.

Note
Note that if you are using the channel messaging you need to convert these XRTs according to XML
Rendering Templates for Channel Messaging.

Customization of the Advanced Search Table View

The following assumes that you have not introduced your own type. Otherwise you need to adapt the
examples below.

The Ai0AIGExternalSystemObject.CellProperties preference is used to define which properties

are displayed for the objects in the search result list of the Advanced Search in the Active Workspace. The
name may differ if you use your own type to represent the search hits.

The full truth about the CellProperties preference is that it only applies to the following types of views: List
with Summary, List and Images.

The set of properties to be shown in the Table and Table with Summary views are specified by column
configurations. These are stored in XML files and by carrying out the following steps you can change which
properties appear in the table view:

1. Open a command shell with Teamcenter environment.

2. Export the current column configuration with the following command:

export_uiconfig -u=<USERNAME> -p=<PASSWORD> -g=<GROUP>

-file=C:\TEMP\uiconfig.xml

Please consult the Teamcenter documentation for the details of this command.
C:\TEMP\uiconfig.xml for the path was chosen for this example for the sake of simplicity. You
might find a better place and even apply source control to the file to track your changes.
3. Modify the exported file, C:\TEMP\uiconfig.xml in this example. It is strongly recommended to
backup the original file or apply source control to it so you can always return to a working state.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 7-9
Unpublished work. © 2024 Siemens Software Version 2406
Customization of the Advanced Search Table View

You only want to modify the <ClientScope> element whose uri is Awp0AdvancedSearch. You
can remove all the others from your copy of the XML file so when you import the file only this one
gets replaced by your configuration. This also speeds up the import significantly.
4. Import the modified column configuration with the following command:

import_uiconfig -u=<USERNAME> -p=<PASSWORD> -g=<GROUP>

-file=C:\TEMP\uiconfig.xml

Please consult the Teamcenter documentation for the details of this command.
5. Repeat the search.

The simplest way to get the properties of the objects representing the search result into the table view is to
add them to the existing <ColumnConfig> element like shown below:

Extended Default Column Configuration

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>

<Import>
<Client abbreviation="AWClient" name="AWClient">
<ClientScope hostingClientName="" name="Advanced Search"
uri="Awp0AdvancedSearch">
<ColumnConfig
columnConfigId="advancedSearchResultsColConfig" sortBy="1"
sortDirection="Descending">
<ColumnDef columnName="ai0ExternalObjectId"
filterable="true" hidden="false"
objectType="Ai0AIGExternalSystemObject"
propertyName="ai0ExternalObjectId" width="100" />
<ColumnDef columnName="ai0ExternalObjectName"
filterable="true" hidden="false"
objectType="Ai0AIGExternalSystemObject"
propertyName="ai0ExternalObjectName" width="200" />
<ColumnDef columnName="object_name" filterable="true"
hidden="false" objectType="WorkspaceObject"
propertyName="object_name" width="300" />
<ColumnDef columnName="owning_user" filterable="true"
hidden="false" objectType="POM_application_object"
propertyName="owning_user" width="300" />
<ColumnDef columnName="last_mod_user"
filterable="true" hidden="false"
objectType="POM_application_object"
propertyName="last_mod_user" width="300" />
<ColumnDef columnName="last_mod_date"
filterable="true" hidden="false"
objectType="POM_application_object"
propertyName="last_mod_date" width="300" />
<ColumnDef columnName="object_desc" filterable="true"
hidden="false" objectType="WorkspaceObject"
propertyName="object_desc" width="300" />
<ColumnDef columnName="release_status_list"

7-10 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Customization of the Advanced Search Table View

Extended Default Column Configuration

filterable="true" hidden="false" objectType="WorkspaceObject"
propertyName="release_status_list" width="300" />
<ColumnDef columnName="item_id" filterable="true"
hidden="false" objectType="Item" propertyName="item_id"
width="100" />
<ColumnDef columnName="item_revision_id"
filterable="true" hidden="false" objectType="ItemRevision"
propertyName="item_revision_id" width="100" />
</ColumnConfig>
</ClientScope>
</Client>
</Import>

This adds two colums to appear leftmost in the table. The ai0ExternalObjectId and
ai0ExternalObjectName properties represent the ID and name of the external objects. For other
types of searches these columns do not appear in the output as the properties are only defined on
the Ai0AIGExternalSystemObject type. However this principle does not apply vice versa: All the other
columns like object_name or item_revision_id are present in the external query result even though
these properties are neither defined for the Ai0AIGExternalSystemObject type nor its super types. Altering
the table's so-called arrangement is the only option to hide these columns. Arrangements cannot be
bound to types. They can be modified interactively and saved under a name chosen by the user. Named
arrangements can be defined in the column configuration to be consumed by the user.

The following configuration example creates an arrangement dedicated to display external query results:

Arrangement For External Query Results

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>

<Import>
<Client abbreviation="AWClient" name="AWClient">
<ClientScope hostingClientName="" name="Advanced Search"
uri="Awp0AdvancedSearch">
<ColumnConfig
columnConfigId="advancedSearchResultsColConfig"
columnConfigName="External Query Results" sortBy="1"
sortDirection="Descending">
<ColumnDef columnName="ai0ExternalObjectId"
filterable="true" hidden="false"
objectType="Ai0AIGExternalSystemObject"
propertyName="ai0ExternalObjectId" width="150" />
<ColumnDef columnName="ai0ExternalObjectName"
filterable="true" hidden="false"
objectType="Ai0AIGExternalSystemObject"
propertyName="ai0ExternalObjectName" width="300" />
</ColumnConfig>
</ClientScope>
</Client>
</Import>

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 7-11
Unpublished work. © 2024 Siemens Software Version 2406
Customization of the Advanced Search Table View

Note that the columnConfigId attribute is identical to the OOTB version and that the
columnConfigName attribute has been added. To activate the arrangement after importing the column
configuration click yourself through the UI elements as numbered in below figures:

7-12 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Customization of the Advanced Search Table View

Activate External Query Results Arrangement

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide 7-13
Unpublished work. © 2024 Siemens Software Version 2406
Customization of the Advanced Search Table View

Users will have to switch between arrangements when they use different types of queries. Both
approaches can be combined, namely extending the default configuration with the columns from the
Ai0AIGExternalSystemObject type and adding an arrangement with only these columns. That way they
only have to switch to the custom arrangement when they want to ban the empty default columns from
the view.

If you choose to create your own type to carry the query results you may add additional properties to the
column configurations.

7-14 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 T4EA Preferences

A. Teamcenter Preference Examples

T4EA Preferences

<?xml version="1.0" encoding="ISO-8859-1"?>

<preferences version="10.0">
<category name="EA Gateway">
<category_description></category_description>
<!-- - - - - - - - - - - - - - - - - - - - - - - - -
! ItemRevision
! - - - - - - - - - - - - - - - - - - - - - - - -->
<preference
name="AWC_ItemRevision.showObjectLocation.SUMMARYRENDERING" type="String"
array="false" disabled="false" protectionScope="Site" envEnabled="false">
<preference_description>Registration of summary stylesheet for Item
Revision for ShowObject Location.
[WebDV] Changed to point to the XRT that includes the T4x Data View
for Web.
The default value is Awb0ItemRevSummaryForShowObjectLocation.
</preference_description>
<context name="Teamcenter">
<value>WebDV_T4EA_Demo_XRT</value>
</context>
</preference>
<preference
name="AWC_ItemRevision.showObjectLocation.ProjectContentsSubLocation.SUMMARY
RENDERING" type="String" array="false" disabled="false"
protectionScope="Site" envEnabled="false">
<preference_description>[WebDV] Registration of summary stylesheet
for ItemRevision for ShowObject Location and ProjectContents SubLocation.
Changed to point to the XRT that includes the T4x Data View for Web. This
preference used to point toAwp0ItemRevSummary.
This is part of the AIG t4eademo feature.</preference_description>
<context name="Teamcenter">
<value>WebDV_T4EA_Demo_XRT</value>
</context>
</preference>
<preference name="AWC_ItemRevision.SUMMARYRENDERING" type="String"
array="false" disabled="false" protectionScope="Site" envEnabled="false">
<preference_description>[WebDV] Registration of summary stylesheet
for ItemRevision.
Changed to point to the XRT that includes the T4x Data View for Web. This
preference used to point toAwp0ItemRevSummary.
This is part of the AIG t4eademo feature.</preference_description>
<context name="Teamcenter">
<value>WebDV_T4EA_Demo_XRT</value>
</context>
</preference>
<preference
name="AWC_ItemRevision.showObjectLocation.OccurrenceManagementSubLocation.SU
MMARYRENDERING" type="String" array="false" disabled="false"
protectionScope="Site" envEnabled="false">

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-1
Unpublished work. © 2024 Siemens Software Version 2406
T4EA Preferences

<preference_description>[WebDV] Registration of summary stylesheet

for ItemRevision for ShowObject Location and OccurrenceManagement
SubLocation.
Changed to point to the XRT that includes the T4x Data View for Web. This
preference used to point toAwp0ItemRevSummary.
This is part of the AIG t4eademo feature.</preference_description>
<context name="Teamcenter">
<value>WebDV_T4EA_Demo_XRT</value>
</context>
</preference>
<preference
name="AWC_ItemRevision.showObjectLocation.objectNavigationSubLocation.SUMMAR
YRENDERING" type="String" array="false" disabled="false"
protectionScope="Site" envEnabled="false">
<preference_description>[WebDV] Registration of summary stylesheet
for ItemRevision for ShowObject Location and Navigate SubLocation.
Changed to point to the XRT that includes the T4x Data View for Web. This
preference used to point toAwp0ItemRevSummary.
This is part of the AIG t4eademo feature.</preference_description>
<context name="Teamcenter">
<value>WebDV_T4EA_Demo_XRT</value>
</context>
</preference>
<preference name="AWC_ItemRevision.showObjectLocation.SUMMARYRENDERING"
type="String" array="false" disabled="false" protectionScope="Site"
envEnabled="false">
<preference_description>[WebDV] Registration of summary stylesheet
for ItemRevision for ShowObject Location.
Changed to point to the XRT that includes the T4x Data View for Web. This
preference used to point toAwb0ItemRevSummaryForShowObjectLocation.
This is part of the AIG t4eademo feature.</preference_description>
<context name="Teamcenter">
<value>WebDV_T4EA_Demo_ForShowObjectLocation_XRT</value>
</context>
</preference>
<!-- - - - - - - - - - - - - - - - - - - - - - - - -
! AIG Demo Prefs
! - - - - - - - - - - - - - - - - - - - - - - - -->
<preference name="T4EA.AW.XRTInfo" type="Logical" array="false"
disabled="false" protectionScope="Site" envEnabled="false">
<preference_description>[WebDV] Set this to true to enable the AIG
Info pages.</preference_description>
<context name="Teamcenter">
<value>false</value>
</context>
</preference>
<preference name="T4EA.AW.MoreWebDVExamples" type="Logical"
array="false" disabled="false" protectionScope="Site" envEnabled="false">
<preference_description>[WebDV] Set this to true to show extended
WebDV examples.</preference_description>
<context name="Teamcenter">
<value>true</value>
</context>
</preference>
<!-- - - - - - - - - - - - - - - - - - - - - - - - -
! IsBOM Preferences

A-2 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 T4EA Preferences

! - - - - - - - - - - - - - - - - - - - - - - - -->
<preference name="T4EA_BillOfMaterialIsBOM" type="Logical"
array="false" disabled="false" protectionScope="Site" envEnabled="false">
<preference_description>[WebDV] Let T4x treat BillOfMaterial as a
bill of material kind of target type.</preference_description>
<context name="Teamcenter">
<value>true</value>
</context>
</preference>
<preference name="T4EA_ProductAssociationIsBOM" type="Logical"
array="false" disabled="false" protectionScope="Site" envEnabled="false">
<preference_description>[WebDV] Let T4x treat ProductAssociation as a
bill of material kind of target type.</preference_description>
<context name="Teamcenter">
<value>true</value>
</context>
</preference>
</category>
</preferences>

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-3
Unpublished work. © 2024 Siemens Software Version 2406
T4EA Preferences

A-4 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 WebDV_T4S_Demo_XRT Dataset

A. XML Rendering Template Examples

The examples outlined in this appendix do only cover the XML elements that have to be added to the
out-of-the-box XRTs in order to add Dataview functionality to the Active Workspace. All examples add new
pages to the XRTs.

Caution
• Note the ↩ symbols. When you find them at the end of the lines that you want to copy&paste to your
text editor please remove them together with the subsequent line breaks and white space.
• You may see line breaks in the documentation that must not appear in the actual XRTs. The values of
XML attributes must not contain line breaks.
• The examples are shortened to fit into the documentation format and to focus on the essential
information. More complete examples can be found in the demo features that are available with many
of the AIG products.
• In general XRTs differ between Active Workspace versions so you may need to migrate them to new
Active Workspace versions.
• You may need to adapt the URL parameters, e.g. add eacon parameters.
• You may need to add more XRTs to account for different locations or sublocations, like supplementing
the WebDV_T4S_Demo_XRT with the WebDV_T4S_Demo_ForShowObjectLocation_XRT XRT.
• You may need to add visibleWhen conditions to pages or place pages in conditional content elements
to account for different locations, sublocations, types or preference values.
• Checkout Create and Modify XRTs for details.

WebDV_T4S_Demo_XRT Dataset
Covers SAP Material Master, Bill of Material, Document Info Record (Item Revision method), Change
Master. Applies to T4S as well as T4S4.

[...]
<content visibleWhen="ActiveWorkspace:SubLocation !=
com.siemens.splm.client.occmgmt:OccurrenceManagementSubLocation">
<page title="SAP Material Master">
<htmlPanel enableresize="true"
src="/webdv?tcobj={{selected.uid}};product=T4S;eaot=MM" />
</page>
<page title="SAP Bill of Material" visibleWhen="structure_revisions!
=null">
<htmlPanel enableresize="true"
src="/webdv?tcobj={{selected.uid}};product=T4S;eaot=BOM" />
</page>
<page title="SAP Document Info Record">
<htmlPanel enableresize="true"

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-1
Unpublished work. © 2024 Siemens Software Version 2406
WebDV_T4S_Dataset_Demo_XRT Dataset

src="/webdv?tcobj={{selected.uid}};product=T4S;eaot=DIR" />
</page>
<page title="SAP Change Master">
<htmlPanel enableresize="true"
src="/webdv?tcobj={{selected.uid}};product=T4S;eaot=ECM" />
</page>
</content>
<content visibleWhen="ActiveWorkspace:SubLocation ==
com.siemens.splm.client.occmgmt:OccurrenceManagementSubLocation">
<page title="SAP Material Master">
<htmlPanel enableresize="true"
src=
"/webdv?
tcobj={{selected.props.awb0UnderlyingObject.dbValues[0]}};product=T4S;eaot=M
M"
/>
</page>
[...]
</content>
[...]

WebDV_T4S_Dataset_Demo_XRT Dataset
Covers SAP Document Info Record (Dataset method). Applies to T4S as well as T4S4.

[...]
</page>
<page title="SAP Document Info Record">
<htmlPanel enableresize="true"
src="/webdv?
tcobj={{selected.uid}};product=T4S;eaot=DIR;ealang=EN;ealang=DE" />
</page>
[...]

WebDV_T4S_Resource_Demo_XRT Dataset
Covers SAP Equipment Master, Functional Location. Applies to T4S as well as T4S4.

[...]
<content visibleWhen="ActiveWorkspace:SubLocation !=
com.siemens.splm.client.occmgmt:OccurrenceManagementSubLocation">
<page title="SAP Equipment Master">
<htmlPanel enableresize="true"
src=
"/webdv?tcobj={{selected.uid}};product=T4S;eaot=EQUI"
/>
</page>
<page title="SAP Functional Location">

A-2 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 WebDV_T4S_Vendor_Demo_XRT Dataset

<htmlPanel enableresize="true"
src=
"/webdv?tcobj={{selected.uid}};product=T4S;eaot=FUNCLOC"
/>
</page>
</content>
<content visibleWhen="ActiveWorkspace:SubLocation ==
com.siemens.splm.client.occmgmt:OccurrenceManagementSubLocation">
<page title="SAP Equipment Master">
<htmlPanel enableresize="true"
src=
"/webdv?
tcobj={{selected.props.awb0UnderlyingObject.dbValues[0]}};product=T4S;eaot=E
QUI"
/>
</page>
[...]
</content>
[...]

WebDV_T4S_Vendor_Demo_XRT Dataset
Covers SAP Vendor. Applies to T4S as well as T4S4.

[...]
<page title="SAP Vendor">
<htmlPanel enableresize="true"
src="/webdv?
tcobj={{selected.uid}};product=T4S;eaot=VENDOR;ealang=EN;ealang=DE" />
</page>
[...]

WebDV_T4O_Demo_XRT Dataset
Covers EBS Item, Bill of Material, Change Order. Applies to T4O.

[...]
<content visibleWhen="ActiveWorkspace:SubLocation !=
com.siemens.splm.client.occmgmt:OccurrenceManagementSubLocation">
<page title="EBS Item">
<htmlPanel enableresize="true"
src="/webdv?tcobj={{selected.uid}};product=T4O;eaot=ITEM" />
</page>
<page title="EBS Bill of Material" visibleWhen="structure_revisions!
=null">
<htmlPanel enableresize="true"
src="/webdv?tcobj={{selected.uid}};product=T4O;eaot=BOM" />
</page>

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-3
Unpublished work. © 2024 Siemens Software Version 2406
WebDV_T4EA_Demo_XRT Dataset

<page title="EBS Change Order">

<htmlPanel enableresize="true"
src="/webdv?tcobj={{selected.uid}};product=T4O;eaot=ECO" />
</page>
</content>
<content visibleWhen="ActiveWorkspace:SubLocation ==
com.siemens.splm.client.occmgmt:OccurrenceManagementSubLocation">
<page title="EBS Item">
<htmlPanel enableresize="true"
src=
"/webdv?
tcobj={{selected.props.awb0UnderlyingObject.dbValues[0]}};product=T4O;eaot=I
TEM"
/>
</page>
[...]
</content>
[....]

WebDV_T4EA_Demo_XRT Dataset
Covers

• Article and BillOfMaterial of the artificial Demo ERP system

• OFBiz Product and Product Association
• Oracle Product Information

Applies to T4EA.

[...]
<content visibleWhen="ActiveWorkspace:SubLocation !=
com.siemens.splm.client.occmgmt:OccurrenceManagementSubLocation">
<page title="Article">
<htmlPanel enableresize="true"
src=
"/webdv?tcobj={{selected.uid}};product=T4EA;eaot=Article;eacon=DemoERP1"
/>
</page>
<page title="Bill of Material" visibleWhen="structure_revisions!
=null">
<htmlPanel enableresize="true"
src=
"/webdv?
tcobj={{selected.uid}};product=T4EA;eaot=BillOfMaterial;eacon=DemoERP1"
/>
</page>
<page title="Product">
<htmlPanel enableresize="true"
src=

A-4 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 WebDV_T4EA_Demo_XRT Dataset

"/webdv?tcobj={{selected.uid}};product=T4EA;eaot=Product;eacon=OFBiz1"
/>
</page>
<page title="Product Association">
<htmlPanel enableresize="true"
src=
"/webdv?
tcobj={{selected.uid}};product=T4EA;eaot=ProductAssociation;eacon=OFBiz1"
/>
</page>
<page title="Product Information 1">
<htmlPanel enableresize="true"
src=
"/webdv?
tcobj={{selected.uid}};product=T4EA;eaot=ProductInformation;eacon=Oracle1"
/>
</page>
<page title="Product Information 2">
<htmlPanel enableresize="true"
src=
"/webdv?
tcobj={{selected.uid}};product=T4EA;eaot=ProductInformation;eacon=Oracle2"
/>
</page>
</content>
<content visibleWhen="ActiveWorkspace:SubLocation ==
com.siemens.splm.client.occmgmt:OccurrenceManagementSubLocation">
<page title="Article">
<htmlPanel enableresize="true"
src=
"/webdv?
tcobj={{selected.props.awb0UnderlyingObject.dbValues[0]}};product=T4EA;eaot=
Article;eacon=DemoERP1"
/>
</page>
[...]
</content>
[...]

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-5
Unpublished work. © 2024 Siemens Software Version 2406
WebDV_T4EA_Demo_XRT Dataset

A-6 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
A. Active Workspace SVG Images

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-1
Unpublished work. © 2024 Siemens Software Version 2406
A-2 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-3
Unpublished work. © 2024 Siemens Software Version 2406
A-4 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-5
Unpublished work. © 2024 Siemens Software Version 2406
A-6 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-7
Unpublished work. © 2024 Siemens Software Version 2406
A-8 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-9
Unpublished work. © 2024 Siemens Software Version 2406
A-10 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-11
Unpublished work. © 2024 Siemens Software Version 2406
A-12 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-13
Unpublished work. © 2024 Siemens Software Version 2406
A-14 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-15
Unpublished work. © 2024 Siemens Software Version 2406
A-16 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-17
Unpublished work. © 2024 Siemens Software Version 2406
A-18 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-19
Unpublished work. © 2024 Siemens Software Version 2406
A-20 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-21
Unpublished work. © 2024 Siemens Software Version 2406
A-22 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-23
Unpublished work. © 2024 Siemens Software Version 2406
A-24 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-25
Unpublished work. © 2024 Siemens Software Version 2406
A-26 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-27
Unpublished work. © 2024 Siemens Software Version 2406
A-28 Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide A-29
Unpublished work. © 2024 Siemens Software Version 2406
ABAP

Glossary

ABAP
Advanced Business Application Programming: A proprietary programming language of SAP AG.

Admin
The term used in this document for people who install and configure Teamcenter and its components. This
is in contrast to the "user" role.

Admin UI
Web based administrative user interface of the GS and BGS.

AIG
The entire Active Integration Gateway product family.

AIG_ROOT
Please see <GS_ROOT> and <BGS_ROOT>. This term is used if something applies to both the GS and BGS.

AI Object
Application Interface Object.

API
Application Programming Interface.

Apps
Please see GS.

AppServer
Application Server.

xxx Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 BAPI

BAPI
Business Application Programming Interface: SAP interface that allows external programs to access SAP
objects and business processes.

Basic Gateway Service

The component of AIG that is responsible for Licensing, Logging and Job management.

BGS
Basic Gateway Service.

BGS_ROOT
The installation directory of the Basic Gateway Service (e.g., C:\Siemens\BGS).

BMIDE
The Teamcenter Deployment Center (Integrated Development Environment).

BOM
Bill Of Materials: A list of the parts or components and their quantities that are required to build a product.

BOM Header
The top item of a BOM. BOMs can have multiple levels, so this often means the top item of the actual level.

BOP
Bill Of Process: A list of the operations and steps in a manufacturing process along with all their
instructions, consumed materials, resources, work places and machines.

CC Object
Collaboration Context Object.

CEP
Camstar Enterprise Platform.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide xxxi
Unpublished work. © 2024 Siemens Software Version 2406
Change Master

Change Master
An SAP object containing the metadata for a change number. See also Engineering Change Master (ECM).

Characteristic
An attribute of an SAP class.

CIO
Camstar Interoperability.

Data Carrier
See Vault.

Dataview
An extension to the Teamcenter RAC (and Active Workspace) that displays real-time Enterprise
Application data associated with a Teamcenter object.

Dataview mark-up
The language understood by the Dataview. The Dataview receives messages written in this language from
the T4x server, formatted as XML or JSON. Users do not normally see such messages, but they may appear
in log files or error messages. The "prop mapping" (e.g., t4s_prop_mapping_template.sd) contains TCL
commands that compose messages in the Dataview mark-up language.

DC_ROOT
The installation directory of Deployment Center (e.g., C:\Siemens\DeploymentCenter).

DCD
Data Collection Definition.

DIR
An SAP Document Info Record.

xxxii Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Document Key

Document Key
The unique identifier of a Document Info Record consisting of the combination of Document Type,
Document Number, Document Part and Document Version.

Document Structure
A list of the document parts or components and their quantities that are required to assemble a structured
document, similar to a BOM.

EA
Enterprise Application.

ECM
An SAP Engineering Change Master.

ECN
Engineering Change Notice. Can also be called an Engineering Change Note, Engineering Change Order
(ECO), or just an Engineering Change (EC).

Enterprise Application
Any software or set of computer programs used by business users to perform various business functions in
the context of the current integration portfolio with Teamcenter.

EPM
Enterprise Process Modeling.

ERP
Enterprise Resource Planning: The integrated management of main business processes such as production
planning, purchasing inventory, sales, marketing, finance, human resources, and more.

EWI
Electronic Work Instructions.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide xxxiii
Unpublished work. © 2024 Siemens Software Version 2406
File Stream

File Stream
A method of directly transferring an Original to SAP rather than using SAPftp or SAPhttp.

FN4S
Opcenter Connect FN for SAP S/4HANA.

Gateway Menu
A menu of Teamcenter Gateway functions that is available in the Teamcenter RAC.

Gateway Service
The component of AIG that manages the communication between Teamcenter and Enterprise
Applications and drives the mapping process.

GRM
Generic Relationship Management: Provides a general way in which two objects can be associated via a
relationship.

GS
Gateway Service.

GS_ROOT
The installation directory of the Gateway Service (e.g., C:\Siemens\GS).

GUI
Graphical User Interface.

GUID
Globally Unique Identifier.

IDGEN
ID Generator: A mechanism to get an external ID from an Enterprise Application when assigning a
Teamcenter ID.

xxxiv Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 Inspection Plan

Inspection Plan
A list of characteristics to be inspected in an inspection operation and the associated test equipment to be
used.

iPPE
Integrated Product and Process Engineering: An SAP module that can be used to mange products with
many variants.

ITK
Integration Toolkit: A set of software tools provided by Siemens PLM Software that can be used to integrate
third-party or user-developed applications with Teamcenter.

JCO
Java Connector: An interface allowing Java applications to connect to SAP. In the context of , it is now
mostly replaced by the NetWeaver RFC SDK.

JDBC
Java Database Connectivity: An API for the programming language Java that defines how a client may
access a database.

Job
A collection of operations to be performed in the background rather than as part of a user’s interactive
session. The Teamcenter Gateway features asynchronous transfer, which is managed via a Job.

Job Agent
The component of the Gateway Service that executes Jobs.

Job Pool
A queue of all Jobs (whether pending, currently executing or completed) that is managed by the BGS.

Job Server
The component of the Basic Gateway Service that manages the Job Pool and distributes pending Jobs to
Job Agents for processing.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide xxxv
Unpublished work. © 2024 Siemens Software Version 2406
JSON

JSON
JavaScript Object Notation: A lightweight data-interchange format. (See https://www.json.org/ for more
information.)

KPro
Knowledge Provider: A cross-application and cross-media technical information infrastructure within the
framework of SAP. See also Data Carrier.

LOV
List of Values: Teamcenter term for a list of selectable values for a property. See also Value Set.

Mapping
The part of the T4x configuration that contains the code to control the behavior of the data transfer
between Teamcenter and an Enterprise Application.

MFK
Multi-field key functionality in Teamcenter.

MM
An SAP Material Master.

MOM
Manufacturing Operations Management.

MRP
Manufacturing Resource Planning: A production planning, scheduling and inventory control system used
to manage manufacturing processes.

NCN
Non-Conformance Notification.

xxxvi Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 NetWeaver RFC SDK

NetWeaver RFC SDK

Libraries allowing third-party applications to connect to SAP using RFCs. It can be obtained from the SAP
ONE Support Launchpad.

Object Key
A string containing the ID of an Enterprise Application object. If the identifier is a combination of multiple
keys, then the Object Key is a combination of those keys in a defined order and format.

Object Link
A relation between two SAP objects such as a Material Master and a Document Info Record.

Object Management Record

An SAP object that links an ECM to another SAP object such as a Material Master or Document Info Record.

OOTB
Out Of The Box: A feature or function that works without any modification or customization.

Original
A representation of a file in SAP.

OSS Notes
An online patch service for SAP. A specific patch can be identified by its OSS Note number.

PIR
An SAP Purchase Info Record.

Portal Transaction
A transfer to an Enterprise Application that is not triggered by a workflow handler but via the Gateway
Menu.

RAC
The Teamcenter Rich Application Client. Also referred to as Rich Client or Portal.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide xxxvii
Unpublished work. © 2024 Siemens Software Version 2406
Revision Level

Revision Level
An SAP attribute that uniquely identifies the particular version of an SAP Material Master or Document Info
Record associated with a Change Master.

RFC
Remote Function Call.

SAP
SAP S/4HANA® or SAP Business Suite®.

SAP GUI
The client application for SAP.

SAP Logon
The application that a user runs to start the SAP GUI for a particular system. It may also refer to the process
of logging in to SAP in Teamcenter via .

SAP Portal iView URL

The URL of the SAP Integrated View (iView) that can be used to show SAP content in a browser window.

Session Log
A T4x logfile on the BGS containing log information for a specific Teamcenter session in which T4x
functions have been executed.

SSL
Secure Sockets Layer.

T4O_ROOT
See <GS_ROOT>.

T4S 4-Tier Client (SAP Lite)

A stripped down GS that is only able to open the SAP GUI on a Teamcenter 4-Tier Client.

xxxviii Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 T4x

T4x
The entire Teamcenter Gateway product family.

TAO
The ACE ORB: An open-source and standards-compliant real-time C++ implementation of CORBA (Common
Object Request Broker Architecture) based upon the Adaptive Communication Environment (ACE).

TargetTypeName
The T4x internal name for a transaction type, such as MaterialMaster or DocumentInfoRecord.

TC
Teamcenter.

TCL
Tool Command Language: A high-level, general-purpose, interpreted, dynamic programming language.
(See https://www.tcl.tk/ for more information.)

TCPCM
Teamcenter Product Cost Management.

TCPCM4S
Teamcenter Product Cost Management Gateway for SAP S/4HANA.

TEM
Teamcenter Environment Manager.

TLS
Transport Layer Security.

Transaction Code
A quick access code for a Transaction in the SAP GUI:

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide xxxix
Unpublished work. © 2024 Siemens Software Version 2406
Transaction Log

Transaction Log
A T4x logfile on the BGS containing log information for a specific T4x transaction.

Transfer Window
The window that is displayed when triggering transactions via the Gateway Menu.

Transport Package
A file containing a set of functions that can be imported to SAP.

UOM
Unit of Measure.

URI
Uniform Resource Identifier: A string of characters in a specific format (such as a URL or URN) that
unambiguously identifies a particular resource. URIs are often used to identify configurations in Java and
other languages. (See https://en.wikipedia.org/wiki/Uniform_Resource_Identifier for more information.)

URL
Uniform Resource Locator: A URI that identifies a web resource by specifying its location on a computer
network and a mechanism for retrieving it.

URN
Uniform Resource Name: A URI that identifies a resource by name without specifying a location or access
method.

User Exit (SAP)

SAP program code that is called if an object like a Material Master has been changed or updated. In the
context of T4S, it is often used to initiate the process to trigger a transfer from SAP to Teamcenter.

xl Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide
Software Version 2406 Unpublished work. © 2024 Siemens
 User Log

User Log
A T4x logfile on the BGS containing log information written to a customized logchannel.

Value Set
SAP term for a list of selectable values for a characteristic. See also LOV.

Vault
A server where an SAP Document Info Record Original is stored. Also called Data Carrier.

WBS
An SAP Work Breakdown Structure.

XML
Extensible Markup Language: A format for storing and transporting data that is both human-readable and
machine-readable.

XRT
XML Rendering Template: Also known as an XML Rendering Stylesheet, this is an XML document stored in
a dataset that defines how parts of the Teamcenter user interface are rendered. They are used for the Rich
Client as well as Active Workspace.

ZPTC
The short name for a Z-Table with the name /TESISPLM/ZPTC, which is used to trigger transfers from
SAP.

Z-Table
A custom SAP table ("Z" is a well-known prefix name for custom tables in the SAP world). In the context of ,
this refers to the table /TESISPLM/ZPTC, which is used to trigger transfers from SAP.

Teamcenter Gateway for Enterprise Applications - Active Workspace Add-ons Installation and Setup Guide xli
Unpublished work. © 2024 Siemens Software Version 2406