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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
|
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<!-- $Id: genericinterface-communication-flow.xml,v 1.1 2012/02/23 13:44:35 mg Exp $ -->
<section id="genericinterface_communication_flow">
<title>Generic Interface Communication Flow</title>
<para>
Generic Interface has a defined flow to perform actions as a provider and as
a requester.
</para>
<para>
This flows are described below:
</para>
<section>
<title>OTRS as Provider</title>
<section>
<title>
Remote Request:
</title>
<orderedlist>
<listitem>
<para>
HTTP request
</para>
<itemizedlist mark="round">
<listitem>
<para>
OTRS receives HTTP request and pass it through the layers.
</para>
</listitem>
<listitem>
<para>
The provider module in in charge to execute and control this actions.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Network Transport
</para>
<itemizedlist mark="round">
<listitem>
<para>
The network transport module decodes the data payload and separates the
operation name from the rest of the data.
</para>
</listitem>
<listitem>
<para>
The operation name and the operation data are returned to the provider.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<remark>Data External</remark>
</para>
<itemizedlist mark="round">
<listitem>
<para>
Data as sent from the remote system (This is not a module-based layer).
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Mapping
</para>
<itemizedlist mark="round">
<listitem>
<para>
The data is transformed from the External System format to the OTRS internal
format as specified in the mapping configuration for this operation (Mapping
for incoming request data).
</para>
</listitem>
<listitem>
<para>
The already transformed data is returned to the provider.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<remark>Data Internal</remark>
</para>
<itemizedlist mark="round">
<listitem>
<para>
Data as transformed and prepared to be passed to the operation (This is not
a module based layer).
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Operation
</para>
<itemizedlist mark="round">
<listitem>
<para>
Receives and validates data.
</para>
</listitem>
<listitem>
<para>
Performs user access control.
</para>
</listitem>
<listitem>
<para>
Executes the action.
</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</section>
<section>
<title>
OTRS Response:
</title>
<orderedlist>
<listitem>
<para>
Operation
</para>
<itemizedlist>
<listitem>
<para>
Returns result data to the provider.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<remark>Data Internal</remark>
</para>
<itemizedlist>
<listitem>
<para>
Data as returned from operation.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Mapping
</para>
<itemizedlist>
<listitem>
<para>
The data is transformed back to the Remote system format as specified in the
mapping configuration (Mapping for outgoing response data).
</para>
</listitem>
<listitem>
<para>
The already transformed data is returned to the provider.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<remark>Data external</remark>
</para>
<itemizedlist>
<listitem>
<para>
Data as transformed and prepared to be passed to Network Transport as
response.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Network Transport
</para>
<itemizedlist>
<listitem>
<para>
Receives the data already in the Remote System format.
</para>
</listitem>
<listitem>
<para>
Constructs a valid response for this network transport type.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
HTTP response
</para>
<itemizedlist>
<listitem>
<para>
The response is sent back to the web service client.
</para>
</listitem>
<listitem>
<para>
In the case of an error, an error response is sent to the remote system
(e.g. SOAP fault, HTTP error, etc).
</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</section>
</section>
<section>
<title>OTRS as Requester</title>
<section>
<title>OTRS Request:</title>
<orderedlist>
<listitem>
<para>
Event Trigger Handler
</para>
<itemizedlist mark="round">
<listitem>
<para>
Based on the web service configuration determines if the request will be
synchronous or asynchronous.
</para>
<itemizedlist mark="round">
<listitem>
<para>
Synchronous
</para>
<itemizedlist mark="round">
<listitem>
<para>
A direct call to the Requester is made in order to create a new request and
pass it through the layers.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Asynchronous
</para>
<itemizedlist mark="round">
<listitem>
<para>
Create a new Generic Interface (Requester) task for the OTRS Scheduler (by
delegating the request execution to the Scheduler, the user experience could
be highly improved, otherwise all time needed to prepare the request and the
remote execution will be added to the OTRS Events that trigger those
requests).
</para>
</listitem>
<listitem>
<para>
In its next cycle the Scheduler process reads the new task and creates a
call to the Requester that will create a new request and pass it through the
layers.
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Invoker
</para>
<itemizedlist mark="round">
<listitem>
<para>
Receives data from the event.
</para>
</listitem>
<listitem>
<para>
Validates received data (if needed).
</para>
</listitem>
<listitem>
<para>
Call core modules to complement the data (if needed).
</para>
</listitem>
<listitem>
<para>
Return the request data structure or send a Stop Communication signal to the
requester, to gracefully cancel the request.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<remark>Data Internal</remark>
</para>
<itemizedlist mark="round">
<listitem>
<para>
Data as passed from the invoker (This is not a module based layer).
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Mapping
</para>
<itemizedlist mark="round">
<listitem>
<para>
The data is transformed to the Remote system format as specified in the
mapping configuration (Mapping for outgoing response data).
</para>
</listitem>
<listitem>
<para>
The already transformed data is returned to the requester.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<remark>Data External</remark>
</para>
<itemizedlist mark="round">
<listitem>
<para>
Data as transformed and prepared for sending to the remote system.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Network Transport
</para>
<itemizedlist mark="round">
<listitem>
<para>
Receives the remote operation name and the data already transformed to the
Remote System format from the requester.
</para>
</listitem>
<listitem>
<para>
Constructs a valid request for the network transport.
</para>
</listitem>
<listitem>
<para>
Sends the request to the remote system and waits for the response
</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</section>
<section>
<title>Remote Response:</title>
<orderedlist>
<listitem>
<para>
Network transport
</para>
<itemizedlist mark="round">
<listitem>
<para>
Receives the response and decodes the data payload.
</para>
</listitem>
<listitem>
<para>
Returns the data to the requester.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<remark>Data External</remark>
</para>
<itemizedlist mark="round">
<listitem>
<para>
Data as received from the Remote System
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Mapping
</para>
<itemizedlist mark="round">
<listitem>
<para>
The data is transformed form the External System format to the OTRS internal
format as specified in the mapping configuration for this operation (Mapping
for incoming response data).
</para>
</listitem>
<listitem>
<para>
The already transformed data is returned to the requester.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<remark>Data Internal</remark>
</para>
<itemizedlist mark="round">
<listitem>
<para>
Data as transformed and ready to be passed back to the requester.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Invoker
</para>
<itemizedlist mark="round">
<listitem>
<para>
Receives return data.
</para>
</listitem>
<listitem>
<para>
Handles the data as needed by specifically by each Invoker (included error
handling if any).
</para>
</listitem>
<listitem>
<para>
Return the Invoker result and data to the Requester.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Event Handler or Scheduler
</para>
<itemizedlist mark="round">
<listitem>
<para>
Receives the data from the Requester, in the case of the Scheduler this data
might contain information to Re-Schedule the task immediately or in the
future.
</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</section>
</section>
</section>
|
