Skip to content
Branch: master
Go to file
Code

README.md

Imixs-Workflow

Build Status Codacy Badge CII Best Practices Join the chat at https://gitter.im/imixs/imixs-workflow License

Imixs-Workflow is an open source workflow engine to build human-centric workflow applications on a flexible and robust framework. Using the Business Process Modelling Notation - BPMN 2.0, business logic can be modeled fast, easy and in a flexible way. Imixs-Workflow is based on the Jarkarta EE and the Eclipse Microprofile standards and fits into any modern microservice architecture thanks to its openness. Imixs-Workflow runs on all modern application servers like Wildfly, Payara, Open Liberty or Apache TomEE.

To follow us, 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. 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. See the following example how to add imixs-workflow to your own maven project:

<dependencies> 
   .....
	<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-index-lucene</artifactId>
		<version>${org.imixs.workflow.version}</version>
	</dependency>
...

To build Imixs-Workflow form the source code run:

mvn install

Prerequisites:

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

Imixs-Admin

The Imixs-Admin project provides a web based tool to administrate an Imixs-Workflow instance remotely.

Imixs-Admin

The Imixs Process Manager

The Imixs Process Manger allows you to start within seconds. The integrated Business Process Management Suite can be used for development, testing and productive environments. It provides you with a generic user interface which can be easily adapted.

Imixs-BPMN


The Imixs Process Manager comes with a Docker image that can be deployed locally or in a containerized environment like Docker Swarm or Kubernetes. Download the docker-compose.yml file and run:

$ docker-compose up

Microservice

The Imixs-Microservice project provides a full service stack for a microservice architecture running on Kubernetes or Docker-Swarm. Find out more on Docker hub.

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.

You can’t perform that action at this time.