Create a connection to Sansan by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Sansan icon is not available, click the Add More icon to download and install the Sansan connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to Sansan

When using the CData Sync App to connect to Sansan, APIKey is required.

Configure Access to Sansan

To obtain the APIKey, follow the steps below:

• Log in to the Sansan management page [https://ap.sansan.com/v/home/] and go to "3rd Party Integration" -> "API".
• Select the target department from the "Please select department" pull-down list.
• Select the target user from the "Please select user" pull-down list.
• Click the "Issue" button to generate the API key.

Authenticate to Sansan Account

Set the following connection property to connect:

• APIKey: Set the API Key. This is the key obtained from your Sansan management screen.

This section details a selection of advanced features of the Sansan 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 Sansan 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.

The CData Sync App models Sansan objects as relational tables and views. A Sansan object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Sansan APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

The Sync App offloads as much of the SELECT statement processing as possible to the Sansan APIs and then processes the rest of the query in memory. See SupportEnhancedSQL for more information on how the Sync App circumvents API limitations with in-memory client-side processing.

The Sync App models the data in Sansan into a list of tables that can be queried using standard SQL statements.

Generally, querying Sansan tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Sansan Connector for CData Sync Tables

Name	Description
Bizcards	Create and query all the Bizcards that the user has scanned or those that the organization has

Create and query all the Bizcards that the user has scanned or those that the organization has

Table Specific Information

Select

The Sync App will use the Sansan API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver. For example, the following query is processed server side:

SELECT * FROM Bizcards

SELECT * FROM Bizcards WHERE UpdatedTime>'2018-03-14'

SELECT * FROM Bizcards WHERE UpdatedTime='2018-03-14 18:35:06.0'

SELECT * FROM Bizcards WHERE UpdatedTime>'2018-03-14' AND UpdatedTime<'2019-03-14'

SELECT * FROM Bizcards WHERE Email='[email protected]'

SELECT * FROM Bizcards ORDER BY UpdatedTime Desc

SELECT * FROM Bizcards ORDER BY RegisteredTime

SELECT * FROM Bizcards WHERE CONTAINS(CompanyName, 'kei') AND CONTAINS(Tel, '7390') AND CONTAINS(Mobile, '7415')

SELECT * FROM Bizcards WHERE SearchTerm = 'kei'

We can override the Range connection property by specifing it inside the query for ex.:

SELECT * FROM Bizcards WHERE Range='me'

Insert

INSERT INTO Bizcards ('OwnerId', 'FirstName', 'LastName', 'SharingPermissionsEmail') VALUES ('afd425d', 'John', 'Doe', true)

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name	Type	ReadOnly	Description
BizcardId [KEY]	String	True	The Id of the Bizcard
CompanyId	String	True	The Id of the Company
PersonId	String	True	The Id of the person
ExchangeDate	Date	False	The date when Bizcards were exchanged
RegisteredTime	Datetime	True	The datetime when the Bizcard was registered
UpdatedTime	Datetime	True	The datetime when the Bizcard was last updated
OwnerId	String	False	The Id of the owner
OwnerName	String	True	The name of the owner
OwnerEmail	String	True	The email of the owner
LastName	String	False	The last name found on Bizcard
FirstName	String	False	The first name found on Bizcard
LastNameReading	String	False
FirstNameReading	String	False
DepartmentName	String	False	The name of the department found on Bizcard
Title	String	False	The title found on Bizcard
Email	String	False	The email found on Bizcard
Mobile	String	False	The mobile number found on Bizcard
CompanyName	String	False	The company name found on Bizcard
CountryCode	String	False	The country code found on Bizcard
PostalCode	String	False	The postal code found on Bizcard
Address	String	True	The address found on Bizcard
Prefecture	String	False	The prefecture found on Bizcard
City	String	False	The city found on Bizcard
Street	String	False	The street found on Bizcard
Building	String	False	The building found on Bizcard
Tel	String	False	The telephone number found on Bizcard
SecondTel	String	False	The second telephone number found on Bizcard
Fax	String	False	The fax number found on Bizcard
Url	String	False	The url found on Bizcard
Memo	String	False	The memo found on Bizcard
EntryStatus	String	True	The status of the Bizcard {processing, completed, unreadable}
IsUserCreated	Boolean	True	Determines if the bizcard has been created by the user or not
HasUnrecognizedChar	Boolean	True	Determines if the bizcard has unrecognized char or not
TagId	String	False	The tag ID to be linked to the business card. This column is supported for Insert only.
SharingPermissionsCompanyInformation	Boolean	False	Company information public/private setting. This column is supported for Insert only.
SharingPermissionsName	Boolean	False	Name public/private setting. This column is supported for Insert only.
SharingPermissionsExchangeDate	Boolean	False	Exchange date public/private setting. This column is supported for Insert only.
SharingPermissionsContact	Boolean	False	Contact public/private setting. This column is supported for Insert only.
SharingPermissionsMobile	Boolean	False	Mobile public/private setting. This column is supported for Insert only.
SharingPermissionsEmail	Boolean	False	Email public/private setting. This column is supported for Insert only.
SharingPermissionsMemo	Boolean	False	Memo public/private setting. This column is supported for Insert only.
SharingPermissionsOthers	Boolean	False	Others public/private setting. This column is supported for Insert only.

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
Range	String	Used to override the range connection property
SearchTerm	String	Search FirstName or LastName starting by criteria

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Sansan Connector for CData Sync Views

Name	Description
BizcardTags	Join Table for Tags and Bizcards
Contacts	Get a Set of contacts. The contacts are ordered by update time.
ExternalAttendees	Usage information for the operation ExternalAttendees.rsd.
InternalAttendees	Usage information for the operation InternalAttendees.rsd.
Tags	Returns all tags created by user or organization tags

Join Table for Tags and Bizcards

Table Specific Information

Select

The Sync App will use the Sansan API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver. For example, the following query is processed server side:

SELECT * FROM BizcardTags

We can override the Range connection property by specifing it inside the query for ex.:

SELECT * FROM BizcardTags WHERE Range='me'

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name	Type	Description
BizcardId [KEY]	String	The Id of the Bizcard
TagID [KEY]	String	The Id of the Tag

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
Range	String	Used to override the range connection property

Get a Set of contacts. The contacts are ordered by update time.

Table Specific Information

Select

The Sync App will use the Sansan API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver. For example, the following query is processed server side:

SELECT * FROM Contacts

SELECT * FROM Contacts WHERE UpdatedTime>'2018-03-14'

SELECT * FROM Contacts WHERE UpdatedTime='2018-03-14 18:35:06.0'

SELECT * FROM Contacts WHERE UpdatedTime>'2018-03-14' AND UpdatedTime<'2019-03-14'

SELECT * FROM Contacts WHERE Type='Meeting'

SELECT * FROM Contacts WHERE Categories='category'

SELECT * FROM Contacts ORDER BY UpdatedTime Desc

SELECT * FROM Contacts ORDER BY RegisteredTime

We can override the Range connection property by specifing it inside the query for ex.:

SELECT * FROM Contacts WHERE Range='me'

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name	Type	Description
Id [KEY]	String	The identifier of teh contact.
RegisteredTime	Datetime	The datetime when the contact has been created.
UpdatedTime	Datetime	The datetime when the contact has been modified for the last time.
StartDate	Date
StartTime	Datetime
EndDate	Date
EndTime	Datetime
OwnerId	String	The identifier of the owner.
OwnerName	String	The name of the owner.
OwnerEmail	String	The email of the owner.
Type	String	The type of the contact.
Categories	String	The contact categories.
Title	String	The title of the contact.
Location	String	The location of the contact.
Memo	String	The memo of the contact.
ExternalAttendees	String	The external attendees associated with the contact.
InternalAttendees	String	The internal attendees associated with the contact.

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
Range	String	Used to override the range connection property
Rows@Next	String	Identifier for the next page of results. Do not set this value manually.

Usage information for the operation ExternalAttendees.rsd.

Table Specific Information

Select

Everything will be executed client side within the driver.

Columns

Name	Type	Description
ContactId [KEY]	String	The identifier of the contact associated with the attendee.
Id [KEY]	String	The identifier of the attendee.
PersonId	String	The person identifier associated with the attendee.
CompanyName	String	The company where the attendee belongs to.
LastName	String	The last name of the attendee.
FirstName	String	The first name of the attendee.

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
Range	String	Used to override the range connection property
Rows@Next	String	Identifier for the next page of results. Do not set this value manually.

Usage information for the operation InternalAttendees.rsd.

Table Specific Information

Select

Everything will be executed client side within the driver.

Columns

Name	Type	Description
ContactId [KEY]	String	The identifier of the contact associated with the attendee.
Id [KEY]	String	The identifier of the attendee.
Name	String	The name of the attendee.
DepartmentName	String	The department where the attendee belongs to.

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
Range	String	Used to override the range connection property
Rows@Next	String	Identifier for the next page of results. Do not set this value manually.

Returns all tags created by user or organization tags

Table Specific Information

Select

The Sync App will use the Sansan API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver. For example, the following query is processed server side:

SELECT * FROM Tags

We can override the Range connection property by specifying it inside the query for ex:

SELECT * FROM Tags WHERE Range='me'

We can also get all Tags of a Bizcard by specifying the BizcardId in the query for ex:

SELECT * FROM Tags WHERE BizcardId='00E683BEE2DFC04399B3CC8DA5591A24'

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name	Type	Description
TagID [KEY]	String	The Id of the Tag
Name	String	The name of the Tag
Type	String	The type of the Tag {public, shared, private}
OwnerID	String	The Id of the owner
OwnerName	String	The name of teh owner
OwnerEmail	String	The email of the owner

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
Range	String	Used to override the range connection property
BizcardId	String	Used to get the tags of a Bizcard specified by BizcardId

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
APIKey	The Sansan API key.
IncludePastBizcards	IncludePastBizcards.
Range	The Sansan Range of holders for acquisition.

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. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
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 rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from Sansan.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
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.

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

---

Property	Description
APIKey	The Sansan API key.
IncludePastBizcards	IncludePastBizcards.
Range	The Sansan Range of holders for acquisition.

The Sansan API key.

Remarks

Used for authentication. You can get an APIKey by going to the settings page of your account.

IncludePastBizcards.

Remarks

Determines if older versions of each bizcard should be included

The Sansan Range of holders for acquisition.

Remarks

The Range connection property determines the scope of the data fetched from the API. If Range is set to "all" the provider will fetch all Bizcards or Tags of the organization in which the user is part of. Otherwise if Range is set to "me" it will fetch my Bizcards or Tags. You can override this connection property while querying for ex.:

SELECT * FROM Bizcards WHERE Range='all'

SELECT * FROM Tags WHERE Range='me'

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 Sansan 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. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
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. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

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\\Sansan Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

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 rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from Sansan.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
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.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

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 Sansan.

Remarks

The Pagesize property affects the maximum number of results to return per page from Sansan. 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, "*=*".

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 Bizcards 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"