archetype-resources.README.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-archetype-servlet-war-demo

Demo application with lots of pre-built parts that uses a shared Camunda Platform 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, and visual process test coverage

The newest version!

#set( $symbol_pound = '#' )
#set( $symbol_dollar = '$' )
#set( $symbol_escape = '\' )
${symbol_pound} ${project-name}
${project-description}

This project has been generated by the Maven archetype
[${archetype-artifactId}-${archetype-version}](https://docs.camunda.org/manual/latest/user-guide/process-applications/maven-archetypes/).

${symbol_pound}${symbol_pound} Show me the important parts!
[BPMN Process](src/main/resources/process.bpmn)

${symbol_pound}${symbol_pound} How does it work?

${symbol_pound}${symbol_pound} How to use it?

${symbol_pound}${symbol_pound}${symbol_pound} Unit Test
You can run the JUnit test [ProcessTest](src/test/java/${packageInPathFormat}/ProcessTest.java) in your IDE or using:

```bash
mvn clean test
```

${symbol_pound}${symbol_pound}${symbol_pound} Deployment to an Application Server
You can also build and deploy the process application to an application server.
For an easy start you can download Apache Tomcat with a pre-installed Camunda
from our [Download Page](https://camunda.com/download/).

${symbol_pound}${symbol_pound}${symbol_pound}${symbol_pound} Manually
1. Build the application using:

```bash
mvn clean package
```
2. Copy the *.war file from the `target` directory to the deployment directory
of your application server e.g. `tomcat/webapps` or `wildfly/standalone/deployments`.
For a faster 1-click (re-)deployment see the alternatives below.

${symbol_pound}${symbol_pound}${symbol_pound}${symbol_pound} Apache Tomcat (using Tomcat Maven Plugin)
1. Create a user in Tomcat with the role `manager-script`.
2. Add the user's credentials to the `tomcat7-maven-plugin` configuration in the [pom.xml](pom.xml) file.
3. Build and deploy the process application using:

```bash
mvn clean tomcat7:deploy
```

${symbol_pound}${symbol_pound}${symbol_pound}${symbol_pound} Wildfly (using Wildfly Maven Plugin)
1. Build and deploy the process application using:

```bash
mvn clean wildfly:deploy
```

${symbol_pound}${symbol_pound}${symbol_pound}${symbol_pound} JBoss AS7 (using JBoss AS Maven Plugin)
1. Build and deploy the process application using:

```bash
mvn clean jboss-as:deploy
```

${symbol_pound}${symbol_pound}${symbol_pound} Run and Inspect with Tasklist and Cockpit
Once you deployed the application you can run it using
[Camunda Tasklist](http://docs.camunda.org/latest/guides/user-guide/#tasklist)
and inspect it using
[Camunda Cockpit](http://docs.camunda.org/latest/guides/user-guide/#cockpit).

${symbol_pound}${symbol_pound} Environment Restrictions
Built and tested against Camunda Platform version ${camunda-version}.

${symbol_pound}${symbol_pound} Known Limitations

${symbol_pound}${symbol_pound} License
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).