Teamcenter Integration For Solidworks Installation Guide For Dispatcher Services
Teamcenter Integration For Solidworks Installation Guide For Dispatcher Services
TranscenData
A Business of International TechneGroup Incorporated
DuPont Circle
Milford, Ohio 45150
ITI PROVIDES THIS PROGRAM AS IS AND WITH ALL FAULTS. ITI SPECIFICALLY
DISCLAIMS ANY IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A
PARTICULAR USE. ITI DOES NOT WARRANT THAT THE OPERATION OF THE
PROGRAM WILL BE UNINTERRUPTED OR ERROR FREE.
i-Man® is a registered trademark of UGS Corp.
Siemens and the Siemens logo are registered trademarks of Siemens AG. UGS, Teamcenter and
UGS Teamcenter are trademarks or registered trademarks of UGS or its subsidiaries. This
software and related documentation are proprietary to UGS Corp. ©2013 UGS Corp. All rights
reserved.
This program contains software licensed from UGS Corp. ©2013 UGS Corp. All Rights
Reserved.
i
Contents
Introduction...............................................................................................................................1
Assumptions ..............................................................................................................................1
Configuration steps ...............................................................................................................2
Install the Teamcenter translation services ...............................................................................2
Grant BVR Modify access to the Proxy User ...........................................................................2
Verify basic Dispatcher functionality ......................................................................................2
Install the Teamcenter Integration for SolidWorks client .........................................................3
Install and verify the SWToJT translator .................................................................................3
Configure the Dispatcher Server ..............................................................................................4
Configure the SWToJT translator ........................................................................................5
Modify the module server’s classpath ..............................................................................5
Modify translator.xml ......................................................................................................5
Modify Integration configuration swtojt.bat file ...............................................................6
Configure the SWToDXF translator ....................................................................................6
Modify translator.xml .....................................................................................................6
Modify the integration’s swim.xml file ............................................................................7
Verify the Dispatcher Server services ......................................................................................7
Configure the Dispatcher Client ..............................................................................................9
Install CORBA services ........................................................................................................10
Optional: Configure the SolidWorks Integration to submit Dispatcher tasks. ....................... 10
Optional: Configure the previewservice post-processor to generate JPG files .......................11
Enable the previewservice post-processor ..........................................................................11
Configure the previewservice to create JPEG files .............................................................12
Configure the previewservice executable ...........................................................................13
Troubleshooting ......................................................................................................................13
ii
Introduction
This guide describes how to configure Dispatcher translation services for SolidWorks data. The Teamcenter
Integration for SolidWorks supports two translators:
• SWToJT: For translating parts and assemblies, including configurations, to the DirectModel (JT)
format.
• SWToDXF: For translating SolidWorks drawings to the DXF format.
Path delimiter characters (‘\’ and ‘/’) should be entered following the existing entries in configuration files and
following the examples in this document.
Important: Dispatcher translation is supported by a complex set of interrelated, yet independently developed
and supported products. Each of these products must work without errors in order for translation to succeed.
These independent products are:
Assumptions
• The software is being installed on a Windows platform. If you are installing the software on a supported
UNIX platform, you must replace the Windows-specific syntax in the examples with the equivalent
UNIX syntax.
• Only one instance of the SolidWorks software is installed on the module server. Sites with multiple
SolidWorks installations must use fully qualified paths and settings so that the SWToJT and
SWToDXF translators will find only one set of SolidWorks executables and configuration files.
• These instructions are only written and validated for Teamcenter, not Teamcenter Express. It is
assumed that, as a derivative of Teamcenter, Teamcenter Express does not have issues which would
prevent a customer from using the Dispatcher translation services for SolidWorks.
1
Configuration steps
Install the Teamcenter translation services
The Teamcenter translation services must be installed and operational. These are called Dispatcher Server and
Dispatcher Client. The installation procedure for these services is documented in the Teamcenter install guide.
2
Figure 2: Verifying basic translator functionality
Additional configuration may be required to set FMS_HOME, create Access Manager rules to grant the
necessary level of access to the Dispatcher Services proxy user, and other tasks. These additional configuration
steps are beyond the scope of this document; please refer to the appropriate Teamcenter manual(s) for details.
This client is used only for Dispatcher translation; it must not be used for interactive CAD data management or
bulk import/export operations. It must be maintained in a stable configuration because several of its executable
and configuration files are used to control the behavior of the SolidWorks translation processes.
3
Figure 3: Verifying the SWToJT translator
DC_HOME The Dispatcher Root directory of the Dispatcher Server and Client software
SWIM_DIR The installed location of the Teamcenter Integration for SolidWorks client
1
For the sake of simplicity, it is assumed that a single Scheduler and a single Module server are installed. In reality, several instances
of each service can be installed on the same, or different, server hosts, for load balancing purposes. It is assumed that the Teamcenter
Administrator understands how to extend these instructions as needed for more distributed environments.
4
Configure the SWToJT translator
Modify the module server’s classpath
set classpath=%classpath%;%HOME%\lib\activation.jar;%HOME%\lib\fileserver.jar
set classpath=%classpath%;%HOME%\lib\log4j-1.2.13.jar;%HOME%\lib\logwriter.jar
set classpath=%classpath%;SWIM_DIR\swjt\swtojt.jar
Modify translator.xml
<!DOCTYPE Translators[
<!ENTITY MODULEBASE " d:\Module\">
<!ENTITY JAVABIN "G:\TEAMCE~1\install\install\jre\bin">
<!ENTITY IDEAS "C:\UGS\IDEAS12">
<!ENTITY ORBIX "C:\ORBIX\Iona\asp\6.1\lib\">
<!ENTITY PROJTRANS "d:\ProjTrans">
<!ENTITY PT_JFV "_8000.0.0">
<!ENTITY UGSPKG "com.teamcenter.translator.ugs.">
<!ENTITY WRAPPER "com.teamcenter.tstk.server.translator.ugs.">
<!ENTITY EAIWRAPPER "&WRAPPER;EaiTranslator">
<!ENTITY SWTOJT "com.transcendata.swimsoa.ets.transwrapper.SWToJt">
]>
2. Find the <swtojt> service tag and set or change the following values as shown in bold:
3. Set the path to the translator’s configuration file, and add the inputdir option, if it does not already
exist, as shown below in bold.
<Options>
<Option name="configfile" string="-z" value="TRANSLATOR_HOME\etc\tessSW.config"
description="Path to the config file"/>
<Option name="outputdir" string="-o" description="Full path to the output directory."/>
<Option name="inputpath" string="" description="Full path to the input file."/>
<Option name="inputdir" string="" description="Full path to the input directory."/>
</Options>
set TRANSDIR=TRANSLATOR_HOME
Note: Ensure that the translator’s executable file, Swtojt.exe, is present in the TRANSLATOR_HOME
location. TRANSLATOR_HOME is the full path to the SolidWorks to JT translator installation.
Be sure to replace SWIM_DIR with the full path to the SolidWorks integration client.
2
In this example it is assumed that the previewservice will not be used to create JPG files from the JT files. Full instructions for
configuring the translator to use the previewservice are provided below, in the optional configuration section
6
Modify the integration’s swim.xml file
Edit the SWIM_DIR\swim.xml file and add the following entries to the auxiliary_file_map:
Optionally, the Integration can be configured to generate and import any 2D output file types that can be
exported from a SolidWorks drawing. Some examples of these types are PDF, TIFF and JPG. To achieve this,
auxiliary_file tags that define the generate command for the desired viewables should be added. For example,
to generate PDF files as part of DXF translation, and to attach the PDF files with the IMAN_Rendering
relation, the following auxiliary_file tag should be added to the auxiliary_file_map:
To create and save TIF files as IMAN_specifications of Item Revisions, add the following auxiliary file
definition:
The system can be configured to generate and save additional file types, following these examples.
When started this way, the services will run in a console window on the server’s desktop, allowing you to see
informative messages as translations are processed. Once correct and reliable translation is verified, these
processes can be restarted as Windows services (if configured as services during or after TEM installation).
7
When the Module Server is started as a Windows service, ensure that the Allow service to interact with
desktop option is turned on, otherwise the translator cannot start SolidWorks.
Once the services are running, start the Admin Client by double-clicking the runUI.bat file in the
DC_HOME\AdminClient\bin directory. Log into the Admin Client (no password required), then submit a
translation request for a SolidWorks part. To submit the request, select the swtojt translator from the drop-
down list, then navigate to select a CAD file of the appropriate type. The following shows an example of a
SolidWorks part translation:
8
Figure 5: Submitting a SWToJT task from the Admin Client
Successful translation is confirmed by a message in the Admin Client’s status window, as shown below:
When using the Admin Client, be sure to submit only standalone parts. These are self-contained CAD models
which have no dependencies on other files. Assemblies and drawings with dependencies to other models will
not work, because the Admin Client is not aware of the integration data model and will not copy additional
dependencies to the staging directory. This additional work is done by the Teamcenter Integration for
SolidWorks when an on-demand request is submitted to the Dispatcher Client.
import TSBasicService,....,TSQSearchServices,TSSWService
A translation request can be generated on demand, by selecting a dataset in Teamcenter and selecting
Translation → Translate from the menu bar. Or, the integration clients can be configured to automatically
submit parts, assemblies and drawings for translation each time these models are saved to Teamcenter as new
versions or new revisions. This is documented in the section below titled Configure the SolidWorks
Integration to submit Dispatcher tasks.
9
Install CORBA services
The translation support provided by the Teamcenter Integration for SolidWorks, when running on Windows
platforms, requires a persistent TAO process to be running at all times. This is configured as follows:
This step is optional, but highly recommended to improve performance for the SolidWorks design engineers 3.
It also ensures that whenever a part is checked into Teamcenter as a new version or revision, a translation task is
automatically submitted, which in turn prevents the lightweight representation of the CAD model from
becoming different from the native CAD geometry.
To configure automatic SWToJT task submission, edit the SWIM_DIR\swim.xml file and insert the following
lines into the auxiliary_file map:
<auxiliary_file cad_type="sldprt:sldasm">
<cadtopdm_control label="Save JT Files (Dispatcher)"/>
<ets_request translator="swtojt" request_per_model="false" provider="SIEMENS"
priority="2"/>
</auxiliary_file>
This entry in the auxiliary file map also displays a checkbox labeled Save JT Files (Dispatcher) in the Save
dialog, allowing users to choose whether the translation request will be submitted. If you wish to prevent users
3
Do not make these changes in the copy of swim.xml that is referenced by the Dispatcher Server. Doing so may cause the integration
to re-submit tasks unnecessarily. These changes should only be made in the copy of swim.xml that is used by the SolidWorks CAD
designers, for their CAD data management work.
10
from bypassing the Dispatcher translation, simply omit the cadtopdm_control tag from the XML entry. This
will cause the integration to always submit a translation task to the Dispatcher for each model that is saved to
Teamcenter, without giving the users a choice.
The configuration for translating drawings to DXF files is similar. Adding these lines to the auxiliary file map
causes a translation request to be submitted each time a drawing is saved to Teamcenter, and displays a Save
DXF Files (Dispatcher) checkbox in the Save dialog:
<auxiliary_file cad_type="slddrw">
<cadtopdm_control label="Save DXF Files (Dispatcher)"/>
<ets_request translator="swtodxf" request_per_model="false"
provider="SIEMENS" priority="2"/>
</auxiliary_file>
The DispatcherClient process can now be started, either from the command line or as a Windows service, if
configured. Once started, the DispatcherClient will begin processing SWToJT and SWToDXF tasks.
SolidWorks data that was last saved to Teamcenter using an integration version earlier than 8.3.0, or migrated
from a legacy system, will not contain preview images. These images can be created and stored as part of JT
translation by configuring the previewservice post-processor to create JPG files 4. The JPG files are derived
from the JT files from the SWToJT translator, and written to the Module Server’s staging directory, where the
integration will find them and upload them to Teamcenter. The following steps are required:
<FileExtensions>
<OutputExtensions nitem="1">
<OutputExtension extension=".jt"/>
</OutputExtensions>
</FileExtensions>
<!--Postprocess provider="SIEMENS" service="previewservice"/-->
</SolidWorksToJt>
To this
<FileExtensions>
<OutputExtensions nitem="1">
<OutputExtension extension=".jt"/>
</OutputExtensions>
</FileExtensions>
<Postprocess provider="SIEMENS" service="previewservice"/>
</SolidWorksToJt>
4
Although the JPG images will be displayed in the Teamcenter Rich Client application, they will not be visible in the SolidWorks
integration’s dialog windows. Those dialogs only display PNG images.
11
Configure the previewservice to create JPEG files
Locate the previewservice translator in DC_HOME\module\conf\translator.xml, and change the following:
To this:
set LM_LICENSE_FILE=CHANGE_ME
set TC_VVCP=CHANGE_ME
to this:
set LM_LICENSE_FILE=28000@svi6p120
set TC_VVCP=D:\apps\Tc8.3Visualization\VVCP
Troubleshooting
When Dispatcher translation does not work as expected, here are some points to consider.
1. Make sure supported versions of SolidWorks and Teamcenter are being used. See the section on
Prerequisites for the Teamcenter Integration for SolidWorks for more information.
2. Make sure all the specified configuration steps are done.
3. Verify that the SolidWorks part can be translated successfully using the standalone translator
framework. This is done by starting the Scheduler and the Module servers, then submitting a task using
the Admin Client.
4. Confirm that the JT translator for SolidWorks is working properly, by translating a part or assembly
from within a SolidWorks session, using the JT menu.
5. If you experience crashes or hangs of the SolidWorks session, make sure that the Module Server does
not have an extra sldworks.exe process running on the system (use the task manager). Only one
sldworks.exe should be running on the system and it should be owned by the user who starts the Module
Server.
6. Running standalone SolidWorks sessions on the Module Server is not supported. Doing so can cause
SolidWorks to crash or hang, resulting in incomplete translations or lost data.
7. It is easier to troubleshoot problems with the Dispatcher Client and Server when these processes are
run from the command line, instead of as Windows services.
5
The VVCP directory is owned by Teamcenter Visualization, which is installed separately and must include the optional modules that
support the jt2jpeg converter.
13