forked from AOT-Technologies/forms-flow-ai-doc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtimeoutNotification_listener.html
307 lines (268 loc) · 13.5 KB
/
timeoutNotification_listener.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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Forms flow ai documentation">
<meta name="author" content="formsflow.ai">
<link rel="shortcut icon" href="favicon.ico">
<title>Welcome to formsflow.ai</title>
<!-- Google Font -->
<!-- <link href="https://fonts.googleapis.com/css?family=Poppins:300,400,500,600,700&display=swap" rel="stylesheet"> -->
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300&display=swap" rel="stylesheet">
<!-- FontAwesome JS-->
<script defer src="assets/fontawesome/js/all.min.js"></script>
<!-- Plugins CSS -->
<link rel="stylesheet" href="assets/plugins/simplelightbox/simple-lightbox.min.css">
<!-- Theme CSS -->
<link id="theme-style" rel="stylesheet" href="assets/css/theme.css">
<link id="theme-style" rel="stylesheet" href="assets/css/atom-one-dark.min.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
</head>
<body>
<header class="header fixed-top">
<div class="branding docs-branding">
<div class="container-fluid position-relative py-2">
<div class="docs-logo-wrapper">
<button id="docs-sidebar-toggler" class="docs-sidebar-toggler docs-sidebar-visible me-2 d-xl-none"
type="button">
<span></span>
<span></span>
<span></span>
</button>
<div class="site-logo"><a class="navbar-brand" href="index.html"><img class="logo-icon me-2"
src="assets/images/formsflow.ai-logo.svg" alt="logo"><span
class="logo-text">formsflow.ai</span></a></div>
</div>
<!--//docs-logo-wrapper-->
<div class="docs-top-utilities d-flex justify-content-end align-items-center">
<div class="top-search-box d-none d-lg-flex">
<form class="search-form">
<input type="text" placeholder="Search the docs..." name="search"
class="form-control search-input">
<button type="submit" class="btn search-btn" value="Search"><i
class="fas fa-search"></i></button>
</form>
</div>
<ul class="social-list list-inline mx-md-3 mx-lg-5 mb-0 d-none d-lg-flex">
<li class="list-inline-item"><a href="https://github.com/AOT-Technologies/forms-flow-ai"><i
class="fab fa-github fa-fw"></i></a></li>
</ul>
<!--//social-list-->
<a href="https://github.com/AOT-Technologies/forms-flow-ai"
class="btn btn-primary d-none d-lg-flex">Download</a>
</div>
<!--//docs-top-utilities-->
</div>
<!--//container-->
</div>
<!--//branding-->
</header>
<!--//header-->
<div class="docs-wrapper">
<div id="docs-sidebar" class="docs-sidebar">
<!-- mobile view -->
<div class="top-search-box d-lg-none p-3">
<form class="search-form">
<input type="text" placeholder="Search the docs..." name="search" class="form-control search-input">
<button type="submit" class="btn search-btn" value="Search"><i class="fas fa-search"></i></button>
</form>
</div>
<nav id="docs-nav" class="docs-nav navbar">
<ul class="section-items list-unstyled nav flex-column pb-3">
<!-- main heading -->
<li class="nav-item section-title"><a class="nav-link scrollto active" href="#section-1"><span
class="theme-icon-holder me-2"><i class="fas fa-map-signs"></i></span>Getting
started</a></li>
<li class="nav-item active" id="introduction"><a class="nav-link scrollto"
href="#introduction">Introduction</a></li>
<li class="nav-item" id="aboutproject"><a class="nav-link scrollto" href="#aboutproject">About The
Project</a></li>
<li class="nav-item" id="architecture"><a class="nav-link scrollto" href="#architecture">System
Architecture</a>
</li>
<li class="nav-item section-title mt-3"><a class="nav-link scrollto active" href="#section-2"><span
class="theme-icon-holder me-2"><i class="fa fa-download"></i></span>Download and
Installation</a></li>
<li class="nav-item" id="downloadformsflow"><a class="nav-link scrollto"
href="#downloadformsflow">Download Formsflow.ai</a></li>
<!-- main heading -->
<li class="nav-item section-title mt-3"><a class="nav-link scrollto active" href="#section-3"><span
class="theme-icon-holder me-2"><i class="fas fa-map-signs"></i></span>Docker Based
Installation</a></li>
<li class="nav-item" id="quick_installation"><a class="nav-link scrollto"
href="#quick_installation">Quick Installation</a></li>
<li class="nav-item" id="docker_full_deployment"><a class="nav-link scrollto"
href="#docker_full_deployment">Docker Full Deployment</a></li>
<li class="nav-item" id="individual_service_deployment"><a class="nav-link scrollto"
href="#individual_service_deployment">Individual Service Deployment</a></li>
<li class="nav-item section-title mt-3"><a class="nav-link scrollto" href="#section-4"><span
class="theme-icon-holder me-2"><i class="fas fa-arrow-down"></i></span>Kubernetes
Installation</a>
</li>
<li class="nav-item" id="kubernetes_installation"><a class="nav-link scrollto"
href="#kubernetes_installation">Kubernetes
Installation</a></li>
<li class="nav-item section-title mt-3"><a class="nav-link scrollto" href="#section-5"><span
class="theme-icon-holder me-2"><i class="fas fa-arrow-down"></i></span>Usage
instructions</a>
</li>
<li class="nav-item" id="howto_use"><a class="nav-link scrollto" href="#howto_use">How to Use
formsflow.ai</a>
</li>
<li class="nav-item" id="examples"><a class="nav-link scrollto" href="#examples">Examples</a>
</li>
<li class="nav-item" id="usage"><a class="nav-link scrollto" href="#usage">Usage</a>
</li>
<li class="nav-item section-title mt-3"><a class="nav-link scrollto" href="#section-6"><span
class="theme-icon-holder me-2"><i class="fas fa-arrow-down"></i></span>Features</a>
</li>
<li class="nav-item" id="language"><a class="nav-link scrollto"
href="#language">Internationalization</a></li>
<li class="nav-item" id="anonymous_form"><a class="nav-link scrollto"
href="#anonymous_form">Anonymous
Forms</a></li>
<li class="nav-item" id="draft_feature"><a class="nav-link scrollto" href="#draft_feature">Draft
Feature</a>
<li class="nav-item" id="exportpdf"><a class="nav-link scrollto" href="#exportpdf">Export Form as
PDF</a>
<li class="nav-item" id="camunda_listeners"><a class="nav-link scrollto"
href="#camunda_listeners">Bpm Listeners</a>
</li>
<li class="nav-item" id="camunda"><a class="nav-link scrollto" href="#camunda">Camunda Filters</a>
</li>
<li class="nav-item" id="task_variables"><a class="nav-link scrollto"
href="#task_variables">Taskvariable workflow</a></li>
<li class="nav-item" id="custom_components"><a class="nav-link scrollto"
href="#custom_components">Custom Components</a>
</li>
<li class="nav-item" id="keycloak_setup"><a class="nav-link scrollto"
href="#keycloak_setup">Keycloak SAML Setup</a></li>
<li class="nav-item" id="redash_guide"><a class="nav-link scrollto" href="#redash_guide">Analytics
User
Guide</a></li>
<li class="nav-item" id="logochange"><a class="nav-link scrollto" href="#logochange">Theming</a>
</li>
<li class="nav-item" id="custom_submission"><a class="nav-link scrollto" href="#custom_submission"
style="color: #566573">Form Adapter</a></li>
<li class="nav-item section-title mt-3"><a class="nav-link scrollto" href="#section-7"><span
class="theme-icon-holder me-2"><i class="fas fa-arrow-down"></i></span>Multi Tenancy</a>
<li class="nav-item" id="tenantbased_taskassignment"><a class="nav-link scrollto"
href="#tenantbased_taskassignment">Tenant-based task assignment</a></li>
<!-- main heading -->
<li class="nav-item section-title mt-3"><a class="nav-link scrollto" href="#section-9"><span
class="theme-icon-holder me-2"><i class="fas fa-lightbulb"></i></span>FAQs</a></li>
<li class="nav-item"><a class="nav-link scrollto" href="#item-9-1">Section Item 9.1</a></li>
<li class="nav-item"><a class="nav-link scrollto" href="#item-9-2">Section Item 9.2</a></li>
<li class="nav-item"><a class="nav-link scrollto" href="#item-9-3">Section Item 9.3</a></li>
</ul>
</nav>
<!--//docs-nav-->
</div>
<!--//docs-sidebar-->
<!-- // this is main container -->
<div>
<div class="container" id="main-content">
<article class="docs-article">
<section class="docs-section" id="listeners">
<div>
<h2 id="timeout-notification-listener">Timeout Notification Listener</h2>
<hr>
<p><strong>org.camunda.bpm.extension.hooks.listeners.task.TimeoutNotifyListener</strong>
</p>
<p>This component sends an email reminder a day before task due date, and escalation
email on the day
after due date.</p>
<h3 id="table-of-content">Table of Content</h3>
<ul>
<li><a href="#type">Type</a></li>
<li><a href="#how-it-works">How it Works</a></li>
<li><a href="#how-to-use">How to Use</a></li>
</ul>
<h3 id="type">Type</h3>
<p>Task Listener</p>
<h3 id="how-it-works">How it Works</h3>
<p>This component intended to use only along with task due date.</p>
<p>This component relies on listed parameters.</p>
<ul>
<li><strong>escalationGroup</strong> (Listener Field) : Recognized groupName within
Camunda.
<code>Mandatory = Yes</code>
</li>
<li><strong>messageName</strong> (Listener Field) : This refers the message name
from
<strong>notification_email.bpmn</strong> . <code>Mandatory = Yes</code>
</li>
</ul>
<p>The listener is expected to be configured on task event <strong>timeout</strong> with
any desired
timer definition.<br>Upon configuration, For reminder: a day before due date;email
is sent. </p>
<pre><code class="hljs">> <span class="hljs-keyword">For</span> assigned tasks; reminder <span class="hljs-keyword">is</span> sent <span class="hljs-keyword">to</span> user.
> <span class="hljs-keyword">For</span> unassigned tasks; reminder <span class="hljs-keyword">is</span> sent <span class="hljs-keyword">to</span> <span class="hljs-keyword">group</span>.
</code></pre>
<p>Also, for escalation: a day after due date; email is sent. </p>
<pre><code class="hljs">> <span class="hljs-keyword">For</span> both assigned <span class="hljs-keyword">and</span> unassigned <span class="hljs-keyword">task</span>, it uses the configured **escalationGroup**.
</code></pre>
<p>Please note this component uses the process <strong>notification_email.bpmn</strong>
and, it will
recognise only the reserved category <strong>activity_reminder</strong> and
<strong>activity_escalation</strong>.
</p>
<h3 id="how-to-use">How to Use</h3>
<p>Below snapshot shows how <strong>TimeoutNotifyListener</strong> can be used in
process.</p>
<h5
id="timeoutnotifylistener-being-configured-on-timeout-of-task-with-fields-configured-for-notification-">
TimeoutNotifyListener being configured on timeout of task; with fields configured
for notification.
</h5>
<p><img src="./assets/images/timeoutnotification-listener-snp1.jpg"
alt="Timeout Notification listener escalationGroup - Snapshot" height="500"
width="1000"></p>
<p><img src="./assets/images/timeoutnotification-listener-snp2.jpg"
alt="Timeout Notification listener messageName - Snapshot" height="500"
width="1000"><br>
</p>
</p>
</div>
</section>
</article>
</div>
<!-- ----------------------- this is footer section ------------------------ -->
<footer class="footer">
<div class="container text-center py-5">
<small class="copyright">Copyright © <a href="https://formsflow.ai/"
target="_blank">formsflow.ai</a></small>
<ul class="social-list list-unstyled pt-4 mb-0">
<li class="list-inline-item"><a href="https://github.com/AOT-Technologies/forms-flow-ai"><i
class="fab fa-github fa-fw"></i></a></li>
<li class="list-inline-item"><a href="https://twitter.com/formsflowai"><i
class="fab fa-twitter fa-fw"></i></a></li>
<li class="list-inline-item"><a
href="https://www.linkedin.com/company/aot-technologies/products/"><i
class="fab fa-linkedin-in"></i></a></li>
<li class="list-inline-item"><a href="https://www.facebook.com/formsflowai"><i
class="fab fa-facebook-f fa-fw"></i></a></li>
<li class="list-inline-item"><a href="https://www.instagram.com/formsflow.ai/"><i
class="fab fa-instagram fa-fw"></i></a></li>
</ul>
<!--//social-list-->
</div>
</footer>
</div>
</div>
</div>
<!--//docs-wrapper-->
<!-- Javascript -->
<script src="assets/plugins/popper.min.js"></script>
<script src="assets/plugins/bootstrap/js/bootstrap.min.js"></script>
<!-- Page Specific JS -->
<script src="assets/plugins/smoothscroll.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.8/highlight.min.js"></script>
<script src="assets/js/highlight-custom.js"></script>
<script src="assets/plugins/simplelightbox/simple-lightbox.min.js"></script>
<script src="assets/plugins/gumshoe/gumshoe.polyfills.min.js"></script>
</body>
</html>