You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/site/markdown/modelling/index.md
+26-8Lines changed: 26 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,28 +21,46 @@ connected (with, e.g. Sequence Flows, Associations, Data Flows, etc.) by selecti
21
21
22
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
23
24
+
### Property Panel
25
+
26
+
On the bottom of the Drawing Canvas you have a property panel to edit the details of a BPMN element. To open the property panel you can double click an element or use the expand icon on the left side of the property panel header.
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".
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
41
36
-
##Examples
42
+
### The Pools
37
43
38
-
In the section ['How to model'](howto.html) you will find examples how you can model your business logic with Imixs-BPMN.
44
+
You can place BPMN elements directly on the Drawing Canvas or into a BPMN Pool element.
45
+
BPMN Pools are used to group different worklfow groups into one model.
39
46
40
-
## Support & Community
47
+
<imgsrc="../images/modelling/bpmn_pools.png"/>
41
48
42
-
Imixs-BPMN and Open-BPMN are open source projects. You will find further information about the project here:
49
+
### The Imixs Workflow Extension
43
50
44
-
-[Open-BPMN](https://www.open-bpmn.org/)
51
+
To adapt a Task or Event element to be processed by the Imixs-Workflow Engine you need to add the extension from the Tool Palette to a Task or Catch Event:
This will extend the corresponding BPMN element with additional Properties used by the Imixs Workflow engine during the processing cycle. An BPMN element which is not annotated with the Imixs-Workflow extension will be ignored during the processing life-cycle.
47
56
57
+
You can recognize the extension by the additional yellow border of the element and by the additional properties in the property panel.
| name | name | String | name of the task element |
19
+
| documentation | bpmn2:documentation| String | short description |
17
20
18
-
The _name_ of the Task element is used as an human readable status identifier.
19
-
The _name_ describes the status of a process instance within the process model (e.g. "open" or "approval" "closed").
21
+
The _name_ of the Task element is used as an human readable status identifier. It describes the status of a process instance within the process model (e.g. "New Open", "In Approval", "Completed",...).
20
22
21
-
**Note:** Inernally each Task Element in a BPMN model has an unambiguously identifier called the _ID_. The _ID_ is assigned to a running process instance to identify the status of a WorkItem controlled by the Workflow Engine.
23
+
The documentation can provide information how the task should be performed or which information need to be entered into a application.
22
24
23
-
### Documentation
25
+
##Workflow
24
26
25
-
The documentation of the Task element is used by the Imixs Workflow System to provide the user
26
-
with additional information about the task. Typically a documentation can provide information how the task should be performed or which information need to be entered into a application.
The Tab 'Workflow' provides identifiers and additional properties used by the Imixs Workflow System to uniquly identify a task by its ID within the current workflow and to provide the user with additional information about the task.
28
30
The documentation can also be created by assigning a TextAnnotation element to the task. In this case the documentation field of the Task should remain empty.
| id | Integer | unique task identifier within the model |
35
-
| name | String | name of the task element |
36
-
| documentation | String | short description |
40
+
### Process ID
37
41
38
-
## Workflow Properties
42
+
Every Imixs Task Element has an unambiguously identifier called the _TaskID_. The _TaskID_ is assigned to a running process instance to identify the status of a WorkItem controlled by the Imixs Workflow Engine.
39
43
40
-
The Tab 'Workflow' contains Processing Information of a Task element. These information will be
41
-
updated after a WorkItem was processed by the Workflow Engine.
44
+
**Note:** The task ID of each Task Element must be unique within one model.
The 'WorkItem Type' is a category assigned to the WorkItem by the Workflow Engine when the WorkItem was processed.
46
49
47
-
Every Imixs Task Element has an unambiguously identifier called the _TaskID_. The _TaskID_ is assigned to a running process instance to identify the status of a WorkItem controlled by the Imixs Workflow Engine.
50
+
### Symbol - Status Icon
51
+
52
+
A 'Status Icon' can be a Image URL to visualize the current status of a WorkItem.
48
53
49
54
### Workflow Summary
50
55
@@ -64,40 +69,26 @@ The Abstract is similar to the Workflow Summary and can also be dynamically comp
64
69
65
70
See the [Text Replacement feature](./textreplacement.html) how to insert WorkItem Values into a message text.
| application.editor | String | Form editor id to be assigned to a process instance |
81
+
| application.form | String | A form description (xml) |
77
82
78
83
### Input Form
79
84
80
85
The 'Input Form' can be used to control how a WorkItem in a specific status is displayed or how it can be edited inside the workflow application. This allows the model to control the behavior of the application in a specific way.
81
86
82
-
### Status Icon
83
-
84
-
A 'Status Icon' can be a Image URL to visualize the current status of a WorkItem.
85
-
86
-
### WorkItem Type
87
-
88
-
The 'WorkItem Type' is a category assigned to the WorkItem by the Workflow Engine when the WorkItem was processed.
Actors play an essential role within a human-centric workflow system.
103
94
In Imixs-Workflow the actors can be defined statically by adding user- or group IDs, or the ACL can be dynamically computed based on the properties of a process instance.
0 commit comments