Adding a Connection to Domino

To add a connection to Domino:

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 Domino icon is not available, click the Add More icon to download and install the Domino 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 Domino

To connect to Domino data, set the following properties:

• URL: The host name or IP of the server hosting the Domino database. Include the port of the server hosting the Domino database.
• DataSource: The datasource to connect to on the Domino URL.

Notes

1. DataSource: is the scope name found in your Domino Admin UI. Go to your Domino Admin UI, navigate to the Scope Management page, and obtain the scope name you want to connect to.

Authenticating to Domino

Domino supports the following types of authentication:

• OAuthJWT
• AzureAD

OAuthJWT

This authentication method exchanges Domino user credentials for a JWT token. This method uses Domino's internal JWT provider. To authenticate using OAuthJWT authentication, set AuthScheme to OAuthJWT and set the following properties:

• User: The username of the authenticating Domino user.
• Password: The password associated with the authenticating Domino user.

AzureAD

This authentication method uses Azure Active Directory as an IdP to obtain a JWT token. This method is used as an external JWT provider. You need to create a custom OAuth application in Azure Active Directory and configure it as an IdP. To do so, follow the instructions here: https://opensource.hcltechsw.com/Domino-rest-api/howto/IdP/configuringAD.html. To authenticate using AzureAD authentication, set AuthScheme to AzureAD and set the following properties:

• OAuthClientId: Set this to the Client ID obtained when setting up the custom OAuth application.
• OAuthClientSecret: Set this to the Client secret obtained when setting up the custom OAuth application.
• CallbackURL : Set this to the redirect URI defined when you registered your app. For example: https://localhost:33333

Notes

1. AzureTenant is generally supplied in the form companyname.microsoft.com, but it is also acceptable to specify the tenant Id. (The tenant Id is the same as the directory Id shown in the Azure Portal Azure Active Directory > Properties page.)

   When OAuthGrantType is set to CODE (the default), AzureTenant is usually not needed unless the user belongs to multiple tenants. When OAuthGrantType is set to CLIENT, AzureTenant is required.

2. The AzureAD AuthScheme is generally used with a custom OAuth application to establish the required OAuth credentials. These usually take the form of an account identifier or cllient ID, and the account password or client secret.

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.

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.

Overview

The Sync App dynamically retrieves notes and views from your Domino database and models them as tables and views. Domino notes are modeled as tables. Domino views are modeled as views.

Tables, Views, Columns and Stored Procedures

Simple and Display Names

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

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 tables and views.

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

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 table or view where the Sync App did not find any multi-value entries during type detection.

Tables

Available tables are listed using System Tables queries.

For example:

SELECT * FROM sys_tables WHERE TableName = 'Person'

Views

Available views are listed using System Tables queries.

For example:

SELECT * FROM sys_tables WHERE TableName = '($Account)'

Columns

Available columns on tables and views are listed using System Table Columns queries.

For example:

SELECT * FROM sys_tablecolumns WHERE TableName = 'Person'

Stored Procedures

Stored procedures allow you to execute operations to Domino Attachments can be manipulated via the DownloadAttachment, UploadAttachment, and RemoveAttachment stored procedures.

The Sync App models the data in Domino as a list of tables in a relational database that can be queried using standard SQL statements.

Domino Connector for CData Sync Tables

Name	Description
Account	The notes visible within Account
Person	The notes visible within Person

The notes visible within Account

Columns

Name	Type	ReadOnly	Description
unid [KEY]	String	False	The unid of the Account table.
$FILES	String	False	The $FILES of the Account table.
AccountAuthor	String	False	The AccountAuthor of the Account table.
AccountDesc	String	False	The AccountDesc of the Account table.
AccountFilename	String	False	The AccountFilename of the Account table.
AccountFileRt	String	False	The AccountFileRt of the Account table.
AccountLocation	String	False	The AccountLocation of the Account table.
AccountLoginHelpText	String	False	The AccountLoginHelpText of the Account table.
AccountLoginName	String	False	The AccountLoginName of the Account table.
AccountName	String	False	The AccountName of the Account table.
AccountPassword	String	False	The AccountPassword of the Account table.
AccountPortNumber	Float	False	The AccountPortNumber of the Account table.
AccountProtocol	String	False	The AccountProtocol of the Account table.
AccountReplicationHistory	String	False	The AccountReplicationHistory of the Account table.
AccountReplicationMaxPull	Float	False	The AccountReplicationMaxPull of the Account table.
AccountServer	String	False	The AccountServer of the Account table.
AccountServer$ED	String	False	The AccountServer$ED of the Account table.
AccountService_ID	String	False	The AccountService_ID of the Account table.
AccountType	String	False	The AccountType of the Account table.
allowsharing	String	False	The allowsharing of the Account table.
authserver	String	False	The authserver of the Account table.
authserver$ED	String	False	The authserver$ED of the Account table.
authtype	String	False	The authtype of the Account table.
authtype$ED	String	False	The authtype$ED of the Account table.
ConnDispName	String	False	The ConnDispName of the Account table.
ConnDispName$ED	String	False	The ConnDispName$ED of the Account table.
connectionType	String	False	The connectionType of the Account table.
connectionType$ED	String	False	The connectionType$ED of the Account table.
connectionTypeInput	String	False	The connectionTypeInput of the Account table.
CSRF_Url	String	False	The CSRF_Url of the Account table.
DisplayName	String	False	The DisplayName of the Account table.
dominosso	String	False	The dominosso of the Account table.
dominossoserver	String	False	The dominossoserver of the Account table.
EditableList	String	False	The EditableList of the Account table.
FormFieldsList	String	False	The FormFieldsList of the Account table.
IMAPDeleteMail	String	False	The IMAPDeleteMail of the Account table.
INIFlg	String	False	The INIFlg of the Account table.
InternetFilter	String	False	The InternetFilter of the Account table.
IS_CLOUD_ACCOUNT	Float	False	The IS_CLOUD_ACCOUNT of the Account table.
IS_CSRFTOKEN_REQUIRED	String	False	The IS_CSRFTOKEN_REQUIRED of the Account table.
IS_GLOBAL_ACCOUNT	Float	False	The IS_GLOBAL_ACCOUNT of the Account table.
IS_SERVER_MANAGED	Float	False	The IS_SERVER_MANAGED of the Account table.
isPrimaryAccount	String	False	The isPrimaryAccount of the Account table.
keepAliveInterval	Float	False	The keepAliveInterval of the Account table.
keepAliveInterval$ED	String	False	The keepAliveInterval$ED of the Account table.
loginAtStartup	String	False	The loginAtStartup of the Account table.
loginAtStartup$ED	String	False	The loginAtStartup$ED of the Account table.
loginByToken	String	False	The loginByToken of the Account table.
loginByToken$ED	String	False	The loginByToken$ED of the Account table.
personalizedHome	String	False	The personalizedHome of the Account table.
port	Float	False	The port of the Account table.
port$ED	String	False	The port$ED of the Account table.
Properties	String	False	The Properties of the Account table.
proxyHost	String	False	The proxyHost of the Account table.
proxyPort	Float	False	The proxyPort of the Account table.
proxyResolvesLocally	String	False	The proxyResolvesLocally of the Account table.
proxyType	String	False	The proxyType of the Account table.
requireSSL	String	False	The requireSSL of the Account table.
requireSSL$ED	String	False	The requireSSL$ED of the Account table.
requireTrustedSites	String	False	The requireTrustedSites of the Account table.
requireTrustedSites$ED	String	False	The requireTrustedSites$ED of the Account table.
resolveLivenames	String	False	The resolveLivenames of the Account table.
resolveLivenames$ED	String	False	The resolveLivenames$ED of the Account table.
samlAcctName	String	False	The samlAcctName of the Account table.
sendKeepAlive	String	False	The sendKeepAlive of the Account table.
sendKeepAlive$ED	String	False	The sendKeepAlive$ED of the Account table.
ServerCopyModTime	Datetime	False	The ServerCopyModTime of the Account table.
ServerCopyUnid	String	False	The ServerCopyUnid of the Account table.
SSLExpiredCerts	String	False	The SSLExpiredCerts of the Account table.
SSLLDAPSASL	String	False	The SSLLDAPSASL of the Account table.
SSLSendCertificates	String	False	The SSLSendCertificates of the Account table.
SSLServerAuthenticate	String	False	The SSLServerAuthenticate of the Account table.
SSLSiteCerts	String	False	The SSLSiteCerts of the Account table.
SSLStatus	String	False	The SSLStatus of the Account table.
SSOCredentialID	String	False	The SSOCredentialID of the Account table.
stIcon	String	False	The stIcon of the Account table.
stIcon$ED	String	False	The stIcon$ED of the Account table.
Type	String	False	The Type of the Account table.
useGlobalConnSettings	String	False	The useGlobalConnSettings of the Account table.
useGlobalConnSettings$ED	String	False	The useGlobalConnSettings$ED of the Account table.
UserName$ED	String	False	The UserName$ED of the Account table.
useServerForLookup	String	False	The useServerForLookup of the Account table.
useServerForLookup$ED	String	False	The useServerForLookup$ED of the Account table.

The notes visible within Person

Columns

Name	Type	ReadOnly	Description
unid [KEY]	String	False	The unid of the Person table.
$FILES	String	False	The $FILES of the Person table.
$Group_Main	Float	False	The $Group_Main of the Person table.
BooleanField	Bool	False	The BooleanField of the Person table.
City	String	False	The City of the Person table.
CompanyName	String	False	The CompanyName of the Person table.
DateField	Date	False	The DateField of the Person table.
DateTimeField	Datetime	False	The DateTimeField of the Person table.
Department	String	False	The Department of the Person table.
DisplayMailAddress	String	False	The DisplayMailAddress of the Person table.
DisplayName	String	False	The DisplayName of the Person table.
DoubleField	Double	False	The DoubleField of the Person table.
EmployeeID	Int	False	The EmployeeID of the Person table.
FirstName	String	False	The FirstName of the Person table.
FullName	String	False	The FullName of the Person table.
GroupTitle	String	False	The GroupTitle of the Person table.
GroupType	String	False	The GroupType of the Person table.
JobTitle	String	False	The JobTitle of the Person table.
LastName	String	False	The LastName of the Person table.
ListName	String	False	The ListName of the Person table.
Location	String	False	The Location of the Person table.
MailServer	String	False	The MailServer of the Person table.
Members	String	False	The Members of the Person table.
Title	String	False	The Title of the Person table.
Type	String	False	The Type of the Person table.

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
URL	Set this to the URL of the server where your Domino instance is hosted.
DataSource	The name of the Domino scope.
AuthScheme	The type of authentication to use when connecting to Domino.
User	The Domino user account used to authenticate.
Password	The password used to authenticate the user.
Scope	Space-separated list of data-access permissions.

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.

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.
TableTypes	What types of tables you want to be returned.
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 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 Domino.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
RowScanDepth	Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionScheme	Determines how to determine the data type of columns.
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
URL	Set this to the URL of the server where your Domino instance is hosted.
DataSource	The name of the Domino scope.
AuthScheme	The type of authentication to use when connecting to Domino.
User	The Domino user account used to authenticate.
Password	The password used to authenticate the user.
Scope	Space-separated list of data-access permissions.

Set this to the URL of the server where your Domino instance is hosted.

Remarks

Set this to the URL of the server where your Domino instance is hosted. The port number can be specified as the following: URL=http://10.0.2.15:8880;

The name of the Domino scope.

Remarks

The datasource to connect to on the Domino URL.

Go to the Domino Admin UI, Scope Management page, and obtain the scope name for this property.

The type of authentication to use when connecting to Domino.

Remarks

• OAuthJWT: This authentication method exchanges Domino user credentials for a JWT token. This method uses Domino's internal JWT provider.
• AzureAD: This authentication method uses Azure Active Directory as an IdP to obtain a JWT token. This method is used as an external JWT provider.

The Domino user account used to authenticate.

Remarks

Together with Password, this field is used to authenticate against the Domino server.

The password used to authenticate the user.

Remarks

The User and Password are together used to authenticate with the server.

Space-separated list of data-access permissions.

Remarks

Specify scope to obtain the initial access and refresh token.

Space-separated list of data-access permissions.

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.

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.

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

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.
TableTypes	What types of tables you want to be returned.
UseDisplayNames	Determines if the display names for view columns should be used instead of internal names.

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:

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.

What types of tables you want to be returned.

Remarks

The Table Types available are Views and Forms.

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

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 Domino.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
RowScanDepth	Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionScheme	Determines how to determine the data type of columns.
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 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.

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

Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.

Remarks

Determines the number of rows used to determine the column data types.

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.

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.

Determines how to determine the data type of columns.

Remarks

None	Setting TypeDetectionScheme to None will return all columns as the string type.
RowScan	Setting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type. The RowScanDepth determines the number of rows to be scanned.

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 Person 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

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.