Skip to content

Commit 2726fa4

Browse files
rsoikarsoika
committed
update documentation
1 parent a120aef commit 2726fa4

File tree

14 files changed

+500
-486
lines changed

14 files changed

+500
-486
lines changed

‎src/site/markdown/index.md‎

Lines changed: 71 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,76 @@
1-
# How Imixs-Workflow Works
2-
3-
Imixs-Workflow is an open source BPMN workflow engine built on the [Jakarta EE architecture](https://jakarta.ee/). The engine is optimized for human-centric business process management, providing essential features for professional process management:
4-
5-
- Model and control business processes with BPMN 2.0
6-
- Enforce compliance rules and guidelines
7-
- Secure business data management
8-
9-
In this way, Imixs-Workflow improves your business processes and supports human activities in a task-centric and event-driven way.
10-
11-
## BPMN 2.0
12-
13-
Imixs-Workflow allows you to execute **BPMN 2.0** models. This standardized approach allows you to change your business logic without touching a single line of code.
14-
15-
<img src="./images/bpmn-example01.png" />
16-
17-
Learn how to design your own business processes in the section "[How to Model with Imixs-BPMN](./modelling/howto.html)". To install Imixs-BPMN see the [installation guide](./modelling/install.html).
18-
19-
## How to Get Started
20-
21-
The fastest way to get started is our [Quickstart Guide](quickstart.html), which shows you different approaches to integrate Imixs-Workflow into your project.
22-
23-
### Jakarta EE Integration
24-
25-
Imixs-Workflow is built on the Jakarta EE standard, allowing you to integrate the workflow engine directly into your business application. Simply add the following Maven dependencies:
26-
27-
```xml
28-
<dependency>
29-
<groupId>org.imixs.workflow</groupId>
30-
<artifactId>imixs-workflow-engine</artifactId>
31-
<version>${org.imixs.workflow.version}</version>
32-
</dependency>
33-
<dependency>
34-
<groupId>org.imixs.workflow</groupId>
35-
<artifactId>imixs-workflow-index-lucene</artifactId>
36-
<version>${org.imixs.workflow.version}</version>
37-
</dependency>
38-
<dependency>
39-
<groupId>org.imixs.workflow</groupId>
40-
<artifactId>imixs-workflow-jax-rs</artifactId>
41-
<version>${org.imixs.workflow.version}</version>
42-
</dependency>
43-
```
44-
45-
This embedded mode gives you full access to the workflow engine API by injecting the [workflow engine](./engine/index.html) as a service component.
46-
47-
```java
48-
@Inject
49-
WorkflowService workflowService;
50-
...
51-
ItemCollection workitem=new ItemCollection().model("1.0.0").task(100).event(10);
52-
workitem=workflowService.processWorkItem(workitem);
53-
```
54-
55-
You can extend the functionality through the [Imixs-Workflow Plugin API](engine/plugins/index.html).
56-
57-
Alternatively you can start with the [Imixs Process Manager](https://github.com/imixs/imixs-process-manager) as a Jakarta EE template for your own application. The Process Manager can be deployed within seconds using Docker.
58-
59-
See also the [Deployment Guide](./deployment/deployment_guide.html) for information how to deploy the Imixs-Workflow engine on an application server.
60-
61-
<h3>Microservice Architecture <img src="./images/docker_small_h-trans.png" height="40" style="vertical-align: middle; position: relative; top: -4px" /></h3>
62-
63-
Alternatively, you can run Imixs-Workflow as a standalone microservice in your architecture. This approach allows you to interact with the workflow engine through its [REST API](restapi/index.html), making it completely language-independent. The workflow engine is managing your business processes while being accessible from any programming language or platform.
64-
65-
Start with the [Imixs-Microservice Project](https://github.com/imixs/imixs-microservice) on GitHub, which provides full Docker support for quick deployment and scaling.
66-
67-
### Web Development with Imixs-Forms
68-
69-
For web developers, [Imixs-Forms](./webforms/index.html) offers an alternative integration approach. This lightweight JavaScript framework allows you to build workflow-enabled web applications on top of the Imixs-Workflow engine. Simply integrate the framework into your web project and start building workflow-driven forms while the robust Java backend handles all workflow operations.
70-
71-
Find out more about Imixs-Forms in our [Quickstart Guide](quickstart.html).
1+
# Welcome to Imixs-Workflow
2+
3+
<p class="lead">
4+
Whether you are building modern <strong>Cloud-Native Microservices</strong> or integrating into a robust <strong>Jakarta EE environment</strong>, you are always working with the same powerful core engine. This unified approach allows you to execute your BPMN models anywhere—from a standalone service to a ready-made suite like <a href="https://doc.office-workflow.com/">Imixs-Office-Workflow</a>. Start with the architecture that fits your current project and remain flexible to switch or combine environments later without ever losing your process logic.
5+
</p>
6+
Choose your preferred path to get started:
7+
8+
<div class="feature-boxes">
9+
<div class="feature-box">
10+
<h3>Open BPMN Modeler</h3>
11+
<div class="audience">For Business Analysts</div>
12+
<p>
13+
Start designing your business processes visually with <a href="https://www.open-bpmn.org" target="_blank">Open-BPMN</a>. This modern BPMN 2.0 modeler integrates seamlessly into VS-Code or runs directly in your browser. No technical knowledge required.
14+
</p>
15+
<a href="./modelling/index.html">Learn more →</a>
16+
</div>
17+
<div class="feature-box">
18+
<h3>Imixs-Forms</h3>
19+
<div class="audience">For Web Developers</div>
20+
<p>Build workflow-enabled web applications in minutes using <a href="https://github.com/imixs/imixs-forms" target="_blank">Imixs-Forms</a>.
21+
The JavaScript framework provides ready-to-use components and follows a low-code approach. Perfect for modern web applications.
22+
</p>
23+
<a href="./webforms/index.html">Learn more →</a>
24+
</div>
25+
<div class="feature-box">
26+
<h3>Microservice Architecture</h3>
27+
<div class="audience">For API-First Developers</div>
28+
<p>Integrate Imixs-Workflow into any application using the comprehensive REST API. Language-independent, containerized, and ready for your microservice architecture. Full flexibility with minimal setup.</p>
29+
<a href="../sub_microservice.html">Learn more →</a>
30+
</div>
31+
<div class="feature-box">
32+
<h3>Jakarta EE Integration</h3>
33+
<div class="audience">For Enterprise Developers</div>
34+
<p>Embed Imixs-Workflow directly into your Jakarta EE applications. Take advantage of enterprise-grade features including transaction management, security integration, and scalability options.</p>
35+
<a href="../sub_jee.html">Learn more →</a>
36+
</div>
37+
<div class="feature-box">
38+
<h3>Imixs-Micro</h3>
39+
<div class="audience">For IoT Developers</div>
40+
<p>Run workflows on embedded devices with <a href="https://github.com/imixs/imixs-micro" target="_blank">Imixs-Micro</a>. The lightweight engine is optimized for IoT environments and industrial automation. Perfect for edge computing and distributed systems.
41+
</p>
42+
<a href="https://github.com/imixs/imixs-micro">Learn more →</a>
43+
</div>
44+
<div class="feature-box">
45+
<h3>Imixs-Office-Workflow</h3>
46+
<div class="audience">For Small and Medium Businesses</div>
47+
<p>
48+
Built on top of the Imixs-Workflow core engine, <a href="https://www.office-workflow.com" target="_blank">Imixs-Office-Workflow</a> is a ready-to-use BPM suite with organization management, task management and document features. Get productive immediately — no Java development required.</p>
49+
<a href="https://www.office-workflow.com">Learn more →</a>
50+
</div>
51+
</div>
52+
53+
## Event-Based Process Modeling
54+
55+
Let's look at a simple order process to understand how business processes are modeled using the event-based approach of Imixs-Workflow:
56+
57+
<img src="./images/modelling/order-01.png" />
58+
59+
This BPMN diagram demonstrates how Imixs-Workflow uses an event-based approach to model a business process. While the blue boxes (Tasks) represent different status within the process, the yellow symbols (Events) define how to transition from one status to another.
60+
For example, when a new order is received, it starts in the status "New Order". Through the "Submit" event, the order transitions into the "Prepare for shipment" status. This event-based approach gives you more flexibility in modeling your business logic, as you can:
61+
62+
- Define multiple events for a single task
63+
- Add business rules and conditions to events
64+
- Trigger automatic actions during status transitions
65+
- Model complex approval workflows
66+
67+
The event-based approach of Imixs-Workflow makes it easy to adapt your process to real-world business scenarios where status changes often involve complex decision making and parallel activities.
7268

7369
## What's Next...
7470

7571
Get started now and read more about:
7672

77-
- [The Quickstart Guide](quickstart.html)
73+
- [How to get Started with Imixs Workflow](./tutorials/tutorial-01.html)
7874
- [How to Model with Imixs-BPMN](./modelling/howto.html)
7975
- [How to Manage your Business Data](./quickstart/workitem.html)
8076
- [Why You Should Use Imixs-Workflow](./quickstart/why.html)
@@ -86,4 +82,6 @@ Get started now and read more about:
8682
## Need Help?
8783

8884
If you have any questions about the Imixs-Workflow project or how you can best integrate Imixs-Workflow in your own project,
89-
[join the Imixs Community](https://www.imixs.org/sub_community.html).
85+
Join our [Community Forum](https://github.com/imixs/imixs-workflow/discussions) for support.
86+
You will also find useful information on our [Imixs Community page](https://www.imixs.org/sub_community.html).
87+
And you can check out our [Java Docs](./apidocs/index.html) for detailed information.

‎src/site/markdown/index_old.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# How Imixs-Workflow Works
2+
3+
Imixs-Workflow is an open source BPMN workflow engine built on the [Jakarta EE architecture](https://jakarta.ee/). The engine is optimized for human-centric business process management, providing essential features for professional process management:
4+
5+
- Model and control business processes with BPMN 2.0
6+
- Enforce compliance rules and guidelines
7+
- Secure business data management
8+
9+
In this way, Imixs-Workflow improves your business processes and supports human activities in a task-centric and event-driven way.
10+
11+
## BPMN 2.0
12+
13+
Imixs-Workflow allows you to execute **BPMN 2.0** models. This standardized approach allows you to change your business logic without touching a single line of code.
14+
15+
<img src="./images/bpmn-example01.png" />
16+
17+
Learn how to design your own business processes in the section "[How to Model with Imixs-BPMN](./modelling/howto.html)". To install Imixs-BPMN see the [installation guide](./modelling/install.html).
18+
19+
## How to Get Started
20+
21+
The fastest way to get started is our [Quickstart Guide](quickstart.html), which shows you different approaches to integrate Imixs-Workflow into your project.
22+
23+
### Jakarta EE Integration
24+
25+
Imixs-Workflow is built on the Jakarta EE standard, allowing you to integrate the workflow engine directly into your business application. Simply add the following Maven dependencies:
26+
27+
```xml
28+
<dependency>
29+
<groupId>org.imixs.workflow</groupId>
30+
<artifactId>imixs-workflow-engine</artifactId>
31+
<version>${org.imixs.workflow.version}</version>
32+
</dependency>
33+
<dependency>
34+
<groupId>org.imixs.workflow</groupId>
35+
<artifactId>imixs-workflow-index-lucene</artifactId>
36+
<version>${org.imixs.workflow.version}</version>
37+
</dependency>
38+
<dependency>
39+
<groupId>org.imixs.workflow</groupId>
40+
<artifactId>imixs-workflow-jax-rs</artifactId>
41+
<version>${org.imixs.workflow.version}</version>
42+
</dependency>
43+
```
44+
45+
This embedded mode gives you full access to the workflow engine API by injecting the [workflow engine](./engine/index.html) as a service component.
46+
47+
```java
48+
@Inject
49+
WorkflowService workflowService;
50+
...
51+
ItemCollection workitem=new ItemCollection().model("1.0.0").task(100).event(10);
52+
workitem=workflowService.processWorkItem(workitem);
53+
```
54+
55+
You can extend the functionality through the [Imixs-Workflow Plugin API](engine/plugins/index.html).
56+
57+
Alternatively you can start with the [Imixs Process Manager](https://github.com/imixs/imixs-process-manager) as a Jakarta EE template for your own application. The Process Manager can be deployed within seconds using Docker.
58+
59+
See also the [Deployment Guide](./deployment/deployment_guide.html) for information how to deploy the Imixs-Workflow engine on an application server.
60+
61+
<h3>Microservice Architecture <img src="./images/docker_small_h-trans.png" height="40" style="vertical-align: middle; position: relative; top: -4px" /></h3>
62+
63+
Alternatively, you can run Imixs-Workflow as a standalone microservice in your architecture. This approach allows you to interact with the workflow engine through its [REST API](restapi/index.html), making it completely language-independent. The workflow engine is managing your business processes while being accessible from any programming language or platform.
64+
65+
Start with the [Imixs-Microservice Project](https://github.com/imixs/imixs-microservice) on GitHub, which provides full Docker support for quick deployment and scaling.
66+
67+
### Web Development with Imixs-Forms
68+
69+
For web developers, [Imixs-Forms](./webforms/index.html) offers an alternative integration approach. This lightweight JavaScript framework allows you to build workflow-enabled web applications on top of the Imixs-Workflow engine. Simply integrate the framework into your web project and start building workflow-driven forms while the robust Java backend handles all workflow operations.
70+
71+
Find out more about Imixs-Forms in our [Quickstart Guide](quickstart.html).
72+
73+
## What's Next...
74+
75+
Get started now and read more about:
76+
77+
- [The Quickstart Guide](quickstart.html)
78+
- [How to Model with Imixs-BPMN](./modelling/howto.html)
79+
- [How to Manage your Business Data](./quickstart/workitem.html)
80+
- [Why You Should Use Imixs-Workflow](./quickstart/why.html)
81+
- [What Means Human Centric Workflow?](./quickstart/human.html)
82+
- [Imixs-BPMN - The Modeler User Guide](./modelling/index.html)
83+
- [The Imixs-Workflow Plugin API](./engine/plugins/index.html)
84+
- [The Imixs-Workflow Rest API](./restapi/index.html)
85+
86+
## Need Help?
87+
88+
If you have any questions about the Imixs-Workflow project or how you can best integrate Imixs-Workflow in your own project,
89+
[join the Imixs Community](https://www.imixs.org/sub_community.html).

0 commit comments

Comments
 (0)