CADpdm Browser

CADpdm SMARTEAM Integrator for UGS NX Users Guide
CADpdm SMARTEAM Integrator
for UGS NX (Unigraphics)
Revised: Wednesday, July 09, 2008
User manual
Page 1 of 23

CADpdm SMARTEAM Integrator for UGS NX Users Guide
Overview
The CADpdm product links UGS NX and SMARTEAM provides for management of the content of
your UGS NX session as well as all interaction with the SMARTEAM vaults.
As a user, you will interact with the CADpdm Browser. This window talks with UGS NX using NX
Open and to SMARTEAM with the SMARTEAM API. This window allows you to see parts,
assemblies and drawings in both your local session as well as search results from SMARTEAM.
You can then use lifecycle functions to move this information between these locations. This
browser provides a consistent data management environment for all your CAD information.
There are several functions that are provided in the CADpdm browser.
� SmarTeam functions that establish the connection between the browser and
SMARTEAM.
� Actions you can perform on Parts, Assemblies, and Drawings in you current UGS
NX session
� LifeCycle operations to manage your data with SMARTEAM
� View information to control the amount of information displayed and to set
preferences.
� Help to display the version of the program and display this file.
Installation
Please see the Installation manual for CADpdm Integrator for specific instructions.
Page 2 of 23

CADpdm SMARTEAM Integrator for UGS NX Users Guide
Table of Contents
Installation ............................................................................................................. 2
Table of Contents .................................................................................................. 3
Overview of CADpdm Integrator ........................................................................... 4
Key Capabilities ................................................................................................. 5
Sample Use ....................................................................................................... 5
CADpdm Browser ................................................................................................. 6
Command Icons: ............................................................................................... 6
Current Session: ................................................................................................ 6
Last SMARTEAM Search Results: .................................................................... 6
Messages: ......................................................................................................... 6
Common Capabilities ........................................................................................ 6
Command Descriptions ......................................................................................... 8
Connection Icons ............................................................................................... 8
SMARTEAM Menu ............................................................................................ 8
Actions Menu..................................................................................................... 9
LifeCycle Menu ................................................................................................ 11
View Menu ...................................................................................................... 12
Help Menu ....................................................................................................... 12
Help, Preferences Form .................................................................................. 13
Save Options ......................................................................................................... 13
Delete Options ...................................................................................................... 14
Display Options .................................................................................................... 15
Debug Options (disabled by default) .................................................................... 18
Help, About ..................................................................................................... 18
UGS NX Profile Card (non-Express database)............................................... 20
Hints .................................................................................................................... 23
a. I can’t see my parts (or drawings or assemblies) ..................................... 23
b. The Viewer does not show my parts ........................................................ 23
c. Clean up of referenced files and the work directory. ................................ 23
Page 3 of 23

CADpdm SMARTEAM Integrator for UGS NX Users Guide
Overview of CADpdm Integrator
CADpdm Integrator was written to provide an easy to use connection between the users daily work
and SmarTeam. This connection is provided via a form that displays the content of the users model
file, the results of the last search of SmarTeam information, and a status window.
Page 4 of 23

Key Capabilities
CADpdm SMARTEAM Integrator for UGS NX Users Guide
1. Establish the connection between CADpdm, UGS NX, and SMARTEAM
2. See objects (UGS NX Parts, Assemblies, and Drawings) and manage the local session
files.
3. Assign Attributes to objects (automatically or done by user)
4. Make objects known to SMARTEAM
5. Perform LifeCycle operations on those items.
Sample Use
1. Start UGS NX
2. Click on SmarTeam, Run CADpdm...
3. Connect to SMARTEAM
4. Switch to UGS NX (Click on Back to NX icon), then Create a part
5. In the CADpdm browser window, select the part in the Current Session window
6. Select Save to define the Metadata (attributes) for the part
7. Select Check-in to move the part into the SMARTEAM Vault
8. Select Find Object, then UGS NX, then run. Then select the object you just checked in
from the Search Result window and finally Check Out. Now your part is back in the current
session and ready to be changed.
Page 5 of 23

CADpdm SMARTEAM Integrator for UGS NX Users Guide
CADpdm Browser
The CADpdm Browser window has several components
Command Icons:
These are icons for the functions that are provided in the pull down menus are well.
Current Session:
Displays all of the parts, assemblies and drawings that are open in your current CAD
session.
Last SMARTEAM Search Results:
After each search, the results are displayed here so you can select the data to operate on.
Additional options allow the filtering of the results by type and only show latest revision.
Messages:
This window provides feedback on various operations and any issues that may have arisen.
You can use the Save button to create a file that can be sent to your support staff for
assistance.
Common Capabilities
Command Icons
CAD data in Current Session
� Click on a field heading to sort on that information.
� Click and drag on a field to rearrange the display order.
� If you want to change what fields are displayed and the order of the
display within the XML configuration file.
Page 6 of 23
Results of Last SMARTEAM search
Messages and Information

CADpdm SMARTEAM Integrator for UGS NX Users Guide
� Text or Icons can be displayed for status messages. Please see the XML
configuration file for details.
Page 7 of 23

CADpdm SMARTEAM Integrator for UGS NX Users Guide
Command Descriptions
Connection Icons
Click the Activate icon to connect SmarTeam and CADpdm so that UGS NX files can be managed.
After Activation, you can either de-activate or launch the SmarTeam editor.
SMARTEAM Menu
The SMARTEAM Menu also has entries to control the connection to SMARTEAM. In addition the
Find options are available. These link to standard SMARTEAM search capabilities.
Page 8 of 23

Actions Menu
CADpdm SMARTEAM Integrator for UGS NX Users Guide
The Actions menu consists of several basic functions:
� Refresh updates the Session window in case information appears to not be up to
date.
� Save makes the selected objects known to SMARTEAM
� Objects with no children become Parts
� Objects with drawings are considered drawings.
� Objects with children are considered Assemblies
� Save As… saves the file with another name, to make a local copy.
� Design Copy will create a shallow copy (that is only the top level) of the selected
objects. There is no link created back to the original objects.
� This uses the UGS NX function Clone to create the new objects.
� Blank and Unblank operate the same as the UGS NX functions on assembly
components only
� Make Work Part is a quick way to isolate the selected object from the CADpdm
browser.
� Get a Reference creates a Read-Only local copy of the selected Object from the
Search Results window.
� Clean Up… will open an additional form and help you to remove files that could
cause the user confusion if left in the work area. The form that is displayed shows
the contents of the current session:
Page 9 of 23

CADpdm SMARTEAM Integrator for UGS NX Users Guide
You should close all open parts in UGS NX first, then run the clean up command. Clean up will
perform the following actions:
� Remove All from CAD session will clean up the relationships between
SMARTEAM and the current files that are open in your UGS NX session.
� Remove the “.prt” files from your working directory. Since they are managed by
SMARTEAM this is not an issue and should be considered house-cleaning or best
practices.
� Undo checkout will release the check-out lock on the selected objects. This is very
useful when you decide you have started down a design change path that is no
longer of value.
Page 10 of 23

LifeCycle Menu
CADpdm SMARTEAM Integrator for UGS NX Users Guide
� Update checks if any of the selected objects in the Session window is out of date
and retrieves a new version from the SmarTeam vault is a new version is available.
� CheckOut and Update not only updates the selected object, but also Checks it
Out for modification.
� New Release and Update will create a new release of any item that requires
update.
� Check In creates a new object in SMARTEAM and locks the item type.
� A Part is the default type. All UGS NX files are assumed to be parts unless
one of the following situations is true.
� A UGS NX file is considered a Drawing if there is a drawing associated
with it. This is only true of the drawing is present before the Part is
checked in. Once a Part or Assembly has been checked in, it remains that
type even is a drawing is later added.
� A UGS NX file is considered an Assembly if there are any children of the
parent part. Once the part has been checked in, it remains a part even if
children are added to the file.
� Release changes the status of the selected object and changes the revision value.
You have the option to keep check out (which will create a new revision. For
example Releasing a.4 with keep check out will create b.0 in your current session)
� Check Out retrieves the selected object from the vault and creates the new
revision in your current session. This also locks the object so that only you can
make changes to this revision.
� New Release will create a new release and revision for the selected object. For
example if the vault contains revision b, then selecting New Release for that object
will create c.0 in your local session file.
Page 11 of 23

View Menu
CADpdm SMARTEAM Integrator for UGS NX Users Guide
The view menu contains filters for the basic object types. The Preferences form contains important
options.
Each filter turns on and off the display of those objects in the session and search results windows.
This can be useful to quickly find a single object like a drawing among a lot of parts and assemblies.
The Messages and Last SMARTEAM Search checkboxes let the user choose to display or not the
Messages and SMARTEAM Search windows.
Help Menu
Page 12 of 23

CADpdm SMARTEAM Integrator for UGS NX Users Guide
Help, Preferences Form
Save Options
� Batch Mode Save will save the parent object and all children. It is important to
understand the rules that will be applied for Name and Number conventions before
using this option. BatchModeSave default="0"
� Show Project Manager Dialog will prompt for the Project to associate each object
with during the Save or Check In procedure. Remember to click the “Link to
Projects” option to create the links between the object and the project.
ShowSaveDlg default="1" (recommend also Hidden="1" to require all objects to be
associated with projects)
� Show Save Results Screen will display a SMARTEAM form outlining all of the
objects that were created during a check-in, release, or save operation. Typically
this information is not needed as any errors will be displayed before this form
appears. ShowSaveResults default="0"
� Create Drawing Objects. If checked, then a drawing object will be created
whenever a Top level assembly contains a drawing at initial check in.
UseDrawings default="1"
� Suppress Attribute Case Sensitivity is a very special option that should only be
set by the system administrator. This is only used in specific data model situations.
Default is to hide this choice and have it disabled.
� Part, Assembly and Drawing Visualization Format can enable the creation of a
Page 13 of 23

Delete Options
CADpdm SMARTEAM Integrator for UGS NX Users Guide
light weight file to be displayed in SMARTEAM Viewer (vrml, jt for Parts and
Assemblies, cgm, jpg for Drawings.)
The Delete options are self-explanatory and reflect SMARTEAM practices.
Page 14 of 23

Display Options
CADpdm SMARTEAM Integrator for UGS NX Users Guide
� Only show latest version filters the information in the search window to a
minimum. On occasion, it can be useful to see additional versions of an Object.
Simply toggle this item to change the display. ShowOnlyLatestVersion default="1"
� Clear Search Results sets the display so that when a search is performed, the
search window will clear after each operation so that out of date information is not
displayed. If you prefer to see this information retained toggle this option off. You
can also use Actions, Refresh to close the search window when you are done with
it. AlwaysClearSearchResults default="1"
� The Show the SMARTEAM window toggle helps reduce the amount of clutter on
the screen. For most operations, you can perform the functions you need from the
CADpdm browser form. When this option is toggled ON, then you will not see the
SMARTEAM form, but only the results in the browser. If you toggle this OFF, then
you will see the standard SMARTEAM forms in response to all queries.
ShowSmarteamSearchResults default="0"
� Highlight selected items in CAD will help identify the item you have selected in
the browser in the CAD system. This can be helpful in complex displays.
HighlightInCAD default="1"
� Apply Filter to Top Level Only controls how the part/drawing/assembly filter is
applied to the display. The following images will help to explain this option.
Page 15 of 23

CADpdm SMARTEAM Integrator for UGS NX Users Guide
In this image all entities are shown and the Apply Filter option does not affect the
display. If we click the part filter, then the display will appear as follows:
Next, if we check the Apply Filter option, then children of the assembly will be
displayed.
Page 16 of 23

CADpdm SMARTEAM Integrator for UGS NX Users Guide
Page 17 of 23

CADpdm SMARTEAM Integrator for UGS NX Users Guide
Debug Options (disabled by default)
If the Debug Option tab has been enable in the STUG.XML file, then the following tab will be
available.
This information is intended for use by the system integrator, system administrator or other person
working with development resources. This should be disabled for general users (default condition).
• Dump General Debug Messages displays log messages for all actions.
• Dump Object Attributes displays the CAD and PDM values of the attributes each
time an object is selected.
• Dump Merge Attributes displays the SmRecord structure used to run a query for an
object from SMARTEAM.
• Dump PDM Record dumps object attributes before and after the call to
mergeAttributes (the method that updates CAD-driven and PDM-driven attributes)
• Dump Viewer File Creation Log displays messages during the creation of light
weight viewer files.
• Use Debug File will capture information that would normally go to the message region
in a file. Used in batch mode.
Help, About
Page 18 of 23

CADpdm SMARTEAM Integrator for UGS NX Users Guide
This form will display the current version of the product. This information is helpful when talking to
technical support.
Page 19 of 23

CADpdm SMARTEAM Integrator for UGS NX Users Guide
UGS NX Profile Card (non-Express database)
Page 20 of 23

CADpdm SMARTEAM Integrator for UGS NX Users Guide
Page 21 of 23

\
CADpdm SMARTEAM Integrator for UGS NX Users Guide
Page 22 of 23

Hints
CADpdm SMARTEAM Integrator for UGS NX Users Guide
a. I can’t see my parts (or drawings or assemblies)
Make sure that your filters are all active so they are displayed.
b. The Viewer does not show my parts
Check the customization and make sure that the correct viewer parameters are set. Both JT
and native file viewing is supported but the file extension the viewer is looking for must
match the desired file type (native .prt or .JT)
c. Clean up of referenced files and the work directory.
If you get files for reference, they will be left in the Elysium/work directory. Once you are
done with your session, please make sure to check-in any files that you wish to keep. Then
you can delete all of the files in the work directory.
It is important to remember to use SMARTEAM to manage your files and not to try and
keep track of them yourself at the operating system level. We recommend that you make it
a habit to clean up the work directory on a regular basis.
Some situations may arise where SMARTEAM has data checked out and you have deleted
the file from the work directory. You will need to work with your SMARTEAM
administrators to develop best practices to prevent and resolve these issues.
Use the Clean Up command in the Actions menu to get rid of files and relationships that are
no longer useful.
Page 23 of 23