Adding a Connection to CloudSign

To add a connection to CloudSign:

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

You must use ClientId when using the CData Sync App to connect to CloudSign.

Configure Access to CloudSign

You can access the WEB API Client ID in production and sandbox environments:

• Production Environment: https://www.cloudsign.jp/api/clients
• Sandbox Environment https://sandbox.cloudsign.jp/api/clients

All client Ids issued for each environment are displayed. To issue a new client Id, click Publish new client ID, a red button at the upper right of the page.

Authenticate to CloudSign Account

Set the following connection properties to connect:

• ClientId: Set to your Client Id.
• UseSandbox: If you want to access your sandbox, set this to True.

This section details a selection of advanced features of the CloudSign 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 CloudSign and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

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

Customizing the SSL Configuration

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

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

Connecting Through a Firewall or Proxy

HTTP Proxies

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

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

Other Proxies

Set the following properties:

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

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

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

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

CloudSign Connector for CData Sync Tables

Name	Description
Documents	Retrieve and query information related to documents.
Files	Retrieve and query information related to files.
Participants	Retrieve and query information related to participants.
Widgets	Retrieve and query information related to widgets.

Retrieve and query information related to documents.

Select

The Sync App will use the CloudSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• DocumentId, Status columns support the = operator.
• TeamDocuments pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM Documents WHERE DocumentId = 'caa8f083-6e48-4b4b-9f42-d27544c4e662'

SELECT * FROM Documents WHERE Status = 0

SELECT * FROM Documents WHERE TeamDocuments = true

INSERT

All columns except DocumentId, CreatedAt, Status, UpdatedAt, UserId can be specified.

INSERT INTO Documents (Title, Note, Message, CanTransfer, TemplateId) VALUES ('Insert Document Title', 'Insert Note', 'Insert Message', false, '808d24d4-c366-4f21-831d-20fabe1f5f73') 

Update

All columns except DocumentId, CreatedAt, Status, UpdatedAt, UserId can be updated. DocumentId is required in the criteria for an UPDATE.

UPDATE Documents SET Note = 'Update Note', CanTransfer = true,  Message = 'Update Message', Title = 'Update Document Title' WHERE DocumentId = 'b4569785-8e87-4595-a435-88649dc3c644' 

Delete

Delete is not supported for this table.

Columns

Name	Type	ReadOnly	References	Description
DocumentId [KEY]	String	False		Document Id.
CanTransfer	Boolean	False		Flag to allow recipients to forward. The default is false.
CreatedAt	Datetime	True		Creation date.
Message	String	False		A message added to the confirmation request mail.
Note	String	False		Notes about documents. It is not displayed to the recipient.
Status	Integer	True		Document status. {0: Draft}, {1: Undergoing checking in progress}, {2: Conclusion completed}, {3: Canceled or rejected}, {4: Template}
Title	String	False		Title of the document.
UpdatedAt	Datetime	True		Update date.
UserId	String	True		Creator ID.
TemplateId	String	False		The document ID of the template that is the source of document creation from the existing template.

Pseudo-Columns

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

Name	Type	Description
TeamDocuments	Boolean	Acquisition of documents lists of all members.

Retrieve and query information related to files.

Select

The Sync App will use the CloudSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• DocumentId columns support the = operator.
• TeamDocuments pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM Files WHERE DocumentId = 'caa8f083-6e48-4b4b-9f42-d27544c4e662'

SELECT * FROM Files WHERE TeamDocuments = true

INSERT

INSERT is not supported for this table.

Update

UPDATE is not supported for this table.

Delete

A file can be deleted by specifying DocumentId, FileId.

DELETE FROM Files WHERE DocumentId = 'b4569785-8e87-4595-a435-88649dc3c644' AND FileId = 'be175a71-b132-48ca-aceb-868203975cc5' 

Columns

Name	Type	ReadOnly	References	Description
DocumentId [KEY]	String	True		Document Id.
Title	String	True		Title of the document.
FileId [KEY]	String	True		The ID of the file.
Name	String	True		File title.
Order	Integer	True		Order of files in documents.

Pseudo-Columns

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

Name	Type	Description
TeamDocuments	Boolean	Acquisition of documents lists of all members.

Retrieve and query information related to participants.

Select

The Sync App will use the CloudSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• DocumentId columns support the = operator.
• TeamDocuments pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM Participants WHERE DocumentId = 'caa8f083-6e48-4b4b-9f42-d27544c4e662'

SELECT * FROM Participants WHERE TeamDocuments = true

Insert

All columns except Title, Order, Status, AccessExpiresAt can be specified. DocumentId, Email, Name are required for an insert.

INSERT INTO Participants (DocumentId, AccessCode, Email, LanguageCode, Name, Organization) VALUES ('b4569785-8e87-4595-a435-88649dc3c644', '1234', '[email protected]', 'ja', 'Name', 'CData')

Update

All columns except Title, Order, Status, AccessExpiresAt can be specified. DocumentId, ParticipantId is required in the criteria for an UPDATE.

UPDATE Participants SET Email = '[email protected]', Name = 'Name Update', Organization = 'CData Update', AccessCode = '56789', LanguageCode = 'zh-CHS' WHERE DocumentId = 'b4569785-8e87-4595-a435-88649dc3c644' AND ParticipantId = '0bf35cc7-6ca6-479c-9c60-d100cb926bf0'; 

Delete

A participant can be deleted by specifying DocumentId, ParticipantId.

DELETE FROM Participants WHERE DocumentId = 'b4569785-8e87-4595-a435-88649dc3c644' AND ParticipantId = '0bf35cc7-6ca6-479c-9c60-d100cb926bf0' 

Columns

Name	Type	ReadOnly	References	Description
DocumentId [KEY]	String	False		Document Id.
Title	String	True		Title of the document.
AccessCode	Integer	False		Access code required for display.
Email	String	False		Destination e-mail address.
ParticipantId [KEY]	String	False		Participant Id.
LanguageCode	String	False		The recipient's language setting. Possible values are ja (Japanese), en (English), zh - CHS (simplified Chinese), zh - CHT (traditional Chinese). If nothing is set the value is ja.
Name	String	False		Participant Name.
Order	Integer	True		Order of the destination in the document (sender 0).
Organization	String	False		Participant company name etc.
Status	Integer	True		Participant Status.
AccessExpiresAt	Datetime	True		URL expiration date (RFC 3339 compliant). It is included in the response only when the status is 4.

Pseudo-Columns

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

Name	Type	Description
TeamDocuments	Boolean	Acquisition of documents lists of all members.

Retrieve and query information related to widgets.

Select

The Sync App will use the CloudSign API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• DocumentId columns support the = operator.
• TeamDocuments pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM Widgets WHERE DocumentId = 'caa8f083-6e48-4b4b-9f42-d27544c4e662'

SELECT * FROM Widgets WHERE TeamDocuments = true

INSERT

All columns except Status, H, W can be specified. DocumentId, FileId, ParticipantId, WidgetType, Page, X, Y are required for an INSERT.

INSERT INTO Widgets (DocumentId, FileId, ParticipantId, Text, WidgetType, Page, X, Y, Label) VALUES ('b4569785-8e87-4595-a435-88649dc3c644', 'be175a71-b132-48ca-aceb-868203975cc5', '0bf35cc7-6ca6-479c-9c60-d100cb926bf0', 'Insert Widgets Text', '1', '1', '100', '200', 'Insert Label')

Update

All columns except Status, H, W, can be updated. WidgetType is required for an UPDATE. DocumentId, FileId, WidgetId is required in the criteria for an UPDATE.

UPDATE Widgets SET ParticipantId = '0bf35cc7-6ca6-479c-9c60-d100cb926bf0', Text = 'Update Text', WidgetType = '0', Page = '2', X = '300', Y = '400', Label = 'Update Label' WHERE DocumentId = 'b4569785-8e87-4595-a435-88649dc3c644' AND FileId = 'be175a71-b132-48ca-aceb-868203975cc5' AND WidgetId = 'f1c623a0-393f-4423-a91b-719b7e361907' 

Delete

A widget can be deleted by specifying DocumentId, FileId, WidgetId.

DELETE FROM Widgets WHERE DocumentId = 'b4569785-8e87-4595-a435-88649dc3c644' AND FileId = 'be175a71-b132-48ca-aceb-868203975cc5' AND WidgetId = 'f1c623a0-393f-4423-a91b-719b7e361907'

Columns

Name	Type	ReadOnly	References	Description
DocumentId [KEY]	String	False		Document Id.
Title	String	False		Title of the document.
FileId [KEY]	String	False		File id.
WidgetId [KEY]	String	False		Widget Id.
ParticipantId	String	False		Participant Id.
Status	Integer	True		Widget status.
Text	String	False		Text entered in the input field.
WidgetType	Integer	False		Type of input item (0 for impression / 1 for free text).
Page	Integer	False		The page number of the target file for which the input item is set.
X	Integer	False		X coordinate of the installation position in the target file / target page at the upper left of the input item.
Y	Integer	False		Y coordinate of the installation position in the target file / target page at the upper left of the input item.
H	Integer	True		Height of input item.
W	Integer	True		Width of input item.
Label	String	False		Label entered in input field.

Pseudo-Columns

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

Name	Type	Description
TeamDocuments	Boolean	Acquisition of documents lists of all members.

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
ClientID	The client Id required to obtain the access token.
UseSandbox	This is a parameter when using a sandbox. Please set it to True when you use it.

SSL

---

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

Firewall

---

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

Proxy

---

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

Logging

---

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

Schema

---

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

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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

---

Property	Description
ClientID	The client Id required to obtain the access token.
UseSandbox	This is a parameter when using a sandbox. Please set it to True when you use it.

The client Id required to obtain the access token.

Remarks

To obtain the access token, a client ID is required. The client ID can be confirmed on the Web API client ID confirmation page https://www.cloudsign.jp/api.

This is a parameter when using a sandbox. Please set it to True when you use it.

Remarks

This is a parameter when using a sandbox. Please set it to True when you use it.

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 CloudSign and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

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

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

Remarks

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

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

The TCP port for a proxy-based firewall.

Remarks

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

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

Remarks

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

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

Remarks

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

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

---

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

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

Remarks

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

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

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

Remarks

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

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

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

The TCP port the ProxyServer proxy is running on.

Remarks

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

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

Remarks

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

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

The authentication type can be one of the following:

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

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

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

Remarks

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

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

user@domain
domain\user

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

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

Core modules to be included in the log file.

Remarks

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

See the Logging page for an overview.

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

---

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

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

Remarks

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

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

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

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

Remarks

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

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

Remarks

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

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

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

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

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

Remarks

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

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

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

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

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

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Limits the number of rows returned 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.

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

Remarks

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

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

Remarks

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

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

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

Remarks

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

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

This User Defined View configuration file is formatted as follows:

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

For example:

{
	"MyView": {
		"query": "SELECT * FROM Documents 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.