Setup a SurveyMonkey REST Connection Manager
The REST Connection Manager is an SSIS connection manager component that can be used to establish connections with SurveyMonkey REST service to help facilitate SurveyMonkey data integration.
See SurveyMonkey REST Source Component for how to retrieve data from SurveyMonkey & SurveyMonkey REST Destination Component for how to write to SurveyMonkey.
To add a new connection, 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 "REST (KingswaySoft)" item to add a new REST Connection Manager.
The REST Connection Manager contains 2 pages of configuration.
- General
- Advanced
General page
The General page allows you to specify connection properties and login credentials for SurveyMonkey REST service:
- Service Name
-
The REST service that will be connected to.
- Generate Token (In App)...
-
The Generate Token File (In App)... button completes the entire OAuth authentication process inside of the toolkit. All you need to do is login to the service endpoint and authorize our app to generate your token.
- Generate Token (In Browser)...
-
The Generate Token File (In Browser)... button completes the OAuth authentication using your default browser. After you click this button simply follow the steps in the dialog to generate your token.
- Access Token
-
If you have an Access Token that you would like to use, enter it in the access token field. If you do not have a SurveyMonkey access token you can generate one by clicking the Generate Token button.
- Base URL
-
The Base URL to use when accessing SurveyMonkey service.
- API Throttle Rate
-
The API Throttling Rate will limit the number of requests that can be sent per second.
- Test Connection
-
After all the connection information has been provided, you may click the "Test Connection" button to test if the user credentials entered can connect to the selected REST service.
Advanced page
- Proxy Mode
-
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)
- Manual
- Proxy Server
-
Using Proxy Server option allows you to specify the name of the proxy server for the connection.
- Port
-
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.
- Timeout
-
The number of seconds requests should wait before timing out.
- Retry on Intermittent Errors
-
The retry on intermittent errors option determines if requests will be retried when there is an error. If this option is checked requests will be retried up to 3 times.