Processors : KeepOutboundLinkTargetProcessor

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.

missing XML code comments

Options

Parameter name	Type	Description	Default Value
CleanupFileName	String	File path where the cleanup script or batch file will be generated for removing unwanted outbound links.	missing XML code comments
DryRun	Boolean	When true, performs a dry run without making actual changes, only generating the cleanup script for review.	missing XML code comments
Enabled	Boolean	If set to `true` then the processor will run. Set to `false` and the processor will not run.	missing XML code comments
PrependCommand	String	Command to prepend to each line in the cleanup script, such as "start" for Windows batch files.	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
TargetLinksToKeepOrganization	String	URL of the Azure DevOps organization whose links should be preserved during cleanup operations.	missing XML code comments
TargetLinksToKeepProject	String	Project name or GUID within the target organization whose links should be preserved.	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	WIQL (Work Item Query Language) query used to select the work items whose outbound links should be processed for preservation.	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": "KeepOutboundLinkTargetProcessorOptions",
  "Enabled": false,
  "WIQLQuery": "Select [System.Id] From WorkItems Where [System.TeamProject] = @project and not [System.WorkItemType] contains 'Test Suite, Test Plan,Shared Steps,Shared Parameter,Feedback Request'",
  "TargetLinksToKeepOrganization": "https://dev.azure.com/nkdagility",
  "TargetLinksToKeepProject": "993d43f0-fa86-40df-9102-50118fb56357",
  "CleanupFileName": "c:/temp/OutboundLinkTargets.bat",
  "PrependCommand": "start",
  "DryRun": true,
  "SourceName": null,
  "TargetName": null
}