Skip to content

Commit 87a3baf

Browse files
committed
cleanup readme and add some more screenshots
1 parent 68e19d0 commit 87a3baf

File tree

7 files changed

+36
-24
lines changed

7 files changed

+36
-24
lines changed

README.md

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,52 @@
22

33
Provides client-side and server-side integration for using Camunda Embedded Forms with Formio Forms.
44

5-
Using Formio for a Start Form:
5+
![](./doc/FormBuild1.png)
6+
7+
![](./doc/StartForm1.png)
8+
9+
![](./doc/UT1.png)
10+
11+
![](./doc/UT1.1.png)
12+
13+
![](./doc/UT1.2.png)
14+
15+
## What does it do?
16+
17+
Allows you to configure *start-event* forms and *user-task* forms with a `formkey` that will load formio forms in Camunda Tasklist webapp.
18+
19+
20+
## How do I set it up?!
21+
22+
Configuring Formio for a Start Form:
623

724
![Start Form](./doc/StartForm-Config.png)
825

926

10-
Using Formio for User Tasks:
27+
Configuring Formio for User Tasks:
1128

1229
![User Task Form](./doc/UserTask-Config.png)
1330

1431
If you want to add server side validation, you add a Validation Constraint with the name `formio`. See the Server Validation
1532
section for more details.
1633

1734

18-
## What does it do?
35+
## Installation
1936

20-
Allows you to configure *start-event* forms and *user-task* forms with a `formkey` that will load formio forms in Camunda Tasklist webapp.
37+
### Camunda SpringBoot Deployment
38+
39+
See the `springboot` folder for a example of the deployment
40+
41+
### Typical Camunda Deployment
42+
43+
See the `docker` folder for an example of the deployment using the Camunda Tomcat distribution
44+
45+
46+
## Building Forms:
47+
48+
Local Builder: Deploy Webapp and access a local builder at: `http://..../forms/builder.html`
49+
50+
Hosted Builder: [https://formio.github.io/formio.js/app/builder](https://formio.github.io/formio.js/app/builder)
2151

2252

2353
## Configure the BPMN
@@ -84,17 +114,6 @@ Examples:
84114
1. `embedded:/forms/formio.html?path=/forms/MyStartForm.json` (where the MyStartForm.json was placed in the `src/main/webapp/forms` folder)
85115

86116

87-
## Installation
88-
89-
### Camunda SpringBoot Deployment
90-
91-
See the `springboot` folder for a example of the deployment
92-
93-
### Typical Camunda Deployment
94-
95-
See the `docker` folder for an example of the deployment using the Camunda Tomcat distribution
96-
97-
98117
## Submission Storage
99118

100119
When a successful submission occurs, a `json` variable will be created as a Process Instance Variable.
@@ -110,13 +129,6 @@ Very often the taskID (which is typically a UUID) will not be very meaningful.
110129
consider using the `var` parameter to set a custom variable name or use the Activity ID (the `id` property when you are in the Modeler on a user task activity).
111130

112131

113-
## Building Forms:
114-
115-
Local Builder: Deploy Webapp and access a local builder at: `http://..../forms/builder.html`
116-
117-
Hosted Builder: [https://formio.github.io/formio.js/app/builder](https://formio.github.io/formio.js/app/builder)
118-
119-
120132
## Trigger 'BPMN Errors'
121133

122134
Support is provided to trigger interrupting BPMN Errors:
@@ -158,7 +170,6 @@ The suffix is used to ensure if/when the user task is normally completed, the su
158170
user task completion does not overwrite the submission variable created through escalation.
159171

160172

161-
162173
## Deploying your Forms
163174

164175
### REST API Form Deployment

bpmn/MyUT1.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"display": "form",
33
"components": [
44
{
5+
"title": "Submission (Read-only)",
56
"collapsible": false,
67
"key": "panel",
78
"type": "panel",
@@ -10,7 +11,7 @@
1011
"tableView": false,
1112
"components": [
1213
{
13-
"label": "Submission (Read-Only)",
14+
"label": "Submission",
1415
"disabled": true,
1516
"tableView": false,
1617
"key": "previousSubmission",

doc/FormBuild1.png

251 KB
Loading

doc/StartForm1.png

249 KB
Loading

doc/UT1.1.png

323 KB
Loading

doc/UT1.2.png

294 KB
Loading

doc/UT1.png

318 KB
Loading

0 commit comments

Comments
 (0)