Getting Started Dispatcher Translation MGMT

Teamcenter 10.
Getting Started with Dispatcher

(Translation Management)
Publication Number
PLM00072 H
Proprietary and restricted rights notice
This software and related documentation are proprietary to Siemens Product

Lifecycle Management Software Inc.
© 2013 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
Siemens and the Siemens logo are registered trademarks of Siemens AG. Teamcenter
is a trademark or registered trademark of Siemens Product Lifecycle Management
Software Inc. or its subsidiaries in the United States and in other countries. All
other trademarks, registered trademarks, or service marks belong to their respective
holders.
2 Getting Started with Dispatcher (Translation Management) PLM00072 H

Contents
Proprietary and restricted rights notice . . . . . . . . . . . . . . . . . . . . . . . . . 2
Overview of Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Overview of Dispatcher . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 1-1
Using Dispatcher in Teamcenter Rapid Start . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Before you begin . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 1-2
Dispatcher interface . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 1-3
Basic concepts about Dispatcher . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . 1-5
Installing Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Installing Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Install all Dispatcher components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Install Dispatcher components to an existing Teamcenter installation or on different
machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Verifying Dispatcher installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Configuring Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Configuring Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Create a dispatcher client access rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Manually configuring Dispatcher components . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Configure logging for dispatcher requests . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Configure Dispatcher to work with Security Services . . . . . . . . . . . . . . . . . . . 3-3
Set preferences for repeating tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Start Dispatcher services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Run dispatcher client as a Windows service . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Setting up and configuring translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Using Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Using Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 4-1
Create a ZIP file for test purposes . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 4-1
Creating a translation request . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 4-2
Translate CAD files . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 4-4
Using the Dispatcher request administration console . . . . . . . . . . . . . . . . . . 4-5
Using logs for error handling . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 4-9
Stop, pause Dispatcher services . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 4-9
View Dispatcher service run-time information . . . . . .. . . . . . . . . . . . . . . . . . 4-10
Use Dispatcher services in Teamcenter Rapid Start . . . . . . . . . . . . . . . 5-1
Customizing Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Customizing Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Dispatcher client architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Adding a new translator to Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
PLM00072 H Getting Started with Dispatcher (Translation Management) 3

Contents
Creating dispatcher requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15

Translation menu integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Add Dispatcher preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
Customizing Translation Selection dialog box behavior . . . . . . . . . . . . . . . . . 6-20
Customizing the Dispatcher request administration console . . . . . . . . . . . . . . 6-22
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .... A-1
Checklist to handle errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .... A-1
Isolate translation problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .... A-2
Setting debug levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .... A-3
Query translation request objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .... A-4
Unable to run Dispatcher components as Windows service due to missing DLL
file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .... A-5
Dispatcher request go to terminal state due to large number of files open .... A-5
Service.properties file reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1
Figures
1-1. Dispatcher request administration console interface . . . . . . . . . . . . . . . 1-3

Dispatcher components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
4-1. Dispatcher request administration console interface . . . . . . . . . . . . . . . 4-5
4 Getting Started with Dispatcher (Translation Management) PLM00072 H

Chapter
1 Overview of Dispatcher
Overview of Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Using Dispatcher in Teamcenter Rapid Start . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Dispatcher interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Dispatcher menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Dispatcher request administration console interface . . . . . . . . . . . . . . . . . 1-3
Teamcenter rich client perspectives and views . . . . . . . . . . . . . . . . . . . . . 1-4
Basic concepts about Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Dispatcher components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Dispatcher request administration console . . . . . . . . . . . . . . . . . . . . 1-7
DispatcherRequest object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
DispatcherRequest object attributes . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Dispatcher request states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Translation process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
PLM00072 H Getting Started with Dispatcher (Translation Management)

Chapter
1 Overview of Dispatcher
Overview of Dispatcher
Dispatcher, earlier known as Translation Management, is the integration of the
Dispatcher Server and Teamcenter. Dispatcher enables Teamcenter users to
translate data files that are managed by Teamcenter to 3D or 2D file formats.
Note The names of Translation Management and its components have changed.
New name Old name

Dispatcher Translation Management
Dispatcher Server Translation Solution Toolkit (TSTK)
Dispatcher client Translation service
Dispatcher request Translator administrator console
administration console
Using Dispatcher in Teamcenter Rapid Start

All of the Dispatcher components are installed and preconfigured during the
Teamcenter Rapid Start installation. There are no additional installation or
configuration requirements necessary. The information in this guide is provided for
reference in the event you want to reconfigure your system.
For information on configuring the Dispatcher translators for Teamcenter Rapid
Start, see Configure translators in Teamcenter Rapid Start.
For information on using Dispatcher Services in Teamcenter Rapid Start, see Use
Dispatcher services in Teamcenter Rapid Start.
PLM00072 H Getting Started with Dispatcher (Translation Management) 1-1

Chapter 1 Overview of Dispatcher
Before you begin

Prerequisites Before installing Dispatcher, you must ensure you have the
required hardware and software. This section describes the
hardware and software you require to install Dispatcher.
Hardware requirements
For information about hardware requirements for the
scheduler, module, and dispatcher client, see the Dispatcher
Server Installation Guide.
Note Siemens PLM Software recommends that you
install translation modules on enterprise-class
servers only. Enterprise-class servers are better
designed to handle the computational, memory, and
multithreaded requirements of translators for large
models.
Software requirements
• Dispatcher has the same software requirements as
Teamcenter. For information about versions of operating
systems, third-party software, and Teamcenter
configurations that are certified for your platform, see
the Siemens PLM Software Certification Database:
http://support.industrysoftware.automation.siemens.com/ certific
• For information about Translator requirements, see

Dispatcher Server Translators Reference Guide.
Enable To enable Dispatcher:
Dispatcher
• Install the CAD design tools.
• Install Teamcenter.
For more information, see the Installation on UNIX and
Linux Servers Guide or the Installation on Windows Servers
Guide.
• Install the Dispatcher feature.

For more information, see Installing Dispatcher.
• Set up translators.
For more information about setting up translators, see the
1-2 Getting Started with Dispatcher (Translation Management) PLM00072 H

Configure The Dispatcher components are configured automatically when

Dispatcher you install Dispatcher using TEM. After installation, you must:
• Create Dispatcher access rules.
For more information, see Create a dispatcher client access
rule.
• Start Dispatcher services.

For more information, see Start Dispatcher services.
Dispatcher interface
Dispatcher uses the Teamcenter rich client interface.
Dispatcher menus
All Dispatcher menus are standard Teamcenter rich client menus except for those
described here. For additional information, see the My Teamcenter Guide.
Command Description
Translation®Translate... Starts translation of the selected dataset.
Translation®Administrator Opens the Request Administration Console.
Console –All
Dispatcher request administration console interface
Figure 1-1. Dispatcher request administration console interface
Buttons Description
Refreshes all dispatcher requests.
Refreshes the selected dispatcher request.

Buttons Description
Resubmits a dispatcher request for processing.
Deletes the selected dispatcher request.
Launches the properties dialog box for the selected
dispatcher request.
Teamcenter rich client perspectives and views

Within the Teamcenter rich client user interface, functionality is provided in
perspectives and views. Some applications use perspectives and views to rearrange
how the functionality is presented. Other applications use a single perspective
and view to present information.
• Perspectives
Are containers for a set of views and editors that exist within the perspective.
o A perspective exists in a window along with any number of other

perspectives, but only one perspective can be displayed at a time.
o In applications that use multiple views, you can add and rearrange views to
display multiple sets of information simultaneously within a perspective.
o You can save a rearranged perspective with the current name, or create a
new perspective by saving the new arrangement of views with a new name.
• Views and view networks

In some Teamcenter applications, using rich client views and view networks, you
can navigate to a hierarchy of information, display information about selected
objects, open an editor, or display properties.
o Views that work with related information typically react to selection changes
in other views.
o Changes to data made in a view can be saved immediately.
o Any view can be opened in any perspective, and any combination of views
can be saved in a current perspective or in a new perspective.
o A view network consists of a primary view and one or more secondary views
that are associated. View networks can be arranged in a single view folder
or in multiple view folders.
o Objects selected in a view may provide context for a shortcut menu. The
shortcut menu is usually displayed by right-clicking.
For more information about using the shortcut menu, see the My Teamcenter
Guide.

Note If your site has online help installed, you can access application and view
help from the rich client Help menu or by pressing F1. Some views, such
as Communication Monitor, Print Object, and Performance Monitor,
are auxiliary views that may be used for debugging and that may not be
displayed automatically by any particular perspective.
For more information about auxiliary views, see the Client Customization
Programmer’s Guide.
For more information about perspectives and views and changing the layout of your
rich client window, see the Rich Client Interface Guide.
Basic concepts about Dispatcher

Dispatcher is the integration of the Dispatcher Server and Teamcenter. Dispatcher
enables Teamcenter users to manage job distribution and execution.
With Dispatcher, you can:
• Asynchronously distribute jobs to machines with the resource capacity to execute
the job. (The jobs can also be done in a synchronous manner on the local client
machines, but this can introduce performance and administration issues based
on the job load.)
• Reduce server load by distributing resource-intensive activities.
• Schedule high-CPU or high-memory jobs for off-hours processing.
• Get a grid technology solution to manage the job distribution, communication,

execution, security, and error handling. You can scale and customize the
Dispatcher system to meet specific site requirements.
Dispatcher is mostly used to translate data files that are managed by Teamcenter to
3D or 2D file formats. You can:
• View, edit, and mark up data without requiring the original data’s authoring tool.
• Share the data with other companies without distributing the original raw data
(CAD, MS Office, and so forth).
• Generate a lightweight data format known as visualization data. The

visualization data can be attached along with the raw data and can be viewed
by Teamcenter viewers or by third-party applications capable of reading and
displaying the format.
Dispatcher components
Figure 1- shows the components of a Dispatcher system. The scheduler, module, and
translators are Dispatcher Server components.
For detailed information about the Dispatcher components, see the Dispatcher

Dispatcher components
Dispatcher client
The dispatcher client provides the framework to extract and load data to Teamcenter.
The dispatcher client provides the communication mechanism to use the Dispatcher
Server components.
The dispatcher client communicates with the Dispatcher Server using Remote
Method Invocation (RMI) or Hypertext Transfer Protocol (HTTP). RMI is the
default. Using HTTP causes file transfer performance issues and it needs more
installation steps. The dispatcher client uses Service Oriented Architecture (SOA) to
communicate with the server.
Scheduler
The scheduler manages distribution of translation requests across modules.
Translation tasks are submitted to the scheduler by Teamcenter via RMI or
HTTP communication. The scheduler tracks what modules are available and the
translators each module has available. It uses this information to distribute the
translation tasks to keep each module running to its maximum capacity.
The scheduler is a Java™-based RMI application. It comprises exposed interfaces
used by the dispatcher client to send and receive information about dispatcher
requests. The scheduler communicates with the module using RMI.
Module
The module is used for dispatching the specific translators required for translation
tasks. It provides the infrastructure for a common way to plug in and execute
any translator and support the various command line options, parameters, and
configuration files unique to each translator.
The module is a Java-based RMI application. It has exposed RMI interfaces used by
the scheduler to send and receive information about translation requests.

Translators
The translators used in the Dispatcher system are a combination of translators
developed by Siemens PLM Software and those developed by a third party.
Translators can be driven by the Dispatcher system to use specific configuration files
or parameters to support translation-specific behavior.
Dispatcher request administration console

The Dispatcher request administration console allows you to manage and monitor
the status of a task submitted for translation. With the Dispatcher request
administration console, you can:
• See all translation requests.
• Resubmit a translation request for processing.
• Delete a translation request.
DispatcherRequest object
The Dispatcher task execution process starts by the creation of a
DispatcherRequest object. The DispatcherRequest object is represented by
the DispatcherRequest class.
DispatcherRequest object attributes
Attribute Description
Current state Displays the current state of the dispatcher request.
Provider name Displays the name of the provider of the translator.
Service name Displays the name of the dispatcher service to be
used.
Priority Specifies a scheduling priority. Set it to low,
medium, or high.
Task ID Displays the task identifier assigned during the
preparation process.
Creation date Displays the date and time when the
DispatcherRequest object was created.
Primary objects Specifies one or more primary objects containing

the data to be translated. When translating CAD
data, primary objects are typically datasets.
Secondary objects Specifies one or more supporting objects for the
translation.
Note Secondary objects are optional and
dependant on the requirements of the
specific translation. When translating CAD
data, secondary objects are typically item
revisions.

Owning user Displays the name of the user that created the
request.
Owning group Displays the name of the group that created the
request.
History states Displays various states that make up the history of

the dispatcher request.
History dates Displays timestamps associated with state values.
Type Shows an application the purpose of the dispatcher
request.
Mode Represents a user-defined mode of operation.
Argument keys/argument Specifies one or more strings containing key/value
data pairs.
Data files keys/data files Specifies one or more strings containing name/value
pairs.
Start time Stores the expected start time of the request.
Interval Stores the number of seconds until the dispatcher
request is translated again.
End time Stores the end time of the request.
Dispatcher request states

The following information describes the various Dispatcher states associated with
the translation process.
State Description
INITIAL Indicates the initial state of a newly created
DispatcherRequest object.
PREPARING Indicates that the data is being extracted from Teamcenter
and that a Dispatcher Server task is being prepared.
SUPERSEDING Supports the situation in which an original request contains
a set of objects that require more than one translation—for
example, if the set contains both CATIA V4 and CATIA
V5 parts. This state indicates that successor dispatcher
requests are being created.
SCHEDULING Indicates that the task is being added to the Dispatcher
Server scheduling queue.
TRANSLATING Indicates the task is being processed by the Dispatcher
Server.
LOADING Indicates the task results are being loaded into Teamcenter.
COMPLETE Indicates the Dispatcher task has successfully completed.
TERMINAL Indicates the Dispatcher tasks has failed.

State Description
DUPLICATE Indicates the primary objects (datasets) specified in the
DispatcherRequest are also specified by one or more
DispatcherRequest objects currently being translated.
DELETE Indicates the dispatcher object has been marked for deletion.
CANCELLED Indicates the dispatcher request has been canceled.

SUPERSEDED Indicates a successful end state in which the original
dispatcher request is replaced by one or more newer
requests.
NO_TRANS Indicates a successful end state in which the original
dispatcher request contained objects that did not require
translation.
Each dispatcher request object has an initial state value, one or more working
state values, and one or more end state values. Each dispatcher service processes
DispatcherRequest objects whose current state matches the initial state of the
dispatcher service. When processing by the dispatcher service completes, it sets the
state of the dispatcher request to an end state value.
Dispatcher
request
states Value
Initial INITIAL
In Progress PREPARING, SCHEDULED, TRANSLATING, LOADING,
SUPERSEDING
Final COMPLETE, DUPLICATE, DELETE, CANCELLED,
SUPERSEDED, NO_TRANS, TERMINAL
Translation process
1. Based on actions such as checkin and workflow, one or more DispatcherRequest
objects are created. (In Teamcenter, the DispatcherRequest object is
represented by the DispatcherRequest class). The dispatcher requests are
added to the DispatcherRequest database table with a state value of INITIAL.
2. Each dispatcher client queries the DispatcherRequest database table

at the configuration-defined interval. The dispatcher client queries for
DispatcherRequest objects with a state value of INITIAL.
3. The dispatcher client changes the DispatcherRequest state value to

PREPARING to prevent other dispatcher client instances from operating on
the same DispatcherRequest object.
4. The dispatcher request is validated to check whether it is a duplicate of another

in-process request. If it is, the DispatcherRequest state value is set to
DUPLICATE.

5. The translator-specific task preparation logic is activated to prepare data for

translation input and create a task XML file to facilitate submission of the
translation task to the scheduler. The input and XML files are collected in
a task staging location. After task preparation is complete, the dispatcher
client submits the task to the scheduler and sets the DispatcherRequest
object state value to SCHEDULED. If an error occurs during preparation, the
DispatcherRequest state value is set to TERMINAL.
6. When translation begins, the Dispatcher Server notifies the scheduler and the
DispatcherRequest state is set to TRANSLATING.
7. When translation successfully completes, the Dispatcher Server again notifies

the dispatcher client and the DispatcherRequest state value is set to
LOADING. If an error occurs or the translation task fails, the Dispatcher
Server notifies the scheduler and sets the DispatcherRequest state value
to TERMINAL.
8. After the result files are loaded to the task staging location, the result files are
mapped to Teamcenter application data. The dispatcher client then activates
the appropriate translator integration logic to store the translation results in
the Teamcenter database containing the associated Teamcenter application
data model. When the results are loaded, the dispatcher client sets the
DispatcherRequest state value to COMPLETE. If an error occurs during
loading, the DispatcherRequest state value is set to TERMINAL.
If the translation fails, the request is updated with a log file in the loader. This is
based on configuration settings.

Chapter
2 Installing Dispatcher
Installing Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Install all Dispatcher components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Install Dispatcher components to an existing Teamcenter installation or on different

machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Install Dispatcher while creating a new configuration . . . . . . . . . . . . . . . 2-4
Install Dispatcher while performing maintenance on an existing
configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Verifying Dispatcher installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6

Chapter
2 Installing Dispatcher
Installing Dispatcher
Install and configure Dispatcher using Teamcenter Environment Manager (TEM).
Note The following procedures describe the automated installation of Teamcenter
Dispatcher components using TEM. If your configuration requires that you
manually install Dispatcher Server components, see the Dispatcher Server
Installation Guide.
Install all Dispatcher components

Note The following instructions are for installing Dispatcher with a new
installation of Teamcenter.
For instructions on installing Dispatcher while creating a new configuration
or performing maintenance on an existing configuration, see Install
Dispatcher components to an existing Teamcenter installation or on different
machines.
1. Start Teamcenter Environment Manager (TEM).

If you are installing Dispatcher to an already existing Teamcenter server, launch
Teamcenter Environment Manager from your Teamcenter environment.
If this is a first-time installation of a Teamcenter server and you want to include
Dispatcher, run the TEM.bat (Windows) or TEM.sh (UNIX) file from your
installation source, such as a DVD.
For more information about launching Teamcenter Environment Manager,
see the Installation on UNIX and Linux Servers Guide or the Installation on
Windows Servers Guide.
2. In the Solutions panel, select Dispatcher (Dispatcher Server).
3. Perform the following steps in the Select Features panel:

a. Under Enterprise Knowledge Foundation, select the following:
• Dispatcher Client for Rich Client
Installs the dispatcher client on the rich client.
This feature requires either Teamcenter two-tier rich client or
Teamcenter four-tier rich client.
• Dispatcher Server

Chapter 2 Installing Dispatcher
Installs Dispatcher Server components: scheduler, module, and Admin

Client.
• Dispatcher Client
Installs the dispatcher client.
This feature requires Teamcenter foundation.
4. Enter information as needed in subsequent panels. For information about

standard Teamcenter installation panels, see the Installation on UNIX and
Linux Servers Guide or the Installation on Windows Servers Guide.
5. In the Dispatcher Components panel, do the following:

a. In the Dispatcher Root Directory box, type or select the Dispatcher root
directory.
Keep the Dispatcher root directory as close to the Teamcenter root directory
as possible.
This directory is referred to as DISP_ROOT.
b. Select the Install Scheduler check box to install the scheduler.
c. Select the Install Module check box to install the module.

If you select the Install Module check box, the Staging Directory box is
activated.
In the Staging Directory box, you can choose the default staging directory or
type a new one.
Note If you are installing the module and the scheduler on the same
machine, the Scheduler Host and the Scheduler Port boxes are
disabled.
d. Select the Install Admin Client check box to install the Admin Client.
e. Click Next.
6. In the Dispatcher Settings panel, do the following:

a. Select the logging level in the Enter Logging Level box.
b. The Dispatcher Services Log Directory is automatically populated with the

location of the log directory.
c. Select the Install Documentation check box to install Javadocs for the
Dispatcher components.
d. In the Documentation Install Directory box, type or browse to the location

where you want the documentation installed.
e. If you want to start Dispatcher services after installation, select the Starting
Dispatcher Services check box.
• To start Dispatcher services as a Windows service, click Start Dispatcher
Services as Windows Services.

• To start Dispatcher services at the console, click Start Dispatcher

Services at console.
f. Click Next.
7. In the Select Translators panel, select the translators you want to enable.
Click Next.
8. In the Translator Settings panel, provide configuration information for the

translators you selected in the Select Translators panel.
For more information about translation configuration, see the Dispatcher Server
Translators Reference Guide.
Click Next.
9. In the Dispatcher Client panel, do the following:

a. Choose the Dispatcher Server Connection Type option. This option allows
you to choose how the dispatcher client communicates between Teamcenter
and the Dispatcher components.
• Select RMI for communicating using the RMI mode.
Note The RMI mode of communication is faster than the WebServer
mode.
• Select WebServer if you send translation requests over a firewall.
b. In the Dispatcher Server Hostname box, type the name of the server where
the translation server will be hosted.
c. In the Dispatcher Server Port box, type the port to be used for the Dispatcher
Server. The default port number is 2001 if the value in the Dispatcher
Server Connection Type box is RMI and 8080 if the value in the Dispatcher
Server Connection Type box is WebServer.
(In RMI mode, the scheduler port is used. In WebServer mode, the Web
server port is used.)
Make sure that the port you choose is not used by any other process.
d. In the Staging Directory box, type or browse to the location to be used as the
staging directory for the dispatcher client.
e. In the Dispatcher Client Proxy User Name box, type the name of the proxy
user who will use dispatcher services.
f. In the Dispatcher Client Proxy Password box, type the password for the
proxy user.
g. In the Dispatcher Client Proxy Confirm Password box, type the password
for the proxy user.
h. In the Polling interval in seconds box, type the time in seconds that a
dispatcher client should wait before querying for dispatcher requests.

i. In the Do you want to store JT files in Source Volume? box, select Yes if
you want to store visualization files in the associated visualization dataset.
If you select No, the visualization files are stored in the Dispatcher Client
Proxy User default volume.
j. Click Next.
10. In the Dispatcher Client panel, do the following:

a. Select the logging level in the Enter Logging Level list.
b. The Dispatcher Client Log Directory is automatically populated with the

location of the log directory.
c. In the Advanced Settings section, do the following:

A. In the Do you want to Update Existing Visualization Data? box, select
Yes if you want to update existing visualization data to the latest version.
B. In the Deletion of successful translation in minutes box, specify the

time (in minutes) that the dispatcher client should wait before querying
and deleting successful translation request objects.
If the interval is set to zero, translation request cleanup will not be done.
C. In the Threshold time in minutes for successful translation deletion

box, specify the time (in minutes) that must pass after a successful
translation request object is last modified before it can be deleted.
D. In the Deletion of unsuccessful translation in minutes box, specify the

time (in minutes) that the dispatcher client should wait before querying
and deleting unsuccessful translation request objects.
E. In the Threshold time in minutes for unsuccessful translation deletion

box, specify the time (in minutes) that must pass after an unsuccessful
translation request object is last modified before it can be deleted.
d. Click Next.
11. In the Confirm Selections panel, click Next.

The installation starts.
Install Dispatcher components to an existing Teamcenter installation

or on different machines
If you are installing Dispatcher components to different machines, decide what
components are to be installed on what machines. This should be based on machine
resources and throughput requirements for the installation.
Install Dispatcher while creating a new configuration

1. Start Teamcenter Environment Manager.

2. In the Maintenance panel, choose the Configuration Manager option and click
Next.
Teamcenter Environment Manager displays the Configuration Maintenance
panel.
3. In the Configuration Maintenance panel, choose the Add new configuration

option and click Next.
Teamcenter Environment Manager displays the New Configuration panel.
4. Enter a description of and unique ID for the configuration you are creating and
click Next.
Teamcenter Environment Manager displays the Solutions panel.
Ensure that you select the Dispatcher (Dispatcher Server) option.
5. Select the components to include in the configuration and click Next.

Teamcenter Environment Manager displays the Select Features panel.
6. In the Select Features panel, select the Dispatcher components.

The Dispatcher components are available under Extensions®Enterprise
Knowledge Foundation.
From this point, the procedure is the same as for the first configuration in an
installation. Teamcenter Environment Manager displays additional panels
depending on the components you are including in the configuration.
For more information, see Install all Dispatcher components.
Install Dispatcher while performing maintenance on an existing

configuration
1. Start Teamcenter Environment Manager.
2. In the Maintenance panel, choose the Configuration Manager option and click
Next.
Teamcenter Environment Manager displays the Configuration Maintenance
panel.
3. In the Configuration Maintenance panel, choose the Perform maintenance on

an existing configuration option and click Next.
Teamcenter Environment Manager displays the Configuration Selection panel.
4. From the list of configurations, select the configuration you want to modify and
click Next.
Teamcenter Environment Manager displays the Feature Maintenance panel.
5. Select Add/Remove Features and click Next.

Teamcenter Environment Manager displays the Select Features panel.
6. In the Select Features panel, select the Dispatcher components.

The Dispatcher components are available under Extensions®Enterprise

Knowledge Foundation.
From this point, the procedure is the same as that for the first configuration in
an installation. Teamcenter Environment Manager displays additional panels
depending on the components you are including in the configuration.
For more information, see Install all Dispatcher components.
Verifying Dispatcher installation

To verify that the Dispatcher installation was successful, check the following:
• The scheduler, module, and dispatcher client are installed, and you should be
able to successfully start these services.
For more information about starting Dispatcher services, see Start Dispatcher
services.
• If you installed dispatcher client for the rich client, you see the Translation
menu in My Teamcenter.
• You are able to perform a test translation with the tozipfile translator.
For more information, see Create a ZIP file for test purposes.
Note In the TC_ROOT directory, you see a directory called Dispatcher. You
should not use the contents of this directory for Dispatcher customizations
or configurations.
All Dispatcher components are installed in a separate directory
(DISP_ROOT). This directory is defined during Dispatcher installation. You
should use this directory for Dispatcher customizations or configurations.

Chapter
3 Configuring Dispatcher
Configuring Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Create a dispatcher client access rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Manually configuring Dispatcher components . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Editing Dispatcher configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Configure logging for dispatcher requests . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Configure Dispatcher to work with Security Services . . . . . . . . . . . . . . . . . . . 3-3
Set preferences for repeating tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Start Dispatcher services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Run dispatcher client as a Windows service . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Setting up and configuring translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5

Setting up and configuring translators . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Configuring translators in Teamcenter Rapid Start . . . . . . . . . . . . . . . . . 3-5
Configure translators in Teamcenter Rapid Start . . . . . . . . . . . . . . . . 3-5
Configuring the visconvertPDF translator . . . . . . . . . . . . . . . . . . . . . 3-6
Configuring the NX to PDF Translator . . . . . . . . . . . . . . . . . . . . . . . 3-6
Configuring the Solid Edge to JT translator . . . . . . . . . . . . . . . . . . . . 3-7

Chapter
3 Configuring Dispatcher
Configuring Dispatcher
After installing Dispatcher, you must create an access rule for the dispatcher client.
You must also start dispatcher services and configure translators if you did not
configure translators during installation.
See the following topics for a list of configurations to be performed.
Create a dispatcher client access rule

After installation, you must add a rule to the access rule tree permitting 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.
1. Log on to the Teamcenter rich client as a system administrator.
2. Open Access Manager.
3. In Access Manager, add the following rule to the rule tree under Has Class
(POM_application_object)®Working:
Condition = Has Class
Value = DispatcherRequest
ACL Name = DispatcherRequest
ACE Type of Accessor = User
ACE ID of Accessor = DC-Proxy-User-ID
ACE Privilege = Write
ACE Privilege Value = Grant
ACE Privilege = Delete
ACE Privilege Value = Grant

Note This rule applies only to the standard Access Manager rule tree. If
custom rules are specified for the installation, your custom rules must be
modified to provide the equivalent access of this rule. The DC-Proxy-User
must be the same user that was specified during installation using the
Teamcenter Environment Manager installation tool.

Chapter 3 Configuring Dispatcher
Manually configuring Dispatcher components

The Dispatcher components are configured when you install Dispatcher. However, if
you want to tweak the configuration of the Dispatcher components after installation,
you must manually edit the configuration files.
For information about manually configuring Dispatcher components, see the
Dispatcher Server Installation Guide.
Manually configure dispatcher client

• Edit the Service.properties file and the DispatcherClient.config file located
in the DISP_ROOT\DispatcherClient\conf directory.
Run dispatcher client as a Windows service

• Run the runDispatcherClientWinService.bat file from the
DISP_ROOT\DispatcherClient\bin directory.
• From the Windows Services console, start the dispatcher client service.
Editing Dispatcher configuration files

• Scheduler
Edit the transcheduler.properties file located in the
DISP_ROOT\Scheduler\conf directory.
• Module
Edit the transmodule.properties file located in the
DISP_ROOT\Module\conf directory.
• Dispatcher Client
Edit the Service.properties file and the DispatcherClient.config file located
in the DISP_ROOT\DispatcherClient\conf directory.
Configure logging for dispatcher requests

To attach log files to dispatcher requests, update the following value in the
Service.properties file.
The Service.properties file is located in the DISP_ROOT/DispatherClient/Conf
directory.
• To attach log files to the dispatcher request when translation is successful, set
Translator.Provider name.Translator name.LogsForComplete to true
Example Translator.SIEMENS.tozipfile.LogsForComplete=true
Note By default, this attribute is set to false. If you do not want to attach log
files to the dispatcher request (for successful translation), remove the
entry from the Service.properties file.

• In case of translation failure, the log is automatically attached to the dispatcher

request.
For more information about viewing the log file attached to the dispatcher request,
see View logs attached to dispatcher requests.
Configure Dispatcher to work with Security Services

1. Install the dispatcher client using TEM. This ensures that Teamcenter creates a
Dispatcher Client Proxy User.
2. Create the same Dispatcher Client Proxy User in LDAP.
3. Ensure that the values of the following properties in the Service.properties

file match LDAP values:
• Service.Tc.Group=dba
• Service.Tc.User=Dispatcher Client Proxy User
4. Create an encrypted password file by running encryptPass.bat/sh LDAP

password for Dispatcher Client Proxy User.
5. Start dispatcher client.
Set preferences for repeating tasks

• Set the ETS.Repeating_UI.<ProviderName>.<ServiceName> preference to
TRUE to display the repeating tasks functionality.
For more information, see the Preferences and Environment Variables Reference.
Note Repeating task functionality is an expensive option. This functionality
increases the load on the Dispatcher Server.
Start Dispatcher services

During installation of the Dispatcher components, you specified the Dispatcher root
directory. This directory is referred to as DISP_ROOT.
To fully process a Dispatcher request, all of the following services must be running
in this order: scheduler, module, and dispatcher client.
During installation of the Dispatcher feature, you have the option of installing the
Dispatcher services either as a service or as a console process.
Start scheduler
• Run the following command:
Windows systems:
DISP_ROOT/Scheduler/bin/runscheduler.bat

UNIX systems:
DISP_ROOT/Scheduler/bin/runscheduler.sh
Start module
Windows systems:
DISP_ROOT/Module/bin/runmodule.bat
UNIX systems:
DISP_ROOT/Module/bin/runmodule.sh
Start dispatcher client

• Ensure that the scheduler and module services are running before starting
the dispatcher client.
Run the following command:
Windows systems:
DISP_ROOT/DispatcherClient/bin/runDispatcherClient.bat
UNIX systems:
DISP_ROOT/DispatcherClient/bin/runDispatcherClient.sh
For information about stopping Dispatcher services, see Stop, pause Dispatcher
services.
Run dispatcher client as a Windows service

On Windows systems, you can optionally configure the dispatcher client as a
Windows service.
Note If you run the dispatcher client as a service, Siemens PLM Software
recommends running the scheduler and modules also as a service.
1. If you use Teamcenter, set the TC_DATA and TC_ROOT system variables as
appropriate.
Examples:
TC_DATA=C:\Progra~1\Siemens\tcdata
TC_ROOT=C:\Progra~1\Siemens\Teamcenter8
Note When you install Teamcenter, TEM automatically sets the FMS_HOME
system variable.
The Dispatcher Client service fails to start as a Windows service if you
do not set the TC_DATA and TC_ROOT system variables.
2. Run the runDispatcherClientWinService.bat file from the

DispatcherClient\bin directory.

3. From the Windows Services console, right-click DispatcherClientversion service

and choose Properties.
4. In the Log On pane, choose the This account option to assign a logon account for
the Dispatcher Client service.
Note You must provide administrator privileges for the Dispatcher Client
service.
5. Start the Dispatcher Scheduler.
6. Start the DispatcherClientversion service.

Note Start the scheduler and modules before you start the dispatcher client to
avoid connection delays and translation failures.
Setting up and configuring translators

Setting up and configuring translators
Before you can start translating CAD files, you must set up and configure translators.
For more information about setting up and configuring translators, see the
Configuring translators in Teamcenter Rapid Start
Configure translators in Teamcenter Rapid Start

During the installation of the Teamcenter Rapid Start server, the installer checks
for NX, Solid Edge, and Microsoft Office installations in the server. If any of these
applications are installed, Teamcenter Rapid Start preconfigures the translator
for that application. For example, if only Solid Edge is installed on the server, the
installer only configures the SE translators.
To install an application after you install Teamcenter Rapid Start, you must
configure the translator manually.
1. Open a Teamcenter Rapid Start command window by choosing
Start→Programs→Teamcenter 10→Starts Translation and Print Services.
2. Change to your installation directory, for example, C:\Program

Files\Siemens\Teamcenter10\install\install\TcRSConfiguration.
3. Execute one of the following commands, depending on the application translator

you want to configure.
Application Command
Microsoft Office TstkUpgrade.bat %tc_root% %tc_data% MSWORD
NX TstkUpgrade.bat %tc_root% %tc_data% NX
Solid Edge TstkUpgrade.bat %tc_root% %tc_data% SE
All applications TstkUpgrade.bat %tc_root% %tc_data% ALL

Configuring the visconvertPDF translator

If you are using this integration, perform the following modifications:
• In the TC_ROOT\ETS\Module\conf\translator.xml file, ensure that the
visconvertPDF element provider attribute value is set to Siemens. For
example:
<VisConvertPDF provider=”Siemens” service=”visconvertPDF”
maxlimit=”1” debug=”&DEBUG;”>
• In the TC_ROOT\ETS\Module\conf\translator.xml file, verify that the

extension option is set to PDF.
<Option name="extension" string="" value="-PDF"
description="Output Extension.”>

inputdir option is the input directory of the source file.
<Option name="inputdir" string=""
description="Full path to the input directory.”>

outputdir option is the output directory of the translated file.
<Option name="outputdir" string="-out"
description="Full path to the output directory.”>

input file extensions and output file extensions are set as follows:
<FileExtensions>
<InputExtensions nitem="3">
<-- List of MS office file extensions -->
<InputExtension extension=".doc"/>
<InputExtension extension=".xls"/>
<InputExtension extension=".ppt"/>
</InputExtensions>
<OutputExtensions nitem="1">
<OutputExtension extension=".pdf"/>
</OutputExtensions>
</FileExtensions>
</VisConvertPDF>
Configuring the NX to PDF Translator

ugtopdf element provider attribute value is set to Siemens. For example:
<ugtopdf provider="Siemens" service="ugtopdf" maxlimit="1"
debug="&DEBUG;">

inputpath option gives the input path of the source file.
<Option name="inputpath" string=""
description="Full path to the input directory."/>


Postprocess service attribute value is set to visconvertPDF as follows:
<Postprocess provider="Siemens" service="visconvertPDF"/>
This indicates that the output file of NX to PDF translation is passed as an input
to visconvertPDF and a PDF file is generated.
Configuring the Solid Edge to JT translator

setojt element provider attribute value is set to Siemens. For example:
<setojt provider="Siemens" service="setojt" maxlimit="1" debug="&DEBUG;">

inputpath option gives the input path of the source file.
<Option name="inputpath" string=""

outputpath option gives the output path of the translated file.
<Option name="outputpath" string=""

vis option is set as follows:
<Option name="vis" string="-v=" value="True"
description="Full path to the input file."/>

target option is set as follows:
<Option name="target" string="-t=" value="jt"
description="Full path to the input file."/>

input file extensions and output file extensions are set as follows:
<FileExtensions>
<InputExtensions nitem="4">
<InputExtension extension=".par"/>
<InputExtension extension=".asm"/>
<InputExtension extension=".psm"/>
<InputExtension extension=".pwd"/>
</InputExtensions>
<OutputExtensions nitem="1">
<OutputExtension extension=".jt"/>
</OutputExtensions>
</FileExtensions>

Chapter
4 Using Dispatcher
Using Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Create a ZIP file for test purposes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Creating a translation request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2

Create translation requests in My Teamcenter . . . . . . . . . . . . . . . . . . . . . 4-2
Create translation requests from the command line . . . . . . . . . . . . . . . . . 4-4
Translate CAD files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Using the Dispatcher request administration console . . . . . . . . . . . . . . . . . . 4-5

Dispatcher request administration console interface . . . . . . . . . . . . . . . . . 4-5
Launch the Dispatcher request administration console . . . . . . . . . . . . . . . 4-5
Refresh dispatcher requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Resubmit a dispatcher request for processing . . . . . . . . . . . . . . . . . . . . . 4-6
Delete dispatcher request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
View dispatcher properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
View logs attached to dispatcher requests . . . . . . . . . . . . . . . . . . . . . . . . 4-7
Filter dispatcher requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Dispatcher request administration console performance tuning . . . . . . . . . 4-8
Using logs for error handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
Stop, pause Dispatcher services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
View Dispatcher service run-time information . . . . . . . . . . . . . . . . . . . . . . . . 4-10

Chapter
4 Using Dispatcher
Using Dispatcher
This topic describes how to perform translations on files and datasets and how to use
the Dispatcher request administration console
Create a ZIP file for test purposes

Siemens PLM Software recommends that you do a test tozipfile translation to make
sure Dispatcher components are working correctly.
Note Make sure that you have created a dispatcher client access rule and started
the Dispatcher services.
1. In My Teamcenter, select an item revision.
2. Choose File→New→Dataset and in the New Dataset dialog box, select MSWord
as the type for the new dataset.
3. In the New Dataset dialog box, click Import to import your Microsoft Word file.
4. In the Import File dialog box, select the Microsoft Word file you want to import
into My Teamcenter and click Import.
5. Click OK to close the New Dataset dialog box.

Your file is imported as the new dataset type.
6. Select the imported dataset and choose Translation→Translate to translate

your Microsoft Word to ZIP format.
7. In the Translation Selection dialog box, choose the tozipfile service.
8. Click Finish to start the translation process.

To test the other option in the Translation Selection dialog box, see Create
translation requests in My Teamcenter.
9. (Optional) Choose Translation→ Administrator Console –All to see the progress

of the translation.
10. After the translation is complete, the ZIP file appears in the item revision.

Chapter 4 Using Dispatcher
Creating a translation request

Dispatcher provides two ways to create a translation request:
• From the Translation→Translate menu command in My Teamcenter.
• Using the dispatcher_create_rqst utility.
Create translation requests in My Teamcenter

1. In the navigation pane, select one or multiple datasets, item revisions, or
structure context objects for translations.
2. Choose Translation→Translate.
The Translation Selection dialog box shows the selected objects for translation.
3. In the Translation Selection dialog box, choose appropriate values from the
Provider and Service lists.
4. Click Finish to start the translation of all the objects.

The default translator arguments are used for the translation.
5. If you want to specify translator arguments and other properties, click Next.
Teamcenter shows the Translation Selection dialog box for the service.

Using Dispatcher
6. In the Translation Arguments section, you add, modify, or delete Key and Value
arguments.
7. In the Priority and Time Properties section, you can set the following options:
a. Time
Choose the time for the translation to start.
Click the Admin Time and Date properties button to display the Date
and Time dialog box.
In the Date and Time dialog box, type the translation start time and click OK.
b. Priority
Choose the priority for the translation task.
c. Repeating
Choose this option if you want to repeat 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.
Note To avoid unpredictable behavior, the (time) interval in repeating

tasks must be greater than the translation time.
8. Click Finish to start the translation.

If there are other objects for translation, they are translated with the default
values.
9. If you want to specify translator arguments and other properties for the
remaining objects, click Next.
Create translation requests from the command line

You can create a translation request from the command line by using the
dispatcher_create_rqst utility. This utility is located in the TC_ROOT/bin
directory.
You can get the usage details of this utility by typing the following on the command
line:
dispatcher_create_rqst —h
For more information about using utilities, see the Utilities Reference.
Translate CAD files

For information about the list of supported CAD translators, see the Dispatcher
Server Translators Reference Guide.
1. In My Teamcenter, select an item revision.
2. In the item revision, select a CAD dataset and choose Translation→Translate.
3. In the Translation Selection dialog box, select the appropriate values for the
Provider and Service lists.
4. Select the translation time, priority, and translation repeating schedule options
from the Date and Time Properties section.
5. Click OK to start the translation.
6. (Optional) Choose Translation→Administrator Console –All to see the progress

of the translation.
7. After the translation is complete, the translated CAD file appears in the item
revision.
If your site has the Teamcenter lifecycle visualization embedded viewer installed,
you can view the translation result in the Viewer data pane in My Teamcenter or in
the Viewer tab in Structure Manager.

Using Dispatcher
Using the Dispatcher request administration console

You can monitor and administer translation requests using the Dispatcher request
administration console. To access the Dispatcher request administration console
choose Translation®Administrator Console –All in the My Teamcenter menu.
You can do the following using the Dispatcher request administration console:
• View all dispatcher requests.
• Resubmit a dispatcher request for processing.
• Delete a dispatcher request.
• View dispatcher properties.
• View dispatcher logs.
Dispatcher request administration console interface
Figure 4-1. Dispatcher request administration console interface
Buttons Description
Refreshes all dispatcher requests.
Refreshes the selected dispatcher request.
Resubmits a dispatcher request for processing.
Deletes the selected dispatcher request.
Launches the properties dialog box for the selected
dispatcher request.
Launch the Dispatcher request administration console

• In My Teamcenter, choose Translation®Administrator Console –All.

Refresh dispatcher requests

• In the Dispatcher request administration console, click one of the following:
o Refresh All Requests (SHIFT+F5) button to refresh all dispatcher requests.
o Refresh Request (F5) button to refresh the selected dispatcher request.
Resubmit a dispatcher request for processing

1. Select a dispatcher request.
2. Click the Resubmit Request for Processing button .

Note You can resubmit dispatcher requests only in final states.
Delete dispatcher request

1. Select a dispatcher request.
2. Click the Delete Request button .
3. To delete dispatcher requests which are in-progress states , press the Shift key
and click the Delete Request button .
Note The translation fails when you delete dispatcher requests which are
in in-progress states.
View dispatcher properties
1. Choose a translation request and click the Request Properties button .
2. The Translation Request Properties dialog box appears.

Using Dispatcher
a. Click the Properties tab to see the properties of the selected dispatcher.
b. Click the Arguments tab to see the dispatcher arguments.
c. Click the Files tab to see the dispatcher log. You can download the dispatcher
log to view it.
For more information, see View logs attached to dispatcher requests.
d. Click History to see a log of the different dispatcher states.
View logs attached to dispatcher requests
1. Choose a dispatcher request and click the Request Properties button .
2. In the Translation Request Properties dialog box, click the Files tab.
3. In the Files pane, select the log and click Export to view the log file locally.

Filter dispatcher requests

1. From the Filter Requests section, select the filters from the available lists.
2. Filter dispatcher requests by selecting options provided in the following lists:
• Provider
• Service
• State
• User
Dispatcher request administration console performance tuning

When you perform the Refresh All operation in the Dispatcher request
administration console, if there are more than 5000 requests to retrieve, the SOA
query has to make multiple server calls. This degrades performance.
To avoid this, set the TC_SOA_MAX_PROPERTIES environment variable from
100,000 to a higher number. For every additional 5000 requests the environment
variable needs to be increased by 100,000.

Using Dispatcher
Using logs for error handling

When you install Dispatcher using the TEM, you can specify a single root location
for all log files. Logs are written in the following format for all the Dispatcher
components.
• Log-volume-location/category/process
• Log-volume-location/category/task
Log-volume-location is the central repository of log files.

category refers to Dispatcher components.
process is the directory for all process logs. Process logs are the main log files for
Dispatcher components.
task is the directory for all task logs. Task logs are log files specific to tasks such as
submitting files for translation or generating translated files.
You can also view logs of a particular translation in the Dispatcher request
administration console. For more information, see View logs attached to dispatcher
requests.
Stop, pause Dispatcher services

If you have installed Dispatcher services as a service, you can stop them by using
the stop command.
Stop scheduler
Windows systems:
DISP_ROOT/Scheduler/bin/runscheduler.bat —stop
UNIX systems:
DISP_ROOT/Scheduler/bin/runscheduler.sh —stop
Stop module
Windows systems:
DISP_ROOT/Module/bin/runmodule.bat —stop
UNIX systems:
DISP_ROOT/Module/bin/runmodule.sh —stop
Stop dispatcher client

Windows systems:
DISP_ROOT/DispatcherClient/bin/runDispatcherClient.bat —stop

UNIX systems:
DISP_ROOT/DispatcherClient/bin/runDispatcherClient.sh —stop
Pause dispatcher client

• The pause command stops processing requests that are in the INITIAL state.
This means the dispatcher client does not accept any new task. Tasks which are
In Progress states continue to be processed.
To pause the dispatcher client, run the following command:
Windows systems:
DISP_ROOT/DispatcherClient/bin/runDispatcherClient.bat —pause true
UNIX systems:
DISP_ROOT/DispatcherClient/bin/runDispatcherClient.sh —pause true
• To start the dispatcher client after pause, run the following command:
Windows systems:
DISP_ROOT/DispatcherClient/bin/runDispatcherClient.bat —pause false
UNIX systems:
DISP_ROOT/DispatcherClient/bin/runDispatcherClient.sh —pause false
View Dispatcher service run-time information

You can view the run-time status of Dispatcher services using the ping command.
Note The ping command is performance intensive; use it only when required.
View run-time status of scheduler

Windows systems:
DISP_ROOT/Scheduler/bin/runscheduler.bat —ping
UNIX systems:
DISP_ROOT/Scheduler/bin/runscheduler.sh —ping
View run-time status of module

Windows systems:
DISP_ROOT/Module/bin/runmodule.bat —ping
UNIX systems:
DISP_ROOT/Module/bin/runmodule.sh —ping

Using Dispatcher
View run-time status of dispatcher client

Windows systems:
DISP_ROOT/DispatcherClient/bin/runDispatcherClient.bat —ping
UNIX systems:
DISP_ROOT/DispatcherClient/bin/runDispatcherClient.sh —ping
View history of tasks performed by dispatcher client

• The history command parses the history logs and shows the detailed summary of
tasks performed per day.
Run the following command:
Windows systems:
DISP_ROOT/DispatcherClient/bin/runDispatcherClient.bat —history
UNIX systems:
DISP_ROOT/DispatcherClient/bin/runDispatcherClient.sh —history

Chapter
5 Use Dispatcher services in

Teamcenter Rapid Start

Chapter
5 Use Dispatcher services in

Teamcenter Rapid Start
1. Start the Dispatcher Server services using the Services dialog box.
Note the following services:
• Dispatcher Service Module
• Dispatcher Service Scheduler
2. Start the Dispatcher services by choosing Start→Programs→Teamcenter

10→Starts Translation and Print Services.
Several windows open and the following Dispatcher services start: Extractor,
Scheduler, and Loader. Be sure that all of the services start without errors. The
services process the translation request created by the users.

Chapter
6 Customizing Dispatcher
Customizing Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Dispatcher client architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

DispatcherRequest object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
DispatcherRequest object attributes . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Dispatcher request states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Translation process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
Adding a new translator to Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6

Module changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Dispatcher client changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Dispatcher client behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Dispatcher client control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
Request filter class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
Develop custom dispatcher client filter . . . . . . . . . . . . . . . . . . . . 6-8
Adding translator support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9
Service configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9
Customizing data extraction and translation task preparation . . . . 6-10
Customizing data loading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
Add customizations during Dispatcher client startup . . . . . . . . . . . . . 6-12
Configure logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
Integrate new translators in Teamcenter rich client . . . . . . . . . . . . . . 6-13
Creating dispatcher requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15

Creating dispatcher requests in Teamcenter rich client . . . . . . . . . . . . . . 6-15
Creating dispatcher requests using ITK APIs . . . . . . . . . . . . . . . . . . . . . 6-16
Create dispatcher requests using ITK APIs . . . . . . . . . . . . . . . . . . . . 6-16
Batch translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Workflow translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Creating dispatcher requests using Teamcenter Services . . . . . . . . . . . . . 6-17
Translation menu integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17

Create new menu item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-17
Create dispatcher request using the new menu item . . . . . . . . . . . . . . . . 6-18
Add Dispatcher preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
Customizing Translation Selection dialog box behavior . . . . . . . . . . . . . . . . . 6-20

Create a custom plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20
Create a custom class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21
Customizing the Dispatcher request administration console . . . . . . . . . . . . . . 6-22

Filter requests in the Dispatcher request administration console . . . . . . . . 6-22

Create a new sub-menu under the Translation menu . . . . . . . . . . . . . . . . 6-23
Getting Started with Dispatcher (Translation Management) PLM00072 H

Chapter
6 Customizing Dispatcher
Customizing Dispatcher
Customizing the scheduler and module is described in the Dispatcher Server
Installation Guide. Customizing translators is described in the Dispatcher Server
Translators Reference Guide. This topic describes customizing the dispatcher client.
The dispatcher client provides a generic framework to support data translation
including the triggering of translations, extraction of data from Teamcenter for
translator input, translation of the data, storage of the translation results in
Teamcenter, and management of the dispatcher request.
The dispatcher client provides limited support for some CAD manager data models
and their respective translators. Within the dispatcher client, data model-specific
logic is isolated into two areas: preparation of a translation task during extraction
and storage of the translation task results during loading. CAD managers must
provide full data model support as part of their dispatcher client integration to
satisfy their specific data model and translator requirements.
The following dispatcher client customizations are supported:
• Adding new translators
This consists of two parts:
o Module changes
For more information about module changes, see the Dispatcher Server
Installation Guide.
o Dispatcher client changes

Dispatcher client behavior
◊ Validating dispatcher requests
◊ Coordinating external systems with dispatcher request processing
Translation triggers
◊ Creating dispatcher requests in response to specific user events
Dispatcher client control

◊ Modifying existing or creating new service filters.
Translator support
◊ Modifying standard data preparation logic

Chapter 6 Customizing Dispatcher
◊ Modifying the standard results store logic
◊ Adding new data preparation and storage logic
• Customizing dispatcher request creation

o Create dispatcher requests in the Teamcenter rich client.
o Create dispatcher requests using ITK APIs.
o Create batch translations.
o Create workflow translations.

Note The dispatcher client users Teamcenter Services from Teamcenter 8 and
later.
You must change existing dispatcher client customizations (Task Prep and
DatabaseOperation classes) written before Teamcenter 8 using rich client
APIs . Use Teamcenter Services instead of rich client APIs.
For more information about Teamcenter Services, see the Services Guide.
Dispatcher client architecture

The dispatcher client employs the ETL model (Extract-Transform-Load) for data
translation. It provides a framework that supports extraction of data for translation,
translation, and loading of translation results. The dispatcher client is implemented
as a stand-alone SOA application.
• Extraction provides a collection of input data to be submitted as a translation
task to the Dispatcher Server. The nature of the extracted data is dependent
upon the input required by the desired translation.
• After extraction, the dispatcher client submits a translation task to the

Dispatcher Server. The Dispatcher Server then processes the translation tasks.
• After the translation is complete, the dispatcher client loads the translated data
in the appropriate Teamcenter target data model.
The nature of the translation results is dependent on the output generated by
the desired translation. Storage of the results is also dependent on the target
data model.
The dispatcher client provides support for translator integrations and related data
models with two Java classes: one for preparation of translator input (TaskPrep
class) and one for storage of translator output (DatabaseOperation class).
These two classes provide a structure for translator- and data model-specific logic
implementation. The dispatcher client configuration properties define the mapping
between translators and supporting classes.
These classes provide a structure for translator-specific and data model–specific logic
implementation. The dispatcher client configuration properties define the mapping
between translators and supporting classes.

DispatcherRequest object
The Dispatcher task execution process starts by the creation of a
DispatcherRequest object. The DispatcherRequest object is represented by
the DispatcherRequest class.
DispatcherRequest object attributes
Current state Displays the current state of the dispatcher request.
Provider name Displays the name of the provider of the translator.
Service name Displays the name of the dispatcher service to be
used.
Priority Specifies a scheduling priority. Set it to low,
medium, or high.
Task ID Displays the task identifier assigned during the
preparation process.
Creation date Displays the date and time when the
DispatcherRequest object was created.
Primary objects Specifies one or more primary objects containing

the data to be translated. When translating CAD
data, primary objects are typically datasets.
Secondary objects Specifies one or more supporting objects for the
translation.
Note Secondary objects are optional and
dependant on the requirements of the
specific translation. When translating CAD
data, secondary objects are typically item
revisions.
Owning user Displays the name of the user that created the
request.
Owning group Displays the name of the group that created the
request.
History states Displays various states that make up the history of

the dispatcher request.
History dates Displays timestamps associated with state values.
Type Shows an application the purpose of the dispatcher
request.
Mode Represents a user-defined mode of operation.
Argument keys/argument Specifies one or more strings containing key/value
data pairs.
Data files keys/data files Specifies one or more strings containing name/value
pairs.
Start time Stores the expected start time of the request.

Interval Stores the number of seconds until the dispatcher
request is translated again.
End time Stores the end time of the request.
Dispatcher request states
The following information describes the various Dispatcher states associated with
the translation process.
State Description
INITIAL Indicates the initial state of a newly created
DispatcherRequest object.
PREPARING Indicates that the data is being extracted from Teamcenter
and that a Dispatcher Server task is being prepared.
SUPERSEDING Supports the situation in which an original request contains
a set of objects that require more than one translation—for
example, if the set contains both CATIA V4 and CATIA
V5 parts. This state indicates that successor dispatcher
requests are being created.
SCHEDULING Indicates that the task is being added to the Dispatcher
Server scheduling queue.
TRANSLATING Indicates the task is being processed by the Dispatcher
Server.
LOADING Indicates the task results are being loaded into Teamcenter.
COMPLETE Indicates the Dispatcher task has successfully completed.
TERMINAL Indicates the Dispatcher tasks has failed.
DUPLICATE Indicates the primary objects (datasets) specified in the
DispatcherRequest are also specified by one or more
DispatcherRequest objects currently being translated.
DELETE Indicates the dispatcher object has been marked for deletion.
CANCELLED Indicates the dispatcher request has been canceled.

SUPERSEDED Indicates a successful end state in which the original
dispatcher request is replaced by one or more newer
requests.
NO_TRANS Indicates a successful end state in which the original
dispatcher request contained objects that did not require
translation.
Each dispatcher request object has an initial state value, one or more working
state values, and one or more end state values. Each dispatcher service processes
DispatcherRequest objects whose current state matches the initial state of the
dispatcher service. When processing by the dispatcher service completes, it sets the
state of the dispatcher request to an end state value.

Dispatcher
request
states Value
Initial INITIAL
In Progress PREPARING, SCHEDULED, TRANSLATING, LOADING,
SUPERSEDING
Final COMPLETE, DUPLICATE, DELETE, CANCELLED,
SUPERSEDED, NO_TRANS, TERMINAL
Translation process
1. Based on actions such as checkin and workflow, one or more DispatcherRequest
objects are created. (In Teamcenter, the DispatcherRequest object is
represented by the DispatcherRequest class). The dispatcher requests are
added to the DispatcherRequest database table with a state value of INITIAL.
2. Each dispatcher client queries the DispatcherRequest database table

at the configuration-defined interval. The dispatcher client queries for
DispatcherRequest objects with a state value of INITIAL.
3. The dispatcher client changes the DispatcherRequest state value to

PREPARING to prevent other dispatcher client instances from operating on
the same DispatcherRequest object.
4. The dispatcher request is validated to check whether it is a duplicate of another

in-process request. If it is, the DispatcherRequest state value is set to
DUPLICATE.
5. The translator-specific task preparation logic is activated to prepare data for

translation input and create a task XML file to facilitate submission of the
translation task to the scheduler. The input and XML files are collected in
a task staging location. After task preparation is complete, the dispatcher
client submits the task to the scheduler and sets the DispatcherRequest
object state value to SCHEDULED. If an error occurs during preparation, the
DispatcherRequest state value is set to TERMINAL.
6. When translation begins, the Dispatcher Server notifies the scheduler and the
DispatcherRequest state is set to TRANSLATING.
7. When translation successfully completes, the Dispatcher Server again notifies

the dispatcher client and the DispatcherRequest state value is set to
LOADING. If an error occurs or the translation task fails, the Dispatcher
Server notifies the scheduler and sets the DispatcherRequest state value
to TERMINAL.
8. After the result files are loaded to the task staging location, the result files are
mapped to Teamcenter application data. The dispatcher client then activates
the appropriate translator integration logic to store the translation results in
the Teamcenter database containing the associated Teamcenter application
data model. When the results are loaded, the dispatcher client sets the
DispatcherRequest state value to COMPLETE. If an error occurs during
loading, the DispatcherRequest state value is set to TERMINAL.

If the translation fails, the request is updated with a log file in the loader. This is
based on configuration settings.
Adding a new translator to Dispatcher

You can add your custom translators to Dispatcher. To add a new translator to
Dispatcher, you must do the following:
• Configure the module.
• Configure the dispatcher client to integrate the new translator with Teamcenter
rich client.
Module changes
For more information about module changes, see the Dispatcher Server Installation
Guide.
Dispatcher client changes

Dispatcher client changes include the following changes:
• Dispatcher client behavior
o Validating dispatcher requests
o Coordinating external systems with dispatcher request processing
• Translation triggers
o Creating dispatcher requests in response to specific user events
• Dispatcher client control

Modifying existing or creating new service filters.
• Translator support
o Modifying standard data preparation logic
o Modifying the standard results store logic
o Adding new data preparation and storage logic
Dispatcher client behavior

You can customize dispatcher client behavior using extensions. Extensions allow
you to write a custom function or method for Teamcenter in C or C++ and attach the
rules to predefined hook points in Teamcenter.
For more information, see the Business Modeler IDE Guide.
Note All user exits for Dispatcher must be replaced by extensions.

Dispatcher client control

Validation
The dispatcher client does a duplicate check by default to make sure the same
primary object is not sent for translation. You can define translator-specific
duplicate check by setting the Service.CheckForDuplicateRequests
property in the property file of the translator. If this property is not set for the
translator, the default Service.CheckForDuplicateRequests property value
will be used. Translator-specific duplicate check helps to override the default
Service.CheckForDuplicateRequests property.
Example Translator.provider name.translator name.Duplicate=false
Filters
You can control translation services using dispatcher client filters. Dispatcher
client filters provide a convenient way to control dispatcher request objects that
are exposed to the dispatcher client for processing. If filters are specified for a
dispatcher client, all dispatcher requests must pass this filter, or the dispatcher
request is not processed by the dispatcher client.
Configuration of dispatcher client filter is specified in the Service.properties file,

located in the DISP_ROOT/DispatcherClient/conf directory.
Dispatcher client filters are implemented as a subclasses of the RequestFilter
class. Dispatcher supplies three request filters:
• TranslatorFilter
Filters dispatcher requests that do not contain the specified providers or
translators.
• PriorityFilter
Filters dispatcher requests that have a priority lower than the specified priority.
• OwningUserFilter
Filters dispatcher requests that do not match the specified owning user name.
Request filter class

Filters are implemented by subclasses of the RequestFilter class. Filter instances
are created by the FilterFactory1 class utilizing methods of the RequestFilter
class. All translation services apply filtering to the results returned from the query
for dispatcher requests.
To create a new filter, create a new subclass of the RequestFilter class providing an
implementation for each of the methods specific to the new filter.
A sample Filter.java file is provided in the
DISP_ROOT/DispatcherClient/sample/integration/filters directory.
1. FilterFactory is a class supplied by Dispatcher. It is a mechanism used by the service classes for creating instances of
RequestFilter subclasses—for example, PriorityFilter.

RequestFilter contains the properties data member. The properties data

member is an object that contains the configuration required and optional properties
and values that are established when the dispatcher client starts.
The RequestFilter contains the following methods:
• getRequiredPropertyNames
This method is used by the FilterFactory class to return an array of property
names of required configuration properties. These properties are those that
must be specified by the filter configuration. If no value is specified for these
properties, the FilterFactory class logs an error in the Extractor service
instance log file and no filter instance is created.
public abstract String[] getRequiredPropertyNames();
• getOptionalPropertyNames
This method is used by the FilterFactory class to return an array of property
names of optional configuration properties. These properties are optional.
public abstract String[] getOptionalPropertyNames();
• setProperties
This method is used by the FilterFactory class to allow a specific
RequestFilter subclass access to property values. The subclass implementation
must execute the super method.
public void setProperties(Properties p) throws Exception
{
properties = p;
}
• filterRequest
This method is used to filter dispatcher request objects for processing by the
dispatcher client. It is run by the dispatcher client to filter the results of the
query for dispatcher request for processing.
public abstract boolean filterRequest( IMANComponent request )
throws Exception;
Develop custom dispatcher client filter

To customize a dispatcher client filter in a Microsoft Windows environment:
Note Adapt the procedure for UNIX as required.
1. Create the custom dispatcher client filter Java source file. Use a custom package
designation.
A sample Filter.java file is provided in the
DISP_ROOT/DispatcherClient/sample/integration/filters directory.
2. Ensure that the appropriate Java SDK is installed and Java path information is
correctly set.
3. Compile the Java source file using the following command:

javac –classpath
Add jars created in the classpath of runDispatcher.bat/sh file
myFilter.java
4. Archive the new Java classes. These new classes, along with other customized
dispatcher client classes, are combined into the CAD Manager JAR file or a
single site-specific custom JAR file.
jar cf jar-file-name.jar myFile.class myFile2.class …
5. Copy the new JAR file to the DISP_ROOT/DispatcherClient/lib directory.
6. Modify the DISP_ROOT/conf/Service.properties file to specify the new filter

and associated properties.
Add the filter in the FILTERS section of the Service.properties file.
7. Run the dispatcher client and verify the operation of the filter.
Adding translator support

The dispatcher client provides the framework to support translators. Each translator
has its own specific input and output requirements. Some translators require very
little input and store their results directly in the Teamcenter database. Other
translators require extensive input information and require result files to be stored
appropriately.
Service configuration
The dispatcher client support for translators is specified as a set of translator
provider and translator service class mappings. These mappings are described in
the Service.properties file located in the DISP_ROOT/DispatcherClient/conf
directory.
Add translator to dispatcher client

1. Create a Translator service nameService.properties file.
For example: If you translator service name is atob, name the file
TSAToBService.properties.
2. Add the following properties:

#====================================================================
# File description: This file contains the TS AToB service configuration
#
# Filename: TSAToBService.properties
#
#====================================================================
###############################################################################
#
# T R A N S L A T O R S
#
# See the Service.properties file for a detailed explanation of these properties.
#
# Provider Name : SIEMENS
# Translator Name: AToB
Translator.SIEMENS.atob.Prepare=com.teamcenter.ets.translator.ugs.atob.TaskPrep
Translator.SIEMENS.atob.Load=com.teamcenter.ets.translator.ugs.atob.DatabaseOperation
Where:
com.teamcenter.ets.translator.ugs.atob.TaskPrep is the class to extract

the data from Teamcenter.

com.teamcenter.ets.translator.ugs.atob.DatabaseOperation is the
class to load the translated data back to Teamcenter.
For more information, see the Translators section of the Service.properties file.
Set provider and service preferences

• If you have added a new provider, add the provider to the ETS.PROVIDERS
preference.
• If you have added a new translator (service), add the translator to the
ETS.TRANSLATORS.<ProviderName> preference.
For more information about these preferences, see Preferences and Environment
Variables Reference.
Customizing data extraction and translation task preparation

Preparation of translator input is provided by the Teamcenter application or
custom integration as an extension of the TaskPrep abstract task preparation
class. The dispatcher client runs the init, prepareTask, and optionally, the
createSuccessorTranslationRequest methods to prepare input data for
dispatcher requests using the translator configuration-specified Prepare class for
the provider name and translator name specified by the dispatcher request.
The Prepare class validates that all data necessary to translate the primary objects
are available and collects the necessary files for input to the translator in a task
staging location. Primary objects that are data incomplete are generally excluded
from the translator input with appropriate logging messages. Objects that have
translation results can also be excluded.
For more information, see the DISP_ROOT/DispatcherClient/docs/dc/javadoc
directory for TaskPrep class Java documentation.
Sample code for the TaskPrep class is provided in the
DISP_ROOT/DispatcherClient/sample/integration/translators/proetojt
directory. A DefaultTaskPrep class is provided that handles the default behavior
of the TaskPrep class. Customizations can be done by extending this class as
shown in the sample code.
Sample code for the DefaultTaskPrep class is provided in the
DISP_ROOT/DispatcherClient/sample/integration/translators directory.
During the extract operation for a dispatcher request, the TaskPrep class methods
are run by the dispatcher client in the following sequence:
init
The init method initializes member variables using argument values, configuration
data, and request data.
prepareTask
The prepareTask method collects all input required by the translator from
the Teamcenter application or custom integration data model and constructs
the translation task file required. All input files are collected in a task staging

location that is uploaded to the Dispatcher Server by the dispatcher client following
successful preparation.
Implementation of this logic is left to a translator–specific subclass. Several
examples of this logic are provided in the examples.
createSuccessorTranslationRequests
The createSuccessorTranslationRequests method is run only if the
prepareTask method sets the isSuperseded Boolean attribute to true.
During customization the custom code can call the prepTransTask and
addRefIdToTask methods in the DefaultTaskPrep class.
Customizing data loading

Storage of translator results is provided by the Teamcenter application for custom
integration as an extension of the DatabaseOperation abstract class. The
dispatcher client runs the DatabaseOperation class methods to map result files
using the configuration-specified FileMap class and store result data for dispatcher
requests using the configuration-specified Load class given for the dispatcher
request provider name and translator name. The translator load integration class
stores translation result files according to the Teamcenter application or custom
integration data model.
For more information about the DatabaseOperation class, see the
DISP_ROOT/DispatcherClient/docs/ts/javadoc directory.
During the load operation for a dispatcher request, the DatabaseOperation class
methods are run by the Loader in the following sequence:
init
The init method initializes member variables using argument values, configuration
data, and request data.
processTaskPre
The processTaskPre method provides, at the translation task scope, a preload
customization enabler for standard translations. It is intended to be a customization
that can be implemented by subclasses of existing DatabaseOperation classes.
An empty implementation is provided by the DatabaseOperation class.
processTask
The process Task method executes the load method sequence to load the translation
results. An implementation is provided by the abstract class.
processTaskPost
The processTaskPost method provides, at the translation task scope, a postload
customization enabler for standard translations. It is intended to be a customization
that can be implemented by subclasses of existing DatabaseOperation classes.
An empty implementation is provided by the DatabaseOperation class.

query
The query method provides support for implementation of preload activities,
for example, queries to identify objects that participate in loading. No database
modifications are made and all data necessary to perform database modifications are
assembled. An implementation is provided by the abstract class.
validate
The validate method validates that the results of translation of a primary object
can be loaded into the database. An implementation is provided by the abstract class
that verifies that the primary and secondary objects on the request are currently
owned by the local Teamcenter site.
loadPre
The loadPre method provides, at the translation data element scope, a preload
customization enabler for standard translators. It is intended to be a customization
point that can be implemented by subclasses of existing DatabaseOperation
classes.
An empty implementation is provided by the abstract DatabaseOperation class.
load
The load method contains the statements that perform database additions,
modifications, and deletions to store the translation results as required by the
target data model.
Implementation of this logic is left to a translator-specific subclass.
loadPost
The loadPost method provides, at the translation data element, a postload
customization enabler for standard translators. It is intended to be a customization
point that can be implemented by subclasses of existing DatabaseOperation
classes. A typical loadPost customization could add additional attributes to a result
or related object.
An empty implementation is provided by the abstract DatabaseOperation class.
Custom implementations of DatabaseOperations classes can extend the
DefaultDatabaseOperation class. A sample DefaultDatabaseOperation class
is located in the DISP_ROOT/DispatcherClient/sample/integration/translators
directory.
The DatabaseOperation class is located in
DISP_ROOT/DispatcherClient/sample/integration/translators/proetojt
directory.
Add customizations during Dispatcher client startup

To call a custom code during the Dispatcher client startup, do the following:
1. Create a custom class that extends com.teamcenter.ets.ServiceInit and
implement the init method.
Example:

{
public void init()
{
//call custom code.
}
}
2. Add the compiled class to the DispatcherClient\lib directory as a jar file.
3. Add the class name to DispatcherClient\conf\Service.properties as follows:
#Custom class to invoke the methods that need to be called during DispatcherClient st
#This class needs to implement the "init" method defined in com.teamcenter.ets.Servic
Configure logging
Dispatcher uses Log Manager for logging. Log Manager controls the location and
other parameters during logging.
To create an SOA log file, use the method
ETSInit.createLogger("com.teamcenter.soa").
For more information about Log Manager, see the System Administration Guide.
Integrate new translators in Teamcenter rich client

The following procedure explains how to integrate new translators in the Teamcenter
rich client. It assumes that appropriate triggers for the translation already exist.
Note Adapt the procedure for UNIX as required.
1. Confirm that the desired translation is supported by a Dispatcher Server

integrated translator.
For more information, see the Dispatcher Server Translators Reference Guide.
2. Determine the following input requirements of the translator:

• Data to be translated.
• Datasets containing the data to be translated.
• Named references are required to perform the translation.
3. Design the logic of the new TaskPrep subclass prepareTask method to satisfy
translator input, and other Dispatcher requirements. Design the necessary
helper classes. Sample TaskPrep classes and property files are provided in the
DISP_ROOT/DispatcherClient/sample/integration/translator directory.
4. Determine the preferences required by the new TaskPrep subclass and add
them to the Translator name_env.xml file. Keep in mind that some preferences
may be required by the TranslateMenu classes and utilize these preferences
before creating new ones.
The Translator-name_env.xml file should be created in the
DISP_ROOT/DispatcherClient/install directory.
You must manually load the preferences into Teamcenter.

5. Determine the output of the translator.
6. Determine the Teamcenter data model under which the result files will be stored.
Utilize the Teamcenter standard data model and supported extensions. Be sure
the data model is supported by any downstream tools that are to consume
translation results from the Teamcenter database.
7. Determine the DatabaseOperation method implementations that will be

necessary to load the translator results in the Teamcenter database. This
includes the load method at a minimum.
8. Design the logic of the required DatabaseOperation

methods and any necessary helper classes. Sample
DatabaseOperation classes and property files are provided in the
DISP_ROOT/DispatcherClient/sample/integration/translator directory.
9. Determine the preferences required by the new DatabaseOperation subclass

and add them to the Translator-name_env.xml file. Keep in mind that some
preferences may be required by the TranslateMenu classes and utilize these
preferences before creating new ones.
10. Extend the dispatcher client DefaultTaskPrep abstract class in a new

TaskPrep class in a package specific to the translator.
For example: your path.translator.provider name.translator name
11. Implement the new DatabaseOperation subclass in the same package with the
TaskPrep class.
12. Implement the associated helper classes.
13. Compile the Java source files.

javac –classpath Classpath created by the
runDispatcherClient.bat/sh file myFile.java
14. Create the TSTranslator nameService.properties file to incorporate the new

translator integration classes.
The provider and service attribute values specified by the module translator
configuration in the translator.xml file must be used in constructing the
property names (keys).
Edit the Service.properties file to import the new TSTranslator
nameService.properties file.
15. Archive the new Java classes and the TSTranslator nameService.properties
file. These new classes along with other customized dispatcher client classes are
most simply combined into a single application or custom JAR file.
Make sure the TSTranslator nameService.properties file is in the root
directory.
jar cf jar file name.jar myFile.class
myFile2.class TSTranslator nameService.properties
16. If the JAR file contains only translator integration classes, copy the new JAR file
to the DISP_ROOT/DispatcherClient/lib directory.

17. Implement the new translator site preference XML file and use the
preferences_manager executable to import the file.
preferences_manager -u=infodba -p=infodba -g=dba -mode=import
-scope=SITE -action=override -context=Teamcenter -file=your XML file
18. Modify the ETS_trans_rqst_referenced_dataset_types site preference to

add the application or customized dataset type name of the datasets that may
be specified as a primary objects in the dispatcher request for this translator.
Addition of a dataset type to this preference allows cancellation of a dispatcher
request and subsequent deletion of the primary objects while the translation
is in process.
19. Add the Translate menu support for the new translation.
20. Start the dispatcher client.
21. Trigger an on-demand dispatcher request and verify that the new TaskPrep
class run by the dispatcher client processes the dispatcher request correctly.
Examine the contents of the Dispatcher Server file server task directory (or task
staging location if configured for shared staging location). Verify that the XML
task file is present and that its contents are correct. Verify that all the expected
translator input files are present.
22. Verify that the translation task is successfully submitted to the Dispatcher
Server scheduler.
23. When translation completes, verify the contents of the Dispatcher Server task
directory (or task staging location) to see that all expected result files are present.
24. Verify that the new DatabaseOperation class runs by the dispatcher client
processes the dispatcher request and correctly loads the result files. Confirm
that the location and ownership of the stored results is correct.
25. Confirm that the results can be accessed in the Teamcenter database.
Creating dispatcher requests

You can customize dispatcher request creation by:
• Adding translator preferences to the Teamcenter database and then using the
Translate menu commands for translations.
• Using APIs for creating dispatcher requests. You can use these APIs for batch
processing of dispatcher requests or creating a dispatcher request from a
workflow.
Creating dispatcher requests in Teamcenter rich client

Dispatcher client provides a single dispatcher request creation menu that is driven
from preferences defined within Teamcenter. This event is activated by selecting
the Translation®Translate menu command in My Teamcenter through one of the
specific translator menu selections.

To add the translator to the Translate menu command, you must add translation
preferences to Teamcenter.
For more information about adding translator preferences, see Add Dispatcher
preferences.
If this menu command does not allow the creation mechanism you need in
the rich client, a method is exposed to create a dispatcher request on the
com.teamcenter.rac.ets plug-in within the rich client. The package, class, and
method to create the request are:
Package: external
Class: DispatcherRequestFactory
Method: createDispatcherRequest
Creating dispatcher requests using ITK APIs

Dispatcher client provides server APIs to support customized triggering of
translations. The dispatcher client framework for creation of dispatcher requests
allows customizations in the following areas:
• Batch translations
• Workflow
You can create dispatcher request objects using the DISPATCHER_create_request

API.
These API support the creation of dispatcher request object in a server environment.
You must include the dispatcher_itk.h file to provide the prototype for these
Dispatcher API functions, and you must modify link scripts to link against the
libdispatcher shared object.
Create dispatcher requests using ITK APIs
1. Modify the sample dispatcher_create_rqst_itk_main.c source code or create a

new ITK command line C source file.
2. Compile the source module using the sample script provided in the
TC_ROOT/sample directory by entering the following command:
compile –DIPLIB=none dispatcher_create_rqst_itk_main.c
3. Copy the sample ITK link script provided in the TC_ROOT/sample directory.
Edit the copied ITK link script to add the Dispatcher library, libdispatcher.lib,
to the link command.
4. Run the modified ITK link script by entering the following command:
myLinkitk –o dispatcher_create_rqst_itk_main dispatcher_create_rqst_itk_main.obj
5. Test the new ITK executable.

Batch translations
Existing non-Dispatcher customer translation processes typically employ a daily
process that runs during off hours to examine the contents of the customers
Teamcenter database and create the necessary visualization data. You can integrate
this process with Dispatcher using Dispatcher Integration Toolkit (ITK) APIs.
For performing batch translations, the following functionalities are provided:
• ITK functions for use in custom batch programs.
• Command line ITK executables (with sample source) for use by batch scripts.
Dispatcher provides the DISPATCHER_create_request server ITK API. This ITK

API supports the creation of dispatcher request objects in a server environment.
For more information about using ITK APIs for creating dispatcher requests, see
Creating dispatcher requests using ITK APIs.
Workflow translations
No workflow action handlers or triggers are currently provided by Dispatcher.
Because workflow is a customer process, it is intended that on-site customizations of
workflow action handlers use the Dispatcher Integration Toolkit (ITK) API to create
dispatcher requests as they are needed.
Creating dispatcher requests using Teamcenter Services

Dispatcher provides a service to allow the creation of a dispatcher request using the
service-oriented architecture within Teamcenter.
For more information, see the Services Guide.
Translation menu integration

The Translation menu item appears on the menu bar, if you select the Translation
for Rich Client option during installation. The following procedures describe how
to create the new menu items in the Translation menu bar and to start a new
dispatcher request using the new menu item.
Create new menu item

1. For information about customizing the menu bar, see the Client Customization
Programmer’s Guide.
2. Open plugin.xml in Eclipse 3.3. In the menuContribution tag, add the

following location;
<menuContribution
locationURI="menu:com.teamcenter.rac.ets.external.translate?after=additions">
</menuContribution>

Note To place your new menu item after the Translate... menu item, use
after=additions in the menuContribution tag.
To place your new menu item before the Translate... menu item, use
after=bottom in the menuContribution tag.
Create dispatcher request using the new menu item

• To create a new dispatcher request from the new menu item, use the
createDispatcherRequest method as an exported function from the
DispatcherRequestFactory class. This method allows you to create a
dispatcher request easily from within your own plug-in by just referencing the
main Dispatcher plug-in from Eclipse.
/**
* Creates the DispatcherRequest.
*
* This function allows customers who wish to create a DispatcherRequest
* through a menu or other plug-in within Teamcenter.
*
* [R] = required, [O] = optional
*
* @param [R] provider - string representing the name of the translator
* provider
* @param [R] service - string representing the name of the translator
* to use
* @param [R] priority - integer representing the priority used in
* processing the request
* @param [O] primaryObjects - array of components selected within
* Teamcenter
* @param [O] secondaryObjects - array of parent components for the
* primary components
* @param [O] startTime - time to start the request
* @param [O] interval - number of times to repeat request
* @param [O] endTime - time at which to stop repeating tasks
* @param [O] type - string for user to define user specific type of request
* @param [O] requestArgs - name/value arguments to pass to service
*
* @return true, if create DispatcherRequest
*
* @throws TCException the TC exception
*
* @published
*/
boolean createDispatcherRequest(String provider, String service, int priority,
TCComponent[] primaryObjects,
TCComponent[] secondaryObjects,
String startTime, int interval, String endTime,
String type, Map<String, String> requestArgs) throws Exception
Add Dispatcher preferences

For translation options to appear in the Translation Selection dialog box, you must
add Dispatcher preferences.
This dialog box allows you to select the translation provider and service for a
selected data type. You can view the Translation Selection dialog box by choosing
the Translation®Translate menu option in My Teamcenter menu.
Note The translator preferences provided by Dispatcher are imported in
Teamcenter during installation. You only need to add preferences of new
translators or providers that you want to add to Teamcenter.
1. In My Teamcenter, choose Edit®Options.
2. In the Options dialog box, select Filter. This option is located at the bottom
left corner of the Options dialog box.
The Preferences By Filter dialog box appears.

3. You can either modify the values of the existing preferences or add new
preferences. To create new Dispatcher preferences, click the Definition tab and
click Create a new preference definition in the Preferences By Filter dialog
box.
To modify the values of an existing preference, select the preference and change
the values in the Values box.
Note Access to preferences and preference hierarchy are specified by
protection scope.
For more information about adding and modifying preferences, see
Preferences and Environment Variables Reference.
You must set the following Dispatcher preferences:
Preference name Description

ETS.PROVIDERS Specifies the company that provides
translators.
ETS.TRANSLATORS. Specifies a list of translators for a specific
PROVIDER provider.
ETS.DATASETTYPES. Specifies valid datasets for the selected
PROVIDER.TRANSLATOR translators.
Note Only the datasets specified in this
preference are valid for translation.

Preference name Description

ETS.PRIORITY. Specifies the priority to be assigned to a
PROVIDER.TRANSLATOR dispatcher request when the translator
specified in this preference is used.
ETS.TRANSLATOR_ARGS. Specifies the list of translation arguments to
PROVIDER.TRANSLATOR be passed to the translator.
Note The order of values in the Values box determines the order in which they
appear in the Translation options dialog box.
4. Restart the Teamcenter server and rich client.
5. Select a dataset for which you defined preferences, and choose

Translation®Translate.
The translators defined for the dataset appear.
Note If there is more than one translator definition, all the translators appear
in a list.
The list with the translator values appears only if you select the cell
that contains the translator service.
For a complete list of Dispatcher preferences, see the Preferences and Environment
Variables Reference.
Customizing Translation Selection dialog box behavior

You can customize the Translation Selection dialog box behavior to do the following:
• Validate data.
• Dynamically add translation argument values to the dispatcher request.
You must perform the following steps to customize the Translation Selection dialog
box.
• Create a custom plugin.
• Create a custom class.
Create a custom plugin

1. Create a new plugin based on the
com.teamcenter.rac.ets.translator.singleselection plugin and extend
the requestCustomize point.

2. You must provide the following information in the plugin.xml file.

• providerName=Name of the provider whose behavior needs to be customized
• serviceName=Name of the service whose behavior needs to be customized
• class=Name of the class that implements the customization
Your plugin.xml file looks like this:

<?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.4"?>
<plugin>
<extension point="com.teamcenter.rac.ets.translator.
singleselection.requestCustomize">
<translator class=" com.foo.customization.abctoxyz.
AbcToXyzRequestCustomization"
providerName="SIEMENS"
serviceName="abctoxyz">
</translator>
</extension>
</plugin>
You can add multiple translator tags to provide customization classes for different
services, and the same plugin can be used to provide customization classes for
different services.
However, there can be only one customization class for a service and provider
combination.
Create a custom class

1. Create a class com.teamcenter.rac.dispatcher.translator.singleselection.
customization.translator service name.New class
nameRequestCustomization, which implements
com.teamcenter.rac.ets.translator.singleselection.customization.

IRequestCustomizable.
2. This class must implement the following methods:

• validateRequestData
• getValuesForKeys
For more information about the extension point, refer to the requestCustomize.exsd
schema located in the com.teamcenter.rac.ets.translator.singleselection plugin.
For an example on how to extend the requestCustomize extension point, see the
com.teamcenter.rac.dispatcher.customization plugin.
Customizing the Dispatcher request administration console

You can customize the Dispatcher request administration console to:
• Filter requests in the Dispatcher request administration console.
For example: Filter out other site requests, filter out requests owned by other
users.
For more information, see Filter requests in the Dispatcher request administration
console.
• Create a new sub-menu under the Translation menu.

This menu launches the Dispatcher request administration console with
predefined filtered results.
For example: Create a sub-menu called Terminal only to show only terminal
requests in the Dispatcher request administration console.
For more information, see Create a new sub-menu under the Translation menu.
Filter requests in the Dispatcher request administration console

1. Create a new plugin based on the com.teamcenter.rac.ets plugin and extend
the DispatcherAdminConsoleFilter point.
2. You must provide the following information in the plugin.xml file.

class=com.teamcenter.rac.dispatcher.sampledispaccustomization.
handlers.NonTerminalFilter
Class is the actual class provided by new plugin
which implements methods defined in the
com.teamcenter.rac.ets.customization.IDispatcherACCustomizable
interface.
Your plugin.xml file looks like this:
<?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.4"?>
<plugin>
<extension
id="adminconsolenonterminal"
point="com.teamcenter.rac.ets.DispatcherAdminConsoleFilter">
<filter

class="com.teamcenter.rac.dispatcher.sampledispaccustomization.
handlers.NonTerminalFilter">
</filter>
</extension>
</plugin>
There can be only one customization class for a service and provider combination.
If there are multiple customizations, the Dispatcher request administration
console ignores all the customizations and displays all the queried requests
to user.
3. Create a class
com.teamcenter.rac.dispatcher.sampledispaccustomization.
handlers.NonTerminalFilter which implements
com.teamcenter.rac.ets.customization.IDispatcherACCustomizable.
4. This class must implement the method in IDispatcherACCustomizable.
For more information about the extension point, refer to the

com.teamcenter.rac.ets.DispatcherAdminConsoleFilter.exsd
schema in com.teamcenter.rac.ets plugin.
Create a new sub-menu under the Translation menu

1. Create a new plugin based on the com.teamcenter.rac.ets plugin.
2. In the new plugin, create a new menu and create a handler class to handle
the menu click.
3. Create a class
com.teamcenter.rac.dispatcher.sampledispaccustomization.
handlers.NonTerminalFilter which implements
com.teamcenter.rac.ets.customization.IDispatcherACCustomizable.
4. This class must implement the method in IDispatcherACCustomizable.
5. In the handler class, implement execute(ExecutionEvent) method to call

AdminDialogService.OpenAdminDialog() method and pass an instance of
filter class created previously.
Note If you use this method, the Dispatcher request administration console will
ignore filter class defined by extending the extension point. Dispatcher
request administration console will only use the filter class passed in
OpenAdminDialog() method.

Appendix
A Troubleshooting
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Checklist to handle errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Isolate translation problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Setting debug levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3
Query translation request objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4
Unable to run Dispatcher components as Windows service due to missing DLL

file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-5
Dispatcher request go to terminal state due to large number of files open . . . . A-5

Appendix
A Troubleshooting
Troubleshooting
If errors occur during translations, follow these guidelines:
• Ensure you are doing things correctly and the prerequisites are set up.
• Isolate the problem and then fix it.
Checklist to handle errors

• Ensure that the installation and configurations are properly done.
For Teamcenter Environment Manager (TEM) installation instructions, see
Installing Dispatcher.
For manually installing and configuring Dispatcher components, see the
Dispatcher Server Installation Guide.
• Follow instructions in the documentation according to the order of dependencies.

Example To run the ideastojt translator, ensure that the ideastojt translator
is installed according to the I-deas installation guide. Next, refer to
the Dispatcher Server Translators Reference Guide for ideastojt
specific translator installation and configuration and dispatcher
client specific configuration.
• Check whether all the property files are configured correctly.

When you are not sure of the property values, try to be as close as possible to
the default property values.
• Ensure that all prerequisite software is installed and tested before installing
the dispatcher client.
Also ensure the correct versions of the prerequisite software are installed.
• Restart the dispatcher client and rich client after any property changes.
• Ensure that service access rules are added.

For more information, see Create a dispatcher client access rule.
• Ensure that you have permissions to write to the staging directory.
• Ensure that you have file storage space to run translation services.
PLM00072 H Getting Started with Dispatcher (Translation Management) A-1

Appendix A Troubleshooting
Isolate translation problems

1. To isolate the application that is causing the translation failure, run the
translator in different contexts:
a. Run the translator in a stand-alone mode from the command line. For
information about running the translator from the command line, see the
translator documentation.
It the translator fails, it is a translator issue. See the translator
documentation for information about fixing it.
If the translator works, go to the next step.
b. Perform a translation within the context of Dispatcher Server using the

administration client.
For information about using the administration client, see the Dispatcher
If the translation fails, it is a Dispatcher Server issue. For information about
fixing it, see the Dispatcher Server Installation Guide.
If the translation works, go to the next step.
c. Perform a translation within Teamcenter. For information about performing

translation within Teamcenter, see Creating a translation request.
If the translation fails, it is a Teamcenter dispatcher client issue.
2. After the issue is identified as a Teamcenter dispatcher client issue, you can
further isolate the problem by setting debug levels to higher values in the
log4j.xml file.
For more information about setting debug levels, see Setting debug levels.
More debug information is available in:
• Console in which the dispatcher client started.
• Service logs are available in the

Log-Directory/Dispatcher/process/DispatcherClient.log file.
• Task logs are available in the

Log-Directory/Dispatcher/Task-ID/Task-ID_ts.log directory.
3. Delete or back up old logs to ensure that you are not looking at wrong files for
debug messages.
4. Create a new query for DispatcherRequest using Query Builder. This is useful
to check whether the DispatcherRequest object is created in the Teamcenter
database.
For more information about creating queries, see Query translation request
objects.
5. Shut down the dispatcher client. Use the on-demand dispatcher client to trigger
a translation request.
A-2 Getting Started with Dispatcher (Translation Management) PLM00072 H

Troubleshooting
a. Start the dispatcher client. Check the console, the DispatcherClient.log

file, or task log files to see whether the dispatcher client was successful in
extracting files from Teamcenter and uploading them to a staging location.
Confirm that files are in a staging directory. If extraction does not occur for
the translation request, query DispatcherRequest in the rich client to see
whether a DispatcherRequest object is created.
b. After extraction, the task is submitted to the scheduler. Check whether the
task was successfully submitted to the scheduler and that you get back a
translation successful event from Dispatcher Server. The Dispatcher Server
events should appear in the following order:
A. Submitted the task successfully
B. Started translation
C. Completed successfully
Confirm that result files (JT, CGM) are available on the file server staging
directory. If translation fails, you get a translation error event. If translation
fails, use input files in the file server staging directory to translate
independent of dispatcher client using Dispatcher Server administration
client or the core stand-alone translator.
If translation fails, the input files have some problem.
c. Check whether the dispatcher client was successful in downloading result

files and attaching result files back to Teamcenter. If the download is
successful and the attachment failed, check whether file mapping failed (file
mapping fails if result files do not map one on one with source files). This can
occur if translators are not configured per dispatcher client requirements.
See the Dispatcher Server Translators Reference Guide.
Setting debug levels

For all Dispatcher services, the LogVolumeLocation property defines the location
of the log files. This property can be found in the following locations:
• Module
DISP_ROOT/Moduel/conf/transmodule.properties
• Scheduler
DISP_ROOT/Scheduler/conf/transscheduler.properties
• Dispatcher client
DISP_ROOT/DispatcherClient/conf/DispatcherClient.properties
You can define the debug level for logs in the Log4j.xml file. This file is located in
the DISP_ROOT/Dispatchert-component/conf directory.
To change the debug level, change the value of the level value property to the
debug level you want.

Appendix A Troubleshooting
Information about the supported debug levels is as follows.











<logger name="Process">
<level value="INFO"/>
<appender-ref ref="ProcessAppender"/>
<appender-ref ref="ProcessConsoleAppender"/>
</logger>
<logger name="Task">
<level value="INFO"/>
<appender-ref ref="TaskAppender"/>
<appender-ref ref="TaskConsoleAppender"/>
</logger>
Query translation request objects

To check whether a translation request object is created in the database, create a
new query in the Query Builder application as follows:
1. In the Query Builder pane, type DispatcherRequest in the Name box.
This specifies the name for the query.
2. Click the Search Class button , and select DispatcherRequest as

the search class.
3. In the Attribute Selection pane, double-click the State attribute to add the State
attribute to the Search Criteria table.
4. In the Search Criteria pane, set the Default Value attribute to *.
5. Click the Create button to create the query definition.
For more information about creating and using queries, see the Query Builder Guide.
A-4 Getting Started with Dispatcher (Translation Management) PLM00072 H

Troubleshooting
Unable to run Dispatcher components as Windows service due to

missing DLL file
You cannot run Dispatcher components as Windows service if the msvcr71.dll file
is missing from your Windows system directory. To add this file to the Windows
system directory:
• Copy the msvcr71.dll file from the
Teamcenter-install-kit\install\install\jre\bin directory to your Windows
system directory.
For example, copy msvcr71.dll to C:\Windows\SysWOW64.
OR
• Add the Teamcenter-install-kit\install\install\jre\bin directory to the system

path variable.
Dispatcher request go to terminal state due to large number of files

open
On a linux server, if the number of open dispatcher requests is greater than the
number of files the server can handle, the extra dispatcher requests go to the
terminal state.
To fix this, run the ulimit utility and update the nofile argument with the number
of files or requests you want Dispatcher to handle at a time.
Example:
$ ulimit -n 65536

Appendix
B Service.properties file reference

Appendix
B Service.properties file reference
The Service.properties file is located in the DispatcherClient\conf directory.
Property Name Description Valid Default

values values
Service.Tc.Host The computer name where String
the dispatcher client tcserver value
processes will run. corresponding
to the
computer
name.
Service.Tc.Marker The Teamcenter database to log String
on to. value
corresponding
to the
database
server
name.
Service.Tc.User The Teamcenter user that the String
dispatcher client logs on as. This value
user is also known as DC Proxy corresponding
User. to the
Teamcenter
user name.
Service.Tc.Group The Teamcenter group that the String dba
dispatcher client logs on as. This value
must be the dba group. corresponding
to the
Teamcenter
group
name.
Service.Tc.Port Port number used for Any
communication between available
dispatcher client and port
Teamcenter processes. number.
Service.Tc.ReLogin Specifies the time (in minutes) Time in 1140
Interval after which the Teamcenter minutes.
services with log off from and log
back on to Teamcenter.
PLM00072 H Getting Started with Dispatcher (Translation Management) B-1

Appendix B Service.properties file reference
Property Name Description Valid Default

values values
Service.DataSetOwner Specifies the owner of DC or
visualization datasets created CAD. DC
by the dispatcher client. means
owner is
DC Proxy
User. CAD
means
owner is
the same as
the owner
of the
translation
datasets.
Service.StoreJTFiles Specifies that visualization data Boolean TRUE
InSourceVol files for a source dataset will be value.
stored in the same volume as the
associated source dataset data
files.
Service.UpdateExisting Specifies that the dispatcher Boolean FALSE
VisualizationData client should update existing value.
visualization data for
subsequent translations of
the same version.
Service.PollingInterval Specifies (in seconds) how long Time in
the translation process should seconds.
sleep before it again queries for
a dispatcher request.
Service.CheckFor Specifies whether validation Boolean TRUE
DuplicateRequests processing should reject value.
duplicate dispatcher requests.
Service.Tc. Specifies (in seconds) the Time in 1
ConnectDelay Teamcenter server connection seconds.
wait time between retries.
Dispatcher request cleanup properties — The request cleanup allows for automatic
cleanup of completed dispatcher equest objects in the database and the staging
directory.
Property name Description Valid Default

values values
Service.Request Specifies (in minutes) how often Time in
Cleanup.Successful. to query for and delete successful minutes
Interval dispatcher request objects.
B-2 Getting Started with Dispatcher (Translation Management) PLM00072 H

Service.properties file reference
Property name Description Valid Default

values values
Service.Request Specifies (in minutes) the amount
Cleanup.Successful. of time that must have passed
Threshold since a successful dispatcher
request is last modified before it
can be deleted.
Service.Request Specifies (in minutes) how often to
Cleanup.UnSuccessful. query for and delete unsuccessful
Interval dispatcher request objects.
Service.Request Specifies (in minutes) the amount
Cleanup.UnSuccessful. of time that must have passed
Threshold since an unsuccessful dispatcher
request is last modified before it
can be deleted.
E-mail properties — The following are the recognized dispatcher client e-mail
properties:
Property name Valid Default

Description values values
Service.Email. Specifies the adminstrator e-mail One or
AdminEmailId addresses to receive notification. more valid,
comma-delimited,
e-mail
addresses.
Service.Email. Specifies the delimiter used for the A valid ,
AdminEmailId Service.Email.AdminEmailId delimiter
Delimiter property value. character.
Service.Email. Specifies the SMTP server. A valid IP
SMTPServerName address of
the SMTP
Server
Service.Email. Specifies whether an e-mail 0=off, 1=on. 0
SendUserEmail should be sent when a translation
OnError error occurs.
Service.Email. Specifies the e-mail address that A single The
SenderId will send error notifications. valid e-mail dispatcher
address. client
name.
Service.Email. Specifies the message to prefix to String [TS_ERROR]
EmailSubjectPrefix the e-mail subject.
Filter properties — You can control translation services using dispatcher client
filters. Dispatcher client filters provide a convenient way to control dispatcher
request objects that are exposed to the dispatcher client for processing. If filters are

Appendix B Service.properties file reference
specified for a dispatcher client, all dispatcher requests must pass this filter, or the
dispatcher request is not processed by the dispatcher client.
For more information about filters and creating custom filters, see Dispatcher client
control.
Property name Default

Description Valid values values
Service.Filters Specifies a list of filters to Comma-separated
apply to the dispatcher request list of filters.
object.
For example:
Service.Filters=TranslatorFilter
Service.Filter name. Specifies the property value for
Filter property a filter.
For example:
Service.TranslatorFilter.Provider=SIEMENS
Filter.Filter name Specifies the class that
implements the filter.
For example:
Filter.TranslatorFilter=
com.teamcenter.ets.request.TranslatorFilter
Translator properties — For more information about Prepare, FileMap, and Load
classes, see the Java documentation in the DispatcherClient/docs/dc/javadoc
directory.

Translator.Provider name. Specifies the name of the class used
Translator name.Prepare to extract data from Teamcenter,
which will be provided to the
translator.
For example:
Translator.SIEMENS.atob.Prepare=
com.teamcenter.ets.translator.
ugs.atob.TaskPrep
Translator.Provider name. Specifies the name of the class used

Translator name.FileMap to match the files produced by the
translator to the source data.
B-4 Getting Started with Dispatcher (Translation Management) PLM00072 H

Service.properties file reference

Translator.Provider name. Specifies the name of the class
Translator name.Load used to save the results of the
translation in theTeamcenter
database and result files in the
Teamcenter volume.
For example:
Translator.SIEMENS.atob.Load=
com.teamcenter.ets.translator.
ugs.atob.DatabaseOperation
Translator.Provider name. Specifies whether a Boolean
Translator translator-specific duplicate
name.Duplicate check should be turned on or not.
Translator.Provider name. Specifies the log files to be attached Comma-delimited
Translator name.Log to the dispatcher request. log file
names.
Translator.Provider name. Specifies whether log files should Boolean
Translator be attached to dispatcher request if
name.LogsForComplete translation is successful.

Appendix
C Glossary

Appendix
C Glossary
AIF
See Application Integration Framework (AIF).
Application Integration Framework (AIF)

Integration framework that enables developers to build custom interfaces to
applications for Teamcenter and NX. This framework provides the foundation
through which applications can be launched and executed in a standard manner. It
also provides the basic design for applications, the base classes and methods, and
a methodology for creating and handling events generated by the user interface.
In addition, the AIF provides tools to handle the registration of components,
represented by Java beans, and a mechanism for locating and passing messages to
those components.
assembly file
3D CAD assembly file that contains an index of the geometry of constituent 3D
model files.
attribute
Named storage variable that describes an object and is stored with the object. Users
can search the database for objects using object attributes.
In an object, an attribute is a name/value pair; in the database, an attribute is a field.
bulk data
Physical information represented in the database by a data item. Examples of bulk
data are file system items, paper documents, and microfiche. The Teamcenter
database describes the bulk data. The bulk data resides elsewhere, for example, in a
file system or in a filing cabinet. See also data item.
CAD manager
Teamcenter interface to the specific CAD authoring tool. The CAD manager provides
the CAD specific knowledge for data interaction, normally to check out and edit, and
to check back into Teamcenter. The CAD manager is used by Dispatcher components
for gathering the dependent CAD items required for a translation.
I-deas – NXMI CAD Manager
NX – NX CAD Manager
Pro/ENGINEER – IPEM CAD Manager
PLM00072 H Getting Started with Dispatcher (Translation Management) C-1

Appendix C Glossary
CATIA – EB Solutions CAD Manager
CGM
Computer Graphics Metafile (CGM) is a file format for 2D vector graphics, raster
graphics, and text.
class
Set of objects that share the same list of attributes but distinguishable by the value
the attributes acquire for specific objects. For example, the Automobile class can be
defined by the brand, color, and price, but each car associated to the Automobile
class has a different brand, color, and price combination.
classification object (ICO)

Representation of a Teamcenter object within the classification system that extends
the object with classification data. ICOs specify the values of attributes defined by a
particular storage class within the classification hierarchy.
Client
Role played by a software component of a system when it requests particular services
be performed on its behalf by another entity, a server. See also server.
component
• Objects used to build up an assembly or subassembly.
• Part in a product structure defined in Teamcenter. A component is the lowest

level part in the product structure: it cannot be broken down into subparts.
corporate server
Host computer at the center of a Teamcenter network. This host contains the
Teamcenter application root directory, Teamcenter data directory, licensing, File
Management System (FMS), and volumes. For installations that include the Web
tier (four-tier architecture), the corporate server also contains the Teamcenter server
manager. Multiple application clients can map to or mount the corporate server.
data item
Teamcenter object representing bulk data defined and manipulated by application
products, for example, papers that reside in a filing cabinet, directories and files that
reside in a file system, Microsoft Excel spreadsheets, and CAD model and drawing
files. Metadata for the data item resides in the Teamcenter database. See also bulk
data and metadata.
dispatcher client
Solution that runs the Dispatcher to perform CAD translation and create required
relationships in Teamcenter.
Dispatcher request
Embeds information about the source file location and type of translation.
Dispatcher Server
Component that handles the specific computational and pipeline mechanisms to
execute translation tasks.
C-2 Getting Started with Dispatcher (Translation Management) PLM00072 H

Glossary
drawing file
Teamcenter CAD file containing a 2D vector image or 2D raster image.
DWG
Default extension used by Autodesk for its AutoCAD drawing files in MS-DOS and
Windows.
DXF
Drawing eXchange format.
extensible
To fit customer specific requirements or customizations not covered in the
out-of-the-box solution, Dispatcher supports extensions to the complete system for
how the data is collected, adding a new translator, and loading of the generated
data back into the PDM system. Java documents and example implementations
are provided for ease of customization.
FCC
See FMS client cache (FCC).
File Management System (FMS)

System that manages uploading and downloading file data between clients and
volumes in both two-tier and four-tier architecture deployments.
• FMS provides volume servers for file management, a shared server-level
performance cache for shared data access between multiple users, a client-based
private user cache for rich clients, and a transient datastore mechanism for
transporting reports, PLM XML, and other nonvolume data between the
enterprise and client tiers.
• FMS file caching enables placing the data close to the user, while maintaining a
central file volume and database store.
FMS client cache (FCC)

FMS process that runs on a client host, uploading files to an FMS server cache
process, requesting files from an FMS server cache process, and caching files on
the client host. The FCC process manages two caches of whole files: a write cache
containing files uploaded to a Teamcenter volume and a read cache containing files
downloaded from a Teamcenter volume. It also manages one segment file cache for
Teamcenter lifecycle visualization. Each Teamcenter rich client host requires a
local FMS client cache.
FMS server cache (FSC)

FMS process that runs on a server host and performs as a volume server (when
running on a host where a volume is located or directly mounted) or a cache server
(when running on a host where a volume is not located or directly mounted) and a
configuration server. As a volume or cache server, the FSC checks all file access
requests for a ticket that Teamcenter generates to authorize file access. As a cache
server, it manages two segment file caches, one for downloading files and one for
uploading files. As a configuration server, it provides FMS configuration information
to file client caches and other FSCs. As a transient server, it delivers PLM XML and

Appendix C Glossary
other transient files to clients. A minimum of one FSC must be deployed in any
Teamcenter installation. Multiple FSCs can be deployed, with each FSC performing
one designated purpose as either a volume, a cache, or a configuration server.
FSC
See FMS server cache (FSC).
ICO
See classification object (ICO).
I-deas
Siemens PLM Software’s integrated CAD/CAM/CAE solution that is used to design,
analyze, test, and manufacture products.
IGES
Initial Graphics Exchange Specification (IGES) defines a neutral data format that
allows the digital exchange of information among CAD systems.
Log Manager
Common logging service framework that the Dispatcher components use for logging
the process and tasks.
metadata
Object description in the Teamcenter database.
My Teamcenter
In the Teamcenter rich client and thin client, application that is the main access
point for managing product information. My Teamcenter provides the functionality
for creating objects in the Teamcenter database, querying the database for objects,
checking in and checking out objects, and managing tasks. Users can also open
objects, automatically launching the related application.
Each user has a personal My Teamcenter window that displays product information
as graphical objects. Although users share product information across the enterprise,
they organize this information individually in personal workspaces.
NX Integration
Integration between Teamcenter and NX. NX Integration users have full access
to the Teamcenter user interface from NX, and they can also access NX from the
Teamcenter user interface.
Teamcenter Integration for NX and NX Integration have the identical user
interface in NX. The difference between the two products is the level of Teamcenter
functionality available. Teamcenter Integration for NX excludes certain Teamcenter
functionality, such as workflow and product structure editing.

Glossary
persistent object manager (POM)

Interface between Teamcenter objects and the Relational Database Management
System (RDBMS). The persistent object manager provides definition of classes
by inheritance from other classes and definition of attributes, manipulation of
in-memory objects and support for their saving and retrieval to and from the
underlying RDBMS, support for applications accessing the same data concurrently,
protection against the deletion of data used by more than one application, and
support for the access control lists attributed to objects.
POM
See persistent object manager (POM).
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 the main translation process. It prepares and sanitizes the data for
the main translation process.
properties file
File containing the attributes (keys and values) that specify how an application is to
behave in the Teamcenter rich client.
remote method invocation (RMI)

Java-to-Java way to call methods of an object or class that is running on another
platform. RMI comes with the Java Development Kit (JDK).
rich client
Java-based user interface to Teamcenter installed on user workstations. The rich
client accesses Teamcenter databases using a remote or local server. Compare to
thin client.
RMI
See remote method invocation (RMI).
scheduler
Regulates translation tasks to the translation modules.
server
System software component that performs a specifically defined set of software
services on behalf of one or more clients. In a typical Teamcenter installation,
servers are centralized on dedicated hosts that support a large number of clients.
Clients are distributed on hosts connected to the servers via various networking
techniques. See also Client.

Appendix C Glossary
Structure Manager
Teamcenter application that enables creation of generic product structures that can
be configured to show the product structure that is in production, effective on a
certain date, used by a particular customer, and so forth. Structure Manager enables
creation and modification of a product structure and its associated occurrence data,
display of a product structure in a multilevel indented format, and viewing graphics
tightly coupled to the structure for easy identification of a component by location in
the structure or in the embedded viewer.
task (workflow)
Fundamental building block used to construct a process. Each task defines a set of
actions, rules, and resources used to accomplish that task.
Teamcenter Integration for NX I-deas

Product that integrates Teamcenter and I-deas to provide a single data management
environment for users. Teamcenter Integration for NX I-deas users author their
data in I-deas and manage the data in Teamcenter. Teamcenter Integration for NX
I-deas includes the My Teamcenter user interface and the I-deas Data Services (IDS)
and Team Data Sharing (TDS) modules. See also I-deas.
thin client
Teamcenter user interface that provides a streamlined browser-based view of product
information stored in a Teamcenter database. The thin client is configured in the
Web tier, which creates and serves its Web pages to the client. Compare to rich client.
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
Launches the translators that perform the translation. Each module resides on one
hardware node on the network and is connected to the translation scheduler.
translation server
Web-accessible, scalable, and configurable software that performs translation from
and to various file formats.
translator wrapper
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

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.

Index
A Dispatcher processing
attributes . . . . . . . . . . . . . 1-7, 6-3
Abbreviations Translation process . . . . . . . . . . . 1-9, 6-5
TM_ROOT . . . . . . . . . . . . . . . . . . . . 3-3 Configuring
Administering Add preferences . . . . . . . . . . . . . . . . 6-18
Error handling . . . . . . . . . . . . . . . . . . 4-9 Configure translators . . . . . . . . . . . . . 3-5
Logging . . . . . . . . . . . . . . . . . . . . . . . 4-9 Create access rule . . . . . . . . . . . . . . . 3-1
Request Administration Console . . . . . 4-5 Logging . . . . . . . . . . . . . . . . . . . . . . . 3-2
Administration Console Manual configuration . . . . . . . . . . . . . 3-2
Using Manual configuring . . . . . . . . . . . . . . 3-2
View dispatcher properties . . . . . . 4-6 Manually configuring
Dispatcher Client . . . . . . . . . . . . 3-2
Module . . . . . . . . . . . . . . . . . . . . 3-2
C Scheduler . . . . . . . . . . . . . . . . . . 3-2
Run dispatcher client as Windows
Classes service . . . . . . . . . . . . . . . . . . . . . 3-4
DatabaseOperation . . . . . . . . . . . . . 6-11 Security services . . . . . . . . . . . . . . . . 3-3
Request filter . . . . . . . . . . . . . . . . . . . 6-7 Start services . . . . . . . . . . . . . . . . . . 3-3
TaskPrep . . . . . . . . . . . . . . . . . . . . . 6-10 Dispatcher Client . . . . . . . . . . . . 3-4
Commands Module . . . . . . . . . . . . . . . . . . . . 3-4
Pause dispatcher client . . . . . . . . . . . 4-10 Scheduler . . . . . . . . . . . . . . . . . . 3-3
Start dispatcher client . . . . . . . . . . . . 3-4 Customizing . . . . . . . . . . . . . . . . . . . . . 6-1
Start module . . . . . . . . . . . . . . . . . . . 3-4 Batch translations . . . . . . . . . . . . . . 6-17
Start scheduler . . . . . . . . . . . . . . . . . 3-3 Configure logging . . . . . . . . . . . . . . . 6-13
Stop dispatcher client . . . . . . . . . . . . . 4-9 Data extraction . . . . . . . . . . . . . . . . 6-10
Stop module . . . . . . . . . . . . . . . . . . . 4-9 Data loading . . . . . . . . . . . . . . . . . . 6-11
Stop scheduler . . . . . . . . . . . . . . . . . . 4-9 Dispatcher client statup . . . . . . . . . . 6-12
View history dispatcher client . . . . . . 4-11 Dispatcher request administration
View runtime status dispatcher console . . . . . . . . . . . . . . . . 6-22–6-23
client . . . . . . . . . . . . . . . . . . . . . 4-10 Extensions . . . . . . . . . . . . . . . . . . . . 6-6
View runtime status module . . . . . . . 4-10 Integrate new translators . . . . . . . . . 6-13
View runtime status scheduler . . . . . 4-10 Service filters . . . . . . . . . . . . . . . . . . 6-8
Windows services Task preparation . . . . . . . . . . . . . . . 6-10
Concepts . . . . . . . . . . . . . . . . . . . . . . . 1-5
Dispatcher components . . . . . . . . . . . . 1-5 D
Module . . . . . . . . . . . . . . . . . . . . 1-6 Dispatcher client configuration files
Request administration Console . . 1-7 Service.properties . . . . . . . . . . . . . . B-6
Scheduler . . . . . . . . . . . . . . . . . . 1-6 Dispatcher client filters . . . . . . . . . . . . . 6-7
Translators . . . . . . . . . . . . . . . . . 1-7 OwningUserFilter . . . . . . . . . . . . . . . 6-7
Dispatcher request object PriorityFilter . . . . . . . . . . . . . . . . . . . 6-7
Dispatcher request states . . . . 1-8, 6-4 Request filter class . . . . . . . . . . . . . . . 6-7
DispatcherRequest object . . . . . . . 1-7, 6-3 TranslatorFilter . . . . . . . . . . . . . . . . . 6-7
PLM00072 H Getting Started with Dispatcher (Translation Management) Index-1

Index
Dispatcher Client filters R

Customize . . . . . . . . . . . . . . . . . . . . . 6-8 Request Administration Console . . . . . . . 4-5
Definition . . . . . . . . . . . . . . . . . . . . . 6-7 Interface . . . . . . . . . . . . . . . . . . . 1-3, 4-5
Using
E Delete dispatcher request . . . . . . . 4-6
Enabling . . . . . . . . . . . . . . . . . . . . . . . 1-2 Filter dispatcher requests . . . . . . . 4-8
Extensions . . . . . . . . . . . . . . . . . . . . . . 6-6 Launch Dispatcher request
Definition . . . . . . . . . . . . . . . . . . . . . 6-6 administration console . .... . 4-5
Performance tuning . . . . . . .... . 4-8
Refresh translation requests .... . 4-6
H Resubmit dispatcher request ... . 4-6
Hardware requirements . . . . . . . . . . . . . 1-2 Rich client perspectives and views .... . 1-4
Rich client views . . . . . . . . . . . . . .... . 1-4
I
S
Installing . . . . . . . . . . . . . . . . . . . . . . . 2-1
Install all components . . . . . . . . . . . . 2-1 Software requirements . . . . . . . . . . . . . 1-2
Install on existing Teamcenter
installation . . . . . . . . . . . . . . . . . . 2-4 T
Install on existing configuration . . 2-5 Teamcenter perspectives and views . . . . . 1-4
Install on new configuration . . . . . 2-4 Translate
Verify installation . . . . . . . . . . . . . . . 2-6 CAD files . . . . . . . . . . . . . . . . . . . . . . 4-4
M U
Methods Using
DatabaseOperation class . . . . . . . . . 6-11 Create dispatcher request
init . . . . . . . . . . . . . . . . . . . . . . 6-11 ITK APIs . . . . . . . . . . . . . . . . . 6-16
load . . . . . . . . . . . . . . . . . . . . . 6-12 Create translation request . . . . . . . . . 4-2
loadPost . . . . . . . . . . . . . . . . . . 6-12 My Teamcenter . . . . . . . . . . . . . . 4-2
loadPre . . . . . . . . . . . . . . . . . . . 6-12 Doc to Zip translation . . . . . . . . . . . . . 4-1
processTask . . . . . . . . . . . . . . . . 6-11 Pause services
processTaskPost . . . . . . . . . . . . 6-11 Dispatcher Client . . . . . . . . . . . 4-10
processTaskPre . . . . . . . . . . . . . 6-11 Stop services . . . . . . . . . . . . . . . . . . . 4-9
query . . . . . . . . . . . . . . . . . . . . 6-12 Dispatcher Client . . . . . . . . . . . . 4-9
validate . . . . . . . . . . . . . . . . . . 6-12 Module . . . . . . . . . . . . . . . . . . . . 4-9
RequestFilter class . . . . . . . . . . . . . . . 6-7 Scheduler . . . . . . . . . . . . . . . . . . 4-9
filterRequest . . . . . . . . . . . . . . . . 6-8 Translation . . . . . . . . . . . . . . . . . . . . 4-4
getOptionalPropertyNames . . . . . 6-8 View runtime status
getRequiredPropertyNames . . . . . 6-8 Dispatcher Client . . . . . . . 4-10–4-11
setProperties . . . . . . . . . . . . . . . . 6-8 Scheduler . . . . . . . . . . . . . . . . . 4-10
TaskPrep class . . . . . . . . . . . . . . . . . 6-10 View service information . . . . . . . . . 4-10
createSuccessorTranslation
Requests . . . . . . . . . . . . . . . 6-11 V
init . . . . . . . . . . . . . . . . . . . . . . 6-10
prepareTask . . . . . . . . . . . . . . . 6-10 View runtime status
Stop services
Module . . . . . . . . . . . . . . . . . . . 4-10
P
Views
Perspectives Rich client . . . . . . . . . . . . . . . . . . . . . 1-4
In general . . . . . . . . . . . . . . . . . . . . . 1-4
Index-2 Getting Started with Dispatcher (Translation Management) PLM00072 H

Getting Started Dispatcher Translation MGMT

Transféré par

Informations du document

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Getting Started Dispatcher Translation MGMT

Transféré par

Droits d'auteur :

Formats disponibles

Teamcenter 10.

Getting Started with Dispatcher

This software and related documentation are proprietary to Siemens Product

2 Getting Started with Dispatcher (Translation Management) PLM00072 H

Proprietary and restricted rights notice . . . . . . . . . . . . . . . . . . . . . . . . . 2

Overview of Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Installing Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Configuring Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Using Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Use Dispatcher services in Teamcenter Rapid Start . . . . . . . . . . . . . . . 5-1

Customizing Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

PLM00072 H Getting Started with Dispatcher (Translation Management) 3

Creating dispatcher requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15

Service.properties file reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

1-1. Dispatcher request administration console interface . . . . . . . . . . . . . . . 1-3

4 Getting Started with Dispatcher (Translation Management) PLM00072 H

Overview of Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Using Dispatcher in Teamcenter Rapid Start . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

Dispatcher interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Basic concepts about Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

PLM00072 H Getting Started with Dispatcher (Translation Management)

New name Old name

Using Dispatcher in Teamcenter Rapid Start

PLM00072 H Getting Started with Dispatcher (Translation Management) 1-1

Before you begin

• For information about Translator requirements, see

• Install the Dispatcher feature.

1-2 Getting Started with Dispatcher (Translation Management) PLM00072 H

Configure The Dispatcher components are configured automatically when

• Start Dispatcher services.

Dispatcher request administration console interface

Figure 1-1. Dispatcher request administration console interface

PLM00072 H Getting Started with Dispatcher (Translation Management) 1-3

Teamcenter rich client perspectives and views

o A perspective exists in a window along with any number of other

• Views and view networks

o Changes to data made in a view can be saved immediately.

1-4 Getting Started with Dispatcher (Translation Management) PLM00072 H

Basic concepts about Dispatcher

• Reduce server load by distributing resource-intensive activities.

• Schedule high-CPU or high-memory jobs for off-hours processing.

• Get a grid technology solution to manage the job distribution, communication,

• Generate a lightweight data format known as visualization data. The

PLM00072 H Getting Started with Dispatcher (Translation Management) 1-5

1-6 Getting Started with Dispatcher (Translation Management) PLM00072 H

Dispatcher request administration console

• Resubmit a translation request for processing.

• Delete a translation request.

DispatcherRequest object attributes

Primary objects Specifies one or more primary objects containing

PLM00072 H Getting Started with Dispatcher (Translation Management) 1-7

History states Displays various states that make up the history of

Dispatcher request states

1-8 Getting Started with Dispatcher (Translation Management) PLM00072 H

CANCELLED Indicates the dispatcher request has been canceled.

2. Each dispatcher client queries the DispatcherRequest database table

3. The dispatcher client changes the DispatcherRequest state value to

4. The dispatcher request is validated to check whether it is a duplicate of another

PLM00072 H Getting Started with Dispatcher (Translation Management) 1-9

5. The translator-specific task preparation logic is activated to prepare data for

7. When translation successfully completes, the Dispatcher Server again notifies

1-10 Getting Started with Dispatcher (Translation Management) PLM00072 H