Extract and load customization

If you want to translate a single dataset and attach a single result dataset back using preferences, see Basic TaskPrep and DatabaseOperation Class section in this topic. However, if you have special cases to handle, see Extract data, Load data, and Compile source files and configure the translator sections in this topic. Note Adapt the procedures for Linux as required. Determine the following input requirements of the translator: Data to be translated. Datasets containing the data to be translated. Named references are required to perform the translation. Decide the output of the translator. Determine the Teamcenter data model under which the result files are stored. Utilize the Teamcenter standard data model and supported extensions. Be sure the data model is supported by any downstream tools that are to consume translation results from the Teamcenter database. For more information about packages and classes, see Dispatcher_Root\DispatcherClient\docs\dc\javadoc\index.html Extract data Design the logic of the new TaskPrep class prepareTask method to satisfy translator input, and other Dispatcher requirements. Design the necessary helper classes. Sample TaskPrep classes and property files are provided in the Dispatcher_Root/DispatcherClient/sample/integration/translator directory. Extend the dispatcher client DefaultTaskPrep abstract class in a new TaskPrep class in a package specific to the translator. For example: your path.translator.provider name.translator name Compile source files and configure the translator. Load data Determine the DatabaseOperation method implementations that are necessary to load the translator results in the Teamcenter database. This includes the load method at a minimum. Design the logic of the required DatabaseOperation methods and any necessary helper classes. Sample DatabaseOperation classes and property files are provided in the DISP_ROOT/DispatcherClient/sample/integration/translator directory. Implement the new DatabaseOperation class in the same package with the TaskPrep class. Compile source files and configure the translator. Compile source files and configure the translator Implement the associated helper classes. Compile the Java source files. Copy javac -classpath Classpath created by the runDispatcherClient.bat/sh file myFile.java Typically, you would add all the JARs in the DispatcherClient\lib directory to the classpath. Create the TSTranslator nameService.properties file to incorporate the new translator integration classes. The provider and service attribute values specified by the module translator configuration in the translator.xml file must be used in constructing the property names (keys). Edit the Service.properties file to import the new TSTranslator nameService.properties file. Archive the new Java classes and the TSTranslator nameService.properties file. These new classes along with other customized dispatcher client classes are most simply combined into a single application or custom JAR file. Make sure the TSTranslator nameService.properties file is in the root directory. Copy jar cf jar file name.jar myFile.classmyFile2.class TSTranslator nameService.properties If the JAR file contains only translator integration classes, copy the new JAR file to the DISP_ROOT/DispatcherClient/lib directory. To see all preferences, refer the Dispatcher_Root\DispatcherClient\install\ets_env.xml file and update them based on your requirements. The preference description contains the details. ETS_trans_rqst_referenced_dataset_types is one of the preferences. If this file is modified, import it using the preferences_manager utility. Example Modify the ETS_trans_rqst_referenced_dataset_types site preference to add the application or customized dataset type name of the datasets that may be specified as a primary objects in the dispatcher request for this translator. Addition of a dataset type to this preference allows cancellation of a dispatcher request and subsequent deletion of the primary objects while the translation is in process. Start the dispatcher client. Trigger a dispatcher request and verify that the new TaskPrep class run by the dispatcher client processes the dispatcher request correctly. Examine the contents of the Dispatcher Server file server task directory (or task staging location if configured for shared staging location). Verify that the XML task file is present and that its contents are correct. Verify that all the expected translator input files are present. Verify that the translation task is successfully submitted to the Dispatcher Server scheduler. When translation completes, verify the contents of the Dispatcher Server task directory (or task staging location) to see that all expected result files are present. Verify that the new DatabaseOperation class runs by the dispatcher client processes the dispatcher request and correctly loads the result files. Confirm that the location and ownership of the stored results is correct. Basic TaskPrep and DatabaseOperation Class Determine the preferences required by the new DatabaseOperation class and add them to the TaskPrep class. Also look at the common tozipfile translator preferences to support MSWord and MSWordX datasets. For examples, refer the Dispatcher_Root\DispatcherClient\install\basic_env.xml file. Implement the new translator site preference XML file and use the preferences_manager executable to import the file. preferences_manager -u=user_name -p=password -g=dba -mode=import -scope=SITE -action=override -context=Teamcenter -file=your_XML_file For more information about how to create a basic example of extract and load in Dispatcher Client, see Readme in the Dispatcher_Root\DispatcherClient\sample\integration\translators\ppttopdf directory.