...
On This Page
| Table of Contents |
|---|
Overview
The Syncplicity connector in DryvIQ allows you to analyze, migrate, copy, and synchronize files to your Syncplicity service from cloud storage repositories and on-premise network file shares. The first step is to create the Syncplicity connection by providing the connection information required for DryvIQ to connect to the platform. DryvIQ connections to Syncplicity require OAuth 2.0 access. In order to create a connection from DryvIQ to Syncplicity, you will need to complete configuration on the Syncplicity side, and you will need to provide several pieces of authentication information. Click here to learn more.
Syncplicity supports storage vault authentication (SVA), which provides an additional layer of security. The feature is optional and needs to be enabled in the storage connector services in Syncplicity. When enabled, the connector services require both an Open Authentication 2.0 (OAuth 2.0) access token and user authentication. If you create a connector for a Syncplicity connection with SVA enabled, you will need to complete additional steps to provide the user authentication that needs to be used.
Create connection | User Interface
Select Connections > Add connection.
Select Syncplicity as the platform on the Add connection modal.
Enter the connection information. Reference the table below for details about each field.
Select Test connection to ensure DryvIQ can connect using the information entered.
You will see a "Connection test succeeded" message on the Add connection modal when DryvIQ establishes connection. (If you don't see this message, verify the information you entered.)
If the connection uses SVA, proceed to Sign in With SVA. Otherwise, select Done to finish creating the connection.
Add Connection Modal - Syncplicity
...
...
Field
...
Description
...
Required
...
Display as
...
Enter the display name for the connection. If you will be creating multiple connections, ensure the name readily identifies the connection. The name displays in the application, and you can use it to search for the connection and filter lists.
If you do not add a display name, the connection will automatically be named using the account owner's name. For example, Syncplicity (John Doe). If in Doe). If it will be useful for you to reference the connection by account, you should use the default name.
...
Optional
...
User Type
...
Required
...
Connect as standard user
...
Select this option to create a standard connection to access a user's files and folders. This is the default selection.
...
Connect as account administrator
...
Select this option to create an administrator connection, This requires administrator privileges and grants access to all accounts within the organization. This option is often used along with impersonation to simplify transferring multiple user accounts. When connected as an administrator, the first level of folders will be user names.
...
Application token
...
This value is provided by your Syncplicity administrator. Each user can provision a personal application token, which can be used to authenticate in UI-less scenarios via API. This is useful for account administration tasks that run in a headless session. If provisioned, an application token is the only information required to log in a user using OAuth 2.0 client credentials grant. You should protect this token. To learn more, click here.
...
Required
...
App key
...
This value is provided by your Syncplicity administrator. The application key identifies DryvIQ (the third-party application) as defined by OAuth 2.0. DryvIQ uses the application key and application secret to authenticate with Syncplicity. To learn more, click here.
...
Required
...
App secret
...
This value is provided by your Syncplicity administrator. The application secret serves as the password for the connection as defined by OAuth 2.0. DryvIQ uses the application key and application secret to authenticate with Syncplicity. To learn more, click here.
...
Required
...
Behavior When Deleting Items
...
Select the type of delete DryvIQ should perform when deleting items: Permanent or Soft. Soft delete is the default delete behavior; however, Permanent is the recommended behavior.
A soft delete marks items as a deleted. You can still access them to restore or permanently delete the items.
A permanent delete removes the items. This delete is not reversible.
...
Optional
...
New SyncPoint type
...
Select the syncpoint type for the list: Standard Sync Folder or SyncDrive Folder. This option instructs DryvIQ as to the type of folder that should be created when a top-level folder is created through a DryvIQ process. To learn more about these options, click here.
...
Optional
Test Connection Succeeded
...
Sign In With SVA
Once DryvIQ establishes connection, it will display an additional sign in option for accounts that have storage vault authentication enabled. You must complete the extra sign in step to provide the user authentication that needs to be used for the connection to access the storage vault. If there are multiple storage vaults enabled for the account, you will see a button for each storage vault. If you want to access multiple storage vaults, you must complete the sign in steps for each vault. Similarly, you don't have to sign into a storage vault if you don't want the connector to use it.
Select the Sign in with button. (The name of the button will reflect the name of the storage vault it is accessing.)
A Syncplicity OneLogin modal appears.
Enter the username for the account and select Continue.
Enter the password for the account and select Continue.
You will see an "SVA sign in succeeded" message when DryvIQ establishes connection. (If you don't see this message, verify the information you entered.)
If there are multiple storage vaults, repeat these steps for each storage vault the connector needs to access.
Select Done to finish creating the connection.
Syncplicity OneLogin Modal
...
Sign in With SVA Succeeded
...
Features and Limitations
Platforms all have unique features and limitations. DryvIQ’s transfer engine manages these differences between platforms and allows you to configure actions based on Job Policies and Behaviors. Utilize the Platform Comparison tool to see how your integration platforms may interact regarding features and limitations.
...
Supported Features
...
Unsupported Features
...
Other Features/Limitations
...
...
...
Path length maximum: n/a
(See Path Lengths below.)
...
...
...
Segment path length: 260
(See Path Lengths below.)
...
...
...
No leading spaces in file name/folder names
(See Invalid Characters and Spaces below.)
...
...
...
No trailing spaces before or after file extensions
...
...
...
No non-printable ASCII characters
...
...
...
Invalid characters: \ / < >
(See Invalid Characters and Spaces below.)
...
...
Only syncpoints can be shared with other users and have permissions persist.
...
Users with a large number of syncpoints are not supported by Syncplicity.
| Info |
|---|
If you are creating a new impersonation job with a Syncplicity connection and the source or destination location is empty, the user you are impersonating has too many syncpoints. You will need to delete the syncpoints before you can create the job. |
Invalid Characters and Spaces
DryvIQ verifies file and folder names to identify unsupported characters based on the platform. It then replaces invalid characters with an underscore (_) so the files and folders can be transferred.
The logic includes leading and trailing spaces in file and folder names. DryvIQ replaces the space rather than trimming it because trimming the space could cause duplicate file names. Adding the underscore ensures the name remains unique.
Trailing whitespace before the file extension will also be replaced by an underscore.
Path Lengths
Syncplicity does not impose restrictions for the total path length.
Segment path lengths are limited to 260character. Segments are delimited by a forward slash (/). For example, <max 260 characters>/<max 260 characters>.
Create connection | REST API
| Info |
|---|
To create a connection that uses SVA through the API, use the instructions here. |
...
Creating a Connection with a new SyncPoint "folder"
| Code Block |
|---|
{
"name": "{{Syncplicity connection name}}",
"platform": {
"id": "syncplicity"
},
"auth": {
"client_id": "{{syncplicity application key}}",
"app_token": "{{syncplicity applicaiton token}}"
"client_secret": "{{syncplicity application secret}}",
"delete_behavior": "permanent"
"syncpoint_type": "folder",
}
} |
...
Creating a
...
Connection with a new SyncPoint
...
"SyncDrive"
To learn more, click here.
| Code Block |
|---|
{
"name": "{{Syncplicity connection name}}",
"platform": {
"id": "syncplicity"
},
"auth": {
"client_id": "{{syncplicity application key}}",
"app_token": "{{syncplicity applicaiton token}}"
"client_secret": "{{syncplicity application secret}}",
"delete_behavior": "permanent"
"syncpoint_type": "syncdrive",
}
} |
...
Creating an Admin Mode Connection
| Code Block |
|---|
{
"name": "{{Syncplicity connection name}}",
"platform": {
"id": "syncplicity"
},
"auth": {
"client_id": "{{syncplicity application key}}",
"app_token": "{{syncplicity applicaiton token}}"
"client_secret": "{{syncplicity application secret}}",
"admin_mode": true
}
} |
Creating a Connection to a StorageVault
To create a DryvIQ Syncplicity connection to a StorageVault configured with Authentication for use in DryvIQ jobs requires a few additional steps, which are outlined below.
1. Create the initial Syncplicity connection in DryvIQ.
2. Obtain the StorageVault Authentication URL and Update the Syncplicity Connection. Retrieve the storage endpoint authentication URL with the following request via browser, curl, Postman, or other tool.
| Code Block |
|---|
GET {{url}}v1/connections/{{connection_id}}/syncplicity-storageendpoints?sva=1&fields=auth |
Example Response
| Code Block |
|---|
{ "status": 200, "item": [ { "id": "09ba2cb2-222e-44bc-b48b-fe4027a7a473", "name": "SVA", "uri": "https://my-sva-server.syncplicity.com", "sva_authentication_uri": "https://my-sva-server.com.syncplicity.com/v2/auth?machine_id=a222333a-0159-4049-b97d-520770f1f1ef&scheme=http%3A%2F%2Fmy-company-server%3A9090%2Fv1%2Fconnections%2Fcavd9325f8994491888888bf09ue0c83%2Fsyncplicity-sva%2F09ba2cb2-309e-44bc-b48b-fe4027a7a473%2F%3Fcallback_token%3DQcbB0lrf%252FM9whZRoh%252FXlEwXAAAAymLqtQzAAAVHmuKs%253D%26token%3D", "requires_sva": true, "has_token": true, "type": "storage_endpoint" } ] } |
3. Copy the URL from item:sva_authentication_uri in the response and paste this value into a browser window. Enter the appropriate credentials in the returned login prompt and submit the form. If successful, an authentication token will be granted, returned to the DryvIQ Manager, and saved to the connection specified in the previous step. A response similar to the following will be displayed in the browser with the account that was used to login, if successful.
| Code Block |
|---|
{ "status": 200, "type": "connection", "connection": { "id": "cabd9125f8994491888888bf09de0c83", "name": "Syncplicity (https://api.syncplicity.com/)", "platform": { "id": "syncplicity", "name": "Syncplicity", ... }, "account": { "name": "Jane Doe", "email": "jdoe@example.com", ... }, ... } } |
5. This connection is now available for use in DryvIQ jobs.