source-connection The source account details
accountfully qualified url for the source accountprojectname of the project to migrate fromaccess-tokenPAT to use when accessing the account.- requires work item read permissions to all work items which need to be migrated.
- note: personal access tokens require https
use-integrate-authwhen connecting to TFS, you can use NTLM instead of an access token.
target-connection The target account details
accountfully qualified url for the target accountprojectname of the project to migrate toaccess-tokenPAT to use when accessing the account.- requires user is required to be a project collection administrator.
- note: personal access tokens require https
use-integrate-authwhen connecting to TFS, you can use NTLM instead of an access token.
query the name of the query to use for identifying work items to migrate. Note: query must be a flat
heartbeat-frequency-in-seconds the number of seconds in between logging the migration status. this gives the user a periodic update on the number of work items that have succeeded or failed the phases of migration. the default value is 30.
query-page-size the number of work item ids to return at a time when running the query. This should be set to 20000 for hosted accounts and 2147483647 for onpremise accounts.
parallelism the number of threads to run in parallel. if omitted, defaults to the number of cores on the computer.
max-attachment-size the maximum size in bytes that an attachment can be. if it exceeds this size, it will be skipped. the default value is 60MB
link-parallelism the number of threads to run in parallel when processing links. if omitted, defaults to the number of cores on the computer.
attachment-upload-chunk-size the chunk size to use when uploading a work item in bytes. the default value is 1MB
skip-existing when true, the migration will not attempt to update any work items that have been previously migrated. when false, it will update any previously migrated work items that have changed on the source since the migration was completed.
move-history create a json file containing the updates of the source work item and attach it to the migrated work item.
move-history-limit the limit to the number of updates of the source work item to attach to the migrated work item.
move-git-links migrate git commit links as hyperlinks that point to the web view of the commit on the source account.
move-links preserve and migrate work item links from source to target if the linked work item is part of the current query or it has been previously migrated.
source-post-move-tag the tag to stamp on the work items on the source project once the migration is complete.
target-post-move-tag the tag to stamp on the work items on the target project once the migration is complete.
skip-work-items-with-type-missing-fields when true, will skip the work item if it's type does not have all fields present on the target account when false, will migrate the work item using only the matching fields present on the target account
skip-work-items-with-missing-area-path when true, will skip the work item if the area path does not exist in the target account when false, will migrate the work item and set the area path to the project name when the area path does not exist on the target account.
skip-work-items-with-missing-iteration-path when true, will skip the work item if the iteration path does not exist in the target account when false, will migrate the work item and set the iteration path to the project name when the iteration path does not exist on the target account.
default-area-path when the area path doesn't exist on the target project, the migrator will use this area path instead of defaulting to the root. note: if skip-work-items-with-missing-area-path is true, this setting is ignored.
default-iteration-path when the iteration path doesn't exist on the target project, the migrator will use this iteration path instead of defaulting to the root. note: if skip-work-items-with-missing-iteration-path is true, this setting is ignored.
clear-identity-display-names if the account has any identities with emojis, it's possible migration will fail if the identity with an emoji has not been added to the account. This setting will remove the display portion of the identity to ensure migration will succeed.
ensure-identities when true, will add any identities that are referenced by work items to the account, adding them to the Licensed Users group. This applies only to VSTS, not TFS. when false, if any identity that is referenced by the work item does not exist it will be created as a non-identity value which can cause issues for query and in the case of special characters in the name the work item will fail to be migrated.
include-web-link when true, will include the web link in addition to the REST link for the source work item on the target.
log-level-for-file minimum log level that will be logged to the file. if omitted, defaults to information. acceptable values from lowest to highest log level: trace, debug, information, warning, error, critical.
field-replacements this can be used for 2 things. the first line in the example below shows how for a source field, we can specify the literal value that its target counterpart will contain. the second line in the example below shows how for a source field, we can specify an existing target field
"field-replacements": {
"System.Title": { "value": "literalTextForSystemTitle" },
"System.Title": { "field-reference-name": "System.Tags" }
}
send-email-notification when true, will send a run summary email if there are details in the Email Notification Message
##Email Notification This can be used to send a run summary email to one or more recipients. If used, please specify a valid smtp-server, one or more recipient-addresses, and the user-name and password if required by the smtp-server.
"email-notification": {
"smtp-server": "127.0.0.1",
"use-ssl": false,
"port": "25",
"from-address": "[email protected]",
"user-name": "un",
"password": "pw",
"recipient-addresses": [
"[email protected]",
"[email protected]"
]
}