Processors : TfsWorkItemDeleteProcessor

Ref

  

Less than 1 minute to read

  

2025-06-19 13:46:05 +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.

The WorkItemDelete processor allows you to delete any amount of work items that meet the query. DANGER: This is not a recoverable action and should be use with extream caution.

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	Gets or sets a value indicating whether to filter out work items that already exist in the target before deletion. Typically used to avoid deleting items that shouldn't be removed.	missing XML code comments
PauseAfterEachWorkItem	Boolean	Gets or sets a value indicating whether to pause after each work item is deleted for review or debugging purposes.	missing XML code comments
SourceName	String	This is the `IEndpoint` that will be used as the source of the Migration. Can be null for a write only processor.	missing XML code comments
TargetName	String	This is the `IEndpoint` that will be used as the Target of the Migration. Can be null for a read only processor.	missing XML code comments
WIQLQuery	String	Gets or sets the WIQL query used to select work items for deletion. Should return a list of work item IDs.	SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc
WorkItemCreateRetryLimit	Int32	Gets or sets the number of retry attempts for work item deletion operations when they fail due to transient errors.	missing XML code comments
WorkItemIDs	IList	Gets or sets a specific list of work item IDs to delete. When specified, takes precedence over the WIQL query.	missing XML code comments

Examples

sample

This is an example of what your config might look like once configured.

    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.

    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.

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