diff --git a/docs/documentation/user-guide/process-applications/maven-archetypes.md b/docs/documentation/user-guide/process-applications/maven-archetypes.md index 1e2a7eb3..fad673f3 100644 --- a/docs/documentation/user-guide/process-applications/maven-archetypes.md +++ b/docs/documentation/user-guide/process-applications/maven-archetypes.md @@ -10,148 +10,35 @@ menu: --- -We provide several project templates for Maven, which are also called Archetypes. -They enable a quickstart for developing production-ready process applications using Operaton. -We incorporated best practices for different application types into the templates to help you start off with a solid base. +Maven Archetypes are project templates that can generate a ready-to-use Maven project. -The Archetypes can be used to generate projects as detailed in the different usage sections. -In case generating a project from an Archetype on your own is not feasible, we also provide a template GitHub repository for every Archetype. +:::caution[Current Availability] +Operaton does not currently publish public Maven archetype artifacts or an archetype catalog. Older documentation pointed to artifact and template repositories that are not available for Operaton and should not be used. +::: -## Overview of Available Maven Archetypes +## Recommended Project Setup -The following archetypes are currently provided. They are distributed via our Maven repository: https://artifacts.camunda.com/artifactory/operaton-bpm/ +Use the manual project setup guides instead. They show the current Maven dependencies and project structure directly: -
| Archetype | Description |
|---|---|
| Operaton Cockpit Plugin | -Plugin for Operaton Cockpit, contains REST-Backend, MyBatis database query, HTML and JavaScript frontend, Ant build script for one-click deployment | -
| Process Application (EJB, WAR) | -Process application that uses a shared Operaton engine in a Java EE Container, e.g., WildFly. - Contains: Operaton EJB Client, Operaton CDI Integration, BPMN Process, Java Delegate as CDI bean, HTML5- & JSF-based start and task forms, - configuration for JPA (Hibernate), JUnit Test with in-memory engine and visual process test coverage, Arquillian Test for WildFly, Maven Plugins or Ant build script for one-click deployment in Eclipse | -
| Process Application (Servlet, WAR) | -Process application that uses a shared Operaton engine in a Servlet Container, e.g., Apache Tomcat. - Contains: Servlet process application, BPMN Process, Java Delegate, HTML5-based start and task forms, - JUnit Test with in-memory engine, Maven Plugins or Ant build script for one-click deployment in Eclipse | -
| Operaton Spring Boot Application | -Application that uses the Operaton Spring Boot Starter. - Contains: Spring Boot Process Application, Operaton Webapps, BPMN Process, Java Delegate, HTML5-based start and task forms, - JUnit Test with in-memory engine, Maven Plugins for packing as an executable application. | -
| Operaton Spring Boot Application with Demo Users | -Same as the Spring Boot Application archetype and additionally creates demo users and groups for easy start with the Operaton Webapps (use demo/demo to log in). |
-
| Process Engine Plugin | -An example for a process engine plugin. - Contains: Process engine plugin, BPMN Parse Listener that is registered via the plugin, Task Listener that is added to every user task, JUnit Test with in-memory engine. | -
-mvn archetype:generate -Dfilter=org.operaton.bpm.archetype: -- - -### Full Automation - -The following command completely automates the project generation and can be used in shell scripts or Ant builds: -
-mvn archetype:generate \ - -DinteractiveMode=false \ - -DarchetypeGroupId=org.operaton.bpm.archetype \ - -DarchetypeArtifactId=operaton-archetype-ejb-war \ - -DarchetypeVersion=7.10.0 \ - -DgroupId=org.example.operaton.bpm \ - -DartifactId=operaton-bpm-ejb-project \ - -Dversion=0.0.1-SNAPSHOT \ - -Dpackage=org.example.operaton.bpm.ejb -- - -## Source Code and Customization - -You can also customize the project templates for your own technology stack. Just [fork them on GitHub](https://github.com/operaton/operaton-archetypes)! +Treat these names as historical until Operaton publishes a public archetype catalog again. For new applications, start from the setup guides above and import the Operaton BOM from Maven Central. diff --git a/docs/documentation/user-guide/process-applications/the-process-application-class.md b/docs/documentation/user-guide/process-applications/the-process-application-class.md index ba005eac..350d20eb 100644 --- a/docs/documentation/user-guide/process-applications/the-process-application-class.md +++ b/docs/documentation/user-guide/process-applications/the-process-application-class.md @@ -55,9 +55,7 @@ Notice the `@ProcessApplication` annotation. This annotation fulfills two purpos This means that in case you deploy to a Servlet 3.0 compliant container (such as Apache Tomcat) annotating your class with `@ProcessApplication` is sufficient. -:::note - There is a [project template for Maven](../../user-guide/process-applications/maven-archetypes.md) called ```operaton-archetype-servlet-war```, which gives you a complete running project based on a servlet process application. -::: +For a complete servlet process application project, follow the [Java process application project setup](/docs/get-started/archive/java-process-app/project-setup/). ### Using Servlet process applications inside an EJB/Jakarta EE/Java EE container such as Wildfly @@ -139,10 +137,10 @@ You could of course use something like the maven shade plugin for adding the cla :::note We always recommend using the Operaton EJB Client over deploying a custom `EjbProcessApplication` class unless you want to customize the behavior of the `EjbProcessApplication`. - - There is a [project template for Maven](../../user-guide/process-applications/maven-archetypes.md) called ```operaton-archetype-servlet-war```, which gives you a complete running project based on a Java EE servlet process application. ::: +For a complete Java EE process application project, follow the [Java EE project setup](/docs/get-started/archive/javaee7/project-setup/). + ### Deploying a Custom `EjbProcessApplication` Class diff --git a/docs/documentation/user-guide/testing/index.md b/docs/documentation/user-guide/testing/index.md index 24eaae4e..f501eea9 100644 --- a/docs/documentation/user-guide/testing/index.md +++ b/docs/documentation/user-guide/testing/index.md @@ -140,9 +140,7 @@ public class MyBusinessProcessTest { } ``` -:::note - Our [Project Templates for Maven](../../user-guide/process-applications/maven-archetypes.md) give you a complete running project including a JUnit test out of the box. -::: +The [Java process application project setup](/docs/get-started/archive/java-process-app/project-setup/) shows a complete project structure that you can extend with tests like the examples below. ### JUnit 3 @@ -274,16 +272,16 @@ Also, you will have to add the AssertJ library to your dependencies. Make sure t ``` -If Operaton Assert is used in combination with [Spring Boot](https://spring.io/projects/spring-boot) or the -[Operaton Spring Boot Starter](https://docs.operaton.org/docs/documentation/user-guide/spring-boot-integration/), +If Operaton Assert is used in combination with [Spring Boot](https://spring.io/projects/spring-boot) or the +[Operaton Spring Boot Starter](../spring-boot-integration/), the AssertJ dependency will be present in your project already. ### Assertions Version Compatibility Each version of Operaton Assert is bound to a specific version of Operaton and AssertJ. Only these default combinations are recommended (and supported) by Operaton. Nevertheless, each version of Operaton Assert can be combined with newer patch versions of the Operaton engine, though such combinations must be thoroughly tested before being used in production. -All versions prior to 3.0.0 belong to the community extension are not part of the official Operaton product support. -With Operaton.17.0 the project was moved into the [Operaton repository](https://github.com/operaton/operaton) and will use the same versioning as Operaton in the future. +All versions prior to 3.0.0 belong to the community extension and are not part of the official Operaton product support. +With Camunda 7.17.0, the project was moved into the platform repository; Operaton now maintains it in the [Operaton repository](https://github.com/operaton/operaton) and uses the same versioning as Operaton.