Establishing a Connection

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

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

Before You Connect

The Sync App requires the Proton component to be installed. Normally, Proton is distributed as part of the AppDev pack. See the HCL documentation for instructions on acquiring and installing Proton or the AppDev pack.

The Sync App can authenticate to Proton using either anonymous access, or by providing a client certificate. Both of these options require specific configuration within Domino.

The following two sections describe the preliminary configuration necessary to make a connection. Refer to the section that corresponds to your intended authentication method.

Configuring Client Certificate Authentication

In client certificate authentication, the Sync App connects as a dedicated user account. This user must be granted designer or greater access to any database you connect to.

In addition, the user must have an Internet Certificate in order for the Sync App to use it. You can have Proton create this certificate by running the following command at the server console. APPUSER is the name of the user account you are configuring for access with the Sync App, while ADMINISTRATOR is the name of the user that will receive the certificate.

load proton --setupclient "APPUSER" --sendto "ADMINISTRATOR"

The new certificate is avialable from the ADMINISTRATOR mail inbox in Notes. Note that the certificate may be sent as two separate files, a client certificate (clientcert) and a key (clientkey). The two files must be combined by copying and pasting the text from the key file onto the end of the certificate file.

Configuring Anonymous Authentication

In anonymous access, the Sync App connects using a generic user account called Anonymous. Every database you connect to must have these two permissions configured:

The Anonymous user must be granted designer or greater access to the database.
The database must have the Maximum Internet name and password option set to designer or greater access. This setting is found under the Advanced tab of the database Access Control List options.

Connecting to Domino

Set the following to connect:

Server: The name or IP address of the server running Domino with the Proton service.
Port: The port number that the Proton service is listening on.
Database: The name of the database file, including the .nsf extension.
SSLServerCert: Set this to the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected. Alternatively, set "*" to accept all certificates.

Authenticating to Domino

The Sync App can authenticate to Proton using a client certificate, or via anonymous access.

Client Certificate Authentication

Set the following to authenticate with an certificate authentication:

AuthScheme: Set this to SSLCertificate.
SSLClientCertType: This must match the format of the certificate file. Typically this will be either PEMKEY_FILE for .pem certificates or PFXFILE for .pfx certificates.
SSLClientCert: The path to the certificate file.

Anonymous Authentication

To use anonymous authentication, set AuthScheme to Anonymous.

Advanced Features

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

SSL Configuration

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.

Client SSL Certificates

The Domino Sync App also supports setting client certificates. Set the following to connect using a client certificate.

SSLClientCert: The name of the certificate store for the client certificate.
SSLClientCertType: The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword: The password for the TLS/SSL client certificate.
SSLClientCertSubject: The subject of the TLS/SSL client certificate.

Firewall and Proxy

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.

Data Model

Overview

The Sync App supports modeling views, attachments and the entire database as distinct views.

Views, Columns and Stored Procedures

Simple and Display Names

The Sync App supports options for controlling how views and columns are named:

UseSimpleNames When simple names are enabled, the Sync App will restrict view and column names so they contain only alphanumeric characters and the underscore. This can be required for some tools which do not properly escape view or column names when sending queries to the Sync App.
UseDisplayNames By default display names are enabled. When they are disabled, the Sync App will set the names of view columns to be their internal names instead of their titles. This may some columns to receive names like '$1' because Domino uses dollar signs to identify columns that are generated from formulas.

Note Metadata

In addition to the items defined on each note, Domino exposes metadata about each note that the Sync App maps to special columns. These columns are:

@unid The unique note identifier, which identifies this specific note across all databases on the server. This is available in all views.
@offset The position of a value within an array. Used only for child views.

Note that these names will be different when UseSimpleNames is enabled because they contain special characters.

Querying Array Data

Domino allows a item within a note to contain multiple values. The Sync App models this one of two ways depending upon the value of the ArrayMode option:

Flatten This mode will report multi-value items as JSON text values, such as: '[1, 2, 3]'
ChildTables This mode will split multi-value items into their own views which put separate values on each row. Each child view has a foreign key referring to the @unid of its parent (for use with JOINs). Child views also have a @offset as part of their primary key, which gives the position of the value within the array (counting up from 1).

Null Values

Domino does not have a direct equivalent of the SQL NULL value. The Sync App reports NULL values for columns in these scenarios:

When an item is not set on a note. In Domino formulas, this is equivalent to @IsAvailable(item) = 0.
When a single-valued item on a note is the empty text value. In Domino formulas, this is equivalent to @IsNull(item) = 1. Here, a single-valued item is an item on the base view (not a child view) where the Sync App did not find any multi-value entries during type detection.

In Flatten mode the Sync App distinguishes between empty multi-value items and multi-value items that are not assigned on a given note:

If the item is not assigned (@IsAvailable(item) = 0) them the column is reported as NULL.
If the item is assigned but contains just an empty text value (@IsAvailable(item) = 1 and @IsNull(item) = 1) then the Sync App reports '[]'.

Querying Attachments

Domino allows a note to contain multiple attachments which the Sync App reports in the Attachments view. This view contains only the metadata for each attachment: the note it belongs to and its name and size. Attachments can be manipulated via the DownloadAttachment and UploadAttachment stored procedures.

Views

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.

Domino Connector for CData Sync Views


Name	Description
Attachments	The attachments available within the Domino database.
ByName-First	The notes visible within ByName-First.
ByName	The notes visible within ByName.
byNameSmall	The notes visible within byNameSmall.
ByNumber	The notes visible within ByNumber.
byState	The notes visible within byState.
ImportView	The notes visible within Import View.
lookupTypeAhead	The notes visible within lookupTypeAhead
stateList	The notes visible within stateList

Attachments

The attachments available within the Domino database.

Select

The Sync App supports filtering on the @unid column using the = and IN operators. All other filters are executed client-side within the Sync App. For example, the following query is processed server side:

SELECT * FROM Attachments WHERE [@unid] IN ('00000000000000000000000000000000', '11111111111111111111111111111111')

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
@unid [KEY]	String	The unique identifier of the note containing the attachment.
@modified	Datetime	When the attachment data was last modified.
FileName [KEY]	String	The name of the attachment, unique within a single note.
Size	Long	The size of the attachment data in bytes.

ByName-First

The notes visible within ByName-First.

Columns


Name	Type	Description
@unid [KEY]	String	The unique identifier of the note.
Name	String	The value of the formula [firstname + ' ' + lastname]
Address	String	The value of the address view column.
City	String	The value of the city view column.
State	String	The value of the state view column.
Zip	Double	The value of the zip view column.
Country	String	The value of the country view column.
EmailAddress	String	The value of the address view column.
Password	String	The value of the password view column.
Phone	String	The value of the phone view column.
Maiden	String	The value of the mothersmaiden view column.
Birthday	Datetime	The value of the birthday view column.
CCType	String	The value of the cctype view column.
CC Number	Double	The value of the ccnumber view column.
CVV2	Double	The value of the cvv2 view column.
CC Expires	String	The value of the ccexpires view column.
NationalID	String	The value of the national view column.
UPS	String	The value of the ups view column.
Occupation	String	The value of the occupation view column.

ByName

The notes visible within ByName.

Columns


Name	Type	Description
@unid [KEY]	String	The unique identifier of the note.
Name	String	The value of the formula [lastname + ', ' + firstname]
Address	String	The value of the address view column.
City	String	The value of the city view column.
State	String	The value of the state view column.
Zip	Double	The value of the zip view column.
Country	String	The value of the country view column.
EmailAddress	String	The value of the address view column.
Password	String	The value of the password view column.
Phone	String	The value of the phone view column.
Maiden	String	The value of the mothersmaiden view column.
Birthday	Datetime	The value of the birthday view column.
CCType	String	The value of the cctype view column.
CC Number	Double	The value of the ccnumber view column.
CVV2	Double	The value of the cvv2 view column.
CC Expires	String	The value of the ccexpires view column.
NationalID	String	The value of the national view column.
UPS	String	The value of the ups view column.
Occupation	String	The value of the occupation view column.

byNameSmall

The notes visible within byNameSmall.

Columns


Name	Type	Description
@unid [KEY]	String	The unique identifier of the note.
Name	String	The value of the formula [lastname + ', ' + firstname]
Address	String	The value of the address view column.
City	String	The value of the city view column.
State	String	The value of the state view column.
Zip	Double	The value of the zip view column.
Country	String	The value of the country view column.
EmailAddress	String	The value of the address view column.
Password	String	The value of the password view column.
Phone	String	The value of the phone view column.
Maiden	String	The value of the mothersmaiden view column.
Birthday	Datetime	The value of the birthday view column.
CCType	String	The value of the cctype view column.
CC Number	Double	The value of the ccnumber view column.
CVV2	Double	The value of the cvv2 view column.
CC Expires	String	The value of the ccexpires view column.
NationalID	String	The value of the national view column.
UPS	String	The value of the ups view column.
Occupation	String	The value of the occupation view column.

ByNumber

The notes visible within ByNumber.

Columns


Name	Type	Description
@unid [KEY]	String	The unique identifier of the note.
Number	String	The value of the formula [@Text(number)].
Name	String	The value of the formula [lastname + ', ' + firstname]
Address	String	The value of the address view column.
City	String	The value of the city view column.
State	String	The value of the state view column.
Zip	Double	The value of the zip view column.
Country	String	The value of the country view column.
EmailAddress	String	The value of the address view column.
Password	String	The value of the password view column.
Phone	String	The value of the phone view column.
Maiden	String	The value of the mothersmaiden view column.
Birthday	Datetime	The value of the birthday view column.
CCType	String	The value of the cctype view column.
CC Number	Double	The value of the ccnumber view column.
CVV2	Double	The value of the cvv2 view column.
CC Expires	String	The value of the ccexpires view column.
NationalID	String	The value of the national view column.
UPS	String	The value of the ups view column.
Occupation	String	The value of the occupation view column.

byState

The notes visible within byState.

Columns


Name	Type	Description
@unid [KEY]	String	The unique identifier of the note.
State	String	The value of the state view column.
Name	String	The value of the formula [lastname + ', ' + firstname]
Address	String	The value of the address view column.
City	String	The value of the city view column.
Zip	Double	The value of the zip view column.
Country	String	The value of the country view column.
EmailAddress	String	The value of the address view column.
Password	String	The value of the password view column.
Phone	String	The value of the phone view column.
Maiden	String	The value of the mothersmaiden view column.
Birthday	Datetime	The value of the birthday view column.
CCType	String	The value of the cctype view column.
CC Number	Double	The value of the ccnumber view column.
CVV2	Double	The value of the cvv2 view column.
CC Expires	String	The value of the ccexpires view column.
NationalID	String	The value of the national view column.
UPS	String	The value of the ups view column.
Occupation	String	The value of the occupation view column.

ImportView

The notes visible within Import View.

Columns


Name	Type	Description
@unid [KEY]	String	The unique identifier of the note.
Number	Double	The value of the number view column.
Gender	String	The value of the gender view column.
First Name	String	The value of the firstname view column.
Middle	String	The value of the middle view column.
Last Name	String	The value of the lastname view column.
Address	String	The value of the address view column.
City	String	The value of the city view column.
State	String	The value of the state view column.
Zip	Double	The value of the zip view column.
Country	String	The value of the country view column.
EmailAddress	String	The value of the address view column.
Password	String	The value of the password view column.
Phone	String	The value of the phone view column.
Maiden	String	The value of the mothersmaiden view column.
Birthday	Datetime	The value of the birthday view column.
CCType	String	The value of the cctype view column.
CC Number	Double	The value of the ccnumber view column.
CVV2	Double	The value of the cvv2 view column.
CC Expires	String	The value of the ccexpires view column.
NationalID	String	The value of the national view column.
UPS	String	The value of the ups view column.
Occupation	String	The value of the occupation view column.

lookupTypeAhead

The notes visible within lookupTypeAhead

Columns


Name	Type	Description
@unid [KEY]	String	The unique identifier of the note.
Name	String	The value of the formula [lastname + ', ' + firstname + ' (' + @Text(number) + ')']
Address	String	The value of the address view column.
City	String	The value of the city view column.
State	String	The value of the state view column.
Zip	Double	The value of the zip view column.
Country	String	The value of the country view column.
EmailAddress	String	The value of the address view column.
Password	String	The value of the password view column.
Phone	String	The value of the phone view column.
Maiden	String	The value of the mothersmaiden view column.
Birthday	Datetime	The value of the birthday view column.
CCType	String	The value of the cctype view column.
CC Number	Double	The value of the ccnumber view column.
CVV2	Double	The value of the cvv2 view column.
CC Expires	String	The value of the ccexpires view column.
NationalID	String	The value of the national view column.
UPS	String	The value of the ups view column.
Occupation	String	The value of the occupation view column.

stateList

The notes visible within stateList

Columns


Name	Type	Description
@unid [KEY]	String	The unique identifier of the note.
State	String	The value of the state view column.

Connection String Options

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
Server	The host name or IP address of the Domino server.
Port	The port number of the Proton service on your Domino server.
Database	The name of the Domino database file.
AuthScheme	The type of authentication to use when connecting to Domino.

SSL

Property	Description
SSLClientCert	The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertType	The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword	The password for the TLS/SSL client certificate.
SSLClientCertSubject	The subject of the TLS/SSL client certificate.
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.
ArrayMode	How fields that contain array values are presented.
UseDisplayNames	Determines if the display names for view columns should be used instead of internal names.

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 Domino.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UseInternalSecurityAPI	Determines if the bundled or platform SSL implementation is used.
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.

Authentication

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

Property	Description
Server	The host name or IP address of the Domino server.
Port	The port number of the Proton service on your Domino server.
Database	The name of the Domino database file.
AuthScheme	The type of authentication to use when connecting to Domino.

Server

The host name or IP address of the Domino server.

Remarks

The host name or IP of the server hosting the Domino Database.

Port

The port number of the Proton service on your Domino server.

Remarks

The port number of the Proton service on the Server hosting the Domino Database.

Database

The name of the Domino database file.

Remarks

The database to connect to on the Domino Server.

AuthScheme

The type of authentication to use when connecting to Domino.

Remarks

This option must match the Client Authentication setting in the server adpconfig.nsf database.

SSLCertificate: The Sync App authenticates as a dedicated user with the client certificate given in SSLClientCert.
Anonymous: The Sync App authenticates as the built-in Anonymous account.

SSL

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

Property	Description
SSLClientCert	The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertType	The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword	The password for the TLS/SSL client certificate.
SSLClientCertSubject	The subject of the TLS/SSL client certificate.
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

SSLClientCert

The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).

Remarks

The name of the certificate store for the client certificate.

The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.

SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).

SSLClientCertType

The type of key store containing the TLS/SSL client certificate.

Remarks

This property can take one of the following values:


USER - default	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PuTTY Private Key (PPK).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.

SSLClientCertPassword

The password for the TLS/SSL client certificate.

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

SSLClientCertSubject

The subject of the TLS/SSL client certificate.

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, [email protected]". The common fields and their meanings are shown below.


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, it must be quoted.

SSLServerCert

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.

Firewall

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.

FirewallType

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

FirewallServer

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.

FirewallPort

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.

FirewallUser

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.

FirewallPassword

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.

Proxy

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 .

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.

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.

ProxyServer

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.

ProxyPort

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.

ProxyAuthScheme

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.

ProxyUser

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

ProxyPassword

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.

ProxySSLType

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.

ProxyExceptions

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.

Logging

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.

LogModules

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.

Schema

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.
ArrayMode	How fields that contain array values are presented.
UseDisplayNames	Determines if the display names for view columns should be used instead of internal names.

Location

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

BrowsableSchemas

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.

Tables

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.

Views

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.

ArrayMode

How fields that contain array values are presented.

Remarks

Domino allows fields within a database to have multiple values within each row. Some types of form elements allow this (for example, checkboxes or listboxes) as well as multiple form elements bound to the same field. The Sync App detects these fields and displays them differently based upon this option.

By default, the Flatten mode is used, which combines all the values in the field into a single text value. For example:

SELECT colors FROM Notes

/*
colors
------------------------
["red", "green", "blue"]
*/

If the ChildTables mode is used instead, each multi-value field is moved from its main view into a separate view. These views contain multiple rows per unique note identifier and can be JOINed back to the main view to get all the values of a multi-value field. For example:

SELECT Notes.[@unid], Notes_colors.[@offset], Notes_colors.color
FROM Notes INNER JOIN Notes_colors ON Notes.[@unid] = [Notes_colors].[@unid]

/*
@unid              @offset  color
-----------------  ---------  -----
01234567890ABCDEF  1          red
01234567890ABCDEF  2          green
01234567890ABCDEF  3          blue
*/

UseDisplayNames

Determines if the display names for view columns should be used instead of internal names.

Remarks

By default, the Sync App will use column labels as the names for view columns. If this option is disabled, the Sync App will use internal names as the names for view columns instead. This can cause some columns computed using formulas to be reported with auto-generated names such as '$21'.

Miscellaneous

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 Domino.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UseInternalSecurityAPI	Determines if the bundled or platform SSL implementation is used.
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.

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.

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.

Other

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.

Pagesize

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

Remarks

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

PseudoColumns

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, "*=*".

RowScanDepth

The maximum number of rows to scan to look for the columns available in a table.

Remarks

The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

Timeout

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.

UseInternalSecurityAPI

Determines if the bundled or platform SSL implementation is used.

Remarks

By default Domino requires TLS 1.2+ when connecting to the Proton service. Most environments will be able to use TLS 1.2 automatically so the platform SSL/TLS implementation is used.

The .NET framework settings used by some versions of Excel exclude TLS 1.2 support, which manifests as an error like "Could not acquire CSP." To avoid this, the bundled SSL implementation is used which supports TLS 1.2 in all environments.

UserDefinedViews

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

UseSimpleNames

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

Remarks

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