Web Service Consumer Transformation Output Mapping
When you view the transformation ports, show the output mapping to view the operation output hierarchy. When you show the output mapping, you can define output groups, define output ports, and map operation output nodes to output ports.
The output mapping includes the following areas:
- Operation Output
- The Operation Output area shows the nodes in the SOAP response message that the web service returns to the Web Service Consumer transformation. The WSDL data object that you use to create the transformation defines the operation output hierarchy.
- Ports
- Create the transformation output groups and ports in the Ports area.
The following figure shows the output mapping for a non-reusable Web Service Consumer transformation:
After you create output ports, map the nodes from the Operation Output area to the ports in the Ports area. When you map a node from the operation output to an output port, the location of the node appears in the Location column in the Ports area.
The Developer tool maps nodes in the first level of the operation output to output ports when you choose to map the first level of the output hierarchy. The Developer tool also creates the ports to perform the mapping. If the first level of the hierarchy contains a multi-occurring parent node with one or more multi-occurring child nodes, the Developer tool does not map the first level of the hierarchy.
You can choose to display the output ports in a hierarchy. Each child group appears under the parent group. You can also choose to view the lines that connect the nodes in the operation output to the output ports.
If the associated WSDL data object is deleted from the repository, the Developer tool retains the location of the operation nodes in the output mapping. When you show the output mapping, the Ports area still displays the location of the operation nodes in the Location column for the output ports. If you associate another WSDL with the transformation, the Developer tool checks whether each location is valid. The Developer tool clears the location of operation nodes in the Ports area of the output mapping if the location is no longer valid.
Rules and Guidelines to Map Nodes to Output Ports
Review the following rules when you map nodes in the operation output hierarchy to output ports:
- •The operation output node and the output port must have compatible datatypes.
- •You cannot map a node to more than one output port in a group.
- •Each output port must have a valid location, unless the port is a pass-through port.
- •If you drag a multiple-occurring child node to an empty output port, you must relate the group to other output groups. When you select a group, the Developer tool creates keys to relate the groups.
- •When you drag a multiple-occurring element into a group that contains the parent element, you can configure the number of child element occurrences to include. Or, you can replace the parent group with the multiple-occurring child group in the transformation output.
Mapping the SOAP Message as XML
You can map the complete SOAP message as XML instead of returning the data to separate output ports.
When you map the SOAP message as XML, the Data Integration Service returns the complete SOAP message in one port. Do not create output ports.
To map the complete message, right-click the root group in the Operation Output area. Select Map as XML.
The Developer tool creates a string output port. The precision is 65535 bytes.
Customize View Options
You can change the operation output hierarchy to show the cookie ports, pass-through ports, and keys in the Operation Output area. You can also show grouping constructs that define how to order nodes.
Click the Customize View button in the Operation Output area. Enable any of the following options:
- Sequence, Choice, and All
- Show a line that indicates whether an element definition is sequence, choice, or all.
- Nodes in an all group must all be included in the SOAP message.
- Nodes in a sequence group must be in the order specified in the WSDL.
- At least one node in a choice group must appear in the SOAP message.
- Keys
- View the keys in the Operation Output area. The Operation Output area includes keys for each group. You can add a key to an output port in the Ports area.
- Pass-through Ports
- The Operation Output area shows the pass-through ports. Pass-through ports are ports that pass data through the transformation without changing the data. You can project pass-through ports from the operation output to any of the Web Service Consumer transformation output groups. A pass-through port receives data one time, so the port is at the root level in the SOAP messages.
- Cookie Ports
- Shows the cookie port. When you configure cookie authentication, the remote web service server tracks the web service consumer users based on the cookies. When you project a web service cookie in the request message, the web service returns a cookie in the response message. You can project the cookie from the operation output to any of the Web Service Consumer transformation output groups.
Mapping the Operation Output to Output Ports
When you show the transformation output mapping, you can define output groups, define output ports, and map operation output nodes to output ports.
1. Open a Web Service Consumer transformation.
2. To show the transformation output mapping, use one of the following methods:
- - For a reusable transformation, click the Overview view. Choose to show the output mapping.
- - For a non-reusable transformation, click the Ports tab in the Properties view. Choose to show the output mapping.
3. To add an output group or port to the Ports area, use one of the following methods:
Option | Description |
---|
Drag a node | Drag a group node or a child node in the Operation Output area to an empty column in the Ports area. If the node is a group node, the Developer tool adds a group without ports. |
Manually add a group or port | To add a group, click the arrow next to the New button and then click Group. To add a port, click the arrow next to the New button and then click Field. |
Drag a port from another transformation | In the editor, drag a port from another transformation to the Web Service Consumer transformation. |
Copy a port | Select ports from another transformation and copy them to the Ports area. To copy ports, you can use keyboard shortcuts or you can use the copy and paste buttons in the Developer tool. |
Select Map first level of hierarchy | Select Map first level of hierarchy. The Developer tool maps nodes in the first level of the operation output to output ports and groups. The Developer tool also creates the output ports and groups to perform the mapping. |
4. If you manually create a port or you copy a port from another transformation, click the Location column in the Ports area and choose a node from the list.
5. To clear the locations of ports, use one of the following methods:
Option | Description |
---|
Click Clear | Select one or more ports in the Ports area and click Clear. |
Delete the lines that connect nodes to ports | Select one or more lines that connect the nodes in the operation output to the output ports and press Delete. |
6. If the associated WSDL data object includes anyType elements, any elements, anyAttribute attributes, derived type elements, or substitution groups, choose objects in the Operation Output area. In the Type column for a node, click Choose and then choose one or more types, elements, or attributes from the list.
7. To map the complete SOAP response message as XML, right-click the root group in the Operation Output area and select Map as XML.