Use an Upgrade Handler for Knockout Model Changes
For some Knockout Model changes you need to upgrade your data action extension using an upgrade handler.
When you're making improvements to your data action extension without making
changes to the Knockout Model you normally edit your JavaScript or CSS files, create a
new ZIP file, and replace the existing data action extension with the new ZIP file.
However, if you've made changes to your data action's Knockout Model then you might need
to change the data action VERSION property and provide an upgrade
handler.
Decide whether you need to use an upgrade handler:
Upgrade Handler Required
- If you rename a property in your Knockout Model.
- If you combine multiple properties into a single property in your Knockout Model.
- If you split a single property into multiple properties in your Knockout Model.
- If you add a new property to the Knockout Model and the correct default value for it depends on other values in the Knockout Model.
- If you add a new property to the Knockout Model and can provide a default value that's correct for all existing usages of your data action.
- If you remove a property from the Knockout Model because it's no longer used by your data action code.