If you are upgrading your instance from a version prior to Eureka, you may have noticed that when you navigate to Personalize > Form Design, the form designer is missing from your context menu. The reason your form designer is not in your menu could be due to a UI Macro.
The form header is rendered using the context_form_header UI macro and when you perform an upgrade the macro is updated, adding the respective logic for the plugin.
When a UI macro is customized, it is tracked in your Customer Updates table. In the future you should prevent your customizations from being overwritten during your upgrades by versioning your macros in the Customer Updates table. Versioning allows the upgrade to automatically skip over any items.
You can also preserve your customizations to ensure that this doesn't happen when you undergo future upgrades.
How to preserve your customizations:
- Copy the changes
- Revert the context_form_header UI Macro to the base system
- Merge the customization back manually
There are scenarios where you may want to overwrite your customizations with the next software version. For example, you may change a script to implement a temporary workaround for a problem that is fixed in the next version. You would want to overwrite your workaround when upgrading to the next version to ensure that you receive any future enhancements to the script.
How to Revert a UI macro to the base system and lose the Customization:
- Navigate to System Diagnostics > Upgrade History.
- Identify the record that represents your recent upgrade and open it.
- Filter the Upgrade Details related list by [File name] [is] [sys_ui_macro_2ff1c56ca9fe3dba014340c4697b5088]
- Select the record.
- Click Revert to Out-of-box to overwrite the UI macro with the default version.
Upgrading is exciting, who doesn't like a shiny new toy to customize and design with the latest bells and whistle? But be aware that upgrading to new versions could also lead to new problems due to old customizations.
Other upgrade resources you may find helpful:
Upgrades and their relation to customizations
Catalog categories being traced by update sets
Saving your personalizations when upgrading your instance
