User Migration Guides | OneDrive for Business to Syncplicity


 

 


Contents


Introduction 

SkySync is an enterprise data integration platform that enables organizations to maximize business value and productivity from their content.  It connects disparate storage platforms and business applications together, allowing organizations to move, copy, synchronize, gather, and organize files as well as their related data across any system. SkySync empowers your users with unified access to the most relevant, complete, and up-to-date content—no matter where it resides.    

SkySync delivers a user-friendly, web-based experience optimized for PC, tablet, and mobile phone interfaces, so you can monitor and control your file transfers anywhere, from any device.   

SkySync’s true bi-directional hybrid/sync capabilities enable organizations to leverage and preserve content across on-premises systems and any cloud service. Seamless to users, new files/file changes from either system are automatically reflected in the other.  


How does SkySync Work? 

Cloud storage and collaboration platforms continue to be the driving force of digital transformation within the enterprise. However, users need to readily access the content that resides within your existing network file systems, ECM, and other storage platforms—enabling them to be productive, wherever they are.  SkySync is purpose-built to provide boundless enterprise content integration possibilities. The SkySync Platform is 100% open and provides a highly-scalable architecture that enables enterprises to meet evolving technology and user demands—no matter how complex. 

The SkySync platform provides: 

  • A low risk approach to moving content to the cloud while maintaining on-premises systems

  • No impact to users, IT staff, business operations, or existing storage integrations

  • The ability to extend cloud storage anywhere/any device capabilities to locally-stored content

  • Easy integration of newly acquired business storage platforms into existing infrastructures

The Engine 

SkySync’s bi-directional synchronization engine enables your enterprise to fully-integrate and synchronize your existing on-premises platforms with any cloud service. It empowers your users to freely access the content they need while IT staff maintains full governance and control. SkySync integrates with each system's published Application Program Interface (API) at the deepest level—optimizing transfer speeds and preserving all file attributes. 

Security 

SkySync’s 100% security-neutral model does not incorporate or use any type of proxy cloud service or other intermediary presence point. All content and related data is streamed directly via HTTPS [256-bit encryption] from the origin to the destination system(s). Additionally, SkySync works with native database encryption. For more information, please see SkySync Platform | Security Whitepaper

Analyzer | Simulation Mode

The SkySync analyzer is a powerful enterprise file transfer simulation that eliminates the guesswork. You will gain granular insight into your entire content landscape including its structure, usage, age, type, applicable metadata, and more no matter where the files are located (in local storage, remote offices, or on user desktops). 

Simulation mode allows you to create a job with all desired configuration options set and execute it as a dry-run. In this mode, no data transfers, no permissions are set, and no changes are made to either the source or the destination. This can be useful in answering several questions about your content prior to running any jobs against your content.

Command and Control 

Via highly-advanced web, SkySync Command-line Interface (CLI), RESTful API, and/or .NET interfaces, SkySync administrators can easily integrate systems, control interactions and behaviors, or create and control end-user experiences for advanced self-service capabilities. 

Features and Functionality 

The SkySync Platform enables you with complete integration and control over: 

  • User accounts 

  • User networked home drives 

  • User and group permissions 

  • Document types, notes, and file attributes 

  • Timestamps 

  • Versions 

  • Departmental, project, and team folders 

  • Defined and custom metadata 

Architecture and Performance 

The SkySync platform is built on a pluggable, content–streaming architecture that enables highly–automated file/data transfer and synchronization capabilities for up to billions of files. File bytes stream in from one connection endpoint (defined by the administrator) and across a customer-owned and operated network and/or cloud service. They are then streamed out to a second connection endpoint. Content can also flow bidirectionally across two endpoints rather than solely from an "origin" to a "destination."

Supported Features

The SkySync Platform Comparison tool allows you to compare platform features and technical details to determine which are supported for your transfer scenario. Viewing the Platform Comparison results for your integration will display a list of features of each platform and provide insight early in the integration planning process on what details may need further investigation.

The Platform Comparison tool is available through the Platforms menu options. For further information, see Platform Comparison.

Connection Setup

SkySync is built on a concept of connections. A connection is made to the source platform, and another connection is made to the destination platform. A job is created to tie the two platforms together. When SkySync connects to a content platform, it does so by using the publicly available Application Programming Interface (API) for the specific platform. This ensures SkySync is “playing by the rules” for each platform. 

Connections “connect” to a platform as a specific user account. The user account requires the proper permissions to the platform to read, write, update, and/or delete the content based on the actions the SkySync job is to perform. The connection user account should also be set up so the password does not expire; otherwise, the connection will no longer be able to access the platform until the connection has been refreshed with the new password. Most connections require a specific user account and its corresponding password. The user account is typically an email address. 

Authenticated Connections

Authenticated Connections are accounts that have been verified with the cloud-based or network-based platform when created. The connection can be user/password-based or done through OAuth2 flow, where a token is generated based on the granting authorization to SkySync through a user login. This authorization allows SkySync access to the user's drive information (files and folder) on the platform. These connections are used as the source or the destination authentication to transfer your content.

 

OAuth2 Interactive (Web) Flow

Connectors such as Box, Google Drive, and Dropbox use the OAuth2 interactive (or web) flow.

 

OAuth2 Client Credentials Flow

Connections such as Syncplicity and GSuite uses the OAuth2 client credentials flow.

 

SharePoint

SharePoint (all versions, CSOM) uses a custom username/password authentication model.


OAuth2 Interactive (Web) Flow

You will need the following information when creating a connection to Network File SystemBox, Dropbox and Dropbox for Business:

  • A name for the connection

  • The account User ID (such as jsmith@company.com)

  • The password for the User ID.

Create Connections

Creating a connection in the SkySync Platform user interface is easy! Simply add a connection, select your platform, and enter the requested information. SkySync will securely validate your credentials and connect to your source content. 


OneDrive for Business

SkySync connections to the OneDrive for Business platform can be made by using an administrator account with the proper privileges to manage OneDrive configurations. SkySync can create this connection using the OAuth 2.0 flow to simplify login and connection management.

Create Connection | SkySync Application User Interface

  1. Select Connections > Add connection.

  2. Select Microsoft OneDrive for Business as the platform on the Add connection modal.

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

  4. Select Sign in with Microsoft OneDrive for Business.

  5. Enter the email for the account being used to create the connection and click Next. You must use an admin account with the proper privileges to manage OneDrive for Business configurations.

  6. Enter the password for the account and select Sign in.

  7. You will see a "Connection test succeeded" message on the Add connection modal. (If you don't see this message, repeat the sign in and authorization steps above. If the connection fails, verify the URL. SkySync cannot create the connection if the URL is incorrect.)

  8. Select Done to finish creating the connection.

 

Add Connection Modal - Microsoft OneDrive for Business

 

 

Field

Description

Required

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 URL. For example, OneDrive for Business (https://mycompany-my.sharepoint.com/personal/user_mycompany_onmicrosoft_com). If it will be useful for you to reference the connection by account, you should use the default name.

Optional

URL

Enter the URL of your OneDrive for Business account. This must be the full URL. If the connection fails, verify the URL. SkySync cannot create the connection if the URL is incorrect. 

You can find the URL by logging into OneDrive for Business using the account you want to use to create the connection. The URL in the address bar is the URL you need to use. It will look something like "https://mycompany-my.sharepoint.com/personal/user_mycompany_onmicrosoft_com" (where mycompany will be the site name of your company).

You must use the full URL, or the connection will fail. For example, the following URL is invalid since it is not the complete URL and will result in a failed connection: "https://skysyncdesktop-my.sharepoint.com/personal/".

Required

Token endpoint

This setting is rare for most Microsoft connections and can be left blank. If needed, this value will be provided by your administrator.

Optional

Graph API endpoint

This setting is rare for most Microsoft connections and can be left blank. If needed, this value will be provided by your administrator.

Optional

External users notifications

This indicates if you want to send notifications to external users. The default value is No, so no notifications will be sent. 

If you select Yes, notifications will be sent to external users when they have been granted access to content based on permissions.

Optional

Behavior When Deleting Items

Select the type of delete SkySync 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

 

Microsoft Sign In Modal

 

 

Connection Test Succeeded

 

Features and Limitations 

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

SharePoint Online Connections must have full control of all SharePoint site collections.

 

OneDrive for Business Connections are automatically configured to the Documents library. When configuring your job JSON, do not include "Documents" in the location path, such as “/Documents/FolderName.” The correct configuration path is “/FolderName.”

Files and Folders

OneDrive for Business has the following file/folder restrictions:

Supported Features

Unsupported Features

Other Features/Limitations 

Supported Features

Unsupported Features

Other Features/Limitations 

Version preservation

Mirror lock ownership

Invalid characters:  |   "   \   /   :   *   ?   <   >

Timestamp preservation

 

File size maximum: 250 GB Microsoft limit
SkySync uses a file maximum size of 249.999999 GB files to ensure transfer. 

Author/Owner preservation

 

Segment path length: N/A

File lock propagation

 

Path length maximum: 400

Account map

 

Maximum number of files per folder: 5000 

Group map

 

Maximum Enterprise Keyword length: 255 characters

Permissions preservation

 

Restricted characters in Enterprise Keywords: < and >

User impersonation

 

No leading whitespace 
(See Invalid Characters and Spaces below.)

Metadata map

 

No trailing periods and whitespace. 

Tags map

 

If a file extension is present, trailing periods and whitespace are allowed before the extension

 

 

No non-printable ASCII characters

 

 

Transferring Microsoft Lists is not supported.

File and Folder Name Restrictions

The following are restricted file/folder names.

  • _vti_test

  • CON

  • PRN

  • AUX

  • NUL

  • COM0

  • COM1

  • COM2

  • COM3

  • COM4

  • COM5

  • COM6

  • COM7

  • COM8

  • COM9

  • LPT0

  • LPT1

  • LPT2

  • LPT3

  • LPT4

  • LPT5

  • LPT6

  • LPT7

  • LPT8

  • LPT9

For more information on OneDrive for Business restrictions, see Microsoft’s official documentation.

Connection Pooling

Microsoft Office 365 connections using OAuth 2 authentication may experience bandwidth throttling from Microsoft when using connection pooling.

HTML Files

SharePoint online does not support uploading HTML files larger than 256 MB. If your migration includes HTML files that exceed this limit, the file transfer will fail, and an entry will be logged in the audit with the following message: "Unable to interpret the contents of this page because it exceeds the maximum page size of 268435456 bytes.”

Impersonation with Batch Mode

When using Impersonation with Batch Mode, SharePoint Online shows “System Account” in the activity rather than the impersonated user. This is expected behavior for batch mode/bulk migration API. With batch mode off, the impersonated user will display in the activity panel.

Invalid Characters and Spaces

SkySync 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. SkySync replaces the space rather than trimming it because trimming the space could cause duplicate file names. Adding the underscore ensures the name remains unique.

Lock Events

Graph API does not support lock event detection without the use of a separate API call, which will slow down change detection. The workaround is to disable native event detection to transfer locks in each job run or to use a soft reset to transfer locks as needed. 

Mapping

When creating CSV mapping files for import, the usernames must be lowercase to properly adhere to the search requirements for the connector.

Metadata Mapping

If a library requires specific metadata but the metadata is missing from a file being copied into the library, the file will be flagged and will not transfer on subsequent jobs runs. If you have files stuck in a flagged state due to missing metadata, you may need to manually transfer the files and add the required metadata.  

Timestamps

There is a discrepancy in timestamps for the SharePoint Online Folder Created Date when using CSOM and Batch ModeThis behavior is a known issue within OneDrive for Business/Office 365.

SkySync will attempt to preserve timestamps on folders when using both CSOM and the batch API. However, SharePoint Online updates the folder's modified dates whenever a file is uploaded into it. As a result, when using CSOM, the timestamps will be preserved when the folder is initially created but then updated after every file that gets uploaded. When using batch API, it preserves the timestamps on the folders after all of the files within the batch are committed. This is the cause for the discrepancy between the two methods.

Version Deletes

Version deletes are supported. 

Character Sanitization

SkySync will sanitize file names that contain combined Unicode characters by replacing the characters with an underscore (_).

Create Connection | SkySync API

You will need to add the relevant connection information into the GET request. The following GET will return a Microsoft login link. Use the link to complete logging into the account and to grant SkySync access to the account. 

1 GET {{url}}v1/connections/platforms/onedrive-business-graph/new?domain={{YOUR URL}}&name={{YOUR CONNECTION NAME}}&client_id={{YOUR CLIENT ID}}&client_secret={{YOUR CLIENT SECRET}}

 

Create Job | Impersonation with Admin Connection

As a OneDrive for Business administrator, you can impersonate a user using the path that relates to their content. Then, use their information in the impersonate_as block. (See Impersonation for more information on how to impersonate users.)

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 { "name":"Basic job with impersonation", "kind": "transfer", "transfer": { "audit_level": "trace", "transfer_type": "copy", "source": { "connection": { "id": "{{nfs_source_connectionID}}" }, "target": { "path": "/sourcePath" } }, "destination": { "connection": { "id": "{{OneDriveforBusiness_destination_connectionID}}" }, "impersonate_as": { "id": "00", "name": "Joe Smith", "email": "jsmith@company.onmicrosoft.com" }, "target": { "path": "/destinationPath" } }, "simulation_mode": false }, "schedule": { "mode": "manual" }, "stop_policy": { "on_success": 5, "on_failure": 5, "on_execute": 25 }, "category": { "name": "Report | Impersonation Job Examples" } }

Syncplicity

The Syncplicity connector in SkySync 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 SkySync to connect to the platform. SkySync connections to Syncplicity require OAuth 2.0 access. In order to create a connection from SkySync 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 | SkySync 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 SkySync can connect using the information entered.

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

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

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 SkySync (the third-party application) as defined by OAuth 2.0.  SkySync 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. SkySync 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 SkySync 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 SkySync as to the type of folder that should be created when a top-level folder is created through a SkySync process. To learn more about these options, click here.

Optional

 

Test Connection Succeeded

 

Sign In With SVA

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

 

Syncplicity OneLogin Modal

 

 

Sign in With SVA Succeeded

 

Features and Limitations

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

Supported Features

Unsupported Features

Other Features/Limitations

Version preservation

File lock propagation

Path length maximum: n/a

Timestamp preservation

Mirror lock ownership

Segment path length: 260

Author/Owner preservation

File size maximum

No leading spaces in file name/folder names

Account map

Restricted types

No trailing spaces before or after file extensions

Group map

Metadata map

No non-printable ASCII characters

Permission preservation

Tags map

Invalid characters: \  /  <  > 

User impersonation

 

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

 

 

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.

Invalid Characters and Spaces

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

To create a connection that uses SVA through the API, use the instructions here.

 

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "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", } }

 

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "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", } }

 

Create an admin mode Syncplicity connection.

1 2 3 4 5 6 7 8 9 10 11 12 { "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 } }

Connection Pooling

When transferring data between a source and destination, there are a number of factors that can limit the transfer speed.  Most cloud providers have rate limitations that reduce the transfer rate, but if those limits are account based and it supports impersonation, SkySync can create a pool of accounts that issues commands in a round-robin format across all the accounts connected to the pool. Any modifications to the connection pool will used on the next job run. 

For example, if a connection pool has two accounts, all commands will be alternated between them. If a third account is added to the pool, the next run of the job will use all three accounts.

 

Connection pooling is not supported with My Computer and Network File System (NFS) connection.

 

User and Group Maps 

A user account or group map provides the ability to explicitly associate users and groups for the purposes of setting ownership and permissions on items transferred. These mappings can happen automatically using rules or explicitly using an exception.  Accounts or groups can be excluded by specifying an exclusion, and unmapped users can be defaulted to a known user.  For more information, see Permissions | Account Map / Group Map.

Here are a few things to consider when creating an account or group map: 

  • A source and destination connection are required and need to match the source and destination of the job that will be referencing the user or group map. 

  • A map can be created before or during the creation of the job. 

  • A map can be used across multiple jobs. 

  • Once updated, the updates will not be reapplied to content that has already been transferred. 

User and Group Map Import Templates

Please see Account Map / Group Map | CSV File Guidelines for map templates and sample downloads. You can use these samples to help you build you own mapping files.

User & Group Map Exceptions

A user or group map exception provides the ability to explicitly map a specific user from one platform to another. These are exceptions to the automatic account or group mapping policies specified. User account or group map exceptions can be defined during the creation of the map or can be imported from a comma-separated values (CSV) file. See Account Map / Group Map | Exceptions for more information.

You can import the mappings using a CSV file.

 

You can manually create a map by selecting the user on the source and the corresponding user on the destination.

 

User and Group Map Exclusions

A user or group map exclusion provides the ability to explicitly exclude an account or group from owner or permissions preservation. User account or group map exclusions can be defined during the creation of the map or can be imported from a comma-separated values (CSV) file. See Account Map / Group Map | Exclusions for more information.

Import the exclusions or manually create them.

Transfer Planner 

 At the start of a project, it is common to begin planning with questions like "How long should I expect this to take?" Transfer Planner allows you to outline the basic assumptions of any integration, primarily around the initial content copy at the beginning of a migration or first synchronization.  It uses basic assumptions to begin visualization of the process without requiring any setup of connections or jobs. 

The tool estimates and graphs a time line to complete the transfer based on the information entered in the Assumptions area. The timeline assumes a start date of today and uses the values in the Assumptions section to model the content transfer.  The window displays projected Total Transfer in dark blue and Daily Transfer Rate in light blue. Hovering the mouse pointer over the graph displays estimated transfer details for that day. The timeline recalculates if you change any of the values, making simple “what if?” scenario evaluations. If necessary, you can reset the timeline to display the default values for the transfer planner tool. 

Note that the Transfer Planner is primarily driven by the amount of data needing to be processed. SkySync has various tools for transferring versions of files (if the platform supports this feature), which can increase the size of your data set. It also has the ability to filter out specific files by their type or by other rules you set. At this stage, a rough estimate of total size is recommended as it can refined later using Simulation Mode.

Simulation Mode

Simulation mode allows you to create a job with all desired configuration options set and execute it as a dry-run. In this mode, no data transfers, no permissions are set, and no changes are made to either the source or the destination. This can be useful in answering several questions about your content prior to running any jobs against your content.

 

How much content do I have?

An important first step in any migration is to determine how much content you actually have since this can help determine how long a migration will take.

 

What kinds of content do I have?

Another important step in any migration is to determine what kinds of content you actually have. Many organizations have accumulated a lot of content, and some of that may not be useful on the destination platform. The results of a simulation mode job can help you determine if you should introduce any filter rules to narrow the scope of the job. An example would be if you should exclude executable files (.exe or .bat files) or exclude files older than 3 years old.

 

What kinds of issues should I expect to run into?

During the course of a migration, there are many things to consider and unknown issues that can arise, many of which will only present themselves once you start doing something with the source and destination. Running a job in simulation mode can help you identify some of those issues before you actually start transferring content. Examples can include:

  • Are my user mappings configured correctly?

  • Does the scope of the job capture everything I expected it to capture?

  • Do I have files that are too large for the destination platform?

  • Do I have permissions that are incompatible with the destination platform (i.e. ACL vs waterfall)?

  • Do I have files or folders that are too long or contain invalid characters that the destination platform will not accept?

Creating a Simulation Job

During the last stage of the job creation process, you have the option to enable simulation mode. When a job is in simulation mode, it can be run and scheduled like any other job, but no data will be transferred. 

 

 

Transitioning a Simulation Job to Transfer Content

After review, a simulation job can be transitioned to a live job that will begin to transfer your content to the destination platform.

 

Creating a Job

SkySync delivers a user-friendly, web-based experience optimized for PC, tablet, and mobile phone interfaces, so you can monitor and control your file transfers anywhere, from any device.

SkySync’s true bi-directional hybrid/sync capabilities enable organizations to leverage and preserve content across on-premises systems and any cloud service. Seamless to users, new files/file changes from either system are automatically reflected in the other.  

SkySync uses jobs to perform specific actions between the source and destination platforms. The most common type of jobs are copy and sync; please see Create New Job | Transfer Direction for more information. All jobs can be configured to run manually or on a defined schedule. This option will be presented as the last configuration step.

To create a job, select the Jobs option from the left menu and click on Create Job. SkySync will lead you through a wizard to select all the applicable options for your scenario.

 

The main job creation steps include:

  • Selecting a Job Type

  • Configuring Locations

  • Defining Transfer Policies

  • Defining Job Transfer Behaviors

  • Selecting Advanced Options

  • Reviewing the job settings summary

  • Creating the job and defining the job schedule.

Job Type 

Job type defines the kind of job and the actions the job will perform with the content.  There are four job types available: basic transfer, folder mapping, user job mapping, and network home drive mapping. 

Transfer Direction

The transfer direction determines if content is copied in one direction from the source to the destination or if the content syncs between the source and destination. There is also an option to replicate the folder structure of the source onto the destination. See Create New Job | Transfer Direction for more information.

 

Define Source & Destination Locations

All platform connections made in the SkySync Platform application will be available in the locations drop-down lists when creating a job. The source defines the current location of the content you wish to transfer, and destination defines the location of where you would like to transfer the content. If your connections were created with administrative privileges, you may have the ability to impersonate another user within your organization.

 

Configuring Your Locations | Impersonation

Impersonation allows a site admin access to all the folders on the site, including those that belong to other users. With SkySync, a job can be set up using the username and password of the site admin to sync/migrate/copy files to or from a different user's account without ever having the username or password of that user. This is done by enabling the Run as user toggle. Then choose the user.

Enable Impersonation and select Choose.
Select the user from the list.

Job Category

The category function allows for the logical grouping of jobs for reporting and filtering purposes.  The category is optional and does not alter the job function in any way. SkySync comes with two default job categories:

  • Maintenance: SkySync maintenance jobs only. This category allows you to view the report of background maintenance jobs and is not intended for newly created transfer jobs.

  • Default: When a category is not defined during job creation, it will automatically be given the default category. This option allows you to create a report for all jobs that a custom category was not assigned.

Create Job Category

You can create custom categories to group jobs as needed. You can then filter the Jobs list by category to quickly find groups of jobs.

Create and manage custom job categories.

 

Filter the Jobs list by category.

Job Policies

Job policies define what should happen once items have been successfully transferred and set up rules around how to deal with content as it is updated on the platforms while the job is running. SkySync works on the concept of “deltas,” where the transfer engine only transfers files after they have been updated. File version conflicts occur when the same file on the source and destination platforms have been updated between job executions. Policies define how SkySync handles file version conflicts and determine whether or not it persists a detected file deletion. Each job has its own defined policies, and the settings are NOT global across all jobs.

Conflict Policy | File Version Conflicts

When a conflict is detected on either the source or the destination, the Conflict Policy determines how SkySync will behave. See Conflict Policy for more information.

 

 

Delete Policy | Deleted Items

When a delete is detected on either the Source or the Destination, the Delete Policy determines how SkySync will behave. See Delete Policy for more information.

 

 

Behaviors

Behaviors determine how this job should execute and what course of action to take in different scenarios. Most behaviors are enabled by default as recommended settings to ensure content is transferred successfully to the destination.

 

Zip Unsupported Files / Restricted Content

Enabling this behavior tells SkySync to compress any file that is not supported on the destination into a ZIP file format before being transferred. This will be done instead of flagging the item for manual remediation to allow transfer of the file. For example, if you attempt to transfer the file "db123.cmd" from a Network File Share to SharePoint, SkySync will compress the file to "db123.zip" before transferring it over, avoiding an error message. 

Allow unsupported file names to be changed

The Segment Transformation policy controls if SkySync can change folder and file names to comply to platform restrictions. This behavior allows SkySync to change the names of folders and files that don't comply with the platform rules for leading and trailing characters or that contain characters that are not supported by the destination. This will be done instead of flagging the file for manual remediation and preventing it from being transferred. There are two options for supporting characters that are not supported by the destination.

 

 

The Replace with underscore option replaces invalid characters with underscores. For example, if you attempted to transfer the file "Congrats!.txt" from Box to NFS, SkySync would rename the file to "Congrats_.txt" on the destination.

The Encode invalid character option encodes invalid characters instead of replacing them with an underscore. The UTF8 bytes for invalid characters are used and converted to a hex string. For example, a file names "123白雜.txt" would be converted to "123E799BDE99B9CE8.txt."

Allow truncation

Each platform has limits for path and segment lengths. The truncation option determines how to handle paths and segments that exceed these limits. If disabled (the default option), an item with a path or segment length that exceeds the platform limits will not transfer and will be be flagged for remediation. When enabled, truncation will shorten a path or segment name when it exceeds the maximum number of characters a platform allows by removing the right-most characters until the path meets the length requirements. Enabling truncation reduces the potential for flagged items.

Preserve file versioning between locations

Some platforms keep snapshots of every change made to files. Version preservation determines how file versions are handled in the transfer. If version preservation is enabled for a job, the application will attempt to preserve all or the specified number of versions of the files if supported on both platforms. See Version Preservation for more information.

 

 

Link detection will scans files and identifies any links in the files. It will run for both simulation and transfer jobs. The Job reports will display link information when available for the job. See Link Detection for more information.

Advanced

These optional job configurations allow you to determine what features you want to preserve, filter, or add during your content transfer. 

Filtering

Filtering defines rules for determining which items are included or excluded during transfer. There are multiple custom filter options available. See Job Filters and the following for more information.

 

Permission Preservation

This setting enables SkySync to determine how permissions are transferred across platforms. See the following resources for more information:

Permissions | Author/Owner Preservation

Permissions | Permissions Preservation

Permissions | Permissions Import

Permissions | Preserve Shared Links

Metadata Mapping

Metadata mapping allows you to import a CSV file that documents source metadata and how you want it applied to the destination. See Metadata Import for more information.

Scripting

Some SkySync features are not available in the user interface. The scripting feature allows the advanced SkySync user to enter advanced transfer features by inserting JSON formatted job controls. Enabling this option will allow you to leverage these features and apply it during job creation. See Advanced Scripting | Additional Configuration Options for more information.

Job Summary

Before you create your job, review all your configurations and adjust them as needed. The Edit option will take you directly to the configuration to make changes. Modifying your job after creation is not supported; however, the option to duplicate your current job will allow you to make any adjustments without starting from the beginning. 

Saving the Job

Once you have verified the configuration options, you need to save the job. This allows you to specify a name for the job so it can be distinguished from any other jobs you need to create.

 

 

You also have the option of setting a schedule and stop policies for a job. If you choose not to schedule the job, it will run every 15 mins after the last execution completes.

Defining the Job Schedule

A job schedule allows you to control when the job runs. The schedule manages the job runs for you so you don't have to manually execute job runs. The schedule can be set to determine both how often a job runs and when a job should stop running. You have the option of editing schedules for jobs as needed once the job is created. See Scheduling a Job for more information.

 

 

Defining Stop Policies 

Stop policies determine when a job should stop running. If none of the stop policies are enabled, a scheduled job will continue to run until it is manually stopped or removed. See Job Stop Policy for more information.

 

 

Reports

Reporting is paramount with the SkySync Platform.  Whether you chose to utilize the SkySync manager application, CLI, or REST API, reporting options are available to help you manage and surface data about your content in real-time.  

Job Overview Report

This report provides detailed transfer information for the individual job. The percentages displayed are intended to provide a quick summary of the content. In the event rounding applies to one of the values, the total of the percentages may not equal exactly 100%.

In some circumstances, bytes on the destination can be higher than listed on the source. This discrepancy is caused by property promotion on Word documents. See Report Values | Potential Differences due to Post Processing for more information.

Schedule: Provides information on how many times the job has executed, when the job will run again, and progress towards meeting the job stop policy defined

Transfer Details | Identified Chart: Reflects content identified on the source platform and the status summary for items

Transfer Details | Revised Chart: Reflects content that SkySync revised during transfer to meet destination requirements and user-defined job configurations

Transfer Details | Flagged Chart: Reflect content that SkySync could not transfer. Manual remediation is required

Run Breakdown Report: Provides job history information for each execution for the given job

 

Values in the run breakdown may differ from values presented in the charts. This is because the run breakdown tracks each individual occurrence where as an item can only exist in a single chart category.

Example: When an item is both truncated AND ignored, it would not show up in the "Revised" chart but would show up in the "Revised" run breakdown

The run breakdown also shows both files and folder values. The charts display files and folder values separately, with the "Transfer Details" dropdown available to switch between display values.

 

Run Breakdown | Select a specific Job Run

Run Breakdown | Last Activity

Job Content Insights Report

The Content Insight report presents a breakdown of your transferred data for your given job. Where applicable, SkySync will use the content modified date when supported by a given platform. This ensures accurate modified date timestamps when viewing the Content Insights charts. Use the drop-down options to change the chart views.


Job Sharing Insights Report

This report offers a breakdown of all permissions associated to your content. The values presented are based on the source content.

On the Shared Insights tab for a job, the value "Not Shared" represents both items that have no permissions as well as content shared by inheritance from the parent folder. At this time, SkySync only tracks permissions applied during transfer, not permissions that result from inheritance within the hierarchy.

 

Job User Mappings Report

The User Mappings report for a given job presents the permission breakdown of your content. If any of the following features are enabled, User Mapping report will populate:

Job Validation Report

Control the level of tracking and reporting for content that exists on both the source and destination platform, including content that has been configured to be excluded from transfer and content that existed on the destination prior to the initial transfer. Items that have been ignored / skipped by policy or not shown because they already existed on the destination can now be seen on reports with the defined categories.

The default validation option is inspect none. This option does not need to be configured in the application user-interface or through the REST API; it is the system default.

This configuration will not track all items but will offer additional tracking with performance in mind. Inspect none will track all items on the source at all levels of the hierarchy but not including those configured to be ignored/skipped through policy. For the destination, all content in the root (files and folders) that existed prior to the initial transfer will be tracked as destination only items and reported as ignored/skipped. For more information, see Job Validation | Item Inspection Policy.

This option has the following features:

Source: All content (files and folders) at all levels in the hierarchy, but not including those configured to be ignored/skipped through policy. However, if the connection does not have access to a given folder in the hierarchy, we cannot track and report these items.

Destination: All content in the root (files and folders) that existed prior to the initial transfer will be tracked as destination only items and reported as ignored/skipped.

Destination: All content (files and folders) lower depths of the directory (sub-folders) that existed prior to the initial transfer will not be tracked.

If the connection does not have access to a given folder in the hierarchy, we cannot track and report these items.

Job Reports - Validation tab: At any time, you may run a validation run, which will trigger a full inspection of all content relating to the option you select for the next run only.

Generate Job Reports

SkySync Reports provide several options to combine multiple jobs into a single report for review. Reports are generated by category, individually selected jobs, or by convention job parent (user job mapping, network home drive mapping, or folder mapping job types). Reports are separated into two categories (report types): transfer jobs and simulation jobs.

Generate Report

Report Type

The report type determines which jobs can be selected for the report and on which tab the information displays. Transfer jobs are the jobs actively transferring content. These reports show under the Reports tab. Simulation jobs imitate transfer. These reports show under the Simulation jobs tab. If you don't specify the report type when creating the report, it is automatically created as a transfer job report and will be added to the Reports tab. 

 

Report Contents

The report contents define which jobs the report includes. 

  • All jobs: All jobs for the selected job type (transfer or simulation) will be added to the report. 

  • Jobs under specific categories: This option allows you to include only jobs that have been assigned to specific categories. Select the category from the list that appears. All available categories display in the list. Only the jobs that match the selected job type (transfer or simulation) will be included. Select Add another category to add additional categories. You can click Remove if you want to remove a selected category.

  • Children under a specific parent job: This option will add all child jobs under the selected parent job to the report. Only jobs that match the selected job type (transfer or simulation) will display in the list.

  • Manually select jobs: This option allows you to select individual jobs you want to include on the report. Only jobs that match the job type selected for the report (transfer or simulation) display in the list. For convention jobs, the jobs display in the list as "Parent Job Name | Child Job Name" so you can easily identify each job. You must select at least two jobs. Select Add another job to add additional jobs.  If you select more than two jobs, you can click Remove next to jobs to remove a job. (This option is only active for jobs three and on. If you need to remove one of the first two jobs, simply select a different job from the list.)  

Remediation

Each item is a package, consisting of the media itself, version history, author, sharing, and any other metadata. SkySync ensures all pieces of the item package are transferred to the destination to preserve data integrity. If SkySync can't transfer an item, the item is set to retry. By default, SkySync will attempt three times to reconcile items that are in pending/retry status. Depending on your job configuration, this may occur with the defined schedule, or you can start the job manually. When an item is in a "flagged" status, this means SkySync has made all attempts to transfer the file without success, and it requires manual remediation. These items can be retried or ignored on subsequent job runs. If retried and successfully transferred, the item will be removed from the flagged items. 

All migrations require some amount of manual user intervention to move content that fails to transfer automatically. One of the uses of simulation mode is to get an understanding prior to a live transfer of how many files might fail to transfer and the reasons. This can be used to adjust the job parameters to achieve a higher number of automatic remediation successes.

General Reasons Content does not Transfer

Errors from Source and Destination Platforms

This is a broad error category that indicates SkySync was prevented from reading, downloading, uploading, or writing content during content transfer by either the source or destination platform provider. Each situation is dependent on the storage provider rejection reason and will require manual investigation to resolve.

 

Insufficient Permissions

Many platforms require additional permissions in order to perform certain functions, even for site administrator accounts. These permissions typically require a special request from the storage provider. For example, content that has been locked, hidden, or flagged to disable download may require this special permission request from your storage provider.

 

Scenario-Specific Configuration

Content on your source storage platform is diverse, and users across your business will structure their data in a variety of ways. A single one-size-fits-all project configuration may not be suitable and can result in some content not transferring to the destination platform. SkySync Professional Services and Customer Support can assist in assessing these situations to help provide custom, scenario-specific configuration that may workaround the issue that is preventing the transfer.

 

Disparate Platform Features

Each platform provider has a given set of features that are generally shared concepts in the storage business industry. However, each storage platform may have behavioral or rule differences within these features, and aligning these discrepancies can be challenging. Features such as permission levels (edit, view, view+upload, etc.) may not align as an exact match from the source platform to the destination platform. File size restrictions or file names may need to be altered to conform to meet the destination platform's policies. SkySync will attempt to accommodate these restrictions through configurations in the system, but not all scenarios can be covered in a diverse data set.

 

Interruption in Service

SkySync must maintain connection to the database at all times during the transfer process. If there is an interruption in service, SkySync will fail the transfer as it is unable to track/write to the database.

 

How do I validate my content transferred successfully?

Verify the destination

SkySync will report all content that has transferred to the destination. Log into your destination platform and verify the content is located as expected.

 

SkySync is reporting items in "pending" or "retrying" status, what are my next steps?

Run the job again

SkySync defaults to retrying the job 3 times to reconcile items that are in pending/retry status. Depending on your job configuration, this may occur with the defined schedule or you can start the job manually.

 

Review the log message

SkySync logs a reason why the item is in pending/retry status. On the job Overview tab, click on the Transfer Details breakdown status "retrying." This will take you to the Items tab with the content filtered to show just items set for retry. Select the item and click the View item history link in toolbox on the right side of the page.

SkySync is reporting items in "Flagged" status. What are my next steps?

When an item is in "flagged" status, this means SkySync has made all attempts to transfer the file without success, and it requires manual remediation. 

 

Review the log message

SkySync logs a reason why the item is in pending/retry status. On the job Overview tab, click on the Transfer Details breakdown status "flagged." This will take you to the Items tab with the content filtered to show just the flagged items. Select the item and click the View item history link in toolbox on the right side of the page. Review the message and determine if you can resolve the issue on the source platform.

 

Export the flagged items for a job

To export the a flagged item report,

  1. Select Jobs and select the job with the flagged items.

  2. Go to the Items tab.

  3. Filter the list to show only items with the Status “Flagged.”

  4. Select Export this report. This saves the list of flagged items to a CSV file for review.

     

Review Flagged Items page

The Flagged items menu option will display the flagged items across all jobs. Use the export option to export the report to a CSV file. You can then use the file to remediate issues by correcting issues that are preventing items from transferring and identifying flagged items that don't need to be transferred. Once you’ve worked through the export, return to the Flagged items page to set the job to retry an item or ignore it on the next job run. You can also choose to view the history of the item. You can work with one item at a time or select multiple items and select the appropriate action.

 


 

 

SkySync enables the world’s most successful enterprises with total control over and unbounded access to their content, empowering their evolving modern workforce.  We connect disparate storage platforms, unite silos of information, and synchronize content spread across the enterprise—at scale. We enable our customers to achieve singular access and unified control over their content, so they can support the evolving needs of a modern workforce.  

To dive in further, view our support documentation or contact us at info@skysync.com for more information about how SkySync can help you connect and transform your content.