Using the HTTP Connection Manager
Web Service comes with an SSIS connection manager component that can be used to establish HTTP connections.
To add a connection to your SSIS package, right-click the Connection Manager area in your Visual Studio project, and choose "New Connection..." from the context menu. You will be prompted the "Add SSIS Connection Manager" window. Select the "HTTP Connection Manager (KingswaySoft)" item to add the new connection manager.
The HTTP Connection Manager contains the following three pages to connect to the HTTP server.
- Advanced Settings
The General page on the HTTP Connection Manager allows you to specify general settings for the connection
- Base URL
The URL field represents the address of the web service to connect to.
- HTTP Method
The HTTP method to be used when accessing the web service. Options available are: GET, POST and DELETE. Typically POST should be used when your requests will have a body.
The Domain to use when accessing the web service.
The Username to use when accessing the web service.
- The Password to use when accessing the web service.
- Use Client Certificate
The use client certificate checkbox will determine if a client certificate will be used when accessing the web service. Checking this box will enable the "Certificate" button, which will allow a certificate to be chosen from the client certificates currently installed.
- Certificate Identifier
A description of the certificate that has been selected.
- Timeout (secs)
- The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds.
- Chunk Size (in KB)
- The chunk size to use when sending web requests. If a size of 0 is used chunking will not be used.
The Advanced Settings page on the HTTP Connection Manager allows you to specify some advanced and optional settings for the connection.
- Proxy Mode (since v2.1)
Proxy Mode option allows to specify how you want to configure the proxy server setting. There are three options available.
- No Proxy
- Auto-detect (Using system configured proxy)
- Proxy Server
Using Proxy Server option allows you to specify the name of the proxy server for the connection.
The Port option allows you to specify the port number of the proxy server for the connection.
- Username (Proxy Server Authentication)
Username option (under Proxy Server Authentication) allows you to specify the proxy user account.
- Password (Proxy Server Authentication)
Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.
NOTE: The Proxy Password is not included in the connection manager's ConnectionString property by default. This is by design for security reasons. However, you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be ProxyPassword=myProxyPassword; (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.
- Retry on Intermittent Errors
The retry on intermittent errors determines if requests will be retried when there is an error. If this option is checked requests will be retried up to 3 times.
- Custom Headers
Custom headers can be added to web requests. Specify the header name and value for each header that should be used.