| //// |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| //// |
| :documentationPath: /plugins/transforms/ |
| :language: en_US |
| :page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/plugins/transforms/webservices/src/main/doc/webservices.adoc |
| = Web services lookup |
| |
| == Description |
| |
| This transform performs a Web Services lookup using the Web Services Description Language (WSDL). |
| |
| == Options |
| |
| [width="90%", options="header"] |
| |=== |
| |Option|Description |
| |Transform Name|Name of the transform this name has to be unique in a single pipeline. |
| |URL|The base URL pointing to the WSDL document that will be retrieved |
| |Load (button)|The load button loads the WSDL at the specified URL and tries to automatically populate the input and output tabs and fields. |
| NOTE: If this doesn't work, you can still try to manually specify the input and output fields using the "Add Input" and "Add Output" buttons. |
| |The number of rows per call| |
| The number of rows to send with each WSDL call |
| |Pass input data to output| |
| If you disable this, the input will be eaten and only the WSDL output will be passed along to the next steps. |
| v2.x/3.x compatibility mode |
| We improved the parsing engine of the 3.x engine dramatically. For compatibility reasons, we kept the old engine around to make sure older steps would still work OK. |
| |Repeating element name| |
| Specify the name of the repeating element in the output XML (if any). |
| |HTTP authentication| |
| Here you can put the username and password if these are required for the web service. |
| |Proxy to use| |
| Here you can optionally put the proxy host and port information. |
| |Add Input / Add Output| |
| These buttons will allow you to manually specify the input and output specifications of the WSDL service. |
| Note: The data of the input fields can be escaped by the Calculator step and the function "Mask XML content from string A" |
| |=== |
