This is an automated email from the ASF dual-hosted git repository. danhaywood pushed a commit to branch ISIS-3255 in repository https://gitbox.apache.org/repos/asf/isis.git
commit 01e6fd2e7924967481ebec1322ccc7125dae66c0 Author: Dan Haywood <[email protected]> AuthorDate: Thu Nov 3 20:08:36 2022 +0000 ISIS-3255: updates docs for executionrepublisher module --- .../adoc/modules/commandlog/pages/about.adoc | 3 +- .../adoc/modules/executionlog/pages/about.adoc | 4 +- .../modules/executionrepublisher/pages/about.adoc | 56 +++++++++++++++++++++- 3 files changed, 57 insertions(+), 6 deletions(-) diff --git a/extensions/core/commandlog/adoc/modules/commandlog/pages/about.adoc b/extensions/core/commandlog/adoc/modules/commandlog/pages/about.adoc index e364186a9e..9257b66648 100644 --- a/extensions/core/commandlog/adoc/modules/commandlog/pages/about.adoc +++ b/extensions/core/commandlog/adoc/modules/commandlog/pages/about.adoc @@ -20,7 +20,7 @@ Sometimes the xref:executionlog:about.adoc[] extension is also configured with o === Dependency Management -Add a section for the _Command Log_ module's own BOM: +Add an entry for the _Command Log_ module's own BOM: [source,xml,subs="attributes+"] .pom.xml @@ -59,7 +59,6 @@ In the webapp module of your application, add the following dependency: [[_update-appmanifest]] === Update AppManifest - In your application's `AppManifest` (top-level Spring `@Configuration` used to bootstrap the app), import the CommandLog modules. [source,java] diff --git a/extensions/core/executionlog/adoc/modules/executionlog/pages/about.adoc b/extensions/core/executionlog/adoc/modules/executionlog/pages/about.adoc index bbab00cc76..b3886a6611 100644 --- a/extensions/core/executionlog/adoc/modules/executionlog/pages/about.adoc +++ b/extensions/core/executionlog/adoc/modules/executionlog/pages/about.adoc @@ -18,7 +18,7 @@ Sometimes the xref:commandlog:about.adoc[] extension is also configured with or === Dependency Management -Add a section for _Execution Log_'s own BOM: +Add an entry for the _Execution Log_ module's own BOM: [source,xml,subs="attributes+"] .pom.xml @@ -53,12 +53,12 @@ In the webapp module of your application, add the following dependency: ---- <.> specify either `causeway-extensions-executionlog-persistence-jpa` or `causeway-extensions-executionlog-persistence-jdo`, as required + [[_update-appmanifest]] === Update AppManifest In your application's `AppManifest` (top-level Spring `@Configuration` used to bootstrap the app), import the _ExecutionLog_ modules. - [source,java] .AppManifest.java ---- diff --git a/extensions/core/executionrepublisher/adoc/modules/executionrepublisher/pages/about.adoc b/extensions/core/executionrepublisher/adoc/modules/executionrepublisher/pages/about.adoc index d3d0946971..183634c9ec 100644 --- a/extensions/core/executionrepublisher/adoc/modules/executionrepublisher/pages/about.adoc +++ b/extensions/core/executionrepublisher/adoc/modules/executionrepublisher/pages/about.adoc @@ -7,13 +7,12 @@ The _executionrepublisher_ module contributes an action to allow logged executions (as per the xref:userguide:executionlog:about.adoc[] module) to be republished to the outbox (as per the xref:userguide:executionoutbox:about.adoc[] modul). -WARNING: TODO: v2 - to write up... == Setup === Dependency Management -Add a section for _Execution Republisher_'s own BOM: +Add an entry for the _Execution Republisher_ module's own BOM: [source,xml,subs="attributes+"] .pom.xml @@ -30,3 +29,56 @@ Add a section for _Execution Republisher_'s own BOM: </dependencies> </dependencyManagement> ---- + +[#dependencies] +=== Dependencies + +In the webapp module of your application, add the following dependency: + +[source,xml] +.pom.xml +---- +<dependencies> + <dependency> + <groupId>org.apache.causeway.extensions</groupId> + <artifactId>causeway-extensions-executionrepublisher-applib</artifactId> + </dependency> +</dependencies> +---- + +Note that this declares the xref:executionlog:about.adoc[] and xref:executionoutbox:about.adoc[] modules as dependencies. + +[[_update-appmanifest]] +=== Update AppManifest + +In your application's `AppManifest` (top-level Spring `@Configuration` used to bootstrap the app), import the _ExecutionLog_ modules. + +[source,java] +.AppManifest.java +---- +@Configuration +@Import({ + ... + CausewayModuleExtExecutionRepublisherApplib.class, + ... +}) +public class AppManifest { +} +---- + +Note that this expects (and depends upon) the xref:executionlog:about.adoc[] and xref:executionoutbox:about.adoc[] modules. + + +== User Interface + +The extension provides this mixins: + +* xref:refguide:extensions:index/executionrepublisher/applib/contributions/ExecutionLogEntry_copyToOutbox.adoc[] ++ +This contributes a `copyToOutbox` action to the xref:refguide:extensions:index/executionlog/applib/dom/ExecutionLogEntry.adoc[] entity. + + +== See also + +* xref:executionlog:about.adoc[] extension +* xref:executionoutbox:about.adoc[] extension
