Tools : TfsAttachmentTool

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.

missing XML code comments

Options

Parameter name	Type	Description	Default Value
Enabled	Boolean	If set to `true` then the tool will run. Set to `false` and the processor will not run.	missing XML code comments
ExportBasePath	String	`AttachmentMigration` is set to true then you need to specify a working path for attachments to be saved locally.	C:\temp\Migration\
MaxAttachmentSize	Int32	`AttachmentMigration` is set to true then you need to specify a max file size for upload in bites. For Azure DevOps Services the default is 480,000,000 bites (60mb), for TFS its 32,000,000 bites (4mb).	480000000

Examples

sample

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

    {
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "TfsAttachmentTool": {
        "Enabled": "True",
        "ExportBasePath": "c:\\temp\\WorkItemAttachmentExport",
        "MaxAttachmentSize": "480000000",
        "RefName": "TfsAttachmentTool"
      }
    }
  }
}
    

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.

    {
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "TfsAttachmentTool": {
        "Enabled": "True",
        "ExportBasePath": "c:\\temp\\WorkItemAttachmentExport",
        "MaxAttachmentSize": "480000000",
        "RefName": "TfsAttachmentTool"
      }
    }
  }
}
    

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": "TfsAttachmentToolOptions",
  "Enabled": true,
  "ExportBasePath": "c:\\temp\\WorkItemAttachmentExport",
  "MaxAttachmentSize": 480000000
}