This page provides a guide to Establishing a Connection to Domino in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Domino

Establishing a Connection shows how to authenticate to Domino and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Domino through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Domino by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

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.

Customizing the SSL Configuration

By default, the Cloud 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 Cloud 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 Cloud 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 Cloud 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 Cloud 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 Cloud 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 Cloud models the data in Domino as a list of tables in a relational database that can be queried using standard SQL statements.

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

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with Domino.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Domino, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Domino Stored Procedures

Name	Description
GetDocumentAttachmentNames	Gets a list of the attachment names for a document.
RemoveAttachment	Removes an attachment from a Domino note

Gets a list of the attachment names for a document.

Input

Name	Type	Required	Description
Unid	String	True	The ID of the note containing the file to download

Result Set Columns

Name	Type	Description
Files	String	Name of the file on the document note.

Removes an attachment from a Domino note

Input

Name	Type	Required	Description
Unid	String	True	The ID of the note containing the file to remove
FileName	String	True	The name of the file to remove on the server

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Domino:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Person table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Person' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the DownloadAttachment stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='DownloadAttachment' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Person table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Person' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:domino:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

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.

SSL

---

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

Logging

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

---

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
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.
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.
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.

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

""

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.

Possible Values

OAuthJWT, AzureAD

Data Type

string

Default Value

"OAuthJWT"

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.

Data Type

string

Default Value

""

Remarks

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

The password used to authenticate the user.

Data Type

string

Default Value

""

Remarks

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

Space-separated list of data-access permissions.

Data Type

string

Default Value

"MAIL $DATA $DECRYPT"

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

Data Type

string

Default Value

""

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 Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

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

---

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
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.

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

Data Type

string

Default Value

""

Remarks

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

What types of tables you want to be returned.

Possible Values

Forms, Views

Data Type

string

Default Value

"Forms"

Remarks

The Table Types available are Views and Forms.

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

Data Type

bool

Default Value

true

Remarks

By default, the Cloud will use column labels as the names for view columns. If this option is disabled, the Cloud 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.
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.
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.

Data Type

int

Default Value

-1

Remarks

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

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

Data Type

int

Default Value

1000

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.

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

"30"

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.

Data Type

int

Default Value

60

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 Cloud throws an exception.

Determines how to determine the data type of columns.

Possible Values

None, RowScan

Data Type

string

Default Value

"RowScan"

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.

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

Data Type

bool

Default Value

false

Remarks

Domino tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Cloud 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.