Using the Web Service Destination Component
The Web Service Destination Component is an SSIS data flow pipeline component that can be used to execute operations of a web service.
- Error Handling
The General page is used to specify general settings for the Web Service Destination Component. The Columns page is used to manage columns from the upstream component.
The General page allows you to specify general settings for the component.
- Connection Manager
The Web Service Source Component requires a connection in order to connect to the web service. The Connection Manager drop-down will show a list of all connection managers that are available to your current SSIS package.
Note that the Connection Managers offered within this toolkit are the following:
- HTTP Connection Manager
- Source File Path
The Source WSDL specifies the location of the WSDL that you are trying to read from. This location can be either a location on the file system, or a URL. For example a value of: c:\wsdl\mathservice.wsdl or http://localhost:28854/MathService.svc?wsdl will both work. There is a button labelled "..." beside the source WSDL field that will launch a dialog let you select a file from the file system. If you select a WSDL file using the open file dialog provided by the "..." button the WSDL file will automatically be loaded upon clicking OK.
- Load WSDL button
The Load WSDL button will try to load a WSDL file from the location specified in the Source WSDL field, and it will populate the other fields in the editor with information from the loaded WSDL file. Use this button after you have entered the path of a WSDL file into the source WSDL field. If you select a WSDL file from the open file dialog provided by the "..." button the WSDL file will automatically be loaded upon clicking OK.
Select a Service from the list of services contained in the web service.
Select a Binding from the list of bindings contained in the service.
Select an Operation from the list of operations contained in the binding.
- Custom SOAP Headers
Custom soap headers can be specified in the Custom SOAP Headers grid. Enter any namespaces, separated by semi colons, in the first column, and the header in the second column. Namespaces will be added to the SOAP envelope.
- Refresh Component Button
Clicking the Refresh Component button will reload the WSDL file, update the options for the service, binding and operation fields, update output columns, and show a dialog with information about changes to the output columns. A similar process occurs when the Load WSDL button is clicked, but a dialog about updated output columns is not displayed.
- Map Unmapped Fields Button
By clicking this button, the component will try to map any unmapped attributes by matching their names with the input columns from upstream components.
- Clear All Mappings Button
By clicking this button, the component will reset (clear) all your mappings in the destination component.
The Columns page of the Web Service Destination Component allows you to map the columns from upstream components to the Web Service Destination Component Fields. The web service will be called once for each row of input data using.
In the Columns page, you would see a grid that contains four columns as shown below.
- Input Column - You can select an input column from an upstream component for the corresponding Web Service Destination field.
- Destination Field - The field that you are writing data to.
- Data Type - This column indicates the type of value for the current field.
- Unmap - This column can be used to unmap the field from the upstream input column, or otherwise it can be used to map the field to an upstream input column by matching its name if the field is not currently mapped.
Error Handling page
The Error Handling page allows you to specify how errors should be handled when they happen.
There are three options available.
- Fail on error
- Redirect rows to error output
- Ignore error
When the Redirect rows to error output option is selected, rows that failed to write to the Web Service Destination will be redirected to the 'Error Output' output of the component. As indicated in the screenshot below, the blue output connection represent rows that were successfully written, and the red 'Error Output' connection represents rows that were erroneous. The 'ErrorMessage' output column found in the 'Error Output' may contain the error message that was reported by server or the component itself.