Processors : TfsWorkItemOverwriteProcessor
Ref
Less than 1 minute to read
2024-10-30 09:13:32 +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. | missing 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 |
SourceName | String | missing XML code comments | missing XML code comments |
TargetName | String | missing XML code comments | missing 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
sample
This is an example of what your config might look like once configured.
1
2
There is no sample, but you can check the classic below for a general feel.
defaults
These are the default values for this configuration. If you do not set it in your config the default always applies. You can overide by adding a diferent value in your config.
1
2
There are no defaults! Check the sample for options!
classic
We have moved to a new config format, and you will need to update your old configs. This entry is a strate seralisation of the object and is here for legacy, and may provide value for debugging issues.
1
2
3
4
5
6
7
8
9
10
11
12
{
"$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,
"SourceName": null,
"TargetName": null
}