TFS Integration Tools – Why is ReflectedWorkItemId not working? (Bug 690647)

We have just raised a bug against the latest build of the TFS Integration Tools, as the feature documented in What is the EnableInsertReflectedWorkItemId that I noticed in logfiles all about is not working as defined. Please  keep an eye on this space, as well as the Codeplex and Visual Studio Gallery sites for a resolution.

Problem

When defining a custom value for the ReflectedWorkItemId and enabling the feature, the ReflectedQWorkItemId is not reflected in the migrated work items and no warning or error is raised in the log files.

Example
<CustomSetting SettingKey="EnableInsertReflectedWorkItemId" SettingValue="true" />
<CustomSetting SettingKey="ReflectedWorkItemIdFieldReferenceName" SettingValue="Custom.Sync.MyReflectedName" />

Workaround

  • Do not define a custom ReflectedWorkItemId in the session configuration.
  • Define the following field in the target work item type definitions, whereby refname must be defined as highlighted and the name can be any custom value.
    • <FIELD refname="TfsMigrationTool.ReflectedWorkItemId" name="Your Custom Name" type="String">

Bug ID

ID

Title

State

Fixed in

690647

ReflectedWorkItemId does not work as documented when using a custom field/reference name

Active

TBD

Special thanks goes to Omar (ALM MVP) who helped isolate this gremlin.