Synchronization Connection String

Overview

A synchronization connection string is a kind of connection string used to identify a synchronization service. The resource is typically the URL of a server, such as a URL to a CSWeb server.

Synchronization connection strings are used in PFF files as well as in logic when synchronization services are specified, such as when using the syncconnect function.

For example, this connection string specifies a CSWeb URL and a property defining the username and password:

https://example.org/csweb/api|username=jackw&password=MyPa%24%24w0rd%21

Used in logic, this might look like:

syncconnect(maketext(
"https://example.org/csweb/api|username=%s&password=%s",
encode(PercentEncoding, "jackw"),
encode(PercentEncoding, "MyPa$$w0rd!")
));

The properties that can be specified differ for each synchronization service and are documented in the topics describing each service.

Type Calculation

The property "type" can be used to specify the synchronization service type. Generally, it is not necessary to define a type because it can be deduced from the resource, especially the resource's prefix. The following table lists the type values as well as any rules for implicit type calculations:

Synchronization Service	Type	Resource
Bluetooth	"Bluetooth"	Resource is "Bluetooth".
CSWeb	"CSWeb"	Resource begins with "https://" or "http://".
Dropbox	"Dropbox"	Resource is "Dropbox".
Dropbox (Local Files)	"Dropbox"	Resource is "Dropbox" with property "useLocal" set to "true".
FTP	"FTP"	Resource begins with "ftp://", "ftps://" or "ftpse://".
Local Files	"LocalFiles"	Resource begins with "file:///".

If the type cannot be deduced due to implicit calculations, and if it is not explicitly specified, it is assumed to be a path to a directory to use for the Local Files synchronization service.