Adding a Connection to SurveyMonkey

To add a connection to SurveyMonkey:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the SurveyMonkey icon is not available, click the Add More icon to download and install the SurveyMonkey connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to SurveyMonkey

SurveyMonkey provides two ways to connect to survey data:

• To use Basic authentication register a private application and obtain the personal access token.
• To connect with OAuth, either use the embedded OAuth credentials that come with SurveyMonkey, or create a custom OAuth application. For further information, see OAuth Authentication, below.

Authenticating to SurveyMonkey

Basic Authentication

Using basic authentication requires you to register a private application and obtain the personal access token.

After obtaining the personal access token, set these properties:

• AuthScheme = AccessToken
• AccessToken = enter the AccessToken generated in your application settings.

OAuth Authentication

SurveyMonkey provides embedded OAuth credentials that simplify connection from a Desktop application . To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth. (This is true regardless of whether you use the embedded OAuth credentials or create a custom OAuth application to connect.)

The following subsections describe how to authenticate to SurveyMonkey from the available OAuth flows. For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in SurveyMonkey, see Connection.

The Sync App offers the possibility to select surveys as relational tables.

Creating Surveys

You can create your own Surveys by performing the following steps:

1. In SurveyMonkey, go to the home page and click "Create Survey" on the vertical navigation bar.
2. Either start a new survey from scratch or pick one of the many templates SurveyMonkey offers.
3. Design and create new questions for your survey.
4. When finished, pick one of the options to share your survey and start receiving data from it.

Selecting Responses from Your Survey

To access the responses to your surveys, append _Responses to your table name, MySurvey_Responses in the query below.

SELECT RespondentId, QuestionText, ChoiceId, ChoiceText, ChoiceWeight FROM MySurvey_Responses

Selecting Questions from Your Survey

To access your survey questions, append _Questions to your table name, MySurvey_Questions in the query below.

SELECT QuestionId, QuestionFamily, QuestionSubtype, QuestionText, AnswerText FROM MySurvey_Questions

This section details a selection of advanced features of the SurveyMonkey Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to SurveyMonkey and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

You can access any survey, and related data, in your account. The CData Sync App models entities in the SurveyMonkey API as tables, views, and stored procedures.

These are defined in schema files, which are configuration files with a simple format that makes the schemas easy to extend.

Using Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to the SurveyMonkey APIs and then processes the rest of the query within the Sync App. The following sections document API limitations and requirements.

Views

The Sync App models surveys and survey statistics as relational Views. Views are tables that are typically read-only.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

SurveyMonkey Connector for CData Sync Views

Name	Description
CollectorMessages	Shows information regarding messages sent from a collector.
CollectorRecipients	Shows information regarding recipients of all or specific messages sent from a collector.
Collectors	Shows collector information.
CollectorStats	Shows statistics regarding all or specific messages sent from a collector.
ContactLists	Shows contact list information.
Contacts	Shows contact information.
Pages	Shows information regarding pages for a survey.
RollupQuestions	Shows rolled up individual stats information for a survey.
Rollups	Shows rolled up stats information for a survey.
SurveyQuestions	Shows the available columns for Survey Questions. Append _Questions to your survey name to query survey questions.
SurveyResponses	Shows the available columns for Survey Responses. Append _Responses to your survey name to query survey responses.
Surveys	Shows information regarding surveys.

Shows information regarding messages sent from a collector.

Table Specific Information

Select

You must specify the collector Id to query from this view. The Sync App will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM CollectorMessages WHERE CollectorId = '175305200'

SELECT * FROM CollectorMessages WHERE CollectorId = '175305200' AND Id = '57071816'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the message.
CollectorId	String	The Id of the collector this message belongs to.
Status	String	The status of this message.
Type	String	Message type: 'invite', 'reminder', or 'thank_you'.
Subject	String	The subject of this message. Only available if resource is being queried by Id.
Body	String	The html body of this message. Only available if resource is being queried by Id.
DateCreated	Datetime	Date message was created. Only available if resource is being queried by Id.
ScheduledDate	Datetime	Date message is scheduled to be sent. If Null, message has not been scheduled to send. Only available if resource is being queried by Id.
EmbedFirstQuestion	Boolean	Whether to embed the first question to the message. Only available if resource is being queried by Id.
EditMessageLink	String	The link to the resource to edit this message. Only available if resource is being queried by Id.
IsBrandingEnabled	Boolean	Whether branding is enabled for this message. Only available if resource is being queried by Id.
IsScheduled	Boolean	Whether this message is scheduled. Only available if resource is being queried by Id.
RecipientStatus	String	Recipient filter: 'reminder' or 'thank_you'. Only available if resource is being queried by Id.

Shows information regarding recipients of all or specific messages sent from a collector.

Table Specific Information

Select

You must specify the collector Id to query from this view. The Sync App will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200'

SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200' AND MessageId = '57071816'

SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200' AND Id = '4496877899'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the recipient.
CollectorId	String	The Id of the collector this recipient belongs to.
MessageId	String	The Id of the message this recipient belongs to. Null if it doesn't belong to a specific message.
Email	String	Email of recipient added to collector.
SurveyResponseStatus	String	If the recipient has completed the survey: 'not_responded', 'partially_responded', 'completely_responded'.
MailStatus	String	If an invite message to the recipient has been: 'sent', 'not_sent', or is 'processing'.
SurveyLink	String	Link to the survey in the invite.
RemoveLink	String	Unsubscribe link.

Shows collector information.

Table Specific Information

Select

You must specify the survey Id or the collector Id to query from this view. The Sync App will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM Collectors WHERE SurveyId = '126748712'

SELECT * FROM Collectors WHERE Id = '175305200'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the collector.
SurveyId	String	The Id of the Survey this collector belongs to. Only shows up if filtering Collectors by SurveyId.
Name	String	The name of the collector.
Status	String	Collector status: 'open' or 'closed'. Only available if resource is being queried by Id.
Type	String	Collector type: 'weblink' or 'email'. Only available if resource is being queried by Id.
ThankYouMessage	String	Message for thank you page. Only available if resource is being queried by Id.
DisqualificationMessage	String	Message for disqualification page. Only available if resource is being queried by Id.
ClosedPageMessage	String	Message shown when someone visits a closed survey. Only available if resource is being queried by Id.
DisplaySurveyResults	Boolean	Shows respondents survey instant results when they complete the survey. Only available if resource is being queried by Id.
EditResponseTypes	String	When respondents can edit their response: 'until_complete', 'never', or 'always'. Only available if resource is being queried by Id.
AnonymousType	String	Turns off IP tracking. For email collectors, also removes respondent email address and name from response: 'not_anonymous', 'partially_anonymous', 'fully_anonymous'. Only available if resource is being queried by Id.
SenderEmail	String	Sender email for email collectors. User's email is used if null. Only available if resource is being queried by Id.
Url	String	If collector is a Web Collector (type 'weblink') then the url for the collector. Only available if resource is being queried by Id.
RedirectType	String	Determines survey end page behavior: url (redirects to URL set in redirect_url or if none is set, shows standard SurveyMonkey thank you page), close (closes the survey window or tab), or loop (loops the survey back to the beginning, only available for weblink collectors with allow_multiple_responses:true). Only available if resource is being queried by Id.
RedirectUrl	String	Redirects respondent to this url upon survey completion. Only available if resource is being queried by Id.
AllowMultipleResponses	Boolean	Allows respondents to take a survey more than once from the same browser on the same computer. Only available for weblink collectors. Only available if resource is being queried by Id.
PasswordEnabled	Boolean	True if the collector is password protected. Only available for weblink collectors. Only available if resource is being queried by Id.
DateModified	Datetime	Date collector was last modified. Only available if resource is being queried by Id.
DateCreated	Datetime	Date collector was created. Only available if resource is being queried by Id.
CloseDate	Datetime	Close date of collector. Only available if resource is being queried by Id.

Shows statistics regarding all or specific messages sent from a collector.

Table Specific Information

Select

You must specify the collector Id to query from this view. The Sync App will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM CollectorStats WHERE CollectorId = '175305200'

SELECT * FROM CollectorStats WHERE CollectorId = '175305200' AND MessageId = '57071816'

Columns

Name	Type	Description
CollectorId	String	The Id of the collector these statistics belongs to.
MessageId	String	The Id of the message these statistics belong to. Null if they don't belong to a specific message.
Recipients	Integer	Count of recipients included in the stats.
CompletelyResponded	Integer	Count of recipients who have completed a survey response.
NotResponded	Integer	Count of recipients who have not started the survey.
PartiallyResponded	Integer	Count of recipients who have begun the survey but not completed it.
Opened	Integer	Count of recipients that have opened the message.
OptedOut	Integer	Count of recipients that have clicked on the opt out link.
NotSent	Integer	Count of recipients that have been added but their message has not been delivered.
Sent	Integer	Count of recipients that messages have been sent to.
Bounced	Integer	Count of recipients with messages that bounced.
LinkClicked	Integer	Count of messages where the included survey link was clicked on.

Shows contact list information.

Select

The Sync App will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM ContactLists WHERE Id = '123740269'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the contact list.
Name	String	The name of the contact list.

Shows contact information.

Select

The Sync App will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM Contacts WHERE Id = '2842583326'

SELECT * FROM Contacts WHERE ContactListId = '123679423'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the contact.
ContactListId	String	Use this to filter contacts only from the given ContactListId.
FirstName	String	The first name of the contact.
LastName	String	The last name of the contact.
Email	String	The email of the contact.
CustomField1	String	The value of the first custom field for this contact.
CustomField2	String	The value of the second custom field for this contact.
CustomField3	String	The value of the third custom field for this contact.
CustomField4	String	The value of the fourth custom field for this contact.
CustomField5	String	The value of the fifth custom field for this contact.
CustomField6	String	The value of the sixth custom field for this contact.

Shows information regarding pages for a survey.

Table Specific Information

Select

You must specify the survey Id for this view to see page information for the survey. The Sync App will execute other filters client-side in memory.

For example, the following query is processed server side:

SELECT * FROM Pages WHERE SurveyId = '1231231'
 
SELECT * FROM Pages WHERE SurveyId = '1231231' AND Id = '1234567'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the page.
SurveyId	String	The Id of the survey.
Title	String	The title of the page.
Description	String	The description of the page.
Position	Integer	The ordinal position of the page.
QuestionCount	Integer	The number of questions in this page.

Shows rolled up individual stats information for a survey.

Select

You must specify the survey Id for this view to see roll up stats for the survey. The Sync App will execute other filters client-side in memory.

For example, the following query is processed server side:

SELECT * FROM RollupQuestions WHERE SurveyId = '1231231' 

Columns

Name	Type	Description
SurveyId	String	The Id of the survey.
QuestionId	String	The Id of the question
ResponseCount	Integer	Number of people which answered by selecting this choice.
ResponseTextCount	Integer	Number of people which answered by writing in a text.
ChoiceId	String	The Id of the response.
Other	Boolean	Whether the selected choice was an other response.
Ordinal	Int	The number of the order this choice appears in the list of choices. Ordinals are used to get a meaningful representation for stats like maximum, minimum, average, median, and standard deviation.
Max	Double	The maximum value of the ordinals of the answered choices.
Min	Double	The minimum value of the ordinals of the answered choices.
Mean	Double	The average value of the ordinals of the answered choices.
Median	Double	The median value of the ordinals of the answered choices.
Std	Double	The standard deviation value of the ordinals of the answered choices.

Shows rolled up stats information for a survey.

Table Specific Information

Select

You must specify the survey Id for this view to see roll up stats for the survey. The Sync App will execute other filters client-side in memory. For example, the following query is processed server side:

SELECT * FROM Rollups WHERE SurveyId = '1231231' 

Columns

Name	Type	Description
SurveyId	String	The id of the survey.
QuestionId	String	The id of the question
Family	String	The family this question belongs to.
Subtype	String	The subtype this question belongs to.
Answered	Integer	Number of people who answered this question by picking one of the given choices.
AnsweredOther	Integer	Number of people who answered this question by picking the other option.
Skipped	Integer	Number of people who skipped this question.

Shows the available columns for Survey Questions. Append _Questions to your survey name to query survey questions.

Select

To query the SurveyQuestions view, you must use the name of the survey and append '_Questions' to the end. For some question types when the specific id is not applicable the value will be represented as '0'

SELECT * FROM [Volunteer Feedback Template_Questions]

SELECT * FROM [Benefits Template_Questions]

Columns

Name	Type	Description
SurveyId	String	The id of the survey.
QuestionId	String	The id of the question.
QuestionPosition	Integer	The position of that query in the Survey.
QuestionText	String	The text of the question.
QuestionFamily	String	The family of the question.
QuestionSubtype	String	The subtype of the question.
ChoiceId	String	The id of the choice.
ChoiceText	String	The text of the choice.
ChoiceWeight	String	The weight of the choice. Used in questions of the subtype rating and ranking. Usually it's an ordinal number in incremenenting order.
ChoiceScore	Int	This field is dynamic and maps to the corresponding report field.
RowId	String	The id of the row.
RowText	String	The text of the row.
ColId	String	The id of the column.
ColText	String	The text of the column.
PageId	String	The id of the page.
PageTitle	String	The title of the page.

Shows the available columns for Survey Responses. Append _Responses to your survey name to query survey responses.

Select

To query the SurveyResponses view, you must use the name of the survey and append '_Responses' to the end.

The Sync App uses the SurveyMonkey APIs to filter results by the following columns and operators:

• DateCreated/DateModified and TotalTime: > and <
• RespondentId: =
• QuestionId: = and IN
• ResponseStatus, IpAddress, and TotalTimeUnit: =

The Sync App processes other filters client-side within the Sync App.

For example, the following queries are processed server side:

SELECT * FROM [Volunteer Feedback Template_Responses]

SELECT * FROM [Benefits Template_Responses]

SELECT * FROM [Benefits Template_Responses] WHERE RespondentId = '1234567890'

SELECT * FROM [Benefits Template_Responses] WHERE RespondentId IN ('1234567890', '0987654321')

SELECT * FROM [Benefits Template_Responses] WHERE DateCreated > '2018-01-01' AND DateCreated < '2018-01-30'

SELECT * FROM [Benefits Template_Responses] WHERE QuestionId = '213965574'

SELECT * FROM [Benefits Template_Responses] WHERE QuestionId IN ('213965574', '213963957')

SELECT * FROM [Benefits Template_Responses] WHERE TotalTime > 5 AND TotalTime < 10 AND TotalTimeUnit = 'minute'

SELECT * FROM [Benefits Template_Responses] WHERE IpAddress = '192.168.0.1'

SELECT * FROM [Benefits Template_Responses] WHERE ResponseStatus = 'completed'

Note: When selecting a specific respondent, the aggregate column "Metadata" will be populated with a JsonObject and its elements can be accessed using the JSON_EXTRACT function in the SQLQuery.

Columns

Name	Type	Description
RespondentId	String	The id of the respondent, the person who answered this question.
SurveyId	String	The id of the survey.
RecipientId	String	The id of the recipient.
PageId	String	The id of the page.
QuestionId	String	The id of the question.
QuestionText	String	The text of the question.
ChoiceId	String	The id of the choice.
ChoiceText	String	The text of the choice.
ChoiceWeight	String	The weight of the choice. Used in questions of the subtype rating and ranking. Usually it's an ordinal number in incremenenting order.
ChoiceScore	Int	This field is dynamic and maps to the corresponding report field.
IsCorrectChoice	Boolean	This field is dynamic and maps to the corresponding report field.
RowId	String	The id of the row.
RowText	String	The text of the row.
ColId	String	The id of the column.
ColText	String	The text of the column.
OtherId	String	The id of the other field.
OtherText	String	The text of the other field.
AnswerText	String	The text of the answer (in the case of an open-ended question).
CollectionMode	String	The mode of collection.
CollectorId	String	The id of the collector the response was taken for.
TotalTime	String	Total time spent on this survey.
ResponseStatus	String	The status of the response. Valid values are `completed`, `partial`, `overquota`, and `disqualified`.
DateCreated	Datetime	Date and time when survey was created.
DateModified	Datetime	Date and time when survey was last modified.
CustomValue	Integer	A custom value for this response.
EditUrl	String	Survey edit URL.
AnalyzeUrl	String	Survey analyze URL.
IpAddress	String	The IP address of the respondent.
QuizCorrectAnswers	Int	This field is dynamic and maps to the corresponding report field.
QuizIncorrectAnswers	Int	This field is dynamic and maps to the corresponding report field.
QuizPartiallyCorrectAnswers	Int	This field is dynamic and maps to the corresponding report field.
QuizTotalScore	Int	This field is dynamic and maps to the corresponding report field.
QuizTotalQuestions	Int	This field is dynamic and maps to the corresponding report field.
QuizMaxScore	Int	This field is dynamic and maps to the corresponding report field.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
TotalTimeUnit	String	The unit of time you want to filter total time values with. Valids units are `second`, `minute`, and `hour`. If not specified, it will use `second` as a default value. This only affects the filtering on SurveyMonkey's end. The values returned for TotalTime from the API will still be in seconds despite what value is being sent for TotalTimeUnit.

Shows information regarding surveys.

Columns

Name	Type	Description
Id [KEY]	String	The Id of the survey.
Title	String	The title of the survey.
Nickname	String	The nickname of the survey.
Category	String	The Category of the survey.
DateCreated	Datetime	The Date that the survey was created.
DateModified	Datetime	The Date that the survey was modified.
FolderId	String	If specified, adds the survey to the folder with that id.
IsOwner	Boolean	Is Owner of the survey.
Language	String	Language of the survey.
QuestionCount	Int	The number of questions in survey.
ResponseCount	Int	The number of responses survey has received.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	The type of authentication to use when connecting to SurveyMonkey.
AccessToken	The Access Token of the SurveyMonkey application.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
Scope	The Scope supplied from the app settings.
AccessURL	The URL to get the data from. Depends on the originating datacenter of the SurveyMonkey account.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from SurveyMonkey.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
ShowCustomVariables	A boolean determining if custom variables and their values should be listed when querying Survey_Responses.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The type of authentication to use when connecting to SurveyMonkey.
AccessToken	The Access Token of the SurveyMonkey application.

The type of authentication to use when connecting to SurveyMonkey.

Remarks

• OAuth: Set to this to perform OAuth authentication.
• AccessToken: Set this to perform Access Token authentication. Provide value for [AccessToken] connection property.

The Access Token of the SurveyMonkey application.

Remarks

The Access Token of the SurveyMonkey application.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
Scope	The Scope supplied from the app settings.
AccessURL	The URL to get the data from. Depends on the originating datacenter of the SurveyMonkey account.

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

The Scope supplied from the app settings.

Remarks

The Scope supplied from the app settings. Recommended to be specified when using a custom app.

The URL to get the data from. Depends on the originating datacenter of the SurveyMonkey account.

Remarks

The URL to get the data from. Depends on the originating datacenter of the SurveyMonkey account. By default takes the value returned when performing the GetOAuthAccessToken procedure. Change this if you are using the AccessToken AuthScheme and your accounts datacenter AccessURL is different from https://api.surveymonkey.net.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to SurveyMonkey and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\SurveyMonkey Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from SurveyMonkey.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
ShowCustomVariables	A boolean determining if custom variables and their values should be listed when querying Survey_Responses.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

The maximum number of results to return per page from SurveyMonkey.

Remarks

The Pagesize property affects the maximum number of results to return per page from SurveyMonkey. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

A boolean determining if custom variables and their values should be listed when querying Survey_Responses.

Remarks

A boolean determining if custom variables and their values should be listed when querying Survey_Responses.

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM MySurvey_Responses WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.

Boolean determining if simple names should be used for tables and columns.

Remarks

SurveyMonkey tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Sync App easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.