Syncplicity® DataHub - Axway Documentation Portal

Syncplicity® DataHub Installation, Configuration and User Guide

Version 1.5

Syncplicity DataHub User Guide 2

Copyright © 2018 Axway. All rights reserved.

This documentation describes the following Axway software:

Syncplicity DataHub

No part of this publication may be reproduced, transmitted, stored in a retrieval system, or translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without the prior written permission of the copyright owner, Axway.

This document, provided for informational purposes only, may be subject to significant modification. The descriptions and information in this document may not necessarily accurately represent or reflect the current or planned functions of this product. Axway may change this publication, the product described herein, or both. These changes will be incorporated in new versions of this document. Axway does not warrant that this document is error free.

Axway recognizes the rights of the holders of all trademarks used in its publications.

The documentation may provide hyperlinks to third-party web sites or access to third-party content. Links and access to these sites are provided for your convenience only. Axway does not control, endorse or guarantee content found in such sites. Axway is not responsible for any content, associated links, resources or services associated with a third-party site.

Axway shall not be liable for any loss or damage of any sort associated with your use of third-party content.

Document

Version

Software

Version Publication Notes

1.0 3.2 April 2016 Initial publication

1.1 3.2

May 2016 Release Candidate 1 updates:

Configuring Syncplicity for on behalf of access,

Home Directory mapping, User Permission mapping, new authentication methods, new

deployment worksheet appendix added.

1.2 3.5.0.3

July 2016 Final GA updates for GA build 3.5.0.3 Setup instructions for obtaining app keys &

secret from the Syncplicity Developer Portal. Updates to the deployment worksheet.


Document

Version

Software

Version Publication Notes

1.3 3.6.3.26

March 2017 GA Updates for eDiscovery, Platform Support, UI

Updates for folder icons, TLS support.

1.4 3.7.0 July 2017 Syncplicity PrivacyRegion support added. SyncDrive folder type support added. The App

Key and App Secret fields are now masked in the connection dialog.

1.5 3.7.12 June 2018 Created and LastModified timestamps are

preserved when uploading to or downloading

from Syncplicity; updated copyright and Axway logo.


Contents

Introduction 8

Architecture .................................................................................................9

Before You Begin 10

Prerequisites: ..............................................................................................10

DataHub Server(s): ....................................................................................10

Operating System and Hardware:................................................................. 10

Database: ......................................................................................................... 10

SQL Server Specifications: ............................................................................... 11

DataHub Server Security: .........................................................................11

Performance sizing: ...................................................................................12

Product Activation Keys: ..........................................................................12

Syncplicity: .................................................................................................12

Syncplicity Account: ........................................................................................ 12

Administrator Accounts: .................................................................................. 13

End User Accounts: .......................................................................................... 13

Security Policies: ............................................................................................... 13

End point access: ............................................................................................. 13

Device Registration: ......................................................................................... 14

On-Premises Syncplicity StorageVaults and Storage Connectors ............ 14

Network: .....................................................................................................14

Supported Data Sources and Targets: ..................................................15

Installation 15

Installing DataHub .....................................................................................15

Default Installation steps using the embedded Windows CE Database: 16

Activating DataHub..................................................................................16

Post Deployment customization: ............................................................16

Configuring a proxy (if applicable) ........................................................16


Connecting to Syncplicity Hosted services in different regions .........18

DataHub Home 20

Working with tiles .......................................................................................20

Home screen toolbar ...............................................................................20

Adding a connector .................................................................................21

Creating a Syncplicity Connection ............................................................... 23

Obtain a Syncplicity Application Token ....................................................... 23

Obtain an App Key and App Secret from the Developer Portal.............. 24

Create a connection to Syncplicity using your Application Token, App Key and App Secret: ....................................................................................................... 27

Settings ........................................................................................................28

Logging: ............................................................................................................. 29

Performance ..................................................................................................... 29

Job History ......................................................................................................... 31

Notifications ...................................................................................................... 32

License ............................................................................................................... 34

Help .............................................................................................................35

Support .......................................................................................................35

Working with auto search ........................................................................35

Working with panels ..................................................................................35

Job Control panel ............................................................................................ 35

Navigation panel ............................................................................................. 35

Basic Search panel .......................................................................................... 36

Favorites panel ................................................................................................. 36

Using the Job Control panel 36

Job Context menu ....................................................................................38

Job Control toolbar ..................................................................................38

Creating a new job...................................................................................39

Advanced job settings .............................................................................43

Content Filtering ........................................................................................46

Basic filters ......................................................................................................... 47

Advanced filters ............................................................................................... 47

Metadata filters ................................................................................................ 47

Map User Accounts & Map Groups .......................................................47

Default settings ................................................................................................. 49

Default accounts ............................................................................................. 49

Advanced settings ........................................................................................... 49


Map metadata .........................................................................................50

Pre-Sync Analyzer ......................................................................................51

Other job templates .................................................................................52

User Drive mapping ......................................................................................... 52

Master Content ................................................................................................ 56

Folder mapping ................................................................................................ 57

Source Convention .......................................................................................... 58

Destination Convention .................................................................................. 59

Permission Migration ........................................................................................ 59

eDiscovery Bulk Extraction Use Cases ........................................................... 60

Working with your jobs ..............................................................................67

Deleting a job ................................................................................................... 67

Starting a job ..................................................................................................... 68

Pausing a job .................................................................................................... 68

Viewing the Log History ................................................................................... 68

Viewing the Audit History ................................................................................ 69

Viewing the server status................................................................................. 71

Job Inspector .................................................................................................... 71

Using the Navigation panel 72

Navigation toolbar ....................................................................................73

Adornments ...............................................................................................73

Creating a new folder ..............................................................................74

Deleting a folder .......................................................................................74

Viewing your folders .................................................................................74

Renaming a folder ....................................................................................75

Moving your items .....................................................................................75

Deleting a file .............................................................................................75

Viewing a file .............................................................................................75

Renaming an item ....................................................................................76

Moving your folders ..................................................................................76

Copying or cutting your folders ..................................................................... 76

Dragging and dropping your folders ............................................................ 77

Adding a favorite folder ..........................................................................77

Defining a job ............................................................................................77

Connection pooling .................................................................................78

Locking and unlocking files .....................................................................79


Using the Basic Search panel 79

Basic Search toolbar.................................................................................79

Performing a basic search .......................................................................80

Saving a favorite search ..........................................................................80

Working with your search results .............................................................81

Working with favorites ..............................................................................82

Accessing your favorite searches from the Favorites tile ........................... 82

Accessing your favorites from the Home screen ......................................... 82

Deleting your favorites..................................................................................... 82

Using the Favorites panel 83

Favorites toolbar ........................................................................................83

Exiting DataHub 84

Enabling long path support for file systems 84

Appendix 1: Deployment Worksheet 85

DataHub Server(s): ....................................................................................85

Syncplicity Account: .................................................................................85

Networking .................................................................................................86

Appendix 2: Deploying DataHub with SQL databases 87 Overview ........................................................................................................... 87

Architectural Notes .......................................................................................... 87

Configure DataHub to use a SQL Server database .................................... 87

Configure multiple DataHub nodes in a cluster .......................................... 88

Pre-Requisites .................................................................................................... 88

Step by step installation instructions for multiple server installation .......... 88

Install DataHub on the first server (node) of the cluster ............................. 88

Error! No text of specified style in document. 8

Introduction Syncplicity DataHub is designed to help you sync, move, copy and migrate your

files no matter where they are stored. It allows you to connect to and access your files stored in a growing number of Cloud and local storage systems from one

central location.

DataHub is a powerful tool for enterprises modernizing their IT infrastructure to

reduce costs and empower the mobile workforce. Connects to over 30 data sources, include legacy files shares, SharePoint and enterprise content management (ECM) systems, enterprise file sync and share solutions, and

automates the process of file migration and integration to Syncplicity.

The Syncplicity DataHub is easily deployed and configured (zero coding) to

migrate, copy and bi-directionally synchronize files between these systems and Syncplicity StorageVaults located in public cloud, private cloud or on-premises

storage. With Syncplicity DataHub, IT can:

• Ensure the integrity of folder structures, metadata, permission and document versions when migrating.

• Set granular filters on what files are included in the migration, allowing the exclusion of unwanted content, whether it’s a file type employees are storing on file

shares that violate IT policies or outdated files.

• Remove enterprise data silos and give employees anywhere, anytime desktop

and mobile access to all of their documents without changing the way users work.

• Automate the bulk extraction of content in Syncplicity to enable eDiscovery and streamline or automate forensic or related legal matters.


Architecture

DataHub is a Windows service on a Windows server of your choosing. DataHub uses

local Windows resources along with information provided in the connection creation process to access content.

To access storage, DataHub must be able to connect to the storage platform via

HTTPS. Depending on your corporate firewall policies and configuration, you may need to open various ports for DataHub to tunnel storage and/or to the DataHub

licensing infrastructure during product activation.


Before You Begin Prerequisites:

To ensure a frictionless deployment process, the following list includes the hardware, software and configuration prerequisites along with sizing recommendations.

Please refer to Appendix 1 for a summarized checklist of requirements and a place to capture your configuration.

DataHub Server(s):

Operating System and Hardware:

Win2k12r2 preferred. Windows .NET 4.5, framework (often found by default on Win2k12r2) Min 100GB disk, 2 CPU Core. Initial trials and functional evaluations of the

product can be conducted on Windows 7 or Windows 8 but should not be used in production under any circumstances.

There are no minimum RAM or processor speed requirements beyond the Microsoft

recommended minimum for a .Net application.

DataHub can be installed on a physical Windows Server or VM. It does not require installation on the network file server or the SharePoint server itself. DataHub can be

co-resident on other Windows Server components such as a server running Syncplicity Panorama although special consideration should be given to high

availability since running both products would create a single point of failure for 2 critical processes.

Database:

DataHub’s default installation contains an embedded database built on Windows CE (Compact Edition). This configuration is perfectly acceptable for initial evaluations or temporary use but is limited to 4GB of log file growth or management

of 10,000 objects (whichever comes first) The key scaling factor is the object count managed by DataHub.


The following table illustrates 4 different configurations and their general sizing

guidelines. The critical consideration in sizing is the number of objects. An ‘object’ is defined as either a file or a folder.

Configuration Size Object Count

Approximate

Storage

Capacity

Required Syncplicity Content

Migrator database

components *with logging

enabled

Demo / Mini Less than

10,000 Under 500GB

Use embedded Windows CE

database

Small 3 Million Under ½ TB

Medium 3-10 Million > 2TB Use SQL Express (customer

provided)

Large > 10 Million > 5 TB Use SQL Server (not

Enterprise)

SQL Server Specifications:

Supported OS, Supported SQL Server (2008 R2 or better, 2012 recommended), MIN

64GB+ RAM, 60GB system drive, 200GB+ data drive, fast hard drives recommended

for performance, redundant network interface cards, dual quad core processor or

better.

DataHub Server Security:

A Windows Service Account is required on the DataHub Server. In order to read from source systems, this service account will need Active Directory read permissions. Depending on the use case with the source system this service account

will require at least read privileges on the source system, R/W access is required if syncing bi-directionally between Syncplicity and your source systems.

Windows network shares configured using Distributed File Systems (DFS) are supported. “Hidden Shares” that have a $ character in the UNC file system path are also supported.

DataHub stores connection information, such as user name, password, URL, and UNC, for some platforms encrypted in its database. This makes it important to

secure the server running DataHub’s local file system to add additional protection to this information.

When migrating DataHub to another server it may be necessary to copy encryption key files manually to ensure shared databases can correctly decrypt this sensitive data.


Cloud platforms use other authentication mechanisms like OAuth2 and only present an access token to DataHub instead of allowing visibility into credentials.

In general, DataHub does not control, edit, move, modify, or otherwise interact with security directly. DataHub acts as an external user to storage systems, interacting with them via their public APIs.

Recommendations:

• Determine up front as part of your security design how DataHub is to access

the content you ask it to transfer. Consider DataHub another “power user” in

your organization manipulating content. Note that integrated Authentication scenarios can be tricky to configure due to Windows Service Identity and

other (ultimately) permissions based issues.

Avoid creating lots of connections by correctly defining security permissions, groups, and proxy users. DataHub works best with platforms that have rich API support for

concepts such as On Behalf Of, setting time stamps, and methods of ownership preservation

Performance sizing:

DataHub performance depends on many variables, such as:

• Quality, specs, and other resource usage on the DataHub server(s)

• Network considerations at the client (bandwidth, switching, load, etc.)

• Network considerations in the cloud (B2B, cloud storage vendor, etc.)

• Cloud storage quotas, rate limits, etc.

DataHub is generally limited more by how many entities (total files and folders) are

tracked by the integration jobs, as this state is stored in the application database. Larger numbers of smaller sized files are a larger challenge to the transfer engine vs. smaller numbers of larger sized files.

Product Activation Keys:

You will need a valid software activation key to immediately after installation of DataHub. You can obtain a trial key from your Syncplicity Customer Success or Sales contact.

Syncplicity:

The following conditions are required for integration to Syncplicity:

Syncplicity Account:

An active trial or paid Enterprise Edition account.


Administrator Accounts:

At least 2 Global Admin accounts (one admin needs to create a 2nd Syncplicity Service account).

An API app key and secret are required that are unique per customer. These can be obtained from the Syncplicity Developer portal.

A service account (the second global admin account) which must have elevated permissions to act on behalf of users via the API. This permission is disabled by default.

The service account used to build connections to Syncplicity needs to belong to groups for users whose data is being migrated. You can migrate data into

Syncplicity and keep it under the ownership of the service account, then manage the permissions and sharing to Syncplicity users from this one account, however for

better scale and efficiency its best to have the ability for the service account to manage data on behalf of other end users.

An Application Token which should be generated by the same service account

that is used to build connections from DataHub to Syncplicity. The application token is generated and obtained from account menu in the Syncplicity Admin portal.

End User Accounts:

When migrating data from source systems into Syncplicity, in order for the Syncplicity user to obtain access to that data, each user must have an active

Syncplicity account.

Security Policies:

In order to establish a connection to Syncplicity as either a source or a destination,

DataHub creates a persistent connection similar to that of a desktop client. This persistence is required to add content automatically and intermittently when jobs

run at predefined intervals. Therefore, the policy considerations for desktop clients also need to be applied to DataHub implementations.

In order to allow connections to be established to Syncplicity, the Desktop Client

Active Directory Restriction Policy must be applied to the Service Account that is authenticating from DataHub to Syncplicity. By default, this policy setting is

“Company users can install and run Syncplicity on any computer”. This policy setting is recommended and must apply to the Service Account being used to connect to Syncplicity.

End point access:

To test end to end data flow from your source systems through Syncplicity onto an end users device or in their browser, it is necessary to either engage directly with

end users or have them verify files have been transferred successfully to their desktop clients and/or mobile clients. Alternatively, whomever is the Global Admin

in the Syncplicity tenant can view the end users files via the Impersonate User option in the Syncplicity Admin console.


Device Registration:

Since DataHub establishes a persistent device, the Syncplicity account that is used to manage DataHub will also have a device mapped to it that is visible via the

Manage Device menu. The device will register with a naming convention similar to the one shown in the following diagram. It is vital that after establishing this

connection, the device should not be renamed or removed unless you are ready to abandon the connection and potentially irrevocably remote wipe the data from Syncplicity.

On-Premises Syncplicity StorageVaults and Storage Connectors

If you chose to store data in an on premises StorageVault special consideration

must be given to the version. Only versions 2.7.0.5 or higher are supported. In a multi-StorageVault environment all Storage Connectors must be at the same version

or higher.

Network:

Proxies between DataHub and either the source or destination systems are supported. More information about proxy configuration steps can be found in the Installation Section.

URL’s and ports to be whitelisted from the DataHub server(s)

a. DataHub licensing: https://api.portalarchitects.com

b. Syncplicity Orchestration: https://xml.syncplicity.com

c. Syncplicity Admin Portal: https://my.syncplicity.com (best practice is to have the ability to access this portal directly from the DataHub

Server to transfer keys and tokens efficiently.

d. Syncplicity Developer Portal: https://developer.syncplicity.com

(best practice is to have the ability to access this portal directly from the DataHub Server to transfer keys and tokens efficiently.


e. Syncplicity API gateway: https://api.syncplicity.com

f. (optional) Syncplicity storage US: https://data.syncplicity.com

g. If using an EU PrivacyRegion hosted account, use the following:

Syncplicity application: https://xml.eu.syncplicity.com

Syncplicity api gateway: https://api.eu.syncplicity.com

Syncplicity Cloud storage EU: https://data-eu.syncplicity.com

h. (optional) Your own StorageVault URL: This can be found in the

Syncplicity Admin portal under Settings.

i. Access to source systems:

1. NAS shares require SMB access via UNC paths and mounted windows drive letters from the DataHub Server.

2. Cloud Storage: Several EFSS systems are supported

sources for DataHub. Each has its own prerequisites and URL access.

Supported Data Sources and Targets:

The list of supported sources and destination systems can be found in the Syncplicity DataHub Data Sheet. The most recent copy can be found here:

https://www.syncplicity.com/features/syncplicity-data-hub/

Installation Syncplicity DataHub is a Windows based application designed for administrators to

define connections to storage systems and define integrations between them via jobs.

Installing DataHub

DataHub uses a local SQL CE database by default. By modifying configuration files,

DataHub can be configured to run against a full SQL Server instance of your choice. This is recommended for high volume and / or high availability scenarios.

For first time use in a proof of concept or test/development scenario based on the default installation flow, please refer to the following installation steps.

https://data-eu.syncplicity.com/

https://www.syncplicity.com/features/syncplicity-data-hub/


For more detailed installation scenarios such as using a local SQL server, remote SQL server or in a clustered scenario, please see Appendix 2 at the end of this guide.

Once completed with that installation option, continue with this guide in the Activating DataHub section.

Default Installation steps using the embedded Windows CE Database:

1. Download and open the DataHub executable.

2. At the Open File – Security Warning prompt, click Run.

3. At the Welcome Screen, click Accept to the License Agreement and Next to begin the installation. Depending on your device specifications you may be

prompted to install the Windows .NET 4.5 dependencies. This will automatically download and install directly from Microsoft.

4. As the installer completes, a splash screen will appear prompting you for your License Key to activate DataHub.

Activating DataHub

DataHub requires an internet connection to activate for the first time, access your cloud storage systems, and run jobs.

If your installation has been completed, you can return to the license key activation prompt by launching DataHub from the icon located on your desktop. Upon

launching DataHub for the first time, the system displays an activation box. To activate DataHub:

1. If you have not contacted Syncplicity and received a license key, please do

so.

2. Copy/paste the key from your email.

3. Select the Start DataHub button.

Once it finishes loading, DataHub opens and displays the Home screen. For more information on the Home screen, refer to the


DataHub Home topic.

Post Deployment customization:

Configuring a proxy (if applicable)

Configuring DataHub to Work With a Proxy Server can be configured in two

configuration files:

C:\Program Files (x86)\SkySync\skysync.exe.config

C:\Program Files (x86)\SkySync\syncservice.exe.config

Run Notepad as Administrator and open each of the config files listed above.

Add the following inside the <system.net> </system.net> tags:

<system.net>

<defaultProxy enabled = "true" useDefaultCredentials = "true">

<proxy autoDetect="false" bypassonlocal="true" proxyaddress="http://127.0.0.1:8888" usesystemdefault="false" />

</defaultProxy>

</system.net>

The proxyaddress value is required to be the IP address of the Proxy Server and not

the FQDN.

DataHub only supports one proxy server per installation. If there are two or more

proxy servers in a load balanced configuration simply use the IP Address of one of the Proxy Servers.

Save each file and then restart DataHub by following these steps:

1. Open the Windows Services menu.

2. Right-click on the SkySync service. (note: at the operating system level DataHub

registers with Windows in a process called “SkySync”)

3. Click Restart.

If your organization utilizes a config script (.pac) and some calls to endpoints fail after configuring DataHub for a proxy server following the steps above, instead edit the two config files between the <system.net> </system.net> tags so they appear

as below:

<system.net>

<defaultProxy useDefaultCredentials="true">


<proxy usesystemdefault="False" scriptLocation="http://<IP ADDRESS>/file.pac" />

</defaultProxy>

</system.net>

Substitute the appropriate IP address pointing to the .pac file for "<IP Address>".

Save the files and restart the SkySync Service for the changes to take effect

Connecting to Syncplicity Hosted services in different regions

For residency or compliance requirements, you may have an Enterprise Edition

account that was provisioned in the US or the EU (referred to as a PrivacyRegion). From time to time Syncplicity may add other PrivacyRegions.

If you are not sure in which PrivacyRegion your Enterprise Edition account is located,

please contact Syncplicity Support ([email protected]).

The default URLs for DataHub are directed to the US-hosted PrivacyRegion so a

simple configuration change will be needed to redirect connections to the EU-hosted PrivacyRegion, or any new PrivacyRegions Syncplicity introduces.

mailto:[email protected]


Configuring these URL’s can be done by updating the contents of a configuration file:

Navigate to: C:\Program Files (x86)\Syncplicity Data Hub\appSettings.config

Run Notepad as Administrator and open the config file listed above.

Between the <appSettings> tags:

Append the keys for SyncplicityBaseUrl and SyncplicityBaseXmlUrl

The result will appear as follows for the EU-hosted PrivacyRegion:

<?xml version="1.0" encoding="utf-8"?> <appSettings> <add key="RequestedParallelWrites" value="2" /> <add key="aspnet:UseTaskFriendlySynchronizationContext" value="true" /> <add key="SyncplicityBaseUrl" value="https://api.eu.syncplicity.com/" /> <add key="SyncplicityBaseXmlUrl" value="https://xml.eu.syncplicity.com/" /> </appSettings>

Save the file.

Go to Services and restart the Syncplicity DataHub service.

NOTE: The URLs for the US and EU PrivacyRegions are as follows:

US PrivacyRegion:

SyncplicityBaseUrl = https://api.syncplicity.com/

SyncplicityBaseXmlUrl = https://xml.syncplicity.com/

EU PrivacyRegion:

SyncplicityBaseUrl = https://api.eu.syncplicity.com/

SyncplicityBaseXmlUrl = https://xml.eu.syncplicity.com/


DataHub Home The Home screen is the first screen you see once DataHub launches. You can return

to it at any time while you are working in the application by selecting the Home button in the application. A sample of the DataHub Home screen displays below.

Working with tiles

Several tiles display on the Home screen by default. Use these tiles to navigate to

the corresponding application panels, where you can execute searches, access your favorites or perform other functions.

Favorites, Favorite Searches, and associated tiles are further identifiable by user

defined color codes. For more information on color coding a favorite search, refer to the Saving a favorite search topic. DataHub also places icons on each search

tile to display the associated supported services.

For more information on working with favorites, refer to the Using the Favorites panel topic.

NOTE: You can delete user-added Favorite tiles but not the application ones.

Home screen toolbar

The toolbar handles all system functionality for DataHub. The buttons available vary based upon the pane that you are viewing. A sample of the Home screen toolbar

displays below.


• Use the Back navigation arrow to move back through screens that you

visited previously.

• Use the Forward navigation arrow to move forward through screens that you

have visited previously.

• Use the New Connection button to connect to a new service. For more

information on connectors, refer to the Adding a connector topic.

• Use the Settings button to open the settings dialog to customize the

appearance of DataHub, edit performance settings, check your license information, and more. For more information, refer to the Settings topic.

For more information on the toolbar buttons on other panels, refer to that panel’s topics in this document.

Adding a connector

Connectors allow DataHub to establish a connection with your storage accounts.

You can connect with the following services:


You must first establish a connection with the storage platform(s) that you want to use in DataHub. To add a connection, click the New Connection button in the

toolbar then choose a service from the drop-down list.

A sample of the drop-down menu displays below.

The connection dialog that displays is dependent on the service you selected. Generally, you need to provide connection credentials and/or authorize DataHub

to access your cloud account. Some connectors require additional information like the URL to the server, whether or not you would like to use Windows Integrated

Security, or other options specific to your desired platform.

Cloud accounts that rely on browser interaction to establish connections may

require additional prompts or settings based on your default browser and configuration. Cloud based services typically launch an embedded web browser window or your default browser to perform the authorization. A connection to on-

premise systems typically display a specific dialog pop up.

If you create your connection with certain platforms with the correct privileges, you

unlock additional functionality such as User Conventions, User Drive Mapping, Permissions Migration, Metadata Mapping, and View User content, if available on your license. See additional sections of this document for details.


Creating a Syncplicity Connection

Connections to Syncplicity are established against 2 interfaces, your Syncplicity Account, and your Syncplicity API gateway.

Select an account role of Global Administrator (such as a service account) which also has the elevated privilege of accessing user files on their behalf. This account

can also be used to obtain app key and an app secret which authenticates against the API gateway.

These tokens and keys are hexadecimal strings which can be copied and pasted

directly from their source web pages into DataHub. For this reason it is a best practice to access the Syncplicity sites directly from the DataHub server.

Obtain a Syncplicity Application Token

Once you’ve selected the account which will be used to create a connection to Syncplicity, open a browser and:

1. Access the Syncplicity Admin portal at https://my.syncplicity.com

2. Navigate to Account page for this Administrator’s account

3. Scroll to the bottom of the Manage Your Account page and look for the “Application Token:” section as shown:

4. Click Create

5. This will generate a unique application token for this account owner. You will need this Token along with the API portal APP key and App Secret to build a

connection.


Obtain an App Key and App Secret from the Developer Portal

The Application Token alone is not enough to create a connection to Syncplicity.

The next and final authentication mechanism is for the API gateway which makes calls to the Syncplicity service to manage jobs.

Based on the configuration done by your Syncplicity administrator, the Syncplicity Developer Portal will present one of the following options for login:

• Basic Authentication using Syncplicity username and password.

• Enterprise Single Sign-on using the Web-SSO service used by your

organization.

Once you have successfully logged in for the first time, the Syncplicity Developer Portal automatically creates an Enterprise Edition sandbox account to help you

isolate API only traffic from actual file transfer traffic.

Open a browser and:

1. Access the Syncplicity developer portal at https://developer.syncplicity.com

(US PrivacyRegion) or https://developer.eu.syncplicity.com (EU PrivacyRegion)

2. Click LOGIN

3. The Syncplicity Developer Portal automatically creates your sandbox

account by appending "-apidev" to the email address you used for logging

into the Developer Portal. For example, if you logged into Syncplicity Developer Portal using [email protected] as your email address, then your

associated sandbox account username is [email protected].

4. The Developer Portal will prompt you to set your password for this sandbox account. See screenshot below for reference.

https://developer.syncplicity.com/

https://developer.eu.syncplicity.com/


5. Look for this confirmation message.

6. Navigate to My Apps, then Create App

7. Create an App Name, approve the API Terms of Use and Save. Description and the App Icon are optional.


8. An App Key and App Secret will automatically generate and populate the page. Choose Apply for Production, and set the Default Scope to

Read/Write in the Default Scope option and Save.


Create a connection to Syncplicity using your Application Token, App Key and App Secret:

1. Create a connection to Syncplicity from the New Connection menu bar in

the Home Screen. The options on your menu may vary depending on your licensing.

2. Choose Application Token for the Authentication Type. The default authentication type “Application Token” is to be used with StorageVaults that do not have StorageVault Authentication (SVA) enabled. If your on-

premises StorageVaults have StorageVault Authentication (SVA) enabled, then choose authentication type “Application Token + StorageVault

Authentication”.

3. Then enter/select:

a. Your Application Token (retrieved from the Account page of the

my.syncplicity.com admin portal or eu.syncplicity.com admin portal)

b. App Key and App Secret (retrieved from the Syncplicity Developer

portal at developer.syncplicity.com or developer.eu.syncplicity.com)


c. List Content For All Users in Your Enterprise is optional – this will be useful when querying on connections for a given service account to return a

list of all users, versus the standard view of folders owned by the service account.

d. Choose whether new Syncplicity syncpoints (top-level folders) are

created as Standard sync folders or as SyncDrive folders when using this connection.

Settings

Select the drop-down Settings menu. The settings dialog has several tabs on the left of the screen: Appearance, Logging, Performance, Job History, Notification and

License. The version number of your copy of DataHub is shown in the lower left.


Logging:

The Logging tab allows you to configure the application to report logs to the ProgramData\PortalArchitects\Logs folder on the host hard drive.

Log Level: Determines the amount of information logged. The application reports all

information at the selected setting or above. Off disables all logging. The rest are

listed in descending order from least potential information logged (Fatal) to most

potential information logged (Trace). The application is set to Info by default.

Archive Files (days): Determines how many days of logs to store on the hard drive.

Log Files: Click Open log file directory to open the folder containing saved logs.

Performance

Depending on your license, you may have access to higher numbers of Parallel

Writes. This determines how many operations DataHub attempts at one time, and can impact your network as well as DataHub performance. Please consult with Support and your Network Administrators before changing this setting.


Bandwidth throttling

If the Limit maximum bandwidth checkbox is checked, DataHub limits the total

bandwidth of all jobs to the amount specified. By default there is no limit.

NOTE: This configuration setting is per-instance, meaning that in deployments where

there are multiple DataHub servers, this setting affects each DataHub server

individually and the bandwidth utilization is cumulative across all DataHub servers affecting all running jobs.

Smart throttling

Separate from the UI and absent any user input, DataHub automatically finds the optimal speed and performance for any job. If a job exceeds the rate limit

responses (ex. 429 errors) allowed by a cloud connector, DataHub “throttles down” to an appropriate speed, ensuring maximum speed along with maximum reliability.

DataHub never exceeds the maximum number of parallel writes designated by the

Limit maximum bandwidth setting.


Job History

The Job History tab allows you to configure how DataHub preserves the job histories that can be viewed from the Job Control Panel. By default, DataHub retains and

preserves all job histories from the last thirty days.

Job History Duration: You can configure DataHub to retain job histories based on

either the number of executions per individual job, or the number of days that have elapsed. Select either Instances or Days from the top drop-down, then define the number of days or instances in the field below.

Preserve Empty Job Histories: By default, this setting is on and DataHub preserves all

job histories. If this box is un-checked, DataHub does not preserve job histories from

executions where no operations were performed (no items were created, modified or deleted), and these job histories are removed from the database.


Notifications

Under the notification tab, the DataHub application can be configured to send notification emails when a job fails, completes successfully, or both.

A test button is provided that sends a test email using the information provided by you.

By default the notification level is Never. Notifications are not sent.

To receive notification emails, set the notification level to one of the following:

• Always: Notification is sent when a job succeeds or fails.

• Only On Success: Notification is sent only when a job succeeds.

• Only On Failure: Notification is sent only when a job fails.


Required fields

The following fields are required in order to send notifications:

• From: Email address appears in the from field of the notification message.

• To: One or more email addresses that are to receive the notification

message. Separate multiple addresses with commas.

• Subject: Subject line of the notification message.

• Report Header: Header title in the notification email.

• Host: DNS resolvable name of the SMTP server or IP address

• Port: TCP port of the SMTP server.

• Use SSL: Check this box if the SMTP server uses SSL.

SMTP Server Authentication

Some SMTP servers require authentication. To configure authentication, check Requires Authentication and provide a valid username and password for the SMTP

server.

The following table provides sample settings for common SMTP servers.

Provider GMAIL Office 365

Host smtp.gmail.com smtp.office365.com

Port 587 587

Use SSL Yes Yes

Requires Authentication Yes Yes

If you are encountering issues with sending messages through Gmail, the most likely

cause is that SMTP notifications have not been enabled. Please see the following link for Gmail support on this

topic: https://support.google.com/mail/answer/78775?hl=en

Validation errors

Required fields are validated when a value is entered. If the value is in an invalid format (ex: invalid email address), a red border appears around the textbox. You

cannot save settings when an invalid value is entered.

https://support.google.com/mail/answer/78775?hl=en


Below is a sample notification email.

The notification email lists a summary of the job and list any errors in a .csv file

attached to the email.

License

To view details about your product license, enter a new license key, or to get more information about DataHub Software editions, use the License tab.


Help

Use this panel for accessing DataHub online help.

Support

Use this panel for contacting Syncplicity Support.

Working with auto search

Auto search is the fastest, simplest way to perform a search from the Home screen or any panel to locate job information in DataHub.

Depending on which panel you are on, you can launch a global item search or search for a job by its name.

Working with panels

There are four system default panels in DataHub: Job Control, Navigation, Basic Search and Favorites. You can access these panels by selecting the corresponding

tile on the Home screen, or by selecting them from the drop-down navigation menu. For more information on each panel, refer to the corresponding topic in this documentation.

Job Control panel

Use the Job Control panel to create and manage jobs. Refer to the Using the Job Control panel topic.

Navigation panel

The Navigation panel allows you to view and work with all of your files in one place. It consists of several panes, including a source pane, a viewer pane containing

folder details and a Destination pane that you can opt to display by selecting the

View button in the toolbar.

The Source pane is an expandable/collapsible tree view. Use standard Windows functionality to navigate through the Source pane. You can view and work with all of your folders that are contained in the services you are connected to. DataHub

retrieves those folders and allows you to perform various actions with them, such as copying them to the clipboard, pasting, deleting, renaming, etc.

In the detail pane, DataHub displays a list of the files contained in the folders. You can work with these files by right-clicking and selecting from a list of actions in the

resulting context menu.

DataHub also gives you the option of viewing a Destination pane. The Destination pane is helpful when you are trying to drag and drop items between storage

platforms and are having trouble getting everything on the screen together in the Explorer pane tree view.


To view the Destination pane, select the View button in the toolbar then click Show Destination from the drop-down menu.

A third pane displays on the right side of the Navigation panel. This pane aids in such actions as copying or moving files. You can copy and paste, or simply drag and drop your files from one folder to another.

For more information on the actions you can perform, refer to the Using the Navigation panel topic.

Basic Search panel

Use the Basic Search panel to perform a search across all your connected storage systems that support global full-text search. The results from each system are listed

on its own tab. Double click on the result item you want to work with and the application automatically displays it in the Navigation panel. For more information

on actions you can perform, refer to the Working with your search results topic.

You can select the services that you want to search and add a favorite search in this panel. Refer to the Performing a basic search topic.

Favorites panel

Use the Favorites panel to see a quick list of all of your favorite searches and places. On the Favorites panel, you differentiate between favorite searches and folders

that you have designated as favorites. For more information on favorites, refer to the Working with favorites topic.

Using the Job Control panel Job Control interfaces with the Windows service that provides most DataHub

editions with unattended synchronization features on a workstation or server. DataHub can create job definitions that can publish, migrate, copy, or synchronize

content between any linked storage systems.

You can access the Job Control panel by clicking the tile on the Home screen or by selecting Job Control from the drop-down navigation. This tile has an adornment

which shows information about the jobs that you have defined. If all your jobs are running properly, the icon is green and the number indicates your total number of

defined jobs. If the system has detected any errors with your jobs, the icon is red and the number indicates the number of jobs that are affected by an error.


A sample of the DataHub dashboard tile displays below.

Clicking the tile takes you to the Job Dashboard. From this panel, you can create a

new job, delete an existing job, or perform various functions to your jobs, such as starting, pausing or reviewing history logs.

A sample of the Job Control displays below.

The Job Control displays the Name of each job you have defined, the Source folder for that job, the destination folder, the type of job you are running, the time the job

was last run, the amount of time that it took the job to run (the last time that it ran) and the next time it runs. You can rearrange the order of the columns by dragging

the headings.

You can use the magnifying glass icon in any column header to filter the job list by various criteria.


Job Context menu

You can access various functions for a job by right clicking on it then accessing the

context menu. Some potential functions match the following toolbar functions.

• Inspect Job runs the Job Inspector, similar to the pre-sync analyzer. This

shows information about the job, differences between source and destination, and other useful facts. Refer to the Job Inspector section for

more information.

• Reset Job discards the DataHub’s tracking information for this job, and

causes the content indexes to be rebuilt. This can help when a job has missed events due to an error or other condition.

• Default View resets the grid if you’ve filtered or hidden child jobs.

• Properties shows you information about the job, particularly its ID. This can

help you find log files for that job to provide to Support if necessary.

Job Control toolbar

The DataHub window contains a toolbar. All system functionality is handled through this toolbar. The buttons available vary based upon the pane that you are viewing.

A sample of the Job Control toolbar displays below.

• Use the Back arrow to move back through screens that you visited previously.

• Use the Forward arrow to move forward through screens that you have

visited previously.

• Use Start to manually start a job. For more information, refer to the Starting a

job topic.

• Use Pause to temporarily suspend a previously scheduled job. For more

information, refer to the Pausing a job topic.

• Use Delete to delete a job that you no longer want in DataHub. For more

information, refer to the Deleting a job topic.

• Use New to create a new job within DataHub. For more information, refer to

the Creating a new job topic.

• Use History to view information about a selected job, or to export a .CSV file

of the job failures. For more information, refer to the Viewing the Log History

topic. Choose Server History to see aggregate information about the jobs that exist in DataHub. For more information, refer to the Viewing the server

status topic.

• Use View to control the display of rows in the job control list.


• Use the New Connection button to connect to a new service. For more

information, refer to the Adding a connector topic.

• Use Settings to customize the appearance of DataHub, edit performance

settings, check your license information, and more. For more information, refer to the Settings topic.

Creating a new job

Before working with the Job Dashboard, you must first establish a new job. You can

have jobs already defined from the Navigation panel, or create a new job in the Job Dashboard.

To create a new job:

1. Select the New button, in the toolbar on the DataHub Job Control panel. A

drop-down menu gives you the option of creating a job from a selection of

templates. You can choose a basic job, a User Drive Mapping job, a Master Content job, or a Folder Mapping job. User Drive Mapping, Folder Mapping,

and Master Content jobs are explained in detail below.

Depending on which job template you choose, what connections you choose, and what other options you choose, DataHub displays other options

for you to configure and customize your job. Not all features are available in all circumstances. The following sections outline what to expect when you

access each option.

A sample of the Add New Job dialog displays below.


2. Select the Click to Select Source button. All of the services that DataHub

supports display.

3. Select the location that you want DataHub to manage content. DataHub

manages all children of this location.

You must have already established a connection between DataHub and the

service to enable a job. If you have not established a connection, you can select the New Connection button in the drop-down. For more information,

refer to the Adding a connector topic.

A sample of the drop-down menu displays below.

4. Navigate through the folders in the service, by clicking the Expand carrot.

When you have located the source folder, select the Choose…button.

5. Select the Click to Select Destination button. All of the services that DataHub

supports display in the drop-down option.

6. Select the location where you want to transfer the files.

7. Navigate through the folders in the service. When you have located the

Destination folder, select the Choose…button.

8. Select the type of job that you want to perform from the Select Job Type

drop-down menu. You can select a copy, publish, synchronize, migrate, or

taxonomy job.

a. Select Copy to copy all of the content from the source folder to the

destination folder.


b. Select Publish to remove all of the content from the destination folder

and then copy the information from the source folder to the destination

folder.

c. Select Synchronize to compare the source and the destination folders,

and determine (via time stamp) if there is any new content that needs to

be added to the destination folder.

NOTE: Content is deleted from the source side of the job if deleted on

the destination end once an ongoing job pair is established and the Mirror option is chosen for Delete Propagation.

d. Select Migrate to remove all of the content from the source folder and

deliver it to the destination folder.

e. Select Taxonomy to copy only the folder structure of the source to the

destination. This type of job is useful when permissions are a factor.

DataHub currently cannot migrate permissions. One process we recommend to accomplish the same effect is:

i Establish the source and destination connections.

ii Create and run a Taxonomy job for the respective data. This copies

the folder structure to the destination.

iii Have an administrator apply the necessary permissions to the folders

on the destination side.

iv Edit the job to Synchronize, Copy or Migrate, whichever one best

suits your needs.

v Run the job.

9. Choose the interval for the job:

• System Default is set to run every 15 minutes. This value is configurable via

an application configuration setting. Contact Support for more information.

• Manual allows you to choose when you want the job to occur, and to

start it manually, by selecting the Start button. For more information on starting a job manually, refer to the Starting a job topic.

• Choose Schedule allows you to select the frequency that you want the

job to run.

10. Select the Interval button, then choose a predefined frequency from the

drop-down. The intervals range from 5 minutes to 2 days. You can use the

Advanced scheduling mode to define more elaborate schedules.


Simple schedule: Advanced:

11. Choose the Conflict Resolution policy you want this job to use. This controls

how DataHub deals with files that it cannot determine which is the “newest”. The “i” icon displays more information in a tool tip to help you decide.

• Conflict Copy is the default and safest option. DataHub creates another

copy of the file in question, appending a time stamp to its name.

• Prefer Latest is similar to file system behavior – “last save wins” per the

timestamp.

• Prefer Source or Prefer Destination picks the copy from the respective

location to support systems of record.

• Fail skips the conflict file, logs it in the job logs, and waits for an

administrator to manually intervene.

12. Choose Delete Propagation policy you want this job to use. This controls how

DataHub deals with files that it detects have been deleted. The “i” icon displays more information in a tool tip to help you decide.

• Ignore Both is the default and safest option. DataHub does not remove

files from source or destination.

• Ignore Source or Ignore Destination DataHub ignores delete events from

the chosen location, but deletes content from the opposite side when detected. For example, choosing Ignore Source does not delete any

content from the destination if a source item is deleted. If a destination delete is detected, the content is deleted from the source. The logic is

reversed for Ignore Destination.

• Mirror DataHub deletes content from either side when it detects the

content has been deleted from the other side of the job.

NOTE: The Interval button does not display until you select the Choose

Schedule option. It is red when there is no interval defined, and changes to green once you have selected a value.

13. Enter a name for the job, in the Name field. The system defaults the name to

a name formatted in the “[chosen job type]:[source folder] to [destination folder]” format. You can enter any value to personalize the job, or leave the

default.


NOTE: If you later change details about the job that would have given a

different default name, DataHub does not automatically change the job

name to match. Don’t let this confuse you, and customize the name when in doubt!

14. Select the OK button to complete the creation of the job and to close the

Add New Job dialog.

DataHub immediately launches the job if you set it for automatic execution.

Advanced job settings

Clicking the Advanced Link on the Add New Job dialog offers more options for your job. You have different options available depending on your selections, the

platforms involved in the job and their support, your features or license level on the platforms, or your version or license of DataHub.

The following describes the advanced options.

• Category applies a category to your jobs to allow you to filter or group them

in the job control panel grid.

• Lock Propagation allows DataHub to manage locks for systems that support

check in / check out.

o Ignore. Default setting. DataHub does not manage locks.

o Mirror Locks causes DataHub to lock a file on the destination if it is

detected to be locked on the source and vice versa. The item shows it is locked by the connection identity.

o Mirror Locks (Impersonate User) causes DataHub to lock a file on the

destination if it is detected to be locked on the source and vice versa. DataHub uses impersonation and information from the User Account

Map to lock the file.


• Email Notification allows DataHub to send email alerts for this specific job to

email addresses you list here, separated by a semicolon (;).

• Content Filtering allows you to decide what content is included in your job.

See the Content Filtering section for more details.

• Map Groups allows DataHub to implement advanced features around

migrating permissions. See the Map User Accounts & Map Groups section for details.

• Map User Accounts allows DataHub to implement advanced features

around impersonation, mirroring locks, preserving author information, and migrating permissions. See the Map User Accounts & Map Groups section for more details.

• Map Metadata allows DataHub to move metadata on content between

systems that support it. See the Map metadata section for more details.

• Enable Version Preservation. When turned on (default), allows supported

platforms to preserve all versions during a job. For example, when syncing a SharePoint 2010 library with versioning enabled to a cloud platform that

supports versioning, DataHub would transfer all versions of a document during the initial job. So if there were versions 1, 2, 3, and 4 on SharePoint, after the initial job there would also be four versions of the content in the

cloud platform.

• Enable Change Only Optimization allows DataHub to use changes or

events APIs to streamline change detection on platforms that support it via

their API. Turning this function off can greatly degrade performance.

• Enable File Name Transformation allows DataHub to modify file names by

replacing invalid characters with an underscore “_”. Turning this option off may cause jobs to fail depending on your data and platform.

• Enable author-preservation allows DataHub to use the information from

your User Account Map to mark any Edited By/Created By type fields on your

content to match on either side of the job.

• Enable permission-migration allows DataHub to use the information from

your User Account Map and Group Map to migrate permissions on files and folders from your source system to your destination system. DataHub

attempts to meet the spirit of the permission, as the levels vary for each platform. If DataHub cannot migrate a permission or has trouble, it places

warnings in the job log. See Map User Accounts & Map Groups for more information.

Network File System

Notes Read Write Read+Write R+W+Delete Full Control

Box Viewer Uploader Viewer Uploader

Editor Co-Owner

Google Can View Can Edit Is Owner


Network File System

Notes Read Write Read+Write R+W+Delete Full Control

Hightail Only valid for users with email address

Can Download Only

Can Edit

Egnyte No search for users or groups. Passthrough only.

Viewer Editor Editor Full Owner

SharePoint Read Contribute Full Control

Documentum Read Write Write Delete Delete

• Use Trust Mode tells DataHub you have already copied content to the

destination. This impacts only the initial transfer. While active, if files exist on

both sides, DataHub assumes the files are equal. After the initial transfer, changes on either side are detected and propagated according to your settings and selected transfer type. This is useful when either the source or

destination system does not support preserving timestamps.

• Zip all unsupported file types tells DataHub to zip and then transfer file types

known to not be accepted by the platform. Turning this off can cause jobs to fail if you attempt to transfer unsupported types into a platform that rejects

them.

• Audit Transfer tells DataHub to keep detailed audit logs of all actions for this

job. This consumes significant database space so this feature is only enabled when DataHub is installed on a full SQL Server.

• Analyze Before Saving tells DataHub to run the Pre-Sync analyzer on this job.

See the Pre-Sync Analyzer section for more information.


Content Filtering

The Content Filtering feature allows you to tell DataHub what content to include in

your jobs. Use Exclude filter categories to automatically block certain file extensions from being involved in any job using the filter. The drop-down menu contains all of the saved filter sets. To create a new one, click on the Add link to bring up the

Content Filter window.

Depending on your platform and license, you may have some or all of these

options.


Basic filters

Click the checkboxes to exclude every file extension included in that category. Clicking on the view link brings up a small window listing every file extension in that

category, allowing you to specify which extensions are to be excluded.

If the custom checkbox is selected, you can use the drop-down menu below to

define whether the specified file extensions entered in the box to the right is be included or excluded. If included is selected, only the defined file extensions is included in the job. When entering desired file extensions, use a semi-colon (;) to

separate multiples.

The Name box allows you to enter the name for the filter set that is displayed in the

Content Filtering drop-down menu within the Add New Job window.

Advanced filters

Per the guidance provided on the dialog, you can Exclude or Include content

based on your choices. You can use the created, modified, or access date ranges as appropriate to only include files with time stamps that match your criteria.

Metadata filters

If the platforms selected for this job support metadata, you can include a source and/or destination metadata filter.

You create expressions that, when the metadata on a file matches, includes the item in the transfer. Items not matching the filter are not copied. For example, if you have an ECM system that has a metadata field on each document called

Approved that can be true or false, you can set a metadata filter expression of “Approved = true”. DataHub only copies content flagged by your users, workflows,

or back end systems that are marked approved.

You can use the Edit button to build the expressions, including more complex ones.

At this time, DataHub does not support nested expressions or order of operations.

By using the Pre-Sync analyzer and noting which items are included in the transfer via the rules, you can predict how your expression is working with your data.

Map User Accounts & Map Groups

When using DataHub on supporting platforms, you can enter a user map. The map

tells DataHub how to set and sync author based fields like “Last Modified By” between platforms. In addition, this information is used for impersonation for author preservation, lock propagation, and permissions migration.


You can choose <None> option (default) from the Map User Accounts drop-down

to ignore user mapping for this job. If you have already created a map previously for this source/destination pair to use, you can select it from the drop-down.

You can click Add Link to launch the Configure Account Links Dialog. Clicking the

Edit link with a previously created map in the drop-down launches the dialog to edit your choices. An example of the Configure Account Links dialog shows below.


Default settings

DataHub attempts to match users and groups based on rules. When it cannot match users or groups automatically, it relies on a map provided by you to map

them. When no mapping can be resolved, DataHub uses the account to set for the Unresolved User for the platform. DataHub places warnings in the job log for entries

that cannot be resolved. Check your map settings and platform settings per the messages provided.

Begin typing to have DataHub search your platform for matching users/groups.

Press tab to select the user/group and move to the next entry box.

Default accounts

Once you have entered an unresolved user/group for both source and destination,

your map is valid and can be saved.

Advanced settings

When there are situations where DataHub cannot correctly link accounts by User

Name nor User ID, you can tell DataHub specifically what accounts to link.

Click the Use Advanced Settings checkbox to set up advanced mappings for these

exception cases.


Use the search boxes to find and define specific exception cases you would like DataHub to use when mapping users/groups. Press the green plus icon to add a

link. Click the red X icon to remove a link you have defined.

If you don’t want to enter the exceptions one by one, you can import the list from a CSV file.

Group maps work identically, but do not have an “Unresolved Accounts” option.

When you are finished, press OK to save the User/Group Map.

Map metadata

If you wish to have DataHub move your user defined metadata along with your

content, you need to provide a metadata map. As long as both platforms support metadata, DataHub uses your map to choose what fields to move across and how to resolve conditions like missing required field data.

From the Advanced section of the Add New Job dialog, click the Add or Edit link to modify the metadata map for this job. From the drop-down, you can use any

previously defined map for this source/destination pair. The default <None> option does not transfer any metadata values.


If a system supports metadata but not the definition of metadata structures, the list may be empty as shown in the screen shot. Otherwise, a list of metadata fields for

each location is shown. By pressing Mirror, DataHub auto links all metadata fields and names. You can then click on the individual lines and press Delete on your keyboard to remove links you do not want. If the fields are already populated, you

can drag the source field onto your desired destination field to establish a link. You can click the Add link to manually add one field. Click the Red X to remove a field

you do not want.

Clicking the Advanced Settings mode gives you more options on how to handle

missing metadata values. You can choose to ignore them, fail to raise an error to the job log, or provide a default value. Required fields are noted with a red

checkbox on the left.

Press OK to save your metadata map. During job execution, DataHub uses your

settings to populate the metadata for your content.

Pre-Sync Analyzer

This setting runs a series of tests against your job to point out any problem areas before you begin transferring data and files. This can help avoid issues with bad

files, file names, permissions problems, and many other areas.

The test contents can vary depending on your platforms, licenses, and selections. An example analysis is shown below.


The analysis can take a few moments. When all your tests are complete, they are flagged green, yellow, or red for OK, warning, or failure respectively.

Any areas that might impact your job allow you to export a list defining the potential problems to CSV for analysis outside of DataHub. Some rules may have a “?” icon, indicating you can click there for more information about the rule being

tested.

Press OK to continue and save your job, or Cancel to abort the process.

NOTE: you can run the Job Inspector from the context menu of a job by right

clicking on it and selecting “Inspect Job”. This provides similar information to the

pre-sync analyzer along with an analysis of the differences between source and destination.

Other job templates

DataHub allows automation of job creation to simplify maintenance for certain tasks.

User Drive mapping

Creating a User Drive Mapping job allows you to easily sync data from a storage provider to a Box, Google Apps, or One Drive for Business account. When creating

a new User Drive Mapping job, DataHub creates a master-job for the map. When that job runs, DataHub scans the source and the destination and creates a sub-job for each relevant folder. In order for this feature to function, the administrator must

be a co-administrator with the “on behalf of” privilege granted in the Box account or similar elevated permissions for other platforms.

An example path that would be created as a sub-job by the convention master job would be: \\Server\SharedFiles\Users\JSmith to the Box account for JSmith. Data is

synced from the first to the second.

Exceptions

From the Add New Job window, once you’ve selected your source system and

destination system, selecting Advanced shows the advanced job options. With a User Drive Mapping job you will see a Contention option. Clicking on Exceptions

brings up the exceptions window. This view shows the navigation:


Match Type

Directory: DataHub attempts to match each source directory name directly to

each destination account. Example: user1234 > [email protected]

LDAP: Selecting this setting from the drop-down menu enables a configure button,

which brings up the following window:


Here you can configure DataHub to use your active directory or other LDAP directory to search for the appropriate user, based on information contained in the

source folder name.

The watermark text on each field is the guide to what information DataHub needs to query your LDAP directory and map the user accounts.

E-Mail Domain

If an e-mail domain is entered in this field, DataHub only maps to accounts

belonging to the designated domain.

Import/Export Exceptions

Exceptions can be imported from a .csv file, or you can create a list of the

configured exceptions by exporting as a .csv file.

Link Home Drives

You can manually link accounts by entering in the Source folder and the desired destination account. This is useful when the two names have no obvious connection, when the account doesn’t exist in either side, or when one account

has inherited content from another account.


Master Content

A Master Content job allows you to Copy or Publish a source (the Master) to every child directory of the chosen destination.

When the Master Job is created, a parent-job is scheduled to run, creating each a sub-job for each directory. If a convention path is entered, a folder with that name

is created as a child for each sub-job.

This type of job is useful for transferring static data to many separate destinations. For example, if you wish each folder in a system to have InstructionManual.txt, a

Master Content job with the source containing InstructionManual.txt copies the file to every child folder one level below the destination.

A sample of the Add New Job window for Master Content jobs with Advanced settings open displays below.


Folder mapping

Creating a Folder Mapping job allows you to create many jobs at once to simplify jobs between multiple “cousin” folders. When a Folder Mapping job is created, a

parent-job is also created similar to a User Drive Mapping job. After the parent-job runs, a sub-job is created for each folder as defined in the Source Convention box

(explained below). When the sub-jobs run, if an identical folder does not exist on the destination it is created and data is transferred accordingly.

A sample of the Add New Job window for User Drive and Folder Mapping jobs with

Advanced settings open displays below.


Source Convention

The Source Convention box is where you enter the name of the folder containing the “child” directories that will have a sub-job created for them.

Exclusions

Clicking on the Exclusions link next to the Source Convention box brings up the

Exclusions window.

You can select which folders to either include or exclude when sub-jobs are

created through convention jobs. You should be aware that when selecting to include certain folders, DataHub does not add new jobs for any new folders that are created after the convention master-job is created. You have to do this

manually. If exclude is selected, however, DataHub continues to automatically add new sub-jobs for newly created folders every time the master-job runs.


Destination Convention

The Destination Convention box allows you one more level of flexibility in transferring data to the destination. An example of data transfer if this field is left blank would

be: \\Server\Users\JSmith to SharePoint\Users\JSmith. Entering “WorkFiles” into the destination box would result in: \\Server\Users\JSmith to

SharePoint\Users\JSmith\WorkFiles.

Permission Migration

In the Advanced options, when mapping folders consider selecting “Enable

Permission-migration” to manage the folder access controls on the source system and enable them in Syncplicity. Selecting this option will allow you to Map User Accounts as shown in the next step.

Exceptions

Clicking on the Exceptions link next to the Destination Convention box brings up the Exceptions window.


The Exceptions window allows you to configure how accounts on the source side are linked to accounts on the destination side.

Default settings

The three checkboxes are all selected by default. Account is linked by matching names and IDs. If the account on the destination side is disabled, the corresponding

sub-job is deleted the next time the master-job runs.

Advanced settings

If the Use Advanced Settings checkbox is selected, the window expands to include the Advanced Settings. Here you can manually link two accounts that are not linked by the default settings. Imports can be imported or exported using .csv files.

To manually link two accounts enter the names in the appropriate boxes and click OK.

eDiscovery Bulk Extraction Use Cases

Electronic discovery (eDiscovery) is the electronic aspect of identifying, collecting

and producing electronically stored information in response to a litigation request or forensic investigation.

For an eDiscovery use case, jobs can easily be configured to bulk extract from Syncplicity to an off-system location where file data can be ingested into an eDiscovery tool to support EDRM workflows as shown in the following illustration:

Conceptual Model for enabling eDiscovery with DataHub


eDiscovery Administrator Role

This is a read-only role in Syncplicity with access to Syncplicity reports, user

accounts, devices, and folders. The role can also be limited to specific user groups. To enable the ability to export data off-system for discovery, forensic or legal-hold reasons, a separate set of Application Token, App Key and App Secret can be

provisioned using the methods described earlier, yet the connections and related jobs associated with this role will have read-only access to Syncplicity.

Configuring eDiscovery Use Cases – extraction without a metadata manifest file

The following illustration captures the conceptual model for using a connection in DataHub with Syncplicity as the Source (with any supported StorageVault) and a

Network Share as the destination. Once the source and destination are configured, the eDiscovery admin can select a given user as the custodian, then view their

original content in Syncplicity via the ‘As User’ delegated ability. You can further reduce the scope of access for your eDiscovery role to only operate on behalf of

certain groups of users.

The following illustration involves a single user but the system supports the ability to discover against multiple custodians in a given shared folder. Note, at the time of

this writing jobs are not able to be configured against Syncplicity as a source either globally or at the custodian level based on full text indexing, regex or other pattern

matching algorithms. However, data extracted from Syncplicity to a destination file share retains the source system-level metadata from Syncplicity and can then be

processed or searched further with customer-provided indexing and forensic methods.

Sample Configuration for eDiscovery between Admin and Custodian Data


The following illustration shows step by step flow for an eDiscovery admin to search and select a given custodian’s source files and folders (whether private or shared).

Browsing to one custodian’s folders from the default view of the Administrator.

Configuring a Job Source on behalf of a Custodian’s Data

Alternatively, when a new connection is being configured, you can select the “List

Content For All Users In Your Enterprise” at the time your connection is built.

With the List Content flag chosen you will see results in the Navigation panel displaying a root folder for each user configured in your Enterprise Account.


Here are side by side comparisons.

With List All Content selected Without List All Content selected

Configuring eDiscovery Use Cases – extraction with a metadata manifest file


For proper automation with 3rd party eDiscovery tools, an inventory of the output extracted from Syncplicity along with past versions of all files not yet marked for

deletion.

Similar to the use case above, Syncplicity will be the target and a platform of your choice will be the destination, typically this is a UNC addressable file server.

With Syncplicity as the source, selecting a particular custodian in DataHub, can then be followed by defining the network share as a destination.

Bulk Extraction Best Practices:

1. Use an eDiscovery Admin Role.

Consider using a service account with the role in Syncplicity of eDiscovery Administrator. This role is a read-only role which will help

avoid spoliation that may be introduced if you use a service account with both read and write permissions in a given

custodian’s Syncplicity folders.

If a job is set to Synchronize with a file share as a destination and the user’s Syncplicity folders as a source, you could inadvertently

be copying data from the file share back to the user custodian’s Syncplicity folders. Creating connections using an eDiscovery role

prevents this accidental copying into the custodian’s folders.

2. Set the Select Type to be Copy.

As an extension to the previous goal of using an account with read-only access to Syncplicity, using a copy job adds a fail-safe mechanism in the event an extraction job is mistakenly created

using a Global Admin role which has both read and write access to a custodian’s folders.

3. Configure Conflict Resolution and Delete Propagation

Extraction jobs should have Conflict Resolution set to Conflict Copy

set so that in the event of a duplicate file, the duplicate file will be

extracted and captured in the metadata manifest file.

Extraction jobs should also have Delete Propagation set to Ignore

Both so that when a file is deleted from Syncplicity the previous

version will still be retained on the destination for auditing reasons.

4. Enable Virtual Versioning


Syncplicity supports numerous versions of each file. Confirm the settings with your Administrator to set your expectations properly.

Enabling virtual versioning will automatically extract all previous versions of files. In the manifest file the incremental versions of a given file will be referenced by an incremental version ID.

5. Enable Export Metadata

Many 3rd party eDiscovery products require a manifest file in csv

format to aid in properly formatting and preparing source data to be ingested into an analytics workflow. Check with your vendor’s

documentation for your requirements. If your processing workflow does not require the manifest file you can ignore this checkbox.

As a result of these best practices, a sample extraction job may look like this:

By selecting “Export Metadata” you will be prompted for a location on the server’s file system to place the manifest file.

By using a read-only eDiscovery role, if you forget to set the job type to Copy from

the default of Synchronize you will be warned about this by seeing a red indicator

in the “Check allow file creation [source]”. This is intentional and will prevent you

from syncing content into the custodian’s Syncplicity folders.


After a job is run once or repeatedly, for each completed execution, the DataHub

administrator has a variety of levels of detail to retrieve the output of a given job. The diagram below illustrates the summary, detailed, and csv output of the results.

Various levels of detail available for a given eDiscovery Job

Finally, the following illustration compares both the source and destination repositories capturing the preservation of metadata to ensure authenticity. This

level of detail can also be correlated with other eDiscovery mechanisms and/or administrative audit reports native to Syncplicity at the user, folder, device, file or

shared link level. See the Syncplicity Support site for the full data dictionary included in audit reports.


Comparisons of the system-level metadata (extracted to a network share)

And that of the source (as viewed by the eDiscovery Admin in the Syncplicity Online File Browser)

Working with your jobs

Once you have established jobs for DataHub to perform, you can control them manually, such as starting or stopping a job or pausing it indefinitely.

Deleting a job

You can delete a job that you no longer need, as follows:

1. Select the job that you want to delete by clicking the checkbox to the left of the job.

2. Select the Delete Job button.

NOTE: The Delete Job button is not enabled until you have selected a

service.

The Delete Job confirmation dialog box displays.

3. Select the Yes button to confirm the deletion. The confirmation box closes

and the job is removed from the Dashboard.


Starting a job

You can start a job that you have set up to run manually. You can also restart a job that you paused. To start a job:

1. Click the checkbox next to the job that you want to start.

2. Select the Start button from the toolbar in the Job Dashboard panel.

The Start Job confirmation box displays

3. Verify that the job you are about to start is the correct job.

4. Select the Yes button to start the job and close the Start Job confirmation

box.

Pausing a job

You can manually interrupt a job in process, or pause a scheduled job from running

at the next scheduled interval as follows:

1. Click checkbox next to the job that you want to halt

2. Select the Pause button from the toolbar, in the Job Control panel

The Pause Job confirmation box displays

3. Select the Yes button to pause the job and close the Pause Job confirmation

box.

Viewing the Log History

DataHub generates a log for each job every time that it is run. The log contains

information such as the time the job occurred, how long it took, the amount of data that was transferred and any errors that arose while it was running. You can then

export the error log to a CSV file.

To view the log:

1. Click the checkbox next for which you want to view the report.

2. Select the History button on the toolbar in the Job Control panel

The History log displays.

NOTE: The History button is not enabled until you select a job and until one or

more jobs have created a history record.


A sample of the History log displays below.

3. From the drop-down menu in the Execution History field, select the instance

of the job that you want to view the log.

4. Select the Export Failures button to export a .CSV file of all the failures

associated with the job.

Viewing the Audit History

The Audit feature is only enabled when DataHub is configured to use a full SQL Server due to the large amounts of data that can be added to the database.

Under the Advanced options in the Add New Job window, there is an Audit Transfer checkbox. If selected, DataHub keeps track of every item creation, transfer, and

deletion. When this setting is enabled and you view the Job History, there is an Audit tab in the middle window that details all operations DataHub performed for that job

run.


A sample of the Audit tab in Job History displays below.


Viewing the server status

DataHub logs all of the job activity performed by the system. Information such as the number of runs, successes, amounts of data sent/received and files

sent/received are available.

To view the job log, select the Server Status button on the toolbar in the Job Control

panel.

A sample of the Status log displays below.

Job Inspector

The Job Inspector allows you to review the status of any one of your jobs. It helps you determine what the state of your source and destination are, and what work DataHub has left to do to complete any content transfer tasks. To access it, right-

click on the job in question in the Job Control Panel and select Inspect Job from the menu.

Functioning similarly to the Job Analyzer, the inspector checks for connectivity, file/folder creation for the source and destination connections, and it counts the

number of items and the post-transfer usage of your allotted license. It differs from the Job Analyzer in that the Inspector detects the changes in both the source and the destination. It reports the number of new files, the number of deleted files, and

subsequently the number of changes DataHub performs the next time the job is run.

The Analyzer tries to predict the outcome of the first job run. The Inspector adds

detail on what DataHub has done previously, what the current state of each repository is, and what DataHub will do next job run.


As in the Job Analyzer, clicking on View next to the reports opens the list in Microsoft

Excel, or saves as a .csv file by clicking on export as csv.

Two pictures of the Job Inspector showing the categories reported are displayed

below.

Using the Navigation panel DataHub contains a Navigation panel where you can view and work with your folders and the files contained in them. Beyond basic navigation, DataHub provides

additional options to help you manage your storage providers. You can access the Navigation panel by clicking the tile on the Home screen or by selecting Navigation

from the drop-down navigation.

A sample of the Navigation panel displays below.


Navigation toolbar

The DataHub window contains a toolbar. All system functionality for DataHub is

handled through this toolbar. The buttons available vary based upon the pane that you are viewing.

A sample of the toolbar displays below.

The following buttons are available on the Navigation panel:



visited previously.

• Use the View button to open or close the Destination pane. The Destination

pane is closed by default. The View button only displays on the Navigation

panel.

• Use the Add Connection button to connect to a new service. For more


• Use the Settings button to customize the appearance of DataHub. For more

information, refer to the Settings topic.

Adornments

The DataHub Navigation pane uses adornments on entries to give you more

information. Some common examples are a small yellow user icon to denote the connection is an admin connection. Some platforms show a small blue user icon on

a folder to denote that folder is a shared folder. Arrows indicate a folder that is the source (up) or destination (down) of a configured sync job. The color coding matches the status of the job, gray for paused/not started, green for successful,

yellow for successful with warnings, or red for errors detected. A small padlock icon on a file indicates it has been locked or checked out from the system.


Creating a new folder

You can create a new folder in the Navigation pane as follows:

1. Navigate to the location in the tree view where you want the new folder

2. Right-click and select New Folder from the resulting context menu.

The New Folder dialog displays.

3. Enter the name of the new folder in the field.

4. Select the OK button.

Deleting a folder

You can remove a folder from the tree view as follows:

1. Navigate to the folder in the tree view that you want to delete.

2. Right-click then select Delete from the resulting context menu.

A warning dialog box displays.

3. Select the Yes button to delete the folder and close the Delete Folder dialog

box.

The folder is removed from both the tree view and your storage system.

Viewing your folders

You can view the contents of your folders in the tree view, Source pane, or Navigation panel. To view the contents of your folder:

1. Navigate to the folder in the tree view that you want to view.

2. Right-click and select Open from the resulting context menu to open any

subfolders or files in the Source pane.

3. If there are subfolders, the next folder displays both in the tree view and in

the detail pane. If there are no secondary folders but there are files, the files display in the detail pane.

NOTE: You can view, move, or delete files the same way that you do folders.


Renaming a folder

You can rename a folder in the tree view as follows. Renaming it also renames it in

your storage system.

1. Navigate to the folder in the tree view.

2. Right-click and select Rename from the resulting context menu.

The Rename Folder dialog displays.

3. Highlight the existing name and replace it with the new name that you have

chosen.

4. Select the OK button to complete the process and close the dialog box.

Moving your items

You can right-click on any folder in the tree view and select Cut or Copy from the resulting context menu. Navigate to the appropriate folder in the Destination pane,

right-click and select Paste, to paste your files to their new location.

NOTE: Per standard Windows functionality, copying simply moves a copy of the file

to the new location, while cutting removes the file from its source location.

Deleting a file

You can remove a file from your system in the tree view as follows:

1. Navigate to the file in the tree view.

2. Right-click and select Delete from the resulting context menu.

The system displays a dialog, confirming that you want to delete the file.

3. Select the Yes button to delete the selected file and close the Delete Item

confirmation box.

The file is removed from the tree view and from your system.

Viewing a file

You can view your selected file from the Viewer pane in the Navigation panel.

DataHub gives you the option of opening the file in Windows Explorer or opening it in the program that you have associated with the file type.

To view your folder in Windows Explorer:

1. Navigate to the file that you want to view in the Results pane.

2. Right-click and select Open in Explorer from the resulting context menu.

Windows Explorer opens, with the file you selected highlighted.


You can view, move, or delete folders the same way that you do files. For more information, refer to the Viewing your folders topic.

To open your file in a program:

1. Navigate to the file in the Results pane.

2. Double-click the file to open it in the program associated with its program

type. For example, a .doc file automatically opens in Microsoft Word.

Alternatively, you can right-click and select Open from the resulting context

menu.

Your system launches the program and the selected file opens.

Renaming an item

You can rename an item in the tree view. Renaming it also renames it in Windows.

To rename an item:

1. Navigate to the item in the Results pane.

2. Right-click and select Rename from the resulting context menu.

The Rename Item dialog displays.

3. Highlight the existing name and replace it with the new name that you have chosen

4. Select the OK button to complete the process and close the Rename Item

dialog box.

Moving your folders

Use the Navigation panel to move your files and folders from one location to another. You can move them manually by cutting or pasting, or by dragging and

dropping.

DataHub has a Destination pane in the Navigation panel in order to more easily see

where you are placing your files. For more information on using the Destination pane, refer to the Navigation panel topic.

Only folders that you have in a particular location display in the Source pane and in

the Destination pane. The files in these folders display in the Detail pane.

NOTE: The main tree view pane is labeled the “Source” pane when the Destination

pane is opened.

Copying or cutting your folders

You can right-click on any folder in the tree view and select Cut or Copy from the

resulting context menu. Navigate to the appropriate folder in the Destination pane, right-click and select Paste, and the system pastes your files to their new location.


NOTE: Per standard Windows functionality, copying simply moves a copy of the file

to the new location, while cutting removes the file from its source location.

Dragging and dropping your folders

To drag your files from one location and drop them in another, simply click on the folder in the tree view and drag it, while holding the left mouse button down, to the

desired location. Release the left mouse button and the files are copied to the new location. You can select multiple files by holding down the CTRL key while clicking.

NOTE: You can permanently move a file by holding the Shift key down while

dragging and dropping the file. Once you release the file, it is moved. After refreshing the view, you see the file in its new destination, and no longer in the

source folder.

Adding a favorite folder

You can add frequently used folders as favorites in DataHub. Favorite folders are

easily accessible from the Home page, as well as the Favorites panel.

To add a favorite folder:

1. Navigate to the folder in the tree view where you want to designate a favorite.

2. Right-click and select Add Favorite from the resulting context menu.

The Add Favorite dialog box displays.

3. Enter the name of the favorite folder in the field.

4. If you want to customize the appearance of the tile on the Home screen and in the tree view, select a color from the choices available.

5. Select the OK button to complete the process and close the Add Favorite

dialog box.

For more information on favorites, refer to the Using the Favorites panel topic.

NOTE: You can also perform actions in the tree view and in the Destination panel

after navigating to a favorite. This makes it easy to get to the content you use most

frequently.

Defining a job

You may define a job from the tree view in the Navigation pane by right clicking on

the folder you want to job. Select Define Job from the resulting context menu.

For more information, refer to the Creating a new job topic.


Connection pooling

Certain job types allow for connection pools to be used as destinations to increase

performance. Connection pooling allows you to group together multiple accounts and run them together in a job with the entire pool as a singular destination connector.

To create a connection pool, any accounts must first be created as connectors in DataHub. Once created, right-click on any one of the desired connectors in the

Navigation Panel. The following menu appears:

Under Connection Pool, select a color to assign to the pool. You are then prompted

to select a name for the pool. A dot of the corresponding color appears next to the connector. To add other Box connectors, right-click on them and select the color you assigned to the first connector. Repeat for every desired connection.


To run a job with a connection pool, from the Job Control Panel click "New" on the toolbar and select "New User Drive Mapping" from the drop-down menu. In the Add

New Job screen, if you select Box as the destination, all of your Box connections in addition to the pool are displayed. You can select the pool to act as the destination.

Locking and unlocking files

Certain platforms support locking and unlocking files. On the context menu for a

file, you see the appropriate options. A locked file is adorned with a lock icon.

Using the Basic Search panel DataHub allows you to search across multiple cloud, local and network locations simultaneously. The results are displayed in a central location on your desktop, and

you can work with them within DataHub. You can move files from one location to another, delete them, rename them or simply view them, all from your desktop. You can access the Basic Search panel by clicking the tile on the Home screen or by

selecting Basic Search from the drop-down navigation.

Basic Search toolbar

The Basic Search Panel contains a toolbar. All system functionality for DataHub is handled through this toolbar. The buttons available vary based upon the pane that

you are viewing.

A sample of the Basic Search panel toolbar displays below.

The following buttons are available on the Basic Search panel:



visited previously.

• Use the Favorite button to create a favorite file or folder. For more

information, refer to the Adding a favorite folder topic.

• Use the Connection button to connect to a new service. For more





Performing a basic search

DataHub opens to the Home screen, by default. From this screen, you can select

the Basic Search tile to open the Basic Search panel. Here you can search for files stored on your computer, or in any of your supported file storage services. You can perform a simple search or choose from saved or favorite searches. For more

information, refer to the Working with favorites topic.

To perform a basic search:

1. Select the Basic Search tile from the Home screen. You can also select “Basic Search” from the drop-down navigation menu, next to the Home button.

The Basic Search panel opens.

2. Select the locations that you want DataHub to search, from the Scope drop-down menu. All available services are selected by default. Select the Select

All link to select all services listed; select the Deselect All link to clear all

services.

3. Enter your search term(s) in the search field.

4. Press Enter on your keyboard, or click the magnifying glass icon in the search

field to initiate the search

Your search results display in the Results pane below the search field. The results from each service display in their own tab in the Results pane. For

more information, refer to the Working with your search results topic.

Saving a favorite search

You can save a search that you commonly used as a favorite search. This speeds

up the searching process for often repeated searches, allowing you to perform a search without re-entering the search criteria each time.

To save a favorite search:

1. Enter the search criteria that you want to search for in the Search field. For more information, refer to the Performing a basic search topic.

2. Select the service(s) that you want to search from the Scope drop-down menu.

3. Select the Add Favorite button.

The Add Favorite dialog box displays.

4. Enter the name that you want your favorite search to be called in the field

provided. The search terms populate the field by default. You can accept this name or enter a new one.


5. You can color code the appearance of your favorite search tiles by selecting one of the colors available. For instance, if you want all of your

“image” searches to be easily recognizable, consider making the tiles all the same color.

6. Select the OK button to name the favorite search and close the dialog box.

Your favorite search displays as a tile on the Home screen, as a tile on the Favorites panel and under My Searches in the navigational drop-down. For more information,

refer to the Working with favorites topic.

Working with your search results

Once you have performed a search, the results display in the Results pane. Each service that you selected in the Scope drop-down menu displays in its own tab. You can reorder these tabs by dragging and dropping, if desired.

The following topics are all actions that you can perform by right-clicking and choosing an option from the context menu.

A sample of the Results pane displays below.

Select the desired file from the list. Double click the file in the results pane. The containing folder then opens in the Navigation panel with the selected file

highlighted. Double click the selected file to open it.

NOTE: Each tab contains an X, visible when you hover over it with your mouse. Click

the X to close the tab and clear the results from that specific search.


Working with favorites

Once you have established favorite places and searches, you can easily find files

and/or folders that you frequently use. You can access your favorites from the Home screen by either selecting the Favorites tile or by selecting the individual favorite tiles. You can also access them from the drop-down option on each panel.

Accessing your favorite searches from the Favorites tile

Select the Favorites tile to open the Favorites panel. On this panel, all of your favorite searches are displayed as tiles. An example of a favorite search tile displays

below.

The name of search is displayed on the tile, as are the service(s) that are in the

scope of the search. Select the desired tile to execute the search.

NOTE: You cannot edit a favorite search. If you want to make changes to one, you

need to create a new search and delete the existing one.

Accessing your favorites from the Home screen

Your favorites display as individual tiles on the Home screen. These items are readily available as soon as DataHub launches.

NOTE: The tiles are arranged on the Home screen in order of most commonly used

to least commonly used.

For favorite searches, selecting the tile launches the search. The results display in the Favorites panel. Click on the file that you want to open to see it in the Navigation pane. For more information, refer to the Performing a basic search topic.

For favorite places, selecting the tile opens the navigation panel and navigates to the favorite location.

Deleting your favorites

You can delete your favorites from either the Home screen or from the Favorites panel by selecting the X on the upper right corner of the favorite search tile.


Using the Favorites panel The Favorites panel is comprised of user-defined tiles. All of the folders, searches or

files that you have saved as favorites display on this panel. Use the Favorites panel to quickly access commonly visited searches or places. Select the appropriate tile

to execute the search. To access the Favorites panel, click the tile on the Home screen or select Favorites from the drop-down navigation.

For more information on the types of tiles, refer to the Working with tiles topic.

A sample of the Favorites panel displays below.

Favorites toolbar

The Favorites panel contains a toolbar. All system functionality for DataHub is handled through this toolbar. The buttons available vary based upon the pane that

you are viewing.

A sample of the Favorites toolbar displays below.

The following buttons are display on the Favorites panel:



visited previously.

• Use the Connection button to connect to a new service. For more





Aside from toolbar buttons, there are many actions you can perform through right

clicking on favorite files and folders.

Exiting DataHub You do not need to log out of DataHub. Simply click the X in the upper right hand corner to exit the system. However, the DataHub service continues to run, as well as

the jobs as scheduled, as long as your server or workstation is running.

Enabling long path support for file systems As installed, DataHub does not support jobs with paths longer than 255 characters in the File System connector. Any job ran with such a path reports an error.

Support for path files over the 255 character limit can be enabled using the

following steps:

1. Locate the file appSettings.config located in the DataHub install directory

(default path: C:\Program Files (x86)\Data Hub).

2. Open appSettings.config with Microsoft Notepad as an administrator.

3. Add the following line:

<add key="FileSystem.EnableLongPathSupport" value="true" />

The file should look something like this:

4. Save the changes.

5. Open the services list (run services.msc), locate the DataHub service and restart it for the changes to take effect.


Your file system provider and network share connections should now support file names and path depths much greater than 255 characters. These deep paths may

not always be fully explorable in Windows Explorer tools however, as many of those tools still have inherent 255 character limits.

Appendix 1: Deployment Worksheet DataHub Server(s):

1. Syncplicity Enterprise Edition Account Owner email:

2. Windows Service Account (requires read permissions on source system for migrating and copying, read/write permissions for sync jobs)

3. Windows server name:

4. Networking:

a. IP:

b. Subnet Mask:

c. Default Gateway:

d. Broadcast:

5. OS

6. CPU

7. RAM

8. # NIC(S)

9. NIC Speed

10. Install path(s)

11. Local Windows CE Database?

12. Local MS SQL Database?

13. Remote MS SQL Database server name (if applicable)

Syncplicity Account:

1. Service Account Name:


2. Confirm that the service account:

a. Has a role of Global Administrator

b. Has a privilege set to “Access content on behalf of managed users through API” in the Manage User page.

c. Has access to all groups that users belong to so that their data can be

imported seamlessly.

d. Has an Application Token created. See Account page in

my.syncplicity.com

e. Is a member of a Policy Set where the Desktop Client Active Directory

Restriction Policy is either set to “company users can install and run Syncplicity on any computer”

3. End users:

a. Confirm all end users that own folders have existing Syncplicity accounts

b. Confirm quota capacity in Syncplicity is equal to or greater than consumed storage capacity on the source system.

Networking

2. URL’s and ports to be whitelisted from the DataHub server(s)

a. DataHub licensing: api.portalarchitects.com

b. Syncplicity Orchestration: xml.syncplicity.com

c. Syncplicity Admin Portal: my.syncplicity.com (best practice is to have the ability to access this portal directly from the DataHub Server to transfer keys and tokens efficiently.

d. Syncplicity Developer Portal: developer.syncplicity.com (best practice is to have the ability to access this portal directly from the

DataHub Server to transfer keys and tokens efficiently.

e. Syncplicity API gateway: api.syncplicity.com

f. (optional) Syncplicity storage US: data.syncplicity.com

g. (optional) Syncplicity storage EU: data-eu.syncplicity.com


Appendix 2: Deploying DataHub with SQL

databases Overview

This section outlines procedures to configure DataHub for advanced scenarios.

Syncplicity recommends you contact us for help with this type of deployment configuration.

The last section outlines a step by step walkthrough of the installer, with notes for each step.

NOTE: The notes apply for a custom install for multiple DataHub server nodes.

Typical installations do not need the extra steps, and will not provide the number of choices required for a custom install. At any step you may keep DataHub's default

install parameters if you do not wish to customize that aspect of the installation.

Architectural Notes

DataHub is a WPF (Windows Presentation Foundation) application that uses WCF

(Windows Communication Foundation) to communicate with the DataHub and its underlying Skysync service. The SkySync Service is a self- hosted WCF service that

exposes functionality to query, maintain, and execute DataHub Jobs. The UI application uses the connector framework for Navigation panel operations, but generally calls the Service application only to view status and define jobs. The

Service itself then connects via the connector framework to configured storage platforms to perform configured jobs and operations.

This indicates that the service identity and connector credentials are both important to successful configuration of a DataHub based solution.

Configure DataHub to use a SQL Server database

DataHub uses a local SQL Ce database by default. By modifying configuration files, DataHub can be configured to run against a full SQL Server instance of your choice. This is recommended for high volume and / or high availability scenarios.

Once you or your database administrators have set up your SQL Server database, and decided upon log in and security details, follow the following steps and

procedures to configure DataHub to access this database. Generally an account will be created and used for applications to access a database. This account will

need to be in the “db owner” group in SQL Server. You or your database administrator will need to create the database “shell”. The DataHub Service will create its working tables automatically once connected to the database the first

time.

Note: DataHub has both a Windows application component (configuration UI) and

the SkySync Service which schedules and executes jobs. These changes will be made to configuration files for BOTH applications automatically by running

migration batch file below.


Configure multiple DataHub nodes in a cluster

DataHub Service can also be set up in a cluster to distribute load or provide fail

over capability. When set up to use the full SQL Server database per the above instructions, DataHub will automatically enter Quartz clustering mode.

Pre-Requisites

You have installed DataHub on all of the nodes you wish to cluster. Each DataHub configuration application and service have been configured to access a SQL

Server per the instructions above in this document.

Port 9000 will be opened on each node of the DataHub server cluster by way of a custom Firewall rule that the DataHub installer will put into place. DataHub inter-

server communication occurs using port 9000.

Note: In clustered scenarios the DataHub Service host servers must be using auto

synced clocks that are accurate to within a second or problems can occur with clustering. Please refer to the Quartz configuration notes for details or additional

information.

http://quartz-scheduler.org/documentation/quartz-2.1.x/configuration/ConfigJDBCJobStoreClustering

Step by step installation instructions for multiple server installation

Copy and extract the DataHub installer binary on each node of the DataHub

Cluster

Ensure that the SQL Server database is present on SQL server and that the security

access

permissions have been applied to the database.

Create a Connection String and test using the UDL technique

Install DataHub on the first server (node) of the cluster

1. Run the DataHub setup

2. Click the Checkbox for I accept the terms in the License Agreement Click

the Custom installation button




Click Next >

3. At the Installation Options step, you may enter new values for the DataHub

Install Location and Program Data Location if you do not want to use the defaults.

4. At the Service Identity step, click This Account to configure the identity the

DataHub Service will run using.

a. Use a valid domain proxy account ex.

Domain\DataHub_Service_Account Enter the password

b. Confirm the password

c. Click the Validate button Click Next > to continue

You may use any valid account or local system but be advised this becomes the security identity of the SkySync service and effects access to secured network

resources and usage of Windows Integrated Authentication options for supported platforms.

5. Click Next > at the Internet Proxy Options form. If you use a specific internet

proxy, you can modify the settings here to match your environment. Contact your network administrator for help with determining the correct values to use.

6. At the Database Configuration Step:

a. Configuring SQL Connection String:

a. Change Database Provider Name to SQL Server

b. Enter your SQL Server name ex. SKYTEST in the example below

c. Enter your SQL Server database name ex. SkySync in the Database box

d. Uncheck the Use Windows Authentication Checkbox

e. Enter database credentials SkySync will use to access the database in the now available

b. User Name box

a. Check the Use Windows Authentication Checkbox (User Name grays-out)

b. Click the Validate button. The Account is valid. Click Next to continue. will display

c. Click Next > to continue


You may modify these options to match your SQL Server installation. Please contact your SQL DBA for help determining the correct values to enter for your specific SQL

Server deployment.

7. At the Confirm Configuration step, Click Install. Click Yes to allow the installer

to proceed

8. Click Exit after the product has been successfully installed.

a. Launch the SkySync application

b. Enter the License Key

c. Copy the C:\ProgramData\PortalArchitects\Data\Keys folder to a network share location that is accessible by all DataHub Nodes.

d. Install DataHub on the remaining nodes following these steps:

e. Install DataHub following Steps 1 – 10

f. Stop the SkySync Service

g. Rename C:\ProgramData\PortalArchitects\Data\Keys to Keys-old d. Copy over the Keys file into the previous directory

h. Start SkySync Service

i. Launch DataHub

j. Enter License Key

k. Return to step 8 above until all nodes have DataHub installed

Syncplicity® DataHub - Axway Documentation Portal

Documents

Transcript of Syncplicity® DataHub - Axway Documentation Portal