Source string Read only

type: Content of: <section><section><section><section><para>
359/3590
Context English State
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 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.
The operation backend is pre-populated 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.
In the left part of the screen on the action column you have the options: <emphasis>Go back to web service</emphasis> (discarding all changes since the last save) and <emphasis>Delete</emphasis>. If you click on the last one, a dialog will open and ask you if you like to remove the operation. Click on <emphasis>Delete</emphasis> button to confirm the removal of the operation and its configuration or <emphasis>Cancel</emphasis> to close the delete dialog.
Web service operation
<graphic fileref="screenshots/administration/genericinterface/genericinterface-webservice-operation.png" scalefit="1" width="100%" contentdepth="100%"></graphic>
Web Service Requester Network Transport
The network transport configuration for the requester is similar to the configuration for the provider. For the Requester <emphasis>HTTP::SOAP</emphasis> network transport there are more fields to be set.
Apart from the <emphasis>Endpoint</emphasis> (URI of the Remote System web service interface to accept requests) and <emphasis>Namespace</emphasis> which are required fields, you can also specify:
Encoding (such as utf-8, latin1, iso-8859-1, cp1250, etc) for the SOAP message.
SOAPAction Header: you can use this to send an empty or filled SOAPAction header. Set to <emphasis>No</emphasis> and the SOAPAction header on the SOAP message will be an empty string, or set to <emphasis>Yes</emphasis> to send the SOAP action in Namespace#Action format and define the separator (typically "/" for .Net web services and "#" for the REST).
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.
Currently only the <emphasis>BasicAuth</emphasis> (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.
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.
Web service requester network transport (HTTP::SOAP)
<graphic fileref="screenshots/administration/genericinterface/genericinterface-webservice-requester-transport-soap.png" scalefit="1" width="100%" contentdepth="100%"></graphic>
In the case of HTTP::REST, this configuration also grows dynamically depending on the configured invokers by adding <emphasis>Controller mapping for Invoker '&lt;InvokerName&gt;':</emphasis> and <emphasis>Valid request command for Invoker '&lt;InvokerName&gt;':</emphasis> for each invoke. Authentication and SSL options are similar to the ones in HTTP::SOAP.
Host
The host name or IP Address and port of the remote system, if no port is specified, port 80 is used by default.
Controller mapping for Invoker '&lt;InvokerName&gt;':
In this setting a resource path is set. This path must be defined according to the needs of the remote web service and following its definition.
Path can contain variables in the form of ':&lt;VariableName&gt;' for each variable name that matches the current data (to be sent), will be replaced by the corresponding data value. This matched variable names and values will be removed from the current data. Depending on the HTTP request command the remaining data could be sent as a JSON string in the request body or as query parameters within the URI.
For data: Var1 = One, Var2 = Two, Var3 = Three and Var4 = Four.
Controller mapping: /Resource
After Replacements:
/Resource
Remaining Data:
Var1 = One, Var2 = Two, Var3 = Three and Var4 = Four
Controller mapping: /Resource/:Var1
/Resource/One
Var2 = Two, Var3 = Three and Var4 = Four
Controller mapping: /Resource/:Var1?Param1=:Var2&amp;Var3=:Var3

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:772
String age
a year ago
Source string age
a year ago
Translation file
i18n/doc-admin.pot, string 2433