SIEMENS

Teamcenter 12.0

Dispatcher Server
Installation
TTS00002 • 12.0
Contents

Part I: Overview and planning

Overview of the Dispatcher Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Overview of the Dispatcher Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Translation process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Using RMI mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Using Web mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Configuring port settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Port settings for RMI mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Port settings for Web mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Planning Your Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Planning your implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Dispatcher Server guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Set up the Dispatcher Server for Web mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Prerequisites for RMI mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Configuring the Dispatcher Server on the Linux platform . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Software distribution image contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Software and hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Software requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Other required software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Using worksheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Using worksheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Worksheet: Web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Worksheet: Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
Worksheet: Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Worksheet: Dispatcher Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9

Dispatcher Server quick start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Setting up dispatcher components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Before setting up dispatcher components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Set up the scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Set up modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Set up the Web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Set up the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Implementing translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Implementing translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Edit the translator.xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3

TTS00002 12.0 Dispatcher Server Installation 3

 Contents
Contents

Part II: Installing and configuring components

Installing and configuring the scheduler in a stand-alone environment . . . . . . . . . . . . . . 4-1

Installing and configuring the scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Install and configure the scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Copy installation files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Set up the scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Start and stop the scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Start and stop the scheduler service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Implementing intelligent licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Implementing intelligent licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Edit the TaskConfiguration.xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Storing translation tasks and events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5

Installing and configuring modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Installing modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Installing modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Copy installation files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Setting up modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Configure modules for RMI or Web mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Configure module properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Setting up an HTTPS connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Starting modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Start and stop the module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Run the module as a Windows service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7
Start and stop the module service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7

Installing and configuring the Web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Installing the Web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Using the Web server to perform translations across a firewall . . . . . . . . . . . . . . . . . . . . . 6-1
Copy installation files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Configuring the Web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Configure the Web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Edit the Dispatcher Server configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

Installing and configuring the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Why use the dispatcher client? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
What is a dispatcher client? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Typical data flow through the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Installing the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Before installing the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Copy installation files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Setting up the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Configure RMI or Web mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Configure dispatcher client properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Starting the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5

4 Dispatcher Server Installation TTS00002 12.0

 Contents

Start and stop dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5

Run the dispatcher client as a Windows service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Start and stop the dispatcher client service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Submitting translation requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Submit a translation request to the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7

Installing and setting up the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Installing the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Installing the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Copy installation files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Setting up the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Using the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Before starting the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Start the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Managing translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Add new translators and customize batch translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6
Add a new translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6
Customize batch translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7

Managing logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Configuring logs in Dispatcher . . . . . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Configuring logs in Dispatcher . . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Set debug levels . . . . . . . . . . . . . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Configure logs in a stand-alone Dispatcher Server ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Configure common log for translations . . . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2

Installing Web Application Manager and creating Web applications . . . . . . . . . . . . . . . . 10-1

Installing the Web Application Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Using the Web Application Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Copy installation files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

Part III: Appendixes

Implementing new translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Implementing new translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Adding the translator wrapper class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Why use a translator wrapper class? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Adding a translator element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3
Adding the translator JAR file to the classpath and path . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7
Sample translator startup scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7

Deployment considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

Deployment considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Selecting hardware for Dispatcher Server components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Criteria for choosing hardware for Dispatcher Server components . . . . . . . . . . . . . . . . . . . . . B-2
Dispatcher Server deployment strategies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3
Planning deployment of dispatcher components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3

TTS00002 12.0 Dispatcher Server Installation 5

 Contents
Contents

All local (same host) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3

Distribution on the same domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3
Multiple access on the same domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-8
Distribution on multiple domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-10

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
Unable to run Dispatcher components as a Windows service due to a missing DLL file . . . . . . . C-1
Troubleshoot the Dispatcher Server by running the Translation Admin Client . . . . . . . . . . . . . . C-1
Troubleshoot the Dispatcher Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2
Troubleshoot the scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2
Troubleshoot translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2
Troubleshoot the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3
Dispatcher client fails to start due to FSC exception error . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3
Dispatcher client fails to start while using JBoss . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-4

Figures

A typical translation process using RMI mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

A typical translation process using Web mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Default connection ports for RMI mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Default connection ports for Web mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
A typical configuration for the Linux platform using Web mode . . . . . . . . . . . . . . . . . . . 2-4
A typical configuration for the Linux platform using RMI mode . . . . . . . . . . . . . . . . . . . 2-5
Flow of data through client service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
All Dispatcher Server components on the same host . . . . . . . . . . . . . . . . . . . . . . . . . B-3
Dispatcher Server components distributed on separate hosts in the same domain . . . . . B-4
Teamcenter server and dispatcher client on the same machine, scheduler and modules on
other machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-5
Teamcenter server, dispatcher client, scheduler on the same machine, modules on other
machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-6
Teamcenter server and dispatcher client on the same machine, scheduler and one module on
the same machines, another module on a different machine . . . . . . . . . . . . . . . . . . . . B-7
Teamcenter server, dispatcher client, scheduler on the same machine, modules on machines
of different platforms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-8
Multiple servers access same Dispatcher Server 1 . . . . . . . . . . . . . . . . . . . . . . . . . . B-9
Multiple servers access same Dispatcher Server 2 . . . . . . . . . . . . . . . . . . . . . . . . . . B-9
Single Teamcenter server accessing Dispatcher Server components on a different
Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-10
Multiple Teamcenter server accessing Dispatcher Server components on a different
domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-11

6 Dispatcher Server Installation TTS00002 12.0

Part I: Overview and planning

Overview of the Dispatcher Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Planning Your Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Dispatcher Server quick start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

TTS00002 12.0 Dispatcher Server Installation

Chapter 1: Overview of the Dispatcher Server

Overview of the Dispatcher Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Translation process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

Using RMI mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Using Web mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Configuring port settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4

Port settings for RMI mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Port settings for Web mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

TTS00002 12.0 Dispatcher Server Installation

Chapter 1: Overview of the Dispatcher Server

Overview of the Dispatcher Server

A dispatcher server functions as an independent compute server that translates files from one
format to other formats. It consists of a dispatcher scheduler, dispatcher modules, and an optional
Dispatcher Admin Client. For better load balancing, each dispatcher module resides on a separate
machine and is connected to the dispatcher scheduler. The scheduler sends translation tasks to the
modules and they invoke one or more translators to perform the translations.

Note
This manual provides instructions for installing and configuring Dispatcher in a stand-alone
environment.
For information about installing Dispatcher components using Teamcenter Environment
Manager (TEM), see the Getting Started with Dispatcher manual.

The Dispatcher Server allows you to perform translations either using a Web server (Web mode) or
through remote method invocation (RMI) mode.
• Web mode: For performing translations across a firewall. This mode requires a Web server
and a file server.

• RMI mode: For performing translations within a firewall. This mode requires a common staging
directory.

RMI is a standard for distributed objects written in Java and uses a remote procedure call (RPC) to
invoke applications, components, and/or modules in a network. Translations using RMI mode are
generally faster. The Dispatcher Server standard installation supports RMI mode.
The scheduler balances the translation load in the event of multiple translation requests. If you have
numerous translation tasks in the scheduler queue at your site, you can start multiple modules. Each
module is automatically connected to the dispatcher scheduler and immediately starts participating
in the translation process.
The translation task request embeds information of the source file location and type of translation.
The module starts a separate thread to process each request. On starting the thread, the module
downloads the source file from the file server or common staging directory location to a unique
directory, invokes the required translator, and starts the translation process. After the Dispatcher
Server successfully completes the translation process, the module uploads the resulting files to the
file server or common staging directory location and notifies the scheduler. The scheduler then
communicates the status of the translation to the client.

TTS00002 12.0 Dispatcher Server Installation 1-1

 Chapter
Chapter 1: 1: Overview
Overview
of theofDispatcher
the Dispatcher Server
Server

Translation process

Using RMI mode

1. The client creates a translation request based on some trigger (such as checkin or on-demand)
and then extracts the source files to the staging directory.

2. The client submits the translation request to the dispatcher scheduler.

3. Depending on time or priority, the dispatcher scheduler sends the request to the dispatcher
module.

4. The dispatcher module accesses the common staging directory to get the source files.

5. The dispatcher module invokes the translator to translate the required files.

6. The dispatcher module places the result files in the staging directory.

7. The dispatcher module notifies the status to the dispatcher scheduler.

8. The scheduler notifies the client about the status.

9. The client accesses the result files from the common staging directory.

The following figure describes a typical translation process using RMI mode.

1-2 Dispatcher Server Installation TTS00002 12.0

 Overview of the Dispatcher Server

Client
SYSTEMS

Staging
1 9 Directory SYSTEMS

4 6 Translation
Scheduler

SwToJt

SeToJt 3

JtToJpeg
5 7
DocToPdf

IdeasToJt

Translation Modules

A typical translation process using RMI mode

Using Web mode

1. The client uploads the CAD file to the file server location.

2. The client creates a translation request and submits it to the Web server across the firewall.

3. The Web server submits the request to the dispatcher scheduler.

4. The dispatcher scheduler sends the task to the dispatcher module.

5. The dispatcher module downloads the CAD file from the file server location and invokes the
required translator based on the request.

6. The dispatcher module uploads the translated file to the file server after the Dispatcher Server
completes the translation.

7. The dispatcher module sends a message to the dispatcher scheduler. The dispatcher scheduler
caches the messages.

8. The client pings the Web server for translation event messages.

9. The Web server communicates with the dispatcher scheduler to get the cached messages.

10. The client downloads the result files from the file server.

TTS00002 12.0 Dispatcher Server Installation 1-3

 Chapter
Chapter 1: 1: Overview
Overview
of theofDispatcher
the Dispatcher Server
Server

The following figure describes a typical translation process using Web mode.

Web Server

Translation
Web Server
SYSTEMS

2 3

8
File Server
SYSTEMS 9
10

1 SYSTEMS

Firewall
6 5
Translation
Scheduler

SYSTEMS SYSTEMS SYSTEMS

Module 1 Module 2 Module 3 7

Translation Modules

A typical translation process using Web mode

Configuring port settings

Port settings for RMI mode

The following figure shows the Dispatcher Server’s default ports for RMI mode. You can configure
any port for various components of the Dispatcher Server as long as these ports are not used by
other processes.

1-4 Dispatcher Server Installation TTS00002 12.0

 Overview of the Dispatcher Server

Client

Unused Port or
Port specified by
Scheduler to Client
Client puts source files Port 2001
and gets results files Client to Scheduler

Port 1999
SYSTEMS
SYSTEMS Scheduler to Module
Module gets source files
and puts results files.
Translation
Common Port 2001
Staging Module to Scheduler Scheduler
Directory

Translation
Module 1 r
1 ule
2 00 hed
r t Sc
Po to le
ule 9 du
od 99 o
M r t 1 to M
Module gets source files SYSTEMS Po ler
du
and puts results files. c he
S

Translation
Module 2

Default connection ports for RMI mode

Port settings for Web mode

The following figure shows the Dispatcher Server’s default ports for Web mode. You can configure
any port for the various components of the Dispatcher Server provided these ports are not used
by other processes.

TTS00002 12.0 Dispatcher Server Installation 1-5

 Chapter
Chapter 1: 1: Overview
Overview
of theofDispatcher
the Dispatcher Server
Server

External Client
Port 80

Trusted Internal Web server/File server: HTTP

Network Web Browser Port 8080 or 80; can also be
configured as HTTPS

SYSTEMS

Web server/
File server

Corporate
Network
Module to File Server Port 2001
HTTP Port 8080 or 80; can to Scheduler
also be configured as HTTPS

SYSTEMS SYSTEMS

Port 1999
Scheduler to
Module

Translation Translation
Module Scheduler

Port 2001
Module to Scheduler

Default connection ports for Web mode

1-6 Dispatcher Server Installation TTS00002 12.0

Chapter 2: Planning Your Implementation

Planning your implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Dispatcher Server guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Set up the Dispatcher Server for Web mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

Prerequisites for RMI mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3

Configuring the Dispatcher Server on the Linux platform . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

Software distribution image contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5

Software and hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6

Software requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6

Other required software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7

Using worksheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7

Using worksheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Worksheet: Web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Worksheet: Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
Worksheet: Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Worksheet: Dispatcher Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9

TTS00002 12.0 Dispatcher Server Installation

Chapter 2: Planning Your Implementation

Planning your implementation

The Dispatcher Server comprises several components that must be installed and configured
separately. Implementing the Dispatcher Server consists of the following high-level tasks:

Note
Use worksheets during the planning stages to record the DNS host name and IP address
of each designated server machine. Mark components as you install them and record
related data such as home directory of Web server and used ports.

• Install and configure the Web server and deploy the Web application if you plan to use Web
mode. Alternatively, configure the common staging directory if you plan to use RMI mode.

• Install and configure the Dispatcher Server scheduler.

• Install the prerequisite software on the modules for the translators you want to implement.

• Install and configure the modules.

• (Optional) Install and configure the dispatcher admin client.

• Install, enable, and configure the translators.

• (Optional) Install and configure the dispatcher client.

Dispatcher Server guidelines

The Dispatcher Server module should have sufficient memory to handle file translations. Many file
translators perform in-memory translations, which can hamper the performance of a machine. The
module machine should be a stand-alone machine dedicated for file translations.

Note
Siemens PLM Software recommends that you install dispatcher 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.

To determine the number of dispatcher modules to implement:

• Determine the CAD translators you plan to support. Plan to include at least one dedicated
machine per CAD translator depending on anticipated loads.

TTS00002 12.0 Dispatcher Server Installation 2-1

 Chapter
Chapter 2: 2: Planning
Planning
Your Your Implementation
Implementation

• For each CAD translator, one or more preprocessor or postprocessor translators may be
required. For each dedicated module machine, plan to include one CAD translator, the required
preprocessor and postprocessor translators, and the required CAD software.

For example, if your site requires translation of Pro/ENGINEER, NX, and I-deas® parts and drawing
data to JT or DXF format for Teamcenter Automotive Supplier, you must ideally allocate three
dedicated module machines as follows:
• module1: Install and enable ProEToJt and ProEToDxf translators. Install and configure the
Pro/ENGINEER translator and Visual Collaboration Toolkit.

• module2: Install and enable NxToPv, NxToPvDirect, and NxToCgmDirect translators. Install
and configure the NX translator and Visual Collaboration Toolkit.

• module3: Install and enable the IdeasToJt package file and the JtToJpeg translator. Install and
configure the IdeasToJt translator and the Visual Collaboration Toolkit.

In a real-world implementation, you can rarely allocate dedicated module machines for each installed
translator. However, each module can support multiple translators if there are no conflicts. The
Dispatcher Server is capable of scheduling translations and load balancing. If the translations are not
fast enough, add additional dispatcher module machines to handle additional loads. To increase the
throughput for a particular translator, implement multiple modules with the same translator.

Set up the Dispatcher Server for Web mode

You can use Web mode for performing translations across a firewall. This mode requires a Web
server and a file server.

Note
The Dispatcher Server standard installation supports RMI mode.

1. Copy the Dispatcher\WebServer\DispatcherServer.config file to the HOME directory of your

Web server.
Each Web server defines its HOME directory differently. Refer the Web server documentation
to determine the HOME directory.

2. Deploy the Dispatcher\WebServer\DispatcherServer.war file on your Web server and start

the Web server.
For more information, see the Web server documentation.

3. Start the scheduler.

4. Open the Dispatcher\Module\conf\transmodule.properties file and edit the Staging.Dir

property. Leave it blank for Web mode and start the module.

5. Open the Dispatcher\DispatcherClient\conf\

DispatcherClient.config file and edit the DispatcherServer.URL property:

2-2 Dispatcher Server Installation TTS00002 12.0

 Planning Your Implementation

Note
Steps 5 and 6 are optional. Perform these procedures only if you run the dispatcher
client.

a. Comment the DispatcherServer.URL property for RMI mode.

Example:

#DispatcherServer.URL=rmi://localhost:2001

b. Uncomment the DispatcherServer.URL property for HTTP mode.

Example:

DispatcherServer.URL=http://localhost:8080/DispatcherServer/

6. Start the dispatcher client.

7. To test the Dispatcher Server in Web mode, start the dispatcher admin client and use HTTP as
Server Mode to login in. Try a test translation using the tozipfile translator.
You have set up the Dispatcher Server for Web mode correctly if your test translation is successful.

Prerequisites for RMI mode

RMI mode supports translations within a firewall and requires a common staging directory. In this
mode, the Dispatcher Server clients can directly communicate with the scheduler and perform the
translations without a Web server and file server. Unlike Web mode, RMI mode does not require file
transfers from the Dispatcher Server client locations and module locations.
The following are the prerequisites for using RMI mode:
• The clients and Dispatcher Server should point to the common staging directory and both should
have read/write permissions to that directory.
This avoids the need for file transfers from the client and module locations. The client writes the
translator input files to the common staging directory and the module writes the translator result
files to the staging directory in the results directory. For example, if d:\StagingDir is the common
staging directory for the module machine, then \\ModuleMachine\StagingDir on the client machine
(can be a different machine) should be the same directory, that is, StagingDir.

• The client and Dispatcher Server should be installed by the same user to avoid directory access
issues as the client and dispatcher modules use the same staging location.

• In the common staging directory configuration, the dispatcher module should have directory
create permission and write access to files on the client staging location using the network.
This means that when you access the staging location from the module machine, you should be
able to access or list (in UNIX systems) the directory contents of the staging location. The staging
location can be a network shared location.

TTS00002 12.0 Dispatcher Server Installation 2-3

 Chapter
Chapter 2: 2: Planning
Planning
Your Your Implementation
Implementation

• The physical location of the machine on which the common staging directory is configured should
be in closer proximity to the module machines than dispatcher server client machines.
This helps the translators to access files faster. The translators create temporary files and read
the source files from the common staging directory.

Configuring the Dispatcher Server on the Linux platform

The Dispatcher Server standard installation supports the Web server and dispatcher scheduler
on different platforms, including Linux; however, some of the translators are not supported on all
platforms. To configure the Dispatcher Server for the Linux platform, you can install the Web server
and the scheduler on Linux and install the dispatcher modules on the platforms that are supported
by the translator.
The following figure describes a typical configuration for the Linux platform using Web mode.

Windows
Translation
Module
Linux T1, T2
(client1)
Solaris
Linux
Linux Linux Translation
Translation
(client2) Web Server Module
Scheduler
T3, T4

Linux
IRIX
(client3)
Translation
Module
T5, T6

A typical configuration for the Linux platform using Web mode

2-4 Dispatcher Server Installation TTS00002 12.0

 Planning Your Implementation

The following figure describes a typical configuration for the Linux platform using RMI mode.

Windows

Translation
Module
Linux T1, T2
(client1)
Solaris
Linux
Linux Translation
Translation
(client2) Module
Scheduler
T3, T4

Linux
IRIX
(client3)
Translation
Module
T5, T6

A typical configuration for the Linux platform using RMI mode

All the Dispatcher Server components except the dispatcher modules can be on the Linux platform.
The dispatcher modules can be installed on Windows, Solaris, or IRIX depending on the platform
supported by the translator. The dispatcher scheduler on Linux communicates with the dispatcher
modules on different platforms based on the service names of these translators. The dispatcher
modules run the platform-specific translators and send the results back to the scheduler.

Software distribution image contents

The following components are included in the software distribution image:
• The DispatcherServer.war file, containing the file server servlet and Dispatcher Server servlet.
This WAR file communicates with the scheduler.

Note
The Web archive (WAR) file, file server servlet, and Dispatcher Server servlet are
required only if you use Web mode to perform translations.

• Dispatcher scheduler

• Dispatcher modules

• Dispatcher client

• Dispatcher admin client

TTS00002 12.0 Dispatcher Server Installation 2-5

 Chapter
Chapter 2: 2: Planning
Planning
Your Your Implementation
Implementation

• Translator wrappers, scripts, configuration, and support files

Software and hardware requirements

Software requirements

Teamcenter is supported on the following platforms:

• Microsoft Windows

• Linux

For information about versions of operating systems, third-party software, and Teamcenter software
that are certified for your platform, see the Siemens PLM Software Certification Database.

Hardware requirements

The following table describes the memory and virtual memory requirements for the Web server,
scheduler, translation module, and dispatcher admin client.

Note
Siemens PLM Software recommends that you install dispatcher 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.

Dispatcher Client
Web application Dispatcher admin client service
Requirements server/scheduler modules (optional) (optional)
Memory Application 4 GB 512 MB 1 GB
server: 1 GB minimum1 minimum minimum
minimum
Scheduler: 512 MB
minimum
Virtual Memory Application 600 MB 600 MB 600 MB
server: 1800 MB minimum minimum minimum
minimum
Scheduler: 600 MB
minimum

1. Dispatcher modules may require additional memory, depending on the source file size, translation type, or other processes running on
the machine.

2-6 Dispatcher Server Installation TTS00002 12.0

 Planning Your Implementation

Note
The Web application is certified to run on WebLogic and WebSphere.
An available HTTP or HTTPS connection is required if you install the Web server on
a remote network.

Other required software

The following components are supplied by the appropriate vendor:
• J2SE Runtime Environment (JRE) or J2SE Development Kit (JDK) for Solaris and Windows.

• Supported Web server: WebLogic or WebSphere.

Using worksheets

Using worksheets
Use the following worksheets during the planning stages to record the DNS host name, IP address,
and other properties for each designated server machine. Mark components you install and record
relevant data such as home directories of Web servers and used ports.
Print or copy the worksheets and use them to plan and track your implementation.
The information you record is especially useful when you modify the configuration and properties files
that control the communication between various servers and server machines.
A typical implementation includes multiple dispatcher modules, a single Web server, and a dispatcher
scheduler. Be sure to print out a copy of the appropriate worksheet for each planned machine.

Worksheet: Web server

Installed software
Supported Web server:
• WebLogic (Yes/No)
• WebSphere (Yes/No)
• DispatcherServer.war (Yes/No)

Web server properties

DNS host name:

IP address:
Operating system: Windows (Yes/No) UNIX (Yes/No)

TTS00002 12.0 Dispatcher Server Installation 2-7

 Chapter
Chapter 2: 2: Planning
Planning
Your Your Implementation
Implementation

Scheduler.URL: Default: Other:

rmi://localhost:2001

Scheduler.BindingName: Default: DispatcherScheduler

Other:
Translation.Dir: Default: d:/scratch/Projects/DispatcherServer
Other:

Checkin.Dir:
Checkout.Dir:
Reference.Dir:
Web server HOME:
resource directory:

Worksheet: Scheduler

Installed components

J2SE Runtime Environment (JRE) or J2SE Development Kit (JDK).

Dispatcher Server properties

DNS host name:

IP address:
Operating system: Windows (Yes/No) UNIX (Yes/No)

Port: Default: 2001 Other (Yes/No):

Scheduler HOME:

MailHost:
AdminEmail:
BindingName Default: DispatcherScheduler
Other:

2-8 Dispatcher Server Installation TTS00002 12.0

 Planning Your Implementation

Worksheet: Module

Installed components

J2SE Runtime Environment (JRE) or J2SE Development Kit (JDK).

Dispatcher Server module properties

DNS host name:

IP address:
Operating system: Windows (Yes/No) UNIX (Yes/No)

Port: Default: 1999 Other:

Module HOME:

MailHost:
AdminEmail:

Worksheet: Dispatcher Client

Installed components

J2SE Runtime Environment (JRE) or J2SE Development Kit (JDK).

Dispatcher Server properties

DNS host name:

IP address:

TCTS_HOME:

DB_Host:
DB_Port:
Staging.Dir:

Scheduler.BindingName: Default: DispatcherScheduler

Other:
Scheduler.ListenerPort:

TTS00002 12.0 Dispatcher Server Installation 2-9

Chapter 3: Dispatcher Server quick start

Setting up dispatcher components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Before setting up dispatcher components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Set up the scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Set up modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Set up the Web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Set up the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Implementing translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3

Implementing translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Edit the translator.xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3

TTS00002 12.0 Dispatcher Server Installation

Chapter 3: Dispatcher Server quick start

Setting up dispatcher components

Before setting up dispatcher components

This quick start is designed to help you install and configure dispatcher components and implement
translators in the shortest possible time. It assumes that you are familiar with the basic concepts of
the Dispatcher Server and provides a high-level overview of how to set up the scheduler, modules,
Web server, Translation Admin Client, and implement translators.

Note
The Dispatcher Server standard installation supports RMI mode. RMI mode is faster for
performing translations; however, it can be used only within a firewall.

Set up the scheduler

1. Locate the Dispatcher Server software distribution image for your platform on your local computer
or network.

2. Copy the Scheduler directory from the DispatcherServer directory to the Web server or a
different machine.

3. From a command prompt, change to the bin directory where the scheduler is installed and run
one of the following:
• Windows: runscheduler.bat

• UNIX: runscheduler.sh

Set up modules
1. Locate the Dispatcher Server software distribution image for your platform on your local computer
or network.

2. Copy the Module directory from the Dispatcher directory to the module machine.

3. Extract the translators.zip file for your platform to the Module directory. When you unzip this
file, it creates a Translators directory (within the Module directory) containing all the supported
translators.

4. Open the transmodule.properties file from the Module/conf directory on the module machine.

5. Edit the Staging.Dir property to specify one of the following:

TTS00002 12.0 Dispatcher Server Installation 3-1

 Chapter
Chapter 3: 3: Dispatcher
Dispatcher Server
Server quickquick
start start

• Web mode: Do not specify any value for this property. When this property is left empty, the
staging directory is set to the Module_Home/Trans directory by default.

• RMI mode: The location you specify must map to the location where the dispatcher client
places the source files. For example, if the source file location is:
D:/Client/staging/UserName/Guid/SourceFiles
Change mapping to:
D:/Client/staging/

6. If the scheduler is on a different machine, edit the Scheduler.URL property to specify the
machine name or IP address and port number of the scheduler machine.

Note
This port number must match the port number given in the transscheduler.properties
file in the Dispatcher\Scheduler\conf directory on the scheduler machine.

7. From a command prompt, change to the bin directory where the module is installed and run
one of the following:
• Windows: runmodule.bat

• UNIX: runmodule.sh

Set up the Web server

Note
Set up the Web server only if you use Web mode for translations.

1. Locate the Dispatcher Server software distribution image for your platform on your local computer
or network.

2. Copy the WebServer directory to the designated translation Web server machine.

3. Copy the Dispatcher\WebServer\DispatcherServer.config file to the HOME directory of your

Web server. Each Web server defines its HOME directory differently. To determine the HOME
directory, see the Web server documentation.

4. Deploy the Dispatcher\WebServer\DispatcherServer.war file on your Web server and start

the Web server.

Set up the Translation Admin Client

Note
Setting up the Translation Admin Client is optional.

3-2 Dispatcher Server Installation TTS00002 12.0

 Dispatcher Server quick start

1. Locate the Dispatcher Server software distribution image for your platform on your local computer
or network.

2. Copy the AdminClient directory from the Dispatcher directory to the Translation Admin Client
machine.

3. Change to the AdminClient\bin directory and run the appropriate script to start the Translation
Admin Client:
• Windows: runUI.bat

• UNIX: runUI.sh

4. Perform a test translation to verify that the Dispatcher Server is set up and configured properly.

Implementing translators

Implementing translators
• Manually edit the translator.xml file to activate translators. Alternatively, use the configuration
editor to quickly configure modules and translators, and install modules.

• Copy the Translators directory from the software distribution image to the Dispatcher\Module
directory on the module machine.

• Edit the startup file (.bat or .sh) of the translator to specify appropriate values for properties with
CHANGE_ME tags.

• Install, set up licenses, and configure all the required translators.

• Verify that you have installed the required software and, if needed, the default postprocessor
and related translator.

Edit the translator.xml file

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

2. Activate the translator, modifying the isactive attribute to set it to true.

Note
By default, the isactive attribute is set to false for all translators in the translator.xml
file.

Example:
<!-- Configuration of the Catia V4 to JT translator developed
by THEOREM -->
<Catiav4ToJt provider="UGS" service="catiav4tojt" isactive="false"
wrapperclass="&EAIWRAPPER">

TTS00002 12.0 Dispatcher Server Installation 3-3

 Chapter
Chapter 3: 3: Dispatcher
Dispatcher Server
Server quickquick
start start

Change to:

<!-- Configuration of the Catia V4 to JT translator developed

by THEOREM -->
<Catiav4ToJt provider="UGS" service="catiav4tojt" isactive="true"
wrapperclass="&EAIWRAPPER">

3. Verify that the TransExecutable dir, TransExecutable name, or SysExecutable name tag
is correctly specified.

4. Ensure that the appropriate postprocessor for the translator is configured and activated. If you do
not want to use a postprocessor, make sure to comment the Postprocess provider tag within
the service tags of the translator in the translator.xml file.
Example of a commented postprocessor:
<!-- Postprocess provider="UGS" service="previewservice"/ -->

5. For CAD translators, verify that the tessellation configuration file name and directory are correctly
specified.

3-4 Dispatcher Server Installation TTS00002 12.0

Part II: Installing and configuring components

Installing and configuring the scheduler in a stand-alone environment . . . . . . . . . . . . . . . . . . 4-1

Installing and configuring modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Installing and configuring the Web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Installing and configuring the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Installing and setting up the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Managing logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Installing Web Application Manager and creating Web applications . . . . . . . . . . . . . . . . . . . 10-1

TTS00002 12.0 Dispatcher Server Installation

Chapter 4: Installing and configuring the scheduler
in a stand-alone environment

Installing and configuring the scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Install and configure the scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Copy installation files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Set up the scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Start and stop the scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Start and stop the scheduler service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3

Implementing intelligent licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

Implementing intelligent licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Edit the TaskConfiguration.xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5

Storing translation tasks and events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5

TTS00002 12.0 Dispatcher Server Installation

Chapter 4: Installing and configuring the scheduler
in a stand-alone environment

Installing and configuring the scheduler

Install and configure the scheduler

Each translation module resides on a separate machine and is connected to the translation scheduler
for better load balancing. The scheduler sends translation tasks to the modules and the modules
start one or more translators to perform the translations. It also balances the translation load in the
event of multiple translation requests.

Install the translation scheduler on the designated scheduler machine. This may be on the same
machine as the Web server or any other machine.

Prerequisite

J2SE Runtime Environment (JRE) or J2SE Development Kit (JDK).

Make sure that you set the JAVA_HOME variable to the root directory where you have installed
JRE or JDK.

Copy installation files

1. Locate the Dispatcher software distribution image for your platform on your local computer
or network.

2. Copy the Scheduler directory from the Dispatcher directory to the translation Web server or to
a different machine.

Set up the scheduler

Note
All the properties described in this section are optional.

1. Open the transcheduler.properties file from the Scheduler/conf/ directory on the scheduler
machine.

2. Edit the Port property to specify an unused port number to look up the translation scheduler. The
default port value is 2001.

TTS00002 12.0 Dispatcher Server Installation 4-1

 Chapter
Chapter 4: 4: Installing
Installing and configuring
and configuring the scheduler
the scheduler in a stand-alone
in a stand-alone environment
environment

Note
This must be the same as the port number specified in the Scheduler.URL property
in the DispatcherServer.config file in the Dispatcher\WebServer directory and the
transmodule.properties file in the Dispatcher\Module\conf directory.

3. To specify mail options, edit the following properties:

• MailHost, to set the SMTP host for sending e-mail generated by the scheduler.

• AdminEmail, to specify the e-mail address of the administrator for notifications.

• CCEmail, to specify additional recipients' e-mail addresses for notifications.

Use a comma (,) to separate multiple e-mail addresses.

4. To specify the number of days for which the scheduler should store translation events, edit the
NumOfEventLogs property. By default, it is set to 3.
If set to 3, the scheduler deletes any events after the third day.

5. Edit the UseDatabase property to set true or false values. By default, it is set to true.
This property determines whether translation data is stored in-memory (false) or in a database
(true) for the scheduler. If you use in memory settings, translation data can possibly be lost if
the scheduler crashes.

Note
Open the database.xml file from the Scheduler\conf directory to see the supported
databases.

6. Edit the DbConfigFile property to specify the location of the database.xml file. By default, it is
set as follows:
DbConfigFile=../conf/database.xml

7. To specify the sleep time (in minutes) for the scheduler thread, edit the
SchedulerThreadSleepTime property. By default, it is set to 0.25.
If the module is busy and the scheduler cannot submit a job, the thread becomes inactive for the
specified time. The scheduler then submits the job after the specified sleep time.

8. (Optional) Edit the SaveSession property to set true or false values. By default, it is set to true.
When set to true, this option saves the session if the scheduler goes down. When you restart the
scheduler, it restores the tasks and events from the session file.

9. To specify a name for the client to look up the scheduler, edit the BindingName property. By
default, it is set to DispatcherScheduler.

4-2 Dispatcher Server Installation TTS00002 12.0

 Installing and configuring the scheduler in a stand-alone environment

Note
The name you specify here must match the Scheduler.BindingName property in the
WebServer\DispatcherServer.config file, if you use Web mode for translations.

10. To stop translation tasks submitted to the module, edit the StopTranslatingTasks property to
specify true or false values. By default, it is set to true.
When set to true, the scheduler can stop translation tasks if the client sends abort or stop
translation requests.

11. To specify the LogWriter internal logger implementation class, edit the LogSystemClassName
property. You can use the default value, which is set as follows:
LogSystemClassName=com.teamcenter.infrastructure.logmanager.
writer.internal.log4j.Log4jInternalLogger

12. Save the transcheduler properties file.

Start and stop the scheduler

To start the dispatcher server, you must start the scheduler first.
1. From a command prompt, change to the bin directory where the scheduler is installed.

2. To start the scheduler, run the following command:

• Windows: runscheduler.bat

• UNIX: runscheduler.sh

A new prompt window with the following message is displayed:

Scheduler is ready to accept tasks

The translation scheduler is installed correctly if the startup message appears.

Note
If the startup message fails to appear, check the log file for errors.

3. To stop the scheduler, run the following command:

• Windows: runscheduler.bat -stop

• UNIX: runscheduler.sh -stop

Start and stop the scheduler service

On Windows systems, you can optionally configure the scheduler as a Windows service.

TTS00002 12.0 Dispatcher Server Installation 4-3

 Chapter
Chapter 4: 4: Installing
Installing and configuring
and configuring the scheduler
the scheduler in a stand-alone
in a stand-alone environment
environment

Note
If you run the scheduler as a service, Siemens PLM Software recommends that you run
the module and dispatcher client also as Windows services.

To run the scheduler as a Windows service, invoke schedulerWinService.bat from the

Scheduler\bin directory.
1. Click the Start menu and choose the following options:
Settings→Control Panel→Administrative Tools→Services

2. Right-click Dispatcher Schedulerversion, and choose Properties.

Note
Perform this step only if you have installed the scheduler manually.

a. In the Log On pane, select the This account option.

b. Click Browse and select your user ID.

c. Enter passwords as appropriate and click OK.

3. Right-click Dispatcher Schedulerversion, and choose:

• Start to start the scheduler.

• Stop to stop the scheduler.

Implementing intelligent licensing

Implementing intelligent licensing

Translation processes running on a dispatcher module may be dependent on the availability of
licenses for the translator. When a process fails due to a license issue, the module sends back an
error to the scheduler; however, the module has no knowledge of why the process failed.
A new configuration file, TaskConfiguration.xml, is included in the scheduler to hold information
about a particular service and the maximum number of processes that can run at a given time. This
allows administrators to control the number of processes and manage license availability for the
specified processes across modules at a given time.
Tasks can be configured in the TaskConfiguration.xml file on the scheduler.
<Tasks>
<!-- Task Provider="SIEMENS" Service="tozipfile" MaxLimit="3"/-->
</Tasks>

Each process or task tag on the scheduler corresponds to a translator definition in the translator.xml
file on the module. You can manage the number of processes you want to run across modules at a

4-4 Dispatcher Server Installation TTS00002 12.0

 Installing and configuring the scheduler in a stand-alone environment

given time by specifying a limit using the MaxLimit property. This property defines the maximum
number of translations that you can run simultaneously.

Note
By default, no process is specified in the TaskConfiguration.xml file. This means that
there is no limit on the number of processes that you can run across modules.

Edit the TaskConfiguration.xml file

1. Open the TaskConfiguration.xml file from the Scheduler\conf directory.
Example:
<?xml version="1.0" encoding="UTF-8"?>
<!-- Configuration file to limit the total number of tasks
for a given -->
<!-- Provider and Service type that can be submitted across
all Modules. -->
<Tasks>
<!-- Task Provider="SIEMENS" Service="tozipfile" MaxLimit="3"/-->
</Tasks>

2. To define the maximum number of translations that you can run simultaneously, add a Task
Provider element as in the example that follows:
Example:
<Task Provider="XYZ" Service="XYZ" MaxLimit="3"/>

Note
The service attribute in the TaskConfiguration.xml file must match the service attribute
in the translator.xml file in the Module\conf directory.

Storing translation tasks and events

The scheduler uses a database to store translation tasks and events. If the scheduler fails due to
some reason, such as a power outage, all translation tasks are stored in the database and you
can restart them.
The scheduler is supported on the following databases:
• Derby (default database)

• MySQL

• Oracle

• HSSQL

For more information about configuring the database, see the Scheduler\conf\database.xml file.

TTS00002 12.0 Dispatcher Server Installation 4-5

Chapter 5: Installing and configuring modules

Installing modules . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Installing modules . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Prerequisite . . . . . . .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Copy installation files ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Setting up modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

Configure modules for RMI or Web mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Configure module properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Setting up an HTTPS connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6

Starting modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6

Start and stop the module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Run the module as a Windows service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7
Start and stop the module service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7

TTS00002 12.0 Dispatcher Server Installation

Chapter 5: Installing and configuring modules

Installing modules

Installing modules
For better load balancing, each translation module resides on a separate machine and is connected
to the translation scheduler. The scheduler sends translation tasks to the modules and the modules
start one or more translators to perform the translations.
The module machine should be a stand-alone machine dedicated for file translations.

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 multi-threaded requirements of translators for large models.

Prerequisite
J2SE Runtime Environment (JRE) or J2SE Development Kit (JDK).
Make sure that you set the JAVA_HOME variable to the root directory where you have installed
JRE or JDK.

Copy installation files

1. Locate the Dispatcher software distribution image for your platform on your local computer
or network.

2. Copy the Module directory from the Dispatcher directory to the module machine.

3. Extract the translators.zip file for your platform to the Module directory. When you unzip this
file, it creates a Translators directory (within the Module directory) containing all the supported
translators.

Caution
Disable screen savers on module machines. If the scheduler sends a translation request to
a module while the screen saver is running, the module may hang.
Some CAD systems have a file-path length limitation. Copy the Module directory to a
root-level directory to avoid this problem.

TTS00002 12.0 Dispatcher Server Installation 5-1

 Chapter
Chapter 5: 5: Installing
Installing and configuring
and configuring modules
modules

Setting up modules
Configure modules for RMI or Web mode
Edit the transmodule.properties file on the module machine to use RMI or Web mode.
1. Open the transmodule.properties file from the Module/conf directory on the module machine.

2. Edit the Staging.Dir property to specify one of the following:

• Web mode
If you use Web mode for performing translations, do not specify any value for this
property. When this property is left empty, the staging directory is automatically set to
Module_Home/Trans directory by default.

• RMI mode
The location you specify must map to the location where the Dispatcher Server client puts
the source files. For example, if the source file location is:
D:/Client/staging/UserName/Guid/SourceFiles
Change the mapping to:

D:/Client/staging/

3. Save the transmodule.properties file.

Configure module properties

Note
All of the properties described in this section are optional except the Scheduler.URL
property (step 2) if the scheduler is on a different machine and FileServer.URL property
(step 16), if you use Web mode.

1. Open the transmodule.properties file from the Dispatcher\Module\conf directory on the

module machine.

2. If the scheduler is on a different machine, edit the Scheduler.URL property to specify the
machine name or IP address and port number of the scheduler machine.

Note
This port number must match the port number given in the transscheduler.properties
file in the Dispatcher\Scheduler\conf directory on the scheduler machine.

Example:
Scheduler.URL=rmi://localhost:2001

If the scheduler is on a different machine, use the scheduler hostname instead of localhost.

5-2 Dispatcher Server Installation TTS00002 12.0

 Installing and configuring modules

3. Edit the LogVolumeLocation property to specify the log volume location.

Log volume location is the root directory in which all the log files are created.

4. Edit the Port property and specify the port number for the module to look up the scheduler. The
default port number is 1999. You can use any other valid port number, which is not in use.
Example:
Port=1999

5. Edit the MaximumTasks property to specify the maximum number of translation tasks. The
default value is 3.

6. Uncomment the SubmitFilters property to activate CPU usage.

This property is used to define the custom class to filter submission of tasks to the module. You
can write your own class that extends the AbstractSubmitFilter. The module provides default
behavior based on the MaximumTasks property (described in the previous step). If there are any
exceptions to these custom classes, the module reverts to using the MaximumTasks property.
By default, the module provides submissions based on CPU usage.
The default value is set as follows:
SubmitFilters=com.teamcenter.tstk.server.translation.
module.filters.CpuUsageSubmitFilter

7. Uncomment the SubmitFilters.CpuUsageThreshold property to define the threshold CPU

usage value. The module does not take any new processes beyond the threshold value.
The default value is 0.7 (as a fraction). This means that the CPU usage is at 70%.

Note
This property is used only if the SubmitFilters property is set as described in the
previous step.

8. Edit the MaximumProgress property to specify the number of attempts the module should make
to monitor the progress of the translation before stopping the process. The default value is 100.
If the translation process does not continue after the specified number of attempts, the module
stops the process.

Note
(Optional) You can also set the MaximumProgress property in the
Module\conf\translator.xml file.
<XYZ provider="SIEMENS" service="XYZ" isactive="true"
MaximumProgress="50">

If the MaximumProgress tag is not included in the Module\conf\translator.xml

file, then the default values are taken from the global definitions in the
Module\conf\transmodule.properties file.

TTS00002 12.0 Dispatcher Server Installation 5-3

 Chapter
Chapter 5: 5: Installing
Installing and configuring
and configuring modules
modules

9. Edit the MonitorInterval property to specify the time interval for checking the progress of the
translation task. The time is specified in minutes. The default value is 0.5.

10. Edit the MaximumDeleteTries property to specify the maximum number of delete attempts for
the module to delete the task directory. The default value is 3. Before deleting the task directory,
the module creates a log entry in the module log file.
The module locks all translation requests for specific files and does not release them until all
files are copied to the appropriate directory. Therefore, you must specify this property for the
module to make several attempts to delete the task directory.

Note
To preserve the task directory for troubleshooting, set this property to 0.

11. Edit the Scheduler.TriesBeforeEmail property to specify the number of attempts for the module
to connect to the scheduler before sending an e-mail message to the administrator. The default
value is 1.

12. Edit the ReportFileTransfer property to set true or false values. The default value is false.
When set to true, the dispatcher client gets all file transfer events; however, this can hamper
performance.

13. To specify mail options, edit the following properties:

• MailHost, to set the SMTP host for sending e-mail generated by the module.

• AdminEmail, to specify the e-mail address of the administrator for notifications.

• CCEmail, property to specify additional recipients e-mail addresses for notifications.

Use a comma (,) to separate multiple e-mail addresses.

14. Edit the Scheduler.BindingName property to specify the binding name used to look up the
scheduler. The default binding name is DispatcherScheduler. If you have more than one
scheduler at your site, the binding name should be unique.

Note
The name you specify here must match the BindingName given in the
transscheduler.properties file in the Dispatcher\Scheduler\conf directory on the
scheduler machine.

Example:

Scheduler.BindingName=DispatcherScheduler

15. Edit the Scheduler.MaximumTry property to specify the number of attempts to connect to the
scheduler before removing the scheduler connection from the list. The default value is 150. If the
scheduler connection is removed from the list, the administrator must restart the module.

5-4 Dispatcher Server Installation TTS00002 12.0

 Installing and configuring modules

The interval between each attempt is determined by the MonitorInterval property, described
in step 9.
Example:

Scheduler.MaximumTry=150

16. To specify the URL used by the module to connect to the file server, edit the FileServer.URL
property.

17. To specify the byte array size used for uploading files, edit the FileServer.ByteSize property. The
default value is 1048576.

18. To specify the maximum threads allowed to upload files at any given time, edit the
FileServer.MaximumUpload property.
The default value is 8. This means that if all the eight threads are uploading files, the thread that
comes after them has to wait till one of the threads has finished uploading files.

19. To configure the file server to authenticate cookies, edit the Cookie.Definition property to specify
the cookie name and value to be sent to the server. The default value is cookie.

Note
Use cookies only if your server supports cookie authentication.

20. Edit the Cookie.NameAndValue property to specify the name and value of the persistent cookie.
This is to authenticate whether the server supports cookie authentication. Separate the name
and value with the equal to (=) sign.

Note
The values you specify for Cookie.Definition and Cookie.NameAndValue properties
should match the values given in the AdminClient\conf\transclient.properties file.

21. To specify the file server implementation classes to use, edit the FileServer.Servlet,
FileServer.Local, and LogSystemClassName properties.
Default values:

Note
The default values can be used without any changes.

• FileServer.Servlet=com.teamcenter.tstk.server.fileserver.servlet.
FileServerImpl

• FileServer.Local=com.teamcenter.tstk.server.fileserver.local.
FileServerLocalImpl

TTS00002 12.0 Dispatcher Server Installation 5-5

 Chapter
Chapter 5: 5: Installing
Installing and configuring
and configuring modules
modules

• LogSystemClassName=com.teamcenter.infrastructure.logmanager.writer.
internal.log4j.Log4jInternalLogger

22. Save the transmodule.properties file.

Setting up an HTTPS connection

The Dispatcher Server standard installation supports HTTP connection between the translation
module and Web server. If you want to use HTTPS or Java secure sockets layer (SSL) connection,
first set up the Web server for SSL. For more information, see the respective Web server
documentation.
Prerequisites for SSL are as follows:
• Specify the key store location of your root certificates.
If you are acting as your own certificate authority, the Java components may fail to connect to the
Web server. If this happens, the Web server displays an error message saying that it cannot find
the trusted certificate. In such cases, edit the runmodule.bat file (Windows) or runmodule.sh
file (UNIX) to specify the necessary environment variables for the key store location of your
root certificates.

• Ensure that the translation module has the necessary certificates.

Both the translation module and Translation Admin Client need to communicate with the Web
server. If you run the Translation Admin Client at your site, ensure that the SDK that starts the
Translation Admin Client and translation module has the necessary certificates, self generated
or public.

1. Open the transmodule.properties file from the Module/conf directory.

2. Edit the FileServer.URL property to specify the machine name or IP address and port number of
the Web server:
Example:

FileServer.URL=https://MachineName:PortNumber/
DispatcherServer/FileServer

3. Save the transmodule properties file.

Starting modules

Start and stop the module

Be sure to implement, enable, and configure the translators and prerequisite software before running
the module in a production environment.
Ensure that the scheduler is running before you start the module. Starting the module before you
start the scheduler can result in connection delays and failed translations.
1. From a command prompt, change to the bin directory where the module is installed.

5-6 Dispatcher Server Installation TTS00002 12.0

 Installing and configuring modules

2. To start the module, run the following command:

• Windows: runmodule.bat

• UNIX: runmodule.sh

When you run the module, it displays the following message:

Module is ready for the tasks.

3. To stop the module, run the following command:

• Windows: runmodule.bat -stop

• UNIX: runmodule.sh -stop

Run the module as a Windows service

On Windows systems, you can optionally configure the module as a Windows service or run it from
a console.

Note
If you run the module as a service, Siemens PLM Software recommends that you run the
scheduler and dispatcher client also as Windows services.
For more information, see the respective chapters for the scheduler and dispatcher client
components.

To run the module as a Windows service, run the moduleWinService.bat file from the Module\bin
directory.

Note
Windows service does not support mapped drives. You should use a UNC path or path
which is local to the machine.
Teamcenter Integration for SolidWorks (SWIM) does not support UNC paths.

Start and stop the module service

Note
Start the scheduler service before you start the module service to avoid connection delays
and translation failures.

1. Click the Start menu and choose the following options:

Settings→Control Panel→Administrative Tools→Services

2. Right-click Dispatcher Moduleversion, and choose Properties.

TTS00002 12.0 Dispatcher Server Installation 5-7

 Chapter
Chapter 5: 5: Installing
Installing and configuring
and configuring modules
modules

Note
Perform this step only if you have installed the module manually.

a. In the Log On pane, select the This account option.

b. Click Browse and select your user ID.

c. Enter passwords as appropriate and click OK.

3. Right-click Dispatcher Moduleversion, and click:

• Start to start the module service.

• Stop to stop the module service.

5-8 Dispatcher Server Installation TTS00002 12.0

Chapter 6: Installing and configuring the Web server

Installing the Web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Using the Web server to perform translations across a firewall . . . . . . . . . . . . . . . . . . . . . 6-1
Copy installation files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Configuring the Web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Configure the Web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Edit the Dispatcher Server configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

TTS00002 12.0 Dispatcher Server Installation

Chapter 6: Installing and configuring the Web server

Installing the Web server

Using the Web server to perform translations across a firewall
You can use a Web server for performing translations across a firewall.
This topic assumes that you have already installed a Web server and it is up and running. For
complete information about installing and configuring a Web server, see the related documentation
for the specific Web server you plan to install.

Note
Skip this topic if you use RMI mode for performing translations.

Copy installation files

1. Locate the Dispatcher software distribution image for your platform on your local computer
or network.

2. Copy the WebServer directory from the Dispatcher directory to the Web server machine.

Configuring the Web server

Configure the Web server
1. Copy the DispatcherServer.config configuration file from the WebServer directory to the
Web server home directory. Each Web server defines its home directory differently. For more
information, see your Web server documentation.

Note
You must verify the home directory location of the Web server before proceeding
with the Dispatcher Server installation.

2. Deploy the DispatcherServer.war file from the WebServer directory on your Web server and
start the Web server. For more information, see your Web server documentation.

3. Open a Web browser and enter the following URL to verify the status of the Dispatcher Server:
http://host-name:port-number/DispatcherServer

Replace host-name with the name of your Web application server host.

TTS00002 12.0 Dispatcher Server Installation 6-1

 Chapter
Chapter 6: 6: Installing
Installing and configuring
and configuring the Web
the Web server
server

Replace port-number with the port number used by your Web application server.

If you have successfully deployed the WAR file, the Web browser displays the following message:

Note
This is only a sample message and the type of message you get depends on the
Web server you use.

Dispatcher Server Servlets started!!!

Expected location of DispatcherServer.config file is:
Web_Server_Install_Dir\DispatcherServer.config

Edit the Dispatcher Server configuration file

Note
All the properties described in this section are optional except the Scheduler.URL property
(step 2), if the scheduler is on a different machine.

1. Open the DispatcherServer.config file from the Dispatcher\WebServer directory.

2. If the scheduler is on a different machine, edit the Scheduler.URL property to specify the
machine name or IP address and port number of the scheduler. The Dispatcher Server uses
2001 as the default port number.
Example for Web mode:

Scheduler.URL=scheduler_hostname:2001

Note
This port number should be the same as the port number in the
transscheduler.properties file in the Dispatcher\Scheduler\conf directory.

3. Edit the Scheduler.BindingName property to specify a name to look up the scheduler. If you
have more than one scheduler at your site, specify a unique name.
Example:

Scheduler.BindingName=DispatcherScheduler

Note
This should be the same as the binding name in the transscheduler.properties file in
the Dispatcher\Scheduler\conf directory.

4. Edit file server environment, general, and file server lock properties as appropriate. For more
information, see the DispatcherServer.config file.

6-2 Dispatcher Server Installation TTS00002 12.0

Chapter 7: Installing and configuring the dispatcher client

Why use the dispatcher client? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

What is a dispatcher client? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Typical data flow through the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Installing the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2

Before installing the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Copy installation files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

Setting up the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

Configure RMI or Web mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Configure dispatcher client properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

Starting the dispatcher client . . . . . . . . . . . . . . . ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5

Start and stop dispatcher client . . . . . . . . . . . ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Run the dispatcher client as a Windows service .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Start and stop the dispatcher client service . . . ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6

Submitting translation requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7

Submit a translation request to the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7

TTS00002 12.0 Dispatcher Server Installation

Chapter 7: Installing and configuring the dispatcher client

Why use the dispatcher client?

What is a dispatcher client?

The dispatcher client receives translation task requests from clients and sends them to the Dispatcher
Server. When a task is complete, the dispatcher client maps output files to the task source files and
notifies the appropriate listeners. It maintains logs of each requested task, including submission
information, messages from the Dispatcher Server, task completion status, uploaded and downloaded
files, and source to output file mapping.
The client creates translation task files for each translation request. The translation task is an XML
representation of the data submitted to the dispatcher client. This information enables the Dispatcher
Server to perform the translation and map the resulting files to the source files. The default schema
for the translation task is provided in the Task.xsd file in the DispatcherClient\xml directory.
Automotive Supplier represents a typical client. The client’s main task is to place the desired
CAD files in a staging directory and send a task request to the dispatcher client. After successful
translation, the dispatcher client collects the generated visualization files and maps the translated
files to the input files.

Typical data flow through the dispatcher client

A typical data flow through the dispatcher client is as follows:
1. The client (A) triggers a translation request to the client service (B) based on some translation
criteria such as checkin or on-demand.

2. The request activates a trigger for:

• Queuing a request for output file generation.

• Gathering the required files (C) and placing them in a predefined directory.

• Creating a task definition file (D).

3. The dispatcher client submits the translation request to the Dispatcher Server (E). The request
contains all the necessary information to submit the request, including a hierarchical map of
CAD files.

4. The Dispatcher Server notifies:

• The dispatcher client if the translation request is successfully completed (F).

• The client service (B) if the request fails.

TTS00002 12.0 Dispatcher Server Installation 7-1

 Chapter
Chapter 7: 7: Installing
Installing and configuring
and configuring the dispatcher
the dispatcher clientclient

5. The dispatcher client maps translated files to CAD files and adds this mapping information
to the original task file (G).

6. The dispatcher client passes this information to the client for further processing.

The following figure shows the flow of data through the dispatcher client.

A 1

SYSTEMS

B 2

/visfiles

F C D G
JT CAD XML XML
CAD
= CAD JT
CAD CAD JT
4 JT CAD CAD CAD JT
JT CAD

4
SYSTEMS

Flow of data through client service

Installing the dispatcher client

Before installing the dispatcher client
Before you install the dispatcher client, you must install the CAD integrations and their associated
CAD translation environments for the CAD models you use. Teamcenter supports CAD integrations
for the following CAD software:
• NX

• I-deas

• Pro/ENGINEER

7-2 Dispatcher Server Installation TTS00002 12.0

 Installing and configuring the dispatcher client

• CATIA

Install server solutions for CAD integration and the translation environment according to the
documentation provided with each integration.

Copy installation files

1. Locate the Dispatcher Client software distribution image for your platform on your local computer
or network.

2. Copy the DispatcherClient directory to the designated dispatcher client machine.

Note
Siemens PLM Software recommends that you install the dispatcher client on a machine in
close proximity to the client machine for optimal performance.

Setting up the dispatcher client

Configure RMI or Web mode

1. Open the DispatcherClient.config file from the DispatcherClient\conf directory.

2. Edit the DispatcherServer.URL property to use RMI or Web mode. By default, it is set to RMI
mode.

Note
If you want to use Web mode, be sure to comment the RMI URL property and
uncomment the HTTP URL property.

Example of RMI mode:

DispatcherServer.URL=rmi://localhost:2001
#DispatcherServer.URL=http://localhost:8080/DispatcherServer/DispatcherServer

Example of Web mode:

#DispatcherServer.URL=rmi://localhost:2001
DispatcherServer.URL=http://localhost:8080/DispatcherServer/DispatcherServer

Configure dispatcher client properties

1. Open the DispatcherClient.config file from the DispatcherClient\conf directory.

2. If you use RMI mode, edit the Staging.Dir property to set it to the common staging directory.
(Leave this property blank for Web mode.)

TTS00002 12.0 Dispatcher Server Installation 7-3

 Chapter
Chapter 7: 7: Installing
Installing and configuring
and configuring the dispatcher
the dispatcher clientclient

Note
The common staging directory specified here should be the same as the directory
specified in the transmodule.properties file on the module machine.

3. (Optional) Edit the Port property to define the port number for the dispatcher client RMI registry.
The default value is 1099.
You can specify any other valid RMI port, which is not in use.

4. Edit the CHANGE_ME tags for database host (DB_Host), database port (DB_Port), and trusted
database user (User) as appropriate.

Note
Edit DB_Host, DB_Port and User properties only if you use Teamcenter Enterprise.

5. (Optional) Edit the BadChars property to replace bad characters from the translation task source
files with “_” to avoid translation errors.

6. (Optional) Edit the PreviewMapping property to define whether the generated preview images
should be mapped back to the PDM system. You can specify the value as 0 to disable preview
images or 1 to generate preview images. The default value is 1.

7. (Optional) Edit the NamingContext property to specify a naming context for the generated JT
files.
Naming context parameters are as follows:

• Option1: Partnumber_PartName.jt

• Option2: The top-level item is Partname.jt and subitems are

Partname_Partnumber_Ver_Rev_Project_library.jt.

8. (Optional) Edit the EventHandler property to specify the event handler class, which is the
implementation of the IEventHandler interface that handles the translation events coming from
the Dispatcher Server.
The default value is set as follows:

EventHandler=com.teamcenter.translationservice.test.TestEventHandlerImpl

9. (Optional) Edit the BomPreviewMapping property to define an appropriate mapper. Specify 1 for
BOM-based preview mapping or 0 for standard preview mapping. The default value is 0.

7-4 Dispatcher Server Installation TTS00002 12.0

 Installing and configuring the dispatcher client

Starting the dispatcher client

Start and stop dispatcher client
Before using the dispatcher client, test each component in the Dispatcher Server individually to
ensure that it is configured properly.
1. From a command prompt, change to the DispatcherClient\bin directory.

2. To start the dispatcher client, run the following command:

• Windows: runDispatcherClient.bat

• UNIX: runDispatcherClient.sh

If the dispatcher client starts successfully, it displays the following message:

Dispatcher Client started successfully!

3. To stop the dispatcher client, run the following command:

• Windows: runDispatcherClient.bat -stop

• UNIX: runDispatcherClient.sh -stop

Run the 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.
You must set a permanent system variable from My Computer or Control Panel > Advanced
system settings > Environment variables.
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.

TTS00002 12.0 Dispatcher Server Installation 7-5

 Chapter
Chapter 7: 7: Installing
Installing and configuring
and configuring the dispatcher
the dispatcher clientclient

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.

Start and stop the dispatcher client service

Note
Start the scheduler service before you start the dispatcher client to avoid connection delays
and translation failures.

1. Click the Start menu and choose the following options:

Settings→Control Panel→Administrative Tools→Services

2. Right-click DispatcherClientversion, and choose Properties.

Note
Perform this step only if you have installed the dispatcher client manually.

a. In the Log On pane, select the This account option.

b. Click Browse and select your user ID.

c. Enter passwords as appropriate and click OK.

3. Right-click DispatcherClientversion, and click:

• Start to start the dispatcher client.

• Stop to stop the dispatcher client.

7-6 Dispatcher Server Installation TTS00002 12.0

 Installing and configuring the dispatcher client

Submitting translation requests

Submit a translation request to the dispatcher client

Typically, tasks are submitted to the dispatcher client using a command string issued by the client.

Note
The procedures described in this section are specific to Teamcenter Enterprise.

1. From a command prompt, change to the DispatcherClient\bin directory.

2. Run the appropriate command for your platform:

Windows:
runDispatcherClient.bat -task full_path_
to_the_task_xml_file

UNIX:

runDispatcherClient.sh -task full_path_

to_the_task_xml_file

Note
To submit tasks, the Task.xml file should have all the required information as defined in
the Task.xsd file in the DispatcherClient\xml directory.

TTS00002 12.0 Dispatcher Server Installation 7-7

Chapter 8: Installing and setting up the Translation Admin Client

Installing the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Installing the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Copy installation files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Setting up the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Using the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2

Before starting the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Start the Translation Admin Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Managing translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Translate files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Manage translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Perform batch translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5

Add new translators and customize batch translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6

Add a new translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6
Customize batch translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7

TTS00002 12.0 Dispatcher Server Installation

Chapter 8: Installing and setting up the Translation Admin Client

Installing the Translation Admin Client

Installing the Translation Admin Client

The Translation Admin Client allows you to translate files, manage translations, and perform batch
translations. The Translation Admin Client:
• Uploads the CAD file to the file server or common staging directory.

• Creates a translation request and submits the request.

• Processes the translation event messages and modifies and/or deletes submitted tasks.

Note
The Translation Admin Client is a sample implementation of the Dispatcher Server. You
can install it optionally to verify the Dispatcher Server installation and setup.

Prerequisites
• J2SE Runtime Environment (JRE) or J2SE Development Kit (JDK).

• Make sure that you set the JAVA_HOME variable to the root directory where you have installed
JRE or SDK.

Copy installation files

1. Locate the Dispatcher software distribution image for your platform on your local computer
or network.

2. Copy the AdminClient directory from the Dispatcher directory to the machine you have
designated for Translation Admin Client.

Setting up the Translation Admin Client

The Translation Admin Client permits translation of files using Web mode or RMI mode. The
Dispatcher Server standard installation supports RMI mode.

TTS00002 12.0 Dispatcher Server Installation 8-1

 Chapter
Chapter 8: 8: Installing
Installing and setting
and setting upTranslation
up the the Translation
AdminAdmin
ClientClient

Note
The Translation Admin Client standard installation supports the common staging directory
option. The common staging directory avoids the need for file transfers from the client
and module locations.

1. Browse to the AdminClient\conf directory and open the transclient properties file.

2. Edit the Staging.Dir property to specify one of the following:

• Web mode: Do not specify any value for this property. When this property is left empty, the
staging directory is set to AdminClient/downloads directory by default.

• RMI mode: The location you specify must map to the location where the module places the
source files. For example, if the source file location is:
D:/Client/staging/UserName/Guid/SourceFiles,
change the mapping to:
D:/Client/staging/

Note
The Staging.Dir property you specify here must match the Staging.Dir property you
have specified in the transmodule properties file in Module\conf directory.

3. Save the transclient properties file.

Using the Translation Admin Client

Before starting the Translation Admin Client

• Start the scheduler.

• Start the requisite modules.

• Specify translation options as described in Installing and setting up the Translation Admin Client.

• Start the Web server/file server, if you use Web mode for translations.

Start the Translation Admin Client

1. Change to the AdminClient\bin directory and run the appropriate script to start the Translation
Admin Client:
• Windows: runUI.bat

• UNIX: runUI.sh

8-2 Dispatcher Server Installation TTS00002 12.0

 Installing and setting up the Translation Admin Client

The Translation Admin Client window opens.

2. Choose the appropriate server mode for your translations.

Select RMI if you use RMI mode or HTTP if you use Web mode for your translations.

3. In the Server URL box, specify the appropriate URL for the server mode you have selected.

4. In the Staging Directory box, enter the staging directory, if you use RMI mode for translations.
Alternatively, click Find to change to the staging directory.

Note
The staging directory you enter here must match the Staging.Dir property you have
specified in the transmodule properties file in the Dispatcher\Module\conf directory.

5. Click Login to start the Translation Admin Client.

Managing translations

Translate files
1. Click Translate to open the Translate pane.
This is the default pane that opens when you start the Translation Admin Client.

2. From the Provider and Service area, select the service provider, for example, UGS. Then
select the translator, for example, tozipfile.

Note
You can customize the Translation Admin Client translator mappings by editing the
AdminClientUI.xml file in the Dispatcher\AdminClient\ui\swing directory.

3. To choose the translation time or priority, select one of the following:

• Time option. Specify the translation start time in mm/dd/yyyy hh:mm format.

• Priority option. Select High, Medium, or Low as appropriate.

• Repeating option for repeated tasks. Select Start Time, End Time and specify the Interval
value (in seconds) as appropriate.

Note
For repeating tasks, the interval you specify should be more than the translation
time. Otherwise, translation state changes can become unpredictable.

4. In the Submits box, type the number of times you want to submit the files for translation. You can
submit the same task multiple times for performance testing.

TTS00002 12.0 Dispatcher Server Installation 8-3

 Chapter
Chapter 8: 8: Installing
Installing and setting
and setting upTranslation
up the the Translation
AdminAdmin
ClientClient

5. From the Context menu, select the context. Generally, the stand-alone translation context
is Translation.

6. In the Source box, specify your main source files.

In the case of an assembly, it can be the root assembly file possibly located on your network
drive. For example, D:\project\ssw_idi0001.idi.

7. In the Destination box, specify the destination file name for translation results.

8. In the Dependent Files box, specify dependent files. Alternatively, click Find to browse to the
location of the files.
For part translations, dependent files can be drawing files associated with the part and for
assembly translations, the dependent files can be subassemblies and parts related to the root
assembly.

9. In the Translator Options box, type a key name and its associated value.
The following table describes some examples of key and value pairs you can use.

Key Values
OUTPUT_TYPE CGM, TIF, HPG, PDF, or JPG
COMBINE_OUTPUT blank to create multiple output files.
-combine to create a single output file.

10. To submit files for translation, select one of the following:

• Submit, to submit the translation request.

• Add to Batch, to submit the translation as a batch request.

The Submitted, Finished, Errors, and Interrupted fields display the number of translations
submitted, translations finished, translations with errors, and translations interrupted for the current
session.

Manage translations
1. Click Admin to open the Admin pane.

2. In the Query & Admin pane, select the appropriate options for your query and then click Query.
The following table describes the query options that you can use in Translation Admin Client.

Option Description
ALL or UGS Allows you to query all tasks or tasks for a specific service
provider such as UGS.
ALL or translator name Allows you to query all tasks or tasks for a specific translator
such as tozipfile.
Task ID Allows you to query for tasks with specific task IDs.

8-4 Dispatcher Server Installation TTS00002 12.0

 Installing and setting up the Translation Admin Client

Option Description
User Name Allows you to query tasks based on user name.
Status Allows you to query tasks based on the task status. For
example, finished tasks.

3. In the Auto Query box, type the time in seconds for querying translation tasks automatically. If
you enter 5, the Translation Admin Client queries for new translation tasks every 5 seconds.
After you start an automatic query, click Stop Query to stop querying.

4. If other modules are connected to the Translation Admin Client, click Manage Modules to
view and manage them. The Manage Translation Modules window lists the machine names
(modules) and their status. Select a machine name and click Start if the module is not started
or Pause to pause the module. Pause stops the modules from taking more requests; however,
it does not stop existing requests.
Click Close to close the Manage Translation Modules window.

5. After you click a task in the Tasks pane, do one of the following:
• Stop, to stop the task.
You cannot stop tasks that have reached the final state, that is, finished translations,
translations with errors, and translations for which service is not available.

• Move To First, to move tasks to the top of the queue.

You cannot move tasks that have started.

• Change Priority, to change the priority of tasks. You can choose, High, Medium, or Low
as appropriate.
You cannot change the priority of tasks that have started.

• Change Time, to specify the translation start time in mm/dd/yyyy hh:mm format for tasks.
You cannot change time for tasks that have started.

Perform batch translations

Batch translations can be used for performing the same translation repeatedly for stress testing
network traffic, repeating translations for all files in a particular directory, or repeating translations for
parts only (not assemblies).

Note
You can also perform batch translations using the sample BatchInput.xml file from the
AdminClient\testxml directory. It uses the Dispatcher Server client APIs to perform
batch translations.

1. Click Batch to open the Batch Translations pane.

2. Click Import to import the batch file you want to translate.

TTS00002 12.0 Dispatcher Server Installation 8-5

 Chapter
Chapter 8: 8: Installing
Installing and setting
and setting upTranslation
up the the Translation
AdminAdmin
ClientClient

You can save translation batch files to an XML file and import it later for performing batch
translations.

3. Select an input file or row in the Batch Translations pane, and select one of the following options:
• Submit, to submit the batch for translation.

• Save, to save the batch file as an XML file. This file can be imported later for performing
batch translations.

Add new translators and customize batch translations

Add a new translator

1. Open the AdminClientUI.xml file from the AdminClient\ui\swing directory.

2. Add tag elements as appropriate:

• If this is a service provider that is not available in the AdminClientUI.xml file, add a
<Provider> element as follows:
<ProviderMap>
<Provider name="UGS" desc="UGSServices">
<Service string="tozipfile" ext=".zip">
<FileFilter id="Idi" string="idi" desc="Idi Files (*.idi)"/>
</Service>
<Service string="previewservice" ext=".jpg">
<FileFilter id="2DFiles" string="jt,cgm,dxf,dwg,igs,prt,dft,
doc,xls,ppt,hpgl,calcomp,txt,ps,pdf"
desc="Vis Files (*.jt, *.cgm, *.dxf, *.dwg, *.igs, *.prt, *.dft,
*.doc, *.xls, *.ppt, *.hpgl,
*.calcomp, *.txt, *.ps, *.pdf)"/>
</Service>
<Service string="iditojt" ext=".jt">
<FileFilter id="Idi" string="idi" desc="Idi Files (*.idi)"/>
</Service>
<Service string="ideastojt" ext=".jt">
<FileFilter id="Pkg" string="pkg" desc="Package Files (*.pkg)"/>
</Service>
<Service string="ideasmftranslator" ext=".jt">
<FileFilter id="Mf" string="mf1" desc="Model Files (*.mf1)"/>
</Service>
<Service string="steptojt" ext=".jt">
<FileFilter id="Step" string="stp" desc="STEP Files (*.stp)"/>
</Service>
<Service string="proetojt" ext=".jt">
<FileFilter id="ProE" string="prt" desc="ProE Files (*.prt)"/>
</Service>
<Service string="proetodxf" ext=".dxf">
<FileFilter id="ProE" string="prt" desc="ProE Files (*.prt)"/>
</Service>
<Service string="jttocatiav5" ext=".CATPart">
<FileFilter id="JT" string="jt" desc="Catia Files (*.jt)"/>
</Service>

8-6 Dispatcher Server Installation TTS00002 12.0

 Installing and setting up the Translation Admin Client

</Provider>
</ProviderMap>

• If Siemens PLM Software is the service provider for the new translator, add a <Service>
element within the existing Siemens PLM Software provider tags as follows:
<Service string="iditojt" ext=".jt">
<FileFilter id="Idi" string="idi" desc="Idi Files (*.idi)"/>
</Service>

3. Enter the values for the new translator.

The following table describes the translator values for the Translation Admin Client.

Property Description
Service string Translator name. For example, IdiToJt.
Service string ext File output extension.
FileFilter id Used for filtering input files.
FileFilter string Input file extension, excluding the period (.).
FileFilter desc Description of input files displayed in the browser.

4. Save the AdminClientUI.xml file.

Customize batch translations

1. Open the BatchInput.xml file from the AdminClient\testxml directory.

2. Edit the <RootDir value="../data"/> property to specify the directory for your main source files.

3. Add more translation tasks, if needed.

You can use the BatchInput.xml file to specify one or more translation tasks. Each task defines
the translator service (for example, ToDosOrUnix), priority, input directory, and file extension.

4. Edit other properties such as service provider, priority value, and input extensions. The sample
code that follows describes these properties.
In the following example, ssw_idi0001.idi file in the data subdirectory of the AdminClient
installation will be translated to the .zip format.

TTS00002 12.0 Dispatcher Server Installation 8-7

 Chapter
Chapter 8: 8: Installing
Installing and setting
and setting upTranslation
up the the Translation
AdminAdmin
ClientClient

<?xml version="1.0"?>
<!--
This software and related documentation are proprietary to UGS Corp.
COPYRIGHT 2007 UGS CORP. ALL RIGHTS RESERVED
-->
<TranslationTasks>
<!-- RootDir is the common directory for all the Input files in
this xml file.-->
<!-- This can be absolute path or relative path from
AdminClient/bin Directory.-->
<RootDir value="../data"/>
<!-- To add more tasks to the batch, copy and insert more TranslationTask
elements -->
<TranslationTask Submits="1" Provider="UGS" Service="tozipfile"
context="Translation"> <Priority value="2"/>
<!-- For time based tasks uncomment Time tag. Time format is
"MM/dd/yyyy HH:mm" -->
<!--Time value="01/25/2007 17:33"/-->
<Options>
<Option key="Test_Key" value="Test_Value"/>
</Options>
<!-- If RootDir is specified input file path is value of "RootDir + Input". >
< If RootDir is not specified input file path is value of "Input" and >
< has to be absolute path. >
< This applies to the both Input and Dependant element attribute. -->
<Input value="ssw_idi0001.idi"/>
<!-- Dependant values take * wildcard -->
<!-- Dependant value="*.dep"/ -->
</TranslationTask>
</TranslationTasks>

8-8 Dispatcher Server Installation TTS00002 12.0

Chapter 9: Managing logs

Configuring logs in Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Configuring logs in Dispatcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Set debug levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Configure logs in a stand-alone Dispatcher Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2

Configure common log for translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2

TTS00002 12.0 Dispatcher Server Installation

Chapter 9: Managing logs

Configuring logs in Dispatcher

Configuring logs in Dispatcher

When you install Dispatcher using the TEM installer, you can specify a single root location as the
central repository for all log files. Logs are written in the following format for all the Dispatcher Server
components, such as scheduler, module, dispatcher client, and Translation Admin Client:
• log-volume-location\category\process

• log-volume-location\category\task

log-volume-location is the central repository of log files. In the TEM installer, you can specify the log
volume location in the Dispatcher Services Log Directory box.
category is Dispatcher Server for Dispatcher Server components.
process is the directory for all process logs. Process logs are the main log files for components,
such as the scheduler and module.
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.

Set debug levels

You can set debug levels for process and task logs in the log4j.xml file.
1. Open the log4j.xml file from the Dispatcher\component-name\conf directory.

2. Search for the Process and Task logger name tags.

Example:

<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>

3. Set the level value to a supported level.

In the example, the INFO level designates informational messages that highlight the progress of
the application. For more information about other supported levels, see the log4j.xml file.

TTS00002 12.0 Dispatcher Server Installation 9-1

 Chapter
Chapter 9: 9: Managing
Managing
logs logs

Configure logs in a stand-alone Dispatcher Server

In a stand-alone Dispatcher Server, the Dispatcher Server creates the process and task logs for
components in the Dispatcher\component-name\logs\Dispatcher directory.

Note
All the properties described in this section are optional.

1. Open the respective properties file for the component from the Dispatcher\component-name\conf
directory.

2. Edit the LogManager.Debug property to set it to true or false values. By default, it is set to false.
If set to true, debug messages are written on the console.

3. Edit the MaxTries property to set it to an appropriate value. By default, it is set to 0 for the
stand-alone Dispatcher Server.
If the MaxTries property is set to 5, the Dispatcher Server component tries to write XML files to
the metadata\process and metadata\task directories every 0.5 seconds for five times if the XML
files are locked by another metadata writer thread.

Configure common log for translations

The module logs translator-specific messages to the task log file. In addition, you can optionally
capture translator output and error streams into a separate translator log file. This log file is available
in the result directory along with the other output files.
1. Open the translator.xml file from the Module\conf directory.

2. Add a logfile attribute for the translator as described in the example.

Example:

<NxToPv provider="UGS" service="nxtopv"

isactive="false" logfile="xyz.log">

Note
To stop logging, set logfile="none".

9-2 Dispatcher Server Installation TTS00002 12.0

Chapter 10: Installing Web Application Manager and
creating Web applications

Installing the Web Application Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

Using the Web Application Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
Copy installation files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

TTS00002 12.0 Dispatcher Server Installation

Chapter 10: Installing Web Application Manager and
creating Web applications

Installing the Web Application Manager

Using the Web Application Manager

You can either use a ready-to-deploy WAR file provided with the software distribution image or
create a custom WAR file for your site by installing and using the Web Application Manager. You
can specify context parameters such as directory for caching files, debug options, and URL of the
scheduler by creating a custom WAR file.

Note
Before you install the Web Application Manager, install a Siemens PLM Software-supported
Web application server on your Web application server host.

Copy installation files

1. Create a root directory on the Web application server host for the Web Application Manager
(insweb) and the Dispatcher Server solutions you install (for example, c:\dispatcher_web).
This directory is referenced as WEB_ROOT.

2. Locate the Teamcenter software distribution image for your platform on your local computer
or network.

3. Browse to the Teamcenter software distribution image and double-click the

INSTALL_TCWEB.EXE program icon. 7-Zip displays a self-extractor dialog box.

4. In the Unzip To Folder field, type the path to WEB_ROOT, and then click Unzip.
After 7-Zip extracts the installation files, click Close to close the 7-Zip self-extractor dialog box.

TTS00002 12.0 Dispatcher Server Installation 10-1

Part III: Appendixes

Implementing new translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Deployment considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

TTS00002 12.0 Dispatcher Server Installation

Appendix A: Implementing new translators

Implementing new translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Adding the translator wrapper class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Why use a translator wrapper class? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Adding a translator element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3
What is a translator element? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3
Specifying the translator container element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3
Specifying the executable definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-5
Specifying command line argument definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-5
Specifying source path definition element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-6
Defining file extension elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-6
Defining preprocessor and postprocessor translator elements . . . . . . . . . . . . . . . . . . A-6

Adding the translator JAR file to the classpath and path . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7

Sample translator startup scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7

TTS00002 12.0 Dispatcher Server Installation

Appendix A: Implementing new translators

Implementing new translators

Translators are Java wrappers that enclose the translator API. Translator properties are specified in
the translator.xml file. If the translation process requires a CAD system, the translator launches the
CAD system before starting the translation process.
This Java wrapper provides:
• Threading

• Process control (start, stop)

• Status checking (progress)

• Error handling

• Completion status and/or messaging (such as completed, failed, or stopped)

Note
Complete API documentation is available in the Dispatcher Server software distribution
image from the dispatcher\Documentation\javadocs directory. Open the index.html
file to view this documentation.

Adding the translator wrapper class

Why use a translator wrapper class?
The transmodule.jar file is required for all translator wrappers. This file is available from the
Dispatcher/Module/lib/ directory.
Third-party Java archive files may also be required, depending on the source and output file types.
For example, Direct Model (.jt) output requires VisWeb.jar and eaisupport.jar and I-deas requires
certain Orbix and OpenIdeas .jar files.
Write translator wrappers use the following APIs:
• Interface Translator

• Interface TranslationModule

• Interface TranslatorRunnable

The Dispatcher Server includes a default wrapper class that can perform most translations and, often,
all you need to do is configure the translator.xml file to set up the translator.

TTS00002 12.0 Dispatcher Server Installation A-1

 Appendix
Appendix A: A: Implementing
Implementing new translators
new translators

Sample executable translator with command line interface

For the AToB translator, command-line options are as follows:
AtoB.exe -i InputFile_path -o OutputFile_path -config Config_file_path

Add the following elements to the translator.xml file:

<AToB provider="UGS" service="atob" maxlimit="1"
isactive="true" debug="&DEBUG;" wrapperclass="&EAIWRAPPER;">
<TransExecutable dir="C:/progra~1/Siemens PLM Software/AToB"
name="AToB.exe">
<Options>
<Option name="inputpath"
string="-i"
description="Path to input file.">
<Option name="outputpath"
string="-o"
description="Path to output file.">
<Option name="configfile"
string="-config"
value="&MODULEBASE;/bin/atob.config"
description="Path to config file">
</Options>
<SrcPathLimit value="75">
<FileExtensions>
<InputExtensions nitem="2">
<InputExtension extension=".a1">
<InputExtension extension=".a2">
</InputExtensions>
<OutputExtensions nitem="1">
<OutputExtension extension=".b">
</OutputExtensions>
</FileExtensions>
<Preprocess provider="Siemens PLM Software"
service="ztoa">
<Postprocess provider="Siemens PLM Software"
service="btoc">
</AToB>

A-2 Dispatcher Server Installation TTS00002 12.0

 Implementing new translators

Sample Java-specific translators

The following example shows a translator.xml element definition for a Java-specific translator:
<AToB provider="Siemens PLM Software" service="atob" maxlimit="1"
isactive="true" debug="&DEBUG;">
<SysExecutable name="java">
<Options>
<Option name="classpath"
string="-cp"
system="java.class.path">
<Option name="classname"
string=""
value="com.ugs.translators.atob ">
<Option name="inputpath"
string="-i"
description="Path to input file.">
<Option name="outputpath"
string="-o"
description="Path to output file.">
<Option name="configfile"
string="-config"
value="&MODULEBASE;/bin/atob.config"
description="Path to config file">
</Options>
...
</AToB>

In this case, the system attribute represents the classpath passed to the Java Virtual Machine (JVM)
module. Ensure that the translator Java archive files are added to the module classpath.

Adding a translator element

What is a translator element?

The element definition of the translator specifies options, file extensions, and any preprocessor or
postprocessor translators. The format of the definition depends on the command string used by the
translator in the batch mode.

Note
The translator.xml file in the Module/conf directory includes examples of translator tags
defined for CAD to JT translators. This is a good source of examples for new translator
tags.

Specifying the translator container element

The container element for this translator is <AToB>. The following table describes the container
element attributes.

TTS00002 12.0 Dispatcher Server Installation A-3

 Appendix
Appendix A: A: Implementing
Implementing new translators
new translators

Attribute Description
provider Ensures that there is no name conflict if there is more than one translator
with the same name. The client uses this provider name to submit a
translation request.
service Identifier for this particular translator. The client uses the service name to
submit a translation request.
maxlimit The maximum number of simultaneous instances of a translation of a
given type (for example, UgToJt) that a module can perform.
If a translator can handle only one translation at a given time, the value
must be set to 1. Any value greater than 1 can cause translation failures.
If there is a limitation based on number of licenses available, set the
maxlimit property for the number of licenses.
isactive Specifies whether a translator is active or not.
NoOfTries Specifies the number of tries.
By default it is set to 1.
OutputNeeded Specifies whether output is needed.
By default it is set to true.
MaximumProgress (Optional) This property is used to specify the number of attempts the
module should make to monitor the progress of the translation before
stopping the process. The default value is 100. If the translation process
does not continue after the specified number of attempts, the module
stops the process.
You can add this property in the Module\conf\translator.xml file.

Note
If this property is not specified in the
Module\conf\translator.xml file, default values
are taken from the global definitions in the
Module\conf\transmodule.properties file.

WaitTimeBetTrans (Optional) Translators take time to release their libraries or subprocesses

at times. In such cases, if a translation is started immediately, it might fail.
This property defines the wait time between translations.
By default it is set to 0.
You can add this property in the Module\conf\translator.xml file.

A-4 Dispatcher Server Installation TTS00002 12.0

 Implementing new translators

Attribute Description
WaitTimeForReTries (Optional) Modules have the capability to retry translations if they fail.
This property is used to specify the wait time before retrying the translator.
It is useful in cases where the translator fails due to resource and/or
license issues.
By default it is set to 0.
You can add this property in the Module\conf\translator.xml file.
ExclExitVal (Optional) Some third-party translators give a non-zero exit value even if
the translations are successful. This property is used to exclude the use
of an exit value to evaluate the status of a translation.
By default it is set to 0.
You can add this property in the Module\conf\translator.xml file.
logfile (Optional) This property is used to capture translator output and error
streams in a separate translator log file. This log file is available in the
result directory along with the other output files.
You can add this property in the Module\conf\translator.xml file.

Note
If the logfile tag is not specified, a log file with
Provider_ServiceName.log name is created. If set to
logfile=none, no log file is created.

wrapperclass Specifies the default wrapper that the translator uses.

Specifying the executable definition

The <TransExecutable> element specifies an executable. This may be any executable file called
from the command line (for example, .exe, .bat, or .sh).
• The dir element specifies the full path to the executable file.

• The name element is the file name of the executable.

Specifying command line argument definitions

The <Options> element defines the arguments for the executable. If the arguments to the translator
are order dependent, ensure that the options are specified in the dependent order.
• The name attribute recognizes the following keywords:

TTS00002 12.0 Dispatcher Server Installation A-5

 Appendix
Appendix A: A: Implementing
Implementing new translators
new translators

o inputpath: Full path to the input file name

o outputpath: Full path to the output file name

o inputfile: Input file name

o inputdir: Path to the directory were the input file is located

o outputfile: Output file name

o outputdir: Path to the directory were the output file should be located

These keywords do not take any value; the Dispatcher Server defines the value. Any other
value passed is only a description name. If you do not use a predefined keyword, you must
assign the name a value.

• The string attribute is a prefix string required for any of the option arguments.

• Use the value option if the name attribute is not one of the predefined keywords. In this example,
the executable requires a configuration file. value defines the full path to the configuration file.
This can be any value the translator understands.

Specifying source path definition element

This is an optional element.
If there is a <SrcPathLimit> source path length limitation, value represents the maximum length
allowed. In this case, the Dispatcher Server attempts to reduce the source input file length by copying
input files to root folders.

Defining file extension elements

The FileExtensions element can contain input file extensions and output file extensions. It is an
optional element. The following table describes the file extension elements.

Element name Description

<InputExtensions> Update the nitem attribute with the number of valid extensions.
<InputExtension extension=" This is an optional element.
">
Allows you to specify valid, multiple input file extensions. The
Dispatcher Server validates all input files using this before
submitting it for translation.
<OutputExtensions> Update the nitem attribute with the number of valid extensions.
<OutputExtension extension=" This is an optional element.
">
Allows you to specify valid, multiple output file extensions. The
Dispatcher Server validates all output files using this before
submitting it for translation.

Defining preprocessor and postprocessor translator elements

The following table describes the preprocessor and postprocessor translator elements.

A-6 Dispatcher Server Installation TTS00002 12.0

 Implementing new translators

Element name Description

<Preprocess> Specifies a preprocessor translator. Specify the service and provider
names. In the previous example, the Siemens PLM Software provider's
ZtoA service runs before the AtoB service starts. The output of the
ZtoA translator becomes the input to the AtoB translator.
<PostProcess> Specifies a postprocessor translator. In the example above, the
Siemens PLM Software provider's BtoC service runs after the AtoB
service completes. The output of the AtoB translator becomes the
input to BtoC translator.

Adding the translator JAR file to the classpath and path

For any special wrapper class you write, you must add the JAR file to the module's JVM classpath. To
add this to the path, modify the appropriate script:
• Windows: Module/Translators/appendcpath.bat
• UNIX: Module/Translators/appendcpath.sh

The module invokes this script during startup.

Note
Copy the Translators directory to Dispatcher\Module directory when you install the
presupplied translators provided with your client solution.

Add PATH and CPATH statements as follows:

• Windows only: Modify the PATH statement to include the path to any .dll files required by the
translator.

• Windows and UNIX: Add a CPATH statement that includes the path to all .jar files required
by the translator.

The following examples show how to modify the appendcpath script to add the AToB translator
to the JVM classpath. In this case, the AToB translator has a single Java archive file and does
not require any DLLs.
• Windows: set CPATH=%CPATH%;%HOME%\Translators\atob\atob.jar

• UNIX: set CPATH=%CPATH%;%HOME%\Translators\atob\atob.jar

Sample translator startup scripts

General rules for sample translator startup scripts for Windows and UNIX are as follows:
1. Set the required classpath to execute the translator executable.

2. Execute the translator with the proper parameters.

TTS00002 12.0 Dispatcher Server Installation A-7

 Appendix
Appendix A: A: Implementing
Implementing new translators
new translators

3. Save the translator process status in local variable.

4. Reset the old classpath.

5. Exit the batch process with saved translator status.

Note
For UNIX, the process status command depends on the UNIX shell.
While ksh uses $?, csh uses $status.

Sample JtToJpeg Windows script

The following example shows the Windows batch file format for the JtToJpeg translator:
echo off
set MODULE_INSTALL_HOME=CHANGE_ME
if "%MODULE_INSTALL_HOME%" == "CHANGE_ME" (
echo set MODULE_INSTALL_HOME environment variable
goto :end
)
set ORG_PATH=%PATH%
set PATH=%MODULE_INSTALL_HOME%/Translators/jt2jpeg;%PATH%
%MODULE_INSTALL_HOME%/Translators/jt2jpeg/jt2jpeg.exe %*
set EXITVALUE=%ERRORLEVEL%
rem # Unset variables
end
set PATH=%ORG_PATH%
echo on
EXIT %EXITVALUE%

A-8 Dispatcher Server Installation TTS00002 12.0

 Implementing new translators

Sample JtToJpeg UNIX script

The following example shows the UNIX shell script format for the JtToJpeg translator:
#!/bin/ksh
export LD_LIBRARY_PATH_ORG=$LD_LIBRARY_PATH
export SHLIB_PATH_ORG=$SHLIB_PATH
if [ -z "$TS_HOME" ] then
# Print a user error
echo "Set TS_HOME variable"
return
fi
if [[ 'uname' = SunOS ]] then
export LD_LIBRARY_PATH=$TS_HOME/Translators?/jt2jpeg
elif [[ 'uname' = HP-UX ]] then
export SHLIB_PATH=$TS_HOME/Translators?/jt2jpeg
fi
export DISPLAY=:0.0
$TS_HOME/Translators?/jt2jpeg/jt2jpeg $*
exitvalue=$?
if [[ 'uname' = SunOS ]] then
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH_ORG
elif [[ 'uname' = HP-UX ]] then
export SHLIB_PATH=$SHLIB_PATH_ORG
fi
exit $exitvalue

TTS00002 12.0 Dispatcher Server Installation A-9

Appendix B: Deployment considerations

Deployment considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

Selecting hardware for Dispatcher Server components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

Criteria for choosing hardware for Dispatcher Server components . . . . . . . . . . . . . . . . . . . . . B-2

Dispatcher Server deployment strategies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3

Planning deployment of dispatcher components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3
All local (same host) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3
Distribution on the same domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3
Multiple access on the same domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-8
Distribution on multiple domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-10

TTS00002 12.0 Dispatcher Server Installation

Appendix B: Deployment considerations

Deployment considerations
Before deploying the Dispatcher Server, you need to plan your deployment strategy which includes:
• Identifying translation load.

• Selecting the hardware to handle the load.

• Selecting a deployment strategy.

Selecting hardware for Dispatcher Server components

Selecting hardware for the module/translators

The module is where all the intense computational process of translations occur. The module should
be sized sufficiently to handle the expected translation throughput.
The module hardware requirement is governed by the translator hardware requirements, number
of translators installed, and the number of maximum potential translation tasks (number of users
simultaneously submitting tasks).
An enterprise class server machine is highly recommended for the module, as these machines have
the ability to scale the number of CPUs and memory much more than a normal workstation.

Selecting hardware for the scheduler

The scheduler provides the communication from Teamcenter clients and manages the queue and job
distribution to the modules.
The scheduler is only a pipeline mechanism to manage the translation requests used by modules.
The scheduler requires minimum machine resource to run; however, it does hold an object in memory
for each translation request that it is managing.

Selecting hardware for the dispatcher client

The dispatcher client gets the translation task from Teamcenter to Dispatcher Server. Only one
dispatcher client is required per Teamcenter server installation.
The dispatcher client for Teamcenter manages the data extraction and data loading into Teamcenter.
While the data extracting and loading are not computationally intensive, it does require a machine
with communication pipeline to the server as well as enough disk space and memory needed for
the operations. Although not required, the recommended approach is to have the dispatcher client
running on the same machine as the Teamcenter server.

TTS00002 12.0 Dispatcher Server Installation B-1

 Appendix
Appendix B: B: Deployment
Deployment considerations
considerations

Criteria for choosing hardware for Dispatcher Server components

Prior to determining the type of machines to use for translations, determine Dispatcher Server system
usage to setup the correct environment to support the expected throughput.

Number of users

The number of users submitting translation tasks needs to be accounted for when trying to get
the maximum amount of throughput.
If a site has 100 users that can potentially submit 100 simultaneous translation tasks, and the
expected throughput is 1 hour, there must be enough computational capacity to handle the load. This
can be accomplished by providing enough CPU and memory to handle the 100 tasks. Increasing
load capacity can also be handled by adding additional modules to handle the additional throughput.
As throughput requires increase or decrease, modules can be started or stopped dynamically to
handle the load requirements.

Size and complexity of the translation models

Knowing the average size of the models that will be using the system will give an idea as to the
minimal requirements required to support the normal day-to-day operational needs. Consider size of
the models to be submitted for translation estimates when planning for the number of translations
that can be executing simultaneously.

Note
If a machine has 10 GB memory available, and the average size of the model requires 4
GB of memory to translate, the maximum number of translators that should be configured
to run at a given time should be two.

Model complexity influences translation times. Models with many curves are more geometrically
complex to translate than models with many straight edges.

Computational ability of the translation machine

The components required to get the data from Teamcenter to the translators are mainly pipeline
mechanisms for moving data and communication and require proper network bandwidth for the
expected data load which is unique to each site. The machine performing the actual translation task
must have enough CPU, memory, and disk space capacity to load and translate the models.

Disk space requirements

Understanding the disk space requirements needed ensures that the translations will not run out of
disk space during a translation. To get the required disk space requirements, multiply the average
sized model with the number of possible simultaneous translations.
Average model size x number of translations = Average disk space needed at any given time
You also need to account for the generated data, logs, CAD system files while calculating the disk
space needed.

B-2 Dispatcher Server Installation TTS00002 12.0

 Deployment considerations

Dispatcher Server deployment strategies

Planning deployment of dispatcher components

Many deployment strategies for Dispatcher Server components can be defined to meet specific
needs. The main goal of defining a deployment layout is to have the Dispatcher Server components
run on machines that have the resource capacity (CPU, memory, disk space, and network bandwidth)
to handle the expected throughput of the site.
You can install Dispatcher Server components on the same machine. While this minimizes the
administrative overhead, it reduces the scalability. A deployment across multiple machines allows
distribution of the needed computing resources and provides scalability. However, distributing the
services across machines increases administrative overhead.
The Dispatcher Server components can be configured to support various domain requirements. You
can select from various deployment layouts based on your requirements.

All local (same host)

All Dispatcher Server components run on the same host. This deployment is typically used if the
translation load on your site is less or if you have a high-end machine with large amount of CPU,
memory resources, and sufficient disk space capable of handling the expected translation throughput.

All Dispatcher Server components on the same host

Distribution on the same domain

All Dispatcher Server components can run on distributed machines within the same domain. The
machines can be of a heterogeneous platform configuration.

TTS00002 12.0 Dispatcher Server Installation B-3

 Appendix
Appendix B: B: Deployment
Deployment considerations
considerations

With this kind of deployment, you can distribute the computing power of multiple machines within
the same domain to handle translation tasks.

Fully distributed on the same domain

Each Dispatcher Server component distributed on separate machines within the same domain.

Dispatcher Server components distributed on separate hosts in the same domain

Partially distributed on the same domain

Teamcenter server and dispatcher client on the same machine, scheduler and modules on other
machines

B-4 Dispatcher Server Installation TTS00002 12.0

 Deployment considerations

Teamcenter server and dispatcher client on the same machine, scheduler and modules on
other machines
Teamcenter Server, dispatcher client, scheduler on the same machine, modules on other machines

TTS00002 12.0 Dispatcher Server Installation B-5

 Appendix
Appendix B: B: Deployment
Deployment considerations
considerations

Teamcenter server, dispatcher client, scheduler on the same machine, modules on other
machines
Teamcenter Server and dispatcher client on the same machine, scheduler and one module on the
same machines, another module on a different machine

B-6 Dispatcher Server Installation TTS00002 12.0

 Deployment considerations

Teamcenter server and dispatcher client on the same machine, scheduler and one module on
the same machines, another module on a different machine
Teamcenter Server, dispatcher client, scheduler on the same machine, modules on machines
of different platforms.

TTS00002 12.0 Dispatcher Server Installation B-7

 Appendix
Appendix B: B: Deployment
Deployment considerations
considerations

Teamcenter server, dispatcher client, scheduler on the same machine, modules on machines
of different platforms.

Multiple access on the same domain

Multiple Teamcenter servers can access and use the same Dispatcher Server components.

B-8 Dispatcher Server Installation TTS00002 12.0

 Deployment considerations

Multiple servers access same Dispatcher Server 1

Multiple servers access same Dispatcher Server 2

TTS00002 12.0 Dispatcher Server Installation B-9

 Appendix
Appendix B: B: Deployment
Deployment considerations
considerations

Distribution on multiple domains

You can distribute Dispatcher Server components across domains. The Web server servlet can
be used to allow communication and file movements across domains. The trade-off of providing
Dispatcher Server across domains is the loss in performance required for communication and file
movement. The performance of this configuration depends on the size of data being translated and
bandwidth of the network. The machines can be of a heterogeneous platform configuration.
Single Teamcenter server accessing Dispatcher Server components on a different domain

Single Teamcenter server accessing Dispatcher Server components on a different Domain

Multiple Teamcenter server accessing Dispatcher Server components on a different domain

B-10 Dispatcher Server Installation TTS00002 12.0

 Deployment considerations

Multiple Teamcenter server accessing Dispatcher Server components on a different domain

TTS00002 12.0 Dispatcher Server Installation B-11

Appendix C: Troubleshooting

Unable to run Dispatcher components as a Windows service due to a missing DLL file . . . . . . . C-1

Troubleshoot the Dispatcher Server by running the Translation Admin Client . . . . . . . . . . . . . . C-1

Troubleshoot the Dispatcher Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2

Troubleshoot the scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2

Troubleshoot translators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2

Troubleshoot the dispatcher client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3

Dispatcher client fails to start due to FSC exception error . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3

Dispatcher client fails to start while using JBoss . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-4

TTS00002 12.0 Dispatcher Server Installation

Appendix C: Troubleshooting

Unable to run Dispatcher components as a Windows service due to

a 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 (on Windows 64-bit systems).

• Add the Teamcenter-install-kit\install\install\jre\bin directory to the system path variable.

Troubleshoot the Dispatcher Server by running the Translation

Admin Client
You can run the Translation Admin Client to troubleshoot problems with the Dispatcher Server,
service, and translators. To run the Translation Admin Client:
1. Start the scheduler.
To start the scheduler, change to the Dispatcher\Scheduler\bin directory and invoke one of the
following:

• Windows: runscheduler.bat

• UNIX: runscheduler.sh

2. Start the modules.

To start the module, change to the Dispatcher\Module\bin directory and invoke one of the
following:

• Windows: runmodule.bat

• UNIX: runmodule.sh

3. Start the dispatcher client.

To start the dispatcher client, change to the Dispatcher\DispatcherClient\bin directory and
invoke one of the following:

Note
Ensure that the Web server is started if you use Web mode.

TTS00002 12.0 Dispatcher Server Installation C-1

 Appendix
Appendix C: C: Troubleshooting
Troubleshooting

• Windows: runDispatcherClient.bat

• UNIX: runDispatcherClient.sh

4. Check log files for the scheduler and modules. If there are any warnings, take correction action
as appropriate.

5. Try a test translation using the tozipfile translator.

You have set up the Dispatcher Server correctly if your test translation is successful.

Troubleshoot the Dispatcher Server

1. Run the Translation Admin Client and start the tozipfile translator as described in Troubleshoot
the Dispatcher Server by running the Translation Admin Client.

2. Check the log files for errors. If there are errors, take corrective action as appropriate.
If there are no errors and if the tozipfile translator successfully completes the translation, the
Dispatcher Server is working properly.

Troubleshoot the scheduler

The scheduler does not initialize due to an incorrect port number and displays the following message:
Problem: Exception in DispatcherSchedulerImpl.main() java.
lang.reflect.InvocationTargetException
Failed to initialize the Scheduler. Inspect the log file at location: /
<somedir path>/logs/default

To correct this problem, modify the port number for the scheduler in the transscheduler.properties
file in the Dispatcher\Scheduler\conf directory.

Note
There is no log file for this error.

Troubleshoot translators
If there is a problem with a translator, you can see a message in the module window or an error in
the log file.
Example:
Skipping translator translator-name
because of exception.

1. Ensure that the Dispatcher Server is working without errors.

C-2 Dispatcher Server Installation TTS00002 12.0

 Troubleshooting

2. Run the translator manually against a CAD file. If it works manually, then the problem is not with
the translator itself, but with the translator setup. If it fails, the translator may not be properly
licensed.
Do not perform translations from within Teamcenter until you can manually perform the translation.

3. To test the translator setup, run the Translation Admin Client to test the translators in question as
described in Troubleshoot the Dispatcher Server by running the Translation Admin Client. If all
configured translators work, the problem is not with the translator setup.

Note
If the translation for any configured translator fails, the problem is with the translator
setup.

4. Examine the translator.xml and other setup files for the failed translator.

Troubleshoot the dispatcher client

1. View the dispatcher client log file. If a warning appears in the log file, then the problem is with
the dispatcher client.

2. Ensure that the connection to the Teamcenter host is still running. Often, dispatcher client fails
because it is unable to upload and download translation files to the Teamcenter host.

3. Ensure that the DispatcherClient.config file is set up properly.

Dispatcher client fails to start due to FSC exception error

When there are multiple instances of Teamcenter hosted on a single server, it is not possible to rely
on the FMS_HOME variable being set as an environment variable. When it does not exist in the
environment variables, the dispatcher client fails to start and displays the following error message:
2010-04-14 15:09:04,097 ERROR - Exception.
java.lang.Exception: java.lang.NoClassDefFoundError: com/
teamcenter/fms/servercache/FSCException
at com.teamcenter.ets.extract.Extractor.<init>
(Extractor.java:270)

To correct this problem:

1. Open the DispatcherClient\bin\runDispatcherClient.bat file.

2. Add the FMS_HOME variable to the correct path.

TTS00002 12.0 Dispatcher Server Installation C-3

 Appendix
Appendix C: C: Troubleshooting
Troubleshooting

Dispatcher client fails to start while using JBoss

You must define dependencies in JBoss modules for the newer versions of JBoss. Since
the Dispatcher makes RMI calls to the scheduler, you must add a dependency for the
com.sun.jndi.rmi.registry.RegistryContextFactory property. To add this dependency:
1. Open the jboss-as-7.1.1.Final\modules\sun\jdk\main\module.xml file.

2. Add the path name as follows:

<dependencies>
<system export="true">
<paths>
<path name="com/sun/jndi/rmi/registry"/>

3. Open the jboss-as-7.1.1.Final\modules\org\jboss\as\naming\main\module.xml file.

4. Add the module name as follows:

<dependencies>
<module name="javax.api"/>
<module name="sun.jdk"/>

5. Start JBoss and run the Dispatcher.

C-4 Dispatcher Server Installation TTS00002 12.0

Siemens Industry Software

Headquarters
Europe
Granite Park One
Stephenson House
5800 Granite Parkway
Sir William Siemens Square
Suite 600
Frimley, Camberley
Plano, TX 75024
Surrey, GU16 8QD
USA
+44 (0) 1276 413200
+1 972 987 3000

Asia-Pacific
Americas
Suites 4301-4302, 43/F
Granite Park One
AIA Kowloon Tower, Landmark East
5800 Granite Parkway
100 How Ming Street
Suite 600
Kwun Tong, Kowloon
Plano, TX 75024
Hong Kong
USA
+852 2230 3308
+1 314 264 8499

About Siemens PLM Software

© 2018 Siemens Product Lifecycle Management

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