TfsWorkItemOverwriteProcessor

Ref

  

Less than 1 minute to read

  

2024-09-10 16:11:58 +0000

draft

This page is in draft and may include errors or omissions. Please check the discussions for any pending updates and changes to the content or to suggest your own changes.

Reapply field mappings after a migration. Does not migtate Work Items, only reapplied changes to filed mappings.

Options

Parameter name	Type	Description	Default Value
Enabled	Boolean	If set to `true` then the processor will run. Set to `false` and the processor will not run.	missng XML code comments
Enrichers	List	List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors.	missng XML code comments
FilterWorkItemsThatAlreadyExistInTarget	Boolean	This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run. While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart.	true
PauseAfterEachWorkItem	Boolean	Pause after each work item is migrated	false
RefName	String	`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.	missng XML code comments
SourceName	String	missng XML code comments	missng XML code comments
TargetName	String	missng XML code comments	missng XML code comments
WIQLQuery	String	A work item query based on WIQL to select only important work items. To migrate all leave this empty. See [WIQL Query Bits](#wiql-query-bits)	AND [Microsoft.VSTS.Common.ClosedDate] = '' AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request')
WorkItemCreateRetryLimit	Int32	**beta** If set to a number greater than 0 work items that fail to save will retry after a number of seconds equal to the retry count. This allows for periodic network glitches not to end the process.	5
WorkItemIDs	IList	A list of work items to import	[]

Examples

defaults

    There are no defaults! Check the sample for options!
    

sample

    There is no sample, but you can check the classic below for a general feel.
    

classic

    {
  "$type": "TfsWorkItemOverwriteProcessorOptions",
  "Enabled": false,
  "WorkItemIDs": null,
  "WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [@ReflectedWorkItemIdField] = ''  AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc",
  "FilterWorkItemsThatAlreadyExistInTarget": false,
  "PauseAfterEachWorkItem": false,
  "WorkItemCreateRetryLimit": 0,
  "Enrichers": null,
  "SourceName": null,
  "TargetName": null,
  "RefName": null
}