|
3 | 3 |
|
4 | 4 | # The Imixs Process Manager |
5 | 5 |
|
6 | | - |
7 | 6 | The digitization of business processes has become a key challenge for modern application design. |
8 | 7 | Essentially, you only need two things to do this. |
9 | 8 |
|
10 | | - - a process description - which you ideally create using the BPMN 2.0 standard |
11 | | - - a runtime environment - which allows you to execute and persist your process instances in a secure way |
| 9 | +- a process description - which you ideally create using the BPMN 2.0 standard |
| 10 | +- a runtime environment - which allows you to execute and persist your process instances in a secure way |
12 | 11 |
|
13 | 12 | The Open Source project [Imixs-Workflow](http://www.imixs.org) provides you with an open and powerful workflow management platform that combines the design and the execution of business processes in a highly scalable and easy to use environment. |
14 | 13 |
|
15 | | -With the *Imixs Process Manager* you can start quickly and develop and test your own business process. And of course you can customize and extend this platform and use it for development as well as for production. |
16 | | - |
| 14 | +With the _Imixs Process Manager_ you can start quickly and develop and test your own business process. And of course you can customize and extend this platform and use it for development as well as for production. |
17 | 15 |
|
18 | 16 | ## How to Install |
19 | 17 |
|
20 | | -The *Imixs Process Manager* comes with a Docker profile which enables you to start within seconds. If you haven't already installed Docker, follow the instructions [here](https://docs.docker.com/get-docker/). |
| 18 | +The _Imixs Process Manager_ comes with a Docker profile which enables you to start within seconds. If you haven't already installed Docker, follow the instructions [here](https://docs.docker.com/get-docker/). |
21 | 19 |
|
22 | 20 | Download the [docker-compose.yml](https://raw.githubusercontent.com/imixs/imixs-process-manager/master/docker-compose.yml) file... |
23 | 21 |
|
24 | 22 | ```yaml |
25 | 23 | version: "3.6" |
26 | 24 | services: |
27 | | - |
28 | 25 | imixs-db: |
29 | 26 | image: postgres:9.6.1 |
30 | 27 | environment: |
31 | 28 | POSTGRES_PASSWORD: adminadmin |
32 | 29 | POSTGRES_DB: workflow-db |
33 | | - volumes: |
| 30 | + volumes: |
34 | 31 | - dbdata:/var/lib/postgresql/data |
35 | | - |
| 32 | + |
36 | 33 | imixs-app: |
37 | 34 | image: imixs/imixs-process-manager:latest |
38 | 35 | environment: |
39 | | - TZ: "CET" |
40 | | - LANG: "en_US.UTF-8" |
| 36 | + TZ: "CET" |
| 37 | + LANG: "en_US.UTF-8" |
41 | 38 | JAVA_OPTS: "-Dnashorn.args=--no-deprecation-warning" |
42 | 39 | POSTGRES_USER: "postgres" |
43 | 40 | POSTGRES_PASSWORD: "adminadmin" |
44 | 41 | POSTGRES_CONNECTION: "jdbc:postgresql://imixs-db/workflow-db" |
45 | 42 | ports: |
46 | 43 | - "8080:8080" |
47 | 44 | - "8787:8787" |
48 | | - - "9990:9990" |
| 45 | + - "9990:9990" |
49 | 46 | volumes: |
50 | 47 | dbdata: |
51 | 48 | ``` |
52 | 49 |
|
53 | 50 | ... and run |
54 | 51 |
|
55 | | - $ docker-compose up |
56 | | - |
57 | | -After a few seconds the Imixs Process Manager is up and running. You can access it from your web browser at: [http://localhost:8080/](http://localhost:8080/) |
| 52 | + $ docker-compose up |
58 | 53 |
|
| 54 | +After a few seconds the Imixs Process Manager is up and running. You can access it from your web browser at: [http://localhost:8080/](http://localhost:8080/) |
59 | 55 |
|
60 | 56 | <img src="./screen-002.png" /> |
61 | 57 |
|
62 | 58 | You can upload your own process model and create customized forms. You can view and search running process instances. |
63 | 59 |
|
64 | 60 | <img src="./screen-001.png" /> |
65 | 61 |
|
66 | | -
|
67 | | -
|
68 | | -
|
69 | | -
|
70 | 62 | ## Authentication and Authorization |
71 | 63 |
|
72 | | -Imixs-Workflow is a human-centric workflow engine which means that each actor need to authenticate against the service to interact. |
| 64 | +Imixs-Workflow is a human-centric workflow engine which means that each actor need to authenticate against the service to interact. |
73 | 65 |
|
74 | | -The default setup of the *Imixs Process Manager* provides a set of predefined users which can be used for testing purpose. The test users are stored in a separate user and roles properties files. See the following list of predefined test user accounts: |
| 66 | +The default setup of the _Imixs Process Manager_ provides a set of predefined users which can be used for testing purpose. The test users are stored in a separate user and roles properties files. See the following list of predefined test user accounts: |
75 | 67 |
|
76 | | -| User | Role | Password | |
77 | | -|---------|------------------------|----------| |
| 68 | +| User | Role | Password | |
| 69 | +| ------- | ---------------------- | ---------- | |
78 | 70 | | admin | IMIXS-WORKFLOW-Manager | adminadmin | |
79 | | -| alex | IMIXS-WORKFLOW-Manager | password | |
80 | | -| marty | IMIXS-WORKFLOW-Author | password | |
81 | | -| melman | IMIXS-WORKFLOW-Author | password | |
82 | | -| gloria | IMIXS-WORKFLOW-Author | password | |
83 | | -| skipper | IMIXS-WORKFLOW-Author | password | |
| 71 | +| alex | IMIXS-WORKFLOW-Manager | password | |
| 72 | +| marty | IMIXS-WORKFLOW-Author | password | |
| 73 | +| melman | IMIXS-WORKFLOW-Author | password | |
| 74 | +| gloria | IMIXS-WORKFLOW-Author | password | |
| 75 | +| skipper | IMIXS-WORKFLOW-Author | password | |
84 | 76 |
|
85 | 77 | You can add accounts or change the default account later, by updating the files "_sampleapp-roles.properties_" and "_sampleapp-users.properties_". You can also configure a different custom security realm (e.g. LDAP or Database). |
86 | 78 |
|
87 | 79 | You will find more information about the security concept in the [Imixs-Workflow Deployent guide](https://www.imixs.org/doc/deployment/index.html). |
88 | 80 |
|
89 | | -
|
90 | | -
|
91 | | - |
92 | | - |
93 | 81 | ## Process Design |
94 | 82 |
|
95 | | -You can define your own business process models using the [Imixs-BPMN modeller tool](https://www.imixs.org/doc/modelling/index.html) and you can upload and execute your models directly within Imixs Process Manager. General information about how to model can be found [here](https://www.imixs.org/doc/modelling/howto.html). |
| 83 | +You can define your own business process models using the [Imixs-BPMN modeller tool](https://www.imixs.org/doc/modelling/index.html) and you can upload and execute your models directly within Imixs Process Manager. General information about how to model can be found [here](https://www.imixs.org/doc/modelling/howto.html). |
96 | 84 |
|
97 | 85 | The Imixs Process Manager allows you to define custom forms for your business process without programming. By defining an XML template, you can store forms directly in a BPMN 2.0 model. |
98 | 86 |
|
99 | 87 | <img src="https://raw.githubusercontent.com/imixs/imixs-process-manager/master/src/main/webapp/pages/model-example.png" /> |
100 | 88 |
|
101 | 89 | Example: |
102 | 90 |
|
| 91 | +```xml |
103 | 92 | <?xml version="1.0"?> |
104 | 93 | <imixs-form> |
105 | 94 | <imixs-form-section label="Order"> |
106 | 95 | <item name="_orderid" type="text" label="Order ID:" /> |
107 | 96 | <item name="_orderdate" type="date" label="Order Date:" /> |
108 | 97 | </imixs-form-section> |
109 | 98 | </imixs-form> |
| 99 | +``` |
110 | 100 |
|
111 | 101 | You can create and change your models at runtime without interrupting your workflow instance. |
112 | 102 |
|
113 | | -
|
114 | | -
|
115 | 103 | ## Jakarta EE 10 |
116 | 104 |
|
117 | 105 | **Note:** Imixs-Workflow and the Imixs-Process-Manager are based on [Jakarta EE 10](https://jakarta.ee/). The project is currently developed based on [Wildfly version 27.0.0.Final](https://wildfly.org). |
118 | 106 |
|
119 | | -
|
120 | 107 | ## Build |
121 | 108 |
|
122 | 109 | To build the artifact from sources run: |
123 | 110 |
|
124 | | - $ mvn clean install |
125 | | - |
| 111 | + $ mvn clean install |
| 112 | + |
126 | 113 | To build the new Docker Image run: |
127 | 114 |
|
128 | | - $ mvn clean install -Pdocker |
129 | | - |
130 | | -To run Wildfly Server in debug mode (port 8787) you can build the Docker Image with: |
| 115 | + $ mvn clean install -Pdocker |
131 | 116 |
|
132 | | - $ mvn clean install -Pdebug |
133 | | - |
| 117 | +To run Wildfly Server in debug mode (port 8787) you can build the Docker Image with: |
134 | 118 |
|
| 119 | + $ mvn clean install -Pdebug |
135 | 120 |
|
136 | 121 | ### Run |
137 | 122 |
|
138 | 123 | To start the Imixs-Process Manger with docker-compose, run: |
139 | 124 |
|
140 | | - $ docker-compose -f docker-compose-dev.yaml up |
141 | | - |
| 125 | + $ docker-compose -f docker-compose-dev.yaml up |
142 | 126 |
|
143 | 127 | ## Autodeploy & Hot Deploy |
144 | 128 |
|
145 | | -We use the [Manik Hot-Deploy Plugin](https://manik.imixs.org/) to auto deploy the application during development. |
| 129 | +We use the [Manik Hot-Deploy Plugin](https://manik.imixs.org/) to auto deploy the application during development. |
146 | 130 | To update the deployment just run: |
147 | 131 |
|
148 | | - $ mvn install |
149 | | - |
| 132 | + $ mvn install |
| 133 | + |
150 | 134 | During development of Jakarta EE Faces you can run the autodeploy mode to update your Web Frontend autoamtically: |
151 | 135 |
|
152 | | - $ mvn manik-hotdeploy:hotdeploy |
| 136 | + $ mvn manik-hotdeploy:hotdeploy |
| 137 | + |
| 138 | +In this mode the Manik-Plugin will detect updates of the Web Frontend and updates your running applicaton. |
| 139 | + |
| 140 | +## Open Liberty |
| 141 | + |
| 142 | +To run the application on the Open Liberty Application Server with Docker run: |
| 143 | + |
| 144 | + $ mvn clean install -Pdocker-build-openliberty |
| 145 | + $ docker-compose -f docker-compose-openliberty.yml up |
| 146 | + |
| 147 | +The application running on OpenLiberty is available from: |
| 148 | + |
| 149 | + http://localhost:9080/ |
153 | 150 |
|
154 | | -In this mode the Manik-Plugin will detect updates of the Web Frontend and updates your running applicaton. |
| 151 | +You can find the configuration details of open liberty server in /src/docker/configuration/openliberty/ |
0 commit comments