WINDCHILL® INTEGRATION

Freeform Add-On

User Guide
February 3rd, 2020
Freeform Windchill Add-On 3D Systems February 3, 2020

Contents
Introduction to Freeform’s PTC Windchill® Add-In ............................................................................................... 3
What is Windchill®............................................................................................................................................. 3
Understanding the Three Types of Windchill Repositories .............................................................................. 4
What are the purposes of each Windchill repository? ................................................................................. 4
Understanding File Repositories and File Activities within Windchill............................................................... 5
The Commonspace (shared) vs. your Server Workspaces (personal) .......................................................... 5
Process flow for file management when using Windchill Functions ............................................................ 5
Getting Set Up on your Workstation .................................................................................................................... 6
Tools>Options ................................................................................................................................................... 6
Turning on the PTC Windchill PDM Features ................................................................................................ 6
Windchill Related Preferences ...................................................................................................................... 6
Establishing a Server Connection ...................................................................................................................... 8
Creating a Server Workspace............................................................................................................................ 9
Why you need to make a Workspace on the Server .................................................................................... 9
Using the Browser View to Setup your Workspace ...................................................................................... 9
Create a Workspace on the Server ............................................................................................................. 10
Adding files from the Commonspace to the Workspace ............................................................................ 12
Starting a Project in Freeform............................................................................................................................. 13
Activating a Workspace .................................................................................................................................. 13
Windchill Functions in Freeform ......................................................................................................................... 14
Overview of the Windchill Menu Tab Functions: ........................................................................................... 14
1_Connect to Server ................................................................................................................................... 14
2_Disconnect .............................................................................................................................................. 15
3_Open Server Browser .............................................................................................................................. 15
4_Open Local File Cache ............................................................................................................................. 15
5_ Activate Workspace ............................................................................................................................... 16
6_Sync Workspace ...................................................................................................................................... 16
7_Check-out ................................................................................................................................................ 17
8_Undo Check-out ...................................................................................................................................... 17
9_Check-In .................................................................................................................................................. 18

1|Page
Freeform Windchill Add-On 3D Systems February 3, 2020

10_File Info ................................................................................................................................................. 18

11_Upload File ............................................................................................................................................ 18
12_Upload Files (plural) .............................................................................................................................. 19
File Creation and Saving.................................................................................................................................. 20
Windchill Icons Key: ........................................................................................................................................ 21
Making a Pseudo Windchill Dashboard, hotkeys, and more…. .......................................................................... 22
Standard or Custom Options for Working with Windchill .............................................................................. 22
Customizing your access to the Windchill functions: ..................................................................................... 23
Making a Pseudo Windchill Dashboard ...................................................................................................... 23
Making a Quick-Access Menu for Windchill ............................................................................................... 24
Creating Hotkeys ......................................................................................................................................... 25
Schematic Diagrams for File Functions ............................................................................................................... 26
File System Overview ...................................................................................................................................... 26
Freeform Check-In: ......................................................................................................................................... 27
File Check-Out ................................................................................................................................................. 28
Freeform Undo Check-Out.............................................................................................................................. 29
Web Browser – Add to Workspace ................................................................................................................. 30
Web Browser – Check-out .............................................................................................................................. 31
Web Browser – Check-In................................................................................................................................. 32
Additional Resources .......................................................................................................................................... 33

2|Page
Freeform Windchill Add-On 3D Systems February 3, 2020

Windchill Integration in Geomagic Freeform®

Introduction to Freeform’s PTC Windchill® Add-In

Welcome to Freeform’s Windchill Integration Add-On. This document will provide an overview of the things
you will need to know to get up and running with the new Windchill integrated features and functions.

What is Windchill®
Windchill is a data management system (PDM). It can track and manage file iterations from creation to
product release. Acting like a central repository, it tracks file status and versioning, manages attributes and
associations, and controls the check-in/check-out processes needed for effective control of an organization’s
data.
While Freeform does not provide deep integration using the Workgroup Manager found in PTC Creo®, a very
similar interface has been provided for Freeform designers which supports the same fundamental Windchill
file management functions from within Freeform, including file status reports upon query, as well as browser
based access to the server for viewing and managing user workspaces and files on your organization’s
Windchill Server.
It is suggested that Freeform designers have the Browser view and the Freeform workspace open at the same
time--each on a different monitor—to have a helpful live view of the file repositories on the Windchill server
while working.

Release Notes:
The new Freeform integrated Windchill Connector Add-On is designed to be compatible with Windchill v11.0.

3|Page
Freeform Windchill Add-On 3D Systems February 3, 2020

Understanding the Three Types of Windchill Repositories

There are three basic Windchill repositories that you will be working with as you design within the Windchill
PDM system: the Commonspace, server-side User Workspaces, and the Local Workspace Caches that contain
the in-progress files on your computer.

What are the purposes of each Windchill repository?

Commonspace: This is the network vault for the Windchill file control system. It is a commonly accessible
repository where files are checked-in and checked-out when they are being managed under the Windchill
data management system (PDM).

Server Workspaces: Workspaces are sandbox spaces which you set up for yourself on the Windchill server.
Similar to a folder, you can give them a name based on the project it will contain. As you work, you can
upload, download, and sync files between your local and server workspace caches.

Local Workspace Cache: The first time a server workspace is activated from within Freeform, an equivalently
named local file repository is automatically created on your computer as a digital twin. When activated, it is
the place where pending work will be saved and retrieved. Having a workspace per project allows for an
easy way to transfer files to and from the server while at the same time keeping files logically organized.

4|Page
Freeform Windchill Add-On 3D Systems February 3, 2020

Understanding File Repositories and File Activities within Windchill

The Commonspace (shared) vs. your Server Workspaces (personal)

The Commonspace is the database of all files under document control within the Windchill context you are
associated with within your organization (i.e. your design department). These are files you have access to for
check-out, and where your files will be vaulted to on check-in.
A workspace is a personal space you can create for in-progress work. You can think of these as project related
sandboxes. Additionally, any files in the Commonspace that you might want to reference or modify can be
added to a workspace and downloaded to your computer.
It is also worth noting that you can have more than one workspace (sandbox) if you have multiple projects
underway simultaneously.
Reference: PTC Support: Using Windchill Workspaces

Process flow for file management when using Windchill Functions

Reference: The following link is a valuable resource found on the Windchill Help Center website’s section for
learning about basic file control functions in Windchill: Managing CAD Data.

5|Page
Freeform Windchill Add-On 3D Systems February 3, 2020

Getting Set Up on your Workstation

Tools>Options
Turning on the PTC Windchill PDM Features

The Windchill features can be turned ON/OFF in Tools Options. To access the Windchill Preferences go to
the Tools Menu>Options>General>PTC Windchill.

Windchill Related Preferences

1. □ Windchill Enabled: This option needs to be checked to enable the Windchill related UI to be
exposed inside of Freeform. Note that the application needs to be restarted for activation changes to
take effect. Also, a Windchill Add-On license is required to activate these features in Freeform.

2. Windchill local file cache: The Local Windchill file Cache repository is where your managed files will
be stored on your workstation. Click on the browse button to change where your Windchill Local
Workspace Cache(s) will be stored.

• Manage Local Cache: This button will open the location where the local data is being stored

6|Page
Freeform Windchill Add-On 3D Systems February 3, 2020

3. Upload Visualization: This dropdown provides options for specifying the type of visualization
attachment that will be attached to a file on Check-In or Upload. The visualization attachment
enables the ability to preview the file on the server.

 None: No visualization file will be attached to uploaded with files

 2D Image: (Default) Uploads a JPEG file screenshot as an attachment for visualization
 3D PDF: * Uploads a pre-created 3D PDF file as a file attachment for visualization
 2D Image and 3D PDF: Uploads both a JPEG and a pre-created 3D PDF attachment
*Note: 3D PDF files take time to generate. It is recommended that its upload not be the default option specified
for visualization. It is advised that 3D PDF file upload be handled as a periodic manual choice on the final Upload
of the day or at the end of a design phase. To use this option, the file must be created in advance, named
equivalently to the parent [*.cly] file, and saved in the local workspace cache.

4. Check-in files on Upload: There are three options in this sub-menu. Never is default, with the
assumption that Check-In will be a periodic task…and Upload, as a backup action, will happen much
more frequently.

 Ask
 Always
 Never (default)

5. □ Prompt to choose file system on Save As: Checked by default. The choices will be Windchill or
Standard. The latter allows you to work on files not intended for document control, such as Freeform
tutorial and training guide models, R&D, etc.

6. □ Prompt to check-out files on open: (Checked by default)

7. □ Use auto-numbering for file name: (Checked by default)

7|Page
Freeform Windchill Add-On 3D Systems February 3, 2020

Establishing a Server Connection

The connection to your company’s Windchill server can be established from within Freeform by signing in to
the Server using the credentials assigned to you by your system administrator.

After clicking the “Connect” button, the following temporary message will be displayed:

If at any time during the Freeform design session you wish to confirm your server connection is still live, look
for the server path listed next to the “Disconnect” option under the Windchill Menu tab:

8|Page
Freeform Windchill Add-On 3D Systems February 3, 2020

Creating a Server Workspace

Why you need to make a Workspace on the Server

Before you can do any Windchill integrated work in Freeform, you will need to create a workspace for your
current project on the Windchill Server. This will function as your working repository on the server to which
you can upload project files, and to which you can add files from the Commonspace should you wish to later
access them from within Freeform, whether for reference or for modification.

Using the Browser View to Setup your Workspace

All workspaces are initially created on the Windchill Server. This can only be done through a browser
window. Begin by accessing the Browser View feature in Freeform to access your organization’s Windchill
server interface. Once there, you can create and manage your server workspaces and see the files in the
Commonspace.
Click on the “Open Server Browser” option on the Windchill menu tab in Freeform or on the Windchill Palette
at the top of the palette stack on the left side of the Freeform workspace.

This will open a browser and connect you to the Windchill PDMLink interface on your company’s Windchill
server. Use the Windchill PDMLink log-in screen to provide your user name and password.

9|Page
Freeform Windchill Add-On 3D Systems February 3, 2020

In the browser window, click on the vertical Browse button on the left.

Select the Workspaces section under your Product context. Here is where you can create and manage your
personal server workspaces.

Create a Workspace on the Server

To create a new workspace, click on the New Workspace icon in the My Workspaces menu bar (the yellow
starburst):

10 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

You can have more than one workspace/sandbox if you have multiple projects underway simultaneously.

11 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Adding files from the Commonspace to the Workspace

Use the Add to Workspace function on the Windchill Server interface to add files to your Server Workspace
from the Commonspace.
This is done from the Folder section (instead of the Workspace section), which will display the contents of the
Commonspace. Adding a file from the Commonspace to a Workspace makes Commonspace files available to
Freeform.

With this potentially being the first time your organization is using Windchill PDM with Freeform, it is possible
that there won’t yet be any Freeform files in the Commonspace.

Reference: PTC Support: Using Windchill Workspaces

12 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Starting a Project in Freeform

Activating a Workspace

Once a workspace for your project has been created on the server, you are ready to begin a project in
Freeform. The very first step is to activate the project workspace you just created.
Use the Activate Workspace option under the Windchill Menu tab or on the Windchill Palette to activate a
workspace and begin working on your design project.
A check mark is shown next to the currently active workspace whenever this dialog is opened.

13 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

At any time while you are working, you can confirm the name of the currently active workspace by clicking on
the Windchill Menu tab, and referencing the workspace name listed after the Sync:

Now you are ready to start designing and using Windchill file management features.

Windchill Functions in Freeform

Overview of the Windchill Menu Tab Functions:

The primary way to access the Windchill functions is from the Windchill Palette (at the top of the Palette
stack on the left side of the Freeform workspace). Functions can also be accessed under the Windchill Menu
tab (found on the top menu bar after the Help menu).
Note: The Freeform Quick-Access menu (Spacebar) and Hotkeys can provide even faster tool access and
workflow efficiency for Windchill functions.

1_Connect to Server

The first step in a Freeform session is to connect to your company’s Windchill Server.

14 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

2_Disconnect

An option to disconnect from the server connection is also provided.

3_Open Server Browser

This option is provided for an easy access to the Windchill server interface. Upon selecting the option, a
browser window will open to access the Windchill server’s portal. On entering your Username and Password,
you will have access to the Server View.

4_Open Local File Cache

This function lets you see the contents of the local directory for currently active Windchill Workspace.
Note: You may need to activate a workspace first.

15 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

5_ Activate Workspace

Assuming you are now connected to your company’s Windchill Server (step 1 above), before starting to
work on a project in Freeform, you must begin by activating a workspace.

6_Sync Workspace

Use the Sync Workspace found in the Windchill palette in Freeform to download, re-download, and
optionally update some or all of the files in the active Server Workspace to your Local Server Workspace
cache.

16 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

7_Check-out

This function, when invoked from the Windchill Menu in Freeform, enables you to Check-Out the
currently loaded file in Freeform (one previously downloaded from the Server).
Once the Check-out process is complete, and the file is reloaded into Freeform, there will be a checkmark
next to the Windchill Menu Tab to indicate the file is Checked-Out.

8_Undo Check-out

This function, will release the check-out status of the document loaded in Freeform.
This will relinquish the file back to the Commonspace (keeping its original state), and also will restore the
document in the Server Workspace and Local Workspace Cash to its original state, and lock the local copy of
the file since it is no longer checked out.

17 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

9_Check-In

Use this function to Check-in the currently open file to the Commonspace.
This will: Save, Upload, Check-In, and then lock the local copy of the file since it will no longer be checked out.
(See the file function process flow diagrams at the end of this document.)

10_File Info

Use this button to view general file control and status information about the currently open file.

11_Upload File

Use the Upload action when you want to upload the currently open [*.cly] file to the Server Workspace
Cache. This can be a modified file, or a new file. This adds or updates the file to the server cache, but does
not check it in…providing a way to back up your recent work while the file is under construction.
To enable file preview on the server, every uploaded file will be accompanied by auto-generated 2d or 3d
visualization files as specified in Tools>Options>General>Windchill (discussed on page 6-7 of this manual).
Note that 3D PDF files take time to generate. Because of this, it is recommended that 2D visualization be the
chosen Upload preference in Options, and that 3D PDFs be uploaded only periodically, as an alternative
upload choice at the end of a design phase.

18 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

12_Upload Files (plural)

This function is useful for adding a set of new files to the Windchill Server. This bulk operation is not
commonly used, but can be helpful when needing to add a lot of new files to the server at once.

Choosing “Upload Files” will open a File Explorer window. From amongst the [*.cly] files shown in the local
workspace cache, select those that you would like to be uploaded to the Server Workspace Cache.

Visualization images are used to preview the files when viewed on the server. Unlike the single file upload
function, a bulk upload will not be able to generate new or updated visualization images to accompany the
file upload; however, any manually created 3D PDF with the proper naming protocol will be included
automatically.

Notes on other file attachments:

Only [*.cly] files can be Uploaded from within Freeform at this time. Other related project files, like [*.stl] or
[*.igs], may be directly added to your server workspace cache from the Browser view of the Windchill Server
Interface.
Files in the local workspace cache that have not been checked-out or modified will be omitted from the batch
upload function.

19 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

File Creation and Saving

Files created in Freeform need to be saved in the Local Workspace cache while you work. From time to time
you may wish to Upload the file to the Server Workspace to have a backup version in your Server Workspace
Cache.
New files can either be created from scratch or opened from another personal or work directory, and using
Save-As it can be added to your Local Windchill Workspace Cache (to later Check-In to Windchill, or just use
as source material for your model).

Files must have unique names. This can be achieved using your own text based name, or by using the auto-
generated numbering scheme provided in the Save Dialog. Auto-numbering is “on” by default, so if you
prefer to name your files yourself, you can uncheck this option, or permanently turn it off in Tools>Options.
The currently active workspace name is noted at the top of the dialog. Also, the dialog provides the option to
save outside of the Windchill file system if you pick the “Standard File System” option.

20 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Tip: Be sure to take advantage of Freeform’s File compression function when you save files to the server:

Windchill Icons Key:

Windchill icons are used for Quick Access to Windchill functions through the Windchill Palette, and also when
functions are added to the Favorites Palette or the Spacebar Quick Access menu.

21 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Making a Pseudo Windchill Dashboard, hotkeys, and more….

Standard or Custom Options for Working with Windchill

22 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Customizing your access to the Windchill functions:

In addition to the default menu and palette, you have several additional options for optimizing accessibility to
Windchill Functions. This includes palette options, custom menus, and hotkeys.

Making a Pseudo Windchill Dashboard

Any palette on the left side of your workspace can be torn-off to be floating. This can be particularly useful
for the Windchill functions, as a torn-off palette can be extended to form a single row, and serve as a handy
Windchill Dashboard when placed in the Upper Right corner of your workspace (or lower left if you are left-
handed. Just drag the palette by its title bar to tear it off, and resize and place as desired.

23 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Making a Quick-Access Menu for Windchill

The Quick-Access menu, aka “Spacebar” menu, is a custom menu you can make for yourself. Defining the
contents of this menu is done under ToolsMenu>Customize>FavoritesList.
Column and separator commands can be used to add meaningful formatting to the menu.

Once defined, a simple press of the spacebar on your keyboard will display the Quick-Access menu directly at
your tooltip, wherever that may be, making it easy to quickly access your favorite functions.
Using the commands entered above, the results are the menu shown below:

24 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Creating Hotkeys

25 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Schematic Diagrams for File Functions

File System Overview

26 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Freeform Check-In:

27 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

File Check-Out

28 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Freeform Undo Check-Out

29 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Web Browser – Add to Workspace

30 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Web Browser – Check-out

31 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Web Browser – Check-In

32 | P a g e
Freeform Windchill Add-On 3D Systems February 3, 2020

Additional Resources

• More detailed information on creating products and access permissions are explained on
the PTC support website: Windchill Help Center .

• Under “Integration with Other Applications” is a section on Managing CAD Data. This is great
resource on the basic file control functions in Windchill: Managing CAD Data.

33 | P a g e