diff --git a/content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md b/content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md index 6e69b4a6894..cb845841767 100644 --- a/content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md +++ b/content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md @@ -93,6 +93,8 @@ Key improvements are delivered through new module properties and a new `manifest The **Package** section on the **General** tab displays package identification information for the module. Studio Pro uses this information to track modules across versions, which is the foundation for more reliable module updates. +For more information on how to use package management when updating modules, see [Updating Marketplace Modules](/refguide/updating-marketplace-modules/). + ### Module ID {#module-id} The module ID is a unique identifier for the module that remains the same across all versions. It determines whether two module packages represent the same module and is therefore the basis for module update compatibility. If two modules share the same module ID, Studio Pro can update one with the other. If the IDs differ, Studio Pro treats them as distinct modules. @@ -143,6 +145,7 @@ The legacy `package.xml` metadata file is not mentioned in `manifest.json` but i ## Read More * [Modules](/refguide/modules/) +* [Updating Marketplace Modules](/refguide/updating-marketplace-modules/) * [Configure Add-on and Solution Modules for Publishing](/refguide/configure-add-on-and-solution-modules/) * [Applying Intellectual Property Protection](/appstore/creating-content/sol-ip-protection/) * [Creating Solutions](/appstore/creating-content/sol-solutions-guide/) diff --git a/content/en/docs/refguide/modeling/app-explorer/modules/updating-marketplace-modules.md b/content/en/docs/refguide/modeling/app-explorer/modules/updating-marketplace-modules.md new file mode 100644 index 00000000000..7554dbdf920 --- /dev/null +++ b/content/en/docs/refguide/modeling/app-explorer/modules/updating-marketplace-modules.md @@ -0,0 +1,49 @@ +--- +title: "Updating Marketplace Modules" +url: /refguide/updating-marketplace-modules/ +weight: 40 +description: "How to update Marketplace modules in Studio Pro while retaining your customizations using three-way merge." +--- + +## Introduction + +{{% alert color="info" %}} +This feature requires Studio Pro 11.12 or above. +{{% /alert %}} + +Previously, when you wanted to update a Marketplace module to a newer version, you had to fully replace it, losing any customizations such as modified microflows or added functionality. + +Studio Pro 11.12 changes this by enabling module updates that retain your customizations. When you update a module, Studio Pro performs a three-way merge that combines your customizations with the publisher's updates. You can keep your changes and benefit from bug fixes and new features in the updated module. + +## How Module Updates Work + +### Three-Way Merge Process + +To retain your customizations when updating a module, Studio Pro performs a three-way merge using three versions: + +1. Original version – The version of the Marketplace module that you originally imported. +2. Current version – The version currently in your app, which may include your modifications. +3. Target version – The new version of the Marketplace module that you want to upgrade to. + +You must manually provide both the original and target versions. If document mapping succeeds, the merge begins. If mapping fails, you cannot upgrade while keeping your customizations and must fully replace the module instead. + +During the merge, conflicts may occur if you and the publisher both modified the same element (for example, the same microflow). For information on resolving conflicts, see [Combining Changes and Resolving Conflicts](/refguide/resolving-conflicts/). + +### Document Mapping + +To merge your customizations with the updated module, Studio Pro matches documents between the old and new versions. The method depends on whether the module has package IDs: + +* Modules with package IDs – Studio Pro uses embedded GUID mapping to match documents by GUID. This is more reliable because documents can be matched even if they have been renamed. + +{{% alert color="info" %}} +Studio Pro 11.12 introduced package IDs and document GUID mappings to make updates more reliable. +{{% /alert %}} + +For more information on package IDs and how they are assigned, see [Module Settings](/refguide/module-settings/#package). + +## Read More + +* [Modules](/refguide/modules/) +* [Module Settings](/refguide/module-settings/) +* [Consuming Add-on Modules and Solutions](/refguide/consume-add-on-modules-and-solutions/) +* [Combining Changes and Resolving Conflicts](/refguide/resolving-conflicts/)