Source string Read only

type: Content of: <section><section><section><section><para>
442/4420
Context English State
On the <emphasis>OTRS as provider</emphasis> section it is possible to set or configure the network transport protocol. Only network transport back-ends that are registered are shown on the list. To configure the network transport click on the <emphasis>Configure</emphasis> button. It is also possible to add new operations in this box. To do this select one of the available operations from the <emphasis>Add Operation</emphasis> list. This will lead you to the operation configuration screen. After saving the new operation it will be listed in the table above.
<emphasis>OTRS as requester</emphasis> is very similar to the previous one, but instead of <emphasis>operations</emphasis> you can add invokers here.
Click the <emphasis>Save</emphasis> button to save and continue configuring the web service, <emphasis>Save and finish</emphasis> to save and return to the web service overview screen, or <emphasis>Cancel</emphasis> to discard current configuration level changes and return to web service overview screen.
Web services change
<graphic fileref="screenshots/administration/genericinterface/genericinterface-webservice-change.png" scalefit="1" width="100%" contentdepth="100%"></graphic>
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: <emphasis>Save</emphasis> and <emphasis>Cancel</emphasis>. If the configuration is re-visited, a new option <emphasis>Save and Finish</emphasis> will appear. The behavior of this feature is defined below.
<emphasis>Save</emphasis> will store the current configuration level in the database and it will return to the previous screen to review your changes or to configure deeper settings.
<emphasis>Save and Finish</emphasis> 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).
<emphasis>Cancel</emphasis> will discard any configuration change to the current configuration level and will return to the previous screen in the configuration hierarchy.
Web Service Provider Network Transport
In future the list of available network transports will be increased. Currently only <emphasis>HTTP::SOAP</emphasis> and <emphasis>HTTP::REST</emphasis> transports are available. Each transport has different configuration options to setup and they might use different frontend modules to configure them.
It is quite simple to configure the <emphasis>HTTP::SOAP</emphasis> protocol as provider. There are only two settings: <emphasis>Namespace</emphasis> and <emphasis>Maximum message length</emphasis>. These fields are required. The first one is a URI to give SOAP methods a context, reducing ambiguities, and the second one is a field where you can specify the maximum size (in bytes) for SOAP messages that OTRS will process.
Web service provider network transport (HTTP::SOAP)
<graphic fileref="screenshots/administration/genericinterface/genericinterface-webservice-provider-transport-soap.png" scalefit="1" width="100%" contentdepth="100%"></graphic>
Optionally, you may want to define additional response headers. These may be used to add static header values to every response. Just click on Add response header and fill both key and value fields. There is no limit in number of additional header lines.
For <emphasis>HTTP::REST</emphasis> the configuration might be a bit more complicated, as it grows dynamically for each configured operation by adding: <emphasis>Route mapping for Operation '&lt;OperationName&gt;':</emphasis> and <emphasis>Valid request methods for Operation '&lt;OperationName&gt;':</emphasis> settings to the default transport settings <emphasis>Maximum message length:</emphasis> and <emphasis>Send Keep-Alive:</emphasis>.
Route mapping for Operation '&lt;OperationName&gt;':
In this setting a resource path is set. This path must be defined according to the needs of the web service considering that the path in conjunction with the HTTP request method determines the Generic Interface operation to be executed.
Path can contain variables in the form of ':&lt;VariableName&gt;' each path string that fits on the position of the variable name will be added to the request payload using the variable name defined in this setting.
Examples:
Route mapping: /Resource
Valid requests:
http://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource
http://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource?Param1=One
Invalid requests:
http://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/
http://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/OtherResource
http://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/OtherResource?Param1=One
Route mapping: /Resource/:ID
http://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/1
http://localhost/otrs/nph-genericinterface.pl/Webservice/Test/Resource/1?Param1=One

Loading…

User avatar None

New source string

OTRS 6 / Administration ManualEnglish

New source string a year ago
Browse all component changes

Glossary

English English
No related strings found in the glossary.

Source information

Source string comment
type: Content of: <section><section><section><section><para>
Flags
read-only
Source string location
en/content/administration/genericinterface/genericinterface-webservice-gui.xml:523
String age
a year ago
Source string age
a year ago
Translation file
i18n/doc-admin.pot, string 2386