webMethods Integration Cloud and Cloud Deployment Documentation 5.6.0 | webMethods Integration Cloud | Integrations, Built-In Services, REST APIs, SOAP APIs, Doc Types, and Recipes | SOAP APIs | Creating SOAP APIs with WSDL
 
Creating SOAP APIs with WSDL
You can create a SOAP API from a WSDL document accessed through a URL or by selecting a WSDL file. You can specify whether Integration Cloud enforces strict, lax, or no content model compliance when generating document types from the XML Schema definition contained or referenced in the WSDL document. Content models provide a formal description of the structure and allowed content for a complex type. The type of compliance that you specify can affect whether Integration Cloud generates a document type from a particular XML Schema definition successfully.
Do not create a SOAP API from a WSDL that specifies RPC - Encoded, contains attributes in its operation signature, and/or has complex type definitions with mixed content. Integration Cloud might successfully create a SOAP API from such WSDLs but the SOAP API may exhibit unexpected runtime behavior.
* To create a SOAP API with WSDL
1. From the Integration Cloud navigation bar, click Projects > <Select a Project> > SOAP APIs.
The SOAP APIs page appears.
2. From the SOAP APIs page, click Add New SOAP API, select Build with WSDL, and then click OK.
The New SOAP API page appears.
3. Provide a name of your SOAP API and complete the following details. Required fields are marked with an asterisk on the screen.
Select...
To...
SOAP API Source
Specify the SOAP API Source.
URL - Select URL if you want to specify the URL of the WSDL. The WSDL URL should begin with http:// or https://. The URL is used to retrieve the WSDL for the SOAP API. Enter the User Name and Password if authentication is required to access the WSDL URL.
File - Select File and then click Browse if you want to select the WSDL from your local file system. The size of the WSDL file cannot exceed 5 MB. Click the icon beside the Browse button if you want to add separate elements of a service definition after import, such as WSDLs or XSDs, to the primary WSDL. Ensure that you add the primary WSDL as the first WSDL, and then add separate elements of the service definition, for example, dependent WSDLs and XSDs to the primary WSDL. If you upload a new file, Integrations and Document Types that are created are now based on the uploaded file.
Content model compliance
In Content model compliance, select one of the following to indicate how strictly Integration Cloud enforces content model compliance when creating document types from the XML Schema definition in the WSDL document.
*Strict - Generate the document type only if Integration Cloud can represent the content models defined in the XML Schema definition correctly. Document type generation fails if Integration Cloud cannot accurately represent the content models in the source XML Schema definition. Currently, Integration Cloud does not support repeating or nested model groups. If you select strict compliance, Integration Cloud does not generate a document type from any XML schema definition that contains those items. If Integration Cloud cannot generate a document type that complies with the content model in the XML schema definition in the WSDL document, Integration Cloud will not generate the SOAP API.
*Lax - When possible, generate a document type that correctly represents the content models for the complex types defined in the XML schema definition from the WSDL document. If Integration Cloud cannot correctly represent the content model in the XML Schema definition in the resulting document type, Integration Cloud generates the document type using a compliance mode of None. When you select Lax compliance, Integration Cloud will generate the document type even if the content models in the XML schema definition cannot be represented correctly.
*None - Generate a document type that does not necessarily represent or maintain the content models in the source XML Schema definition.
Enforce WS-I Basic Profile 1.1 compliance
Select this option if you want Integration Cloud to validate the SOAP API objects and properties against the WS-I requirements before creating the SOAP API. The Enforce WS-I Basic Profile 1.1 compliance option specifies whether the SOAP API enforces compliance with the WS-I Basic Profile 1.1, a set of guidelines for using web services specifications to maximize interoperability (including guidance for such core web services specifications such as SOAP, WSDL, and UDDI).
As an example, using the RPC-Encoded style and use is not supported by the WS-I profile. If a SOAP API makes use of the RPC/Encoded style, and Enforce WS-I Basic Profile 1.1 compliance is enabled, Integration Cloud will indicate that the SOAP API is not compliant.
Enforcing WS-I compliance also affects the contents and signature for operations in the SOAP API.
Validate schema using Xerces
Integration Cloud automatically uses an internal schema parser to validate the schemas associated with the XML Schema definition. Select this option if you want Integration Cloud to also use the Xerces parser to validate the schemas associated with the XML Schema definition. However, the Xerces parser provides stricter validation. As a result, some schemas that the internal schema parser considers to be valid might be considered invalid by the Xerces parser.
Attachment Enabled
The Attachment Enabled option is displayed when you edit the SOAP API. If attachments are enabled for the SOAP API, instances of XML-type base64Binary are transported using MIME attachments, which improves the performance of large binary payload transport. Integration Cloud supports SOAP attachments only for SOAP APIs that specify style/use of RPC-Literal or Document-Literal.
4. Click Save to create the SOAP API.
The SOAP API details page appears where you can edit the SOAP API.
5. Click the Operations tab to go to the Operations page. Integration Cloud uses the operation definitions from the WSDL to generate an Integration for each operation in the WSDL. You cannot add operations to a SOAP API created from a WSDL.
6. Click the WSDL tab to go to the WSDL page.
On the WSDL page, you can view the WSDL document associated with the SOAP API.
*The displayed WSDL document contains all the information to invoke the operations described in the WSDL.
*For a SOAP API created from a WSDL that contains relative URIs that are anonymously addressable, Integration Cloud replaces any relative URIs with an absolute URI using the base URI of the WSDL file.
Copyright © 2014- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.