Installation of Windchill Modeler

Windchill Modeler 9.
5
Installation Guide
Copyright © 2022 PTC Inc. and/or Its Subsidiary Companies. All Rights
Reserved.
User and training guides and related documentation from PTC Inc. and its
subsidiary companies (collectively "PTC") are 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 in printed form of this
documentation if provided on software media, 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. 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.
Information described herein is furnished for general information only, is subject
to change without notice, and should not be construed as a warranty or
commitment by PTC. PTC assumes no responsibility or liability for any errors or
inaccuracies that may appear in this document.
The software described in this document is provided under written license
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 software licenses agreement except
with written prior approval from PTC.
UNAUTHORIZED USE OF SOFTWARE OR ITS DOCUMENTATION CAN
RESULT IN CIVIL DAMAGES AND CRIMINAL PROSECUTION.
PTC regards software piracy as the crime it is, and we view offenders accordingly.
We do not tolerate the piracy of PTC software products, and we pursue (both
civilly and criminally) those who do so using all legal means available, including
public and private surveillance resources. As part of these efforts, PTC uses data
monitoring and scouring technologies to obtain and transmit data on users of
illegal copies of our software. This data collection is not performed on users of
legally licensed software from PTC and its authorized distributors. If you are
using an illegal copy of our software and do not consent to the collection and
transmission of such data (including to the United States), cease using the illegal
version, and contact PTC to obtain a legally licensed copy.
Important Copyright, Trademark, Patent, and Licensing Information: See
the About Box, or copyright notice, of your PTC software.
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
2
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
3
Contents
Getting Started............................................................................................................8
Before You Begin..................................................................................................9
Overview of this Installation Guide .........................................................................9
Choosing your Deployment Type .........................................................................10
Server Only, Client Only, or Standalone Installations..............................................12
Server Only Installation .......................................................................................13
Client Only Installation ........................................................................................13
Standalone Installation........................................................................................13
Environment Requirements for Each Installation Type ...........................................14
Default SQL Server Configuration ........................................................................15
Hardware Requirements .....................................................................................18
Administrator Rights Required for Installing Modeler..............................................20
Installation Components......................................................................................22
Installation Configurations ...................................................................................24
Installing Modeler for a Project Team....................................................................28
Installing Modeler Through a Customized MSI File ................................................30
Renaming a Modeler Computer or its Domain After Installation ..............................33
Managing Modeler and Web Interface Security .....................................................34
Working Across Sites.................................................................................................39
Overview of Working Across Sites........................................................................40
Direct Access of a Remote Model from Modeler ....................................................42
Direct Access of a Remote Model Through Microsoft Remote Desktop Services
or Citrix MetaFrame.........................................................................................43
Local Editing of Packages that are Imported from a Sandbox of a Remote
Model .............................................................................................................45
Local Editing of Packages that are Imported from a Remote Model and then
Protected........................................................................................................47
Local Editing of Models that are Stored in an Integrated CM tool ............................49
Local Editing of Models that are Stored in Shared Folders......................................51
Collaboration when working offline .......................................................................55
Planning for Windchill Modeler Installation ..................................................................58
Considerations for a New Installation Based on Deployment Type ..........................59
Choosing your Deployment Type .........................................................................59
Individual User Deployment Checklist ..................................................................61
Production — Workgroup Deployment Checklist ...................................................63
Production — Enterprise Deployment Checklist ....................................................68
Installing Windchill Modeler........................................................................................74
Installing Modeler ...............................................................................................75
Standalone Installation........................................................................................75
4 Windchill Modeler 9.5 Installation Guide

Server Only Installation .......................................................................................81
Client Only Installation ........................................................................................90
Installing Optional Modeler Components .....................................................................94
Installing Optional Modeler Components — Model Manager and Web
Interface ........................................................................................................95
Licensing Modeler ................................................................................................... 131
Introduction to Licensing Modeler....................................................................... 132
Licensing Modeler ............................................................................................ 133
Local and Server-based Licensing ..................................................................... 133
Modeler License Types: Subscription, Evaluation, Permanent, Incremental and
Upgrade ....................................................................................................... 136
Working with a Server-based Floating License ................................................... 137
Working with a Local License............................................................................. 143
License Borrowing - Frequently Asked Questions................................................ 146
License Manager .............................................................................................. 149
Performing an Upgrade ........................................................................................... 164
About Upgrades ............................................................................................... 165
Migrating Data from Enabler to SQL Server ........................................................ 165
Migrating model references from Enabler to SQL Server...................................... 169
Upgrade from Artisan Studio 6.0 or earlier .......................................................... 170
Upgrade from Integrity Modeler 8.2 or Earlier...................................................... 170
Upgrade from Integrity Modeler 8.3, 8.4 or 8.5 .................................................... 171
Upgrade from Integrity Modeler 9.0 .................................................................... 172
Upgrade to Windchill Modeler 9.5 ...................................................................... 173
License Upgrade .............................................................................................. 173
Upgrading State Diagrams from 7.3 or Earlier ..................................................... 173
Upgrading Profiles in Models ............................................................................. 173
Upgrading Custom Integrations ......................................................................... 174
Upgrading ACS Models..................................................................................... 174
Upgrading TDK Models ..................................................................................... 174
Upgrading DOORs Sychronizer Mappings from 8.0 or Earlier............................... 176
Upgrading Publisher Document Definitions ......................................................... 177
Upgrading Custom User Role Definitions............................................................ 177
Upgrading Web Interface................................................................................... 177
Upgrading an instance ...................................................................................... 178
Transferring the Web Interface User Database.................................................... 179
Maintaining OSLC Settings During an Upgrade................................................... 181
Upgrading Asset Library Integration ................................................................... 181
Setting up a Backup Procedure ................................................................................ 182
Setting up a Backup Procedure.......................................................................... 183
Setting up Applications to Work with Modeler ............................................................ 185
Setting up Applications to Work with Modeler ...................................................... 186
Setting up IBM Rational DOORS........................................................................ 186
Setting up IBM Rational Rose ............................................................................ 188
Setting up Microsoft Visual SourceSafe .............................................................. 188
Contents 5
Setting up IBM Rational ClearCase .................................................................... 189
Setting up PTC Integrity Lifecycle Manager......................................................... 189
Setting up Serena Dimensions........................................................................... 192
Setting up Serena Version Manager ................................................................... 194
Setting up Telelogic SYNERGY/CM ................................................................... 194
Uninstalling Modeler ................................................................................................ 199
Uninstalling Modeler ......................................................................................... 200
Appendix 1: Configuration Management Use Cases .................................................. 202
Overview of Configuration Management Use Cases ............................................ 203
Configuration Management Use Cases .............................................................. 205
Agile Modeling Using a Multi-User Model............................................................ 206
Versioning Models Quickly and Compactly.......................................................... 207
Controlling Access Using Package Protection and Access Rights......................... 209
Differencing Models for Review Purposes........................................................... 211
Model Import and Export Between Databases and CM ........................................ 213
Change Tracking in a Multi-User Model .............................................................. 214
Breaking Large Projects into Subsystem and Component Specific Models ............ 218
Saving a Database for an External CM Baseline ................................................. 219
Sharing Components and Packages Between Teams and CM ............................. 220
Developer Isolation in Support of Code and Debug Cycles................................... 222
Parallel Development of a Model for the Current and Next Release ...................... 226
Team Isolation in Support of Product Variants ..................................................... 229
Working on Parts of the Model Remotely ............................................................ 229
Appendix 2: Useful Information................................................................................. 231
Adding a certificate to SQL Server ..................................................................... 232
Making a Standalone Installation Work when Disconnected from the
Network ........................................................................................................ 233
Checking You Are Logged on to Windows with Administrator Rights ..................... 234
Setting up Trusted Domains .............................................................................. 235
Disabling Virus Checkers During Installation ....................................................... 236
Migrating Models after Updating PTC Profiles ..................................................... 236
Appendix 3: Troubleshooting.................................................................................... 237
Problems Experienced When Installing the Software ........................................... 238
Problems Experienced When Using the Product ................................................. 239

About This Guide
This guide explains how to install and configure Windchill Modeler 9.3 as well as
optional components Web Interface and Model Manager.
Technical Support
Contact PTC Technical Support through the PTC website or by phone if you
encounter problems using this product or the product documentation. The PTC
eSupport portal provides the resources and tools to support your implementation:
https://support.ptc.com/appserver/cs/portal/. For complete support details, see the
PTC Customer Support Guide. You must have a Service Contract Number (SCN)
before you can receive technical support. If you do not know your SCN, see
“Preparing to contact TS” on the Processes tab of the PTC Customer Support
Guide. This topic describes how to locate your SCN.
7
1
Getting Started
Before You Begin ........................................................................................................9
Overview of this Installation Guide ................................................................................9
Choosing your Deployment Type ................................................................................10
Server Only, Client Only, or Standalone Installations ....................................................12
Server Only Installation..............................................................................................13
Client Only Installation ...............................................................................................13
Standalone Installation ..............................................................................................13
Environment Requirements for Each Installation Type..................................................14
Default SQL Server Configuration...............................................................................15
Hardware Requirements ............................................................................................18
Administrator Rights Required for Installing Modeler ....................................................20
Installation Components ............................................................................................22
Installation Configurations..........................................................................................24
Installing Modeler for a Project Team ..........................................................................28
Installing Modeler Through a Customized MSI File.......................................................30
Renaming a Modeler Computer or its Domain After Installation .....................................33
Managing Modeler and Web Interface Security............................................................34

Before You Begin
This guide covers the installation of Modeler, and the setting up of integrated
applications to work with Modeler.
For information about upgrading Modeler, see Upgrading Modeler on page 165.
This guide describes the Modeler components, configurations and environment
requirements, so that you can determine how best to install Modeler to meet your
project needs.
For each installation type, this guide describes the pre-installation tasks, the
procedure for installing Modeler and the post-installation tasks.
We recommend that you read Choosing your deployment type on page 10 and
follow the checklist provided for each deployment option.
Overview of this Installation Guide

This installation guide covers the following:
• Choosing your Deployment Type on page 10 provides a list of consideration
for choosing the correct deployment type.
• Overview of working across sites on page 40 explains how to share models
between users at different sites.
• Installing Modeler on page 75 provides step-by-step instructions for each
installation type, including pre-installation and post-installation tasks. This
section also provides detailed environment requirements for each installation
type.
• Licensing Modeler on page 132 describes how to license Client Only and
Standalone installations of Modeler.
• Performing an Upgrade on page 165 describes how to upgrade Modeler.
• Setting up a backup procedure on page 183 describes how to back up your
databases and models.
• Setting up applications to work with Modeler on page 186 describes how to
set up integrated applications to work with Modeler.
• Uninstalling Modeler on page 200 explains how to uninstall the product.
• Configuration management use cases on page 203 helps you understand the
different Configuration Management features in Modeler.
• Useful Information on page 233 contains information that is referenced by
other parts of the installation guide.
• Troubleshooting on page 238 helps you with problems you may experience
while trying to install and set up Modeler.
Getting Started 9
Custom setup icons
When selecting features to install, the icon next to the feature name indicates the
install state of the feature. Click the icon to drop down the install state menu for
each feature.
This means the feature will be
completely installed to the local hard
drive.
This means the feature will have some
subfeatures installed to the local hard
drive.
This means the feature will not be
installed.
Choosing your Deployment Type

Use the table below to determine the most suitable type of deployment for your
site:

Deployment Type Description Installation Type
Individual User This is the simplest and Standalone
fastest deployment type
and should be used for
single user and
demonstration
environments. The
Standalone installation is
used for this deployment,
with all components
being installed on one
computer.
Click here to view the
Individual User
Deployment Checklist on
page 61.
Production — Workgroup This deployment type Server Only and Client
should be used for Only
production environments
for a workgroup of users
at a single physical
location. This deployment
uses Client/Server
architecture and therefore
requires Server Only and
Client Only installations.
Production – Workgroup
page 63.
Production — Enterprise This deployment type Server Only and Client
for enterprise-wide users
at multiple locations who
access shared data. This
deployment uses Client/
Server architecture and
therefore requires Server
Only and Client Only
installations.
Getting Started 11
Production – Enterprise
page 68.
Server Only, Client Only, or Standalone

Installations
Modeler is a client/server application:
• The server software is used to manage databases.
• The client software is used to develop the models that are stored on the
servers.
The Setup Type page of the Modeler installation program makes you choose one
of the following installation types of Modeler:
• Server Only - by default installs the server software on to a computer.
• Client Only - by default installs the client software on to a computer.
• Standalone - by default installs both the server and client software on to a
computer for single user use.
After the Setup Type page, the Custom Setup page allows you to change the
default installation options that are set up by the Server Only, Client Only or
Standalone option you selected. These options are set up as follows:
Server Only
Client Only
Standalone

Server Only Installation
A Server Only installation of Modeler installs the server software required for
setting up and managing Modeler Databases in a multi-user environment, that is,
databases that will be accessed by users on different computers.
A Server Only installation sets up a Floating License server, and allows access
permissions to be set up for Modeler users on other computers.
Perform a Server Only installation when you want to be able to create databases
and models that can be accessed by Modeler users on other computers.
In a Client/Server configuration, perform the server installations before
performing any client installations.
Client Only Installation

A Client Only installation of Modeler installs the client software required for
working with models, that is, the Modeler application and add-ins.
A Client Only installation sets up the Modeler application to work with a default
server for databases. In addition, a Client Only installation sets up Modeler to
work with a floating license.
Perform a Client Only installation when you want to able to use the Modeler
application with models that are always stored on other computers.
Tip: On the Custom Setup page, expand the Modeler Model Editor entry and
choose not to install any add-ins you do not require (click the entry, and then click
'This feature will not be available').
Standalone Installation
A Standalone installation is intended for single user use only.
A Standalone installation of Modeler installs the server software required for
setting up and managing Modeler Databases that will be accessed only from that
computer, and installs the client software required for working with models, that
is, the Modeler application and add-ins.
Perform a Standalone installation of Modeler when the main purpose of the
installation is as a client, but you require the server software to work locally with
models as a single user.
Getting Started 13
Note
When setting access permissions for Models stored on a Standalone
installation computer, only local users are available for selection. A
Standalone installation sets up Modeler to work with a local license.
If you want the client and server software to be installed on a computer, and also
want to be able to set access permissions for users on other computers, perform a
Server Only installation and on the Custom Setup page of the installation
program, choose to install the Modeler Model Editor.
Tip: On the Custom Setup page, expand the Modeler Model Editor entry and
choose not to install any add-ins you do not require (click the entry, and then click
'This feature will not be available').
Environment Requirements for Each

Installation Type
If your environment is not configured to the Modeler requirements, the installation
may fail.
The following table summarizes the key environment requirements for each
installation type.
Environment Server Only Client Only Standalone For More
Require- Installation Installation Installation Information
ments
Windows Yes Yes Yes See the
operating Modeler
system Release Notes
for supported
operating
systems.
Computer has Yes Yes Yes See the
enough free Modeler
disk space Release Notes.
Domain Optional - - See Checking
Administrator you are logged
rights on to Windows
(optional) with
Administrator
rights on page
234.

Environment Server Only Client Only Standalone For More
Require- Installation Installation Installation Information
ments
Windows Yes Yes Yes See Checking
Local you are logged
Administrator on to Windows
rights with
Administrator
rights on page
234.
Computer can Yes - Yes –
be restarted
during
installation
(upgrades
only)
Virus checkers Yes Yes Yes See Disabling
temporarily virus checkers
disabled during
installation on
page 236.
Note
For a complete detailed list of environment requirements for each installation
type, see Installing Modeler on page 75.
Default SQL Server Configuration
Note
This topic contains and refers to SQL Server 2017–specific information. If you
have installed a different SQL Server version, you must search for your
version-specific information at https://docs.microsoft.com.
Getting Started 15
The Windchill Modeler installation program sets up a SQL Server 2017 Express
instance named MODELER as part of Standalone and Server Only installations by
default. SQL Server provides database storage and management services. In
Model Explorer, databases are used to store, organize, and distribute models. For a
list of all supported versions of SQL Server, see the Release Notes document.
The following table outlines SQL Server system and Windchill Modeler databases
following an installation:
Database Description
System Databases – master, msdb, SQL Server System databases are
model, and tempdb hidden by default in Model Explorer.
For more information, see the following
SQL Server help topic:
System Databases
https://docs.microsoft.com/sql/
relational-databases/databases/system-
databases?view=sql-server-2017
StudioRestService Installed as part of Web Interface.
Contains Web Interface user account
information.
Examples Optional component—Contains the
Windchill Modeler Example Models.
Models Optional component—An empty
database that’s used to store Models.
Note
Your SQL Server instance may contain additional databases that are used by
programs and services other than Windchill Modeler.
The SQL Server Express Edition 2017 provided with Windchill Modeler has the
following limitations:
• CPU support is limited to one socket and up to four cores
• 1GB of RAM for each SQL Server instance
• 10GB maximum database size

Caution
If you have multiple SQL Server instances installed on one server, databases
names in each instance must unique for the server.
While Express edition is sufficient for Standalone Windchill Modeler installations,

these limitations can have a direct impact on performance for larger server
deployments.
For more information on supported features for each SQL Server edition, refer to
the following help topic:
Features Supported by the Editions of SQL Server 2017
https://docs.microsoft.com/en-us/sql/sql-server/editions-and-components-of-sql-
server-2017?view=sql-server-ver15
If your production requirements exceed the capabilities of Express Edition, you
should consider installing SQL Server Standard or SQL Server Enterprise.
To install Windchill Modeler using a SQL Server instance other than the one
provided with Windchill Modeler, do the following:
1. Install and configure a SQL Server instance. For more information on
supported SQL Server versions, refer to the Windchill Modeler Release Notes
document.
For more information on how to install and configure SQL Server, refer to the
following SQL Server help topic:
Install SQL Server 2017
https://docs.microsoft.com/en-us/sql/database-engine/install-windows/install-
sql-server?view=sqlallproducts-allversions
2. Run the Windchill Modeler installation program, and in the Installation
Wizard connect to your SQL Server instance:
• For Standalone; follow the instructions in Performing a Standalone
installation.
• For Server Only; follow the instructions in Performing a Server Only
installation.
3. Execute the adminscript_master.sql script on the master database of SQL
Server instance using SQL Server Management Studio.
To execute a script in SQL Server Management Studio, do the following:
a. On the computer running the SQL Server instance, start SQL Server
Managment Studio.
Getting Started 17
b. Connect to the SQL Server instance.
c. Click File, point to Open, then click File...
d. In the Open File dialog box, select the adminscript_master.sql script, then
click Open.
The full path to the script is C:\Program Files (x86)\Windchill
Modeler\Modeler\System\SQLScripts\adminscript_
master.sql
e. With the script open, select the master database from the drop-down list in
the SQL Editor toolbar, then click Execute.
f. Confirm that the Query executed successfully message appears.
Hardware Requirements
The following sections outline the minimum hardware specifications for
deploying Windchill Modeler in different scenarios. For optimum performance,
PTC recommends using at least 32 GB RAM and utilizing SSDs (solid state
drives) for the computer that will host the Modeler Server and SQL Server.
Hardware and Software Requirements for Installing SQL Server 2017
https://docs.microsoft.com/en-us/sql/sql-server/install/hardware-and-software-
requirements-for-installing-sql-server?view=sql-server-ver15
When it comes to storage and performance, PTC recommends solid state drives
(SSDs) These are faster than conventional hard disk drives (HDDs) and are also
more reliable and use less power. When considering disk speed in terms of
sequential or random read/write speeds, SSDs are 2 to 5 times faster than
conventional hard disks.
For information on SQL Server requirements and prerequisites, refer to the
Microsoft help topic:
Hardware and Software Requirements for Installing SQL Server 2017
https://docs.microsoft.com/en-us/sql/sql-server/install/hardware-and-software-
requirements-for-installing-sql-server?view=sql-server-ver15
For a list of all supported versions of SQL Server, see the Release Notes
document.
Windchill Modeler Client or Standalone Installation

For Client Only and Standalone installations of Modeler, we recommend a
computer with the following minimum specifications:
• Windows PC with a 3 GHz i5 processor
• 8 GB RAM recommended

• SVGA graphics, 1280x1024 minimum, 256 colors
• Supported Windows operating system - For more information, see the Modeler
Release Notes.
If the Client Only or Standalone installation is integrated with a Requirements
Management tool requiring both Modeler and the Requirements Management tool
to be running simultaneously, you should add the recommendations for CPU
throughput and RAM.
If you are using ACS to generate large quantities of code, or a Reverser to reverse
engineer large quantities of code, we recommend you use a computer that has 16
GB of RAM or more.
Windchill Modeler Server – Workgroup Deployment:

For Server Only installations supporting multi-user access of small models by up
to five concurrent users, we recommend a computer with the following minimum
specifications:
• Windows PC with a 3 GHz i5 or Xeon processor
• 8 GB RAM recommended (for SQL Server 2017 Express)
• SVGA graphics, 800x600 minimum, 256 colors.
• Supported Windows operating system - for more information, see the Modeler
Release Notes.
Windchill Modeler Server – Enterprise Deployment

If you want to support a greater number of concurrent users, or if you want to
store large models (for example, models that make a Database larger than 1 GB)
on a Modeler server, the recommended specifications may not provide a
satisfactory performance when performing operations that process a large number
of objects, such as check in and check out operations and versioning of models.
To maintain a good performance with a greater number of concurrent users or
large models, we make the following minimum recommendations:
• 3 GHz Xeon multi-core processor.
• 16 GB RAM recommended (for SQL Server 2017 Standard)
• Use fast SCSI disks (15,000 RPM) or equivalents.
• If you are using a RAID disk array, configure it as RAID 0. The RAID 5
configuration is not recommended because it performs poorly with large
numbers of small disk writes.
• Enable Write-caching on disks. Performance can be substantially improved by
enabling Write-caching, but if you do this ensure that the server has an
Uninterruptible Power Supply.
Getting Started 19
The following table suggests the minimum number of processor cores and the
minimum size of RAM that we recommend to support different numbers of users.
Number of Users Processor Cores RAM
10 4 16 GB
25 6 16 GB
50 6 32 GB
100 8 32 GB
200 8 32 GB
Note
Ensure that you have a working, regular backup procedure in place for your
models.
For more information, see Setting up a backup procedure on page 183.
Microsoft Remote Desktop Services and Citrix MetaFrame

Installations
If you set up a Modeler server and client on a Microsoft Remote Desktop Services
or Citrix MetaFrame computer, that computer must be powerful enough to run the
server and client software, along with any add-ins the remote clients choose to
use.
The following table suggests the minimum number of process cores and the
minimum size of RAM that we recommend to support different numbers of users.
Number of Users Processor Cores RAM
10 6 32 GB
25 8 32 GB
50 12 64 GB
100 12 64 GB
Administrator Rights Required for

Installing Modeler
Modeler is an enterprise-scale product that runs on the Microsoft SQL Server
database service. Therefore, it is very important (particularly for Server Only
installations) to understand the required environment so that installations of
Modeler are successful.

Standalone Installations
A Standalone installation is intended for local use. When performing a Standalone
installation, log on to Windows as a user that has local administrator rights.
Client Only Installations

When performing a Client Only installation, log on to Windows as a user that has
local administrator rights.
Administrator Rights Required during Installation

Successful installation of Modeler requires a basic understanding of domain
administration and network administration issues.
Windows can be set up in multiple ways, especially with regard to security and
user rights. If you attempt to install Modeler without having the appropriate rights
on the computer and its domain, the installation may not be successful. To avoid
these problems, all Modeler installations require you to log on to Windows with
Administrator rights. The following examples illustrate why this is the case:
• The installation program adds information to the Windows registry. On many
Windows networks, it is common for registries to be protected using user
rights. Logging on with Administrator rights means that the installation will
not encounter access permission problems.
• The Server Only and Standalone installations install a service named
Microsoft SQL Server. Typically, user rights are set to stop users changing
Windows services, therefore, Administrator rights are required to ensure that
the Microsoft SQL Server service is set up correctly.
If you choose to install Web Interface, the installation program creates a PTC-IM-
WSU user account on the local computer.
The Local PTC-IM-WSU User Account

If you choose to install Web Interface, the installation program creates a Windows
user account named PTC-IM-WSU. The Web Interface website uses the PTC-IM-
WSU user account to access models. During the install of Web Interface you must
set a password for the PTC-IM-WSU account. You can accept the default
password, or enter a new password. The default password for the PTC-IM-WSU
user account is: P8=:nc((pgChTt%f
It is recommended that you change the password of the PTC-IM-WSU user
account to make it secure. The password can be changed during the Modeler
installation process, or after installation by updating the PTC-IM-WSU Windows
user account.
Getting Started 21
Note
After changing the PTC-IM-WSU password, you must use Internet
Information Services (IIS) to update the Windchill Modeler Web Interface
application pool to use the new password.
See Licensing a Web Interface website on page 103 and selecting the
databases it can access for more information.
Installation Components
It is worth taking the time to understand the Modeler components that can be
installed.
The Setup Type page of the Modeler installation program makes you choose a
Server Only, Client Only or Standalone installation.
The Custom Setup page allows you to change the default installation options that
are set up by the Server Only, Client Only or Standalone option you selected. If
you require additional components at later date, you can repeat the installation and
select additional components to install.
Note
Through the installation program you can also remove components you want
to uninstall.
Summary of Components Installed by Default by Each Installation

Type
The following table shows which components are installed or selected by default
for each installation type.
Component Server Only Client Only Standalone
Installation Installation Installation
Microsoft ® SQL Yes – Yes
Server ® Express
2017
Floating License Yes – –
Server
Example Models Yes – Yes
and Databases
Model Explorer Yes Yes Yes

Component Server Only Client Only Standalone
Installation Installation Installation
Modeler - Yes Yes
Web Interface - – –
Add-ins - Yes Yes
Microsoft SQL Server

Stores and runs databases.
SQL Server is installed by default as part of a Standalone and Server Only
installation. Microsoft SQL Server Express 2017 runs as a service named SQL
Server and supports multi-user access of its databases.
Floating License Server

Manages a server-based floating license through FLEXnet Publisher.
The Floating License Server runs a service on the server (Windchill Modeler
License Server) and is installed by default as part of a Server Only installation.
Example Models and Databases

You can install the following Databases:
• Empty Databases – an empty database in which you can create your models.
The database is named Models when installed.
• Examples – a database that contains example models, such as the HSUV
model, which is referenced by the Modeler Tutorial.
The models are installed by default as part of a Standalone and Server Only
installation.
Model Explorer
Accesses databases that contain models you want to work with. If you want to
work with a model, you must locate (and optionally bookmark) its database in
Model Explorer. In addition, Model Explorer allows you to manage models, for
example, importing, exporting and versioning of models.
Model Explorer is installed as part of a Standalone, Server Only and Client Only
installation.
Modeler Model Editor

Maintains models that are stored in a database.
Modeler is the main tool for developing a model and it is installed by default as
part of a Standalone and Client Only installation.
Getting Started 23
Web Interface
Allows users to view Models through their web browser.
Add-ins
Optional tools that perform functions such as document generation and code
generation. Most of the add-ins are installed by default as part of a Standalone and
Client Only installation, however, some add-ins are dependent on other
applications being installed. For example, Integration for IBM Rational DOORS is
installed only if IBM Rational DOORS is installed.
Windows .NET Framework and Java SE Runtime Environment

For information about the which versions of the Windows .NET Framework is
installed, see the Modeler Release Notes.
The Modeler installation program installs the following applications:
• Windows .NET Framework – to install Windows .NET Framework you
require Windows Installer 3.1 or later installed on your computer.
Note
Installing the Windows .NET Framework can take up to 10 minutes; during
installation, the Cancel button on the dialog is not available.
• Java SE Runtime Environment – required by XMI Import/Export. If you want

to use XMI Import/Export, you must download and install the 32–bit version
of Java 8 JRE.
Installation Configurations
There are different deployment options and installation configurations for
Windchill Modeler:
• Individual user deployment
This is the simplest option and is suitable for individual users or test
environments. This deployment utilizes the standalone configuration.
• Production – workgroup deployment
This option is suitable for production environments and can support small and
medium sized workgroups. This deployment options utilizes client/server
configuration.
• Production – enterprise deployment

This option is suitable for production environments and can support small and
medium sized workgroups. This deployment options utilizes client/server
configuration.
Individual User Deployment

This deployment type utilizes the Standalone installation configuration and allows
the Windchill Modeler Server and Client to run on a single computer. The
following diagram shows how the components of a Standalone installation work
together.
Use the Standalone configuration only when you have a requirement to run the
client software and the server software in a single user environment, that is, a
requirement to use local databases. A Standalone installation can also access
remote databases if required.
PTC recommends using SQL Server Express as a database for this type of
deployment. SQL Server Express is bundled with Windchill Modeler and can be
automatically installed with Windchill Modeler.
Getting Started 25
If only the client software is required, perform a Client Only installation in
preference to a Standalone installation as this will have less effect on the
computer's resources.
Production – Workgroup Deployment

This deployment option utilizes a client/server installation configuration and
allows multiple users to share and work with models that are stored in databases
on a server. PTC recommends using this deployment when working in a small and
medium sized workgroup environment.
Client computers are installed with only the software required for developing
models (including software for add-ins), while the server computers are installed
with only the software required for managing databases and storing models.

The client software can access models stored in databases on many servers
through Model Explorer. In a client/server configuration, perform the server
installation before performing any client installations.
If only the client software is required, perform a Client Only installation in

preference to a Standalone installation as this will have less effect on the
computer's resources.
Production – Enterprise Deployment

To ensure optimum performance for distributed locations or where network
performance is not acceptable, application virtualization (Microsoft Remote
Desktop Services (RDS) or Citrix MetaFrame) should be used. This requires RDS
to be enabled or Citrix Server to be installed on the Windchill Modeler Server or
another server. Windchill Modeler Client must also be installed on this computer
and be able to access the Windchill Modeler Server.
For clients in distributed locations, RDS must be enabled or Citrix Client installed,
and they must be able to access the computer with RDS or Citrix Server.
Windchill Modeler Client does not need to be installed, as access to Windchill
Modeler is provide virtually.
PTC recommends using this deployment for optimum performance when working
in a large, distributed enterprise environment.
Getting Started 27
PTC recommends using SQL Server Standard as a database for this type of
deployment for optimum performance. This must be installed before installing
Windchill Modeler, or an existing SQL Server Standard instance can be used.
During installation of Windchill Modeler, a database will be created and
configured in the selected SQL Server instance.
Installing Modeler for a Project Team

This section describes the installation of Modeler for a project team using a
central server and many client computers. The project team includes both static
and mobile team members. The static team members are permanently connected
to the network, the mobile team members sometimes work on project data when
not connected to the network.
For information about working across sites, see Overview of working across sites
on page 40.

Step Consideration
1. Perform a Server Only installation on Which server will be used to share
the project server. information? The server needs to be
accessible to all team members.
2. Create the databases required for the Use a single database to group related
project. work. It makes sense to place related
models within the same database.
3. Perform a Client Only or Standalone A Client Only installation requires less
installation on each team member's computer resources than a Standalone
computer. installation. A Client Only installation
can be upgraded to a Standalone by
performing a Standalone or Server
Only installation on that computer.
For static team members Perform a Client Only installation.
For mobile team members Perform a Standalone installation.
If a Standalone user does not require
local storage, they can save resources
by either:
• Unbookmarking, stopping and
deleting local databases, and
stopping the database service.
• Uninstalling the Standalone
installation and performing a Client
Only installation.
Getting Started 29
Installing Modeler Through a Customized
MSI File
When you install Modeler, the Modeler installation MSI file
(WindchillModeler9_x.msi) determines the default options that are used
for the installation program. These default options can be changed in the pages of
the Modeler installation wizard.
If you are rolling out Modeler to a large number of users, you can create a
customized version of the Modeler installation MSI file so that the default options
result in the required installation of Modeler.
This topic covers setting the default installation folders for Modeler, and setting
up the default license server and database server.
In addition to rolling out Modeler through a customized MSI file, you can perform
administrator installs by installing Modeler through the Windows Installer
(msiexec.exe) command line interface and passing installation parameters
through command line arguments. You can also make use of Systems
Management Server (SMS) to install Modeler. These methods for installing
Modeler are not covered in the Help. For more information, contact customer
support.
Note
• Changing properties in the Modeler MSI file that are not covered in this topic
may result in invalid installations of Modeler and can potentially damage your
Windows system.
• After modifying the Modeler installation MSI file, thoroughly test the changes
you have made to ensure that it creates a valid Modeler installation.
Orca Database Editor

You can use the Microsoft Orca database editor to change the Modeler installation
MSI file.
The Orca database editor is provided with the Windows Installer SDK. For
information about installing the Orca database editor, see How to use the Orca
database editor to edit Windows Installer files.
Modeler Installation MSI file

Copy the Setup folder to a network location and then make the required changes
to the Modeler installation MSI file (WindchillModeler9_x.msi) through
the Orca database editor.

Users can then install Modeler through the Modeler installation exe application
(WindchillModeler9_xSetup.exe), which will then call the modified
MSI file.
Changing the Installation Path for Modeler

From the Orca database editor, open the Modeler installation MSI file
(WindchillModeler9_x.msi) you want to change.
In the Tables pane, select the Directory entry, and in the adjacent pane locate the
INSTALLDIR entry in the Directory column. The INSTALLDIR entry specifies
the top-level folder for the Modeler installation.
By default:
• The INSTALLDIR entry references the ARTISAN_SOFTWARE_TOOLS
entry.
• The ARTISAN_SOFTWARE_TOOLS entry creates the Windchill Modeler
folder in the Program Files folder.
• The ARTISAN_REAL_TIME_STUDIO entry creates the Modeler folder as a
subfolder of the Windchill Modeler folder.
Note
ProgramFilesFolder is a special property for specifying the Windows Program
Files folder.
For more information on these special properties, see the Windows Installer
Guide.
In the following example, we want to install Modeler to a folder named C:

\MyFolder:
• The new MY_FOLDER entry creates the MyFolder folder in Windows volume
(typically C:).
• The INSTALLDIR entry is changed to reference the MY_FOLDER entry. Note
that WindowsVolume is another special property and the ARTISAN_
SOFTWARE_TOOLS entry is no longer used.
• The ARTISAN_REAL_TIME_STUDIO entry creates the Modeler folder as a
subfolder of the MyFolder folder.
Getting Started 31
Following on from the previous example, we now want to install Modeler to a
folder named C:\MyFolder\MySubfolder:
• The new MY_SUBFOLDER entry creates the MySubfolder folder as a
subfolder of the MyFolder folder.
• The INTALLDIR entry is changed to reference the new MY_SUBFOLDER
entry.
Changing the default license server and database server instance

Often you will want to specify a default license server and database server
instance to use.
From the Orca database editor, open the Modeler installation MSI file you want to
change.
In the Tables pane, select the Property entry, and in the adjacent pane find the
ART_DEFAULT_LICENSE_SERVER and ART_DEFAULT_REP_SERVER
entries in the Directory column. The values set appear as defaults in the Modeler
installation program.
In the following example, we change the default license server to LS001, and
change the default database server instance to RepServ001.
Other MSI properties that can be configured

• ART_INSTALL_CODE_SYNC — possible value can be either 0 or 1

• ART_INSTALL_DOORS — possible value can be either 0 or 1
• ART_INSTALL_SYNC_ACS — possible value can be either 0 or 1
• ART_INSTALL_SYNC_ADA — possible value can be either 0 or 1
• ART_INSTALL_SYNC_C — possible value can be either 0 or 1
• ART_INSTALL_SYNC_C_PLUS — possible value can be either 0 or 1
• ART_INSTALL_SYNC_JAVA — possible value can be either 0 or 1
• ART_INSTALL_SYNC_SHADOW_TDK — possible value can be either 0 or 1
• ART_INSTALL_SYSML — possible value can be either 0 or 1
• ART_INSTALL_XMI — possible value can be either 0 or 1
• ART_SETUP_TYPE — possible values can be: Client, Server or
Standalone
• ART_DEFAULT_LICENSE_SERVER — value is <<Name of the
License Server>>
• ART_DEFAULT_REP_SERVER — value is <<Name of the Repository
Server>>
• ART_DOC_GEN_PAPER_SIZE — possible value can be: A4, Normal or
None
• INSTALL_DOC_GEN — possible value can be either 0 or 1
• INSTALL_ENABLER_SERVER — possible value can be either 0 or 1
• INSTALL_MENTOR — possible value can be either 0 or 1
• INSTALL_MODEL_EDITOR — possible value can be either 0 or 1
• INSTALL_REPOSITORY_EXAMPLES — possible value can be either 0 or 1
• INSTALL_REPOSITORY_MODELS — possible value can be either 0 or 1
• ART_CREATE_EXAMPLES — possible value can be either 0 or 1
• ART_CREATE_MODELS — possible value can be either 0 or 1
Renaming a Modeler Computer or its

Domain After Installation
If after installing Modeler on a computer you need to rename that computer or its
domain, please contact Customer Support before doing so.
Renaming a Modeler computer or its domain can result in not being able to open
models that you could previously open.
Getting Started 33
Managing Modeler and Web Interface
Security
Microsoft SQL Server
Microsoft SQL Server is the Modeler database engine. The server runs as a
windows service named sqlservr.exe on port 1433.
For information on how to change the default port number, refer to the following
Microsoft SQL Server help topic:
Configure a Server to Listen on a Specific TCP Port
https://docs.microsoft.com/sql/database-engine/configure-windows/configure-a-
server-to-listen-on-a-specific-tcp-port?view=sql-server-2017
You should also ensure that the relevant ports are opened and secured.
For more information, see Setting up the Windows Firewall on page 87.
Network Shares
The following network share is created:
• ModelerATF – contains information on the models that are needed to locate
the model when communicating with the Microsoft SQL Server service.
Those shares are used by the Modeler application to get the appropriate
information on how to locate Microsfot SQL Server, databases, and models.
Note
The contents of the database (models) is not exposed in those folders.
Shares use the standard Microsoft SMB network shares that operate on port 445.
By default, those folders are publicly shared, but the visibility can be restricted by
modifying the sharing configuration through the Windows sharing properties.
The following sharing properties are required:
• ModelerATF – all Modeler users should have Write permissions for the
share property, associated folder, subfolders, and files.

Note
By default, Everyone is granted Full Control to the share folder. You should
restrict this so that only Windchill Modeler users have access, and only
Administrators have Full Control.
Access Rights Management

You can define access rights at database level to define database administrators.
Administrators are users that are allowed to perform administrator functions on
the Database. For example: Start, Stop, Backup, and Restore.
Using Model Explorer, you can define user access rights at the following levels:
• Database — sets database access permissions for users and groups for a
specific database. For example: Read, Write, and Owner.
• Model — sets model access permissions for users and groups for a specific
model. For example: Read, Write, and Owner.
• Package — sets package access permissions for users and groups for a specific
package. For Example: Write and Owner.
If a user has read access to a model, they can see the contents of the entire
model. However, they cannot modify the items without Write permissions for
the relevant package.
For more information, see Controlling Access Using Package Protection and
Access Rights on page 209.
Modeler Client, Automation Interface and Simulation

The Modeler client interacts with the database through TCP/IP and the user is
authenticated using a Trusted Connection (usually the user’s Windows
credentials).
The Automation Interface enforces the access rights rules that are defined on
databases, models, and packages. For example, if a user does not have read access
to a model, they will not be able to access the model information through the
Automation Interface.
The Modeler UI uses port 15777 to receive instrumentation from simulation code
generated from a model. The sender and receiver are typically on the same
machine so access is not required from anywhere else on the network.
Getting Started 35
FlexLM Server (license)
The license mechanism relies on FlexLM. The following programs or ports need
to be set up as firewall exceptions. In each case, the path shown is for a Modeler
installation to the default locations. For more information, see Setting up the
Windows Firewall on page 87.
For 64-bit versions of Windows:
• C:\Program Files (x86)\Windchill Modeler\License
Manager\lmgrd.exe (for Floating License Server)
Manager\artsansw.exe (for Floating License Server)
• C:\Program Files\Windchill Modeler\License Manager\
lmgrd.exe (for Floating License Server)
artsansw.exe (for Floating License Server)
You should also ensure that the relevant ports are open and secure. For more
information on ports and setting up the firewall, see Setting up the Windows
Firewall on page 87.
Windchill Modeler Web Interface

Windchill Modeler Web Interface allows you to view the content of a model
through a web browser. By default, Windchill Modeler Web Interface is installed
using HTTPS and requires a security certificate to be configured.
The Web Interface is an optional feature.
Note
When you grant a user access to a Web Interface website, they can view all
models that are set to Public Read or Public Write in all databases that can be
accessed through the website.

When you choose to install Web Interface, the Modeler installation program
creates a Windows user account named PTC-IM-WSU, with a default password.
You can change the password during the installation process, or after installation
has completed. The Web Interface website uses the PTC-IM-WSU user account to
access models.
Note
To ensure security, we recommend changing the PTC-IM-WSU user account
password.
You can set up how users are authenticated when they log in to a Web Interface
website. You can use:
• LDAP authentication,
• Web Interface website account authentication (local accounts created through
the Web Interface administration),
• Both LDAP and Web Interface website account authentication
Getting Started 37
When using LDAP authentication, a user can view the following models through
the Web Interface website: models that are Public Read or Public Write; and
models for which the user has Modeler Owner, Write or Read access permissions.
The installation program sets up the Web Interface and Model Manager websites
as HTTPS. You can configure HTTP for the websites if required. For information
on configuring Websites as HTTP, see Configuring the Web Interface website to
use HTTP on page 123.
Firewall rules must be added to allow access to the Modeler sites which are
configured by default.
For more information, see Setting up the Windows Firewall on page 87.

2
Working Across Sites
Overview of Working Across Sites ..............................................................................40
Direct Access of a Remote Model from Modeler...........................................................42
Direct Access of a Remote Model Through Microsoft Remote Desktop Services or
Citrix MetaFrame ...................................................................................................43
Local Editing of Packages that are Imported from a Sandbox of a Remote
Model....................................................................................................................45
Local Editing of Packages that are Imported from a Remote Model and then
Protected ..............................................................................................................47
Local Editing of Models that are Stored in an Integrated CM tool ...................................49
Local Editing of Models that are Stored in Shared Folders ............................................51
Collaboration when working offline..............................................................................55
39
Overview of Working Across Sites
For a Modeler client to work directly with a model on a Modeler server, ideally
you want a connection that has a latency of less than one 1 millisecond. As the
latency of a connection increases from 1 millisecond, the performance and
responsiveness of the Modeler client decreases. When a connection cannot
support direct editing of remote models, you should consider which of the
available solutions works best for you.
The following table summarizes the solutions that are available for accessing
remote models based on the strength of the connection you have between sites.
To perform cross-site working it is essential to clearly identify the responsibilities

and ownership of all project data. The physical separation of team members
creates an additional barrier to communication however, Modeler can be used to
reinforce these responsibilities and ownership.
These are the preferred solutions that allow you to directly edit
remote models:
• Direct access of remote models from Modeler on page 42
This solution requires a high-bandwidth, low-latency connection between the
Modeler client the server software.
This is the simplest solution, but will often not be possible across sites.
• Direct access of remote models through Microsoft Remote Desktop Service or
Citrix MetaFrame on page 43
This solution can provide direct editing of remote models when the latency
and bandwidth of the connection is not fast enough for an acceptable
performance of Modeler, but is fast enough to support Microsoft Remote
Desktop Services or Citrix MetaFrame.

These are the preferred solutions that allows you to edit remote
models when the connection cannot support direct access of those
models. These solutions import Packages from a remote model to a
local model so that those Packages can be edited locally:
• Local editing of Packages that are imported from a sandbox of a remote model
on page 45
This solution requires an email or FTP connection.
This is the safest way of editing a remote model by importing the Packages
from a sandbox of the remote model to a local model. The sandbox features of
Modeler ensure that the changes you make to the local model are intelligently
reconciled to the remote model.
This solution has the benefit of allowing items to be changed in both the
remote and local models with any clashes being resolved at the time of
reconciliation.
• Local editing of packages that are imported from a remote model and then
protected on page 47
This solution requires an email or FTP connection.
This solution imports Packages from the remote model to a local model for
editing, and then exports those Packages back to the remote model after the
required changes have been made. While Packages in the remote model are
being edited in a local model, those Packages must be protected in the remote
model so that they cannot be changed by other users.
This solution has the disadvantage of the Packages being edited must be
mostly self-contained in the remote model, so that when those Packages are
protected they do not prevent further development of the remote model.
These are non-preferred solutions that allow you to edit remote

models through a master model being stored in a CM tool or a shared
folder:
• Local editing of models that are stored in an integrated CM tool on page 49
This solution requires use of an external Configuration Management tool (CM
tool) that is integrated with Modeler.
This solution stores the master version of a model (as Package export files) in
a CM tool. The CM tool integration and CM tool features are used to provide
access and change control to that model.
• Local editing of models that are stored in shared folders on page 51
This solution requires a folder that all users can access, such as a network
folder.
Working Across Sites 41

This solution stores the master version of a model (as Package export files) in
a shared folder. This solution provides configuration management of a Model
without the need to integrate Modeler with a configuration management tool.
However, this solution needs to be carefully managed to ensure that different
users do not edit the same Packages at the same time.
Direct Access of a Remote Model from

Modeler
This solution is the simplest way to work across sites, but for a reasonable
performance you must have a high-bandwidth low-latency connection between the
sites.
Ideally you want a connection that has a latency of less than one 1 millisecond. As
the latency of a connection increases from 1 millisecond, the performance and
responsiveness of the Modeler client decreases.
Note
You can reduce network traffic by hiding the status bar, toolbars and the
Property Pages when not in use.
The following diagram illustrates a potential configuration for working across

sites in this way.
The following table summarizes the advantages and disadvantages of working

across sites in this way:

Advantages Disadvantages
Simple configuration and You require a permanent high-
implementation. bandwidth low-latency connection
Direct access of the model, so changes between the sites.
are immediately seen by other users of
the model.
No administration requirements for
transferring information across sites.
Direct Access of a Remote Model

Through Microsoft Remote Desktop
Services or Citrix MetaFrame
When the latency of the connection between the Modeler client and server is such
that the performance of Modeler is not acceptable to you, you may be able to
access the models on the Modeler server directly by using Microsoft Remote
Desktop Services (RDS) or Citrix MetaFrame (Citrix).
In this scenario, the latency of the connection is not fast enough for an acceptable
performance of Modeler, but it is fast enough to support RDS or Citrix. When this
is the case, you can use RDS or Citrix to run the Modeler client software on the
Modeler server site. Remote users run the Modeler client software through RDS
or Citrix client software.
sites in this way.

• Greatly reduces network traffic • You require a permanent connection
across sites. between the sites, but it does not
• Direct access of the model, so have to be a high-bandwidth low-
changes are immediately seen by latency connection.
other users of the model. • You need to install Microsoft
• No need to install Modeler on the Remote Desktop Services or Citrix
client computers. MetaFrame.
The following table outlines the steps for setting up the sites:
Step Consideration
1. On the server site, perform a You must perform a Server installation
Modeler Server installation. to install the floating license software.
The SQL Server and Floating License
Server software can reside on any site
computer.
2. On the server site, install the
Microsoft Remote Desktop Services/
Citrix MetaFrame server software and
the Modeler client software.

Step Consideration
3. Set up a floating license for clients.
Define the default user settings.
4. Each user that wants to run Modeler
uses the Microsoft Remote Desktop
Services/Citrix MetaFrame remote
client software to run Modeler from the
Microsoft Remote Desktop Services/
Citrix MetaFrame computer.
Local Editing of Packages that are

Imported from a Sandbox of a Remote
Model
When the connection between the Modeler client and server is not fast enough to
support Microsoft Remote Desktop Services or Citrix MetaFrame, or if there is no
direction connection between the Modeler client and server, you cannot work with
the models on the Modeler server directly. However, you can still work with a
model on the Modeler server using sandboxes, and exported and imported
package files.
A sandbox allows parallel development of a model. When the changes in a
sandbox are complete, you can merge those changes back to the trunk of the
model through a reconcile operation. For more information about sandboxes, see
the Database-based Configuration Management section of the Modeler Help.
sites in this way:

• No fast connection is required If you intended to work on a model
between the sites. through a sandbox, the only
• Changes that are made locally are disadvantage of this solution is having
intelligently merged to the remote to import and export the packages.
model.
• Work on the remote model can
continue in parallel while changes
to that model are being made
locally.
Step Consideration
1. On the server site, perform a server You must perform a Server installation
installation of Modeler. to install the floating license software.
2. On the client site, depending on
whether you want multiuser access to
the model, perform a Server installation
or Standalone installation of Modeler.
3. On the server site, create a sandbox When working with sandboxes, you
for the model you want to edit. may want to change the trunk only
through sandboxes.

Step Consideration
4. On the server site, use Modeler
Explorer to export the sandbox.
5. On the client site, import the sandbox
model to your database.
6. On the client site, make the required
changes to the model.
7. When the work is complete, export • For large models, you may want to
all the packages from the model on the export only packages that have
client site to the sandbox on the server changed.
site. • You can use the Component
Sharing Wizard or Package Import/
Export to export and import
packages. The Component Sharing
Wizard has the benefit of
identifying potential problems, such
as stub generation.
8. On the server site, reconcile the Before reconciling a sandbox, it is good
sandbox to the trunk of the model. practice to rebase sandbox first. This
allows conflicts to be resolved in the
sandbox rather than the trunk.
Local Editing of Packages that are

Imported from a Remote Model and then
Protected
This solution exports selected Packages from a model on the server site to a model
on the client site for editing. After exporting the Packages from the server site,
those Packages are set to Protected on the server site. After changing the Packages
on the client site, they are exported back to the model on the server site, and those
Packages are set to unprotected.
sites in this way.

• No fast connection is required • The Packages that are exported for
between the sites. changing need to be self-contained
• Changes made locally can be with low coupling to other parts of
simply imported to the remote the model on the remote site.
model. • The Packages that are exported to
client site cannot be changed on the
server site while they are being
worked on remotely, because they
will be protected. This can
potentially restrict development of
the remote model.
Step Consideration
1. On the server site, perform a server You must perform a Server installation
installation of Modeler. to install the floating license software.
2. On the client site, depending on
whether you want multiuser access to
the model, perform a Modeler Server
installation or Standalone installation.
3. On the server site, protect that

Step Consideration
Packages that you want to edit on the
client site.
4. Export the Packages from the server You can use the Component Sharing
site, and import the Package files to a Wizard or Package Import/Export to
model on the client site. copy Packages from one more to
another. The Component Sharing
Wizard has the benefit of identifying
potential problems, such as stub
generation.
5. On the client site, make the required
changes to the Packages in the model.
6. When the work is complete, export For large models, you may want to
all the packages from the client site export only Packages that have
model, and import the Package files to changed. If you do this using the
the model on the server site. Component Sharing Wizard, it will
report any potential problems when
importing the Packages.
7. On the server site, unprotect the
Packages that you protected in Step 3.
Local Editing of Models that are Stored in

an Integrated CM tool
This solution provides the most controlled solution for working across sites. The
Modeler model is stored in a CM tool. If a site wants to work with the model, they
create a replica of the model in their Modeler environment.
Each site checks out Packages they want to change. While a Package is checked
out, other sites cannot change that Package. After making the required changes,
the site checks in their Packages. To use the CM tool integration, you require a
live connection between the sites, a Modeler license and a CM Integration license.
For more information about configuration management tool integration, see the
Modeler User's Guide.
sites in this way.

with replicas of CM tool models:
CM tool change control ensures that • CM tool change control ensures that
only one site makes changes to a only one site makes changes to a
Package at any given time. However, Package at any given time.
this could be seen as a disadvantage as However, this could be seen as a
well. disadvantage as well.
• Using an external CM tool with a
model disables the database-based
configuration management features
of Modeler for that model.
• This solution does not support
parallel development of a model.
• Other users see your changes only
after you have checked in the
associated Packages, and the other
users have then updated their
models through Get or Check Out
operations on those Packages.

Step Consideration
1. Perform a Server Only installation on A server will be required for each site.
each project site.
2. Install the CM tool server software Decide which site is going to be
on one site, and the CM tool client responsible for the CM tool server,
software on both sites. including backups.
3. Determine the split of work between • Within a model, use Packages to
the sites and set up the Package group items assigned to each site.
hierarchy and Package access • The access permissions of the
permissions accordingly. Packages should re-enforce the
work ownership. For example, for
Packages owned by site A, site A
team members should have write
access and site B team members
should have read-only access.
Alternatively, the Protected
property of Packages could be set to
control access on each site.
Local Editing of Models that are Stored in

Shared Folders
This solution stores a Modeler model as Package export files in a shared folder. If
a site wants to work with the model, they create a replica of the model in their
Modeler environment.
Each site imports the Packages they want to change from the shared folder. After
making the required changes in Modeler, the site exports the Packages they have
changed back to the shared folder.

Note
You must devise a mechanism that ensures that only one site is allowed to
make changes to a Package at any given time.
For example, you can have a shared spreadsheet that lists the Package export
files; a site must update the spreadsheet to record that they intend to change a
Package by 'signing out' that Package before importing the Package from the
shared folder. After that site has made their changes and exported the Package
back to the shared folder, they update the spreadsheet to record that the
Package is available for other sites to change by 'signing in' the Package.
sites in this way:
The following table summarizes the advantages and disadvantages of local

editing:

Disadvantages Disadvantages
Changes are available to other users • You must set up and enforce a
only after the changed Packages are mechanism to ensure that only one
exported to the shared folder, so you site changes a Package at any given
can prevent other users from seeing time. Failure to do so can result in
transitional changes to the Packages lost data.
you are changing. • Live TCP/IP connection is required
between the sites and the shared
folder.
• Other users see your changes only
after you have exported the
associated Packages to the shared
folder, and the other users have then
imported those Package files to
their models.
The following table outlines the steps for storing a Modeler model in a shared
folder:
Step Consideration
1. From Modeler, set up the 'base' Try to minimize future changes to the
model as required. Package hierarchy by finalizing the
Package hierarchy as much as possible.
2. Set up the access permissions in the Warning: Modeler model access
'base' model as required. permissions cannot always be enforced
in a remote database. See Chapter 4 -
Working with Access Permissions in
the Modeler User's Guide.
3. Set the Model and each Package to After setting the Protected check box of
protected by selecting the Protected the Model or a Package, you can set the
check box on the Access Permissions Protected check box of all child
tab of the Model and Package Property Packages to the same value through the
Pages. Copy Protected Flag to Child
Packages button.
4. Set up a shared folder on the WAN. All sites must be able to access the
shared folder.
5. Export the base Modeler Model to After exporting to the shared folder, the
the shared folder; from Modeler, right- Package files in the shared folder
click the Model in the Packages pane, should be considered the definitive
and select Tools ▶ Package Import/ version of the model.
Export ▶ Export (export sub-Packages)

The following table outlines the steps for setting up a site to use a model that is
stored in a shared folder.
Step Consideration
1. Perform a Server Only installation on A server will be required for each site.
the site.
2. From Model Explorer, bookmark the
Database in which you want to create a
replica.
3. Create a replica: from Model • As an alternative to steps 3 and 4,
Explorer, right-click the required you can use Model Explorer to
Database, point to Create Replica, and export the complete base model,
then click From Directory (select the and then import the model to the
shared folder). new site.
• Note that the Packages are created
as stubs.
4. From Modeler, open the replica you
created, right-click the Model in the
Packages pane, select Tools ▶ Package
Import/Export ▶ Update Existing (select
the shared folder).
The following table outlines the steps for getting changes that have been made by
other users to a Package that is stored in a shared folder.
Step Consideration
1. From Modeler, right-click the • When Modeler gets a Package, it
Package, select Tools ▶ Package Import/ gets the Package and all its child
Export ▶ Update Existing, and then click Packages.
Update Existing (select the shared
folder). • Do not get an unprotected Package
or a Package that contains
unprotected child Packages. If you
get an unprotected Package, any
changes you have made to the
unprotected Package will be lost.
The following table outlines the steps for making changes to a Package that is
stored in a shared folder:

Step Consideration
1. Ensure that no other sites are If you are using a spreadsheet to record
changing the Package you want to what changes are being made, 'sign out'
change, and then record that you are the Package you want to change.
going to make changes to that Package.
2. From Modeler, right-click the
Package, and select Tools ▶ Package
Import/Export ▶ Update Existing (select
the shared folder).
3. Set the Package and its subpackages Clear the Protected check box on the
to unprotected. Access Permissions tab of the
Package's Property Pages.
4. Make the required changes to the
Packages.
5. Right-click the Package, and select
Tools ▶ Package Import/Export ▶ Export
(select the shared folder).
6. Set the Package and its subpackages Select the Protected check box on the
to protected. Access Permissions tab of the
Package's Property Pages.
7. Record that the Package is now If you are using a spreadsheet to record
available for other sites to change. what changes are being made, 'sign in'
the Package you have changed.
It is important to consider the following:

• Before changing a Package, always ensure that no other sites are making
changes to that Package.
• Always 'sign out' a Package before making any changes to a Package. After
'signing out' a Package, always perform an Update Existing operation to
ensure that you have any changes made by other users.
• Do not perform an Update Existing operation on an unprotected Package,
unless you want to lose any changes you have made.
Collaboration when working offline

In this topic, we discuss how you can work with models when you are not
connected to the centralized server. While working offline, you can work on
models, make the required updates or changes to the models, and then consolidate
the changes to the corresponding models and local databases when connected to
the server. You can do this with a 2–way/3–way merge that is explained in this

topic. With this method, you do not have to check-out or lock the model that you
will be working on in the offline mode. The following diagram illustrates the
workflow involved, the steps of which are explained further down.
Steps explaining the process to work on models offline

1. Create a sandbox.
Create a sandbox of the model that you will be working on in the offline
mode. This sandbox will receive the changes that you would make to the
model when offline. You do not have to checkout the model or mark the areas
that you anticipate to change.
2. Export the model.
Export the required model that will be imported for offsite changes.
3. Version the model.
When you create the sandbox, the base version will be read-only version.
Therefore, you must version the model to continue working onsite.
4. Import the model.
You need to import the model allowing you to work on the whole model.
5. Version the model, again.
You need to version the model again for a couple of reasons; to make the
model editable as the model that you had exported was a read-only model, and
the other reason is to allow you to track the changes you make to the model.
6. Work on the model, make the required changes.
Once you are done working on the model, generate a Diff report to identify
which parts of the model need to be sent to the sandbox that you had created in
Step 1.
7. Create a component sharing file.

This component sharing file will contain all the information about the changed
packages in the model. This will be needed later to update the sandbox.
8. Import component into sandbox.
Use the component sharing file to update the changes to the model in the
sandbox.
9. Reconcile the sandbox.
In this step, you merge the changes into a new trunk version of the model. You
can directly resolve the differences and clashes in the model.
10. Optional: Conflict resolution.
In this step, you will need to manually resolve all conflicts; conflicts such as,
ordering contained elements or resolving completely different textual
information. You can use the Diff report that includes links to the elements
that need resolving.

3
Planning for Windchill Modeler
Installation
Considerations for a New Installation Based on Deployment Type.................................59
Choosing your Deployment Type ................................................................................59
Individual User Deployment Checklist .........................................................................61
Production — Workgroup Deployment Checklist ..........................................................63
Production — Enterprise Deployment Checklist ...........................................................68

Considerations for a New Installation
Based on Deployment Type
This chapter goes through the process of planning an Windchill Modeler
installation based on deployment type.
There are three types of Windchill Modeler deployment: Individual User,
Production Workgroup and Production Enterprise.
Choosing your Deployment Type

Use the table below to determine the most suitable type of deployment for your
site:
Planning for Windchill Modeler Installation 59

Individual User This is the simplest and Standalone
fastest deployment type
and should be used for
single user and
demonstration
environments. The
Standalone installation is
used for this deployment,
with all components
being installed on one
computer.
Individual User
page 61.
Production — Workgroup This deployment type Server Only and Client
for a workgroup of users
at a single physical
location. This deployment
uses Client/Server
architecture and therefore
requires Server Only and
Client Only installations.
Production – Workgroup
page 63.
Production — Enterprise This deployment type Server Only and Client
for enterprise-wide users
at multiple locations who
access shared data. This
deployment uses Client/
Server architecture and
therefore requires Server
Only and Client Only
installations.

Production – Enterprise
page 68.
Individual User Deployment Checklist

Provided below is a summary of the steps involved in planning and performing an
Individual User deployment. Use this as a checklist when planning and
performing an installation. For guidance on upgrading existing deployments, refer
to the section at the end.
Planning an Individual User Deployment

1. Decide which optional components will be installed.
• Most optional components are selected for installation by default. You will
need to de-select any optional components that you do not wish to install.
Note
Instructions for installing Web Interface and Model Manager are not
included with the Individual User deployment. If you wish to install these
products, refer to the instructions provided for the Production – Workgroup
or Production – Enterprise deployments.
2. Plan licensing.
• The individual User deployment uses a node-locked license file. The
license file will be requested from PTC Support after installation.
For more information on licensing, see Introduction to Licensing Modeler
on page 132.
3. Prepare the environment.
a. Confirm that the computer that will host Modeler meets the environment
requirements.
For more information, see Environment Requirements on page 14.
b. Confirm that the computer that will host Modeler meets the hardware
requirements.
For more information, see Hardware Requirements on page 18.

4. Plan the installation of maintenance releases.
• Access PTC Support and check if there are any Maintenance or patch
releases available for the relevant version of Modeler (e.g. M010). If so,
download the installation files for the latest maintenance release.
Performing an Individual User Deployment

1. Prepare for a Standalone installation.
• Ensure all environment requirements are met. Refer to Preparing for a
standalone installation on page 76.
2. Perform Standalone installation.
• Complete the steps provided in Performing a standalone installation on
page 78. Select the optional components you require.
Note
Java SE Runtime Environment 8 32bit will also be installed, if it is not
installed already.
3. Perform post-Standalone installation tasks.

• Complete the steps provided in Post-standalone installation tasks on page
80.
Upgrading an Individual User Deployment

If you already have Modeler installed using the Standalone options, follow the
instructions below to upgrade to the latest version of Modeler.
1. Prepare for upgrade installation.
• Refer to Performing an Upgrade on page 165. Complete any steps that
apply to your upgrade situation.
2. Perform upgrade installation.
a. Complete the steps provided in Performing a standalone installation on
page 78. Select the optional components you require. Note that Java SE
Runtime Environment 8 32–bit must have been installed on your
computer.
b. If prompted to install Microsoft .Net Framework 4.6.1, click Install to
confirm.
c. When prompted to uninstall the previous version of Modeler, click Yes to
confirm.

3. Perform post-upgrade tasks.
a. Refer to Performing an Upgrade on page 165. Complete any post-
installation steps that apply to your upgrade situation.
At a minimum, this will involve upgrading models and profiles in models.
b. Use the License Manager Request Wizard to request a license file for the
correct version of Modeler. Once the license has been received from PTC
Support, use the Replace function in License Manager and select the
received license file to install the new license. Refer to Working with a
local license on page 143.
c. Install the latest Maintenance Release, if one has been released. Download
the latest Maintenance Release from PTC Support and follow the
instructions in the included Release Notes.
Production — Workgroup Deployment

Checklist
Provided below is a summary of the steps involved in planning and performing a
Production — Workgroup deployment. Use this as a checklist when planning and
performing an installation.
For guidance on upgrading existing deployments, refer to the section at the end.
Planning a Production — Workgroup Deployment

1. Decide which optional components will be installed. Some optional
components are selected for installation by default. You will need to de-select
any optional components that you do not wish to install:
a. Modeler Model Editor
This component, and its sub-components, are required to use the Modeler
client application. These components are required for Client Only
installations and selected by default. These components are optional for
Server Only installations and are de-selected by default.
b. Floating License Server
This component is required for server-based floating licenses, which is the
recommended licensing approach for this deployment. This component is
selected by default during the Server Only installation. The floating
License Server can be installed on any computer but it is recommended
that it is installed on Modeler Server. For more information on licensing,
refer to Introduction to licensing Modeler on page 132.
c. DOORS Synchronizer

This component is required if you wish to use the Integration for IBM
Rational DOORS. If IBM Rational DOORS is installed on your machine,
this component will be selected by default. For more information on this
integration, refer to Overview of Integration for IBM Rational DOORS on
page 186.
d. Integrity Lifecycle Manager Integration Admin
If you wish to use the Integration for PTC Integrity Lifecycle Manager,
this component is needed to perform configuration of the Integrity
Lifecycle Manager server. It must be installed on at least one computer,
either the Modeler Server or a Modeler Client. For more information on
this integration refer to Overview of Integration for PTC Integrity
Lifecycle Manager on page 189.
e. Model Manager
Fore more information on this component, refer to Model Manager
overview on page 95.
f. Web Interface
For more information on this component, refer to Overview of Web
Interface on page 103.
Note
Web Interface is required if you wish to use the REST Service or the
OSLC Provider.
g. Documentation
This component is selected by default during the Client Only installation.
2. Plan the system architecture:
a. Review Client/Server architecture information and identify the computers
that will host the Modeler Server (or servers) and Modeler Clients. Refer
to the Client/Server section of Installation configurations on page 24.
b. Review Client/Server architecture installation process. Refer to Installing
Modeler for a project team on page 28.
c. Review security considerations explained in Managing Modeler and Web
Interface Security on page 34. If required, plan the security configurations
for your site.
d. If you are installing the Web Interface, determine the user authentication
strategy and if LDAP will be used. Refer to Setting up user authentication
for a Web Interface website on page 108.

e. Plan licensing:
i. The Production — Workgroup deployment uses server-based floating
licenses. Identify which license type(s) you will be using. Refer to
Modeler license types: subscription, evaluation, permanent,
incremental and upgrade on page 136.
ii. Identify which features will be needed as well as the number of
licenses for each feature. The license file will be requested from PTC
Support after installation. For more information on licensing, refer to
Local and server-based licensing on page 133.
iii. If you have chosen to install the Web Interface, plan the licenses
required for Web Interface Server and Clients. Refer to Client licensing
of a Web Interface website on page 117.
iv. If you have chosen to install Model Manager, refer to the Licensing
Model Manager section in Installing Model Manager on page 96.
f. Plan the environment:
i. Confirm that the computers which will host the Modeler Server and
Modeler Clients meet the environment requirements. Refer to
Environment requirements for each installation type on page 14.
ii. Confirm that the computers which will host the Modeler Server and
Modeler Clients meet the hardware requirements. Refer to Hardware
requirements on page 18.
g. Plan installation of maintenance releases:
Access PTC Support and check if there are any Maintenance/patch
Performing a Production — Workgroup Deployment

1. Prepare for Server Only and Client Only installations:
a. Ensure all environment requirements are met for Server and Client
computers. Refer to Preparing for a server only installation on page 81 and
to Preparing for a client only installation on page 90.
b. If you are installing the Web Interface, complete the relevant steps in
Preparing for installation of Web Interface on page 99.
2. Perform Server Only Installation:
• On the computer that will host the Modeler Server, complete the steps
provided in Performing a server only installation on page 83. Select the
optional components you require, such as Model Manager or Web
Interface.

3. Perform Client Only installation:
• On all computers that will host the Modeler Client, complete the steps
provided in Performing a client only installation on page 91.
4. Perform post-installation tasks for the Modeler Server:
a. Install the latest Maintenance Release, if on has been released. Download
the latest Maintenance Release from PTC Support and run the executable
file.
correct version of Modeler, with the correct number of licenses for each
component. Once the license has been received from PTC Support,
configure Modeler to use the new license. Refer to Working with a server-
based floating license on page 137.
i. If you have installed the Web Interface, refer to Licensing a Web
Interface website and selecting the databases it can access on page 103.
ii. If you have installed Model Manager, refer to the Licensing Model
Manager section in Installing Model Manager on page 96.
c. Set up the Windows firewall. See Setting up the Windows firewall on page
87.
d. Set up databases. Refer to Post-server only installation tasks on page 86.
e. Optionally set up server to add users and groups through an organizational
unit. Refer to Set up server to add users and groups through an
organizational unit on page 89.
f. Optionally set up databases to utilize quad-core processors. Refer to Set up
databases to utilize quad-core processors on page 89.
g. Setup a backup procedure. Refer to Setting up a backup procedure on page
183.
h. If you have installed Web Interface:
i. Grant the PTC-IM-WSU user account access to every database that
you want to be accessed on Web Interface.
ii. Bookmark databases as PTC-IM-WSU user. Refer to the section called
“To select which Databases can be accessed from the Web Interface
Website” in Licensing a Web Interface website and select the database
it can access on page 103.
iii. Complete testing. Refer to Testing and launching a Web Interface
website on page 111.
iv. If the Web Interface is not working, refer to Troubleshooting a Web
Interface website on page 125.

v. Optionally configure Web Interface user authentication. Refer to
Setting up user authentication for a Web Interface website on page 108.
vi. Optionally configure Web Interface user account management. Refer to
Setting up how Web Interface website accounts work on page 120.
5. Perform post-installation tasks for the Modeler Clients:
a. Install the latest Maintenance Release, if one has been released. Download
the latest Maintenance Release from PTC Support and follow instructions
in its Release Notes.
b. Bookmark databases. Refer to Post-client only installation tasks on page
93.
Upgrading a Production — Workgroup Deployment

If you already have Modeler installed using the Product — Workgroup
deployment, follow the instruction below to upgrade the server and then each of
the clients with the latest version of Modeler.
1. Prepare for upgrade installation:
• Refer to Performing an upgrade on page 165 and complete any steps that
apply to your upgrade situation.
2. Perform an upgrade installation:
a. On the Modeler Server, complete the steps provided in Performing a
Server Only on page 83 installation. Select the optional components you
require.
b. If prompted to install Microsoft .NET Framework 4.6.1, click the Install
button to confirm.
c. When prompted to uninstall the previous version of Modeler, click Yes to
confirm.
d. On all Modeler Clients, complete the steps provided in Performing a Client
Only installation on page 91. Select the optional components you require.
3. Perform post-upgrade tasks:
a. Refer to Performing an Upgrade. Complete any post-installation steps that
apply to your upgrade situation. At a minimum, this will involve
upgrading models and profiles in models.
correct version of Modeler, with the correct number of license file for the
correct version of Modeler, with the correct number of license for each

the latest Maintenance Release from PTC Support and follow instructions
in its Release Notes.
Production — Enterprise Deployment

Checklist
Provided below is a summary of the steps involved in planning and performing a
Production – Enterprise deployment. Use this as a checklist when planning and
performing an installation.
For guidance on upgrading existing deployments, refer to the section at the end.
Planning a Production – Enterprise Deployment

1. Decide which optional components will be installed. Some optional
components are selected for installation by default. You will need to de-select
any optional components that you do not wish to install:
a. Modeler Model Editor
This component, and its sub-components, are required to use the Modeler
client application. These components are required for Client Only
installations and selected by default. These components are optional for
Server Only installations and are de-selected by default.
b. Floating License Server
This component is required for server-based floating licenses, which is the
recommended licensing approach for this deployment. This component is
selected by default during the Server Only installation. The Floating
License Server can be installed on any computer but it is recommended
that it is installed on the Modeler Server as part of the Server Only
installation. For more information on licensing, refer to Introduction to
licensing Modeler on page 75.
c. DOORS Synchronizer
This component is required if you wish to use the Integration for IBM
Rational DOORS. If IBM Rational DOORS is installed on your machine,
this component will be selected by default. For more information on this
integration, refer to Overview of Integration for IBM Rational DOORS on
page 186.
d. Integrity Lifecycle Manager Integration Admin
If you wish to use the Integration for PTC Integrity Lifecycle Manager,
this component is needed to perform configuration of the Integrity

Lifecycle Manager server. It must be installed on at least one computer,
either the Modeler Server or a Modeler Client. For more information on
this integration, refer to Overview of Integration for PTC Integrity
Lifecycle Manager on page 189.
e. Model Manager
For more information on this component, refer to Model Manager
overview on page 95.
f. Web Interface
For more information on this component, refer to Overview of Web
Interface on page 99.
Note
Web Interface is required if you wish to use the REST Service or the
OSLC Provider.
g. Documentation
This component is selected by default during the Client Only installation.
2. Plan the system architecture:
a. Decide how distributed users (those not physically close to the Modeler
Server) will access and use model data. Refer to the Help topic called
Overview of working across sites on page 40 as well as the other topics in
chapter called Working across sites. Decide if Microsoft Remote Desktop
Service or Citrix XenApp (previously called MetaFrame) will be utilized.
b. Review Client/Server architecture information and identify the computers
that will host the Modeler Server (or servers) and Modeler Clients (or
Microsoft Remote Desktop Service or Citrix XenApp clients). Refer to the
Client/Server section of Installation configurations on page 24. If you are
using Microsoft Remote Desktop Service or Citrix XenApp, refer to Direct
access of a remote model through Microsoft Remote Desktop Services or
Citrix MetaFrame on page 43.
c. Review Client/Server architecture installation process. Refer to Installing
Modeler for a project team on page 28.
d. Review security considerations explained in Managing Modeler and Web
Interface Security on page 34. If required, plan the security configurations
for your site.

e. If you are installing the Web Interface, determine the user authentication
strategy and if LDAP will be used. Refer to Setting up user authentication
3. Plan licensing:
a. The Production – Enterprise deployment uses server-based floating
licenses. Identify which license type(s) you will be using. Refer to
Modeler license types: subscription, evaluation, permanent, incremental
and upgrade on page 136.
b. Identify which features will be needed as well as the number of licenses
for each feature. The license file will be requested from PTC Support after
installation. For more information on licensing, refer to Local and server-
based licensing on page 133.
c. If you have chosen to install the Web Interface, plan the licenses required
for Web Interface Server and Clients. Refer to Client licensing of a Web
d. If you have chosen to install Model Manager, refer to the Licensing Model
4. Plan the environment:
a. Confirm that the computers which will host the Modeler Server and
Modeler Clients meet the environment requirements. Refer to
Environment requirements for each installation type on page 14.
b. Confirm that the computers which will host the Modeler Server and
Modeler Clients meet the hardware requirements. Refer to Hardware
requirements on page 18.
5. Plan installation of maintenance releases:
• Access PTC Support and check if there are any Maintenance or patch
Performing a Production – Enterprise Deployment

1. Prepare for Server Only and Client Only installations:
a. Ensure all environment requirements are met for Server and Client
computers. Refer to Preparing for a server only installation on page 81 and
to Preparing for a client only installation on page 90.
2. Perform Server Only installation:
a. On the computer that will host the Modeler Server, complete the steps
provided in Performing a server only installation on page 83. Select the

optional components you require, such as Model Manager or Web
Interface.
b. If you are using Microsoft Remote Desktop Service or Citrix XenApp,
install the Microsoft Remote Desktop Service or Citrix XenApp Server
software. Refer to the steps provided in Direct access of a remote model
through Microsoft Remote Desktop Services or Citrix MetaFrame on page
43.
3. Perform post-installation tasks for the Modeler Server:
the latest Maintenance Release from PTC Support and run the executable
file.
i. If you have installed the Web Interface, refer to Licensing a Web
Interface website and selecting the databases it can access on page 103.
ii. If you have installed Model Manager, refer to the Licensing Model
c. Set up the Windows firewall. Refer to Post-server only installation tasks
on page 86.
d. Set up databases. Refer to Post-server only installation tasks on page 86.
e. Optionally set up a server to add users and groups through an
organizational unit. Refer to Post-server only installation tasks on page 86.
f. Optionally set up databases to utilize quad-core processors. Refer to Post-
server only installation tasks on page 86.
g. Setup a backup procedure. Refer to Setting up a backup procedure on page
183.
h. If you have installed Web Interface:
i. Grant the PTC-IM-WSU user account access to every database that
you want to be accessed on Web Interface.
ii. Bookmark databases as PTC-IM-WSU user. Refer to the section called
To select which Databases can be accessed from the Web Interface
website in Licensing a Web Interface website and selecting the
databases it can access on page 103.

iii. Complete testing. Refer to Testing and launching a Web Interface
website on page 111. If the Web Interface is not working, refer to
Troubleshooting a Web Interface website on page 125.
iv. If the Web Interface is not working, refer to Troubleshooting a Web
v. Optionally configure Web Interface user authentication. Refer to
vi. Optionally configure Web Interface user account management. Refer to
Setting up how Web Interface website accounts work on page 120.
vii. Optionally configure HTTPS. Refer to Configuring the Web Interface
website to use HTTPS on page 123.
4. Perform Client Only installations:
a. On all computers that will host the Modeler Client, complete the steps
provided in Performing a client only installation on page 91. Select the
optional components you require.
b. Specify the SQL Server that will be used.
c. Optionally specify the Floating License Server that will be used by the
Modeler Client. Refer to Post-client only installation tasks on page 93.
d. If you are using Microsoft Remote Desktop Service or Citrix XenApp:
i. Install the Modeler Client on the Modeler Server using the Client Only
installation on page 13.
ii. Install the Microsoft Remote Desktop Service or Citrix XenApp Client
on all client computers. Refer to the steps provided in Direct access of
a remote model through Microsoft Remote Desktop Services or Citrix
MetaFrame on page 43.
5. Perform post-installation tasks for the Modeler Clients:
b. Bookmark databases. Refer to Post-client only installation tasks on page
93.
Upgrading a Production – Enterprise Deployment

If you already have Modeler installed using the Product – Enterprise deployment,
follow the instructions below to upgrade the Modeler Server then each of the
Modeler Clients to the latest version of Modeler.
1. Perform upgrade installation:

a. Refer to Performing an Upgrade on page 165. Complete any preparation
and installation steps that apply to your upgrade situation.
b. On the Modeler Server, complete the steps provided in Performing a
Server Only installation on page 83. Select the optional components you
require.
c. If prompted to install Microsoft .Net Framework 4.6.1, click the Install
button to confirm.
d. When prompted to uninstall the previous version of Modeler, click Yes to
confirm.
e. On all Modeler Clients, complete the steps provided in Performing a Client
Only installation on page 13. Select the optional components you require.
2. Perform post-upgrade tasks:
a. Refer to Performing an Upgrade on page 165. Complete any post-
installation steps that apply to your upgrade situation. At a minimum, this
will involve upgrading models and profiles in models.
component. Once the license has been received from PTC Support, use the
Replace function in License Manager and select the received license file to
install the new license. Refer to Working with a server-based floating
license on page 137.

4
Installing Windchill Modeler
Installing Modeler ......................................................................................................75
Standalone Installation ..............................................................................................75
Server Only Installation..............................................................................................81
Client Only Installation ...............................................................................................90

Installing Modeler
This section provides step-by-step instructions for performing Server Only, Client
Only and Standalone installations.
If after following the instructions and advice in this section, you experience
problems installing Modeler, see the Troubleshooting on page 238 section.
To start the Modeler installation, run the Modeler installation application
(WindchillModeler9_5Setup.exe).
If you want to roll out a customized Modeler installation to a large number of
users, you may want to customize the Modeler Installation MSI file and install
Modeler through that customized file. For more information, see Installing
Modeler through a customized MSI file on page 30.
Standalone Installation
Preparing to Upgrade a Standalone Installation
Note
Only Windows Administrators who are also Modeler Administrators can
perform Modeler upgrades.
For information about upgrading a previous version of Modeler, see Upgrading

Modeler on page 165.
If you have installed Modeler to the default location, the Release Notes file resides
in the following location:
C:\Program Files (x86)\Windchill Modeler\Modeler\System\
PrintableDocs
C:\Program Files\Windchill Modeler\Modeler\System\
PrintableDocs
Important:
• Before you upgrade a Standalone installation, ensure that you have obtained
the appropriate replacement licenses from PTC. After upgrading Modeler, you
must start License Manager and replace the license file.
Installing Windchill Modeler 75

• Before you upgrade a Standalone installation, ensure that you backup your
databases and read the Modeler Release Notes.
• Each database will be upgraded when a user (with Database Administrator or
Database Owner access permissions) attempts to open one of its models.
• If you choose to install Web Interface, a dialog will be displayed that allows
you to set the password for the PTC-IM-WSU account. If you have previously
changed the default password for this account (which is recommended),
ensure you re-enter your chosen password.
Preparing for a Standalone Installation

A Standalone installation may fail if your environment is not set up for installation
of Modeler.
Requirement Comment For more Information
The specifications of the See Hardware
computer meets Modeler requirements on page 18.
requirements.
There is enough free disk Installation process See the Modeler Release
space. requires disk space in the Notes.
target folders and in the
Windows TEMP folder.
Windows operating Installation program See the Modeler Release
system. checks for valid operating Notes for supported
system. operating systems.
You are logged on with Installation program See Checking you are
local administrator rights. checks. logged on to Windows
with administrator rights
on page 234.
The computer can be Upgrades only.
restarted during the
installation process.
Virus checkers Can make an installation See Disabling virus
temporarily disabled. stop while copying files, checkers during
or prevent registration. installation on page 236.
If you are installing -
Modeler the first time,
ensure that you have
obtained the appropriate
licenses from PTC.
If you are upgrading - See Preparing to upgrade
Modeler, ensure that you a standalone installation

Requirement Comment For more Information
have obtained the on page 75.
appropriate upgrade or
replacement Modeler
licenses.
On Windows Server 2008 - -
or later, Internet Explorer
Enhanced Security
Configuration must be
disabled to view
Reviewer or Web images
correctly.
.NET 4 Framework Required only if installing See Preparing for
installed and Internet Web Interface. installation of Web
Information Services Interface on page 99.
(IIS) enabled and set up.
The latest Service Pack
and any relevant critical
and high-priority updates
must be applied to all
supported Microsoft
products regularly. Beta
releases are not
supported. For Windows
Server 2012 R2, ensure
Windows updates
KB2975061 and
KB2919355 have been
installed.
Making a Standalone Installation Work When Disconnected From the

Network
If you want to be able to use a Standalone installation when the computer is
disconnected from the network, you must set up your network card to not stop
when disconnected or you must install the Microsoft Loopback Adapter.
For more information, see Making a standalone installation work when
disconnected from the network on page 233.

Performing a Standalone Installation
To perform a Standalone installation:
1. Log on to Windows as a user that has Local Administrator rights.
2. If you want to use XMI Import/Export, you must download and install the 32–
bit version of Oracle Java 8 JRE.
3. If you want to be able to use Modeler while not connected to the network,
remove the network cable from the computer. The installation program will
then check that TCP/IP works under these conditions.
Note
Note that this will not prevent you from using Modeler when connected to
the network.
4. To start a standard installation of Modeler, run the Modeler installation

application WindchillModeler9_5Setup.exe.
5. Follow the installation program instructions.
Note
Installation of the Windows .NET Framework can take up to 10 minutes;
during installation, the Cancel button on the dialog is not available.
The installation program enables the Transport Layer Security (TLS) 1.2
protocol as part of a Standalone installation.
• On the Setup Type page, select the Standalone option.

• On the Custom Setup page, the following options are selected by default:
On the Custom Setup page, expand the Modeler Model Editor entry and
review the add-ins, documentation and profiles that are selected for
installation. To deselect, click an option, then click This feature will not be
available. If you do not want to install the empty Models database or the
Examples database, expand the Modeler Server entry, click the Models or
Examples as appropriate, and then choose This feature will not be available.

By default, the installation program sets up a SQL Server instance named
MODELER. To install using an existing SQL Server instance, do the
following:
○ On the Default Modeler Server page, type the name of an existing SQL
Server instance, or select it from the drop-down list.
If you choose to install Web Interface, the PTC-IM-WSU user account is
created on the local computer.
The Integration for IBM Rational DOORS is available only if DOORS is
installed and has been run on the computer. The Publisher add-in requires
Microsoft Word.
The IDL Profile requires Microsoft Excel for some reports. For
information about which versions of Microsoft Word and Excel are
supported, see the Modeler Release Notes.
• If you choose to install Web Interface, the installation program creates a
PTC-IM-WSU user account on the local computer. A dialog will also be
displayed that allows you to set the password for the PTC-IM-WSU
account. For more information, see Administrator rights required for
installing Modeler on page 20.
• In addition, If you choose to install Web Interface or Model Manager, a
dialog will be displayed that allows you to select an SSL certificate for
HTTPS connections. The list shows self-signed and commercial
certificates found on the local IIS server. For more information, see
Configuring the Web Interface Website to Use HTTP on page 123.
You can continue without selecting a certificate, but you must set bindings
manually using IIS Manager after the installation is finished.
6. If you are prompted to restart your computer after SQL Server Express is
installed, restart your computer.
The install wizard should start again automatically once you log in. Enter the
same options that you set before you restarted, and complete the installation.
7. After the installation is complete, perform the necessary post-installation
tasks. For more information, see Post-standalone installation tasks on page 80.
Note
If you are prompted to restart your computer, ensure that you log on to
Windows using the same user name as you did before starting the installation.

Performing a silent install from the Windows command line
Enter the following command in the Windows command line:
msiexec /i Windchill Modeler .msi filename /qn /L*v C:\
ProgramData\WindchillModeler9_5.log ART_INSTALLATION=
"Full" ART_LICENSE="ARTISANRTS" ART_PRODUCT_NAME=
"Windchill Modeler version number" ART_UPGRADE="1" ART_
SETUP_TYPE= "Standalone" INSTALL_REPOSITORY_EXAMPLES="1"
ART_CREATE_ EXAMPLES="1" INSTALL_REPOSITORY_MODELS="1"
ART_CREATE_ MODELS="1" INSTALL_MODEL_EDITOR="1" INSTALL_
MODELER_ SERVER="1" LIC_TYPE.40204B5B_4AEA_4F66_8504_
14A8FEEF9618="Local" ART_INSTALL_SYNC_IDL="1" ART_
INSTALL_SYNC_ACS="1" ART_INSTALL_SYNC_ADA="1" ART_
INSTALL_SYNC_ARINC="1" ART_INSTALL_SYNC_C="1" ART_
INSTALL_SYNC_C_PLUS="1" ART_INSTALL_SYNC_C_SHARP="1"
ART_INSTALL_SYNC_JAVA="1" ART_INSTALL_SYNC_SHADOW_TDK=
"1" ART_INSTALL_SYNC_VB="1" ART_INSTALL_DOORS="1" ART_
DOORS_INSTALL_DIR.7ECF38A2_73F9_4D9B_AF75_66D371CC3E2C=
"DOORS installation location" ART_REST_ SERVICE_USER_
PWD.98490CE2_3E15_452C_A4B1_8E90C1F789F5= "Password"
ART_PTC_IM_WSU_PASSOWRD1="Password" ART_PTC_ IM_WSU_
PASSOWRD2="Password" ART_INSTALL_MODEL_MANAGER_ WEB="1"
ART_INSTALL_WEB_INTERFACE="1" IIS_SSL_ CERTIFICATE_
VALIDATE="1" IIS_SSL_CERTIFICATE="SSL Certificate hash"
ADDLOCAL=
"Examples,StudioModelEditor,CodeGen,CodeGenStorageMap
per,CodeReversers,CompSharingWiz,DOORSSynchronizer,Doc
Publisher,ModelerServer,ImportExport,ImportExportXMI,In
tegritySynchronizer,WebServers,ModelManageWeb,Models,Ob
jectAnimator,Reviewer,SySim,SyncACS,SyncACSARINC,SyncAC
SAda,SyncACSC,SyncACSCPlus,SyncACSCSharp,SyncACSIDL,Syn
cACSJava,SyncACSSQL,SyncACSTDK,SyncACSVB,SynchronizerAd
minTool,TellMe,VariantSelector,WebInterface,WindchillIn
tegration" IS_SQLSERVER_SERVER="Server Name"
Post-Standalone Installation Tasks

After a Standalone installation perform the following tasks:
• Change the password of the PTC-IM-WSU user account on page 86
• License Modeler on page 133
• Set up a Web Interface website on page 89
If you have upgraded Modeler from an earlier version, see the Upgrade section on
page 165 for post installation tasks that apply to Modeler upgrades.

Server Only Installation
Preparing to Upgrade a Server Only Installation
Note
For information about upgrading a previous version of Modeler, see Upgrading

If you have installed Modeler to the default location, the Release Notes reside in
the following location.
• C:\Program Files(x86)\Windchill Modeler\Modeler\
System\PrintableDocs
• C:\Program Files\Windchill Modeler\Modeler\System\
PrintableDocs
Note
• Before you upgrade a Server Only installation, ensure that you backup your
databases and read the Modeler Release Notes.
• If the server runs a server-based floating license, ensure that you have obtained
the appropriate replacement licenses from PTC. After upgrading Modeler, you
must start License Manager and replace the license file.
• If you choose to install Web Interface, a dialog will be displayed that allows
you to set the password for the PTC-IM-WSU account. If you have previously
changed the default password for this account (which is recommended),
ensure you re-enter your chosen password.
Preparing for a Server Only Installation

A Server Only installation may fail if your environment is not set up for
installation of Modeler.

Requirement Comments For more Information
requirements.
local administrator and/or checks for local logged on to Windows
domain administrator administrator rights only. with administrator rights
rights. on page 234.
The computer is in the If not, the two domains See Setting up trusted
same domain as the require read/write trusts. domains on page 235.
clients that will access it.
The computer can be Upgrades only. –
restarted during the
installation process.
If the server is going to – –
run a server-based
floating license, ensure
that you have obtained
the appropriate licenses
from PTC.
If you are upgrading a – See Preparing to upgrade
server that runs a server- a server only installation
based floating license, on page 81.
upgrade or replacement
licenses.
On Windows Server 2008 – –
or later, Internet Explorer
Enhanced Security
Configuration must be

disabled to view
Reviewer or Web
Interface images
correctly.
.NET 4 Framework Required only if installing See Preparing for
installed and Internet Web Interface. installation of Web
Information Services Interface on page 99.
(IIS) enabled and set up.
The latest Service Pack
and any relevant critical
and high-priority updates
must be applied to all
supported Microsoft
products regularly. Beta
releases are not
supported. For Windows
Server 2012 R2, ensure
Windows updates
KB2975061 and
KB2919355 have been
installed.
Performing a Server Only Installation

To perform a Server Only installation:
1. Log on to the Windows as a user that has Local Administrator rights. If you
want the installation program to set up an Oms user account on the server's
domain, you must log on to Windows as a user that also has Domain
Administrator rights.
2. If you want to use XMI Import/Export, you must download and install the 32–
3. To start a standard installation of Modeler, run the Modeler installation

Note
The installation program enables the Transport Layer Security (TLS) 1.2
protocol as part of a Server Only installation.
• On the Setup Type page, select the Server Only option.

• To install Web Interface or Model Manager, expand the Web Servers entry,
click the drop-down arrow next to the web site, then click This feature will
be installed on the local hard drive.
• If you do not want to install the empty Models database or the Examples
database, expand the Modeler Server entry, and then choose to not install
the Models or Examples as appropriate.
Also on the Custom Setup page, if you want to install the Modeler
application, click the Modeler Model Editor entry, and then click This
feature will be installed on the local hard drive.
• You must provide the path to the ModelerATFiles folder location. This
folder can be located on the local directory or on a mapped drive. You can
provide a UNC path to the folder location.
Note
The ATFiles folder should be a unique folder and the same folder
should not be used for other Modeler installations. Also, the path that
you provide should not have a trailing “\”.
• If you choose to install Web Interface, a dialog will be displayed that

allows you to set the password for the PTC-IM-WSU account.
• If you choose to install Web Interface or Model Manager, a dialog will be
displayed that allows you to select an SSL certificate for HTTPS
connections. The list shows self-signed and commercial certificates found
on the local IIS server.

If you continue without selecting a certificate, you must configure
bindings manually using IIS Manager after the installation is finished. For
more information, see Configuring the Web Interface Website to Use
HTTP on page 123.
• By default, the installation program sets up a SQL Server instance named
MODELER. The default instance will not be installed if an existing SQL
Server instance is detected. To install using an existing SQL Server
instance, do the following:
○ On the Default Modeler Server page, enter the name of an existing SQL
Server instance, or select one from the drop-down list.
5. If you are prompted to restart your computer after SQL Server Express is
installed, restart your computer.
The installation wizard should start again automatically once you log in. Enter
the same options that you set before you restarted and complete the
installation.
tasks. For more information, see Post-server only installation tasks on page 86.
Note
If you are prompted to restart your computer, ensure that you log on to
Windows using the same user name as you did before starting the installation.
Moving the location of the ATFiles folder

While performing the server-only installation, Modeler creates the
UNCpath.sql file located in the [Modeler installation path]\
Modeler\System\SQLScripts folder. This is used to modify the location of
the ATFiles folder in your server.
To modify the ATFiles folder location:
1. Open the UNCpath.sql file.
2. Replace ‘$(FilePath)’ with the path of the new ATFiles folder location.
Note that the path should be a fully qualified local path, having no trailing “\”.
3. Save and close the UNCpath.sql file.
4. Execute the UNCpath.sql query from SSMS.
You may also modify the path from SSMS and execute the query.

Post-Server Only Installation Tasks
After a Server Only installation perform the following tasks:
• Change the Password of the PTC-IM-WSU User Account on page 86
• Set up a Server-based Floating License on page 154
• Set up the Windows Firewall on page 87
• Set up Databases on page 87
• Set up a Server to Add Users and Groups through an Organizational Unit on
page 89
• Set up a backup procedure on page 183
• Set up a Web Interface Website on page 99
• Set up Databases to Utilize Quad-core Processors on page 89
If you have upgraded Modeler from an earlier version, see Upgrading Modeler on
page 165 for any post installation tasks that apply to Modeler upgrades.
Changing the Password of the PTC-IM-WSU User Account

If you choose to install Web Interface, the installation program creates a Windows
user account named PTC-IM-WSU. The Web Interface website uses the PTC-IM-
WSU user account to access models. During the installation of Web Interface, you
must set a password for the PTC-IM-WSU account. You can accept the default
password, or enter a new password. The default password for the PTC-IM-WSU
user account is: P8=:nc((pgChTt%f
It is recommended that you change the password of the PTC-IM-WSU user
account to make it secure. The password can be changed during the Modeler
installation process, or after installation by updating the PTC-IM-WSU Windows
user account.
Note
After changing the PTC-IM-WSU password, you must use Internet
Information Services (IIS) to update the Windchill Modeler Web Interface
application pool to use the new password.
For more information, see Licensing a Web Interface website and selecting the
Setting up a Server-based Floating License

If you have installed the server-based floating license software, you must set up
the license for other users to use. To set up the license:

• Obtain the appropriate licenses from PTC.
• Add or replace the licenses you have received from PTC. See Replacing a
local license file on page 153.
After adding a new license, you must stop and restart the Windchill Modeler
License Manager service.
If you are upgrading Modeler, you will require replacement Modeler licenses. If
you have a maintenance agreement with PTC, you should receive an email that
provides instructions for obtaining the replacement Modeler licenses.
For more information about licensing Modeler, see Licensing Modeler on page
133.
Setting up Databases
You can now set up the access rights to the databases and models on the server.
Ensure that Model Administrators are given Administrator rights to the database,
so that they can perform operations such as starting and stopping the database, and
importing models.
Setting up the Windows Firewall

The Windows firewall on the Modeler server computer will prevent Modeler
clients from accessing the server's databases. To overcome this problem, set up the
Windows firewall to allow access to the Modeler applications.
When a Windows server is added to a domain, ping is blocked by default. You
must enable ping on the Windows server. For more information, see I cannot
connect to the server on page 239.
If you are using Windows Server, verify that the Windows firewall rule named
File and Printer Sharing (Echo Request — ICMPv4–In) is enabled
by performing the following steps:
1. On the Windows Start menu, click Administrative Tools, and then click
Windows Firewall with Advanced Security.
2. In the left pane, click Inbound Rules.
3. In the rules list, find the File and Printer Sharing (Echo Request
- ICMPv4–In) rule for the Domain profile.
4. Check that the Enabled column is set to Yes for the rule name.
• A gray icon indicates that a rule is disabled.
5. If the Enabled column is set to No, right-click the rule name, and then click
Enable Rule to enable the rule.
6. Close the Windows Firewall with Advanced Security window.

The following files need to be set up as exceptions. In each case, the path shown is
for a Modeler installation to the default locations.
Manager\lmgrd.exe (for Floating License Server)
Manager\artsansw.exe (for Floating License Server)
• C:\Program Files (x86)\Microsoft SQL Server\
MSSQL12.MODELER\MSSQL\Binn\sqlservr.exe (Allow inbound
connections to SQL Server)
lmgrd.exe (for Floating License Server)
artsansw.exe (for Floating License Server)
• C:\Program Files\Microsoft SQL Server\MSSQL12.MODELER\
MSSQL\Binn\sqlservr.exe (Allow inbound connections to SQL
Server)
The firewall must allow use of the following ports:
Port Port Used by
num- type
ber
1433 TCP SQL Server instance, sqlservr.exe
1434 UDP Microsoft SQL Server Browser service, sqlbrowser.exe
15777 TCP Modeler generated application to send notification calls to
Modeler (this can be changed to 4242 if Modeler has been
upgraded)
27000 TCP Windchill Modeler License Server service (lmgrd.exe).
This port number can be changed by adding a new port
number to the end of the SERVER line in the floating license
file.
It is necessary to define not only the TCP port that lmgrd
will use, but also the port each vendor daemon will use. Each
vendor daemon’s exe file should be allowed through by the
firewall. The vendor daemon port is random, but can be
explicitly specified on the DAEMON line. The PORT= entry
on the DAEMON line allows explicit selection of both
externally available ports. 27001 is the TCP port reserved for
use by the lmgrd process while 27002 is the port used by the

Port Port Used by
num- type
ber
vendor daemon process idl_lmgrd. Both port numbers
must be unused by other processes. For example: DAEMON
ARTSANSW PORT=27002.
57850 TCP Web Interface. Used with port https by default. If you
configure the Web Interface to use with http, then the port
to use is 57851.
62344 TCP Model Manager
For more information about the ports that Modeler uses, see Executables that use
ports and their protocols in Windchill Modeler on the PTC eSupport.
Setting up a Server to add Users and Groups through an

Organizational Unit
When you use SQL Server to update available users and groups, by default the
Modeler server finds users and groups on the user's domain.
Setting up a Backup Procedure for your Repositories

Ensure that you set up backup procedures for your databases. Failure to do so can
result in loss of data.
For more information about backing up your databases, see Setting up a backup
procedure on page 183.
Setting up a Web Interface Website

If you have installed Web Interface, you can set up a Web Interface website for
viewing models through a web browser.
For more information, see Overview of installing and setting up a Web Interface
website on page 99.
Setting up databases to utilize more than one quad-core

processor
The default SQL Server Express edition that is installed with Windchill Modeler
supports up to one processor and four cores.
If you require higher performance, consider setting up SQL Server Standard
edition.
Also, note that on 64–bit computers, it is recommended that you install the 64–bit
version of SQL Server Standard Edition for better performance.

Upgrading Databases and Models to Work with an
Upgraded Modeler Server
If you have upgraded your Modeler server, you will have to upgrade your
databases and their models.
Each database is upgraded when a user (with Database Administrator or Database
Owner access permissions) opens one of its models.
Client Only Installation

Preparing to Upgrade a Client Only Installation
Note
For information about upgrading a previous version of Modeler, see the

Upgrading Modeler on page 165.
If you have installed Modeler to the default location, the Release Notes reside in
the following location.
• C:\Program Files (x86)\Windchill Modeler\Modeler\
System\PrintableDocs
• C:\Program Files\Windchill Modeler\Modeler\System\
PrintableDocs
Important: Before you upgrade a Client Only installation, ensure that you have
obtained the appropriate replacement licenses from PTC. After upgrading
Modeler, you must start License Manager and replace the license file on the
server.
Preparing for a Client Only Installation

A Client Only installation may fail if your environment is not set up for
installation of Modeler.
We recommend that you set up Modeler servers before performing Client Only
installations, so that the clients are correctly configured to use the server.

Note
Before you upgrade a Client Only installation, ensure that you read the
“Performing an Upgrade” chapter on page 165.

requirements.
local administrator rights. checks. logged on to Windows
with administrator rights
on page 234.
The computer is in the If not, the two domains See Setting up trusted
same domain as the require read/write trusts. domains on page 235
servers it will access.
If you are installing -
Modeler the first time,
licenses from PTC.
If you are upgrading - See Preparing to upgrade
Modeler, ensure that you a client only installation
have obtained the on page 90.
appropriate upgrade or
replacement licenses.
Performing a Client Only Installation

To perform a Client Only installation:

1. Log on to Windows as a user that has Local Administrator rights.
2. If you plan to use XMI Import/Export, you must download and install the 32–
3. To start a standard installation of Modeler, Run the Modeler installation
Note
• On the Setup Type page, select the Client Only option.

On the Custom Setup page, expand the Modeler Model Editor entry and
review the add-ins, documentation and profiles that are selected for
installation. If you do not want to install a feature, click the entry, and then
click This feature will not be available.
• On the Default Servers page, enter a SQL Server instance and a Modeler
License Server:
○ To connect to a SQL Server instance, click Browse..., then select a
SQL Server instance from the list of available servers.
○ To connect to a Modeler License Server, type the name of the license
server computer.
Note
The Integration for IBM Rational DOORS is available only if DOORS
is installed and has been run on the computer. The Publisher add-in
requires Microsoft Word. The IDL Profile requires Microsoft Excel for
some reports. For information about which versions of Microsoft Word
and Excel are supported, see the Modeler Release Notes.

tasks. For more information, see Post-Client Only installation tasks on page
93.
Post-Client Only Installation Tasks

After a Client Only installation perform the following tasks:
• License Modeler on page 133
• Bookmark databases you want to access models through Model Explorer
If you have upgraded Modeler from an earlier version, see the Upgrading Modeler
on page 165 for any post installation tasks that apply to Modeler upgrades.

5
Installing Optional Modeler
Components
Installing Optional Modeler Components — Model Manager and Web Interface ............95

Installing Optional Modeler Components
— Model Manager and Web Interface
This section explains how to install the following optional Windchill Modeler
components:
• Model Manager
• Web Interface
Model Manager Installation
Model Manager Overview

Model Manager is a web application that allows users to login to a Modeler server
and perform common database and model management tasks on that Modeler
Server.
Executing tasks on the Modeler Server, instead of the Modeler Client,
significantly improves performance of many operations.
Key features include:
• Perform common database management tasks including start, stop and
upgrade.
• Perform common model management tasks including export, import, new
version and upgrade profiles.
• Streamlined user experience for initiating, executing, monitoring and
managing tasks.
• Tasks can be scheduled to execute at specific times (for example outside of
working hours) in order to minimize the performance impact on the Modeler
Servers and users.
• Scheduled tasks can also be set to recurring, allowing routine management
tasks to be executed on a regular basis.
• Database and model access permissions are respected when using Model
Manager.
Installing Optional Modeler Components 95

Installing Model Manager
Model Manager is an optional component that can be installed as part of the
Server only and Standalone Windchill Modeler installation options. It is not
selected by default.
Note
You cannot add Model Manager to an existing installation of Windchill
Modeler. To add Model Manager, reinstall Windchill Modeler and make sure
that Model Manager is selected.
Pre-requisites
Internet Information Services (IIS) must be enabled to use Model Manager.
Firewall rules must be added to allow access to the Model Manager website. For
more information, see Managing Modeler and Web Interface Security on page 34.

Setting the Access Policy
To allow user access to Model Manager, you must set User Rights Assignment
policies to allow local log on to the Modeler server. You can manage user group
policies through the Local Group Policy Editor in Windows. To configure user
and group access on the Modeler server, you need to do the following:
1. From the computer that is hosting the Modeler server, start the Local Group
Policy Editor: in the Windows Run text box, type gpedit.msc, and then
press the Enter key.
2. In the left pane tree, under Local Computer Policy, select Computer
Configuration ▶ Windows Settings ▶ Security Settings ▶ Local Policy ▶ User
Rights Assignment.
3. In the Policy window, locate and set the following policies:
• Allow log on locally
Double-click the policy to open the properties window, and make sure that
the Model Manager user or group is allowed.
• Deny log on locally
Double-click the policy to open the properties window, and make sure that
the Model Manager user or group is not listed.
4. Click OK to apply any changes, and then close the Local Group Policy Editor.
Licensing Model Manager

You must set up licensing for all of the users on the computer hosting the
Windchill Modeler Server.
Running the License Manager as an administrator will allow you to set up default
license details for users who have not tried to use Windchill Modeler yet.
Supported Web Browsers

The following web browsers can be used to access Model Manager:
• Chrome
• Firefox
• Opera
• Safari (Mac)
• Edge

Note
If you recently upgraded Windchill Modeler, you may need to clear your
browser cache to see the new changes to Model Manager.
Enabling HTTP for the Model Manager Website

For high security environments, we recommend keeping HTTPS enabled. Use the
instructions provided for enabling HTTP for the Web Interface as guidance. For
more information, see Configuring the Web Interface website to use HTTP on
page 123.
Manual Configuration of applicationHost.config File

If you saw the following error during the Windchill Modeler installation:
Error setting applicationHost.config file.
Failed to create applicationHost.config backup file.
Or if a 500 error occurs when you access the Model Manager, you should
complete the steps below to manually configure the
applicationHost.config file (the following steps apply to Windows 10
and Windows 7).
1. Open Internet Information Services (IIS) Manager
2. Select the root server node in the 'Connections' tree
3. In the 'Features View' select the 'Configuration Editor' under the 'Management'
section
4. In the 'Configuration Editor' in the 'Section' drop down select system.
webServer/serverRuntime
5. In 'Actions' pane under the 'Section' heading there should be 'Unlock Section'
text
6. If set to 'Lock Section' then section should already be unlocked
7. If the text "Unlock Section" is displayed, click on the text and this will change
to 'Lock Section'
8. Stop/start the 'Windchill Modeler Model Manager' website and application
pool

Web Interface Installation
Overview of the Web Interface Website

Windchill Modeler Web Interface (Web Interface) allows users to view the content
of a Model through their web browser, without the need to install Modeler.
A Web Interface website does not allow you to make changes to a model.
Note
When a user can view models through a Web Interface website, that user can
view ALL the Models that are Public Read or Public Write in ALL the
Databases that can be accessed through that Web Interface website.
Preparing for Installation of Web Interface

You can install Web Interface as part of Modeler installation only when .NET
Framework version 4.6.1 or later is installed on the computer.
Note
.NET Framework version 4.6.1 is installed by default with Modeler.
Before you begin, consider the following:

• It is not possible to add the Web Interface to an existing installation of
Windchill Modeler. If you have an existing installation and want to add the
web interface, you should uninstall Windchill Modeler and then reinstall it
including the Web Interface.
• In addition, Web Interface can be installed only when the Internet Information
Services (IIS) 7.5 or later is enabled and set up for use with Web Interface.
Installation with IIS 7.0 is not supported.
• Installing Web Interface adds the StudioRESTService database to the default
SQL Server instance.
• You must grant the PTC-IM-WSU user account access rights to all the
databases that you want to access using Web Interface.

To Enable and Set up Internet Information Services (IIS) for Use with
Web Interface (Windows Server 2012 or 2016):
1. Ensure that you are logged on to Windows as a user that has local
administrator rights.
2. From the Control Panel, search for and then click Turn Windows Features On or
Off.
3. On the Before You Begin page of the Add Roles and Features Wizard dialog,
click Next.
4. On the Installation type page, select Role-based or feature-based installation
option, and click Next.
5. On the Select Destination Server page, select the Select a server from the
server pool option, select your computer, and then click Next.
6. On the Server Roles page, select the Web Server (IIS) check box.
7. On the dialog that is opened, click Add Features.
8. On the Server Roles page, click Next.
9. On the Features page, click Next.
10. On the Web Server Role (IIS) page, click Next.
11. On the Role Services page, ensure that you select the check boxes associated
with the following services that are shown in bold.
When you select a check box, Windows may open a dialog for you to add the
features. If this happens, click the Add Features button.
Web Server
• Common HTTP Features:
○ Static Content
○ Default Document
○ HTTP Errors
○ HTTP Redirection
• Security:
○ Request Filtering
• Application Development:
○ ASP.NET (select 4.5 or 4.6)
○ .NET Extensibility (select 4.5 or 4.6)
○ ISAPI Extensions
○ ISAPI Filters
• Management Tools:

○ IIS Management Console
12. Click Next, and then click Install.
13. If you are prompted to reboot your computer, reboot your computer.
Web Interface (Windows Server 2008):
Off.
3. From Server Manager, in the left pane click Roles, in the right pane click Add
Roles (the Add Roles link is available only after the Roles data has been
collected).
4. On the Before You Begin page of the Add Roles Wizard, click Next.
5. On the Server Roles page, select the Web Server (IIS) check box.
6. Click Next, and then click Next again.
7. On the Role Services page, ensure that you select the check boxes associated
Web Server
• Common HTTP Features:
○ Static Content
○ Default Document
○ HTTP Errors
○ HTTP Redirection
• Application Development:
○ ASP.NET
○ .NET Extensibility
○ ISAPI Extensions
○ ISAPI Filters
• Security:
○ Request Filtering
• Management Tools:
8. Continue through the wizard to Install the Web Server (IIS) server role.

Web Interface (Windows 10, 8.1 and 7):
Off.
3. From the Windows Features dialog, select the check boxes that are associated
Internet Information Services
• Web Management Tools:
• World Wide Web Services:
○ Application Development Features:
◆ .NET Extensibility (select 4.6 if given the option)
◆ ASP.NET (select 4.6 if given the option)
◆ ISAPI Extensions
◆ ISAPI Filters
○ Common HTTP Features:
◆ Default Document
◆ HTTP Errors
◆ HTTP Redirection
◆ Static Content
○ Security:
◆ Request Filtering
For Windows 8.1 only, also select the check box that is associated with the
following service that is shown in bold.
.NET Framework 4.6 Advanced Services
• WCF Services
○ HTTP Activation
4. Click OK.

To Include Web Interface in an Installation of Modeler:
The Web Interface is not included by default in any of the Modeler installation
types.
To include Web Interface in a Modeler installation, on the Custom Setup page of
the Modeler installation wizard, expand the Modeler Model Editor feature, and
then set the Web Interface feature for installation.
Note
• The Modeler software is required on the computer that is going to host the
Web Interface website. This is because Model Explorer is used to bookmark
the databases that can be accessed from the Web Interface website.
• The Modeler software installation must add Profiles if Web Interface is also
installed. Otherwise, rendering diagrams from profiled models will fail
because the profile DLLs are not installed.
To ensure that the profiles are installed, during initial install or Update
existing, click the Profiles option under Model Editor Client.
After installing Web Interface, you can license the Web Interface website for
use and select the databases it can access. See Setting up user authentication
Installing a Web Interface Website

To install and set up a Web Interface website, perform the following steps:
1. License the Web Interface and select the databasesit can access on page 103.
2. Set up user authentication for a Web Interface Website on page 108.
3. Set up the contacts page of a Web Interface website on page 122.
4. Set up how Web Interface website accounts work on page 120.
5. Launch and test the Web Interface website on page 111.
6. Manage Web Interface website accounts on page 114.
Licensing a Web Interface Website and Selecting the

Databases it Can Access
A Web Interface website requires the following licenses:
• A Modeler license and a Windchill Modeler Web Interface Server license.
• A Windchill Modeler Web Interface Client license for each concurrent user of
the Web Interface website.

• Any additional licenses required for accessing the required models. For
example, a Product Line Model Access license is required to view information
in a Product Line Model.
After installing Web Interface, you must license it for use on the hosting computer.
You can then specify how many client licenses are checked out by the Web
Interface website, how long after inactivity a license expires, and select the
Databases that can be access from the Web Interface website.
If you have changed the default password for the PTC-IM-WSU user account
during install, the Windchill Modeler Web Interface application pool will be set to
use that new password. If you change the password after install, you must use the
IIS Management Console to update the application pool.
To License Web Interface for Use on the Hosting Computer:
Note
This step is required to complete Web Interface installation and configuration.
Modeler licenses are for specific users on specific computers, so you must log on
to the hosting computer using the PTC-IM-WSU user, and license Web Interface
for use.
1. If you have performed a Server only installation and have installed the
Floating License Server on the same computer, you do not have to change the
license settings but do need to add a license to the server. Run License
Manager and choose the Replace option, then select the license file to be
added.
2. If the computer that is hosting the Web Interface website does not have a
Floating License Server itself, launch the License Manager using Run as
administrator, and select Manage default license settings for New Users, choose
Options and set the license servername.
It is recommended that you use a server-based license, but you can use a local
license for a Standalone installation. The license server you choose must also
provide Windchill Modeler Web Interface Client licenses for each concurrent
user of the website.
For more information about how client licensing of a Web Interface website
works, see Client licensing of a Web Interface website on page 117.
For more information about setting up a Modeler license, see Introduction to
licensing Modeler on page 132.

To Select Which Databases Can be Accessed from the Web Interface
Website:
Note
This step is required to complete Web Interface installation and configuration.
1. Logon to the hosting computer as the PTC-IM-WSU user.

2. Start Model Explorer.
3. Bookmark the Databases that you want to be accessible through the Web
Interface website.
Ensure that any Databases you bookmark are using the same version of
Modeler as that of the Web Interface.
To bookmark a Database: right-click the Database, and then click Bookmark.
In Model Explorer, you can add Servers, and show all the Databases on a
Server:
• To add a Server to Model Explorer: right-click the SQL icon, and then
click Add Server.
• To see all the Databases on a Server: right-click the server and then click
Show All Databases.
For more information about working with Model Explorer, see the
Modeler Help.
4. Ensure that each Database you bookmark has been updated to work with the
version of Modeler you are using.
You can do this by using Modeler to open a model in the Database; if the
Database requires updating you are prompted to update the Database.
Important: If a Web Interface website is connected to a Database that requires
updating, the website will stop responding when you expand its Server icon.
5. When a bookmarked Database owns Models that are not Public Read or Public
Write, those models are accessible through the Web Interface website only
when the PTC-IM-WSU user has read access permissions to them.
To ensure that sandboxes in Databases with set access permissions are
accessible on the Web Interface website, you need to grant the PTC-IM-WSU
user access permissions to each sandbox in the Database.
• To set up PTC-IM-WSU user access to a sandbox: grant the PTC-IM-
WSU user read access permissions to the sandbox. Alternatively, you can

set the PTC-IM-WSU user as a Database Administrator or as an Owner of
the Database in which the sandbox resides through Model Explorer.
• To set up PTC-IM-WSU user access to a Model: grant the PTC-IM-WSU
user read access permission to the Model through Modeler or Modeler
Explorer.
• To set up PTC-IM-WSU user access to all Models in a Database: set up the
PTC-IM-WSU user as a Database Administrator of that Database or grant
PTC-IM-WSU Owner access to the Database through Model Explorer.
Note that when a user views a Model through a Web Interface website, or
successfully logs in or out, it is recorded in the visitors.txt file that resides in the
following folder:
C:\inetpub\wwwroot\PTC Integrity Modeler Web Interface\
settings
To Specify How Many Client Licenses Are Checked out by the Web
Interface Website and How Long after Inactivity a License Expires:
A Web Interface website requires a Windchill Modeler Web Interface Client
license for each concurrent user of that website.
At startup, a Web Interface website checks out a number of Windchill Modeler
Web Interface Client licenses. These licenses are then consumed by users as they
log in to the Web Interface website.
1. From the computer that is hosting the Web Interface website, ensure that the
Web Interface website is not running:
a. Start Internet Information Services (IIS) Manager: from the Run text box,
type inetmgr, and then press the Enter key.
b. In the Connections pane, select Application Pools.
c. In the Application Pools pane, select the Windchill Modeler Web Interface
entry.
d. If the Status of the Web Interface website is Started, in the Actions pane
click the Stop link.
2. From the computer that is hosting the Web Interface website, locate the
web.config file. The web.config file resides in the following location:
C:\inetpub\wwwroot\PTC Integrity Modeler Web Interface
3. Create a backup of the web.config file.
4. Using a text editor, open the web.config file.

5. In the web.config file, locate the <add key=" UserLicenses"
value=" 5" /> entry.
6. Set the value to required number of client licenses you want checked out by
the Web Interface website.
7. In the web.config file, locate the <authentication mode=
"Forms"> entry.
8. After 240 minutes of inactivity, a license expires. If you want to change how
long after inactivity a license expires.
a. In the web.config file, locate the entry that starts with <forms.
b. Change the timeout value from its default value of 240 to the desired
value.
9. Save the changes you have made to the web.config file.
10. If you stopped the Web Interface website, in the Actions pane click the Start
link.
To Set up the Windchill Modeler Web Interface Application Pool to Use

a New Password for the PTC-IM-WSU User Account:
1. From the computer that is hosting the Web Interface website, start Internet
Information Services (IIS) Manager.
2. In the Connections pane, select Application Pools.
3. In the central pane, select Windchill Modeler Web Interface.
4. In the Actions pane, click Advanced Settings.
5. In the Advanced Settings dialog, in the Process Model section, locate the
Identity entry.
6. For the Identity entry, click the value cell, and then click the button
7. Select the Custom Account option, and then click the Set button.
8. In the User Name box, type PTC-IM-WSU.
9. In the Password and Confirm Password boxes, type the new password you
created for the PTC-IM-WSU user account.
10. Click OK on the open dialogs to save the changes you have made.
After licensing the Web Interface website and selecting the databases it can
access, you can set up how users are authenticated. For more information, see

Setting up user Authentication for a Web Interface Website
Note
The Help assumes that you have a good working knowledge of setting up
websites and the security issues regarding access.
There are many different ways in which you can control access to a Web Interface
website, for example, through intranet access. How you choose to control access
to a Web Interface website is outside the scope of this Help. The Help assumes
that you have a good working knowledge of setting up websites and the security
issues regarding access.
After connecting to a Web Interface website, a user must be authenticated before
they can view any models. There are two ways in which a Web Interface website
can authenticates users. You can use one or both of these methods:
LDAP Authentication
When using LDAP authentication, the Web Interface website is set up to work
with one or more domains. When a user is a member of a supported domain, they
can log in to the Web Interface website using their Windows user name and
password. Their user name must be prefixed with the domain name followed by a
backslash mark. For example, MyDomain\MyUserName.
When using LDAP authentication, a user can view the following models through
the Web Interface website: Models that are Public Read or Public Write; and
Models for which the user has Modeler Owner, Write or Read access permissions.
Web Interface Website Account Authentication

Web Interface website account authentication, users connect to the Web Interface
website and create their own account for logging in to the Web Interface website.
After their account is approved, they can view models through the Web Interface
website.
A Web Interface website can be set up to automatically approve new accounts.
Alternatively, a Web Interface website can be set up so that new accounts must be
approved by the Web Interface website administrator.
When using Web Interface website account authentication, a user can view the
following models through the Web Interface website: Models that are Public Read
or Public Write.
It is important that you set up the user authentication of a Web Interface website to
meet the security needs of the models that can be accessed through that website.
For example:

• You may want only users that are a member of a specified domain to have
access to the models.
Use only LDAP authentication.
• You may want users that are a member of a specified domain to have access to
the models, and you may also want users that are outside of that domain to
have access after they have been approved.
Use LDAP authentication and Web Interface website account authentication.
Set up the Web Interface website so that new accounts require administrator
approval.
• You may want any user to have access to the models without the need to be
approved.
Use only Web Interface website account authentication. Set up the Web
Interface website so that new accounts are automatically approved.
The web.config file determines how users are authenticated. When installed,
the default authentication is as follows:
• LDAP authentication is disabled.
• Web Interface website account authentication is enabled, but newly created
Web Interface website accounts must be approved by the Website
Administrator.
To Set up the User Authentication for a Web Interface Website:

entry.
web.config file. The web.config file resides in the following
location:C:\inetpub\wwwroot\PTC Integrity Modeler Web
Interface
4. Using a text editor, open the web.config file

5. By default, a Web Interface website is not set up to support LDAP
authentication.
To enable LDAP authentication for the Web Interface website:
a. In the web.config file, locate the commented out <add name="PTC_
ADMembershipConnection" entry.
b. Uncomment the <add name ="PTC_ADMembershipConnection"
entry by deleting the leading '<!–' characters and trailing '–>' characters.
c. Replace the two placeholders named 'myDomain' and the two placeholders
named 'local' with the names of the domain and domain local group that
you want to use to authenticate users.
d. In the web.config file, locate the commented out <add name ="PTC_
ADMembershipProvider" entry.
e. Uncomment the <add name="PTC_ADMembershipProvider"
entry by deleting the leading '<!–' characters and trailing '–>' characters.
f. For the connectionUsername and connectionPassword, type
the user name and password of a user that is valid within the LDAP
domain. Note that companies often enforce regular changes of passwords
for user accounts. If the password is changed for the user account you use,
you must change the password in the web.config file accordingly.
Note
You can encrypt the user name and password in the web.config
file. For more information see the Microsoft Developer Network
website.
g. If you want to also use other domains and local groups to authenticate
users, create a copy of the <add name ="PTC_
ADMembershipConnection" and <add name ="PTC_
ADMembershipProvider" entries, and change them accordingly.
6. By default, a user can be authenticated through its REST service. If you are
not using the REST service, you may want to disable it for security reasons.
To disable the REST service:
a. In the web.config file, locate the <add key=
"EnableModelerService" value="true" /> entry.
b. Change the value to false.

Note
If you disable the REST service, Windchill Modeler's OSLC consumer will
not be able to authenticate its users.
7. By default, a user can be authenticated through the Web Interface website. If

you have created a Web Interface website only for its REST service, you may
want to disable website access for security reasons.
Note that the website is required to create Web Interface website accounts. In
addition, when learning to use the REST service, the website provides a way
of logging in to the REST service without the use of access tokens.
To disable the website:
a. In the web.config file, locate the <add key=
"EnableModelerServiceHTML" value="true"/> entry.
b. Change the value to false.
After setting up the user authentication, you can set up the contact details for the
Contacts page. See Setting up the Contacts Page of a Web Interface Website on
page 122.
Testing and Launching a Web Interface Website

After you have set up a Web Interface website, you can start the website, test that
it works as expected, and then launch the website so that it is available to users.
If user accounts need to be approved by the Web Interface website administrator,
you should have a process in place to ensure that accounts are approved promptly
and that users are informed when their accounts are approved.
Note
• The installation program sets up a Web Interface website as an HTTPS
website. You can configure it as an HTTP website if desired.
For more information about configuring the Web Interface website to use
HTTP, see Testing and Launching a Web Interface Website on page 123.
• To allow access of Models that have special characters in their names,
allowDoubleEscaping is set to true in the win.config file:
<requestFiltering allowDoubleEscaping="true" />.

If you set allowDoubleEscaping to false, a Web Interface website may not be
able to access Models that have non-alphanumeric characters in their names.
To Start and Test a Web Interface Website:

1. From the computer that is hosting the Web Interface website, start Internet
To start Internet Information Services (IIS) Manager: from the Run text box,
2. In the Connections pane, select Application Pools.
3. In the central pane, select Windchill Modeler Web Interface.
4. In the Actions pane, click Advanced Settings and set Load User Profile to True.
5. If the Status of the Web Interface website is Started, in the Actions pane click
the Stop link.
6. In the Actions pane click the Start link.
7. In the Connections pane, expand the Sites entry, and select the Windchill
Modeler Web Interface site.
8. In the Actions pane, click Restart.
9. In the Manage Web Site section of the Action pane, click the Browse entry.
10. Your default browser should open the Log In page of the Windchill Modeler
Web Interface website.
Log in to the website. In the Navigation pane, expand the SQL root item and
you will see the Servers and Databases that have been bookmarked through
the PTC-IM-WSU user.
11. Open the port 57850 on the firewall.
12. Confirm that you can access the Web Interface website from another
computer.
For example, if the name of the hosting computer is Test1, you can use the
following URL: https://test1:57850/
13. Test that the website is working as expected:
• Ensure that the Web Interface website can be accessed through its URL.
• Ensure that the authentication of users is working as you expected. If you
are using Web Interface website accounts, ensure that they can be created
and managed as required.
• Ensure that the security needs of ALL the models that can be accessed
through the Web Interface website are as required.

Note
When a user can view models through a Web Interface website, that
user can view ALL the Models that are Public Read or Public Write in
ALL the Databases that can be accessed through that Web Interface
website.
After you have tested the website, change the administrator password
before launching the website.
To Change the Password for the Web Interface Website Administrator:

For security reasons, you should change the default password that is used for the
Web Interface website administrator account. You cannot change the user name.
Note
Be aware that if you forget the new password, there is no way of resetting the
password. If you forget the password, contact PTC for assistance.
1. From your web browser, connect to the Web Interface website.

The Log In page is displayed.
2. In the User Name box, type MWI_SiteAdmin, which is the user name for the
Web Interface website administrator.
3. In the Password box, type [email protected], which is the default password for
the Web Interface website administrator account.
4. Click the Log In button below the User Name and Password boxes.
5. From the Hello, <your user name> link, click <your user name>.
6. From the Manage Account page, in the Current Password box, type
[email protected].
7. In the New Password and Confirm New Password boxes, type the new
password for the administrator account.
8. Click Change Password.
After changing the Web Interface website administrator password, launch the
website.
To Launch a Web Interface Website:

• Inform users that the Web Interface website is available.

You may want to provide the following information to the users:
• The URL for connecting to the Web Interface website.
• Contact information for the Web Interface website administrator.
• Which models can be viewed through the Web Interface website.
• How they should log in to the website, that is, whether they can log in through
their Windows user name or password, or whether they need to create an
account.
• If they need to create an account, whether that account will need to be
approved by the Web Interface website administrator.
Administering Web Interface Websites

This topic covers the following administration tasks:
• Managing the Visitors Log.
• Configuring the Web Interface Website to Use HTTP.
• Errors File and Status Log File.
• Changing the password for the Web Interface website administrator.
• Approve a new Web Interface website account.
• Unlocking a Web Interface website account.
• Deleting a Web Interface website account.
• Viewing which users have client licenses taken for the Web Interface website.
• Viewing which users have taken tokens for the Web Interface website.
Managing the Visitors Log

When a user views a Model through a Web Interface website, or successfully logs
in or out, it is recorded in the visitors.txt file that resides in the following
folder:
settings
Over time the size of the visitors.txt file will grow, so you may want to
delete or back up its content on a regular basis.
Configuring the Web Interface Website to Use HTTP

By default, Windchill Modeler Web Interface websites are configured to use
HTTPS/SSL. This configuration option ensures communication between clients
and server is totally secure.
To configure the Web Interface website to use HTTP instead of HTTPS, see
Configuring the Web Interface website to use HTTP on page 123.

Errors File and Status Log File
When an error occurs during a log in attempt to a Web Interface website, the full
details of the error are recorded in a log file that is named errors.log. In
addition, the status.log file records useful information about the status of the
The error.log and status.log files reside in the following folder.
settings
Important: The status.log file can become significantly large.
To Change the Password for the Web Interface Website Administrator:

For security reasons, you should change the default password that is used for the
Web Interface website administrator account. You cannot change the user name.
Important: Be aware that if you forget the new password, there is no way of
resetting the password.
1. From your web browser, connect to the Web Interface website.
The Log In page is displayed.
2. In the User Name box, type MWI_SiteAdmin, which is the user name for the
Web Interface website administrator.
3. In the Password box, type [email protected], which is the default password for
the Web Interface website administrator account.
4. Click the Log In button below the User Name and Password boxes.
5. From the Hello, <your user name> link, click <your user name>.
6. From the Manage Account page, in the Current Password box, type
[email protected].
7. In the New Password and Confirm New Password boxes, type the new
password for the administrator account.
8. Click Change Password.
To Approve a New Account:

This task applies only when a Web Interface website is set up so that new accounts
must be manually approved by the Web Interface website administrator.
1. Connect to the Web Interface website.
2. Log in to the Web Interface website using the administrator user name (MWI_
SiteAdmin) and password.
3. If the Admin Options page is not shown, click the Admin link in the toolbar.
4. Click the Manage User Accounts link.

5. In the User Name column, locate the user name for the account you want to
approve.
In the Approved? column, a cleared check box indicates that the account has
not been approved.
6. In the User Name column, click the user name for the account that you want to
approve.
7. From the Manage User page, in the Approved? column select the check box for
the account.
Note that you can un-approve an account by clearing this check box.
8. Contact the account user and inform them that their account has been
approved.
The email address of the user is shown on the Manage Users page.
To Unlock an Account:
This topic applies only when the Web Interface website supports Web Interface
website accounts.
5. In the User Name column, click the user name for the account you want to
unlock.
In the Locked-Out? column, the check box for the account should be selected.
6. In the User Name column, click the user name for the account you want to
unlock.
7. From the Manage User page, in the Locked-Out? column click the Unlock User
button.
8. Contact the account user and inform them that their account has been
unlocked.
The email address of the user is shown on the Manage Users page.
To Delete an Account:
This topic applies only when the Web Interface website supports Web Interface
website accounts.

5. In the User Name column, locate the user name for the account that you want
to delete.
6. In the Delete User column, click the Delete User button.
To view Which Users Have Client Licenses taken for the Web Interface
Website:
4. Click the Manage Used Licenses link.
Note
The total number of available licenses and the number of licenses currently in
use is displayed at the bottom of the Log in page.
The Web Interface administrator account does not use a license.
To View Which Users Have Taken Tokens for the Web Interface
Website:
4. Click the Manage Issued Tokens link.
Client Licensing of a Web Interface Website

When you start a Web Interface website, the website takes the following Modeler
licenses:
• A Windchill Modeler Web Interface Server license.

This license is required to start the Web Interface website.
• A number of Windchill Modeler Web Interface Client licenses (Web Interface
Client licenses).
These licenses are used for each concurrent user of the Web Interface website.
Note
The administrator account can login to the Web Interface website even if all
client licenses are in use.
The Web Interface administrator account can only access the Admin, Contact, and
About pages of the Web Interface website. If you try to access other pages, you
will be redirected to the Admin page. Accessing REST and OSLC services returns
a 401 unauthorized response.
Client Licensing Process

Each time the Web Interface website is started, the website takes a specified
number of Web Interface Client licenses from the license server.
These Web Interface Client licenses are stored in an internal pool for use with the
Web Interface website:
• Each time a user logs in to the Web Interface website, the website takes a
license from the internal pool (not the license server).
• Each time a user logs out of the Web Interface website, the website returns
their license to the internal pool.
Note
The license is returned only when the user clicks the Log Out link on the
website. Closing the web browser or web browser tab does not return the
license.
If the internal pool runs out of licenses, new users cannot log in to the Web
Interface website.
A Web Interface website restarts automatically every 24 hours:
• When the Web Interface website stops, the licenses are removed from the
internal pool, and the Web Interface website returns the Web Interface Client
licenses to the license server.

• When the Web Interface website starts again, the Web Interface website takes
the Web Interface Client licenses from the license server and stores them in the
internal pool.
If a user is using a Web Interface website when it restarts, they will not have to log
in again to continue using the website.
Note
The Web Interface administrator account does not take a license.
The Web Interface administrator account can only access the Admin, Contact,
and About pages of the Web Interface website. If you try to access other
pages, you will be redirected to the Admin page. Accessing REST and OSLC
services returns a 401 unauthorized response message.
Specifying how many Web Interface Client licenses a Web Interface

website takes
Being able to specify how many licenses a Web Interface website can take is
useful when you have many websites using the same license server.
The number of licenses that are taken by the website is determined by its
web.config file. The <add key="UserLicenses"> entry specifies the
value.
If the required number of licenses are not available, the Web Interface website
takes as many licenses as it can. The status.log file records how many
licenses are taken.
For more information about specifying how many Web Interface Client licenses a
website can take, see Licensing a Web Interface website and selecting the
Returning of Client Licenses

As previously mentioned, a Web Interface website takes a license from the
internal pool when a user logs in, and returns a license to the internal pool when a
user logs out.
Note
If a user is logged in to a Web Interface website and they close their web
browser (or the web browser tab) without logging out of the Web Interface
website, their license is not released.

When a user closes their web browser without logging out, their license becomes
available for other users when either of the following events occurs:
• The Web Interface website is restarted.
• The license expires.
The administrator of the website can view when a license will expire through
the Admin page of the website.
Note that by default a license expires after 240 minutes of inactivity. If
desired, you can change the value of 240 minutes through the web.config
file. For more information on how to do this, see Licensing a Web Interface
website and selecting the databases it can access on page 103
Setting up how Web Interface Website Accounts Work

If you are using Web Interface website account authentication, you should review
the configuration options that are available. For example, you can set the
minimum password length and whether passwords can be retrieved through a
security question.
To Set up How Web Interface Website Accounts Work:

entry.
5. By default, a Web Interface website is set up so that Web Interface website
accounts need to be approved by the website administrator.
a. In the web.config file, find the DisableCreatedUser key.
b. Set the value of the DisableCreatedUser key to false.

6. By default, the Remember Me check box is shown on the Log In page of the
When a user selects the Remember Me check box they can leave the website
without logging out (not recommended) and return within the authorization
timeout period without the need to log in again.
To remove the Remember Me check box from the Log In page:
a. In the web.config file, find the EnableRememberMe key.
b. Set the value of the EnableRememberMe key to false.
7. By default, when creating a new account, the Security Question and Security
Answer boxes are shown on the Register page of the Web Interface website.
The security question and answer feature allows users to retrieve and reset
their account passwords.
To remove the Security Question and Security Answer boxes from the
Register page, so that users cannot retrieve their account passwords:
a. In the web.config file, find the requiresQuestionAndAnswer key.
b. Set the value of the requiresQuestionAndAnswer key to false.
8. By default, each account requires a unique email address.
To allow different accounts to use the same email address:
a. In the web.config file, find the requiresUniqueEmail key.
b. Set the value of the requiresUniqueEmail key to false.
9. By default, a user's session will time out if they are inactive for 240 minutes.
To change the time taken before a user's session times out:
a. In the web.config file, locate the entry that starts with <forms.
b. Change the timeout value from its default value of 240 to the desired
value.
10. By default, a user's password must be a minimum of eight characters, and it
must contain at least one non-alphanumeric character.
To change the minimum length of a password:
a. In the web.config file, find the minRequiredPasswordLength key.
b. Set the value of the minRequiredPasswordLength key to the minimum
length you require.
To change the number of non-alphanumeric characters that are required in a
password:

a. In the web.config file, find the
minRequiredNonalphanumericCharacters key.
b. Set the value of the minRequiredNonalphanumericCharacters key to the
minimum number of non-alphanumeric characters you require.
11. By default, a user has a maximum of three failed log in attempts before their
account is locked out.
To change the number of failed log in attempts a user can have before their
account is locked out:
a. In the web.config file, find the maxInvalidPasswordAttempts key.
b. Set the value of the maxInvalidPasswordAttempts key to the required
value.
After setting up how Web Interface website accounts work, you can launch the
website so that it is available to users. See Testing and launching a Web Interface
website on page 111.
Setting up the Contacts Page of a Web Interface Website

A Web Interface website includes a Contacts page that provides information for
contacting the website administrator.
To Set up the Contacts Page of a Web Interface Website:

entry.
C:\inetpub\wwwroot\PTC Integrity Modeler Web Interface. Create a backup of
the web.config file.
4. Specify the contact information for the Web Interface website administrator.
This information is displayed when the user clicks the Contact link on the Web
Interface website:

a. In the web.config file, find the Contact_Email1 key.
b. Change the values of the Email, Phone and Address entries to specify the
contact information for the company and Web Interface website
administrator. Note that the values appear after the | symbol.
c. Create any additional entries you require for the Email, Phone and Address
sections. For example, if you want to add a third email address: copy the
Contact_Email2 entry, paste a new entry after the Contact_Email2 entry,
change Contact_Email2 to Contact_Email3, and change its value
accordingly.
d. Remove any entries that are not required.
After setting up the contact information, you can set up how Web Interface
website accounts work. See Setting up how Web Interface website accounts work
on page 120.
If you are not using Web Interface website accounts, you can launch the website
so that it is available to users. See Testing and launching a Web Interface website
on page 111.
Configuring the Web Interface Website to Use HTTP

Enabling HTTP
Note
You can use either http or https. You should not configure both as this
results in login errors.

By default, the Web Interface website, Modeler REST Service, and OSLC
Provider are configured to use HTTPS on port 57850. This setting is configured
in the web.config file, which resides in the following location:
To enable HTTP, do the following:
1. Open the web.config file, then edit the following entries:
a. Disable forced SSL by setting the requireSSL="true" attribute for
Form Authentication to false:

<authentication mode="Forms">
<forms name=".StudioRESTService" loginUrl="~/account/
login"
timeout="240" defaultUrl="~/" protection="All" requireSSL=
"false" />
</authentication>
b. Remove or comment out the <bindings> section:
<bindings>
<webHttpBinding>
<binding>
<security mode="Transport" />
</binding>
</webHttpBinding>
</bindings>
2. Add the HTTP binding using Internet Information Services (IIS) Manager:
a. On the server hosting the Windchill Modeler Web Interface, open IIS
Manager.
b. In the left pane, select the Windchill Modeler Web Interface site.
c. In the Actions pane, click Bindings...
d. Click Add... in the Site Bindings dialog box.
e. In the Add Site Binding dialog box, add the binding information as follows:
• Type — http
• Port — 57851
f. Click OK to confirm.
If you do not want to use HTTPS, you can remove the https binding using IIS
Manager after setting up HTTP:
• Select the https binding, then click Remove.

Testing the Web Sites
As mentioned above, you can configure the Web Interface either with http or
https. but not both.
To test the Web Interface with http
• Using a different computer to the one hosting the Modeler Web Interface,
open a web browser and check that you can access the secure website
using the https connection. Add the port number 57850 at the end of the
URL (e.g. https://<myserver>:57850).
1. If you see a security warning, allow the certificate.
2. Click on Continue to this website. You will be able to login as normal,
but you will see the address bar is shown in red that the site is
potentially insecure.
To test the Web Interface with https

• Using a different computer to the one hosting the Modeler Web Interface,
open a web browser and check that you can access the web site using port
57851 (e.g. http://<myserver>:57851) by logging in.
Troubleshooting a Web Interface Website

This topic includes the following troubleshooting sections:
• Does PTC-IM-WSU have rights to run the Windchill Modeler Web Interface
application pool?
• Have you set up the Windchill Modeler Web Interface application pool to use
a new PTC-IM-WSU password?
• Checking the status of the website service
• Checking the error log
• Checking the visitors of a website
• Checking which users are connected to a website through access tokens
• Checking that Web Interface has been installed correctly
• I experienced license check failures when using Web Interface
• I cannot see a model for which I have access permissions
• The Web Interface website has run out of client licenses

Does PTC-IM-WSU Have Rights to Run the Windchill Modeler Web
Interface Application Pool?
If the Web Interface application pool fails to start or gives an HTTP Error 503, the
System Event Log on the server may show an error preceded by a warning which
include:
“The identity of application pool Windchill Modeler Web Interface is invalid. The
user name or password that is specified for the identity may be incorrect, or the
user may not have batch logon rights.”
If you have checked the password is correct, see above, then permission for batch
logon may be denied by your domain policies. Add the PTC-IM-WSU user to the
local Administrators group to resolve this.
Have You Set up the Windchill Modeler Web Interface Application

Pool to Use a New PTC-IM-WSU Password?
If you have changed the password of the PTC-IM-WSU user account, you must
set up the Windchill Modeler Web Interface application pool to use that new
password.
If you have not done so, the Web Interface website will not respond.
For information about setting up the Windchill Modeler Web Interface application
pool to use a new PTC-IM-WSU password, see Licensing a Web Interface website
and selecting the databases it can access on page 103.
Checking the Status of the Website Service

When the Web Service starts or restarts (not when a request for data is made), it
writes to a status.log file that resides in the following folder:
settings\
The Service Status Test makes the following checks:
• Checks the Version Number of the Web Interface website.
• Checks that the license for Web Interface is valid.
• Checks that the REST Service Path is registered.
• Checks that the HTML Service Path is registered.
• Checks the User Account Name the Service is running under.
• Checks for the Registry key (under the Local User Account for the Service)
that provides the actual path to the files required for the service.
• Checks that the Service can write to the \enabler folder.
• Checks that the Service can write to the \render\icons folder.
• Checks that the Service can write to the \render\images folder.

Confirm that the results of the checks are true. The results will look similar to as
follows.
Note that if a Web Interface website cannot read the Registry key for the files
path, it will not be able to write to the status.log. When this occurs, an entry
is sent to the Application Event log under Windchill Modeler Web Interface.
Checking the Error Log

When an error occurs during a log in attempt to a Web Interface website, the full
details of the error are recorded in a log file that is named errors.log. The
error log also records any errors that occur when attempting to render a diagram.
The error.log file resides in the following folder.
settings
Checking the Visitors of a Website

The following information is recorded in the visitors.txt log file:
• When a user opens a model in the Web Interface website.
• When a user successfully logs in or out of the Web Interface website.
The visitors.txt file resides in the following folder:
settings
Checking Which Users Are Connected to a Website Through Access

Tokens
4. Click the Manage Tokens link.
A table shows which users are accessing the website through access tokens.

Checking That Web Interface Has Been Installed Correctly
To check that it has been set up correctly by the Modeler installation program:
1. Start Internet Information Services (IIS) Manager: from the Run text box, type
inetmgr, and then click OK.
2. In the Connections pane, expand the Application Pools entry.
3. There should be an application pool named Windchill Modeler Web Interface.
4. Select the Windchill Modeler Web Interface application pool, and in the Actions
pane click Advanced Settings.
5. In the General section, .Net Framework Version should be set to v4.0 or later.
6. If running on a 64–bit version of Windows, Enable 32-Bit Applications should
be set to True.
7. Managed Pipeline Mode should be set to Integrated.
8. In the Process Model section, Identity should be set to PTC-IM-WSU.
9. Load User Profile should be set to True (by default this is set to False on
Windows Server).
10. Close the Advanced Settings dialog.
11. In the Connections pane, expand the Sites entry.
12. There should be a site named Windchill Modeler Web Interface.
13. Select the Windchill Modeler Web Interface site and in the Actions Pane click
Basic Settings.
14. Site Name and Application pool should both be set to Windchill Modeler Web
Interface.
15. Physical path should be set to C:\inetpub\wwwroot\PTC Integrity
Modeler Web Interface.
16. Click the Connect as button.
17. On the Connect As dialog the Application user (pass through authentication)
option should be selected.
18. Click OK to close the Connect As dialog
19. Click the Test Settings button.
20. On the Test Connection dialog, the Authentication should be set to Pass-
through authentication, and Authorization should show Path is accessible. If
Authorization fails then the PTC-IM-WSU account does not have full control
over the 'PTC Integrity Modeler Web Interface' folder.
21. Close the Test Connection dialog and close the Edit Site dialog.
22. A Web Interface website should be set up to run on Port 57850 and will be
given the next available Site ID. If you want to change these or set the Host
Name, use the Bindings option that is available in the Actions pane.

23. In the central pane, in the IIS group, double-click the Authentication icon.
24. Anonymous Authentication and Forms Authentication should be set to
Enabled. ASP .NET Impersonation should be set to Disabled.
I Experienced License Check Failures When Using Web Interface

If you experience license check failures when using Web Interface, check that the
hosting computer is set up to use a Windchill Modeler Web Interface license. For
information about viewing local license keys, see Viewing local license keys on
page 154.
If the Web Interface website has been successfully licensed in the past but is now
reporting the license problems, after resolving the license problems you may have
to restart the Windchill Modeler Web Interface application pool through Internet
If the hosting computer is licensed correctly and you are experiencing license
check failures when using Web Interface, this may be caused by .NET Framework
4.0 not being installed correctly. This applies only if you are using .NET
Framework version 4.0.
I Cannot See a Model for Which I Have Access Permissions

If you are using LDAP authentication and cannot see a Model for which you have
access permissions:
• Check that you have logged in to the Web Interface website using your
Windows credentials, and not a Web Interface website account.
If you log in using a Web Interface website account, you can view only models
that are Public Read or Public Write.
• If you have logged in using your Windows credentials, confirm that the PTC-
IM-WSU user has read access permissions to the model.
When a bookmarked Database owns Models that are not Public Read or Public
Write, those models are accessible through the Web Interface website only
when the PTC-IM-WSU user has read access permissions to them. For more
information, see Licensing a Web Interface website and selecting the databases
it can access on page 103.
The Web Interface Website Has Run Out of Client Licenses

If a Web Interface website runs out of licenses, users that are not using the website
but are still logged in can log out to return their licenses.
It is possible that licenses may have been taken and not returned, even though they
are not being used. This can happen when a user closes a Web Interface website
without first logging out.

When this happens, the license is returned when either of the following events
occurs:
• The Web Interface website is restarted.
• The license expires.
The administrator of the website can view when a license will expire through
the Admin page of the website.

6
Licensing Modeler
Introduction to Licensing Modeler ............................................................................. 132
Licensing Modeler ................................................................................................... 133
Local and Server-based Licensing ............................................................................ 133
Modeler License Types: Subscription, Evaluation, Permanent, Incremental and
Upgrade .............................................................................................................. 136
Working with a Server-based Floating License .......................................................... 137
Working with a Local License ................................................................................... 143
License Borrowing - Frequently Asked Questions ...................................................... 146
License Manager..................................................................................................... 149
131
Introduction to Licensing Modeler
Each Modeler client must be licensed. Modeler servers do not require a license.
Modeler is supplied with evaluation Modeler licenses that allow new installations
of the product to be started. However, the evaluation licenses expire after a
specific number of days. During this initial period, you must obtain permanent
Modeler licenses from PTC, so that you can continue to use the product after the
evaluation Modeler licenses have expired. There are two ways of licensing
Modeler:
• Through a local license.
• Through a server-based floating license.
Note
You can borrow a license from a server-based floating license and work
locally.
• Before using Modeler for the first time, you must start License Manager and
specify the location of the license file.
• If you are upgrading Modeler, you will require upgrade or replacement
Modeler licenses. For more information, see the Modeler Release Notes. If
you have a maintenance agreement with PTC, you should receive an email
that provides instructions for obtaining the upgrade and replacement licenses.
This section describes how you license Modeler. It contains information about:
• Local and server-based licensing
• Modeler licenses
• Working with server-based floating licenses
• Working with local licenses
• License borrowing - frequently asked questions
• License Manager
Note
FLEXnet Publisher user documentation refers to a local license as a node-
locked license.
For more information about licensing a Web Interface website, see Licensing a
Web Interface Website on page 103.

Licensing Modeler
Follow the steps below to license Modeler:
• Obtain the appropriate licenses from PTC.
• Add or replace the licenses you have received from PTC. See Replacing a
local license file on page 153.
• Specify whether you are using a local or server-based floating license and the
location of that license.
For more information, see the following topics:
• Using a local license file on page 153.
• Using a server-based floating license on page 154.
If you are upgrading Modeler, you will require replacement licenses. If you have a
maintenance agreement with PTC, you should receive an email that provides
instructions for obtaining the replacement licenses.
For more information about licensing Modeler, see Introduction to licensing
Local and Server-based Licensing

You can license a Modeler client through a server-based floating license or
through a local Modeler license.
Note
A Modeler client cannot use both a floating and local license at the same time.
Server-based Floating Modeler License

A server-based floating license is achieved through the Floating License Server,
which is installed as part of a Modeler Server Only installation by default.
Licensing Modeler 133

The Floating License Server determines the number of licenses that are available
through the Modeler licenses that have been added to its license file. The Floating
License Server then ensures that no more than the maximum number of licenses
are being used at any given time. If you attempt to open Modeler and all the
licenses are in use, Modeler opens the License Status dialog box so that you can
see who is using each license.
Permanent, incremental (which are permanent) and upgrade Modeler licenses can
be borrowable or non-borrowable. You can borrow a borrowable license from a
server-based floating license and then work locally without being connected to the
license server. You can borrow a license for up to 10 days and License Manager
will automatically use the borrowed license until it expires. After a borrowed
license expires, that license becomes available on the license server. Important:
You cannot extend the period for which you borrow a license, but you can return a
borrowed license before it has expired and then borrow that license again. See
License borrowing - frequently asked questions on page 146 for more information.
If as part of the client only installation of Modeler you specify the server on which
the Floating License Server resides, the Modeler client will be set up to use a
floating Modeler license on that server.

A standalone installation of Modeler uses a local Modeler license by default. If
you want a standalone installation of Modeler to use a server-based floating
Modeler license, you must manually set it up through the Options dialog box in
License Manager.
Floating License Server uses the Windchill Modeler License Server service, which
is a Windows service that is implemented through FLEXnet Publisher.
To download the FLEXnet Publisher end users guide, see FLEXlm end user guide.
A license request for a permanent or incremental Modeler license must be made
from the computer on which the Floating License Server resides.
You must use a server-based floating Modeler license for a Microsoft Remote
Desktop Services or Citrix MetaFrame installation of Modeler.
Local Modeler license

Each Modeler client can be set up to use a local Modeler license.
A local Modeler license is installed on the same computer as the Modeler client,
and it allows Modeler to be run at any time. A local Modeler license will work
only on the computer from which the license request is made.
A Standalone installation of Modeler is set up to use a local Modeler license by
default. A Client Only installation of Modeler uses a server-based floating
Modeler license by default. If you want a Client Only installation of Modeler to
use a local Modeler license, you must manually set it up through the Options page
of License Manager.

Note
If you want to set up default License Manager settings for different users of
the computer to use: after starting License Manager, from the dialog that
prompts you to choose between managing license settings for yourself or
managing default license settings for new users, click Manage Default License
Settings for New Users.
Modeler License Types: Subscription,

Evaluation, Permanent, Incremental and
Upgrade
A Modeler License can be one of five types: Subscription, Evaluation, Permanent,
Incremental or Upgrade.
Subscription
A subscription license is a temporary license, usually valid for one year, that can
be borrowed to allow users to work with Modeler while disconnected from the
license server.
Evaluation
An evaluation Modeler license allows you to start Modeler after installing the
product. The evaluation type expires after a specific number of days, so for use of
Modeler after the Modeler license has expired, you must obtain a permanent or a
subscription Modeler license from PTC. If you have purchased a server-based
floating license, the correct number of evaluation Modeler Licenses will be
provided. The evaluation Modeler license is supplied in the cover letter that
accompanies Modeler.
Permanent
A permanent Modeler license allows you to use Modeler after the evaluation
Modeler license has expired. Use License Manager to create a license request for a
permanent Modeler license, and then send this license request to PTC. PTC can
then send you a permanent Modeler license. A permanent Modeler license works
only on the computer from which the license request was made.
Incremental
If you are using a server-based floating license, you can add additional licenses to
that license by adding an incremental Modeler Licenses to the license file. Use
License Manager to create a license request for an incremental Modeler License,

and then send this license request to PTC. PTC can then send you an incremental
Modeler license. An incremental Modeler license works only on the computer
from which the license request was made.
Upgrade
An upgrade Modeler license upgrades a permanent or incremental Modeler license
to work with a new release of Modeler. An upgrade Modeler license works only
on the computer from which the license request was made. Users that have a
maintenance agreement with PTC should receive an email that provides
instructions for obtaining an upgrade Modeler license.
Working with a Server-based Floating

License
The Floating License Server ensures that no more than a specified number of
Modeler installations are running at any given time.
This topic contains the following tasks:
• Setting up the Floating License Server
• Adding or Replacing a License File
• Creating a Request for a Permanent or Incremental Modeler License
• Setting up the default Modeler License for new users of the Server-based
Floating License
• Using a Server-based Floating License from a Modeler Client
• Borrowing a License from a Server-based Floating License
• Returning a Borrowed License to a Server-based Floating License
• Viewing Which Users are Using Licenses of a Server-based Floating License
Setting up the Floating License Server

The Floating License Server is controlled by FLEXnet Publisher License
Manager. You should not need to change its configuration.
Download the FLEXnet Publisher end users guide, on the PTC eSupport website.
Adding or Replacing a License File

After adding a new license file, you must stop and start the Floating License
Server. This may temporarily disrupt any users that are using the server-based
floating license. The license file is sent to you through email.
To add a license file, follow the instructions provided in the email:

1. From the computer on which the Floating License Server resides, start License
Manager.
To start License Manager under Windows 10:
• On the Windows Start menu, click All Apps, click Windchill Modeler, and
then click License Manager.
To start License Manager under Windows 8.1 or Windows Server 2012:
• On the Windows Apps screen, in the Windchill Modeler group, click
License Manager.
To start License Manager under Windows 7 and earlier supported versions of

Windows:
• On the Windows Start menu, point to All Programs, click Windchill
Modeler, and then click License Manager.
2. Click Options.
3. If the path shown in the The Path to the Local License box is not as required,
click the associated browse button and select the required folder.
Note
You cannot select a folder that can be subject to virtualization.
4. Click Return to Main.

5. Click Replace.
6. Select the license file that has been sent to you by PTC, and then click Open.
Floating License Server prompts you to restart the Windchill Modeler License
Server service, so that the new license file is used.
7. Close License Manager.
8. If you chose not to restart the Windchill Modeler License Server service, the
new Modeler license will not be available until you restart the Windchill
Modeler License Server service.
To restart the Windchill Modeler License Server service:
• Under Windows 10 in the Windows Search the Web and Windows box,
type Services, and then press the Enter key. Right-click the Windchill
Modeler License Server service, and then click Restart.
• Under Windows 8.1, Windows 7 or Windows Server 2012, from the
Control Panel Category view, click the System and Security link, click the
Administrative Tools link, double-click the Services entry, right-click the
Windchill Modeler License Server service, and then click Restart.

• Under Windows Server 2008, from the Control Panel Home view, click the
System and Maintenance link, click the Administrative Tools link, double-
click the Services entry, right-click the Windchill Modeler License Server
service, and then click Restart.
Creating a Request for a Permanent or Incremental Modeler License

Modeler license has expired.
An incremental license adds additional licenses to a permanent license.
To request a permanent or incremental Modeler license:
1. From the computer on which Floating License Server resides, start License
Manager.
License Manager.

Windows:
2. Click Request Wizard.
License Manager opens the Introduction page of the License Request Wizard.
3. Follow the instructions of the License Request Wizard.
• On the Feature Details page, select the check boxes associated with the
features you want to license, and in each case type the number of licenses
you require in the associated text box.
• In the Additional Information text box, specify whether you require a
permanent or incremental license.
• On the final page of the Request Wizard, click Save As to create a license
request file.
4. After finishing the wizard, close License Manager.
5. From the PTC eSupport Portal, create a new Support Case to request the
required license from PTC. Ensure that you attach the license request file to
the Support Case.

Upon receipt and verification of your request, PTC will send you a permanent or
incremental Modeler license.
Using a Server-based Floating License for Modeler

If, as part of Modeler installation, you specify a floating point license server, then
Modeler client uses the server-based floating license by default. Although, you
can use a floating license with any installation of Modeler - Client, Standalone or
Server. Also, you can change the license server on any installation of Modeler that
does not have the floating license server component installed.
To use a floating license:
1. From the computer on which Modeler resides, start License Manager.
License Manager.

Windows:
2. Click Options.
3. Select the option button associated with the Name of the License Server box.
4. In the Name of the License Server box, type the name of the Modeler License
Server on which the server-based floating license you want to use resides.
5. Click Save, and then close License Manager.
Each time you start Modeler it will request a license from the specified server.
Modeler periodically validates the license while in use.
Borrowing a License from a Server-based Floating License

Permanent, incremental (which are permanent), and upgrade licenses can be
borrowable or non-borrowable. You can borrow a license from any installation of
Modeler that does not have the floating license component installed. You can
borrow a license for up to 10 days and Modeler and other add-ins use the
borrowed license until it expires. After a borrowed license expires, that license
becomes available on the license server.

Note
You cannot extend the period for which you borrow a license, but you can
return a borrowed license before it has expired and then borrow that license
again.
1. From the computer on which the Modeler client resides, start License
Manager.
License Manager.

Windows:
2. Click Borrow/Return.
3. In the Available Features tab, select the check boxes associated with the
license features you want to borrow.
4. Set the Date and Time at which you want the borrowed license features to
expire.
5. Click Borrow Selected Features.
The Borrowed Features tab displays information about the license features you
have borrowed.
Returning a Borrowed License to a Server-based Floating License

You can return a license from any installation of Modeler that does not have the
floating license server component installed.
Manager.

License Manager.

Windows:
3. Click the Borrowed Features tab.
4. Select the check boxes associated with the license features you want to return.
5. Click Return Selected Features.
The selected license features are returned to the license server.
Viewing Which Users are Using Licenses of a Server-based Floating

License
You can view the license status from any computer and installation type of
Modeler, the only constraint is that the logged in user has configured License
Manager to use a floating license.
Note
The following works only on the license server.
It can be useful to view which users are currently using the licenses of a server-
based floating license.
To view which users are using a floating license, from the Modeler server, start
License Status. You should note that only the computer that has the floating
license server component installed, has the License Status shortcut added to the
Windows Start menu. On computers that do not have the floating license server
component, you can view the floating license status from Modeler, on the Model
tab, Floating License Status option.
To start License Status under Windows 10:
• On the Windows Start menu, click All Apps, click Windchill Modeler, and then
click License Status.
To start License Status under Windows 8.1 or Windows Server 2012:
• On the Windows Apps screen, in the Windchill Modeler group, click License
Status.

To start License Status under Windows 7 and earlier supported versions of
Windows:
• On the Windows Start menu, point to All Programs, click Windchill Modeler,
and then click License Status.
To view which users are using a floating license - from the Modeler client:
• From Modeler, on the Model tab, click Floating License Status.
Working with a Local License

A local license allows Modeler to be used at any time.
Standalone installations of Modeler are initially set up to use a local license.
Client Only installations of Modeler are initially set up to use a server-based
floating license.
Note
FLEXnet Publisher user documentation refers to a local license as a node-
locked license.
Setting Up Modeler to Use a Local License

To set up Modeler to use a local license:
Manager.
License Manager.

Windows:
2. If you are setting up default settings for other users of the computer, click
Manage Default License Settings for New Users.
3. Click Options.

4. If the The Path to the Local License option is not selected, click the Path to the
Local License option.
If the Path to the Local License is empty or if the path is not as required, click
the associated browse button, and then select the folder in which the license
file will reside.
Note
5. Click OK, and then close License Manager.
Adding or Replacing a License File

PTC provides license files to customers through emails.
1. To add a license file, follow the instructions provided in the email:
License Manager.
2. Click Manage License Settings for Yourself.
3. Click Options.
4. If the The Path to the Local License option is not selected, click the The Path to
the Local License option.
If the Path to the Local License is empty or if the path is not as required, click
the associated browse button, and then select the folder in which you want the
license file to be copied.
Note
5. Click Replace.
6. Select the license file that has been sent to you by PTC, and then click Open.
License Manager copies the license file to the folder that is shown in the Path
to the Local License box.

Creating a Request for a Permanent Modeler License

Modeler license has expired.
To request a permanent Modeler license:
Manager.
License Manager.

Windows:
3. Click Request Wizard.
License Manager opens the Introduction page of the License Request Wizard.
Note
If the Request Wizard button is not available, Modeler is set up to use a
floating license. If you require a Modeler license for the server, you must
generate the license request from the server. If you require a local license,
enable the Request Wizard button by clicking Options, clicking the Path to
the Local License option, and then clicking OK.
4. Follow the instructions of the License Request Wizard.

Note
• On the Features Details page - select the check boxes associated with the
Modeler licenses you want to use.
• On the final page of the Request Wizard, click Save As to create a license
request file.

6. From the PTC eSupport Portal (https://support.ptc.com/), create a new Support
Case to request the required license from PTC. Ensure that you attach the
license request file to the Support Case.
Upon receipt and verification of your request, PTC will send you a permanent
Modeler license.
Viewing Modeler Licenses

1. Start License Manager.
License Manager.

Windows:
3. Click View.
License Borrowing - Frequently Asked

Questions
The License Options page of License Manager allows you borrow a license from a
server-based floating license. After borrowing a license, you can work locally
without being connected to the license server.

Permanent, incremental (which are permanent) and upgrade licenses can be
borrowable or non-borrowable. You can borrow a borrowable license from a
server-based floating license and then work locally without being connected to the
license server. You can borrow a license for up to 10 days and License Manager
will automatically use the borrowed license until it expires. After a borrowed
license expires, that license becomes available on the license server.
Note
You cannot extend the period for which you borrow a license, but you can
return a borrowed license before it has expired and then borrow that license
again.
These are the frequently asked questions that relate to license borrowing.
What is the maximum amount of time for which a license can be

borrowed?
The maximum is 10 days; the minimum is 5 minutes.
Can I set predefined borrowing time for all users?

This is not a feature that is available for Windchill Modeler, however Flexlm
allows you to limit the time of borrowing a feature using the Flexlm Options file.
For more information see The Options File section of the Flexlm End User Guide.
Can an incremental license be borrowable if the permanent license

isn't?
Yes, it can. The number of licenses available for borrowing is determined by the
number of borrowable incremental license. For example, if you have four non-
borrowable permanent licenses and one borrowable incremental license, only one
license can be borrowed. If you try to borrow more than one license then an error
will occur.
Note that the order licenses are checked out does have an effect. For example, if a
server has one borrowable license and one non-borrowable license, it is possible
for a user to perform a normal checkout that takes the borrowable license. This
means that when another user tries to borrow a license they get an error stating
that borrowing is not supported. The order that licenses get checked out is the
same as the order they appear in the license file. With this in mind we recommend
putting additional, borrowable licenses at the end of the license file.
Can an evaluation license be borrowed?

No, only permanent licenses can be borrowed.

If a license is borrowable then do incremental license for the same
product have to be borrowable as well, are they automatically
borrowable, or is it optional?
Each entry in the license file is treated individually. This means different
combinations of licenses for the same product can have different Borrow settings.
The number of borrowable licenses that are available is dependent on how many
Modeler licenses have borrowing enabled.
Can an upgrade license be borrowable independently of whether the

license it upgrades is borrowable?
Upgrade licenses can be used to upgrade a previous version of a permanent or
incremental license to a newer version and enable borrowing at the same time. It's
also worth noting that if a license is marked as borrowable then any upgrade
licenses must be borrowable too. You do not have to upgrade all of the borrowable
licenses, but any you do upgrade cannot be made non-borrowable. Failure to
maintain this consistency will cause the license file to be unusable.
Is there any way to check a borrowed license back in before it

expires?
Yes. From License Manager, click Borrow/Return, click the Borrowed Features
tab, select the licenses you want to return, and then click Return Selected Features.
Is there any way to extend the period of a borrowed license before it

has expired?
No, but you can return a borrowed license before it has expired and then borrow
that license again.
If I want to upgrade licenses with one or more licenses marked for

borrowing, what do I do?
Add two upgrade licenses to the license file. One upgrade license should be
marked as borrowable and the other as non-borrowable. The total number of
licenses between the two upgrade licenses should add up to the number of licenses
you have maintenance cover for. The order of the upgrade licenses in the license
file does not make any difference. For example, if the borrowable upgrade license
comes before the non-borrowable upgrade license, the non-borrowable licenses
will still be used first.
Is there a way to report or show how many licenses are being

borrowed from a server?
It is possible to view the floating license status on the server - from Modeler, on
the Tools menu, click Floating License Server. The dialog shows you the details of
the licenses that are checked out.

Can I borrow a license whilst I have Modeler open?
Yes, but there are a few things to keep in mind. Firstly, to borrow a license you'll
need to have one unused license on the server. Even though this license will not
actually be borrowed, it must be there for the borrow to succeed (the borrowed
license is actually merged with the original checked out license). Secondly,
Modeler will not automatically switch to the borrowed license if it's already open,
so you'll have to close Modeler and reopen it.
Is there a way to terminate a license on an idle workstation?

Yes, by using the TIMEOUTALL option. The TIMEOUTALL option allows the
license administrator to terminate a license that is being used on an idle
workstation.
1. Create a text file named artsansw.opt in the same folder as the
artisan.lic file. (This location can be found in the Options page of the
License Manager.
2. Add the following line to the file and save:
TIMEOUTALL 1800
3. Copy the artisan.lic file to a temporary location.
4. Open the License Manager and click Replace.
5. Navigate to the temporary location, select artisan.lic, click Open and
answer Yes to restart the service.
6. Exit the License Manager.
License Manager
License Manager Overview
For Windchill Modeler, you can maintain your licenses through the License
Manager for both modeler clients and servers.
From a Modeler Client, Use License Manager to Perform the Following

Tasks:
• Choose to use a local Modeler license or a server-based Modeler license:
○ Using a local license file on page 153
○ Using a server-based floating license on page 154.
• Request a permanent Modeler license for the local license. See Creating a
license request on page 152.
• Add or replace the license file. See Replacing a local license file on page 153.

• Borrow a license from a borrowable server-based floating Modeler license.
See the following topics:
○ Borrowing a license from a sever-based floating license on page 154
○ Returning a borrowed license to a sever-based floating license on page 155
• View the local Modeler license.
From a Modeler Server, Use the License Manager to Perform the

Following Tasks:
• Request a permanent or incremental Modeler license for the server-based
floating license. See Creating a license request on page 152.
• Add or Replace the license file. See Replacing a local license file on page 153.
• View the server-based floating Modeler license. See Viewing local license
keys on page 154.
Managing License Settings for Yourself and Setting

Up Default Settings for New Users
When you start License Manager for a Client Only or Standalone installation of
Modeler, you may be prompted to choose between managing License Manager
settings for yourself or setting up default License Manager settings for new users.
This dialog is not shown for Server Only installations of Modeler, and the Manage
Default License Settings for New Users button is available only when you are
logged on to Windows with Administrator Rights.
Click the Manage Default License Settings for New Users button to set up default
License Manager settings for all new of the computer:
• Administrators should click the Manage Default License Settings for New Users
button when they want to set up default License Manager settings for other

users to use: By clicking the Manage Default License Settings for New Users
button, Administrators can set up the default (initial) License Manager options
for new users of a computer or license server.
• When a user opens License Manager the first time, the default settings are
used to populate License Manager Options page, which can then be saved
locally.
Click the Manage License Settings for Yourself button to manage License Manager
settings for yourself:
• When a user first uses Modeler, they must start License Manager to set up
their license options, even if default settings have been set up. After starting
License Manager, each user should click the Options button:
○ If default settings have been set up and those settings are correct for the
user, that user can close License Manager.
○ If default settings have been set up and those settings are not correct for
the user, they can make the necessary changes, save those changes and
close License Manager.
○ If default settings have not been set up, they can specify the license file to
use, save the settings and close License Manager.
• License Manager settings are uniquely saved for each user of the computer.
Starting License Manager

1. Start the License Manager.
• On the Windows Start menu, click All Apps, then click Windchill Modeler,
and then click License Manager.
License Manager.

Windows:
2. If a dialog prompts you to choose between managing License Manager
settings for yourself or setting up default License Manager settings for new
users.

Click Manage Default License Settings for New Users to set up default License
Manager settings for new users of the computer.
Click Manage License Settings for Yourself to manage License Manager
settings for yourself.
Creating a License Request

1. On the computer that is to own the license file, start License Manager. See
Starting License Manager on page 151.
2. Click the Request Wizard button.
If the Request Wizard button is not available:
a. Click Options.
b. Select the option button associated with the Path of the Local License box.
c. Click Save.
d. Click Return to Main.
e. Click Request Wizard.
3. From the Introduction page, click Next.
4. From the Company Details page, type your details and then click Next.
5. From the Feature Details page:
a. Select the check boxes associated with the Modeler licenses you require.
b. If you are requesting Modeler licenses for a Modeler server, set the
quantity value of each selected Modeler license: Click the value, and then
type a new value.
c. Click Next.
6. From the Order Details page, select the country and specify any additional
information, and then click Finish.
7. On the final page of the Request Wizard, click Save As to create a license
request file.
9. From the PTC eSupport Portal, create a new Support Case to request the
required license from PTC. Ensure that you attach the license request file to
the Support Case.
Upon receipt and verification of your request, PTC will send you a permanent
or incremental Modeler license.

Replacing a Local License File
This procedure replaces the local license file you are using with a selected license
file.
To Replace a License Request File:

1. On the computer that is to own the license file, start License Manager. See
Starting License Manager on page 151.
2. If a dialog prompts you to choose between managing license settings for
yourself or managing default license settings for new users, click Manage
License Settings for Yourself.
3. Click Options.
4. If the path shown in the The Path to the Local License box is not as required,
click the associated browse button and select the required folder.
Note that you cannot select a folder that can be subject to virtualization.
5. Click Return to Main.
6. Click Replace.
7. From the dialog, select the license file you want to use, and then click Open.
License Manager copies the selected file to the folder shown in the 'The Path to
the Local License' box.
Using a Local License File

1. Start License Manager. See Starting License Manager on page 151.
3. Click Options.
4. Select the option button associated with the Path of the Local License box.
5. If the path to the local license you want to use is not as required:
a. Click the associated Browse button.
b. Select the required folder.
Note
Note that you cannot select a folder that can be subject to virtualization
6. Click Save.

When you use the Replace button, License Manager copies the license file to the
folder shown in the The Path of the Local License box.
Using a Server-based Floating License

3. Click Options.
4. Select the option button associated with the Name of the License Server box.
5. In the Name of the License Server box, type the name of the Modeler License
Server on which the server-based floating license you want to use resides.
If you want to use more than one Modeler License Server, delimit each server
using a comma.
6. Click Save.
Viewing Local License Keys

3. Click View.
The View License page shows the text of the local license file.
Borrowing a License from a Server-based Floating

License
expire.

The Borrowed Features tab displays information about the license features you
have borrowed.
Returning a Borrowed License to a Server-based

Floating License
3. Click the Borrowed Features tab.
4. Select the check boxes associated with the license features you want to return.
The selected license features are returned to the license server.
License Manager Pages
License manager - main page

The Main page of License Manager has the following controls:
• Options button
Opens the License Options page for you to specify whether Modeler is using a
local license or a server-based floating license.
• Request Wizard button
Opens the Request Wizard pages for you to request a license file for the
computer. For more information, see the following topics:
○ Creating a license request on page 152
○ License manager - request wizard company details page on page 159
○ License manager - request wizard feature details page on page 160
○ License manager - request wizard introduction page on page 158
○ License manager - request wizard order details page on page 161
○ License manager - request wizard request information page on page 161
The Request Wizard button is available only when License Manager is set up
to use a local license.
• Borrow/Return button

Opens the Borrow/Return Features page for you borrow and return license
features from a server-based floating license. See the following topics:
○ Borrowing a license from a server-based floating license on page 155
○ License borrowing - frequently asked questions on page 146
○ License manager - borrow/return features page on page 158
○ Returning a borrowed license to a server-based floating license on page
155
• Replace button
Opens a dialog for you to select a new license file to use. The selected file is
copied to the path specified in the 'The Path to the Local License' box on the
License Options page. See Replacing a local license file on page 153.
• View button
Opens the View License page for you to view the text of a local license. See
License manager - view license page on page 163.
The View button is available only when License Manager is set up to use a
local license.
• Help button
Opens the help topics.

• Exit button
Closes License Manager.
License manager - license options page

The License Options page allows you to specify whether you want to use a local
license or a server-based floating license and manage the borrowing and returning
of Modeler licenses.
For information about using local licenses and server-based floating licenses, see
Local and server-based licensing on page 133.
Using a local license

If you want to use a local license, you must specify the path of the folder in which
the license file resides.
If you use the Replace button to add a license file to your computer, License
Manager saves the license file to the folder specified in the 'The Path to the Local
License' box on the Options page.
To specify the path of the local license:
1. From the Main page, click Options.

2. On the License Options page, select the The Path to the Local License option.
3. Click the associated Browse button.
4. Select the required folder.
5. Click OK.
6. On the License Options page, click Save.
Using a server-based floating license

If you want to use a server-based floating license, you must specify the name of
the license server.
To specify the name of a license server:
1. From the Main page, click Options.
2. On the License Options page, select theName of the License Server option.
3. In the Name of the License Server box, type the name of the License Server.
If you want to use more than one Modeler License Server, delimit each server
using a comma.
4. Click Save.
The License Options page has the following controls:
• The Path to the Local License option
Specifies that Modeler and its add-ins will use a local license.
• The Path to the Local License box
When the The Path to the Local License option is selected, shows the path that
has been set up for the local license file. When active, you can type a path
directly in to this box.
• Browse button
Opens a dialog to select the folder in which the license file resides, or is going
to reside.
Note
• Name of the License Server option
Specifies that Modeler and its add-ins will use a server-based floating license.
• Name of the License Server box

When the 'Name of the License Server' option is selected, shows the name of
the license server. When active, you can type the name of a license server in
this box. If you want to use more than one Modeler License Server, delimit
each server using a comma.
• Help button
Opens the help topic.

• Save button
Saves the options you have set on this page.

The Save button is available only when you have made a change to one of the
following controls: The Path of the Local License option or Name of the
License Server option.
• Cancel button
The Cancel button abandons any changes you have made to the following
controls and returns you to the Main page: The Path of the Local License
option or Name of the License Server option.
The Cancel button is available only when you have made a change to one of
the following controls: The Path of the Local License option or Name of the
License Server option.
• Return to Main button
Opens the Main page of License Manager. See License manager - main page
on page 155.
License manager - request wizard introduction page

The Request Wizard Introduction page introduces the wizard for requesting a
license.
After you have provided the required details, License Manager creates a license
request that can be sent to PTC.
Note
When requesting a license, the license must be for the computer from which
you are creating the request.
Click Next.
The Request Wizard Introduction page has the following controls:
• Next button.

Opens the Request Wizard Company Details page. See License manager -
request wizard company details page on page 159.
• Help button
Opens the topic.

on page 155.
License manager - request wizard company details page

The Request Wizard Company Details page allows you to specify your contact
details, so that PTC can confirm your details and send you a license file.
You must specify your Contact Name and Company Name.
You must specify an Email Address, Fax number or Address.
After you have specified the Modeler licenses you require, click Next.
The Request Wizard Company Details page has the following controls:
• Contact Name box
Specifies your contact name.

• Company Name box
Specifies the name of your company.

• Email box
Specifies your email address.

• Phone box
Specifies your phone number.

• Fax box
Specifies your fax number.

• Address box
Specifies your postal address.

• Previous button
Opens the Request Wizard Introduction page. See License manager - request
wizard introduction page on page 158.
• Next button
Opens the Request Wizard Features Details page. See License manager -
request wizard feature details page on page 160.

• Help button
Opens the topic.

on page 155.
License manager - request wizard feature details page

The Request Wizard Features Details page allows you to specify which Modeler
licenses you require.
To specify that you want a Modeler license: select its associated check box.
To specify that you want more than one license key (server only installation of
Modeler only): after selecting the check box, click the value, and then type the
new value.
After you have specified the Modeler licenses you require, click Next.
The Request Wizard Feature Details page has the following controls:
• Feature Details list
Lists the available Modeler licenses and allows you to specify the Modeler
licenses you require. For server only installations of Modeler you can specify
how many licenses are required for each Modeler license:
○ To request a Modeler license: select its associated check box.
○ To request more than one license for a Modeler license: select its value,
and then type a new value.
• Select All Features check box.
Selects or clears all check boxes in the Features Details list.

• Previous button.
Opens the Request Wizard Company Details page. See License manager -
request wizard company details page on page 159.
• Next button.
Opens the Request Wizard Order Details page. See License manager - request
wizard order details page on page 161.
• Help button
Opens thetopic.
on page 155.

License manager - request wizard order details page
The Request Wizard Order Details page allows you to specify the country in
which you reside and any additional information you want to provide.
The Request Wizard Order Details page has the following controls:
• Order Details/Additional Information box
Specifies any additional information you want to provide to PTC.

• Previous button
Opens the Request Wizard Features Details page. See License manager -
request wizard feature details page on page 160.
• Finish button
Opens the Request Wizard Request Information page. See License manager -
request wizard request information page on page 161.
• Help button

on page 155.
License manager - request wizard request information page

The Request Wizard Request Information page shows the license request details.
Click Save As to create a license request file.
To request a license: From the PTC eSupport portal, create a new Support Case to
request the required license from PTC. Ensure that you attach the license request
file to the Support Case.
The Request Wizard Request Information page has the following controls:
• Text box
Shows the text of the license request.

• Copy button
Copies the text of the license request to the Windows Clipboard.

• Save As button
Opens a dialog for you to save the license request to a text file.
• Print button
Opens the Print dialog for you to send the license request to a printer.
• Help button

on page 155
License manager - borrow/return features page

The Borrow/Return Features page allows you to borrow and return license
features from a server-based floating license.
For information on questions relating to borrowing licenses from a server-based
floating license, see Borrowing a license from a server-based floating license on
page 155
Borrowing a license from a server-based floating license

expire.
Returning a license to a server-based floating license

1. In the Borrowed Features tab, Select the check boxes associated with the
license features you want to return.
The Borrow/Return Features page has the following controls.
• Help button
Opens this help topic.

on page 155
On the Available Features tab:
• Available Features list
Lists the license features that can be borrowed. Select the check boxes
associated with the license features you want to borrow.
• Select All check box
Selects or clears all the check boxes in the Available Features list.
• Date box

• Time box
Sets the time at which the borrowed licenses will expire. To set the time, select
the hour or minute value and then use the up and down arrows to adjust.
Note
The time cannot be set to a time that will result in the license being
borrowed for more than ten days.
• Borrow Selected Features button
Borrows the selected license features that are selected in the Available
Features list.
On the Borrowed Features tab:
• Borrowed Features list
Lists the license features that are borrowed. Select the check boxes associated
with the license features you want to return.
• Select All check box
Selects or clears all the check boxes in the Borrowed Features list.
The Return Selected Features button is available only when one or more
license feature is selected in the Borrowed Features list.
• Return Selected Features button
Returns the license features that are selected in the Borrowed Features list.
The Return Selected Features button is available only when one or more
license feature is selected in the Borrowed Features list.
License manager - view license page

The View License page shows the content of a local license file.
The View Licenser page of License Manager has the following controls:
• Help button
Opens thr help topic.

Opens the Main page of License Manager. For more information, see License
Manager — main page on page 155.

7
Performing an Upgrade
About Upgrades ...................................................................................................... 165
Migrating Data from Enabler to SQL Server ............................................................... 165
Migrating model references from Enabler to SQL Server ............................................ 169
Upgrade from Artisan Studio 6.0 or earlier ................................................................. 170
Upgrade from Integrity Modeler 8.2 or Earlier ............................................................ 170
Upgrade from Integrity Modeler 8.3, 8.4 or 8.5 ........................................................... 171
Upgrade from Integrity Modeler 9.0........................................................................... 172
Upgrade to Windchill Modeler 9.5 ............................................................................. 173
License Upgrade ..................................................................................................... 173
Upgrading State Diagrams from 7.3 or Earlier............................................................ 173
Upgrading Profiles in Models.................................................................................... 173
Upgrading Custom Integrations ................................................................................ 174
Upgrading ACS Models ........................................................................................... 174
Upgrading TDK Models............................................................................................ 174
Upgrading DOORs Sychronizer Mappings from 8.0 or Earlier ..................................... 176
Upgrading Publisher Document Definitions................................................................ 177
Upgrading Custom User Role Definitions .................................................................. 177
Upgrading Web Interface ......................................................................................... 177
Upgrading an instance ............................................................................................. 178
Transferring the Web Interface User Database .......................................................... 179
Maintaining OSLC Settings During an Upgrade ......................................................... 181
Upgrading Asset Library Integration .......................................................................... 181

About Upgrades
When installing a new version of Modeler, you may be required to perform one or
more of the following upgrades.
Note
You may need to clear the browser cache to see new changes after upgrading
any of the following Modeler components:
• Web Interface
• Model Manager
Migrating Data from Enabler to SQL

Server
If you are upgrading from a previous version, you can continue working on your
existing models in Windchill Modeler 9.5.
This topic covers the process of migrating data from a previous version of
Integrity Modeler that uses Enabler to Windchill Modeler 9.3, which uses SQL
Server.
Before starting the migration process, you should run a migration test. Follow the
instructions below and inspect the SQL Server database to confirm that all tables,
data, and relationships have been migrated correctly. If all of your data’s integrity
is maintained, you can proceed with the upgrade to Windchill Modeler 9.5.
Tip
If you are migrating multiple Enabler databases, you can write a batch script to
automate the export and import process. Also, make sure the computer you are
exporting databases from and the one you are importing databases into have
the same locale as the data that you are migrating.
Using DBImport and DBExport

To maintain the diagram look and symbol order (Z-order) of diagrams during
migration, use the DBExport.exe and DBImport.exe commands in place of
EnablerExport.exe and SQLImport.exe.
Before using these new commands, ensure to take a backup of your repository.
Performing an Upgrade 165

Command line usage:
DBExport.exe "\\Enabler\ComputerName\Repository"
"ZipFileName.zip" — to export the database (from Modeler 8.5).
DBImport.exe "ZipFileName.zip" "ComputerName\
{SQLInstance" "ModelName" — to import the database (to Windchill
Modeler 9.5). Ensure that the Model name is the same as the repository name
from the Modeler 8.5 version.
Using the Enabler Export Tool
Note
You can only migrate models from Integrity Modeler 8.3, 8.4 and 8.5. Direct
migration of models from earlier versions of Integrity Modeler is not
supported. To migrate data from previous versions, refer to the instructions in
the following topic: Upgrade from Integrity Modeler 8.2 or Earlier on page
170
Before exporting, you should check your Enabler databases and resolve any
issues with your data. For more information, see “Checking a repository"
under the Enabler Administration chapter of the Integrity Modeler 8.5 online
help.
In addition to model data, the following Enabler database components are also
migrated:
• database, package, and model access permissions.
• Active database users and groups.
The Enabler Export tool, EnablerExport.exe, is included with the Windchill

Modeler 9.3 setup zip file. The tool allows you to export Enabler databases to
zip files. To export an Enabler database:
1. Copy the EnablerExport.exe tool to the Exe folder in your Windchill
Modeler installation directory.
The default path is as follows: C:\Program Files (x86)\Windchill
Modeler\Modeler\Exe
2. Start the Windows Command Prompt window as an administrator.
3. Change the working directory to the Modeler\Exe folder on your system.
4. Run the EnablerExport.exe tool with the following arguments:
• The Enabler database reference: "\\Enabler\<ServerName>\
<database>"

• The full path to the export zip file: "D:\Migration\
EnablerExport\databaseExport.zip"
For example:
EnablerExport.exe "\\Enabler\ServerName\database"
"D:\Migration\EnablerExport\databaseExport.zip"
Using the SQL Server Import Tool
Note
SQL Server logins and database principals are automatically created for users
and groups that are on the Enabler database.
The SQL Server Import tool allows you to import files you created using the
Enabler Export tool into SQL Server. Before you start the import process, copy
the Enabler Export files to your Windchill Modeler machine.
To import an Enabler export into SQL Server:
1. Start the Windows Command Prompt window as an administrator.
2. Change the working directory to the Exe folder in the Windchill Modeler
installation directory.
3. Run the SQLImport.exe application with the following arguments:
• The full path to the Enabler Export zip file: "D:\Migration\
EnablerExport\databaseExport.zip"
• The name of your machine followed by the SQL Server instance name:
"<Machine-Name>\<SQL-Instance>"
• A specific name for the SQL Server database: "<Database-Name>".
Use alphanumeric characters. The database name cannot contain spaces or
be more than 123 characters long.
• If you are importing Japanese or Chinese data, you must use the -R
argument.
Optional arguments:
• The import batch size parameter: set to 1000 rows by default.
• The bcp.exe path.
You can use the following combinations:
• SQLImport <mandatory arguments>
• SQLImport <mandatory arguments> -R

• SQLImport <mandatory arguments> <batch size>
• SQLImport <mandatory arguments> <batch size> -R
• SQLImport <mandatory arguments> <batch size> <bcp path>
• SQLImport <mandatory arguments> <batch size> <bcp path> -R
Note
<Mandatory arguments> = <EnablerExport zip file> <machine\instance>
<database name>
For example (SQL-Instance is by default Modeler):

SQLImport.exe "D:\Migration\EnablerExport\
databaseExport.zip" "MYSERVER\MODELER" "oldexamples"
The following example applies to Chinese and Japanese data:
SQLImport.exe "D:\Migration\EnablerExport\
databaseExport.zip" "MYSERVER\MODELER" "oldexamples"
-R
4. In Model Explorer, right-click on the database that you just imported, and
click Show All Database. The imported database now appears.
Confirm that the Import End Successfully message appears in the
<DBName_timestamp>.log file.
The SQL Import tool generates log files that are stored in the %temp% directory:
• <DBName_timestamp>.log—Contains logs for the SQL Import tool.
The file shows an "Import End Successfully" message if the import
process is successful.
• <SQLAdmin_timestamp>.txt—Contains log data for the database
creation.
• The SQL Server bulk copy program utility (bcp) errors are logged to the
following files:
○ BoolErrors.Log
○ DBPermErrors.Log
○ ObjectPermErrors.Log
○ ShortErrors.Log
○ TimeErrors.Log
○ LongErrors.Log

○ SysRelErrors.Log
○ StringErrors.Log
○ ConfigErrors.Log
○ RelationshipErrors.Log
○ VersionErrors.Log
○ ObjectErrors.Log
Migrating model references from Enabler

to SQL Server
You can retain old model references such as bookmarks and OSLC links. Use the
Mappings.ini file to map model references from an Enabler database to a
SQL Server database.
To map old model references, perform the following:
For a Standalone installation

1. Create a Mappings.ini file in the ModelerATFiles folder. The folder
resides in following location:
C:\ProgramData\PTC Integrity Modeler\ModelerATFiles
2. For each database, create a mapping entry using the following format:
[MAPPINGS]
<old-server>\<old-repository>=<new-instance>\<new-database>
<old-server>\<old-repository2>=<new-instance>\<new-database2>
• <old-server>— specifies the name of the old Enabler server.

• <old-repository>— specifies the name of the old repository.
• <new-instance>— specifies the name of the new SQL Server instance in
the following format: <machine-name>@<instance-name>
• <new-database>— specifies the name of the new database.
For a Client/Server installation

1. On the Integrity Modeler server, create the Mappings.ini file in the
ModelerATF share folder.
2. Create a mapping entry for each database reference using the same format as a
Standalone installation.
Enabling mapping logs

You can enable logs for reference mapping. To enable logs, do the following:

1. Start the Registry Editor.
2. In the left pane, expand HKEY_CURRENT_USER ▶ Software ▶ ARTiSAN
Software Tools ▶ SFC2.
3. Under the SCF2 subkey, create a DWORD (32-bit) value with the name
LogMappings and set it to a number other than 0.
The mappings are logged to the ModelerMappings.log file in the Windows
temporary folder: %temp%.
Upgrade from Artisan Studio 6.0 or earlier

An upgrade from Artisan Studio 6.0 or earlier, directly to Windchill Modeler 9.5
is not supported.
To upgrade to Windchill Modeler 9.5, do the following:
1. Upgrade to Artisan Studio 6.1 following instructions in the 6.1 Release Notes.
2. Upgrade to Integrity Modeler 8.5, or uninstall the old version, then install
Integrity Modeler 8.5.
For more information, see the instructions in the following topic: Upgrade
from Integrity Modeler 8.2 or Earlier on page 170.
Upgrade from Integrity Modeler 8.2 or

Earlier
Upgrade from Integrity Modeler 8.2 or earlier
A direct upgrade from Integrity Modeler 8.2 or earlier is not supported. To
upgrade to Windchill Modeler 9.5, follow these steps:
1. If you are running an earlier version, upgrade to Integrity Model 8.5, 8.4, or
8.3:
a. Backup datastores using the Save command in the Database Administrator.
b. Backup any customizations (including Publisher templates, DOORs or
ILM synchronizer mappings, custom Reviews in Reviewer, custom
Profiles, etc.)
c. If you previously separately installed Reviewer for use by 'Just me' (by
choosing this option in the install wizard), or you do not know which
option was chosen, uninstall Reviewer before upgrading.
d. For client/server installations, upgrade the server(s) first and then all the
clients. A datastore may not be accessed by clients on different version of
Artisan Studio or Integrity Modeler.

e. Install directly over your previous version by running
IntegrityModeler8_5Setup.exe. Do not manually uninstall the
older version first, it will be uninstalled during the upgrade process. This
will ensure that all settings are retained after the upgrade and access rights
(including Administration) to your existing datastores are retained. If you
do uninstall and then reinstall you may not have rights to your existing
datastores.
f. On the Custom Setup page of the Installation, ensure that all the
components you would like installed after the upgrade are selected to be
installed.
g. If you upgraded a server-only install from 6.1 , and had made manual
changes to the WinPasswd and WinGroup files, these need to be migrated
as follows:
i. Open a command prompt and type the following command (substitute
paths as necessary if you have not used the install defaults):
c:
cd\Enabler\Server\Param
copy WinPasswd.bak WinPasswd
copy winGroup.bak WinGroup
ren users users.bak
ren groups goups.bak
cd..\bin
omsdiag migrateWinPasswd
h. Reboot computer.
2. Upgrade to Windchill Modeler 9.5. For more information, see Upgrade from
Integrity Modeler 8.3 or Later on page 171.
Upgrade from Integrity Modeler 8.3, 8.4 or

8.5
Note
You can perform a direct upgrade from Integrity Modeler 8.3 or later.
To migrate archived model export data after you upgrade to Windchill
Modeler 9.5, you should consider maintaining an Integrity Modeler 8.3, 8.4 or
8.5 installation.
To upgrade to Windchill Modeler 9.5, follow the instructions for each installation
type below.

For Server Only and Client Only installations:
1. Stop clients from connecting to the server by closing all firewall ports.
2. Use the Enabler Export tool to export repositories that you want to migrate.
For more information, see Migrating Data from Enabler to SQL Server on
page 165.
3. Install an Windchill Modeler 9.5 Server Only installation on a new server
machine.
4. Use the SQL Server Import tool to import Enabler export files that you created
in step 2.
page 165.
5. Install an Windchill Modeler 9.5 Client on a client machine, and point to the
new server.
6. Run Integrity Modeler, and confirm that models can be opened and have been
migrated correctly.
7. Install Windchill Modeler 9.5 clients on remaining client machines, pointing
to the new server.
For a Standalone installation:
1. Use the Enabler Export tool to export repositories that you want to migrate.
page 165.
2. Install the Windchill Modeler 9.5 Standalone.
3. Use the SQL Server Import tool to import Enabler Export files that you
created in step 1.
page 165.
4. Run Integrity Modeler, and confirm that models can be opened and have been
migrated correctly.
Upgrade from Integrity Modeler 9.0

If you are upgrading from Integrity Modeler 9.0, you must upgrade your databases
either from Model Explorer or from Model Manager.
To upgrade a database, right-click on the database that requires an upgrade and
click Upgrade.

Upgrade to Windchill Modeler 9.5
If you are upgrading to Windchill Modeler 9.5 and you are not using a supported
version of SQL Server, you must follow the instructions listed in the topic in the
Modeler help center.
License Upgrade
Your Integrity Modeler 9.2 license works on Windchill Modeler 9.5. You do not
have to acquire a new license for Windchill Modeler 9.5.
For information on getting a new license for Windchill Modeler 9.5, refer to
Licensing Modeler on page 133.
Upgrading State Diagrams from 7.3 or

Earlier
Due to the introduction of a State Machine object, when a State Diagram created
before 7.3 is first opened in 7.4 or later, an upgrade warning will be shown. You
may update just this State Diagram, or all State Diagrams in the model. A
command line tool is also provided to automate the process if necessary:
SMUpgrade.exe <Model Ref>
where ModelRef is the reference (in double-quotes if it contains spaces) to the
model to be upgraded.
Upgrading Profiles in Models

If you have used any profiles supplied with Integrity Modeler (such as UPDM,
SysML, UML, Ada, C++, ACS) in a model, you must upgrade them after
installing Windchill Modeler 9.5.
If you have added your own objects (including Stereotypes or Tag Definitions) to
a supplied profile, they will be deleted when you update the profile. To save these
objects, you must move them to a different package before updating the profile.
Open the model then right-click any PTC supplied profile package and select
Tools ▶ Update All Profiles from the menu. You can also select the profile, and on
the Manage tab, click Update All profiles.

If you are upgrading from 7.0 or earlier, the Upgrade All Profiles... command may
not be shown when you right-click the profile. Go to the Access Permissions tab
of the profile package and deselect the Protected check box, then on the Options
tab, select the Profile Package check box, then try again.

If you have defined lightweight extensions of supplied profiles, you must set the
Profile Package flag on the package which contains them and apply the
<<LightWeightProfile>> stereotype to the package. The LightweightProfile
Stereotype should only be applied to the outermost Profile Package - not any child
packages.
After the profiles are upgraded, close Modeler before editing the model or
opening another model to be upgraded.
Upgrading Custom Integrations

If you have used 'ARTiSAN.Interop.ENTLib6.dll' to call the Modeler
Automation interface from .Net code, your custom application will need to be
rebuilt to use the new interop.
Upgrading ACS Models

Before upgrading a model used for code generation with ACS, ensure that no
important data is held in the ACS cache (on client machines) by starting ACS and
then clicking the Show Protected Properties button on the ACS/TDK Control
tab. If this reports anything, you should reverse these into the model before
upgrading.
If you upgrade from 7.1, note that some of the C++ code generators were renamed
and merged so after upgrading you may receive an error like these:
"DLL not found Error"
'C:\Program Files\Artisan Software Tools\Artisan Real-time
Studio\ItsShadow\Exe\Cpp Win32 Animation EXE.dll' does not
exist or is not readable' error.
In these cases, you should choose the appropriate new generation scheme from the
ACS Launcher instead, e.g. if you were using the Cpp Win32 Animation EXE
scheme in 7.1 then you should now use the Cpp Win32 Animation scheme
instead.
Upgrading TDK Models

Any customized ACS generators should be regenerated and rebuilt with Windchill
Modeler 9.5 if they have not already been rebuilt with 8.0b or later.
If the TDK model is being upgraded from 7.3 or earlier, open the model and
upgrade the TDK Framework. The TDK can then be launched from the ACS/TDK
Control tab. Choose a clean target directory to build a new generator DLL for use
with ACS.

When upgrading from 7.2 or earlier, other manual changes may also be needed:
for C
1. In the sdl, replace all instances of MakeTypeDef with MakeTypedef.
2. For TheGenerator::Generator::Model2Text::GeneratorRoot, clear the EndText
and EndExecOrderClass tags on the GenClass property tab.
3. Comment out TheGenerator::TDK Generator Framework::Reversers::
TGuardTag.PostInstanceText value.
4. Add a class called TheGenerator::Generator::Reversers::TCGuardTag. This
class should be:
a. a subclass of TheGenerator::TDK Generator Framework::Reversers::
TGuardTag and
b. stereotyped as GenClass with the following non-default tag values:
ExplicitAllocator=TRUE, ExplicitInstance=CGuardTag,
PostInstanceText=%tagdef CGuardTag
5. Copy TheGenerator::Generator::Reversers::TCActionTag.GetModelValue to
TheGenerator::Generator::Reversers::TCGuardTag.
for C++
1. Add a Refine function to TheGenerator::Generator::Model2Model::SMG::
ZCSMGEnum.
Set the function body to:
Self.DefaultRefine()
Self->"Dependency Start" = %null
2. Comment out TheGenerator::TDK Generator
Framework::Reversers::TGuardTag.PostInstanceText value.
3. Add a class called TheGenerator::Generator::Reversers::TCppGuardTag. This
class should be:
a. a subclass of TheGenerator::TDK Generator Framework::Reversers::
TGuardTag
b. stereotyped as GenClass with the following non-default tag values:
ExplicitAllocator=TRUE, ExplicitInstance=CppGuardTag,
PostInstanceText=%tagdef CppGuardTag
4. Copy TheGenerator::Generator::Reversers::TCppActionTag.GetModelValue
to TheGenerator::Generator::Reversers::TCppGuardTag.
You may use the Synchronizer Scheme Importer for migrating customized OCS
generators to ACS/TDK.

Upgrading DOORs Sychronizer Mappings
from 8.0 or Earlier
No migration will be required for the DOORs Synchronizer when upgrading from
8.1 or later. If upgrading from an earlier version, ensure you have a backup of any
synchronized DOORs modules and Integrity Modeler models before first
synchronizing with 9.3. You may also want to baseline your DOORs module and
version your model so make it easy to review any changes made by the DOORs
Synchronizer.
Mappings for the DOORs Synchronizer can be upgraded from Artisan Studio 7.3
or later, but if you have not already upgraded to 8.0, manual changes may be
required, as follows:
• DOORs Synchronizer Requirements mappings now include Actors, Use Case
Diagrams and Requirement Diagrams. If your mapping is bi-directional or
Studio to DOORs, these objects will automatically be added to your DOORs
module when resynchronized. If your mapping is DOORs to Studio, these
items will be deleted from (or marked as deleted in) your model. To avoid
them being deleted from your model, you can enable the new "Keep
unsynchronized items" option.
• On the Types To Synchronize page, if your model uses any Stereotypes which
'Override Type Name' and 'Apply to All Objects of Associated Model Item
Types', then these Stereotypes may not be selected. Either disable the
'Override Type Name' option on the Stereotypes, or select them here if you
want to continue synchronizing their stereotyped items with DOORs,
otherwise these will be deleted from DOORs. In the latter case, when
resynchronized, the stereotyped items will appear under their own heading if
using the Group By Type option.
• Check that other types are still selected correctly in the mapping.
• Click Next >. On the Property Mapping page, scroll down to any selected
properties and ensure that the types they should apply to are selected.
• Click Next >. Under Association Types, scroll down to any selected
Associations and check that the types they should apply to are selected.
• Artisan Studio 8.0 (or later) allows synchronization of objects to/from multiple
models with one DOORs module. Before using this feature, the existing
mapping must be resynchronized to upgrade the original DOORs module.
• When using a 'Group By Type' Surrogate module mapping, if an error is
logged that 'One or more DOORS objects were found with duplicate Studio
IDs' this may relate to Stereotypes synchronized as both headings and as
objects under a 'Stereotype' heading. To resolve this, delete the problem

objects under the 'Stereotype' heading from your DOORs module and
resynchronize.
• After the upgrade, RTF properties (such as Operation Bodies) may cause a
difference to be reported when first synchronized. If so, choose to keep the
Studio values and continue with the synchronization.
The way diagram images are exported to DOORs has changed which may affect
links to or from any diagram objects in DOORs. Please see Help topic: "Updating
DOORS modules created through Artisan DOORS synchronizer 7.4 or earlier
(DOORS synchronizer)" for further details.
Upgrading Publisher Document

Definitions
Publisher documents and templates will automatically upgrade from 7.3 or later.
However, due to metamodel changes (in 7.4, to Class, Signal, Interface, Datatype,
State Machine, and Dependency) and profile changes (in 8.0, for example,
renaming stereotypes in the SysML, and in 8.1, changes to UPDM and MARTE
profiles), some manual updates to the document definition may be needed to
extract the required content in 9.0.
After upgrade to 9.3, any custom styles created in previous versions may be
recovered from C:\ProgramData\PTC Integrity Modeler\
Publisher\Stylesheets\DocumentGeneration\CustomDocBook.
Upgrading Custom User Role Definitions

Integrity Modeler 9.0 includes new User Role definitions. Any custom User Roles
created in previous versions may be recovered from C:\ProgramData\PTC
Integrity Modeler\Install\Upgrade\Modeler\UserRoles.
Upgrading Web Interface

To upgrade the Web Interface from 8.3, login as PTC-IM-WSU and either:
• note the repositories which are bookmarked in Model Explorer or
• run regedit and export the key HKEY_CURRENT_USER\Software\
Artisan Software Tools\ESsG10\Mappings to a file saved outside
this user's profile folders (e.g. C:\programdata\ptcbookmarks.reg)

To upgrade the Web Interface from any previous version, you must select the Web
Interface component when installing 9.3. During the upgrade process, a number of
configuration files will be removed and re-created. You will be prompted for a
password for the PTC-IM-WSU account and should enter your own previous
password.
The following files can be found in C:\ProgramData\PTC Integrity
Modeler\Install\Upgrade\WebInterface:
• web.config - any custom entries (such as SiteAdminAccoutName,
DisableCreatedUser, PTC_ADMembershipConnection and Contact details)
must be individually copied into the new web.config file which has been
installed in C:\inetpub\wwwroot\PTC Integrity Modeler Web
Interface. Further details on how to configure these settings may be found
in the Help.
If you are upgrading from 8.3, Login as PTC-IM-WSU and either:
• bookmark the repositories in Model Explorer which are bookmarked in 8.3 or
• run regedit and import the file you saved above (e.g. C:\programdata
\ptcbookmarks.reg) to restore the key HKEY_CURRENT_USER\Software\
Artisan Software Tools\ESsG10\Mappings
Use IIS Manager to restart the PTC Integrity Model Web Interface website and
Application Pool.
Note
After performing an upgrade, you may need to clear your browser cache to see
the new changes to Web Interface.
Upgrading an instance
In Model Explorer, if your server or instance needs an upgrade, an indication is
displayed in the bottom pane.
To upgrade an instance, you need to execute the adminscript_master.sql
on the master database using SQL Server Management Studio:
1. On the computer running the SQL Server instance, start SQL Server
Managment Studio.
2. Connect to the SQL Server instance.
3. Click File, point to Open, then click File...
4. In the Open File dialog box, select the adminscript_master.sql script, then
click Open.

The full path to the script is C:\Program Files (x86)\Windchill
Modeler\Modeler\System\SQLScripts\adminscript_
master.sql
5. With the script open, select the master database from the drop-down list in the
SQL Editor toolbar, then click Execute.
6. Confirm that the Query executed successfully message appears.
Transferring the Web Interface User

Database
If you are installing Windchill Modeler 9.5 on a new machine, you can transfer
the StudioRestService database, which stores Web Interface user login
information. Before you install Windchill Modeler 9.5, make sure to copy the
StudioRestService.mdf and StudioRestService.ldf files for the
database that contains your Web Interface users.
To transfer a Web Interface user database to Windchill Modeler 9.5, do the
following:
1. Start SQL Server Management Studio and connect to the SQL Server instance.
2. In the left pane, expand the list of databases.
3. Right-click on the StudioRestService database, and then click Delete ▶ OK.
4. Using Windows File Explorer, copy the StudioRestService.mdf and
StudioRestService.ldf files into the following folder:
App_Data
This retains the correct access permissions. For a default Modeler install with
SQL Server, access is granted to MSSQL$MODELER:

5. In SQL Server Management Studio, click New Query on the toolbar, and then
perform the following tasks:
a. Attach the new StudioRESTService database files by executing the
following query:
USE Master
GO
EXEC sp_attach_db @dbname = N'StudioRESTService',
@filename1 =
N'C:\inetpub\wwwroot\PTC Integrity Modeler Web Interface\App_Data
\StudioRESTService.mdf',
@filename2 =
N'C:\inetpub\wwwroot\PTC Integrity Modeler Web Interface\App_Data
\StudioRESTService_log.ldf';
GO
b. Clear the query window, then copy and execute the following script to
grant the PTC-IM-WSU user account access to the database:
DECLARE @User nvarchar(50)

DECLARE @Command VARCHAR(1000)
SELECT @User = CONVERT(nvarchar(50),SERVERPROPERTY('MACHINENAME'))
SET @User = @User + '\PTC-IM-WSU'
SET @Command = 'USE [StudioRESTService] CREATE USER ['+@User+']
FOR LOGIN ['+@User+'] WITH DEFAULT_SCHEMA=[db_owner]
ALTER ROLE [db_owner] ADD MEMBER ['+@User+']'
EXECUTE (@Command)
GO
6. Close SQL Server Management Studio.
Maintaining OSLC Settings During an

Upgrade
When performing a standalone or server installation of Windchill Modeler 9.5, all
existing OSLC settings will be backed up and placed in the %programdata%\
PTC Integrity Modeler\Install\Upgrade\WebInterface folder.
The path to the installed files is C:\inetpub\wwwroot\PTC Integrity
Modeler Web Interface\App_Data folder.
• OSLCControl.xml
• OSLCMappings.xml
Also, the following files are backed up and placed in the C:\ProgramData\
PTC Integrity Modeler\Install\Upgrade\ATFiles folder:
• TraceLinks.xml
• VariantSelectorControl.xml
Upgrading Asset Library Integration

If you use Asset Library with Modeler, you will need to uninstall and reinstall the
Asset Library Bridge after installing 9.3.

8
Setting up a Backup Procedure
Setting up a Backup Procedure ................................................................................ 183

Setting up a Backup Procedure
This topic contains the following sections:
• Backing up a running database
• Backing up a model
The following table outlines the steps to be taken to set up a back up procedure for
database information.
Step Consideration
1. Talk to the network administrator You need to determine the following
responsible for file backups. from the network administrator:
• At what time the backups are
created.
• Disk locations that are backed up.
During installation, you can specify
a folder for backups. By default,
this folder is on the same disk, but
you should consider saving backups
to a different disk. You can override
the default backup location when
back up procedure is performed.
2. Set up a batch file or use SQL Server For more information, see the following
to automatically back up your database. sections.
3. Confirm that the backups are It is important to verify your back up
working. procedure by restoring a database. This
ensures that your procedure is working
when you come to use it in the future.
4. Periodically audit backups to ensure • When performing the back up you
they are still working. can log the output to a file. You
should periodically check the log
for any errors.
• Periodically, repeat step 3 to ensure
the full back up procedure is still
working.
Backing up a Running Database

We strongly recommend that you create regular backups of your databases. You
can create backups of running databases using Model Explorer, ScfUtils, or SQL
Server Agent. Backups must be performed on the SQL Server machine. You can
truncate logs when a backup is done to recover disk space.
For more information, refer to the SQL Server help topic:
Setting up a Backup Procedure 183

Backup Overview
https://docs.microsoft.com/sql/relational-databases/backup-restore/backup-
overview-sql-server?view=sql-server-2017
Backing up a Model
You can use the export facility in Model Explorer to manually back up a model.
For information about exporting and importing models, see the Model Explorer
Help.

9
Setting up Applications to Work
with Modeler
Setting up Applications to Work with Modeler............................................................. 186
Setting up IBM Rational DOORS .............................................................................. 186
Setting up IBM Rational Rose................................................................................... 188
Setting up Microsoft Visual SourceSafe..................................................................... 188
Setting up IBM Rational ClearCase........................................................................... 189
Setting up PTC Integrity Lifecycle Manager ............................................................... 189
Setting up Serena Dimensions ................................................................................. 192
Setting up Serena Version Manager.......................................................................... 194
Setting up Telelogic SYNERGY/CM .......................................................................... 194
185
Setting up Applications to Work with
Modeler
Modeler can work with the following applications.
Configuration Management Tools:

• IBM Rational® ClearCase® - DEPRECATED
• Microsoft® Visual SourceSafe® - DEPRECATED
• Serena® Dimensions® - DEPRECATED
• Serena® Version Manager® - DEPRECATED
• Telelogic SYNERGY/CM - DEPRECATED
Requirement Management Tools:

• IBM Rational® DOORS®
• PTC Integrity Lifecycle Manager
Modeling Tools:
• IBM Rational® Rose®
For information about the preceding application versions that are supported, see
the Modeler Release Notes.
For information about setting up the preceding applications to work with Modeler,
see the following topics:
• Setting up IBM Rational ClearCase on page 189
• Setting up IBM Rational DOORS on page 186
• Setting up IBM Rational Rose on page 188
• Setting up Microsoft Visual SourceSafe on page 188
• Setting up PTC Integrity Lifecycle Manager on page 189
• Setting up Serena Dimensions on page 192
• Setting up Serena Version Manager on page 194
• Setting up Telelogic SYNERGY/CM on page 194
Setting up IBM Rational DOORS

Integration for IBM Rational DOORS integrates the local and client applications
of Modeler and DOORS, that is:
• Standalone and Client Only installations of Modeler.

• Complete Server, Standard Client and Workstation Client installations of
DOORS.
If you are installing Integration for IBM Rational DOORS on to a DOORS
Workstation Client computer, you may require read/write access to the DOORS
Server computer, on which the program files reside.
Note
In DOORS, a Workstation Client installation does not install the program files
on the computer.
For information about working with Integration for IBM Rational DOORS, open
the Modeler Help, expand the Product Integrations book, and then see the topics
in the Integration for IBM Rational DOORS book. Note that the Integration for
IBM Rational DOORS help topics are installed only when the Integration for IBM
Rational DOORS is installed.
Installation Scenarios
If you install or upgrade DOORS after installing Modeler, Integration for IBM
Rational DOORS will not work:
• If DOORS is installed and has been run and you are installing or upgrading
Modeler, install Modeler and Integration for IBM Rational DOORS.
• If you install DOORS after installing Modeler, you must reinstall Integration
for IBM Rational DOORS through the Modeler installation program.
• If you upgrade DOORS, you must reinstall Integration for IBM Rational
DOORS through the Modeler installation program.
Installing on DOORS Client Workstation Computers

A DOORS Workstation Client uses program files that reside on a remote DOORS
Server computer. In this environment, the Integration for IBM Rational DOORS
program files need to be set up only on the DOORS Server. When you install
Integration for IBM Rational DOORS on to a DOORS Workstation Client, the
installation program may need to set up the program files on the DOORS Server:
• If Integration for IBM Rational DOORS program files have been previously
set up on the DOORS Server, the installation program makes no changes to
the DOORS Server.
• If Integration for IBM Rational DOORS program files have not been
previously set up on the DOORS Server, the installation program sets up the
program files on the DOORS Server. To achieve this, the installation program
requires write access to the DOORS Server.
Setting up Applications to Work with Modeler 187

If you upgrade DOORS, you must reinstall Integration for IBM Rational DOORS.
Setting up IBM Rational Rose

There are no special considerations when working with Rational Rose.
For information about working with Connector for IBM Rational Rose, open the
Modeler Help, and then see the topics in the Product Integrations > Connector for
IBM Rational Rose book.
Setting up Microsoft Visual SourceSafe
Note
CM tool integration support for Microsoft Visual SourceSafe is being
deprecated.
We recommend that all Visual SourceSafe users use a shared srcsafe.ini file,
which is the default for a client/server installation of Visual SourceSafe.
If users do not use a shared srcsafe.ini file and those users have different
drive mappings for the Visual SourceSafe database the following problem can
occur; if a user checks in a Package and another user with a different drive
mapping views that Package, the Package icon will not have a check mark or
cross and the Check In command will not be available. To overcome this problem,
the user will have to reconnect the Package using locally stored paths.
If you check out a Package, rename that Package in Modeler, and then check in
that Package, the file name of the Package in the CM tool environment will reflect
the new name of the Package, not the old name.
If you are working with Microsoft Visual SourceSafe version 6.0d, you must
install a Microsoft patch to work with the Modeler CM Tool integration. For more
information, click here to open the KB article 821419 on the Microsoft website.
For generic information about the configuration management tool integration, see
the topics in the 'Model, component and package management (includes access
permissions) > Configuration management tool integration' section of the Modeler
Help.

Setting up IBM Rational ClearCase
Note
CM tool integration support for IBM Rational ClearCase is being deprecated.
To check in a model the first time you must:

• Create a subfolder of the vob, in which to store the model. You must set this
up manually, because the check in operation cannot create a subfolder of a
vob.
• Using ClearCase, check in the subfolder you created. Important: Ensure that
you leave the subfolder of the vob checked out, else each check in and check
out operations performed on Packages will have to also check in and check out
the subfolder.
• Using Modeler, check in the model to the subfolder you created, ensuring that
you select the subfolder through its UNC path, that is, through your network
neighborhood.
• If you are using ClearCase MultiSite, you must select the 'When creating an
element in a replicated VOB, make current replica the master of all newly
created braches' option in ClearCase.
For procedural information about working with ClearCase and checking in a
Model for the first time, open the Modeler Help, expand the 'Database, model,
component and package management (includes access permissions)' section,
expand the 'Configuration management tool integration' section, and then see the
topics in the 'IBM Rational ClearCase integration' section.
the topics in the ‘Database, model, component and package management (includes
access permissions) > Configuration management tool integration' section of the
Modeler Help.
Setting up PTC Integrity Lifecycle

Manager
Integration for PTC Integrity Lifecycle Manager integrates Modeler with PTC
Integrity Lifecycle Manager.
Before you can use Integration for PTC Integrity Lifecycle Manager, consider the
following:

• Integrity Lifecycle Manager Client (version 10.5 or higher) must be installed
on the same computer as Modeler.
Note
The synchronizer tool currently does not work with multiple installations
of Integrity Lifecycle Manager on a single computer.
• The Integrity Lifecycle Manager Client and its Integrity Lifecycle Manager
Server must both be the same version.
• In the target Integrity Lifecycle Manager system, a user account must be
created that has access permissions to modify data. This account will be used
when Integration for PTC Integrity Lifecycle Manager accesses and modifies
data in Integrity Lifecycle Manager.
Note
To create or synchronize mappings, the user account must have the
ViewAdmin access permission set in Integrity Lifecycle Manager.
• Microsoft Office must be installed to synchronize Word, Excel and

PowerPoint files that are embedded as OLE objects in rich text properties. For
more information see the Property mappings page (Integration for PTC
Integrity Lifecycle Manager) topic in the Modeler Help.
Important information for ESET Endpoint Antivirus users:
• The standard configuration of ESET Endpoint Antivirus prevents PTC
Synchronizer Administration Tool from starting.
• To resolve this problem, set up ESET Endpoint Antivirus to exclude the
loopback IP address (127.0.0.1) from protocol filtering.
• This problem may affect users of other anti-virus software as well.
Configuring Document Types to Work with Integration for Lifecycle

Manager
Before Integration for Lifecycle Manager can work with a PTC Integrity Lifecycle
Manager Document, the Document Type of that Document must be configured to
work with Integration for Lifecycle Manager.
The PTC Synchronizer Administration Tool sets up the required fields in a
Document Type.

Note
The PTC Synchronizer Administration Tool is not installed by default as part
of a Client Only, Server Only or Standalone installation of Windchill Modeler.
It is installed only when the Integrity Lifecycle Manager Integration Admin
feature is selected for installation on the Custom Setup page of the Windchill
Modeler installation program.
To Configure Document Types to Work with Integration for Lifecycle

Manager:
1. Ensure that you have administrator rights to the database in which the
Document Type you want to configure resides.
2. Start the PTC Synchronizer Administration Tool.
From Windows Explorer, double-click the
SynchronizerAdminTool.exe file that resides in the Modeler Exe
folder. If you have installed Modeler to the default location, the path of the
Exe folder is as follows:
C:\Program Files (x86)\Windchill Modeler\Modeler\Exe
C:\Program Files\Windchill Modeler\Modeler\Exe
3. If you are prompted to select a server connection, log on to the PTC Integrity
Lifecycle Manager database.
4. From the PTC Synchronizer Administration Tool, select the check boxes
associated with the Document Types you want to configure to work with
Integration for Lifecycle Manager.
Note
Document Types shown in blue text have previously been configured.
Leaving the check boxes associated with these Document Types selected
will ensure that they are updated with any required changes.
5. Click Execute.
6. After the selected Document Types have been configured (log states 'The
process has completed.'), review the log for any errors or warnings.

Setting up Serena Dimensions
Note
CM tool integration support for Serena Dimensions is being deprecated.
the topics in the 'Database, model, component and package management (includes
Modeler Help.
Serena Dimension clients must have the optional SCC Integration component
installed.
Through Dimensions Administration Console you must set up the Dimensions
server to work with Modeler.
Before checking in a Model the first time, you must set up the Dimensions server
to work with Modeler, and then create a Dimensions Project, Workspace and Part
in which to store the Model.
If the check in or check out commands are not available Modeler, it may be
because the lifecycle status of the associated items in Dimensions is preventing
them from being checked in or checked out.
To Set up a Serena Dimensions Version 10.1 Server to Work with

Modeler:
1. Start the Serena Dimensions Administration Console.
2. Login to the Server you want to set up.
3. Set up Modeler as an IDE project:
a. From the Administration Console, in the Product Administration group,
click Valid Set Definitions.
b. If the current product is not GENERIC, change the current product to
GENERIC through the Switch Current Product button.
c. In the left pane, select IDE_PROJECTS.
d. In the right pane, click the Edit Valid Set button in the Values table.
e. Insert a new row and in Column 1, type Windchill Modeler - ensure
that you match the case shown, because this is case sensitive.
f. In Column 2, type rts.
g. Click OK.
4. Click Home.

5. Set up upload rules for the Windchill Modeler object:
a. In the Configuration Object Management group, click Upload Rules.
b. In the left pane, expand Windchill Modeler, and then click Default Project.
c. In the right pane, click the New Object button in the Include table.
d. In the File Name Pattern Match box, type PTC.
e. In the Data Format box, type DOC.
f. In the Item Type box, select DOC.
Note
Steps d. to f. set up the Windchill Modeler IDE to check in all Modeler
files using the DOC item type. If you choose to check in Modeler files
using a different Dimensions item type, ensure that the Modeler MDF
and PKF files are checked in as binary files
g. Click OK.
6. Click Home.
7. In the Configuration Object Management group, click Data Format & MIME
Types.
8. Set up the IDF file format type:
a. Click the New button.
b. In the File Format box, type IDF.
c. In the Class list, select ASCII.
d. In the MIME Type box, type application/octet-stream.
e. In the Description box, type Windchill Modeler package id file.
f. Click OK.
9. Set up the PKF file format type:
b. In the File Format box, type PKF.
c. In the Class list, select BINARY.
e. In the Description box, type Windchill Modeler package archive
file.
f. Click OK.
10. Set up the MDF file format type:

b. In the File Format box, type MDF.
c. In the Class list, select BINARY.
e. In the Description box, type Windchill Modeler model archive
file.
f. In the Description box, type Windchill Modeler model archive
file.
11. Click Logout.
Setting up Serena Version Manager
Note
CM tool integration support for Serena Version Manager is being deprecated.
When installing Version Manager clients, we recommend that each client uses the
same drive and path mapping for Version Manager. Failure to do so will not
prevent Version Manager from working correctly, but it can result in the following
problem; if a user checks in a Package and another user with a different drive
mapping views that Package, the Package icon will not have a check mark or
cross and the Check In command will not be available. To overcome this problem,
the user will have to reconnect the Package using locally stored paths.
Modeler Help.
Setting up Telelogic SYNERGY/CM
Note
CM tool integration support for Telelogic SYNERGY/CM is being deprecated.
A standard installation of SYNERGY/CM will not work with Modeler, because it

will not have the Telelogic SCCI integration software installed. The SCCI
integration software is installed through an integration patch that is available on
the Telelogic website. If the Telelogic integration patch installation does not set up

the required PATH environment variable, ensure that you set it up manually. If the
PATH environmental variable is not set up correctly, the CM Tool integration will
not work.
Ensure that SYNERGY/CM is licensed for use. When using the CM tool
integration with an unlicensed copy of SYNERGY/CM, the error messages are
unpredictable and misleading.
The CM tool integration works only if you set up the SYNERGY/CM database,
project and directory object to work with Modeler:
• Database- You must create two types (rts_model_file and rts_package_file)
before creating the project. We provide a batch file to help you set up these
types.
• Project- You must use SYNERGY/CM to create and define a project in which
to store the model:
○ You must use SYNERGY/CM to create the project, because the CM tool
integration cannot create a project for you.
○ The name of the project must not contain any spaces.
○ The Project's Purpose must be set to Shared. Note that when you create a
Project in SYNERGY/CM, its Purpose is set to Personal by default and it
cannot be changed after creation.
○ The Project's Work Area path must be defined using a UNC path. On the
Work Area Properties dialog, you must type the UNC path in the Directory
box. For example:
If you want SYNERGY/CM to create a work area in a subfolder of the c:
\cms folder on a computer whose machine name is computer12, create a
share for the cms folder (named cmsshare in this example) and type the
following text in the Directory box: \\computer12\cmsshare\
• Directory Object- You must set the status of the directory object to Integrate or
Public. By default, the status of the directory object is set to working, which
prevents non-owners of the directory object from checking in new Packages.
Note
When using SYNERGY/CM, you typically check out files and then check in
the tasks associated with those files. When using SYNERGY/CM with
Modeler, you must perform all check out and check in operations from
Modeler. Modeler associates check in and check out operations with the
default SYNERGY/CM task. Warning: Do not check in package files or tasks
from SYNERGY/CM, as this may check in out-of-date package files.

If SYNERGY/CM is not running and you open a Modeler model that is stored in a
SYNERGY/CM project, Modeler will start SYNERGY/CM so that it can
interrogate the status of the stored Model and Package files.
When you perform a check in or check out operation on a model, the operation
applies also to files that reside in the ModelerATFiles subfolder for the Model.
Unlike other CM tool integrations, the operation will not apply to files that reside
in subfolders of the ModelerATFiles subfolder for the Model.
If you want to baseline a SYNERGY/CM project that stores a Modeler Model,
check in the Model and all its Packages before creating the baseline. After
creating the baseline, perform the following steps:
• Disconnect and Reconnect using the Configuration Management > Advanced
> Disconnect From Configuration Management command followed by the
Configuration Management > Advanced > Reconnect to Configuration
Management > Store CM Tool Paths Globally in Model command.
• Check out the Model and all its Packages.
• Disconnect and Reconnect using the Configuration Management > Advanced
> Disconnect From Configuration Management command followed by the
Configuration Management > Advanced > Reconnect to Configuration
Management > Store CM Tool Paths Globally in Model command.
• Check in the Model and all its Packages.
To Set up a SYNERGY/CM Database to Work with Modeler:

You must run the supplied import batch file to set up a SYNERGY/CM database
for use with Modeler. The import batch file creates two types (mdf and pkf) and
must be run on the SYNERGY/CM server. The instructions assume the server is
running on a Windows XP computer.
Important The batch file must be run on the SYNERGY/CM Server, not the
SYNERGY/CM Client.
1. Install the SCCI integration software from the Telelogic integration patch,
which is available on the Telelogic website.
If the Telelogic integration patch installation does not set up the required
PATH environment variable, ensure that you set it up manually. If the PATH
environmental variable is not set up correctly, the CM Tool integration will not
work.
2. Open a Command Prompt window.
3. From the Modeler installation files, change directory to Synergy_Setup.
4. Run the import.bat file.
5. When prompted, log on to the database that you will be using to store Modeler
Models, as a user with type_developer privileges.

The batch file will set the role and import the two types.
6. Check that the import was successful:
a. From the SYNERGY/CM Project View, on the File menu, click Show
Messages.
b. At the bottom of the log, confirm that the rts_model_file and rts_package_
file types have been imported without any errors.
c. Close the SYNERGY/CM Message View window.
Having completed the import, check that the Super Type and the Migrate Rules
for each type have been set correctly:
1. Having completed the import, check that the Super Type and the Migrate
Rules for each type have been set correctly:
2. For each of the imported file types (rts_model_file and rts_package_file):
a. Click the Browse Types button.
b. From the list of types, select the file type, and then click OK.
c. From the Type Definition dialog, check that Super Type is set to binary.
d. On the Type menu, click Modify Migrate Rule.
The Type Definition - Migrate Rules dialog is displayed.
e. Check that the File Match Patterns are set:
.*\.[Mm][Dd][Ff]$ for the rts_model_file file type.
.*\.[Pp][Kk][Ff]$ for the rts_package_file file type.
f. Close the Type Definition - Migrate Rules dialog.
3. Close the Type Definition dialog.
4. If your SYNERGY/CM server is not running NT, run the ccm commands
listed in import.bat manually.
After setting up the SYNERGY/CM database, you can set up a SYNERGY/CM
project to store the Model.
To Set up a SYNERGY/CM Project to Work with Modeler:

1. If you have not done so already, set up the SYNERGY/CM database to work
with Modeler.
2. If you are using SYNERGY/CM version 7.0:
a. Ensure that you use the ccm_admin role when creating the project.
b. Ensure that the name of the project does not contain any spaces.

c. Set the project's Purpose to Shared. Note that when you create a Project in
SYNERGY/CM, its Purpose is set to Personal by default and it cannot be
changed after creation.
Note that a CM project can store only one Model.
3. Define the Project's Work Area Directory using a UNC path. On the Work Area
Properties dialog, you must type the UNC path in the Directory box. For
example:
If you want SYNERGY/CM to create a work area in a subfolder of the c:\ccm
folder on a computer whose machine name is computer12, create a share for
the ccm folder (named ccmshare in this example) and type the following text
in the Directory box: \\computer12\ccmshare\
4. Close the Create Project dialog.
5. If you are using SYNERGY/CM version 7.0, from SYNERGY/CM, set the
Status of the project's Directory object to Integrate or Public. Note that by
default the status of the directory object is set to working, which prevents non-
owners of the directory object from checking in new Packages.
For procedural information about working with SYNERGY/CM and checking in a
Model for the first time, open the Modeler Help, expand the 'Database, model,
component and package management (includes access permissions)' section,
expand the 'Configuration management tool integration' section, and then see the
topics in the 'Telelogic SYNERGY/CM integration' section.
Modeler Help.

10
Uninstalling Modeler
Uninstalling Modeler ................................................................................................ 200
199
The uninstall program will not start if the Modeler is running.
To uninstall Modeler, perform the following procedure:
1. For Standalone and Server Only installations of Modeler, stop all databases on
the computer.
2. Ensure that no Modeler products are running on the computer.
3. From the Control Panel, uninstall Modeler:
• For Windows 10, Windows 8.1 or Windows Server 2012, from the Control
Panel view, click the Uninstall a Program link, click the Windchill Modeler
entry, and then click Remove.
• For Windows 7, from the Control Panel view, click the Uninstall a Program
link, and then click the Windchill Modeler entry.
• For Windows Server 2008, from the Control Panel view, click the Uninstall
a Program link, click the Windchill Modeler entry, and then click Uninstall.
4. From the confirmation dialog, click Yes.
5. If prompted, restart your computer.
Note
The ModelerATFiles folder is not removed.
Removing Databases
The Windchill Modeler uninstall program does not remove databases from the
computer. To remove databases after uinstalling Windchill Modeler, refer to the
Microsoft SQL Server help topic:
Delete a Database
https://docs.microsoft.com/sql/relational-databases/databases/delete-a-database?
view=sql-server-2017
Uninstalling SQL Server

The Windchill Modeler uninstall program does not remove the included instance
of Microsoft SQL Server Express 2017. To uninstall SQL Server, refer to the
following Microsoft SQL Server help topic:
Uninstall SQL Server

https://docs.microsoft.com/en-us/sql/sql-server/install/uninstall-sql-server?view=
sql-server-2017
Note
You can reinstall Microsoft SQL Server without uninstalling Windchill
Modeler. However, changing the SQL Server instance name can affect
bookmarked databases in Model Explorer. Ensure that you use the same
instance name to keep bookmarked databases.
Uninstalling Modeler 201

11
Appendix 1: Configuration
Management Use Cases
Overview of Configuration Management Use Cases................................................... 203
Configuration Management Use Cases ..................................................................... 205
Agile Modeling Using a Multi-User Model .................................................................. 206
Versioning Models Quickly and Compactly ................................................................ 207
Controlling Access Using Package Protection and Access Rights ............................... 209
Differencing Models for Review Purposes ................................................................. 211
Model Import and Export Between Databases and CM ............................................... 213
Change Tracking in a Multi-User Model..................................................................... 214
Breaking Large Projects into Subsystem and Component Specific Models................... 218
Saving a Database for an External CM Baseline ........................................................ 219
Sharing Components and Packages Between Teams and CM .................................... 220
Developer Isolation in Support of Code and Debug Cycles ......................................... 222
Parallel Development of a Model for the Current and Next Release ............................. 226
Team Isolation in Support of Product Variants ............................................................ 229
Working on Parts of the Model Remotely................................................................... 229

Overview of Configuration Management
Use Cases
This section is intended to assist you in understanding the Configuration
Management (CM) features in Modeler and how they are intended to be used to
support common CM Use Cases.
Detailed information on working with parallel sandboxes, change tracking, and
access permissions is provided in the Modeler Help.
Feature Summary
This is a short high-level summary of key features in Modeler that support
collaborative team-based development.
The Modeler Help also provides details on specific aspects of usage, including a
table on associated access permission rights. The usage scenarios for exploiting
these features are provided in the Use Cases topics.
The key features are as follows:
• Multi-User
Multi-user refers to the ability of multiple developers to interact with the same
model at the same time, without needing to use an external CM tool as a
deployment platform. Based on the client-server architecture, multi-user is a
proven solution for many familiar large-scale database applications like email,
online discussion tools, and financial trading systems.
• Model Versioning
Model Versioning refers to the ability to create snapshots of a complete model
at a particular moment in time. After being versioned, the model is protected
and the version number can be used for unique referencing purposes.
• Active Data Dictionary
At the heart of each model is a single data dictionary that maintains a
consistent view across the model. Model items are defined once in the model
and can be referenced on any diagram and dragged into text fields as hypertext
links. Changes to model item names are automatically propagated across all
diagrams, including references to the model item in textual descriptions. The
active data dictionary also refers to the ability to view the same data in
different ways depending on the user's viewpoint. These varying views of
model content can help to improve the viewer's comprehension and workflow.
• Private Sandboxes
A Private Sandbox is a private view of the model that allows a user to work in
isolation without being affected by other user's changes to the same model.
• Model Reconcile
Appendix 1: Configuration Management Use Cases 203

A Model Reconcile is the merging of changes in a private sandbox into the
trunk version of a model.
• Sandbox Rebase
A Sandbox Rebase is the merging of the latest changes in the trunk version
into a sandbox. Rebase is the conceptual complement of Reconcile: rather than
merging changes from the branch to the trunk, changes are merged from the
latest trunk to the branch.
• Model Cloning
Model cloning creates a completely new model with a copy of all the objects
in the original model. Model clones are independent models and cannot be
reconciled with the original model. Cloning can be used to start a new project
in the same database based on an existing model.
• Model Differencing
The model Differencer compares two different versions of a model and reports
the differences. It can also produce a textual report, if needed.
• Model Export and Import
Model export and import represents the ability to export to file all the data
from a given version of a model, and then import that data into a different
database.
• Component Sharing Wizard
The Component Sharing Wizard supports the export and import of Packages
when you need to quickly move Packages from one model. You can move
Packages to another model directly or through an exported file, for example, to
send Packages remotely or check them into an external CM tool.
• Change Tracking
Change tracking can be used to document changes required to a model and
provide a detailed audit trail for review when the change is complete.
• Access Permissions
Access permissions are available at database, model and package level.
Package level access permissions can be used to control write or owner access
to different parts of the model by different team members or groups.
• Package Protection
Package protection allows you to freeze the development of parts of the model
by making the Package and its child items read-only.
• Full Logging and Backups

Modeler's databases are stored in a journaling, transactional object database.
This data server architecture provides highly available and recoverable access
to referentially consistent model content. Database SAV files also provide an
efficient method for transferring data between different databases.
It is strongly recommended that Full Logging is enabled and the database is
backed up regularly. You should ensure that backup procedures are in place
and periodically verify the recovery procedure works in practice.
• Package Check Out, Check In, and Create Replica
These will still work as in previous releases of Modeler, but we are
recommending using the database-based CM features above, as it will improve
scalability and reliability within your project.
Configuration Management Use Cases

The following example use cases show how Modeler's database-based CM
features can be used to support various development processes and lifecycle
stages. In practice, teams will employ two or more of these use cases during a
projects lifecycle and may combine aspects from different use cases at different
points in a project.
It is important to note that for a large project there is unlikely to be a single
process for all project phases. Often it is desirable to use different features at
different times to maintain optimal productivity. The important thing is to have
appropriate processes at the right time in your project. In practice, this means
looking at the goals of a particular modeling phase and ensuring that the processes
are appropriate to supporting these goals.
The following example use cases are provided:
• Agile modeling using a multi-user model on page 206
• Versioning models quickly and compactly on page 207
• Controlling access using package protection and access rights on page 209
• Differencing models for review purposes on page 211
• Change tracking in a multi-user model on page 214
• Breaking large projects into subsystem and component specific models on
page 218
• Model import and export between databases and CM on page 213
• Saving a database for an external CM baseline on page 219
• Sharing components and packages between teams and CM on page 220
• Developer isolation in support of code and debug cycles on page 222
• Parallel development of a model for the current and next release on page 226

• Team isolation in support of product variants on page 229
• Working on parts of the model remotely on page 229
Agile Modeling Using a Multi-User Model

Very often the point of modeling is to improve the communication between
people, that is, we want to use modeling to effectively share information about our
system between multiple stakeholders; often with different disciplinary skills and
backgrounds. This is especially true in the early phases of a project when it is
important to be able to propose and challenge ideas and make the appropriate
choices. This includes the ability to make corrections and restructure the model
without a formal change authorization process, and to be able to evolve the model
structure in collaboration with other users in a flexible way.
Modeler supports agile modeling using a server-based database providing a
collaborative modeling environment where modifications automatically propagate
to all active client sessions and yet where the user can selectively apply Modeler
CM features to control access and modification rights to a model and to track why
changes occurred.
To manage simultaneous access, the locking and unlocking of the model data is
performed automatically at the finest level of granularity. For example, when you
modify the Parameter of an Operation of a Class of a Package of a Model,
Modeler automatically locks (and then unlocks) just that Parameter item.
Usage
Modeler provides a turnkey solution for multi-user modeling using its object-
based database and active data dictionary.
Benefits
Agile re-structuring: With Modeler, you can easily change the package structure in
a model as the project evolves without having to restructure and change the access
controls in an external CM tool. The ability to restructure model content can
increase modeling productivity, particularly in early lifecycle phases when the
structure of a system is still evolving.
Robustness: Multi-user ensures that model consistency is maintained at all times.
This ensures consistency of the model regardless of the number of users and
without mandating unnecessary process constraints.
Granularity and locking: When you begin to modify the location, name,
properties, or associations of an item, Modeler automatically applies a lock on the
item and then releases it when you complete your modification. The fine
granularity and transaction-based approach to locking, reduces the potential for
multi-user conflicts.

Usability: Multi-user support provides an effective and integrated platform for
coping with fluctuations and increases in project team size without enforcing
process change. Importantly, it enables a wide team, including non-software
stakeholders, to access and edit the model without requiring training in complex
software-orientated external CM systems and processes.
Reduced complexity and overheads: An integrated solution reduces the total cost
of ownership, including co-installation and support costs of complex external CM
tools.
Recommendations
To exploit the benefits of Modeler's multi-user client/server architecture, you will
need to deploy Modeler in its Client/Server configuration rather than in
Standalone configuration. In a Client/Server configuration clients are installed on
separate machines and access is provided to central databases through network
connectivity.
For large teams (50+), or a Wide Area Network (WAN) where clients connect to
the server through routers or firewalls that degrade throughput, a practical
optimization for network utilization issues is to deploy Microsoft Remote Desktop
Services or Citrix as this will reduce network traffic. Due to the network lag
introduced by routers, this may also improve performance for local users who are
not connected to the server on the same Local Area Network (LAN).
To make appropriate use of this architecture it is strongly recommended that Full
Logging is enabled and the database is backed up regularly.
For more information about Full Logging, refer to the following SQL Server help
topic:
Recovery Models
https://docs.microsoft.com/sql/relational-databases/backup-restore/recovery-
models-sql-server?view=sql-server-2017
It is also prudent to periodically test the integrity of the back up processes by
exercising the restoration capabilities.
If users are opening diagrams for read-only purposes, then it is recommended they
select the Open Diagrams Read-only check-box in the Tools Options dialog.
Versioning Models Quickly and

Compactly
In most projects, you are likely to reach a point where you want to capture the
state of the model at a given moment in time.
Scenarios include creating a version of the model:
• For review and downstream audit purposes,

• Before performing a major change, so that you have a fixed version you can
roll-back to, or
• So that the model or its Packages can be exported in a known and fixed state.
To support this Modeler provides built-in model versioning. You can create a new
version of a model from Model Explorer by right-clicking on the model, and
selecting New ▶ New Version. You can add a textual comment to label a particular
version of the model. When versioning the model, locks are taken before
versioning starts ensuring that the versioning process can run to completion.
When you version a model, instead of creating a copy of the model objects,
Modeler captures a view representing the configured state of each model object.
This results in much better storage efficiency and performance.
Usage
From Model Explorer, right-click the model, select New ▶ New Version to protect
the current version and create a new version. Previous versions of a model can be
opened by showing all versions in Model Explorer.
Benefits
Model availability: Model versions can be viewed at any time by clicking the
Show Versions toolbar button in Model Explorer without having to restore from
CM. Previous model versions are available for audit, review, and differencing
purposes without having to retrieve and rebuild them.
Disk efficiency and storage utilization: Versioning does not create duplicate
objects. Model versions are merely different re-configured views of the underlying
data in the database.

Recommendations
Version and label the model only when deliveries or milestones are reached to
avoid unnecessary storage. If you do not need the whole model for differencing
purposes then you could export Packages in the model to a file using the
Component Sharing Wizard and then delete the file after you have finished with it.
Note: The Component Sharing Wizard will not export root level objects and hence
the data needed must be contained within a Package.
To revert to a previous version of a model, delete the subsequent versions of the
model. Then, to recommence modifications, version the model to obtain a new
writable model from the protected baseline version that you want to work from.
From the frozen version, use other tools like Windchill Modeler Publisher to
provide material for external review.
Logging is enabled and the database is backed up regularly. It is also prudent to
periodically test the integrity of the backup processes by exercising the restoration
capabilities.
Controlling Access Using Package

Protection and Access Rights
Modeler supports the ability to set read and write access control at database and
model level. Write access controls are also supported at package level allowing
you to control write access to different parts of the model for different users. This
feature is supported by setting access permissions on Packages.
Alternatively, you may want to freeze the development of a Package and its
contents. This may be for ongoing reasons, for example, to prevent parallel
development of Packages that have been imported from elsewhere, or for
temporary reasons, for example, to freeze a Package during a review. This feature
is supported with the ability to set a protected flag on a Package.
Both of these features are supported in the Access Permissions tab of the property
pages for a Package. Buttons are also provided to cascade access permissions and
the protected flag to child Packages.
Usage
From Modeler, on the Property Pages of a Package, use the Access Permissions
tab to modify, add or delete access permissions to the Package.

From Modeler, on the Property Pages of a Package, use the Protected check-box
on the Access Permissions tab to protect and unprotect that Package. Protected
Packages in a model can be easily identified by the padlock on the Package icon.
Benefits
Package protection is often used when part of a model is imported into a separate
model for reference purposes. For example, the flow down of an analysis model
from a systems engineering team to a software engineering team, where this part
of the model is for reference only.
Access permissions are often used to limit the danger of inadvertent changes. For
example, when you have a large team working in different parts of the same
interrelated model, a growing team of new and inexperienced users, or many users
accessing the model merely for review and audit purposes.
Recommendations
Only use access control when you need to. The need for access rights will depend
upon the structure and size of your team and the development stage you are
currently in. It is important therefore that you choose a strategy that makes the

best compromise in terms of limiting access versus making it efficient for making
the required changes. A key time for tightening access permissions is likely to be
when you need to introduce a change control review board.
On small teams, assign a team leader as model owner and allow them to
administer the access rights on the model. On larger teams, empower a CM
controller to administer Model and Package access control.
Modeler access permissions at model and package level support up to eight
different names or groups. When working with a large team it will be necessary to
use groups, rather than discrete user names, to control access. If you want further
advice on policies to adopt then speak to PTC support, who will be pleased to
advise you.
It is worth remembering that diagrams in UML are used to present a view of the
underlying data. For example, locking a Package that contains a diagram will lock
the size and location of items on that diagram. If you wish to protect the names of
items on a diagram then you need to also protect the Packages that contain the
items shown on it. For example, all useful class diagrams will implicitly contain
Classes, so if you do not want the Class names to change on the diagram then you
also must protect the Packages that contain those Classes.
The Modeler Help provides extensive information on Access Permissions,
including a summary table of access rights at database, model, and package level.
See the Model, Component and Package Management > Access Permissions
section of the Modeler Help.
Differencing Models for Review Purposes

Analyzing the changes to a model is an important step in team based development,
particularly when review evidence needs to be collected for downstream audit and
certification purposes. Modeler provides two orthogonal ways of analyzing
change with respect to models. The first is using model differencing to compare
two different versions of the same model. The second is using change tracking to
track individual changes.
The model Differencer can be accessed from the context menu of a model in
Model Explorer. If the Packages have been exported to disk then differencing can
also be performed between a given model and exported files.
Usage
From Model Explorer, right-click a model and choose Difference to see that
commands that compare the current version of a model with another version.

Benefits
Model differencing gives you a report of what items and properties have changed
since a selectable given point in time, that is, a model version in the database or a
component or package export to file.
Textual difference reports can also be generated for use in both the review cycle
and audit trail.
Recommendations
If you want to capture the differences since a moment in time then create a version
of the model before starting work. This is needed if you need to permanently
retain the version of the model for downstream audit or to support roll-back.
Alternatively, you can export part of the model to disk for differencing purposes
downstream through the Component Sharing Wizard. This can be used when you
only need to capture parts of the model and do not need to rollback to a previous
model version downstream.

Model Import and Export Between
Databases and CM
The model export capability allows you to export the whole version of a model
from Model Explorer to file.
You may want to do this either to:
• Share a model with remote and disconnected Stakeholders, for example, for
review purposes, or
• Store an archive of the model in an external CM system, for example, as part
of a project baseline.
Locks are taken automatically before the export starts in order to ensure that it can
run to completion. Note also that when using sandboxes, you can only import and
export trunk models. This is because sandboxes make use of delta information
from the previous version for storage efficiency. Model import and export is not
constrained to require that you need the previous version in the target database
before you import. Instead it will export the whole model so that the model can be
reconstructed in its entirety.
Usage
From Model Explorer, right-click the model version (not sandbox) and click
Export. An exported model version can be imported into a separate database using
the Import command in Model Explorer.
Benefits
Remote availability: Model versions can be exported into a different Modeler
database. This is useful for sending a snapshot of the model to an external site for
read-only review purposes.
Scalability: Importing models using Model Explorer is more efficient than
importing using Package import and export or the Component Sharing Wizard as
it does not require the merging of new data with existing data.
Consistency: Importing and exporting a complete model results in a more
consistent view as it ensures that the model is fully consistent with itself.
Importing and exporting Packages increases the risk of version skew.
Recommendations
Note that the latest version of a model (the tip) is writable. When delivering a
model to another team you want to send them a fixed version of the model not the
tip. To do this you should first version the model in Model Explorer and then
export the protected version of the model.
After you have exported the model, you can email it to other sites or check it into
CM as part of a project baseline.

It is not possible to export all versions of a given model en-mass using model
import and export. Although it is possible to script the export and import of a
hierarchy of models (v1…v11 etc), it is important to note that the import of these
models into a different database will result in a copy of the model data for each
version, rather than a view of the same data. This could thus be prohibitively
expensive in terms of storage space and import time. If it is necessary to move the
full history of versions to another machine then the preferred mechanism is to
save and restore the data as a whole database, rather than separate models, as this
will result in more efficient storage utilization and transfer times.
In the event that you want to export a model from a sandbox it is possible to use
the Component Sharing Wizard instead. This will require you to create a single
root Package for your model. For more information, see CM uses cases - Sharing
components and packages between teams and CM on page 220.
Change Tracking in a Multi-User Model

In most projects, especially safety-critical projects where collection of evidence in
support of certification is necessary, a transition point is reached where the
introduction of a change review board may become desirable or mandated within
a Quality Assurance (QA) process.
Very often this relates to a major delivery milestone after which a project requires
a more formal change control process to ensure integrity of previously reviewed
artifacts is protected. At this stage, it is still important that the model can be
shared between collaborating users, however it needs to be changed in a
controlled manner and in conformance with a formal change process. The change
tracking feature of Modeler supports this need. The Change Tracking feature
requires a Change Tracking license.
Change tracking can be enabled model wide by a model owner. After being
enabled, this enforces that all users must select and make a Change Note active
when making edits to the model. All edits to the model are then tracked against
the Change Note set active. Different users can select different Change Notes and
therefore using this mechanism it is possible to track the work performed on
individual change requests and use the automatically collected change information
in support of review and audit processes.
When complete, a Change Note can be marked as Closed to prevent further use.
This renders them unavailable for tracking further changes. When necessary, a
user with Model Owner privileges can reopen a closed Change Note.
Usage
From Modeler, On the Property Pages for the Model, select the Enable Change
Tracking check box. This enables the Change Tracking feature model wide.

The list of items associated with a particular Change Note can be browsed in the
Relationships pane.

Change Notes are model items and hence are visible in the model. On the Property
Pages of a Change Note you can use the View Change Summary button to switch
between a view of the changes and a list of items affected by those changes.
Benefits
Communication of change: After being enabled, change tracking ensures that an
audit trail is maintained against all model items. This is useful for enhancing the
communication of change between collaborating users.
Detailed changes: The detailed changes information includes a full audit trail of
all the changes made. This information is accessible through the automation
interface and hence can be used for custom reports, change metrics or audit
purposes.
Changed items synopsis: A synopsis of what items were touched in the process of
completing a change is also available. In the Relationships pane, you can see
which items have been affected by a Change Note. You can quickly find a Change
Note in the Relationships pane by right-clicking the Change Note, pointing to
Find, and then clicking In Relationships Browser. This list of items can be used as
a check-list for the review cycle.
Recommendations
Modeler CM’s features empower you to choose the level of tracking and control
you deem appropriate for your project in its particular stages of development.
However, this does come at the cost of adding information to the model and
requiring additional processes to support Change Notes. At certain project stages,
a barrier preventing changes is needed. For example: after delivery. At other
project stages, such a barrier is not useful. For example: early in the project
lifecycle when the aim is to use the model to improve communication of ideas
between people.

Each Change Note should cover a single set of dependent changes by one user,
analogous to the task-specific, user-specific, Change Requests utilized in most
CM systems, rather than multiple changes by multiple developers. Since Change
Notes take their access permissions from the owning Package, we recommend that
you have a separate Package hierarchy in the model that allows a model owner to
control access to Change Notes, for example:
Using temporary Change Notes: Change tracking requires that all users of the
model have an active change node when making edits and a Change Note
monitors all modifications made by the user in their session throughout the Model.
If parts of the model are not under formal change control, then it may be necessary
to create dummy Change Notes for users who are changing these. If many people
are using the same temporary Change Notes then the number of links can become
large. When using this technique therefore, housekeeping is recommended to
regularly delete temporary Change Notes from the model.
Housekeeping: Change tracking will increase the storage space required for a
model and increase the time taken to perform model-level operations, such as,
versioning and model imports and exports. If the number of changes is great, then
you may elect to periodically delete Change Notes from the model. One option is
to version the model when a particular milestone is complete, delete all the closed
Change Notes, and then start again. An alternative is to version the model after the
completion of a particular change and then delete the Change Note. The Change
Notes will be stored in the versioned model and hence are not lost. An external
cross reference of Change Notes to Model Versions could be maintained in, for
example, an external CM tool or external database. If the model has been
versioned then it can be opened for downstream audit to recover the complete
details of changes associated with a Change Note.
Deleting Change Notes: When deleting a Change Note a different Change Note
must be set to active, so that a record of the deletion is tracked. One suggestion is
to have a Change Note in the model for use by a model administrator for deleting
Change Notes.
Change Notes can also be stereotyped to record information relating to your
process, for example, adding a tag definition that records a particular review
status, such as In Progress, Reviewed and Completed. A description can also be
added to the Change Note to summarize the overall change.

Breaking Large Projects into Subsystem
and Component Specific Models
When working with very large projects, it is not always practical to model the
complete system in a single model, because the size of the resulting model can
result in performance problems.
Typically, a large system comprises a number of subsystems and components, and
those subsystems can be modeled in separate models. It is good practice to
consider how best to allocate subsystems to different models before starting a
project. If a model becomes too large and it contains two or more subsystems, you
can move one or more subsystems to a different model.
Usage
If you want to move a subsystem or component to a different model, use Package
Import/Export or the Component Sharing Wizard to move the subsystem or
component Package to a different model. The Component Sharing Wizard has the
advantage of identifying any dependencies that the Package has.
Benefits
Model size: Breaking large projects into subsystem and component specific
models results in smaller more manageable models.
Scalability: Large projects can be modeled without individual models becoming
too large.
User access: When a model contains only a subsystem or component, access to
that subsystem or component can be controlled at the model level.
Recommendations
Ensure that each subsystem or component has its own Package.
When deciding how to assign subsystems to models, you should consider the
following factors:
• How large each subsystem is likely to be.
• Which users require access to the different subsystems.
• How connected the different subsystems have to be. You cannot create
Modeler links between subsystems that are in different models.
When a subsystem or component is likely to be reused:
• Ensure that the subsystem or component is modeled in its own Package, so
that it can be easily copied or moved.

• Consider using PTC Integrity Asset Library to create the subsystem or
component as a reusable asset. For more information about PTC Integrity
Asset Library, see the PTC website.
When breaking down a model that has become too large, consider moving
subsystems that have the fewest links to other subsystems first. When using the
Component Sharing Wizard to move a Package, the Component Sharing Wizard
can identify links to items that are outside of the Package.
When a system and its subsystems are modeled in more than one model, it is good
practice to version all the models at the same time. Failure to do so can result in
version skew.
Saving a Database for an External CM

Baseline
Very often the model is only part of an overall project that may include other
artifacts such as source code, executables, documents and plans etc. It is therefore
often desirable to have an easy, robust and efficient way of including a model in
an externally configured baseline.
There are a number of techniques that can be used for this. If you have a very
large model or you want to archive multiple versions of the same model, then one
of the quickest methods is to capture a database .bak file, and to check this into
your CM tool as part of a project baseline. Database .bak files are created using
Model Explorer and will archive all the information in a given database.
Benefits
Database .bak files take minutes to capture and restore because they do not
require the translation of data. They are a very efficient way of capturing a
complete snapshot of a database.
Recommendations
It is recommended that database .bak files are automatically generated as part of
overnight back ups. Providing you have a policy in place, you could take the
Backup file from the previous night, and check this into CM.
.bak files need to be generated by users who have server access. If this is
required regularly then you could set up certain users with remote login
capabilities so they can connect to the server when needed.
.bak files contain text. If you want to email a database .bak file, then compress
the file to a zip file.
If your model includes Attribute Files such as generated Word and Excel
documents or you have created custom properties for your model then your
backups must include the Database's ModelerATFiles subdirectory as the .bak file

does NOT contain these artifacts. A Model's custom properties are stored in the
Template.txt file that resides in the ModelerATFiles sub-folder for the
Model. Note that use of UML profiles (Stereotypes and Tag Definitions) is now
the recommended mechanism for extending base types in Modeler and use of
custom properties is not recommended.
To make appropriate use of this architecture it is strongly recommended that
Logging is enabled and the database is backed up regularly. You should test
backups regularly by restoring and checking for data integrity.
Contact PTC Technical Support if you have any queries concerning the
recommended backup procedures for your databases.
Sharing Components and Packages

Between Teams and CM
Often when working in large teams and on large projects it may be necessary to
send some parts of the model to a different team for modeling purposes. One
example is to import an analysis model into a design model so that «trace»
relationships can be established. Another example is importing the interfaces of a
shared component in order to reuse the published classes.
Modeler provides a Component Sharing Wizard to support the movement of
Packages between different models. The Component Sharing Wizard includes
functionality for assessing the dependencies between Packages and storing a
textual description with the file. An option is also available to difference the
model with a Component Sharing Wizard file before import. When exporting
Packages to disk, the Component Sharing Wizard zips up the data to a single
compressed file, so that it can be emailed easily or checked into a CM project.
When sharing components and Packages that are evolving, it is assumed that the
subscribing team requires read access but not write access. UML dependency
relationships, such as «trace», can be used to trace a model to items in read-only
Packages without having to unprotect them.
Usage
From Modeler, right-click a Package and select Tools ▶ Component Wizard ▶
Export To Directory to export set of Packages to a file. The component information
is zipped into a compressed format so that can be emailed between sites or
checked into a CM tool. To import the file, right-click the Package in which you
want the exported Package to reside, and select Tools ▶ Component Wizard ▶
Import From Directory.
Alternatively, from Modeler, right-click a Package and select Tools ▶ Component
Wizard ▶ Export To Model to export Packages from a publishing model into a
subscribing model. You can use the Import From Model command to import
Packages from a publishing model.

Benefits
This can be used to reuse a Package, share it between two models or allow it to be
worked on remotely.
The Component Sharing Wizard reports dependencies to other parts of the model
that may also need to be shared.
Recommendations
Version the publishing model and then export the relevant Packages from the
protected version using the Component Sharing Wizard.
Interfaces should be put in a shared Package that is updated as a whole. Where
possible, separate private Packages from public Packages and only share the
public Packages to reduce the coupling between models.
It is not possible for a model to have more than one root model object. This means
that the Component Sharing Wizard can only export and import Packages and
their contents. If you want to share a whole model inside another model then the
publishing model will need to have a single root Package, for example, named
after the model. To import an analysis model into a design model, for example,
create a single root Package in the analysis model and put all the Packages and
items in the model under this root Package. You can then share the root Package
and all its children in other models.
Ensure, where possible, that the Packages that need to be shared have a common
root Package so that you can move a complete Package hierarchy as one.
Although there may be more than one subscribing model, there should only ever
be one publishing model. Packages imported into the subscriber model should
always be protected so they are read-only.
If you want to share a whole model using the Component Sharing Wizard then
create a single root Package, for example, named after the model, and move
everything into it. You can then share the single root Package and all its children.

capabilities.
Developer Isolation in Support of Code

and Debug Cycles
During an implementation phase when the model is used for code generation, it is
important that it can be changed in isolation from other users in a controlled
manner. Isolation allows a developer to compile and debug generated code
generated from the model without being affected by, and without affecting, other
users working on the same model. Isolating developers supports concurrent
development on the same code base and is therefore an enabling factor for
increased team productivity during an implementation phase.
Modeler's private sandbox supports the ability to create, branch and merge private
workspaces at model-level. This technique applies a branch-per-change policy, so
when you create a private sandbox from the model, the trunk is protected by
default to provide a stable baseline. Developers work in isolation using a new
private sandbox for each change. The sandbox represents a private view of the
configured data in the model, rather than a copy of the data, and by default the
sandbox is visible only to the user who created it (and Database Administrators).
When work is complete in a sandbox a Reconcile operation is used to publish the
changes into the trunk model. This uses the new merge engine in Modeler to
resolve conflicts where the same items have been changed by different users. This
process is known as a 3-way merge. The 3-way merge uses the trunk version of
the model from which the sandbox was created, the latest trunk version and the
sandbox version. The 3-way merge automatically applies all non-overlapping
changes from each version. If any changes were overlapping, then these are
brought to the attention of the user for resolution.
Whenever a rebase or reconcile is performed the trunk version is protected during
the merge. After being reconciled the sandbox is protected and hidden from the
normal Model Explorer view. A new sandbox needs to be created for the next
change and the process repeats. The sandbox version prior to a Reconcile is
available when the Show Versions toolbar button is selected in Model Explorer.
When sandboxes have been created from the same version of the trunk, those
sandboxes can be reconciled with each other before reconciling the resultant
model to the trunk.
In addition to the Reconcile operation a new Rebase operation is provided in
Model Explorer for a user to update their sandbox with changes in the trunk. A
Rebase is normally performed prior to a Reconcile so that the merge can be tested
in the sandbox without affecting other users, and any conflicts can be resolved.

Differencing functionality is also provided to assist with the review of changes.
Optionally, you can also use Change Tracking to document and track changes to
the model.
Usage
From Model Explorer, right-click a model, and select New and then click New
Private Sandbox to create a personal branch of the selected model.
Notice that trunk versions of a model have an integer value, starting at 0. The
sandbox versions of a model have three parts delimited by periods, such as 1.1.0.
The value of each part is determined as follows:
• The first part is set to the model version in the trunk from which the sandbox
was created. For example, if a sandbox has a version number of 2.1.3, you
know that it was created from version 2 of the model.
• The second part is determined by how many sandboxes have been created
from the same trunk version. For the first sandbox that is created from a trunk
version, the value is set to 0, for the second sandbox that is created from the
same trunk version the value is set to 1, and so on. For example, if a sandbox
has a version number of 2.1.3, you know that it is the second sandbox to be
created from version 2 of the model.
• The third part is determined by how many times the sandbox has been
versioned. When the sandbox is created, this value is set to 0. For the next
version of that sandbox, the value is set to 1, and so on. For example, if a
sandbox has a version number of 2.1.3, you know it is the fourth version of
that sandbox.

From Model Explorer, right-click a sandbox, and select Reconcile ▶ To Trunk to
merge the changes from a private sandbox into a trunk model. Conflicts where the
same model item has been updated in parallel will be reported and can be resolved
before creating a new version of the trunk.
From Model Explorer, right-click a sandbox and click Rebase to merge changes in
the trunk into a private sandbox. Conflicts where the same model item has been
updated in parallel will be reported and can be resolved before creating a new
version of the sandbox.

Benefits
Storage efficiency: Private sandboxes represent a view of the configured data
objects, rather than a copy. This means that private sandboxes are much more disk
efficient than replica models (the previous technique used by PTC to support
isolation).
Model consistency: The merge process is designed to ensure that all dependent
changes are merged together. Deleting an Operation on a Class, for example, will
affect that Class as well as any diagrams where that Operation is referenced. This
means that model consistency can be preserved automatically for a given Rebase
or Reconcile operation.
Recommendations
Use a private sandbox for each separate change or set of dependent changes made
by one user. A sandbox should only be shared with another user when very close
cooperation is needed. Although access permissions can be changed, by default a
sandbox is private to the user that creates it.
It is good practice to always rebase before reconciling, so that changes can be
tested privately in the branch before being reconciled to the trunk.
If you rebase often then this creates frequent but smaller integration work. If you
rebase infrequently then you increase the risk of larger integration work. This is
known as the integration-versus-isolation conundrum. When using sandboxes, the
goal is to achieve a balance, that is, do not rebase so often that it causes disruption
to your tasks but rebase often enough to keep abreast of changes that may affect
your work.
Do not unprotect the trunk model. The trunk model will be protected by default.
This significantly improves the time taken to create and reconcile sandboxes and
reduces contention between users.
If the changes need to be abandoned, the sandbox can be kept without being
reconciled or deleted.
After a milestone is reached, old reconciled sandbox versions can be deleted by
the Database Administrator or Model Owner, if desired, as the reconciled changes
can be constructed by comparing the trunk versions.
capabilities.
The Modeler Help has a topic on database-based configuration management;
including a review of terminology and working with branches, see the Database-
based Configuration Management section of the Modeler Help.

Parallel Development of a Model for the
Current and Next Release
A common use case when developing a model is wanting to make maintenance
fixes for the current release of a model, while making more significant changes for
the next release of that model.
A possible solution is to clone of the model so that you have two separate models,
one for developing the current release, and one for developing the next release.
Although this solution allows you to make changes for the next release of the
model without affecting current release of the model, it is inefficient because the
maintenance fixes will have to be made in both models.
A better solution is to use the sandboxing features of Modeler that support parallel
development of a model. The current release of the model can be maintained in
the trunk, while development of the next release can be made in isolation through
a sandbox. The maintenance fixes that are made to the trunk can be merged easily
to the sandbox through a rebase operation.
Usage
From Model Explorer, right-click the latest version of the model, point to New
and then click New Private Sandbox.
Note that a trunk version number is an integer value, such as 1. A branch version
number has three parts, such as 1.1.0. The previous use case describes how the
sandbox version numbers are derived.

Use the trunk to make maintenance fixes for the current release of the model. use
the sandbox to make changes for the next release of the model.
Maintenance fixes that are made in the trunk for the current release can be merged
to the sandbox for the next release. You do this through a rebase operation. To
rebase a sandbox, right-click the tip version of the sandbox, and then click
Rebase.
When it is time for the next release of the model to be released, merge the sandbox
to the trunk so that the next release in the sandbox of the model becomes the
current release in the trunk. You do this through a reconcile operation. To
reconcile a sandbox, right-click the tip version of the sandbox, point to Reconcile,
and then click To Trunk.

To make further changes for the next release, you repeat the process by creating a
sandbox from the latest version of the trunk.
Benefits
Efficiency: Maintenance fixes have to be made only in the trunk for the current
release of the model. Rebase operations merge those changes to the sandbox for
the next release of the model.
Parallel development: Changes made to the Next Release of the model in the
sandbox do not affect Current Release in the trunk.
Recommendations
It is good practice to always rebase a sandbox before reconciling it, so that
changes can be tested privately in the sandbox before being reconciled with the
trunk.
If you rebase often then this creates frequent but smaller integration work. If you
rebase infrequently then you increase the risk of larger integration work. This is
known as the integration-versus-isolation conundrum. When using sandboxes, the
goal is to achieve a balance, that is, do not rebase so often that it causes disruption
to the development of the next release, but rebase often enough to keep abreast of
the maintenance fixes in the current release.
After reconciling a sandbox, the tip version of the trunk will be protected. Do not
unprotect the tip version of the trunk. This significantly improves the time taken to
create and reconcile sandboxes and reduces contention. To continue development
of the trunk, create a new version of it.
capabilities.

Team Isolation in Support of Product
Variants
In some cases, it may become necessary to create a temporary or permanent
variant of the model.
For a temporary variant, a private sandbox can be created from any frozen trunk
version of the model and its rights changed to give other users access as necessary.
After the variant is complete, the changes can be differenced for review and
reconciled back into the trunk. This may be used, for example, to fix a bug in a
released product without introducing changes made for the next release.
For a permanent variant, any model version (including a sandbox) can be cloned.
From Model Explorer, right-click a model or sandbox, point to Clone, and then
click the desired command.
The clone may be versioned and sandboxed as necessary, but will take more disk
space and time to create than a sandbox. Any Packages which are shared between
the original model and the clone can be kept up to date using Component Sharing
Wizard. If a Package needs to be modified in both models, it can be shared via a
sandbox so that changes can be reconciled. This may be used to create multiple
variant models from the same base.
This document does not cover the variability modeling features of Modeler.
Variability modeling allows you to choose variability options for a model and then
generate a product model based on the options you have chosen. For more
information about variability modeling, see the Modeler Help.
Working on Parts of the Model Remotely

In some cases, it is necessary for a separate team or developer to work on parts of
the model remote from access to the central database.

To do this you will need to create a model sandbox and then export the relevant
Packages from the sandbox using the Component Sharing Wizard. This is
imported into a new model by the subcontractor, modified as necessary and
exported to return it. The original author may difference the Component Sharing
Wizard file before import to review the changes and then import it into the
sandbox. The sandbox can then be rebased and reconciled.
Note
Note that this process ensures that it is possible for both the original author
and subcontractor to make changes to the Package then reconcile them in a
managed way. However, working in parallel in this way should be done
carefully as the problems with reference to the isolation-versus-integration
conundrum.

12
Appendix 2: Useful Information
Adding a certificate to SQL Server ............................................................................ 232
Making a Standalone Installation Work when Disconnected from the Network.............. 233
Checking You Are Logged on to Windows with Administrator Rights............................ 234
Setting up Trusted Domains ..................................................................................... 235
Disabling Virus Checkers During Installation.............................................................. 236
Migrating Models after Updating PTC Profiles............................................................ 236
231
Adding a certificate to SQL Server
To add a certificate to SQL Server:
Note
We recommend you use a commercial certificate that is signed by a trusted
Certificate Authority.
1. Start SQL Server Configuration Manager.

2. In the left pane, expand SQL Server Network Configuration.
3. Right-click on Protocols for <Instance_Name>, and then click Properties. The
Properties window appears.
The default <Instance_Name> is MODELER.

4. On the Flags tab, under General, change Force Encryption to Yes.
5. Click on the Certificate tab.
6. Select the certificate that you want to use from the drop-down list, and then
click OK.
If the certificate you that you want to does not appear, do the following:
a. Open the certificate file that you want to use.
b. Click on the details tab, and then copy the certificate Thumbprint value.
c. Start the Windows Registry Editor, and then navigate to the following key:
SOFTWARE\WOW6432Node\Microsoft\Microsoft SQL
Server\MSSQL12.MODELER\MSSQLServer\
SuperSocketNetLib
If you not using the default SQL Server instance, replace MODELER with
the name of your current instance.
d. Replace the data for the Certificate value with the Thumbprint value that
you copied in step b.
7. Click on SQL Server Services and restart the SQL Server service: Right-click
on the SQL Server instance, and then click Restart.

Making a Standalone Installation Work
when Disconnected from the Network
If you want to be able to use a Standalone installation when the computer is
disconnected from the network, you must perform the task that applies to your
computer setup so that the SQL Server database can use TCP/IP.
If your computer is disconnected from the network, Windows may disable TCP/IP.
For more information, see The Modeler license stops working when disconnected
from the network on page 242.
If you are using a server-based floating license and you want Modeler to be
licensed when disconnected from the network, you must borrow the license you
require. For information about borrowing licenses, see the following topics:
• Borrowing a license from a server-based floating license on page 154.
• License borrowing — frequently asked questions on page 146.
• Returning a borrowed license to a sever-based floating license on page 155.
To Make a Standalone Installation Work when Disconnected from the

Network:
The computer name and DNS suffix must contain only valid characters. You may
also need to prevent the network card from going in to standby mode.
1. Display the system information about your computer:
• Under Windows 10, Windows 8.1, Windows 7 or Windows Server 2012,
from the Control Panel Category view, click the System and Security link,
and then click the System link.
System and Maintenance link, and then click the System link.
2. The computer name is shown by the Full Computer Name label.
3. Ensure the characters of the computer name are letters, numbers or hyphens. If
other character types are included, rename the computer name using only
letters, numbers or hyphens.
4. Display the Primary DNS suffix of your computer: click the Change Settings
link, click Change, and then click More.
5. Ensure the characters of the DNS suffix are letters, numbers or hyphens. If
other character types are included, rename the computer name using only
letters, numbers or hyphens.
6. If you have changed the computer name or DNS suffix, save the changes and
restart your computer.
Appendix 2: Useful Information 233

To Prevent the Network Card from Going in to Standby Mode:
1. In Windows Explorer, right-click This PC, Computer or My Computer, and then
click Manage.
2. For Windows Server 2008 only, in the left pane, expand Diagnostics.
3. In the left pane, select Device Manager.
4. In the right pane, expand Network Adaptors.
5. Right-click your network adaptor, and then click Properties.
6. Click the Power Management tab.
If there is not a Power Management tab on the dialog, your network card is not
under power management and you can abandon this procedure.
7. Clear the Allow the computer to turn off this device to save power check box.
8. Click OK.
9. Close the Server Management window/Computer Management window.
Checking You Are Logged on to Windows

with Administrator Rights
Under Windows you require local administrator rights for all installation types. In
addition, for Server Only installations you may optionally require domain
administrator rights the first time you perform a Server Only installation on that
domain.
Note
If you do not have Local Administrator rights and you attempt to install
Modeler, the installation will fail.
Local Administrator Rights

If you do not have local administrator rights, you can either log on to Windows as
a user that does have local administrator rights, or add your user account to the
local administrators group. Note that only a user with administration rights can
add you to the administrators group.
To verify that you have local administrator rights to your computer (under
Windows 10):
1. From Control Panel Category view, click the User Accounts link.
2. Locate your user name and confirm that you are an Administrator.

Windows 8.1):
1. From Control Panel Category view, click the User Accounts and Family Safety
link.
2. Click the User Accounts link.
3. Locate your user name and confirm that you are an Administrator.
Windows 7):
2. Click the Change Account Type.
3. Locate your user name, and confirm it has Administrators listed in the Group
column.
Windows Server 2012):
2. Click the Change Account Type.
3. Locate your user name and confirm it has Administrator listed.
Windows Server 2008):
1. From Control Panel Home view, click the User Accounts link.
2. Click the User Accounts link.
3. Click the Change Account Type link.
4. Confirm that the Administrator option is selected.
Domain Administrator Rights

When you log on to Windows, you can specify which domain you want to log on
to. You can verify whether you have domain administrator rights from the
domain's computer.
For more information, see Administrator rights required for installing Modeler on
page 20.
Setting up Trusted Domains

If your client has only one domain, then there is no issue of a trust domain.
If a Modeler client and server are in different domains, you must set up read/write
trust between the two domains.
Appendix 2: Useful Information 235

The method for setting up trusted domains is demonstrated in the following
example.
• The Server is named server1 and is in a domain named ServerDom.
• The Client is named client1 and is in a domain named ClientDom.
Domain ClientDom has read/write trust to domain ServerDom, which means that
any one from domain ClientDom can read and write resources to domain
ServerDom.
To work with Modeler, you must have a read/write trust between the two domains.
The client's domain ClientDom must be able to write to the ModelerATF share
directories on the server in domain ServerDom.
Make sure that the necessary trust relationships and permissions are set up by your
domain administrator.
If your Modeler client has two domains configured as child and parent domains,
and there is a trust relationship between the child and parent, then consider the
following:
• If Modeler is installed in the child domain, then SQL service must be executed
from the parent domain to enable access for both the domains.
• If Modeler is installed in the parent domain, then Modeler can not access the
users/groups that are in the child domain.
Disabling Virus Checkers During

Installation
Virus checkers can cause problems when copying many files to a computer. Stop
virus checkers before installing Modeler.
We have experienced problems installing Modeler when the following virus
checkers and applications are running; PC-Cillin, McAfee, WinGuard and NIC
Diagnostics.
Migrating Models after Updating PTC

Profiles
When you update the PTC profiles in a model, Modeler runs any required
migration scripts to migrate the data in that model.
The results of a migration are sent to a log file, which you can find in the
%temp%\ModelWizard folder.
To update the PTC profiles in a model: right-click a PTC profile, and select Tools
▶ Update All Profiles.

13
Appendix 3: Troubleshooting
Problems Experienced When Installing the Software.................................................. 238
Problems Experienced When Using the Product ........................................................ 239
237
Problems Experienced When Installing
the Software
This section covers problems that occur during the installation process.
The installation log file is named PTCWindchillModeler_MSI_<version
number>.log and is generated to your Windows temp folder. To view the
content of your Windows temp folder in Windows Explorer, in the Address box
type %temp%, and then press the Enter key.
The following table documents known issues that can affect the installation
process.
Problem Solution
Installation closed with local See Checking you are logged on to
administrator rights required message. Windows with administrator rights on
page 234.
There was not enough disk space to See the Modeler Release Notes for
complete the installation. information about how much disk space
is required for the installation type you
performed.
Installation stopped before copying all This problem can be caused by virus
the files to the computer. checkers. See Disabling virus checkers
during installation on page 236.
Installation prompted me for The Publisher add-in creates Microsoft
information about Microsoft Word and Word documents. If Microsoft Word is
I do not have it installed. not installed we recommend that you do
not install the Publisher add-in.
database is already mapped message. You are reinstalling Modeler, and the
database has been previously installed.
You may want to install the database
again as it may contain updated models.
Run-time error message. Check that virus checkers are disabled,
close any applications that are running,
and then repeat the installation.
Database not installed message. On an upgrade, this can be caused by
the user not being a Database
Administrator. If this is the case, set up
the user as a Database Administrator
and repeat the installation.
If the problem you experienced is not covered in the previous table, we

recommend that you confirm that your installation environment is set up correctly,
and then repeat the installation. For more information see:

Preparing for a Server Only Installation on page 81
Preparing for a Client Only Installation on page 90
Preparing for a Standalone Installation on page 76
Preparing for Installation of Web Interface on page 99
Installing Model Manager on page 96
Problems Experienced When Using the

Product
I Cannot Connect to the Server
This problem can be caused by network and server configuration issues.
Alternatively, the problem can be caused by the client and server being logged on
to different domains.
When a Windows server is added to a domain, ping is blocked by default. You
must enable ping on the Windows server.
To check that the server and network are working correctly, try to ping the server
from your computer.
If you cannot ping the server, Modeler will not be able to connect to the server.
Resolve the server or network problems so that you can ping the server. Make sure
the Windows Firewall is set up correctly. For more information, see Setting up the
Windows Firewall on page 87.
If the client and server are logged on to different domains, there are two solutions
to this problem:
• Log on to the same domain as the server.
• Set up read/write trust between the two domains.
For more information about setting up trusted domains, see Setting up trusted
domains on page 235.
I Cannot Bookmark the Database I Require

You bookmark a database through Model Explorer.
If when you attempt to connect to the server Model Explorer displays an Unable
to Establish a Connection With the Server message, you must resolve this problem
before you can bookmark a database.
For more information, see I cannot connect to the server on page 239.
Appendix 3: Troubleshooting 239

If when you attempt to connect to the server Model Explorer displays a Class Not
Registered message, then manually register the following DLLs in the Modeler
EXE folder:
• EAsG10.DLL
• EMxG10.DLL
• EPsE10.DLL
• ESsG10.DLL
• EWsE10.DLL
• SFCClSvr.dll
To Manually Register a DLL File:
Note
You can manually register a DLL file only if you have administrator rights.
1. From Windows Explorer, right-click the DLL file you want to register, and
then click Open With.
2. If you are using Windows 8.1 or Windows Server 2012:
a. From the warning dialog, click More Options.
b. From the next dialog, click Look for Another App on This PC.
If you are using Windows 10, Windows 7 or Windows Server 2008:
a. If the Caution dialog is displayed, click Open With.
b. From the Windows dialog, select the Select the program from a list of
installed programs option, and then click OK.
c. From the Open With dialog, click Browse.
3. Locate and select the Regsvr32.exe application that resides in your
Windows System32 folder, and then click Open.
I Cannot Start a Database

You can start a database only if you are an administrator of that database.
To Start a Database:
2. Expand the SQL Icon, the Server Instance, then right-click the database you
want to start.

3. Click Start.
I Cannot See the Model I Require

If you can see the database but not see the model you require, you may not have
access rights to that model.
The Modeler License Does Not Work

The Modeler license will work only on the computer from which the license
request was made.
If the evaluation Modeler license has expired, you must request a permanent
Modeler license from PTC.
From License Manager, click Options, and ensure that the license options are set
up correctly:
• If you are using a local license, the 'The Path to the Local License' option is
selected, and the path to the license file is correct.
• If you are using server-based floating license, the Name of the License Server
option is selected, and the name of the server is correct.
If you are investigating problems with a floating license, the log file on the server
may contain useful information. If you have installed Modeler to the default
locations, the log file resides in the following location.
Manager
• C:\Program Files\Windchill Modeler\License Manager
The Modeler License Does Not Work after

Upgrading Modeler
If you are upgrading Modeler, you will require upgrade or replacement Modeler
licenses. For more information, see the Modeler Release Notes.
If you have a maintenance agreement with PTC, you should receive an email that
provides instructions for obtaining the upgrade and replacement Modeler licenses.
If you are investigating problems with a floating license, the log file on the server
may contain useful information. If you have installed Modeler to the default
locations, the log file resides in the following location.

Manager
• C:\Program Files\Windchill Modeler\License Manager
The Modeler License Stops Working when

Disconnected from the Network
If you are using a floating license, Modeler will work only when it can access the
license server or you have borrowed the necessary licenses.
If you are using a local license but have not set up your computer so that Modeler
works when the computer is disconnected from the network, then set up your
computer accordingly.
For more information, see Making a standalone installation work when
disconnected from the network on page 233.
If Modeler is installed while the client is configured to receive an IP address
automatically from a DHCP server, when disconnected from the network the IP
'lease' period to that client may expire. This can cause Modeler or the license
request to fail. To resolve this problem, check that the local HOSTS file has the
client name associated to the localhost 127.0.0.1 IP address, for example:
127.0.0.1 localhost stuartevans
The HOSTS file is located in the following directory: <system directory>\
system32\drivers\etc
I Get Errors When Starting Add-ins

This problem can occur if your virus checker was running during the installation
of Modeler.
Stop the virus checker, and then repeat the installation.
I Cannot Use the Floating License

Start by checking that Modeler is set up to use the floating license.
To Check That You Are Set Up to Use a Floating License:

1. Start License Manager.

License Manager.

Windows:
2. Click Options.
3. Confirm that the Name of License Server option is selected, and the correct
server name is specified in the text box.
If Modeler cannot connect to the server on which the floating license resides, this
problem must be resolved.
For more information, see I cannot connect to the server on page 239.
If you can connect to the server, check that the Windchill Modeler License Server
service is running on the server.
To Check that the Windchill Modeler License Server Service is

Running on the Server:
1. From the Modeler server, open the Control Panel.
2. Open the Services dialog:
• Under Windows 10, in the Windows Search the Web and Windows box,
type Services, and then press the Enter key.
Administrative Tools link, and then double-click the Services entry.
System and Maintenance link, click the Administrative Tools link, and then
double-click the Services entry.
3. Right-click the Windchill Modeler License Server service, and then click Start.
If the Windchill Modeler License Server service is running, its status will be
Started.
To Start the Windchill Modeler License Server Service on the Server:

1. From the Modeler server, open the Control Panel.
2. Open the Services dialog:

type Services, and then press the Enter key.
Administrative Tools link, and then double-click the Services entry.
System and Maintenance link, click the Administrative Tools link, and then
double-click the Services entry.
3. Right-click the Windchill Modeler License Server service, and then click Start.
To Further Diagnose the License Service Connection:

Server checks:
1. On the license server computer, stop the License Manager Service:
type Services, and then press the Enter key. Double-click License Manager
Service service, and then click Stop.
Administrative Tools link, double-click the Services entry, double-click
License Manager Service service, and then click Stop.
System and Maintenance link, click the Administrative Tools link, double-
click the Services entry, double-click License Manager Service service, and
then click Stop.
2. Copy the license file you are using to the C:\flexlm folder. Change the name of
the license file in the flexlm folder to license.dat.
3. From a Command Prompt window, run the following commands.
cd C:\Program Files (x86)\Windchill Modeler\License Manager
lmgrd -c -app

cd C:\Program Files\Windchill Modeler\License Manager
lmgrd -c -app
4. This should use the renamed license file in \flexlm directory and create a log
file in that directory named lmgrd.#pid. It will also give you additional
verbose information at the Command Prompt.
5. Review the text returned to the Command Prompt window and review the
lmgrd log file for any possible issues the license service may have.
Client checks:

1. On the client computer, stop Modeler.
2. Set up the FLEXLM_DIAGNOSTICS environment variable:
• Under Windows 10, Windows 8.1, Windows 7 or Windows Server 2012,
from the Control Panel Category view, click the System and Security link,
click the System link, and click the Advanced System Settings link. Click
the Advanced tab, click Environment Variables, and then click the
appropriate New button. In the Variable Name box type FLEXLM_
DIAGNOSTICS, in the Variable Value box type 2, and then click OK.
System and Maintenance link, click the System link, and then click the
Advanced System Settings link. Click the Advanced tab, click Environment
Variables, and then click the appropriate New button. In the Variable Name
box type FLEXLM_DIAGNOSTICS, in the Variable Value box type 2, and
then click OK.
3. Start Modeler.
4. Review the diagnostic output file, which is created in the current startup
folder. For Modeler, the current startup folder is usually the Windchill
Modeler\Exe folder. The diagnostic output file is named flex<process
id>.log.
Model Explorer is Slow

This problem can be caused by bookmarking databases that are stopped or no
longer exist or cannot be contacted. Model Explorer attempts to contact the
databases that no longer exist, and in each case you will have to wait for the
connection attempt to time out. To improve performance, remove bookmarks from
databases you are not using.
To Remove a Bookmark from a Database:

2. Right-click the database for which you want to remove the Bookmark, and
then click Remove Bookmark.
Windows Message after Restarting Computer

Stating that at Least One Service Failed to Start
This Windows message may be the result of the Microsoft SQL Server service not
being installed correctly.

The Server Has Run Out of Disk Space
If your server has run out of disk space, you can try to regain some disk space by
truncating the log files. You can do this in Model Explorer by right-clicking the
database and selecting Backup ▶ Backup and Truncate Log.
You can also perform the same operation using SSMS by running the following
stored procedure on the master database:
EXECUTE spTruncateDatabaseLog <DBname>
Note
The above stored procedure works only if the log file size is greater than 2
GB. If it is, then the log file size is truncated to 64 MB.
For more information about stored procedures, refer to the following SQL Server
help topic on how to execute a stored procedure:
https://docs.microsoft.com/sql/relational-databases/stored-procedures/execute-a-
stored-procedure?view=sql-server-2017
For more information about backing up and deleting log files, see the
Administration chapter of the Modeler help.
Broker Not Found Message

This message is displayed when the Microsoft SQL Server service is not started. If
this is the case, start the Microsoft SQL Server service.
If the Microsoft SQL Server service is running, check that you have read access to
the ModelerATF share on the server. If the server is using NTFS, check that you
have file permissions.
Failed to Load Extensibility Data Message

This can be caused by the user rights to the ModelerATFiles folder on the server
not being set up correctly.
Check that the ModelerATFiles Folder is Shared Correctly:

1. On the server host, open Windows Explorer.
2. Locate the ModelerATFiles folder.
The default path is C:\ProgramData\PTC Integrity Modeler\
ModelerATF.
3. Right-click the ModelerATFiles folder and select Properties.

4. Select the Sharing tab.
5. Click Advanced Sharing…
6. Ensure that the share name is ModelerATF.
7. Click Permissions.
8. Ensure that Everyone has Full Control.
9. Click OK to close the dialogs.
Ensure that the ModelerATFiles Folder, Sub-Folders and Files are

Editable:
1. Open a Command Prompt shell.
2. Assuming a default SQL Server installation location, use the attrib
command to remove the read-only attribute on the ModelerATFiles folder,
sub-folders, and files.
attrib -r C:\ProgramData\PTC Integrity Modeler\
ModelerATFiles /d /s
attrib -r C:\ProgramData\PTC Integrity Modeler\
ModelerATFiles\* /d /s
Moniker Cannot Open File Message

This can be caused by the user rights to the ModelerATFiles folder on the server
not being set up correctly.
Check that the ModelerATFiles Folder is Shared Correctly:

1. On the server host, open Windows Explorer.
2. Locate the ModelerATFiles folder.
The default path is C:\ProgramData\PTC Integrity Modeler\
ModelerATF.
3. Right-click the ModelerATFiles folder and select Properties.
4. Select the Sharing tab.
5. Click Advanced Sharing…
6. Ensure that the share name is ModelerATF.
7. Click Permissions.
8. Ensure that Everyone has Full Control.
9. Click OK to close the dialogs.

Ensure that the ModelerATFiles Folder, Sub-Folders and Files are
Editable:
1. Open a Command Prompt shell.
2. Assuming a default SQL Server installation location, use the attrib
command to remove the read-only attribute on the ModelerATFiles folder,
sub-folders, and files.
attrib -r C:\ProgramData\PTC Integrity Modeler\ModelerATF /d /s
attrib -r C:\ProgramData\PTC Integrity Modeler\ModelerATFiles\*
/d /s
I Get Errors When Performing Long Operations on a

Very Large Model
On a very large model, transactions may time-out. This can result in a variety of
problems, including the following error message: 7171 Transaction has
timed out.
You can resolve this problem by increasing the time-out value for the database in
which the Model resides.
To increase the transaction time-out value for a database:

1. If the database in which the Model resides is running, select the database, and
then click the Stop button.
2. Start the Windows Registry Editor.
3. In the left pane navigation tree, expand HKEY_CURRENT_USER ▶ Software ▶
ARTiSAN Software Tools
4. Right-click on ARTiSAN Software Tools, point to New, then click Key.
5. Type SFC2 for the key name
6. Right-click on SFC2, point to New, and click DWORD (32–bit) Value to create a
value.
7. Type TransactionTimeout for the value name, and set it to the number
of required timeout in seconds.
8. Close the Registry Editor.

I Cannot Use Another Application at the Same Time
as Modeler
If you experience problems using an application at the same time as Modeler, this
problem may be caused by a TCP/IP port number conflict. You can view the port
numbers allocated to other applications through the SERVICES file on your
computer. You must check and review your firewall settings. For more
information, see Setting up the Windows Firewall on page 87.
I Cannot Open Models after Changing the Name of

my Computer or its Domain
If you have changed the name of your computer or its domain, you may not be
able to open models that you could previously open.
For help in resolving this problem, please contact Customer Support.

Installation of Windchill Modeler

Uploaded by

Copyright:

Available Formats

Installation of Windchill Modeler

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Installation of Windchill Modeler

Uploaded by

Copyright:

Available Formats

Windchill Modeler 9.

4 Windchill Modeler 9.5 Installation Guide

6 Windchill Modeler 9.5 Installation Guide

8 Windchill Modeler 9.5 Installation Guide

Overview of this Installation Guide

Choosing your Deployment Type

10 Windchill Modeler 9.5 Installation Guide

Server Only, Client Only, or Standalone

12 Windchill Modeler 9.5 Installation Guide

Client Only Installation

Environment Requirements for Each

14 Windchill Modeler 9.5 Installation Guide

Default SQL Server Configuration

16 Windchill Modeler 9.5 Installation Guide

While Express edition is sufficient for Standalone Windchill Modeler installations,

Windchill Modeler Client or Standalone Installation

18 Windchill Modeler 9.5 Installation Guide

Windchill Modeler Server – Workgroup Deployment:

Windchill Modeler Server – Enterprise Deployment

Microsoft Remote Desktop Services and Citrix MetaFrame

Administrator Rights Required for

20 Windchill Modeler 9.5 Installation Guide

Client Only Installations

Administrator Rights Required during Installation

The Local PTC-IM-WSU User Account

Summary of Components Installed by Default by Each Installation

22 Windchill Modeler 9.5 Installation Guide

Microsoft SQL Server

Floating License Server

Example Models and Databases

Modeler Model Editor

Windows .NET Framework and Java SE Runtime Environment

• Java SE Runtime Environment – required by XMI Import/Export. If you want

24 Windchill Modeler 9.5 Installation Guide

Individual User Deployment

Production – Workgroup Deployment

26 Windchill Modeler 9.5 Installation Guide

If only the client software is required, perform a Client Only installation in

Production – Enterprise Deployment

Installing Modeler for a Project Team

28 Windchill Modeler 9.5 Installation Guide

Orca Database Editor

Modeler Installation MSI file

30 Windchill Modeler 9.5 Installation Guide

Changing the Installation Path for Modeler

In the following example, we want to install Modeler to a folder named C:

Changing the default license server and database server instance

Other MSI properties that can be configured

32 Windchill Modeler 9.5 Installation Guide

Renaming a Modeler Computer or its

34 Windchill Modeler 9.5 Installation Guide

Access Rights Management

Modeler Client, Automation Interface and Simulation

Windchill Modeler Web Interface

36 Windchill Modeler 9.5 Installation Guide

38 Windchill Modeler 9.5 Installation Guide

To perform cross-site working it is essential to clearly identify the responsibilities

40 Windchill Modeler 9.5 Installation Guide

These are non-preferred solutions that allow you to edit remote