Syncplicity Support

Search our knowledgebase to get the help you need, today

Submit a request

Related articles
Follow

Syncplicity connection

The Syncplicity connector in DataHub 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 DataHub to connect to the platform. DataHub connections to Syncplicity require OAuth 2.0 access. In order to create a connection from DataHub 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 - DataHub application user-interface

  1. Select Connections > Add connection.

  2. Select Syncplicity as the platform on the Add connection modal.

  3. Enter the connection information. Reference the table below for details about each field.

  4. Select Test connection to ensure DataHub can connect using the information entered.

  5. You will see a "Connection test succeeded" message on the Add connection modal when DataHub establishes connection. (If you don't see this message, verify the information you entered.)

  6. If the connection uses SVA, proceed to StorageVault Authentication (SVA). Otherwise, select Done to finish creating the connection.

Add Connection Modal - Syncplicity

  Field Description Required
1 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 Syncplicity API URL. For example, Syncplicity (https://api.syncplicity.com/). 

 Optional
2 User Type Required
3

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.

  
4

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.

  
5      
6

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
7 App key

This value is provided by your Syncplicity administrator. The application key identifies DataHub (the third-party application) as defined by OAuth 2.0.  DataHub uses the application key and application secret to authenticate with Syncplicity. To learn more, click here.

 Required
8 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. DataHub uses the application key and application secret to authenticate with Syncplicity. To learn more, click here.

 Required
9 New SyncPoint type

Select the syncpoint type for the list. This option instructs DataHub as to the type of folder that should be created when a top-level folder is created through a DataHub process. To learn more about these options, click here.

 Optional

Test Connection Succeeded

Sign In With SVA

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

  1. Select the Sign in with button. (The name of the button will reflect the name of the storage vault it is accessing.)

  2. A Syncplicity OneLogin modal appears.

  3. Enter the username for the account and select Continue.

  4. Enter the password for the account and select Continue.

  5. You will see an "SVA sign in succeeded" message when DataHub establishes connection. (If you don't see this message, verify the information you entered.)

  6. If there are multiple storage vaults, repeat these steps for each storage vault the connector needs to access. 

  7. Select Done to finish creating the connection.

Sign in With SVA Succeeded

Features and Limitations

Platforms all have unique features and limitations. DataHub’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 

Version preservation

File lock propagation

Segment path length: 260

Timestamp preservation

Mirror lock ownership

No leading spaces in file name/folder names

Author/Owner preservation

File size maximum

No trailing spaces before or after file extensions

Account map

Path length maximum

No non-printable ASCII characters

Group map

Restricted types

Invalid characters: \  /  <  > 

Permission preservation

Metadata map

Only syncpoints can be shared with other users and have permissions persist.

User impersonation

Tags map

Users with a large number of syncpoints are not supported by Syncplicity.

 

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.

Create connection - DataHub API

Create a Syncplicity connection with a new SyncPoint type of "folder."

POST {{url}}v1/connections/

{
    "name": "{{Syncplicity connection name}}",
    "platform": {
        "id": "syncplicity"
    },
    "auth": {
        "client_id": "{{syncplicity application key}}",
        "client_secret": "{{syncplicity application secret}}",
        "syncpoint_type": "folder",
        "app_token": "{{syncplicity applicaiton token}}"
    }
}

Create a Syncplicity connection with a new SyncPoint type of "SyncDrive."  To learn more, click here.

POST {{url}}v1/connections/

{
    "name": "{{Syncplicity connection name}}",
    "platform": {
        "id": "syncplicity"
    },
    "auth": {
        "client_id": "{{syncplicity application key}}",
        "client_secret": "{{syncplicity application secret}}",
        "syncpoint_type": "syncdrive",
        "app_token": "{{syncplicity applicaiton token}}"
    }
}

Create an admin mode Syncplicity connection.

POST {{url}}v1/connections/

{
    "name": "{{Syncplicity connection name}}",
    "platform": {
        "id": "syncplicity"
    },
    "auth": {
        "client_id": "{{syncplicity application key}}",
        "client_secret": "{{syncplicity application secret}}",
        "app_token": "{{syncplicity applicaiton token}}",
        "admin_mode": true
    }
}
Powered by Zendesk