How to: Generate the Converter Configuration File

  • Article

The converter configuration file is an XML file that provides settings for the ClearQuest converter. The settings are specified in sections of the XML file as follows:

<ClearQuest>

The ClearQuest section contains information about the ClearQuest database that you want to migrate.

  • ConnectionName   ClearQuest connection name.

  • UserDatabase   ClearQuest database name.

  • QueryName   Name of a query saved in ClearQuest.

  • UserID   ClearQuest user ID. The specified user ID must have the Super User permission for the ClearQuest database.

<VSTS>

The VSTS section contains information about the Team Foundation work item tracking server and team project to which you are migrating.

  • URI   Team Foundation Server friendly name or complete URI in the form of https://MyServer:MyPort.

    If you use friendly names, make sure that you have added the Team Foundation Server through Team Explorer before running the converter.

  • ProjectName   Team Foundation work item tracking team project name.

Other Configuration Settings

The other sections in the XML file let you control:

  • ExitOnError   This section accepts a value of True or False. Select True to exit on errors. A value of True means that if errors are experienced in the migration of some work items, the ClearQuest converter stops.

    Note

    This setting only applies to non-fatal errors. For fatal errors, such as the ClearQuest converter being unable to connect to ClearQuest, the converter will always exit even if the setting is False.

  • OutputDirectory   Specify the directory where you want the migrated files to go. If you do not specify an output directory, the converter creates a directory with a Base Entity name for generating output files. If the directory already exists, the converter overwrites the files in that directory.

Required Permissions

To perform this procedure, you must have the Active User and Public Folder Administrator permissions for the ClearQuest database. For more information, see the ClearQuest Administrator's Guide.

To create the configuration file

  1. Collect the following information:

    • ClearQuest connection name.

    • ClearQuest database name.

    • ClearQuest Administrator user ID and password. Make sure that this user has permissions to submit issues in ClearQuest.

    • Team Foundation server name.

    • Team Foundation work item tracking team project name (the team project to which you want to migrate the work items).

  2. Create a query in ClearQuest to select the work items that you want to migrate to Team Foundation work item tracking and save the query. Save the query by any name, for example TransitionQuery.

  3. Select a directory to store the files that are produced during the analysis phase.

  4. Copy the following XML configuration file into a text editor:

    <?xml version="1.0" encoding="utf-8"?>
<WorkItemConverter>
  <Source id="ClearQuest">
    <ClearQuest>
      <ConnectionName>CQRep</ConnectionName> 
      <UserDatabase>TEST</UserDatabase> 
      <QueryName>Public Queries/All Defects</QueryName> 
      <UserID>admin</UserID>
    </ClearQuest>
  </Source>
  <VSTS>
    <URI>JoseLugo</URI>
    <ProjectName>JoseLugoProjectX</ProjectName> 
  </VSTS>
  <ExitOnError>true</ExitOnError>
  <OutputDirectory>DefectSchema</OutputDirectory>
</WorkItemConverter>

  5. Change the file to specify your settings with information gathered in previous steps. For example, under <QueryName>, specify the query name as TransitionQuery that includes the query path. See "The Configuration File" section earlier in this topic for information about what each section should contain.

    Note

    The password is not entered in the file, the ClearQuest converter tool asks for it later in the migration process.

  6. Save the file, for example, as CqConverterConfig.xml.

Note

Save the file by using UTF-8 encoding. For example, if you save the file by using Notepad, select UTF-8 in the Encoding box on the Save As dialog box

See Also

Other Resources

Work Item Type Definition Schema