Awc
Awc
Common Errors faced during Teamcenter patch update and AWC patch update:........................ 24
Unable To Unzip XXX.Zip File: ...................................................................................................... 24
Service failed to start. The service did not start due to a logon failure: ...................................... 25
The Network Adapter could not establish the connection: ........................................................... 26
JBoss 5.1.0 tc.ear deploy error: ....................................................................................................... 27
The Web server had a problem. ...................................................................................................... 27
Active Workspace Folder Structure: ................................................................................................... 28
AWS2: .................................................................................................................................................... 28
Build ................................................................................................................................................... 29
Out ...................................................................................................................................................... 30
Repo.................................................................................................................................................... 30
Src ....................................................................................................................................................... 30
Solr-4.4.0: ............................................................................................................................................... 31
Awc ..................................................................................................................................................... 32
contrib ................................................................................................................................................ 33
dist ...................................................................................................................................................... 34
TcFTSIndexer: ...................................................................................................................................... 34
bin ....................................................................................................................................................... 35
conf ..................................................................................................................................................... 36
Configuration of AWC: ............................................................................................................................ 37
Start Teamcenter Pool_manager ...................................................................................................... 37
Start JBoss server Manager ............................................................................................................... 37
Start Solr ............................................................................................................................................... 38
Start TcFTSIndexer.............................................................................................................................. 39
Introduction to AWC
Active Workspace is a light weight version of Teamcenter with no need for client installation. It has better
performance compared to Rich Client or Thin Client. AWC presents complex structures with animated
graphics on UI. It is available on mobile devices. AWC aims on providing access of PLM data to all users
throughout the products lifecycle by providing an organized and in-built understanding, on any device.
Key Features
Simplified AWC installation -reduced manual steps, simplified TEM, Organize feature selection
and enforce prerequisites
Browser independent
Configurable UI
Visualize huge models in seconds and analyze the features like measure, cross-section and spatial
searching
Multiple select functionality to cut, copy, reassign tasks or to add/remove an object from
favorites
AWC Architecture:
No particular architecture for active workspace we are going to deploy AWC on top of Teamcenter
4-Tier architecture. So the base for AWC is Teamcenter 4-Tier architecture.
Changes to be made in the Teamcenter 4-Tier architecture to have an add on of AWC will be discussed
in the document
Client Tier
Web Tier
Enterprise Tier
Resource Tier
Client tier:
Client functionality is provided by a user-facing Java EE web application (awc.war) that is built using
TEM and deployed on a Java EE web application server such as JBoss or WebSphere. Users
Connect to the client web application using a web browser.
Web tier:
In the team center 4-tier architecture web tier is used to generate the tc.ear file.
In AWC, awc.war file will be generated in the aws2 folder once the client is installed.
To enable the 3D visualization functionality first we need to install visualization server pool
assigner.
When Visualization server pool assigner feature is selected it mainly installs the middle tier
processes that communicate with the visualization server processes of the Active Workspace
client.
This feature will be present in the Client of AWC as shown in below screenshot.
Enterprise tier:
Mainly two features related to Active Workspace will be present in this tier
TcFTSIndexer
Vis Server
TcFTSIndexer:
It is a four tier SOA client used to export Team center data for importing into Solr database. This
server manages overall indexing processes.
The following command can be used to index the object data of team center
runTcFTSIndexer.bat -task=objdata: index
TcFTSIndexer and Solr database will be interconnected and communication between these two
will be referred to as indexing.
Vis Server:
The Visualization Server provides dynamic 3D visualization functionality to the Active Workspace client.
Vis Server will be within the Active Workspace as shown in the below screen shot
Resource tier:
If Active Workspace under server extensions is selected while installing then it will add binaries to
TC_ROOT and data model changes to the database and TC_DATA. It adds the Active Workspace
(aw2_template.xml) and Relationship Viewer (relationshipviewer_template.xml) templates to the
database.
Solr Database:
Solr is a database which is full text search engine that stores indexed team center data. TcFTSIndexer and
Solr will be communicating in a way like if any indexing is done using TCFTSIndexer then the indexed
data will be stored in solr database.
The base version of Teamcenter (10.1.0) should be patched to the compatible Teamcenter version with
active workspace i.e., Tc10.1.4.
Check the JRE version installed. Oracle and Siemens strongly recommends upgrading to JRE 1.7 for
application like TEM and Pool Manager.
Note: JRE1.7 is required for Browser based clients after Tc9.1.2.7
Check if the Environmental variables like JAVA_HOME, JRE_HOME, and ORACLE_HOME are set. If
not, set before proceeding with the installation.
Before proceeding with Teamcenter patch update and AWC patch update download the listed installation packages
from GTAC.
TC10.1.0_patch_4_install.
TC10.1.0_patch_4_wntx64.
TC10.1.4_Activeworkspace_2.4a_wntx64.
Backup the TC_DATA and TC_ROOT/install folder of the base version Teamcenter setup.
Run TEM.bat from TC_ROOT/install folder and select the Updates Manager from Maintenance window.
Under Update kits location, browse to the location where you unzipped the TC10.1.4_patch_4_wntx64
folder up to wntx64 folder and proceed.
Operating System user need to enter the password to proceed further. This is needed since Teamcenter use
this specific user to create required services.
Note: The installation process will proceed further even though the wrong credentials are entered, but
installation will fail in the middle. So care should be taken while providing the user credentials.
Teamcenter Administrative user window requires the Teamcenter database credentials to be entered to
proceed with the installation. Provided the wrong credentials, the window will not proceed further. This is
the credentials which you determined during the creation of corporate server while installing Teamcenter
base version.
After the installation is completed, the TEM window will prompt for TC_DATA patch up. For that process
unzip the TC10.1.4_patch_4_wntx64\wntx64\tc\data.zip contents to the TC_DATA.
Now the patch update process is completed. To check for the update, check the version of Teamcenter
opening Rich client.
Backup the TC_DATA and TC_ROOT/install folder of the updated version Teamcenter setup.
Run TEM.bat from TC_ROOT/install folder and select the Updates Manager from Maintenance window.
Under
Update
kits
location,
browse
to
the
location
where
you
unzipped
the
After this operating system user credentials and Teamcenter database credentials are to be provided and
click on the start at the confirmation panel which initiates AWC patch update.
After installing the Teamcenter patch (10.1.4) and AWC (2.4A) patch, one can able to install the AWC features. The
Active workspace can be verified by running the Teamcenter TEM window again and proceeding to the features
window, you can able to see the active workspace appearing as one of the feature.
Cognizant EMS - Internal
Server Extensions.
Client.
Indexing Server.
64-bit JDK.
Teamcenter with Four tier architecture. (JAVA EE server and JAVA EE web tier).
In the features under Active workspace under sever extension tab of AWC feature and proceed further by
clicking Next.
Teamcenter Administrative Window will ask for user and password. You need to enter credentials of the
database which you created while installing the base version of Teamcenter. The installation will not
proceed if wrong credentials are provided.
In the Indexing Engine user window, you need to enter the credentials for the indexing engine to be used
for Active Workspace indexing.
If the indexing engine is already installed, provide the same user and passwords in the given text
fields and proceed.
If not installed, make note of user and password input you provide in the text fields as the same
will be required while installing Indexing engine and proceed.
At the next window, you need to provide the search engine URL .The Search engine general preferred for
Active Workspace is Solr.
If Solr and indexing engine is installed on a machine, provide the URL to access the search
engine for Active Workspace.
Note: host is the machine designated to run Solr. This is the machine on which the Indexing Engine is
installed.
Port is the port value used by Solr. The default is 8983.
Database Template Summary will help you to know about the templates that are being added to the
database after the installation of this feature.
Confirmation of the installation by clicking start will update the TC_ROOT, database and TC_DATA with
notified templates.
A minimum of 16 GB of free memory to successfully generate the awc.war file. Siemens PLM Software
recommends that the machine used have a minimum of 24 GB.
JDK 64-bit is installed and the JAVA_HOME system environment variable must be set.
Select Active Workspace Client (Java EE) under client section of Active Workspace feature.
The proceeding page is Prerequisites checks page where the environment needed for the Active workspace
client installation is verified by the Teamcenter Environment Manger.
Enter the desired path where the Teamcenter should create log files related to AWC and click Run.
RAM availability and JDK version compatibility are verified further. If you get warning for RAM
availability and passed status for JDK version, the installation will proceed. In other cases like
failed in both checks and failed in JDK version compatibility, the installation will not proceed
further.
The JDK version compatible recommended by siemens for active Workspace is JDK1.7 or above.
Even the RAM availability is around 8GB or more, the installation will proceed.
After the prerequisites check TEM will proceed to the AWC client Settings where the user need to input the
Teamcenter 4-Tier URL, JDK path and Bootstrap URLs.
The data entered used to configure the Awc.war file which needs to be deployed on a web
application server to make the active workspace client work on a web browser.
Any Error in the input data will generate awc.war successfully, but we cannot able to access the
AWC client.
Clicking on Start button on confirmation will start the installation of AWC client and creation of awc.war
file.
The created awc.war file can be found at TC_ROOT\aws2\stage\out directory which you need to deploy on
a web application server to login to Active workspace client.
Select Active Workspace Indexing Engine and Active Workspace Indexer under Indexing server section
of Active Workspace feature.
In the Teamcenter Administrative User window input the credentials of Teamcenter database that is created
during the installation of base Teamcenter version.
In the Indexing Engine User window, enter the user and password credentials of Solr indexing engine
which you entered during the installation of Active Workspace server extension feature or during Solr
creation.
In the next window Indexing Engine Configuration browse to the location where solr_schema_files are
available. Generally they can be found at TC_DATA\fts\ solr_schema_files and proceed.
If you want to run the indexing engine as a service, check the button install indexing engine as
a service
AWC Indexer settings check Standalone Indexing Environment and input the Teamcenter 4-tier URL
which will be configured in the generation of awc.war file to work on AWC client functionality.
The Indexer Type selection window is about the configuration of indexer to work for indexing the object
data or structure data. We can configure the indexer to work for both features for index the data as
required.
Object Data Indexer settings window is to input the object data extraction time for which the indexer will
index the data related to the object (created in between the Start time and end time). If no end time is
selected, the indexer will index up to the present system time.
Click on the start on the confirmation page to install the indexing engine feature for the active workspace.
For the Active workspace 2.4A and Teamcenter 10.1.4 version the JBoss version supported is jboss-as7.1.1.Final where you need to deploy the tc.ear and awc.war files. On a successful deploy we will be able
to login to the Teamcenter and AWC client functionality through browser.
Before logging into the active workspace client check for the following services working:
Pool manager is started or not. If pool manager is running as a service, start through services.msc or
Task manager else run it manually.
Active workspace indexing service Solr, TcFTSIndexer should be started and running successfully.
To deploy the Teamcenter EAR file and Active workspace WAR file using JBoss we need to copy the
files generated to the folder...\jboss-as-7.1.1.Final\standalone\deployments\ and running the command
standalone.bat of the jBoss.
The tc.ear file will present in the Teamcenter webtier folder which you created during the four tier
configuration of Teamcenter.\web_Tier\staging1\deployment\tc.ear.
Pool manager:
Start the pool manager service through services.msc or Task Manager\services option.
If service is not present, we need to run the service manually. We need to open the command prompt at
TC_ROOT\poolmanager and run mgrstartconfig.bat which will start the pool manager.
Solr, TcFTSIndexer:
To enable the indexing feature of Teamcenter we need to run the indexing services.
To run Solr, run the runSolr.bat opening the command prompt at TC_ROOT\ solr-4.4.0.
To
run
TcFTSIndexer,
run
runTcFTSIndexer.bat
opening
command
prompt
at
TC_ROOT\ TcFTSIndexer\bin.
Common Errors faced during Teamcenter patch update and AWC patch update:
Unable To Unzip XXX.Zip File:
The Teamcenter Environment Manager window will throw the error Unable to unzip bin.zip , Unable
to unzip fsc.zip , unable to unzip XXX.zip file
Cause:
Running Teamcenter services like FSC, Server Manager, process that is running due to the last login to the
Teamcenter are still holding the required files and the session is not ended fully.
Solution:
Stop all the Services related to Teamcenter if it is not specially notified by the TEM window to start or not
to stop a specific Teamcenter related service.
Check for running JAVA.exe process and stop the process through the TASK MANAGER.
Close the TAO window and any Teamcenter related applications if left opened after the last login.
Service failed to start. The service did not start due to a logon failure:
Cause:
The error is due to the invalid operating system credentials provided.
Solution:
Open the Start Menu, type Services.msc in the search box, press Enter.
under the Log On give the correct user credentials and start the service.
Click on Retry option on the TEM window and the installation will proceed.
Cause:
When the installation is proceeding and if the database related services are not started or stopped due to other
applications.
Oracle database: In case of oracle database, this error is observed when the oracle listener and oracle sid services
are not started or stopped.
Solution:
Need to run services manually through services.msc or through Task Manager.
JBoss 5.1.0 tc.ear deploy error:
Following process need to follow if faced deployment error with JBoss:
In JBOSS 5.1.0 do the following changes
Cause:
Patching active workspace on higher version of Teamcenter
The supported Teamcenter version for Active Workspace 2.4 A is 10.1.4. The installation will proceed
successfully if you try to patch Teamcenter version above 10.1.4 with active workspace 2.4 A.
Solution:
The supported version is needed to be patched. Check the required packages as mentioned and should proceed
further. If not the installation is need to be done from base version which is not optional.
AWS2
SOLR-4.4.0
TCFTSINDEXER
AWS2:
This folder is related to AWC client. Once the client is installed awc.war file will be generated in the
Out folder.
This awc.war is responsible for the client related functionality
Deploy awc.war using JBOSS or WEBSPHERE and after deploying you can be able to access the URL
and active work space screen appears in the browser.
New customization related projects can be created by using generatModule.cmd. This is simply
called as module generator .Some of the module generator types are as follows.
If any customized changes are made and if that changes need to be reflected in thin client then
gwtcompile.cmd command needs to be run so that all the changes will be updated in the awc.war
file and deploy the new war file in jboss then the changes will be reflected in the thinclient.
Build
All the java scripts related to client functionality will be present in this folder.
Out
Awc.war file will be generated in this out folder which is responsible for the architectural
information of thin client active workspace.
In the war folder tc.html will be having the information regarding the browser in which thin
client can be opened.
aws2\stage\out\war\thinclient contains all the information related to images of icons and basic
themes like light, dark which appears on thinclient.
All the .class files related to the new customization projects will be present JAVAC folder.
Repo
All the jar files related to Team center SOA like TcSoaClassification, TcSoaCommon,
TcSoaCore, TcSoaDocumentManagement, TcSoaImportExport, TcSoaVisualization will be
present in this folder.
Src
Any new customization projects related to GWT customization will be added into the source
folder.
Solr-4.4.0:
Solr is a database which is full text search engine that stores indexed team center data.
runSolr.bat:
To launch Jetty with the Solr WAR, just run the start.jar
In the batch file there is a command as shown below which will be used to run the start.jar.
This will start up the Jetty application server on port 8983, and use your terminal to
display the logging information from Solr.
You can see that the Solr is running by loading http://localhost:8983/solr/ in your web
browser. This is the main starting point for Administering Solr.
solrWinService.bat:
This batch file mainly used to specify whether to run Solr as a windows service or a manual
start.
Usage: solrWinService.bat -i or -c or r
Awc
SolrCloud:
SolrCloud is the name of a set of new distributed capabilities in Solr. Passing parameters to enable these
capabilities will enable you to set up a highly available, fault tolerant cluster of Solr servers. Use
SolrCloud when you want high scale, fault tolerant, distributed indexing and search capabilities.
Solr:
Collection:
On a single instance, Solr has something called a SolrCore that is essentially a single index. If you want
multiple indexes, you create multiple SolrCores. With SolrCloud, a single index can span multiple Solr
instances. This means that a single index can be made up of multiple SolrCores on different machines.
We call all of these SolrCores that make up one logical index a collection.
A collection is essentially a single index that spans many SolrCores, both for index scaling as well as
redundancy. If you wanted to move your 2 SolrCore Solr setup to SolrCloud, you would have 2
collections, each made up of multiple individual SolrCores.
Solr.xml:
This is the primary configuration file Solr looks for when starting. This file specifies the list of
"SolrCores" it should load, and high level configuration options that should be used for all SolrCores.
If no solr.xml file is found, then Solr assumes that there should be a single SolrCore named "collection1"
and that the "Instance Directory" for collection1 should be the same as the Solr Home Directory.
schema.xml:
This file defines the schema for the index including field type definitions with associated analyzers. It
contains details about the fields that you can include in your document and also describes how those
fields can be used when adding documents to the index or when querying those fields.
Zoo.cfg:
Solr embeds and uses Zookeeper as a repository for cluster configuration and coordination - think of it as
a distributed file system that contains information about all of the Solr servers.
contrib
Analysis-extras:
The International Components for Unicode (ICU) plug-in is an essential tool for dealing with
languages other than English.
Cognizant EMS - Internal
Analysis-extras folder includes integration with ICU for multilingual support, and analyzers for
Chinese and Polish.
Clustering:
The clustering plugin adds support for running multiple redundant servers together in a cluster b y running
in a cluster, you can distribute the connection load among several server
Extraction:
Apache Solr Extraction provides a means for extracting and indexing content contained in "rich"
documents, such as Microsoft Word, Adobe PDF, etc.
Langid:
Its purpose is to identify language from documents and tag the document with language code.
The module can optionally map field names to their language specific counterpart
E.g. if the input is "title" and language is detected as "en", map to "title_en".
dist
It offers a java interface to add, update, and query the solr index.
TcFTSIndexer:
It is a four tier SOA client used to export Team center data for importing into Solr database. This server
manages overall indexing processes.
bin
Tcenv:
In the tcenv folder there will be a batcfh file which will be pointing to the tc_profilevars.
Encryptpass.bat:
If a new user is needed to run TcFTSIndexer , create an encrypted password file by setting an
environment variable, within the console, to the password value.
E.g.: set mytcenv=mytcenv
Then run the encryptPass.bat utility with the -tc argument specifying the Environment variable name
created.
E.g.: encryptPass -tc password.
runTCFTSIndexer.bat:
runTcFTSIndexer -task=type:action [additional-arguments]
-task=structure:test
Performs basic tests, such as for Teamcenter logon, FMS connectivity, verifying or downloading
of transform files, Solr schema, and so on. This command must be run exclusively; it cannot be
run concurrently with other exclusive actions.
-task=structure:show
-task=structure:sync
Performs normal synchronization and delete actions for all product configurations. This command
must be run exclusively. This command queues up all the synchronization actions for the product
configurations. The queued synchronization actions are processed as resource permits.
-task=structure:syncone product-config-UID
Performs normal synchronization and delete actions for a single product configuration UID. This
command must be run exclusively. This command queues up all the synchronization actions
Cognizant EMS - Internal
for the product configurations. The queued synchronization actions are processed as resource
permits.
-task=structure:recoverfailures
Changes all product configurations with failed states to the ready to Index state or the
marked for Deletion state.
-task=structure:resetall
Downloads the latest transform and schema files, resets all active product configurations to the
Ready To Index state, and resets all deleted product configurations to the Marked For Deletion
state. This command must be run exclusively.
-task=structure:reset product-config-UID
Resets the given PRODUCT_CONFIG_UID setting to the Ready To Index or Marked For Deletion
state. This command must be run exclusively.
conf
All the language related property files will be present in configuration folder.
Configuration of AWC:
Once AWC features are installed, starting all the required services we can able to login to AWC client
through a web browser.
To start AWC client we need to check the following services.
Run cd %TC_ROOT%/pool_manager.
Pre-check that environment variable like TC_ROOT and TC_DATA are pointing to the correct installation
path
Run cd jboss_home/bin
Proper JDK version is needed to run the JBoss, check JDK >1.7 for AWC (browser based client
architecture).
Start Solr
For the AWC indexing feature to work we need SOLR running in the background. We need to run the
Solr service manually if it is not installed as a service.
To start Solr Manually,
Run cd %TC_ROOT%/solr-4.4.0
Start TcFTSIndexer
Search feature of AWC is enabled by proper object data indexing which is achieved through the TcFTS
indexer service. If indexing is not properly done, the search feature will not work. The output from AWC
client will be.
Run cd %TC_ROOT%/TcFTSindexer/bin.
Next Run the command runTcFTSIndexer task=objdata:index to index the object data for
the first time.
On successful completion of the indexing process, the command prompt will show the below status.
To synchronize the object data in specific interval of time we need to run the command
runTcFTSIndexer task=objdata:sync interval=25 which synchronize the data for every 25
seconds.
While running the TcFTSIndexer again ti index we need to run the reindex command
runTcFTSIndexer task=objdata:reindex instead of index command in the step 4which index
the data that is not indexed instaed of indexing from the first.
Ex:
.Open the active workspace client on a web browser and search for a key word that is available in
any dataset attached. Now you will be able to view all the datasets that contain the search word in
the search results pane of workspace client.