diff --git a/content/en/docs/refguide/modeling/app-explorer/modules/configure-add-on-and-solution-modules.md b/content/en/docs/refguide/modeling/app-explorer/modules/configure-add-on-and-solution-modules.md index 7c4c8c30031..c2f6222662e 100644 --- a/content/en/docs/refguide/modeling/app-explorer/modules/configure-add-on-and-solution-modules.md +++ b/content/en/docs/refguide/modeling/app-explorer/modules/configure-add-on-and-solution-modules.md @@ -5,6 +5,12 @@ url: /refguide/configure-add-on-and-solution-modules/ weight: 20 --- +{{% alert color="warning" %}} + +Add-on and solution modules will soon be deprecated. They are being replaced by other functionality that you can use across modules. For more information, see [Substitute Features for Add-On and Solution Modules](#substitute-features). + +{{% /alert %}} + ## Introduction Add-on and solution modules are special types of modules that are developed to add functionality to an app. They have intellectual property (IP) protection enabled and have the *.mxmodule* extension. For more information on IP protection, see [Applying Intellectual Property Protection](/appstore/creating-content/sol-ip-protection/). @@ -100,6 +106,18 @@ When you update an individual add-on or a solution module to another version, yo If for some reason you switch the add-on and solution module to an app module (for example, to provide the source code to customers), their module data is lost once they upload a new version of this module to their app. {{% /alert %}} +## Substitute Features for Add-On and Solution Modules {#substitute-features} + +The deprecated add-on and solution module concepts are being replaced with the following features and capabilities: + +1. Access control replacements: + 1. Private documents and domain model elements *(future release)* – Publishers can mark documents, entities, attributes, and associations as **Private**. Private elements cannot be referenced from outside the module (with consistency errors triggered if violated) and are hidden by default, though consumers can toggle to inspect them. Solution modules receive an exception so core functionality works. + 2. Module lock *(future release)* – Instead of completely hiding implementations, all document implementations are visible. To prevent accidental edits, modules are imported as **Locked** by default. Consumers must explicitly unlock them to modify them. +2. Replacing the **USE_ME** folder *(future release)* – Introducing **Setup** node, a formal replacement for the **USE_ME** folder. Publishers can add shortcuts to documents that form the public API of their module using the **Setup** node. +3. Module integrity and updates: + 1. Retaining customizations on update *(already available)* – Instead of losing changes when updating a Marketplace module, a Merge algorithm with conflict resolution automatically retains consumer customizations. Renamed entities by publishers no longer cause data loss. + 2. Module integrity check *(future release)* – An integrity check that validates whether the current state of a module is still the same as the original package, provided that the original package is available for comparison. The modifications that Studio Pro makes to the module when converting to newer versions are ignored during this comparison. + ## Read More * [Create Solutions](/appstore/creating-content/sol-solutions-guide/) diff --git a/content/en/docs/refguide/modeling/app-explorer/modules/consume-add-on-modules-and-solutions.md b/content/en/docs/refguide/modeling/app-explorer/modules/consume-add-on-modules-and-solutions.md index 5423df51f15..886c1d5ff48 100644 --- a/content/en/docs/refguide/modeling/app-explorer/modules/consume-add-on-modules-and-solutions.md +++ b/content/en/docs/refguide/modeling/app-explorer/modules/consume-add-on-modules-and-solutions.md @@ -6,6 +6,12 @@ weight: 30 #If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details. --- +{{% alert color="warning" %}} + +Add-on and solution modules will soon be deprecated. They are being replaced by other functionality that you can use across modules. For more information, see [Substitute Features for Add-On and Solution Modules](/refguide/configure-add-on-and-solution-modules/#substitute-features) in *Configuring Add-on and Solution Modules for Publishing*. + +{{% /alert %}} + ## Introduction An *add-on module* is a special type of module that adds functionality to your app. It has Intellectual Property (IP) protection enabled and has the *.mxmodule* extension. An add-on module is developed to be a *standalone functionality* that other users can consume in their apps, for example, an add-on can be a connector.