The open source workflow technology for business applications
Clone or download
Latest commit 773346b Sep 18, 2018

README.md

Imixs-Workflow

Join the chat at https://gitter.im/imixs/imixs-workflow Build Status License

Imixs-Workflow is an open source workflow engine based on the Java Enterprise Architecture (JEE). The Imixs-Workflow project provides components to build human-centric workflow applications within a flexible and robust framework. The business logic can be modeled and executed using the Business Process Modelling Notation - BPMN 2.0 standard.

To follow us in this project, please join GitHub by creating an account. You can than "Watch" the project with the link above or if you like the project click on the "Star".

You will find more detailed information how to work with Imixs-Workflow on the Project Home.

Imixs-BPMN

Imixs-BPMN is an Eclipse modeling tool to design a business process based on the BPMN 2.0 standard. These models can be executed by the Imixs-Workflow engine.

Imixs-BPMN

Read more about Imixs-BPMN on the project home.

Imixs-RESTful API

Imixs-Workflow provides a RESTful API to integrate the Imixs-Workflow engine into a microservice architecture. In such an architecture the Imixs-Workflow engine can be deployed as a separate microservice managing human-centric workflow tasks. The Imixs-Microservice project also includes a Docker Container to setup the workflow engine in a few minutes. See the Imixs-Microservice project for more information.

How to Build

Imixs-Workflow can be build with Maven. All artifacts are provided in the maven central repository.

This is an example how to add imixs-workflow into the dependencies of your own maven project:

<dependencies> 
   .....
	<!-- Imixs Workflow -->
	<dependency>
		<groupId>org.imixs.workflow</groupId>
		<artifactId>imixs-workflow-engine</artifactId>
		<version>${org.imixs.workflow.version}</version>
	</dependency>
	<dependency>
		<groupId>org.imixs.workflow</groupId>
		<artifactId>imixs-workflow-jax-rs</artifactId>
		<version>${org.imixs.workflow.version}</version>
	</dependency>
	<dependency>
		<groupId>org.imixs.workflow</groupId>
		<artifactId>imixs-workflow-faces</artifactId>
		<version>${org.imixs.workflow.version}</version>
	</dependency>
</dependencies>
...

To build form the source code run:

mvn install

Prerequisites:

  • JDK8+
  • Maven 3.0.3+
  • Java EE Application Server

The Sample Application

The Imixs-Workflow Sample Application demonstrates the Imixs-Workflow engine embedded into a simple JSF Web Application. The Sample Application can be used as a scaffold for custom projects.

Imixs-BPMN

Docker

The Imixs-Workflow engine is also available as a Docker Image running Imixs-Workflow as a microservice. Find out more on the Imixs-Microservice project.

Joining the Project

If you have any questions post them into the issue tracker. If you have a bug or an idea, browse the open issues before opening a new one. You can also take a look at the Open Source Guide.

License

Imixs-Workflow is free software, because we believe that an open exchange of experiences is fundamental for the development of valuable software. All results of this project are provided under the GNU General Public License.

Since in the typical use cases the Imixs-Workflow engine runs as a separate process, embedded into an application which is probably a separate work, we do not see any violation of the GPL. Feel free to ask for your concrete use case.