Skip to content

Commit e0483aa

Browse files
rsoikarsoika
committed
docu
1 parent 2726fa4 commit e0483aa

5 files changed

Lines changed: 74 additions & 47 deletions

File tree

‎src/site/markdown/modelling/deployment.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# How to deploy a BPMN Model
22

3-
After you have created a model with the Imixs-BPMN modeler you can deploy the model. The Imixs-Workflow Rest API provides a convenient way to upload a BPMN model or to verify the deployment
4-
status of BPMN models. Make sure that your Imixs-Workflow instance is up and running and the Imxis-Workflow Rest Service is deployed on your server. (See the [deployment section](../deployment/index.html) how to deploy the Imixs-Workflow engine into a server.)
3+
After you have created a model with the Imixs-BPMN modeler you can deploy the model. You can deploy a Model using the [Imixs-Admin Client](../administration.html) or using the Imixs-Workflow Rest API to upload a BPMN model or to verify the deployment
4+
status of BPMN models. Make sure that your Imixs-Workflow instance is up and running and the Imixs-Workflow Rest Service is deployed on your server. (See the [deployment section](../deployment/index.html) how to deploy the Imixs-Workflow engine into a server.)
55

66
The Imixs-Workflow Model Rest Service is available under the following resource URL:
77

88
http://localhost:8080/api/model/
99

10-
where '/workflow/' is the context root of your workflow application and '/api/' is the
11-
context of the Imixs-Workflow Rest Services. See the [section model rest service](../restapi/modelservice.html) for general information about the Imixs-Workflow Rest API.
10+
See the [section model rest service](../restapi/modelservice.html) for general information about the Imixs-Workflow Rest API.
1211

1312
## Deploy a Model
1413

@@ -25,8 +24,7 @@ You can also verify the current status of deployed models by calling the model R
2524

2625
http://localhost:8080/api/model/
2726

28-
<img src="../images/modelling/bpmn_screen_28.png"/>
29-
27+
<img src="../images/modelling/bpmn_screen_28.png"/>
3028

3129
## Delete a model
3230

‎src/site/markdown/modelling/index.md‎

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,38 @@
11
# The Imixs-BPMN Modeler - User Guide
22

33
<p class="lead">
4-
Imixs-BPMN is a free modelling tool to create process models for the Imixs-Workflow framework. Imixs-BPMN takes the full advantage of all the capabilities from the BPMN standard and complements them with the requirements to a workflow management system. Imixs-BPMN is based on the Open Source project <a href="https://www.open-bpmn.org" target="_blank">Open-BPMN</a> and extends this framework with the aspects of a human-centric workflow model executable on the Imixs-Workflow Engine.
4+
<strong>Imixs-Workflow</strong> is based on the <strong>Business Process Model and Notation (BPMN 2.0)</strong>.
5+
You can create a BPMN Model with <strong>Imixs-BPMN</strong>, a free modelling tool. Imixs-BPMN takes the full advantage of all the capabilities from the BPMN standard and complements them with the requirements to a workflow management system. Imixs-BPMN is based on the Open Source project <a href="https://www.open-bpmn.org" target="_blank">Open-BPMN</a> and extends this framework with the aspects of a human-centric workflow model executable on the Imixs-Workflow Engine.
56
</p>
67

7-
To install Imixs-BPMN please see the [Installation Guide](./install.html). The section [Overview](./overview.html) provides general information about how you can use the Imixs-BPMN modelling tool.
8-
98
<img src="../images/modelling/open-bpmn_screen_01.png"/>
109

10+
To install Imixs-BPMN please see the [Installation Guide](./install.html).
11+
12+
## Overview
13+
14+
A BPMN Model can be created simply be creating a new file with the file extension `.bpmn`.
15+
As shown in the screenshot, Imixs-BPMN provides all of the BPMN features in a Tool Palette at the right side of the editor panel. The Drawing Canvas in the main area of the editor window is used to place the BPMN elements into the model.
16+
17+
BPMN elements can be placed on the canvas by selecting them from the Tool Palette and clicking anywhere on the canvas. Elements can be moved on the canvas and
18+
connected (with, e.g. Sequence Flows, Associations, Data Flows, etc.) by selecting a connection tool from the palette and then first clicking the source element.
19+
20+
### The Tool Palette
21+
22+
The Tool Palette is, by default, located along the right edge of the Drawing Canvas. It consists of several standard BPMN2 elements that can be dragged onto the Drawing Canvas. The Imixs-BPMN plug-in provides a separate section called "Imixs-Workflow". This category contains the extension which allows you to annotate a BPMN Task or a Catch Event. The extension can be dragged like any other BPMN element onto a Task or Catch Event.
23+
24+
### The Workflow-Task
25+
26+
<img src="../images/modelling/bpmn_screen_04.png"/>
27+
28+
The "Workflow-Task" is used to describe a Task inside a process model controlled by the Imixs-Workflow engine. The Task Element typically reflects a task to be processed by a participant during the process life-cycle of a process instance. A Imixs Workflow-Task contains a custom set of properties used to describe the status of a process instance. Read more about the Task Element in the [section Task Properties](process.html). The "Workflow-Task" Element is an extension to the BPMN 2.0 Element "Task".
29+
30+
### The Workflow-Event
31+
32+
<img src="../images/modelling/bpmn_screen_05.png"/>
33+
34+
The "Workflow-Event" is used to describe a transition from one Task into another. The Event Element contains a custom set of properties to be evaluated during the execution by the Imixs-Workflow engine. Read more about the Event Element in the [section Event Properties](activities.html). The "Workflow-Event" is an extension to the BPMN 2.0 Intermediate CatchEvent.
35+
1136
## Examples
1237

1338
In the section ['How to model'](howto.html) you will find examples how you can model your business logic with Imixs-BPMN.
@@ -20,4 +45,4 @@ Imixs-BPMN and Open-BPMN are open source projects. You will find further informa
2045

2146
- [GitHub](https://github.com/imixs/open-bpmn).
2247

23-
- [Disussion](https://github.com/imixs/open-bpmn/discussions)
48+
- [Discussion](https://github.com/imixs/open-bpmn/discussions)

‎src/site/markdown/modelling/overview-old.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Overview
2+
3+
<p class="lead">
4+
<strong>Imixs-BPMN</strong> is based on the <a href="https://www.open-bpmn.org/">Open BPMN Modeler</a>. A free and open modeling platform to view, create and maintain BPM models based on the BPMN 2.0 standard. Open BPMN can be used by business analysts to design a top level business process, as also by architects and developers to model the technical details of complex processing logic.
5+
6+
</p>
7+
8+
A Imixs-BPMN Model can be executed within the <strong>Imixs-Worklfow engine</strong>. It extends the BPMN2 metamodel and allows you to add Plug-In and Adapter Classes to control the process flow and the behavior of the Imixs-Workflow engine.
9+
10+
## General concepts
11+
12+
As shown in the screenshot below, Imixs-BPMN provides all of the BPMN features in a Tool Palette at the right side of the editor panel. The Drawing Canvas in the main area of the editor window is used to place the BPMN elements into the model.
13+
14+
<img src="../images/modelling/bpmn_screen_03.png"/>
15+
16+
BPMN elements can be placed on the canvas by selecting them from the Tool Palette and clicking anywhere on the canvas. Elements can be moved on the canvas and
17+
connected (with, e.g. Sequence Flows, Associations, Data Flows, etc.) by selecting a connection tool from the palette and then first clicking the source element.
18+
19+
## The Imixs-BPMN Tools
20+
21+
The Tool Palette is, by default, located along the right edge of the Drawing Canvas. It consists of several standard BPMN2 elements that can be dragged onto the Drawing Canvas. The Imixs-BPMN plug-in provides a separate section called "Imixs-Workflow". This category contains the "Imixs-Workflow Task" and the "Imixs-Workflow Event" Elements. Both elements are extensions to the BPMN Task and Event Elements defined by the BPMN 2.0 spec. The elements can be dragged like any other BPMN element onto the canvas to describe a workflow to be executable inside the Imixs-Workflow engine.
22+
23+
### The Workflow-Task
24+
25+
<img src="../images/modelling/bpmn_screen_04.png"/>
26+
27+
The "Workflow-Task" is used to describe a Task inside a process model controlled by the Imixs-Workflow engine. The Task Element typically reflects a task to be processed by a participant during the process life-cycle of a process instance. A Imixs Workflow-Task contains a custom set of properties used to describe the status of a process instance. Read more about the Task Element in the [section Task Properties](process.html). The "Workflow-Task" Element is an extension to the BPMN 2.0 Element "Task".
28+
29+
### The Workflow-Event
30+
31+
<img src="../images/modelling/bpmn_screen_05.png"/>
32+
33+
The "Workflow-Event" is used to describe a transition from one Task into another. The Event Element contains a custom set of properties to be evaluated during the execution by the Imixs-Workflow engine. Read more about the Event Element in the [section Event Properties](activities.html). The "Workflow-Event" is an extension to the BPMN 2.0 Intermediate CatchEvent.

‎src/site/markdown/modelling/overview.md‎

Lines changed: 6 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,6 @@
1-
# Overview
2-
3-
<p class="lead">
4-
<strong>Imixs-BPMN</strong> is based on the <a href="https://www.open-bpmn.org/">Open BPMN Modeler</a>. A free and open modeling platform to view, create and maintain BPM models based on the BPMN 2.0 standard. Open BPMN can be used by business analysts to design a top level business process, as also by architects and developers to model the technical details of complex processing logic.
5-
6-
</p>
7-
8-
A Imixs-BPMN Model can be executed within the <strong>Imixs-Worklfow engine</strong>. It extends the BPMN2 metamodel and allows you to add Plug-In and Adapter Classes to control the process flow and the behavior of the Imixs-Workflow engine.
9-
10-
## General concepts
11-
12-
As shown in the screenshot below, Imixs-BPMN provides all of the BPMN features in a Tool Palette at the right side of the editor panel. The Drawing Canvas in the main area of the editor window is used to place the BPMN elements into the model.
13-
14-
<img src="../images/modelling/bpmn_screen_03.png"/>
15-
16-
BPMN elements can be placed on the canvas by selecting them from the Tool Palette and clicking anywhere on the canvas. Elements can be moved on the canvas and
17-
connected (with, e.g. Sequence Flows, Associations, Data Flows, etc.) by selecting a connection tool from the palette and then first clicking the source element.
18-
19-
## The Imixs-BPMN Tools
20-
21-
The Tool Palette is, by default, located along the right edge of the Drawing Canvas. It consists of several standard BPMN2 elements that can be dragged onto the Drawing Canvas. The Imixs-BPMN plug-in provides a separate section called "Imixs-Workflow". This category contains the "Imixs-Workflow Task" and the "Imixs-Workflow Event" Elements. Both elements are extensions to the BPMN Task and Event Elements defined by the BPMN 2.0 spec. The elements can be dragged like any other BPMN element onto the canvas to describe a workflow to be executable inside the Imixs-Workflow engine.
22-
23-
### The Workflow-Task
24-
25-
<img src="../images/modelling/bpmn_screen_04.png"/>
26-
27-
The "Workflow-Task" is used to describe a Task inside a process model controlled by the Imixs-Workflow engine. The Task Element typically reflects a task to be processed by a participant during the process life-cycle of a process instance. A Imixs Workflow-Task contains a custom set of properties used to describe the status of a process instance. Read more about the Task Element in the [section Task Properties](process.html). The "Workflow-Task" Element is an extension to the BPMN 2.0 Element "Task".
28-
29-
### The Workflow-Event
30-
31-
<img src="../images/modelling/bpmn_screen_05.png"/>
32-
33-
The "Workflow-Event" is used to describe a transition from one Task into another. The Event Element contains a custom set of properties to be evaluated during the execution by the Imixs-Workflow engine. Read more about the Event Element in the [section Event Properties](activities.html). The "Workflow-Event" is an extension to the BPMN 2.0 Intermediate CatchEvent.
1+
<head>
2+
<link rel="canonical" href="https://www.imixs.org/doc/modelling/index.html" />
3+
<script>
4+
window.location.replace("https://www.imixs.org/doc/modelling/index.html");
5+
</script>
6+
</head>

‎src/site/site.xml‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,14 @@
2121
</item>
2222

2323
<item name="BPMN 2.0" href="modelling/index.html" collapse="true">
24-
<item name="Overview" href="modelling/overview.html" />
2524
<item name="Installation" href="modelling/install.html" />
26-
<item name="Eclipse Workbench" href="modelling/eclipse_workbench.html" />
27-
<item name="Creating a Model" href="modelling/create_model.html" />
25+
<item name="The Workbench" href="modelling/eclipse_workbench.html" />
26+
2827
<item name="Process Properties" href="modelling/main_editor.html" />
2928
<item name="Task Element" href="modelling/process.html" />
3029
<item name="Event Element" href="modelling/activities.html" />
3130
<item name="Text Replacement" href="modelling/textreplacement.html" />
3231
<item name="Data Objects" href="modelling/dataobject.html" />
33-
<item name="Reports" href="modelling/report_plugin.html" />
3432
<item name="Deployment" href="modelling/deployment.html" />
3533

3634
</item>

0 commit comments

Comments
 (0)
⚡