Understanding the Consume Web Service Wizard

This section discusses the Consume Web Service wizard.

The Consume Web Service wizard supports:

  • WS-interoperability standards for WSDL.

  • Consumption of WSDL version 1.1 documents.

  • Consuming WSDL with SOAP, HTTP–GET/POST bindings.

  • Nested URIs to resolve WSDL fragments.

You can consume WSDL documents for the following service operation types:

  • Synchronous.

  • Asynchronous one-way.

  • Asynchronous request/response.

You can use the Consume Web Service wizard to consume WSDL documents from the following sources:

  • UDDI repositories.

  • WSDL URL.

  • WSIL registries.

  • File.

  • Legacy PeopleSoft WSDL documents.

The Consume Web Service wizard creates the following integration metadata in the PeopleSoft system from the consumed WSDL documents:

Note: The internal name is the name that the PeopleSoft system assigns to the metadata and is the definition name that appears in the PeopleSoft system.

Metadata

Internal Name

Version

Comments

Service definitions

System generated name in the format:<WSDL service name>_ <four random generated numbers>.

Version one, denoted as:

.V1

NA

Service operation definitions

System generated name in the format:<WSDL Service Operation Name>_ <four random generated numbers>.

Version one, denoted as:

.V1

NA

Message definitions

System-generated name in the format: M<unique number>.

For example: M120508438.

Version one, denoted as:

.V1

By default, the system creates document type messages.

Includes request messages, response messages. and fault messages, as appropriate.

You can rename the system-generated message names in the wizard using more meaningful names.

The consume process also generates schemas for each message. All schemas are unstructured.

If you chose not to create document type messages, it creates nonrowset-based or container messages with references to schemas.

Note: Any integers or decimals not defined with a length in the WSDL will be defined in the document as unbounded. The maximum length that fields are defined in the database for Number or Signed Number is 31, which includes the negative (if applicable) and the fractional part (for decimal). If the value needs to be larger than 31, string should be used.

Additional information about messages that the Consume Web Service wizard generates is featured in this section.

Document definitions

The following metadata names are system generated:

  • Package name: <Service_Name>.

  • Document name: <WSDL_ Operation (input/output)_Message_Name>.

Version one, denoted as:

.V1

NA

Routing definitions

System-generated name in the format ~IMPORTED~<unique number>.

For example: ~IMPORTED~14857.

Version one, denoted as:

.V1

System creates a point-to-point routing.

By default, the system creates document type messages based on the message schema(s). Documents generated are restricted. To modify the document, you must use the Restricted Documents page to clear the restricted status.

If the system cannot create document type messages or if you chose not to create document type messages, it creates nonrowset-based or container messages with references to schemas.

By default, the Consume Web Service wizard builds document type messages and will create a single fault message.

To read faults in document type messages generated by the Consume Web Service wizard, use the GetContentString() method of the Message object.

To process multiple faults, you can examine the stored WSDL generated by the wizard.

Another option to capturing and reading multiple faults is to clear the Build Document Messages option in Step 1 of the wizard so that the system generates nonrowset–based messages. If generating nonrowset-based messages, PeopleSoft Integration Broker creates a part message for each fault in the WSDL operation. The system then creates a container message and places the fault part messages in the container. The container message is assigned as a fault message to the created service operation.

In a WSDL document, the schema defined in the <types> section may have multiple root elements, corresponding to multiple messages used by one or more operations. When the PeopleSoft system consumes such a WSDL document, the entire message schema contained in the WSDL document gets associated with each of the service operation messages when the PeopleSoft system generates the integration metadata.

Use the element name that appears in the Comments text box of the message definition to construct the XML data for the correct schema fragment in the message.

PeopleSoft delivers a queue, WSDL_QUEUE, and a node, WSDL_NODE, that the Consume Web Service wizard uses as defaults.

You may use these objects or select other existing queues or nodes.

The binding style of consumed WSDL documents appears in the service operation definition for the consumed service. The Default Service Operation Version section of the Service Operations page features a Comments box. The binding style appears in that box.

If a WSDL document has two port types with a single input message in each operation, the Consume Web Service wizard displays step where you can convert a pair of asynchronous one-way operations to a single asynchronous request/response operation. In this step you can special the request and callback service operations and convert the operation.