Teamcenter 11.4 Dispatcher Server Translators Reference: Siemens Siemens Siemens

SIEMENS
Teamcenter 11.4
Dispatcher Server
Translators
Reference
TTS00003 • 11.4
Contents
Getting started with translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Getting started with translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Implement translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Enabling translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Editing the translator.xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Creating an exclusion list for error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Modifying tessellation configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Run translation modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Implementing CAD part translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Implementing CAD part translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Implementing CATIA translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Prerequisite for Product Manufacturing Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Enable Catiav5ToJt translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Enable JtToCatia translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Enable SolidEdgeToJt translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Enable SolidWorksToJt translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Enabling ProEToJt translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Prerequisites for ProEToJt translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Enable ProEToJt translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Implementing CAD drawing translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Implementing CAD drawing translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Enabling NxToCgmDirect translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Enable NxToPv translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Enabling NxToPvDirect translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Enabling ProEToDxf translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Implementing Teamcenter-specific translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Enable ECAD (PCB) translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Enable NxRefile translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Enabling NxClone translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Enabling NxClone translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Prerequisites for NxClone translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Enable NxClone translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Enabling NxNastran service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Enabling NxNastran service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Prerequisites for NxNastran service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Enable NxNastran service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
TTS00003 11.4 Dispatcher Server Translators Reference 3

Contents
Contents
Enable NxTransDirect translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6

Enabling FMSTransfer service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Enabling FMSTransfer service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Prerequisites for FMSTransfer service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Enable FMSTransfer service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
Enable BatchMesh translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
Enabling SimProcess service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
Enabling SimProcess service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
Prerequisites for SimProcess service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
Enable SimProcess service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
Enable JtToBBoxAndTso service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
Enabling PdfGenerator service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
Enabling PdfGenerator service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
Prerequisites for PdfGenerator service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
Enable PdfGenerator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
Enabling RenderMgtTranslator service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
Enabling RenderMgtTranslator service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
Prerequisites for RenderMgtTranslator service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
Enable RenderMgtTranslator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
Enable QSEARCH_process_queue service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
Enabling the Simpgen translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
Enabling the Simpgen translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
Prerequisites for Simpgen translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
Enable Simpgen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
Enable plmxml_import_export translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20
Enable populateFSC translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21
Enabling BatchPrint translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
Enabling BatchPrint translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
Prerequisites for BatchPrint translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
Enable BatchPrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
Enabling QueryScos translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
Enabling QueryScos translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
Prerequisites for QueryScos translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
Enable QueryScos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
Enable plmxmltojt translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
Enable ImportObjects translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26
Enable ReplicatePLMXML translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
Enabling CreateAssemblyPLMXML translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
Enabling CreateAssemblyPLMXML translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
Enable CreateAssemblyPLMXML translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
Enable CreateAssemblyPLMXML translator in an SSO environment . . . . . . . . . . . . . . . . 4-30
Enable PLMXMLBasedSync translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
Configuring asynchronous services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
Configuring asynchronous services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
Configuring the asynchronous environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33
Configuring Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34
Configuring Security Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35
Enable the AsyncService translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36
Enabling PublishBatch translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37
4 Dispatcher Server Translators Reference TTS00003 11.4

Contents
Enabling PublishBatch translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37

Prerequisites for PublishBatch translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37
Enable PublishBatch translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38
Enable tcmfg_update_productviews translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39
Enable tc3dpdftrans translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40
Enable ContMgmtPublish translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41
Enabling the mmvindexgen translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41
Enabling the mmvindexgen translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41
Prerequisites for mmvindexgen translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42
Enable mmvindexgen translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42
Enable store_and_forward translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43
Enable Teamcenter Substance Compliance services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44
Implementing postprocessor translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Implementing postprocessor translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Enable PreviewService translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Troubleshooting translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

I-deas translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
NXToPvDirect translations hang . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
View Dispatcher services runtime status and Dispatcher client history . . . . . . . . . . . . . . . . . . A-3
Translator specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
CAD part translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
CAD drawing translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2
Postprocessor translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2
File translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
TTS00003 11.4 Dispatcher Server Translators Reference 5

Chapter 1: Getting started with translators
Getting started with translators

Some CAD system translators require a postprocessor translator and some require preprocessor
translators. Typically, postprocessor translators are used to generate a 2D preview or thumbnail
image of translated 3D data.
All presupplied CAD translators require a postprocessor translator. These translators generate the 2D
preview image of the 3D CAD data.
Some CAD authoring tools require different translators for 3D (part) and 2D (drawing) engineering
data. Both formats must be translated to JPEG to create preview images. Typically, to support the full
range of translations for a given CAD tool, you must install, enable, and configure both the part and
the drawing translators for that tool (in addition to the postprocessors).
Implement translators
1. Install the dispatcher scheduler and dispatcher module components.
2. Install each translator on the appropriate Dispatcher Server module machine.
3. Locate the Dispatcher Server software distribution image for your platform on your local computer
or network and copy the Translators directory to the Dispatcher_Root\Module directory on
each module machine.
Note
You must copy the Translators directory into the Dispatcher_Root\Module directory.
The configuration assumes absolute and relative addresses based on this directory.
4. Install the required software as per specifications. For example, some CAD translators require
the CAD software to be installed on the dispatcher machine.
You can follow the installation procedures provided by the software vendor to install the required
software for CAD parts, CAD drawings, postprocessor and file translator.
Note
Some CAD systems have a file path length limitation. The module must be installed in
a root-level directory to avoid this problem.
5. Install the translator. Each translator has specific installation instructions. Refer to the related
documentation for translator-specific installation instructions. Ensure that each translator is
properly licensed.
TTS00003 11.4 Dispatcher Server Translators Reference 1-1

Chapter
Chapter 1: 1: Getting
Getting started
started with translators
with translators
6. Before integrating the translator with the Dispatcher Server, perform a manual test of the
translation locally.
Note
If the manual test is successful, it is easier to isolate issues specific to the file server,
the scheduler, and/or the module.
7. Back up the translator.xml file, modify it to activate each installed translator, and then associate
each translator with a translator module.
Note
Incorrect modifications to the translator.xml file can cause some or all translators
to fail.
8. Some translators require additional configuration, such as setting batch file environment variables
or tessellation configuration.
9. After implementing each translator, run the dispatcher module to include the translator so that
you can progressively troubleshoot for any file translation errors.
10. Repeat steps 1–10 for each translator implemented.
Note
You can implement additional instances of a translator on another machine to increase the
translation throughput. Follow the procedure discussed in this section by modifying the
translator.xml file. Also, you must implement a dispatcher module on each machine with
the additional instances.
Enabling translators
Editing the translator.xml file
Editing the translator.xml file
Each translator is associated with a translator module by specifying the required information in the
translator.xml file in the Dispatcher_Root\Module\conf directory. Like any XML file, it consists
of elements and attributes.
• Each translator is defined within a unique element
Each supported translator is defined in its own element (for example, <IdeasToJt>), all nested
within a <Translators> element. Nested within each translators element are elements that
define the location of the translator and any required software, supported file name extensions,
classpath definitions, or any other required data.
1-2 Dispatcher Server Translators Reference TTS00003 11.4

• Modifying the isactive attribute to activate a translator

To activate a translator, modify the isactive attribute to true to activate a translator or false to
turn off the translator.
Note
By default, the isactive value is set to false for all translators in the translator.xml file.
• Wrapper class attribute for defining a wrapper

Most translators have a wrapper class attribute used to define a wrapper. Wrappers are used
for managing translations including threading, process control (start and stop), status checking,
error handling and completion status.
Example:
<IdeasMFTranslator provider="Siemens"
service="ideasmftranslator" isactive="false" wrapperclass="&EAIWRAPPER">
Note
You don't have to modify the wrapperclass attribute unless you write a custom
wrapper to manage your translator.
• Modifying attributes to associate a translator

To associate a translator with the translator module, modify the attributes that point to various
executable files or classpaths. In some cases, you must define additional elements to
accommodate additional file extensions.
• Modifying input and output extensions

The InputExtensions and OutputExtension elements define valid input and output file
extensions for each translator.
Note
If your site uses nonstandard file extensions (extensions that are not specified in the
translator.xml file) for certain file types, you can add that file extension to the list
of supported extensions.
Example:
<FileExtensions>
<InputExtensions nitem="1">
<InputExtension extension=".pkg"/>
</InputExtensions>
<OutputExtensions nitem="2">
<OutputExtension extension=".jt"/>
<OutputExtension extension=".cgm"/>
</OutputExtensions>
</FileExtensions>

Chapter
Getting started
with translators
As shown in the example above, you must change the nitem attribute based on the number of
input or output file extensions for each translator.
Define entities
1. Open the translator.xml file from the Dispatcher_Root\Module\conf directory.
2. Locate the <!ENTITY> elements located at the start of the file.
3. For each translator you want to activate, set the isactive attribute to true.
Example:


<ProEToJt provider="Siemens" service="proetojt" isactive="true"
wrapperclass="&EAIWRAPPER;">
4. For each installed translator, verify the MODULEBASE property.

Example of a translator startup file called from the Dispatcher_Root\Module\Translators
directory:
<TransExecutable dir="&MODULEBASE;/Translators/catiatojt/v5/UGS"
name="catiav5tojt.sh" />
Example of a deamon executable called from the directory where the translator is installed:
<Daemon exec="/proe<ver>/sun4_solaris/nms/nmsd" args="-noservice"/>
Modify input extensions
2. Locate the <InputExtensions> tag for the translator you want to modify. Increment the value of
the nitem parameter to the total number of file extensions you want to support.
3. For each additional file extension, add an <InputExtension extension=" "> tag. Specify the file
extension (including the dot) in the extension attribute.
The following example shows the IdeasToJt translator definition modified with the <InputExtension
extension=""> tag to accept files with the SLDASM extension:
<FileExtensions>
<InputExtension extension=".pkg"/>
</InputExtensions>
</OutputExtensions>
</FileExtensions>

Creating an exclusion list for error messages
Creating an exclusion list for error messages
Translators display error messages or warning messages while performing translations. The
dispatcher module cannot distinguish between serious errors that result in translation failures or
simple warnings. For example, the following warning can prevent the dispatcher module from
completing the translation:
This is not an error string
The Dispatcher Server provides an exclusion list in the translator.xml file to ignore simple
warnings and continue the translation. The translator.xml file contains predefined InputStream
and ErrorStream error strings with keywords such as cannot, error, exception, and failed. The
dispatcher module checks both the streams for the error displayed by the translator, verifies whether
the same error is defined in the exclusion string, and if they are the same, the module continues with
the translation.
You can add specific error strings to the exclusion list to prevent the dispatcher module from stopping
translations. For example, you can add Not a Failure within the TransErrorExclStrings tags of the
ToZip translator in the translator.xml file to prevent this translator from failing.
Error strings
The error tags can be either translator-specific or global. You can use:
• Translator-specific error tags for specific translators defined in the translator.xml file.
• Global error tags for all active translators in the dispatcher module.
Note
When you use translator-specific error tags, the dispatcher module ignores global error
strings.

Chapter
Getting started
with translators
Sample translator-specific error tags:

<UgToPvDirect provider="Siemens" service="ugtopvdirect"
maxlimit="1" debug="&DEBUG">
<TransExecutable name="ugtopvdirect.sh" dir="&MODULEBASE;/Translators/
ugtopvdirect"/>
<Options>

<Option name="ConfigMapFile" string="-configmap"
value="&MODULEBASE;/Translators/ugtopvdirect/
ConfigMap.properties"
description="Property file which has the Map between Client
passed in Criteria and the location of config file to be used"/>
<Option name="inputpath" string=""
description="Full path to the input file."/>
</Options>
<TransErrorStrings>
<TransInputStream string="Cannot"/>
<TransInputStream string="Error"/>
<TransInputStream string="exception"/>
<TransInputStream string="ERROR"/>
<TransErrorStream string="Errored"/>
<TransErrorStream string="failed"/>
</TransErrorStrings>

</UgToPvDirect>
Sample global error tags:

<ErrorStrings>
<InputStream string="Error"/>
<InputStream string="error"/>
<InputStream string="Null"/>
<InputStream string="Exception"/>
<InputStream string="ERROR"/>
<ErrorStream string="Error"/>
<ErrorStream string="error"/>
<ErrorStream string="Exception"/>
<ErrorStream string="termination"/>
<ErrorStream string="Bad"/>
<ErrorStream string="Null"/>
<ErrorStream string="ERROR"/>
</ErrorStrings>
Exclusion tags
Similar to error tags, the exclusion tags can be either translator-specific or global. You can use:
• Translator-specific exclusion tags for specific translators defined in the translator.xml file.
• Global exclusion list for active translators in the dispatcher module.

Note
When you use translator-specific exclusion tags, the dispatcher module ignores the global
exclusion list.
Sample translator-specific exclusion tags:


<ToZipfile provider="Siemens" service="tozipfile" maxlimit="1"
debug="&DEBUG">
<SysExecutable name="java"/>
<Options>
<Option name="classpath" string="-cp" system="java.class.path"
description="Classpath to the java virtual machine." />
<Option name="classname" string=""
value="com.sdrc.intellivis.translator.ZipUtility"
description="Zip Utility class."/>
<Option name="zip" string="-zip" value=""/>
description="Full path to the input file or directory."/>
<Option name="outputpath" string=""
description="Full path to the output zip file."/>
</Options>
<TransErrorStrings>
<TransErrorStream string="Null"/>
<TransErrorExclStrings>
<TransInputStreamExcl string="Not a Failure"/>
<TransErrorStreamExcl string="Translator did not fail."/>
</TransErrorExclStrings>
<FileExtensions>
<OutputExtension extension=".zip"/>
</OutputExtensions>
</FileExtensions>
</ToZipfile>
Sample global exclusion list tags:




<ErrorExclStrings>
<InputStreamExcl string="Error Reporting mechanism"/>
<ErrorStreamExcl string="This is not an error"/>
</ErrorExclStrings>
Modifying tessellation configuration files

Tessellation is a process that translates a CAD file to a visualization file.
The table that follows describes the translators for which you can modify tessellation output options.

Chapter
Getting started
with translators
Note
If you do not specify any options, the translator service generates a default output.
Translator Modify which file?

CATIA 4 Part Translator (Theorem) .bat or .sh script of the translator to point to the
Catiav4ToJt tessellation configuration file of the translator
CATIA 4 Part Translator (UGS) .sh script of the translator to point to the tessellation
Catiav4ToJt configuration file of the translator1
CATIA 5 Part Translator Catiav5ToJt Dispatcher_Root\Module\conf\
translator.xml
NX Part Translator NxToPv .bat or .sh script of the translator
Note
You must edit either the translator.xml file or the startup script (.bat or .sh) for each
translator to ensure that the Dispatcher Server uses the latest tessellation options.
Run translation modules

1. Start the dispatcher scheduler.
2. Stop dispatcher modules that are running.
Note
For each translator added, it is a good practice to shut down the dispatcher module
and restart it. This makes it easy to isolate and troubleshoot failed translations.
3. From a command prompt, change to the bin directory where you have installed the module.
4. Execute the following command:

• Windows: runmodule.bat
• UNIX: runmodule.sh
1. This translator is available only in UNIX.

The following message is displayed for the tozipfile translator service:

Release Version : 2007.1
Home Directory : F:\Dispatcher_Server_Latest\Dispatcher\Module
Log files Directory : F:\Dispatcher_Server_Latest\Dispatcher\Module\
logs\Dispatcher
Java Version : 1.5.0_04
Start Time : Jul 06, 2007 10:56:48
Module Name : Module_1fe38674_13797b3e
Module Host Name : pni3w329
Module URL : rmi://146.122.195.151:1999
Module Log FileName : Module_1fe38674_13797b3e.log
Translators Available
--------------------------------------------
Provider: Siemens Service: tozipfile
--------------------------------------------
Connected to Scheduler at rmi://localhost:2001
Module is ready for the tasks.
If this message appears for each installed translator, your translator module is ready for files to be
translated to the appropriate format by the Dispatcher Server.
If there is a problem, you see a message similar to the following:
Skipping translator translator_name
This is followed by the text of the Java exception. The likely causes are:
• Invalid XML format in the translator.xml file.
If the module fails due to invalid XML, check the logs for modules in the Dispatcher_Rootlogs\
Dispatcher\process directory for error messages.
• The specified location of the required software or translator may be incorrect.

Confirm the location of all translator executable files, scripts, and batch files in the translator.xml
file.

Chapter 2: Implementing CAD part translators
Implementing CAD part translators

CAD part translators convert part and assembly data to the Direct Model (.jt) file format.
Implementing CATIA translators

Prerequisite for Product Manufacturing Information
To import the accountability ID for Product Manufacturing Information (PMI) using CatiaToJt
translators, create the SET_ACCOUNTABILITY_ID environment variable on the dispatcher module
used for this translator and set the value to 1.
Enable Catiav5ToJt translator

The Catiav5ToJt service translates Catia V5 (.CATPart) files to JT (.jt) files.
Note
After you enable the Catiav5ToJt service, this service is not available from the default
Translate menu in My Teamcenter. There is a separate CATIA V5 menu that you can use
to perform a conversion to JT files.

Windows example:
<catiatojtv5 provider="SIEMENS"
service="catiatojtv5" isactive="false">
<TransExecutable dir="&MODULEBASE/Translators/catiatojt/
v5/UGS" name="catiav5tojt.bat" />
<Options>
<Option name="inputdir" string="-dir"
description="Full path to the input directory."/>
<Option name="outputdir" string="-outputDirectory"
description="Full path to the output directory."/>
</Options>
<FileExtensions>
<InputExtension extension=".CATPart"/>
<InputExtension extension=".CATDrawing"/>
</InputExtensions>

Chapter
Chapter 2: 2: Implementing
Implementing
CAD CAD part translators
part translators
</OutputExtensions>
</FileExtensions>

</catiatojtv5>
2. Set the isactive attribute to true to activate this translator.
Note
By default, this attribute is set to false.
3. Open the catiav5tojt.bat (Windows) or catiav5tojt.sh (UNIX) file from the

Dispatcher_Root\Module\Translators\catiatojt\v5\UGS directory and edit the CHANGE_ME
tags.
Note
On UNIX systems, be sure to set the SPLM_LICENSE_SERVER variable in the
catiav5tojt.sh file.
4. Verify that you have installed the required software, related translator, and default postprocessor
(optional).

The Catiav4ToJt service translates Catia V4 (.model) files to JT (.jt) files.
Windows example:


<Catiav4ToJt provider="Siemens" service="catiav4tojt" isactive="true"
<TransExecutable dir="&MODULEBASE;/Translators/catiatojt/v4/Theorem"
name="catiav4tojt.bat" />
<Options>
<Option name="inputdir" string="-input_dir"
<Option name="outputdir" string="-output_dir"
</Options>
<FileExtensions>
<InputExtension extension=".model"/>
</InputExtensions>
</OutputExtensions>
</FileExtensions>
<Postprocess provider="Siemens" service="previewservice"/>
</Catiav4ToJt>

Note
3. Open the catiav4tojt.bat (Windows) or catiav4tojt.sh (UNIX) file from the

Dispatcher_Root\Module\Translators\catiatojt\v4\Theorem directory and edit the CHANGE_ME
tags.
(optional).

The Catiav4ToJt (Siemens) service translates Catia V4 (.model) files to JT (.jt) files.
Note
The CATIA 4 part translator (Siemens) is supported only on UNIX systems.

UNIX example:
<Catiav4ToJt provider="Siemens" service="catiav4tojt"

isactive="false"
<TransExecutable dir="&MODULEBASE;/Translators/catiatojt/v4/UGS"
name="catiav4tojt.sh" />
<Options>
<Option name="inputdir" string=""
<Option name="outputdir" string=""
<Option name="configfile" string=""
value="&MODULEBASE;/Translators/catiatojt/v4/tessCAT.config"/>
<Option name="dclfile" string=""
value="&MODULEBASE;/Translators/catiatojt/v4/trans.dcls"/>
</Options>
<FileExtensions>
<InputExtension extension=".model"/>
</InputExtensions>
</OutputExtensions>
</FileExtensions>
</Catiav4ToJt>

Chapter
Implementing
part translators
Note
3. Open the catiav4tojt.sh file from the Dispatcher_Root\Module\Translators\catiatojt\v4\UGS

directory and edit the CHANGE_ME tags.
(optional).
Enable JtToCatia translator

The JtToCatia translator translates JT (.jt) files to Catia (.CATPart and .CATProduct) files.
1. Open the translator.xml file from the Dispatcher_RootModule\conf directory.
Windows example:


<JtToCatiaV5 provider="Siemens" service="jttocatiav5" isactive="true">
<TransExecutable dir="&MODULEBASE;/Translators/jttocatia/v5"
name="jttocatiav5.bat" />
<Options>
<Option name="inputdir" string="-i"
<Option name="outputdir" string="-o"
</Options>
<FileExtensions>
<InputExtension extension=".jt"/>
</InputExtensions>
<OutputExtension extension=".CATPart"/>
<OutputExtension extension=".CATProduct"/>
</OutputExtensions>
</FileExtensions>
</JtToCatiaV5>
Note
3. Open the jttocatiav5.bat (Windows) or jttocatiav5.sh (UNIX) file from the

Dispatcher_Root\Module\Translators\jttocatia\V5 directory and edit the CHANGE_ME tags.

Note
For more information about additional parameters used by this translator, from a command
prompt, change to the Translators\jttocatia directory and type the following command:
• Windows: call jttocatia5.bat -help
• UNIX: jttocatia5.sh -help
Enable SolidEdgeToJt translator

The SolidEdgeToJt service translates Solid Edge part and assembly files to the Direct Model (.jt)
visualization format.
Note
This translator is not supported on Teamcenter and is available only for Teamcenter Rapid
Start.
To install the Solid Edge application after you install Teamcenter Rapid Start, you must
configure the translator manually.
To implement SolidEdgeToJt translator:


Chapter
Implementing
part translators
Windows example:
<SolidEdgeToJt provider="SIEMENS" service="setojt" isactive="false">

<TransExecutable name="setranslations.bat"
dir="d:/UGS/Translators/setranslations"/>
<Options>
<Option name="outputpath" string="-o="
description="Full path to the output file."/>
<Option name="inputpath" string="-i="
<Option name="vis" string="-v=" value="True"
description="-v option to SE Translator."/>
<Option name="target" string="-t=" value="jt"
description="Out put file format Option to SE Translator."/>
</Options>
<FileExtensions>
<InputExtension extension=".par"/>
<InputExtension extension=".asm"/>
<InputExtension extension=".psm"/>
<InputExtension extension=".pwd"/>
</InputExtensions>
</OutputExtensions>
</FileExtensions>
<Postprocess provider="SIEMENS" service="previewservice"/>
</SolidEdgeToJt>
Enable SolidWorksToJt translator

The SolidWorksToJt service translates SolidWorks part and assembly files to the Direct Model (.jt)
visualization format.
To implement SolidWorksToJt translator:

Windows example:
<SolidWorksToJt provider="SIEMENS" service="swtojt" isactive="false"

wrapperclass="&EAIWRAPPER">
<TransExecutable dir="C:/progra~1/EAI/Translators/SolidWorks"
name="Swtojt.exe"/>
<Options>
<Option name="configfile" string="-z" value="D:/apps/Translators/
SWtoJt/SwtoJt.config"
description="Path to the config file"/>
<Option name="outputdir" string="-o"
</Options>
<FileExtensions>
<InputExtension extension=".SLDASM"/>
<InputExtension extension=".SLDPRT"/>
</InputExtensions>
</OutputExtensions>
</FileExtensions>
<Postprocess provider="SIEMENS" service="previewservice"/>
</SolidWorksToJt>
Enabling ProEToJt translator
Prerequisites for ProEToJt translator

• Norton AntiVirus may cause Pro/ENGINEER translators to hang. Disable it on the translation
module that includes the Pro/ENGINEER translator.
• Do not install the Vis Mockup translator on any dedicated translation module machine used to
run the ProEToJt translator as these translators cause conflicts.
• If the Pro/ENGINEER translator is installed in a directory with spaces in the directory name
(for example, Program Files), ensure that the value of the PROE_CMD variable in the
proetojtversion.bat file is set in quotation marks. For example:
PROE_CMD="D:\Program Files\proe<ver>\bin
\proe<ver>.bat”
Enable ProEToJt translator
Enable ProEToJt translator

The ProEToJt service translates Pro/ENGINEER drawing (.drw) files to DXF (.dxf) files. It supports
all Pro/ENGINEER drawing files.

Chapter
Implementing
part translators

Windows example:


<ProEToJt provider="Siemens" service="proetojt" isactive="true"

<Daemon exec="C:/Progra~1/proe<ver>/i486_nt/nms/nmsd.exe"
args="-noservice"/>
<SysExecutable name="java"/>
<Options>
value="&UGSPKGproetojt.ProeToJtLauncher"
description="ProE-To-Jt Generation class."/>
<Option name="cadlaunchscript" string=""
value="C:\UGS\ProE_Translator\proetojt<ver>.bat"
description="Path to ProE translator bat file."/>
<Option name="structureOption" string=""
value="MONOLITHIC"
description="Structure option in the TessProE.config file."/>
<Option name="configfile" string=""
value="D:\UGS\ProE<ver>_Translator\etc\tessPRO.config"
description="tessPRO.config file path."/>
<Option name="clientoption" optionkey="INST_NAME" string=""
value="GENERIC"
description="Translator client options."/>
</Options>
<FileExtensions>
</OutputExtensions>
</FileExtensions>
</ProEToJt>
Note
3. Verify that the daemon service name for the translator version you want to use is specified
correctly. This daemon is started whenever the dispatcher client is started.

4. Verify that the startup script name and directory (cadlaunchscript directory) for the translator
version you want to use are correctly specified. The .bat (Windows) or .sh (UNIX) script from
this directory invokes the translator service.
5. Verify that the tessellation configuration file name and directory are correctly specified. The
configuration file determines the tessellation output.
(optional).
Test the translator locally
1. Open the Pro/ENGINEER CAD system and load any Pro/ENGINEER part.
2. Select the Export option to generate a Direct Model file to the current directory by selecting
default values.
If the Direct Model file is created, your Pro/ENGINEER CAD system and translator components
are installed and licensed correctly.

Chapter 3: Implementing CAD drawing translators
Implementing CAD drawing translators

The CAD drawing translators convert native CAD drawing formats to generic drawing formats, such
as AutoCAD Drawing eXchange Format (DXF) or CGM.
Enabling NxToCgmDirect translator

The NxToCgmDirect service translates UG (.prt) files to CGM (.cgm) files. It connects to Teamcenter
to perform the translations.
Prerequisites for NxToCgmDirect translator
• Not supported on four-tier or SSO environments.
• Ensure that a matching user name is available in Teamcenter for the user name of the user
running the translator module. This user must have all read/write and checkin/checkout privileges
to perform translations.
Note
To overcome this limitation, modify the Dispatcher_Root\Module\Translators\
nxtocgmdirect\nxtocgmdirect.bat (Windows) or Dispatcher_Root\Module\
Translators\nxtocgmdirect\nxtocgmdirect.sh (UNIX) file to add the -u, -p, or -pf
arguments.
Enable NxToCgmDirect translator

Chapter
Implementing
CAD CAD drawing
drawing translators
translators
Windows example:


<NxToCgmDirect provider="Siemens" service="nxtocgmdirect" isactive="false"
OutputNeeded="false"
wrapperclass="&WRAPPERugtocgmdirect.UgToCgmDirect">
<TransExecutable name="nxtocgmdirect.bat"
dir="&MODULEBASE;/Translators/nxtocgmdirect"/>
<Options>
<Option name="inputpath" string="-i"
</Options>
<TransErrorStrings>
<TransInputStream string="ERRORS"/>
</NxToCgmDirect>
Note
Skip this step if you use TEM to install and configure this translator.
3. Open the nxtocgmdirect.bat (Windows) or nxtocgmdirect.sh (UNIX) file from the

Dispatcher_Root\Module\Translators\nxtocgmdirect directory and edit the CHANGE_ME tags.
Note
For more information about additional parameters used by this translator, from a
command prompt, browse to the Translators\nxtocgmdirect directory and enter
the following command:
• Windows: call nxtocgmdirect.bat -help
• UNIX: nxtocgmdirect.sh -help
Enable NxToPv translator

The NxToPv service translates UG (.prt) files to JT (.jt) files.
Windows example:


<NxToPv provider="Siemens" service="nxtopv" isactive="false">
<TransExecutable name="nxtopv.bat" dir="&MODULEBASE;/Translators/nxtopv"/>

<Options>
<Option name="StructOption" string="-honour_structure" value=""
description=""/>
<Option name="Output_dir" string="-force_output_dir" value=""
description=""/>
<Option name="BOM_Indicator" string="-bom" value=""
description=""/>
<Option name="BOM_FileName" string="nxtopv.bom" value=""
description=""/>
</Options>
<FileExtensions>
</OutputExtensions>
</FileExtensions>
<TransInputStreamExcl string="Translator Error Log File created"/>
<TransInputStreamExcl string="Error Reporting mechanism"/>
</NxToPv>
3. (Optional) Edit the nxtopv.bat (Windows) or nxtopv.sh (UNIX) file from the
Dispatcher_Root\Module\Translators\nxtopv directory if you need to set environment variables
for NX. These variables are set by default if you have installed NX.
4. Verify that you have installed the required software, related translator, and, if needed, the default
postprocessor.
Enabling NxToPvDirect translator

The NxToPvDirect translator service translates UG (.prt) files to JT (.jt ) files. It connects to
Teamcenter to perform translations.
Prerequisites for NxToPvDirect
• Not supported on four-tier or SSO environments.
• Ensure that a matching user name is available in Teamcenter for the user name of the user
running the translator module. This user must have all read/write and checkin/checkout privileges
to perform translations.

Chapter
Implementing
CAD CAD drawing
drawing translators
translators
Note
To overcome this limitation, modify the Dispatcher_Root\Module\Translators\
nxtopvdirect\nxtopvdirect.bat (Windows) or
Dispatcher_Root\Module\Translators\nxtopvdirect\nxtopvdirect.sh (UNIX) file
to add the -u, -p, or -pf arguments.
Enable NxToPvDirect translator

Windows example:

<NxToPvDirect provider="Siemens" service="nxtopvdirect"
isactive="false"
OutputNeeded="false"
wrapperclass="&WRAPPERugtopvdirect.UgToPvDirect">
<TransExecutable name="nxtopvdirect.bat"
dir="&MODULEBASE;/Translators/nxtopvdirect"/>
<Options>

<Option name="ConfigMapFile" string="-configmap"
value="&MODULEBASE;/Translators/nxtopvdirect/
ConfigMap.properties" description="Property file
which has the Map between Client passed in
criteria and the location of config
file to be used"/>
</Options>
<TransErrorStrings>

</NxToPvDirect>
Note
3. (Optional) Edit the nxtopvdirect.bat (Windows) or nxtopvdirect.sh (UNIX) file from the
Dispatcher_Root\Module\Translators\nxtopvdirect directory if you need to set environment
variables for NX. These variables are set by default if you have installed NX.
4. (Optional) To use the -single_part option:

a. Uncomment following option in translator.xml file for the NxToPvDirect translator:


as follows:
<Option name="" string="" value="-single_part"/>
b. Specify the configuration file for the item revision in the Dispatcher_Root\Module\
Translators\nxtopvdirect\ConfigMap.properties file.
For example: ItemRevision=defaultdef
If defaultdef is set for the configuration file in the ConfigMap.properties file, then
UGII_BASE_DIR\PVTRANS\tessUG.configis used.
Users can customize the default configuration file in the nxtopvdirect.bat file.
postprocessor.
Enabling ProEToDxf translator

The ProEToDxf service translates the Pro/ENGINEER drawing files to the Autodesk Drawing
eXchange Format (DXF) format.
Enable ProEToDxf translator

Windows example:


<ProEToDxf provider="SIEMENS" service="proetodxf" isactive="false"
wrapperclass="&WRAPPERproetodxf.ProEToDxf">

<Daemon exec="C:/UGS/Proe/i486_nt/nms/nmsd.exe" args="-noservice"/>
<TransExecutable name="ProEWildfireDXFExe.exe" dir="&MODULEBASE/
Translators/proetodxf/"/>
<Options>
<Option name="inputpath" string="-i"
description="Full path to the input file"/>
<Option name="outputpath" string="-o"
</Options>
<FileExtensions>
<OutputExtension extension=".dxf"/>
</OutputExtensions>
</FileExtensions>

</ProEToDxf>

Chapter
Implementing
CAD CAD drawing
drawing translators
translators
Note
3. Verify that the Daemon exec attribute is specified correctly for the version of the translator you
have installed.
postprocessor.
Create a copy of the Pro/ENGINEER startup script
The batch file that starts the Pro/ENGINEER translator may have different names depending on the
installation. The Dispatcher Server looks for InvokeProE.bat file in the bin directory to invoke the
translator. Therefore, if the batch file has a different name, you must save the file as InvokeProE.bat
in the bin directory for the Dispatcher Server to invoke the Pro/ENGINEER translator.
1. Locate the batch file that starts Pro/ENGINEER.
Note
This file may have different names depending on the installation, but it is usually
located in the bin directory of the Pro/ENGINEER installation.
2. Open the batch file and save it as InvokeProE.bat in the same directory.
Set the PRO_COMM_MSG_EXE environment variable
Create a PRO_COMM_MSG_EXE environment variable that points to loadpoint/OS

name/obj/pro_comm_msg.exe.
For example, set PRO_COMM_MSG_EXE to:
C:\ptc\proe2000i2\i486_nt\obj\pro_comm_msg.exe

Chapter 4: Implementing Teamcenter-specific translators
Enable ECAD (PCB) translators

To implement the PcbToFatf translator:
Windows example:
<PcbToFatf provider="Siemens" service="pcbtofatf" isactive="false">

<TransExecutable dir="C:/Tc2007SR1/emps/Translation"
name="ECADTSMgr.bat"/>
<Options>
<Option description="Translator Name." name="clientoption"
optionkey="TRANS_NAME" string="" value="cadence"/>
</Options>
<FileExtensions>
<OutputExtension extension=".xfatf"/>
</OutputExtensions>
</FileExtensions>
</PcbToFatf>
3. Verify that the TransExecutable dir is correctly specified for this translator.
Enable NxRefile translator

The NxRefile service executes the NX refile utility and saves NX parts in the current version of NX.
Tip
The Dispatcher_Root directory is the directory specified in the Dispatcher Root
Directory box while installing Dispatcher components using TEM. Typically, this
directory is close to the Teamcenter root directory.

Chapter
Implementing Teamcenter-specific
Teamcenter-specific translators
translators
Windows example:

<NxRefile provider="Siemens" service="nxrefile" isactive="false"
OutputNeeded="false">
<TransExecutable name="nxrefile.bat"
dir="&MODULEBASE;/Translators/nxrefile"/>
<Options>
<Option name="modulePath" string=""
value="&MODULEBASE;/Translators/nxrefile"
description="Dir where refile command is located"/>
<Option name="clientoption" optionkey="commandName" string=""
value="refilenx"
description="Refile command to launch.
Do not include extension (.bat/.sh)"/>
<Option name="clientoption" optionkey="commandArgs" string=""
description="arguments for refile command"/>
</Options>
<FileExtensions>
<InputExtension extension=".bat"/>
<InputExtension extension=".txt"/>
</InputExtensions>
<OutputExtension extension=".log"/>
<OutputExtension extension=".syslog"/>
</OutputExtensions>
</FileExtensions>
</NxRefile>
Note
3. Open the nxrefile.bat (Windows) or nxrefile.sh (UNIX) file from the Dispatcher_Root\Module\
Translators\nxrefile directory and set environment variables, if they are not already defined.
For more information, see the respective .bat or .sh file for the translator.
4. Run the translator in stand-alone mode from the command prompt to verify whether it is working
properly.
For more information about running the translator in stand-alone mode, from a command prompt,
change to the Dispatcher_Root\Module\Translators\nxrefile directory and run the appropriate
command for your platform:
• Windows: nxrefile.bat -help
• UNIX: nxrefile.sh -help

Implementing Teamcenter-specific translators
For more information about this translator, see Teamcenter Integration for NX help.
Enabling NxClone translator

Enabling NxClone translator
The NxClone service calls the NX refile utility to refile NX parts.
Note
NX must be installed with the UGManager module to use this service.
Prerequisites for NxClone translator

The dispatcher client proxy user must have the following privileges to update the attributes of a
DispatcherRequest object:
• ACE Privilege = Read
• ACE Privilege = Write
• ACE Privilege = Delete
Enable NxClone translator

Windows example:
<NxClone provider="SIEMENS" service="nxclone"
isactive="true" OutputNeeded="false">
<TransExecutable name="nxclone.bat"
dir="&MODULEBASE/Translators/nxclone"/>
<Options>
<Option name="modulePath" string=""
value="&MODULEBASE/Translators/nxclone"
description="Dir where clone command is located"/>
<Option name="clientoption" optionkey="single_part" string=""
value="no"
description="Whether to use -part or -assembly option"/>
<Option name="clientoption" optionkey="operation"
string="-operation="
value="export" description="Default is export.
Other modes are not currently supported"/>
<Option name="clientoption" optionkey="default_naming"
string="-default_naming="
value="autotranslate" description="Default naming"/>
<Option name="clientoption" optionkey="default_checkout"
string="-default_checkout="
value="no" escription="Checkout parts"/>

Chapter
translators
<Option name="clientoption" optionkey="copy_associated_files"

string="-copy_associated_files=" value="no"
description="Copy Teamcenter Associated files"/>
<Option name="clientoption" optionkey="copy_n_s" string="-copy_n="
value="specification:yes"
description="Copy non-master datasets of ItemRevision"/>
<Option name="clientoption" optionkey="copy_n_m" string="-copy_n="
value="manifestation:yes"
description="Copy non-master datasets in ItemRevision"/>
<Option name="clientoption" optionkey="copy_n_a" string="-copy_n="
value="altrep:yes"
<Option name="clientoption" optionkey="copy_n_c" string="-copy_n="
value="scenario:yes"
<Option name="clientoption" optionkey="copy_n_e" string="-copy_n="
value="simulation:yes"
<Option name="clientoption" optionkey="copy_n_l" string="-copy_n="
value="motion:yes"
<Option name="clientoption" optionkey="copy_n_r" string="-copy_n="
value="cae_solution:yes"
<Option name="clientoption" optionkey="copy_n_n" string="-copy_n="
value="cae_mesh:yes"
<Option name="clientoption" optionkey="copy_n_g" string="-copy_n="
value="cae_geometry:yes"
</Options>
Note
3. Open the nxclone.bat (Windows) or nxclone.sh (UNIX) file from the Dispatcher_Root\Module\
Translators\nxclone directory and edit CHANGE_ME and other variables as appropriate.
properly.
For more information about running the translator in stand-alone mode, from a command prompt,
change to the Dispatcher\Translators\nxclone directory and run the appropriate command
for your platform:

Note
For more information, see the Readme file in the Translators\nxclone directory.
• Windows: nxclone.bat -help
• UNIX: nxclone.sh -help
Enabling NxNastran service
Enabling NxNastran service
The NxNastran service is used to launch NX Nastran remotely using Simulation Process
Management.
Prerequisites for NxNastran service
• The tc_launch_sim_process_ts_pl.bat file in the module/SimProcess directory points to the

Perl location. Make sure that the Perl location is correct.
• The clients and Dispatcher Server should point to the common staging directory and both should
have read/write permissions to that directory.
Enable NxNastran service
Windows example:
<nxnastran provider="SIEMENS" service="nxnastran" isactive="false">

<TransExecutable dir="&MODULEBASE/Translators/simprocess"
name="tc_launch_sim_process_ts_pl.bat"/>
<Options>
</Options>
<FileExtensions>
<InputExtension extension=".xml"/>
</InputExtensions>
</FileExtensions>
</nxnastran>

Chapter
translators
Note
To launch a service remotely, ensure that the service name in the translator.xml file
matches the process name in the Simulation Tools Configuration window in CAE
Manager.
Enable NxTransDirect translator

NxTransDirect translates NX files (.prt) to JT (.jt) and other formats and directly stores the JT files
in Teamcenter.

Windows example:
<NxTransDirect provider="SIEMENS" service="nxtransdirect"

isactive="false" OutputNeeded="false">
<TransExecutable name="nxtransdirect.bat" dir="&MODULEBASE;/
Translators/nxtransdirect"/>
<Options>
<Option name="inputpath" string="-inputFile="
<Option name="clientoption" optionkey="user" string="-u="
value="" description="Specifies username for NX Translator
login to Teamcenter."/>
<Option name="clientoption" optionkey="password" string="-p="
value="" description="Specifies password for NX Translator
<Option name="clientoption" optionkey="group" string="-g="
value="" description="Specifies group for NX
Translator login to Teamcenter."/>
<Option name="clientoption" optionkey="encrypted_password"
string="-encrypt=" value="true" description="Specifies
whether or not password is encrypted for NX Translator
<Option name="clientoption" optionkey="use_module_user"
string="-autologin=" value="true" description="Specifies
whether to auto login as module user."/>
<Option name="clientoption" optionkey="storeInSourceVolume"
string="-storeInSourceVolume=" value="false"
description="Specifies whether to store the translated
data in the same volume as source."/>
<Option name="clientoption" optionkey="updateExistingVisData"
string="-updateExistingVisData="
value="false" description="Specifies whether to update
existing translated data."/>
<Option name="clientoption" optionkey="changeOwnerToCad"
string="-changeOwnerToCad=" value="false"
description="Specifies whether to change the translated
data to the same owner as source."/>
</Options>
<TransErrorStrings>
</NxTransDirect>
Note

Chapter
translators
3. Open the nxtransdirect.bat (Windows) or nxtransdirect.sh (UNIX) file from the

Dispatcher_Root\Module\Translators\nxtransdirect directory and set environment variables, if
they are not already defined.
4. (Optional) To set up options such as -auto_login using the nxtransdirect.bat (Windows) or

nxtransdirect.sh (UNIX) file, comment out the options from the translator.xml file.
Example:

Similarly, change other options as appropriate.
5. (Optional) To set up dcproxy as the owner of the translated files, make the following change to
the nxtransdirect.bat (Windows) or nxtransdirect.sh (UNIX) file.
Example:
"%UGII_BASE_DIR%\ugmanager\run_nxtrans.bat" -u=dcproxy -p=dcproxy

-changeOwnerToCad=false -config="%UGII_CONFIG_DIR%" "-pim=yes" %*
properly.
For more information about running the translator in stand-alone mode, from a command
prompt, change to the Dispatcher_Root\Module\Translators\nxtransdirect directory and run
the appropriate command for your platform:
• Windows: nxtransdirect.bat -help
• UNIX: nxtransdirect.sh -help
Enabling FMSTransfer service
Enabling FMSTransfer service

The FMSTransfer service is used to forward a file from a temporary store and forward volume to
its destination volume.
Prerequisites for FMSTransfer service

• TC_ENABLE_STOREANDFORWARD site preference must be set to true.
• Uploaded files are transferred to their destination according to the set rules and the configured
schedule.
• The user must have appropriate permissions to upload files.

Enable FMSTransfer service

Windows example:
<FMSTransfer provider="SIEMENS" service="fmstransfer" isactive="false">

<TransExecutable name="fmstransfer.bat"
dir="&MODULEBASE/Translators/fmstransfer"/>
<Options>
<Option name="inputpath" string="-Dcom.teamcenter.fms.ts.task="
<Option name="outputpath" string="-Dcom.teamcenter.fms.ts.output="
</Options>
<FileExtensions>
<InputExtension extension=".fmst"/>
</InputExtensions>
<OutputExtension extension=".fmstransferred"/>
</OutputExtensions>
</FileExtensions>
</FMSTransfer>
Enable BatchMesh translator

The BatchMesh service translates part (.prt) files to mesh files and directly stores them in
Teamcenter.
Note
The BatchMesh translator is supported only on Windows systems.

Chapter
translators
Windows example:
<BatchMesher provider="Siemens" service="batchmesh"

isactive="false">
<TransExecutable dir="&MODULEBASE;;/Translators/batchmesh"
name="tc_batch_mesh_ets_pl.bat"/>
<Options>
</Options>
<FileExtensions>
</InputExtensions>
</FileExtensions>
</BatchMesher>
3. Open the tc_batch_mesh_ets_pl.bat file from the Dispatcher_Root\Module\Translators\

batchmesh directory and edit the CHANGE_ME tags.
For more information about CHANGE_ME tags, see the .bat file for the translator.
Enabling SimProcess service
Enabling SimProcess service
The SimProcess service supports remote launch for Simulation Process Management.
Prerequisites for SimProcess service
• The tc_launch_sim_process_ts_pl.bat file in the module/SimProcess directory points to the

Perl location. Make sure that the Perl location is correct.
• The clients and Dispatcher Server should point to the common staging directory and both should
have read/write permissions to that directory.
Enable SimProcess service
SimProcess is a sample service that supports remote launch for Simulation Process Management.
You can add custom services by copying the SimProcess service element in the translator.xml file
and changing the service attribute.

Note
The service name in the translator.xml file must match the process name in the
Simulation Tools Configuration window in CAE Manager for each custom service you
add.

Windows example:
<SimProcess provider="SIEMENS" service="simprocess" isactive="false">

<TransExecutable dir="&MODULEBASE/Translators/simprocess"
name="tc_launch_sim_process_ts_pl.bat"/>
<Options>
</Options>
<FileExtensions>
</InputExtensions>
</FileExtensions>
</SimProcess>
3. If you add custom services, add an entry (see example) in the TSSimProcessService.properties
file for each service. The TSSimProcessService.properties file is available from the
DCTransSvcs.jar file in the DispatcherClient\lib directory.
Note
You can copy parameters of an existing provider and edit them as described in the
following example.
Example:
# Provider Name : XYZ

# Translator Name: new_process
Translator.SIEMENS.new_process.Prepare=com.teamcenter.ets.translator.
ugs.simprocess.TaskPrep
Translator.SIEMENS.new_process.Load=com.teamcenter.ets.translator.
ugs.simprocess.DatabaseOperation
4. Open the Service.properties file from the DispatcherClient\conf directory and edit the
Service.DataSetOwner property to set it to CAD. By default, it is set to DC.
CAD specifies that the owner of visualization data sets and the owner of the corresponding
translation source data sets are the same.

Chapter
translators
5. (Optional) If you want to receive notifications, open the Service.properties file from the
DispatcherClient\conf directory and edit the following properties as appropriate:
• Service.Email.SendUserEmailOnError=1 (by default, it is set to 0, that is, turned off)
• Service.Email.SenderId=CHANGE_ME@LOCALHOST: Change as appropriate for

administrator and user e-mail notifications.
Note
For more information about configuring e-mail properties, see the Service.properties
file in the DispatcherClient\conf directory.
Enable JtToBBoxAndTso service

The JtToBBoxAndTso service generates bounding box and TSO files from JT files in Teamcenter.
Note
Teamcenter and the jttobboxandtso utility must be installed to use this service.

<JtToBBoxAndTso provider="SIEMENS" service="jttobboxandtso"
isactive="false" OutputNeeded="false">
<TransExecutable dir="&MODULEBASE/Translators/jttobboxandtso"
name="jttobboxandtso.bat" />
<Options>
<Option name="mode" string="-mode="
value="process"
description="Utility will always run in process mode"/>
<Option name="clientoption" optionkey="TRANSLATION_MODE"
string="-translation_mode="
value="JTTOBBOX+JTTOTSO"
description="Translator mode options."/>
<Option name="inputpath" string="-dataset_list="
</Options>
<TransErrorStreamExcl string="0 errors"/>
<FileExtensions>
</InputExtensions>
</FileExtensions>
</JtToBBoxAndTso>
3. Edit the CHANGE_ME tags in the jttobboxandtso and jttobboxandtso.bat files in the
Dispatcher_Root\Module\Translators\jttobboxandtso directory.

For more information, see the respective files.
4. From the command prompt, run the translator in stand-alone mode to verify whether it is working
properly.
For information about running the translator in stand-alone mode, from a command prompt,
change to the Dispatcher_Root\Module\Translators\jttobboxandtso directory and call
jttobboxandtso.bat -help.
Enabling PdfGenerator service

Enabling PdfGenerator service
The PdfGenerator service converts a variety of file formats, such as Microsoft Office documents
(.doc, .docx, .xls, .xlsx, .ppt, .pptx) and others (Postscript, Adobe Photoshop, WordPerfect,
Rich Text, Bitmap, GIF, JPEG, and TIFF), to Adobe PDF (.pdf) and directly stores the .pdf file in
Teamcenter.
Note
This service is supported on Windows only.
Prerequisites for PdfGenerator service

• Adobe LiveCycle PDF Generator ES (configured as WatchedFolder).
• When the WatchedFolder is shared across the network, users must have complete read/write
permissions to the shared WatchedFolder directory.
The Watched Folder Input Dir and Watched Folder Result Dir must point to the same location
as the Adobe LiveCycle watched folder input and result directories, respectively. You must also
modify the default applications extension to include other file types for generating.
For more information about configuring these directories and setting up application extensions,
see Adobe LiveCycle documentation.
• Do not append %Y/%M/%D in the result folder directory. This can be an absolute or relative
directory path. Include file pattern *.
Enable PdfGenerator
<PdfGenerator isactive="false" provider="SIEMENS" service="pdfgenerator">
<SysExecutable name="&JAVABIN\java"/>
<Options>
append=";&MODULEBASE/Translators/docmgt_translators/lib/
docmgt_pdfgenerator&PT_JFV.jar;&MODULEBASE/Translators/
docmgt_translators/lib/log4j-1.2.13.jar"
description="Classpath to the java virtual machine."/>

Chapter
translators

value="com.teamcenter.docmgt.translator.pdfgenerator.PdfGenerator"
description="Teamcenter Document Management PdfGenerator
Translator class."/>
<Option name="configfFile" string="-configFile"
value="&MODULEBASE/Translators/
docmgt_translators/config/pdfgenerator_config.properties"
description="Path to pdfgenerator configuration file"/>
<Option name="inputpath" string="-inputFile"
<Option name="inputdir" string="-inputDir"
<Option name="outputdir" string="-outputDir"
<Option name="clientoption" optionkey="OUTPUT_TYPE"
string="-outputFormat" value="PDF"
description="The output file type. Values can be PDF."/>
<Option name="clientoption" optionkey="serverSettingFile"
string="-serverSetting" value="CHANGE_ME"
description="Server setting file. Contains watermarks, stamps,
and etc"/>
</Options>
<FileExtensions>

<InputExtension extension=".bmp"/>
<InputExtension extension=".gif"/>
<InputExtension extension=".jpg"/>
<InputExtension extension=".jpeg"/>
<InputExtension extension=".tif"/>
<InputExtension extension=".dft"/>

<InputExtension extension=".doc"/>
<InputExtension extension=".docx"/>
<InputExtension extension=".xls"/>
<InputExtension extension=".xlsx"/>
<InputExtension extension=".ppt"/>
<InputExtension extension=".pptx"/>
<InputExtension extension=".mpp"/>

<InputExtension extension=".ascii"/>
<InputExtension extension=".rtf"/>
<InputExtension extension=".ps"/>
<InputExtension extension=".eps"/>
<InputExtension extension=".psd"/>
</InputExtensions>
<OutputExtension extension=".pdf"/>
</OutputExtensions>
</FileExtensions>
</PdfGenerator>

Note
Skip this step if you use TEM to install and configure this service.
3. (Optional) Open the Dispatcher_Root\Module\Translators\docmgt_translators\pdfgenerator\

pdfgenerator.bat file and edit the CHANGE_ME tags.
For more information, see the pdfgenerator.bat file.
4. (Optional) Open the Dispatcher_Root\Module\Translators\docmgt_translators\config\

pdfgenerator_config.properties file and edit configuration properties.
The configuration properties are set automatically when you use TEM to install and configure
this service.
For more information, see the pdfgenerator_config.properties file.
5. Run the translator from the command prompt in stand-alone mode to test whether it is working
properly.
change to the Dispatcher_Root\Module\Translators\docmgt_translators\pdfgenerator
directory and call pdfgenerator.bat -help.
Enabling RenderMgtTranslator service
Enabling RenderMgtTranslator service
The RenderMgtTranslator service translates files from one input file format to another output file
format and stores the output files in Teamcenter.
Prerequisites for RenderMgtTranslator service
• Requires PdfGenerator and/or PreviewService.
Use TEM to install and configure either PdfGenerator or PreviewService.

If you use PreviewService, Teamcenter Visualization Convert and Ghostscript 8.53 are
prerequisites. To use Ghostscript for PDF conversions:
o Modify the PSPath property in the vvcp.cfg file to point to the location where Ghostscript is
installed.
o Set the AllowOpenApplication property to on to convert a file that is already open in an

application.
For more information, see the vvcp.cfg file.

Chapter
translators
Note
Verify whether Teamcenter Visualization Convert is installed correctly by performing a
test conversion using the prepare command line utility. You can run this utility from
the VIS_version/VVCP directory.
• You can use any other translator if the translator is defined as a dispatcher service
configuration in Business Modeler IDE and the ServiceToExeMap attributes in the
Dispatcher_Root\Module\conf\translator.xml file are set to the location of the translator .bat
(Windows) or .sh (UNIX) files.
Note
You can use the rendermgt_previewservice.bat or rendermgt_previewservice.sh
file in the Dispatcher_Root\Module\Translators\previewservice directory as a
template for creating the .bat or .sh file for your custom translator.
Enable RenderMgtTranslator
<RenderMgtTranslator isactive="false" provider="SIEMENS"
service="rendermgttranslator">
<Options>
append=";&MODULEBASE/Translators/docmgt_translators/lib/
docmgt_rendermgttranslator&PT_JFV.jar;&MODULEBASE/Translators/
docmgt_translators/lib/log4j-1.2.13.jar;&MODULEBASE/Translators/
docmgt_translators/lib/jdom.jar"
value="com.teamcenter.docmgt.translator.rendermgttranslator.
RenderMgtTranslator"
description="Teamcenter Document Management RenderMgtTranslator
Translator class."/>
<Option name="configFile" string="-configFile"
value="&MODULEBASE/Translators/
docmgt_translators/config/rendermgttrans_config.properties"
description="Path to RenderMgtTranslator configuration file"/>
<Option name="inputpath" string="-inputFile"
description="Full path to the task xml input file." />
<Option name="inputdir" string="-inputDir"
<Option name="outputdir" string="-outputDir"
<Option name="ServiceToExeMap_1" string="-serviceToExeMap"
value="previewservice=&MODULEBASE/Translators/previewservice/
rendermgt_previewservice.bat" description="The translator
executable of previewservice translation service.
See the previewservice translation service definition defined
in this file."/>

<Option name="ServiceToExeMap_2" string="-serviceToExeMap"

value="pdfgenerator=&MODULEBASE/Translators/docmgt_translators/
pdfgenerator/pdfgenerator.bat" description="The translator
executable of pdfgenerator translation service. See the
pdfgenerator translation service definition defined in
this file."/>
</Options>
<FileExtensions>

</InputExtensions>
<OutputExtension extension=".ps"/>
<OutputExtension extension=".tif"/>
<OutputExtension extension=".jpg"/>
</OutputExtensions>
</FileExtensions>
</RenderMgtTranslator>
Note
3. (Optional) Open the Dispatcher_Root\Module\Translators\docmgt_translators\config\

rendermgttrans_config.properties file and edit the configuration properties.
The configuration properties are set automatically when you use TEM to install and configure
this service.
For more information, see the rendermgttrans_config.properties file.
Enable QSEARCH_process_queue service

The QSEARCH_process_queue service generates spatial index boxes.
Note
Teamcenter and the qsearchprocessqueue utility should be installed to use this service.

Chapter
translators

<QSEARCH_process_queue provider="SIEMENS"
service="qsearchprocessqueue" isactive="false"
OutputNeeded="false">
<TransExecutable dir="&MODULEBASE/Translators/qsearch"
name="qsearch_process_queue.bat"/>
<Options>
<Option name="mode" string="-mode=" value="process"
description="mode flag"/>
<Option name="clientoption" optionkey="QSearchTranslation"
string="-qsmode=" value="not_used_here"
description="Translator mode options."/>
<Option name="inputpath" string="-input_uid_list="
</Options>
</QSEARCH_process_queue>
Note
3. Run the translator from the command prompt in stand-alone mode to test whether it is working
properly.
Windows example: From a command prompt, change to the
Dispatcher_Root\Module\Translators\qsearch directory and call qsearch_process_queue.bat
-help.
Enabling the Simpgen translator
Enabling the Simpgen translator

The Simpgen translator is primarily used to create assembly-level simplification geometry.
Prerequisites for Simpgen translator

• The Simpgen translator requires Perl 5.0.3 or later.
• Licenses for Teamcenter and Teamcenter lifecycle visualization mockup (for the JtOptimize
utility). An additional license is required to work with JtSimplification data in the viewer.
For more information, contact your Siemens PLM Software representative.
• OpenGL on the Teamcenter server. OpenGL is an open source environment for developing
2D and 3D graphics applications.
For more information, see the OpenGL website.

The Simpgen translator heavily leverages the graphics hardware. Siemens PLM Software
recommends that you install a high-end graphics card for better performance. When this
translator is run on a UNIX machine, a user with appropriate permissions must locally log on to
the machine to initialize the graphics hardware and grant hardware permission (for example,
using the xhost command) to other users who start the dispatcher remotely.
For more information, see the Dispatcher_Root\Module\Translators\simpgen\Readme.txt file.
• The clients and Dispatcher Server should point to the common staging directory and both
should have read/write permissions to that directory. Additionally, the common staging directory
should have sufficient disk space to store temporary PLM/XML and JT files created during the
translation process.
The Dispatcher Server allows translations using a Web server (Web mode) or through remote
method invocation (RMI) mode. RMI mode requires a common staging directory.
• When JtSimplification production is performed on an assembly under which a JtSimplification

dataset already exists for one or more item revisions, the existing JtSimplification dataset
is overwritten. To avoid accidental overwrite of the JtSimplification dataset, Siemens PLM
Software recommends that only a select few user accounts are given the authority to perform
JtSimplification production.
VIS_simpgen_admin_group site preference is used to give the user group the authority to run
the Simpgen translator from the Teamcenter Translation menu.
The default value for this site preference is SimpGenAdmin. You can specify the name of a
Teamcenter group as a valid value.
Enable Simpgen
<Simpgen provider="SIEMENS" service="simpgen" isactive="false"
maxlimit="1" NoOfTries="1" OutputNeeded="false">
<TransExecutable dir="&MODULEBASE/Translators/simpgen"
name="simpgen.bat"/>
<Options>
<Option name="outputpath" string="-output_file="
<Option name="clientoption" optionkey="Username" string="-user="
value="" description="Username of the translation task"/>
<Option name="clientoption" optionkey="Group" string="-group="
value="" description="Group of the translation task"/>
<Option name="clientoption" optionkey="RevisionRule"
string="-revision_rule="
value="" description="Revision rule name"/>
<Option name="clientoption" optionkey="ItemID" string="-item="
value="" description="Item ID of the translated dataset"/>
<Option name="clientoption" optionkey="Revision" string="-rev="
value="" description="Item Revision of the translated dataset"/>
</Options>
<TransErrorStreamExcl string="0 errors during this run"/>
<FileExtensions>

Chapter
translators
<OutputExtension extension=".plmxml"/>
</OutputExtensions>
</FileExtensions>
</Simpgen>
3. Update the optionkey, string, and description attributes as follows.

<Option name="clientoption" optionkey="ItemID" string="-item=" value=""
description="Item ID of the translated dataset"/>
Change to:
<Option name="clientoption" optionkey="ItemUID" string="-ItemUID=" value=""
description="UID of the Item to be translated"/>
4. Open the simpgen.bat (Windows) or simpgen.sh (UNIX) file from the

Dispatcher_Root\Module\Translators\simpgen directory and edit CHANGE_ME variables
as appropriate.
5. (Optional) Run the translator in stand-alone mode from the command prompt to verify whether it
is working properly.
For more information about running the translator in stand-alone mode, see the Readme file in
the Dispatcher_Root\Module\Translators\simpgen directory.
6. (Optional) To reject or allow duplicate translation requests,

set the Service.CheckForDuplicateRequests property in the
DispatcherClient\conf\Service.properties file to true or false values.
For more information, see the Service.properties file.
7. (Optional) To clean up temporary files, use the Service.RequestCleanup options in the

DispatcherClient\conf\Service.properties file.
For more information, see the Service.properties file.
8. (Optional) Open the simpgen.config file from the Dispatcher_Root\Module\Translators\

simpgen directory and edit the saved_variant_rule option to define a variant rule to generate
the JtSimplification dataset.
By default, this option does not have a variant and generates JtSimplification in nonvariant
mode.
Enable plmxml_import_export translator

The plmxml_import_export translator imports and exports objects into Teamcenter asynchronously
through rich client. Currently, it supports only exporting objects. The translator uses the
plmxml_export utility in the background to transfer objects.

<PlmXmlImportExport provider="SIEMENS"
service="plmxml_import_export" isactive="false">
<TransExecutable dir="&MODULEBASE/Translators/plmxml_import_export"
name="plmxml_import_export.bat"/>
<Options>
<Option name="clientoption" optionkey="user" string="-u=" value=""
description="Specifies user name to login to Teamcenter."/>
<Option name="clientoption" optionkey="password" string="-p=" value=""
description="Specifies password to login to Teamcenter."/>
<Option name="clientoption" optionkey="group" string="-g=" value=""
description="Specifies group to login to Teamcenter."/>
string="-encrypt=" value="true"
description="Specifies whether or not password is encrypted
to login to Teamcenter."/>
<Option name="clientoption" optionkey="mode" string="-mode=" value=""
description="Mode of operation Import or Export"/>
<Option name="clientoption" optionkey="file" string="" value=""
description="Specifies output filename."/>
<Option name="clientoption" optionkey="logfilename" string="" value=""
description="Specifies log filename."/>
</Options>
<FileExtensions>
</InputExtensions>
<OutputExtension extension=".log"/>
</OutputExtensions>
</FileExtensions>
</PlmXmlImportExport>
3. Open the plmxml_import_export.bat (Windows) or plmxml_import_export.sh (UNIX) file

from the Dispatcher_Root\Module\Translators\ plmxml_import_export directory and edit the
CHANGE_ME variables, that is, TC_ROOT and TC_DATA variables to match your installation.
Enable populateFSC translator

The populateFSC translator supports FSC caching of structured context object (SCO) content at
non-database sites. The translator generates a PLM XML file of the SCO object, parses it for file
global unique IDs (GUIDs), and generates read tickets for all the files referenced in the PLM XML file.
You can use the read tickets to load the FSC cache of a target/distant FSC serving the same database.
<PopulateFSC provider="SIEMENS" service="populatefsc" isactive="false">
<TransExecutable name="populatefsc.bat"
dir="&MODULEBASE/Translators/populatefsc"/>

Chapter
translators
<Options>
<Option name="clientoption" optionkey="FSC_TARGETS" string="-targets="
value=""
description="Target FSC Server URI that has to be loaded"/>
<Option name="clientoption" optionkey="SCO_UID" string="-uid="
value=""
description="UID of the Structured Context Object(SCO)"/>
</Options>
</PopulateFSC>
3. Open the populatefsc.bat (Windows) or populatefsc.sh (UNIX) file from the

Dispatcher_Root\Module\Translators\populatefsc directory and edit the CHANGE_ME
variables, that is, TC_ROOT, TC_DATA, and PERL_DIR variables to match your installation.
Enabling BatchPrint translator

Enabling BatchPrint translator
The BatchPrint Dispatcher client handles calls from the RAC and thin client to process the batch
printing of files. This translator processes batch print requests submitted by the BatchPrint
Dispatcher client. The batchprint.bat (for Windows) or batchprint.sh (for UNIX, Linux, and Mac
OS) file invokes the Vis Print application to print the selected files.
Prerequisites for BatchPrint translator

• Vis Home Path location, that is, the path to the visualization directory while installing BatchPrint
using TEM.
• Vis License location while installing BatchPrint using TEM.
Enable BatchPrint
<BatchPrint provider="SIEMENS" service="batchprint" isactive="true">
<Options>
append=";&MODULEBASE/Translators/batchprint/lib/
docmgt_batchprint.jar;&MODULEBASE/Translators/
batchprint/lib/log4j-1.2.13.jar;&MODULEBASE/
Translators/batchprint/lib/jdom.jar"

value="com.teamcenter.docmgt.batchprint.BatchPrint"
description="Teamcenter Document Management BatchPrint class."/>
<Option name="inputpath" string="-inputPath"
description="The task input XML file." />
<Option name="configFile" string="-configFile" value="&MODULEBASE/
Translators/batchprint/config/batchprint_config.properties"
description="The BatchPrint configuration file."/>
<Option name="exefile" string="-exeFile" value="&MODULEBASE/
Translators/batchprint/script/batchprint.bat"
description="The executable used for batch printing."/>
</Options>
<FileExtensions>

</InputExtensions>
</FileExtensions>
</BatchPrint>
Note
3. Edit the CHANGE_ME properties in the batchprint.bat (Windows) or batchprint.sh (UNIX) file
from the Dispatcher_Root\Module\Translators\batchprint\script\ directory.
Note
Enabling QueryScos translator
Enabling QueryScos translator

The QueryScos translator generates a list of structure context objects (SCOs) for a given saved query
or folder containing the SCOs. The generated SCOs are used by the RdvContextDBDownload
or RdvContextNONDBDownload translators.
Prerequisites for QueryScos translator

• Start the start_sco_dispatcher utility to invoke the query_scos translator.
• Install the RdvContextDBDownload or RdvContextNONDBDownload translator.
Enable QueryScos

Chapter
translators
<QueryScos provider="SIEMENS" service="queryscos" isactive="false">

<TransExecutable name="queryscos.bat" dir="&MODULEBASE/
Translators/queryscos"/>
<Options>
description="Full path to the input file which will contain
user input for complete dispatcher service."/>
<Option name="outputfile" string="queryscos_results.txt"
description="Name of the output file containing results."/>
</Options>
<TransErrorStrings>
<TransErrorStream string="ERROR"/>
<FileExtensions>
<OutputExtension extension=".txt"/>
</OutputExtensions>
</FileExtensions>
</QueryScos>
Note
3. Edit the CHANGE_ME properties in the queryscos.bat (Windows) or queryscos.sh (UNIX) file
from the Dispatcher_Root\Module\Translators\queryscos\ directory.
Note
Enable plmxmltojt translator

The plmxmltojt translator translates PLMXML files (.plmxml) to JT (.jt) and directly stores the default
configuration JT files in Teamcenter Engineering.
Note
Teamcenter and the supported plmxmltojt utility must be installed to use this translator.

<plmxmltojt provider="SIEMENS" service="plmxmltojt" isactive="false"

maxlimit="3" NoOfTries="1" OutputNeeded="true">

<TransExecutable dir="&MODULEBASE/Translators/plmxmltojt"
name="plmxmltojt.bat"/>
<Options>
<Option name="inputpath" string="-inputpath="
<Option name="outputpath" string="-outputpath="
<Option name="clientoption" optionkey="ArgumentFilename"
string="-argfile=" value=""
description="This is a file that has all the
arguments to the translator"/>
<Option name="clientoption" optionkey="ItemID" string="-item="
value="" description="Item ID of the translated dataset"/>
<Option name="clientoption" optionkey="ItemName" string="-itemname="
value="" description="Item name of the translated dataset"/>
value="" description="Item Revision of the
translated dataset"/>
</Options>
<FileExtensions>
</OutputExtensions>
</FileExtensions>
</plmxmltojt>
Note
3. Edit the CHANGE_ME tags in the plmxmltojt.bat or plmxmltojt.sh file in the

Dispatcher_Root\Module\Translators\plmxmltojt directory.
Note
properly.
For information about running the translator in stand-alone mode, from a command
prompt, change to the Dispatcher_Root\Module\Translators\plmxmltojt directory and call
plmxmltojt.bat -help.

Chapter
translators
Enable ImportObjects translator

The ImportObjects dispatcher task executes data_share -f=remote_import for a given items list.
Note
Teamcenter and the Classic-Multisite feature must be installed to use this translator.

<ImportObjects provider="SIEMENS" service="importobjects"
isactive="false">
<TransExecutable dir="&MODULEBASE/Translators/importobjects"
name="importobjects.bat" />
<Options>
<Option name="inputpath" string="-filename="
description="Full path to the input file
containing items list."/>
<Option name="outputdir" string="-report_dir="
<Option name="clientoption" optionkey="SITE_ID" string="-site="
value=""
description="Site to import from."/>
<Option name="clientoption" optionkey="CLASSOFFILE"
string="-classoffile=" value="ItemRevision"
description="class of objects in the file."/>
<Option name="clientoption" optionkey="SELECTED_REV" string=""
value=""
description="Option to import selected revision only."/>
<Option name="clientoption" optionkey="REPORTFILE" string="-report="
value=""
description="File containing replication report"/>
</Options>
<TransErrorStrings>
<TransInputStream string="not currently available"/>
<TransErrorStream string="No site available for processing"/>
<TransErrorStreamExcl string="no error"/>
</ImportObjects>
Note
3. Edit the CHANGE_ME tags in the importobjects.bat or importobjects.sh file in the

Dispatcher_Root\Module\Translators\importobjects directory.

Note
properly.
For information about running the translator in stand-alone mode, from a command
prompt, change to the Dispatcher_Root\Module\Translators\plmxmltojt directory and call
importobjects.bat -help.
Enable ReplicatePLMXML translator

The ReplicatePLMXML dispatcher task executes data_share -f=remote_import for a given items list.
Note
Teamcenter Engineering and Classic-Multisite feature must be installed.

<ReplicatePLMXML provider="SIEMENS" service="replicateplmxml"
isactive="false">
<TransExecutable dir="&MODULEBASE/Translators/replicateplmxml"
name="replicateplmxml.bat" />
<Options>
<Option name="inputpath" string="-filename="
description="Full path to the input file containing
items list." />
<Option name="outputdir" string="-report_dir="
<Option name="clientoption" optionkey="SITE_ID" string="-site="
value=""
description="Site(s) to send to."/>
<Option name="clientoption" optionkey="CLASSOFFILE"
string="-classoffile=" value=""
description="class of objects in the file."/>
<Option name="clientoption" optionkey="SELECTED_REV" string=""
value=""
description="Option to import selected revision only"/>
<Option name="clientoption" optionkey="INCLUDE" string="-include="
value="IMAN_specification"
description="relations to include in export."/>
<Option name="clientoption" optionkey="SYNC_PLMXML_CONTENTS" string=""
value=""
description="Option to start the PLM XML based
synchronization mechanism"/>
<Option name="clientoption" optionkey="REPORTFILE" string="-report="
value=""
</Options>
<TransErrorStrings>

Chapter
translators
<TransInputStream string="not currently available"/>

<TransErrorStream string="No site available for processing"/>
<TransErrorStreamExcl string="no error"/>
</ReplicatePLMXML>
Note
3. Edit the CHANGE_ME tags in the replicateplmxml.bat or replicateplmxml.sh file in the

Dispatcher_Root\Module\Translators\replicateplmxml directory.
Note
properly.
change to the Dispatcher_Root\Module\Translators\replicateplmxml directory and call
replicateplmxml.bat -help.
Enabling CreateAssemblyPLMXML translator
Enabling CreateAssemblyPLMXML translator

The CreateAssemblyPLMXML dispatcher task creates a PLMXML file of the configured assembly
and loads it in a dataset related to the root item revision. The dispatcher task invokes the controlled
replication mechanism to replicate the configured assembly.
Note
Teamcenter and the Multi-Site Collaboration feature must be installed to use this translator.
Enable CreateAssemblyPLMXML translator

<CreateAssemblyPLMXML provider="SIEMENS" service="createassemblyplmxml"
isactive="false">

<TransExecutable dir="&MODULEBASE/Translators/createassemblyplmxml"
name="createassemblyplmxml.bat" />
<Options>
<Option name="outputdir" string="-outfile_dir="
<Option name="clientoption" optionkey="REPORTFILE"
string="-outfile_name=" value=""
<Option name="clientoption" optionkey="ITEM_ID" string="-item="
value=""
description="File containing list of items to send."/>
<Option name="clientoption" optionkey="REV_ID" string="-rev="
value=""
description="Item Revision"/>
<Option name="clientoption" optionkey="REVISION_RULE"
string="-revision_rule=" value="Latest Working"
description="Revision rule to use for
configuring assembly"/>
<Option name="clientoption" optionkey="VARIANT_RULE"
string="-svrule=" value=""
description="Variant rule to use for configuring assembly"/>
<Option name="clientoption" optionkey="EMAIL" string="-notify_email="
value=""
description="mail id to send error"/>
<Option name="clientoption" optionkey="CHECK_PRECISE"
string="" value=""
description="do precise check on assembly"/>
<Option name="clientoption" optionkey="CHECK_NOSTUBS" string=""
value=""
description="do no-stubs check on assembly"/>
<Option name="clientoption" optionkey="CHECK_ALL_RELEASED" string=""
value=""
description="do all released check on assembly"/>
<Option name="clientoption" optionkey="CREATE_JTFILE" string=""
value=""
description="invoke the nxtopvdirect translator for
assembly root item revision"/>
<Option name="clientoption" optionkey="START_SYNC"
string="-start_sync" value=""
description="Invoke replication for the PLM XML"/>
<Option name="clientoption" optionkey="DEST_SITES_PER_SYNC"
string="-num_sites=" value="0"
description="separate data_share will we invoked to
replicate to num_sites. 0 (or negative) corresponds to all
destination sites in single data_share"/>
<Option name="clientoption" optionkey="TESSELATION_WAIT_TIME"
string="-tesselation_wait_time=" value="600"
description="Used only with create JT. Creation of assembly
PLM XML, will wait for the the time (in seconds) for the
tesselation task to complete, before continuing with other
operations"/>
</Options>
</CreateAssemblyPLMXML>

Chapter
translators
Note
3. Edit the CHANGE_ME tags in the createassemblyplmxml.bat or createassemblyplmxml.sh

file in the Dispatcher_Root\Module\Translators\createassemblyplmxml directory.
Note
properly.
change to the Dispatcher_Root\Module\Translators\createassemblyplmxml directory and call
createassemblyplmxml.bat -help.
Enable CreateAssemblyPLMXML translator in an SSO environment

To enable the CreateAssemblyPLMXML translator in an SSO environment, install the Dispatcher in
a non-SSO environment and perform the following steps for each site:
1. Stop Dispatcher services.
2. Choose a DBA user, say user (dcproxy is the default user).
3. Create a password abc.txt file containing the password for the dcproxy user.
The default password file for the dcproxy user is TC_BIN\PasswordFile.txt.
4. Edit the following files:

• createassemblyplmxml\createassemblyplmxml.sh (UNIX) or
createassemblyplmxml\createassemblyplmxml.bat (Windows)
• replicateplmxml\replicateplmxml.sh (UNIX) or replicateplmxml\replicateplmxml.bat

(Windows)
• plmxmlbasedsync\plmxmlbasedsync.sh (UNIX) or
plmxmlbasedsync\plmxmlbasedsync.bat (Windows)
• importobjects\importobjects.sh (UNIX) or importobjects\importobjects.bat (Windows)
5. Change as follows.
• UNIX example: TC_ROOT/bin/data_share -u=dcproxy -pf=TC_ROOT/PasswordFile.txt
-f=remote_import

Change to:
TC_ROOT/bin/data_share -u=user -pf=/usr/securepwds/abc.txt -f=remote_import
• Windows example: TC_ROOT\bin\data_share.exe -u=dcproxy

-pf=TC_ROOT\PasswordFile.txt -f=remote_import %*
Change to:
TC_ROOT\bin\data_share.exe -u=user -pf=C:\dispatchpwds\abc.txt -f=remote_import
%*
6. Start the Dispatcher.
Enable PLMXMLBasedSync translator

The PLMXMLBasedSync dispatcher task parses the PLMXML file of a configured assembly,
identifies item revisions that need sync/import and does the import as per controlled replication
mechanism.
Note
Teamcenter and the Classic-Multisite feature must be installed to use this translator.

<PLMXMLBasedSync provider="SIEMENS" service="plmxmlbasedsync"
isactive="false">
<TransExecutable dir="&MODULEBASE/Translators/plmxmlbasedsync"
name="plmxmlbasedsync.bat" />
<Options>
<Option name="outputdir" string="-outfile_dir="
<Option name="clientoption" optionkey="REPORTFILE"
string="-outfile_name=" value=""
<Option name="clientoption" optionkey="OBJECT_UID" string="-wso_uid="
value="" description="Object, whose attached PLM XML
needs to be parsed."/>
<Option name="clientoption" optionkey="TIMEOFFSET"
string="-timeoffset=" value=""
description="Time offset with GMT at owning site."/>
<Option name="clientoption" optionkey="START_IMPORT"
string="-start_sync" value=""
description="start import based on parsing result"/>
<Option name="clientoption" optionkey="IMPORT_ITEMS_PER_SITE"
string="-num_items=" value="0"
description="separate data_share will we invoked to
replicate to num_itemss. 0 (or negative) corresponds
to all items owned at one site in single data_share"/>
</Options>

Chapter
translators
</PLMXMLBasedSync>
Note
3. Edit the CHANGE_ME tags in the plmxmlbasedsync.bat or plmxmlbasedsync.sh file in the

Dispatcher_Root\Module\Translators\plmxmlbasedsync directory.
Note
properly.
change to the Dispatcher_Root\Module\Translators\plmxmlbasedsync directory and call
plmxmlbasedsync.bat -help.
Configuring asynchronous services
Configuring asynchronous services

The AsyncService translator independently processes asynchronous requests constructed by the
Teamcenter server using Teamcenter SOA native C++ framework in background mode.
Background operations are accomplished by using the Dispatcher to hold and schedule the
asynchronous request and to initiate the operation as a standard services oriented architecture (SOA)
request in a separate Teamcenter four-tier session. Operations are executed using the Teamcenter
middle tier for session management and load balancing.
The operation can be executed either on the local site or on a remote site. When running the
operation on a remote site, the asynchronous facility uses the same configuration and authentication
information in the site object as used by Teamcenter Multi-Site.
If the site uses Teamcenter Security Services single sign-on (SSO), the asynchronous facility uses
SSO tokens to authenticate to the remote site. After the request completes, the Teamcenter
event/notification/subscription service is used to inform the user that the background task has
completed.
The asynchronous session is initiated in a new session as the same user/group/role and locale as
the original session.
• Authentication without Security Services

The original Teamcenter server session generates a unique authentication token for the user,
encrypts it, and stores it with the background request. When the request is executed, this token is
decrypted and used in place of a password to authenticate the user’s session.
• Remote invocation
The asynchronous facility can execute the operation on a remote site if the installation is
configured for Multi-Site.
Configuring the asynchronous environment

• Set up a four-tier environment.
• Set SOA URL for your site.

Use the Organization application add the middle tier system’s URL to the SOA URL field in the
site object of your local site and each remote site to which you need to send asynchronous
requests. This should have the same base value as used to set up and configure the middle
tier and to run the Web client and rich client.
Example:
http://localhost:7001/tc
If you use SSL to access Teamcenter, that is, if the address starts with "https:", then ensure that
a proper certificate is stored in the business logic server's trust certificate store file.
• Set up the AsyncService service.
• Set up automatic logon or the user name and password file logon for the async_invoker service.
o Setting up automatic logon.
You must set up the operating system user name on which you run the Dispatcher module
that runs the AsyncService service to execute Teamcenter utilities in autologon mode. That
is, make sure there is a Teamcenter user who has the same OS user name setting as the
operating system user running the module service. This Teamcenter user needs no special
privileges and can be a new unique Teamcenter user or an existing administrative user.
■ Use the Organization application to create or find this user, and specify a valid OS Name
field for the Teamcenter user.
■ Use this operating system name to log on to Windows or UNIX, or to set up the
logon information for the Windows service for the Dispatcher module that runs the
AsyncService service.
■ Test the autologon mode by running a Teamcenter utility called list_users without
providing a user name or password.

Chapter
translators
Note
This ensures that the Dispatcher module does not prompt for the Teamcenter
user name and password. If autologon is not working, the AsyncService
service hangs waiting for input from the non-interactive standard input stream
and the Dispatcher module cannot complete the request.
o Configure the user name and password file logon.

In the Dispatcher_Root\Dispatcher\Module\Translators\asyncservice\asyncservice.bat
file (asyncservice.sh file for UNIX) add the -u and -pf parameters to the end of the line
that invokes the asyncinvoker program.
Windows example:
"async_invoker.exe" %1 %2 %3 %4 %5 -u=tcadmin -pf=C:\teamcenter_creds\pwf.txt
Note
Ensure that password files are managed well and private. Only users who run
Teamcenter servers, in this case, the Dispatcher module, should have access
to password files.
In a Teamcenter Security Services environment, remove or comment the following lines to

allow Teamcenter Security Services authentication to takes place:
rem disable SSO for asyncservice so that auto-login can complete.
set TC_SSO_APP_ID=
set TC_SSO_SERVICE=
set TC_SSO_LOGIN_URL=
• Configuring connection retries.

If the async_invoker service cannot connect to the four-tier environment, it retries a configurable
number of times (60), at a configurable interval (60 seconds), before giving up and failing. To
change the retry count or interval, set the following preferences:
preferences_manager -u=user–id -p=password -g=dba -mode=import
-preference=ASYNC_connection_retries -scope=SITE -values=1 -action=OVERRIDE
preferences_manager -u=user–id -p=password -g=dba -mode=import

-preference=ASYNC_connection_retry_interval -scope=SITE -values=10
-action=OVERRIDE
Configuring Dispatcher
• Install Dispatcher and set up the dispatcher client, scheduler, and module.
• Set the maxlimit parameter to run multiple requests.

By default, the dispatcher module runs only one request of a particular type at a time.
This limits your throughput as users may submit many requests. However, ensure that
you do not allow more requests than your server manager pool can handle at a time. To

configure this value, add the maxlimit parameter to the AsyncService element in the
Dispatcher_Root\Module\conf\translator.xml file.
Example:
<AsyncService provider="SIEMENS" service="asyncservice"
maxlimit="2" isactive="true">
• Clean up temporary files.

To clean up temporary files, use the Service.RequestCleanup options in the
DispatcherClient/conf/Service.properties file.
For more information, see the DispatcherClient/conf/Service.properties file.
Configuring Security Services
Note
Skip this topic if you do not use Security Services.
The asynchronous facility supports Security Services for authentication of the asynchronous session.
When calling requests on a different site, both the calling and destination site must use the same
Teamcenter Security Services directory. In addition, you must configure Teamcenter and Security
Services to define a shared mediator key.
A type of Teamcenter Security Services token is used only in conjunction with mediating applications.
Mediating applications (such as the Teamcenter when invoking the AsyncService service) can
assume the role of a Security Services session agent and submit special Security Services logon
requests. All logon requests to Security Services return a Teamcenter Security Services application
token built for the target application, but the token which Teamcenter Security Services returns to
the mediating application has a special structure: It contains an inner token, which is intended for
the target application. That token is returned to the mediating application wrapped in an outer token
that is separately encrypted. The mediating application decrypts the outer token and extracts and
forwards the inner token to the target Teamcenter Security Services application, which subsequently
validates that token back with Security Services.
Note
Configuring asynchronous services with Security Services depends on a valid security
services session that has not been affected by a timeout or expiration.
To configure Teamcenter Security Services application tokens:

• Set a mediator password in Security Services (using Web Application Manager while building
Security Services).
• Set the same mediator password into Teamcenter (using install_encryption_keys).

Run the install_encryptionkeys utility as follows, and enter the mediator password when the
utility prompts for the password:
install_encryptionkeys -u=infodba -p=<pw> -g=dba -f=install_mediator_key

Chapter
translators
If the default one week lifetime is not adequate, set the ASYNC_credentials_lifetime site preference.
When the server calls an asynchronous request, it obtains an special double-encrypted token
from the Security Services Identity Service and stores it in the DispatcherRequest along with the
other information for the request. When the Dispatcher schedules and invokes the request, the
AsyncService service uses the mediator key to decrypt the token and uses it to log on to the new
Teamcenter session as the original user.
Configure HTTP enabled Multi-Site for single sign-on
If you use Security Services single sign-on (SSO) functionality, configure the
TC_SSO_app_id_of_site_site-name preference at the site. site-name represents the name of the
site, and this preference does not exist by default. The preference value must match the Application
ID value for the site as defined in the Application Registry table.
Note
All sites that are using SSO must be in the same SSO domain.
Enable the AsyncService translator

The AsyncService translator independently processes asynchronous requests constructed by the
server using Teamcenter service-oriented architecture (SOA) native C++ framework in background
mode.
1. Open the translator.xml file in the Dispatcher_Root\Module\conf directory.
<AsyncService provider="SIEMENS" service="asyncservice" isactive="false">
<TransExecutable name="asyncservice.bat" dir="&MODULEBASE/Translators/
asyncservice"/>
<Options>
description="Full path to the input file or directory ."/>
<Option name="OutputFileName" string="" value="output.txt"
description="Name of the output file."/>
</Options>
<TransErrorStrings>
<TransInputStream string="AsyncInvoker Report"/>
<TransErrorStream string="AsyncInvoker Report"/>
</AsyncService>
Note
3. Edit the CHANGE_ME tags in the asyncservice.bat (Windows) or asyncservice.sh (UNIX) file
in the Dispatcher_Root\Module\Translators\asyncservice directory.

Note
Skip this step if you use Teamcenter Environment Manager (TEM) to install and
configure this translator.
4. Create the input required for this translator.

Example 1:
Create an item revision, right-click the item revision, and send it to Structure Manager. Select
File→Duplicate and select the Run in Background option.
Example 2:
Create a workflow task in Workflow Designer. When you create this workflow task, be sure to
select the Process in Background option in the Attributes dialog.
The system creates an input.txt file. You can use this file as the input for this translator.
properly.
change to the Dispatcher_Root\Module\Translators\asyncservice directory and call
asyncservice.bat -help (Windows) or asyncservice.sh -help (UNIX).
To run this translator in stand-alone mode, you must specify the full path name of the file that
holds the async request arguments by editing the asyncservice.bat file.
Example:
asyncservice.bat C:\Dispatcher\input.txt C:\Dispatcher\result\output.txt
ARG1 is a full path name of the file which holds the async request arguments.
ARG2 is the location of the result files (log, output, etc).
ARG3 is the output file name that the async invoker program generates.
Where C:\Dispatcher\input.txt is the full path name of the file used as the input for this translator
and is generated by running the workflow task (step 4) and C:\Dispatcher\result\output.txt is
the output file that the AsyncService translator generates.
Enabling PublishBatch translator

Enabling PublishBatch translator
The PublishBatch translator uses the Dispatcher infrastructure for scheduling create and update
features.
Prerequisites for PublishBatch translator

• The translator is supported on Windows only.
• VisAutomationApp, Microsoft Visio, FMS file client cache (FCC), and the Teamcenter SOA client
installed on the translator machine.

Chapter
translators
Note
The VisAutomationApp is installed automatically when you install Lifecycle
Visualization.
For more information about installing Lifecycle Visualization, see the Teamcenter lifecycle
visualization Install Guide.
For more information about installing MS Visio, see the Microsoft Visio Online Help.
• The startPublishBatch.bat file is installed in a directory that is specified during installation of the
PublishBatch translator. Each setting in this file must be modified as specified in the file.
• The transmodule.properties file in the module/conf directory has a setting called

MaximumTasks that defaults to 3. This defines the maximum number of instances of publish
batch tasks that can run simultaneously. Do not increase this value above 3.
• The clients and Dispatcher Server should point to the common staging directory with read/write
permissions to the directory.
Enable PublishBatch translator

<TcPublishBatch provider="SIEMENS" service="publishbatch" isactive="true">
<TransExecutable dir="D:/Dispatcher/PublishBatch/tcpublishbatch/"
name="startPublishBatch.bat" />
<Options>
</Options>
<FileExtensions>
</InputExtensions>
</FileExtensions>
</TcPublishBatch>
Note
3. (Optional) Open the startPublishBatch.bat file and add the –log option to the
TRANS_PATH\tcpublish_batch attribute.
Teamcenter then adds detailed progress and error entries to the task’s log file.

Note
The startPublishBatch.bat file is installed in a directory that is specified during
installation of the PublishBatch translator. Follow the instructions in the file to add
the –log option.
Teamcenter stores the log files in the directory you specify during installation.
Enable tcmfg_update_productviews translator

The tcmfg_update_productviews translator updates product views in a batch mode.
Note
After installing and configuring this translator, you must add a rule to the access rule tree
to permit the translation service proxy user to update attributes of a DispatcherRequest
object. If this access rule is not created correctly, the dispatcher client reports errors.

<TcUpdateProductViews provider="SIEMENS"
service="tcmfg_update_productviews" isactive="false">
<TransExecutable dir="&MODULEBASE/Translators/
tcmfg_update_productviews"
name="startUpdateProductViews.bat" />
<Options>
<Option name="outputdir" string="" description="Full path to
the output directory." />
</Options>
<FileExtensions>
</InputExtensions>
</FileExtensions>
</TcUpdateProductViews>
Note
3. Edit the CHANGE_ME tags in the startUpdateProductViews.bat or

startUpdateProductViews.sh file in the Dispatcher_Root\Module\Translators\
tcmfg_update_productviews directory.

Chapter
translators
Note
properly.
change to the Dispatcher_Root\Module\Translators\tcmfg_update_productviews directory
and call startUpdateProductViews.bat -help.
Enable tc3dpdftrans translator

The tc3dpdftrans translator creates 3D PDF reports.
<Tc3DPDFTrans provider="SIEMENS" service="tc3dpdftrans"
isactive="false">
<TransExecutable dir="&MODULEBASE/Translators/tc3dpdftrans"
name="start3DPDFTrans.bat" />
<Options>
</Options>
<FileExtensions>
</InputExtensions>
</FileExtensions>
<TransInputStreamExcl string="isNull"/>
</Tc3DPDFTrans>
Note
3. Edit the CHANGE_ME tags in the start3DPDFTrans.bat file in the Dispatcher_Root\Module\

Translators\asyncservice directory.
For more information, see the respective file.
Note

properly.
change to the Dispatcher_Root\Module\Translators\tc3dpdftrans directory and call
tc3dpdftrans.bat -help.
Enable ContMgmtPublish translator

The ContMgmtPublish translator is used to render Content Management content to an output file
format defined by a publishing tool, such as PDF or HTML. The translator then stores the output file
in Teamcenter.
Note
You can install this translator using TEM only. This translator is not designed to run in a
stand-alone mode or run by a user directly.
1. Install the required XSL formatter for this translator, such as Antenna House.
2. (Optional) If you use a DITA open toolkit to publish content, install Java JDK version 1.6 and
modify the Dispatcher_Root\Module\Translators\contmgmtpublish\config\contmgmtpublish_
config.properties file to change the JDK_HOME variable to the JDK installation directory.
Note
• Content Management supports version 2.4.6 of the DITA Open Toolkit (OT)
publishing tools.
• To use an older version of DITA OT, copy the older version of DITA OT to: the
Dispatcher_Root\Module\Translators\contmgmtpublish\lib folder.
• Set the path for DITA_ANT_HOME in the Dispatcher_Root\Module\Translators\

contmgmtpublish\config\contmgmtpublish_config.properties file. The path
must be set to the Ant directory in the DITA OT.
3. To verify the installation, after you set up the ContMgmtPublish translator, publish a topic
revision using Teamcenter Content Management rich client (Tools→Publish Content).
Enabling the mmvindexgen translator

Enabling the mmvindexgen translator
An MMV dataset consists of a spatial hierarchy of a model, which is harvested from JT data using
the Teamcenter Dispatcher mmvindexgen translator. You can use the My Teamcenter Translation
menu to automate the generation of the spatial index on a recurring basis, in order to capture design
changes over the course of the product lifecycle.

Chapter
translators
Prerequisites for mmvindexgen translator
• The clients and the Dispatcher Server should point to the common staging directory and both
should have read/write permissions to that directory. Additionally, the common staging directory
should have sufficient disk space to store temporary PLM/XML and JT files created during the
translation process.
The Dispatcher Server allows translations using a Web server (Web mode) or through remote
method invocation (RMI) mode. The RMI mode requires a common staging directory.
• When MMV index production is performed on an assembly under which a Spatial Hierarchy
dataset already exists for one or more item revisions, the existing Spatial Hierarchy dataset
is overwritten. To avoid an accidental overwrite of the Spatial Hierarchy dataset, Siemens
PLM Software recommends that you restrict the authorization of performing Spatial Hierarchy
production to select user accounts. The VIS_mmvindexgen_admin_group site preference
is used to give the user group the authority to run the mmvindexgen translator from the
Teamcenter Translation menu.
• This translator requires Perl version 5.0.3 or later.
Enable mmvindexgen translator

<MmvIndexGen provider="SIEMENS" service="mmvindexgen" isactive="true"
maxlimit="1" NoOfTries="1" OutputNeeded="false">
<TransExecutable dir="&MODULEBASE/Translators/mmvindexgen"
name="mmvindexgen.bat"/>
<Options>
<Option name="clientoption" optionkey="itemuid" string="-itemuid="
value="" description="UID of the Item to be translated"/>
value="" description="Item Revision to be translated"/>
</Options>
<TransErrorStrings>
<TransErrorStream string="Can't"/>
<TransErrorStream string="incorrect"/>
</MmvIndexGen>
Note

3. Edit the CHANGE_ME tags in the mmvindexgen.bat (Windows) or mmvindexgen.sh (UNIX)

file in the Dispatcher_Root\Module\Translators\mmvindexgen directory.
For more information, see the respective file.
Note
If Dispatcher is installed on machine separate from where corporate server is installed,
make sure the TC_ROOT directory specified contains all features included in
TC_ROOT created when installing the corporate server.
4. The mmvindexgen.bat (Windows) or mmvindexgen.sh (UNIX) file in the

Dispatcher_Root\Module\Translators\mmvindexgen directory points to the Perl location.
Note
This translator requires Perl version 5.0.3 or later. You can specify this Perl path while
installing and configuring this translator using TEM.
5. (Optional) To reject or allow duplicate translation requests,

set the Service.CheckForDuplicateRequests property in the
DispatcherClient\conf\Service.properties file to true or false.
For more information, see the DispatcherClient\conf\Service.properties file.
6. (Optional) To define one or more revision rules to generate the Spatial Hierarchy dataset, open
the mmvindexgen.config file from the Dispatcher_RootModule\Translators\mmvindexgen
directory and edit the revision_rules option.
By default, this option does not have any revision rule and generates Spatial Hierarchy in the
unconfigured mode.

For more information, see the DispatcherClient\conf\Service.properties file.
properly.
For information about running the translator in a stand-alone mode, from a command prompt,
change to the Dispatcher_Root\Module\Translators\mmvindexgen directory and call
mmvindexgen.bat -help.
Enable store_and_forward translator

The store_and_forward translator supports the store and forward functionality in batch mode. It
executes the move_volume_files utility with a new -transfersaf argument. The utility queries
the entire database for the extent of user’s files under local volumes and transfers them to their

Chapter
translators
respective default volumes. The utility also creates and schedules a dispatcher task to delete the
local volume files after the ticket expiry interval.
Default local volumes are temporary local volumes that allow files to be stored locally before they
are automatically transferred to the final destination volume. This functionality is referred to as
store and forward functionality.
1. Set the TC_Store_and_Forward preference.
You must set this preference to enable store and forward functionality.
2. In the Select Translators panel in TEM, select the StoreAndForward translator.
3. Specify the Bootstrap FSC URIs value.

You must specify this value while enabling this translator using TEM.
This is generally the same as the Fms_bootStrap_Urls preference value.
4. To set the store_and_forward translator as a repeat task, in My Teamcenter, choose

Translation→Translate, select the translation service, and click Next. Select the Repeating
option and click Finish to start the translation.
Note
The Repeating option does not appear by default. You must set the
ETS.Repeating_UI.<ProviderName>.<ServiceName> preference to TRUE to display
the repeating tasks functionality.
To avoid unpredictable behavior, the (time) interval in repeating tasks must be greater
than the translation time.
Enable Teamcenter Substance Compliance services

The Teamcenter Substance Compliance solution requires the following dispatcher services:
• Compliance Results Validation: Invalidates substance compliance results based on the expiry
of exemptions on related objects.
• Supplier Declaration Import: Creates the material and substance information in Teamcenter
based on material substance declaration (MSD) files.
• Supplier Declaration Re-Request: Sends an MSD request again to suppliers, for all qualified
vendor parts.
• Email Polling: Polls email on a dedicated email account based on Teamcenter rules.
Enable these dispatcher services as follows.
Tip
If you use TEM to install and configure these services, skip steps 1 through 6.

2. To activate the SubsCmplValidationService service, set the isactive attribute to true.

<SubsCmplValidationService provider="SIEMENS"
service="subscmplvalidationservice" isactive="true">
<TransExecutable name="subscmplvalidationservice.bat"
dir="&MODULEBASE;/Translators/subscmplvalidationservice"/>
</SubsCmplValidationService>
3. To activate the SubsCmplMSDImportService service, set the isactive attribute to true.

<SubsCmplMSDImportService provider="SIEMENS"
service="subscmplmsdimport"
isactive="true">
<TransExecutable dir="&MODULEBASE;/Translators/subscmplmsdimport"
name="subscmplmsdimport.bat" />
<Options>
value="" description="username"/>
value="" description="Specifies encrypted password
token to login to Teamcenter."/>
value="" description="current group"/>
description="Specifies whether or not password
is encrypted to login to Teamcenter."/>
<Option name="clientoption" optionkey="filename" string="-file="
value="" description="input file path"/>
<Option name="clientoption" optionkey="directoryPath" string="-dir="
value="" description="option set"/>
<Option name="clientoption" optionkey="xslfilepath" string="-xsl="
value="" description="style sheet file path"/>
</Options>
</SubsCmplMSDImportService>
4. To activate the SubsCmplMSDRerequestService service, set the isactive attribute to true.

<SubsCmplMSDRerequestService provider="SIEMENS"
service="subscmplmsdrerequest" isactive="true">
<TransExecutable dir="&MODULEBASE;/Translators/subscmplmsdrerequest"
name="subscmplmsdrerequest.bat" />
<Options>
value=""
description="username"/>
value="" description="Specifies encrypted password token
to login to Teamcenter."/>

Chapter
translators
string="-encrypt=" value="true" description="Specifies

whether or not password is encrypted to login to
Teamcenter."/>
</Options>
</SubsCmplMSDRerequestService>
5. To activate the EmailPollingService service, set the isactive attribute to true.

<EmailPollingService provider="SIEMENS" service="emailpolling" isactive="true">
<TransExecutable name="emailpolling.bat"
dir="&MODULEBASE;/Translators/emailpolling"/>
<Options>
value="" description="username"/>
value="" description="Specifies encrypted
password token to login to Teamcenter."/>
description="Specifies whether or not password is
encrypted to login to Teamcenter."/>
<Option name="clientoption" optionkey="ruleID" string="-rule_id="
value=""
description="Rule ID for EmailPoll Rule Object"/>
</Options>
</EmailPollingService>
6. Edit the CHANGE_ME tags for all the services you have activated in the
respective service_name.bat (Windows) or service_name.sh (UNIX) files in the
\Module\Translators\service_name directory.
Refer to the respective files.

Refer to the DispatcherClient\conf\Service.properties file.
8. From the command prompt, run the service in standalone mode to verify whether it is working
properly.
To view help about running the translator in a standalone mode, from a command prompt, change
to the Dispatcher_Root\Module\Translators\service_name directory and call service_name.bat
-help.

Chapter 5: Implementing postprocessor translators
Implementing postprocessor translators

Postprocessor translators generate a small 2D (JPEG) preview image of 3D CAD data and 2D
vector data. Many viewers display a preview image of, for example, search results, to allow visual
confirmation of selected geometry before loading the larger 3D or vector data.
Enable PreviewService translator

PreviewService is a generic preview generation translator, which combines the translators configured
as a part of this service. It also translates NX drawing (.prt) files to CGM (.cgm) files.
PreviewService can be used as a postprocessor for preview generation. If a translator you have
implemented in the Dispatcher Server uses a postprocessor, make sure that you also configure the
postprocessor. For example, if you are configuring the IdeasToJt translator and you want to use a
postprocessor, you must also configure PreviewService.
Note
JT to JPEG translations are handled by the PreviewService translator. You must install
Teamcenter lifecycle visualization Convert before performing JT to JPEG translations using
the PreviewService translator.
Teamcenter lifecycle visualization Convert is not available on all operating systems. Ensure
that you install the PreviewService translator on an operating system that is supported by
Teamcenter lifecycle visualization Convert.
If you do not want to use a postprocessor for a translator, make sure that you disable PreviewService
by commenting out the postprocess provider in the translator.xml file.
Example:
Change to:


Windows example:
<PreviewService isactive="false" provider="Siemens"

service="previewservice">
<TransExecutable dir="&MODULEBASE;/Translators/previewservice"
name="previewservice.bat"/>
<Options>

Chapter
Implementing postprocessor
postprocessor translators
translators
<Option description="Full path to the input directory."

name="inputdir" string=""/>
<Option description="Full path to the output directory."
name="outputdir" string="-o"/>
<Option description="Jt2jpeg directory." name="jt2jpegdir"
string="-j" value="&MODULEBASE;/Translators/previewservice/jt2jpeg"/>
<Option name="clientoption" optionkey="OUTPUT_TYPE" string=""
value="JPG_AND_PDF" description="The output file type.
Values can be CGM, TIF, HPG, PDF, JPG, CGM_AND_JPG,
CGM_AND_PDF or JPG_AND_PDF."/>
<Option name="clientoption" optionkey="COMBINE_OUTPUT" string=""
value="" description="Translator client options. The option to
combine the output in single file. Values can be blank or -combine." />
</Options>
<FileExtensions>
<InputExtension extension=".jt"/>

<InputExtension extension=".cgm"/>
<InputExtension extension=".dxf"/>
<InputExtension extension=".dwg"/>
<InputExtension extension=".igs"/>
<InputExtension extension=".prt"/>
<InputExtension extension=".dft"/>

<InputExtension extension=".doc"/>
<InputExtension extension=".xls"/>
<InputExtension extension=".ppt"/>

<InputExtension extension=".hpgl"/>
<InputExtension extension=".calcomp"/>
<InputExtension extension=".ps"/>
<InputExtension extension=".pdf"/>
</InputExtensions>
<OutputExtension extension=".tif"/>
<OutputExtension extension=".hpg"/>
<OutputExtension extension=".jpg"/>
</OutputExtensions>
</FileExtensions>
</PreviewService>
Note
3. Open the previewservice.bat (Windows) or previewservice.sh (UNIX) file from the

Dispatcher_Root\Module\Translators\previewservice directory and edit the CHANGE_ME tags.

Implementing postprocessor translators
4. Verify that you have installed the required software.

Appendix A: Troubleshooting translators
I-deas translator
When you attempt to translate an I-deas part using the Teamcenter IdeasToJt_direct translator, the
task terminates with the following error in the \logs\Dispatcher\task\taskid..._m.log file:
ERROR - The translation failed because the following error
in the Standard Input : # A fatal error has been detected by the
Java Runtime Environment:
The dispatch\Stage\DC\taskid...\SIEMENS_ideastojt_direct.log shows the following error:

WARN : 14:18:35,486 - TcLogger$IC_PrintStream.log:?
OutputDirectory=C:\plm\tstk83\Stage\DC\U6200a14f04ded2803d09x/result
#
# A fatal error has been detected by the Java Runtime Environment:
#
# EXCEPTION_ACCESS_VIOLATION (0xc0000005) at pc=0x6d9aa279,
# pid=5948, tid=5732
#
# JRE version: 6.0_20-b02
# Java VM: Java HotSpot(TM) Client VM (16.3-b01 mixed mode,
# sharing windows-x86 )
# Problematic frame:
# V [jvm.dll+0xfa279]
#
# An error report file with more information is saved as:
# c:\plm\DISP_T~1\portal\hs_err_pid5948.log
#
# If you would like to submit a bug report, please visit:
# http://java.sun.com/webapps/bugreport/crash.jsp
How to work around or avoid

The Java HotSpot can occur when you have set a Windows desktop theme. Change the desktop
theme to Windows Classic.
For more information about changing your desktop theme, refer Microsoft Windows documentation.
NXToPvDirect translations hang

When translations for NxToPvDirect are submitted to the Dispatcher Server, the translator launches,
but hangs and never completes.
When this translator runs in batch mode it must connect and log in to Teamcenter as a validated user.
When the dispatcher module launches the translator, the validated user logging into Teamcenter must
be the same user as the Module, meaning that the translator is running as the same user name as
the Module service. There are two solutions for this:
TTS00003 11.4 Dispatcher Server Translators Reference A-1

Appendix
Appendix A: A: Troubleshooting
Troubleshooting translators
translators
• Run the Module as a user with a valid Teamcenter user. This is the correct solution for this
problem.
• Modify the launch script used by Dispatcher to start the translator to add the user name and
password as a parameter to the UgToPvDirect translator. This is not the best solution because
this will expose the user name and password in a text file. If this approach is chosen, the
Dispatcher batch script should be properly secured to avoid anyone (other than the module and
translator) from being able to read or get access to this file.
UNIX example:
# Using single part option with individual @DB strings
#
if [ $1 = -single_part ]; then
if [ $3 = defaultdef ]; then
export UGII_DEFAULTS_FILE=
else
export UGII_DEFAULTS_FILE=$3
fi
export UGII_LOAD_OPTIONS=
$UGII_BASE_DIR/pvtrans/run_ugtopv -single_part
-config=$UGII_CONFIG_FILE -noupdate -pim=yes $4 $5 $6 $7 $8 $9
#
# Copying latest UG release status.
#
elif [ $1 = copyugrelstatus ]; then
. $TC_DATA/tc_profilevars
$TC_ROOT/bin/tc_workflow_postprocess $2 $3 $4 $5 $6 $7 $8 $9
#
# Using text file with @DB Strings
#
else
$UGII_BASE_DIR/pvtrans/run_ugtopv
-config=$UGII_CONFIG_FILE -noupdate
-pim=yes $3 $4 $5 $6 $7 $8 $9
fi
exitvalue=$?
if [[ ùname` = SunOS ]] then
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH_ORG
elif [[ ùname` = HP-UX ]] then
export SHLIB_PATH=$SHLIB_PATH_ORG
elif [[ ùname` = AIX ]] then
export LIBPATH=$LIBPATH_ORG
elif [[ ùname` = IRIX64 ]] then
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH_ORG
export LD_LIBRARYN32_PATH=$LD_LIBRARYN32_PATH_ORG
fi
exit $exitvalue
Windows example:
REM
REM Using text file with @DB Strings
REM
"%UGII_BASE_DIR%\PVTRANS\run_ugtopv.bat"
A-2 Dispatcher Server Translators Reference TTS00003 11.4

Troubleshooting translators
-config="%UGII_CONFIG_FILE%"
-noupdate "-pim=yes" %3 %4 %5 %6 %7 %8 %9
goto done
REM
REM Using single part option with individual @DB strings
REM
:single_part
set UGII_DEFAULTS_FILE=%3
if %3==defaultdef set UGII_DEFAULTS_FILE=
set UGII_LOAD_OPTIONS=
"%UGII_BASE_DIR%\PVTRANS\run_ugtopv.bat"
-single_part -config="%UGII_CONFIG_FILE%"
-noupdate "-pim=yes" %4 %5 %6 %7 %8 %9
goto done
REM
REM Copying latest UG release status.
REM
:copyugrelstatus
call %TC_DATA%\tc_profilevars
"%TC_ROOT%\bin\tc_workflow_postprocess.exe" %2 %3 %4 %5 %6 %7 %8 %9
goto done
View Dispatcher services runtime status and Dispatcher client history

The –ping command is provided for all the three Dispatcher services. This command provides
the runtime status of these services.
Note
The ping command is performance intensive; use it only when required.
• Dispatcher scheduler: The runscheduler.bat –ping (Windows) or runscheduler.sh –ping

(UNIX/Linux) ping command provides runtime information on the scheduler and modules
associated with the scheduler.
• Dispatcher module: The runmodule.bat –ping (Windows) or runmodule.sh –ping (UNIX/Linux)

ping command provides runtime information on the module.
• Dispatcher client: The runDispatcherClient.bat –ping (Windows) or runDispatcherClient.sh

–ping (UNIX/Linux) ping command provides runtime information on the Dispatcher client,
scheduler and the modules associated with the scheduler.
The –history command is provided for the Dispatcher client. It is used to parse the history log and
provide a detailed summary of tasks performed per day. The runDispatcherClient.bat –history
(Windows) or runDispatcherClient.sh –history (UNIX/Linux) command provides information on
the usage of the Dispatcher client.
TTS00003 11.4 Dispatcher Server Translators Reference A-3

Appendix B: Translator specifications
Prerequisites
Install prerequisite software and verify that your hardware is supported for Teamcenter 11.2.
For information about versions of operating systems, third-party software, Teamcenter software, and
system hardware certified for your platform, see the hardware and software certifications page
on GTAC.
Note
Some software requirements differ for non-English locales. When viewing the certification
database, make sure you note any exceptions for your locale.
CAD part translators

The table that follows describes the hardware, software, and other specifications for CAD part
translators.
Default post Related CAD

Translator name Required software processor translator
Catiav5ToJt None PreviewService None
Catiav4ToJt (Theorem) None PreviewService None
Catiav4ToJt (UGS) CATIA 41 PreviewService None
IdeasMF I-deas 12m1 PreviewService None
Translator
IdeasToJt I-deas 12m1 PreviewService None
JtToCatia (v5) JT to Catia (v5) None None
translator
ProEToJtWF2 Pro/ENGINEER PreviewService ProEToDxf
Wildfire
BatchMesh Teamcenter and None None
BatchMesh utility
1. Do not install CATIA in a directory with the name containing spaces.
TTS00003 11.4 Dispatcher Server Translators Reference B-1

Appendix
Appendix B: B: Translator
Translator specifications
specifications
CAD drawing translators

The table that follows describes the hardware, software, and other specifications for CAD drawing
translators.

NxToCgmDirect NX and Engineering None NxToPvDirect
Process Management
NxToPv NX PreviewService NxToCgm
NxToPvDirect NX and Engineering copyugrelstatus NxToCgmDirect
Process Management
ProEToDxf Pro/ENGINEER PreviewService ProEToJt
Wildfire2
Postprocessor translator
This section describes the hardware, software, and other specifications for the postprocessor
translator.
Translator name: Preview Service
Required software: VCT Toolkit
Default postprocessor: None
Related CAD translator: None
File translators
The table that follows describes the hardware, software, and other specifications for file translators.

IdiToJT I-deas 10m3 PTF 2, JtToJpeg None
I-deas 11m3, and
I-deas 12m1
StepToJt Vis Mockup JtToJpeg None
B-2 Dispatcher Server Translators Reference TTS00003 11.4

Appendix C: Glossary
This appendix defines Teamcenter and Dispatcher Server terms.
Assembly File
3D CAD assembly file that contains an index of the geometry of constituent 3D model files.
C9T
Core module for Teamcenter Enterprise. Contains common Teamcenter Enterprise functionality for
extracting data from Enterprise and the functionality to create data items resulting from translations
and relations to these data items. Often referred to as the primary Teamcenter Enterprise client
of the Translation Services Toolkit.
CGM
Computer Graphics Metafile (CGM) is a file format for 2D vector graphics, raster graphics, and text.
Drawing File
Teamcenter Enterprise CAD file containing a 2D vector image or 2D raster image.
DWG
DWG is the default extension used by Autodesk for its AutoCAD drawing files in MS-DOS and
Windows.
DXF
Drawing eXchange Format
I-deas
UGS’s integrated CAD/CAM/CAE solution that is used to design, analyze, test, and manufacture
products.
IGES
The Initial Graphics Exchange Specification (IGES) defines a neutral data format that allows the
digital exchange of information among CAD systems.
TTS00003 11.4 Dispatcher Server Translators Reference C-1

Appendix
Appendix C: C: Glossary
Glossary
Orbix
Iona Technologies, Ltd. full implementation of the Common Object Request Broker Architecture
(CORBA) standard developed by the Object Management Group (OMG).
Orbix Host
Teamcenter Enterprise managed host where the Orbix migration service is registered for the I-deas
data installation being migrated.
Orbix Server Name

Name under which the Orbix migration service is registered for the I-deas data installation being
migrated. For example, MI_Migration1 is the Orbix server name used to register the Orbix migration
service during the I-deas Enterprise TDS module post installation routine for PCL server configuration.
Postprocessor translator
Converts the translated data from the main process to more formats useful for customers. For
example, it generates JPEG from JT, which is generated from CAD data.
Preprocessor translator
Runs before main translation process. It prepares and sanitizes the data for the main translation
process.
Rich Client
Web application interface to Teamcenter Enterprise with integrations to CAD authoring tools and
additional optional capabilities.
Tessellation
Process that translates a CAD file to a visualization file.
Translation Configuration Control Object

Object that Translation Administrators set up in Teamcenter Enterprise to control the translation.
This object points to a particular Enterprise class and has attributes that control the translation. It
specifies the translator to use. One translation configuration control object is required for each
type of translation for the site.
Translation Control Object

Configuration control object in Document Manager that defines the rendering processes for various
types of file input and specifies the order in which the processes should be applied.
Translation Module
Translation modules launch the translators that perform the translation. Each module resides on one
hardware node on the network and is connected to the translation scheduler.
Translation Scheduler
Regulates translation tasks to the translation modules.
C-2 Dispatcher Server Translators Reference TTS00003 11.4

Glossary
Translation Server
Web-accessible, scalable, and configurable software that performs translation from and to various
file formats.
Translation Service
Solution that invokes the Translation Server to perform CAD translation and create required
relationships in Teamcenter Enterprise and Engineering Process Management.
Translation Task Request

Embeds information on the source file location and type of translation.
Translator Wrapper
Translators are Java wrappers that enclose the translator API. The wrapper provides threading,
process control (start, stop), status checking, error handling, and completion status and/or messaging.
Transmodule Properties File

A property file that allows you to specify the URL of the scheduler or file server, number of tries
for connecting to the scheduler, location of the staging directory, maximum number of services or
translations running on a machine, and other parameters.
Visualization
Viewing of business data, rendered in specified formats, as presentation data. For a particular data
item, the specified presentation data formats may or may not include original source format for
the data. For example, Microsoft Office documents and CAD files can be translated to formats
for presentation with industry-standard viewers.
Visualization File
File that can be viewed with common, industry-standard viewers or by Teamcenter Enterprise-provided
view and/or markup tools. A visualization file can be a 3D model, a 2D drawing, a 2D captured image,
or a business document such as a Microsoft Office file.
TTS00003 11.4 Dispatcher Server Translators Reference C-3

Siemens Industry Software
Headquarters
Europe
Granite Park One
Stephenson House
5800 Granite Parkway
Sir William Siemens Square
Suite 600
Frimley, Camberley
Plano, TX 75024
Surrey, GU16 8QD
USA
+44 (0) 1276 413200
+1 972 987 3000
Asia-Pacific
Americas
Suites 4301-4302, 43/F
Granite Park One
AIA Kowloon Tower, Landmark East
5800 Granite Parkway
100 How Ming Street
Suite 600
Kwun Tong, Kowloon
Plano, TX 75024
Hong Kong
USA
+852 2230 3308
+1 314 264 8499
About Siemens PLM Software
© 2017 Siemens Product Lifecycle Management

Siemens PLM Software, a business unit of the Siemens
Software Inc. Siemens and the Siemens logo are
Industry Automation Division, is a leading global provider
registered trademarks of Siemens AG. D-Cubed,
of product lifecycle management (PLM) software and
Femap, Geolus, GO PLM, I-deas, Insight, JT, NX,
services with 7 million licensed seats and 71,000 customers
Parasolid, Solid Edge, Teamcenter, Tecnomatix and
worldwide. Headquartered in Plano, Texas, Siemens
Velocity Series are trademarks or registered trademarks
PLM Software works collaboratively with companies
of Siemens Product Lifecycle Management Software
to deliver open solutions that help them turn more
Inc. or its subsidiaries in the United States and in other
ideas into successful products. For more information
countries. All other trademarks, registered trademarks
on Siemens PLM Software products and services, visit
or service marks belong to their respective holders.
www.siemens.com/plm.

Teamcenter 11.4 Dispatcher Server Translators Reference: Siemens Siemens Siemens

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

Teamcenter 11.4 Dispatcher Server Translators Reference: Siemens Siemens Siemens

Uploaded by

Copyright:

Available Formats

SIEMENS

Getting started with translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Implementing CAD part translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Implementing CAD drawing translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Implementing Teamcenter-specific translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

TTS00003 11.4 Dispatcher Server Translators Reference 3

Enable NxTransDirect translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6

4 Dispatcher Server Translators Reference TTS00003 11.4

Enabling PublishBatch translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37

Implementing postprocessor translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Troubleshooting translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Translator specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

TTS00003 11.4 Dispatcher Server Translators Reference 5

Getting started with translators

2. Install each translator on the appropriate Dispatcher Server module machine.

TTS00003 11.4 Dispatcher Server Translators Reference 1-1

10. Repeat steps 1–10 for each translator implemented.

Editing the translator.xml file

Editing the translator.xml file

1-2 Dispatcher Server Translators Reference TTS00003 11.4

• Modifying the isactive attribute to activate a translator

• Wrapper class attribute for defining a wrapper

• Modifying attributes to associate a translator

• Modifying input and output extensions

TTS00003 11.4 Dispatcher Server Translators Reference 1-3

1. Open the translator.xml file from the Dispatcher_Root\Module\conf directory.

2. Locate the <!ENTITY> elements located at the start of the file.

4. For each installed translator, verify the MODULEBASE property.

<Daemon exec="/proe<ver>/sun4_solaris/nms/nmsd" args="-noservice"/>

Modify input extensions

1. Open the translator.xml file from the Dispatcher_Root\Module\conf directory.

1-4 Dispatcher Server Translators Reference TTS00003 11.4

Creating an exclusion list for error messages

Creating an exclusion list for error messages

TTS00003 11.4 Dispatcher Server Translators Reference 1-5

Sample translator-specific error tags:

Sample global error tags:

• Global exclusion list for active translators in the dispatcher module.

1-6 Dispatcher Server Translators Reference TTS00003 11.4

Sample translator-specific exclusion tags:

Sample global exclusion list tags:

Modifying tessellation configuration files

TTS00003 11.4 Dispatcher Server Translators Reference 1-7

Translator Modify which file?

Run translation modules

2. Stop dispatcher modules that are running.

4. Execute the following command:

1. This translator is available only in UNIX.

1-8 Dispatcher Server Translators Reference TTS00003 11.4

The following message is displayed for the tozipfile translator service:

• The specified location of the required software or translator may be incorrect.

TTS00003 11.4 Dispatcher Server Translators Reference 1-9

Implementing CAD part translators

Implementing CATIA translators

Enable Catiav5ToJt translator

1. Open the translator.xml file from the Dispatcher_Root\Module\conf directory.

TTS00003 11.4 Dispatcher Server Translators Reference 2-1

2. Set the isactive attribute to true to activate this translator.

3. Open the catiav5tojt.bat (Windows) or catiav5tojt.sh (UNIX) file from the

Enable Catiav4ToJt translator

2-2 Dispatcher Server Translators Reference TTS00003 11.4