Skip to content

Commit b474f5a

Browse files
authored
Update index.md
1 parent bcab381 commit b474f5a

File tree

1 file changed

+41
-24
lines changed

1 file changed

+41
-24
lines changed

docs/index.md

Lines changed: 41 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,62 @@
11
# VSTS Bulk Data Editor Engine Docs
22

3-
Visual Studio Team Services Bulk Data Editor Engine allows you to bulk edit data in Microsoft Team Foundation Server (TFS) and Visual Studio Team Services (VSTS). It has many names depending on what you are trying to achive. You might call it a migration tool, or a bulk update tool, and both are correct.
3+
Visual Studio Team Services Bulk Data Editor Engine allows you to bulk edit data in Microsoft Team Foundation Server (TFS) and Visual Studio Team Services (VSTS). It has many names depending on what you are trying to achieve. You might call it a migration tool, or a bulk update tool, and both are correct.
44

55
## Overview
66

77
### Main Purpose
88

9-
- **Bulk Update** - You can builk update work items and apply processing rules against your server or account. Use the `WorkItemUpdate` class that takes only a target Team Project.
10-
- **Migration** - You can migrate work items, area & iterations, & test data from one Team Project to another. Use the `WorkItemMigrationContext` calss that takes both a Source and a Target Team Project
9+
- **Bulk Update** - You can bulk update work items and apply processing rules against your server or account. Use the `WorkItemUpdate` class that takes only a target Team Project.
10+
- **Migration** - You can migrate work items, area & iterations, & test data from one Team Project to another. Use the `WorkItemMigrationContext` class that takes both a Source and a Target Team Project
1111

1212
### Field Mapps
1313

14-
There are for field mapping systems available:
14+
By default, when you are moving from source to target the system will map all of the fields that exist in source to the same field in the target. However sometimes you want to move data to another field, or use a regex to parse out just the bits that you want. To help we have built a number of mapping tools that should give you the versatility you need.
1515

16-
- FieldValueMap
17-
- FieldToTagFieldMap
18-
- FieldToTagFieldMap
19-
- RegexFieldMap
16+
- **FieldtoFieldMap** - Just want to map one field to another? This is the one for you.
17+
- **FieldMergeMap** - Ever wanted to merge two fields? This mapping will let you do just that.
18+
- **FieldBlankMap** - Allows you to set an already populated field to empty
19+
- **FieldtoTagMap** - Want to take a field and convert its value to a tag? Done...
20+
- **FieldValueMap** - Need to map not just the field but also values? This is the default value mapper.
21+
- **FieldValuetoTagMap** - Need to create a Tag based on a field value? Just create a regex match and choose how to populate the target.
22+
- **RegexFieldMap** - I just need that bit of a field... need to send "2016.2" to two fields, one for year and one for releae? Done.
23+
- **TreeToTagMap** - Need to clear out those nasty Area tree hierarchies? This creates Tags for each node in the Area Path...
2024

2125
### Processors
2226

23-
There are other processors that can be used to migrate, or process, different sorts of data:
24-
25-
- AttachementExportMigrationContext
26-
- AttachementImportMigrationContext
27-
- LinkMigrationContext
28-
- NodeStructuresMigrationContext
29-
- TestConfigurationsMigrationContext
30-
- TestPlansAndSuitsMigrationContext
31-
- TestVeriablesMigrationContext
32-
- TestRunsMigrationContext
33-
- WorkItemMigrationContext
34-
- ImportProfilePictureContext
35-
- WorkItemDelete
27+
There are other processors that can be used to migrate, or process, different sorts of data in diferent ways. Which one is right for you depends on the situation at hand.
3628

37-
### Processors (Beta)
29+
####In-Place Processors
3830

39-
- CreateTeamFolders
31+
- **WorkItemUpdate** - Need to just update work items in place, use this and only set the Target. All field mappings work...
32+
- **WorkItemDelete** - Woops... Can I just start again? Feed this a query and watch those items vanish ***WARNING***
33+
34+
####Migrators
35+
36+
Most of thise processors need to be run in order. If you try to migrate work items before you have migrated Area and Iterations then ***bang*** you need to go back.
37+
38+
#####Work Items
39+
1. **NodeStructuresMigrationContext** -
40+
1. **WorkItemMigrationContext** - The work horse...push tip from one location to another while maintining context. Make sure that you add a ReflectedWorkItemID and you can restart the service at any time...
41+
1. **AttachementExportMigrationContext** -
42+
1. **AttachementImportMigrationContext** -
43+
1. **LinkMigrationContext** -
44+
45+
#####Test Plans & Suites
46+
47+
1. TestVeriablesMigrationContext
48+
1. TestConfigurationsMigrationContext
49+
1. TestPlansAndSuitsMigrationContext
50+
1. TestRunsMigrationContext [BETA]
51+
52+
#####Misc
53+
54+
- ImportProfilePictureContext
4055
- ExportProfilePictureFromADContext
41-
- ExportTeamList
56+
- WorkItemDelete
4257
- FixGitCommitLinks
58+
- CreateTeamFolders
59+
- ExportTeamList
4360

4461
## Contributing
4562

0 commit comments

Comments
 (0)