Skip to content

Commit 381bf0c

Browse files
committed
Describe data stores and changeset generation in composite projects #602
1 parent 4e459e4 commit 381bf0c

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

content/modules/ROOT/pages/add-ons.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
Jmix does not only provide a platform to build your applications upon. It also contains an ecosystem of add-ons that enrich the core functionality. A lot of add-ons are provided by the Jmix team, while others are contributions from the community.
44

5-
Jmix add-ons are published on the Jmix https://www.jmix.io/marketplace/[marketplace^]. You can browse and install them directly in Studio as described <<installation,below>>. To publish your own open-source add-on to the marketplace, see xref:publish-add-on.adoc[].
5+
Jmix add-ons are published on the Jmix https://www.jmix.io/marketplace/[marketplace^]. You can browse and install them directly in Studio as described <<installation,below>>.
6+
7+
xref:modularity:creating-add-ons.adoc[] section describes how to create your own add-ons to modularize your applications and reuse functionality. To publish your open-source add-on to the Jmix marketplace, see xref:publish-add-on.adoc[].
68

79
[[installation]]
810
== Installation

content/modules/studio/pages/composite-projects.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,10 @@ To generate a changelog, you first need to define a xref:studio:data-stores.adoc
8080

8181
image::studio:add-on-data-store.png[align="center",width="484"]
8282

83-
The data store settings will be saved in the `jmix-studio.xml` file instead of the Java configuration.
84-
8583
Now, you can execute the *Generate Liquibase Changelog* action on the Data Store.
8684

87-
In a composite project, you should specify a Data Store for the same add-on again, because the composite project has its own `jmix-studio.xml` file located in the root or `<project-name>-all` aggregator project. So, data store settings will be stored separately for when you are working on the add-on in a standalone project and in a composite project, but the set of generated changelogs will be the same.
85+
The data store settings will be saved in the `jmix-studio.xml` file instead of the Java configuration. This means that the add-on does not define a data store for an application in which it is included. Instead, it expects the data store with the same name to be defined by the application itself.
86+
87+
For example, if you define `ads1` data store in an add-on, you should also define the `ads1` data store in the application that includes this add-on. And if the add-on provides Liquibase changelogs for this data store, they will be executed by the application.
88+
89+
TIP: When working with an add-on both in a standalone project and in a composite project, you should specify a data store twice, because the composite project has its own `jmix-studio.xml` file located in the root or in the `<project-name>-all` aggregator project. So, the data store settings will be stored separately in the standalone project and in the composite project, but the set of generated changelogs will be the same.

0 commit comments

Comments
 (0)