KB: Update Existing Managed Components to a New Component Type and Template

Solution Details

Existing Components Require a New Structure

Existing managed components may need to be updated when an organization replaces sample component types and templates with custom configurations. Components must then be migrated to the new component type, template, and folder structure. When restructuring components, it is important to consider the varying requirements and starting points involved. As such, a rigid step-by-step process may not always be suitable.

Component Types Control Organization and Templates

Component types are typically associated with a component template and a default folder structure. Component templates define parameter sets, parameter visibility, default values, and required parameter settings. Updating a component type often requires updating the associated template and folder structure to maintain consistency across the Workspace.

Available Approaches for Restructuring Components

• Activate a new workspace without sample data and create custom component types, templates, and folder structures. Note that this option is not viable if you have already created live project data in your current workspace.
   
• Update existing component templates and types before creating components. 
  
• Create a new component type, template, and folder structure, then update existing components to the new configuration using batch editing.

Update Components Using Batch Editing

1. Create the new component type, template, and folder structure.
   
2. Review the old and new templates to ensure parameter consistency. Matching parameter names and Type help prevent duplicate parameters and reduce post-migration cleanup efforts. Additional parameters are acceptable, but key parameters should remain consistent where possible. When making new template parameters, avoid marking them as required unless the corresponding data will be entered manually. 
    
3. Validate the process on a small test batch of components before updating a larger component library.
4. Move the existing components from the old folder structure to the new folder structure in Explorer.
    
5. Open the migrated components for batch editing
   
6. In the Models and Parameters section, click Add and select Template: None. This converts existing template parameters into user parameters.
    
7. Click Add again and select the new component template
8. When prompted, confirm updating the component type for all selected components. The new template replaces user parameters with template parameter names and adds any newly defined parameters.
    
9. Perform updates in batches, beginning with components in the Draft lifecycle state before updating components in other lifecycle states.
10. Verify that lifecycle states are preserved during component release operations performed through the batch editor.
11. After successfully validating the migrated components, remove obsolete component types, templates, and related items to prevent confusion.

Additional Notes

• Moving components and lifecycle state management can be completed incrementally.
• Parameter inconsistencies between old and new templates may require manual cleanup using batch editing tools. Link

References

• Batch Component Editing
• Component Templates
• Component Types