forked from AOT-Technologies/forms-flow-ai-doc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
camunda_listeners.html
167 lines (163 loc) · 8.88 KB
/
camunda_listeners.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<article class="docs-article">
<section class="docs-section" id="listeners">
<div>
<h1 id="listeners">Adding Listeners</h1>
<hr>
<h4>Listeners</h4>
<p>Listeners allow you to execute external Java code or evaluate an expression when
certain
events occur during process execution.
Listeners are a mechanism that is very often used during process development.
We can compare them to aspects of aspect programming. Comparing to aspects may open
up some
horizons for you, as many programmers are closer to this solution than Camunda
specific
listeners.
Depending on the definition, we can run them at start/end activity/gateway/process
instance/events.<br><br>
<h2 id="forms-flow-bpm-listeners">forms-flow-bpm Listeners</h2>
<p>This page elaborates on customization and listeners created for use.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>How it Works</th>
<th>How to Use</th>
</tr>
</thead>
<tbody>
<tr>
<td> <code>FormConnectorListener</code></td>
<td>Task Listener</td>
<td>This component can be used on <strong>CREATE</strong> event of task
listener.
This
serves to associate a form with task.</td>
<td>Refer <a href="form_connectorListener.html" target="_blank">link</a></td>
</tr>
<tr>
<td> <code>NotifyListener</code></td>
<td>Task Listener</td>
<td>This component can be used on <strong>CREATE</strong> event of task
listener;
and sends
email upon task creation.</td>
<td>Refer <a href="notify_listener.html" target="_blank">link</a></td>
</tr>
<tr>
<td> <code>TaskDurationAttributesListener</code></td>
<td>Task/Execution Listener</td>
<td>This component can be used on any event of task/execution listener. This
calculates and
set DUE DATE in business days.</td>
<td>Refer <a href="formDuration_listener.html" target="_blank">link</a> </td>
</tr>
<tr>
<td> <code>ApplicationAuditListener</code></td>
<td>Task/Execution Listener</td>
<td>This component to be used on any event of task or execution. Upon
configuration,
this
send value from cam variables: "applicationStatus" and
"formUrl" to
formsflow.ai system for capturing audit.</td>
<td>Refer <a href="applicationAudit_listener.html" target="_blank">link</a></td>
</tr>
<tr>
<td> <code>ApplicationStateListener</code></td>
<td>Task/Execution Listener</td>
<td>This component can be used on any event of task/execution listener. Upon
configuration
it takes care of <br />1. Syncing formsflow.ai system' with the
active
status from
camunda. <br />2. Send value from cam variables:
"applicationStatus"
and
"formUrl" to formsflow.ai system for capturing audit.</td>
<td>Refer <a href="applicationState_listener.html" target="_blank">link</a></td>
</tr>
<tr>
<td> <code>FormBPMDataPipelineListener</code></td>
<td>Task/Execution Listener</td>
<td>This component can be used on any event of task/execution listener. It
is used
for
populating formio data into CAM Variables.</td>
<td>Refer <a href="formBPMDataPipeline_listener.html" target="_blank">link</a></td>
</tr>
<tr>
<td> <code>BPMFormDataPipelineListener</code></td>
<td>Task/Execution Listener</td>
<td>This component can be used on any event of task/execution listener. It
is used
for
populating CAM Variables into formio data.</td>
<td>Refer <a href="bpmformDataPipeline_listener.html" target="_blank">link</a></td>
</tr>
<tr>
<td> <code>ExternalSubmissionListener</code></td>
<td>Execution Listener</td>
<td>This component allows direct integration from any external system and
does
offline
sync-up within formsflow.ai i.e creates submission in formio.</td>
<td>Refer <a href="externalSubmission_listener.html" target="_blank">link</a></td>
</tr>
<tr>
<td> <code>FormAccessTokenCacheListener</code></td>
<td>Execution Listener</td>
<td>This component intended to run <strong>ONLY</strong> with the dedicated
token
cache
process <strong>formio-access-token.bpmn</strong>.It generates and
stores the
formio
token as variable in global scope.</td>
<td>Refer <a href="formAccessTokenCache_listener.html" target="_blank">link</a></td>
</tr>
<tr>
<td> <code>EmailAttributesListener</code></td>
<td>Execution Listener</td>
<td>This component intended to run <strong>ONLY</strong> with the process
<strong>notification_email.bpmn</strong> &
"email-template.dmn" or
any
similar notification processes.It replaces all reserved identifier
<strong>@{variable}</strong> with values in email body.
</td>
<td>Refer <a href="emailAttributes_listener.html" target="_blank">link</a></td>
</tr>
<tr>
<td> <code>TimeoutNotifyListener</code></td>
<td>Task Listener</td>
<td>This component sends an email reminder a day before task due date, and
escalation email
on the day after due date.</td>
<td>Refer <a href="timeoutNotification_listener.html" target="_blank">link</a></td>
</tr>
<tr>
<td> <code>FormSubmissionListener</code></td>
<td>Task/Execution Listener</td>
<td>This component from the current formUrl create a new revision and set
that as a
CAM
variable.</td>
<td>Refer <a href="formSubmission_listener.html" target="_blank">link</a></td>
</tr>
<tr>
<td> <code>FormBPMFilteredDataPipelineListener</code></td>
<td>Task/Execution Listener</td>
<td>This component can be used on any event of task/execution listener. It
is used
for
populating specific variables from formio to CAM Variables.</td>
<td>Refer <a href="formBPMFilteredDataPipeline_listener.html" target="_blank">link</a>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</article>