0% found this document useful (0 votes)
2K views74 pages

WWGMInstallationGuide 13-0-0 1

The Windchill Workgroup Manager Installation Guide provides detailed instructions for installing and configuring the Windchill Workgroup Manager software, including prerequisites and steps for both standard and silent installations. It covers registration of authoring applications, server registration, and the preparation of abstraction libraries for CATIA V5 and 3DEXPERIENCE. The guide also emphasizes compliance with copyright and licensing agreements for PTC software products.

Uploaded by

pramit008
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
2K views74 pages

WWGMInstallationGuide 13-0-0 1

The Windchill Workgroup Manager Installation Guide provides detailed instructions for installing and configuring the Windchill Workgroup Manager software, including prerequisites and steps for both standard and silent installations. It covers registration of authoring applications, server registration, and the preparation of abstraction libraries for CATIA V5 and 3DEXPERIENCE. The guide also emphasizes compliance with copyright and licensing agreements for PTC software products.

Uploaded by

pramit008
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 74

Windchill Workgroup

Manager™ 13.0.0.1
Installation Guide
Copyright © 2023 PTC Inc. and/or Its Subsidiary Companies. All Rights
Reserved.
Copyright for PTC software products is with PTC Inc. and its subsidiary
companies (collectively “PTC”), and their respective licensors. This software is
provided under written license or other agreement, contains valuable trade secrets
and proprietary information, and is protected by the copyright laws of the United
States and other countries. It may not be copied or distributed in any form or
medium, disclosed to third parties, or used in any manner not provided for in the
applicable agreement except with written prior approval from PTC. More
information regarding third party copyrights and trademarks and a list of PTC’s
registered copyrights, trademarks, and patents can be viewed here: https://www.
ptc.com/support/go/copyright-and-trademarks
User and training guides and related documentation from PTC are also subject to
the copyright laws of the United States and other countries and are provided under
a license agreement that restricts copying, disclosure, and use of such
documentation. PTC hereby grants to the licensed software user the right to make
copies of product documentation and guides in printed form, but only for internal/
personal use and in accordance with the license agreement under which the
applicable software is licensed. Any copy made shall include the PTC copyright
notice and any other proprietary notice provided by PTC. Note that training
materials may not be copied without the express written consent of PTC. This
documentation may not be disclosed, transferred, modified, or reduced to any
form, including electronic media, or transmitted or made publicly available by any
means without the prior written consent of PTC and no authorization is granted to
make copies for such purposes.
UNITED STATES GOVERNMENT RIGHTS
PTC software products and software documentation are “commercial items” as
that term is defined at 48 C.F.R. 2.101. Pursuant to Federal Acquisition Regulation
(FAR) 12.212 (a)-(b) (Computer Software) (MAY 2014) for civilian agencies or
the Defense Federal Acquisition Regulation Supplement (DFARS) at 227.7202-1
(a) (Policy) and 227.7202-3 (a) (Rights in commercial computer software or
commercial computer software documentation) (FEB 2014) for the Department of
Defense, PTC software products and software documentation are provided to the
U.S. Government under the PTC commercial license agreement. Use, duplication
or disclosure by the U.S. Government is subject solely to the terms and conditions
set forth in the applicable PTC software license agreement.
PTC Inc., 121 Seaport Blvd, Boston, MA 02210 USA

2
Contents

About This Guide ........................................................................................................4


Installing Windchill Workgroup Manager........................................................................6
Adding System Environment Variables........................................................................21
Registering your Authoring Application with PTC Windchill Workgroup Manager ............23
Registering the Windchill Server.................................................................................27
Creating a Redistributable PTC Windchill Workgroup Manager Client Installer with
Silent Installation....................................................................................................31
Uninstalling PTC Windchill Workgroup Manager ..........................................................37
CATIA V5 Preparation: Build and Place the Abstraction Library .....................................42
Abstraction Library Prerequisites .........................................................................43
Building and Placing the Abstraction Library .........................................................54
CATIA 3DEXPERIENCE Preparation: Build and Place the Abstraction Library and
Install PTC Windchill Workgroup Manager ENOVIA 3DEXPERIENCE
Adapter .................................................................................................................58
Abstraction Library Prerequisites .........................................................................60
Building and Placing the Abstraction Library .........................................................61
Installing the Windchill Workgroup Manager ENOVIA 3DEXPERIENCE
Adapter ..........................................................................................................67

3
About This Guide

The Windchill Workgroup Manager Installation Guide provides instructions on


installing and getting Windchill Workgroup Manager up and running.

4 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


Overview
To make it easier to locate information topics covered in this guide include:
• Installing Windchill Workgroup Manager on page 6
• Registering your Authoring Application with Windchill Workgroup Manager
on page 23
• Registering the Windchill Server on page 27
• Creating a Redistributable Windchill Workgroup Manager Client Installer with
Silent Installation on page 31
• Uninstalling Windchill Workgroup Manager on page 37
• CATIA V5 Preparation: Build and Place the Abstraction Library on page 42
• CATIA 3DEXPERIENCE Preparation: Build and Place the Abstraction
Library on page 58
Examples in this guide referencing third-party products are intended for
illustrative purposes only. For additional information about third-party products,
contact the individual product vendors.
Some code examples in this guide have been reformatted for presentation
purposes and, therefore, may contain hidden editing characters (such as tabs and
end-of-line characters) and extraneous spaces. If you cut and paste code from this
manual, check for these characters and remove them before attempting to use the
example in your application.

5
1
Installing Windchill Workgroup
Manager
This topic describes the process for installing and getting Windchill Workgroup
Manager operational on a local computer.
The topic is split into the following sections:
• The Installation Procedure on page 9 section describes the process of installing
Windchill Workgroup Manager.
• The Updating the Windchill Workgroup Manager Installation on page 16
section describes the process of adding CAD application versions to the
Windchill Workgroup Manager installation with an example.

Prerequisite
• You must have the Microsoft Universal C Runtime in Windows installed on
the local or network computer where you want to install Windchill Workgroup
Manager.
If you do not have the required Windows update, the following steps describe
what occurs and what action you need to take:
1. The message “The Windows update for Universal C Runtime is required in
order for the installation to continue.” appears during installation.
2. There is an automatic exit from the installer.
3. Visit the Microsoft web page Update for Universal C Runtime in
Windows.
4. Install the required update.

6 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


After you complete the update, you can install Windchill Workgroup
Manager.
• For Windchill Workgroup Manager for CATIA V5 only, you must build and
place the CATIA V5 abstraction library. This task must be completed before
Windchill Workgroup Manager is installed, updated or upgraded. See CATIA
V5 Preparation: Build and Place the Abstraction Library on page 42 for
instructions on how to do this.
If you do not use Windchill Workgroup Manager for CATIA V5, skip this
section.
• For Windchill Workgroup Manager for CATIA 3DEXPERIENCE, you must
build and place the CATIA 3DEXPERIENCE abstraction library. You must
perform this task before installing, updating or upgrading the Windchill
Workgroup Manager. See CATIA 3DEXPERIENCE Preparation: Build and
Place the Abstraction Library and Install PTC Windchill Workgroup Manager
ENOVIA 3DEXPERIENCE Adapter on page 58 for instructions on how to do
this.

Deploying Custom wgmclient.ini During Windchill Workgroup


Manager Installation
Customizing wgmclient.ini during the Windchill Workgroup Manager
installation is a good way to set selective preferences for multiple installations.
You can thus avoid the hassle of asking individual users to set those selective
preferences. For example, an administrator can set or change a preference in the
wgmclient.ini file, deploy this custom wgmclient.ini file, and then
perform silent installation on page 31 for 100 machines.
To deploy a custom wgmclient.ini file, perform the following steps:

Note
In the following procedure:
• <root directory>: Directory or folder in which, the installation files are
extracted from the Windchill Workgroup Manager installation CD; for
example, C:\SW-cd-images\MED-60707-CD-121_12-1-2-1_
Windchill-Workgroup-Managers.
• <Installation directory>: Directory or folder in which Windchill
Workgroup Manager is installed; for example, C:\Program Files\PTC\
wgm.

Installing Windchill Workgroup Manager 7


1. Copy the custom wgmclient.ini file to the root directory. For example,
copy the custom wgmclient.ini file to C:\SW-cd-images\MED-
60707-CD-121_12-1-2-1_Windchill-Workgroup-Managers.
2. Open the <root directory>\pim\xml\uwgm.xml file and edit the
following:
a. Ensure that the <root directory> and the <Installation
directory> (directory or folder where Windchill Workgroup Manager
is installed) point to the correct location.
Use the <Property> tag to define the alias of the <root
directory> and the <Installation directory> location.
b. Add a custom action under the DISTRIBUTION node as shown below.
<CUSTOM_ACTION dest="[Installation directory]/
wgmclient.ini" dll="" file="[root directory]/
wgmclient.ini" name="CopyFileToDest" when=
"PostCopy"/>
3. Install Windchill Workgroup Manager in the UI mode on page 9 or silent
mode on page 31.
4. After the Windchill Workgroup Manager installation verify if the
wgmclient.ini file is copied from the <root directory>.

8 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


Installation Procedure
Installing Windchill Workgroup Manager with the WGM Installation Assistant is
quick and easy.

Note
In Windchill Workgroup Manager for CATIA V5 only, ensure that all
prerequisites are executed before installing, updating or upgrading the
Windchill Workgroup Manager. See CATIA V5 Preparation: Build and Place
the Abstraction Library on page 42 for instructions on how to do this.

1. Start the WGM Installation Assistant by launching setup.exe from the root
directory of either the DVD or the downloaded installation files.

Note
To start the WGM Installation Assistant on Microsoft Windows, you must
have elevated privileges assigned to you by an administrator.

Installing Windchill Workgroup Manager 9


2. Windows launches the Installation Assistant, which defaults to Install new
software. Click Next. Accept the license agreement and click Next.

10 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


3. The Application Selection screen lets you define the install location, along with
which applications you want to include in your installation.

• The installation path defaults to C: ▶ Program Files ▶ PTC. You can modify
this path by clicking the down arrow and entering your desired location.
Alternatively, you can also type the desired path and press Enter on the
keyboard.
• The list of available options consists of Windchill Workgroup Manager,
which installs the Windchill Workgroup Manager, ECAD Plugins, MCAD
Plugins, Other Plugins, and Utilities.
• The ECAD plugin is listed as shown in the preceding image.
• All MCAD plugins are listed as shown in the preceding image. Windchill
File System is listed under Utilities.

Installing Windchill Workgroup Manager 11


Note
○ The Windchill Workgroup Manager Toolkit is optional, you can select
it at Application Selection screen. After selecting this option, Windchill
Workgroup Manager Toolkit is installed under Windchill Workgroup
Manager installation point.
○ Windchill Workgroup Manager client and Creo Platform Services are
required applications and will be installed automatically.
○ Although it is an optional install, Windchill File System is mandatory
for Windchill Workgroup Manager for AutoCAD, Windchill
Workgroup Manager for Autodesk Inventor, Windchill Workgroup
Manager for NX, and Windchill Workgroup Manager for
SOLIDWORKS, and must be installed with these products.
○ When either NX, AutoCAD, Autodesk Inventor, or SOLIDWORKS is
selected, Windchill File System is automatically selected for
installation.
○ A new Creo Platform Services version is available when updating or
upgrading theWindchill Workgroup Manager. This new Creo Platform
Services version is installed without uninstalling the existing one. By
default the new Creo Platform Services version is used when the
Windchill Workgroup Manager is launched. You can uninstall the old
Creo Platform Services version manually.
○ Diagnostic Tools is a mandatory component, and it is always installed
with the Windchill Workgroup Manager client. The Diagnostic Tools is
used to collect client data about the CAD integration with Windchill.
Windchill administrator can control whether to collect data from all
Windchill Workgroup Manager clients that are connected to the
Windchill server.

No applications are selected by default. To select individual CAD


tools within application categories, select the respective check box. Select
the required MCAD Plugins and click Next.
4. In Customize Selected Applications screen, select an application and select
application versions you want to use on the Application Features window.

Note
If you do not select any application version on the Customize Selected
Applications screen at this step, the following warning appears when you
click Next.

12 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


5. You can choose to install as many or as few third-party applications as are
suitable for your site. In this example, the installation will consist of CATIA V5–
6R2019 and SOLIDWORKS 2019 selected as shown below. When you have
made your choices, click Install.

Installing Windchill Workgroup Manager 13


6. A complete installation may take several minutes. During the installation,
colored progress bars track each application’s installation progress. Solid bars
and “100%” indicate that the installation is complete. Click Finish to exit the
WGM Installation Assistant.

Caution
During installation, you must not close the WGM Installation Assistant
window.

14 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


In some cases, a restart may be required to successfully complete the
installation. You can click the information button to view the message as
shown below.

To open the Windchill Workgroup Manager Installation Guide, click ‘?’ on the top
right corner of WGM Installation Assistant window.

Installing Windchill Workgroup Manager 15


Updating the Windchill Workgroup Manager Installation
If you have installed Windchill Workgroup Manager with certain CAD application
versions, you can modify the current installation without uninstalling and re-
installing Windchill Workgroup Manager.

Note
In Windchill Workgroup Manager for CATIA V5 only, ensure that all
prerequisites are executed before installing, updating or upgrading the
Windchill Workgroup Manager. See CATIA V5 Preparation: Build and Place
the Abstraction Library on page 42 for instructions on how to do this.

For example, consider the scenario where Windchill Workgroup Manager is


installed with CATIA V5–6R2018. Windchill Workgroup Manager is installed
without the Windchill File System as CATIA V5 does not require the Windchill
File System. Modify this installation to add:
• CATIA V5–6R2019
• NX 1872
To update the Windchill Workgroup Manager installation,
1. Start the WGM Installation Assistant by launching setup.exe from the root
directory of either the DVD or the downloaded installation files.
2. Windows launches the Installation Assistant, which defaults to Install new
software. Click Next. Accept the license agreement and click Next.
3. From the Module column, select NX.

Note
CATIA V5 is already selected because CATIA V5 plugin is already
installed.

16 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


The Customize Selected Application window appears.
4. Select CATIA V5–6R2019 and NX 1872 Series.

Installing Windchill Workgroup Manager 17


5. On the WGM Installation Assistant window, click Install.
6. A complete installation may take several minutes. During the installation,
colored progress bars track each application’s installation progress. Solid bars
and “100%” indicate that the installation is complete. Click Finish to exit the
WGM Installation Assistant.

Deleting Windchill Workgroup Manager related Folder Contents


After you have upgraded the Windchill Workgroup Manager client, you should
delete the following Windchill Workgroup Manager files and folder contents.
1. The Cache directory <PTC_WF_ROOT>, if set; or The .wf and .wwgm
directories and files that are created under the Application registry location,
<APPDATA>\PTC\ProENGINEER\Wildfire.

Note
The .wf and .wwgm directories are hidden.

2. The Windchill File System Cache directory <PTC_WFS_ROOT>, if set or, The
.wwgm directory that is created under <User Profile Location>.

Post-installation notes
• You can set the value of System Environment Variable PIM_LOG_ENV, in
which you can specify the location of the following installer logs:

18 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


○ pim_installmgr.log
○ pim_creoagent.msi.log
○ pim_PtcVfs64.msi.log or pim_PtcVfs32.msi.log
The default locations for the log files are listed in the following table:
Log File Name Default Location
Windchill pim_installmgr.log Windows Explorer, My
Workgroup Documents folder
Manager Note
installation You can share this log file
log with PTC for any further
analysis of issues related to
the WGM Installation
Assistant.
Creo pim_ Windows Explorer, My
Platform creoagent.msi.log Documents folder
Services
installation
log
Windchill pim_PtcVfs64.msi.log Windows Explorer, My
File System or Documents folder
installation pim_PtcVfs32.msi.log
log

Installing Windchill Workgroup Manager 19


Auto autoreg_bat.log <WGM installation
registry log uwgm_autoreg.log path>\install

uwgm_autoreg.out
Diagnostic pim_qualityagent_ Windows Explorer, My
Tools 64.msi.log Documents folder
installation
logs
• The installer also creates a System Environment Variable, PIM_DEBUG=1,
which contains additional installation logging information that can be used for
troubleshooting.
• During installation, the shortcut icon shown below is placed on your Windows
desktop and on the Windows Start menu. Click this icon to launch Windchill
Workgroup Manager.

Once your installation is complete, you must register your CAD application with
Windchill Workgroup Manager and connect the Windchill Workgroup Manager
client with your Windchill servers. These actions are covered in the next two
chapters.

Installing and Running Multiple Versions of Windchill Workgroup


Manager Client on the Same Machine
It is possible to install and run multiple different versions of the Windchill
Workgroup Manager client on the same machine. For detailed instructions on how
to do this, consult the PTC knowledge base article CS212589, How to install and
run multiple, different versions of the Windchill Workgroup Manager client on the
same machine.

20 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


2
Adding System Environment
Variables
This section describes some of the environment variables that can be set on your
local computer if you want to specify specific locations to store your Windchill
Workgroup Manager data. The table below lists these environment variables and
their descriptions.

Note
If you do not set these variables, then during runtime, files will be created at
the locations specified in the “Default Location” column.

Environment Description Default Location


Variable
PTC_WF_ROOT Defines the cache directory
<APPDATA>\PTC
\ProENGINEER\
Wildfire\.wwgm
PTC_WFS_ROOT Defines the Windchill File %HOMEDRIVE%\
System cache directory %HOMEPATH%\.wwgm\
.wfs
PTC_WFS_ Defines the Windchill Folder %USERPROFILE%\
DEFAULT_ Location to a local folder. Documents\PTC Places
LOCATION

21
Environment Description Default Location
Variable

Tip
• Set this environment
variable before installing
Windchill Workgroup
Manager.
• Do not use a shared
folder for the default
location.
PTC_WLD_ROOT Defines the Workspace Local %HOMEDRIVE%\
Directory %HOMEPATH%\.wwgm\
.ws
PTC_WGM_ Defines the application <APPDATA>\PTC\
ROOT registry location WindchillWorkgroup
Manager
PTC_WGM_ Defines the Windchill <USERPROFILE>
STARTUP_DIR Workgroup Manager startup
directory path

22 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


3
Registering your Authoring
Application with PTC Windchill
Workgroup Manager
After you have installed and configured Windchill Workgroup Manager, you must
register your CAD application with Windchill Workgroup Manager.

Caution
If you do not register your CAD application, your files in Windchill will not
be listed or accessible in Windchill Workgroup Manager.

When you first initialize Windchill Workgroup Manager, no applications are


registered, and the client automatically launches the Application Management
utility, as shown below. You are prompted to choose from a list of applications

23
based on what you selected during installation. The application must be installed
on your client server in order to register it with the Windchill Workgroup
Manager.

The operating system-specific components for integration with all supported


applications and their versions are automatically installed with the Windchill
Workgroup Manager. Your CAD application must be registered with the
Windchill Workgroup Manager client before it can be used with Windchill
Workgroup Manager. It is possible to register several different applications at the
same time, but only one version of each at a time.

Note
Windchill Workgroup Manager for NX and Windchill Workgroup Manager for
CATIA V5 allow registration of multiple versions of the CAD Applications.

1. Launch Windchill Workgroup Manager to display the screen shown above.


(You can also access the Application Management utility by selecting Tools ▶
Application Management.) The Application Management utility lists all of the
applications that your system administrator has made available. Following the

24 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


example shown in the previous chapter, CATIA V5–6R2015, NX10, and
SolidWorks 2015 are available to be registered with the Windchill Workgroup
Manager client.
2. If the application you want to register with Windchill Workgroup Manager is
listed:
a. Select the application — in this case, CATIA V5–6R2015 — and click
Register.
b. Once the application has been located, the Register an Authoring
Application window Register button becomes gray. Click Close.
3. If the application you want to register is not automatically found on your hard
drive, the following message appears as shown below: “Automatic registration
failed. Please register the authoring application manually.” Click OK .

4. From the Register an Authoring Application window, select CATIA V5–6R2015


and click Register Manually....
5. Click Find to signal Windchill Workgroup Manager that the application will be
registered manually.
6. Enter the Startup Command of your CAD application, along with its Install
Directory. Click the folder icon to browse to each of these locations. Click
Reset to remove an incorrect entry. When you are finished, click OK.

Registering your Authoring Application with PTC Windchill Workgroup Manager 25


7. Applications registered with Windchill Workgroup Manager now appear in the
Application Management window. Click on CATIA V5–6R2015 to verify it with
Windchill Workgroup Manager.
8. The verification credentials for the application appear under the Description in
the Application Management window. Click Close when you are finished.

Registering Multiple Versions of CATIA V5


You can register any valid installation of CATIA V5 without having to unregister
other versions. You can register up to two versions of CATIA V5, but only one
installation of each release. For example, you can register one version each of
CATIA V5-6R2012 and CATIA V5-6R2013.

The client preference for opening a CATIA V5 document is based on the


“authoring application version selection on open” preference in the wgmclient.ini
file:
• If set to true, the selection window always launches.
• If set to false, the selection window may or may not open, based on the “last
saved ” related rules. If multiple options are available to open the selected
files, or if none of the files can be opened by the registered versions, the
window opens. Otherwise, no window is shown and CATIA V5 opens the
selected files.
Windchill does not support multiple sessions of CATIA V5 running at the same
time. Running multiple simultaneous sessions results in error messages in both
CATIA V5 and the Windchill Workgroup Manager client.

26 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


4
Registering the Windchill Server
This section explains how to connect your Windchill Workgroup Manager client
with your Windchill servers, and how to use the Server Management utility to
create and remove Windchill server connections.
In order to work in Windchill from your CAD application, you must first establish
a connection by registering a Windchill server. This is done from the Tools menu
in Windchill Workgroup Manager. Once accomplished, you can select a
workspace and start working with your CAD data.

Caution
If you do not register a Windchill server, you cannot connect to Windchill
from your CAD application.

Note
When managing servers and workspaces, Windchill automatically displays all
virtual workspaces for your site or organization in the Server Management
utility. To learn more about virtual workspaces, see “Displaying or Hiding
Virtual Workspaces in the Server Management Utility” in the Windchill Help
Center.

Use the following steps to register a Windchill server.

27
1. From an active Windchill Workgroup Manager session, click Tools ▶ Server
Management. The Server Management window opens.

28 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


2. Click Server ▶ Register New Server. The Register New Server window opens.

3. Specify the server name as you want it to appear in the Name field.

Note
It is recommended that all users in a company register the server using the
same name.

4. Enter the Windchill server URL in the Location field. (You can get this
information from your Windchill administrator.)

Registering the Windchill Server 29


5. Click Check to validate that the server location information is complete and
valid.
6. Enter your user name and password in the Authentication window.
7. Select the workspace name from the list of workspaces that you want to be
your active workspace.

Note
A default workspace already exists for each Windchill product that you
have access to. If you want to create new, additional workspaces, click
Workspace ▶ New to create a new one. This option is only available when
the server is registered and has been given primary importance.

Note
By default, a new workspace becomes the active workspace on the primary
server. If you already have an active workspace and you create a new
workspace, the status of the currently-active workspace changes and the
open files from this workspace are erased from your CAD application.

8. Click Close.
9. Click Server ▶ Set as Primary Server. This enables your CAD application to
connect to the specified Windchill server and use the selected workspace.

Note
Once registered, the server and workspace are listed in the Folder
Navigator.

Tip
If only one server is registered, it automatically becomes the primary server. If
you have registered multiple servers, you must select one server and mark it as
primary.

For more information about server management, see “Using the Server
Management Utility” in the Windchill Help Center.

30 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


5
Creating a Redistributable PTC
Windchill Workgroup Manager
Client Installer with Silent
Installation
Guidelines and Advantages of a Silent Installation
The Windchill Workgroup Manager installed for the first time using WGM
Installation Assistant can be reinstalled during subsequent installation sessions in
silent (nongraphics and noninteractive) mode. The silent installation process with
command-line arguments uses an XML file with application-specific
configuration settings. An independent XML file is stored for each of the
Windchill Workgroup Managers you have installed. To perform a silent
installation, provide the path to the corresponding XML file as an argument when
running setup.exe from the DVD root directory at the command prompt. See
“Command Syntax for a Silent Installation” below for more information.
Remember the following points for a silent installation:
• You cannot use the independent XML file of an earlier release or a
maintenance release for a silent installation in the following cases:
○ The major release to be installed and the release of the application for
generating the XML file are not the same.
○ The selected Windchill Workgroup Manager application, language,
platform, or package is not on the DVD/download.

31
○ The prerequisites for installing Windchill Workgroup Manager application
are not met.
• You must run the WGM Installation Assistant only from the DVD or
download when installing Windchill Workgroup Manager for the first time.
• You cannot copy an existing installation while performing a silent installation.

Note
If you change the installation folder structure of an installed Windchill
Workgroup Manager CAD application, uninstall may not work properly for
that installation of the Windchill Workgroup Manager CAD application.

Some of the advantages of a silent installation are:


• You can efficiently mass-deploy Windchill Workgroup Manager across a large
enterprise.
• You can source all the configuration settings, such as installation location and
startup commands, for installing Windchill Workgroup Manager from an XML
file.

Creating the Redistributable Client Installer


You create a redistributable Windchill Workgroup Manager Client installer with
silent installation using command-line arguments. In this way, Windchill
Workgroup Manager client software can be downloaded for redistribution rather
than installed from the server.
Use the following steps to generate a Windchill Workgroup Manager installation
image with pre-configured installation inputs that can be used to install the
Windchill Workgroup Manager silently in the background, without any user input.
This image can be distributed on a network drive for users to install, or used in
conjunction with software deployment tools to roll out Windchill Workgroup
Manager to multiple clients.
1. Locate the p.xml files from the pre-installed Windchill Workgroup Manager
loadpoint, such as C:\Program Files\PTC\wgm. For example, the
mcad_swx.p.xml file is saved in wgm/components/mcad/swx/bin/
pim/xml.

Note
p.xml files are created by the installer based on the information you
entered during the Customize ... step of the installation.

32 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


2. Copy the p.xml files to the installer. The following table is a list of p.xml
files and their installation criteria.
File Name Installation criteria
uwgm.p.xml Required
mcad_autocad.p.xml Required
mcad_cadds.p.xml Required
mcad_catia3dx.p.xml Required
mcad_catiav5.p.xml Required
mcad_ccd.p.xml Required
mcad_ccm.p.xml Required
mcad_inventor.p.xml Required
mcad_nx.p.xml Required
mcad_swx.p.xml Required
xcad_mathcad.p.xml Required

Caution
Do not use p.xml files captured during a silent installation for performing
the downgrade to an earlier version. For example, if you use p.xml from
Windchill Workgroup Manager M020 installation to downgrade to M010,
the installation will continue but this is strictly not recommended.

Creating a Redistributable PTC Windchill Workgroup Manager Client Installer with


Silent Installation 33
Note
The *.p.xml file is not generated for Creo Platform Services and
Windchill File System. These modules are automatically installed as a pre-
requisite while installing the Windchill Workgroup Manager client. Also,
the installation of these modules are recorded in adapter xml or
uwgm.p.xml.

3. Open a command prompt and navigate to the Installer loadpoint.


4. Create a batch file (setup.bat) at the installer loadpoint.

Note
The setup.bat batch file is not available by default. Using
setup.bat, you can silently install Windchill Workgroup Manager on
multiple machines (for example, 100 machines) simultaneously.

5. To install Workgroup Manager and Diagnostic Tools, perform these steps:


a. For installing Workgroup Manager, set the system environment variable
PIM_LOG_ENV=<path> and include -xml pim\xml\
qualityagent.xml in the installation command as shown in the
following example:
setup.exe -xml uwgm.p.xml -xml ecad_creo_sch.p.xml
-xml xcad_mathcad.p.xml -xml mcad_swx.p.xml -xml pim\
xml\qualityagent.xml PIM_DEBUG=1 PIM_LOG_ENV="c:\

34 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


install\MED-60707-CD-121_12-1-2-0_Windchill-
Workgroup-Managers" -destination "C:\Program Files\
PTC"
b. To silently install the Diagnostic Tools (Quality Agent), you can either
perform of the following:
• Copy the qualityagent.xml file found at <installation
media>:\pim\xml\ to your local computer. Edit the ‘install=’
attribute of the MSI entry to be ‘Y’ and then perform the silent
installation at the command prompt.
• Alternatively, perform the silent installation of PTC Diagnostic Tools
using the following command at the command prompt:
msiexec.exe /qn /norestart /I "<Installation_
Files>\msi\qualityagent_64.msi" /lv "c:\logs\
pim_qualityagent_64.msi.log"
6. Put the shared CD-image folder in your shared network folder, where the
client software can be downloaded for redistribution.
You can set the value of System Environment Variable PIM_LOG_ENV, in which
you can specify the location of the following installer logs:
• pim_installmgr.log
• pim_creoagent.msi.log
• pim_creoagent_uninstall.msi.log
• pim_PtcVfs64.msi.log or pim_PtcVfs32.msi.log
The default locations for the log files are listed in the following table:
Log File Name Default Location
Windchill pim_installmgr.log Windows Explorer, My
Workgroup Documents folder
Note
Manager
installation You can share this log file
log with PTC for any further
analysis of issues related to
the WGM Installation
Assistant.
Creo pim_creoagent.msi.log Windows Explorer, My
Platform Documents folder
Services
installation
log

Creating a Redistributable PTC Windchill Workgroup Manager Client Installer with


Silent Installation 35
Windchill pim_PtcVfs64.msi.log or Windows Explorer, My
File System pim_PtcVfs32.msi.log Documents folder
installation
log
Auto registry autoreg_bat.log <WGM installation
log uwgm_autoreg.log path>\install
uwgm_autoreg.out

Similarly, the installer also creates a System Environment Variable, PIM_DEBUG=


1, which contains additional installation logging information that can be used for
troubleshooting.

Command Syntax for a Silent Installation


To perform a silent installation of Windchill Workgroup Manager, open a
command shell, and run setup.exe from the root directory of the DVD as
follows:
<dvd>:\setup.exe –xml “<path to the .xml file stored in a
temporary location>”
... where dvd is the DVD drive letter or the location of the downloaded DVD
image.
The arguments you can use with setup.exe during a silent installation are
shown in the following table:
Command Syntax Description
setup.exe <no arguments> Runs the installer interactively.
setup.exe –help Displays all the arguments to use with
the installer.
setup.exe –v Displays the version of the installer.
setup.exe –xml <file1> –xml Performs a silent installation as per the
<file2>.... directives in the specified XML files.
setup.exe –xml [–destination [Optional] Overrides the destination
<directory>] specified in the XML file
setup.exe –progressbar –xml [Optional] Displays the indicative
<file1> progress bar during the installation
using the XML file.
setup.exe –xmlall <path of [Optional] Displays the indicative
the folder where all *.p.xmls directory where all the required xml
files are saved> files are saved. It is useful when
installing multiple adapters.

36 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


6
Uninstalling PTC Windchill
Workgroup Manager
To uninstall Windchill Workgroup Manager:
• On Windows Operating System, navigate to Start ▶ Control Panel ▶ Programs
and Features. Scroll down the list of programs and double-click on PTC
Windchill Workgroup Manager Version. The Uninstall PTC Windchill Workgroup
Manager window appears.

37
Tip
For Windows 10 Operating System, it is recommended to run the
Uninstall_all_utilities.bat file with Run as administrator
option to uninstall the PTC Windchill File System.

• Select the desired option from the Uninstall Options section. If you want to
uninstall all applications like Creo Agent, Windchill File System and
Windchill Workgroup Manager client then select the Uninstall all applications
and Utilities in this version option.

Note
You can uninstall Creo Platform Services only after you uninstall
Windchill Workgroup Manager.

38 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


• Registered CAD Applications are removed from the Application Manager
once the uninstall is complete. If you want to unregister your Windchill
servers, click the check box. Read the NOTE, and if needed, perform any
applicable actions. Then click Uninstall.

Uninstalling PTC Windchill Workgroup Manager 39


• A progress bar tracks the uninstall progress. When the bar is solid blue, the
uninstall is complete. Click Close.

Note
You might get a ‘Windows Explorer Restart’ dialog box as seen in the
following image.

When you click the OK button, the uninstallation process is completed, but the
uwgmwfspropext.dll file remains in the installation directory location.
You may have to delete this file manually. Also, when you click the Cancel
button, the uninstallation process is completed, but the *.dll file remains in
40 the installation directory location.Windchill
You may have toManager
Workgroup delete™ these
13.0.0.1files manually.
Installation Guide
Silent Uninstallation
To uninstall Windchill Workgroup Manager silently, execute the file Silent_
Group_Uninstall.bat, located in the InstallManager directory which
will silently uninstall Creo Agent and Windchill File System as well as Windchill
Workgroup Manager client.
If you use the Silent_Group_Uninstall.bat file to uninstall Windchill
Workgroup Manager while the Windchill Workgroup Manager client is running in
the background, all files are not uninstalled and no error is reported, however an
error is reported when the Silent_Group_Uninstall.bat file is not used
for unistallation.

Deleting Windchill Workgroup Manager related Folder Contents


After you have uninstalled the Windchill Workgroup Manager client, you should
delete the following Windchill Workgroup Manager files and folder contents.
1. The Cache directory <PTC_WF_ROOT>, if set; or The .wf and .wwgm
directories and files that are created under the Application registry location,
<APPDATA>\PTC\ProENGINEER\Wildfire.

Note
The .wf and .wwgm directories are hidden.

2. The Windchill File System Cache directory <PTC_WFS_ROOT>, if set or, The
.wwgm directory that is created under <User Profile Location>.
3. The Application registry location <APPDATA>\PTC\Windchill
Workgroup Manager, or, The <PTC_WGM_ROOT>, if set.

Setting Windchill File System Default Location


During first application registration of Windchill File System (WFS) supported
CAD tool with Windchill Workgroup Manager, default WFS folder location is set
to <%USERPROFILE%\Documents\PTC Places>. To override the default
setting during install, set environment PTC_WFS_DEFAULT_LOCATION to user
defined path that you want to set as the WFS location before Windchill
Workgroup Manager client installation.

Uninstalling PTC Windchill Workgroup Manager 41


7
CATIA V5 Preparation: Build and
Place the Abstraction Library
Abstraction Library Prerequisites ................................................................................43
Building and Placing the Abstraction Library ................................................................54

For Windchill Workgroup Manager for CATIA V5 only, you must build and place
the CATIA V5 abstraction library. This task must be completed before Windchill
Workgroup Manager is installed, updated or upgraded.
If you do not plan to use Windchill Workgroup Manager for CATIA V5, skip this
section.

Prerequisites
• Ensure that your environment meets CAA software requirements for your
CATIA V5 version.
• Ensure that your environment meets the CAA framework requirements. For
details, see CAA Framework Requirements on page 47.
• As a part of the installation, you must create the abstraction library. To do this,
you must have knowledge of the CATIA V5 CAA RADE tool so you can
correctly enter the tool level name. (CAA RADE is a separate toolkit from
Dassault, from whom you can find documentation.)

Installation Task Overview


Before you deploy Windchill Workgroup Manager, you build the abstraction
library and place the abstraction library file in the Windchill Workgroup Manager
release media image.

42 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


Abstraction Library Prerequisites
For a smooth installation, you must perform the installation in the order shown
below. If you complete these steps out of order, you will need to perform
additional, more complex configuration steps later.
These prerequisites are automatically verified during the abstraction library
building process. If any prerequisites are missing, the abstraction builder provides
a message, which you must address before you can successfully build the
abstraction library.
1. Install Microsoft Visual Studio. Ensure that:
• It contains static and shared Unicode libraries for Microsoft foundation
classes.
• The default C++ settings are used, with the additional installation of X64
Compilers and Tools if you are installing on 64-bit Windows.
• You have applied any available service packs and hotfixes.
2. Install CATIA V5.

Note
Before installing CATIA V5, review the list of required CAA frameworks
that are used by Windchill Workgroup Manager for CATIA V5, along with
their configurations and products. For each CAA framework, you must
install at least one configuration or product. For details, see CAA
Framework Requirements on page 47.

CATIA V5 Preparation: Build and Place the Abstraction Library 43


Note
For installation of CATIA V5, a specific version of Microsoft Visual
Studio is required:
• For CATIA V5–6 R2016: Microsoft Visual Studio 2012 Update 4, with
the following patches:
○ KB2929731
○ KB2957527
○ KB2969618
• For CATIA V5-6R2017 and V5-6R2018: Microsoft Visual Studio 2012
Update 5
• For CATIA V5-6R2019: Microsoft Visual Studio 2015 Update 3
• For CATIA V5-6R2020: Microsoft Visual Studio 2017 with Windows
10 SDK 10.0.16299.0
• For CATIA V5-6R2021: Microsoft Visual Studio 2017 (64-bit
compiler) with Windows 10 SDK 10.0.16299.0
• For CATIA V5-6R2022 and V5-6R2023: Microsoft Visual Studio 2019
version 16.9.2 including C/C++ compilers, with Windows SDK
10.0.18362.0
For full details, see the CATIA V5 hardware and software requirements
documentation that is available on the CATIA V5 installation media

44 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


3. Install and configure the CATIA V5 CAA API software:

Note
If your CATIA V5 version is CATIA V5-6R2015 or later, running
CATVBTSetup.exe is not a mandatory step to build DLLs for
Workgroup Manager otherwise follow these steps:

a. Launch the CAA V5 Development Environment Setup setup utility,


available under <client_loadpoint>\BXX\intel_a\code\
bin\CATVBTSetup.exe.

Note
• The default location for a 64-bit platform might be slightly different:
<client_loadpoint>\BXX_RADE\ intel_a\code\bin\
CATVBTSetup.exe.
• Running CATVBTSetup.exe is required to setup configuration
setting of the RADE interactive tools; for example, add-in in Microsoft
Visual Studio. This is not a mandatory step to build CATIA DLLs for
Workgroup Manager for any supported CATIA Release.

b. Select the following CATIA CAA development components to be


installed: MKMK, CodeGenerator, and Workspace Manager:

CATIA V5 Preparation: Build and Place the Abstraction Library 45


c. Click Install and then OK. Close the window.
4. Install and configure CATIA V5 RADE software:

Note
The same CATIA V5 RADE software is used for both the Windows 64-bit
and 32-bit platforms (starting from CATIA V5-6R2016 RADE is only 64-
bit version). When setting up build environment on a Windows 64-bit
platform for CATIA V5-6R2017 and below, the RADE software cannot be
installed in the same location as the client and API software. You must
choose another location for the installation directory (for example, B24_
RADE).

a. From the Windows Start menu, navigate to CAA RADE ▶ Tools ▶ RADE
License Manager V5RXX.
b. Locate and select your available license:

c. Click Apply and close the window.

46 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


Note
For details about the required CAA frameworks, see CAA Framework
Requirements on page 47.

Note
See the CAA RADE documentation for the CATIA V5 versions you are
planning to use with the Windchill Workgroup Manager for CATIA V5 for
the supported compilers.

CAA Framework Requirements


Following is a list of the required CAA frameworks that are used by Windchill
Workgroup Manager for CATIA V5, along with their configurations and products.
For each CAA framework, at least one configuration or product must be installed.
Before installing CATIA V5, review the configuration or product options that you
intend to install and ensure that all of the CAA frameworks listed below are
included. For each framework, ensure that one of the required configuration and
product options is included.
For more information about CAA frameworks and configuration and product
options, see the Dassault Systemes website: http://www.3ds.com.
CAA Configuration and Product Options
Framework
Administration ANR, CO1, DMU, DU1, E5I, EFD, EHI, EWR, HBR, KIN,
MPG, PH1, PHS, RT1, RTR, SMG, TXG
Application- ANR, CBD, CCV, CNA, CO1, COM, CPR, DMU, DN1,
Frame DSE, DU1, E5I, EC1, ELB, ELD, EQT, FSK, FT1, GP1,
GPS, GS1, HBR, HGR, HVA, HVD, ICM, IG1, IMA, KIN,
NCG, NG1, PH1, PHS, PID, PIP, PLO, QSR, RCD, RM1,
RT1, RTR, SDD, SDI, SFD, SH1, SM1, SMD, SP1, SR1,
SRT, SSR, ST1, STC, STL, TL1, TUB, TUD, TXG, V4I,
WAV, WGD
AutomationInter- ANR, CCV, CNA, CO1, CPR, DMU, DT1, DU1, E5I, EC1,
faces ELD, EQT, HBR, HGR, HVA, HVD, KIN, NCG, NG1, PH1,
PHS, PID, PIP, PLO, QSR, RCD, RM1, RT1, RTR, SDD,
SDI, SFD, SR1, SRT, SSR, STL, TL1, TUB, TUD, TXG,
WAV, WGD

CATIA V5 Preparation: Build and Place the Abstraction Library 47


CAA Configuration and Product Options
Framework
CATAnalysisIn- ANR, AS1, CCV, CNA, CO1, CPE, CPM, CPR, DN1, DSE,
terfaces DSS, DU1, EC1, ECR, EFD, EHF, EHI, ELB, EQT, EWE,
EWR, FAR, FM1, FS1, FSK, FSP, FSS, FT1, FTA, GD1,
GP1, GPS, GS1, GSD, HA1, HGR, HVA, ICM, ID1, MBG,
MSG, NCG, PD1, PEO, PH1, PHS, PIP, QSR, RCD, RSO,
RT1, RTR, SDD, SFD, SH1, SM1, SMD, SP1, SR1, STL,
TL1, TUB, WAV, WS1
CATAssemblyIn- ANR, AS1, ASD, BK2, CBD, CC1, CCV, CNA, CO1, CPR,
terfaces DF1, DN1, DSE, DT1, DU1, E5I, EC1, ECR, EFD, EHF,
EHI, ELB, ELD, EQT, EWE, EWR, FIT, FM1, FS1, FSK,
FSP, FSS, FT1, FTA, GD1, GDR, GP1, GPS, GS1, GSD,
HA1, HBR, HGR, HVA, HVD, ICM, ID1, IG1, KIN, KT1,
KWA, MBG, MSG, MTD, NCG, NG1, PD1, PDG, PFD,
PG1, PH1, PHS, PID, PIP, PKT, PLO, QSR, RCD, RT1, RTR,
SDD, SDI, SFD, SH1, SM1, SMD, SP1, SR1, SRT, SSR,
ST1, STC, STL, TG1, TL1, TUB, TUD, TXG, V41, V4I,
WAV, WGD, WS1
CATIAApplica- ANR, CBD, CCV, CNA, CO1, COM, CPR, DMU, DN1,
tionFrame DSE, DU1, E5I, EC1, ELD, EQT, FSK, FT1, GP1, GPS,
HBR, HGR, HVA, HVD, IG1, IMA, KE1, KIN, NCG, NG1,
PH1, PHS, PID, PIP, PLO, QSR, RCD, RM1, RT1, RTR,
SDD, SDI, SFD, SH1, SM1, SMD, SR1, SRT, SSR, ST1,
STC, STL, TL1, TUB, TUD, TXG, WAV, WGD
CATMatInterfa- ANR, AS1, CBD, CCV, CNA, CO1, CPE, CPM, CPR, DF1,
ces DMU, DN1, DSE, DSS, DU1, EC1, ECR, EFD, EHF, EHI,
ELB, ELD, EQT, EWR, FAR, FIT, FM1, FS1, FSK, FSP,
FSS, FT1, FTA, GD1, GP1, GPS, GS1, GSD, HA1, HBR,
HGR, HVA, HVD, ICM, ID1, IG1, KIN, LO1, MBG, MSG,
NCG, NG1, PD1, PDG, PG1, PH1, PHS, PID, PIP, PLO,
QSR, RCD, RSO, RT1, RTR, SDD, SDI, SFD, SH1, SM1,
SMD, SP1, SR1, SRT, SSR, STL, TG1, TL1, TUB, TUD,
TXG, V41, V4I, WAV, WGD, WS1
CATTPSInterfa- ANR, AS1, ASD, BK2, CBD, CCV, CNA, CPE, CPM, CPR,
ces DF1, DL1, DMN, DN1, DSE, DSS, DT1, DU1, EC1, ECR,
EFD, EHF, EHI, ELB, ELD, EQT, EWR, FAR, FIT, FM1,
FS1, FSK, FSP, FSS, FT1, FTA, GD1, GDR, GP1, GPS, GS1,
GSD, GSO, HA1, HBR, HGR, HVA, HVD, ICM, ID1, IG1,
IMA, KIN, KT1, KWA, LO1, MBG, MSG, MTD, NCG,
NG1, PD1, PDG, PFD, PH1, PHS, PID, PIP, PLO, QSR,
RCD, RSO, RT1, RTR, SDD, SDI, SFD, SH1, SM1, SMD,

48 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


CAA Configuration and Product Options
Framework
SP1, SPA, SR1, SRT, SSR, ST1, STL, TG1, TL1, TUB, TUD,
TXG, V41, V4I, WAV, WGD, WS1
ComponentsCa- ANR, AS1, ASD, BK2, CBD, CCV, CNA, CO1, DMN,
talogs DMO, DMU, DN1, DSE, DT1, DU1, E5I, EC1, ECR, EFD,
EHF, EHI, ELB, ELD, EQT, EWR, FIT, FM1, FS1, FSK,
FSP, FSS, FT1, FTA, GD1, GDR, GP1, GPS, GS1, GSD,
HA1, HBR, HGR, HVA, HVD, ICM, ID1, IG1, KE1, KIN,
KT1, KWA, KWE, MTD, NCG, NG1, PD1, PDG, PEO, PFD,
PH1, PHS, PID, PIP, PKT, PLO, QSR, RCD, RT1, RTR,
SDD, SDI, SFD, SH1, SM1, SMD, SP1, SPA, SR1, SRT,
SSR, ST1, STC, STL, TG1, TL1, TUB, TUD, TXG, V41,
V4I, WAV, WGD, WS1,
ComponentsCa- ANR, AS1, ASD, BK2, CBD, CCV, CNA, CO1, CPR, DMN,
talogsInterfaces DMO, DMU, DN1, DSE, DT1, DU1, E5I, EC1, EFD, EHF,
EHI, ELB, ELD, EQT, EWR, FIT, FM1, FS1, FSK, FSP, FSS,
FT1, FTA, GD1, GDR, GP1, GPS, GS1, GSD, HA1, HBR,
HGR, HVA, HVD, ICM, ID1, IG1, KE1, KIN, KT1, KWA,
KWE, MTD, NCG, NG1, PD1, PDG, PEO, PFD, PH1, PHS,
PID, PIP, PKT, PLO, QSR, RCD, RT1, RTR, SDD, SDI, SFD,
SH1, SM1, SMD, SP1, SPA, SR1, SRT, SSR, ST1, STC, STL,
TG1, TL1, TUB, TUD, TXG, V41, V4I, WAV, WGD, WS1
Dialog ANR, CBD, CCV, CNA, CO1, COM, CPR, DMU, DU1, E5I,
EC1, ELB, ELD, EQT, FSK, FT1, HBR, HGR, HVA, HVD,
IG1, IMA, KIN, NCG, NG1, PH1, PHS, PID, PIP, PLO, QSR,
RCD, RM1, RT1, RTR, SDD, SDI, SFD, SH1, SM1, SMD,
SR1, SRT, SSR, ST1, STC, STL, TL1, TUB, TUD, TXG,
V4I, WAV, WGD
DialogEngine ANR, CBD, CCV, CNA, CO1, CPR, DMU, DU1, E5I, EC1,
EFD, EHF, EHI, ELB, ELD, EQT, EWR, FSK, FT1, HBR,
HGR, HVA, HVD, IG1, IMA, KIN, NCG, NG1, PH1, PHS,
PID, PIP, PLO, QSR, RCD, RM1, RT1, RTR, SDD, SDI,
SFD, SH1, SM1, SMD, SR1, SRT, SSR, ST1, STC, STL,
TL1, TUB, TUD, TXG, WAV, WGD
DMAPSInterfa- ANR, AS1, ASD, BK2, CBD, CCV, CNA, CO1, CPE, CPM,
ces CPR, DF1, DL1, DMN, DMU, DN1, DSE, DSS, DU1, E5I,
EC1, ECR, EFD, EHF, EHI, ELB, ELD, EQT, EWR, FAR,
FIT, FM1, FS1, FSK, FSP, FT1, GD1, GDY, GP1, GPS, GS1,
GSD, GSO, HA1, HBR, HGR, HVA, HVD, ICM, ID1, IMA,
KIN, KT1, LO1, MBG, MSG, NCG, NG1, PD1, PDG, PFD,
PH1, PHS, PID, PIP, PLO, QSR, RCD, RSO, RT1, RTR,

CATIA V5 Preparation: Build and Place the Abstraction Library 49


CAA Configuration and Product Options
Framework
SDD, SDI, SFD, SH1, SM1, SMD, SP1, SPA, SR1, SRT,
SSR, ST1, STL, TG1, TL1, TUB, TUD, V4I, WAV, WGD,
WS1
DraftingInterfa- ANR, AS1, ASD, BK2, CBD, CC1, CCV, CNA, CO1, COZ,
ces CPR, DF1, DMN, DMU, DN1, DSE, DT1, DU1, E5I, EC1,
ECR, EFD, EHF, EHI, ELB, ELD, EQT, EWE, EWR, FIT,
FM1, FS1, FSK, FSP, FSS, FT1, FTA, GD1, GDR, GP1,
GPS, GS1, GSD, HA1, HBR, HGR, HVA, HVD, ICM, ID1,
IG1, KIN, KT1, KWA, LO1, MBG, MSG, MTD, NCG, NG1,
PD1, PDG, PEO, PFD, PG1, PH1, PHS, PID, PIP, PKT, PLO,
QSR, RCD, RT1, RTR, SDD, SDI, SFD, SH1, SM1, SMD,
SP1, SR1, SRT, SSR, ST1, STC, STL, TG1, TL1, TUB, TUD,
TXG, V41, V4I, WAV, WGD, WS1
InfInterfaces ANR, CBD, CCV, CNA, CO1, CPR, DF1, DMU, DU1, E5I,
EC1, EFD, EHF, EHI, ELB, ELD, EQT, EWR, FM1, FT1,
HBR, HGR, HVA, HVD, IG1, KIN, NCG, NG1, PD1, PH1,
PHS, PID, PIP, PLO, QSR, RCD, RM1, RT1, RTR, SDD,
SDI, SFD, SH1, SM1, SMD, SR1, SRT, SSR, ST1, STC,
STL, TL1, TUB, TUD, TXG, V4I, WAV, WGD
InteractiveInter- ANR, CCV, CNA, CO1, CPE, CPM, CPR, DMU, DSE, DU1,
faces E5I, EC1, EFD, EHI, ELB, ELD, EQT, EWR, FS1, FSK, FSP,
FSS, HA1, HBR, HGR, HVA, HVD, IMA, KIN, NCG, NG1,
PH1, PHS, PID, PIP, PLO, QSR, RCD, RM1, RT1, RTR,
SDD, SDI, SFD, SR1, SRT, SSR, STL, TL1, TUB, TUD,
TXG, V41, V4I, WAV, WGD
KnowledgeInter- ANR, AS1, BK2, CBD, CCV, CNA, CO1, COZ, CPE, CPM,
faces CPR, DMN, DMO, DMU, DN1, DSE, DSS, DT1, DU1, E5I,
EC1, EFD, EHF, EHI, ELB, ELD, EQT, EWR, FAR, FIT,
FM1, FS1, FSK, FSP, FSS, FT1, GD1, GP1, GPS, GSD,
HA1, HBR, HGR, HVA, HVD, ID1, IG1, KE1, KIN, KT1,
KWA, KWE, MBG, MSG, MTD, NCG, NG1, PD1, PDG,
PEO, PFD, PH1, PHS, PID, PIP, PKT, PLO, QSR, RCD,
RM1, RT1, RTR, SDD, SDI, SFD, SH1, SM1, SMD, SP1,
SPA, SR1, SRT, SSR, ST1, STC, STL, TG1, TL1, TUB,
TUD, TXG, V4I, WAV, WGD, WS1
ManufacturingIn- CCV, NCG, NG1, SH1, SM1, SMD
terfaces
Mathematics ANR, CBD, CCV, CNA, CO1, CPR, DMU, DU1, E5I, EC1,
EFD, EHF, EHI, ELB, ELD, EQT, EWR, FSK, FT1, HBR,
HGR, HVA, HVD, IG1, IMA, KIN, NCG, NG1, PH1, PHS,

50 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


CAA Configuration and Product Options
Framework
PID, PIP, PLO, QSR, RCD, RM1, RT1, RTR, SDD, SDI,
SFD, SH1, SM1, SMD, SR1, SRT, SSR, ST1, STC, STL,
TL1, TUB, TUD, TXG, V4I, WAV, WGD
MechanicalCom- ANR, AS1, ASD, BK2, CBD, CCV, CNA, CPE, CPM, CPR,
mands DF1, DL1, DMN, DMO, DMU, DN1, DSE, DSS, DT1, DU1,
EC1, ECR, EFD, EHF, EHI, ELB, ELD, EQT, EWR, FAR,
FIT, FM1, FS1, FSK, FSP, FSS, FT1, FTA, GD1, GDR, GP1,
GPS, GS1, GSD, GSO, HA1, HBR, HGR, HVA, HVD, ICM,
ID1, IG1, IMA, KE1, KIN, KT1, KWA, KWE, LO1, MBG,
MSG, MTD, NCG, NG1, PD1, PDG, PFD, PG1, PH1, PHS,
PID, PIP, PKT, PLO, QSR, RCD, RSO, RT1, RTR, SDD,
SDI, SFD, SH1, SM1, SMD, SP1, SR1, SRT, SSR, ST1, STC,
STL, TG1, TL1, TUB, TUD, TXG, V41, V4I, WAV, WGD,
WS1
MechanicalMod- ANR, AS1, ASD, BK2, CBD, CCV, CNA, CPE, CPM, CPR,
eler DF1, DL1, DMU, DN1, DSE, DSS, DT1, DU1, EC1, ECR,
EFD, EHF, EHI, ELB, ELD, EQT, EWR, FAR, FIT, FM1,
FS1, FSK, FSP, FSS, FT1, FTA, GD1, GDR, GP1, GPS, GS1,
GSD, GSO, HA1, HBR, HGR, HVA, HVD, ICM, ID1, IG1,
IMA, KIN, KT1, KWA, LO1, MBG, MSG, MTD, NCG,
NG1, PD1, PDG, PFD, PG1, PH1, PHS, PID, PIP, PKT, PLO,
QSR, RCD, RSO, RT1, RTR, SDD, SDI, SFD, SH1, SM1,
SMD, SP1, SPA, SR1, SRT, SSR, ST1, STC, STL, TG1, TL1,
TUB, TUD, TXG, V41, V4I, WAV, WGD, WS1
MecModInterfa- ANR, AS1, ASD, BK2, CBD, CCV, CNA, CO1, CPE, CPM,
ces CPR, DMN, DMO, DMU, DN1, DSE, DSS, DT1, DU1, E5I,
EC1, EFD, EHF, EHI, ELB, ELD, EQT, EWR, FIT, FM1,
FS1, FSK, FSP, FSS, FT1, FTA, GD1, GDR, GP1, GPS, GS1,
GSD, HA1, HBR, HGR, HVA, HVD, ICM, ID1, IG1, IMA,
KE1, KIN, KT1, KWA, KWE, MTD, NCG, NG1, PD1, PDG,
PEO, PFD, PH1, PHS, PID, PIP, PKT, PLO, QSR, RCD, RT1,
RTR, SDD, SDI, SFD, SH1, SM1, SMD, SP1, SPA, SR1,
SRT, SSR, ST1, STC, STL, TG1, TL1, TUB, TUD, TXG,
V41, V4I, WAV, WGD, WS1
NewTopologica- ANR, AS1, ASD, BK2, CBD, CCV, CNA, CO1, CPR, DMN,
lObjects DMO, DMU, DN1, DSE, DT1, DU1, E5I, EC1, ECR, EFD,
EHF, EHI, ELB, ELD, EQT, EWR, FIT, FM1, FS1, FSK,
FSP, FSS, FT1, FTA, GD1, GDR, GP1, GPS, GS1, GSD,
HA1, HBR, HGR, HVA, HVD, ICM, ID1, IG1, IMA, KE1,
KIN, KT1, KWA, KWE, MTD, NCG, NG1, PD1, PDG, PEO,

CATIA V5 Preparation: Build and Place the Abstraction Library 51


CAA Configuration and Product Options
Framework
PFD, PH1, PHS, PID, PIP, PKT, PLO, QSR, RCD, RM1,
RT1, RTR, SDD, SDI, SFD, SH1, SM1, SMD, SP1, SPA,
SR1, SRT, SSR, ST1, STC, STL, TG1, TL1, TUB, TUD,
TXG, V41, V4I, WAV, WGD, WS1
ObjectModeler- ANR, CBD, CCV, CNA, CO1, COZ, CPE, CPM, CPR,
Base DMU, DSE, DU1, E5I, EC1, EFD, EHF, EHI, ELB, ELD,
EQT, EWR, FSK, FT1, HBR, HGR, HVA, HVD, IG1, IMA,
KIN, NCG, NG1, PH1, PHS, PID, PIP, PLO, QSR, RCD,
RM1, RT1, RTR, SDD, SDI, SFD, SH1, SM1, SMD, SR1,
SRT, SSR, ST1, STC, STL, TL1, TUB, TUD, TXG, V4I,
WAV, WGD
ObjectModeler- ANR, CBD, CCV, CNA, CO1, CPE, CPM, CPR, DMU, DSE,
Navigator DU1, E5I, EC1, EFD, EHF, EHI, ELB, ELD, EQT, EWR,
FSK, FT1, HBR, HGR, HVA, HVD, IG1, IMA, KIN, NCG,
NG1, PH1, PHS, PID, PIP, PLO, QSR, RCD, RM1, RT1,
RTR, SDD, SDI, SFD, SH1, SM1, SMD, SR1, SRT, SSR,
ST1, STC, STL, TL1, TUB, TUD, TXG, V4I, WAV, WGD
ObjectSpecs- ANR, AS1, ASD, BK2, CBD, CCV, CNA, CO1, COZ, CPE,
Modeler CPM, CPR, DMN, DMO, DMU, DN1, DSE, DT1, DU1, E5I,
EC1, EFD, EHF, EHI, ELB, ELD, EQT, EWR, FIT, FM1,
FS1, FSK, FSP, FSS, FT1, FTA, GD1, GDR, GP1, GPS, GS1,
GSD, HA1, HBR, HGR, HVA, HVD, ICM, ID1, IG1, IMA,
KE1, KIN, KT1, KWA, KWE, MTD, NCG, NG1, PD1, PDG,
PEO, PFD, PH1, PHS, PID, PIP, PKT, PLO, QSR, RCD, RT1,
RTR, SDD, SDI, SFD, SH1, SM1, SMD, SP1, SPA, SR1,
SRT, SSR, ST1, STC, STL, TG1, TL1, TUB, TUD, TXG,
V41, V4I, WAV, WGD, WS1
ProductStructure ANR, AS1, ASD, BK2, CBD, CC1, CCV, CNA, CO1, COZ,
CPE, CPM, CPR, DF1, DL1, DMN, DMO, DMU, DN1,
DSE, DT1, DU1, E5I, EC1, ECR, EFD, EHF, EHI, ELB,
ELD, EQT, EWE, EWR, FAR, FIT, FM1, FS1, FSK, FSO,
FSP, FSS, FT1, FTA, GAS, GD1, GDR, GP1, GPS, GS1,
GSD, GSO, HA1, HBR, HGR, HVA, HVD, ICM, ID1, IG1,
KE1, KIN, KT1, KWA, KWE, MBG, MPG, MSG, MTD,
NCG, NG1, PD1, PDG, PEO, PFD, PG1, PH1, PHS, PID,
PIP, PKT, PLO, PMG, PX1, QSR, RCD, RSO, RT1, RTR,
SDD, SDI, SFD, SH1, SM1, SMD, SMG, SP1, SPA, SR1,
SRT, SSR, ST1, STC, STL, TG1, TL1, TUB, TUD, TXG,
V41, V4I, WAV, WGD, WS1, Z7Z
ANR, AS1, ASD, BK2, CBD, CCV, CNA, CO1, CPR, DMN,

52 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


CAA Configuration and Product Options
Framework
ProductStructur- DMO, DMU, DN1, DSE, DT1, DU1, E5I, EC1, EFD, EHF,
eInterfaces EHI, ELB, ELD, EQT, EWR, FIT, FM1, FS1, FSK, FSP, FSS,
FT1, FTA, GD1, GDR, GP1, GPS, GS1, GSD, HA1, HBR,
HGR, HVA, HVD, ICM, ID1, IG1, KE1, KIN, KT1, KWA,
KWE, MTD, NCG, NG1, PD1, PDG, PEO, PFD, PH1, PHS,
PID, PIP, PKT, PLO, QSR, RCD, RT1, RTR, SDD, SDI, SFD,
SH1, SM1, SMD, SP1, SPA, SR1, SRT, SSR, ST1, STC, STL,
TG1, TL1, TUB, TUD, TXG, V41, V4I, WAV, WGD, WS1
SketcherInterfa- ANR, AS1, ASD, BK2, CBD, CCV, CNA, CO1, CPR, DF1,
ces DMN, DMO, DMU, DN1, DSE, DT1, DU1, E5I, EC1, EFD,
EHF, EHI, ELB, ELD, EQT, EWR, FIT, FM1, FS1, FSK,
FSP, FSS, FT1, FTA, GD1, GDR, GP1, GPS, GS1, GSD,
HA1, HBR, HGR, HVA, HVD, ICM, ID1, IG1, KE1, KIN,
KT1, KWA, KWE, LO1, MTD, NCG, NG1, PD1, PDG, PEO,
PFD, PH1, PHS, PID, PIP, PKT, PLO, QSR, RCD, RT1, RTR,
SDD, SDI, SFD, SH1, SM1, SMD, SP1, SPA, SR1, SRT,
SSR, ST1, STC, STL, TG1, TL1, TUB, TUD, TXG, V41,
V4I, WAV, WGD, WS1
SpaceAnalysisIn- AS1, ASD, BK2, CBD, CCV, CNA, CO1, CPE, CPM, CPR,
terfaces DF1, DL1, DMO, DN1, DSE, DSS, DT1, DU1, E5I, EC1,
ECR, EFD, EHF, EHI, ELB, ELD, EQT, EWR, FAR, FIT,
FM1, FS1, FSK, FSP, FT1, GD1, GS1, GSD, GSO, HA1,
HBR, HGR, HVA, HVD, ICM, ID1, IMA, KIN, KT1, LO1,
MBG, MSG, NCG, NG1, PD1, PDG, PFD, PH1, PHS, PID,
PIP, PLO, QSR, RCD, RSO, RT1, RTR, SDD, SDI, SFD,
SH1, SM1, SMD, SP1, SPA, SR1, SRT, SSR, ST1, STL, TG1,
TL1, TUB, TUD, V4I, WAV, WGD, WS1
Visualization ANR, CBD, CCV, CNA, CO1, COM, CPR, DF1, DMN,
DMO, DMU, DN1, DSE, DU1, E5I, EC1, ELB, ELD, EQT,
FSK, FT1, GP1, GPS, GS1, HBR, HGR, HVA, HVD, ICM,
IG1, IMA, KIN, NCG, NG1, PH1, PHS, PID, PIP, PLO, QSR,
RCD, RM1, RT1, RTR, SDD, SDI, SFD, SH1, SM1, SMD,
SP1, SR1, SRT, SSR, ST1, STC, STL, TL1, TUB, TUD,
TXG, V4I, WAV, WGD

CATIA V5 Preparation: Build and Place the Abstraction Library 53


Building and Placing the Abstraction
Library

Note
The CATIA V5 abstraction library must be built and placed in the Windchill
Workgroup Manager installation media image before the Windchill
Workgroup Manager client is installed.

The CATIA V5 abstraction library allows Windchill Workgroup Manager for


CATIA V5 to interact with CATIA V5. When you update your Windchill
Workgroup Manager software, such as by installing maintenance releases and
patches, you must rebuild the abstraction library.
PTC provides a utility to build the CATIA V5 abstraction library. Once you have
built the abstraction library, you place it in the Windchill Workgroup Manager
installation media image. When you install Windchill Workgroup Manager for
CATIA V5, the rebuilt abstraction library allows Windchill Workgroup Manager
for CATIA V5 to interact with CATIA V5.
Before you begin, ensure that you have reviewed the prerequisites and completed
any necessary steps. For more information, see Abstraction Library Prerequisites
on page 43. The prerequisites are automatically verified by the abstraction library
builder, and you are notified of any issues. However, ensuring that the
prerequisites are met before beginning helps to streamline the process.
Additional verifications take place when CATIA V5 is registered with Windchill
Workgroup Manager and when CATIA V5 is launched after it has been registered.
A message appears if there is a mismatch between the versions of Windchill
Workgroup Manager or CATIA V5 that were used to build the abstraction library
and the ones currently being used. For full details, see Windchill Help Center
topic Runtime CATIA Environment Check.
For a video that shows the procedure for building the abstraction library that is
described in this section, see PTC Windchill Workgroup Manager for CATIA V5:
Creating the CATIA V5 Abstraction Library on the PTC University Learning
Exchange website.

Note
If your environment uses more than one version of CATIA V5, you must
perform this procedure once for each version of CATIA V5.

54 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


To build and place the abstraction library, perform the following steps:
1. Copy the following file locally, and then launch it: <Windchill
Workgroup Manager installation media image>\
Catia5Builder\Windows\CATIA_V5_Builder.exe.
2. Complete the CATIA V5 abstraction library builder:

Note
During these steps, the abstraction library builder automatically verifies its
prerequisites and notifies you of any issues. If any of these messages
appear, complete the action described in the message. Then, launch the
CATIA V5 abstraction library builder and start this process again.

a. Select the installation language from the list and then click OK.
b. Under the Before You Begin step, review the information to ensure that you
have the required products, then select Next.

CATIA V5 Preparation: Build and Place the Abstraction Library 55


c. Under the Select Installation Directory step, enter the directory where you
would like to save the abstraction builder file. This can be any location on
your computer; you will copy it to the installation image later in this
procedure.

d. Under the Select CATIA V5 Release step, select the appropriate CATIA V5
release and then click Next.

56 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


e. Under the CAA RADE Tool Level step, the default CAA RADE tool level
value is pre-populated, but you can change it if required. Click Next.

f. Under the Review Settings step, review the settings and then click Install.
The abstraction library is generated as a CAB file. For example, uwgm_
client.x86_win64.cv5-6absR2013.cab.
g. After the build process is complete, make a note of the location where the
CAB file was saved. Click Done.
3. Copy the abstraction library CAB file to the ptcsh0 folder in the installation
image. Your file replaces the default file in the installation image, which is
empty (0 KB).

CATIA V5 Preparation: Build and Place the Abstraction Library 57


8
CATIA 3DEXPERIENCE
Preparation: Build and Place the
Abstraction Library and Install
PTC Windchill Workgroup
Manager ENOVIA 3DEXPERIENCE
Adapter
Abstraction Library Prerequisites ................................................................................60
Building and Placing the Abstraction Library ................................................................61
Installing the Windchill Workgroup Manager ENOVIA 3DEXPERIENCE Adapter............67

This chapter covers installation of the Windchill Workgroup Manager ENOVIA


adapter and the abstraction library (which must be built before installing, updating
or upgrading the Windchill Workgroup Manager client) for Windchill Workgroup
Manager for CATIA 3DEXPERIENCE.
For CATIA 3DEXPERIENCE to work with Windchill Workgroup Manager, you
must install and register the following applications in the roles prescribed:
• Administrator (on the server side): With 3DSpace already installed, run the
ENOVIA Adapter installer on page 67.
After the installation, run the batch files BuildDeploy3DSpace_

58 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


CAS.bat and BuildDeploy3DSpace_NoCAS.bat. Verify that the
services start.
• Administrator: Run Abstraction Builder to generate Abstraction CAB on page
61, before Windchill Workgroup Manager is installed, updated or upgraded.
• User: Install PTC Windchill Workgroup Manager on page 6 and register
CATIA 3DEXPERIENCE with Windchill Workgroup Manager.

Note
• BuildDeploy3DSpace_CAS.bat and BuildDeploy3DSpace_
NoCAS.bat are installed with ENOVIA and shortcuts are created on the
desktop.
• On the Windows Task Manager, ensure that the following Windows services
start (status Running):
○ Apache2.4
○ 3DPassport TomEE
○ 3DDashboard TomEE
○ federated TomEE
○ Full-text AdvancedSearch (for R2017x) or 3DSpace Index (for R2018x or
later)
○ 3DSpace TomEE
○ 3DSpaceNoCAS TomEE

Prerequisites
• Ensure that your environment meets CAA software requirements for your
CATIA 3DEXPERIENCE version.
• As a part of the installation, you must create the abstraction library. To do this,
you must know how to install CATIA 3DEXPERIENCE Native Apps
Development Toolset. The default tool level name is filled in automatically.
(Native Apps Development Toolset is a separate toolkit from Dassault, from
whom you can find documentation.)

Installation Task Overview


Before you deploy Windchill Workgroup Manager, you must build the abstraction
library and place the abstraction library file in the Windchill Workgroup Manager
release media image.

CATIA 3DEXPERIENCE Preparation: Build and Place the Abstraction Library and
Install PTC Windchill Workgroup Manager ENOVIA 3DEXPERIENCE Adapter 59
Abstraction Library Prerequisites
For a smooth installation, you must perform the installation in the order shown
below. If you complete these steps out of order, you will need to perform
additional, more complex configuration steps later.
These prerequisites are automatically verified during the abstraction library
building process. If any prerequisites are missing, the abstraction builder provides
a message, which you must address before you can successfully build the
abstraction library.
1. On the license server host, install and configure DS License Server (DSLS).
On the client, create or edit the file C:\ProgramData\
DassaultSystemes\Licenses\DSLicSrv.txt. You must specify
license server name and host; for example, license_server_
host.mycompany.com:4085.
2. Install Microsoft Visual Studio with Microsoft Foundation Classes for C++
option and with service packs and hotfixes required by Dassault Systems.

Note
Refer to the CATIA 3DEXPERIENCE documentation for supported and
compatible C/C++ compiler version for CATIA 3DEXPERIENCE version.

3. Install CATIA 3DEXPERIENCE.

Note
For full details, see the CATIA 3DEXPERIENCE hardware and software
requirements documentation that is available on the CATIA
3DEXPERIENCE installation media

4. Install and configure the CATIA 3DEXPERIENCE CAA API software.


5. Install and configure CATIA 3DEXPERIENCE Native Apps Development
Toolset:
a. From the Windows Start menu, navigate to Programs ▶ Dassault Systems
Development Toolset for Native Apps 3DEXPERIENCE R2021x ▶
3DEXPERIENCE Open Development Toolset Licenses Manager.
b. Locate and select your available license:

60 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


c. Click Apply and close the window.

Note
See the Native Apps Development Toolset documentation for the
supported compilers.

Building and Placing the Abstraction


Library

Note
The CATIA 3DEXPERIENCE abstraction library must be built and placed in
the Windchill Workgroup Manager installation media image before the
Windchill Workgroup Manager client is installed.

The CATIA 3DEXPERIENCE abstraction library allows Windchill Workgroup


Manager for CATIA 3DEXPERIENCE to interact with CATIA 3DEXPERIENCE.
When you update your Windchill Workgroup Manager software, such as by
installing maintenance releases or patches, you must rebuild the abstraction
library.

CATIA 3DEXPERIENCE Preparation: Build and Place the Abstraction Library and
Install PTC Windchill Workgroup Manager ENOVIA 3DEXPERIENCE Adapter 61
PTC provides a utility to build the CATIA 3DEXPERIENCE abstraction library.
Before you begin, ensure that you have reviewed the prerequisites and completed
any necessary steps. For more information, see Abstraction Library Prerequisites
on page 60. The prerequisites are automatically verified by the abstraction library
builder, and you are notified of any issues. However, ensuring that the
prerequisites are met before beginning helps to streamline the process.
Additional verifications take place when CATIA 3DEXPERIENCE is registered
with Windchill Workgroup Manager and when CATIA 3DEXPERIENCE is
launched after it has been registered. A message appears if there is a mismatch
between the versions of Windchill Workgroup Manager or CATIA
3DEXPERIENCE that were used to build the abstraction library and the ones
currently being used.
For a video that shows the procedure for building the abstraction library for
CATIA V5, see PTC Windchill Workgroup Manager for CATIA V5: Creating the
CATIA V5 Abstraction Library on the PTC University Learning Exchange
website. The procedure to build abstraction library for CATIA 3DEXPERIENCE
is similar.

Note
If your environment uses more than one version of CATIA 3DEXPERIENCE,
you must perform this procedure once for each version of CATIA
3DEXPERIENCE.

To build and place the abstraction library, perform the following steps:
1. Launch the following file: <Windchill Workgroup Manager
installation media image>\Catia3DXBuilder\Windows\
CATIA_3DEXPERIENCE_Builder.exe.
2. Complete the CATIA 3DEXPERIENCE abstraction library builder:

Note
During these steps, the abstraction library builder automatically verifies its
prerequisites and notifies you of any issues. If any of these messages
appear, complete the action described in the message. Then, launch the
CATIA 3DEXPERIENCE abstraction library builder and start this process
again.

a. Under the Before You Begin step, review the information to ensure that you
have the required products, then select Next.

62 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


b. Under the Select Installation Directory step, on the Define Settings window,
enter the directory where you would like the builder to output the library
file. This can be any location on your computer; you must copy the library
file to the installation image later in this procedure.

CATIA 3DEXPERIENCE Preparation: Build and Place the Abstraction Library and
Install PTC Windchill Workgroup Manager ENOVIA 3DEXPERIENCE Adapter 63
c. Select Select CATIA 3DEXPERIENCE Release and click Next.

Note
The latest CATIA 3DEXPERIENCE release is automatically selected.
For example, CATIA 3DEXPERIENCE R2018x is automatically selected
as shown in the following image.

64 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


d. If there are multiple CAA installations for the selected CATIA
3DEXPERIENCE installation, you must select a CAA path and click Next.

e. If there are multiple Native Apps Development Toolset installations, you


must select an installation of Native Apps Development Toolset and click
Next.

CATIA 3DEXPERIENCE Preparation: Build and Place the Abstraction Library and
Install PTC Windchill Workgroup Manager ENOVIA 3DEXPERIENCE Adapter 65
f. Under the Native Apps Development Toolset Tool Level step, change the
tool level if required. Click Next.

g. Under the Review Settings step, review the settings and then click Install.

66 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


The abstraction library is generated as a CAB file. For example, uwgm_
client.x86e_win64.c3dxabsR2017x.cab.
h. After the build process is complete, make a note of the location where the
CAB file is saved. Click Done.

3. Copy the abstraction library CAB file to the ptcsh0 folder in the installation
image. Your file replaces the default file in the installation image.

Installing the Windchill Workgroup


Manager ENOVIA 3DEXPERIENCE
Adapter
To allow interaction between Windchill and Windchill Workgroup Manager for
CATIA 3DEXPERIENCE, you must install the Windchill Workgroup Manager
ENOVIA adapter on the ENOVIA server. The installation must be performed by
an ENOVIA administrator from the machine on which, ENOVIA is installed.
To install Windchill Workgroup Manager ENOVIA adapter on the ENOVIA
server, perform the following steps:
1. Launch the following file:
<Windchill Workgroup Manager installation media

CATIA 3DEXPERIENCE Preparation: Build and Place the Abstraction Library and
Install PTC Windchill Workgroup Manager ENOVIA 3DEXPERIENCE Adapter 67
image>EnoviaAdapterInstaller\Windows\ ENOVIA_Adapter_
Installer.exe
2. On the Before You Begin window, review the information to ensure that you
have the required products and then click Next.

3. Under the Select ENOVIA 3DEXPERIENCE Release step, click Next.

Note
The latest ENOVIA 3DEXPERIENCE release is automatically selected.
For example, in the following image, ENOVIA 3DEXPERIENCE R2018x is
automatically selected.

68 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


4. On the ENOVIA Installation Parameters window, enter the following folder
paths and then click Next:
• ENOVIA “3DSpace” folder: A folder where 3D Space is installed.
• Adapter working directory: A folder where server side logs are written
while using the adapter.

CATIA 3DEXPERIENCE Preparation: Build and Place the Abstraction Library and
Install PTC Windchill Workgroup Manager ENOVIA 3DEXPERIENCE Adapter 69
5. Enter the user account to be used for all ENOVIA transactions. This user
account must be assigned admin_role (business, admin all, VPLMAdmin).
Enter the ENOVIA Administrator login and Administrator password and then
click Next.

70 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


6. On the ENOVIA Administrator Info window, enter the requested administrator
information such as Administrator organization, Administrator project, and
Administrator role and then click Next.

Change or Enter Administrator organization, Administrator project and


Administrator role if necessary.

Note
• Under the defined security context, the Administrator must have read and
write access to user data stored in Windchill. This user data is generated
when the users work with Windchill Workgroup Manager for CATIA
3DEXPERIENCE.
• The Administrator is created during the installation of ENOVIA
(3DSpace) with the following default values:
○ Name: admin_platform
○ Security context: VPLMAdmin.Company Name.Default
(VPLMAdmin is Administrator role, Company Name is Administrator
Organization, Default is Administrator project (collaborative space)).
• ENOVIA Adapter Installer assigns additional privileges to the user to
ensure proper working of the adapter.

CATIA 3DEXPERIENCE Preparation: Build and Place the Abstraction Library and
Install PTC Windchill Workgroup Manager ENOVIA 3DEXPERIENCE Adapter 71
7. On the ENOVIA Environment Customization Info window, click Next.

Note
For ENOVIA 3DEXPERIENCE 2017, UnifiedTyping is only available for
Customize Environment.

8. On the Review Settings window, review all the settings and then click Install.

72 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide


9. After the ENOVIA 3DEXPERIENCE Adapter is installed successfully, make
note of the further instructions and then click Done.

CATIA 3DEXPERIENCE Preparation: Build and Place the Abstraction Library and
Install PTC Windchill Workgroup Manager ENOVIA 3DEXPERIENCE Adapter 73
After you install the ENOVIA 3DEXPERIENCE Adapter, the customization is
added to a staging folder. To bring the customization to production, you must run
BuildDeploy3DSpace_CAS.bat and BuildDeploy3DSpace_
NoCAS.bat.

Tip
• It is mandatory to restart all 3DEXPERIENCE services on the application
server for ENOVIA 3DEXPERIENCE.
• You are recommended to increase the timeout on reverse proxy for
uninterrupted processing of large datasets. An example of a large dataset value
to be added in the 3dspace.conf file is stated below:
Timeout 7200
ProxyTimeout 7200
Where the value 7200 (2 hours) is approximate. This value can be increased or
decreased depending on the operations performed on the 3DSpace, count of
users and hardware resources (Includes CPU and memory).

74 Windchill Workgroup Manager™ 13.0.0.1 Installation Guide

You might also like