Processors : TfsSharedQueryProcessor

Ref

  

Less than 1 minute to read

  

2024-12-04 17:20:47 +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 TfsSharedQueryProcessor enabled you to migrate queries from one locatio nto another.

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
PrefixProjectToNodes	Boolean	Do we add the source project name into the folder path	false
SharedFolderName	String	The name of the shared folder, made a parameter incase it every needs to be edited	Shared Queries
SourceName	String	missing XML code comments	missing XML code comments
SourceToTargetFieldMappings	Dictionary	Mapping of the source to the target	missing XML code comments
TargetName	String	missing XML code comments	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": "TfsSharedQueryProcessorOptions",
  "Enabled": false,
  "PrefixProjectToNodes": false,
  "SharedFolderName": "Shared Queries",
  "SourceToTargetFieldMappings": null,
  "SourceName": null,
  "TargetName": null
}