File: genericinterface-webservice-gui.xml

package info (click to toggle)
otrs2-doc 20120224-1
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 36,060 kB
  • sloc: xml: 57,412; sh: 126; makefile: 12
file content (840 lines) | stat: -rw-r--r-- 37,355 bytes parent folder | download
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
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
<?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-webservice-gui.xml,v 1.1 2012/02/23 13:44:35 mg Exp $ -->
<section id="webservice_gui">
    <title>Web Service Graphical Interface</title>
    <para>
        The web service graphical user interface (GUI) is a tool that allows to
construct complex web service configurations in a friendly and nice
interface. It allows to:
    </para>
    <para>
        <itemizedlist>
            <listitem>
                <para>
                    Create and Delete web services.
                </para>
            </listitem>
            <listitem>
                <para>
                    Import and Export configurations (in YAML file format) for existing web
services.
                </para>
            </listitem>
            <listitem>
                <para>
                    View, Revert and Export old configurations for existing web services in the
Web Service History screen.
                </para>
            </listitem>
            <listitem>
                <para>
                    Track all communication logs for each web service in the Debugger screen.
                </para>
            </listitem>
        </itemizedlist>
    </para>

    <section id="webservice_gui_overview">
        <title>Web Service Overview</title>
        <para>
            The "Web Services" link in the main screen of Admin Interface (in the System
Administration box) leads to the web services overview screen, where you are
able to manage your web service configurations. You can add new web services
or change the configuration of the existing ones from this screen.
        </para>
        <para>
            Every web service configuration screen has in the upper part of the screen a
navigation path in a "bread crumbs" style. This navigation path is useful to
know exactly in which part of the web service configuration we are, and also
we can jump back to any level of the configuration at any time (this action
will not save any changes).
        </para>
        <note>
            <para>
                To create a new web service, press the button "Add web service", and provide
the needed information.
            </para>
        </note>
        <para>
            <screenshot>
<screeninfo>Web Service Overview</screeninfo> <graphic srccredit="Adminarea web
service - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-overview.png"></graphic></screenshot>
        </para>
        <para>
            <emphasis>Figure: Web services overview.</emphasis>
        </para>
    </section>

    <section id="webservice_gui_add">
        <title>Web Service Add</title>
        <para>
            The only required field in this part is the web service "Name" that needs to
be unique in the system and non empty. Other fields are also necessary for
the configuration like the "Debug Threshold" and "Validity" but these fields
are already filled with the default value for each list.
        </para>
        <para>
            The default value for "Debug Threshold" is "debug", under this configuration
all communication logs are registered in the database, each Debug Threshold
value is more restrictive and discard communication logs set for lower
values.
        </para>
        <para>
            <itemizedlist>
                <title>Debug Threshold levels (from lower to upper)</title>
                <listitem>
                    <para>
                        Debug
                    </para>
                </listitem>
                <listitem>
                    <para>
                        Info
                    </para>
                </listitem>
                <listitem>
                    <para>
                        Notice
                    </para>
                </listitem>
                <listitem>
                    <para>
                        Error
                    </para>
                </listitem>
            </itemizedlist>
        </para>
        <para>
            It is also possible to define the network transport protocol for "OTRS as
Provider" and "OTRS as requester".
        </para>
        <para>
            Click on the "Save" button to register the new web service in the database
or click "Cancel" to discard this operation. You will now be returned to the
web service overview screen.
        </para>
        <para>
            If you already have a web service configuration file in YAML format you can
click on the "Import web service" button on the left side of the screen. For
more information on importing web services please check the next section
"Web Service Change".
        </para>
        <note>
            <para>
                To change or add more details to a web service, click on the web service
name in the web service overview screen.
            </para>
        </note>
        <para>
            <screenshot>
<screeninfo>Web service add</screeninfo> <graphic srccredit="Adminarea web
service add - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-add.png"></graphic></screenshot>
        </para>
        <para>
            <emphasis>Figure: Web services add.</emphasis>
        </para>
    </section>

    <section id="webservice_gui_change">
        <title>Web Service Change</title>
        <para>
            On this screen you have a complete set of functions to handle every part of
a web service. On the left side in the action column you can find some
buttons that allows you to perform all possible actions on a web service:
        </para>
        <para>
        <itemizedlist>
            <listitem>
                <para>
                    Clone web service.
                </para>
            </listitem>
            <listitem>
                <para>
                    Export web service.
                </para>
            </listitem>
            <listitem>
                <para>
                    Import web service.
                </para>
            </listitem>
            <listitem>
                <para>
                    Configuration History.
                </para>
            </listitem>
            <listitem>
                <para>
                    Delete web service.
                </para>
            </listitem>
            <listitem>
                <para>
                    Debugger.
                </para>
            </listitem>
        </itemizedlist>
        </para>
        <note>
            <para>
                "Configuration history" and "Debugger" will lead you to different screens.
            </para>
        </note>

        <section id="webservice-clone">
            <title>Web Service Clone</title>
            <para>
                To clone a web service, you need to click on the "Clone web service" button,
a dialog will be shown where you can use the default name or set a new name
for the (cloned) web service.
            </para>
            <note>
                <para>
                    <emphasis>Remember </emphasis> the name of the web service must be unique
within the system.
                </para>
            </note>
            <para>Click on "Clone" button to create the web service clone or "Cancel" to close
the dialog.</para>
            <para>
                <screenshot>
<screeninfo>Web service clone</screeninfo> <graphic srccredit="Adminarea web
service clone - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-clone.png"></graphic></screenshot>
            </para>
            <para>
                <emphasis>Figure: Web service clone.</emphasis>
            </para>
        </section>

        <section id="webservice-export">
            <title>Web Service Export</title>
            <para>
                The "Export web service" button gives you the opportunity to dump the
configuration of the current web service into a YAML file, download it and
store it on your file system. This can be specially useful if you want to
migrate the web service from one server to another, for example from a
testing environment to a production system.
            </para>
            <warning>
                <para>
                    All stored passwords in the web service configuration will be exported as
plain text.
                </para>
            </warning>
            <para>
                Right after clicking the "Export web service" button a save dialog of your
browser will appear, just like when you click on a file download link on a
web page.
            </para>
            <note>
                <para>
                    Each browser on each operating system has its own save dialog screen and
style, depending on the browser and its configuration it is possible that no
dialog is shown and the file is saved to a default directory on your file
system. Please check your browser documentation for more specific
instructions if needed.
                </para>
            </note>
            <para>
                <screenshot>
<screeninfo>Web service export</screeninfo> <graphic srccredit="Adminarea web
service export - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-export.png"></graphic></screenshot>
            </para>
            <para>
                <emphasis>Figure: Web services export.</emphasis>
            </para>
        </section>

        <section id="webservice-import">
            <title>Web Service Import</title>
            <para>
                A valid web service configuration YAML file is required to use the import
web service feature. Click on the "Import web service" button, browse for
the configuration file or provide the complete path in the input box.
            </para>
            <para>
                Click "Import" button to create a new web service from a file or "Cancel" to
close the dialog.
            </para>
            <note>
                <para>
                    The web service name will be taken from the configuration file name (e.g. if
the file name is MyWebservice.yml the resulting web service will be named
MyWebservice). If a web service is registered in the system with the same
name as the web service that you want to import, the system will lead you to
the web service change screen to let you change the name of the imported web
service.
                </para>
            </note>
            <para>
                <screenshot>
<screeninfo>Web service import</screeninfo> <graphic srccredit="Adminarea web
service import - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-import.png"></graphic></screenshot>
            </para>
            <para>
                <emphasis>Figure: Web services import.</emphasis>
            </para>
        </section>

        <section id="webservice-history">
            <title>Web Service History</title>
            <para>
                Every change to the web service configuration creates a new entry in the web
service history (as a journal). The web service history screen displays a
list of all configuration versions for a web service. Each row (version) in
the "Configuration History List" represents a single revision in the web
service history.
            </para>
            <para>
                Click on one of the rows to show the whole configuration as it was on that
particular date / time. The configuration will be shown in the "History
details" section of this screen. Here you are also able to export the
selected web service configuration version or to restore that version into
the current web service configuration.
            </para>
            <para>
                The "Export web service configuration" behaves exactly as the "Export web
service" feature in the web service change screen. For more information
refer to that section.
            </para>
            <para>
                If changes to the current web service configuration does not work as
expected and it is not easy to revert the changes manually, you can click on
the "Revert web service configuration" button. This will open a dialog to
ask you if you are sure to revert the web service configuration. Click
"Revert web service configuration" in this dialog to replace the current
configuration with the selected version, or click "Cancel" to close the
dialog.
            </para>
            <warning>
                <para>
                    Remember that any passwords stored in the web service configuration will be
exported as plain text.
                </para>
                <para>
                    Please be careful when you restore a configuration because this can't be
undone.
                </para>
            </warning>
            <para>
                <screenshot>
<screeninfo>Web Service History</screeninfo> <graphic srccredit="Adminarea web
service history - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-history.png"></graphic></screenshot>
            </para>
            <para>
                <emphasis>Figure: Web service history.</emphasis>
            </para>
        </section>

        <section id="webservice-delete">
            <title>Web Service Delete</title>
            <para>
                Sometimes it is necessary to delete a web service completely.  To do this
you can press on the "Delete web service" button and a new dialog will
appear asking for confirmation.
            </para>
            <para>
                Clink on "Delete" to confirm the removal of the web service or on "Cancel"
to close the dialog.
            </para>
            <warning>
                <para>
                    Delete a web service can't be undone, please be careful when deleting a web
service.
                </para>
             </warning>
            <para>
                <screenshot>
<screeninfo>Web service delete</screeninfo> <graphic srccredit="Adminarea web
service delete - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-delete.png"></graphic></screenshot>
            </para>
            <para>
                <emphasis>Figure: Web service delete.</emphasis>
            </para>
        </section>

        <section id="webservice-debugger">
            <title>Web Service Debugger</title>
            <para>
                The Debugger stores the log of a web service. In the debugger screen you can
track all the web service communications for either provider or requester
types.
            </para>
            <para>
                When this screen is shown the request list starts to load. After the list is
fully filled you can choose one of the rows (that means a communication
sequence) to check its details. This details will appear in a box below.
            </para>
            <para>
                You can narrow the communication list using the filter on the right part of
the screen. You can filter by:
            </para>
            <itemizedlist>
                <listitem>
                    <para>
                        Communication type (provider or requester)
                    </para>
                </listitem>
                <listitem>
                    <para>
                        Date: before and / or after a particular date
                    </para>
                </listitem>
                <listitem>
                    <para>
                        The remote IP Address
                    </para>
                </listitem>
                <listitem>
                    <para>
                        A combination of all.
                    </para>
                </listitem>
            </itemizedlist>
            <para>
                After filter settings are set, push the "Refresh" button and a new list will
be displayed meeting your search criteria.
            </para>
            <note>
                <para>
                    Depending on the search criteria for the filters the new list could return
no results.
                </para>
            </note>
            <para>
                On the left part of the screen under the action column you can select "Go
back to the web service" or clear the debugger log by pushing the "Clear"
button.  This will open a dialog that ask you to confirm erasing of the
log. Click "Clear" in the dialog button to perform the action or click on
"Cancel" to close this dialog.
            </para>
            <para>
                In the "Request details" section you can see all the details for the
selected communication. Here you can track the complete flow and check for
possible errors or confirm success responses.
            </para>
            <para>
                <screenshot>
<screeninfo>Web Service Debugger</screeninfo> <graphic srccredit="Adminarea web
service debugger - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-debugger.png"></graphic></screenshot>
            </para>
            <para>
                <emphasis>Figure: Web service debugger.</emphasis>
            </para>
        </section>

        <section id="webservice-configuration-change">
            <title>Web Service Configuration Change</title>
            <para>
                Returning to the web service change screen, now we are going to review the
right side of it. Here we have the possibility to modify all the general
data for a web service such as name, description, debug threshold, etc. Also
there are two more sections below that allows us to modify specific
parameters for communication types "OTRS as Provider" and "OTRS as
Requester".
            </para>
            <para>
                The web service configuration needs to be saved on each level. This means
that if a setting is changed, links to other, deeper parts of the
configuration will be disabled forcing to save the current configuration
level. After saving the disabled links will be re-enabled again allowing you
to continue with the configuration.
            </para>
            <para>
                On the "OTRS as provider" section it is possible to set or configure the
network transport protocol. Only network transport backends that are
registered are shown on the list. To configure the network transport click
on the "Configure" button.  It is also possible to add new operations in
this box. To do this select one of the available operations from the "Add
Operation" list. This will lead you to the operation configuration
screen. After saving the new operation it will be listed in the table above.
            </para>
            <para>
                "OTRS as requester" is very similar to the previous one, but instead of
"operations" you can add invokers here.
            </para>
            <para>
                Click the "Save" button to save and continue configuring the web service,
"Save and finish" to save and return to the web service overview screen, or
"Cancel" to discard current configuration level changes and return to web
service overview screen.
            </para>
            <para>
                <screenshot>
<screeninfo>Web service change</screeninfo> <graphic srccredit="Adminarea web
service change - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-change.png"></graphic></screenshot>
            </para>
            <para>
                <emphasis>Figure: Web services change.</emphasis>
            </para>
            <note>
                <para>
                    Like the other Generic Interface configuration screens such as Network
Transport, operation, Invoker and Mapping, the initial configuration (add)
screen will only present two options: "Save" and "Cancel", when the
configuration is re-visited then a new option "Save and Finish" will
appear.  The behavior of this feature is defined below.
                </para>
                <para>
                    "Save" will store the current configuration level in the database and it
will return to the same screen to review your changes or to configure deeper
settings.
                </para>
                <para>
                    "Save and Finish" will store the current configuration level in the database
and it will return to the previous screen in the configuration hierarchy (to
the immediate upper configuration level).
                </para>
                <para>
                    "Cancel" will discard any configuration change to the current configuration
level and will return to the previous screen in the configuration hierarchy.
                </para>
            </note>

        <section id="webservice-provider-network-transport">
            <title>Web Service Provider Network Transport</title>
            <para>
                In future the list of available network transports will be
increased. Currently only the "HTTP::SOAP" transport is available. Each
transport has different configuration options to setup and they might use
different frontend modules to configure it, but mostly they should look
similar to the "HTTP::SOAP" transport configuration module.
            </para>
            <para>
                For "HTTP::SOAP" protocol as provider the configuration is quite simple.
There are only two settings: "Namespace" and "Maximum message length". These
fields are required. The first one is a URI to give SOAP methods a context,
reducing ambiguities, and the second one it's a field where you can specify
the maximum size (in bytes) for SOAP messages that OTRS will process.
            </para>
            <para>
                <screenshot>
<screeninfo>Web Service Provider Network Transport</screeninfo> <graphic srccredit="Adminarea web
service provider network transport - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-provider-transport.png"></graphic></screenshot>
            </para>
            <para>
                <emphasis>Figure: Web service provider network transport.</emphasis>
            </para>
        </section>

        <section id="webservice-operation">
            <title>Web Service Operation</title>
            <para>
                The actions that can be performed when you are using OTRS as a provider are
called "Operations". Each operation belongs to a controller. Controllers are
collections of operations or invokers, normally operations from the same
controller need similar settings and shares the same configuration
dialog. But each operation can have independent configuration dialogs if
needed.
            </para>
            <para>
                Name, Description, Backend, and Mappings are fields that normally appear on
every operation, other special fields can appear in non default
configuration dialogs like the Remote System GUID field in SolMan Controller
operations.
            </para>
            <para>
                Normally there are two mapping configuration sections on each operation, one
for the incoming data and another one for the outgoing data. You can choose
different mapping types (backends) for each mapping direction, since their
configuration is independent from each other and also independent from the
operation backend. The normal and most common practice is that the operation
uses same mapping type in both cases (with inverted configuration). The
complete mapping configuration is done in a separate screen which depends on
the mapping type.
            </para>
            <para>
                The operation backend is pre-filled and is not editable. You will see this
parameter when you choose the operation on the web service edit screen. The
field is only informative.
            </para>
            <para>
                In the left part of the screen on the action column you have the options:
"Go back to web service" (discarding all changes since the last save) and
"Delete". If you click on the last one, a dialog will open and ask you if
you like to remove the operation. Click on "Delete" button to confirm the
removal of the operation and it configuration or "Cancel" to close the
delete dialog.
            </para>
            <para>
                <screenshot>
<screeninfo>Web Service Operation</screeninfo> <graphic srccredit="Adminarea web
service operation - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-operation.png"></graphic></screenshot>
            </para>
            <para>
                <emphasis>Figure: Web service operation.</emphasis>
            </para>
        </section>

           <section id="webservice-requester-transport">
                <title>Web Service Provider Transport</title>
                <para>
                    The network transport configuration for the requester is similar to the
configuration for the provider. For the Requester "HTTP::SOAP" network
transport there are more fields to be set.
                </para>
                <para>
                    Apart from the "Endpoint" (URI of the Remote System web service interface to
accept requests) and "Namespace" which are required fields, you can also
specify:
                </para>
                <itemizedlist>
                    <listitem>
                        <para>
                            Encoding (such as utf-8, latin1, iso-8859-1, cp1250, etc) for the SOAP
message.
                        </para>
                    </listitem>
                    <listitem>
                        <para>
                            SOAPAction Header: you can use this to send an empty or filled SOAPAction
header.  Set to "No" and the SOAPAction header on the SOAP message will be
an empty string, or set to "Yes" to send the soap action in Namespace#Action
format and define the separator (typically "/" for .Net web services and "#"
for the rest).
                        </para>
                    </listitem>
                    <listitem>
                        <para>
                            Authentication: to set the authentication mechanism, set to "-" to not use
any authentication or select one from the list and the detail fields will
appear.
                        </para>
                    </listitem>
                </itemizedlist>
                <note>
                    <para>
                        Currently only the "BasicAuth" (HTTP) authentication mechanism is
implemented.  You can decide whether or not to use it depending on the
Remote System configuration. If used, you must provide the User Name and the
Password to access the remote system.
                    </para>
                </note>
                <warning>
                    <para>
                        If you supply a password for authentication and after you export the web
service to a YAML file this password will be revealed and will be written
into a plain text string inside the YAML file. Be aware of it and take
precautions if needed.
                    </para>
                </warning>
                <para>
                    <screenshot>
<screeninfo>Web Service Requester Network Transport</screeninfo> <graphic srccredit="Adminarea web
service requester network transport - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-requester-transport.png"></graphic></screenshot>
                </para>
                <para>
                    <emphasis>Figure: Web service requester network transport.</emphasis>
                </para>
            </section>

            <section id="webservice-invoker">
                <title>Web Service Invoker</title>
                <para>
                    The actions that can be performed when you are using OTRS as a requester are
called "Invokers". Each invoker belongs to a controller (controllers are
collections of operations or invokers), normally invokers from the same
controller need similar settings and share the same configuration dialogs.
Each invoker can have independent configuration dialogs if needed.
                </para>
                <para>
                    Name, Description, Backend, and Mappings are fields that normally appear on
every invoker, as well as the list of event triggers other special fields
can appear on non default configuration dialogs like the Remote System GUID
field in SolMan Controller invokers.
                </para>
                <para>
                    Normally there are two mapping configuration sections for each invoker, one
for the incoming data and another one for the outgoing data. You can choose
different mapping types (backends) for each mapping direction, since their
configuration is independent from each other and also independent from the
invoker backend. The normal and most common practice is that the invoker
uses the same mapping type in both cases, with inverted configuration. The
complete mapping configuration is done in a separate screen, which depends
on the mapping type.
                </para>
                <para>
                    The invoker backend is pre-filled and is not editable. You will see this
parameter when you choose the invoker on the web service edit screen. The
field is only informative.  informative.
                </para>
                <para>
                    Event triggers are events within OTRS such as "TicketCreate", "ArticleSend",
etc.  These can act as triggers to execute the invoker. Each invoker needs
to have at least one event trigger registered, or the invoker will be
useless, because it will never be called. The asynchronous property of the
event triggers define if the OTRS process will handle the invoker or if it
will be delegated to the Scheduler.
                </para>
                <note>
                    <para>
                        The OTRS Scheduler is a separated process that executes tasks in the
background.  Using this the OTRS process itself will not be affected if the
Remote System takes a long time to respond, if it is not available or if
there are network problems. If you don't use the scheduler using web
services can make OTRS slow or non-responsive. Therefore it is highly
recommend to use asynchronous event triggers as often as possible.
                    </para>
                </note>
                <para>
                    To add an Event trigger first select the event family from the first list,
then the event name from the second list, then set the asynchronous property
(if unchecked means that the event trigger will not be asynchronous) and
then click on the plus button. A new event trigger will be created and it
will be listed on the invoker "Event Triggers" list.
                </para>
                <para>
                    To delete an Event trigger, simply locate the event trigger to be deleted in
the "Event Triggers" list and click on the trash icon at the end of the
row. This will open a dialog that ask you if you are sure to delete the
event trigger. Click "Delete" to remove the event trigger from the list, or
"Cancel" to close the dialog.
                </para>
                <para>
                    In the left part of the screen on the action column you have the options:
"Go back to web service" (discarding all changes since the last save) and
"Delete".  If you click on the last one, a dialog will emerge and ask you if
you like to remove the invoker. Click on the "Delete" button to confirm the
removal of the invoker and its configuration or "Cancel" to close the delete
dialog.
                </para>
                <para>
                    <screenshot>
<screeninfo>Web Service Invoker</screeninfo> <graphic srccredit="Adminarea web
service invoker - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-invoker.png"></graphic></screenshot>
                </para>
                <para>
                    <emphasis>Figure: Web service invoker.</emphasis>
                </para>
            </section>

            <section id="webservice-mapping">
                <title>Web Service Mapping</title>
                <para>
                    There are cases where you need to transform the data from one format to
another (map or change data structure), because normally a web service is
used to interact with a Remote System, that is highly probable that is not
another OTRS system and / or could not understand the OTRS data structures
and values. In these cases some or all values has to be changed, and
sometimes even the names of the values (keys) or sometimes the complete
structure, in order to match with the expected data on the other end. To
accomplish this task the the Generic Interface Mapping Layer exists.
                </para>
                <para>
                    Each Remote System has it own data structures and it is possible to create
new mapping modules for each case (e.g. there is a customized mapping module
for SAP Solution Manager shipped with OTRS), but it is not always
necessary.  The module Mapping::Simple should cover most of the mapping
needs.
                </para>
                <note>
                    <para>
                        When Mapping::Simple does not cover all mapping needs for a web service a
new mapping module should be created. To learn more about how to create new
mapping modules please consult the OTRS Development Manual.
                    </para>
                </note>
                <para>
                    This module gives you the opportunity to set default values to map for each
key or value for the whole communication data.
                </para>
                <para>
                    At the beginning of the screen you will see a general section where you can
set the default rules that will apply for all the unmapped keys and
values. there are three options available, these options are listed below:
                </para>
                <itemizedlist>
                    <listitem>
                        <para>
                            Keep (leave unchanged): doesn't touch the keys or values in any way.
                        </para>
                    </listitem>
                    <listitem>
                        <para>
                            Ignore (drop key/value pair): when this is applied to the key it deletes the
key and value, because when a key is deleted then in consequence it
associated value is deleted too. When this is applied to the value, only the
value is deleted, keeping the key, that now will be associated to an empty
value.
                        </para>
                    </listitem>
                    <listitem>
                        <para>
                            MapTo (use provided key or value as default): all keys and / or values
without a defined map rule, will use this as default, when you select this
option a new text field will appear to set this default.
                        </para>
                    </listitem>
                </itemizedlist>
                <para>
                    Clicking on the "+" button for new key map, will display a new box for a
single mapping configuration. You can add as many key mappings as
needed. Just click on the "+" button again and a new mapping box will appear
below the existing one. From this mapping boxes you can define a map for a
single key, with the next options:
                </para>
                <para>
                    <itemizedlist>
                        <listitem>
                            <para>
                                Exact value(s): the old key string will be changed to a new one if the old
key matches exactly.
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                Regular expression: The key string will be replaced following a regular
expression rule.
                            </para>
                        </listitem>
                    </itemizedlist>
                </para>
                <para>
                    Pressing the new value map "+" button will display a new row for a value
map.  Here also is possible to define rules for each value to be mapped with
the same options as for the key map (Exact value and Regular
expression). You can add as many values to map as needed, and if you want to
delete one of them, just click on the "-" button for each mapping value row.
                </para>
                <para>
                    Deleting the complete key mapping section (box) is possible, just push on
the "-" button located on the up right corner of each box that you want to
delete.
                </para>
                <para>
                    If you need to delete a complete mapping configuration: go back to the
corresponding operation or invoker screen, look for the mapping direction
that you select before and set its value to "-", and save the configuration
to apply changes.
                </para>
                <para>
                    <screenshot>
<screeninfo>Web Service Mapping</screeninfo> <graphic srccredit="Adminarea web
service mapping - screenshot" scale="40"
fileref="screenshots/genericinterface-webservice-mapping.png"></graphic></screenshot>
                </para>
                <para>
                    <emphasis>Figure: Web service mapping.</emphasis>
                </para>
            </section>
        </section>

    </section>
</section>