Migrating process templates using the Process Template Migration Application

This article describes how to use the Process Template Migration Application to migrate process templates exported from Rational Team Concert 1.0 or 1.0.1.1 so that they can be imported into a Rational Team Concert 2.0 server. Throughout this article we use RTC 1.0 to refer to both the 1.0 and the 1.0.1.1 release of RTC. Please note that this article does not describe migration of the entire database. Please see the Migrating Jazz repository after upgrading Jazz Team Server help topic for guidance on migrating databases.

What is Process Template Migration?

Process Template Migration refers to the process of converting existing process templates exported from RTC 1.0 to a format that can be imported to a RTC 2.0 system. It is important to note that this migration process does not insert additional content to add newer features supported in RTC 2.0. Rather, the migration tool simply updates the existing content of the 1.0 template so that it is compatible with a RTC 2.0 server. Process Template Migration is necessary:

  • to import a process template that is in the RTC 1.0 format onto a running RTC 2.0 server without having to redo the steps to create and customize the process template on the new server
  • to import existing 1.0 process templates on an RTC 2.0 system for testing without undergoing a full Repository migration.

The Process Template Migration Application

The process template migration application is a standalone application that can be run to migrate a zipped process template from the 1.0 format to the 2.0 format. The tool is currently available as an “Incubator” on the Rational Team Concert download page. The tool is run from the command line with arguments to convert zipped process templates.

The tool accepts the following command line arguments:

Parameter Name Required Description
fromFile Yes The full path name and file name for the process template zip file from which to create a migrated process template.
toFile Yes Name of the zip file to which the migrated process template will be saved. If the specified name is that of a folder, then the tool will save the migrated process template zip file in the specified folder with the default name, migrated_process_template.zip.
overwrite No If the target file specified in the argument toFile already exists, then this argument must be set to true in order to overwrite the existing file, otherwise the migration will fail (the default value is false).

The following steps describe how to run the tool to convert process templates:

  1. Download the process template migration application archive file and extract its contents to a local folder.
  2. If you do not already have a zipped process template ready for migration, export the process template that needs to be converted as a zip archive file. See Exporting and importing process templates for guidance on exporting process templates as zip files.

    Note: It is important that the process template zip file that will be submitted for migration have the same archive file structure as when exported using the template export functionality available through an RTC client. Thus, the exported process template archive should contain a top level folder with all the necessary files and folders that define a process. These files and folders might include the files attachments.txt, name.txt, processId.txt, specification.txt, state.txt, summary.txt, version.txt as well as an attachments folder.

  3. Run the application from the command line (via the migrateTemplate.bat file for Windows or migrateTemplate.sh file for Linux) with the appropriate command line arguments. The application may take a few minutes to complete migration for a large process template.

Example:

  migrateTemplate fromFile=exported_process_templates/myTemplate.zip toFile=migrated_process_template.zip   

Errors and Warning Messages

Log information and error messages are displayed on the console as well as appended to the migration.log file (located in the top level folder of the downloaded Process Template Migration Application).

If errors or warnings are generated during migration or if errors are experienced while importing the migrated template to a 2.0 server, please ensure that the original 1.0 process template archive can be imported without errors to a RTC 1.0 server. Since the migration tool does not specifically validate the entire template before migration, a successful migration may still fail to be imported correctly into an RTC server if the original 1.0 template contained errors.


For more information


Feedback
Was this information helpful? Yes No 1 person rated this as helpful.