Dispatcher: Local Kit Inventory

Where the Dispatcher SDK and documentation actually live on this workstation. Recorded because finding them the first time took longer than reading them.

The SDK ships with the ITK toolkit

D:\tk\wntx64\additional_applications\dispatcher\
    Dispatcher.zip              21.8 MB   Scheduler + Module + DispatcherClient + AdminClient + javadocs
    DispatcherClient_wnt.zip     4.9 MB   Full DispatcherClient incl. sample/ and install/
    DispatcherTranslators.zip    0.6 MB   All OOTB translator scripts, per platform

Dispatcher.zip contains four inner archives: Dispatcher-WIN.zip, Dispatcher-UNIX.zip (AIX / HPUX / Solaris variants), Dispatcher-FOSS.zip.

The two DispatcherClient copies are not the same. The one inside Dispatcher.zip has bin/ conf/ docs/ lib/ xml/ only. DispatcherClient_wnt.zip additionally has install/ (the preference bundles) and sample/ (the ppttopdf and proetojt worked examples). The samples that matter are only in DispatcherClient_wnt.zip.

DispatcherTranslators.zip contains per-platform archives; unzip DispatcherTranslators-WIN.zip into the Module install location so it lands as Module/Translators/.

What each archive contains

Dispatcher.zip → Dispatcher-WIN.zip

Dispatcher/
  readme.txt
  Scheduler/     bin/{runscheduler,schedulerWinService,setschedulerenv}.bat, scheduler.policy
                 conf/{transscheduler.properties, database.xml, TaskConfiguration.xml, log4j2.xml}
  Module/        module.config, deploymodule.bat
                 bin/{runmodule,moduleWinService,setmoduleenv}.bat, module.policy
                 conf/{translator.xml (93 KB), transmodule.properties, log4j2.xml}
                 samples/ProEToDxf.java          ← the wrapperclass example
  DispatcherClient/
                 bin/{runDispatcherClient,runDispatcherClientWinService,
                      setDispatcherClientEnv,encryptPass,tscpappend}.bat
                 conf/{DispatcherClient.config, PostProcessor.xml, log4j2.xml}
                 xml/Task.xsd                    ← the wire-format schema
                 docs/javadocs/                  ← com.teamcenter.translationservice.*
  AdminClient/   bin/{runUI,runBatch,runSampleClient}.bat, client.policy
                 conf/transclient.properties
                 samples/{SampleClient,SubmitTransTaskRunnable,TranslationServerUtil}.java
                 testxml/BatchInput.xml
                 ui/swing/AdminClientUI.xml
                 data/ssw_idi0001.idi            ← the smoke-test input file
  Documentation/javadocs/                        ← com.teamcenter.tstk.*

DispatcherClient_wnt.zip — the one with the samples

DispatcherClient/
  conf/Service.properties                        ← 20.6 KB, the Prepare/Load bindings
  install/  basic_env.xml (10.7 KB)  ets_env.xml (9.3 KB)  fms_env.xml
            nx_env.xml  catia_env.xml  catiav4_env.xml  proe_env.xml
            simpgen_env.xml  mmvindexgen_preference.xml
  sample/integration/
    filters/TranslatorFilter.java                (4 KB)
    translators/DefaultTaskPrep.java             (17 KB)
    translators/DefaultDatabaseOperation.java    (9 KB)
    translators/ppttopdf/{Readme.txt, CreateRequestInRAC.xml, ExtractAndLoad.xml}
    translators/proetojt/{TaskPrep.java, DatabaseOperation.java, proetojt.properties}
  sample/utilities/dispatcher_create_rqst_itk_main.cxx   (86 KB, ITK submission)
  docs/dc/javadoc/                               ← com.teamcenter.ets.*

Javadoc packages

Two distinct APIs, do not confuse them:

Kit	Root package	Covers
Dispatcher/Documentation/javadocs	com.teamcenter.tstk.*	Scheduler, Module, translators, file server. Module-side
Dispatcher/DispatcherClient/docs/javadocs	com.teamcenter.translationservice.*	Task model, post-processors. Client-side
DispatcherClient/docs/dc/javadoc	com.teamcenter.ets.*	extract, load, request, soa, translator, util. Client-side customization

com.teamcenter.tstk.translator is where AbstractTranslator, DefaultTranslator, Translator, TranslatorTask, Option, TranslatorMap and TranslatorException live.

com.teamcenter.ets.extract and com.teamcenter.ets.load are where DefaultTaskPrep and DefaultDatabaseOperation live.

Documentation

D:\Siemens\Help Server\collections\documentation\external\PL20241125556497283\
    en-US\tc_help\Dispatcher  Deployment and Administration.pdf

1.49 MB, 135 pages, Software Version 2506, dated 2025-05-26. Note the two spaces in the filename. Chapter map:

Ch	Title	Pages
1	Introduction to Dispatcher	1-1 to 1-4
2	Dispatcher deployment considerations	2-1 to 2-14
3	Install and configure Dispatcher components	3-1 to 3-22
4	Configure the Dispatcher server	4-1
5	Configure the Dispatcher client for default translators	5-1 to 5-6
6	Enable default translators	6-1 to 6-39
7	Add custom translators to Dispatcher	7-1 to 7-20
8	Monitor and administer translation requests	8-1 to 8-4
9	Customize the rich client for Dispatcher	9-1 to 9-6
10	Troubleshooting	10-1 to 10-9

Chapter 7 is the one to read. Chapter 6 is a per-translator enablement cookbook worth consulting for whichever OOTB service is closest to what you are building.

Supporting screenshots live alongside in tc_help\common\ (dispatcher_*.png, configure_dispatcher_server.png, DispatcherRequest.png). Preference definitions are in the Admin Data Report at ...\PL20250129156809455\en-US\AdminDataReport\Preferences\.

Not installed here

There is no deployed Dispatcher on this workstation: no Dispatcher directory under C:\Program Files\Siemens\Teamcenter2506 or D:\Teamcenter2506, and no Scheduler or Module process. Everything above is the kit, not a running system.

On the Saber 2.0 cloud tier, DISPATCHER_CLIENT_INSTALLED reads true (verified 2026-08-03 via Administration-2012-09-PreferenceManagement/getPreferences, protectionScope User, origination Overlay). Two related preferences do not exist there: TransientVolume_RootDir and DispatcherRequest_default_provider. TC_tms_use_dispatcher_for_async_operation is false.

That preference makes the Translate menu available. It is not evidence that a Scheduler or Module exists or is reachable. Confirming that is an open item.