Skip to content

Commit cf263c7

Browse files
committed
add some additional wording for use of "path="
1 parent ee63099 commit cf263c7

File tree

3 files changed

+120
-88
lines changed

3 files changed

+120
-88
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,15 +103,15 @@ The following are the parameters that can be passed in the `formKey`:
103103
| Parameter | Required? | Default | Description |
104104
|---------------|-------------------|--------------|-----------------------|
105105
|deployment= | Yes or use path= | - | The .json file name in the deployment created through the API. |
106-
|path= | Yes or use deployment= | - | The file system path to the .json file. |
106+
|path= | Yes or use deployment= | - | The file system path to the .json file. **Must start with a `/`** |
107107
|transient= | No | false | If true, then variable will be submitted as Transient, and thus not saved to database. Use a Script Task or listener in the transaction to post-process the submission into the desired variable. |
108108
|var= | No | if start form then "startForm_submission", if user task then "`[taskId]`_submission"| Define a custom variable name for the form submission. Will be submitted as a Process Variable.|
109109

110110
Examples:
111111

112112
1. `embedded:/forms/formio.html?deployment=MyUT1.json?transient=true&var=myCustomSubmission`
113113
1. `embedded:/forms/formio.html?deployment=MyUT1.json?var=UT1-Submission`
114-
1. `embedded:/forms/formio.html?path=/forms/MyStartForm.json` (where the MyStartForm.json was placed in the `src/main/webapp/forms` folder)
114+
1. `embedded:/forms/formio.html?path=/forms/MyStartForm.json` (where the MyStartForm.json was placed in the `src/main/webapp/forms` folder. **Make sure your path starts with a `/`**)
115115

116116

117117
## Submission Storage

bpmn/SomeProcess1.bpmn

Lines changed: 111 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ execution.setVariable('postProcessed_submission', execution.getVariable('submiss
8080
<bpmn:outgoing>Flow_0069xxd</bpmn:outgoing>
8181
<bpmn:outgoing>Flow_0vjjadb</bpmn:outgoing>
8282
<bpmn:outgoing>Flow_1fnta01</bpmn:outgoing>
83+
<bpmn:outgoing>Flow_1623iq8</bpmn:outgoing>
8384
</bpmn:parallelGateway>
8485
<bpmn:userTask id="Activity_17hmd5d" name="No Persist Field Example" camunda:formKey="embedded:/forms/formio.html?deployment=NoPersistFieldExample.json&#38;var=noPersitSubmission">
8586
<bpmn:incoming>Flow_1fnta01</bpmn:incoming>
@@ -133,6 +134,15 @@ execution.setVariable('postProcessed_submission', execution.getVariable('submiss
133134
<bpmn:incoming>Flow_1ius0d1</bpmn:incoming>
134135
</bpmn:endEvent>
135136
<bpmn:sequenceFlow id="Flow_1ius0d1" sourceRef="Activity_1hmibg0" targetRef="Event_0fjx7tf" />
137+
<bpmn:sequenceFlow id="Flow_1623iq8" sourceRef="Gateway_0u22n92" targetRef="Activity_0ngrvxl" />
138+
<bpmn:endEvent id="Event_0qnw1pi">
139+
<bpmn:incoming>Flow_0dsu483</bpmn:incoming>
140+
</bpmn:endEvent>
141+
<bpmn:sequenceFlow id="Flow_0dsu483" sourceRef="Activity_0ngrvxl" targetRef="Event_0qnw1pi" />
142+
<bpmn:userTask id="Activity_0ngrvxl" name="Typical Form with Server Validation (path loaded)" camunda:formKey="embedded:/forms/formio.html?path=/forms/MyUT1.json&#38;var=subWithServerValidationPathLoaded">
143+
<bpmn:incoming>Flow_1623iq8</bpmn:incoming>
144+
<bpmn:outgoing>Flow_0dsu483</bpmn:outgoing>
145+
</bpmn:userTask>
136146
<bpmn:textAnnotation id="TextAnnotation_19wn5bt">
137147
<bpmn:text>Required in 7.13 due to bug that does not allow listeners on start event access variables</bpmn:text>
138148
</bpmn:textAnnotation>
@@ -146,185 +156,200 @@ execution.setVariable('postProcessed_submission', execution.getVariable('submiss
146156
<bpmn:escalation id="Escalation_07acmmp" name="custom-escalation" escalationCode="ce1" />
147157
<bpmndi:BPMNDiagram id="BPMNDiagram_1">
148158
<bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="someProcess1">
159+
<bpmndi:BPMNShape id="TextAnnotation_19wn5bt_di" bpmnElement="TextAnnotation_19wn5bt">
160+
<dc:Bounds x="210" y="450" width="140" height="82" />
161+
</bpmndi:BPMNShape>
162+
<bpmndi:BPMNEdge id="Flow_1ius0d1_di" bpmnElement="Flow_1ius0d1">
163+
<di:waypoint x="760" y="630" />
164+
<di:waypoint x="812" y="630" />
165+
</bpmndi:BPMNEdge>
166+
<bpmndi:BPMNEdge id="Flow_0chzapv_di" bpmnElement="Flow_0chzapv">
167+
<di:waypoint x="590" y="692" />
168+
<di:waypoint x="590" y="630" />
169+
<di:waypoint x="660" y="630" />
170+
</bpmndi:BPMNEdge>
149171
<bpmndi:BPMNEdge id="Flow_0bpdigz_di" bpmnElement="Flow_0bpdigz">
150-
<di:waypoint x="760" y="730" />
151-
<di:waypoint x="812" y="730" />
172+
<di:waypoint x="760" y="870" />
173+
<di:waypoint x="812" y="870" />
152174
</bpmndi:BPMNEdge>
153175
<bpmndi:BPMNEdge id="Flow_1pbq7gx_di" bpmnElement="Flow_1pbq7gx">
154-
<di:waypoint x="540" y="800" />
155-
<di:waypoint x="592" y="800" />
176+
<di:waypoint x="540" y="940" />
177+
<di:waypoint x="592" y="940" />
156178
</bpmndi:BPMNEdge>
157179
<bpmndi:BPMNEdge id="Flow_1oiyaed_di" bpmnElement="Flow_1oiyaed">
158-
<di:waypoint x="590" y="668" />
159-
<di:waypoint x="590" y="730" />
160-
<di:waypoint x="660" y="730" />
180+
<di:waypoint x="590" y="808" />
181+
<di:waypoint x="590" y="870" />
182+
<di:waypoint x="660" y="870" />
161183
</bpmndi:BPMNEdge>
162184
<bpmndi:BPMNEdge id="Flow_0tm9nf2_di" bpmnElement="Flow_0tm9nf2">
163-
<di:waypoint x="490" y="668" />
164-
<di:waypoint x="490" y="760" />
185+
<di:waypoint x="490" y="808" />
186+
<di:waypoint x="490" y="900" />
165187
</bpmndi:BPMNEdge>
166188
<bpmndi:BPMNEdge id="Flow_0x38wt9_di" bpmnElement="Flow_0x38wt9">
167-
<di:waypoint x="740" y="390" />
168-
<di:waypoint x="822" y="390" />
189+
<di:waypoint x="740" y="530" />
190+
<di:waypoint x="822" y="530" />
169191
</bpmndi:BPMNEdge>
170192
<bpmndi:BPMNEdge id="Flow_1b6gdbh_di" bpmnElement="Flow_1b6gdbh">
171-
<di:waypoint x="590" y="390" />
172-
<di:waypoint x="640" y="390" />
193+
<di:waypoint x="590" y="530" />
194+
<di:waypoint x="640" y="530" />
173195
</bpmndi:BPMNEdge>
174196
<bpmndi:BPMNEdge id="Flow_1fnta01_di" bpmnElement="Flow_1fnta01">
175-
<di:waypoint x="440" y="455" />
176-
<di:waypoint x="440" y="390" />
177-
<di:waypoint x="490" y="390" />
197+
<di:waypoint x="440" y="595" />
198+
<di:waypoint x="440" y="530" />
199+
<di:waypoint x="490" y="530" />
178200
</bpmndi:BPMNEdge>
179201
<bpmndi:BPMNEdge id="Flow_05xcmy5_di" bpmnElement="Flow_05xcmy5">
180-
<di:waypoint x="890" y="120" />
181-
<di:waypoint x="1030" y="120" />
202+
<di:waypoint x="890" y="260" />
203+
<di:waypoint x="1030" y="260" />
182204
</bpmndi:BPMNEdge>
183205
<bpmndi:BPMNEdge id="Flow_0c6nkbs_di" bpmnElement="Flow_0c6nkbs">
184-
<di:waypoint x="1130" y="120" />
185-
<di:waypoint x="1232" y="120" />
206+
<di:waypoint x="1130" y="260" />
207+
<di:waypoint x="1232" y="260" />
186208
</bpmndi:BPMNEdge>
187209
<bpmndi:BPMNEdge id="Flow_0u40k0l_di" bpmnElement="Flow_0u40k0l">
188-
<di:waypoint x="890" y="250" />
189-
<di:waypoint x="956" y="250" />
190-
<di:waypoint x="956" y="120" />
191-
<di:waypoint x="1030" y="120" />
210+
<di:waypoint x="890" y="390" />
211+
<di:waypoint x="956" y="390" />
212+
<di:waypoint x="956" y="260" />
213+
<di:waypoint x="1030" y="260" />
192214
</bpmndi:BPMNEdge>
193215
<bpmndi:BPMNEdge id="Flow_0ur7f30_di" bpmnElement="Flow_0ur7f30">
194-
<di:waypoint x="695" y="250" />
195-
<di:waypoint x="790" y="250" />
216+
<di:waypoint x="695" y="390" />
217+
<di:waypoint x="790" y="390" />
196218
<bpmndi:BPMNLabel>
197-
<dc:Bounds x="720" y="232" width="46" height="14" />
219+
<dc:Bounds x="720" y="372" width="46" height="14" />
198220
</bpmndi:BPMNLabel>
199221
</bpmndi:BPMNEdge>
200222
<bpmndi:BPMNEdge id="Flow_185fj8e_di" bpmnElement="Flow_185fj8e">
201-
<di:waypoint x="670" y="225" />
202-
<di:waypoint x="670" y="120" />
203-
<di:waypoint x="790" y="120" />
223+
<di:waypoint x="670" y="365" />
224+
<di:waypoint x="670" y="260" />
225+
<di:waypoint x="790" y="260" />
204226
<bpmndi:BPMNLabel>
205-
<dc:Bounds x="675" y="143" width="46" height="14" />
227+
<dc:Bounds x="675" y="283" width="46" height="14" />
206228
</bpmndi:BPMNLabel>
207229
</bpmndi:BPMNEdge>
208230
<bpmndi:BPMNEdge id="Flow_1pazkck_di" bpmnElement="Flow_1pazkck">
209-
<di:waypoint x="590" y="250" />
210-
<di:waypoint x="645" y="250" />
231+
<di:waypoint x="590" y="390" />
232+
<di:waypoint x="645" y="390" />
211233
</bpmndi:BPMNEdge>
212234
<bpmndi:BPMNEdge id="Flow_0vjjadb_di" bpmnElement="Flow_0vjjadb">
213-
<di:waypoint x="440" y="455" />
214-
<di:waypoint x="440" y="250" />
215-
<di:waypoint x="490" y="250" />
235+
<di:waypoint x="440" y="595" />
236+
<di:waypoint x="440" y="390" />
237+
<di:waypoint x="490" y="390" />
216238
</bpmndi:BPMNEdge>
217239
<bpmndi:BPMNEdge id="Flow_0069xxd_di" bpmnElement="Flow_0069xxd">
218-
<di:waypoint x="440" y="505" />
219-
<di:waypoint x="440" y="610" />
220-
<di:waypoint x="490" y="610" />
240+
<di:waypoint x="440" y="645" />
241+
<di:waypoint x="440" y="750" />
242+
<di:waypoint x="490" y="750" />
221243
</bpmndi:BPMNEdge>
222244
<bpmndi:BPMNEdge id="Flow_0eob9zj_di" bpmnElement="Flow_0eob9zj">
223-
<di:waypoint x="340" y="480" />
224-
<di:waypoint x="415" y="480" />
245+
<di:waypoint x="340" y="620" />
246+
<di:waypoint x="415" y="620" />
225247
</bpmndi:BPMNEdge>
226248
<bpmndi:BPMNEdge id="Flow_17ssoz9_di" bpmnElement="Flow_17ssoz9">
227-
<di:waypoint x="740" y="610" />
228-
<di:waypoint x="822" y="610" />
249+
<di:waypoint x="740" y="750" />
250+
<di:waypoint x="822" y="750" />
229251
</bpmndi:BPMNEdge>
230252
<bpmndi:BPMNEdge id="Flow_18xtnen_di" bpmnElement="Flow_18xtnen">
231-
<di:waypoint x="590" y="610" />
232-
<di:waypoint x="640" y="610" />
253+
<di:waypoint x="590" y="750" />
254+
<di:waypoint x="640" y="750" />
233255
</bpmndi:BPMNEdge>
234256
<bpmndi:BPMNEdge id="Flow_1ax32ut_di" bpmnElement="Flow_1ax32ut">
235-
<di:waypoint x="188" y="480" />
236-
<di:waypoint x="240" y="480" />
257+
<di:waypoint x="188" y="620" />
258+
<di:waypoint x="240" y="620" />
237259
</bpmndi:BPMNEdge>
238-
<bpmndi:BPMNEdge id="Flow_0chzapv_di" bpmnElement="Flow_0chzapv">
239-
<di:waypoint x="590" y="552" />
240-
<di:waypoint x="590" y="490" />
241-
<di:waypoint x="660" y="490" />
260+
<bpmndi:BPMNEdge id="Flow_1623iq8_di" bpmnElement="Flow_1623iq8">
261+
<di:waypoint x="440" y="595" />
262+
<di:waypoint x="440" y="120" />
263+
<di:waypoint x="490" y="120" />
242264
</bpmndi:BPMNEdge>
243-
<bpmndi:BPMNEdge id="Flow_1ius0d1_di" bpmnElement="Flow_1ius0d1">
244-
<di:waypoint x="760" y="490" />
245-
<di:waypoint x="812" y="490" />
265+
<bpmndi:BPMNEdge id="Flow_0dsu483_di" bpmnElement="Flow_0dsu483">
266+
<di:waypoint x="590" y="120" />
267+
<di:waypoint x="622" y="120" />
246268
</bpmndi:BPMNEdge>
247269
<bpmndi:BPMNShape id="Event_0emfvgy_di" bpmnElement="Event_0emfvgy">
248-
<dc:Bounds x="152" y="462" width="36" height="36" />
270+
<dc:Bounds x="152" y="602" width="36" height="36" />
249271
</bpmndi:BPMNShape>
250272
<bpmndi:BPMNShape id="Activity_0r0ndxw_di" bpmnElement="Activity_1xq7c62">
251-
<dc:Bounds x="490" y="570" width="100" height="80" />
273+
<dc:Bounds x="490" y="710" width="100" height="80" />
252274
</bpmndi:BPMNShape>
253275
<bpmndi:BPMNShape id="Event_1dcdoiz_di" bpmnElement="Event_1dcdoiz">
254-
<dc:Bounds x="822" y="592" width="36" height="36" />
276+
<dc:Bounds x="822" y="732" width="36" height="36" />
255277
</bpmndi:BPMNShape>
256278
<bpmndi:BPMNShape id="Activity_0bbya1l_di" bpmnElement="Activity_1riah04">
257-
<dc:Bounds x="640" y="570" width="100" height="80" />
279+
<dc:Bounds x="640" y="710" width="100" height="80" />
258280
</bpmndi:BPMNShape>
259281
<bpmndi:BPMNShape id="Activity_0jlxpwl_di" bpmnElement="Activity_1g9mlga">
260-
<dc:Bounds x="240" y="440" width="100" height="80" />
282+
<dc:Bounds x="240" y="580" width="100" height="80" />
261283
</bpmndi:BPMNShape>
262284
<bpmndi:BPMNShape id="Activity_0ow5fbt_di" bpmnElement="Activity_16j3pe3">
263-
<dc:Bounds x="490" y="210" width="100" height="80" />
285+
<dc:Bounds x="490" y="350" width="100" height="80" />
264286
</bpmndi:BPMNShape>
265287
<bpmndi:BPMNShape id="Gateway_0dckhkz_di" bpmnElement="Gateway_0dckhkz" isMarkerVisible="true">
266-
<dc:Bounds x="645" y="225" width="50" height="50" />
288+
<dc:Bounds x="645" y="365" width="50" height="50" />
267289
<bpmndi:BPMNLabel>
268-
<dc:Bounds x="639" y="282" width="63" height="14" />
290+
<dc:Bounds x="639" y="422" width="63" height="14" />
269291
</bpmndi:BPMNLabel>
270292
</bpmndi:BPMNShape>
271293
<bpmndi:BPMNShape id="Activity_1m14h4j_di" bpmnElement="Activity_1m14h4j">
272-
<dc:Bounds x="790" y="210" width="100" height="80" />
294+
<dc:Bounds x="790" y="350" width="100" height="80" />
273295
</bpmndi:BPMNShape>
274296
<bpmndi:BPMNShape id="Activity_1jpxv3r_di" bpmnElement="Activity_1ic5lqh">
275-
<dc:Bounds x="790" y="80" width="100" height="80" />
297+
<dc:Bounds x="790" y="220" width="100" height="80" />
276298
</bpmndi:BPMNShape>
277299
<bpmndi:BPMNShape id="Event_0bjxyk4_di" bpmnElement="Event_0bjxyk4">
278-
<dc:Bounds x="1232" y="102" width="36" height="36" />
300+
<dc:Bounds x="1232" y="242" width="36" height="36" />
279301
</bpmndi:BPMNShape>
280302
<bpmndi:BPMNShape id="Activity_0guxhgg_di" bpmnElement="Activity_1e75b9b">
281-
<dc:Bounds x="1030" y="80" width="100" height="80" />
303+
<dc:Bounds x="1030" y="220" width="100" height="80" />
282304
</bpmndi:BPMNShape>
283305
<bpmndi:BPMNShape id="Gateway_0foqjz0_di" bpmnElement="Gateway_0u22n92">
284-
<dc:Bounds x="415" y="455" width="50" height="50" />
306+
<dc:Bounds x="415" y="595" width="50" height="50" />
285307
</bpmndi:BPMNShape>
286308
<bpmndi:BPMNShape id="Activity_1c1qdbc_di" bpmnElement="Activity_17hmd5d">
287-
<dc:Bounds x="490" y="350" width="100" height="80" />
309+
<dc:Bounds x="490" y="490" width="100" height="80" />
288310
</bpmndi:BPMNShape>
289311
<bpmndi:BPMNShape id="Event_1xyz7b9_di" bpmnElement="Event_1xyz7b9">
290-
<dc:Bounds x="822" y="372" width="36" height="36" />
312+
<dc:Bounds x="822" y="512" width="36" height="36" />
291313
</bpmndi:BPMNShape>
292314
<bpmndi:BPMNShape id="Activity_0inm4x2_di" bpmnElement="Activity_0hqbttr">
293-
<dc:Bounds x="640" y="350" width="100" height="80" />
315+
<dc:Bounds x="640" y="490" width="100" height="80" />
294316
</bpmndi:BPMNShape>
295317
<bpmndi:BPMNShape id="Event_17gjw51_di" bpmnElement="Event_17gjw51">
296-
<dc:Bounds x="592" y="782" width="36" height="36" />
318+
<dc:Bounds x="592" y="922" width="36" height="36" />
297319
</bpmndi:BPMNShape>
298320
<bpmndi:BPMNShape id="Event_1fpw6td_di" bpmnElement="Event_1fpw6td">
299-
<dc:Bounds x="812" y="712" width="36" height="36" />
321+
<dc:Bounds x="812" y="852" width="36" height="36" />
300322
</bpmndi:BPMNShape>
301323
<bpmndi:BPMNShape id="Activity_1s7ml4b_di" bpmnElement="Activity_136f9by">
302-
<dc:Bounds x="440" y="760" width="100" height="80" />
324+
<dc:Bounds x="440" y="900" width="100" height="80" />
303325
</bpmndi:BPMNShape>
304326
<bpmndi:BPMNShape id="Activity_0c2zne5_di" bpmnElement="Activity_1c18sr8">
305-
<dc:Bounds x="660" y="690" width="100" height="80" />
306-
</bpmndi:BPMNShape>
307-
<bpmndi:BPMNShape id="TextAnnotation_19wn5bt_di" bpmnElement="TextAnnotation_19wn5bt">
308-
<dc:Bounds x="210" y="310" width="140" height="82" />
327+
<dc:Bounds x="660" y="830" width="100" height="80" />
309328
</bpmndi:BPMNShape>
310329
<bpmndi:BPMNShape id="Activity_1t1614z_di" bpmnElement="Activity_1hmibg0">
311-
<dc:Bounds x="660" y="450" width="100" height="80" />
330+
<dc:Bounds x="660" y="590" width="100" height="80" />
312331
</bpmndi:BPMNShape>
313332
<bpmndi:BPMNShape id="Event_0fjx7tf_di" bpmnElement="Event_0fjx7tf">
314-
<dc:Bounds x="812" y="472" width="36" height="36" />
333+
<dc:Bounds x="812" y="612" width="36" height="36" />
315334
</bpmndi:BPMNShape>
316-
<bpmndi:BPMNShape id="Event_0rfidvh_di" bpmnElement="Event_19kscew">
317-
<dc:Bounds x="472" y="632" width="36" height="36" />
335+
<bpmndi:BPMNShape id="Event_0qnw1pi_di" bpmnElement="Event_0qnw1pi">
336+
<dc:Bounds x="622" y="102" width="36" height="36" />
337+
</bpmndi:BPMNShape>
338+
<bpmndi:BPMNShape id="Activity_188iga8_di" bpmnElement="Activity_0ngrvxl">
339+
<dc:Bounds x="490" y="80" width="100" height="80" />
318340
</bpmndi:BPMNShape>
319341
<bpmndi:BPMNEdge id="Association_04d5fx0_di" bpmnElement="Association_04d5fx0">
320-
<di:waypoint x="287" y="440" />
321-
<di:waypoint x="283" y="392" />
342+
<di:waypoint x="287" y="580" />
343+
<di:waypoint x="283" y="532" />
322344
</bpmndi:BPMNEdge>
345+
<bpmndi:BPMNShape id="Event_1p2gfns_di" bpmnElement="Event_1ugcuo2">
346+
<dc:Bounds x="572" y="692" width="36" height="36" />
347+
</bpmndi:BPMNShape>
323348
<bpmndi:BPMNShape id="Event_0cfl141_di" bpmnElement="Event_0hw13qf">
324-
<dc:Bounds x="572" y="632" width="36" height="36" />
349+
<dc:Bounds x="572" y="772" width="36" height="36" />
325350
</bpmndi:BPMNShape>
326-
<bpmndi:BPMNShape id="Event_1p2gfns_di" bpmnElement="Event_1ugcuo2">
327-
<dc:Bounds x="572" y="552" width="36" height="36" />
351+
<bpmndi:BPMNShape id="Event_0rfidvh_di" bpmnElement="Event_19kscew">
352+
<dc:Bounds x="472" y="772" width="36" height="36" />
328353
</bpmndi:BPMNShape>
329354
</bpmndi:BPMNPlane>
330355
</bpmndi:BPMNDiagram>

springboot/build.gradle.kts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,11 @@ tasks.withType<ProcessResources> {
6464
from("../common/forms"){
6565
into("public/forms")
6666
}
67+
}
68+
69+
tasks.withType<ProcessResources> {
70+
// Setup of the formio customizations into the required locations within the springboot app
71+
from("../bpmn"){
72+
into("public/forms")
73+
}
6774
}

0 commit comments

Comments
 (0)