Creating user exit customizations (CMM 1921)

Creating User Exit Customizations Introduction CMM provides the user with the ability to insert custom code into certain places within the execution of the migration. This code is written by the user to perform tasks specific for that user’s data and processes. The interface methods (API’s) are written in Java. The APIs are defined in Java code provided with this documentation. To use these APIs you must modify and build the code as described below. Caveats Adding user customizations require a strong knowledge of Java programming within a Teamcenter environment. Most customers will only want to attempt this with the support of Siemens PLM Services. Thorough testing of any customizations is required to make sure it does not negatively impact the migration process. Intended Use Cases The provided User Exit Customization Points are primarily intended for customers to do additional validation and data gathering specific to their processes. For instance customization points prior to migration of a top level item or an individual item could be used to validate customer specific work flows or perform data preparation activities. Customization points after migration of an item or all items complete can be used to tag the data according to a customer specific work flow or in more advanced use cases perform processing on the resultant data. It can also be used to gather result and statistic data that is not otherwise available in CMM. User Exit Customization Points At a high level, CMM processes data as shown in the diagram below. The locations of user customization points are shaded. Example code is provided. More details on parameters and other development information are provided in the example code.

Validate All Selected Data UserExit_ValidatedT opLevel Get Top Level Item Get Child item UserExit_PostMigrat ion Migrate Item UserExit_PreMigrati on Get Next Child Item Get Next Top Level Item Cleanup and Terminate UserExit_FinalizeTo pLevel Found Fail Fail Not Found Fail Fail Migration Process excluding CATIA V4 Found Not Found

Because CATIA V4 migrations can create product structure from globbed model files, CATIA V4 is slightly different. It is shown below.

It is important that you fully understand the location of these customization points before trying to customize your migration. The example code shipped with CMM can be used to write the parameter values for each call to the CMM log file. This will allow you to study and better understand the location and capabilities of each customization point. Fail Validate All Selected Data UserExit_ValidatedT opLevel Get CATIA V4 Glob UserExit_CV4_PreD eglob Migrate Glob and Children UserExit_CV4_PostD eglob Deglob UserExit_CV4_PostG lobMigration Get Next Glob Cleanup and Terminate UserExit_FinalizeTo pLevel Found Not Found Fail Fail Fail CATIA V4 Migration Process

Building Customization Point Code CMM customization points are created using Java code. The customization points are in the files MigrationPostProcess.java and MigrationPreProcess.java. To modify and use the files, you must create a new .jar file from these files. The .jar file must be named CMMExtender.jar. Once you have created your .jar file you must copy it to the following locations. Make sure you backup the existing CMMExtender.jar file before you copy over it.  \jars  TC_INSTALL_DIR\portal\plugins\com.teamcenter.rac.addcmmbatch_8.0.0  TC_INSTALL_DIR\portal\plugins\com.teamcenter.rac.cmm_8.0.0