Supported operations when moving from Hosted XML to an inherited process
Upgrading a Hosted XML process model to an inherited process provides the convenience of customizing your work tracking system through the user interface. For an overview of supported customizations available to you with the Inheritance process, see About process customization and inherited processes.
While the clone process attempts to model all your work tracking customizations, there are some limitations. This article outlines the set of customizations that are supported during the clone process and those which aren't.
The Inheritance process model supports most customizations, however some of the more advanced customizations you made with the Hosted XML process might not be supported. In addition, some of the customizations made to the Hosted XML process need to be manually created in the inherited process.
Before you change the process of an existing project from Hosted XML to the cloned inherited process, review this article to understand which customizations are preserved and which are ignored.
Customizations preserved during clone
When you clone a Hosted XML process to an inherited process, the customizations listed in the following table are preserved.
|Work item types (WITs)||All system and custom WITs are preserved. Customizations made to WIT color and icon are preserved.|
|Work item fields||All custom fields are preserved. Fields that reference global lists are updated with picklists. All default values are ignored. To learn more about supported field customizations, see About process customization and inherited processes, Field customizations.|
|Workflow states||All system and custom workflow states are preserved.|
|Workflow state categories||All customizations made to the ProcessConfiguration XML file to map a workflow state to a state category (Proposed, In Progress, Resolved, Completed) are preserved. Only one workflow state can be assigned to the Completed state category. If you have assigned a custom workflow state to the Completed state category, it will be preserved upon clone.
Any workflow state for a work item type that isn't included in a backlog level will get assigned to the In Progress state category. Check all custom workflow states post clone. To learn more, see Workflow states and state categories.
|Work item form layout||A best effort is made to preserve the customizations made to the web form layout. However, any customizations made to the header area are ignored. Specifically, the Weblayout
|Backlog levels||Additions and customizations made to the product backlog and portfolio backlog levels are preserved.|
|Global lists||Global lists are converted to picklists for individual fields.|
|Default properties||The default properties set for teams that you add to a project are preserved as documented in Process configuration XML element reference, Specify properties and behaviors.|
Customizations ignored during clone
|Header area customization||Any customizations made to the header area within the work item form are ignored. The header area, as shown in the following image, is managed by the system. Any customizations made within the SystemControls section of the WebLayout are ignored.
|Four column layout and size||The inherited process supports a a fixed relative sizing of three columns to a WIT layout, while the Hosted XML process supports up to four columns and allows you to set the first column as equal sized with the rest of the columns.|
|Hide Details page in layout||The inherited process ignores any customizations made to hide the Details page in a WIT layout.|
|Workflow restriction||The inherited process follows an any-to-any workflow state transition. Any customizations that restrict the transition from one workflow state to another are ignored.|
|Workflow state reasons||Customized reasons added to workflow states are ignored.|
|Conditional picklists||Conditional picklists, also referred to as dependent or cascading picklists, are ignored. Multiple sets of allowed values per field are ignored. Picklists are defined for a field at the collection level and shared across processes and WITs.|
|Custom rules||All custom rules to fields and workflow are ignored.|
|Custom link controls||Custom link controls are ignored.|
|Extensions||The inherited process supports an opt-out model for custom control extensions, while the Hosted XML process supports an opt-in model. This means that work item types defined within the cloned inherited process will show all contributions from all installed and enabled extensions. You can selectively hide or remove them as needed.|
|Categories||Changes made to a default category are preserved, but any custom categories are ignored. Also note that system work item types such as Issue or Impediment are not supported on a backlog level.|
|Identity fields with string values||Lists that contains an identity value in ALLOWEDVALUES or PROHIBITEDVALUES will automatically be converted into the Identity field type. Any other string values in the list will be ignored.|
Post-upgrade customizations to make manually
The upgrade makes a best-effort attempt to reconcile the system process and the customizations made to the Hosted XML process. After you upgrade, you'll want to review the inherited process and reapply customizations manually.
- Create a test project: Use to verify the customizations preserved or reapplied to a process
- Update the default value for any field: define any default values you had previously defined
- Workflow states: verify the mapping of states to workflow state categories
- Custom rules: You can recreate select rules as needed. Note, however, there is not a one-to-one mapping of rules defined in a Hosted XML process model and those for an inherited process. Specifically:
- Some rules are already defined in the system process or auto-generated (e.g. certain system fields such as Changed By, Change Date, Closed By, Closed Date)
- Some rules are now specified as field attributes (default, required)
- Disable work item types
- Hide inherited fields or controls
- Custom controls: verify that custom controls are applied as expected; disable or hide unwanted groups or page extensions.
We'd love to hear your thoughts. Choose the type you'd like to provide:
Our feedback system is built on GitHub Issues. Read more on our blog.